(X-Face): Add uncompface-use-external.
[gnus] / texi / gnus.texi
1 \input texinfo
2
3 @setfilename gnus
4 @settitle Gnus Manual
5 @syncodeindex fn cp
6 @syncodeindex vr cp
7 @syncodeindex pg cp
8 @dircategory Emacs
9 @direntry
10 * Gnus: (gnus).         The newsreader Gnus.
11 @end direntry
12 @documentencoding ISO-8859-1
13 @iftex
14 @finalout
15 @end iftex
16 @setchapternewpage odd
17
18 @iftex
19 @iflatex
20 \documentclass[twoside,a4paper,openright,11pt]{book}
21 \usepackage[latin1]{inputenc}
22 \usepackage{pagestyle}
23 \usepackage{epsfig}
24 \usepackage{pixidx}
25 \input{gnusconfig.tex}
26
27 \ifx\pdfoutput\undefined
28 \else
29 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
30 \usepackage{thumbpdf}
31 \pdfcompresslevel=9
32 \fi
33
34 \makeindex
35 \begin{document}
36
37 \newcommand{\gnusversionname}{Gnus v5.10.6}
38 \newcommand{\gnuschaptername}{}
39 \newcommand{\gnussectionname}{}
40
41 \newcommand{\gnusbackslash}{/}
42
43 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
44 \ifx\pdfoutput\undefined
45 \newcommand{\gnusuref}[1]{\gnustt{#1}}
46 \else
47 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
48 \fi
49 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
50 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
51
52 \newcommand{\gnuskindex}[1]{\index{#1}}
53 \newcommand{\gnusindex}[1]{\index{#1}}
54
55 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
56 \newcommand{\gnuscode}[1]{\gnustt{#1}}
57 \newcommand{\gnusasis}[1]{\gnustt{#1}}
58 \newcommand{\gnusurl}[1]{\gnustt{#1}}
59 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
60 \newcommand{\gnusenv}[1]{\gnustt{#1}}
61 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
62 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
63 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
64 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
65 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
66 \newcommand{\gnusdfn}[1]{\textit{#1}}
67 \newcommand{\gnusi}[1]{\textit{#1}}
68 \newcommand{\gnusr}[1]{\textrm{#1}}
69 \newcommand{\gnusstrong}[1]{\textbf{#1}}
70 \newcommand{\gnusemph}[1]{\textit{#1}}
71 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
72 \newcommand{\gnussc}[1]{\textsc{#1}}
73 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
74 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
75 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
76 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
77 \newcommand{\gnusacronym}[1]{\textsc{#1}}
78 \newcommand{\gnusemail}[1]{\textit{#1}}
79
80 \newcommand{\gnusbullet}{{${\bullet}$}}
81 \newcommand{\gnusdollar}{\$}
82 \newcommand{\gnusampersand}{\&}
83 \newcommand{\gnuspercent}{\%}
84 \newcommand{\gnushash}{\#}
85 \newcommand{\gnushat}{\symbol{"5E}}
86 \newcommand{\gnusunderline}{\symbol{"5F}}
87 \newcommand{\gnusnot}{$\neg$}
88 \newcommand{\gnustilde}{\symbol{"7E}}
89 \newcommand{\gnusless}{{$<$}}
90 \newcommand{\gnusgreater}{{$>$}}
91 \newcommand{\gnusbraceleft}{{$>$}}
92 \newcommand{\gnusbraceright}{{$>$}}
93
94 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
95 \newcommand{\gnusinteresting}{
96 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
97 }
98
99 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
100
101 \newcommand{\gnuspagechapter}[1]{
102 {\mbox{}}
103 }
104
105 \newdimen{\gnusdimen}
106 \gnusdimen 0pt
107
108 \newcommand{\gnuschapter}[2]{
109 \gnuscleardoublepage
110 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
111 \chapter{#2}
112 \renewcommand{\gnussectionname}{}
113 \renewcommand{\gnuschaptername}{#2}
114 \thispagestyle{empty}
115 \hspace*{-2cm}
116 \begin{picture}(500,500)(0,0)
117 \put(480,350){\makebox(0,0)[tr]{#1}}
118 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
119 \end{picture}
120 \clearpage
121 }
122
123 \newcommand{\gnusfigure}[3]{
124 \begin{figure}
125 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
126 #3
127 \end{picture}
128 \caption{#1}
129 \end{figure}
130 }
131
132 \newcommand{\gnusicon}[1]{
133 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
134 }
135
136 \newcommand{\gnuspicon}[1]{
137 \margindex{\epsfig{figure=#1,width=2cm}}
138 }
139
140 \newcommand{\gnusxface}[2]{
141 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
142 }
143
144 \newcommand{\gnussmiley}[2]{
145 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
146 }
147
148 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
149
150 \newcommand{\gnussection}[1]{
151 \renewcommand{\gnussectionname}{#1}
152 \section{#1}
153 }
154
155 \newenvironment{codelist}%
156 {\begin{list}{}{
157 }
158 }{\end{list}}
159
160 \newenvironment{asislist}%
161 {\begin{list}{}{
162 }
163 }{\end{list}}
164
165 \newenvironment{kbdlist}%
166 {\begin{list}{}{
167 \labelwidth=0cm
168 }
169 }{\end{list}}
170
171 \newenvironment{dfnlist}%
172 {\begin{list}{}{
173 }
174 }{\end{list}}
175
176 \newenvironment{stronglist}%
177 {\begin{list}{}{
178 }
179 }{\end{list}}
180
181 \newenvironment{samplist}%
182 {\begin{list}{}{
183 }
184 }{\end{list}}
185
186 \newenvironment{varlist}%
187 {\begin{list}{}{
188 }
189 }{\end{list}}
190
191 \newenvironment{emphlist}%
192 {\begin{list}{}{
193 }
194 }{\end{list}}
195
196 \newlength\gnusheadtextwidth
197 \setlength{\gnusheadtextwidth}{\headtextwidth}
198 \addtolength{\gnusheadtextwidth}{1cm}
199
200 \newpagestyle{gnuspreamble}%
201 {
202 {
203 \ifodd\count0
204 {
205 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
206 }
207 \else
208 {
209 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
210 }
211 }
212 \fi
213 }
214 }
215 {
216 \ifodd\count0
217 \mbox{} \hfill
218 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
219 \else
220 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
221 \hfill \mbox{}
222 \fi
223 }
224
225 \newpagestyle{gnusindex}%
226 {
227 {
228 \ifodd\count0
229 {
230 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
231 }
232 \else
233 {
234 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
235 }
236 \fi
237 }
238 }
239 {
240 \ifodd\count0
241 \mbox{} \hfill
242 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
243 \else
244 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
245 \hfill \mbox{}
246 \fi
247 }
248
249 \newpagestyle{gnus}%
250 {
251 {
252 \ifodd\count0
253 {
254 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
255 }
256 \else
257 {
258 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
259 }
260 \fi
261 }
262 }
263 {
264 \ifodd\count0
265 \mbox{} \hfill
266 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
267 \else
268 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
269 \hfill \mbox{}
270 \fi
271 }
272
273 \pagenumbering{roman}
274 \pagestyle{gnuspreamble}
275
276 @end iflatex
277 @end iftex
278
279 @iftex
280 @iflatex
281 \begin{titlepage}
282 {
283
284 %\addtolength{\oddsidemargin}{-5cm}
285 %\addtolength{\evensidemargin}{-5cm}
286 \parindent=0cm
287 \addtolength{\textheight}{2cm}
288
289 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
290 \rule{15cm}{1mm}\\
291 \vfill
292 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
293 \vfill
294 \rule{15cm}{1mm}\\
295 \gnusauthor{by Lars Magne Ingebrigtsen}
296 \newpage
297 }
298
299 \mbox{}
300 \vfill
301
302 \thispagestyle{empty}
303
304 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
305 2002, 2003, 2004
306 Free Software Foundation, Inc.
307
308
309 Permission is granted to copy, distribute and/or modify this document
310 under the terms of the GNU Free Documentation License, Version 1.1 or
311 any later version published by the Free Software Foundation; with no
312 Invariant Sections, with the Front-Cover texts being ``A GNU
313 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
314 license is included in the section entitled ``GNU Free Documentation
315 License'' in the Emacs manual.
316
317 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
318 this GNU Manual, like GNU software.  Copies published by the Free
319 Software Foundation raise funds for GNU development.''
320
321 This document is part of a collection distributed under the GNU Free
322 Documentation License.  If you want to distribute this document
323 separately from the collection, you can do so by adding a copy of the
324 license to the document, as described in section 6 of the license.
325 \newpage
326 \end{titlepage}
327 @end iflatex
328 @end iftex
329
330 @ifnottex
331
332 This file documents Gnus, the GNU Emacs newsreader.
333
334 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
335         Free Software Foundation, Inc.
336
337 Permission is granted to copy, distribute and/or modify this document
338 under the terms of the GNU Free Documentation License, Version 1.1 or
339 any later version published by the Free Software Foundation; with the
340 Invariant Sections being none, with the Front-Cover texts being ``A GNU
341 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
342 license is included in the section entitled ``GNU Free Documentation
343 License'' in the Emacs manual.
344
345 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
346 this GNU Manual, like GNU software.  Copies published by the Free
347 Software Foundation raise funds for GNU development.''
348
349 This document is part of a collection distributed under the GNU Free
350 Documentation License.  If you want to distribute this document
351 separately from the collection, you can do so by adding a copy of the
352 license to the document, as described in section 6 of the license.
353 @end ifnottex
354
355 @tex
356
357 @titlepage
358 @title Gnus Manual
359
360 @author by Lars Magne Ingebrigtsen
361 @page
362
363 @vskip 0pt plus 1filll
364 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
365 2002, 2003, 2004
366         Free Software Foundation, Inc.
367
368 Permission is granted to copy, distribute and/or modify this document
369 under the terms of the GNU Free Documentation License, Version 1.1 or
370 any later version published by the Free Software Foundation; with no
371 Invariant Sections, with the Front-Cover texts being ``A GNU
372 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
373 license is included in the section entitled ``GNU Free Documentation
374 License'' in the Emacs manual.
375
376 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
377 this GNU Manual, like GNU software.  Copies published by the Free
378 Software Foundation raise funds for GNU development.''
379
380 This document is part of a collection distributed under the GNU Free
381 Documentation License.  If you want to distribute this document
382 separately from the collection, you can do so by adding a copy of the
383 license to the document, as described in section 6 of the license.
384
385 @end titlepage
386 @page
387
388 @end tex
389
390
391 @node Top
392 @top The Gnus Newsreader
393
394 @ifinfo
395
396 You can read news (and mail) from within Emacs by using Gnus.  The news
397 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
398 spool or your mbox file.  All at the same time, if you want to push your
399 luck.
400
401 This manual corresponds to Gnus v5.10.6.
402
403 @end ifinfo
404
405 @iftex
406
407 @iflatex
408 \tableofcontents
409 \gnuscleardoublepage
410 @end iflatex
411
412 Gnus is the advanced, self-documenting, customizable, extensible
413 unreal-time newsreader for GNU Emacs.
414
415 Oops.  That sounds oddly familiar, so let's start over again to avoid
416 being accused of plagiarism:
417
418 Gnus is a message-reading laboratory.  It will let you look at just
419 about anything as if it were a newsgroup.  You can read mail with it,
420 you can browse directories with it, you can @code{ftp} with it---you
421 can even read news with it!
422
423 Gnus tries to empower people who read news the same way Emacs empowers
424 people who edit text.  Gnus sets no limits to what the user should be
425 allowed to do.  Users are encouraged to extend Gnus to make it behave
426 like they want it to behave.  A program should not control people;
427 people should be empowered to do what they want by using (or abusing)
428 the program.
429
430 @end iftex
431
432 @menu
433 * Starting Up::                 Finding news can be a pain.
434 * Group Buffer::                Selecting, subscribing and killing groups.
435 * Summary Buffer::              Reading, saving and posting articles.
436 * Article Buffer::              Displaying and handling articles.
437 * Composing Messages::          Information on sending mail and news.
438 * Select Methods::              Gnus reads all messages from various select methods.
439 * Scoring::                     Assigning values to articles.
440 * Various::                     General purpose settings.
441 * The End::                     Farewell and goodbye.
442 * Appendices::                  Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
443 * Index::                       Variable, function and concept index.
444 * Key Index::                   Key Index.
445
446 Other related manuals
447
448 * Message:(message).            Composing messages.
449 * Emacs-MIME:(emacs-mime).      Composing messages; @acronym{MIME}-specific parts.
450 * Sieve:(sieve).                Managing Sieve scripts in Emacs.
451 * PGG:(pgg).                    @acronym{PGP/MIME} with Gnus.
452 * SASL:(sasl).                  @acronym{SASL} authentication in Emacs.
453
454 @detailmenu
455  --- The Detailed Node Listing ---
456
457 Starting Gnus
458
459 * Finding the News::            Choosing a method for getting news.
460 * The First Time::              What does Gnus do the first time you start it?
461 * The Server is Down::          How can I read my mail then?
462 * Slave Gnusae::                You can have more than one Gnus active at a time.
463 * Fetching a Group::            Starting Gnus just to read a group.
464 * New Groups::                  What is Gnus supposed to do with new groups?
465 * Changing Servers::            You may want to move from one server to another.
466 * Startup Files::               Those pesky startup files---@file{.newsrc}.
467 * Auto Save::                   Recovering from a crash.
468 * The Active File::             Reading the active file over a slow line Takes Time.
469 * Startup Variables::           Other variables you might change.
470
471 New Groups
472
473 * Checking New Groups::         Determining what groups are new.
474 * Subscription Methods::        What Gnus should do with new groups.
475 * Filtering New Groups::        Making Gnus ignore certain new groups.
476
477 Group Buffer
478
479 * Group Buffer Format::         Information listed and how you can change it.
480 * Group Maneuvering::           Commands for moving in the group buffer.
481 * Selecting a Group::           Actually reading news.
482 * Subscription Commands::       Unsubscribing, killing, subscribing.
483 * Group Data::                  Changing the info for a group.
484 * Group Levels::                Levels? What are those, then?
485 * Group Score::                 A mechanism for finding out what groups you like.
486 * Marking Groups::              You can mark groups for later processing.
487 * Foreign Groups::              Creating and editing groups.
488 * Group Parameters::            Each group may have different parameters set.
489 * Listing Groups::              Gnus can list various subsets of the groups.
490 * Sorting Groups::              Re-arrange the group order.
491 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
492 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
493 * Exiting Gnus::                Stop reading news and get some work done.
494 * Group Topics::                A folding group mode divided into topics.
495 * Misc Group Stuff::            Other stuff that you can to do.
496
497 Group Buffer Format
498
499 * Group Line Specification::    Deciding how the group buffer is to look.
500 * Group Mode Line Specification::  The group buffer mode line.
501 * Group Highlighting::          Having nice colors in the group buffer.
502
503 Group Topics
504
505 * Topic Commands::              Interactive E-Z commands.
506 * Topic Variables::             How to customize the topics the Lisp Way.
507 * Topic Sorting::               Sorting each topic individually.
508 * Topic Topology::              A map of the world.
509 * Topic Parameters::            Parameters that apply to all groups in a topic.
510
511 Misc Group Stuff
512
513 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
514 * Group Information::           Information and help on groups and Gnus.
515 * Group Timestamp::             Making Gnus keep track of when you last read a group.
516 * File Commands::               Reading and writing the Gnus files.
517 * Sieve Commands::              Managing Sieve scripts.
518
519 Summary Buffer
520
521 * Summary Buffer Format::       Deciding how the summary buffer is to look.
522 * Summary Maneuvering::         Moving around the summary buffer.
523 * Choosing Articles::           Reading articles.
524 * Paging the Article::          Scrolling the current article.
525 * Reply Followup and Post::     Posting articles.
526 * Delayed Articles::            Send articles at a later time.
527 * Marking Articles::            Marking articles as read, expirable, etc.
528 * Limiting::                    You can limit the summary buffer.
529 * Threading::                   How threads are made.
530 * Sorting the Summary Buffer::  How articles and threads are sorted.
531 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
532 * Article Caching::             You may store articles in a cache.
533 * Persistent Articles::         Making articles expiry-resistant.
534 * Article Backlog::             Having already read articles hang around.
535 * Saving Articles::             Ways of customizing article saving.
536 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
537 * Article Treatment::           The article buffer can be mangled at will.
538 * MIME Commands::               Doing MIMEy things with the articles.
539 * Charsets::                    Character set issues.
540 * Article Commands::            Doing various things with the article buffer.
541 * Summary Sorting::             Sorting the summary buffer in various ways.
542 * Finding the Parent::          No child support? Get the parent.
543 * Alternative Approaches::      Reading using non-default summaries.
544 * Tree Display::                A more visual display of threads.
545 * Mail Group Commands::         Some commands can only be used in mail groups.
546 * Various Summary Stuff::       What didn't fit anywhere else.
547 * Exiting the Summary Buffer::  Returning to the Group buffer,
548                                 or reselecting the current group.
549 * Crosspost Handling::          How crossposted articles are dealt with.
550 * Duplicate Suppression::       An alternative when crosspost handling fails.
551 * Security::                    Decrypt and Verify.
552 * Mailing List::                Mailing list minor mode.
553
554 Summary Buffer Format
555
556 * Summary Buffer Lines::        You can specify how summary lines should look.
557 * To From Newsgroups::          How to not display your own name.
558 * Summary Buffer Mode Line::    You can say how the mode line should look.
559 * Summary Highlighting::        Making the summary buffer all pretty and nice.
560
561 Choosing Articles
562
563 * Choosing Commands::           Commands for choosing articles.
564 * Choosing Variables::          Variables that influence these commands.
565
566 Reply, Followup and Post
567
568 * Summary Mail Commands::       Sending mail.
569 * Summary Post Commands::       Sending news.
570 * Summary Message Commands::    Other Message-related commands.
571 * Canceling and Superseding::
572
573 Marking Articles
574
575 * Unread Articles::             Marks for unread articles.
576 * Read Articles::               Marks for read articles.
577 * Other Marks::                 Marks that do not affect readedness.
578
579 Marking Articles
580
581 * Setting Marks::             How to set and remove marks.
582 * Generic Marking Commands::  How to customize the marking.
583 * Setting Process Marks::     How to mark articles for later processing.
584
585 Threading
586
587 * Customizing Threading::       Variables you can change to affect the threading.
588 * Thread Commands::             Thread based commands in the summary buffer.
589
590 Customizing Threading
591
592 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
593 * Filling In Threads::          Making the threads displayed look fuller.
594 * More Threading::              Even more variables for fiddling with threads.
595 * Low-Level Threading::         You thought it was over@dots{} but you were wrong!
596
597 Decoding Articles
598
599 * Uuencoded Articles::          Uudecode articles.
600 * Shell Archives::              Unshar articles.
601 * PostScript Files::            Split PostScript.
602 * Other Files::                 Plain save and binhex.
603 * Decoding Variables::          Variables for a happy decoding.
604 * Viewing Files::               You want to look at the result of the decoding?
605
606 Decoding Variables
607
608 * Rule Variables::              Variables that say how a file is to be viewed.
609 * Other Decode Variables::      Other decode variables.
610 * Uuencoding and Posting::      Variables for customizing uuencoding.
611
612 Article Treatment
613
614 * Article Highlighting::        You want to make the article look like fruit salad.
615 * Article Fontisizing::         Making emphasized text look nice.
616 * Article Hiding::              You also want to make certain info go away.
617 * Article Washing::             Lots of way-neat functions to make life better.
618 * Article Header::              Doing various header transformations.
619 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
620 * Article Button Levels::       Controlling appearance of buttons.
621 * Article Date::                Grumble, UT!
622 * Article Display::             Display various stuff---X-Face, Picons, Smileys
623 * Article Signature::           What is a signature?
624 * Article Miscellanea::         Various other stuff.
625
626 Alternative Approaches
627
628 * Pick and Read::               First mark articles and then read them.
629 * Binary Groups::               Auto-decode all articles.
630
631 Various Summary Stuff
632
633 * Summary Group Information::   Information oriented commands.
634 * Searching for Articles::      Multiple article commands.
635 * Summary Generation Commands::
636 * Really Various Summary Commands::  Those pesky non-conformant commands.
637
638 Article Buffer
639
640 * Hiding Headers::              Deciding what headers should be displayed.
641 * Using MIME::                  Pushing articles through @acronym{MIME} before reading them.
642 * Customizing Articles::        Tailoring the look of the articles.
643 * Article Keymap::              Keystrokes available in the article buffer.
644 * Misc Article::                Other stuff.
645
646 Composing Messages
647
648 * Mail::                        Mailing and replying.
649 * Posting Server::              What server should you post and mail via?
650 * Mail and Post::               Mailing and posting at the same time.
651 * Archived Messages::           Where Gnus stores the messages you've sent.
652 * Posting Styles::              An easier way to specify who you are.
653 * Drafts::                      Postponing messages and rejected messages.
654 * Rejected Articles::           What happens if the server doesn't like your article?
655 * Signing and encrypting::      How to compose secure messages.
656
657 Select Methods
658
659 * Server Buffer::               Making and editing virtual servers.
660 * Getting News::                Reading USENET news with Gnus.
661 * Getting Mail::                Reading your personal mail with Gnus.
662 * Browsing the Web::            Getting messages from a plethora of Web sources.
663 * IMAP::                        Using Gnus as a @acronym{IMAP} client.
664 * Other Sources::               Reading directories, files, SOUP packets.
665 * Combined Groups::             Combining groups into one group.
666 * Gnus Unplugged::              Reading news and mail offline.
667
668 Server Buffer
669
670 * Server Buffer Format::        You can customize the look of this buffer.
671 * Server Commands::             Commands to manipulate servers.
672 * Example Methods::             Examples server specifications.
673 * Creating a Virtual Server::   An example session.
674 * Server Variables::            Which variables to set.
675 * Servers and Methods::         You can use server names as select methods.
676 * Unavailable Servers::         Some servers you try to contact may be down.
677
678 Getting News
679
680 * NNTP::                        Reading news from an @acronym{NNTP} server.
681 * News Spool::                  Reading news from the local spool.
682
683 @acronym{NNTP}
684
685 * Direct Functions::            Connecting directly to the server.
686 * Indirect Functions::          Connecting indirectly to the server.
687 * Common Variables::            Understood by several connection functions.
688
689 Getting Mail
690
691 * Mail in a Newsreader::        Important introductory notes.
692 * Getting Started Reading Mail::  A simple cookbook example.
693 * Splitting Mail::              How to create mail groups.
694 * Mail Sources::                How to tell Gnus where to get mail from.
695 * Mail Back End Variables::     Variables for customizing mail handling.
696 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
697 * Group Mail Splitting::        Use group customize to drive mail splitting.
698 * Incorporating Old Mail::      What about the old mail you have?
699 * Expiring Mail::               Getting rid of unwanted mail.
700 * Washing Mail::                Removing cruft from the mail you get.
701 * Duplicates::                  Dealing with duplicated mail.
702 * Not Reading Mail::            Using mail back ends for reading other files.
703 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
704
705 Mail Sources
706
707 * Mail Source Specifiers::      How to specify what a mail source is.
708 * Mail Source Customization::   Some variables that influence things.
709 * Fetching Mail::               Using the mail source specifiers.
710
711 Choosing a Mail Back End
712
713 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
714 * Rmail Babyl::                 Emacs programs use the Rmail Babyl format.
715 * Mail Spool::                  Store your mail in a private spool?
716 * MH Spool::                    An mhspool-like back end.
717 * Maildir::                     Another one-file-per-message format.
718 * Mail Folders::                Having one file for each group.
719 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
720
721 Browsing the Web
722
723 * Archiving Mail::
724 * Web Searches::                Creating groups from articles that match a string.
725 * Slashdot::                    Reading the Slashdot comments.
726 * Ultimate::                    The Ultimate Bulletin Board systems.
727 * Web Archive::                 Reading mailing list archived on web.
728 * RSS::                         Reading RDF site summary.
729 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
730
731 @acronym{IMAP}
732
733 * Splitting in IMAP::           Splitting mail with nnimap.
734 * Expiring in IMAP::            Expiring mail with nnimap.
735 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
736 * Expunging mailboxes::         Equivalent of a ``compress mailbox'' button.
737 * A note on namespaces::        How to (not) use @acronym{IMAP} namespace in Gnus.
738 * Debugging IMAP::              What to do when things don't work.
739
740 Other Sources
741
742 * Directory Groups::            You can read a directory as if it was a newsgroup.
743 * Anything Groups::             Dired?  Who needs dired?
744 * Document Groups::             Single files can be the basis of a group.
745 * SOUP::                        Reading @sc{soup} packets ``offline''.
746 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
747
748 Document Groups
749
750 * Document Server Internals::   How to add your own document types.
751
752 SOUP
753
754 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
755 * SOUP Groups::                 A back end for reading @sc{soup} packets.
756 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
757
758 Combined Groups
759
760 * Virtual Groups::              Combining articles from many groups.
761 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
762
763 Gnus Unplugged
764
765 * Agent Basics::                How it all is supposed to work.
766 * Agent Categories::            How to tell the Gnus Agent what to download.
767 * Agent Commands::              New commands for all the buffers.
768 * Agent Visuals::               Ways that the agent may effect your summary buffer.
769 * Agent as Cache::              The Agent is a big cache too.
770 * Agent Expiry::                How to make old articles go away.
771 * Agent Regeneration::          How to recover from lost connections and other accidents.
772 * Agent and IMAP::              How to use the Agent with @acronym{IMAP}.
773 * Outgoing Messages::           What happens when you post/mail something?
774 * Agent Variables::             Customizing is fun.
775 * Example Setup::               An example @file{~/.gnus.el} file for offline people.
776 * Batching Agents::             How to fetch news from a @code{cron} job.
777 * Agent Caveats::               What you think it'll do and what it does.
778
779 Agent Categories
780
781 * Category Syntax::             What a category looks like.
782 * Category Buffer::             A buffer for maintaining categories.
783 * Category Variables::          Customize'r'Us.
784
785 Agent Commands
786
787 * Group Agent Commands::        Configure groups and fetch their contents.
788 * Summary Agent Commands::      Manually select then fetch specific articles.
789 * Server Agent Commands::       Select the servers that are supported by the agent.
790
791 Scoring
792
793 * Summary Score Commands::      Adding score entries for the current group.
794 * Group Score Commands::        General score commands.
795 * Score Variables::             Customize your scoring.  (My, what terminology).
796 * Score File Format::           What a score file may contain.
797 * Score File Editing::          You can edit score files by hand as well.
798 * Adaptive Scoring::            Big Sister Gnus knows what you read.
799 * Home Score File::             How to say where new score entries are to go.
800 * Followups To Yourself::       Having Gnus notice when people answer you.
801 * Scoring On Other Headers::    Scoring on non-standard headers.
802 * Scoring Tips::                How to score effectively.
803 * Reverse Scoring::             That problem child of old is not problem.
804 * Global Score Files::          Earth-spanning, ear-splitting score files.
805 * Kill Files::                  They are still here, but they can be ignored.
806 * Converting Kill Files::       Translating kill files to score files.
807 * Advanced Scoring::            Using logical expressions to build score rules.
808 * Score Decays::                It can be useful to let scores wither away.
809
810 Advanced Scoring
811
812 * Advanced Scoring Syntax::     A definition.
813 * Advanced Scoring Examples::   What they look like.
814 * Advanced Scoring Tips::       Getting the most out of it.
815
816 Various
817
818 * Process/Prefix::              A convention used by many treatment commands.
819 * Interactive::                 Making Gnus ask you many questions.
820 * Symbolic Prefixes::           How to supply some Gnus functions with options.
821 * Formatting Variables::        You can specify what buffers should look like.
822 * Window Layout::               Configuring the Gnus buffer windows.
823 * Faces and Fonts::             How to change how faces look.
824 * Compilation::                 How to speed Gnus up.
825 * Mode Lines::                  Displaying information in the mode lines.
826 * Highlighting and Menus::      Making buffers look all nice and cozy.
827 * Buttons::                     Get tendinitis in ten easy steps!
828 * Daemons::                     Gnus can do things behind your back.
829 * NoCeM::                       How to avoid spam and other fatty foods.
830 * Undo::                        Some actions can be undone.
831 * Predicate Specifiers::        Specifying predicates.
832 * Moderation::                  What to do if you're a moderator.
833 * Image Enhancements::          Modern versions of Emacs/XEmacs can display images.
834 * Fuzzy Matching::              What's the big fuzz?
835 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
836 * Other modes::                 Interaction with other modes.
837 * Various Various::             Things that are really various.
838
839 Formatting Variables
840
841 * Formatting Basics::           A formatting variable is basically a format string.
842 * Mode Line Formatting::        Some rules about mode line formatting variables.
843 * Advanced Formatting::         Modifying output in various ways.
844 * User-Defined Specs::          Having Gnus call your own functions.
845 * Formatting Fonts::            Making the formatting look colorful and nice.
846 * Positioning Point::           Moving point to a position after an operation.
847 * Tabulation::                  Tabulating your output.
848 * Wide Characters::             Dealing with wide characters.
849
850 Image Enhancements
851
852 * X-Face::                      Display a funky, teensy black-and-white image.
853 * Face::                        Display a funkier, teensier colored image.
854 * Smileys::                     Show all those happy faces the way they were meant to be shown.
855 * Picons::                      How to display pictures of what you're reading.
856 * XVarious::                    Other XEmacsy Gnusey variables.
857
858 Thwarting Email Spam
859
860 * The problem of spam::         Some background, and some solutions
861 * Anti-Spam Basics::            Simple steps to reduce the amount of spam.
862 * SpamAssassin::                How to use external anti-spam tools.
863 * Hashcash::                    Reduce spam by burning CPU time.
864 * Filtering Spam Using The Spam ELisp Package::
865 * Filtering Spam Using Statistics with spam-stat::
866
867 Filtering Spam Using The Spam ELisp Package
868
869 * Spam ELisp Package Sequence of Events::  
870 * Spam ELisp Package Filtering of Incoming Mail::  
871 * Spam ELisp Package Global Variables::  
872 * Spam ELisp Package Configuration Examples::  
873 * Blacklists and Whitelists::   
874 * BBDB Whitelists::             
875 * Gmane Spam Reporting::        
876 * Anti-spam Hashcash Payments::  
877 * Blackholes::                  
878 * Regular Expressions Header Matching::  
879 * Bogofilter::                  
880 * ifile spam filtering::        
881 * spam-stat spam filtering::    
882 * SpamOracle::                  
883 * Extending the Spam ELisp package::  
884
885 Filtering Spam Using Statistics with spam-stat
886
887 * Creating a spam-stat dictionary::
888 * Splitting mail using spam-stat::
889 * Low-level interface to the spam-stat dictionary::
890
891 Appendices
892
893 * XEmacs::                      Requirements for installing under XEmacs.
894 * History::                     How Gnus got where it is today.
895 * On Writing Manuals::          Why this is not a beginner's guide.
896 * Terminology::                 We use really difficult, like, words here.
897 * Customization::               Tailoring Gnus to your needs.
898 * Troubleshooting::             What you might try if things do not work.
899 * Gnus Reference Guide::        Rilly, rilly technical stuff.
900 * Emacs for Heathens::          A short introduction to Emacsian terms.
901 * Frequently Asked Questions::  The Gnus FAQ
902
903 History
904
905 * Gnus Versions::               What Gnus versions have been released.
906 * Other Gnus Versions::         Other Gnus versions that also have been released.
907 * Why?::                        What's the point of Gnus?
908 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
909 * Conformity::                  Gnus tries to conform to all standards.
910 * Emacsen::                     Gnus can be run on a few modern Emacsen.
911 * Gnus Development::            How Gnus is developed.
912 * Contributors::                Oodles of people.
913 * New Features::                Pointers to some of the new stuff in Gnus.
914
915 New Features
916
917 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
918 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
919 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
920 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
921 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
922 * Oort Gnus::                   It's big.  It's far out.  Gnus 5.10.
923 * No Gnus::                     Lars, FIXME!
924
925 Customization
926
927 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
928 * Slow Terminal Connection::    You run a remote Emacs.
929 * Little Disk Space::           You feel that having large setup files is icky.
930 * Slow Machine::                You feel like buying a faster machine.
931
932 Gnus Reference Guide
933
934 * Gnus Utility Functions::      Common functions and variable to use.
935 * Back End Interface::          How Gnus communicates with the servers.
936 * Score File Syntax::           A BNF definition of the score file standard.
937 * Headers::                     How Gnus stores headers internally.
938 * Ranges::                      A handy format for storing mucho numbers.
939 * Group Info::                  The group info format.
940 * Extended Interactive::        Symbolic prefixes and stuff.
941 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
942 * Various File Formats::        Formats of files that Gnus use.
943
944 Back End Interface
945
946 * Required Back End Functions::  Functions that must be implemented.
947 * Optional Back End Functions::  Functions that need not be implemented.
948 * Error Messaging::             How to get messages and report errors.
949 * Writing New Back Ends::       Extending old back ends.
950 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
951 * Mail-like Back Ends::         Some tips on mail back ends.
952
953 Various File Formats
954
955 * Active File Format::          Information on articles and groups available.
956 * Newsgroups File Format::      Group descriptions.
957
958 Emacs for Heathens
959
960 * Keystrokes::                  Entering text and executing commands.
961 * Emacs Lisp::                  The built-in Emacs programming language.
962
963 @end detailmenu
964 @end menu
965
966 @node Starting Up
967 @chapter Starting Gnus
968 @cindex starting up
969
970 @kindex M-x gnus
971 @findex gnus
972 If your system administrator has set things up properly, starting Gnus
973 and reading news is extremely easy---you just type @kbd{M-x gnus} in
974 your Emacs.
975
976 @findex gnus-other-frame
977 @kindex M-x gnus-other-frame
978 If you want to start Gnus in a different frame, you can use the command
979 @kbd{M-x gnus-other-frame} instead.
980
981 If things do not go smoothly at startup, you have to twiddle some
982 variables in your @file{~/.gnus.el} file.  This file is similar to
983 @file{~/.emacs}, but is read when Gnus starts.
984
985 If you puzzle at any terms used in this manual, please refer to the
986 terminology section (@pxref{Terminology}).
987
988 @menu
989 * Finding the News::            Choosing a method for getting news.
990 * The First Time::              What does Gnus do the first time you start it?
991 * The Server is Down::          How can I read my mail then?
992 * Slave Gnusae::                You can have more than one Gnus active at a time.
993 * Fetching a Group::            Starting Gnus just to read a group.
994 * New Groups::                  What is Gnus supposed to do with new groups?
995 * Changing Servers::            You may want to move from one server to another.
996 * Startup Files::               Those pesky startup files---@file{.newsrc}.
997 * Auto Save::                   Recovering from a crash.
998 * The Active File::             Reading the active file over a slow line Takes Time.
999 * Startup Variables::           Other variables you might change.
1000 @end menu
1001
1002
1003 @node Finding the News
1004 @section Finding the News
1005 @cindex finding news
1006
1007 @vindex gnus-select-method
1008 @c @head
1009 The @code{gnus-select-method} variable says where Gnus should look for
1010 news.  This variable should be a list where the first element says
1011 @dfn{how} and the second element says @dfn{where}.  This method is your
1012 native method.  All groups not fetched with this method are
1013 foreign groups.
1014
1015 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1016 you want to get your daily dosage of news from, you'd say:
1017
1018 @lisp
1019 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1020 @end lisp
1021
1022 If you want to read directly from the local spool, say:
1023
1024 @lisp
1025 (setq gnus-select-method '(nnspool ""))
1026 @end lisp
1027
1028 If you can use a local spool, you probably should, as it will almost
1029 certainly be much faster.  But do not use the local spool if your
1030 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1031
1032 @vindex gnus-nntpserver-file
1033 @cindex NNTPSERVER
1034 @cindex @acronym{NNTP} server
1035 If this variable is not set, Gnus will take a look at the
1036 @env{NNTPSERVER} environment variable.  If that variable isn't set,
1037 Gnus will see whether @code{gnus-nntpserver-file}
1038 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1039 If that fails as well, Gnus will try to use the machine running Emacs
1040 as an @acronym{NNTP} server.  That's a long shot, though.
1041
1042 @vindex gnus-nntp-server
1043 If @code{gnus-nntp-server} is set, this variable will override
1044 @code{gnus-select-method}.  You should therefore set
1045 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1046
1047 @vindex gnus-secondary-servers
1048 @vindex gnus-nntp-server
1049 You can also make Gnus prompt you interactively for the name of an
1050 @acronym{NNTP} server.  If you give a non-numerical prefix to @code{gnus}
1051 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1052 in the @code{gnus-secondary-servers} list (if any).  You can also just
1053 type in the name of any server you feel like visiting.  (Note that this
1054 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1055 gnus} later in the same Emacs session, Gnus will contact the same
1056 server.)
1057
1058 @findex gnus-group-browse-foreign-server
1059 @kindex B (Group)
1060 However, if you use one @acronym{NNTP} server regularly and are just
1061 interested in a couple of groups from a different server, you would be
1062 better served by using the @kbd{B} command in the group buffer.  It will
1063 let you have a look at what groups are available, and you can subscribe
1064 to any of the groups you want to.  This also makes @file{.newsrc}
1065 maintenance much tidier.  @xref{Foreign Groups}.
1066
1067 @vindex gnus-secondary-select-methods
1068 @c @head
1069 A slightly different approach to foreign groups is to set the
1070 @code{gnus-secondary-select-methods} variable.  The select methods
1071 listed in this variable are in many ways just as native as the
1072 @code{gnus-select-method} server.  They will also be queried for active
1073 files during startup (if that's required), and new newsgroups that
1074 appear on these servers will be subscribed (or not) just as native
1075 groups are.
1076
1077 For instance, if you use the @code{nnmbox} back end to read your mail,
1078 you would typically set this variable to
1079
1080 @lisp
1081 (setq gnus-secondary-select-methods '((nnmbox "")))
1082 @end lisp
1083
1084
1085 @node The First Time
1086 @section The First Time
1087 @cindex first time usage
1088
1089 If no startup files exist, Gnus will try to determine what groups should
1090 be subscribed by default.
1091
1092 @vindex gnus-default-subscribed-newsgroups
1093 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1094 will subscribe you to just those groups in that list, leaving the rest
1095 killed.  Your system administrator should have set this variable to
1096 something useful.
1097
1098 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1099 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
1100 here as @dfn{whatever Lars thinks you should read}.)
1101
1102 You'll also be subscribed to the Gnus documentation group, which should
1103 help you with most common problems.
1104
1105 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1106 use the normal functions for handling new groups, and not do anything
1107 special.
1108
1109
1110 @node The Server is Down
1111 @section The Server is Down
1112 @cindex server errors
1113
1114 If the default server is down, Gnus will understandably have some
1115 problems starting.  However, if you have some mail groups in addition to
1116 the news groups, you may want to start Gnus anyway.
1117
1118 Gnus, being the trusting sort of program, will ask whether to proceed
1119 without a native select method if that server can't be contacted.  This
1120 will happen whether the server doesn't actually exist (i.e., you have
1121 given the wrong address) or the server has just momentarily taken ill
1122 for some reason or other.  If you decide to continue and have no foreign
1123 groups, you'll find it difficult to actually do anything in the group
1124 buffer.  But, hey, that's your problem.  Blllrph!
1125
1126 @findex gnus-no-server
1127 @kindex M-x gnus-no-server
1128 @c @head
1129 If you know that the server is definitely down, or you just want to read
1130 your mail without bothering with the server at all, you can use the
1131 @code{gnus-no-server} command to start Gnus.  That might come in handy
1132 if you're in a hurry as well.  This command will not attempt to contact
1133 your primary server---instead, it will just activate all groups on level
1134 1 and 2.  (You should preferably keep no native groups on those two
1135 levels.) Also @pxref{Group Levels}.
1136
1137
1138 @node Slave Gnusae
1139 @section Slave Gnusae
1140 @cindex slave
1141
1142 You might want to run more than one Emacs with more than one Gnus at the
1143 same time.  If you are using different @file{.newsrc} files (e.g., if you
1144 are using the two different Gnusae to read from two different servers),
1145 that is no problem whatsoever.  You just do it.
1146
1147 The problem appears when you want to run two Gnusae that use the same
1148 @file{.newsrc} file.
1149
1150 To work around that problem some, we here at the Think-Tank at the Gnus
1151 Towers have come up with a new concept: @dfn{Masters} and
1152 @dfn{slaves}.  (We have applied for a patent on this concept, and have
1153 taken out a copyright on those words.  If you wish to use those words in
1154 conjunction with each other, you have to send $1 per usage instance to
1155 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
1156 Applications}) will be much more expensive, of course.)
1157
1158 @findex gnus-slave
1159 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1160 however you do it).  Each subsequent slave Gnusae should be started with
1161 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
1162 files, but instead save @dfn{slave files} that contain information only
1163 on what groups have been read in the slave session.  When a master Gnus
1164 starts, it will read (and delete) these slave files, incorporating all
1165 information from them.  (The slave files will be read in the sequence
1166 they were created, so the latest changes will have precedence.)
1167
1168 Information from the slave files has, of course, precedence over the
1169 information in the normal (i.e., master) @file{.newsrc} file.
1170
1171 If the @file{.newsrc*} files have not been saved in the master when the
1172 slave starts, you may be prompted as to whether to read an auto-save
1173 file.  If you answer ``yes'', the unsaved changes to the master will be
1174 incorporated into the slave.  If you answer ``no'', the slave may see some
1175 messages as unread that have been read in the master.
1176
1177 @node Fetching a Group
1178 @section Fetching a Group
1179 @cindex fetching a group
1180
1181 @findex gnus-fetch-group
1182 It is sometimes convenient to be able to just say ``I want to read this
1183 group and I don't care whether Gnus has been started or not''.  This is
1184 perhaps more useful for people who write code than for users, but the
1185 command @code{gnus-fetch-group} provides this functionality in any case.
1186 It takes the group name as a parameter.
1187
1188
1189 @node New Groups
1190 @section New Groups
1191 @cindex new groups
1192 @cindex subscription
1193
1194 @vindex gnus-check-new-newsgroups
1195 If you are satisfied that you really never want to see any new groups,
1196 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
1197 also save you some time at startup.  Even if this variable is
1198 @code{nil}, you can always subscribe to the new groups just by pressing
1199 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
1200 is @code{ask-server} by default.  If you set this variable to
1201 @code{always}, then Gnus will query the back ends for new groups even
1202 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1203
1204 @menu
1205 * Checking New Groups::         Determining what groups are new.
1206 * Subscription Methods::        What Gnus should do with new groups.
1207 * Filtering New Groups::        Making Gnus ignore certain new groups.
1208 @end menu
1209
1210
1211 @node Checking New Groups
1212 @subsection Checking New Groups
1213
1214 Gnus normally determines whether a group is new or not by comparing the
1215 list of groups from the active file(s) with the lists of subscribed and
1216 dead groups.  This isn't a particularly fast method.  If
1217 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1218 server for new groups since the last time.  This is both faster and
1219 cheaper.  This also means that you can get rid of the list of killed
1220 groups altogether, so you may set @code{gnus-save-killed-list} to
1221 @code{nil}, which will save time both at startup, at exit, and all over.
1222 Saves disk space, too.  Why isn't this the default, then?
1223 Unfortunately, not all servers support this command.
1224
1225 I bet I know what you're thinking now: How do I find out whether my
1226 server supports @code{ask-server}?  No?  Good, because I don't have a
1227 fail-safe answer.  I would suggest just setting this variable to
1228 @code{ask-server} and see whether any new groups appear within the next
1229 few days.  If any do, then it works.  If none do, then it doesn't
1230 work.  I could write a function to make Gnus guess whether the server
1231 supports @code{ask-server}, but it would just be a guess.  So I won't.
1232 You could @code{telnet} to the server and say @code{HELP} and see
1233 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
1234 it does, then it might work.  (But there are servers that lists
1235 @samp{NEWGROUPS} without supporting the function properly.)
1236
1237 This variable can also be a list of select methods.  If so, Gnus will
1238 issue an @code{ask-server} command to each of the select methods, and
1239 subscribe them (or not) using the normal methods.  This might be handy
1240 if you are monitoring a few servers for new groups.  A side effect is
1241 that startup will take much longer, so you can meditate while waiting.
1242 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1243
1244
1245 @node Subscription Methods
1246 @subsection Subscription Methods
1247
1248 @vindex gnus-subscribe-newsgroup-method
1249 What Gnus does when it encounters a new group is determined by the
1250 @code{gnus-subscribe-newsgroup-method} variable.
1251
1252 This variable should contain a function.  This function will be called
1253 with the name of the new group as the only parameter.
1254
1255 Some handy pre-fab functions are:
1256
1257 @table @code
1258
1259 @item gnus-subscribe-zombies
1260 @vindex gnus-subscribe-zombies
1261 Make all new groups zombies.  This is the default.  You can browse the
1262 zombies later (with @kbd{A z}) and either kill them all off properly
1263 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1264
1265 @item gnus-subscribe-randomly
1266 @vindex gnus-subscribe-randomly
1267 Subscribe all new groups in arbitrary order.  This really means that all
1268 new groups will be added at ``the top'' of the group buffer.
1269
1270 @item gnus-subscribe-alphabetically
1271 @vindex gnus-subscribe-alphabetically
1272 Subscribe all new groups in alphabetical order.
1273
1274 @item gnus-subscribe-hierarchically
1275 @vindex gnus-subscribe-hierarchically
1276 Subscribe all new groups hierarchically.  The difference between this
1277 function and @code{gnus-subscribe-alphabetically} is slight.
1278 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1279 alphabetical fashion, while this function will enter groups into its
1280 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
1281 @samp{comp} hierarchy, this function will not mess that configuration
1282 up.  Or something like that.
1283
1284 @item gnus-subscribe-interactively
1285 @vindex gnus-subscribe-interactively
1286 Subscribe new groups interactively.  This means that Gnus will ask
1287 you about @strong{all} new groups.  The groups you choose to subscribe
1288 to will be subscribed hierarchically.
1289
1290 @item gnus-subscribe-killed
1291 @vindex gnus-subscribe-killed
1292 Kill all new groups.
1293
1294 @item gnus-subscribe-topics
1295 @vindex gnus-subscribe-topics
1296 Put the groups into the topic that has a matching @code{subscribe} topic
1297 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
1298 topic parameter that looks like
1299
1300 @example
1301 "nnslashdot"
1302 @end example
1303
1304 will mean that all groups that match that regex will be subscribed under
1305 that topic.
1306
1307 If no topics match the groups, the groups will be subscribed in the
1308 top-level topic.
1309
1310 @end table
1311
1312 @vindex gnus-subscribe-hierarchical-interactive
1313 A closely related variable is
1314 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
1315 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
1316 hierarchical fashion whether to subscribe to new groups or not.  Gnus
1317 will ask you for each sub-hierarchy whether you want to descend the
1318 hierarchy or not.
1319
1320 One common mistake is to set the variable a few paragraphs above
1321 (@code{gnus-subscribe-newsgroup-method}) to
1322 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
1323 will not work.  This is ga-ga.  So don't do it.
1324
1325
1326 @node Filtering New Groups
1327 @subsection Filtering New Groups
1328
1329 A nice and portable way to control which new newsgroups should be
1330 subscribed (or ignored) is to put an @dfn{options} line at the start of
1331 the @file{.newsrc} file.  Here's an example:
1332
1333 @example
1334 options -n !alt.all !rec.all sci.all
1335 @end example
1336
1337 @vindex gnus-subscribe-options-newsgroup-method
1338 This line obviously belongs to a serious-minded intellectual scientific
1339 person (or she may just be plain old boring), because it says that all
1340 groups that have names beginning with @samp{alt} and @samp{rec} should
1341 be ignored, and all groups with names beginning with @samp{sci} should
1342 be subscribed.  Gnus will not use the normal subscription method for
1343 subscribing these groups.
1344 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
1345 variable defaults to @code{gnus-subscribe-alphabetically}.
1346
1347 @vindex gnus-options-not-subscribe
1348 @vindex gnus-options-subscribe
1349 If you don't want to mess with your @file{.newsrc} file, you can just
1350 set the two variables @code{gnus-options-subscribe} and
1351 @code{gnus-options-not-subscribe}.  These two variables do exactly the
1352 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
1353 and if the new group matches the former, it will be unconditionally
1354 subscribed, and if it matches the latter, it will be ignored.
1355
1356 @vindex gnus-auto-subscribed-groups
1357 Yet another variable that meddles here is
1358 @code{gnus-auto-subscribed-groups}.  It works exactly like
1359 @code{gnus-options-subscribe}, and is therefore really superfluous,
1360 but I thought it would be nice to have two of these.  This variable is
1361 more meant for setting some ground rules, while the other variable is
1362 used more for user fiddling.  By default this variable makes all new
1363 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1364 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1365 subscribed.  If you don't like that, just set this variable to
1366 @code{nil}.
1367
1368 New groups that match this regexp are subscribed using
1369 @code{gnus-subscribe-options-newsgroup-method}.
1370
1371
1372 @node Changing Servers
1373 @section Changing Servers
1374 @cindex changing servers
1375
1376 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1377 This happens very rarely, but perhaps you change jobs, or one server is
1378 very flaky and you want to use another.
1379
1380 Changing the server is pretty easy, right?  You just change
1381 @code{gnus-select-method} to point to the new server?
1382
1383 @emph{Wrong!}
1384
1385 Article numbers are not (in any way) kept synchronized between different
1386 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1387 you have read is by keeping track of article numbers.  So when you
1388 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1389 worthless.
1390
1391 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1392 file from one server to another.  They all have one thing in
1393 common---they take a looong time to run.  You don't want to use these
1394 functions more than absolutely necessary.
1395
1396 @kindex M-x gnus-change-server
1397 @findex gnus-change-server
1398 If you have access to both servers, Gnus can request the headers for all
1399 the articles you have read and compare @code{Message-ID}s and map the
1400 article numbers of the read articles and article marks.  The @kbd{M-x
1401 gnus-change-server} command will do this for all your native groups.  It
1402 will prompt for the method you want to move to.
1403
1404 @kindex M-x gnus-group-move-group-to-server
1405 @findex gnus-group-move-group-to-server
1406 You can also move individual groups with the @kbd{M-x
1407 gnus-group-move-group-to-server} command.  This is useful if you want to
1408 move a (foreign) group from one server to another.
1409
1410 @kindex M-x gnus-group-clear-data-on-native-groups
1411 @findex gnus-group-clear-data-on-native-groups
1412 If you don't have access to both the old and new server, all your marks
1413 and read ranges have become worthless.  You can use the @kbd{M-x
1414 gnus-group-clear-data-on-native-groups} command to clear out all data
1415 that you have on your native groups.  Use with caution.
1416
1417 @kindex M-x gnus-group-clear-data
1418 @findex gnus-group-clear-data
1419 Clear the data from the current group only---nix out marks and the
1420 list of read articles (@code{gnus-group-clear-data}).
1421
1422 After changing servers, you @strong{must} move the cache hierarchy away,
1423 since the cached articles will have wrong article numbers, which will
1424 affect which articles Gnus thinks are read.
1425 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1426 to have it done automatically; for @code{gnus-group-clear-data}, you
1427 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1428 cache for all groups).
1429
1430
1431 @node Startup Files
1432 @section Startup Files
1433 @cindex startup files
1434 @cindex .newsrc
1435 @cindex .newsrc.el
1436 @cindex .newsrc.eld
1437
1438 Now, you all know about the @file{.newsrc} file.  All subscription
1439 information is traditionally stored in this file.
1440
1441 Things got a bit more complicated with @sc{gnus}.  In addition to
1442 keeping the @file{.newsrc} file updated, it also used a file called
1443 @file{.newsrc.el} for storing all the information that didn't fit into
1444 the @file{.newsrc} file.  (Actually, it also duplicated everything in
1445 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
1446 files was the most recently saved, which enabled people to swap between
1447 @sc{gnus} and other newsreaders.
1448
1449 That was kinda silly, so Gnus went one better: In addition to the
1450 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1451 @file{.newsrc.eld}.  It will read whichever of these files that are most
1452 recent, but it will never write a @file{.newsrc.el} file.  You should
1453 never delete the @file{.newsrc.eld} file---it contains much information
1454 not stored in the @file{.newsrc} file.
1455
1456 @vindex gnus-save-newsrc-file
1457 @vindex gnus-read-newsrc-file
1458 You can turn off writing the @file{.newsrc} file by setting
1459 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1460 the file and save some space, as well as exiting from Gnus faster.
1461 However, this will make it impossible to use other newsreaders than
1462 Gnus.  But hey, who would want to, right?  Similarly, setting
1463 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1464 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1465 convenient if you have a tendency to use Netscape once in a while.
1466
1467 @vindex gnus-save-killed-list
1468 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1469 will not save the list of killed groups to the startup file.  This will
1470 save both time (when starting and quitting) and space (on disk).  It
1471 will also mean that Gnus has no record of what groups are new or old,
1472 so the automatic new groups subscription methods become meaningless.
1473 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1474 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1475 Groups}).  This variable can also be a regular expression.  If that's
1476 the case, remove all groups that do not match this regexp before
1477 saving.  This can be useful in certain obscure situations that involve
1478 several servers where not all servers support @code{ask-server}.
1479
1480 @vindex gnus-startup-file
1481 @vindex gnus-backup-startup-file
1482 @vindex version-control
1483 The @code{gnus-startup-file} variable says where the startup files are.
1484 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1485 file being whatever that one is, with a @samp{.eld} appended.
1486 If you want version control for this file, set
1487 @code{gnus-backup-startup-file}.  It respects the same values as the
1488 @code{version-control} variable.
1489
1490 @vindex gnus-save-newsrc-hook
1491 @vindex gnus-save-quick-newsrc-hook
1492 @vindex gnus-save-standard-newsrc-hook
1493 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1494 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1495 saving the @file{.newsrc.eld} file, and
1496 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1497 @file{.newsrc} file.  The latter two are commonly used to turn version
1498 control on or off.  Version control is on by default when saving the
1499 startup files.  If you want to turn backup creation off, say something like:
1500
1501 @lisp
1502 (defun turn-off-backup ()
1503   (set (make-local-variable 'backup-inhibited) t))
1504
1505 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1506 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1507 @end lisp
1508
1509 @vindex gnus-init-file
1510 @vindex gnus-site-init-file
1511 When Gnus starts, it will read the @code{gnus-site-init-file}
1512 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1513 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
1514 and can be used to avoid cluttering your @file{~/.emacs} and
1515 @file{site-init} files with Gnus stuff.  Gnus will also check for files
1516 with the same names as these, but with @file{.elc} and @file{.el}
1517 suffixes.  In other words, if you have set @code{gnus-init-file} to
1518 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1519 and finally @file{~/.gnus} (in this order).
1520
1521
1522
1523 @node Auto Save
1524 @section Auto Save
1525 @cindex dribble file
1526 @cindex auto-save
1527
1528 Whenever you do something that changes the Gnus data (reading articles,
1529 catching up, killing/subscribing groups), the change is added to a
1530 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
1531 Emacs way.  If your Emacs should crash before you have saved the
1532 @file{.newsrc} files, all changes you have made can be recovered from
1533 this file.
1534
1535 If Gnus detects this file at startup, it will ask the user whether to
1536 read it.  The auto save file is deleted whenever the real startup file is
1537 saved.
1538
1539 @vindex gnus-use-dribble-file
1540 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1541 maintain a dribble buffer.  The default is @code{t}.
1542
1543 @vindex gnus-dribble-directory
1544 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
1545 this variable is @code{nil}, which it is by default, Gnus will dribble
1546 into the directory where the @file{.newsrc} file is located.  (This is
1547 normally the user's home directory.)  The dribble file will get the same
1548 file permissions as the @file{.newsrc} file.
1549
1550 @vindex gnus-always-read-dribble-file
1551 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1552 read the dribble file on startup without querying the user.
1553
1554
1555 @node The Active File
1556 @section The Active File
1557 @cindex active file
1558 @cindex ignored groups
1559
1560 When Gnus starts, or indeed whenever it tries to determine whether new
1561 articles have arrived, it reads the active file.  This is a very large
1562 file that lists all the active groups and articles on the server.
1563
1564 @vindex gnus-ignored-newsgroups
1565 Before examining the active file, Gnus deletes all lines that match the
1566 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
1567 any groups with bogus names, but you can use this variable to make Gnus
1568 ignore hierarchies you aren't ever interested in.  However, this is not
1569 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
1570 Groups} for an overview of other variables that can be used instead.
1571
1572 @c This variable is
1573 @c @code{nil} by default, and will slow down active file handling somewhat
1574 @c if you set it to anything else.
1575
1576 @vindex gnus-read-active-file
1577 @c @head
1578 The active file can be rather Huge, so if you have a slow network, you
1579 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1580 reading the active file.  This variable is @code{some} by default.
1581
1582 Gnus will try to make do by getting information just on the groups that
1583 you actually subscribe to.
1584
1585 Note that if you subscribe to lots and lots of groups, setting this
1586 variable to @code{nil} will probably make Gnus slower, not faster.  At
1587 present, having this variable @code{nil} will slow Gnus down
1588 considerably, unless you read news over a 2400 baud modem.
1589
1590 This variable can also have the value @code{some}.  Gnus will then
1591 attempt to read active info only on the subscribed groups.  On some
1592 servers this is quite fast (on sparkling, brand new INN servers that
1593 support the @code{LIST ACTIVE group} command), on others this isn't fast
1594 at all.  In any case, @code{some} should be faster than @code{nil}, and
1595 is certainly faster than @code{t} over slow lines.
1596
1597 Some news servers (old versions of Leafnode and old versions of INN, for
1598 instance) do not support the @code{LIST ACTIVE group}.  For these
1599 servers, @code{nil} is probably the most efficient value for this
1600 variable.
1601
1602 If this variable is @code{nil}, Gnus will ask for group info in total
1603 lock-step, which isn't very fast.  If it is @code{some} and you use an
1604 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1605 read all the replies in one swoop.  This will normally result in better
1606 performance, but if the server does not support the aforementioned
1607 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1608
1609 If you think that starting up Gnus takes too long, try all the three
1610 different values for this variable and see what works best for you.
1611
1612 In any case, if you use @code{some} or @code{nil}, you should definitely
1613 kill all groups that you aren't interested in to speed things up.
1614
1615 Note that this variable also affects active file retrieval from
1616 secondary select methods.
1617
1618
1619 @node Startup Variables
1620 @section Startup Variables
1621
1622 @table @code
1623
1624 @item gnus-load-hook
1625 @vindex gnus-load-hook
1626 A hook run while Gnus is being loaded.  Note that this hook will
1627 normally be run just once in each Emacs session, no matter how many
1628 times you start Gnus.
1629
1630 @item gnus-before-startup-hook
1631 @vindex gnus-before-startup-hook
1632 A hook run after starting up Gnus successfully.
1633
1634 @item gnus-startup-hook
1635 @vindex gnus-startup-hook
1636 A hook run as the very last thing after starting up Gnus
1637
1638 @item gnus-started-hook
1639 @vindex gnus-started-hook
1640 A hook that is run as the very last thing after starting up Gnus
1641 successfully.
1642
1643 @item gnus-setup-news-hook
1644 @vindex gnus-setup-news-hook
1645 A hook that is run after reading the @file{.newsrc} file(s), but before
1646 generating the group buffer.
1647
1648 @item gnus-check-bogus-newsgroups
1649 @vindex gnus-check-bogus-newsgroups
1650 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1651 startup.  A @dfn{bogus group} is a group that you have in your
1652 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1653 bogus groups can take quite a while, so to save time and resources it's
1654 best to leave this option off, and do the checking for bogus groups once
1655 in a while from the group buffer instead (@pxref{Group Maintenance}).
1656
1657 @item gnus-inhibit-startup-message
1658 @vindex gnus-inhibit-startup-message
1659 If non-@code{nil}, the startup message won't be displayed.  That way,
1660 your boss might not notice as easily that you are reading news instead
1661 of doing your job.  Note that this variable is used before
1662 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1663
1664 @item gnus-no-groups-message
1665 @vindex gnus-no-groups-message
1666 Message displayed by Gnus when no groups are available.
1667
1668 @item gnus-play-startup-jingle
1669 @vindex gnus-play-startup-jingle
1670 If non-@code{nil}, play the Gnus jingle at startup.
1671
1672 @item gnus-startup-jingle
1673 @vindex gnus-startup-jingle
1674 Jingle to be played if the above variable is non-@code{nil}.  The
1675 default is @samp{Tuxedomoon.Jingle4.au}.
1676
1677 @end table
1678
1679
1680 @node Group Buffer
1681 @chapter Group Buffer
1682 @cindex group buffer
1683
1684 @c Alex Schroeder suggests to rearrange this as follows:
1685 @c
1686 @c <kensanata> ok, just save it for reference.  I'll go to bed in a minute.
1687 @c   1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1688 @c   4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1689 @c   7. Group Score, 8. Group Buffer Format
1690 @c <kensanata> Group Levels should have more information on levels 5 to 9.  I
1691 @c   suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1692 @c <kensanata> First, "Gnus considers groups... (default 9)."
1693 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1694 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1695 @c <kensanata> Then expand the next paragraph or add some more to it.
1696 @c    This short one sentence explains levels 1 and 2, therefore I understand
1697 @c    that I should keep important news at 3 and boring news at 4.
1698 @c    Say so!  Then go on to explain why I should bother with levels 6 to 9.
1699 @c    Maybe keep those that you don't want to read temporarily at 6,
1700 @c    those that you never want to read at 8, those that offend your
1701 @c    human rights at 9...
1702
1703
1704 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1705 is the first buffer shown when Gnus starts, and will never be killed as
1706 long as Gnus is active.
1707
1708 @iftex
1709 @iflatex
1710 \gnusfigure{The Group Buffer}{320}{
1711 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1712 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1713 \put(120,38){\vector(1,2){10}}
1714 \put(40,60){\makebox(0,0)[r]{Mode line}}
1715 \put(40,58){\vector(1,0){30}}
1716 \put(200,28){\makebox(0,0)[t]{Native select method}}
1717 \put(200,26){\vector(-1,2){15}}
1718 }
1719 @end iflatex
1720 @end iftex
1721
1722 @menu
1723 * Group Buffer Format::         Information listed and how you can change it.
1724 * Group Maneuvering::           Commands for moving in the group buffer.
1725 * Selecting a Group::           Actually reading news.
1726 * Subscription Commands::       Unsubscribing, killing, subscribing.
1727 * Group Data::                  Changing the info for a group.
1728 * Group Levels::                Levels? What are those, then?
1729 * Group Score::                 A mechanism for finding out what groups you like.
1730 * Marking Groups::              You can mark groups for later processing.
1731 * Foreign Groups::              Creating and editing groups.
1732 * Group Parameters::            Each group may have different parameters set.
1733 * Listing Groups::              Gnus can list various subsets of the groups.
1734 * Sorting Groups::              Re-arrange the group order.
1735 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
1736 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
1737 * Exiting Gnus::                Stop reading news and get some work done.
1738 * Group Topics::                A folding group mode divided into topics.
1739 * Misc Group Stuff::            Other stuff that you can to do.
1740 @end menu
1741
1742
1743 @node Group Buffer Format
1744 @section Group Buffer Format
1745
1746 @menu
1747 * Group Line Specification::    Deciding how the group buffer is to look.
1748 * Group Mode Line Specification::  The group buffer mode line.
1749 * Group Highlighting::          Having nice colors in the group buffer.
1750 @end menu
1751
1752
1753 @node Group Line Specification
1754 @subsection Group Line Specification
1755 @cindex group buffer format
1756
1757 The default format of the group buffer is nice and dull, but you can
1758 make it as exciting and ugly as you feel like.
1759
1760 Here's a couple of example group lines:
1761
1762 @example
1763      25: news.announce.newusers
1764  *    0: alt.fan.andrea-dworkin
1765 @end example
1766
1767 Quite simple, huh?
1768
1769 You can see that there are 25 unread articles in
1770 @samp{news.announce.newusers}.  There are no unread articles, but some
1771 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1772 asterisk at the beginning of the line?).
1773
1774 @vindex gnus-group-line-format
1775 You can change that format to whatever you want by fiddling with the
1776 @code{gnus-group-line-format} variable.  This variable works along the
1777 lines of a @code{format} specification, which is pretty much the same as
1778 a @code{printf} specifications, for those of you who use (feh!) C.
1779 @xref{Formatting Variables}.
1780
1781 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1782
1783 There should always be a colon on the line; the cursor always moves to
1784 the colon after performing an operation.  @xref{Positioning
1785 Point}.  Nothing else is required---not even the group name.  All
1786 displayed text is just window dressing, and is never examined by Gnus.
1787 Gnus stores all real information it needs using text properties.
1788
1789 (Note that if you make a really strange, wonderful, spreadsheet-like
1790 layout, everybody will believe you are hard at work with the accounting
1791 instead of wasting time reading news.)
1792
1793 Here's a list of all available format characters:
1794
1795 @table @samp
1796
1797 @item M
1798 An asterisk if the group only has marked articles.
1799
1800 @item S
1801 Whether the group is subscribed.
1802
1803 @item L
1804 Level of subscribedness.
1805
1806 @item N
1807 Number of unread articles.
1808
1809 @item I
1810 Number of dormant articles.
1811
1812 @item T
1813 Number of ticked articles.
1814
1815 @item R
1816 Number of read articles.
1817
1818 @item U
1819 Number of unseen articles.
1820
1821 @item t
1822 Estimated total number of articles.  (This is really @var{max-number}
1823 minus @var{min-number} plus 1.)
1824
1825 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1826 efficient access to @var{max-number} and @var{min-number} but getting
1827 the true unread message count is not possible efficiently.  For
1828 hysterical raisins, even the mail back ends, where the true number of
1829 unread messages might be available efficiently, use the same limited
1830 interface.  To remove this restriction from Gnus means that the back
1831 end interface has to be changed, which is not an easy job.  If you
1832 want to work on this, please contact the Gnus mailing list.
1833
1834 @item y
1835 Number of unread, unticked, non-dormant articles.
1836
1837 @item i
1838 Number of ticked and dormant articles.
1839
1840 @item g
1841 Full group name.
1842
1843 @item G
1844 Group name.
1845
1846 @item C
1847 Group comment (@pxref{Group Parameters}) or group name if there is no
1848 comment element in the group parameters.
1849
1850 @item D
1851 Newsgroup description.  You need to read the group descriptions
1852 before these will appear, and to do that, you either have to set
1853 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1854 command.
1855
1856 @item o
1857 @samp{m} if moderated.
1858
1859 @item O
1860 @samp{(m)} if moderated.
1861
1862 @item s
1863 Select method.
1864
1865 @item B
1866 If the summary buffer for the group is open or not.
1867
1868 @item n
1869 Select from where.
1870
1871 @item z
1872 A string that looks like @samp{<%s:%n>} if a foreign select method is
1873 used.
1874
1875 @item P
1876 Indentation based on the level of the topic (@pxref{Group Topics}).
1877
1878 @item c
1879 @vindex gnus-group-uncollapsed-levels
1880 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1881 variable says how many levels to leave at the end of the group name.
1882 The default is 1---this will mean that group names like
1883 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1884
1885 @item m
1886 @vindex gnus-new-mail-mark
1887 @cindex %
1888 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1889 the group lately.
1890
1891 @item p
1892 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1893
1894 @item d
1895 A string that says when you last read the group (@pxref{Group
1896 Timestamp}).
1897
1898 @item u
1899 User defined specifier.  The next character in the format string should
1900 be a letter.  Gnus will call the function
1901 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1902 following @samp{%u}.  The function will be passed a single dummy
1903 parameter as argument.  The function should return a string, which will
1904 be inserted into the buffer just like information from any other
1905 specifier.
1906 @end table
1907
1908 @cindex *
1909 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1910 if no info is available---for instance, if it is a non-activated foreign
1911 group, or a bogus native group.
1912
1913
1914 @node Group Mode Line Specification
1915 @subsection Group Mode Line Specification
1916 @cindex group mode line
1917
1918 @vindex gnus-group-mode-line-format
1919 The mode line can be changed by setting
1920 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1921 doesn't understand that many format specifiers:
1922
1923 @table @samp
1924 @item S
1925 The native news server.
1926 @item M
1927 The native select method.
1928 @end table
1929
1930
1931 @node Group Highlighting
1932 @subsection Group Highlighting
1933 @cindex highlighting
1934 @cindex group highlighting
1935
1936 @vindex gnus-group-highlight
1937 Highlighting in the group buffer is controlled by the
1938 @code{gnus-group-highlight} variable.  This is an alist with elements
1939 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1940 something non-@code{nil}, the @var{face} will be used on the line.
1941
1942 Here's an example value for this variable that might look nice if the
1943 background is dark:
1944
1945 @lisp
1946 (cond (window-system
1947        (setq custom-background-mode 'light)
1948        (defface my-group-face-1
1949          '((t (:foreground "Red" :bold t))) "First group face")
1950        (defface my-group-face-2
1951          '((t (:foreground "DarkSeaGreen4" :bold t)))
1952          "Second group face")
1953        (defface my-group-face-3
1954          '((t (:foreground "Green4" :bold t))) "Third group face")
1955        (defface my-group-face-4
1956          '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1957        (defface my-group-face-5
1958          '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1959
1960 (setq gnus-group-highlight
1961       '(((> unread 200) . my-group-face-1)
1962         ((and (< level 3) (zerop unread)) . my-group-face-2)
1963         ((< level 3) . my-group-face-3)
1964         ((zerop unread) . my-group-face-4)
1965         (t . my-group-face-5)))
1966 @end lisp
1967
1968 Also @pxref{Faces and Fonts}.
1969
1970 Variables that are dynamically bound when the forms are evaluated
1971 include:
1972
1973 @table @code
1974 @item group
1975 The group name.
1976 @item unread
1977 The number of unread articles in the group.
1978 @item method
1979 The select method.
1980 @item mailp
1981 Whether the group is a mail group.
1982 @item level
1983 The level of the group.
1984 @item score
1985 The score of the group.
1986 @item ticked
1987 The number of ticked articles in the group.
1988 @item total
1989 The total number of articles in the group.  Or rather,
1990 @var{max-number} minus @var{min-number} plus one.
1991 @item topic
1992 When using the topic minor mode, this variable is bound to the current
1993 topic being inserted.
1994 @end table
1995
1996 When the forms are @code{eval}ed, point is at the beginning of the line
1997 of the group in question, so you can use many of the normal Gnus
1998 functions for snarfing info on the group.
1999
2000 @vindex gnus-group-update-hook
2001 @findex gnus-group-highlight-line
2002 @code{gnus-group-update-hook} is called when a group line is changed.
2003 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
2004 calls @code{gnus-group-highlight-line} by default.
2005
2006
2007 @node Group Maneuvering
2008 @section Group Maneuvering
2009 @cindex group movement
2010
2011 All movement commands understand the numeric prefix and will behave as
2012 expected, hopefully.
2013
2014 @table @kbd
2015
2016 @item n
2017 @kindex n (Group)
2018 @findex gnus-group-next-unread-group
2019 Go to the next group that has unread articles
2020 (@code{gnus-group-next-unread-group}).
2021
2022 @item p
2023 @itemx DEL
2024 @kindex DEL (Group)
2025 @kindex p (Group)
2026 @findex gnus-group-prev-unread-group
2027 Go to the previous group that has unread articles
2028 (@code{gnus-group-prev-unread-group}).
2029
2030 @item N
2031 @kindex N (Group)
2032 @findex gnus-group-next-group
2033 Go to the next group (@code{gnus-group-next-group}).
2034
2035 @item P
2036 @kindex P (Group)
2037 @findex gnus-group-prev-group
2038 Go to the previous group (@code{gnus-group-prev-group}).
2039
2040 @item M-n
2041 @kindex M-n (Group)
2042 @findex gnus-group-next-unread-group-same-level
2043 Go to the next unread group on the same (or lower) level
2044 (@code{gnus-group-next-unread-group-same-level}).
2045
2046 @item M-p
2047 @kindex M-p (Group)
2048 @findex gnus-group-prev-unread-group-same-level
2049 Go to the previous unread group on the same (or lower) level
2050 (@code{gnus-group-prev-unread-group-same-level}).
2051 @end table
2052
2053 Three commands for jumping to groups:
2054
2055 @table @kbd
2056
2057 @item j
2058 @kindex j (Group)
2059 @findex gnus-group-jump-to-group
2060 Jump to a group (and make it visible if it isn't already)
2061 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
2062 like living groups.
2063
2064 @item ,
2065 @kindex , (Group)
2066 @findex gnus-group-best-unread-group
2067 Jump to the unread group with the lowest level
2068 (@code{gnus-group-best-unread-group}).
2069
2070 @item .
2071 @kindex . (Group)
2072 @findex gnus-group-first-unread-group
2073 Jump to the first group with unread articles
2074 (@code{gnus-group-first-unread-group}).
2075 @end table
2076
2077 @vindex gnus-group-goto-unread
2078 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2079 commands will move to the next group, not the next unread group.  Even
2080 the commands that say they move to the next unread group.  The default
2081 is @code{t}.
2082
2083
2084 @node Selecting a Group
2085 @section Selecting a Group
2086 @cindex group selection
2087
2088 @table @kbd
2089
2090 @item SPACE
2091 @kindex SPACE (Group)
2092 @findex gnus-group-read-group
2093 Select the current group, switch to the summary buffer and display the
2094 first unread article (@code{gnus-group-read-group}).  If there are no
2095 unread articles in the group, or if you give a non-numerical prefix to
2096 this command, Gnus will offer to fetch all the old articles in this
2097 group from the server.  If you give a numerical prefix @var{n}, @var{n}
2098 determines the number of articles Gnus will fetch.  If @var{n} is
2099 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2100 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2101
2102 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2103 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2104 - 4 2 SPC} fetches the 42 oldest ones.
2105
2106 When you are in the group (in the Summary buffer), you can type
2107 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2108 ones.
2109
2110 @item RET
2111 @kindex RET (Group)
2112 @findex gnus-group-select-group
2113 Select the current group and switch to the summary buffer
2114 (@code{gnus-group-select-group}).  Takes the same arguments as
2115 @code{gnus-group-read-group}---the only difference is that this command
2116 does not display the first unread article automatically upon group
2117 entry.
2118
2119 @item M-RET
2120 @kindex M-RET (Group)
2121 @findex gnus-group-quick-select-group
2122 This does the same as the command above, but tries to do it with the
2123 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
2124 scoring/killing will be performed, there will be no highlights and no
2125 expunging.  This might be useful if you're in a real hurry and have to
2126 enter some humongous group.  If you give a 0 prefix to this command
2127 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2128 which is useful if you want to toggle threading before generating the
2129 summary buffer (@pxref{Summary Generation Commands}).
2130
2131 @item M-SPACE
2132 @kindex M-SPACE (Group)
2133 @findex gnus-group-visible-select-group
2134 This is yet one more command that does the same as the @kbd{RET}
2135 command, but this one does it without expunging and hiding dormants
2136 (@code{gnus-group-visible-select-group}).
2137
2138 @item C-M-RET
2139 @kindex C-M-RET (Group)
2140 @findex gnus-group-select-group-ephemerally
2141 Finally, this command selects the current group ephemerally without
2142 doing any processing of its contents
2143 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
2144 turned off.  Everything you do in the group after selecting it in this
2145 manner will have no permanent effects.
2146
2147 @end table
2148
2149 @vindex gnus-large-newsgroup
2150 The @code{gnus-large-newsgroup} variable says what Gnus should
2151 consider to be a big group.  If it is @code{nil}, no groups are
2152 considered big.  The default value is 200.  If the group has more
2153 (unread and/or ticked) articles than this, Gnus will query the user
2154 before entering the group.  The user can then specify how many
2155 articles should be fetched from the server.  If the user specifies a
2156 negative number (@var{-n}), the @var{n} oldest articles will be
2157 fetched.  If it is positive, the @var{n} articles that have arrived
2158 most recently will be fetched.
2159
2160 @vindex gnus-large-ephemeral-newsgroup
2161 @code{gnus-large-ephemeral-newsgroup} is the same as
2162 @code{gnus-large-newsgroup}, but is only used for ephemeral
2163 newsgroups.
2164
2165 @vindex gnus-select-group-hook
2166 @vindex gnus-auto-select-first
2167 @vindex gnus-auto-select-subject
2168 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2169 automatically when entering a group with the @kbd{SPACE} command.
2170 Which article this is is controlled by the
2171 @code{gnus-auto-select-subject} variable.  Valid values for this
2172 variable is:
2173
2174 @table @code
2175
2176 @item unread
2177 Place point on the subject line of the first unread article.
2178
2179 @item first
2180 Place point on the subject line of the first article.
2181
2182 @item unseen
2183 Place point on the subject line of the first unseen article.
2184
2185 @item unseen-or-unread
2186 Place point on the subject line of the first unseen article, and if
2187 there is no such article, place point on the subject line of the first
2188 unread article.
2189
2190 @item best
2191 Place point on the subject line of the highest-scored unread article.
2192
2193 @end table
2194
2195 This variable can also be a function.  In that case, that function
2196 will be called to place point on a subject line.
2197
2198 If you want to prevent automatic selection in some group (say, in a
2199 binary group with Huge articles) you can set the
2200 @code{gnus-auto-select-first} variable to @code{nil} in
2201 @code{gnus-select-group-hook}, which is called when a group is
2202 selected.
2203
2204
2205 @node Subscription Commands
2206 @section Subscription Commands
2207 @cindex subscription
2208
2209 @table @kbd
2210
2211 @item S t
2212 @itemx u
2213 @kindex S t (Group)
2214 @kindex u (Group)
2215 @findex gnus-group-unsubscribe-current-group
2216 @c @icon{gnus-group-unsubscribe}
2217 Toggle subscription to the current group
2218 (@code{gnus-group-unsubscribe-current-group}).
2219
2220 @item S s
2221 @itemx U
2222 @kindex S s (Group)
2223 @kindex U (Group)
2224 @findex gnus-group-unsubscribe-group
2225 Prompt for a group to subscribe, and then subscribe it.  If it was
2226 subscribed already, unsubscribe it instead
2227 (@code{gnus-group-unsubscribe-group}).
2228
2229 @item S k
2230 @itemx C-k
2231 @kindex S k (Group)
2232 @kindex C-k (Group)
2233 @findex gnus-group-kill-group
2234 @c @icon{gnus-group-kill-group}
2235 Kill the current group (@code{gnus-group-kill-group}).
2236
2237 @item S y
2238 @itemx C-y
2239 @kindex S y (Group)
2240 @kindex C-y (Group)
2241 @findex gnus-group-yank-group
2242 Yank the last killed group (@code{gnus-group-yank-group}).
2243
2244 @item C-x C-t
2245 @kindex C-x C-t (Group)
2246 @findex gnus-group-transpose-groups
2247 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
2248 really a subscription command, but you can use it instead of a
2249 kill-and-yank sequence sometimes.
2250
2251 @item S w
2252 @itemx C-w
2253 @kindex S w (Group)
2254 @kindex C-w (Group)
2255 @findex gnus-group-kill-region
2256 Kill all groups in the region (@code{gnus-group-kill-region}).
2257
2258 @item S z
2259 @kindex S z (Group)
2260 @findex gnus-group-kill-all-zombies
2261 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2262
2263 @item S C-k
2264 @kindex S C-k (Group)
2265 @findex gnus-group-kill-level
2266 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2267 These groups can't be yanked back after killing, so this command should
2268 be used with some caution.  The only time where this command comes in
2269 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2270 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
2271 kill off all unsubscribed groups that do not have message numbers in the
2272 @file{.newsrc} file.
2273
2274 @end table
2275
2276 Also @pxref{Group Levels}.
2277
2278
2279 @node Group Data
2280 @section Group Data
2281
2282 @table @kbd
2283
2284 @item c
2285 @kindex c (Group)
2286 @findex gnus-group-catchup-current
2287 @vindex gnus-group-catchup-group-hook
2288 @c @icon{gnus-group-catchup-current}
2289 Mark all unticked articles in this group as read
2290 (@code{gnus-group-catchup-current}).
2291 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2292 the group buffer.
2293
2294 @item C
2295 @kindex C (Group)
2296 @findex gnus-group-catchup-current-all
2297 Mark all articles in this group, even the ticked ones, as read
2298 (@code{gnus-group-catchup-current-all}).
2299
2300 @item M-c
2301 @kindex M-c (Group)
2302 @findex gnus-group-clear-data
2303 Clear the data from the current group---nix out marks and the list of
2304 read articles (@code{gnus-group-clear-data}).
2305
2306 @item M-x gnus-group-clear-data-on-native-groups
2307 @kindex M-x gnus-group-clear-data-on-native-groups
2308 @findex gnus-group-clear-data-on-native-groups
2309 If you have switched from one @acronym{NNTP} server to another, all your marks
2310 and read ranges have become worthless.  You can use this command to
2311 clear out all data that you have on your native groups.  Use with
2312 caution.
2313
2314 @end table
2315
2316
2317 @node Group Levels
2318 @section Group Levels
2319 @cindex group level
2320 @cindex level
2321
2322 All groups have a level of @dfn{subscribedness}.  For instance, if a
2323 group is on level 2, it is more subscribed than a group on level 5.  You
2324 can ask Gnus to just list groups on a given level or lower
2325 (@pxref{Listing Groups}), or to just check for new articles in groups on
2326 a given level or lower (@pxref{Scanning New Messages}).
2327
2328 Remember:  The higher the level of the group, the less important it is.
2329
2330 @table @kbd
2331
2332 @item S l
2333 @kindex S l (Group)
2334 @findex gnus-group-set-current-level
2335 Set the level of the current group.  If a numeric prefix is given, the
2336 next @var{n} groups will have their levels set.  The user will be
2337 prompted for a level.
2338 @end table
2339
2340 @vindex gnus-level-killed
2341 @vindex gnus-level-zombie
2342 @vindex gnus-level-unsubscribed
2343 @vindex gnus-level-subscribed
2344 Gnus considers groups from levels 1 to
2345 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2346 @code{gnus-level-subscribed} (exclusive) and
2347 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2348 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2349 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2350 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
2351 same, but zombie and killed groups have no information on what articles
2352 you have read, etc, stored.  This distinction between dead and living
2353 groups isn't done because it is nice or clever, it is done purely for
2354 reasons of efficiency.
2355
2356 It is recommended that you keep all your mail groups (if any) on quite
2357 low levels (e.g. 1 or 2).
2358
2359 Maybe the following description of the default behavior of Gnus helps to
2360 understand what these levels are all about.  By default, Gnus shows you
2361 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2362 empty subscribed groups and unsubscribed groups, too.  Type @kbd{l} to
2363 go back to showing nonempty subscribed groups again.  Thus, unsubscribed
2364 groups are hidden, in a way.
2365
2366 Zombie and killed groups are similar to unsubscribed groups in that they
2367 are hidden by default.  But they are different from subscribed and
2368 unsubscribed groups in that Gnus doesn't ask the news server for
2369 information (number of messages, number of unread messages) on zombie
2370 and killed groups.  Normally, you use @kbd{C-k} to kill the groups you
2371 aren't interested in.  If most groups are killed, Gnus is faster.
2372
2373 Why does Gnus distinguish between zombie and killed groups?  Well, when
2374 a new group arrives on the server, Gnus by default makes it a zombie
2375 group.  This means that you are normally not bothered with new groups,
2376 but you can type @kbd{A z} to get a list of all new groups.  Subscribe
2377 the ones you like and kill the ones you don't want.  (@kbd{A k} shows a
2378 list of killed groups.)
2379
2380 If you want to play with the level variables, you should show some care.
2381 Set them once, and don't touch them ever again.  Better yet, don't touch
2382 them at all unless you know exactly what you're doing.
2383
2384 @vindex gnus-level-default-unsubscribed
2385 @vindex gnus-level-default-subscribed
2386 Two closely related variables are @code{gnus-level-default-subscribed}
2387 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2388 which are the levels that new groups will be put on if they are
2389 (un)subscribed.  These two variables should, of course, be inside the
2390 relevant valid ranges.
2391
2392 @vindex gnus-keep-same-level
2393 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2394 will only move to groups of the same level (or lower).  In
2395 particular, going from the last article in one group to the next group
2396 will go to the next group of the same level (or lower).  This might be
2397 handy if you want to read the most important groups before you read the
2398 rest.
2399
2400 If this variable is @code{best}, Gnus will make the next newsgroup the
2401 one with the best level.
2402
2403 @vindex gnus-group-default-list-level
2404 All groups with a level less than or equal to
2405 @code{gnus-group-default-list-level} will be listed in the group buffer
2406 by default.
2407
2408 @vindex gnus-group-list-inactive-groups
2409 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2410 groups will be listed along with the unread groups.  This variable is
2411 @code{t} by default.  If it is @code{nil}, inactive groups won't be
2412 listed.
2413
2414 @vindex gnus-group-use-permanent-levels
2415 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2416 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2417 use this level as the ``work'' level.
2418
2419 @vindex gnus-activate-level
2420 Gnus will normally just activate (i. e., query the server about) groups
2421 on level @code{gnus-activate-level} or less.  If you don't want to
2422 activate unsubscribed groups, for instance, you might set this variable
2423 to 5.  The default is 6.
2424
2425
2426 @node Group Score
2427 @section Group Score
2428 @cindex group score
2429 @cindex group rank
2430 @cindex rank
2431
2432 You would normally keep important groups on high levels, but that scheme
2433 is somewhat restrictive.  Don't you wish you could have Gnus sort the
2434 group buffer according to how often you read groups, perhaps?  Within
2435 reason?
2436
2437 This is what @dfn{group score} is for.  You can have Gnus assign a score
2438 to each group through the mechanism described below.  You can then sort
2439 the group buffer based on this score.  Alternatively, you can sort on
2440 score and then level.  (Taken together, the level and the score is
2441 called the @dfn{rank} of the group.  A group that is on level 4 and has
2442 a score of 1 has a higher rank than a group on level 5 that has a score
2443 of 300.  (The level is the most significant part and the score is the
2444 least significant part.))
2445
2446 @findex gnus-summary-bubble-group
2447 If you want groups you read often to get higher scores than groups you
2448 read seldom you can add the @code{gnus-summary-bubble-group} function to
2449 the @code{gnus-summary-exit-hook} hook.  This will result (after
2450 sorting) in a bubbling sort of action.  If you want to see that in
2451 action after each summary exit, you can add
2452 @code{gnus-group-sort-groups-by-rank} or
2453 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2454 slow things down somewhat.
2455
2456
2457 @node Marking Groups
2458 @section Marking Groups
2459 @cindex marking groups
2460
2461 If you want to perform some command on several groups, and they appear
2462 subsequently in the group buffer, you would normally just give a
2463 numerical prefix to the command.  Most group commands will then do your
2464 bidding on those groups.
2465
2466 However, if the groups are not in sequential order, you can still
2467 perform a command on several groups.  You simply mark the groups first
2468 with the process mark and then execute the command.
2469
2470 @table @kbd
2471
2472 @item #
2473 @kindex # (Group)
2474 @itemx M m
2475 @kindex M m (Group)
2476 @findex gnus-group-mark-group
2477 Set the mark on the current group (@code{gnus-group-mark-group}).
2478
2479 @item M-#
2480 @kindex M-# (Group)
2481 @itemx M u
2482 @kindex M u (Group)
2483 @findex gnus-group-unmark-group
2484 Remove the mark from the current group
2485 (@code{gnus-group-unmark-group}).
2486
2487 @item M U
2488 @kindex M U (Group)
2489 @findex gnus-group-unmark-all-groups
2490 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2491
2492 @item M w
2493 @kindex M w (Group)
2494 @findex gnus-group-mark-region
2495 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2496
2497 @item M b
2498 @kindex M b (Group)
2499 @findex gnus-group-mark-buffer
2500 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2501
2502 @item M r
2503 @kindex M r (Group)
2504 @findex gnus-group-mark-regexp
2505 Mark all groups that match some regular expression
2506 (@code{gnus-group-mark-regexp}).
2507 @end table
2508
2509 Also @pxref{Process/Prefix}.
2510
2511 @findex gnus-group-universal-argument
2512 If you want to execute some command on all groups that have been marked
2513 with the process mark, you can use the @kbd{M-&}
2514 (@code{gnus-group-universal-argument}) command.  It will prompt you for
2515 the command to be executed.
2516
2517
2518 @node Foreign Groups
2519 @section Foreign Groups
2520 @cindex foreign groups
2521
2522 Below are some group mode commands for making and editing general foreign
2523 groups, as well as commands to ease the creation of a few
2524 special-purpose groups.  All these commands insert the newly created
2525 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2526 consulted.
2527
2528 @table @kbd
2529
2530 @item G m
2531 @kindex G m (Group)
2532 @findex gnus-group-make-group
2533 @cindex making groups
2534 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
2535 for a name, a method and possibly an @dfn{address}.  For an easier way
2536 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2537
2538 @item G M
2539 @kindex G M (Group)
2540 @findex gnus-group-read-ephemeral-group
2541 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}).  Gnus
2542 will prompt you for a name, a method and an @dfn{address}.
2543
2544 @item G r
2545 @kindex G r (Group)
2546 @findex gnus-group-rename-group
2547 @cindex renaming groups
2548 Rename the current group to something else
2549 (@code{gnus-group-rename-group}).  This is valid only on some
2550 groups---mail groups mostly.  This command might very well be quite slow
2551 on some back ends.
2552
2553 @item G c
2554 @kindex G c (Group)
2555 @cindex customizing
2556 @findex gnus-group-customize
2557 Customize the group parameters (@code{gnus-group-customize}).
2558
2559 @item G e
2560 @kindex G e (Group)
2561 @findex gnus-group-edit-group-method
2562 @cindex renaming groups
2563 Enter a buffer where you can edit the select method of the current
2564 group (@code{gnus-group-edit-group-method}).
2565
2566 @item G p
2567 @kindex G p (Group)
2568 @findex gnus-group-edit-group-parameters
2569 Enter a buffer where you can edit the group parameters
2570 (@code{gnus-group-edit-group-parameters}).
2571
2572 @item G E
2573 @kindex G E (Group)
2574 @findex gnus-group-edit-group
2575 Enter a buffer where you can edit the group info
2576 (@code{gnus-group-edit-group}).
2577
2578 @item G d
2579 @kindex G d (Group)
2580 @findex gnus-group-make-directory-group
2581 @cindex nndir
2582 Make a directory group (@pxref{Directory Groups}).  You will be prompted
2583 for a directory name (@code{gnus-group-make-directory-group}).
2584
2585 @item G h
2586 @kindex G h (Group)
2587 @cindex help group
2588 @findex gnus-group-make-help-group
2589 Make the Gnus help group (@code{gnus-group-make-help-group}).
2590
2591 @item G a
2592 @kindex G a (Group)
2593 @cindex (ding) archive
2594 @cindex archive group
2595 @findex gnus-group-make-archive-group
2596 @vindex gnus-group-archive-directory
2597 @vindex gnus-group-recent-archive-directory
2598 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
2599 default a group pointing to the most recent articles will be created
2600 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2601 group will be created from @code{gnus-group-archive-directory}.
2602
2603 @item G k
2604 @kindex G k (Group)
2605 @findex gnus-group-make-kiboze-group
2606 @cindex nnkiboze
2607 Make a kiboze group.  You will be prompted for a name, for a regexp to
2608 match groups to be ``included'' in the kiboze group, and a series of
2609 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2610 @xref{Kibozed Groups}.
2611
2612 @item G D
2613 @kindex G D (Group)
2614 @findex gnus-group-enter-directory
2615 @cindex nneething
2616 Read an arbitrary directory as if it were a newsgroup with the
2617 @code{nneething} back end (@code{gnus-group-enter-directory}).
2618 @xref{Anything Groups}.
2619
2620 @item G f
2621 @kindex G f (Group)
2622 @findex gnus-group-make-doc-group
2623 @cindex ClariNet Briefs
2624 @cindex nndoc
2625 Make a group based on some file or other
2626 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
2627 command, you will be prompted for a file name and a file type.
2628 Currently supported types are @code{mbox}, @code{babyl},
2629 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2630 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2631 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2632 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}.  If
2633 you run this command without a prefix, Gnus will guess at the file
2634 type.  @xref{Document Groups}.
2635
2636 @item G u
2637 @kindex G u (Group)
2638 @vindex gnus-useful-groups
2639 @findex gnus-group-make-useful-group
2640 Create one of the groups mentioned in @code{gnus-useful-groups}
2641 (@code{gnus-group-make-useful-group}).
2642
2643 @item G w
2644 @kindex G w (Group)
2645 @findex gnus-group-make-web-group
2646 @cindex Google
2647 @cindex nnweb
2648 @cindex gmane
2649 Make an ephemeral group based on a web search
2650 (@code{gnus-group-make-web-group}).  If you give a prefix to this
2651 command, make a solid group instead.  You will be prompted for the
2652 search engine type and the search string.  Valid search engine types
2653 include @code{google}, @code{dejanews}, and @code{gmane}.
2654 @xref{Web Searches}.
2655
2656 If you use the @code{google} search engine, you can limit the search
2657 to a particular group by using a match string like
2658 @samp{shaving group:alt.sysadmin.recovery}.
2659
2660 @item G R
2661 @kindex G R (Group)
2662 @findex gnus-group-make-rss-group
2663 Make a group based on an @acronym{RSS} feed
2664 (@code{gnus-group-make-rss-group}).  You will be prompted for an URL.
2665 @xref{RSS}.
2666
2667 @item G DEL
2668 @kindex G DEL (Group)
2669 @findex gnus-group-delete-group
2670 This function will delete the current group
2671 (@code{gnus-group-delete-group}).  If given a prefix, this function will
2672 actually delete all the articles in the group, and forcibly remove the
2673 group itself from the face of the Earth.  Use a prefix only if you are
2674 absolutely sure of what you are doing.  This command can't be used on
2675 read-only groups (like @code{nntp} groups), though.
2676
2677 @item G V
2678 @kindex G V (Group)
2679 @findex gnus-group-make-empty-virtual
2680 Make a new, fresh, empty @code{nnvirtual} group
2681 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
2682
2683 @item G v
2684 @kindex G v (Group)
2685 @findex gnus-group-add-to-virtual
2686 Add the current group to an @code{nnvirtual} group
2687 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2688 @end table
2689
2690 @xref{Select Methods}, for more information on the various select
2691 methods.
2692
2693 @vindex gnus-activate-foreign-newsgroups
2694 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2695 Gnus will check all foreign groups with this level or lower at startup.
2696 This might take quite a while, especially if you subscribe to lots of
2697 groups from different @acronym{NNTP} servers.  Also @pxref{Group Levels};
2698 @code{gnus-activate-level} also affects activation of foreign
2699 newsgroups.
2700
2701
2702 @node Group Parameters
2703 @section Group Parameters
2704 @cindex group parameters
2705
2706 The group parameters store information local to a particular group.
2707 Here's an example group parameter list:
2708
2709 @example
2710 ((to-address . "ding@@gnus.org")
2711  (auto-expire . t))
2712 @end example
2713
2714 We see that each element consists of a ``dotted pair''---the thing before
2715 the dot is the key, while the thing after the dot is the value.  All the
2716 parameters have this form @emph{except} local variable specs, which are
2717 not dotted pairs, but proper lists.
2718
2719 Some parameters have correspondent customizable variables, each of which
2720 is an alist of regexps and values.
2721
2722 The following group parameters can be used:
2723
2724 @table @code
2725 @item to-address
2726 @cindex to-address
2727 Address used by when doing followups and new posts.
2728
2729 @example
2730 (to-address . "some@@where.com")
2731 @end example
2732
2733 This is primarily useful in mail groups that represent closed mailing
2734 lists---mailing lists where it's expected that everybody that writes to
2735 the mailing list is subscribed to it.  Since using this parameter
2736 ensures that the mail only goes to the mailing list itself, it means
2737 that members won't receive two copies of your followups.
2738
2739 Using @code{to-address} will actually work whether the group is foreign
2740 or not.  Let's say there's a group on the server that is called
2741 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2742 the articles from a mail-to-news gateway.  Posting directly to this
2743 group is therefore impossible---you have to send mail to the mailing
2744 list address instead.
2745
2746 See also @code{gnus-parameter-to-address-alist}.
2747
2748 @item to-list
2749 @cindex to-list
2750 Address used when doing @kbd{a} in that group.
2751
2752 @example
2753 (to-list . "some@@where.com")
2754 @end example
2755
2756 It is totally ignored
2757 when doing a followup---except that if it is present in a news group,
2758 you'll get mail group semantics when doing @kbd{f}.
2759
2760 If you do an @kbd{a} command in a mail group and you have neither a
2761 @code{to-list} group parameter nor a @code{to-address} group parameter,
2762 then a @code{to-list} group parameter will be added automatically upon
2763 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2764 @vindex gnus-add-to-list
2765
2766 @findex gnus-mailing-list-mode
2767 @cindex mail list groups
2768 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2769 entering summary buffer.
2770
2771 See also @code{gnus-parameter-to-list-alist}.
2772
2773 @anchor{subscribed}
2774 @item subscribed
2775 @cindex subscribed
2776 @cindex Mail-Followup-To
2777 @findex gnus-find-subscribed-addresses
2778 If this parameter is set to @code{t}, Gnus will consider the
2779 to-address and to-list parameters for this group as addresses of
2780 mailing lists you are subscribed to.  Giving Gnus this information is
2781 (only) a first step in getting it to generate correct Mail-Followup-To
2782 headers for your posts to these lists.  The second step is to put the
2783 following in your @file{.gnus.el}
2784
2785 @lisp
2786 (setq message-subscribed-address-functions
2787       '(gnus-find-subscribed-addresses))
2788 @end lisp
2789
2790 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2791 a complete treatment of available MFT support.
2792
2793 @item visible
2794 @cindex visible
2795 If the group parameter list has the element @code{(visible . t)},
2796 that group will always be visible in the Group buffer, regardless
2797 of whether it has any unread articles.
2798
2799 @item broken-reply-to
2800 @cindex broken-reply-to
2801 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2802 headers in this group are to be ignored, and for the header to be hidden
2803 if @code{reply-to} is part of @code{gnus-boring-article-headers}.  This
2804 can be useful if you're reading a mailing list group where the listserv
2805 has inserted @code{Reply-To} headers that point back to the listserv
2806 itself.  That is broken behavior.  So there!
2807
2808 @item to-group
2809 @cindex to-group
2810 Elements like @code{(to-group . "some.group.name")} means that all
2811 posts in that group will be sent to @code{some.group.name}.
2812
2813 @item newsgroup
2814 @cindex newsgroup
2815 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2816 will treat all responses as if they were responses to news articles.
2817 This can be useful if you have a mail group that's really a mirror of a
2818 news group.
2819
2820 @item gcc-self
2821 @cindex gcc-self
2822 If @code{(gcc-self . t)} is present in the group parameter list, newly
2823 composed messages will be @code{Gcc}'d to the current group.  If
2824 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2825 generated, if @code{(gcc-self . "string")} is present, this string will
2826 be inserted literally as a @code{gcc} header.  This parameter takes
2827 precedence over any default @code{Gcc} rules as described later
2828 (@pxref{Archived Messages}).
2829
2830 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2831 @code{nntp} groups (or the like) isn't valid.  An @code{nntp} server
2832 doesn't accept articles.
2833
2834 @item auto-expire
2835 @cindex auto-expire
2836 If the group parameter has an element that looks like @code{(auto-expire
2837 . t)}, all articles read will be marked as expirable.  For an
2838 alternative approach, @pxref{Expiring Mail}.
2839
2840 See also @code{gnus-auto-expirable-newsgroups}.
2841
2842 @item total-expire
2843 @cindex total-expire
2844 If the group parameter has an element that looks like
2845 @code{(total-expire . t)}, all read articles will be put through the
2846 expiry process, even if they are not marked as expirable.  Use with
2847 caution.  Unread, ticked and dormant articles are not eligible for
2848 expiry.
2849
2850 See also @code{gnus-total-expirable-newsgroups}.
2851
2852 @item expiry-wait
2853 @cindex expiry-wait
2854 @vindex nnmail-expiry-wait-function
2855 If the group parameter has an element that looks like
2856 @code{(expiry-wait . 10)}, this value will override any
2857 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2858 (@pxref{Expiring Mail}) when expiring expirable messages.  The value
2859 can either be a number of days (not necessarily an integer) or the
2860 symbols @code{never} or @code{immediate}.
2861
2862 @item expiry-target
2863 @cindex expiry-target
2864 Where expired messages end up.  This parameter overrides
2865 @code{nnmail-expiry-target}.
2866
2867 @item score-file
2868 @cindex score file group parameter
2869 Elements that look like @code{(score-file . "file")} will make
2870 @file{file} into the current score file for the group in question.  All
2871 interactive score entries will be put into this file.
2872
2873 @item adapt-file
2874 @cindex adapt file group parameter
2875 Elements that look like @code{(adapt-file . "file")} will make
2876 @file{file} into the current adaptive file for the group in question.
2877 All adaptive score entries will be put into this file.
2878
2879 @item admin-address
2880 @cindex admin-address
2881 When unsubscribing from a mailing list you should never send the
2882 unsubscription notice to the mailing list itself.  Instead, you'd send
2883 messages to the administrative address.  This parameter allows you to
2884 put the admin address somewhere convenient.
2885
2886 @item display
2887 @cindex display
2888 Elements that look like @code{(display . MODE)} say which articles to
2889 display on entering the group.  Valid values are:
2890
2891 @table @code
2892 @item all
2893 Display all articles, both read and unread.
2894
2895 @item an integer
2896 Display the last @var{integer} articles in the group.  This is the same as
2897 entering the group with @kbd{C-u @var{integer}}.
2898
2899 @item default
2900 Display the default visible articles, which normally includes unread and
2901 ticked articles.
2902
2903 @item an array
2904 Display articles that satisfy a predicate.
2905
2906 Here are some examples:
2907
2908 @table @code
2909 @item [unread]
2910 Display only unread articles.
2911
2912 @item [not expire]
2913 Display everything except expirable articles.
2914
2915 @item [and (not reply) (not expire)]
2916 Display everything except expirable and articles you've already
2917 responded to.
2918 @end table
2919
2920 The available operators are @code{not}, @code{and} and @code{or}.
2921 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2922 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2923 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2924 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2925
2926 @end table
2927
2928 The @code{display} parameter works by limiting the summary buffer to
2929 the subset specified.  You can pop the limit by using the @kbd{/ w}
2930 command (@pxref{Limiting}).
2931
2932 @item comment
2933 @cindex comment
2934 Elements that look like @code{(comment . "This is a comment")} are
2935 arbitrary comments on the group.  You can display comments in the
2936 group line (@pxref{Group Line Specification}).
2937
2938 @item charset
2939 @cindex charset
2940 Elements that look like @code{(charset . iso-8859-1)} will make
2941 @code{iso-8859-1} the default charset; that is, the charset that will be
2942 used for all articles that do not specify a charset.
2943
2944 See also @code{gnus-group-charset-alist}.
2945
2946 @item ignored-charsets
2947 @cindex ignored-charset
2948 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2949 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2950 default charset will be used for decoding articles.
2951
2952 See also @code{gnus-group-ignored-charsets-alist}.
2953
2954 @item posting-style
2955 @cindex posting-style
2956 You can store additional posting style information for this group
2957 here (@pxref{Posting Styles}).  The format is that of an entry in the
2958 @code{gnus-posting-styles} alist, except that there's no regexp matching
2959 the group name (of course).  Style elements in this group parameter will
2960 take precedence over the ones found in @code{gnus-posting-styles}.
2961
2962 For instance, if you want a funky name and signature in this group only,
2963 instead of hacking @code{gnus-posting-styles}, you could put something
2964 like this in the group parameters:
2965
2966 @example
2967 (posting-style
2968   (name "Funky Name")
2969   ("X-My-Header" "Funky Value")
2970   (signature "Funky Signature"))
2971 @end example
2972
2973 @item post-method
2974 @cindex post-method
2975 If it is set, the value is used as the method for posting message
2976 instead of @code{gnus-post-method}.
2977
2978 @item banner
2979 @cindex banner
2980 An item like @code{(banner . @var{regexp})} causes any part of an article
2981 that matches the regular expression @var{regexp} to be stripped.  Instead of
2982 @var{regexp}, you can also use the symbol @code{signature} which strips the
2983 last signature or any of the elements of the alist
2984 @code{gnus-article-banner-alist}.
2985
2986 @item sieve
2987 @cindex sieve
2988 This parameter contains a Sieve test that should match incoming mail
2989 that should be placed in this group.  From this group parameter, a
2990 Sieve @samp{IF} control structure is generated, having the test as the
2991 condition and @samp{fileinto "group.name";} as the body.
2992
2993 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
2994 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2995 translating the group parameter into a Sieve script (@pxref{Sieve
2996 Commands}) the following Sieve code is generated:
2997
2998 @example
2999 if address \"sender\" \"sieve-admin@@extundo.com\" @{
3000         fileinto \"INBOX.list.sieve\";
3001 @}
3002 @end example
3003
3004 The Sieve language is described in RFC 3028.  @xref{Top, Emacs Sieve,
3005 Top, sieve, Emacs Sieve}.
3006
3007 @item (agent parameters)
3008 If the agent has been enabled, you can set any of the its parameters
3009 to control the behavior of the agent in individual groups. See Agent
3010 Parameters in @ref{Category Syntax}.  Most users will choose to set
3011 agent parameters in either an agent category or group topic to
3012 minimize the configuration effort.
3013
3014 @item (@var{variable} @var{form})
3015 You can use the group parameters to set variables local to the group you
3016 are entering.  If you want to turn threading off in @samp{news.answers},
3017 you could put @code{(gnus-show-threads nil)} in the group parameters of
3018 that group.  @code{gnus-show-threads} will be made into a local variable
3019 in the summary buffer you enter, and the form @code{nil} will be
3020 @code{eval}ed there.
3021
3022 Note that this feature sets the variable locally to the summary buffer.
3023 But some variables are evaluated in the article buffer, or in the
3024 message buffer (of a reply or followup or otherwise newly created
3025 message).  As a workaround, it might help to add the variable in
3026 question to @code{gnus-newsgroup-variables}.  @xref{Various Summary
3027 Stuff}.  So if you want to set @code{message-from-style} via the group
3028 parameters, then you may need the following statement elsewhere in your
3029 @file{~/.gnus} file:
3030
3031 @lisp
3032 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3033 @end lisp
3034
3035 @vindex gnus-list-identifiers
3036 A use for this feature is to remove a mailing list identifier tag in
3037 the subject fields of articles.  E.g. if the news group
3038
3039 @example
3040 nntp+news.gnus.org:gmane.text.docbook.apps
3041 @end example
3042
3043 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3044 tag can be removed from the article subjects in the summary buffer for
3045 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3046 into the group parameters for the group.
3047
3048 This can also be used as a group-specific hook function, if you'd like.
3049 If you want to hear a beep when you enter a group, you could put
3050 something like @code{(dummy-variable (ding))} in the parameters of that
3051 group.  @code{dummy-variable} will be set to the result of the
3052 @code{(ding)} form, but who cares?
3053
3054 @end table
3055
3056 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
3057 group.  (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
3058 presents you with a Customize-like interface.  The latter helps avoid
3059 silly Lisp errors.)  You might also be interested in reading about topic
3060 parameters (@pxref{Topic Parameters}).
3061
3062 @vindex gnus-parameters
3063 Group parameters can be set via the @code{gnus-parameters} variable too.
3064 But some variables, such as @code{visible}, have no effect.  For
3065 example:
3066
3067 @lisp
3068 (setq gnus-parameters
3069       '(("mail\\..*"
3070          (gnus-show-threads nil)
3071          (gnus-use-scoring nil)
3072          (gnus-summary-line-format
3073           "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3074          (gcc-self . t)
3075          (display . all))
3076
3077         ("^nnimap:\\(foo.bar\\)$"
3078          (to-group . "\\1"))
3079
3080         ("mail\\.me"
3081          (gnus-use-scoring  t))
3082
3083         ("list\\..*"
3084          (total-expire . t)
3085          (broken-reply-to . t))))
3086 @end lisp
3087
3088 String value of parameters will be subjected to regexp substitution, as
3089 the @code{to-group} example shows.
3090
3091
3092 @node Listing Groups
3093 @section Listing Groups
3094 @cindex group listing
3095
3096 These commands all list various slices of the groups available.
3097
3098 @table @kbd
3099
3100 @item l
3101 @itemx A s
3102 @kindex A s (Group)
3103 @kindex l (Group)
3104 @findex gnus-group-list-groups
3105 List all groups that have unread articles
3106 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
3107 command will list only groups of level ARG and lower.  By default, it
3108 only lists groups of level five (i.e.,
3109 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3110 groups).
3111
3112 @item L
3113 @itemx A u
3114 @kindex A u (Group)
3115 @kindex L (Group)
3116 @findex gnus-group-list-all-groups
3117 List all groups, whether they have unread articles or not
3118 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
3119 this command will list only groups of level ARG and lower.  By default,
3120 it lists groups of level seven or lower (i.e., just subscribed and
3121 unsubscribed groups).
3122
3123 @item A l
3124 @kindex A l (Group)
3125 @findex gnus-group-list-level
3126 List all unread groups on a specific level
3127 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
3128 with no unread articles.
3129
3130 @item A k
3131 @kindex A k (Group)
3132 @findex gnus-group-list-killed
3133 List all killed groups (@code{gnus-group-list-killed}).  If given a
3134 prefix argument, really list all groups that are available, but aren't
3135 currently (un)subscribed.  This could entail reading the active file
3136 from the server.
3137
3138 @item A z
3139 @kindex A z (Group)
3140 @findex gnus-group-list-zombies
3141 List all zombie groups (@code{gnus-group-list-zombies}).
3142
3143 @item A m
3144 @kindex A m (Group)
3145 @findex gnus-group-list-matching
3146 List all unread, subscribed groups with names that match a regexp
3147 (@code{gnus-group-list-matching}).
3148
3149 @item A M
3150 @kindex A M (Group)
3151 @findex gnus-group-list-all-matching
3152 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3153
3154 @item A A
3155 @kindex A A (Group)
3156 @findex gnus-group-list-active
3157 List absolutely all groups in the active file(s) of the
3158 server(s) you are connected to (@code{gnus-group-list-active}).  This
3159 might very well take quite a while.  It might actually be a better idea
3160 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3161 thing to match on.  Also note that this command may list groups that
3162 don't exist (yet)---these will be listed as if they were killed groups.
3163 Take the output with some grains of salt.
3164
3165 @item A a
3166 @kindex A a (Group)
3167 @findex gnus-group-apropos
3168 List all groups that have names that match a regexp
3169 (@code{gnus-group-apropos}).
3170
3171 @item A d
3172 @kindex A d (Group)
3173 @findex gnus-group-description-apropos
3174 List all groups that have names or descriptions that match a regexp
3175 (@code{gnus-group-description-apropos}).
3176
3177 @item A c
3178 @kindex A c (Group)
3179 @findex gnus-group-list-cached
3180 List all groups with cached articles (@code{gnus-group-list-cached}).
3181
3182 @item A ?
3183 @kindex A ? (Group)
3184 @findex gnus-group-list-dormant
3185 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3186
3187 @item A /
3188 @kindex A / (Group)
3189 @findex gnus-group-list-limit
3190 List groups limited within the current selection
3191 (@code{gnus-group-list-limit}).
3192
3193 @item A f
3194 @kindex A f (Group)
3195 @findex gnus-group-list-flush
3196 Flush groups from the current selection (@code{gnus-group-list-flush}).
3197
3198 @item A p
3199 @kindex A p (Group)
3200 @findex gnus-group-list-plus
3201 List groups plus the current selection (@code{gnus-group-list-plus}).
3202
3203 @end table
3204
3205 @vindex gnus-permanently-visible-groups
3206 @cindex visible group parameter
3207 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3208 always be shown, whether they have unread articles or not.  You can also
3209 add the @code{visible} element to the group parameters in question to
3210 get the same effect.
3211
3212 @vindex gnus-list-groups-with-ticked-articles
3213 Groups that have just ticked articles in it are normally listed in the
3214 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
3215 @code{nil}, these groups will be treated just like totally empty
3216 groups.  It is @code{t} by default.
3217
3218
3219 @node Sorting Groups
3220 @section Sorting Groups
3221 @cindex sorting groups
3222
3223 @kindex C-c C-s (Group)
3224 @findex gnus-group-sort-groups
3225 @vindex gnus-group-sort-function
3226 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3227 group buffer according to the function(s) given by the
3228 @code{gnus-group-sort-function} variable.  Available sorting functions
3229 include:
3230
3231 @table @code
3232
3233 @item gnus-group-sort-by-alphabet
3234 @findex gnus-group-sort-by-alphabet
3235 Sort the group names alphabetically.  This is the default.
3236
3237 @item gnus-group-sort-by-real-name
3238 @findex gnus-group-sort-by-real-name
3239 Sort the group alphabetically on the real (unprefixed) group names.
3240
3241 @item gnus-group-sort-by-level
3242 @findex gnus-group-sort-by-level
3243 Sort by group level.
3244
3245 @item gnus-group-sort-by-score
3246 @findex gnus-group-sort-by-score
3247 Sort by group score.  @xref{Group Score}.
3248
3249 @item gnus-group-sort-by-rank
3250 @findex gnus-group-sort-by-rank
3251 Sort by group score and then the group level.  The level and the score
3252 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
3253
3254 @item gnus-group-sort-by-unread
3255 @findex gnus-group-sort-by-unread
3256 Sort by number of unread articles.
3257
3258 @item gnus-group-sort-by-method
3259 @findex gnus-group-sort-by-method
3260 Sort alphabetically on the select method.
3261
3262 @item gnus-group-sort-by-server
3263 @findex gnus-group-sort-by-server
3264 Sort alphabetically on the Gnus server name.
3265
3266
3267 @end table
3268
3269 @code{gnus-group-sort-function} can also be a list of sorting
3270 functions.  In that case, the most significant sort key function must be
3271 the last one.
3272
3273
3274 There are also a number of commands for sorting directly according to
3275 some sorting criteria:
3276
3277 @table @kbd
3278 @item G S a
3279 @kindex G S a (Group)
3280 @findex gnus-group-sort-groups-by-alphabet
3281 Sort the group buffer alphabetically by group name
3282 (@code{gnus-group-sort-groups-by-alphabet}).
3283
3284 @item G S u
3285 @kindex G S u (Group)
3286 @findex gnus-group-sort-groups-by-unread
3287 Sort the group buffer by the number of unread articles
3288 (@code{gnus-group-sort-groups-by-unread}).
3289
3290 @item G S l
3291 @kindex G S l (Group)
3292 @findex gnus-group-sort-groups-by-level
3293 Sort the group buffer by group level
3294 (@code{gnus-group-sort-groups-by-level}).
3295
3296 @item G S v
3297 @kindex G S v (Group)
3298 @findex gnus-group-sort-groups-by-score
3299 Sort the group buffer by group score
3300 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
3301
3302 @item G S r
3303 @kindex G S r (Group)
3304 @findex gnus-group-sort-groups-by-rank
3305 Sort the group buffer by group rank
3306 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
3307
3308 @item G S m
3309 @kindex G S m (Group)
3310 @findex gnus-group-sort-groups-by-method
3311 Sort the group buffer alphabetically by back end name@*
3312 (@code{gnus-group-sort-groups-by-method}).
3313
3314 @item G S n
3315 @kindex G S n (Group)
3316 @findex gnus-group-sort-groups-by-real-name
3317 Sort the group buffer alphabetically by real (unprefixed) group name
3318 (@code{gnus-group-sort-groups-by-real-name}).
3319
3320 @end table
3321
3322 All the commands below obey the process/prefix convention
3323 (@pxref{Process/Prefix}).
3324
3325 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3326 commands will sort in reverse order.
3327
3328 You can also sort a subset of the groups:
3329
3330 @table @kbd
3331 @item G P a
3332 @kindex G P a (Group)
3333 @findex gnus-group-sort-selected-groups-by-alphabet
3334 Sort the groups alphabetically by group name
3335 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3336
3337 @item G P u
3338 @kindex G P u (Group)
3339 @findex gnus-group-sort-selected-groups-by-unread
3340 Sort the groups by the number of unread articles
3341 (@code{gnus-group-sort-selected-groups-by-unread}).
3342
3343 @item G P l
3344 @kindex G P l (Group)
3345 @findex gnus-group-sort-selected-groups-by-level
3346 Sort the groups by group level
3347 (@code{gnus-group-sort-selected-groups-by-level}).
3348
3349 @item G P v
3350 @kindex G P v (Group)
3351 @findex gnus-group-sort-selected-groups-by-score
3352 Sort the groups by group score
3353 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
3354
3355 @item G P r
3356 @kindex G P r (Group)
3357 @findex gnus-group-sort-selected-groups-by-rank
3358 Sort the groups by group rank
3359 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
3360
3361 @item G P m
3362 @kindex G P m (Group)
3363 @findex gnus-group-sort-selected-groups-by-method
3364 Sort the groups alphabetically by back end name@*
3365 (@code{gnus-group-sort-selected-groups-by-method}).
3366
3367 @item G P n
3368 @kindex G P n (Group)
3369 @findex gnus-group-sort-selected-groups-by-real-name
3370 Sort the groups alphabetically by real (unprefixed) group name
3371 (@code{gnus-group-sort-selected-groups-by-real-name}).
3372
3373 @item G P s
3374 @kindex G P s (Group)
3375 @findex gnus-group-sort-selected-groups
3376 Sort the groups according to @code{gnus-group-sort-function}.
3377
3378 @end table
3379
3380 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3381 move groups around.
3382
3383
3384 @node Group Maintenance
3385 @section Group Maintenance
3386 @cindex bogus groups
3387
3388 @table @kbd
3389 @item b
3390 @kindex b (Group)
3391 @findex gnus-group-check-bogus-groups
3392 Find bogus groups and delete them
3393 (@code{gnus-group-check-bogus-groups}).
3394
3395 @item F
3396 @kindex F (Group)
3397 @findex gnus-group-find-new-groups
3398 Find new groups and process them (@code{gnus-group-find-new-groups}).
3399 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3400 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
3401 to query the server for new groups, and subscribe the new groups as
3402 zombies.
3403
3404 @item C-c C-x
3405 @kindex C-c C-x (Group)
3406 @findex gnus-group-expire-articles
3407 Run all expirable articles in the current group through the expiry
3408 process (if any) (@code{gnus-group-expire-articles}).  That is, delete
3409 all expirable articles in the group that have been around for a while.
3410 (@pxref{Expiring Mail}).
3411
3412 @item C-c C-M-x
3413 @kindex C-c C-M-x (Group)
3414 @findex gnus-group-expire-all-groups
3415 Run all expirable articles in all groups through the expiry process
3416 (@code{gnus-group-expire-all-groups}).
3417
3418 @end table
3419
3420
3421 @node Browse Foreign Server
3422 @section Browse Foreign Server
3423 @cindex foreign servers
3424 @cindex browsing servers
3425
3426 @table @kbd
3427 @item B
3428 @kindex B (Group)
3429 @findex gnus-group-browse-foreign-server
3430 You will be queried for a select method and a server name.  Gnus will
3431 then attempt to contact this server and let you browse the groups there
3432 (@code{gnus-group-browse-foreign-server}).
3433 @end table
3434
3435 @findex gnus-browse-mode
3436 A new buffer with a list of available groups will appear.  This buffer
3437 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
3438 a lot) like a normal group buffer.
3439
3440 Here's a list of keystrokes available in the browse mode:
3441
3442 @table @kbd
3443 @item n
3444 @kindex n (Browse)
3445 @findex gnus-group-next-group
3446 Go to the next group (@code{gnus-group-next-group}).
3447
3448 @item p
3449 @kindex p (Browse)
3450 @findex gnus-group-prev-group
3451 Go to the previous group (@code{gnus-group-prev-group}).
3452
3453 @item SPACE
3454 @kindex SPACE (Browse)
3455 @findex gnus-browse-read-group
3456 Enter the current group and display the first article
3457 (@code{gnus-browse-read-group}).
3458
3459 @item RET
3460 @kindex RET (Browse)
3461 @findex gnus-browse-select-group
3462 Enter the current group (@code{gnus-browse-select-group}).
3463
3464 @item u
3465 @kindex u (Browse)
3466 @findex gnus-browse-unsubscribe-current-group
3467 Unsubscribe to the current group, or, as will be the case here,
3468 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3469
3470 @item l
3471 @itemx q
3472 @kindex q (Browse)
3473 @kindex l (Browse)
3474 @findex gnus-browse-exit
3475 Exit browse mode (@code{gnus-browse-exit}).
3476
3477 @item d
3478 @kindex d (Browse)
3479 @findex gnus-browse-describe-group
3480 Describe the current group (@code{gnus-browse-describe-group}).
3481
3482 @item ?
3483 @kindex ? (Browse)
3484 @findex gnus-browse-describe-briefly
3485 Describe browse mode briefly (well, there's not much to describe, is
3486 there) (@code{gnus-browse-describe-briefly}).
3487 @end table
3488
3489
3490 @node Exiting Gnus
3491 @section Exiting Gnus
3492 @cindex exiting Gnus
3493
3494 Yes, Gnus is ex(c)iting.
3495
3496 @table @kbd
3497 @item z
3498 @kindex z (Group)
3499 @findex gnus-group-suspend
3500 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
3501 but it kills all buffers except the Group buffer.  I'm not sure why this
3502 is a gain, but then who am I to judge?
3503
3504 @item q
3505 @kindex q (Group)
3506 @findex gnus-group-exit
3507 @c @icon{gnus-group-exit}
3508 Quit Gnus (@code{gnus-group-exit}).
3509
3510 @item Q
3511 @kindex Q (Group)
3512 @findex gnus-group-quit
3513 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3514 The dribble file will be saved, though (@pxref{Auto Save}).
3515 @end table
3516
3517 @vindex gnus-exit-gnus-hook
3518 @vindex gnus-suspend-gnus-hook
3519 @vindex gnus-after-exiting-gnus-hook
3520 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3521 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3522 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3523 exiting Gnus.
3524
3525 Note:
3526
3527 @quotation
3528 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3529 numbly heavy and herself fall into a hazy trance as the boy sitting
3530 behind her drew repeated lines with his pencil across the back of her
3531 plastic chair.
3532 @end quotation
3533
3534
3535 @node Group Topics
3536 @section Group Topics
3537 @cindex topics
3538
3539 If you read lots and lots of groups, it might be convenient to group
3540 them hierarchically according to topics.  You put your Emacs groups over
3541 here, your sex groups over there, and the rest (what, two groups or so?)
3542 you put in some misc section that you never bother with anyway.  You can
3543 even group the Emacs sex groups as a sub-topic to either the Emacs
3544 groups or the sex groups---or both!  Go wild!
3545
3546 @iftex
3547 @iflatex
3548 \gnusfigure{Group Topics}{400}{
3549 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3550 }
3551 @end iflatex
3552 @end iftex
3553
3554 Here's an example:
3555
3556 @example
3557 Gnus
3558   Emacs -- I wuw it!
3559      3: comp.emacs
3560      2: alt.religion.emacs
3561     Naughty Emacs
3562      452: alt.sex.emacs
3563        0: comp.talk.emacs.recovery
3564   Misc
3565      8: comp.binaries.fractals
3566     13: comp.sources.unix
3567 @end example
3568
3569 @findex gnus-topic-mode
3570 @kindex t (Group)
3571 To get this @emph{fab} functionality you simply turn on (ooh!) the
3572 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
3573 is a toggling command.)
3574
3575 Go ahead, just try it.  I'll still be here when you get back.  La de
3576 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3577 Yes, and now press @kbd{l}.  There.  All your groups are now listed
3578 under @samp{misc}.  Doesn't that make you feel all warm and fuzzy?
3579 Hot and bothered?
3580
3581 If you want this permanently enabled, you should add that minor mode to
3582 the hook for the group mode.  Put the following line in your
3583 @file{~/.gnus.el} file:
3584
3585 @lisp
3586 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3587 @end lisp
3588
3589 @menu
3590 * Topic Commands::              Interactive E-Z commands.
3591 * Topic Variables::             How to customize the topics the Lisp Way.
3592 * Topic Sorting::               Sorting each topic individually.
3593 * Topic Topology::              A map of the world.
3594 * Topic Parameters::            Parameters that apply to all groups in a topic.
3595 @end menu
3596
3597
3598 @node Topic Commands
3599 @subsection Topic Commands
3600 @cindex topic commands
3601
3602 When the topic minor mode is turned on, a new @kbd{T} submap will be
3603 available.  In addition, a few of the standard keys change their
3604 definitions slightly.
3605
3606 In general, the following kinds of operations are possible on topics.
3607 First of all, you want to create topics.  Secondly, you want to put
3608 groups in topics and to move them around until you have an order you
3609 like.  The third kind of operation is to show/hide parts of the whole
3610 shebang.  You might want to hide a topic including its subtopics and
3611 groups, to get a better overview of the other groups.
3612
3613 Here is a list of the basic keys that you might need to set up topics
3614 the way you like.
3615
3616 @table @kbd
3617
3618 @item T n
3619 @kindex T n (Topic)
3620 @findex gnus-topic-create-topic
3621 Prompt for a new topic name and create it
3622 (@code{gnus-topic-create-topic}).
3623
3624 @item T TAB
3625 @itemx TAB
3626 @kindex T TAB (Topic)
3627 @kindex TAB (Topic)
3628 @findex gnus-topic-indent
3629 ``Indent'' the current topic so that it becomes a sub-topic of the
3630 previous topic (@code{gnus-topic-indent}).  If given a prefix,
3631 ``un-indent'' the topic instead.
3632
3633 @item M-TAB
3634 @kindex M-TAB (Topic)
3635 @findex gnus-topic-unindent
3636 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3637 parent of its current parent (@code{gnus-topic-unindent}).
3638
3639 @end table
3640
3641 The following two keys can be used to move groups and topics around.
3642 They work like the well-known cut and paste.  @kbd{C-k} is like cut and
3643 @kbd{C-y} is like paste.  Of course, this being Emacs, we use the terms
3644 kill and yank rather than cut and paste.
3645
3646 @table @kbd
3647
3648 @item C-k
3649 @kindex C-k (Topic)
3650 @findex gnus-topic-kill-group
3651 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
3652 topic will be removed along with the topic.
3653
3654 @item C-y
3655 @kindex C-y (Topic)
3656 @findex gnus-topic-yank-group
3657 Yank the previously killed group or topic
3658 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
3659 before all groups.
3660
3661 So, to move a topic to the beginning of the list of topics, just hit
3662 @kbd{C-k} on it.  This is like the ``cut'' part of cut and paste.  Then,
3663 move the cursor to the beginning of the buffer (just below the ``Gnus''
3664 topic) and hit @kbd{C-y}.  This is like the ``paste'' part of cut and
3665 paste.  Like I said -- E-Z.
3666
3667 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics.  So
3668 you can move topics around as well as groups.
3669
3670 @end table
3671
3672 After setting up the topics the way you like them, you might wish to
3673 hide a topic, or to show it again.  That's why we have the following
3674 key.
3675
3676 @table @kbd
3677
3678 @item RET
3679 @kindex RET (Topic)
3680 @findex gnus-topic-select-group
3681 @itemx SPACE
3682 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3683 When you perform this command on a group, you'll enter the group, as
3684 usual.  When done on a topic line, the topic will be folded (if it was
3685 visible) or unfolded (if it was folded already).  So it's basically a
3686 toggling command on topics.  In addition, if you give a numerical
3687 prefix, group on that level (and lower) will be displayed.
3688
3689 @end table
3690
3691 Now for a list of other commands, in no particular order.
3692
3693 @table @kbd
3694
3695 @item T m
3696 @kindex T m (Topic)
3697 @findex gnus-topic-move-group
3698 Move the current group to some other topic
3699 (@code{gnus-topic-move-group}).  This command uses the process/prefix
3700 convention (@pxref{Process/Prefix}).
3701
3702 @item T j
3703 @kindex T j (Topic)
3704 @findex gnus-topic-jump-to-topic
3705 Go to a topic (@code{gnus-topic-jump-to-topic}).
3706
3707 @item T c
3708 @kindex T c (Topic)
3709 @findex gnus-topic-copy-group
3710 Copy the current group to some other topic
3711 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
3712 convention (@pxref{Process/Prefix}).
3713
3714 @item T h
3715 @kindex T h (Topic)
3716 @findex gnus-topic-hide-topic
3717 Hide the current topic (@code{gnus-topic-hide-topic}).  If given
3718 a prefix, hide the topic permanently.
3719
3720 @item T s
3721 @kindex T s (Topic)
3722 @findex gnus-topic-show-topic
3723 Show the current topic (@code{gnus-topic-show-topic}).  If given
3724 a prefix, show the topic permanently.
3725
3726 @item T D
3727 @kindex T D (Topic)
3728 @findex gnus-topic-remove-group
3729 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3730 This command is mainly useful if you have the same group in several
3731 topics and wish to remove it from one of the topics.  You may also
3732 remove a group from all topics, but in that case, Gnus will add it to
3733 the root topic the next time you start Gnus.  In fact, all new groups
3734 (which, naturally, don't belong to any topic) will show up in the root
3735 topic.
3736
3737 This command uses the process/prefix convention
3738 (@pxref{Process/Prefix}).
3739
3740 @item T M
3741 @kindex T M (Topic)
3742 @findex gnus-topic-move-matching
3743 Move all groups that match some regular expression to a topic
3744 (@code{gnus-topic-move-matching}).
3745
3746 @item T C
3747 @kindex T C (Topic)
3748 @findex gnus-topic-copy-matching
3749 Copy all groups that match some regular expression to a topic
3750 (@code{gnus-topic-copy-matching}).
3751
3752 @item T H
3753 @kindex T H (Topic)
3754 @findex gnus-topic-toggle-display-empty-topics
3755 Toggle hiding empty topics
3756 (@code{gnus-topic-toggle-display-empty-topics}).
3757
3758 @item T #
3759 @kindex T # (Topic)
3760 @findex gnus-topic-mark-topic
3761 Mark all groups in the current topic with the process mark
3762 (@code{gnus-topic-mark-topic}).  This command works recursively on
3763 sub-topics unless given a prefix.
3764
3765 @item T M-#
3766 @kindex T M-# (Topic)
3767 @findex gnus-topic-unmark-topic
3768 Remove the process mark from all groups in the current topic
3769 (@code{gnus-topic-unmark-topic}).  This command works recursively on
3770 sub-topics unless given a prefix.
3771
3772 @item C-c C-x
3773 @kindex C-c C-x (Topic)
3774 @findex gnus-topic-expire-articles
3775 Run all expirable articles in the current group or topic through the
3776 expiry process (if any)
3777 (@code{gnus-topic-expire-articles}).  (@pxref{Expiring Mail}).
3778
3779 @item T r
3780 @kindex T r (Topic)
3781 @findex gnus-topic-rename
3782 Rename a topic (@code{gnus-topic-rename}).
3783
3784 @item T DEL
3785 @kindex T DEL (Topic)
3786 @findex gnus-topic-delete
3787 Delete an empty topic (@code{gnus-topic-delete}).
3788
3789 @item A T
3790 @kindex A T (Topic)
3791 @findex gnus-topic-list-active
3792 List all groups that Gnus knows about in a topics-ified way
3793 (@code{gnus-topic-list-active}).
3794
3795 @item T M-n
3796 @kindex T M-n (Topic)
3797 @findex gnus-topic-goto-next-topic
3798 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3799
3800 @item T M-p
3801 @kindex T M-p (Topic)
3802 @findex gnus-topic-goto-previous-topic
3803 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3804
3805 @item G p
3806 @kindex G p (Topic)
3807 @findex gnus-topic-edit-parameters
3808 @cindex group parameters
3809 @cindex topic parameters
3810 @cindex parameters
3811 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3812 @xref{Topic Parameters}.
3813
3814 @end table
3815
3816
3817 @node Topic Variables
3818 @subsection Topic Variables
3819 @cindex topic variables
3820
3821 The previous section told you how to tell Gnus which topics to display.
3822 This section explains how to tell Gnus what to display about each topic.
3823
3824 @vindex gnus-topic-line-format
3825 The topic lines themselves are created according to the
3826 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3827 Valid elements are:
3828
3829 @table @samp
3830 @item i
3831 Indentation.
3832 @item n
3833 Topic name.
3834 @item v
3835 Visibility.
3836 @item l
3837 Level.
3838 @item g
3839 Number of groups in the topic.
3840 @item a
3841 Number of unread articles in the topic.
3842 @item A
3843 Number of unread articles in the topic and all its subtopics.
3844 @end table
3845
3846 @vindex gnus-topic-indent-level
3847 Each sub-topic (and the groups in the sub-topics) will be indented with
3848 @code{gnus-topic-indent-level} times the topic level number of spaces.
3849 The default is 2.
3850
3851 @vindex gnus-topic-mode-hook
3852 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3853
3854 @vindex gnus-topic-display-empty-topics
3855 The @code{gnus-topic-display-empty-topics} says whether to display even
3856 topics that have no unread articles in them.  The default is @code{t}.
3857
3858
3859 @node Topic Sorting
3860 @subsection Topic Sorting
3861 @cindex topic sorting
3862
3863 You can sort the groups in each topic individually with the following
3864 commands:
3865
3866
3867 @table @kbd
3868 @item T S a
3869 @kindex T S a (Topic)
3870 @findex gnus-topic-sort-groups-by-alphabet
3871 Sort the current topic alphabetically by group name
3872 (@code{gnus-topic-sort-groups-by-alphabet}).
3873
3874 @item T S u
3875 @kindex T S u (Topic)
3876 @findex gnus-topic-sort-groups-by-unread
3877 Sort the current topic by the number of unread articles
3878 (@code{gnus-topic-sort-groups-by-unread}).
3879
3880 @item T S l
3881 @kindex T S l (Topic)
3882 @findex gnus-topic-sort-groups-by-level
3883 Sort the current topic by group level
3884 (@code{gnus-topic-sort-groups-by-level}).
3885
3886 @item T S v
3887 @kindex T S v (Topic)
3888 @findex gnus-topic-sort-groups-by-score
3889 Sort the current topic by group score
3890 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
3891
3892 @item T S r
3893 @kindex T S r (Topic)
3894 @findex gnus-topic-sort-groups-by-rank
3895 Sort the current topic by group rank
3896 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
3897
3898 @item T S m
3899 @kindex T S m (Topic)
3900 @findex gnus-topic-sort-groups-by-method
3901 Sort the current topic alphabetically by back end name
3902 (@code{gnus-topic-sort-groups-by-method}).
3903
3904 @item T S e
3905 @kindex T S e (Topic)
3906 @findex gnus-topic-sort-groups-by-server
3907 Sort the current topic alphabetically by server name
3908 (@code{gnus-topic-sort-groups-by-server}).
3909
3910 @item T S s
3911 @kindex T S s (Topic)
3912 @findex gnus-topic-sort-groups
3913 Sort the current topic according to the function(s) given by the
3914 @code{gnus-group-sort-function} variable
3915 (@code{gnus-topic-sort-groups}).
3916
3917 @end table
3918
3919 When given a prefix argument, all these commands will sort in reverse
3920 order.  @xref{Sorting Groups}, for more information about group
3921 sorting.
3922
3923
3924 @node Topic Topology
3925 @subsection Topic Topology
3926 @cindex topic topology
3927 @cindex topology
3928
3929 So, let's have a look at an example group buffer:
3930
3931 @example
3932 @group
3933 Gnus
3934   Emacs -- I wuw it!
3935      3: comp.emacs
3936      2: alt.religion.emacs
3937     Naughty Emacs
3938      452: alt.sex.emacs
3939        0: comp.talk.emacs.recovery
3940   Misc
3941      8: comp.binaries.fractals
3942     13: comp.sources.unix
3943 @end group
3944 @end example
3945
3946 So, here we have one top-level topic (@samp{Gnus}), two topics under
3947 that, and one sub-topic under one of the sub-topics.  (There is always
3948 just one (1) top-level topic).  This topology can be expressed as
3949 follows:
3950
3951 @lisp
3952 (("Gnus" visible)
3953  (("Emacs -- I wuw it!" visible)
3954   (("Naughty Emacs" visible)))
3955  (("Misc" visible)))
3956 @end lisp
3957
3958 @vindex gnus-topic-topology
3959 This is in fact how the variable @code{gnus-topic-topology} would look
3960 for the display above.  That variable is saved in the @file{.newsrc.eld}
3961 file, and shouldn't be messed with manually---unless you really want
3962 to.  Since this variable is read from the @file{.newsrc.eld} file,
3963 setting it in any other startup files will have no effect.
3964
3965 This topology shows what topics are sub-topics of what topics (right),
3966 and which topics are visible.  Two settings are currently
3967 allowed---@code{visible} and @code{invisible}.
3968
3969
3970 @node Topic Parameters
3971 @subsection Topic Parameters
3972 @cindex topic parameters
3973
3974 All groups in a topic will inherit group parameters from the parent
3975 (and ancestor) topic parameters.  All valid group parameters are valid
3976 topic parameters (@pxref{Group Parameters}).  When the agent is
3977 enabled, all agent parameters (See Agent Parameters in @ref{Category
3978 Syntax}) are also valid topic parameters.
3979
3980 In addition, the following parameters are only valid as topic
3981 parameters:
3982
3983 @table @code
3984 @item subscribe
3985 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3986 @code{subscribe} topic parameter says what groups go in what topic.  Its
3987 value should be a regexp to match the groups that should go in that
3988 topic.
3989
3990 @item subscribe-level
3991 When subscribing new groups by topic (see the @code{subscribe} parameter),
3992 the group will be subscribed with the level specified in the
3993 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3994
3995 @end table
3996
3997 Group parameters (of course) override topic parameters, and topic
3998 parameters in sub-topics override topic parameters in super-topics.  You
3999 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
4000 verb, although you may feel free to disagree with me here.)
4001
4002 @example
4003 @group
4004 Gnus
4005   Emacs
4006      3: comp.emacs
4007      2: alt.religion.emacs
4008    452: alt.sex.emacs
4009     Relief
4010      452: alt.sex.emacs
4011        0: comp.talk.emacs.recovery
4012   Misc
4013      8: comp.binaries.fractals
4014     13: comp.sources.unix
4015    452: alt.sex.emacs
4016 @end group   
4017 @end example
4018
4019 The @samp{Emacs} topic has the topic parameter @code{(score-file
4020 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4021 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4022 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
4023 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4024 . "religion.SCORE")}.
4025
4026 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4027 will get the @file{relief.SCORE} home score file.  If you enter the same
4028 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4029 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
4030 get the @file{religion.SCORE} home score file.
4031
4032 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
4033 there are some problems, especially with the @code{total-expiry}
4034 parameter.  Say you have a mail group in two topics; one with
4035 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
4036 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
4037 of these topics you mean to expire articles from, so anything may
4038 happen.  In fact, I hereby declare that it is @dfn{undefined} what
4039 happens.  You just have to be careful if you do stuff like that.
4040
4041
4042 @node Misc Group Stuff
4043 @section Misc Group Stuff
4044
4045 @menu
4046 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
4047 * Group Information::           Information and help on groups and Gnus.
4048 * Group Timestamp::             Making Gnus keep track of when you last read a group.
4049 * File Commands::               Reading and writing the Gnus files.
4050 * Sieve Commands::              Managing Sieve scripts.
4051 @end menu
4052
4053 @table @kbd
4054
4055 @item ^
4056 @kindex ^ (Group)
4057 @findex gnus-group-enter-server-mode
4058 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4059 @xref{Server Buffer}.
4060
4061 @item a
4062 @kindex a (Group)
4063 @findex gnus-group-post-news
4064 Start composing a message (a news by default)
4065 (@code{gnus-group-post-news}).  If given a prefix, post to the group
4066 under the point.  If the prefix is 1, prompt for a group to post to.
4067 Contrary to what the name of this function suggests, the prepared
4068 article might be a mail instead of a news, if a mail group is specified
4069 with the prefix argument.  @xref{Composing Messages}.
4070
4071 @item m
4072 @kindex m (Group)
4073 @findex gnus-group-mail
4074 Mail a message somewhere (@code{gnus-group-mail}).  If given a prefix,
4075 use the posting style of the group under the point.  If the prefix is 1,
4076 prompt for a group name to find the posting style.
4077 @xref{Composing Messages}.
4078
4079 @item i
4080 @kindex i (Group)
4081 @findex gnus-group-news
4082 Start composing a news (@code{gnus-group-news}).  If given a prefix,
4083 post to the group under the point.  If the prefix is 1, prompt
4084 for group to post to.  @xref{Composing Messages}.
4085
4086 This function actually prepares a news even when using mail groups.
4087 This is useful for ``posting'' messages to mail groups without actually
4088 sending them over the network: they're just saved directly to the group
4089 in question.  The corresponding back end must have a request-post method
4090 for this to work though.
4091
4092 @end table
4093
4094 Variables for the group buffer:
4095
4096 @table @code
4097
4098 @item gnus-group-mode-hook
4099 @vindex gnus-group-mode-hook
4100 is called after the group buffer has been
4101 created.
4102
4103 @item gnus-group-prepare-hook
4104 @vindex gnus-group-prepare-hook
4105 is called after the group buffer is
4106 generated.  It may be used to modify the buffer in some strange,
4107 unnatural way.
4108
4109 @item gnus-group-prepared-hook
4110 @vindex gnus-group-prepare-hook
4111 is called as the very last thing after the group buffer has been
4112 generated.  It may be used to move point around, for instance.
4113
4114 @item gnus-permanently-visible-groups
4115 @vindex gnus-permanently-visible-groups
4116 Groups matching this regexp will always be listed in the group buffer,
4117 whether they are empty or not.
4118
4119 @item gnus-group-name-charset-method-alist
4120 @vindex gnus-group-name-charset-method-alist
4121 An alist of method and the charset for group names.  It is used to show
4122 non-@acronym{ASCII} group names.
4123
4124 For example:
4125 @lisp
4126 (setq gnus-group-name-charset-method-alist
4127     '(((nntp "news.com.cn") . cn-gb-2312)))
4128 @end lisp
4129
4130 @item gnus-group-name-charset-group-alist
4131 @cindex UTF-8 group names
4132 @vindex gnus-group-name-charset-group-alist
4133 An alist of regexp of group name and the charset for group names.  It
4134 is used to show non-@acronym{ASCII} group names.  @code{((".*"
4135 utf-8))} is the default value if UTF-8 is supported, otherwise the
4136 default is @code{nil}.
4137
4138 For example:
4139 @lisp
4140 (setq gnus-group-name-charset-group-alist
4141     '(("\\.com\\.cn:" . cn-gb-2312)))
4142 @end lisp
4143
4144 @end table
4145
4146 @node Scanning New Messages
4147 @subsection Scanning New Messages
4148 @cindex new messages
4149 @cindex scanning new news
4150
4151 @table @kbd
4152
4153 @item g
4154 @kindex g (Group)
4155 @findex gnus-group-get-new-news
4156 @c @icon{gnus-group-get-new-news}
4157 Check the server(s) for new articles.  If the numerical prefix is used,
4158 this command will check only groups of level @var{arg} and lower
4159 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
4160 command will force a total re-reading of the active file(s) from the
4161 back end(s).
4162
4163 @item M-g
4164 @kindex M-g (Group)
4165 @findex gnus-group-get-new-news-this-group
4166 @vindex gnus-goto-next-group-when-activating
4167 @c @icon{gnus-group-get-new-news-this-group}
4168 Check whether new articles have arrived in the current group
4169 (@code{gnus-group-get-new-news-this-group}).
4170 @code{gnus-goto-next-group-when-activating} says whether this command is
4171 to move point to the next group or not.  It is @code{t} by default.
4172
4173 @findex gnus-activate-all-groups
4174 @cindex activating groups
4175 @item C-c M-g
4176 @kindex C-c M-g (Group)
4177 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4178
4179 @item R
4180 @kindex R (Group)
4181 @cindex restarting
4182 @findex gnus-group-restart
4183 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
4184 file(s), closes the connection to all servers, clears up all run-time
4185 Gnus variables, and then starts Gnus all over again.
4186
4187 @end table
4188
4189 @vindex gnus-get-new-news-hook
4190 @code{gnus-get-new-news-hook} is run just before checking for new news.
4191
4192 @vindex gnus-after-getting-new-news-hook
4193 @code{gnus-after-getting-new-news-hook} is run after checking for new
4194 news.
4195
4196
4197 @node Group Information
4198 @subsection Group Information
4199 @cindex group information
4200 @cindex information on groups
4201
4202 @table @kbd
4203
4204
4205 @item H f
4206 @kindex H f (Group)
4207 @findex gnus-group-fetch-faq
4208 @vindex gnus-group-faq-directory
4209 @cindex FAQ
4210 @cindex ange-ftp
4211 Try to fetch the @acronym{FAQ} for the current group
4212 (@code{gnus-group-fetch-faq}).  Gnus will try to get the @acronym{FAQ}
4213 from @code{gnus-group-faq-directory}, which is usually a directory on
4214 a remote machine.  This variable can also be a list of directories.
4215 In that case, giving a prefix to this command will allow you to choose
4216 between the various sites.  @code{ange-ftp} (or @code{efs}) will be
4217 used for fetching the file.
4218
4219 If fetching from the first site is unsuccessful, Gnus will attempt to go
4220 through @code{gnus-group-faq-directory} and try to open them one by one.
4221
4222 @item H c
4223 @kindex H c (Group)
4224 @findex gnus-group-fetch-charter
4225 @vindex gnus-group-charter-alist
4226 @cindex charter
4227 Try to open the charter for the current group in a web browser
4228 (@code{gnus-group-fetch-charter}).  Query for a group if given a
4229 prefix argument.
4230
4231 Gnus will use @code{gnus-group-charter-alist} to find the location of
4232 the charter.  If no location is known, Gnus will fetch the control
4233 messages for the group, which in some cases includes the charter.
4234
4235 @item H C
4236 @kindex H C (Group)
4237 @findex gnus-group-fetch-control
4238 @vindex gnus-group-fetch-control-use-browse-url
4239 @cindex control message
4240 Fetch the control messages for the group from the archive at
4241 @code{ftp.isc.org} (@code{gnus-group-fetch-control}).  Query for a
4242 group if given a prefix argument.
4243
4244 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4245 Gnus will open the control messages in a browser using
4246 @code{browse-url}.  Otherwise they are fetched using @code{ange-ftp}
4247 and displayed in an ephemeral group.
4248
4249 Note that the control messages are compressed.  To use this command
4250 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4251 Files, ,Compressed Files, emacs, The Emacs Manual}).
4252
4253 @item H d
4254 @itemx C-c C-d
4255 @c @icon{gnus-group-describe-group}
4256 @kindex H d (Group)
4257 @kindex C-c C-d (Group)
4258 @cindex describing groups
4259 @cindex group description
4260 @findex gnus-group-describe-group
4261 Describe the current group (@code{gnus-group-describe-group}).  If given
4262 a prefix, force Gnus to re-read the description from the server.
4263
4264 @item M-d
4265 @kindex M-d (Group)
4266 @findex gnus-group-describe-all-groups
4267 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
4268 prefix, force Gnus to re-read the description file from the server.
4269
4270 @item H v
4271 @itemx V
4272 @kindex V (Group)
4273 @kindex H v (Group)
4274 @cindex version
4275 @findex gnus-version
4276 Display current Gnus version numbers (@code{gnus-version}).
4277
4278 @item ?
4279 @kindex ? (Group)
4280 @findex gnus-group-describe-briefly
4281 Give a very short help message (@code{gnus-group-describe-briefly}).
4282
4283 @item C-c C-i
4284 @kindex C-c C-i (Group)
4285 @cindex info
4286 @cindex manual
4287 @findex gnus-info-find-node
4288 Go to the Gnus info node (@code{gnus-info-find-node}).
4289 @end table
4290
4291
4292 @node Group Timestamp
4293 @subsection Group Timestamp
4294 @cindex timestamps
4295 @cindex group timestamps
4296
4297 It can be convenient to let Gnus keep track of when you last read a
4298 group.  To set the ball rolling, you should add
4299 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4300
4301 @lisp
4302 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4303 @end lisp
4304
4305 After doing this, each time you enter a group, it'll be recorded.
4306
4307 This information can be displayed in various ways---the easiest is to
4308 use the @samp{%d} spec in the group line format:
4309
4310 @lisp
4311 (setq gnus-group-line-format
4312       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4313 @end lisp
4314
4315 This will result in lines looking like:
4316
4317 @example
4318 *        0: mail.ding                                19961002T012943
4319          0: custom                                   19961002T012713
4320 @end example
4321
4322 As you can see, the date is displayed in compact ISO 8601 format.  This
4323 may be a bit too much, so to just display the date, you could say
4324 something like:
4325
4326 @lisp
4327 (setq gnus-group-line-format
4328       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4329 @end lisp
4330
4331 If you would like greater control of the time format, you can use a
4332 user-defined format spec.  Something like the following should do the
4333 trick:
4334
4335 @lisp
4336 (setq gnus-group-line-format
4337       "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4338 (defun gnus-user-format-function-d (headers)
4339   (let ((time (gnus-group-timestamp gnus-tmp-group)))
4340     (if time
4341         (format-time-string "%b %d  %H:%M" time)
4342       "")))
4343 @end lisp
4344
4345
4346 @node File Commands
4347 @subsection File Commands
4348 @cindex file commands
4349
4350 @table @kbd
4351
4352 @item r
4353 @kindex r (Group)
4354 @findex gnus-group-read-init-file
4355 @vindex gnus-init-file
4356 @cindex reading init file
4357 Re-read the init file (@code{gnus-init-file}, which defaults to
4358 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4359
4360 @item s
4361 @kindex s (Group)
4362 @findex gnus-group-save-newsrc
4363 @cindex saving .newsrc
4364 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4365 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
4366 file(s) whether Gnus thinks it is necessary or not.
4367
4368 @c @item Z
4369 @c @kindex Z (Group)
4370 @c @findex gnus-group-clear-dribble
4371 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4372
4373 @end table
4374
4375
4376 @node Sieve Commands
4377 @subsection Sieve Commands
4378 @cindex group sieve commands
4379
4380 Sieve is a server-side mail filtering language.  In Gnus you can use
4381 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4382 sieve rules that should apply to each group.  Gnus provides two
4383 commands to translate all these group parameters into a proper Sieve
4384 script that can be transfered to the server somehow.
4385
4386 @vindex gnus-sieve-file
4387 @vindex gnus-sieve-region-start
4388 @vindex gnus-sieve-region-end
4389 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4390 default @file{~/.sieve}).  The Sieve code that Gnus generate is placed
4391 between two delimiters, @code{gnus-sieve-region-start} and
4392 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4393 outside these delimiters that will not be removed the next time you
4394 regenerate the Sieve script.
4395
4396 @vindex gnus-sieve-crosspost
4397 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4398 is generated.  If it is non-@code{nil} (the default) articles is
4399 placed in all groups that have matching rules, otherwise the article
4400 is only placed in the group with the first matching rule.  For
4401 example, the group parameter @samp{(sieve address "sender"
4402 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4403 code if @code{gnus-sieve-crosspost} is @code{nil}.  (When
4404 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4405 except that the line containing the call to @code{stop} is removed.)
4406
4407 @example
4408 if address "sender" "owner-ding@@hpc.uh.edu" @{
4409         fileinto "INBOX.ding";
4410         stop;
4411 @}
4412 @end example
4413
4414 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4415
4416 @table @kbd
4417
4418 @item D g
4419 @kindex D g (Group)
4420 @findex gnus-sieve-generate
4421 @vindex gnus-sieve-file
4422 @cindex generating sieve script
4423 Regenerate a Sieve script from the @code{sieve} group parameters and
4424 put you into the @code{gnus-sieve-file} without saving it.
4425
4426 @item D u
4427 @kindex D u (Group)
4428 @findex gnus-sieve-update
4429 @vindex gnus-sieve-file
4430 @cindex updating sieve script
4431 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4432 @code{sieve} group parameters, save the file and upload it to the
4433 server using the @code{sieveshell} program.
4434
4435 @end table
4436
4437
4438 @node Summary Buffer
4439 @chapter Summary Buffer
4440 @cindex summary buffer
4441
4442 A line for each article is displayed in the summary buffer.  You can
4443 move around, read articles, post articles and reply to articles.
4444
4445 The most common way to a summary buffer is to select a group from the
4446 group buffer (@pxref{Selecting a Group}).
4447
4448 You can have as many summary buffers open as you wish.
4449
4450 @menu
4451 * Summary Buffer Format::       Deciding how the summary buffer is to look.
4452 * Summary Maneuvering::         Moving around the summary buffer.
4453 * Choosing Articles::           Reading articles.
4454 * Paging the Article::          Scrolling the current article.
4455 * Reply Followup and Post::     Posting articles.
4456 * Delayed Articles::            Send articles at a later time.
4457 * Marking Articles::            Marking articles as read, expirable, etc.
4458 * Limiting::                    You can limit the summary buffer.
4459 * Threading::                   How threads are made.
4460 * Sorting the Summary Buffer::  How articles and threads are sorted.
4461 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
4462 * Article Caching::             You may store articles in a cache.
4463 * Persistent Articles::         Making articles expiry-resistant.
4464 * Article Backlog::             Having already read articles hang around.
4465 * Saving Articles::             Ways of customizing article saving.
4466 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
4467 * Article Treatment::           The article buffer can be mangled at will.
4468 * MIME Commands::               Doing MIMEy things with the articles.
4469 * Charsets::                    Character set issues.
4470 * Article Commands::            Doing various things with the article buffer.
4471 * Summary Sorting::             Sorting the summary buffer in various ways.
4472 * Finding the Parent::          No child support? Get the parent.
4473 * Alternative Approaches::      Reading using non-default summaries.
4474 * Tree Display::                A more visual display of threads.
4475 * Mail Group Commands::         Some commands can only be used in mail groups.
4476 * Various Summary Stuff::       What didn't fit anywhere else.
4477 * Exiting the Summary Buffer::  Returning to the Group buffer,
4478                                 or reselecting the current group.
4479 * Crosspost Handling::          How crossposted articles are dealt with.
4480 * Duplicate Suppression::       An alternative when crosspost handling fails.
4481 * Security::                    Decrypt and Verify.
4482 * Mailing List::                Mailing list minor mode.
4483 @end menu
4484
4485
4486 @node Summary Buffer Format
4487 @section Summary Buffer Format
4488 @cindex summary buffer format
4489
4490 @iftex
4491 @iflatex
4492 \gnusfigure{The Summary Buffer}{180}{
4493 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4494 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4495 }
4496 @end iflatex
4497 @end iftex
4498
4499 @menu
4500 * Summary Buffer Lines::        You can specify how summary lines should look.
4501 * To From Newsgroups::          How to not display your own name.
4502 * Summary Buffer Mode Line::    You can say how the mode line should look.
4503 * Summary Highlighting::        Making the summary buffer all pretty and nice.
4504 @end menu
4505
4506 @findex mail-extract-address-components
4507 @findex gnus-extract-address-components
4508 @vindex gnus-extract-address-components
4509 Gnus will use the value of the @code{gnus-extract-address-components}
4510 variable as a function for getting the name and address parts of a
4511 @code{From} header.  Two pre-defined functions exist:
4512 @code{gnus-extract-address-components}, which is the default, quite
4513 fast, and too simplistic solution; and
4514 @code{mail-extract-address-components}, which works very nicely, but is
4515 slower.  The default function will return the wrong answer in 5% of the
4516 cases.  If this is unacceptable to you, use the other function instead:
4517
4518 @lisp
4519 (setq gnus-extract-address-components
4520       'mail-extract-address-components)
4521 @end lisp
4522
4523 @vindex gnus-summary-same-subject
4524 @code{gnus-summary-same-subject} is a string indicating that the current
4525 article has the same subject as the previous.  This string will be used
4526 with those specs that require it.  The default is @code{""}.
4527
4528
4529 @node Summary Buffer Lines
4530 @subsection Summary Buffer Lines
4531
4532 @vindex gnus-summary-line-format
4533 You can change the format of the lines in the summary buffer by changing
4534 the @code{gnus-summary-line-format} variable.  It works along the same
4535 lines as a normal @code{format} string, with some extensions
4536 (@pxref{Formatting Variables}).
4537
4538 There should always be a colon or a point position marker on the line;
4539 the cursor always moves to the point position marker or the colon after
4540 performing an operation.  (Of course, Gnus wouldn't be Gnus if it wasn't
4541 possible to change this.  Just write a new function
4542 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4543 @xref{Positioning Point}.
4544
4545 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4546
4547 The following format specification characters and extended format
4548 specification(s) are understood:
4549
4550 @table @samp
4551 @item N
4552 Article number.
4553 @item S
4554 Subject string.  List identifiers stripped,
4555 @code{gnus-list-identifies}.  @xref{Article Hiding}.
4556 @item s
4557 Subject if the article is the root of the thread or the previous article
4558 had a different subject, @code{gnus-summary-same-subject} otherwise.
4559 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4560 @item F
4561 Full @code{From} header.
4562 @item n
4563 The name (from the @code{From} header).
4564 @item f
4565 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4566 From Newsgroups}).
4567 @item a
4568 The name (from the @code{From} header).  This differs from the @code{n}
4569 spec in that it uses the function designated by the
4570 @code{gnus-extract-address-components} variable, which is slower, but
4571 may be more thorough.
4572 @item A
4573 The address (from the @code{From} header).  This works the same way as
4574 the @code{a} spec.
4575 @item L
4576 Number of lines in the article.
4577 @item c
4578 Number of characters in the article.  This specifier is not supported
4579 in some methods (like nnfolder).
4580 @item k
4581 Pretty-printed version of the number of characters in the article;
4582 for example, @samp{1.2k} or @samp{0.4M}.
4583 @item I
4584 Indentation based on thread level (@pxref{Customizing Threading}).
4585 @item B
4586 A complex trn-style thread tree, showing response-connecting trace
4587 lines.  A thread could be drawn like this:
4588
4589 @example
4590 >
4591 +->
4592 | +->
4593 | | \->
4594 | |   \->
4595 | \->
4596 +->
4597 \->
4598 @end example
4599
4600 You can customize the appearance with the following options.  Note
4601 that it is possible to make the thread display look really neat by
4602 replacing the default @acronym{ASCII} characters with graphic
4603 line-drawing glyphs.
4604 @table @code
4605 @item gnus-sum-thread-tree-root
4606 @vindex gnus-sum-thread-tree-root
4607 Used for the root of a thread.  If @code{nil}, use subject
4608 instead.  The default is @samp{> }.
4609
4610 @item gnus-sum-thread-tree-false-root
4611 @vindex gnus-sum-thread-tree-false-root
4612 Used for the false root of a thread (@pxref{Loose Threads}).  If
4613 @code{nil}, use subject instead.  The default is @samp{> }.
4614
4615 @item gnus-sum-thread-tree-single-indent
4616 @vindex gnus-sum-thread-tree-single-indent
4617 Used for a thread with just one message.  If @code{nil}, use subject
4618 instead.  The default is @samp{}.
4619
4620 @item gnus-sum-thread-tree-vertical
4621 @vindex gnus-sum-thread-tree-vertical
4622 Used for drawing a vertical line.  The default is @samp{| }.
4623
4624 @item gnus-sum-thread-tree-indent
4625 @vindex gnus-sum-thread-tree-indent
4626 Used for indenting.  The default is @samp{  }.
4627
4628 @item gnus-sum-thread-tree-leaf-with-other
4629 @vindex gnus-sum-thread-tree-leaf-with-other
4630 Used for a leaf with brothers.  The default is @samp{+-> }.
4631
4632 @item gnus-sum-thread-tree-single-leaf
4633 @vindex gnus-sum-thread-tree-single-leaf
4634 Used for a leaf without brothers.  The default is @samp{\-> }
4635
4636 @end table
4637
4638 @item T
4639 Nothing if the article is a root and lots of spaces if it isn't (it
4640 pushes everything after it off the screen).
4641 @item [
4642 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4643 for adopted articles (@pxref{Customizing Threading}).
4644 @item ]
4645 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4646 for adopted articles.
4647 @item >
4648 One space for each thread level.
4649 @item <
4650 Twenty minus thread level spaces.
4651 @item U
4652 Unread.  @xref{Read Articles}.
4653
4654 @item R
4655 This misleadingly named specifier is the @dfn{secondary mark}.  This
4656 mark will say whether the article has been replied to, has been cached,
4657 or has been saved.  @xref{Other Marks}.
4658
4659 @item i
4660 Score as a number (@pxref{Scoring}).
4661 @item z
4662 @vindex gnus-summary-zcore-fuzz
4663 Zcore, @samp{+} if above the default level and @samp{-} if below the
4664 default level.  If the difference between
4665 @code{gnus-summary-default-score} and the score is less than
4666 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4667 @item V
4668 Total thread score.
4669 @item x
4670 @code{Xref}.
4671 @item D
4672 @code{Date}.
4673 @item d
4674 The @code{Date} in @code{DD-MMM} format.
4675 @item o
4676 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4677 @item M
4678 @code{Message-ID}.
4679 @item r
4680 @code{References}.
4681 @item t
4682 Number of articles in the current sub-thread.  Using this spec will slow
4683 down summary buffer generation somewhat.
4684 @item e
4685 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4686 article has any children.
4687 @item P
4688 The line number.
4689 @item O
4690 Download mark.
4691 @item &user-date;
4692 Age sensitive date format.  Various date format is defined in
4693 @code{gnus-user-date-format-alist}.
4694 @item u
4695 User defined specifier.  The next character in the format string should
4696 be a letter.  Gnus will call the function
4697 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4698 following @samp{%u}.  The function will be passed the current header as
4699 argument.  The function should return a string, which will be inserted
4700 into the summary just like information from any other summary specifier.
4701 @end table
4702
4703 Text between @samp{%(} and @samp{%)} will be highlighted with
4704 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4705 There can only be one such area.
4706
4707 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4708 have to be handled with care.  For reasons of efficiency, Gnus will
4709 compute what column these characters will end up in, and ``hard-code''
4710 that.  This means that it is invalid to have these specs after a
4711 variable-length spec.  Well, you might not be arrested, but your summary
4712 buffer will look strange, which is bad enough.
4713
4714 The smart choice is to have these specs as far to the left as possible.
4715 (Isn't that the case with everything, though?  But I digress.)
4716
4717 This restriction may disappear in later versions of Gnus.
4718
4719
4720 @node To From Newsgroups
4721 @subsection To From Newsgroups
4722 @cindex To
4723 @cindex Newsgroups
4724
4725 In some groups (particularly in archive groups), the @code{From} header
4726 isn't very interesting, since all the articles there are written by
4727 you.  To display the information in the @code{To} or @code{Newsgroups}
4728 headers instead, you need to decide three things: What information to
4729 gather; where to display it; and when to display it.
4730
4731 @enumerate
4732 @item
4733 @vindex gnus-extra-headers
4734 The reading of extra header information is controlled by the
4735 @code{gnus-extra-headers}.  This is a list of header symbols.  For
4736 instance:
4737
4738 @lisp
4739 (setq gnus-extra-headers
4740       '(To Newsgroups X-Newsreader))
4741 @end lisp
4742
4743 This will result in Gnus trying to obtain these three headers, and
4744 storing it in header structures for later easy retrieval.
4745
4746 @item
4747 @findex gnus-extra-header
4748 The value of these extra headers can be accessed via the
4749 @code{gnus-extra-header} function.  Here's a format line spec that will
4750 access the @code{X-Newsreader} header:
4751
4752 @example
4753 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4754 @end example
4755
4756 @item
4757 @vindex gnus-ignored-from-addresses
4758 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4759 summary line spec returns the @code{To}, @code{Newsreader} or
4760 @code{From} header.  If this regexp matches the contents of the
4761 @code{From} header, the value of the @code{To} or @code{Newsreader}
4762 headers are used instead.
4763
4764 @end enumerate
4765
4766 @vindex nnmail-extra-headers
4767 A related variable is @code{nnmail-extra-headers}, which controls when
4768 to include extra headers when generating overview (@acronym{NOV}) files.
4769 If you have old overview files, you should regenerate them after
4770 changing this variable, by entering the server buffer using @kbd{^},
4771 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
4772 regeneration.
4773
4774 @vindex gnus-summary-line-format
4775 You also have to instruct Gnus to display the data by changing the
4776 @code{%n} spec to the @code{%f} spec in the
4777 @code{gnus-summary-line-format} variable.
4778
4779 In summary, you'd typically put something like the following in
4780 @file{~/.gnus.el}:
4781
4782 @lisp
4783 (setq gnus-extra-headers
4784       '(To Newsgroups))
4785 (setq nnmail-extra-headers gnus-extra-headers)
4786 (setq gnus-summary-line-format
4787       "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4788 (setq gnus-ignored-from-addresses
4789       "Your Name Here")
4790 @end lisp
4791
4792 (The values listed above are the default values in Gnus.  Alter them
4793 to fit your needs.)
4794
4795 A note for news server administrators, or for users who wish to try to
4796 convince their news server administrator to provide some additional
4797 support:
4798
4799 The above is mostly useful for mail groups, where you have control over
4800 the @acronym{NOV} files that are created.  However, if you can persuade your
4801 nntp admin to add (in the usual implementation, notably INN):
4802
4803 @example
4804 Newsgroups:full
4805 @end example
4806
4807 to the end of her @file{overview.fmt} file, then you can use that just
4808 as you would the extra headers from the mail groups.
4809
4810
4811 @node Summary Buffer Mode Line
4812 @subsection Summary Buffer Mode Line
4813
4814 @vindex gnus-summary-mode-line-format
4815 You can also change the format of the summary mode bar (@pxref{Mode Line
4816 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
4817 like.  The default is @samp{Gnus: %%b [%A] %Z}.
4818
4819 Here are the elements you can play with:
4820
4821 @table @samp
4822 @item G
4823 Group name.
4824 @item p
4825 Unprefixed group name.
4826 @item A
4827 Current article number.
4828 @item z
4829 Current article score.
4830 @item V
4831 Gnus version.
4832 @item U
4833 Number of unread articles in this group.
4834 @item e
4835 Number of unread articles in this group that aren't displayed in the
4836 summary buffer.
4837 @item Z
4838 A string with the number of unread and unselected articles represented
4839 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4840 articles, and just as @samp{<%U more>} if there are just unread articles
4841 and no unselected ones.
4842 @item g
4843 Shortish group name.  For instance, @samp{rec.arts.anime} will be
4844 shortened to @samp{r.a.anime}.
4845 @item S
4846 Subject of the current article.
4847 @item u
4848 User-defined spec (@pxref{User-Defined Specs}).
4849 @item s
4850 Name of the current score file (@pxref{Scoring}).
4851 @item d
4852 Number of dormant articles (@pxref{Unread Articles}).
4853 @item t
4854 Number of ticked articles (@pxref{Unread Articles}).
4855 @item r
4856 Number of articles that have been marked as read in this session.
4857 @item E
4858 Number of articles expunged by the score files.
4859 @end table
4860
4861
4862 @node Summary Highlighting
4863 @subsection Summary Highlighting
4864
4865 @table @code
4866
4867 @item gnus-visual-mark-article-hook
4868 @vindex gnus-visual-mark-article-hook
4869 This hook is run after selecting an article.  It is meant to be used for
4870 highlighting the article in some way.  It is not run if
4871 @code{gnus-visual} is @code{nil}.
4872
4873 @item gnus-summary-update-hook
4874 @vindex gnus-summary-update-hook
4875 This hook is called when a summary line is changed.  It is not run if
4876 @code{gnus-visual} is @code{nil}.
4877
4878 @item gnus-summary-selected-face
4879 @vindex gnus-summary-selected-face
4880 This is the face (or @dfn{font} as some people call it) used to
4881 highlight the current article in the summary buffer.
4882
4883 @item gnus-summary-highlight
4884 @vindex gnus-summary-highlight
4885 Summary lines are highlighted according to this variable, which is a
4886 list where the elements are of the format @code{(@var{form}
4887 . @var{face})}.  If you would, for instance, like ticked articles to be
4888 italic and high-scored articles to be bold, you could set this variable
4889 to something like
4890 @lisp
4891 (((eq mark gnus-ticked-mark) . italic)
4892  ((> score default) . bold))
4893 @end lisp
4894 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4895 @var{face} will be applied to the line.
4896 @end table
4897
4898
4899 @node Summary Maneuvering
4900 @section Summary Maneuvering
4901 @cindex summary movement
4902
4903 All the straight movement commands understand the numeric prefix and
4904 behave pretty much as you'd expect.
4905
4906 None of these commands select articles.
4907
4908 @table @kbd
4909 @item G M-n
4910 @itemx M-n
4911 @kindex M-n (Summary)
4912 @kindex G M-n (Summary)
4913 @findex gnus-summary-next-unread-subject
4914 Go to the next summary line of an unread article
4915 (@code{gnus-summary-next-unread-subject}).
4916
4917 @item G M-p
4918 @itemx M-p
4919 @kindex M-p (Summary)
4920 @kindex G M-p (Summary)
4921 @findex gnus-summary-prev-unread-subject
4922 Go to the previous summary line of an unread article
4923 (@code{gnus-summary-prev-unread-subject}).
4924
4925 @item G g
4926 @kindex G g (Summary)
4927 @findex gnus-summary-goto-subject
4928 Ask for an article number and then go to the summary line of that article
4929 without displaying the article (@code{gnus-summary-goto-subject}).
4930 @end table
4931
4932 If Gnus asks you to press a key to confirm going to the next group, you
4933 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4934 buffer, searching for the next group to read without actually returning
4935 to the group buffer.
4936
4937 Variables related to summary movement:
4938
4939 @table @code
4940
4941 @vindex gnus-auto-select-next
4942 @item gnus-auto-select-next
4943 If you issue one of the movement commands (like @kbd{n}) and there are
4944 no more unread articles after the current one, Gnus will offer to go to
4945 the next group.  If this variable is @code{t} and the next group is
4946 empty, Gnus will exit summary mode and return to the group buffer.  If
4947 this variable is neither @code{t} nor @code{nil}, Gnus will select the
4948 next group with unread articles.  As a special case, if this variable
4949 is @code{quietly}, Gnus will select the next group without asking for
4950 confirmation.  If this variable is @code{almost-quietly}, the same
4951 will happen only if you are located on the last article in the group.
4952 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4953 command will go to the next group without confirmation.  Also
4954 @pxref{Group Levels}.
4955
4956 @item gnus-auto-select-same
4957 @vindex gnus-auto-select-same
4958 If non-@code{nil}, all the movement commands will try to go to the next
4959 article with the same subject as the current.  (@dfn{Same} here might
4960 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
4961 for details (@pxref{Customizing Threading}).)  If there are no more
4962 articles with the same subject, go to the first unread article.
4963
4964 This variable is not particularly useful if you use a threaded display.
4965
4966 @item gnus-summary-check-current
4967 @vindex gnus-summary-check-current
4968 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4969 to the next (or previous) article if the current article is unread.
4970 Instead, they will choose the current article.
4971
4972 @item gnus-auto-center-summary
4973 @vindex gnus-auto-center-summary
4974 If non-@code{nil}, Gnus will keep the point in the summary buffer
4975 centered at all times.  This makes things quite tidy, but if you have a
4976 slow network connection, or simply do not like this un-Emacsism, you can
4977 set this variable to @code{nil} to get the normal Emacs scrolling
4978 action.  This will also inhibit horizontal re-centering of the summary
4979 buffer, which might make it more inconvenient to read extremely long
4980 threads.
4981
4982 This variable can also be a number.  In that case, center the window at
4983 the given number of lines from the top.
4984
4985 @end table
4986
4987
4988 @node Choosing Articles
4989 @section Choosing Articles
4990 @cindex selecting articles
4991
4992 @menu
4993 * Choosing Commands::           Commands for choosing articles.
4994 * Choosing Variables::          Variables that influence these commands.
4995 @end menu
4996
4997
4998 @node Choosing Commands
4999 @subsection Choosing Commands
5000
5001 None of the following movement commands understand the numeric prefix,
5002 and they all select and display an article.
5003
5004 If you want to fetch new articles or redisplay the group, see
5005 @ref{Exiting the Summary Buffer}.
5006
5007 @table @kbd
5008 @item SPACE
5009 @kindex SPACE (Summary)
5010 @findex gnus-summary-next-page
5011 Select the current article, or, if that one's read already, the next
5012 unread article (@code{gnus-summary-next-page}).
5013
5014 If you have an article window open already and you press @kbd{SPACE}
5015 again, the article will be scrolled.  This lets you conveniently
5016 @kbd{SPACE} through an entire newsgroup.  @xref{Paging the Article}.
5017
5018 @item G n
5019 @itemx n
5020 @kindex n (Summary)
5021 @kindex G n (Summary)
5022 @findex gnus-summary-next-unread-article
5023 @c @icon{gnus-summary-next-unread}
5024 Go to next unread article (@code{gnus-summary-next-unread-article}).
5025
5026 @item G p
5027 @itemx p
5028 @kindex p (Summary)
5029 @findex gnus-summary-prev-unread-article
5030 @c @icon{gnus-summary-prev-unread}
5031 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5032
5033 @item G N
5034 @itemx N
5035 @kindex N (Summary)
5036 @kindex G N (Summary)
5037 @findex gnus-summary-next-article
5038 Go to the next article (@code{gnus-summary-next-article}).
5039
5040 @item G P
5041 @itemx P
5042 @kindex P (Summary)
5043 @kindex G P (Summary)
5044 @findex gnus-summary-prev-article
5045 Go to the previous article (@code{gnus-summary-prev-article}).
5046
5047 @item G C-n
5048 @kindex G C-n (Summary)
5049 @findex gnus-summary-next-same-subject
5050 Go to the next article with the same subject
5051 (@code{gnus-summary-next-same-subject}).
5052
5053 @item G C-p
5054 @kindex G C-p (Summary)
5055 @findex gnus-summary-prev-same-subject
5056 Go to the previous article with the same subject
5057 (@code{gnus-summary-prev-same-subject}).
5058
5059 @item G f
5060 @itemx .
5061 @kindex G f  (Summary)
5062 @kindex .  (Summary)
5063 @findex gnus-summary-first-unread-article
5064 Go to the first unread article
5065 (@code{gnus-summary-first-unread-article}).
5066
5067 @item G b
5068 @itemx ,
5069 @kindex G b (Summary)
5070 @kindex , (Summary)
5071 @findex gnus-summary-best-unread-article
5072 Go to the unread article with the highest score
5073 (@code{gnus-summary-best-unread-article}).  If given a prefix argument,
5074 go to the first unread article that has a score over the default score.
5075
5076 @item G l
5077 @itemx l
5078 @kindex l (Summary)
5079 @kindex G l (Summary)
5080 @findex gnus-summary-goto-last-article
5081 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5082
5083 @item G o
5084 @kindex G o (Summary)
5085 @findex gnus-summary-pop-article
5086 @cindex history
5087 @cindex article history
5088 Pop an article off the summary history and go to this article
5089 (@code{gnus-summary-pop-article}).  This command differs from the
5090 command above in that you can pop as many previous articles off the
5091 history as you like, while @kbd{l} toggles the two last read articles.
5092 For a somewhat related issue (if you use these commands a lot),
5093 @pxref{Article Backlog}.
5094
5095 @item G j
5096 @itemx j
5097 @kindex j (Summary)
5098 @kindex G j (Summary)
5099 @findex gnus-summary-goto-article
5100 Ask for an article number or @code{Message-ID}, and then go to that
5101 article (@code{gnus-summary-goto-article}).
5102
5103 @end table
5104
5105
5106 @node Choosing Variables
5107 @subsection Choosing Variables
5108
5109 Some variables relevant for moving and selecting articles:
5110
5111 @table @code
5112 @item gnus-auto-extend-newsgroup
5113 @vindex gnus-auto-extend-newsgroup
5114 All the movement commands will try to go to the previous (or next)
5115 article, even if that article isn't displayed in the Summary buffer if
5116 this variable is non-@code{nil}.  Gnus will then fetch the article from
5117 the server and display it in the article buffer.
5118
5119 @item gnus-select-article-hook
5120 @vindex gnus-select-article-hook
5121 This hook is called whenever an article is selected.  By default it
5122 exposes any threads hidden under the selected article.  If you would
5123 like each article to be saved in the Agent as you read it, putting
5124 @code{gnus-agent-fetch-selected-article} on this hook will do so.
5125
5126 @item gnus-mark-article-hook
5127 @vindex gnus-mark-article-hook
5128 @findex gnus-summary-mark-unread-as-read
5129 @findex gnus-summary-mark-read-and-unread-as-read
5130 @findex gnus-unread-mark
5131 This hook is called whenever an article is selected.  It is intended to
5132 be used for marking articles as read.  The default value is
5133 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5134 mark of almost any article you read to @code{gnus-unread-mark}.  The
5135 only articles not affected by this function are ticked, dormant, and
5136 expirable articles.  If you'd instead like to just have unread articles
5137 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5138 instead.  It will leave marks like @code{gnus-low-score-mark},
5139 @code{gnus-del-mark} (and so on) alone.
5140
5141 @end table
5142
5143
5144 @node Paging the Article
5145 @section Scrolling the Article
5146 @cindex article scrolling
5147
5148 @table @kbd
5149
5150 @item SPACE
5151 @kindex SPACE (Summary)
5152 @findex gnus-summary-next-page
5153 Pressing @kbd{SPACE} will scroll the current article forward one page,
5154 or, if you have come to the end of the current article, will choose the
5155 next article (@code{gnus-summary-next-page}).
5156
5157 @vindex gnus-article-boring-faces
5158 @vindex gnus-article-skip-boring
5159 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5160 the article consists only of citations and signature, then it will be
5161 skipped; the next article will be shown instead.  You can customize
5162 what is considered uninteresting with
5163 @code{gnus-article-boring-faces}.  You can manually view the article's
5164 pages, no matter how boring, using @kbd{C-M-v}.
5165
5166 @item DEL
5167 @kindex DEL (Summary)
5168 @findex gnus-summary-prev-page
5169 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5170
5171 @item RET
5172 @kindex RET (Summary)
5173 @findex gnus-summary-scroll-up
5174 Scroll the current article one line forward
5175 (@code{gnus-summary-scroll-up}).
5176
5177 @item M-RET
5178 @kindex M-RET (Summary)
5179 @findex gnus-summary-scroll-down
5180 Scroll the current article one line backward
5181 (@code{gnus-summary-scroll-down}).
5182
5183 @item A g
5184 @itemx g
5185 @kindex A g (Summary)
5186 @kindex g (Summary)
5187 @findex gnus-summary-show-article
5188 @vindex gnus-summary-show-article-charset-alist
5189 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
5190 given a prefix, fetch the current article, but don't run any of the
5191 article treatment functions.  This will give you a ``raw'' article, just
5192 the way it came from the server.
5193
5194 If given a numerical prefix, you can do semi-manual charset stuff.
5195 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5196 encoded in the @code{cn-gb-2312} charset.  If you have
5197
5198 @lisp
5199 (setq gnus-summary-show-article-charset-alist
5200       '((1 . cn-gb-2312)
5201         (2 . big5)))
5202 @end lisp
5203
5204 then you can say @kbd{C-u 1 g} to get the same effect.
5205
5206 @item A <
5207 @itemx <
5208 @kindex < (Summary)
5209 @kindex A < (Summary)
5210 @findex gnus-summary-beginning-of-article
5211 Scroll to the beginning of the article
5212 (@code{gnus-summary-beginning-of-article}).
5213
5214 @item A >
5215 @itemx >
5216 @kindex > (Summary)
5217 @kindex A > (Summary)
5218 @findex gnus-summary-end-of-article
5219 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5220
5221 @item A s
5222 @itemx s
5223 @kindex A s (Summary)
5224 @kindex s (Summary)
5225 @findex gnus-summary-isearch-article
5226 Perform an isearch in the article buffer
5227 (@code{gnus-summary-isearch-article}).
5228
5229 @item h
5230 @kindex h (Summary)
5231 @findex gnus-summary-select-article-buffer
5232 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5233
5234 @end table
5235
5236
5237 @node Reply Followup and Post
5238 @section Reply, Followup and Post
5239
5240 @menu
5241 * Summary Mail Commands::       Sending mail.
5242 * Summary Post Commands::       Sending news.
5243 * Summary Message Commands::    Other Message-related commands.
5244 * Canceling and Superseding::
5245 @end menu
5246
5247
5248 @node Summary Mail Commands
5249 @subsection Summary Mail Commands
5250 @cindex mail
5251 @cindex composing mail
5252
5253 Commands for composing a mail message:
5254
5255 @table @kbd
5256
5257 @item S r
5258 @itemx r
5259 @kindex S r (Summary)
5260 @kindex r (Summary)
5261 @findex gnus-summary-reply
5262 @c @icon{gnus-summary-mail-reply}
5263 @c @icon{gnus-summary-reply}
5264 Mail a reply to the author of the current article
5265 (@code{gnus-summary-reply}).
5266
5267 @item S R
5268 @itemx R
5269 @kindex R (Summary)
5270 @kindex S R (Summary)
5271 @findex gnus-summary-reply-with-original
5272 @c @icon{gnus-summary-reply-with-original}
5273 Mail a reply to the author of the current article and include the
5274 original message (@code{gnus-summary-reply-with-original}).  This
5275 command uses the process/prefix convention.
5276
5277 @item S w
5278 @kindex S w (Summary)
5279 @findex gnus-summary-wide-reply
5280 Mail a wide reply to the author of the current article
5281 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
5282 goes out to all people listed in the @code{To}, @code{From} (or
5283 @code{Reply-to}) and @code{Cc} headers.  If @code{Mail-Followup-To} is
5284 present, that's used instead.
5285
5286 @item S W
5287 @kindex S W (Summary)
5288 @findex gnus-summary-wide-reply-with-original
5289 Mail a wide reply to the current article and include the original
5290 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
5291 the process/prefix convention.
5292
5293 @item S v
5294 @kindex S v (Summary)
5295 @findex gnus-summary-very-wide-reply
5296 Mail a very wide reply to the author of the current article
5297 (@code{gnus-summary-wide-reply}).  A @dfn{very wide reply} is a reply
5298 that goes out to all people listed in the @code{To}, @code{From} (or
5299 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5300 articles.  This command uses the process/prefix convention.
5301
5302 @item S V
5303 @kindex S V (Summary)
5304 @findex gnus-summary-very-wide-reply-with-original
5305 Mail a very wide reply to the author of the current article and include the
5306 original message (@code{gnus-summary-very-wide-reply-with-original}).  This
5307 command uses the process/prefix convention.
5308
5309 @item S B r
5310 @kindex S B r (Summary)
5311 @findex gnus-summary-reply-broken-reply-to
5312 Mail a reply to the author of the current article but ignore the
5313 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5314 If you need this because a mailing list incorrectly sets a
5315 @code{Reply-To} header pointing to the list, you probably want to set
5316 the @code{broken-reply-to} group parameter instead, so things will work
5317 correctly.  @xref{Group Parameters}.
5318
5319 @item S B R
5320 @kindex S B R (Summary)
5321 @findex gnus-summary-reply-broken-reply-to-with-original
5322 Mail a reply to the author of the current article and include the
5323 original message but ignore the @code{Reply-To} field
5324 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5325
5326 @item S o m
5327 @itemx C-c C-f
5328 @kindex S o m (Summary)
5329 @kindex C-c C-f (Summary)
5330 @findex gnus-summary-mail-forward
5331 @c @icon{gnus-summary-mail-forward}
5332 Forward the current article to some other person
5333 (@code{gnus-summary-mail-forward}).  If no prefix is given, the message
5334 is forwarded according to the value of (@code{message-forward-as-mime})
5335 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5336 message and forward directly inline; if the prefix is 2, forward message
5337 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5338 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5339 directly inline; otherwise, the message is forwarded as no prefix given
5340 but use the flipped value of (@code{message-forward-as-mime}).  By
5341 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5342 section.
5343
5344 @item S m
5345 @itemx m
5346 @kindex m (Summary)
5347 @kindex S m (Summary)
5348 @findex gnus-summary-mail-other-window
5349 @c @icon{gnus-summary-mail-originate}
5350 Prepare a mail (@code{gnus-summary-mail-other-window}).  By default, use
5351 the posting style of the current group.  If given a prefix, disable that.
5352 If the prefix is 1, prompt for a group name to find the posting style.
5353
5354 @item S i
5355 @itemx i
5356 @kindex i (Summary)
5357 @kindex S i (Summary)
5358 @findex gnus-summary-news-other-window
5359 Prepare a news (@code{gnus-summary-news-other-window}).  By default,
5360 post to the current group.  If given a prefix, disable that.  If the
5361 prefix is 1, prompt for a group to post to.
5362
5363 This function actually prepares a news even when using mail groups.
5364 This is useful for ``posting'' messages to mail groups without actually
5365 sending them over the network: they're just saved directly to the group
5366 in question.  The corresponding back end must have a request-post method
5367 for this to work though.
5368
5369 @item S D b
5370 @kindex S D b (Summary)
5371 @findex gnus-summary-resend-bounced-mail
5372 @cindex bouncing mail
5373 If you have sent a mail, but the mail was bounced back to you for some
5374 reason (wrong address, transient failure), you can use this command to
5375 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
5376 will be popped into a mail buffer where you can edit the headers before
5377 sending the mail off again.  If you give a prefix to this command, and
5378 the bounced mail is a reply to some other mail, Gnus will try to fetch
5379 that mail and display it for easy perusal of its headers.  This might
5380 very well fail, though.
5381
5382 @item S D r
5383 @kindex S D r (Summary)
5384 @findex gnus-summary-resend-message
5385 Not to be confused with the previous command,
5386 @code{gnus-summary-resend-message} will prompt you for an address to
5387 send the current message off to, and then send it to that place.  The
5388 headers of the message won't be altered---but lots of headers that say
5389 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
5390 means that you actually send a mail to someone that has a @code{To}
5391 header that (probably) points to yourself.  This will confuse people.
5392 So, natcherly you'll only do that if you're really eVIl.
5393
5394 This command is mainly used if you have several accounts and want to
5395 ship a mail to a different account of yours.  (If you're both
5396 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5397 to the @code{root} account, you may want to resend it to
5398 @code{postmaster}.  Ordnung muss sein!
5399
5400 This command understands the process/prefix convention
5401 (@pxref{Process/Prefix}).
5402
5403 @item S D e
5404 @kindex S D e (Summary)
5405 @findex gnus-summary-resend-message-edit
5406
5407 Like the previous command, but will allow you to edit the message as
5408 if it were a new message before resending.
5409
5410 @item S O m
5411 @kindex S O m (Summary)
5412 @findex gnus-uu-digest-mail-forward
5413 Digest the current series (@pxref{Decoding Articles}) and forward the
5414 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
5415 uses the process/prefix convention (@pxref{Process/Prefix}).
5416
5417 @item S M-c
5418 @kindex S M-c (Summary)
5419 @findex gnus-summary-mail-crosspost-complaint
5420 @cindex crossposting
5421 @cindex excessive crossposting
5422 Send a complaint about excessive crossposting to the author of the
5423 current article (@code{gnus-summary-mail-crosspost-complaint}).
5424
5425 @findex gnus-crosspost-complaint
5426 This command is provided as a way to fight back against the current
5427 crossposting pandemic that's sweeping Usenet.  It will compose a reply
5428 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
5429 command understands the process/prefix convention
5430 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5431
5432 @end table
5433
5434 Also @xref{Header Commands, ,Header Commands, message, The Message
5435 Manual}, for more information.
5436
5437
5438 @node Summary Post Commands
5439 @subsection Summary Post Commands
5440 @cindex post
5441 @cindex composing news
5442
5443 Commands for posting a news article:
5444
5445 @table @kbd
5446 @item S p
5447 @itemx a
5448 @kindex a (Summary)
5449 @kindex S p (Summary)
5450 @findex gnus-summary-post-news
5451 @c @icon{gnus-summary-post-news}
5452 Prepare for posting an article (@code{gnus-summary-post-news}).  By
5453 default, post to the current group.  If given a prefix, disable that.
5454 If the prefix is 1, prompt for another group instead.
5455
5456 @item S f
5457 @itemx f
5458 @kindex f (Summary)
5459 @kindex S f (Summary)
5460 @findex gnus-summary-followup
5461 @c @icon{gnus-summary-followup}
5462 Post a followup to the current article (@code{gnus-summary-followup}).
5463
5464 @item S F
5465 @itemx F
5466 @kindex S F (Summary)
5467 @kindex F (Summary)
5468 @c @icon{gnus-summary-followup-with-original}
5469 @findex gnus-summary-followup-with-original
5470 Post a followup to the current article and include the original message
5471 (@code{gnus-summary-followup-with-original}).  This command uses the
5472 process/prefix convention.
5473
5474 @item S n
5475 @kindex S n (Summary)
5476 @findex gnus-summary-followup-to-mail
5477 Post a followup to the current article via news, even if you got the
5478 message through mail (@code{gnus-summary-followup-to-mail}).
5479
5480 @item S N
5481 @kindex S N (Summary)
5482 @findex gnus-summary-followup-to-mail-with-original
5483 Post a followup to the current article via news, even if you got the
5484 message through mail and include the original message
5485 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
5486 the process/prefix convention.
5487
5488 @item S o p
5489 @kindex S o p (Summary)
5490 @findex gnus-summary-post-forward
5491 Forward the current article to a newsgroup
5492 (@code{gnus-summary-post-forward}).
5493  If no prefix is given, the message is forwarded according to the value
5494 of (@code{message-forward-as-mime}) and
5495 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5496 message and forward directly inline; if the prefix is 2, forward message
5497 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5498 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5499 directly inline; otherwise, the message is forwarded as no prefix given
5500 but use the flipped value of (@code{message-forward-as-mime}).  By
5501 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5502
5503 @item S O p
5504 @kindex S O p (Summary)
5505 @findex gnus-uu-digest-post-forward
5506 @cindex digests
5507 @cindex making digests
5508 Digest the current series and forward the result to a newsgroup
5509 (@code{gnus-uu-digest-mail-forward}).  This command uses the
5510 process/prefix convention.
5511
5512 @item S u
5513 @kindex S u (Summary)
5514 @findex gnus-uu-post-news
5515 @c @icon{gnus-uu-post-news}
5516 Uuencode a file, split it into parts, and post it as a series
5517 (@code{gnus-uu-post-news}).  (@pxref{Uuencoding and Posting}).
5518 @end table
5519
5520 Also @xref{Header Commands, ,Header Commands, message, The Message
5521 Manual}, for more information.
5522
5523
5524 @node Summary Message Commands
5525 @subsection Summary Message Commands
5526
5527 @table @kbd
5528 @item S y
5529 @kindex S y (Summary)
5530 @findex gnus-summary-yank-message
5531 Yank the current article into an already existing Message composition
5532 buffer (@code{gnus-summary-yank-message}).  This command prompts for
5533 what message buffer you want to yank into, and understands the
5534 process/prefix convention (@pxref{Process/Prefix}).
5535
5536 @end table
5537
5538
5539 @node Canceling and Superseding
5540 @subsection Canceling Articles
5541 @cindex canceling articles
5542 @cindex superseding articles
5543
5544 Have you ever written something, and then decided that you really,
5545 really, really wish you hadn't posted that?
5546
5547 Well, you can't cancel mail, but you can cancel posts.
5548
5549 @findex gnus-summary-cancel-article
5550 @kindex C (Summary)
5551 @c @icon{gnus-summary-cancel-article}
5552 Find the article you wish to cancel (you can only cancel your own
5553 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
5554 c} (@code{gnus-summary-cancel-article}).  Your article will be
5555 canceled---machines all over the world will be deleting your article.
5556 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5557
5558 Be aware, however, that not all sites honor cancels, so your article may
5559 live on here and there, while most sites will delete the article in
5560 question.
5561
5562 Gnus will use the ``current'' select method when canceling.  If you
5563 want to use the standard posting method, use the @samp{a} symbolic
5564 prefix (@pxref{Symbolic Prefixes}).
5565
5566 Gnus ensures that only you can cancel your own messages using a
5567 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5568 message, Message Manual}).
5569
5570 If you discover that you have made some mistakes and want to do some
5571 corrections, you can post a @dfn{superseding} article that will replace
5572 your original article.
5573
5574 @findex gnus-summary-supersede-article
5575 @kindex S (Summary)
5576 Go to the original article and press @kbd{S s}
5577 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
5578 where you can edit the article all you want before sending it off the
5579 usual way.
5580
5581 The same goes for superseding as for canceling, only more so: Some
5582 sites do not honor superseding.  On those sites, it will appear that you
5583 have posted almost the same article twice.
5584
5585 If you have just posted the article, and change your mind right away,
5586 there is a trick you can use to cancel/supersede the article without
5587 waiting for the article to appear on your site first.  You simply return
5588 to the post buffer (which is called @code{*sent ...*}).  There you will
5589 find the article you just posted, with all the headers intact.  Change
5590 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5591 header by substituting one of those words for the word
5592 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
5593 you would do normally.  The previous article will be
5594 canceled/superseded.
5595
5596 Just remember, kids: There is no 'c' in 'supersede'.
5597
5598 @node Delayed Articles
5599 @section Delayed Articles
5600 @cindex delayed sending
5601 @cindex send delayed
5602
5603 Sometimes, you might wish to delay the sending of a message.  For
5604 example, you might wish to arrange for a message to turn up just in time
5605 to remind your about the birthday of your Significant Other.  For this,
5606 there is the @code{gnus-delay} package.  Setup is simple:
5607
5608 @lisp
5609 (gnus-delay-initialize)
5610 @end lisp
5611
5612 @findex gnus-delay-article
5613 Normally, to send a message you use the @kbd{C-c C-c} command from
5614 Message mode.  To delay a message, use @kbd{C-c C-j}
5615 (@code{gnus-delay-article}) instead.  This will ask you for how long the
5616 message should be delayed.  Possible answers are:
5617
5618 @itemize @bullet
5619 @item
5620 A time span.  Consists of an integer and a letter.  For example,
5621 @code{42d} means to delay for 42 days.  Available letters are @code{m}
5622 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5623 (months) and @code{Y} (years).
5624
5625 @item
5626 A specific date.  Looks like @code{YYYY-MM-DD}.  The message will be
5627 delayed until that day, at a specific time (eight o'clock by default).
5628 See also @code{gnus-delay-default-hour}.
5629
5630 @item
5631 A specific time of day.  Given in @code{hh:mm} format, 24h, no am/pm
5632 stuff.  The deadline will be at that time today, except if that time has
5633 already passed, then it's at the given time tomorrow.  So if it's ten
5634 o'clock in the morning and you specify @code{11:15}, then the deadline
5635 is one hour and fifteen minutes hence.  But if you specify @code{9:20},
5636 that means a time tomorrow.
5637 @end itemize
5638
5639 The action of the @code{gnus-delay-article} command is influenced by a
5640 couple of variables:
5641
5642 @table @code
5643 @item gnus-delay-default-hour
5644 @vindex gnus-delay-default-hour
5645 When you specify a specific date, the message will be due on that hour
5646 on the given date.  Possible values are integers 0 through 23.
5647
5648 @item gnus-delay-default-delay
5649 @vindex gnus-delay-default-delay
5650 This is a string and gives the default delay.  It can be of any of the
5651 formats described above.
5652
5653 @item gnus-delay-group
5654 @vindex gnus-delay-group
5655 Delayed articles will be kept in this group on the drafts server until
5656 they are due.  You probably don't need to change this.  The default
5657 value is @code{"delayed"}.
5658
5659 @item gnus-delay-header
5660 @vindex gnus-delay-header
5661 The deadline for each article will be stored in a header.  This variable
5662 is a string and gives the header name.  You probably don't need to
5663 change this.  The default value is @code{"X-Gnus-Delayed"}.
5664 @end table
5665
5666 The way delaying works is like this: when you use the
5667 @code{gnus-delay-article} command, you give a certain delay.  Gnus
5668 calculates the deadline of the message and stores it in the
5669 @code{X-Gnus-Delayed} header and puts the message in the
5670 @code{nndraft:delayed} group.
5671
5672 @findex gnus-delay-send-queue
5673 And whenever you get new news, Gnus looks through the group for articles
5674 which are due and sends them.  It uses the @code{gnus-delay-send-queue}
5675 function for this.  By default, this function is added to the hook
5676 @code{gnus-get-new-news-hook}.  But of course, you can change this.
5677 Maybe you want to use the demon to send drafts?  Just tell the demon to
5678 execute the @code{gnus-delay-send-queue} function.
5679
5680 @table @code
5681 @item gnus-delay-initialize
5682 @findex gnus-delay-initialize
5683 By default, this function installs @code{gnus-delay-send-queue} in
5684 @code{gnus-get-new-news-hook}.  But it accepts the optional second
5685 argument @code{no-check}.  If it is non-@code{nil},
5686 @code{gnus-get-new-news-hook} is not changed.  The optional first
5687 argument is ignored.
5688
5689 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5690 Presumably, you want to use the demon for sending due delayed articles.
5691 Just don't forget to set that up :-)
5692 @end table
5693
5694
5695 @node Marking Articles
5696 @section Marking Articles
5697 @cindex article marking
5698 @cindex article ticking
5699 @cindex marks
5700
5701 There are several marks you can set on an article.
5702
5703 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5704 neologism ohoy!) of the article.  Alphabetic marks generally mean
5705 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5706
5707 In addition, you also have marks that do not affect readedness.
5708
5709 @menu
5710 * Unread Articles::             Marks for unread articles.
5711 * Read Articles::               Marks for read articles.
5712 * Other Marks::                 Marks that do not affect readedness.
5713 @end menu
5714
5715 @ifinfo
5716 There's a plethora of commands for manipulating these marks:
5717 @end ifinfo
5718
5719 @menu
5720 * Setting Marks::             How to set and remove marks.
5721 * Generic Marking Commands::  How to customize the marking.
5722 * Setting Process Marks::     How to mark articles for later processing.
5723 @end menu
5724
5725
5726 @node Unread Articles
5727 @subsection Unread Articles
5728
5729 The following marks mark articles as (kinda) unread, in one form or
5730 other.
5731
5732 @table @samp
5733 @item !
5734 @vindex gnus-ticked-mark
5735 Marked as ticked (@code{gnus-ticked-mark}).
5736
5737 @dfn{Ticked articles} are articles that will remain visible always.  If
5738 you see an article that you find interesting, or you want to put off
5739 reading it, or replying to it, until sometime later, you'd typically
5740 tick it.  However, articles can be expired (from news servers by the
5741 news server software, Gnus itself never expires ticked messages), so if
5742 you want to keep an article forever, you'll have to make it persistent
5743 (@pxref{Persistent Articles}).
5744
5745 @item ?
5746 @vindex gnus-dormant-mark
5747 Marked as dormant (@code{gnus-dormant-mark}).
5748
5749 @dfn{Dormant articles} will only appear in the summary buffer if there
5750 are followups to it.  If you want to see them even if they don't have
5751 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5752 Otherwise (except for the visibility issue), they are just like ticked
5753 messages.
5754
5755 @item SPACE
5756 @vindex gnus-unread-mark
5757 Marked as unread (@code{gnus-unread-mark}).
5758
5759 @dfn{Unread articles} are articles that haven't been read at all yet.
5760 @end table
5761
5762
5763 @node Read Articles
5764 @subsection Read Articles
5765 @cindex expirable mark
5766
5767 All the following marks mark articles as read.
5768
5769 @table @samp
5770
5771 @item r
5772 @vindex gnus-del-mark
5773 These are articles that the user has marked as read with the @kbd{d}
5774 command manually, more or less (@code{gnus-del-mark}).
5775
5776 @item R
5777 @vindex gnus-read-mark
5778 Articles that have actually been read (@code{gnus-read-mark}).
5779
5780 @item O
5781 @vindex gnus-ancient-mark
5782 Articles that were marked as read in previous sessions and are now
5783 @dfn{old} (@code{gnus-ancient-mark}).
5784
5785 @item K
5786 @vindex gnus-killed-mark
5787 Marked as killed (@code{gnus-killed-mark}).
5788
5789 @item X
5790 @vindex gnus-kill-file-mark
5791 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5792
5793 @item Y
5794 @vindex gnus-low-score-mark
5795 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5796
5797 @item C
5798 @vindex gnus-catchup-mark
5799 Marked as read by a catchup (@code{gnus-catchup-mark}).
5800
5801 @item G
5802 @vindex gnus-canceled-mark
5803 Canceled article (@code{gnus-canceled-mark})
5804
5805 @item F
5806 @vindex gnus-souped-mark
5807 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
5808
5809 @item Q
5810 @vindex gnus-sparse-mark
5811 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
5812 Threading}.
5813
5814 @item M
5815 @vindex gnus-duplicate-mark
5816 Article marked as read by duplicate suppression
5817 (@code{gnus-duplicate-mark}).  @xref{Duplicate Suppression}.
5818
5819 @end table
5820
5821 All these marks just mean that the article is marked as read, really.
5822 They are interpreted differently when doing adaptive scoring, though.
5823
5824 One more special mark, though:
5825
5826 @table @samp
5827 @item E
5828 @vindex gnus-expirable-mark
5829 Marked as expirable (@code{gnus-expirable-mark}).
5830
5831 Marking articles as @dfn{expirable} (or have them marked as such
5832 automatically) doesn't make much sense in normal groups---a user doesn't
5833 control expiring of news articles, but in mail groups, for instance,
5834 articles marked as @dfn{expirable} can be deleted by Gnus at
5835 any time.
5836 @end table
5837
5838
5839 @node Other Marks
5840 @subsection Other Marks
5841 @cindex process mark
5842 @cindex bookmarks
5843
5844 There are some marks that have nothing to do with whether the article is
5845 read or not.
5846
5847 @itemize @bullet
5848
5849 @item
5850 You can set a bookmark in the current article.  Say you are reading a
5851 long thesis on cats' urinary tracts, and have to go home for dinner
5852 before you've finished reading the thesis.  You can then set a bookmark
5853 in the article, and Gnus will jump to this bookmark the next time it
5854 encounters the article.  @xref{Setting Marks}.
5855
5856 @item
5857 @vindex gnus-replied-mark
5858 All articles that you have replied to or made a followup to (i.e., have
5859 answered) will be marked with an @samp{A} in the second column
5860 (@code{gnus-replied-mark}).
5861
5862 @item
5863 @vindex gnus-forwarded-mark
5864 All articles that you have forwarded will be marked with an @samp{F} in
5865 the second column (@code{gnus-forwarded-mark}).
5866
5867 @item
5868 @vindex gnus-cached-mark
5869 Articles stored in the article cache will be marked with an @samp{*} in
5870 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
5871
5872 @item
5873 @vindex gnus-saved-mark
5874 Articles ``saved'' (in some manner or other; not necessarily
5875 religiously) are marked with an @samp{S} in the second column
5876 (@code{gnus-saved-mark}).
5877
5878 @item
5879 @vindex gnus-recent-mark
5880 Articles that according to the server haven't been shown to the user
5881 before are marked with a @samp{N} in the second column
5882 (@code{gnus-recent-mark}).  Note that not all servers support this
5883 mark, in which case it simply never appears.  Compare with
5884 @code{gnus-unseen-mark}.
5885
5886 @item
5887 @vindex gnus-unseen-mark
5888 Articles that haven't been seen before in Gnus by the user are marked
5889 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5890 Compare with @code{gnus-recent-mark}.
5891
5892 @item
5893 @vindex gnus-downloaded-mark
5894 When using the Gnus agent (@pxref{Agent Basics}), articles may be
5895 downloaded for unplugged (offline) viewing.  If you are using the
5896 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
5897 (The variable @code{gnus-downloaded-mark} controls which character to
5898 use.)
5899
5900 @item
5901 @vindex gnus-undownloaded-mark
5902 When using the Gnus agent (@pxref{Agent Basics}), some articles might
5903 not have been downloaded.  Such articles cannot be viewed while you
5904 are unplugged (offline).  If you are using the @samp{%O} spec, these
5905 articles get the @samp{-} mark in that spec.  (The variable
5906 @code{gnus-undownloaded-mark} controls which character to use.)
5907
5908 @item
5909 @vindex gnus-downloadable-mark
5910 The Gnus agent (@pxref{Agent Basics}) downloads some articles
5911 automatically, but it is also possible to explicitly mark articles for
5912 download, even if they would not be downloaded automatically.  Such
5913 explicitly-marked articles get the @samp{%} mark in the first column.
5914 (The variable @code{gnus-downloadable-mark} controls which character to
5915 use.)
5916
5917 @item
5918 @vindex gnus-not-empty-thread-mark
5919 @vindex gnus-empty-thread-mark
5920 If the @samp{%e} spec is used, the presence of threads or not will be
5921 marked with @code{gnus-not-empty-thread-mark} and
5922 @code{gnus-empty-thread-mark} in the third column, respectively.
5923
5924 @item
5925 @vindex gnus-process-mark
5926 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
5927 variety of commands react to the presence of the process mark.  For
5928 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5929 all articles that have been marked with the process mark.  Articles
5930 marked with the process mark have a @samp{#} in the second column.
5931
5932 @end itemize
5933
5934 You might have noticed that most of these ``non-readedness'' marks
5935 appear in the second column by default.  So if you have a cached, saved,
5936 replied article that you have process-marked, what will that look like?
5937
5938 Nothing much.  The precedence rules go as follows: process -> cache ->
5939 replied -> saved.  So if the article is in the cache and is replied,
5940 you'll only see the cache mark and not the replied mark.
5941
5942
5943 @node Setting Marks
5944 @subsection Setting Marks
5945 @cindex setting marks
5946
5947 All the marking commands understand the numeric prefix.
5948
5949 @table @kbd
5950 @item M c
5951 @itemx M-u
5952 @kindex M c (Summary)
5953 @kindex M-u (Summary)
5954 @findex gnus-summary-clear-mark-forward
5955 @cindex mark as unread
5956 Clear all readedness-marks from the current article
5957 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
5958 article as unread.
5959
5960 @item M t
5961 @itemx !
5962 @kindex ! (Summary)
5963 @kindex M t (Summary)
5964 @findex gnus-summary-tick-article-forward
5965 Tick the current article (@code{gnus-summary-tick-article-forward}).
5966 @xref{Article Caching}.
5967
5968 @item M ?
5969 @itemx ?
5970 @kindex ? (Summary)
5971 @kindex M ? (Summary)
5972 @findex gnus-summary-mark-as-dormant
5973 Mark the current article as dormant
5974 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
5975
5976 @item M d
5977 @itemx d
5978 @kindex M d (Summary)
5979 @kindex d (Summary)
5980 @findex gnus-summary-mark-as-read-forward
5981 Mark the current article as read
5982 (@code{gnus-summary-mark-as-read-forward}).
5983
5984 @item D
5985 @kindex D (Summary)
5986 @findex gnus-summary-mark-as-read-backward
5987 Mark the current article as read and move point to the previous line
5988 (@code{gnus-summary-mark-as-read-backward}).
5989
5990 @item M k
5991 @itemx k
5992 @kindex k (Summary)
5993 @kindex M k (Summary)
5994 @findex gnus-summary-kill-same-subject-and-select
5995 Mark all articles that have the same subject as the current one as read,
5996 and then select the next unread article
5997 (@code{gnus-summary-kill-same-subject-and-select}).
5998
5999 @item M K
6000 @itemx C-k
6001 @kindex M K (Summary)
6002 @kindex C-k (Summary)
6003 @findex gnus-summary-kill-same-subject
6004 Mark all articles that have the same subject as the current one as read
6005 (@code{gnus-summary-kill-same-subject}).
6006
6007 @item M C
6008 @kindex M C (Summary)
6009 @findex gnus-summary-catchup
6010 @c @icon{gnus-summary-catchup}
6011 Mark all unread articles as read (@code{gnus-summary-catchup}).
6012
6013 @item M C-c
6014 @kindex M C-c (Summary)
6015 @findex gnus-summary-catchup-all
6016 Mark all articles in the group as read---even the ticked and dormant
6017 articles (@code{gnus-summary-catchup-all}).
6018
6019 @item M H
6020 @kindex M H (Summary)
6021 @findex gnus-summary-catchup-to-here
6022 Catchup the current group to point (before the point)
6023 (@code{gnus-summary-catchup-to-here}).
6024
6025 @item M h
6026 @kindex M h (Summary)
6027 @findex gnus-summary-catchup-from-here
6028 Catchup the current group from point (after the point)
6029 (@code{gnus-summary-catchup-from-here}).
6030
6031 @item C-w
6032 @kindex C-w (Summary)
6033 @findex gnus-summary-mark-region-as-read
6034 Mark all articles between point and mark as read
6035 (@code{gnus-summary-mark-region-as-read}).
6036
6037 @item M V k
6038 @kindex M V k (Summary)
6039 @findex gnus-summary-kill-below
6040 Kill all articles with scores below the default score (or below the
6041 numeric prefix) (@code{gnus-summary-kill-below}).
6042
6043 @item M e
6044 @itemx E
6045 @kindex M e (Summary)
6046 @kindex E (Summary)
6047 @findex gnus-summary-mark-as-expirable
6048 Mark the current article as expirable
6049 (@code{gnus-summary-mark-as-expirable}).
6050
6051 @item M b
6052 @kindex M b (Summary)
6053 @findex gnus-summary-set-bookmark
6054 Set a bookmark in the current article
6055 (@code{gnus-summary-set-bookmark}).
6056
6057 @item M B
6058 @kindex M B (Summary)
6059 @findex gnus-summary-remove-bookmark
6060 Remove the bookmark from the current article
6061 (@code{gnus-summary-remove-bookmark}).
6062
6063 @item M V c
6064 @kindex M V c (Summary)
6065 @findex gnus-summary-clear-above
6066 Clear all marks from articles with scores over the default score (or
6067 over the numeric prefix) (@code{gnus-summary-clear-above}).
6068
6069 @item M V u
6070 @kindex M V u (Summary)
6071 @findex gnus-summary-tick-above
6072 Tick all articles with scores over the default score (or over the
6073 numeric prefix) (@code{gnus-summary-tick-above}).
6074
6075 @item M V m
6076 @kindex M V m (Summary)
6077 @findex gnus-summary-mark-above
6078 Prompt for a mark, and mark all articles with scores over the default
6079 score (or over the numeric prefix) with this mark
6080 (@code{gnus-summary-clear-above}).
6081 @end table
6082
6083 @vindex gnus-summary-goto-unread
6084 The @code{gnus-summary-goto-unread} variable controls what action should
6085 be taken after setting a mark.  If non-@code{nil}, point will move to
6086 the next/previous unread article.  If @code{nil}, point will just move
6087 one line up or down.  As a special case, if this variable is
6088 @code{never}, all the marking commands as well as other commands (like
6089 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6090 The default is @code{t}.
6091
6092
6093 @node Generic Marking Commands
6094 @subsection Generic Marking Commands
6095
6096 Some people would like the command that ticks an article (@kbd{!}) go to
6097 the next article.  Others would like it to go to the next unread
6098 article.  Yet others would like it to stay on the current article.  And
6099 even though I haven't heard of anybody wanting it to go to the
6100 previous (unread) article, I'm sure there are people that want that as
6101 well.
6102
6103 Multiply these five behaviors with five different marking commands, and
6104 you get a potentially complex set of variable to control what each
6105 command should do.
6106
6107 To sidestep that mess, Gnus provides commands that do all these
6108 different things.  They can be found on the @kbd{M M} map in the summary
6109 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
6110 to list in this manual.
6111
6112 While you can use these commands directly, most users would prefer
6113 altering the summary mode keymap.  For instance, if you would like the
6114 @kbd{!} command to go to the next article instead of the next unread
6115 article, you could say something like:
6116
6117 @lisp
6118 @group
6119 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6120 (defun my-alter-summary-map ()
6121   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6122 @end group
6123 @end lisp
6124
6125 @noindent
6126 or
6127
6128 @lisp
6129 (defun my-alter-summary-map ()
6130   (local-set-key "!" "MM!n"))
6131 @end lisp
6132
6133
6134 @node Setting Process Marks
6135 @subsection Setting Process Marks
6136 @cindex setting process marks
6137
6138 Process marks are displayed as @code{#} in the summary buffer, and are
6139 used for marking articles in such a way that other commands will
6140 process these articles.  For instance, if you process mark four
6141 articles and then use the @kbd{*} command, Gnus will enter these four
6142 commands into the cache.  For more information,
6143 @pxref{Process/Prefix}.
6144
6145 @table @kbd
6146
6147 @item M P p
6148 @itemx #
6149 @kindex # (Summary)
6150 @kindex M P p (Summary)
6151 @findex gnus-summary-mark-as-processable
6152 Mark the current article with the process mark
6153 (@code{gnus-summary-mark-as-processable}).
6154 @findex gnus-summary-unmark-as-processable
6155
6156 @item M P u
6157 @itemx M-#
6158 @kindex M P u (Summary)
6159 @kindex M-# (Summary)
6160 Remove the process mark, if any, from the current article
6161 (@code{gnus-summary-unmark-as-processable}).
6162
6163 @item M P U
6164 @kindex M P U (Summary)
6165 @findex gnus-summary-unmark-all-processable
6166 Remove the process mark from all articles
6167 (@code{gnus-summary-unmark-all-processable}).
6168
6169 @item M P i
6170 @kindex M P i (Summary)
6171 @findex gnus-uu-invert-processable
6172 Invert the list of process marked articles
6173 (@code{gnus-uu-invert-processable}).
6174
6175 @item M P R
6176 @kindex M P R (Summary)
6177 @findex gnus-uu-mark-by-regexp
6178 Mark articles that have a @code{Subject} header that matches a regular
6179 expression (@code{gnus-uu-mark-by-regexp}).
6180
6181 @item M P G
6182 @kindex M P G (Summary)
6183 @findex gnus-uu-unmark-by-regexp
6184 Unmark articles that have a @code{Subject} header that matches a regular
6185 expression (@code{gnus-uu-unmark-by-regexp}).
6186
6187 @item M P r
6188 @kindex M P r (Summary)
6189 @findex gnus-uu-mark-region
6190 Mark articles in region (@code{gnus-uu-mark-region}).
6191
6192 @item M P g
6193 @kindex M P g (Summary)
6194 @findex gnus-uu-unmark-region
6195 Unmark articles in region (@code{gnus-uu-unmark-region}).
6196
6197 @item M P t
6198 @kindex M P t (Summary)
6199 @findex gnus-uu-mark-thread
6200 Mark all articles in the current (sub)thread
6201 (@code{gnus-uu-mark-thread}).
6202
6203 @item M P T
6204 @kindex M P T (Summary)
6205 @findex gnus-uu-unmark-thread
6206 Unmark all articles in the current (sub)thread
6207 (@code{gnus-uu-unmark-thread}).
6208
6209 @item M P v
6210 @kindex M P v (Summary)
6211 @findex gnus-uu-mark-over
6212 Mark all articles that have a score above the prefix argument
6213 (@code{gnus-uu-mark-over}).
6214
6215 @item M P s
6216 @kindex M P s (Summary)
6217 @findex gnus-uu-mark-series
6218 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6219
6220 @item M P S
6221 @kindex M P S (Summary)
6222 @findex gnus-uu-mark-sparse
6223 Mark all series that have already had some articles marked
6224 (@code{gnus-uu-mark-sparse}).
6225
6226 @item M P a
6227 @kindex M P a (Summary)
6228 @findex gnus-uu-mark-all
6229 Mark all articles in series order (@code{gnus-uu-mark-series}).
6230
6231 @item M P b
6232 @kindex M P b (Summary)
6233 @findex gnus-uu-mark-buffer
6234 Mark all articles in the buffer in the order they appear
6235 (@code{gnus-uu-mark-buffer}).
6236
6237 @item M P k
6238 @kindex M P k (Summary)
6239 @findex gnus-summary-kill-process-mark
6240 Push the current process mark set onto the stack and unmark all articles
6241 (@code{gnus-summary-kill-process-mark}).
6242
6243 @item M P y
6244 @kindex M P y (Summary)
6245 @findex gnus-summary-yank-process-mark
6246 Pop the previous process mark set from the stack and restore it
6247 (@code{gnus-summary-yank-process-mark}).
6248
6249 @item M P w
6250 @kindex M P w (Summary)
6251 @findex gnus-summary-save-process-mark
6252 Push the current process mark set onto the stack
6253 (@code{gnus-summary-save-process-mark}).
6254
6255 @end table
6256
6257 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6258 set process marks based on article body contents.
6259
6260
6261 @node Limiting
6262 @section Limiting
6263 @cindex limiting
6264
6265 It can be convenient to limit the summary buffer to just show some
6266 subset of the articles currently in the group.  The effect most limit
6267 commands have is to remove a few (or many) articles from the summary
6268 buffer.
6269
6270 All limiting commands work on subsets of the articles already fetched
6271 from the servers.  None of these commands query the server for
6272 additional articles.
6273
6274 @table @kbd
6275
6276 @item / /
6277 @itemx / s
6278 @kindex / / (Summary)
6279 @findex gnus-summary-limit-to-subject
6280 Limit the summary buffer to articles that match some subject
6281 (@code{gnus-summary-limit-to-subject}).  If given a prefix, exclude
6282 matching articles.
6283
6284 @item / a
6285 @kindex / a (Summary)
6286 @findex gnus-summary-limit-to-author
6287 Limit the summary buffer to articles that match some author
6288 (@code{gnus-summary-limit-to-author}).  If given a prefix, exclude
6289 matching articles.
6290
6291 @item / x
6292 @kindex / x (Summary)
6293 @findex gnus-summary-limit-to-extra
6294 Limit the summary buffer to articles that match one of the ``extra''
6295 headers (@pxref{To From Newsgroups})
6296 (@code{gnus-summary-limit-to-extra}).  If given a prefix, exclude
6297 matching articles.
6298
6299 @item / u
6300 @itemx x
6301 @kindex / u (Summary)
6302 @kindex x (Summary)
6303 @findex gnus-summary-limit-to-unread
6304 Limit the summary buffer to articles not marked as read
6305 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
6306 buffer to articles strictly unread.  This means that ticked and
6307 dormant articles will also be excluded.
6308
6309 @item / m
6310 @kindex / m (Summary)
6311 @findex gnus-summary-limit-to-marks
6312 Ask for a mark and then limit to all articles that have been marked
6313 with that mark (@code{gnus-summary-limit-to-marks}).
6314
6315 @item / t
6316 @kindex / t (Summary)
6317 @findex gnus-summary-limit-to-age
6318 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6319 (@code{gnus-summary-limit-to-age}).  If given a prefix, limit to
6320 articles younger than that number of days.
6321
6322 @item / n
6323 @kindex / n (Summary)
6324 @findex gnus-summary-limit-to-articles
6325 Limit the summary buffer to the current article
6326 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
6327 convention (@pxref{Process/Prefix}).
6328
6329 @item / w
6330 @kindex / w (Summary)
6331 @findex gnus-summary-pop-limit
6332 Pop the previous limit off the stack and restore it
6333 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
6334 the stack.
6335
6336 @item / .
6337 @kindex / . (Summary)
6338 @findex gnus-summary-limit-to-unseen
6339 Limit the summary buffer to the unseen articles
6340 (@code{gnus-summary-limit-to-unseen}).
6341
6342 @item / v
6343 @kindex / v (Summary)
6344 @findex gnus-summary-limit-to-score
6345 Limit the summary buffer to articles that have a score at or above some
6346 score (@code{gnus-summary-limit-to-score}).
6347
6348 @item / p
6349 @kindex / p (Summary)
6350 @findex gnus-summary-limit-to-display-predicate
6351 Limit the summary buffer to articles that satisfy the @code{display}
6352 group parameter predicate
6353 (@code{gnus-summary-limit-to-display-predicate}).  @xref{Group
6354 Parameters}, for more on this predicate.
6355
6356 @item / r
6357 @kindex / r (Summary)
6358 @findex gnus-summary-limit-to-replied
6359 Limit the summary buffer to replied articles
6360 (@code{gnus-summary-limit-to-replied}).  If given a prefix, exclude
6361 replied articles.
6362
6363 @item / E
6364 @itemx M S
6365 @kindex M S (Summary)
6366 @kindex / E (Summary)
6367 @findex gnus-summary-limit-include-expunged
6368 Include all expunged articles in the limit
6369 (@code{gnus-summary-limit-include-expunged}).
6370
6371 @item / D
6372 @kindex / D (Summary)
6373 @findex gnus-summary-limit-include-dormant
6374 Include all dormant articles in the limit
6375 (@code{gnus-summary-limit-include-dormant}).
6376
6377 @item / *
6378 @kindex / * (Summary)
6379 @findex gnus-summary-limit-include-cached
6380 Include all cached articles in the limit
6381 (@code{gnus-summary-limit-include-cached}).
6382
6383 @item / d
6384 @kindex / d (Summary)
6385 @findex gnus-summary-limit-exclude-dormant
6386 Exclude all dormant articles from the limit
6387 (@code{gnus-summary-limit-exclude-dormant}).
6388
6389 @item / M
6390 @kindex / M (Summary)
6391 @findex gnus-summary-limit-exclude-marks
6392 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6393
6394 @item / T
6395 @kindex / T (Summary)
6396 @findex gnus-summary-limit-include-thread
6397 Include all the articles in the current thread in the limit.
6398
6399 @item / c
6400 @kindex / c (Summary)
6401 @findex gnus-summary-limit-exclude-childless-dormant
6402 Exclude all dormant articles that have no children from the limit@*
6403 (@code{gnus-summary-limit-exclude-childless-dormant}).
6404
6405 @item / C
6406 @kindex / C (Summary)
6407 @findex gnus-summary-limit-mark-excluded-as-read
6408 Mark all excluded unread articles as read
6409 (@code{gnus-summary-limit-mark-excluded-as-read}).  If given a prefix,
6410 also mark excluded ticked and dormant articles as read.
6411
6412 @item / N
6413 @kindex / N (Summary)
6414 @findex gnus-summary-insert-new-articles
6415 Insert all new articles in the summary buffer.  It scans for new emails
6416 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6417
6418 @item / o
6419 @kindex / o (Summary)
6420 @findex gnus-summary-insert-old-articles
6421 Insert all old articles in the summary buffer.  If given a numbered
6422 prefix, fetch this number of articles.
6423
6424 @end table
6425
6426
6427 @node Threading
6428 @section Threading
6429 @cindex threading
6430 @cindex article threading
6431
6432 Gnus threads articles by default.  @dfn{To thread} is to put responses
6433 to articles directly after the articles they respond to---in a
6434 hierarchical fashion.
6435
6436 Threading is done by looking at the @code{References} headers of the
6437 articles.  In a perfect world, this would be enough to build pretty
6438 trees, but unfortunately, the @code{References} header is often broken
6439 or simply missing.  Weird news propagation exacerbates the problem,
6440 so one has to employ other heuristics to get pleasing results.  A
6441 plethora of approaches exists, as detailed in horrible detail in
6442 @ref{Customizing Threading}.
6443
6444 First, a quick overview of the concepts:
6445
6446 @table @dfn
6447 @item root
6448 The top-most article in a thread; the first article in the thread.
6449
6450 @item thread
6451 A tree-like article structure.
6452
6453 @item sub-thread
6454 A small(er) section of this tree-like structure.
6455
6456 @item loose threads
6457 Threads often lose their roots due to article expiry, or due to the root
6458 already having been read in a previous session, and not displayed in the
6459 summary buffer.  We then typically have many sub-threads that really
6460 belong to one thread, but are without connecting roots.  These are
6461 called loose threads.
6462
6463 @item thread gathering
6464 An attempt to gather loose threads into bigger threads.
6465
6466 @item sparse threads
6467 A thread where the missing articles have been ``guessed'' at, and are
6468 displayed as empty lines in the summary buffer.
6469
6470 @end table
6471
6472
6473 @menu
6474 * Customizing Threading::       Variables you can change to affect the threading.
6475 * Thread Commands::             Thread based commands in the summary buffer.
6476 @end menu
6477
6478
6479 @node Customizing Threading
6480 @subsection Customizing Threading
6481 @cindex customizing threading
6482
6483 @menu
6484 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
6485 * Filling In Threads::          Making the threads displayed look fuller.
6486 * More Threading::              Even more variables for fiddling with threads.
6487 * Low-Level Threading::         You thought it was over@dots{} but you were wrong!
6488 @end menu
6489
6490
6491 @node Loose Threads
6492 @subsubsection Loose Threads
6493 @cindex <
6494 @cindex >
6495 @cindex loose threads
6496
6497 @table @code
6498 @item gnus-summary-make-false-root
6499 @vindex gnus-summary-make-false-root
6500 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6501 and create a dummy root at the top.  (Wait a minute.  Root at the top?
6502 Yup.)  Loose subtrees occur when the real root has expired, or you've
6503 read or killed the root in a previous session.
6504
6505 When there is no real root of a thread, Gnus will have to fudge
6506 something.  This variable says what fudging method Gnus should use.
6507 There are four possible values:
6508
6509 @iftex
6510 @iflatex
6511 \gnusfigure{The Summary Buffer}{390}{
6512 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6513 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6514 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6515 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6516 }
6517 @end iflatex
6518 @end iftex
6519
6520 @cindex adopting articles
6521
6522 @table @code
6523
6524 @item adopt
6525 Gnus will make the first of the orphaned articles the parent.  This
6526 parent will adopt all the other articles.  The adopted articles will be
6527 marked as such by pointy brackets (@samp{<>}) instead of the standard
6528 square brackets (@samp{[]}).  This is the default method.
6529
6530 @item dummy
6531 @vindex gnus-summary-dummy-line-format
6532 @vindex gnus-summary-make-false-root-always
6533 Gnus will create a dummy summary line that will pretend to be the
6534 parent.  This dummy line does not correspond to any real article, so
6535 selecting it will just select the first real article after the dummy
6536 article.  @code{gnus-summary-dummy-line-format} is used to specify the
6537 format of the dummy roots.  It accepts only one format spec:  @samp{S},
6538 which is the subject of the article.  @xref{Formatting Variables}.
6539 If you want all threads to have a dummy root, even the non-gathered
6540 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6541
6542 @item empty
6543 Gnus won't actually make any article the parent, but simply leave the
6544 subject field of all orphans except the first empty.  (Actually, it will
6545 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6546 Buffer Format}).)
6547
6548 @item none
6549 Don't make any article parent at all.  Just gather the threads and
6550 display them after one another.
6551
6552 @item nil
6553 Don't gather loose threads.
6554 @end table
6555
6556 @item gnus-summary-gather-subject-limit
6557 @vindex gnus-summary-gather-subject-limit
6558 Loose threads are gathered by comparing subjects of articles.  If this
6559 variable is @code{nil}, Gnus requires an exact match between the
6560 subjects of the loose threads before gathering them into one big
6561 super-thread.  This might be too strict a requirement, what with the
6562 presence of stupid newsreaders that chop off long subject lines.  If
6563 you think so, set this variable to, say, 20 to require that only the
6564 first 20 characters of the subjects have to match.  If you set this
6565 variable to a really low number, you'll find that Gnus will gather
6566 everything in sight into one thread, which isn't very helpful.
6567
6568 @cindex fuzzy article gathering
6569 If you set this variable to the special value @code{fuzzy}, Gnus will
6570 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6571 Matching}).
6572
6573 @item gnus-simplify-subject-fuzzy-regexp
6574 @vindex gnus-simplify-subject-fuzzy-regexp
6575 This can either be a regular expression or list of regular expressions
6576 that match strings that will be removed from subjects if fuzzy subject
6577 simplification is used.
6578
6579 @item gnus-simplify-ignored-prefixes
6580 @vindex gnus-simplify-ignored-prefixes
6581 If you set @code{gnus-summary-gather-subject-limit} to something as low
6582 as 10, you might consider setting this variable to something sensible:
6583
6584 @c Written by Michael Ernst <mernst@cs.rice.edu>
6585 @lisp
6586 (setq gnus-simplify-ignored-prefixes
6587       (concat
6588        "\\`\\[?\\("
6589        (mapconcat
6590         'identity
6591         '("looking"
6592           "wanted" "followup" "summary\\( of\\)?"
6593           "help" "query" "problem" "question"
6594           "answer" "reference" "announce"
6595           "How can I" "How to" "Comparison of"
6596           ;; ...
6597           )
6598         "\\|")
6599        "\\)\\s *\\("
6600        (mapconcat 'identity
6601                   '("for" "for reference" "with" "about")
6602                   "\\|")
6603        "\\)?\\]?:?[ \t]*"))
6604 @end lisp
6605
6606 All words that match this regexp will be removed before comparing two
6607 subjects.
6608
6609 @item gnus-simplify-subject-functions
6610 @vindex gnus-simplify-subject-functions
6611 If non-@code{nil}, this variable overrides
6612 @code{gnus-summary-gather-subject-limit}.  This variable should be a
6613 list of functions to apply to the @code{Subject} string iteratively to
6614 arrive at the simplified version of the string.
6615
6616 Useful functions to put in this list include:
6617
6618 @table @code
6619 @item gnus-simplify-subject-re
6620 @findex gnus-simplify-subject-re
6621 Strip the leading @samp{Re:}.
6622
6623 @item gnus-simplify-subject-fuzzy
6624 @findex gnus-simplify-subject-fuzzy
6625 Simplify fuzzily.
6626
6627 @item gnus-simplify-whitespace
6628 @findex gnus-simplify-whitespace
6629 Remove excessive whitespace.
6630
6631 @item gnus-simplify-all-whitespace
6632 @findex gnus-simplify-all-whitespace
6633 Remove all whitespace.
6634 @end table
6635
6636 You may also write your own functions, of course.
6637
6638
6639 @item gnus-summary-gather-exclude-subject
6640 @vindex gnus-summary-gather-exclude-subject
6641 Since loose thread gathering is done on subjects only, that might lead
6642 to many false hits, especially with certain common subjects like
6643 @samp{} and @samp{(none)}.  To make the situation slightly better,
6644 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6645 what subjects should be excluded from the gathering process.@*
6646 The default is @samp{^ *$\\|^(none)$}.
6647
6648 @item gnus-summary-thread-gathering-function
6649 @vindex gnus-summary-thread-gathering-function
6650 Gnus gathers threads by looking at @code{Subject} headers.  This means
6651 that totally unrelated articles may end up in the same ``thread'', which
6652 is confusing.  An alternate approach is to look at all the
6653 @code{Message-ID}s in all the @code{References} headers to find matches.
6654 This will ensure that no gathered threads ever include unrelated
6655 articles, but it also means that people who have posted with broken
6656 newsreaders won't be gathered properly.  The choice is yours---plague or
6657 cholera:
6658
6659 @table @code
6660 @item gnus-gather-threads-by-subject
6661 @findex gnus-gather-threads-by-subject
6662 This function is the default gathering function and looks at
6663 @code{Subject}s exclusively.
6664
6665 @item gnus-gather-threads-by-references
6666 @findex gnus-gather-threads-by-references
6667 This function looks at @code{References} headers exclusively.
6668 @end table
6669
6670 If you want to test gathering by @code{References}, you could say
6671 something like:
6672
6673 @lisp
6674 (setq gnus-summary-thread-gathering-function
6675       'gnus-gather-threads-by-references)
6676 @end lisp
6677
6678 @end table
6679
6680
6681 @node Filling In Threads
6682 @subsubsection Filling In Threads
6683
6684 @table @code
6685 @item gnus-fetch-old-headers
6686 @vindex gnus-fetch-old-headers
6687 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6688 more old headers---headers to articles marked as read.  If you would
6689 like to display as few summary lines as possible, but still connect as
6690 many loose threads as possible, you should set this variable to
6691 @code{some} or a number.  If you set it to a number, no more than that
6692 number of extra old headers will be fetched.  In either case, fetching
6693 old headers only works if the back end you are using carries overview
6694 files---this would normally be @code{nntp}, @code{nnspool},
6695 @code{nnml}, and @code{nnmaildir}.  Also remember that if the root of
6696 the thread has been expired by the server, there's not much Gnus can
6697 do about that.
6698
6699 This variable can also be set to @code{invisible}.  This won't have any
6700 visible effects, but is useful if you use the @kbd{A T} command a lot
6701 (@pxref{Finding the Parent}).
6702
6703 @item gnus-fetch-old-ephemeral-headers
6704 @vindex gnus-fetch-old-ephemeral-headers
6705 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
6706 newsgroups.
6707
6708 @item gnus-build-sparse-threads
6709 @vindex gnus-build-sparse-threads
6710 Fetching old headers can be slow.  A low-rent similar effect can be
6711 gotten by setting this variable to @code{some}.  Gnus will then look at
6712 the complete @code{References} headers of all articles and try to string
6713 together articles that belong in the same thread.  This will leave
6714 @dfn{gaps} in the threading display where Gnus guesses that an article
6715 is missing from the thread.  (These gaps appear like normal summary
6716 lines.  If you select a gap, Gnus will try to fetch the article in
6717 question.)  If this variable is @code{t}, Gnus will display all these
6718 ``gaps'' without regard for whether they are useful for completing the
6719 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
6720 off sparse leaf nodes that don't lead anywhere.  This variable is
6721 @code{nil} by default.
6722
6723 @item gnus-read-all-available-headers
6724 @vindex gnus-read-all-available-headers
6725 This is a rather obscure variable that few will find useful.  It's
6726 intended for those non-news newsgroups where the back end has to fetch
6727 quite a lot to present the summary buffer, and where it's impossible to
6728 go back to parents of articles.  This is mostly the case in the
6729 web-based groups, like the @code{nnultimate} groups.
6730
6731 If you don't use those, then it's safe to leave this as the default
6732 @code{nil}.  If you want to use this variable, it should be a regexp
6733 that matches the group name, or @code{t} for all groups.
6734
6735 @end table
6736
6737
6738 @node More Threading
6739 @subsubsection More Threading
6740
6741 @table @code
6742 @item gnus-show-threads
6743 @vindex gnus-show-threads
6744 If this variable is @code{nil}, no threading will be done, and all of
6745 the rest of the variables here will have no effect.  Turning threading
6746 off will speed group selection up a bit, but it is sure to make reading
6747 slower and more awkward.
6748
6749 @item gnus-thread-hide-subtree
6750 @vindex gnus-thread-hide-subtree
6751 If non-@code{nil}, all threads will be hidden when the summary buffer is
6752 generated.
6753
6754 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6755 Available predicates are @code{gnus-article-unread-p} and
6756 @code{gnus-article-unseen-p}.
6757
6758 Here's an example:
6759
6760 @lisp
6761 (setq gnus-thread-hide-subtree
6762       '(or gnus-article-unread-p
6763            gnus-article-unseen-p))
6764 @end lisp
6765
6766 (It's a pretty nonsensical example, since all unseen articles are also
6767 unread, but you get my drift.)
6768
6769
6770 @item gnus-thread-expunge-below
6771 @vindex gnus-thread-expunge-below
6772 All threads that have a total score (as defined by
6773 @code{gnus-thread-score-function}) less than this number will be
6774 expunged.  This variable is @code{nil} by default, which means that no
6775 threads are expunged.
6776
6777 @item gnus-thread-hide-killed
6778 @vindex gnus-thread-hide-killed
6779 if you kill a thread and this variable is non-@code{nil}, the subtree
6780 will be hidden.
6781
6782 @item gnus-thread-ignore-subject
6783 @vindex gnus-thread-ignore-subject
6784 Sometimes somebody changes the subject in the middle of a thread.  If
6785 this variable is non-@code{nil}, which is the default, the subject
6786 change is ignored.  If it is @code{nil}, a change in the subject will
6787 result in a new thread.
6788
6789 @item gnus-thread-indent-level
6790 @vindex gnus-thread-indent-level
6791 This is a number that says how much each sub-thread should be indented.
6792 The default is 4.
6793
6794 @item gnus-sort-gathered-threads-function
6795 @vindex gnus-sort-gathered-threads-function
6796 Sometimes, particularly with mailing lists, the order in which mails
6797 arrive locally is not necessarily the same as the order in which they
6798 arrived on the mailing list.  Consequently, when sorting sub-threads
6799 using the default @code{gnus-thread-sort-by-number}, responses can end
6800 up appearing before the article to which they are responding to.
6801 Setting this variable to an alternate value
6802 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6803 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6804 more logical sub-thread ordering in such instances.
6805
6806 @end table
6807
6808
6809 @node Low-Level Threading
6810 @subsubsection Low-Level Threading
6811
6812 @table @code
6813
6814 @item gnus-parse-headers-hook
6815 @vindex gnus-parse-headers-hook
6816 Hook run before parsing any headers.
6817
6818 @item gnus-alter-header-function
6819 @vindex gnus-alter-header-function
6820 If non-@code{nil}, this function will be called to allow alteration of
6821 article header structures.  The function is called with one parameter,
6822 the article header vector, which it may alter in any way.  For instance,
6823 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6824 in systematic ways (by adding prefixes and such), you can use this
6825 variable to un-scramble the @code{Message-ID}s so that they are more
6826 meaningful.  Here's one example:
6827
6828 @lisp
6829 (setq gnus-alter-header-function 'my-alter-message-id)
6830
6831 (defun my-alter-message-id (header)
6832   (let ((id (mail-header-id header)))
6833     (when (string-match
6834            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6835       (mail-header-set-id
6836        (concat (match-string 1 id) "@@" (match-string 2 id))
6837        header))))
6838 @end lisp
6839
6840 @end table
6841
6842
6843 @node Thread Commands
6844 @subsection Thread Commands
6845 @cindex thread commands
6846
6847 @table @kbd
6848
6849 @item T k
6850 @itemx C-M-k
6851 @kindex T k (Summary)
6852 @kindex C-M-k (Summary)
6853 @findex gnus-summary-kill-thread
6854 Mark all articles in the current (sub-)thread as read
6855 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
6856 remove all marks instead.  If the prefix argument is negative, tick
6857 articles instead.
6858
6859 @item T l
6860 @itemx C-M-l
6861 @kindex T l (Summary)
6862 @kindex C-M-l (Summary)
6863 @findex gnus-summary-lower-thread
6864 Lower the score of the current (sub-)thread
6865 (@code{gnus-summary-lower-thread}).
6866
6867 @item T i
6868 @kindex T i (Summary)
6869 @findex gnus-summary-raise-thread
6870 Increase the score of the current (sub-)thread
6871 (@code{gnus-summary-raise-thread}).
6872
6873 @item T #
6874 @kindex T # (Summary)
6875 @findex gnus-uu-mark-thread
6876 Set the process mark on the current (sub-)thread
6877 (@code{gnus-uu-mark-thread}).
6878
6879 @item T M-#
6880 @kindex T M-# (Summary)
6881 @findex gnus-uu-unmark-thread
6882 Remove the process mark from the current (sub-)thread
6883 (@code{gnus-uu-unmark-thread}).
6884
6885 @item T T
6886 @kindex T T (Summary)
6887 @findex gnus-summary-toggle-threads
6888 Toggle threading (@code{gnus-summary-toggle-threads}).
6889
6890 @item T s
6891 @kindex T s (Summary)
6892 @findex gnus-summary-show-thread
6893 Expose the (sub-)thread hidden under the current article, if any@*
6894 (@code{gnus-summary-show-thread}).
6895
6896 @item T h
6897 @kindex T h (Summary)
6898 @findex gnus-summary-hide-thread
6899 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6900
6901 @item T S
6902 @kindex T S (Summary)
6903 @findex gnus-summary-show-all-threads
6904 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6905
6906 @item T H
6907 @kindex T H (Summary)
6908 @findex gnus-summary-hide-all-threads
6909 Hide all threads (@code{gnus-summary-hide-all-threads}).
6910
6911 @item T t
6912 @kindex T t (Summary)
6913 @findex gnus-summary-rethread-current
6914 Re-thread the current article's thread
6915 (@code{gnus-summary-rethread-current}).  This works even when the
6916 summary buffer is otherwise unthreaded.
6917
6918 @item T ^
6919 @kindex T ^ (Summary)
6920 @findex gnus-summary-reparent-thread
6921 Make the current article the child of the marked (or previous) article
6922 (@code{gnus-summary-reparent-thread}).
6923
6924 @end table
6925
6926 The following commands are thread movement commands.  They all
6927 understand the numeric prefix.
6928
6929 @table @kbd
6930
6931 @item T n
6932 @kindex T n (Summary)
6933 @itemx C-M-f
6934 @kindex C-M-n (Summary)
6935 @itemx M-down
6936 @kindex M-down (Summary)
6937 @findex gnus-summary-next-thread
6938 Go to the next thread (@code{gnus-summary-next-thread}).
6939
6940 @item T p
6941 @kindex T p (Summary)
6942 @itemx C-M-b
6943 @kindex C-M-p (Summary)
6944 @itemx M-up
6945 @kindex M-up (Summary)
6946 @findex gnus-summary-prev-thread
6947 Go to the previous thread (@code{gnus-summary-prev-thread}).
6948
6949 @item T d
6950 @kindex T d (Summary)
6951 @findex gnus-summary-down-thread
6952 Descend the thread (@code{gnus-summary-down-thread}).
6953
6954 @item T u
6955 @kindex T u (Summary)
6956 @findex gnus-summary-up-thread
6957 Ascend the thread (@code{gnus-summary-up-thread}).
6958
6959 @item T o
6960 @kindex T o (Summary)
6961 @findex gnus-summary-top-thread
6962 Go to the top of the thread (@code{gnus-summary-top-thread}).
6963 @end table
6964
6965 @vindex gnus-thread-operation-ignore-subject
6966 If you ignore subject while threading, you'll naturally end up with
6967 threads that have several different subjects in them.  If you then issue
6968 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
6969 wish to kill the entire thread, but just those parts of the thread that
6970 have the same subject as the current article.  If you like this idea,
6971 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
6972 is non-@code{nil} (which it is by default), subjects will be ignored
6973 when doing thread commands.  If this variable is @code{nil}, articles in
6974 the same thread with different subjects will not be included in the
6975 operation in question.  If this variable is @code{fuzzy}, only articles
6976 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6977 Matching}).
6978
6979
6980 @node Sorting the Summary Buffer
6981 @section Sorting the Summary Buffer
6982
6983 @findex gnus-thread-sort-by-total-score
6984 @findex gnus-thread-sort-by-date
6985 @findex gnus-thread-sort-by-score
6986 @findex gnus-thread-sort-by-subject
6987 @findex gnus-thread-sort-by-author
6988 @findex gnus-thread-sort-by-number
6989 @findex gnus-thread-sort-by-random
6990 @vindex gnus-thread-sort-functions
6991 @findex gnus-thread-sort-by-most-recent-number
6992 @findex gnus-thread-sort-by-most-recent-date
6993 If you are using a threaded summary display, you can sort the threads by
6994 setting @code{gnus-thread-sort-functions}, which can be either a single
6995 function, a list of functions, or a list containing functions and
6996 @code{(not some-function)} elements.
6997
6998 By default, sorting is done on article numbers.  Ready-made sorting
6999 predicate functions include @code{gnus-thread-sort-by-number},
7000 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
7001 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
7002 @code{gnus-thread-sort-by-most-recent-number},
7003 @code{gnus-thread-sort-by-most-recent-date},
7004 @code{gnus-thread-sort-by-random} and
7005 @code{gnus-thread-sort-by-total-score}.
7006
7007 Each function takes two threads and returns non-@code{nil} if the first
7008 thread should be sorted before the other.  Note that sorting really is
7009 normally done by looking only at the roots of each thread.
7010
7011 If you use more than one function, the primary sort key should be the
7012 last function in the list.  You should probably always include
7013 @code{gnus-thread-sort-by-number} in the list of sorting
7014 functions---preferably first.  This will ensure that threads that are
7015 equal with respect to the other sort criteria will be displayed in
7016 ascending article order.
7017
7018 If you would like to sort by reverse score, then by subject, and finally
7019 by number, you could do something like:
7020
7021 @lisp
7022 (setq gnus-thread-sort-functions
7023       '(gnus-thread-sort-by-number
7024         gnus-thread-sort-by-subject
7025         (not gnus-thread-sort-by-total-score)))
7026 @end lisp
7027
7028 The threads that have highest score will be displayed first in the
7029 summary buffer.  When threads have the same score, they will be sorted
7030 alphabetically.  The threads that have the same score and the same
7031 subject will be sorted by number, which is (normally) the sequence in
7032 which the articles arrived.
7033
7034 If you want to sort by score and then reverse arrival order, you could
7035 say something like:
7036
7037 @lisp
7038 (setq gnus-thread-sort-functions
7039       '((lambda (t1 t2)
7040           (not (gnus-thread-sort-by-number t1 t2)))
7041         gnus-thread-sort-by-score))
7042 @end lisp
7043
7044 @vindex gnus-thread-score-function
7045 The function in the @code{gnus-thread-score-function} variable (default
7046 @code{+}) is used for calculating the total score of a thread.  Useful
7047 functions might be @code{max}, @code{min}, or squared means, or whatever
7048 tickles your fancy.
7049
7050 @findex gnus-article-sort-functions
7051 @findex gnus-article-sort-by-date
7052 @findex gnus-article-sort-by-score
7053 @findex gnus-article-sort-by-subject
7054 @findex gnus-article-sort-by-author
7055 @findex gnus-article-sort-by-random
7056 @findex gnus-article-sort-by-number
7057 If you are using an unthreaded display for some strange reason or
7058 other, you have to fiddle with the @code{gnus-article-sort-functions}
7059 variable.  It is very similar to the
7060 @code{gnus-thread-sort-functions}, except that it uses slightly
7061 different functions for article comparison.  Available sorting
7062 predicate functions are @code{gnus-article-sort-by-number},
7063 @code{gnus-article-sort-by-author},
7064 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7065 @code{gnus-article-sort-by-random}, and
7066 @code{gnus-article-sort-by-score}.
7067
7068 If you want to sort an unthreaded summary display by subject, you could
7069 say something like:
7070
7071 @lisp
7072 (setq gnus-article-sort-functions
7073       '(gnus-article-sort-by-number
7074         gnus-article-sort-by-subject))
7075 @end lisp
7076
7077
7078
7079 @node Asynchronous Fetching
7080 @section Asynchronous Article Fetching
7081 @cindex asynchronous article fetching
7082 @cindex article pre-fetch
7083 @cindex pre-fetch
7084
7085 If you read your news from an @acronym{NNTP} server that's far away, the
7086 network latencies may make reading articles a chore.  You have to wait
7087 for a while after pressing @kbd{n} to go to the next article before the
7088 article appears.  Why can't Gnus just go ahead and fetch the article
7089 while you are reading the previous one?  Why not, indeed.
7090
7091 First, some caveats.  There are some pitfalls to using asynchronous
7092 article fetching, especially the way Gnus does it.
7093
7094 Let's say you are reading article 1, which is short, and article 2 is
7095 quite long, and you are not interested in reading that.  Gnus does not
7096 know this, so it goes ahead and fetches article 2.  You decide to read
7097 article 3, but since Gnus is in the process of fetching article 2, the
7098 connection is blocked.
7099
7100 To avoid these situations, Gnus will open two (count 'em two)
7101 connections to the server.  Some people may think this isn't a very nice
7102 thing to do, but I don't see any real alternatives.  Setting up that
7103 extra connection takes some time, so Gnus startup will be slower.
7104
7105 Gnus will fetch more articles than you will read.  This will mean that
7106 the link between your machine and the @acronym{NNTP} server will become more
7107 loaded than if you didn't use article pre-fetch.  The server itself will
7108 also become more loaded---both with the extra article requests, and the
7109 extra connection.
7110
7111 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7112 you really want to.
7113
7114 @vindex gnus-asynchronous
7115 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
7116 happen automatically.
7117
7118 @vindex gnus-use-article-prefetch
7119 You can control how many articles are to be pre-fetched by setting
7120 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
7121 that when you read an article in the group, the back end will pre-fetch
7122 the next 30 articles.  If this variable is @code{t}, the back end will
7123 pre-fetch all the articles it can without bound.  If it is
7124 @code{nil}, no pre-fetching will be done.
7125
7126 @vindex gnus-async-prefetch-article-p
7127 @findex gnus-async-read-p
7128 There are probably some articles that you don't want to pre-fetch---read
7129 articles, for instance.  The @code{gnus-async-prefetch-article-p}
7130 variable controls whether an article is to be pre-fetched.  This
7131 function should return non-@code{nil} when the article in question is
7132 to be pre-fetched.  The default is @code{gnus-async-read-p}, which
7133 returns @code{nil} on read articles.  The function is called with an
7134 article data structure as the only parameter.
7135
7136 If, for instance, you wish to pre-fetch only unread articles shorter
7137 than 100 lines, you could say something like:
7138
7139 @lisp
7140 (defun my-async-short-unread-p (data)
7141   "Return non-nil for short, unread articles."
7142   (and (gnus-data-unread-p data)
7143        (< (mail-header-lines (gnus-data-header data))
7144           100)))
7145
7146 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7147 @end lisp
7148
7149 These functions will be called many, many times, so they should
7150 preferably be short and sweet to avoid slowing down Gnus too much.
7151 It's probably a good idea to byte-compile things like this.
7152
7153 @vindex gnus-prefetched-article-deletion-strategy
7154 Articles have to be removed from the asynch buffer sooner or later.  The
7155 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7156 articles.  This is a list that may contain the following elements:
7157
7158 @table @code
7159 @item read
7160 Remove articles when they are read.
7161
7162 @item exit
7163 Remove articles when exiting the group.
7164 @end table
7165
7166 The default value is @code{(read exit)}.
7167
7168 @c @vindex gnus-use-header-prefetch
7169 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7170 @c from the next group.
7171
7172
7173 @node Article Caching
7174 @section Article Caching
7175 @cindex article caching
7176 @cindex caching
7177
7178 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7179 consider turning article caching on.  Each article will then be stored
7180 locally under your home directory.  As you may surmise, this could
7181 potentially use @emph{huge} amounts of disk space, as well as eat up all
7182 your inodes so fast it will make your head swim.  In vodka.
7183
7184 Used carefully, though, it could be just an easier way to save articles.
7185
7186 @vindex gnus-use-long-file-name
7187 @vindex gnus-cache-directory
7188 @vindex gnus-use-cache
7189 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
7190 all articles ticked or marked as dormant will then be copied
7191 over to your local cache (@code{gnus-cache-directory}).  Whether this
7192 cache is flat or hierarchical is controlled by the
7193 @code{gnus-use-long-file-name} variable, as usual.
7194
7195 When re-selecting a ticked or dormant article, it will be fetched from the
7196 cache instead of from the server.  As articles in your cache will never
7197 expire, this might serve as a method of saving articles while still
7198 keeping them where they belong.  Just mark all articles you want to save
7199 as dormant, and don't worry.
7200
7201 When an article is marked as read, is it removed from the cache.
7202
7203 @vindex gnus-cache-remove-articles
7204 @vindex gnus-cache-enter-articles
7205 The entering/removal of articles from the cache is controlled by the
7206 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7207 variables.  Both are lists of symbols.  The first is @code{(ticked
7208 dormant)} by default, meaning that ticked and dormant articles will be
7209 put in the cache.  The latter is @code{(read)} by default, meaning that
7210 articles marked as read are removed from the cache.  Possibly
7211 symbols in these two lists are @code{ticked}, @code{dormant},
7212 @code{unread} and @code{read}.
7213
7214 @findex gnus-jog-cache
7215 So where does the massive article-fetching and storing come into the
7216 picture?  The @code{gnus-jog-cache} command will go through all
7217 subscribed newsgroups, request all unread articles, score them, and
7218 store them in the cache.  You should only ever, ever ever ever, use this
7219 command if 1) your connection to the @acronym{NNTP} server is really, really,
7220 really slow and 2) you have a really, really, really huge disk.
7221 Seriously.  One way to cut down on the number of articles downloaded is
7222 to score unwanted articles down and have them marked as read.  They will
7223 not then be downloaded by this command.
7224
7225 @vindex gnus-uncacheable-groups
7226 @vindex gnus-cacheable-groups
7227 It is likely that you do not want caching on all groups.  For instance,
7228 if your @code{nnml} mail is located under your home directory, it makes no
7229 sense to cache it somewhere else under your home directory.  Unless you
7230 feel that it's neat to use twice as much space.
7231
7232 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7233 regexp of groups to cache, @samp{^nntp} for instance, or set the
7234 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7235 Both variables are @code{nil} by default.  If a group matches both
7236 variables, the group is not cached.
7237
7238 @findex gnus-cache-generate-nov-databases
7239 @findex gnus-cache-generate-active
7240 @vindex gnus-cache-active-file
7241 The cache stores information on what articles it contains in its active
7242 file (@code{gnus-cache-active-file}).  If this file (or any other parts
7243 of the cache) becomes all messed up for some reason or other, Gnus
7244 offers two functions that will try to set things right.  @kbd{M-x
7245 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7246 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7247 file.
7248
7249 @findex gnus-cache-move-cache
7250 @code{gnus-cache-move-cache} will move your whole
7251 @code{gnus-cache-directory} to some other location.  You get asked to
7252 where, isn't that cool?
7253
7254 @node Persistent Articles
7255 @section Persistent Articles
7256 @cindex persistent articles
7257
7258 Closely related to article caching, we have @dfn{persistent articles}.
7259 In fact, it's just a different way of looking at caching, and much more
7260 useful in my opinion.
7261
7262 Say you're reading a newsgroup, and you happen on to some valuable gem
7263 that you want to keep and treasure forever.  You'd normally just save it
7264 (using one of the many saving commands) in some file.  The problem with
7265 that is that it's just, well, yucky.  Ideally you'd prefer just having
7266 the article remain in the group where you found it forever; untouched by
7267 the expiry going on at the news server.
7268
7269 This is what a @dfn{persistent article} is---an article that just won't
7270 be deleted.  It's implemented using the normal cache functions, but
7271 you use two explicit commands for managing persistent articles:
7272
7273 @table @kbd
7274
7275 @item *
7276 @kindex * (Summary)
7277 @findex gnus-cache-enter-article
7278 Make the current article persistent (@code{gnus-cache-enter-article}).
7279
7280 @item M-*
7281 @kindex M-* (Summary)
7282 @findex gnus-cache-remove-article
7283 Remove the current article from the persistent articles
7284 (@code{gnus-cache-remove-article}).  This will normally delete the
7285 article.
7286 @end table
7287
7288 Both these commands understand the process/prefix convention.
7289
7290 To avoid having all ticked articles (and stuff) entered into the cache,
7291 you should set @code{gnus-use-cache} to @code{passive} if you're just
7292 interested in persistent articles:
7293
7294 @lisp
7295 (setq gnus-use-cache 'passive)
7296 @end lisp
7297
7298
7299 @node Article Backlog
7300 @section Article Backlog
7301 @cindex backlog
7302 @cindex article backlog
7303
7304 If you have a slow connection, but the idea of using caching seems
7305 unappealing to you (and it is, really), you can help the situation some
7306 by switching on the @dfn{backlog}.  This is where Gnus will buffer
7307 already read articles so that it doesn't have to re-fetch articles
7308 you've already read.  This only helps if you are in the habit of
7309 re-selecting articles you've recently read, of course.  If you never do
7310 that, turning the backlog on will slow Gnus down a little bit, and
7311 increase memory usage some.
7312
7313 @vindex gnus-keep-backlog
7314 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7315 at most @var{n} old articles in a buffer for later re-fetching.  If this
7316 variable is non-@code{nil} and is not a number, Gnus will store
7317 @emph{all} read articles, which means that your Emacs will grow without
7318 bound before exploding and taking your machine down with you.  I put
7319 that in there just to keep y'all on your toes.
7320
7321 The default value is 20.
7322
7323
7324 @node Saving Articles
7325 @section Saving Articles
7326 @cindex saving articles
7327
7328 Gnus can save articles in a number of ways.  Below is the documentation
7329 for saving articles in a fairly straight-forward fashion (i.e., little
7330 processing of the article is done before it is saved).  For a different
7331 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7332 (@pxref{Decoding Articles}).
7333
7334 For the commands listed here, the target is a file.  If you want to
7335 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7336 command (@pxref{Mail Group Commands}).
7337
7338 @vindex gnus-save-all-headers
7339 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7340 unwanted headers before saving the article.
7341
7342 @vindex gnus-saved-headers
7343 If the preceding variable is @code{nil}, all headers that match the
7344 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7345 deleted before saving.
7346
7347 @table @kbd
7348
7349 @item O o
7350 @itemx o
7351 @kindex O o (Summary)
7352 @kindex o (Summary)
7353 @findex gnus-summary-save-article
7354 @c @icon{gnus-summary-save-article}
7355 Save the current article using the default article saver
7356 (@code{gnus-summary-save-article}).
7357
7358 @item O m
7359 @kindex O m (Summary)
7360 @findex gnus-summary-save-article-mail
7361 Save the current article in mail format
7362 (@code{gnus-summary-save-article-mail}).
7363
7364 @item O r
7365 @kindex O r (Summary)
7366 @findex gnus-summary-save-article-rmail
7367 Save the current article in Rmail format
7368 (@code{gnus-summary-save-article-rmail}).
7369
7370 @item O f
7371 @kindex O f (Summary)
7372 @findex gnus-summary-save-article-file
7373 @c @icon{gnus-summary-save-article-file}
7374 Save the current article in plain file format
7375 (@code{gnus-summary-save-article-file}).
7376
7377 @item O F
7378 @kindex O F (Summary)
7379 @findex gnus-summary-write-article-file
7380 Write the current article in plain file format, overwriting any previous
7381 file contents (@code{gnus-summary-write-article-file}).
7382
7383 @item O b
7384 @kindex O b (Summary)
7385 @findex gnus-summary-save-article-body-file
7386 Save the current article body in plain file format
7387 (@code{gnus-summary-save-article-body-file}).
7388
7389 @item O h
7390 @kindex O h (Summary)
7391 @findex gnus-summary-save-article-folder
7392 Save the current article in mh folder format
7393 (@code{gnus-summary-save-article-folder}).
7394
7395 @item O v
7396 @kindex O v (Summary)
7397 @findex gnus-summary-save-article-vm
7398 Save the current article in a VM folder
7399 (@code{gnus-summary-save-article-vm}).
7400
7401 @item O p
7402 @itemx |
7403 @kindex O p (Summary)
7404 @kindex | (Summary)
7405 @findex gnus-summary-pipe-output
7406 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
7407 the current article to a process (@code{gnus-summary-pipe-output}).
7408 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7409 complete headers in the piped output.
7410
7411 @item O P
7412 @kindex O P (Summary)
7413 @findex gnus-summary-muttprint
7414 @vindex gnus-summary-muttprint-program
7415 Save the current article into muttprint.  That is, print it using the
7416 external program @uref{http://muttprint.sourceforge.net/,
7417 Muttprint}.  The program name and options to use is controlled by the
7418 variable @code{gnus-summary-muttprint-program}.
7419 (@code{gnus-summary-muttprint}).
7420
7421 @end table
7422
7423 @vindex gnus-prompt-before-saving
7424 All these commands use the process/prefix convention
7425 (@pxref{Process/Prefix}).  If you save bunches of articles using these
7426 functions, you might get tired of being prompted for files to save each
7427 and every article in.  The prompting action is controlled by
7428 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7429 default, giving you that excessive prompting action you know and
7430 loathe.  If you set this variable to @code{t} instead, you'll be prompted
7431 just once for each series of articles you save.  If you like to really
7432 have Gnus do all your thinking for you, you can even set this variable
7433 to @code{nil}, which means that you will never be prompted for files to
7434 save articles in.  Gnus will simply save all the articles in the default
7435 files.
7436
7437
7438 @vindex gnus-default-article-saver
7439 You can customize the @code{gnus-default-article-saver} variable to make
7440 Gnus do what you want it to.  You can use any of the six ready-made
7441 functions below, or you can create your own.
7442
7443 @table @code
7444
7445 @item gnus-summary-save-in-rmail
7446 @findex gnus-summary-save-in-rmail
7447 @vindex gnus-rmail-save-name
7448 @findex gnus-plain-save-name
7449 This is the default format, @dfn{Babyl}.  Uses the function in the
7450 @code{gnus-rmail-save-name} variable to get a file name to save the
7451 article in.  The default is @code{gnus-plain-save-name}.
7452
7453 @item gnus-summary-save-in-mail
7454 @findex gnus-summary-save-in-mail
7455 @vindex gnus-mail-save-name
7456 Save in a Unix mail (mbox) file.  Uses the function in the
7457 @code{gnus-mail-save-name} variable to get a file name to save the
7458 article in.  The default is @code{gnus-plain-save-name}.
7459
7460 @item gnus-summary-save-in-file
7461 @findex gnus-summary-save-in-file
7462 @vindex gnus-file-save-name
7463 @findex gnus-numeric-save-name
7464 Append the article straight to an ordinary file.  Uses the function in
7465 the @code{gnus-file-save-name} variable to get a file name to save the
7466 article in.  The default is @code{gnus-numeric-save-name}.
7467
7468 @item gnus-summary-write-to-file
7469 @findex gnus-summary-write-to-file
7470 Write the article straight to an ordinary file.  The file is
7471 overwritten if it exists.  Uses the function in the
7472 @code{gnus-file-save-name} variable to get a file name to save the
7473 article in.  The default is @code{gnus-numeric-save-name}.
7474
7475 @item gnus-summary-save-body-in-file
7476 @findex gnus-summary-save-body-in-file
7477 Append the article body to an ordinary file.  Uses the function in the
7478 @code{gnus-file-save-name} variable to get a file name to save the
7479 article in.  The default is @code{gnus-numeric-save-name}.
7480
7481 @item gnus-summary-save-in-folder
7482 @findex gnus-summary-save-in-folder
7483 @findex gnus-folder-save-name
7484 @findex gnus-Folder-save-name
7485 @vindex gnus-folder-save-name
7486 @cindex rcvstore
7487 @cindex MH folders
7488 Save the article to an MH folder using @code{rcvstore} from the MH
7489 library.  Uses the function in the @code{gnus-folder-save-name} variable
7490 to get a file name to save the article in.  The default is
7491 @code{gnus-folder-save-name}, but you can also use
7492 @code{gnus-Folder-save-name}, which creates capitalized names.
7493
7494 @item gnus-summary-save-in-vm
7495 @findex gnus-summary-save-in-vm
7496 Save the article in a VM folder.  You have to have the VM mail
7497 reader to use this setting.
7498 @end table
7499
7500 @vindex gnus-article-save-directory
7501 All of these functions, except for the last one, will save the article
7502 in the @code{gnus-article-save-directory}, which is initialized from the
7503 @env{SAVEDIR} environment variable.  This is @file{~/News/} by
7504 default.
7505
7506 As you can see above, the functions use different functions to find a
7507 suitable name of a file to save the article in.  Below is a list of
7508 available functions that generate names:
7509
7510 @table @code
7511
7512 @item gnus-Numeric-save-name
7513 @findex gnus-Numeric-save-name
7514 File names like @file{~/News/Alt.andrea-dworkin/45}.
7515
7516 @item gnus-numeric-save-name
7517 @findex gnus-numeric-save-name
7518 File names like @file{~/News/alt.andrea-dworkin/45}.
7519
7520 @item gnus-Plain-save-name
7521 @findex gnus-Plain-save-name
7522 File names like @file{~/News/Alt.andrea-dworkin}.
7523
7524 @item gnus-plain-save-name
7525 @findex gnus-plain-save-name
7526 File names like @file{~/News/alt.andrea-dworkin}.
7527
7528 @item gnus-sender-save-name
7529 @findex gnus-sender-save-name
7530 File names like @file{~/News/larsi}.
7531 @end table
7532
7533 @vindex gnus-split-methods
7534 You can have Gnus suggest where to save articles by plonking a regexp into
7535 the @code{gnus-split-methods} alist.  For instance, if you would like to
7536 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7537 related to VM in @file{vm-stuff}, you could set this variable to something
7538 like:
7539
7540 @lisp
7541 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7542  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7543  (my-choosing-function "../other-dir/my-stuff")
7544  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7545 @end lisp
7546
7547 We see that this is a list where each element is a list that has two
7548 elements---the @dfn{match} and the @dfn{file}.  The match can either be
7549 a string (in which case it is used as a regexp to match on the article
7550 head); it can be a symbol (which will be called as a function with the
7551 group name as a parameter); or it can be a list (which will be
7552 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
7553 the @dfn{file} will be used as a default prompt.  In addition, the
7554 result of the operation itself will be used if the function or form
7555 called returns a string or a list of strings.
7556
7557 You basically end up with a list of file names that might be used when
7558 saving the current article.  (All ``matches'' will be used.)  You will
7559 then be prompted for what you really want to use as a name, with file
7560 name completion over the results from applying this variable.
7561
7562 This variable is @code{((gnus-article-archive-name))} by default, which
7563 means that Gnus will look at the articles it saves for an
7564 @code{Archive-name} line and use that as a suggestion for the file
7565 name.
7566
7567 Here's an example function to clean up file names somewhat.  If you have
7568 lots of mail groups called things like
7569 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7570 these group names before creating the file name to save to.  The
7571 following will do just that:
7572
7573 @lisp
7574 (defun my-save-name (group)
7575   (when (string-match "^nnml:mail." group)
7576     (substring group (match-end 0))))
7577
7578 (setq gnus-split-methods
7579       '((gnus-article-archive-name)
7580         (my-save-name)))
7581 @end lisp
7582
7583
7584 @vindex gnus-use-long-file-name
7585 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
7586 @code{nil}, all the preceding functions will replace all periods
7587 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7588 the functions will generate hierarchies of directories instead of having
7589 all the files in the top level directory
7590 (@file{~/News/alt/andrea-dworkin} instead of
7591 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
7592 on most systems.  However, for historical reasons, this is @code{nil} on
7593 Xenix and usg-unix-v machines by default.
7594
7595 This function also affects kill and score file names.  If this variable
7596 is a list, and the list contains the element @code{not-score}, long file
7597 names will not be used for score files, if it contains the element
7598 @code{not-save}, long file names will not be used for saving, and if it
7599 contains the element @code{not-kill}, long file names will not be used
7600 for kill files.
7601
7602 If you'd like to save articles in a hierarchy that looks something like
7603 a spool, you could
7604
7605 @lisp
7606 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
7607 (setq gnus-default-article-saver
7608       'gnus-summary-save-in-file)          ; @r{no encoding}
7609 @end lisp
7610
7611 Then just save with @kbd{o}.  You'd then read this hierarchy with
7612 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7613 the top level directory as the argument (@file{~/News/}).  Then just walk
7614 around to the groups/directories with @code{nneething}.
7615
7616
7617 @node Decoding Articles
7618 @section Decoding Articles
7619 @cindex decoding articles
7620
7621 Sometime users post articles (or series of articles) that have been
7622 encoded in some way or other.  Gnus can decode them for you.
7623
7624 @menu
7625 * Uuencoded Articles::          Uudecode articles.
7626 * Shell Archives::              Unshar articles.
7627 * PostScript Files::            Split PostScript.
7628 * Other Files::                 Plain save and binhex.
7629 * Decoding Variables::          Variables for a happy decoding.
7630 * Viewing Files::               You want to look at the result of the decoding?
7631 @end menu
7632
7633 @cindex series
7634 @cindex article series
7635 All these functions use the process/prefix convention
7636 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7637 the extension that a ``single article'' means ``a single series''.  Gnus
7638 can find out by itself what articles belong to a series, decode all the
7639 articles and unpack/view/save the resulting file(s).
7640
7641 Gnus guesses what articles are in the series according to the following
7642 simplish rule: The subjects must be (nearly) identical, except for the
7643 last two numbers of the line.  (Spaces are largely ignored, however.)
7644
7645 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
7646 will find all the articles that match the regexp @samp{^cat.gif
7647 ([0-9]+/[0-9]+).*$}.
7648
7649 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7650 series}, will not be properly recognized by any of the automatic viewing
7651 commands, and you have to mark the articles manually with @kbd{#}.
7652
7653
7654 @node Uuencoded Articles
7655 @subsection Uuencoded Articles
7656 @cindex uudecode
7657 @cindex uuencoded articles
7658
7659 @table @kbd
7660
7661 @item X u
7662 @kindex X u (Summary)
7663 @findex gnus-uu-decode-uu
7664 @c @icon{gnus-uu-decode-uu}
7665 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7666
7667 @item X U
7668 @kindex X U (Summary)
7669 @findex gnus-uu-decode-uu-and-save
7670 Uudecodes and saves the current series
7671 (@code{gnus-uu-decode-uu-and-save}).
7672
7673 @item X v u
7674 @kindex X v u (Summary)
7675 @findex gnus-uu-decode-uu-view
7676 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7677
7678 @item X v U
7679 @kindex X v U (Summary)
7680 @findex gnus-uu-decode-uu-and-save-view
7681 Uudecodes, views and saves the current series
7682 (@code{gnus-uu-decode-uu-and-save-view}).
7683
7684 @end table
7685
7686 Remember that these all react to the presence of articles marked with
7687 the process mark.  If, for instance, you'd like to decode and save an
7688 entire newsgroup, you'd typically do @kbd{M P a}
7689 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7690 (@code{gnus-uu-decode-uu-and-save}).
7691
7692 All this is very much different from how @code{gnus-uu} worked with
7693 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7694 the sun.  This version of @code{gnus-uu} generally assumes that you mark
7695 articles in some way (@pxref{Setting Process Marks}) and then press
7696 @kbd{X u}.
7697
7698 @vindex gnus-uu-notify-files
7699 Note: When trying to decode articles that have names matching
7700 @code{gnus-uu-notify-files}, which is hard-coded to
7701 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7702 automatically post an article on @samp{comp.unix.wizards} saying that
7703 you have just viewed the file in question.  This feature can't be turned
7704 off.
7705
7706
7707 @node Shell Archives
7708 @subsection Shell Archives
7709 @cindex unshar
7710 @cindex shell archives
7711 @cindex shared articles
7712
7713 Shell archives (``shar files'') used to be a popular way to distribute
7714 sources, but it isn't used all that much today.  In any case, we have
7715 some commands to deal with these:
7716
7717 @table @kbd
7718
7719 @item X s
7720 @kindex X s (Summary)
7721 @findex gnus-uu-decode-unshar
7722 Unshars the current series (@code{gnus-uu-decode-unshar}).
7723
7724 @item X S
7725 @kindex X S (Summary)
7726 @findex gnus-uu-decode-unshar-and-save
7727 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7728
7729 @item X v s
7730 @kindex X v s (Summary)
7731 @findex gnus-uu-decode-unshar-view
7732 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7733
7734 @item X v S
7735 @kindex X v S (Summary)
7736 @findex gnus-uu-decode-unshar-and-save-view
7737 Unshars, views and saves the current series
7738 (@code{gnus-uu-decode-unshar-and-save-view}).
7739 @end table
7740
7741
7742 @node PostScript Files
7743 @subsection PostScript Files
7744 @cindex PostScript
7745
7746 @table @kbd
7747
7748 @item X p
7749 @kindex X p (Summary)
7750 @findex gnus-uu-decode-postscript
7751 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7752
7753 @item X P
7754 @kindex X P (Summary)
7755 @findex gnus-uu-decode-postscript-and-save
7756 Unpack and save the current PostScript series
7757 (@code{gnus-uu-decode-postscript-and-save}).
7758
7759 @item X v p
7760 @kindex X v p (Summary)
7761 @findex gnus-uu-decode-postscript-view
7762 View the current PostScript series
7763 (@code{gnus-uu-decode-postscript-view}).
7764
7765 @item X v P
7766 @kindex X v P (Summary)
7767 @findex gnus-uu-decode-postscript-and-save-view
7768 View and save the current PostScript series
7769 (@code{gnus-uu-decode-postscript-and-save-view}).
7770 @end table
7771
7772
7773 @node Other Files
7774 @subsection Other Files
7775
7776 @table @kbd
7777 @item X o
7778 @kindex X o (Summary)
7779 @findex gnus-uu-decode-save
7780 Save the current series
7781 (@code{gnus-uu-decode-save}).
7782
7783 @item X b
7784 @kindex X b (Summary)
7785 @findex gnus-uu-decode-binhex
7786 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
7787 doesn't really work yet.
7788 @end table
7789
7790
7791 @node Decoding Variables
7792 @subsection Decoding Variables
7793
7794 Adjective, not verb.
7795
7796 @menu
7797 * Rule Variables::              Variables that say how a file is to be viewed.
7798 * Other Decode Variables::      Other decode variables.
7799 * Uuencoding and Posting::      Variables for customizing uuencoding.
7800 @end menu
7801
7802
7803 @node Rule Variables
7804 @subsubsection Rule Variables
7805 @cindex rule variables
7806
7807 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
7808 variables are of the form
7809
7810 @lisp
7811       (list '(regexp1 command2)
7812             '(regexp2 command2)
7813             ...)
7814 @end lisp
7815
7816 @table @code
7817
7818 @item gnus-uu-user-view-rules
7819 @vindex gnus-uu-user-view-rules
7820 @cindex sox
7821 This variable is consulted first when viewing files.  If you wish to use,
7822 for instance, @code{sox} to convert an @file{.au} sound file, you could
7823 say something like:
7824 @lisp
7825 (setq gnus-uu-user-view-rules
7826       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7827 @end lisp
7828
7829 @item gnus-uu-user-view-rules-end
7830 @vindex gnus-uu-user-view-rules-end
7831 This variable is consulted if Gnus couldn't make any matches from the
7832 user and default view rules.
7833
7834 @item gnus-uu-user-archive-rules
7835 @vindex gnus-uu-user-archive-rules
7836 This variable can be used to say what commands should be used to unpack
7837 archives.
7838 @end table
7839
7840
7841 @node Other Decode Variables
7842 @subsubsection Other Decode Variables
7843
7844 @table @code
7845 @vindex gnus-uu-grabbed-file-functions
7846
7847 @item gnus-uu-grabbed-file-functions
7848 All functions in this list will be called right after each file has been
7849 successfully decoded---so that you can move or view files right away,
7850 and don't have to wait for all files to be decoded before you can do
7851 anything.  Ready-made functions you can put in this list are:
7852
7853 @table @code
7854
7855 @item gnus-uu-grab-view
7856 @findex gnus-uu-grab-view
7857 View the file.
7858
7859 @item gnus-uu-grab-move
7860 @findex gnus-uu-grab-move
7861 Move the file (if you're using a saving function.)
7862 @end table
7863
7864 @item gnus-uu-be-dangerous
7865 @vindex gnus-uu-be-dangerous
7866 Specifies what to do if unusual situations arise during decoding.  If
7867 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
7868 that didn't work, and overwrite existing files.  Otherwise, ask each
7869 time.
7870
7871 @item gnus-uu-ignore-files-by-name
7872 @vindex gnus-uu-ignore-files-by-name
7873 Files with name matching this regular expression won't be viewed.
7874
7875 @item gnus-uu-ignore-files-by-type
7876 @vindex gnus-uu-ignore-files-by-type
7877 Files with a @acronym{MIME} type matching this variable won't be viewed.
7878 Note that Gnus tries to guess what type the file is based on the name.
7879 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
7880 kludgey.
7881
7882 @item gnus-uu-tmp-dir
7883 @vindex gnus-uu-tmp-dir
7884 Where @code{gnus-uu} does its work.
7885
7886 @item gnus-uu-do-not-unpack-archives
7887 @vindex gnus-uu-do-not-unpack-archives
7888 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7889 looking for files to display.
7890
7891 @item gnus-uu-view-and-save
7892 @vindex gnus-uu-view-and-save
7893 Non-@code{nil} means that the user will always be asked to save a file
7894 after viewing it.
7895
7896 @item gnus-uu-ignore-default-view-rules
7897 @vindex gnus-uu-ignore-default-view-rules
7898 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7899 rules.
7900
7901 @item gnus-uu-ignore-default-archive-rules
7902 @vindex gnus-uu-ignore-default-archive-rules
7903 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7904 unpacking commands.
7905
7906 @item gnus-uu-kill-carriage-return
7907 @vindex gnus-uu-kill-carriage-return
7908 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7909 from articles.
7910
7911 @item gnus-uu-unmark-articles-not-decoded
7912 @vindex gnus-uu-unmark-articles-not-decoded
7913 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7914 decoded articles as unread.
7915
7916 @item gnus-uu-correct-stripped-uucode
7917 @vindex gnus-uu-correct-stripped-uucode
7918 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7919 uuencoded files that have had trailing spaces deleted.
7920
7921 @item gnus-uu-pre-uudecode-hook
7922 @vindex gnus-uu-pre-uudecode-hook
7923 Hook run before sending a message to @code{uudecode}.
7924
7925 @item gnus-uu-view-with-metamail
7926 @vindex gnus-uu-view-with-metamail
7927 @cindex metamail
7928 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7929 commands defined by the rule variables and just fudge a @acronym{MIME}
7930 content type based on the file name.  The result will be fed to
7931 @code{metamail} for viewing.
7932
7933 @item gnus-uu-save-in-digest
7934 @vindex gnus-uu-save-in-digest
7935 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7936 decoding, will save in digests.  If this variable is @code{nil},
7937 @code{gnus-uu} will just save everything in a file without any
7938 embellishments.  The digesting almost conforms to RFC 1153---no easy way
7939 to specify any meaningful volume and issue numbers were found, so I
7940 simply dropped them.
7941
7942 @end table
7943
7944
7945 @node Uuencoding and Posting
7946 @subsubsection Uuencoding and Posting
7947
7948 @table @code
7949
7950 @item gnus-uu-post-include-before-composing
7951 @vindex gnus-uu-post-include-before-composing
7952 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7953 before you compose the article.  If this variable is @code{t}, you can
7954 either include an encoded file with @kbd{C-c C-i} or have one included
7955 for you when you post the article.
7956
7957 @item gnus-uu-post-length
7958 @vindex gnus-uu-post-length
7959 Maximum length of an article.  The encoded file will be split into how
7960 many articles it takes to post the entire file.
7961
7962 @item gnus-uu-post-threaded
7963 @vindex gnus-uu-post-threaded
7964 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7965 thread.  This may not be smart, as no other decoder I have seen is able
7966 to follow threads when collecting uuencoded articles.  (Well, I have
7967 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7968 think that counts@dots{}) Default is @code{nil}.
7969
7970 @item gnus-uu-post-separate-description
7971 @vindex gnus-uu-post-separate-description
7972 Non-@code{nil} means that the description will be posted in a separate
7973 article.  The first article will typically be numbered (0/x).  If this
7974 variable is @code{nil}, the description the user enters will be included
7975 at the beginning of the first article, which will be numbered (1/x).
7976 Default is @code{t}.
7977
7978 @end table
7979
7980
7981 @node Viewing Files
7982 @subsection Viewing Files
7983 @cindex viewing files
7984 @cindex pseudo-articles
7985
7986 After decoding, if the file is some sort of archive, Gnus will attempt
7987 to unpack the archive and see if any of the files in the archive can be
7988 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
7989 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
7990 uncompress and de-tar the main file, and then view the two pictures.
7991 This unpacking process is recursive, so if the archive contains archives
7992 of archives, it'll all be unpacked.
7993
7994 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
7995 extracted file into the summary buffer.  If you go to these
7996 ``articles'', you will be prompted for a command to run (usually Gnus
7997 will make a suggestion), and then the command will be run.
7998
7999 @vindex gnus-view-pseudo-asynchronously
8000 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8001 until the viewing is done before proceeding.
8002
8003 @vindex gnus-view-pseudos
8004 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8005 the pseudo-articles into the summary buffer, but view them
8006 immediately.  If this variable is @code{not-confirm}, the user won't even
8007 be asked for a confirmation before viewing is done.
8008
8009 @vindex gnus-view-pseudos-separately
8010 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8011 pseudo-article will be created for each file to be viewed.  If
8012 @code{nil}, all files that use the same viewing command will be given as
8013 a list of parameters to that command.
8014
8015 @vindex gnus-insert-pseudo-articles
8016 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8017 pseudo-articles when decoding.  It is @code{t} by default.
8018
8019 So; there you are, reading your @emph{pseudo-articles} in your
8020 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8021 Why isn't anything real anymore? How did we get here?
8022
8023
8024 @node Article Treatment
8025 @section Article Treatment
8026
8027 Reading through this huge manual, you may have quite forgotten that the
8028 object of newsreaders is to actually, like, read what people have
8029 written.  Reading articles.  Unfortunately, people are quite bad at
8030 writing, so there are tons of functions and variables to make reading
8031 these articles easier.
8032
8033 @menu
8034 * Article Highlighting::        You want to make the article look like fruit salad.
8035 * Article Fontisizing::         Making emphasized text look nice.
8036 * Article Hiding::              You also want to make certain info go away.
8037 * Article Washing::             Lots of way-neat functions to make life better.
8038 * Article Header::              Doing various header transformations.
8039 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
8040 * Article Button Levels::       Controlling appearance of buttons.
8041 * Article Date::                Grumble, UT!
8042 * Article Display::             Display various stuff---X-Face, Picons, Smileys
8043 * Article Signature::           What is a signature?
8044 * Article Miscellanea::         Various other stuff.
8045 @end menu
8046
8047
8048 @node Article Highlighting
8049 @subsection Article Highlighting
8050 @cindex highlighting
8051
8052 Not only do you want your article buffer to look like fruit salad, but
8053 you want it to look like technicolor fruit salad.
8054
8055 @table @kbd
8056
8057 @item W H a
8058 @kindex W H a (Summary)
8059 @findex gnus-article-highlight
8060 @findex gnus-article-maybe-highlight
8061 Do much highlighting of the current article
8062 (@code{gnus-article-highlight}).  This function highlights header, cited
8063 text, the signature, and adds buttons to the body and the head.
8064
8065 @item W H h
8066 @kindex W H h (Summary)
8067 @findex gnus-article-highlight-headers
8068 @vindex gnus-header-face-alist
8069 Highlight the headers (@code{gnus-article-highlight-headers}).  The
8070 highlighting will be done according to the @code{gnus-header-face-alist}
8071 variable, which is a list where each element has the form
8072 @code{(@var{regexp} @var{name} @var{content})}.
8073 @var{regexp} is a regular expression for matching the
8074 header, @var{name} is the face used for highlighting the header name
8075 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8076 the header value.  The first match made will be used.  Note that
8077 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8078
8079 @item W H c
8080 @kindex W H c (Summary)
8081 @findex gnus-article-highlight-citation
8082 Highlight cited text (@code{gnus-article-highlight-citation}).
8083
8084 Some variables to customize the citation highlights:
8085
8086 @table @code
8087 @vindex gnus-cite-parse-max-size
8088
8089 @item gnus-cite-parse-max-size
8090 If the article size if bigger than this variable (which is 25000 by
8091 default), no citation highlighting will be performed.
8092
8093 @item gnus-cite-max-prefix
8094 @vindex gnus-cite-max-prefix
8095 Maximum possible length for a citation prefix (default 20).
8096
8097 @item gnus-cite-face-list
8098 @vindex gnus-cite-face-list
8099 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8100 When there are citations from multiple articles in the same message,
8101 Gnus will try to give each citation from each article its own face.
8102 This should make it easier to see who wrote what.
8103
8104 @item gnus-supercite-regexp
8105 @vindex gnus-supercite-regexp
8106 Regexp matching normal Supercite attribution lines.
8107
8108 @item gnus-supercite-secondary-regexp
8109 @vindex gnus-supercite-secondary-regexp
8110 Regexp matching mangled Supercite attribution lines.
8111
8112 @item gnus-cite-minimum-match-count
8113 @vindex gnus-cite-minimum-match-count
8114 Minimum number of identical prefixes we have to see before we believe
8115 that it's a citation.
8116
8117 @item gnus-cite-attribution-prefix
8118 @vindex gnus-cite-attribution-prefix
8119 Regexp matching the beginning of an attribution line.
8120
8121 @item gnus-cite-attribution-suffix
8122 @vindex gnus-cite-attribution-suffix
8123 Regexp matching the end of an attribution line.
8124
8125 @item gnus-cite-attribution-face
8126 @vindex gnus-cite-attribution-face
8127 Face used for attribution lines.  It is merged with the face for the
8128 cited text belonging to the attribution.
8129
8130 @end table
8131
8132
8133 @item W H s
8134 @kindex W H s (Summary)
8135 @vindex gnus-signature-separator
8136 @vindex gnus-signature-face
8137 @findex gnus-article-highlight-signature
8138 Highlight the signature (@code{gnus-article-highlight-signature}).
8139 Everything after @code{gnus-signature-separator} (@pxref{Article
8140 Signature}) in an article will be considered a signature and will be
8141 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8142 default.
8143
8144 @end table
8145
8146 @xref{Customizing Articles}, for how to highlight articles automatically.
8147
8148
8149 @node Article Fontisizing
8150 @subsection Article Fontisizing
8151 @cindex emphasis
8152 @cindex article emphasis
8153
8154 @findex gnus-article-emphasize
8155 @kindex W e (Summary)
8156 People commonly add emphasis to words in news articles by writing things
8157 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
8158 this look nicer by running the article through the @kbd{W e}
8159 (@code{gnus-article-emphasize}) command.
8160
8161 @vindex gnus-emphasis-alist
8162 How the emphasis is computed is controlled by the
8163 @code{gnus-emphasis-alist} variable.  This is an alist where the first
8164 element is a regular expression to be matched.  The second is a number
8165 that says what regular expression grouping is used to find the entire
8166 emphasized word.  The third is a number that says what regexp grouping
8167 should be displayed and highlighted.  (The text between these two
8168 groupings will be hidden.)  The fourth is the face used for
8169 highlighting.
8170
8171 @lisp
8172 (setq gnus-emphasis-alist
8173       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8174         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8175 @end lisp
8176
8177 @cindex slash
8178 @cindex asterisk
8179 @cindex underline
8180 @cindex /
8181 @cindex *
8182
8183 @vindex gnus-emphasis-underline
8184 @vindex gnus-emphasis-bold
8185 @vindex gnus-emphasis-italic
8186 @vindex gnus-emphasis-underline-bold
8187 @vindex gnus-emphasis-underline-italic
8188 @vindex gnus-emphasis-bold-italic
8189 @vindex gnus-emphasis-underline-bold-italic
8190 By default, there are seven rules, and they use the following faces:
8191 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8192 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8193 @code{gnus-emphasis-underline-italic},
8194 @code{gnus-emphasis-underline-bold}, and
8195 @code{gnus-emphasis-underline-bold-italic}.
8196
8197 If you want to change these faces, you can either use @kbd{M-x
8198 customize}, or you can use @code{copy-face}.  For instance, if you want
8199 to make @code{gnus-emphasis-italic} use a red face instead, you could
8200 say something like:
8201
8202 @lisp
8203 (copy-face 'red 'gnus-emphasis-italic)
8204 @end lisp
8205
8206 @vindex gnus-group-highlight-words-alist
8207
8208 If you want to highlight arbitrary words, you can use the
8209 @code{gnus-group-highlight-words-alist} variable, which uses the same
8210 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
8211 parameter (@pxref{Group Parameters}) can also be used.
8212
8213 @xref{Customizing Articles}, for how to fontize articles automatically.
8214
8215
8216 @node Article Hiding
8217 @subsection Article Hiding
8218 @cindex article hiding
8219
8220 Or rather, hiding certain things in each article.  There usually is much
8221 too much cruft in most articles.
8222
8223 @table @kbd
8224
8225 @item W W a
8226 @kindex W W a (Summary)
8227 @findex gnus-article-hide
8228 Do quite a lot of hiding on the article buffer
8229 (@kbd{gnus-article-hide}).  In particular, this function will hide
8230 headers, @acronym{PGP}, cited text and the signature.
8231
8232 @item W W h
8233 @kindex W W h (Summary)
8234 @findex gnus-article-hide-headers
8235 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
8236 Headers}.
8237
8238 @item W W b
8239 @kindex W W b (Summary)
8240 @findex gnus-article-hide-boring-headers
8241 Hide headers that aren't particularly interesting
8242 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
8243
8244 @item W W s
8245 @kindex W W s (Summary)
8246 @findex gnus-article-hide-signature
8247 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
8248 Signature}.
8249
8250 @item W W l
8251 @kindex W W l (Summary)
8252 @findex gnus-article-hide-list-identifiers
8253 @vindex gnus-list-identifiers
8254 Strip list identifiers specified in @code{gnus-list-identifiers}.  These
8255 are strings some mailing list servers add to the beginning of all
8256 @code{Subject} headers---for example, @samp{[zebra 4711]}.  Any leading
8257 @samp{Re: } is skipped before stripping.  @code{gnus-list-identifiers}
8258 may not contain @code{\\(..\\)}.
8259
8260 @table @code
8261
8262 @item gnus-list-identifiers
8263 @vindex gnus-list-identifiers
8264 A regular expression that matches list identifiers to be removed from
8265 subject.  This can also be a list of regular expressions.
8266
8267 @end table
8268
8269 @item W W P
8270 @kindex W W P (Summary)
8271 @findex gnus-article-hide-pem
8272 Hide @acronym{PEM} (privacy enhanced messages) cruft
8273 (@code{gnus-article-hide-pem}).
8274
8275 @item W W B
8276 @kindex W W B (Summary)
8277 @findex gnus-article-strip-banner
8278 @vindex gnus-article-banner-alist
8279 @vindex gnus-article-address-banner-alist
8280 @cindex banner
8281 @cindex OneList
8282 @cindex stripping advertisements
8283 @cindex advertisements
8284 Strip the banner specified by the @code{banner} group parameter
8285 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
8286 annoying banners and/or signatures that some mailing lists and moderated
8287 groups adds to all the messages.  The way to use this function is to add
8288 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8289 group you want banners stripped from.  The parameter either be a string,
8290 which will be interpreted as a regular expression matching text to be
8291 removed, or the symbol @code{signature}, meaning that the (last)
8292 signature should be removed, or other symbol, meaning that the
8293 corresponding regular expression in @code{gnus-article-banner-alist} is
8294 used.
8295
8296 Regardless of a group, you can hide things like advertisements only when
8297 the sender of an article has a certain mail address specified in
8298 @code{gnus-article-address-banner-alist}.
8299
8300 @table @code
8301
8302 @item gnus-article-address-banner-alist
8303 @vindex gnus-article-address-banner-alist
8304 Alist of mail addresses and banners.  Each element has the form
8305 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8306 matching a mail address in the From header, @var{banner} is one of a
8307 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8308 a regexp and @code{nil}.  If @var{address} matches author's mail
8309 address, it will remove things like advertisements.  For example, if a
8310 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8311 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8312 sends, you can use the following element to remove them:
8313
8314 @lisp
8315 ("@@yoo-hoo\\.co\\.jp\\'" .
8316  "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8317 @end lisp
8318
8319 @end table
8320
8321 @item W W c
8322 @kindex W W c (Summary)
8323 @findex gnus-article-hide-citation
8324 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
8325 customizing the hiding:
8326
8327 @table @code
8328
8329 @item gnus-cited-opened-text-button-line-format
8330 @itemx gnus-cited-closed-text-button-line-format
8331 @vindex gnus-cited-closed-text-button-line-format
8332 @vindex gnus-cited-opened-text-button-line-format
8333 Gnus adds buttons to show where the cited text has been hidden, and to
8334 allow toggle hiding the text.  The format of the variable is specified
8335 by these format-like variable (@pxref{Formatting Variables}).  These
8336 specs are valid:
8337
8338 @table @samp
8339 @item b
8340 Starting point of the hidden text.
8341 @item e
8342 Ending point of the hidden text.
8343 @item l
8344 Number of characters in the hidden region.
8345 @item n
8346 Number of lines of hidden text.
8347 @end table
8348
8349 @item gnus-cited-lines-visible
8350 @vindex gnus-cited-lines-visible
8351 The number of lines at the beginning of the cited text to leave
8352 shown.  This can also be a cons cell with the number of lines at the top
8353 and bottom of the text, respectively, to remain visible.
8354
8355 @end table
8356
8357 @item W W C-c
8358 @kindex W W C-c (Summary)
8359 @findex gnus-article-hide-citation-maybe
8360
8361 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8362 following two variables:
8363
8364 @table @code
8365 @item gnus-cite-hide-percentage
8366 @vindex gnus-cite-hide-percentage
8367 If the cited text is of a bigger percentage than this variable (default
8368 50), hide the cited text.
8369
8370 @item gnus-cite-hide-absolute
8371 @vindex gnus-cite-hide-absolute
8372 The cited text must have at least this length (default 10) before it
8373 is hidden.
8374 @end table
8375
8376 @item W W C
8377 @kindex W W C (Summary)
8378 @findex gnus-article-hide-citation-in-followups
8379 Hide cited text in articles that aren't roots
8380 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
8381 useful as an interactive command, but might be a handy function to stick
8382 have happen automatically (@pxref{Customizing Articles}).
8383
8384 @end table
8385
8386 All these ``hiding'' commands are toggles, but if you give a negative
8387 prefix to these commands, they will show what they have previously
8388 hidden.  If you give a positive prefix, they will always hide.
8389
8390 Also @pxref{Article Highlighting} for further variables for
8391 citation customization.
8392
8393 @xref{Customizing Articles}, for how to hide article elements
8394 automatically.
8395
8396
8397 @node Article Washing
8398 @subsection Article Washing
8399 @cindex washing
8400 @cindex article washing
8401
8402 We call this ``article washing'' for a really good reason.  Namely, the
8403 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8404
8405 @dfn{Washing} is defined by us as ``changing something from something to
8406 something else'', but normally results in something looking better.
8407 Cleaner, perhaps.
8408
8409 @xref{Customizing Articles}, if you want to change how Gnus displays
8410 articles by default.
8411
8412 @table @kbd
8413
8414 @item C-u g
8415 This is not really washing, it's sort of the opposite of washing.  If
8416 you type this, you see the article exactly as it exists on disk or on
8417 the server.
8418
8419 @item g
8420 Force redisplaying of the current article
8421 (@code{gnus-summary-show-article}).  This is also not really washing.
8422 If you type this, you see the article without any previously applied
8423 interactive Washing functions but with all default treatments
8424 (@pxref{Customizing Articles}).
8425
8426 @item W l
8427 @kindex W l (Summary)
8428 @findex gnus-summary-stop-page-breaking
8429 Remove page breaks from the current article
8430 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
8431 delimiters.
8432
8433 @item W r
8434 @kindex W r (Summary)
8435 @findex gnus-summary-caesar-message
8436 @c @icon{gnus-summary-caesar-message}
8437 Do a Caesar rotate (rot13) on the article buffer
8438 (@code{gnus-summary-caesar-message}).
8439 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8440 (Typically offensive jokes and such.)
8441
8442 It's commonly called ``rot13'' because each letter is rotated 13
8443 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8444 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
8445 is rumored to have employed this form of, uh, somewhat weak encryption.
8446
8447 @item W m
8448 @kindex W m (Summary)
8449 @findex gnus-summary-morse-message
8450 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8451
8452 @item W t
8453 @item t
8454 @kindex W t (Summary)
8455 @kindex t (Summary)
8456 @findex gnus-summary-toggle-header
8457 Toggle whether to display all headers in the article buffer
8458 (@code{gnus-summary-toggle-header}).
8459
8460 @item W v
8461 @kindex W v (Summary)
8462 @findex gnus-summary-verbose-headers
8463 Toggle whether to display all headers in the article buffer permanently
8464 (@code{gnus-summary-verbose-headers}).
8465
8466 @item W o
8467 @kindex W o (Summary)
8468 @findex gnus-article-treat-overstrike
8469 Treat overstrike (@code{gnus-article-treat-overstrike}).
8470
8471 @item W d
8472 @kindex W d (Summary)
8473 @findex gnus-article-treat-dumbquotes
8474 @vindex gnus-article-dumbquotes-map
8475 @cindex Smartquotes
8476 @cindex M****s*** sm*rtq**t*s
8477 @cindex Latin 1
8478 Treat M****s*** sm*rtq**t*s according to
8479 @code{gnus-article-dumbquotes-map}
8480 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
8481 whether a character is a sm*rtq**t* or not, so it should only be used
8482 interactively.
8483
8484 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8485 an attempt to provide more quoting characters.  If you see something
8486 like @code{\222} or @code{\264} where you're expecting some kind of
8487 apostrophe or quotation mark, then try this wash.
8488
8489 @item W Y f
8490 @kindex W Y f (Summary)
8491 @findex gnus-article-outlook-deuglify-article
8492 @cindex Outlook Express
8493 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8494 unwrap lines, repair attribution and rearrange citation.
8495 (@code{gnus-article-outlook-deuglify-article}).
8496
8497 @item W Y u
8498 @kindex W Y u (Summary)
8499 @findex gnus-article-outlook-unwrap-lines
8500 @vindex gnus-outlook-deuglify-unwrap-min
8501 @vindex gnus-outlook-deuglify-unwrap-max
8502 Unwrap lines that appear to be wrapped citation lines.  You can control
8503 what lines will be unwrapped by frobbing
8504 @code{gnus-outlook-deuglify-unwrap-min} and
8505 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8506 maximum length of an unwrapped citation line.
8507 (@code{gnus-article-outlook-unwrap-lines}).
8508
8509 @item W Y a
8510 @kindex W Y a (Summary)
8511 @findex gnus-article-outlook-repair-attribution
8512 Repair a broken attribution line.@*
8513 (@code{gnus-article-outlook-repair-attribution}).
8514
8515 @item W Y c
8516 @kindex W Y c (Summary)
8517 @findex gnus-article-outlook-rearrange-citation
8518 Repair broken citations by rearranging the text.
8519 (@code{gnus-article-outlook-rearrange-citation}).
8520
8521 @item W w
8522 @kindex W w (Summary)
8523 @findex gnus-article-fill-cited-article
8524 Do word wrap (@code{gnus-article-fill-cited-article}).
8525
8526 You can give the command a numerical prefix to specify the width to use
8527 when filling.
8528
8529 @item W Q
8530 @kindex W Q (Summary)
8531 @findex gnus-article-fill-long-lines
8532 Fill long lines (@code{gnus-article-fill-long-lines}).
8533
8534 @item W C
8535 @kindex W C (Summary)
8536 @findex gnus-article-capitalize-sentences
8537 Capitalize the first word in each sentence
8538 (@code{gnus-article-capitalize-sentences}).
8539
8540 @item W c
8541 @kindex W c (Summary)
8542 @findex gnus-article-remove-cr
8543 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8544 (this takes care of DOS line endings), and then translate any remaining
8545 CRs into LF (this takes care of Mac line endings)
8546 (@code{gnus-article-remove-cr}).
8547
8548 @item W q
8549 @kindex W q (Summary)
8550 @findex gnus-article-de-quoted-unreadable
8551 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8552 Quoted-Printable is one common @acronym{MIME} encoding employed when
8553 sending non-@acronym{ASCII} (i.e., 8-bit) articles.  It typically
8554 makes strings like @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which
8555 doesn't look very readable to me.  Note that this is usually done
8556 automatically by Gnus if the message in question has a
8557 @code{Content-Transfer-Encoding} header that says that this encoding
8558 has been done.  If a prefix is given, a charset will be asked for.
8559
8560 @item W 6
8561 @kindex W 6 (Summary)
8562 @findex gnus-article-de-base64-unreadable
8563 Treat base64 (@code{gnus-article-de-base64-unreadable}).  Base64 is
8564 one common @acronym{MIME} encoding employed when sending
8565 non-@acronym{ASCII} (i.e., 8-bit) articles.  Note that this is
8566 usually done automatically by Gnus if the message in question has a
8567 @code{Content-Transfer-Encoding} header that says that this encoding
8568 has been done.  If a prefix is given, a charset will be asked for.
8569
8570 @item W Z
8571 @kindex W Z (Summary)
8572 @findex gnus-article-decode-HZ
8573 Treat HZ or HZP (@code{gnus-article-decode-HZ}).  HZ (or HZP) is one
8574 common encoding employed when sending Chinese articles.  It typically
8575 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8576
8577 @item W A
8578 @kindex W A (Summary)
8579 @findex gnus-article-treat-ansi-sequences
8580 Translate ANSI SGR control sequences into overlays or extents
8581 (@code{gnus-article-treat-ansi-sequences}).  ANSI sequences are used in
8582 some Chinese hierarchies for highlighting.
8583
8584 @item W u
8585 @kindex W u (Summary)
8586 @findex gnus-article-unsplit-urls
8587 Remove newlines from within URLs.  Some mailers insert newlines into
8588 outgoing email messages to keep lines short.  This reformatting can
8589 split long URLs onto multiple lines.  Repair those URLs by removing
8590 the newlines (@code{gnus-article-unsplit-urls}).
8591
8592 @item W h
8593 @kindex W h (Summary)
8594 @findex gnus-article-wash-html
8595 Treat @acronym{HTML} (@code{gnus-article-wash-html}).  Note that this is
8596 usually done automatically by Gnus if the message in question has a
8597 @code{Content-Type} header that says that the message is @acronym{HTML}.
8598
8599 If a prefix is given, a charset will be asked for.
8600
8601 @vindex gnus-article-wash-function
8602 The default is to use the function specified by
8603 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
8604 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
8605 @acronym{HTML}, but this is controlled by the
8606 @code{gnus-article-wash-function} variable.  Pre-defined functions you
8607 can use include:
8608
8609 @table @code
8610 @item w3
8611 Use Emacs/w3.
8612
8613 @item w3m
8614 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
8615
8616 @item links
8617 Use @uref{http://links.sf.net/, Links}.
8618
8619 @item lynx
8620 Use @uref{http://lynx.isc.org/, Lynx}.
8621
8622 @item html2text
8623 Use html2text---a simple @acronym{HTML} converter included with Gnus.
8624
8625 @end table
8626
8627 @item W b
8628 @kindex W b (Summary)
8629 @findex gnus-article-add-buttons
8630 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8631 @xref{Article Buttons}.
8632
8633 @item W B
8634 @kindex W B (Summary)
8635 @findex gnus-article-add-buttons-to-head
8636 Add clickable buttons to the article headers
8637 (@code{gnus-article-add-buttons-to-head}).
8638
8639 @item W p
8640 @kindex W p (Summary)
8641 @findex gnus-article-verify-x-pgp-sig
8642 Verify a signed control message
8643 (@code{gnus-article-verify-x-pgp-sig}).  Control messages such as
8644 @code{newgroup} and @code{checkgroups} are usually signed by the
8645 hierarchy maintainer.  You need to add the @acronym{PGP} public key of
8646 the maintainer to your keyring to verify the
8647 message.@footnote{@acronym{PGP} keys for many hierarchies are
8648 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8649
8650 @item W s
8651 @kindex W s (Summary)
8652 @findex gnus-summary-force-verify-and-decrypt
8653 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
8654 @acronym{S/MIME}) message
8655 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8656
8657 @item W a
8658 @kindex W a (Summary)
8659 @findex gnus-article-strip-headers-in-body
8660 Strip headers like the @code{X-No-Archive} header from the beginning of
8661 article bodies (@code{gnus-article-strip-headers-in-body}).
8662
8663 @item W E l
8664 @kindex W E l (Summary)
8665 @findex gnus-article-strip-leading-blank-lines
8666 Remove all blank lines from the beginning of the article
8667 (@code{gnus-article-strip-leading-blank-lines}).
8668
8669 @item W E m
8670 @kindex W E m (Summary)
8671 @findex gnus-article-strip-multiple-blank-lines
8672 Replace all blank lines with empty lines and then all multiple empty
8673 lines with a single empty line.
8674 (@code{gnus-article-strip-multiple-blank-lines}).
8675
8676 @item W E t
8677 @kindex W E t (Summary)
8678 @findex gnus-article-remove-trailing-blank-lines
8679 Remove all blank lines at the end of the article
8680 (@code{gnus-article-remove-trailing-blank-lines}).
8681
8682 @item W E a
8683 @kindex W E a (Summary)
8684 @findex gnus-article-strip-blank-lines
8685 Do all the three commands above
8686 (@code{gnus-article-strip-blank-lines}).
8687
8688 @item W E A
8689 @kindex W E A (Summary)
8690 @findex gnus-article-strip-all-blank-lines
8691 Remove all blank lines
8692 (@code{gnus-article-strip-all-blank-lines}).
8693
8694 @item W E s
8695 @kindex W E s (Summary)
8696 @findex gnus-article-strip-leading-space
8697 Remove all white space from the beginning of all lines of the article
8698 body (@code{gnus-article-strip-leading-space}).
8699
8700 @item W E e
8701 @kindex W E e (Summary)
8702 @findex gnus-article-strip-trailing-space
8703 Remove all white space from the end of all lines of the article
8704 body (@code{gnus-article-strip-trailing-space}).
8705
8706 @end table
8707
8708 @xref{Customizing Articles}, for how to wash articles automatically.
8709
8710
8711 @node Article Header
8712 @subsection Article Header
8713
8714 These commands perform various transformations of article header.
8715
8716 @table @kbd
8717
8718 @item W G u
8719 @kindex W G u (Summary)
8720 @findex gnus-article-treat-unfold-headers
8721 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8722
8723 @item W G n
8724 @kindex W G n (Summary)
8725 @findex gnus-article-treat-fold-newsgroups
8726 Fold the @code{Newsgroups} and @code{Followup-To} headers
8727 (@code{gnus-article-treat-fold-newsgroups}).
8728
8729 @item W G f
8730 @kindex W G f (Summary)
8731 @findex gnus-article-treat-fold-headers
8732 Fold all the message headers
8733 (@code{gnus-article-treat-fold-headers}).
8734
8735 @item W E w
8736 @kindex W E w (Summary)
8737 @findex gnus-article-remove-leading-whitespace
8738 Remove excessive whitespace from all headers
8739 (@code{gnus-article-remove-leading-whitespace}).
8740
8741 @end table
8742
8743
8744 @node Article Buttons
8745 @subsection Article Buttons
8746 @cindex buttons
8747
8748 People often include references to other stuff in articles, and it would
8749 be nice if Gnus could just fetch whatever it is that people talk about
8750 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8751 button on these references.
8752
8753 @vindex gnus-button-man-handler
8754 Gnus adds @dfn{buttons} to certain standard references by default:
8755 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
8756 Emacs or Gnus related references.  This is controlled by two variables,
8757 one that handles article bodies and one that handles article heads:
8758
8759 @table @code
8760
8761 @item gnus-button-alist
8762 @vindex gnus-button-alist
8763 This is an alist where each entry has this form:
8764
8765 @lisp
8766 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8767 @end lisp
8768
8769 @table @var
8770
8771 @item regexp
8772 All text that match this regular expression (case insensitive) will be
8773 considered an external reference.  Here's a typical regexp that matches
8774 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}.  This can also be a
8775 variable containing a regexp, useful variables to use include
8776 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
8777
8778 @item button-par
8779 Gnus has to know which parts of the matches is to be highlighted.  This
8780 is a number that says what sub-expression of the regexp is to be
8781 highlighted.  If you want it all highlighted, you use 0 here.
8782
8783 @item use-p
8784 This form will be @code{eval}ed, and if the result is non-@code{nil},
8785 this is considered a match.  This is useful if you want extra sifting to
8786 avoid false matches.  Often variables named
8787 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
8788 Levels}, but any other form may be used too.
8789
8790 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
8791
8792 @item function
8793 This function will be called when you click on this button.
8794
8795 @item data-par
8796 As with @var{button-par}, this is a sub-expression number, but this one
8797 says which part of the match is to be sent as data to @var{function}.
8798
8799 @end table
8800
8801 So the full entry for buttonizing URLs is then
8802
8803 @lisp
8804 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8805 @end lisp
8806
8807 @item gnus-header-button-alist
8808 @vindex gnus-header-button-alist
8809 This is just like the other alist, except that it is applied to the
8810 article head only, and that each entry has an additional element that is
8811 used to say what headers to apply the buttonize coding to:
8812
8813 @lisp
8814 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
8815 @end lisp
8816
8817 @var{header} is a regular expression.
8818 @end table
8819
8820 @subsubsection Related variables and functions
8821
8822 @table @code
8823 @item gnus-button-@var{*}-level
8824 @xref{Article Button Levels}.
8825
8826 @c Stuff related to gnus-button-browse-level
8827
8828 @item gnus-button-url-regexp
8829 @vindex gnus-button-url-regexp
8830 A regular expression that matches embedded URLs.  It is used in the
8831 default values of the variables above.
8832
8833 @c Stuff related to gnus-button-man-level
8834
8835 @item gnus-button-man-handler
8836 @vindex gnus-button-man-handler
8837 The function to use for displaying man pages.  It must take at least one
8838 argument with a string naming the man page.
8839
8840 @c Stuff related to gnus-button-message-level
8841
8842 @item gnus-button-mid-or-mail-regexp
8843 @vindex gnus-button-mid-or-mail-regexp
8844 Regular expression that matches a message ID or a mail address.
8845
8846 @item gnus-button-prefer-mid-or-mail
8847 @vindex gnus-button-prefer-mid-or-mail
8848 This variable determines what to do when the button on a string as
8849 @samp{foo123@@bar.invalid} is pushed.  Strings like this can be either a
8850 message ID or a mail address.  If it is one of the symbols @code{mid} or
8851 @code{mail}, Gnus will always assume that the string is a message ID or
8852 a mail address, respectively.  If this variable is set to the symbol
8853 @code{ask}, always query the user what do do.  If it is a function, this
8854 function will be called with the string as its only argument.  The
8855 function must return @code{mid}, @code{mail}, @code{invalid} or
8856 @code{ask}.  The default value is the function
8857 @code{gnus-button-mid-or-mail-heuristic}.
8858
8859 @item gnus-button-mid-or-mail-heuristic
8860 @findex gnus-button-mid-or-mail-heuristic
8861 Function that guesses whether its argument is a message ID or a mail
8862 address.  Returns @code{mid} if it's a message IDs, @code{mail} if
8863 it's a mail address, @code{ask} if unsure and @code{invalid} if the
8864 string is invalid.
8865
8866 @item gnus-button-mid-or-mail-heuristic-alist
8867 @vindex gnus-button-mid-or-mail-heuristic-alist
8868 An alist of @code{(RATE . REGEXP)} pairs used by the function
8869 @code{gnus-button-mid-or-mail-heuristic}.
8870
8871 @c Stuff related to gnus-button-tex-level
8872
8873 @item gnus-button-ctan-handler
8874 @findex gnus-button-ctan-handler
8875 The function to use for displaying CTAN links.  It must take one
8876 argument, the string naming the URL.
8877
8878 @item gnus-ctan-url
8879 @vindex gnus-ctan-url
8880 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
8881 by @code{gnus-button-ctan-handler}.
8882
8883 @c Misc stuff
8884
8885 @item gnus-article-button-face
8886 @vindex gnus-article-button-face
8887 Face used on buttons.
8888
8889 @item gnus-article-mouse-face
8890 @vindex gnus-article-mouse-face
8891 Face used when the mouse cursor is over a button.
8892
8893 @end table
8894
8895 @xref{Customizing Articles}, for how to buttonize articles automatically.
8896
8897
8898 @node Article Button Levels
8899 @subsection Article button levels
8900 @cindex button levels
8901 The higher the value of the variables @code{gnus-button-@var{*}-level},
8902 the more buttons will appear.  If the level is zero, no corresponding
8903 buttons are displayed.  With the default value (which is 5) you should
8904 already see quite a lot of buttons.  With higher levels, you will see
8905 more buttons, but you may also get more false positives.  To avoid them,
8906 you can set the variables @code{gnus-button-@var{*}-level} local to
8907 specific groups (@pxref{Group Parameters}).  Here's an example for the
8908 variable @code{gnus-parameters}:
8909
8910 @lisp
8911 ;; @r{increase @code{gnus-button-*-level} in some groups:}
8912 (setq gnus-parameters
8913       '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
8914         ("\\<unix\\>"               (gnus-button-man-level 10))
8915         ("\\<tex\\>"                (gnus-button-tex-level 10))))
8916 @end lisp
8917
8918 @table @code
8919
8920 @item gnus-button-browse-level
8921 @vindex gnus-button-browse-level
8922 Controls the display of references to message IDs, mail addresses and
8923 news URLs.  Related variables and functions include
8924 @code{gnus-button-url-regexp}, @code{browse-url}, and
8925 @code{browse-url-browser-function}.
8926
8927 @item gnus-button-emacs-level
8928 @vindex gnus-button-emacs-level
8929 Controls the display of Emacs or Gnus references.  Related functions are
8930 @code{gnus-button-handle-custom},
8931 @code{gnus-button-handle-describe-function},
8932 @code{gnus-button-handle-describe-variable},
8933 @code{gnus-button-handle-symbol},
8934 @code{gnus-button-handle-describe-key},
8935 @code{gnus-button-handle-apropos},
8936 @code{gnus-button-handle-apropos-command},
8937 @code{gnus-button-handle-apropos-variable},
8938 @code{gnus-button-handle-apropos-documentation}, and
8939 @code{gnus-button-handle-library}.
8940
8941 @item gnus-button-man-level
8942 @vindex gnus-button-man-level
8943 Controls the display of references to (Unix) man pages.
8944 See @code{gnus-button-man-handler}.
8945
8946 @item gnus-button-message-level
8947 @vindex gnus-button-message-level
8948 Controls the display of message IDs, mail addresses and news URLs.
8949 Related variables and functions include
8950 @code{gnus-button-mid-or-mail-regexp},
8951 @code{gnus-button-prefer-mid-or-mail},
8952 @code{gnus-button-mid-or-mail-heuristic}, and
8953 @code{gnus-button-mid-or-mail-heuristic-alist}.
8954
8955 @item gnus-button-tex-level
8956 @vindex gnus-button-tex-level
8957 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
8958 URLs.  See the variables @code{gnus-ctan-url},
8959 @code{gnus-button-ctan-handler},
8960 @code{gnus-button-ctan-directory-regexp}, and
8961 @code{gnus-button-handle-ctan-bogus-regexp}.
8962
8963 @end table
8964
8965
8966 @node Article Date
8967 @subsection Article Date
8968
8969 The date is most likely generated in some obscure timezone you've never
8970 heard of, so it's quite nice to be able to find out what the time was
8971 when the article was sent.
8972
8973 @table @kbd
8974
8975 @item W T u
8976 @kindex W T u (Summary)
8977 @findex gnus-article-date-ut
8978 Display the date in UT (aka. GMT, aka ZULU)
8979 (@code{gnus-article-date-ut}).
8980
8981 @item W T i
8982 @kindex W T i (Summary)
8983 @findex gnus-article-date-iso8601
8984 @cindex ISO 8601
8985 Display the date in international format, aka. ISO 8601
8986 (@code{gnus-article-date-iso8601}).
8987
8988 @item W T l
8989 @kindex W T l (Summary)
8990 @findex gnus-article-date-local
8991 Display the date in the local timezone (@code{gnus-article-date-local}).
8992
8993 @item W T p
8994 @kindex W T p (Summary)
8995 @findex gnus-article-date-english
8996 Display the date in a format that's easily pronounceable in English
8997 (@code{gnus-article-date-english}).
8998
8999 @item W T s
9000 @kindex W T s (Summary)
9001 @vindex gnus-article-time-format
9002 @findex gnus-article-date-user
9003 @findex format-time-string
9004 Display the date using a user-defined format
9005 (@code{gnus-article-date-user}).  The format is specified by the
9006 @code{gnus-article-time-format} variable, and is a string that's passed
9007 to @code{format-time-string}.  See the documentation of that variable
9008 for a list of possible format specs.
9009
9010 @item W T e
9011 @kindex W T e (Summary)
9012 @findex gnus-article-date-lapsed
9013 @findex gnus-start-date-timer
9014 @findex gnus-stop-date-timer
9015 Say how much time has elapsed between the article was posted and now
9016 (@code{gnus-article-date-lapsed}).  It looks something like:
9017
9018 @example
9019 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9020 @end example
9021
9022 @vindex gnus-article-date-lapsed-new-header
9023 The value of @code{gnus-article-date-lapsed-new-header} determines
9024 whether this header will just be added below the old Date one, or will
9025 replace it.
9026
9027 An advantage of using Gnus to read mail is that it converts simple bugs
9028 into wonderful absurdities.
9029
9030 If you want to have this line updated continually, you can put
9031
9032 @lisp
9033 (gnus-start-date-timer)
9034 @end lisp
9035
9036 in your @file{~/.gnus.el} file, or you can run it off of some hook.  If
9037 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9038 command.
9039
9040 @item W T o
9041 @kindex W T o (Summary)
9042 @findex gnus-article-date-original
9043 Display the original date (@code{gnus-article-date-original}).  This can
9044 be useful if you normally use some other conversion function and are
9045 worried that it might be doing something totally wrong.  Say, claiming
9046 that the article was posted in 1854.  Although something like that is
9047 @emph{totally} impossible.  Don't you trust me? *titter*
9048
9049 @end table
9050
9051 @xref{Customizing Articles}, for how to display the date in your
9052 preferred format automatically.
9053
9054
9055 @node Article Display
9056 @subsection Article Display
9057 @cindex picons
9058 @cindex x-face
9059 @cindex smileys
9060
9061 These commands add various frivolous display gimmicks to the article
9062 buffer in Emacs versions that support them.
9063
9064 @code{X-Face} headers are small black-and-white images supplied by the
9065 message headers (@pxref{X-Face}).
9066
9067 @code{Face} headers are small colored images supplied by the message
9068 headers (@pxref{Face}).
9069
9070 Smileys are those little @samp{:-)} symbols that people like to litter
9071 their messages with (@pxref{Smileys}).
9072
9073 Picons, on the other hand, reside on your own system, and Gnus will
9074 try to match the headers to what you have (@pxref{Picons}).
9075
9076 All these functions are toggles---if the elements already exist,
9077 they'll be removed.
9078
9079 @table @kbd
9080 @item W D x
9081 @kindex W D x (Summary)
9082 @findex gnus-article-display-x-face
9083 Display an @code{X-Face} in the @code{From} header.
9084 (@code{gnus-article-display-x-face}).
9085
9086 @item W D d
9087 @kindex W D d (Summary)
9088 @findex gnus-article-display-face
9089 Display a @code{Face} in the @code{From} header.
9090 (@code{gnus-article-display-face}).
9091
9092 @item W D s
9093 @kindex W D s (Summary)
9094 @findex gnus-treat-smiley
9095 Display smileys (@code{gnus-treat-smiley}).
9096
9097 @item W D f
9098 @kindex W D f (Summary)
9099 @findex gnus-treat-from-picon
9100 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9101
9102 @item W D m
9103 @kindex W D m (Summary)
9104 @findex gnus-treat-mail-picon
9105 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9106 (@code{gnus-treat-mail-picon}).
9107
9108 @item W D n
9109 @kindex W D n (Summary)
9110 @findex gnus-treat-newsgroups-picon
9111 Piconify all news headers (i. e., @code{Newsgroups} and
9112 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9113
9114 @item W D D
9115 @kindex W D D (Summary)
9116 @findex gnus-article-remove-images
9117 Remove all images from the article buffer
9118 (@code{gnus-article-remove-images}).
9119
9120 @end table
9121
9122
9123
9124 @node Article Signature
9125 @subsection Article Signature
9126 @cindex signatures
9127 @cindex article signature
9128
9129 @vindex gnus-signature-separator
9130 Each article is divided into two parts---the head and the body.  The
9131 body can be divided into a signature part and a text part.  The variable
9132 that says what is to be considered a signature is
9133 @code{gnus-signature-separator}.  This is normally the standard
9134 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
9135 non-standard signature separators, so this variable can also be a list
9136 of regular expressions to be tested, one by one.  (Searches are done
9137 from the end of the body towards the beginning.)  One likely value is:
9138
9139 @lisp
9140 (setq gnus-signature-separator
9141       '("^-- $"         ; @r{The standard}
9142         "^-- *$"        ; @r{A common mangling}
9143         "^-------*$"    ; @r{Many people just use a looong}
9144                         ; @r{line of dashes.  Shame!}
9145         "^ *--------*$" ; @r{Double-shame!}
9146         "^________*$"   ; @r{Underscores are also popular}
9147         "^========*$")) ; @r{Pervert!}
9148 @end lisp
9149
9150 The more permissive you are, the more likely it is that you'll get false
9151 positives.
9152
9153 @vindex gnus-signature-limit
9154 @code{gnus-signature-limit} provides a limit to what is considered a
9155 signature when displaying articles.
9156
9157 @enumerate
9158 @item
9159 If it is an integer, no signature may be longer (in characters) than
9160 that integer.
9161 @item
9162 If it is a floating point number, no signature may be longer (in lines)
9163 than that number.
9164 @item
9165 If it is a function, the function will be called without any parameters,
9166 and if it returns @code{nil}, there is no signature in the buffer.
9167 @item
9168 If it is a string, it will be used as a regexp.  If it matches, the text
9169 in question is not a signature.
9170 @end enumerate
9171
9172 This variable can also be a list where the elements may be of the types
9173 listed above.  Here's an example:
9174
9175 @lisp
9176 (setq gnus-signature-limit
9177       '(200.0 "^---*Forwarded article"))
9178 @end lisp
9179
9180 This means that if there are more than 200 lines after the signature
9181 separator, or the text after the signature separator is matched by
9182 the regular expression @samp{^---*Forwarded article}, then it isn't a
9183 signature after all.
9184
9185
9186 @node Article Miscellanea
9187 @subsection Article Miscellanea
9188
9189 @table @kbd
9190 @item A t
9191 @kindex A t (Summary)
9192 @findex gnus-article-babel
9193 Translate the article from one language to another
9194 (@code{gnus-article-babel}).
9195
9196 @end table
9197
9198
9199 @node MIME Commands
9200 @section MIME Commands
9201 @cindex MIME decoding
9202 @cindex attachments
9203 @cindex viewing attachments
9204
9205 The following commands all understand the numerical prefix.  For
9206 instance, @kbd{3 b} means ``view the third @acronym{MIME} part''.
9207
9208 @table @kbd
9209 @item b
9210 @itemx K v
9211 @kindex b (Summary)
9212 @kindex K v (Summary)
9213 View the @acronym{MIME} part.
9214
9215 @item K o
9216 @kindex K o (Summary)
9217 Save the @acronym{MIME} part.
9218
9219 @item K c
9220 @kindex K c (Summary)
9221 Copy the @acronym{MIME} part.
9222
9223 @item K e
9224 @kindex K e (Summary)
9225 View the @acronym{MIME} part externally.
9226
9227 @item K i
9228 @kindex K i (Summary)
9229 View the @acronym{MIME} part internally.
9230
9231 @item K |
9232 @kindex K | (Summary)
9233 Pipe the @acronym{MIME} part to an external command.
9234 @end table
9235
9236 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9237 the same manner:
9238
9239 @table @kbd
9240 @item K b
9241 @kindex K b (Summary)
9242 Make all the @acronym{MIME} parts have buttons in front of them.  This is
9243 mostly useful if you wish to save (or perform other actions) on inlined
9244 parts.
9245
9246 @item K m
9247 @kindex K m (Summary)
9248 @findex gnus-summary-repair-multipart
9249 Some multipart messages are transmitted with missing or faulty headers.
9250 This command will attempt to ``repair'' these messages so that they can
9251 be viewed in a more pleasant manner
9252 (@code{gnus-summary-repair-multipart}).
9253
9254 @item X m
9255 @kindex X m (Summary)
9256 @findex gnus-summary-save-parts
9257 Save all parts matching a @acronym{MIME} type to a directory
9258 (@code{gnus-summary-save-parts}).  Understands the process/prefix
9259 convention (@pxref{Process/Prefix}).
9260
9261 @item M-t
9262 @kindex M-t (Summary)
9263 @findex gnus-summary-toggle-display-buttonized
9264 Toggle the buttonized display of the article buffer
9265 (@code{gnus-summary-toggle-display-buttonized}).
9266
9267 @item W M w
9268 @kindex W M w (Summary)
9269 @findex gnus-article-decode-mime-words
9270 Decode RFC 2047-encoded words in the article headers
9271 (@code{gnus-article-decode-mime-words}).
9272
9273 @item W M c
9274 @kindex W M c (Summary)
9275 @findex gnus-article-decode-charset
9276 Decode encoded article bodies as well as charsets
9277 (@code{gnus-article-decode-charset}).
9278
9279 This command looks in the @code{Content-Type} header to determine the
9280 charset.  If there is no such header in the article, you can give it a
9281 prefix, which will prompt for the charset to decode as.  In regional
9282 groups where people post using some common encoding (but do not
9283 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9284 parameter to the required charset (@pxref{Group Parameters}).
9285
9286 @item W M v
9287 @kindex W M v (Summary)
9288 @findex gnus-mime-view-all-parts
9289 View all the @acronym{MIME} parts in the current article
9290 (@code{gnus-mime-view-all-parts}).
9291
9292 @end table
9293
9294 Relevant variables:
9295
9296 @table @code
9297 @item gnus-ignored-mime-types
9298 @vindex gnus-ignored-mime-types
9299 This is a list of regexps.  @acronym{MIME} types that match a regexp from
9300 this list will be completely ignored by Gnus.  The default value is
9301 @code{nil}.
9302
9303 To have all Vcards be ignored, you'd say something like this:
9304
9305 @lisp
9306 (setq gnus-ignored-mime-types
9307       '("text/x-vcard"))
9308 @end lisp
9309
9310 @item gnus-article-loose-mime
9311 @vindex gnus-article-loose-mime
9312 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9313 before interpreting the message as a @acronym{MIME} message.  This helps
9314 when reading messages from certain broken mail user agents.  The
9315 default is @code{nil}.
9316
9317 @item gnus-article-emulate-mime
9318 @vindex gnus-article-emulate-mime
9319 There are other, non-@acronym{MIME} encoding methods used.  The most common
9320 is @samp{uuencode}, but yEncode is also getting to be popular.  If
9321 this variable is non-@code{nil}, Gnus will look in message bodies to
9322 see if it finds these encodings, and if so, it'll run them through the
9323 Gnus @acronym{MIME} machinery.  The default is @code{t}.
9324
9325 @item gnus-unbuttonized-mime-types
9326 @vindex gnus-unbuttonized-mime-types
9327 This is a list of regexps.  @acronym{MIME} types that match a regexp from
9328 this list won't have @acronym{MIME} buttons inserted unless they aren't
9329 displayed or this variable is overridden by
9330 @code{gnus-buttonized-mime-types}.  The default value is
9331 @code{(".*/.*")}.  This variable is only used when
9332 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9333
9334 @item gnus-buttonized-mime-types
9335 @vindex gnus-buttonized-mime-types
9336 This is a list of regexps.  @acronym{MIME} types that match a regexp from
9337 this list will have @acronym{MIME} buttons inserted unless they aren't
9338 displayed.  This variable overrides
9339 @code{gnus-unbuttonized-mime-types}.  The default value is @code{nil}.
9340 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9341 is @code{nil}.
9342
9343 To see e.g. security buttons but no other buttons, you could set this
9344 variable to @code{("multipart/signed")} and leave
9345 @code{gnus-unbuttonized-mime-types} at the default value.
9346
9347 @item gnus-inhibit-mime-unbuttonizing
9348 @vindex gnus-inhibit-mime-unbuttonizing
9349 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons.  The
9350 default value is @code{nil}.
9351
9352 @item gnus-article-mime-part-function
9353 @vindex gnus-article-mime-part-function
9354 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9355 handle as the parameter.  The function is meant to be used to allow
9356 users to gather information from the article (e. g., add Vcard info to
9357 the bbdb database) or to do actions based on parts (e. g., automatically
9358 save all jpegs into some directory).
9359
9360 Here's an example function the does the latter:
9361
9362 @lisp
9363 (defun my-save-all-jpeg-parts (handle)
9364   (when (equal (car (mm-handle-type handle)) "image/jpeg")
9365     (with-temp-buffer
9366       (insert (mm-get-part handle))
9367       (write-region (point-min) (point-max)
9368                     (read-file-name "Save jpeg to: ")))))
9369 (setq gnus-article-mime-part-function
9370       'my-save-all-jpeg-parts)
9371 @end lisp
9372
9373 @vindex gnus-mime-multipart-functions
9374 @item gnus-mime-multipart-functions
9375 Alist of @acronym{MIME} multipart types and functions to handle them.
9376
9377 @vindex mm-file-name-rewrite-functions
9378 @item mm-file-name-rewrite-functions
9379 List of functions used for rewriting file names of @acronym{MIME} parts.
9380 Each function takes a file name as input and returns a file name.
9381
9382 Ready-made functions include@*
9383 @code{mm-file-name-delete-whitespace},
9384 @code{mm-file-name-trim-whitespace},
9385 @code{mm-file-name-collapse-whitespace}, and
9386 @code{mm-file-name-replace-whitespace}.  The later uses the value of
9387 the variable @code{mm-file-name-replace-whitespace} to replace each
9388 whitespace character in a file name with that string; default value
9389 is @code{"_"} (a single underscore).
9390 @findex mm-file-name-delete-whitespace
9391 @findex mm-file-name-trim-whitespace
9392 @findex mm-file-name-collapse-whitespace
9393 @findex mm-file-name-replace-whitespace
9394 @vindex mm-file-name-replace-whitespace
9395
9396 The standard functions @code{capitalize}, @code{downcase},
9397 @code{upcase}, and @code{upcase-initials} may be useful, too.
9398
9399 Everybody knows that whitespace characters in file names are evil,
9400 except those who don't know.  If you receive lots of attachments from
9401 such unenlightened users, you can make live easier by adding
9402
9403 @lisp
9404 (setq mm-file-name-rewrite-functions
9405       '(mm-file-name-trim-whitespace
9406         mm-file-name-collapse-whitespace
9407         mm-file-name-replace-whitespace))
9408 @end lisp
9409
9410 @noindent
9411 to your @file{~/.gnus.el} file.
9412
9413 @end table
9414
9415
9416 @node Charsets
9417 @section Charsets
9418 @cindex charsets
9419
9420 People use different charsets, and we have @acronym{MIME} to let us know what
9421 charsets they use.  Or rather, we wish we had.  Many people use
9422 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9423 just send out messages without saying what character sets they use.  To
9424 help a bit with this, some local news hierarchies have policies that say
9425 what character set is the default.  For instance, the @samp{fj}
9426 hierarchy uses @code{iso-2022-jp-2}.
9427
9428 @vindex gnus-group-charset-alist
9429 This knowledge is encoded in the @code{gnus-group-charset-alist}
9430 variable, which is an alist of regexps (use the first item to match full
9431 group names) and default charsets to be used when reading these groups.
9432
9433 @vindex gnus-newsgroup-ignored-charsets
9434 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9435 aren't.  These blithely mark messages as being in @code{iso-8859-1}
9436 even if they really are in @code{koi-8}.  To help here, the
9437 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
9438 charsets that are listed here will be ignored.  The variable can be
9439 set on a group-by-group basis using the group parameters (@pxref{Group
9440 Parameters}).  The default value is @code{(unknown-8bit x-unknown)},
9441 which includes values some agents insist on having in there.
9442
9443 @vindex gnus-group-posting-charset-alist
9444 When posting, @code{gnus-group-posting-charset-alist} is used to
9445 determine which charsets should not be encoded using the @acronym{MIME}
9446 encodings.  For instance, some hierarchies discourage using
9447 quoted-printable header encoding.
9448
9449 This variable is an alist of regexps and permitted unencoded charsets
9450 for posting.  Each element of the alist has the form @code{(}@var{test
9451 header body-list}@code{)}, where:
9452
9453 @table @var
9454 @item test
9455 is either a regular expression matching the newsgroup header or a
9456 variable to query,
9457 @item header
9458 is the charset which may be left unencoded in the header (@code{nil}
9459 means encode all charsets),
9460 @item body-list
9461 is a list of charsets which may be encoded using 8bit content-transfer
9462 encoding in the body, or one of the special values @code{nil} (always
9463 encode using quoted-printable) or @code{t} (always use 8bit).
9464 @end table
9465
9466 @cindex Russian
9467 @cindex koi8-r
9468 @cindex koi8-u
9469 @cindex iso-8859-5
9470 @cindex coding system aliases
9471 @cindex preferred charset
9472
9473 Other charset tricks that may be useful, although not Gnus-specific:
9474
9475 If there are several @acronym{MIME} charsets that encode the same Emacs
9476 charset, you can choose what charset to use by saying the following:
9477
9478 @lisp
9479 (put-charset-property 'cyrillic-iso8859-5
9480                       'preferred-coding-system 'koi8-r)
9481 @end lisp
9482
9483 This means that Russian will be encoded using @code{koi8-r} instead of
9484 the default @code{iso-8859-5} @acronym{MIME} charset.
9485
9486 If you want to read messages in @code{koi8-u}, you can cheat and say
9487
9488 @lisp
9489 (define-coding-system-alias 'koi8-u 'koi8-r)
9490 @end lisp
9491
9492 This will almost do the right thing.
9493
9494 And finally, to read charsets like @code{windows-1251}, you can say
9495 something like
9496
9497 @lisp
9498 (codepage-setup 1251)
9499 (define-coding-system-alias 'windows-1251 'cp1251)
9500 @end lisp
9501
9502
9503 @node Article Commands
9504 @section Article Commands
9505
9506 @table @kbd
9507
9508 @item A P
9509 @cindex PostScript
9510 @cindex printing
9511 @kindex A P (Summary)
9512 @vindex gnus-ps-print-hook
9513 @findex gnus-summary-print-article
9514 Generate and print a PostScript image of the article buffer
9515 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will
9516 be run just before printing the buffer.  An alternative way to print
9517 article is to use Muttprint (@pxref{Saving Articles}).
9518
9519 @end table
9520
9521
9522 @node Summary Sorting
9523 @section Summary Sorting
9524 @cindex summary sorting
9525
9526 You can have the summary buffer sorted in various ways, even though I
9527 can't really see why you'd want that.
9528
9529 @table @kbd
9530
9531 @item C-c C-s C-n
9532 @kindex C-c C-s C-n (Summary)
9533 @findex gnus-summary-sort-by-number
9534 Sort by article number (@code{gnus-summary-sort-by-number}).
9535
9536 @item C-c C-s C-a
9537 @kindex C-c C-s C-a (Summary)
9538 @findex gnus-summary-sort-by-author
9539 Sort by author (@code{gnus-summary-sort-by-author}).
9540
9541 @item C-c C-s C-s
9542 @kindex C-c C-s C-s (Summary)
9543 @findex gnus-summary-sort-by-subject
9544 Sort by subject (@code{gnus-summary-sort-by-subject}).
9545
9546 @item C-c C-s C-d
9547 @kindex C-c C-s C-d (Summary)
9548 @findex gnus-summary-sort-by-date
9549 Sort by date (@code{gnus-summary-sort-by-date}).
9550
9551 @item C-c C-s C-l
9552 @kindex C-c C-s C-l (Summary)
9553 @findex gnus-summary-sort-by-lines
9554 Sort by lines (@code{gnus-summary-sort-by-lines}).
9555
9556 @item C-c C-s C-c
9557 @kindex C-c C-s C-c (Summary)
9558 @findex gnus-summary-sort-by-chars
9559 Sort by article length (@code{gnus-summary-sort-by-chars}).
9560
9561 @item C-c C-s C-i
9562 @kindex C-c C-s C-i (Summary)
9563 @findex gnus-summary-sort-by-score
9564 Sort by score (@code{gnus-summary-sort-by-score}).
9565
9566 @item C-c C-s C-r
9567 @kindex C-c C-s C-r (Summary)
9568 @findex gnus-summary-sort-by-random
9569 Randomize (@code{gnus-summary-sort-by-random}).
9570
9571 @item C-c C-s C-o
9572 @kindex C-c C-s C-o (Summary)
9573 @findex gnus-summary-sort-by-original
9574 Sort using the default sorting method
9575 (@code{gnus-summary-sort-by-original}).
9576 @end table
9577
9578 These functions will work both when you use threading and when you don't
9579 use threading.  In the latter case, all summary lines will be sorted,
9580 line by line.  In the former case, sorting will be done on a
9581 root-by-root basis, which might not be what you were looking for.  To
9582 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9583 Commands}).
9584
9585
9586 @node Finding the Parent
9587 @section Finding the Parent
9588 @cindex parent articles
9589 @cindex referring articles
9590
9591 @table @kbd
9592 @item ^
9593 @kindex ^ (Summary)
9594 @findex gnus-summary-refer-parent-article
9595 If you'd like to read the parent of the current article, and it is not
9596 displayed in the summary buffer, you might still be able to.  That is,
9597 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
9598 and the @code{References} in the current article are not mangled, you
9599 can just press @kbd{^} or @kbd{A r}
9600 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
9601 you'll get the parent.  If the parent is already displayed in the
9602 summary buffer, point will just move to this article.
9603
9604 If given a positive numerical prefix, fetch that many articles back into
9605 the ancestry.  If given a negative numerical prefix, fetch just that
9606 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
9607 grandparent and the grandgrandparent of the current article.  If you say
9608 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
9609 article.
9610
9611 @item A R (Summary)
9612 @findex gnus-summary-refer-references
9613 @kindex A R (Summary)
9614 Fetch all articles mentioned in the @code{References} header of the
9615 article (@code{gnus-summary-refer-references}).
9616
9617 @item A T (Summary)
9618 @findex gnus-summary-refer-thread
9619 @kindex A T (Summary)
9620 Display the full thread where the current article appears
9621 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
9622 headers in the current group to work, so it usually takes a while.  If
9623 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9624 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
9625 visible effects normally, but it'll make this command work a whole lot
9626 faster.  Of course, it'll make group entry somewhat slow.
9627
9628 @vindex gnus-refer-thread-limit
9629 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9630 articles before the first displayed in the current group) headers to
9631 fetch when doing this command.  The default is 200.  If @code{t}, all
9632 the available headers will be fetched.  This variable can be overridden
9633 by giving the @kbd{A T} command a numerical prefix.
9634
9635 @item M-^ (Summary)
9636 @findex gnus-summary-refer-article
9637 @kindex M-^ (Summary)
9638 @cindex Message-ID
9639 @cindex fetching by Message-ID
9640 You can also ask the @acronym{NNTP} server for an arbitrary article, no
9641 matter what group it belongs to.  @kbd{M-^}
9642 (@code{gnus-summary-refer-article}) will ask you for a
9643 @code{Message-ID}, which is one of those long, hard-to-read thingies
9644 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
9645 have to get it all exactly right.  No fuzzy searches, I'm afraid.
9646 @end table
9647
9648 The current select method will be used when fetching by
9649 @code{Message-ID} from non-news select method, but you can override this
9650 by giving this command a prefix.
9651
9652 @vindex gnus-refer-article-method
9653 If the group you are reading is located on a back end that does not
9654 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9655 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method.  It
9656 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
9657 updating the spool you are reading from, but that's not really
9658 necessary.
9659
9660 It can also be a list of select methods, as well as the special symbol
9661 @code{current}, which means to use the current select method.  If it
9662 is a list, Gnus will try all the methods in the list until it finds a
9663 match.
9664
9665 Here's an example setting that will first try the current method, and
9666 then ask Google if that fails:
9667
9668 @lisp
9669 (setq gnus-refer-article-method
9670       '(current
9671         (nnweb "google" (nnweb-type google))))
9672 @end lisp
9673
9674 Most of the mail back ends support fetching by @code{Message-ID}, but
9675 do not do a particularly excellent job at it.  That is, @code{nnmbox},
9676 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
9677 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
9678 only able to locate articles that have been posted to the current
9679 group.  (Anything else would be too time consuming.)  @code{nnmh} does
9680 not support this at all.
9681
9682
9683 @node Alternative Approaches
9684 @section Alternative Approaches
9685
9686 Different people like to read news using different methods.  This being
9687 Gnus, we offer a small selection of minor modes for the summary buffers.
9688
9689 @menu
9690 * Pick and Read::               First mark articles and then read them.
9691 * Binary Groups::               Auto-decode all articles.
9692 @end menu
9693
9694
9695 @node Pick and Read
9696 @subsection Pick and Read
9697 @cindex pick and read
9698
9699 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9700 a two-phased reading interface.  The user first marks in a summary
9701 buffer the articles she wants to read.  Then she starts reading the
9702 articles with just an article buffer displayed.
9703
9704 @findex gnus-pick-mode
9705 @kindex M-x gnus-pick-mode
9706 Gnus provides a summary buffer minor mode that allows
9707 this---@code{gnus-pick-mode}.  This basically means that a few process
9708 mark commands become one-keystroke commands to allow easy marking, and
9709 it provides one additional command for switching to the summary buffer.
9710
9711 Here are the available keystrokes when using pick mode:
9712
9713 @table @kbd
9714 @item .
9715 @kindex . (Pick)
9716 @findex gnus-pick-article-or-thread
9717 Pick the article or thread on the current line
9718 (@code{gnus-pick-article-or-thread}).  If the variable
9719 @code{gnus-thread-hide-subtree} is true, then this key selects the
9720 entire thread when used at the first article of the thread.  Otherwise,
9721 it selects just the article.  If given a numerical prefix, go to that
9722 thread or article and pick it.  (The line number is normally displayed
9723 at the beginning of the summary pick lines.)
9724
9725 @item SPACE
9726 @kindex SPACE (Pick)
9727 @findex gnus-pick-next-page
9728 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
9729 at the end of the buffer, start reading the picked articles.
9730
9731 @item u
9732 @kindex u (Pick)
9733 @findex gnus-pick-unmark-article-or-thread.
9734 Unpick the thread or article
9735 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
9736 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9737 thread if used at the first article of the thread.  Otherwise it unpicks
9738 just the article.  You can give this key a numerical prefix to unpick
9739 the thread or article at that line.
9740
9741 @item RET
9742 @kindex RET (Pick)
9743 @findex gnus-pick-start-reading
9744 @vindex gnus-pick-display-summary
9745 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
9746 given a prefix, mark all unpicked articles as read first.  If
9747 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9748 will still be visible when you are reading.
9749
9750 @end table
9751
9752 All the normal summary mode commands are still available in the
9753 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
9754 which is mapped to the same function
9755 @code{gnus-summary-tick-article-forward}.
9756
9757 If this sounds like a good idea to you, you could say:
9758
9759 @lisp
9760 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9761 @end lisp
9762
9763 @vindex gnus-pick-mode-hook
9764 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9765
9766 @vindex gnus-mark-unpicked-articles-as-read
9767 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9768 all unpicked articles as read.  The default is @code{nil}.
9769
9770 @vindex gnus-summary-pick-line-format
9771 The summary line format in pick mode is slightly different from the
9772 standard format.  At the beginning of each line the line number is
9773 displayed.  The pick mode line format is controlled by the
9774 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9775 Variables}).  It accepts the same format specs that
9776 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9777
9778
9779 @node Binary Groups
9780 @subsection Binary Groups
9781 @cindex binary groups
9782
9783 @findex gnus-binary-mode
9784 @kindex M-x gnus-binary-mode
9785 If you spend much time in binary groups, you may grow tired of hitting
9786 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
9787 is a minor mode for summary buffers that makes all ordinary Gnus article
9788 selection functions uudecode series of articles and display the result
9789 instead of just displaying the articles the normal way.
9790
9791 @kindex g (Binary)
9792 @findex gnus-binary-show-article
9793 The only way, in fact, to see the actual articles is the @kbd{g}
9794 command, when you have turned on this mode
9795 (@code{gnus-binary-show-article}).
9796
9797 @vindex gnus-binary-mode-hook
9798 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9799
9800
9801 @node Tree Display
9802 @section Tree Display
9803 @cindex trees
9804
9805 @vindex gnus-use-trees
9806 If you don't like the normal Gnus summary display, you might try setting
9807 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
9808 additional @dfn{tree buffer}.  You can execute all summary mode commands
9809 in the tree buffer.
9810
9811 There are a few variables to customize the tree display, of course:
9812
9813 @table @code
9814 @item gnus-tree-mode-hook
9815 @vindex gnus-tree-mode-hook
9816 A hook called in all tree mode buffers.
9817
9818 @item gnus-tree-mode-line-format
9819 @vindex gnus-tree-mode-line-format
9820 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9821 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
9822 of valid specs, @pxref{Summary Buffer Mode Line}.
9823
9824 @item gnus-selected-tree-face
9825 @vindex gnus-selected-tree-face
9826 Face used for highlighting the selected article in the tree buffer.  The
9827 default is @code{modeline}.
9828
9829 @item gnus-tree-line-format
9830 @vindex gnus-tree-line-format
9831 A format string for the tree nodes.  The name is a bit of a misnomer,
9832 though---it doesn't define a line, but just the node.  The default value
9833 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9834 the name of the poster.  It is vital that all nodes are of the same
9835 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9836
9837 Valid specs are:
9838
9839 @table @samp
9840 @item n
9841 The name of the poster.
9842 @item f
9843 The @code{From} header.
9844 @item N
9845 The number of the article.
9846 @item [
9847 The opening bracket.
9848 @item ]
9849 The closing bracket.
9850 @item s
9851 The subject.
9852 @end table
9853
9854 @xref{Formatting Variables}.
9855
9856 Variables related to the display are:
9857
9858 @table @code
9859 @item gnus-tree-brackets
9860 @vindex gnus-tree-brackets
9861 This is used for differentiating between ``real'' articles and
9862 ``sparse'' articles.  The format is
9863 @example
9864 ((@var{real-open} . @var{real-close})
9865  (@var{sparse-open} . @var{sparse-close})
9866  (@var{dummy-open} . @var{dummy-close}))
9867 @end example
9868 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9869
9870 @item gnus-tree-parent-child-edges
9871 @vindex gnus-tree-parent-child-edges
9872 This is a list that contains the characters used for connecting parent
9873 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
9874
9875 @end table
9876
9877 @item gnus-tree-minimize-window
9878 @vindex gnus-tree-minimize-window
9879 If this variable is non-@code{nil}, Gnus will try to keep the tree
9880 buffer as small as possible to allow more room for the other Gnus
9881 windows.  If this variable is a number, the tree buffer will never be
9882 higher than that number.  The default is @code{t}.  Note that if you
9883 have several windows displayed side-by-side in a frame and the tree
9884 buffer is one of these, minimizing the tree window will also resize all
9885 other windows displayed next to it.
9886
9887 You may also wish to add the following hook to keep the window minimized
9888 at all times:
9889
9890 @lisp
9891 (add-hook 'gnus-configure-windows-hook
9892           'gnus-tree-perhaps-minimize)
9893 @end lisp
9894
9895 @item gnus-generate-tree-function
9896 @vindex gnus-generate-tree-function
9897 @findex gnus-generate-horizontal-tree
9898 @findex gnus-generate-vertical-tree
9899 The function that actually generates the thread tree.  Two predefined
9900 functions are available: @code{gnus-generate-horizontal-tree} and
9901 @code{gnus-generate-vertical-tree} (which is the default).
9902
9903 @end table
9904
9905 Here's an example from a horizontal tree buffer:
9906
9907 @example
9908 @{***@}-(***)-[odd]-[Gun]
9909      |      \[Jan]
9910      |      \[odd]-[Eri]
9911      |      \(***)-[Eri]
9912      |            \[odd]-[Paa]
9913      \[Bjo]
9914      \[Gun]
9915      \[Gun]-[Jor]
9916 @end example
9917
9918 Here's the same thread displayed in a vertical tree buffer:
9919
9920 @example
9921 @group
9922 @{***@}
9923   |--------------------------\-----\-----\
9924 (***)                         [Bjo] [Gun] [Gun]
9925   |--\-----\-----\                          |
9926 [odd] [Jan] [odd] (***)                   [Jor]
9927   |           |     |--\
9928 [Gun]       [Eri] [Eri] [odd]
9929                           |
9930                         [Paa]
9931 @end group
9932 @end example
9933
9934 If you're using horizontal trees, it might be nice to display the trees
9935 side-by-side with the summary buffer.  You could add something like the
9936 following to your @file{~/.gnus.el} file:
9937
9938 @lisp
9939 (setq gnus-use-trees t
9940       gnus-generate-tree-function 'gnus-generate-horizontal-tree
9941       gnus-tree-minimize-window nil)
9942 (gnus-add-configuration
9943  '(article
9944    (vertical 1.0
9945              (horizontal 0.25
9946                          (summary 0.75 point)
9947                          (tree 1.0))
9948              (article 1.0))))
9949 @end lisp
9950
9951 @xref{Window Layout}.
9952
9953
9954 @node Mail Group Commands
9955 @section Mail Group Commands
9956 @cindex mail group commands
9957
9958 Some commands only make sense in mail groups.  If these commands are
9959 invalid in the current group, they will raise a hell and let you know.
9960
9961 All these commands (except the expiry and edit commands) use the
9962 process/prefix convention (@pxref{Process/Prefix}).
9963
9964 @table @kbd
9965
9966 @item B e
9967 @kindex B e (Summary)
9968 @findex gnus-summary-expire-articles
9969 Run all expirable articles in the current group through the expiry
9970 process (@code{gnus-summary-expire-articles}).  That is, delete all
9971 expirable articles in the group that have been around for a while.
9972 (@pxref{Expiring Mail}).
9973
9974 @item B C-M-e
9975 @kindex B C-M-e (Summary)
9976 @findex gnus-summary-expire-articles-now
9977 Delete all the expirable articles in the group
9978 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
9979 articles eligible for expiry in the current group will
9980 disappear forever into that big @file{/dev/null} in the sky.
9981
9982 @item B DEL
9983 @kindex B DEL (Summary)
9984 @findex gnus-summary-delete-article
9985 @c @icon{gnus-summary-mail-delete}
9986 Delete the mail article.  This is ``delete'' as in ``delete it from your
9987 disk forever and ever, never to return again.'' Use with caution.
9988 (@code{gnus-summary-delete-article}).
9989
9990 @item B m
9991 @kindex B m (Summary)
9992 @cindex move mail
9993 @findex gnus-summary-move-article
9994 @vindex gnus-preserve-marks
9995 Move the article from one mail group to another
9996 (@code{gnus-summary-move-article}).  Marks will be preserved if
9997 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9998
9999 @item B c
10000 @kindex B c (Summary)
10001 @cindex copy mail
10002 @findex gnus-summary-copy-article
10003 @c @icon{gnus-summary-mail-copy}
10004 Copy the article from one group (mail group or not) to a mail group
10005 (@code{gnus-summary-copy-article}).  Marks will be preserved if
10006 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10007
10008 @item B B
10009 @kindex B B (Summary)
10010 @cindex crosspost mail
10011 @findex gnus-summary-crosspost-article
10012 Crosspost the current article to some other group
10013 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
10014 the article in the other group, and the Xref headers of the article will
10015 be properly updated.
10016
10017 @item B i
10018 @kindex B i (Summary)
10019 @findex gnus-summary-import-article
10020 Import an arbitrary file into the current mail newsgroup
10021 (@code{gnus-summary-import-article}).  You will be prompted for a file
10022 name, a @code{From} header and a @code{Subject} header.
10023
10024 @item B I
10025 @kindex B I (Summary)
10026 @findex gnus-summary-create-article
10027 Create an empty article in the current mail newsgroups
10028 (@code{gnus-summary-create-article}).  You will be prompted for a
10029 @code{From} header and a @code{Subject} header.
10030
10031 @item B r
10032 @kindex B r (Summary)
10033 @findex gnus-summary-respool-article
10034 @vindex gnus-summary-respool-default-method
10035 Respool the mail article (@code{gnus-summary-respool-article}).
10036 @code{gnus-summary-respool-default-method} will be used as the default
10037 select method when respooling.  This variable is @code{nil} by default,
10038 which means that the current group select method will be used instead.
10039 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10040 (which is the default).
10041
10042 @item B w
10043 @itemx e
10044 @kindex B w (Summary)
10045 @kindex e (Summary)
10046 @findex gnus-summary-edit-article
10047 @kindex C-c C-c (Article)
10048 @findex gnus-summary-edit-article-done
10049 Edit the current article (@code{gnus-summary-edit-article}).  To finish
10050 editing and make the changes permanent, type @kbd{C-c C-c}
10051 (@code{gnus-summary-edit-article-done}).  If you give a prefix to the
10052 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10053
10054 @item B q
10055 @kindex B q (Summary)
10056 @findex gnus-summary-respool-query
10057 If you want to re-spool an article, you might be curious as to what group
10058 the article will end up in before you do the re-spooling.  This command
10059 will tell you (@code{gnus-summary-respool-query}).
10060
10061 @item B t
10062 @kindex B t (Summary)
10063 @findex gnus-summary-respool-trace
10064 Similarly, this command will display all fancy splitting patterns used
10065 when respooling, if any (@code{gnus-summary-respool-trace}).
10066
10067 @item B p
10068 @kindex B p (Summary)
10069 @findex gnus-summary-article-posted-p
10070 Some people have a tendency to send you ``courtesy'' copies when they
10071 follow up to articles you have posted.  These usually have a
10072 @code{Newsgroups} header in them, but not always.  This command
10073 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10074 article from your news server (or rather, from
10075 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10076 report back whether it found the article or not.  Even if it says that
10077 it didn't find the article, it may have been posted anyway---mail
10078 propagation is much faster than news propagation, and the news copy may
10079 just not have arrived yet.
10080
10081 @item K E
10082 @kindex K E (Summary)
10083 @findex gnus-article-encrypt-body
10084 @vindex gnus-article-encrypt-protocol
10085 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10086 The body is encrypted with the encryption protocol specified by the
10087 variable @code{gnus-article-encrypt-protocol}.
10088
10089 @end table
10090
10091 @vindex gnus-move-split-methods
10092 @cindex moving articles
10093 If you move (or copy) articles regularly, you might wish to have Gnus
10094 suggest where to put the articles.  @code{gnus-move-split-methods} is a
10095 variable that uses the same syntax as @code{gnus-split-methods}
10096 (@pxref{Saving Articles}).  You may customize that variable to create
10097 suggestions you find reasonable.  (Note that
10098 @code{gnus-move-split-methods} uses group names where
10099 @code{gnus-split-methods} uses file names.)
10100
10101 @lisp
10102 (setq gnus-move-split-methods
10103       '(("^From:.*Lars Magne" "nnml:junk")
10104         ("^Subject:.*gnus" "nnfolder:important")
10105         (".*" "nnml:misc")))
10106 @end lisp
10107
10108
10109 @node Various Summary Stuff
10110 @section Various Summary Stuff
10111
10112 @menu
10113 * Summary Group Information::   Information oriented commands.
10114 * Searching for Articles::      Multiple article commands.
10115 * Summary Generation Commands::
10116 * Really Various Summary Commands::  Those pesky non-conformant commands.
10117 @end menu
10118
10119 @table @code
10120 @vindex gnus-summary-display-while-building
10121 @item gnus-summary-display-while-building
10122 If non-@code{nil}, show and update the summary buffer as it's being
10123 built.  If @code{t}, update the buffer after every line is inserted.
10124 If the value is an integer, @var{n}, update the display every @var{n}
10125 lines.  The default is @code{nil}.
10126
10127 @vindex gnus-summary-display-arrow
10128 @item gnus-summary-display-arrow
10129 If non-@code{nil}, display an arrow in the fringe to indicate the
10130 current article.
10131
10132 @vindex gnus-summary-mode-hook
10133 @item gnus-summary-mode-hook
10134 This hook is called when creating a summary mode buffer.
10135
10136 @vindex gnus-summary-generate-hook
10137 @item gnus-summary-generate-hook
10138 This is called as the last thing before doing the threading and the
10139 generation of the summary buffer.  It's quite convenient for customizing
10140 the threading variables based on what data the newsgroup has.  This hook
10141 is called from the summary buffer after most summary buffer variables
10142 have been set.
10143
10144 @vindex gnus-summary-prepare-hook
10145 @item gnus-summary-prepare-hook
10146 It is called after the summary buffer has been generated.  You might use
10147 it to, for instance, highlight lines or modify the look of the buffer in
10148 some other ungodly manner.  I don't care.
10149
10150 @vindex gnus-summary-prepared-hook
10151 @item gnus-summary-prepared-hook
10152 A hook called as the very last thing after the summary buffer has been
10153 generated.
10154
10155 @vindex gnus-summary-ignore-duplicates
10156 @item gnus-summary-ignore-duplicates
10157 When Gnus discovers two articles that have the same @code{Message-ID},
10158 it has to do something drastic.  No articles are allowed to have the
10159 same @code{Message-ID}, but this may happen when reading mail from some
10160 sources.  Gnus allows you to customize what happens with this variable.
10161 If it is @code{nil} (which is the default), Gnus will rename the
10162 @code{Message-ID} (for display purposes only) and display the article as
10163 any other article.  If this variable is @code{t}, it won't display the
10164 article---it'll be as if it never existed.
10165
10166 @vindex gnus-alter-articles-to-read-function
10167 @item gnus-alter-articles-to-read-function
10168 This function, which takes two parameters (the group name and the list
10169 of articles to be selected), is called to allow the user to alter the
10170 list of articles to be selected.
10171
10172 For instance, the following function adds the list of cached articles to
10173 the list in one particular group:
10174
10175 @lisp
10176 (defun my-add-cached-articles (group articles)
10177   (if (string= group "some.group")
10178       (append gnus-newsgroup-cached articles)
10179     articles))
10180 @end lisp
10181
10182 @vindex gnus-newsgroup-variables
10183 @item gnus-newsgroup-variables
10184 A list of newsgroup (summary buffer) local variables, or cons of
10185 variables and their default values (when the default values are not
10186 @code{nil}), that should be made global while the summary buffer is
10187 active.  These variables can be used to set variables in the group
10188 parameters while still allowing them to affect operations done in
10189 other buffers.  For example:
10190
10191 @lisp
10192 (setq gnus-newsgroup-variables
10193       '(message-use-followup-to
10194         (gnus-visible-headers .
10195  "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10196 @end lisp
10197
10198 @end table
10199
10200
10201 @node Summary Group Information
10202 @subsection Summary Group Information
10203
10204 @table @kbd
10205
10206 @item H f
10207 @kindex H f (Summary)
10208 @findex gnus-summary-fetch-faq
10209 @vindex gnus-group-faq-directory
10210 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10211 for the current group (@code{gnus-summary-fetch-faq}).  Gnus will try
10212 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10213 is usually a directory on a remote machine.  This variable can also be
10214 a list of directories.  In that case, giving a prefix to this command
10215 will allow you to choose between the various sites.  @code{ange-ftp}
10216 or @code{efs} will probably be used for fetching the file.
10217
10218 @item H d
10219 @kindex H d (Summary)
10220 @findex gnus-summary-describe-group
10221 Give a brief description of the current group
10222 (@code{gnus-summary-describe-group}).  If given a prefix, force
10223 rereading the description from the server.
10224
10225 @item H h
10226 @kindex H h (Summary)
10227 @findex gnus-summary-describe-briefly
10228 Give an extremely brief description of the most important summary
10229 keystrokes (@code{gnus-summary-describe-briefly}).
10230
10231 @item H i
10232 @kindex H i (Summary)
10233 @findex gnus-info-find-node
10234 Go to the Gnus info node (@code{gnus-info-find-node}).
10235 @end table
10236
10237
10238 @node Searching for Articles
10239 @subsection Searching for Articles
10240
10241 @table @kbd
10242
10243 @item M-s
10244 @kindex M-s (Summary)
10245 @findex gnus-summary-search-article-forward
10246 Search through all subsequent (raw) articles for a regexp
10247 (@code{gnus-summary-search-article-forward}).
10248
10249 @item M-r
10250 @kindex M-r (Summary)
10251 @findex gnus-summary-search-article-backward
10252 Search through all previous (raw) articles for a regexp
10253 (@code{gnus-summary-search-article-backward}).
10254
10255 @item &
10256 @kindex & (Summary)
10257 @findex gnus-summary-execute-command
10258 This command will prompt you for a header, a regular expression to match
10259 on this field, and a command to be executed if the match is made
10260 (@code{gnus-summary-execute-command}).  If the header is an empty
10261 string, the match is done on the entire article.  If given a prefix,
10262 search backward instead.
10263
10264 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10265 all articles that have heads or bodies that match @samp{some.*string}.
10266
10267 @item M-&
10268 @kindex M-& (Summary)
10269 @findex gnus-summary-universal-argument
10270 Perform any operation on all articles that have been marked with
10271 the process mark (@code{gnus-summary-universal-argument}).
10272 @end table
10273
10274 @node Summary Generation Commands
10275 @subsection Summary Generation Commands
10276
10277 @table @kbd
10278
10279 @item Y g
10280 @kindex Y g (Summary)
10281 @findex gnus-summary-prepare
10282 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10283
10284 @item Y c
10285 @kindex Y c (Summary)
10286 @findex gnus-summary-insert-cached-articles
10287 Pull all cached articles (for the current group) into the summary buffer
10288 (@code{gnus-summary-insert-cached-articles}).
10289
10290 @item Y d
10291 @kindex Y d (Summary)
10292 @findex gnus-summary-insert-dormant-articles
10293 Pull all dormant articles (for the current group) into the summary buffer
10294 (@code{gnus-summary-insert-dormant-articles}).
10295
10296 @end table
10297
10298
10299 @node Really Various Summary Commands
10300 @subsection Really Various Summary Commands
10301
10302 @table @kbd
10303
10304 @item A D
10305 @itemx C-d
10306 @kindex C-d (Summary)
10307 @kindex A D (Summary)
10308 @findex gnus-summary-enter-digest-group
10309 If the current article is a collection of other articles (for instance,
10310 a digest), you might use this command to enter a group based on the that
10311 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
10312 guess what article type is currently displayed unless you give a prefix
10313 to this command, which forces a ``digest'' interpretation.  Basically,
10314 whenever you see a message that is a collection of other messages of
10315 some format, you @kbd{C-d} and read these messages in a more convenient
10316 fashion.
10317
10318 @item C-M-d
10319 @kindex C-M-d (Summary)
10320 @findex gnus-summary-read-document
10321 This command is very similar to the one above, but lets you gather
10322 several documents into one biiig group
10323 (@code{gnus-summary-read-document}).  It does this by opening several
10324 @code{nndoc} groups for each document, and then opening an
10325 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
10326 command understands the process/prefix convention
10327 (@pxref{Process/Prefix}).
10328
10329 @item C-t
10330 @kindex C-t (Summary)
10331 @findex gnus-summary-toggle-truncation
10332 Toggle truncation of summary lines
10333 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
10334 line centering function in the summary buffer, so it's not a good idea
10335 to have truncation switched off while reading articles.
10336
10337 @item =
10338 @kindex = (Summary)
10339 @findex gnus-summary-expand-window
10340 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10341 If given a prefix, force an @code{article} window configuration.
10342
10343 @item C-M-e
10344 @kindex C-M-e (Summary)
10345 @findex gnus-summary-edit-parameters
10346 Edit the group parameters (@pxref{Group Parameters}) of the current
10347 group (@code{gnus-summary-edit-parameters}).
10348
10349 @item C-M-a
10350 @kindex C-M-a (Summary)
10351 @findex gnus-summary-customize-parameters
10352 Customize the group parameters (@pxref{Group Parameters}) of the current
10353 group (@code{gnus-summary-customize-parameters}).
10354
10355 @end table
10356
10357
10358 @node Exiting the Summary Buffer
10359 @section Exiting the Summary Buffer
10360 @cindex summary exit
10361 @cindex exiting groups
10362
10363 Exiting from the summary buffer will normally update all info on the
10364 group and return you to the group buffer.
10365
10366 @table @kbd
10367
10368 @item Z Z
10369 @itemx Z Q
10370 @itemx q
10371 @kindex Z Z (Summary)
10372 @kindex Z Q (Summary)
10373 @kindex q (Summary)
10374 @findex gnus-summary-exit
10375 @vindex gnus-summary-exit-hook
10376 @vindex gnus-summary-prepare-exit-hook
10377 @vindex gnus-group-no-more-groups-hook
10378 @c @icon{gnus-summary-exit}
10379 Exit the current group and update all information on the group
10380 (@code{gnus-summary-exit}).  @code{gnus-summary-prepare-exit-hook} is
10381 called before doing much of the exiting, which calls
10382 @code{gnus-summary-expire-articles} by default.
10383 @code{gnus-summary-exit-hook} is called after finishing the exit
10384 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
10385 group mode having no more (unread) groups.
10386
10387 @item Z E
10388 @itemx Q
10389 @kindex Z E (Summary)
10390 @kindex Q (Summary)
10391 @findex gnus-summary-exit-no-update
10392 Exit the current group without updating any information on the group
10393 (@code{gnus-summary-exit-no-update}).
10394
10395 @item Z c
10396 @itemx c
10397 @kindex Z c (Summary)
10398 @kindex c (Summary)
10399 @findex gnus-summary-catchup-and-exit
10400 @c @icon{gnus-summary-catchup-and-exit}
10401 Mark all unticked articles in the group as read and then exit
10402 (@code{gnus-summary-catchup-and-exit}).
10403
10404 @item Z C
10405 @kindex Z C (Summary)
10406 @findex gnus-summary-catchup-all-and-exit
10407 Mark all articles, even the ticked ones, as read and then exit
10408 (@code{gnus-summary-catchup-all-and-exit}).
10409
10410 @item Z n
10411 @kindex Z n (Summary)
10412 @findex gnus-summary-catchup-and-goto-next-group
10413 Mark all articles as read and go to the next group
10414 (@code{gnus-summary-catchup-and-goto-next-group}).
10415
10416 @item Z R
10417 @itemx C-x C-s
10418 @kindex Z R (Summary)
10419 @kindex C-x C-s (Summary)
10420 @findex gnus-summary-reselect-current-group
10421 Exit this group, and then enter it again
10422 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
10423 all articles, both read and unread.
10424
10425 @item Z G
10426 @itemx M-g
10427 @kindex Z G (Summary)
10428 @kindex M-g (Summary)
10429 @findex gnus-summary-rescan-group
10430 @c @icon{gnus-summary-mail-get}
10431 Exit the group, check for new articles in the group, and select the
10432 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
10433 articles, both read and unread.
10434
10435 @item Z N
10436 @kindex Z N (Summary)
10437 @findex gnus-summary-next-group
10438 Exit the group and go to the next group
10439 (@code{gnus-summary-next-group}).
10440
10441 @item Z P
10442 @kindex Z P (Summary)
10443 @findex gnus-summary-prev-group
10444 Exit the group and go to the previous group
10445 (@code{gnus-summary-prev-group}).
10446
10447 @item Z s
10448 @kindex Z s (Summary)
10449 @findex gnus-summary-save-newsrc
10450 Save the current number of read/marked articles in the dribble buffer
10451 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
10452 given a prefix, also save the @file{.newsrc} file(s).  Using this
10453 command will make exit without updating (the @kbd{Q} command) worthless.
10454 @end table
10455
10456 @vindex gnus-exit-group-hook
10457 @code{gnus-exit-group-hook} is called when you exit the current group
10458 with an ``updating'' exit.  For instance @kbd{Q}
10459 (@code{gnus-summary-exit-no-update}) does not call this hook.
10460
10461 @findex gnus-summary-wake-up-the-dead
10462 @findex gnus-dead-summary-mode
10463 @vindex gnus-kill-summary-on-exit
10464 If you're in the habit of exiting groups, and then changing your mind
10465 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10466 If you do that, Gnus won't kill the summary buffer when you exit it.
10467 (Quelle surprise!)  Instead it will change the name of the buffer to
10468 something like @samp{*Dead Summary ... *} and install a minor mode
10469 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
10470 buffer, you'll find that all keys are mapped to a function called
10471 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
10472 summary buffer will result in a live, normal summary buffer.
10473
10474 There will never be more than one dead summary buffer at any one time.
10475
10476 @vindex gnus-use-cross-reference
10477 The data on the current group will be updated (which articles you have
10478 read, which articles you have replied to, etc.) when you exit the
10479 summary buffer.  If the @code{gnus-use-cross-reference} variable is
10480 @code{t} (which is the default), articles that are cross-referenced to
10481 this group and are marked as read, will also be marked as read in the
10482 other subscribed groups they were cross-posted to.  If this variable is
10483 neither @code{nil} nor @code{t}, the article will be marked as read in
10484 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10485
10486
10487 @node Crosspost Handling
10488 @section Crosspost Handling
10489
10490 @cindex velveeta
10491 @cindex spamming
10492 Marking cross-posted articles as read ensures that you'll never have to
10493 read the same article more than once.  Unless, of course, somebody has
10494 posted it to several groups separately.  Posting the same article to
10495 several groups (not cross-posting) is called @dfn{spamming}, and you are
10496 by law required to send nasty-grams to anyone who perpetrates such a
10497 heinous crime.  You may want to try NoCeM handling to filter out spam
10498 (@pxref{NoCeM}).
10499
10500 Remember: Cross-posting is kinda ok, but posting the same article
10501 separately to several groups is not.  Massive cross-posting (aka.
10502 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10503 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10504 excessive crossposting (@pxref{Summary Mail Commands}).
10505
10506 @cindex cross-posting
10507 @cindex Xref
10508 @cindex @acronym{NOV}
10509 One thing that may cause Gnus to not do the cross-posting thing
10510 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
10511 (which is very nice, because it speeds things up considerably) which
10512 does not include the @code{Xref} header in its @acronym{NOV} lines.  This is
10513 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
10514 even with @sc{xover} by registering the @code{Xref} lines of all
10515 articles you actually read, but if you kill the articles, or just mark
10516 them as read without reading them, Gnus will not get a chance to snoop
10517 the @code{Xref} lines out of these articles, and will be unable to use
10518 the cross reference mechanism.
10519
10520 @cindex LIST overview.fmt
10521 @cindex overview.fmt
10522 To check whether your @acronym{NNTP} server includes the @code{Xref} header
10523 in its overview files, try @samp{telnet your.nntp.server nntp},
10524 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10525 overview.fmt}.  This may not work, but if it does, and the last line you
10526 get does not read @samp{Xref:full}, then you should shout and whine at
10527 your news admin until she includes the @code{Xref} header in the
10528 overview files.
10529
10530 @vindex gnus-nov-is-evil
10531 If you want Gnus to get the @code{Xref}s right all the time, you have to
10532 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10533 considerably.
10534
10535 C'est la vie.
10536
10537 For an alternative approach, @pxref{Duplicate Suppression}.
10538
10539
10540 @node Duplicate Suppression
10541 @section Duplicate Suppression
10542
10543 By default, Gnus tries to make sure that you don't have to read the same
10544 article more than once by utilizing the crossposting mechanism
10545 (@pxref{Crosspost Handling}).  However, that simple and efficient
10546 approach may not work satisfactory for some users for various
10547 reasons.
10548
10549 @enumerate
10550 @item
10551 The @acronym{NNTP} server may fail to generate the @code{Xref} header.  This
10552 is evil and not very common.
10553
10554 @item
10555 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
10556 @file{.overview} data bases.  This is evil and all too common, alas.
10557
10558 @item
10559 You may be reading the same group (or several related groups) from
10560 different @acronym{NNTP} servers.
10561
10562 @item
10563 You may be getting mail that duplicates articles posted to groups.
10564 @end enumerate
10565
10566 I'm sure there are other situations where @code{Xref} handling fails as
10567 well, but these four are the most common situations.
10568
10569 If, and only if, @code{Xref} handling fails for you, then you may
10570 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
10571 will remember the @code{Message-ID}s of all articles you have read or
10572 otherwise marked as read, and then, as if by magic, mark them as read
10573 all subsequent times you see them---in @emph{all} groups.  Using this
10574 mechanism is quite likely to be somewhat inefficient, but not overly
10575 so.  It's certainly preferable to reading the same articles more than
10576 once.
10577
10578 Duplicate suppression is not a very subtle instrument.  It's more like a
10579 sledge hammer than anything else.  It works in a very simple
10580 fashion---if you have marked an article as read, it adds this Message-ID
10581 to a cache.  The next time it sees this Message-ID, it will mark the
10582 article as read with the @samp{M} mark.  It doesn't care what group it
10583 saw the article in.
10584
10585 @table @code
10586 @item gnus-suppress-duplicates
10587 @vindex gnus-suppress-duplicates
10588 If non-@code{nil}, suppress duplicates.
10589
10590 @item gnus-save-duplicate-list
10591 @vindex gnus-save-duplicate-list
10592 If non-@code{nil}, save the list of duplicates to a file.  This will
10593 make startup and shutdown take longer, so the default is @code{nil}.
10594 However, this means that only duplicate articles read in a single Gnus
10595 session are suppressed.
10596
10597 @item gnus-duplicate-list-length
10598 @vindex gnus-duplicate-list-length
10599 This variable says how many @code{Message-ID}s to keep in the duplicate
10600 suppression list.  The default is 10000.
10601
10602 @item gnus-duplicate-file
10603 @vindex gnus-duplicate-file
10604 The name of the file to store the duplicate suppression list in.  The
10605 default is @file{~/News/suppression}.
10606 @end table
10607
10608 If you have a tendency to stop and start Gnus often, setting
10609 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
10610 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
10611 the other hand, saving the list makes startup and shutdown much slower,
10612 so that means that if you stop and start Gnus often, you should set
10613 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
10614 to you to figure out, I think.
10615
10616 @node Security
10617 @section Security
10618
10619 Gnus is able to verify signed messages or decrypt encrypted messages.
10620 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
10621 and @acronym{S/MIME}, however you need some external programs to get
10622 things to work:
10623
10624 @enumerate
10625 @item
10626 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
10627 install an OpenPGP implementation such as GnuPG.  The Lisp interface
10628 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
10629 Manual}), but Mailcrypt and gpg.el are also supported.
10630
10631 @item
10632 To handle @acronym{S/MIME} message, you need to install OpenSSL.  OpenSSL 0.9.6
10633 or newer is recommended.
10634
10635 @end enumerate
10636
10637 More information on how to set things up can be found in the message
10638 manual (@pxref{Security, ,Security, message, Message Manual}).
10639
10640 @table @code
10641 @item mm-verify-option
10642 @vindex mm-verify-option
10643 Option of verifying signed parts.  @code{never}, not verify;
10644 @code{always}, always verify; @code{known}, only verify known
10645 protocols.  Otherwise, ask user.
10646
10647 @item mm-decrypt-option
10648 @vindex mm-decrypt-option
10649 Option of decrypting encrypted parts.  @code{never}, no decryption;
10650 @code{always}, always decrypt; @code{known}, only decrypt known
10651 protocols.  Otherwise, ask user.
10652
10653 @item mml1991-use
10654 @vindex mml1991-use
10655 Symbol indicating elisp interface to OpenPGP implementation for
10656 @acronym{PGP} messages.  The default is @code{pgg}, but
10657 @code{mailcrypt} and @code{gpg} are also supported although
10658 deprecated.
10659
10660 @item mml2015-use
10661 @vindex mml2015-use
10662 Symbol indicating elisp interface to OpenPGP implementation for
10663 @acronym{PGP/MIME} messages.  The default is @code{pgg}, but
10664 @code{mailcrypt} and @code{gpg} are also supported although
10665 deprecated.
10666
10667 @end table
10668
10669 @cindex snarfing keys
10670 @cindex importing PGP keys
10671 @cindex PGP key ring import
10672 Snarfing OpenPGP keys (i.e., importing keys from articles into your
10673 key ring) is not supported explicitly through a menu item or command,
10674 rather Gnus do detect and label keys as @samp{application/pgp-keys},
10675 allowing you to specify whatever action you think is appropriate
10676 through the usual @acronym{MIME} infrastructure.  You can use a
10677 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
10678 Emacs MIME Manual}) such as the following to import keys using GNU
10679 Privacy Guard when you click on the @acronym{MIME} button
10680 (@pxref{Using MIME}).
10681
10682 @example
10683 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
10684 @end example
10685 @noindent
10686 This happens to also be the default action defined in
10687 @code{mailcap-mime-data}.
10688
10689 @node Mailing List
10690 @section Mailing List
10691 @cindex mailing list
10692 @cindex RFC 2396
10693
10694 @kindex A M (summary)
10695 @findex gnus-mailing-list-insinuate
10696 Gnus understands some mailing list fields of RFC 2369.  To enable it,
10697 add a @code{to-list} group parameter (@pxref{Group Parameters}),
10698 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10699 summary buffer.
10700
10701 That enables the following commands to the summary buffer:
10702
10703 @table @kbd
10704
10705 @item C-c C-n h
10706 @kindex C-c C-n h (Summary)
10707 @findex gnus-mailing-list-help
10708 Send a message to fetch mailing list help, if List-Help field exists.
10709
10710 @item C-c C-n s
10711 @kindex C-c C-n s (Summary)
10712 @findex gnus-mailing-list-subscribe
10713 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10714
10715 @item C-c C-n u
10716 @kindex C-c C-n u (Summary)
10717 @findex gnus-mailing-list-unsubscribe
10718 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10719 field exists.
10720
10721 @item C-c C-n p
10722 @kindex C-c C-n p (Summary)
10723 @findex gnus-mailing-list-post
10724 Post to the mailing list, if List-Post field exists.
10725
10726 @item C-c C-n o
10727 @kindex C-c C-n o (Summary)
10728 @findex gnus-mailing-list-owner
10729 Send a message to the mailing list owner, if List-Owner field exists.
10730
10731 @item C-c C-n a
10732 @kindex C-c C-n a (Summary)
10733 @findex gnus-mailing-list-owner
10734 Browse the mailing list archive, if List-Archive field exists.
10735
10736 @end table
10737
10738
10739 @node Article Buffer
10740 @chapter Article Buffer
10741 @cindex article buffer
10742
10743 The articles are displayed in the article buffer, of which there is only
10744 one.  All the summary buffers share the same article buffer unless you
10745 tell Gnus otherwise.
10746
10747 @menu
10748 * Hiding Headers::              Deciding what headers should be displayed.
10749 * Using MIME::                  Pushing articles through @acronym{MIME} before reading them.
10750 * Customizing Articles::        Tailoring the look of the articles.
10751 * Article Keymap::              Keystrokes available in the article buffer.
10752 * Misc Article::                Other stuff.
10753 @end menu
10754
10755
10756 @node Hiding Headers
10757 @section Hiding Headers
10758 @cindex hiding headers
10759 @cindex deleting headers
10760
10761 The top section of each article is the @dfn{head}.  (The rest is the
10762 @dfn{body}, but you may have guessed that already.)
10763
10764 @vindex gnus-show-all-headers
10765 There is a lot of useful information in the head: the name of the person
10766 who wrote the article, the date it was written and the subject of the
10767 article.  That's well and nice, but there's also lots of information
10768 most people do not want to see---what systems the article has passed
10769 through before reaching you, the @code{Message-ID}, the
10770 @code{References}, etc. ad nauseam---and you'll probably want to get rid
10771 of some of those lines.  If you want to keep all those lines in the
10772 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10773
10774 Gnus provides you with two variables for sifting headers:
10775
10776 @table @code
10777
10778 @item gnus-visible-headers
10779 @vindex gnus-visible-headers
10780 If this variable is non-@code{nil}, it should be a regular expression
10781 that says what headers you wish to keep in the article buffer.  All
10782 headers that do not match this variable will be hidden.
10783
10784 For instance, if you only want to see the name of the person who wrote
10785 the article and the subject, you'd say:
10786
10787 @lisp
10788 (setq gnus-visible-headers "^From:\\|^Subject:")
10789 @end lisp
10790
10791 This variable can also be a list of regexps to match headers to
10792 remain visible.
10793
10794 @item gnus-ignored-headers
10795 @vindex gnus-ignored-headers
10796 This variable is the reverse of @code{gnus-visible-headers}.  If this
10797 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10798 should be a regular expression that matches all lines that you want to
10799 hide.  All lines that do not match this variable will remain visible.
10800
10801 For instance, if you just want to get rid of the @code{References} line
10802 and the @code{Xref} line, you might say:
10803
10804 @lisp
10805 (setq gnus-ignored-headers "^References:\\|^Xref:")
10806 @end lisp
10807
10808 This variable can also be a list of regexps to match headers to
10809 be removed.
10810
10811 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10812 variable will have no effect.
10813
10814 @end table
10815
10816 @vindex gnus-sorted-header-list
10817 Gnus can also sort the headers for you.  (It does this by default.)  You
10818 can control the sorting by setting the @code{gnus-sorted-header-list}
10819 variable.  It is a list of regular expressions that says in what order
10820 the headers are to be displayed.
10821
10822 For instance, if you want the name of the author of the article first,
10823 and then the subject, you might say something like:
10824
10825 @lisp
10826 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10827 @end lisp
10828
10829 Any headers that are to remain visible, but are not listed in this
10830 variable, will be displayed in random order after all the headers listed in this variable.
10831
10832 @findex gnus-article-hide-boring-headers
10833 @vindex gnus-boring-article-headers
10834 You can hide further boring headers by setting
10835 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
10836 does depends on the @code{gnus-boring-article-headers} variable.  It's a
10837 list, but this list doesn't actually contain header names.  Instead it
10838 lists various @dfn{boring conditions} that Gnus can check and remove
10839 from sight.
10840
10841 These conditions are:
10842 @table @code
10843 @item empty
10844 Remove all empty headers.
10845 @item followup-to
10846 Remove the @code{Followup-To} header if it is identical to the
10847 @code{Newsgroups} header.
10848 @item reply-to
10849 Remove the @code{Reply-To} header if it lists the same addresses as
10850 the @code{From} header, or if the @code{broken-reply-to} group
10851 parameter is set.
10852 @item newsgroups
10853 Remove the @code{Newsgroups} header if it only contains the current group
10854 name.
10855 @item to-address
10856 Remove the @code{To} header if it only contains the address identical to
10857 the current group's @code{to-address} parameter.
10858 @item to-list
10859 Remove the @code{To} header if it only contains the address identical to
10860 the current group's @code{to-list} parameter.
10861 @item cc-list
10862 Remove the @code{CC} header if it only contains the address identical to
10863 the current group's @code{to-list} parameter.
10864 @item date
10865 Remove the @code{Date} header if the article is less than three days
10866 old.
10867 @item long-to
10868 Remove the @code{To} header if it is very long.
10869 @item many-to
10870 Remove all @code{To} headers if there are more than one.
10871 @end table
10872
10873 To include these three elements, you could say something like:
10874
10875 @lisp
10876 (setq gnus-boring-article-headers
10877       '(empty followup-to reply-to))
10878 @end lisp
10879
10880 This is also the default value for this variable.
10881
10882
10883 @node Using MIME
10884 @section Using MIME
10885 @cindex @acronym{MIME}
10886
10887 Mime is a standard for waving your hands through the air, aimlessly,
10888 while people stand around yawning.
10889
10890 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
10891 while all newsreaders die of fear.
10892
10893 @acronym{MIME} may specify what character set the article uses, the encoding
10894 of the characters, and it also makes it possible to embed pictures and
10895 other naughty stuff in innocent-looking articles.
10896
10897 @vindex gnus-display-mime-function
10898 @findex gnus-display-mime
10899 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
10900 to display the @acronym{MIME} parts.  This is @code{gnus-display-mime} by
10901 default, which creates a bundle of clickable buttons that can be used to
10902 display, save and manipulate the @acronym{MIME} objects.
10903
10904 The following commands are available when you have placed point over a
10905 @acronym{MIME} button:
10906
10907 @table @kbd
10908 @findex gnus-article-press-button
10909 @item RET (Article)
10910 @kindex RET (Article)
10911 @itemx BUTTON-2 (Article)
10912 Toggle displaying of the @acronym{MIME} object
10913 (@code{gnus-article-press-button}).  If built-in viewers can not display
10914 the object, Gnus resorts to external viewers in the @file{mailcap}
10915 files.  If a viewer has the @samp{copiousoutput} specification, the
10916 object is displayed inline.
10917
10918 @findex gnus-mime-view-part
10919 @item M-RET (Article)
10920 @kindex M-RET (Article)
10921 @itemx v (Article)
10922 Prompt for a method, and then view the @acronym{MIME} object using this
10923 method (@code{gnus-mime-view-part}).
10924
10925 @findex gnus-mime-view-part-as-type
10926 @item t (Article)
10927 @kindex t (Article)
10928 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
10929 (@code{gnus-mime-view-part-as-type}).
10930
10931 @findex gnus-mime-view-part-as-charset
10932 @item C (Article)
10933 @kindex C (Article)
10934 Prompt for a charset, and then view the @acronym{MIME} object using this
10935 charset (@code{gnus-mime-view-part-as-charset}).
10936
10937 @findex gnus-mime-save-part
10938 @item o (Article)
10939 @kindex o (Article)
10940 Prompt for a file name, and then save the @acronym{MIME} object
10941 (@code{gnus-mime-save-part}).
10942
10943 @findex gnus-mime-save-part-and-strip
10944 @item C-o (Article)
10945 @kindex C-o (Article)
10946 Prompt for a file name, then save the @acronym{MIME} object and strip it from
10947 the article.  Then proceed to article editing, where a reasonable
10948 suggestion is being made on how the altered article should look
10949 like.  The stripped @acronym{MIME} object will be referred via the
10950 message/external-body @acronym{MIME} type.
10951 (@code{gnus-mime-save-part-and-strip}).
10952
10953 @findex gnus-mime-delete-part
10954 @item d (Article)
10955 @kindex d (Article)
10956 Delete the @acronym{MIME} object from the article and replace it with some
10957 information about the removed @acronym{MIME} object
10958 (@code{gnus-mime-delete-part}).
10959
10960 @findex gnus-mime-copy-part
10961 @item c (Article)
10962 @kindex c (Article)
10963 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
10964 (@code{gnus-mime-copy-part}).  Compressed files like @file{.gz} and
10965 @file{.bz2} are automatically decompressed if
10966 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
10967 Accessing Compressed Files, emacs, The Emacs Editor}).
10968
10969 @findex gnus-mime-print-part
10970 @item p (Article)
10971 @kindex p (Article)
10972 Print the @acronym{MIME} object (@code{gnus-mime-print-part}).  This
10973 command respects the @samp{print=} specifications in the
10974 @file{.mailcap} file.
10975
10976 @findex gnus-mime-inline-part
10977 @item i (Article)
10978 @kindex i (Article)
10979 Insert the contents of the @acronym{MIME} object into the buffer
10980 (@code{gnus-mime-inline-part}) as text/plain.  If given a prefix, insert
10981 the raw contents without decoding.  If given a numerical prefix, you can
10982 do semi-manual charset stuff (see
10983 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
10984 Article}).
10985
10986 @findex gnus-mime-view-part-internally
10987 @item E (Article)
10988 @kindex E (Article)
10989 View the @acronym{MIME} object with an internal viewer.  If no internal
10990 viewer is available, use an external viewer
10991 (@code{gnus-mime-view-part-internally}).
10992
10993 @findex gnus-mime-view-part-externally
10994 @item e (Article)
10995 @kindex e (Article)
10996 View the @acronym{MIME} object with an external viewer.
10997 (@code{gnus-mime-view-part-externally}).
10998
10999 @findex gnus-mime-pipe-part
11000 @item | (Article)
11001 @kindex | (Article)
11002 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11003
11004 @findex gnus-mime-action-on-part
11005 @item . (Article)
11006 @kindex . (Article)
11007 Interactively run an action on the @acronym{MIME} object
11008 (@code{gnus-mime-action-on-part}).
11009
11010 @end table
11011
11012 Gnus will display some @acronym{MIME} objects automatically.  The way Gnus
11013 determines which parts to do this with is described in the Emacs
11014 @acronym{MIME} manual.
11015
11016 It might be best to just use the toggling functions from the article
11017 buffer to avoid getting nasty surprises.  (For instance, you enter the
11018 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11019 decoded the sound file in the article and some horrible sing-a-long song
11020 comes screaming out your speakers, and you can't find the volume button,
11021 because there isn't one, and people are starting to look at you, and you
11022 try to stop the program, but you can't, and you can't find the program
11023 to control the volume, and everybody else in the room suddenly decides
11024 to look at you disdainfully, and you'll feel rather stupid.)
11025
11026 Any similarity to real events and people is purely coincidental.  Ahem.
11027
11028 Also @pxref{MIME Commands}.
11029
11030
11031 @node Customizing Articles
11032 @section Customizing Articles
11033 @cindex article customization
11034
11035 A slew of functions for customizing how the articles are to look like
11036 exist.  You can call these functions interactively
11037 (@pxref{Article Washing}), or you can have them
11038 called automatically when you select the articles.
11039
11040 To have them called automatically, you should set the corresponding
11041 ``treatment'' variable.  For instance, to have headers hidden, you'd set
11042 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
11043 be set, but first we discuss the values these variables can have.
11044
11045 Note: Some values, while valid, make little sense.  Check the list below
11046 for sensible values.
11047
11048 @enumerate
11049 @item
11050 @code{nil}: Don't do this treatment.
11051
11052 @item
11053 @code{t}: Do this treatment on all body parts.
11054
11055 @item
11056 @code{head}: Do the treatment on the headers.
11057
11058 @item
11059 @code{last}: Do this treatment on the last part.
11060
11061 @item
11062 An integer: Do this treatment on all body parts that have a length less
11063 than this number.
11064
11065 @item
11066 A list of strings: Do this treatment on all body parts that are in
11067 articles that are read in groups that have names that match one of the
11068 regexps in the list.
11069
11070 @item
11071 A list where the first element is not a string:
11072
11073 The list is evaluated recursively.  The first element of the list is a
11074 predicate.  The following predicates are recognized: @code{or},
11075 @code{and}, @code{not} and @code{typep}.  Here's an example:
11076
11077 @lisp
11078 (or last
11079     (typep "text/x-vcard"))
11080 @end lisp
11081
11082 @end enumerate
11083
11084 You may have noticed that the word @dfn{part} is used here.  This refers
11085 to the fact that some messages are @acronym{MIME} multipart articles that may
11086 be divided into several parts.  Articles that are not multiparts are
11087 considered to contain just a single part.
11088
11089 @vindex gnus-article-treat-types
11090 Are the treatments applied to all sorts of multipart parts?  Yes, if you
11091 want to, but by default, only @samp{text/plain} parts are given the
11092 treatment.  This is controlled by the @code{gnus-article-treat-types}
11093 variable, which is a list of regular expressions that are matched to the
11094 type of the part.  This variable is ignored if the value of the
11095 controlling variable is a predicate list, as described above.
11096
11097 The following treatment options are available.  The easiest way to
11098 customize this is to examine the @code{gnus-article-treat} customization
11099 group.  Values in parenthesis are suggested sensible values.  Others are
11100 possible but those listed are probably sufficient for most people.
11101
11102 @table @code
11103 @item gnus-treat-buttonize (t, integer)
11104 @item gnus-treat-buttonize-head (head)
11105
11106 @xref{Article Buttons}.
11107
11108 @item gnus-treat-capitalize-sentences (t, integer)
11109 @item gnus-treat-overstrike (t, integer)
11110 @item gnus-treat-strip-cr (t, integer)
11111 @item gnus-treat-strip-headers-in-body (t, integer)
11112 @item gnus-treat-strip-leading-blank-lines (t, integer)
11113 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11114 @item gnus-treat-strip-pem (t, last, integer)
11115 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11116 @item gnus-treat-unsplit-urls (t, integer)
11117 @item gnus-treat-wash-html (t, integer)
11118
11119 @xref{Article Washing}.
11120
11121 @item gnus-treat-date-english (head)
11122 @item gnus-treat-date-iso8601 (head)
11123 @item gnus-treat-date-lapsed (head)
11124 @item gnus-treat-date-local (head)
11125 @item gnus-treat-date-original (head)
11126 @item gnus-treat-date-user-defined (head)
11127 @item gnus-treat-date-ut (head)
11128
11129 @xref{Article Date}.
11130
11131 @item gnus-treat-from-picon (head)
11132 @item gnus-treat-mail-picon (head)
11133 @item gnus-treat-newsgroups-picon (head)
11134
11135 @xref{Picons}.
11136
11137 @item gnus-treat-display-smileys (t, integer)
11138
11139 @item gnus-treat-body-boundary (head)
11140
11141 @vindex gnus-body-boundary-delimiter
11142 Adds a delimiter between header and body, the string used as delimiter
11143 is controlled by @code{gnus-body-boundary-delimiter}.
11144
11145 @xref{Smileys}.
11146
11147 @item gnus-treat-display-x-face (head)
11148
11149 @xref{X-Face}.
11150
11151 @item gnus-treat-display-face (head)
11152
11153 @xref{Face}.
11154
11155 @item gnus-treat-emphasize (t, head, integer)
11156 @item gnus-treat-fill-article (t, integer)
11157 @item gnus-treat-fill-long-lines (t, integer)
11158 @item gnus-treat-hide-boring-headers (head)
11159 @item gnus-treat-hide-citation (t, integer)
11160 @item gnus-treat-hide-citation-maybe (t, integer)
11161 @item gnus-treat-hide-headers (head)
11162 @item gnus-treat-hide-signature (t, last)
11163 @item gnus-treat-strip-banner (t, last)
11164 @item gnus-treat-strip-list-identifiers (head)
11165
11166 @xref{Article Hiding}.
11167
11168 @item gnus-treat-highlight-citation (t, integer)
11169 @item gnus-treat-highlight-headers (head)
11170 @item gnus-treat-highlight-signature (t, last, integer)
11171
11172 @xref{Article Highlighting}.
11173
11174 @item gnus-treat-play-sounds
11175 @item gnus-treat-translate
11176 @item gnus-treat-x-pgp-sig (head)
11177
11178 @item gnus-treat-unfold-headers (head)
11179 @item gnus-treat-fold-headers (head)
11180 @item gnus-treat-fold-newsgroups (head)
11181 @item gnus-treat-leading-whitespace (head)
11182
11183 @xref{Article Header}.
11184
11185
11186 @end table
11187
11188 @vindex gnus-part-display-hook
11189 You can, of course, write your own functions to be called from
11190 @code{gnus-part-display-hook}.  The functions are called narrowed to the
11191 part, and you can do anything you like, pretty much.  There is no
11192 information that you have to keep in the buffer---you can change
11193 everything.
11194
11195
11196 @node Article Keymap
11197 @section Article Keymap
11198
11199 Most of the keystrokes in the summary buffer can also be used in the
11200 article buffer.  They should behave as if you typed them in the summary
11201 buffer, which means that you don't actually have to have a summary
11202 buffer displayed while reading.  You can do it all from the article
11203 buffer.
11204
11205 A few additional keystrokes are available:
11206
11207 @table @kbd
11208
11209 @item SPACE
11210 @kindex SPACE (Article)
11211 @findex gnus-article-next-page
11212 Scroll forwards one page (@code{gnus-article-next-page}).
11213 This is exactly the same as @kbd{h SPACE h}.
11214
11215 @item DEL
11216 @kindex DEL (Article)
11217 @findex gnus-article-prev-page
11218 Scroll backwards one page (@code{gnus-article-prev-page}).
11219 This is exactly the same as @kbd{h DEL h}.
11220
11221 @item C-c ^
11222 @kindex C-c ^ (Article)
11223 @findex gnus-article-refer-article
11224 If point is in the neighborhood of a @code{Message-ID} and you press
11225 @kbd{C-c ^}, Gnus will try to get that article from the server
11226 (@code{gnus-article-refer-article}).
11227
11228 @item C-c C-m
11229 @kindex C-c C-m (Article)
11230 @findex gnus-article-mail
11231 Send a reply to the address near point (@code{gnus-article-mail}).  If
11232 given a prefix, include the mail.
11233
11234 @item s
11235 @kindex s (Article)
11236 @findex gnus-article-show-summary
11237 Reconfigure the buffers so that the summary buffer becomes visible
11238 (@code{gnus-article-show-summary}).
11239
11240 @item ?
11241 @kindex ? (Article)
11242 @findex gnus-article-describe-briefly
11243 Give a very brief description of the available keystrokes
11244 (@code{gnus-article-describe-briefly}).
11245
11246 @item TAB
11247 @kindex TAB (Article)
11248 @findex gnus-article-next-button
11249 Go to the next button, if any (@code{gnus-article-next-button}).  This
11250 only makes sense if you have buttonizing turned on.
11251
11252 @item M-TAB
11253 @kindex M-TAB (Article)
11254 @findex gnus-article-prev-button
11255 Go to the previous button, if any (@code{gnus-article-prev-button}).
11256
11257 @item R
11258 @kindex R (Article)
11259 @findex gnus-article-reply-with-original
11260 Send a reply to the current article and yank the current article
11261 (@code{gnus-article-reply-with-original}).  If given a prefix, make a
11262 wide reply.  If the region is active, only yank the text in the
11263 region.
11264
11265 @item F
11266 @kindex F (Article)
11267 @findex gnus-article-followup-with-original
11268 Send a followup to the current article and yank the current article
11269 (@code{gnus-article-followup-with-original}).  If given a prefix, make
11270 a wide reply.  If the region is active, only yank the text in the
11271 region.
11272
11273
11274 @end table
11275
11276
11277 @node Misc Article
11278 @section Misc Article
11279
11280 @table @code
11281
11282 @item gnus-single-article-buffer
11283 @vindex gnus-single-article-buffer
11284 If non-@code{nil}, use the same article buffer for all the groups.
11285 (This is the default.)  If @code{nil}, each group will have its own
11286 article buffer.
11287
11288 @vindex gnus-article-decode-hook
11289 @item gnus-article-decode-hook
11290 @cindex @acronym{MIME}
11291 Hook used to decode @acronym{MIME} articles.  The default value is
11292 @code{(article-decode-charset article-decode-encoded-words)}
11293
11294 @vindex gnus-article-prepare-hook
11295 @item gnus-article-prepare-hook
11296 This hook is called right after the article has been inserted into the
11297 article buffer.  It is mainly intended for functions that do something
11298 depending on the contents; it should probably not be used for changing
11299 the contents of the article buffer.
11300
11301 @item gnus-article-mode-hook
11302 @vindex gnus-article-mode-hook
11303 Hook called in article mode buffers.
11304
11305 @item gnus-article-mode-syntax-table
11306 @vindex gnus-article-mode-syntax-table
11307 Syntax table used in article buffers.  It is initialized from
11308 @code{text-mode-syntax-table}.
11309
11310 @vindex gnus-article-over-scroll
11311 @item gnus-article-over-scroll
11312 If non-@code{nil}, allow scrolling the article buffer even when there
11313 no more new text to scroll in.  The default is @code{nil}.
11314
11315 @vindex gnus-article-mode-line-format
11316 @item gnus-article-mode-line-format
11317 This variable is a format string along the same lines as
11318 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
11319 accepts the same format specifications as that variable, with two
11320 extensions:
11321
11322 @table @samp
11323
11324 @item w
11325 The @dfn{wash status} of the article.  This is a short string with one
11326 character for each possible article wash operation that may have been
11327 performed.  The characters and their meaning:
11328
11329 @table @samp
11330
11331 @item c
11332 Displayed when cited text may be hidden in the article buffer.
11333
11334 @item h
11335 Displayed when headers are hidden in the article buffer.
11336
11337 @item p
11338 Displayed when article is digitally signed or encrypted, and Gnus has
11339 hidden the security headers.  (N.B. does not tell anything about
11340 security status, i.e. good or bad signature.)
11341
11342 @item s
11343 Displayed when the signature has been hidden in the Article buffer.
11344
11345 @item o
11346 Displayed when Gnus has treated overstrike characters in the article buffer.
11347
11348 @item e
11349 Displayed when Gnus has treated emphasised strings in the article buffer.
11350
11351 @end table
11352
11353 @item m
11354 The number of @acronym{MIME} parts in the article.
11355
11356 @end table
11357
11358 @vindex gnus-break-pages
11359
11360 @item gnus-break-pages
11361 Controls whether @dfn{page breaking} is to take place.  If this variable
11362 is non-@code{nil}, the articles will be divided into pages whenever a
11363 page delimiter appears in the article.  If this variable is @code{nil},
11364 paging will not be done.
11365
11366 @item gnus-page-delimiter
11367 @vindex gnus-page-delimiter
11368 This is the delimiter mentioned above.  By default, it is @samp{^L}
11369 (formfeed).
11370
11371 @cindex IDNA
11372 @cindex internationalized domain names
11373 @vindex gnus-use-idna
11374 @item gnus-use-idna
11375 This variable controls whether Gnus performs IDNA decoding of
11376 internationalized domain names inside @samp{From}, @samp{To} and
11377 @samp{Cc} headers.  This requires
11378 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
11379 variable is only enabled if you have installed it.
11380
11381 @end table
11382
11383
11384 @node Composing Messages
11385 @chapter Composing Messages
11386 @cindex composing messages
11387 @cindex messages
11388 @cindex mail
11389 @cindex sending mail
11390 @cindex reply
11391 @cindex followup
11392 @cindex post
11393 @cindex using gpg
11394 @cindex using s/mime
11395 @cindex using smime
11396
11397 @kindex C-c C-c (Post)
11398 All commands for posting and mailing will put you in a message buffer
11399 where you can edit the article all you like, before you send the
11400 article by pressing @kbd{C-c C-c}.  @xref{Top, , Overview, message,
11401 Message Manual}.  Where the message will be posted/mailed to depends
11402 on your setup (@pxref{Posting Server}).
11403
11404 @menu
11405 * Mail::                        Mailing and replying.
11406 * Posting Server::              What server should you post and mail via?
11407 * Mail and Post::               Mailing and posting at the same time.
11408 * Archived Messages::           Where Gnus stores the messages you've sent.
11409 * Posting Styles::              An easier way to specify who you are.
11410 * Drafts::                      Postponing messages and rejected messages.
11411 * Rejected Articles::           What happens if the server doesn't like your article?
11412 * Signing and encrypting::      How to compose secure messages.
11413 @end menu
11414
11415 Also @pxref{Canceling and Superseding} for information on how to
11416 remove articles you shouldn't have posted.
11417
11418
11419 @node Mail
11420 @section Mail
11421
11422 Variables for customizing outgoing mail:
11423
11424 @table @code
11425 @item gnus-uu-digest-headers
11426 @vindex gnus-uu-digest-headers
11427 List of regexps to match headers included in digested messages.  The
11428 headers will be included in the sequence they are matched.  If
11429 @code{nil} include all headers.
11430
11431 @item gnus-add-to-list
11432 @vindex gnus-add-to-list
11433 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
11434 that have none when you do a @kbd{a}.
11435
11436 @item gnus-confirm-mail-reply-to-news
11437 @vindex gnus-confirm-mail-reply-to-news
11438 This can also be a function receiving the group name as the only
11439 parameter which should return non-@code{nil} if a confirmation is
11440 needed, or a regular expression matching group names, where
11441 confirmation is should be asked for.
11442
11443 If you find yourself never wanting to reply to mail, but occasionally
11444 press R anyway, this variable might be for you.
11445
11446 @item gnus-confirm-treat-mail-like-news
11447 @vindex gnus-confirm-treat-mail-like-news
11448 If non-@code{nil}, Gnus also requests confirmation according to
11449 @code{gnus-confirm-mail-reply-to-news} when replying to mail.  This is
11450 useful for treating mailing lists like newsgroups.
11451
11452 @end table
11453
11454
11455 @node Posting Server
11456 @section Posting Server
11457
11458 When you press those magical @kbd{C-c C-c} keys to ship off your latest
11459 (extremely intelligent, of course) article, where does it go?
11460
11461 Thank you for asking.  I hate you.
11462
11463 It can be quite complicated.
11464
11465 @vindex gnus-post-method
11466 When posting news, Message usually invokes @code{message-send-news}
11467 (@pxref{News Variables, , News Variables, message, Message Manual}).
11468 Normally, Gnus will post using the same select method as you're
11469 reading from (which might be convenient if you're reading lots of
11470 groups from different private servers).  However.  If the server
11471 you're reading from doesn't allow posting, just reading, you probably
11472 want to use some other server to post your (extremely intelligent and
11473 fabulously interesting) articles.  You can then set the
11474 @code{gnus-post-method} to some other method:
11475
11476 @lisp
11477 (setq gnus-post-method '(nnspool ""))
11478 @end lisp
11479
11480 Now, if you've done this, and then this server rejects your article, or
11481 this server is down, what do you do then?  To override this variable you
11482 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
11483 the ``current'' server, to get back the default behavior, for posting.
11484
11485 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
11486 Gnus will prompt you for what method to use for posting.
11487
11488 You can also set @code{gnus-post-method} to a list of select methods.
11489 If that's the case, Gnus will always prompt you for what method to use
11490 for posting.
11491
11492 Finally, if you want to always post using the native select method,
11493 you can set this variable to @code{native}.
11494
11495 When sending mail, Message invokes @code{message-send-mail-function}.
11496 The default function, @code{message-send-mail-with-sendmail}, pipes
11497 your article to the @code{sendmail} binary for further queuing and
11498 sending.  When your local system is not configured for sending mail
11499 using @code{sendmail}, and you have access to a remote @acronym{SMTP}
11500 server, you can set @code{message-send-mail-function} to
11501 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
11502 package correctly.  An example:
11503
11504 @lisp
11505 (setq message-send-mail-function 'smtpmail-send-it
11506       smtpmail-default-smtp-server "YOUR SMTP HOST")
11507 @end lisp
11508
11509 To the thing similar to this, there is
11510 @code{message-smtpmail-send-it}.  It is useful if your ISP requires
11511 the @acronym{POP}-before-@acronym{SMTP} authentication.  See the
11512 documentation for the function @code{mail-source-touch-pop}.
11513
11514 Other possible choices for @code{message-send-mail-function} includes
11515 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
11516 and @code{feedmail-send-it}.
11517
11518 @node Mail and Post
11519 @section Mail and Post
11520
11521 Here's a list of variables relevant to both mailing and
11522 posting:
11523
11524 @table @code
11525 @item gnus-mailing-list-groups
11526 @findex gnus-mailing-list-groups
11527 @cindex mailing lists
11528
11529 If your news server offers groups that are really mailing lists
11530 gatewayed to the @acronym{NNTP} server, you can read those groups without
11531 problems, but you can't post/followup to them without some difficulty.
11532 One solution is to add a @code{to-address} to the group parameters
11533 (@pxref{Group Parameters}).  An easier thing to do is set the
11534 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
11535 really are mailing lists.  Then, at least, followups to the mailing
11536 lists will work most of the time.  Posting to these groups (@kbd{a}) is
11537 still a pain, though.
11538
11539 @item gnus-user-agent
11540 @vindex gnus-user-agent
11541 @cindex User-Agent
11542
11543 This variable controls which information should be exposed in the
11544 User-Agent header.  It can be one of the symbols @code{gnus} (show only
11545 Gnus version), @code{emacs-gnus} (show only Emacs and Gnus versions),
11546 @code{emacs-gnus-config} (same as @code{emacs-gnus} plus system
11547 configuration), @code{emacs-gnus-type} (same as @code{emacs-gnus} plus
11548 system type) or a custom string.  If you set it to a string, be sure to
11549 use a valid format, see RFC 2616.
11550
11551 @end table
11552
11553 You may want to do spell-checking on messages that you send out.  Or, if
11554 you don't want to spell-check by hand, you could add automatic
11555 spell-checking via the @code{ispell} package:
11556
11557 @cindex ispell
11558 @findex ispell-message
11559 @lisp
11560 (add-hook 'message-send-hook 'ispell-message)
11561 @end lisp
11562
11563 If you want to change the @code{ispell} dictionary based on what group
11564 you're in, you could say something like the following:
11565
11566 @lisp
11567 (add-hook 'gnus-select-group-hook
11568           (lambda ()
11569             (cond
11570              ((string-match
11571                "^de\\." (gnus-group-real-name gnus-newsgroup-name))
11572               (ispell-change-dictionary "deutsch"))
11573              (t
11574               (ispell-change-dictionary "english")))))
11575 @end lisp
11576
11577 Modify to suit your needs.
11578
11579
11580 @node Archived Messages
11581 @section Archived Messages
11582 @cindex archived messages
11583 @cindex sent messages
11584
11585 Gnus provides a few different methods for storing the mail and news you
11586 send.  The default method is to use the @dfn{archive virtual server} to
11587 store the messages.  If you want to disable this completely, the
11588 @code{gnus-message-archive-group} variable should be @code{nil}, which
11589 is the default.
11590
11591 For archiving interesting messages in a group you read, see the
11592 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
11593 Group Commands}).
11594
11595 @vindex gnus-message-archive-method
11596 @code{gnus-message-archive-method} says what virtual server Gnus is to
11597 use to store sent messages.  The default is:
11598
11599 @lisp
11600 (nnfolder "archive"
11601           (nnfolder-directory   "~/Mail/archive")
11602           (nnfolder-active-file "~/Mail/archive/active")
11603           (nnfolder-get-new-mail nil)
11604           (nnfolder-inhibit-expiry t))
11605 @end lisp
11606
11607 You can, however, use any mail select method (@code{nnml},
11608 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likable select method
11609 for doing this sort of thing, though.  If you don't like the default
11610 directory chosen, you could say something like:
11611
11612 @lisp
11613 (setq gnus-message-archive-method
11614       '(nnfolder "archive"
11615                  (nnfolder-inhibit-expiry t)
11616                  (nnfolder-active-file "~/News/sent-mail/active")
11617                  (nnfolder-directory "~/News/sent-mail/")))
11618 @end lisp
11619
11620 @vindex gnus-message-archive-group
11621 @cindex Gcc
11622 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11623 to one or more group(s) on that server.  Which group to use is
11624 determined by the @code{gnus-message-archive-group} variable.
11625
11626 This variable can be used to do the following:
11627
11628 @table @asis
11629 @item a string
11630 Messages will be saved in that group.
11631
11632 Note that you can include a select method in the group name, then the
11633 message will not be stored in the select method given by
11634 @code{gnus-message-archive-method}, but in the select method specified
11635 by the group name, instead.  Suppose @code{gnus-message-archive-method}
11636 has the default value shown above.  Then setting
11637 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11638 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11639 value @code{"nnml:foo"}, then outgoing messages will be stored in
11640 @samp{nnml:foo}.
11641
11642 @item a list of strings
11643 Messages will be saved in all those groups.
11644
11645 @item an alist of regexps, functions and forms
11646 When a key ``matches'', the result is used.
11647
11648 @item @code{nil}
11649 No message archiving will take place.  This is the default.
11650 @end table
11651
11652 Let's illustrate:
11653
11654 Just saving to a single group called @samp{MisK}:
11655 @lisp
11656 (setq gnus-message-archive-group "MisK")
11657 @end lisp
11658
11659 Saving to two groups, @samp{MisK} and @samp{safe}:
11660 @lisp
11661 (setq gnus-message-archive-group '("MisK" "safe"))
11662 @end lisp
11663
11664 Save to different groups based on what group you are in:
11665 @lisp
11666 (setq gnus-message-archive-group
11667       '(("^alt" "sent-to-alt")
11668         ("mail" "sent-to-mail")
11669         (".*" "sent-to-misc")))
11670 @end lisp
11671
11672 More complex stuff:
11673 @lisp
11674 (setq gnus-message-archive-group
11675       '((if (message-news-p)
11676             "misc-news"
11677           "misc-mail")))
11678 @end lisp
11679
11680 How about storing all news messages in one file, but storing all mail
11681 messages in one file per month:
11682
11683 @lisp
11684 (setq gnus-message-archive-group
11685       '((if (message-news-p)
11686             "misc-news"
11687           (concat "mail." (format-time-string "%Y-%m")))))
11688 @end lisp
11689
11690 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11691 @c use a different value for @code{gnus-message-archive-group} there.)
11692
11693 Now, when you send a message off, it will be stored in the appropriate
11694 group.  (If you want to disable storing for just one particular message,
11695 you can just remove the @code{Gcc} header that has been inserted.)  The
11696 archive group will appear in the group buffer the next time you start
11697 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
11698 enter it and read the articles in it just like you'd read any other
11699 group.  If the group gets really big and annoying, you can simply rename
11700 if (using @kbd{G r} in the group buffer) to something
11701 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
11702 continue to be stored in the old (now empty) group.
11703
11704 That's the default method of archiving sent messages.  Gnus offers a
11705 different way for the people who don't like the default method.  In that
11706 case you should set @code{gnus-message-archive-group} to @code{nil};
11707 this will disable archiving.
11708
11709 @table @code
11710 @item gnus-outgoing-message-group
11711 @vindex gnus-outgoing-message-group
11712 All outgoing messages will be put in this group.  If you want to store
11713 all your outgoing mail and articles in the group @samp{nnml:archive},
11714 you set this variable to that value.  This variable can also be a list of
11715 group names.
11716
11717 If you want to have greater control over what group to put each
11718 message in, you can set this variable to a function that checks the
11719 current newsgroup name and then returns a suitable group name (or list
11720 of names).
11721
11722 This variable can be used instead of @code{gnus-message-archive-group},
11723 but the latter is the preferred method.
11724
11725 @item gnus-gcc-mark-as-read
11726 @vindex gnus-gcc-mark-as-read
11727 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11728
11729 @item gnus-gcc-externalize-attachments
11730 @vindex gnus-gcc-externalize-attachments
11731 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11732 and matches the Gcc group name, attach files as external parts; if it is
11733 @code{all}, attach local files as external parts; if it is other
11734 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11735 changed in the future.
11736
11737 @end table
11738
11739
11740 @node Posting Styles
11741 @section Posting Styles
11742 @cindex posting styles
11743 @cindex styles
11744
11745 All them variables, they make my head swim.
11746
11747 So what if you want a different @code{Organization} and signature based
11748 on what groups you post to?  And you post both from your home machine
11749 and your work machine, and you want different @code{From} lines, and so
11750 on?
11751
11752 @vindex gnus-posting-styles
11753 One way to do stuff like that is to write clever hooks that change the
11754 variables you need to have changed.  That's a bit boring, so somebody
11755 came up with the bright idea of letting the user specify these things in
11756 a handy alist.  Here's an example of a @code{gnus-posting-styles}
11757 variable:
11758
11759 @lisp
11760 ((".*"
11761   (signature "Peace and happiness")
11762   (organization "What me?"))
11763  ("^comp"
11764   (signature "Death to everybody"))
11765  ("comp.emacs.i-love-it"
11766   (organization "Emacs is it")))
11767 @end lisp
11768
11769 As you might surmise from this example, this alist consists of several
11770 @dfn{styles}.  Each style will be applicable if the first element
11771 ``matches'', in some form or other.  The entire alist will be iterated
11772 over, from the beginning towards the end, and each match will be
11773 applied, which means that attributes in later styles that match override
11774 the same attributes in earlier matching styles.  So
11775 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11776 signature and the @samp{What me?} @code{Organization} header.
11777
11778 The first element in each style is called the @code{match}.  If it's a
11779 string, then Gnus will try to regexp match it against the group name.
11780 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
11781 will look in the original article for a header whose name is
11782 @var{match} and compare that @var{regexp}.  @var{match} and
11783 @var{regexp} are strings.  (The original article is the one you are
11784 replying or following up to.  If you are not composing a reply or a
11785 followup, then there is nothing to match against.)  If the
11786 @code{match} is a function symbol, that function will be called with
11787 no arguments.  If it's a variable symbol, then the variable will be
11788 referenced.  If it's a list, then that list will be @code{eval}ed.  In
11789 any case, if this returns a non-@code{nil} value, then the style is
11790 said to @dfn{match}.
11791
11792 Each style may contain an arbitrary amount of @dfn{attributes}.  Each
11793 attribute consists of a @code{(@var{name} @var{value})} pair.  The
11794 attribute name can be one of:
11795
11796 @itemize @bullet
11797 @item @code{signature}
11798 @item @code{signature-file}
11799 @item @code{x-face-file}
11800 @item @code{address}, overriding @code{user-mail-address}
11801 @item @code{name}, overriding @code{(user-full-name)}
11802 @item @code{body}
11803 @end itemize
11804
11805 The attribute name can also be a string or a symbol.  In that case,
11806 this will be used as a header name, and the value will be inserted in
11807 the headers of the article; if the value is @code{nil}, the header
11808 name will be removed.  If the attribute name is @code{eval}, the form
11809 is evaluated, and the result is thrown away.
11810
11811 The attribute value can be a string (used verbatim), a function with
11812 zero arguments (the return value will be used), a variable (its value
11813 will be used) or a list (it will be @code{eval}ed and the return value
11814 will be used).  The functions and sexps are called/@code{eval}ed in the
11815 message buffer that is being set up.  The headers of the current article
11816 are available through the @code{message-reply-headers} variable, which
11817 is a vector of the following headers: number subject from date id
11818 references chars lines xref extra.
11819
11820 @vindex message-reply-headers
11821
11822 If you wish to check whether the message you are about to compose is
11823 meant to be a news article or a mail message, you can check the values
11824 of the @code{message-news-p} and @code{message-mail-p} functions.
11825
11826 @findex message-mail-p
11827 @findex message-news-p
11828
11829 So here's a new example:
11830
11831 @lisp
11832 (setq gnus-posting-styles
11833       '((".*"
11834          (signature-file "~/.signature")
11835          (name "User Name")
11836          ("X-Home-Page" (getenv "WWW_HOME"))
11837          (organization "People's Front Against MWM"))
11838         ("^rec.humor"
11839          (signature my-funny-signature-randomizer))
11840         ((equal (system-name) "gnarly")  ;; @r{A form}
11841          (signature my-quote-randomizer))
11842         (message-news-p        ;; @r{A function symbol}
11843          (signature my-news-signature))
11844         (window-system         ;; @r{A value symbol}
11845          ("X-Window-System" (format "%s" window-system)))
11846         ;; @r{If I'm replying to Larsi, set the Organization header.}
11847         ((header "from" "larsi.*org")
11848          (Organization "Somewhere, Inc."))
11849         ((posting-from-work-p) ;; @r{A user defined function}
11850          (signature-file "~/.work-signature")
11851          (address "user@@bar.foo")
11852          (body "You are fired.\n\nSincerely, your boss.")
11853          (organization "Important Work, Inc"))
11854         ("nnml:.*"
11855          (From (save-excursion
11856                  (set-buffer gnus-article-buffer)
11857                  (message-fetch-field "to"))))
11858         ("^nn.+:"
11859          (signature-file "~/.mail-signature"))))
11860 @end lisp
11861
11862 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11863 @code{From} address in all your outgoing replies, which might be handy
11864 if you fill many roles.
11865
11866
11867 @node Drafts
11868 @section Drafts
11869 @cindex drafts
11870
11871 If you are writing a message (mail or news) and suddenly remember that
11872 you have a steak in the oven (or some pesto in the food processor, you
11873 craaazy vegetarians), you'll probably wish there was a method to save
11874 the message you are writing so that you can continue editing it some
11875 other day, and send it when you feel its finished.
11876
11877 Well, don't worry about it.  Whenever you start composing a message of
11878 some sort using the Gnus mail and post commands, the buffer you get will
11879 automatically associate to an article in a special @dfn{draft} group.
11880 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11881 article will be saved there.  (Auto-save files also go to the draft
11882 group.)
11883
11884 @cindex nndraft
11885 @vindex nndraft-directory
11886 The draft group is a special group (which is implemented as an
11887 @code{nndraft} group, if you absolutely have to know) called
11888 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
11889 @code{nndraft} is to store its files.  What makes this group special is
11890 that you can't tick any articles in it or mark any articles as
11891 read---all articles in the group are permanently unread.
11892
11893 If the group doesn't exist, it will be created and you'll be subscribed
11894 to it.  The only way to make it disappear from the Group buffer is to
11895 unsubscribe it.  The special properties of the draft group comes from
11896 a group property (@pxref{Group Parameters}), and if lost the group
11897 behaves like any other group.  This means the commands below will not
11898 be available.  To restore the special properties of the group, the
11899 simplest way is to kill the group, using @kbd{C-k}, and restart
11900 Gnus.  The group is automatically created again with the
11901 correct parameters.  The content of the group is not lost.
11902
11903 @c @findex gnus-dissociate-buffer-from-draft
11904 @c @kindex C-c M-d (Mail)
11905 @c @kindex C-c M-d (Post)
11906 @c @findex gnus-associate-buffer-with-draft
11907 @c @kindex C-c C-d (Mail)
11908 @c @kindex C-c C-d (Post)
11909 @c If you're writing some super-secret message that you later want to
11910 @c encode with PGP before sending, you may wish to turn the auto-saving
11911 @c (and association with the draft group) off.  You never know who might be
11912 @c interested in reading all your extremely valuable and terribly horrible
11913 @c and interesting secrets.  The @kbd{C-c M-d}
11914 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11915 @c If you change your mind and want to turn the auto-saving back on again,
11916 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11917 @c
11918 @c @vindex gnus-use-draft
11919 @c To leave association with the draft group off by default, set
11920 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
11921
11922 @findex gnus-draft-edit-message
11923 @kindex D e (Draft)
11924 When you want to continue editing the article, you simply enter the
11925 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11926 that.  You will be placed in a buffer where you left off.
11927
11928 Rejected articles will also be put in this draft group (@pxref{Rejected
11929 Articles}).
11930
11931 @findex gnus-draft-send-all-messages
11932 @kindex D s (Draft)
11933 @findex gnus-draft-send-message
11934 @kindex D S (Draft)
11935 If you have lots of rejected messages you want to post (or mail) without
11936 doing further editing, you can use the @kbd{D s} command
11937 (@code{gnus-draft-send-message}).  This command understands the
11938 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
11939 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11940 in the buffer.
11941
11942 @findex gnus-draft-toggle-sending
11943 @kindex D t (Draft)
11944 If you have some messages that you wish not to send, you can use the
11945 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11946 as unsendable.  This is a toggling command.
11947
11948
11949 @node Rejected Articles
11950 @section Rejected Articles
11951 @cindex rejected articles
11952
11953 Sometimes a news server will reject an article.  Perhaps the server
11954 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
11955 @emph{there be demons}.  Perhaps you have included too much cited text.
11956 Perhaps the disk is full.  Perhaps the server is down.
11957
11958 These situations are, of course, totally beyond the control of Gnus.
11959 (Gnus, of course, loves the way you look, always feels great, has angels
11960 fluttering around inside of it, doesn't care about how much cited text
11961 you include, never runs full and never goes down.)  So Gnus saves these
11962 articles until some later time when the server feels better.
11963
11964 The rejected articles will automatically be put in a special draft group
11965 (@pxref{Drafts}).  When the server comes back up again, you'd then
11966 typically enter that group and send all the articles off.
11967
11968 @node Signing and encrypting
11969 @section Signing and encrypting
11970 @cindex using gpg
11971 @cindex using s/mime
11972 @cindex using smime
11973
11974 Gnus can digitally sign and encrypt your messages, using vanilla
11975 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}.  For
11976 decoding such messages, see the @code{mm-verify-option} and
11977 @code{mm-decrypt-option} options (@pxref{Security}).
11978
11979 @vindex gnus-message-replysign
11980 @vindex gnus-message-replyencrypt
11981 @vindex gnus-message-replysignencrypted
11982 Often, you would like to sign replies to people who send you signed
11983 messages.  Even more often, you might want to encrypt messages which
11984 are in reply to encrypted messages.  Gnus offers
11985 @code{gnus-message-replysign} to enable the former, and
11986 @code{gnus-message-replyencrypt} for the latter.  In addition, setting
11987 @code{gnus-message-replysignencrypted} (on by default) will sign
11988 automatically encrypted messages.
11989
11990 Instructing @acronym{MML} to perform security operations on a
11991 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
11992 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
11993
11994 @table @kbd
11995
11996 @item C-c C-m s s
11997 @kindex C-c C-m s s (Message)
11998 @findex mml-secure-message-sign-smime
11999
12000 Digitally sign current message using @acronym{S/MIME}.
12001
12002 @item C-c C-m s o
12003 @kindex C-c C-m s o (Message)
12004 @findex mml-secure-message-sign-pgp
12005
12006 Digitally sign current message using @acronym{PGP}.
12007
12008 @item C-c C-m s p
12009 @kindex C-c C-m s p (Message)
12010 @findex mml-secure-message-sign-pgp
12011
12012 Digitally sign current message using @acronym{PGP/MIME}.
12013
12014 @item C-c C-m c s
12015 @kindex C-c C-m c s (Message)
12016 @findex mml-secure-message-encrypt-smime
12017
12018 Digitally encrypt current message using @acronym{S/MIME}.
12019
12020 @item C-c C-m c o
12021 @kindex C-c C-m c o (Message)
12022 @findex mml-secure-message-encrypt-pgp
12023
12024 Digitally encrypt current message using @acronym{PGP}.
12025
12026 @item C-c C-m c p
12027 @kindex C-c C-m c p (Message)
12028 @findex mml-secure-message-encrypt-pgpmime
12029
12030 Digitally encrypt current message using @acronym{PGP/MIME}.
12031
12032 @item C-c C-m C-n
12033 @kindex C-c C-m C-n (Message)
12034 @findex mml-unsecure-message
12035 Remove security related @acronym{MML} tags from message.
12036
12037 @end table
12038
12039 @xref{Security, ,Security, message, Message Manual}, for more information.
12040
12041 @node Select Methods
12042 @chapter Select Methods
12043 @cindex foreign groups
12044 @cindex select methods
12045
12046 A @dfn{foreign group} is a group not read by the usual (or
12047 default) means.  It could be, for instance, a group from a different
12048 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12049 personal mail group.
12050
12051 A foreign group (or any group, really) is specified by a @dfn{name} and
12052 a @dfn{select method}.  To take the latter first, a select method is a
12053 list where the first element says what back end to use (e.g. @code{nntp},
12054 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12055 name}.  There may be additional elements in the select method, where the
12056 value may have special meaning for the back end in question.
12057
12058 One could say that a select method defines a @dfn{virtual server}---so
12059 we do just that (@pxref{Server Buffer}).
12060
12061 The @dfn{name} of the group is the name the back end will recognize the
12062 group as.
12063
12064 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12065 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12066 method @code{(nntp "some.where.edu")}.  Gnus will call this group
12067 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12068 back end just knows this group as @samp{soc.motss}.
12069
12070 The different methods all have their peculiarities, of course.
12071
12072 @menu
12073 * Server Buffer::               Making and editing virtual servers.
12074 * Getting News::                Reading USENET news with Gnus.
12075 * Getting Mail::                Reading your personal mail with Gnus.
12076 * Browsing the Web::            Getting messages from a plethora of Web sources.
12077 * IMAP::                        Using Gnus as a @acronym{IMAP} client.
12078 * Other Sources::               Reading directories, files, SOUP packets.
12079 * Combined Groups::             Combining groups into one group.
12080 * Gnus Unplugged::              Reading news and mail offline.
12081 @end menu
12082
12083
12084 @node Server Buffer
12085 @section Server Buffer
12086
12087 Traditionally, a @dfn{server} is a machine or a piece of software that
12088 one connects to, and then requests information from.  Gnus does not
12089 connect directly to any real servers, but does all transactions through
12090 one back end or other.  But that's just putting one layer more between
12091 the actual media and Gnus, so we might just as well say that each
12092 back end represents a virtual server.
12093
12094 For instance, the @code{nntp} back end may be used to connect to several
12095 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12096 on the same actual @acronym{NNTP} server.  You tell Gnus which back end to
12097 use, and what parameters to set by specifying a @dfn{select method}.
12098
12099 These select method specifications can sometimes become quite
12100 complicated---say, for instance, that you want to read from the
12101 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12102 hangs if queried for @acronym{NOV} headers and has a buggy select.  Ahem.
12103 Anyway, if you had to specify that for each group that used this
12104 server, that would be too much work, so Gnus offers a way of naming
12105 select methods, which is what you do in the server buffer.
12106
12107 To enter the server buffer, use the @kbd{^}
12108 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12109
12110 @menu
12111 * Server Buffer Format::        You can customize the look of this buffer.
12112 * Server Commands::             Commands to manipulate servers.
12113 * Example Methods::             Examples server specifications.
12114 * Creating a Virtual Server::   An example session.
12115 * Server Variables::            Which variables to set.
12116 * Servers and Methods::         You can use server names as select methods.
12117 * Unavailable Servers::         Some servers you try to contact may be down.
12118 @end menu
12119
12120 @vindex gnus-server-mode-hook
12121 @code{gnus-server-mode-hook} is run when creating the server buffer.
12122
12123
12124 @node Server Buffer Format
12125 @subsection Server Buffer Format
12126 @cindex server buffer format
12127
12128 @vindex gnus-server-line-format
12129 You can change the look of the server buffer lines by changing the
12130 @code{gnus-server-line-format} variable.  This is a @code{format}-like
12131 variable, with some simple extensions:
12132
12133 @table @samp
12134
12135 @item h
12136 How the news is fetched---the back end name.
12137
12138 @item n
12139 The name of this server.
12140
12141 @item w
12142 Where the news is to be fetched from---the address.
12143
12144 @item s
12145 The opened/closed/denied status of the server.
12146 @end table
12147
12148 @vindex gnus-server-mode-line-format
12149 The mode line can also be customized by using the
12150 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12151 Formatting}).  The following specs are understood:
12152
12153 @table @samp
12154 @item S
12155 Server name.
12156
12157 @item M
12158 Server method.
12159 @end table
12160
12161 Also @pxref{Formatting Variables}.
12162
12163
12164 @node Server Commands
12165 @subsection Server Commands
12166 @cindex server commands
12167
12168 @table @kbd
12169
12170 @item a
12171 @kindex a (Server)
12172 @findex gnus-server-add-server
12173 Add a new server (@code{gnus-server-add-server}).
12174
12175 @item e
12176 @kindex e (Server)
12177 @findex gnus-server-edit-server
12178 Edit a server (@code{gnus-server-edit-server}).
12179
12180 @item SPACE
12181 @kindex SPACE (Server)
12182 @findex gnus-server-read-server
12183 Browse the current server (@code{gnus-server-read-server}).
12184
12185 @item q
12186 @kindex q (Server)
12187 @findex gnus-server-exit
12188 Return to the group buffer (@code{gnus-server-exit}).
12189
12190 @item k
12191 @kindex k (Server)
12192 @findex gnus-server-kill-server
12193 Kill the current server (@code{gnus-server-kill-server}).
12194
12195 @item y
12196 @kindex y (Server)
12197 @findex gnus-server-yank-server
12198 Yank the previously killed server (@code{gnus-server-yank-server}).
12199
12200 @item c
12201 @kindex c (Server)
12202 @findex gnus-server-copy-server
12203 Copy the current server (@code{gnus-server-copy-server}).
12204
12205 @item l
12206 @kindex l (Server)
12207 @findex gnus-server-list-servers
12208 List all servers (@code{gnus-server-list-servers}).
12209
12210 @item s
12211 @kindex s (Server)
12212 @findex gnus-server-scan-server
12213 Request that the server scan its sources for new articles
12214 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
12215 servers.
12216
12217 @item g
12218 @kindex g (Server)
12219 @findex gnus-server-regenerate-server
12220 Request that the server regenerate all its data structures
12221 (@code{gnus-server-regenerate-server}).  This can be useful if you have
12222 a mail back end that has gotten out of sync.
12223
12224 @end table
12225
12226
12227 @node Example Methods
12228 @subsection Example Methods
12229
12230 Most select methods are pretty simple and self-explanatory:
12231
12232 @lisp
12233 (nntp "news.funet.fi")
12234 @end lisp
12235
12236 Reading directly from the spool is even simpler:
12237
12238 @lisp
12239 (nnspool "")
12240 @end lisp
12241
12242 As you can see, the first element in a select method is the name of the
12243 back end, and the second is the @dfn{address}, or @dfn{name}, if you
12244 will.
12245
12246 After these two elements, there may be an arbitrary number of
12247 @code{(@var{variable} @var{form})} pairs.
12248
12249 To go back to the first example---imagine that you want to read from
12250 port 15 on that machine.  This is what the select method should
12251 look like then:
12252
12253 @lisp
12254 (nntp "news.funet.fi" (nntp-port-number 15))
12255 @end lisp
12256
12257 You should read the documentation to each back end to find out what
12258 variables are relevant, but here's an @code{nnmh} example:
12259
12260 @code{nnmh} is a mail back end that reads a spool-like structure.  Say
12261 you have two structures that you wish to access: One is your private
12262 mail spool, and the other is a public one.  Here's the possible spec for
12263 your private mail:
12264
12265 @lisp
12266 (nnmh "private" (nnmh-directory "~/private/mail/"))
12267 @end lisp
12268
12269 (This server is then called @samp{private}, but you may have guessed
12270 that.)
12271
12272 Here's the method for a public spool:
12273
12274 @lisp
12275 (nnmh "public"
12276       (nnmh-directory "/usr/information/spool/")
12277       (nnmh-get-new-mail nil))
12278 @end lisp
12279
12280 @cindex proxy
12281 @cindex firewall
12282
12283 If you are behind a firewall and only have access to the @acronym{NNTP}
12284 server from the firewall machine, you can instruct Gnus to @code{rlogin}
12285 on the firewall machine and telnet from there to the @acronym{NNTP} server.
12286 Doing this can be rather fiddly, but your virtual server definition
12287 should probably look something like this:
12288
12289 @lisp
12290 (nntp "firewall"
12291       (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
12292       (nntp-via-address "the.firewall.machine")
12293       (nntp-address "the.real.nntp.host")
12294       (nntp-end-of-line "\n"))
12295 @end lisp
12296
12297 If you want to use the wonderful @code{ssh} program to provide a
12298 compressed connection over the modem line, you could add the following
12299 configuration to the example above:
12300
12301 @lisp
12302       (nntp-via-rlogin-command "ssh")
12303 @end lisp
12304
12305 See also @code{nntp-via-rlogin-command-switches}.
12306
12307 If you're behind a firewall, but have direct access to the outside world
12308 through a wrapper command like "runsocks", you could open a socksified
12309 telnet connection to the news server as follows:
12310
12311 @lisp
12312 (nntp "outside"
12313       (nntp-pre-command "runsocks")
12314       (nntp-open-connection-function nntp-open-via-telnet)
12315       (nntp-address "the.news.server")
12316       (nntp-end-of-line "\n"))
12317 @end lisp
12318
12319 This means that you have to have set up @code{ssh-agent} correctly to
12320 provide automatic authorization, of course.  And to get a compressed
12321 connection, you have to have the @samp{Compression} option in the
12322 @code{ssh} @file{config} file.
12323
12324
12325 @node Creating a Virtual Server
12326 @subsection Creating a Virtual Server
12327
12328 If you're saving lots of articles in the cache by using persistent
12329 articles, you may want to create a virtual server to read the cache.
12330
12331 First you need to add a new server.  The @kbd{a} command does that.  It
12332 would probably be best to use @code{nnml} to read the cache.  You
12333 could also use @code{nnspool} or @code{nnmh}, though.
12334
12335 Type @kbd{a nnml RET cache RET}.
12336
12337 You should now have a brand new @code{nnml} virtual server called
12338 @samp{cache}.  You now need to edit it to have the right definitions.
12339 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
12340 will contain the following:
12341
12342 @lisp
12343 (nnml "cache")
12344 @end lisp
12345
12346 Change that to:
12347
12348 @lisp
12349 (nnml "cache"
12350          (nnml-directory "~/News/cache/")
12351          (nnml-active-file "~/News/cache/active"))
12352 @end lisp
12353
12354 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
12355 @kbd{RET} over this virtual server, you should be entered into a browse
12356 buffer, and you should be able to enter any of the groups displayed.
12357
12358
12359 @node Server Variables
12360 @subsection Server Variables
12361 @cindex server variables
12362 @cindex server parameters
12363
12364 One sticky point when defining variables (both on back ends and in Emacs
12365 in general) is that some variables are typically initialized from other
12366 variables when the definition of the variables is being loaded.  If you
12367 change the ``base'' variable after the variables have been loaded, you
12368 won't change the ``derived'' variables.
12369
12370 This typically affects directory and file variables.  For instance,
12371 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
12372 directory variables are initialized from that variable, so
12373 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
12374 new virtual @code{nnml} server, it will @emph{not} suffice to set just
12375 @code{nnml-directory}---you have to explicitly set all the file
12376 variables to be what you want them to be.  For a complete list of
12377 variables for each back end, see each back end's section later in this
12378 manual, but here's an example @code{nnml} definition:
12379
12380 @lisp
12381 (nnml "public"
12382       (nnml-directory "~/my-mail/")
12383       (nnml-active-file "~/my-mail/active")
12384       (nnml-newsgroups-file "~/my-mail/newsgroups"))
12385 @end lisp
12386
12387 Server variables are often called @dfn{server parameters}.
12388
12389 @node Servers and Methods
12390 @subsection Servers and Methods
12391
12392 Wherever you would normally use a select method
12393 (e.g. @code{gnus-secondary-select-method}, in the group select method,
12394 when browsing a foreign server) you can use a virtual server name
12395 instead.  This could potentially save lots of typing.  And it's nice all
12396 over.
12397
12398
12399 @node Unavailable Servers
12400 @subsection Unavailable Servers
12401
12402 If a server seems to be unreachable, Gnus will mark that server as
12403 @code{denied}.  That means that any subsequent attempt to make contact
12404 with that server will just be ignored.  ``It can't be opened,'' Gnus
12405 will tell you, without making the least effort to see whether that is
12406 actually the case or not.
12407
12408 That might seem quite naughty, but it does make sense most of the time.
12409 Let's say you have 10 groups subscribed to on server
12410 @samp{nephelococcygia.com}.  This server is located somewhere quite far
12411 away from you and the machine is quite slow, so it takes 1 minute just
12412 to find out that it refuses connection to you today.  If Gnus were to
12413 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
12414 attempt to do that.  Once it has gotten a single ``connection refused'',
12415 it will regard that server as ``down''.
12416
12417 So, what happens if the machine was only feeling unwell temporarily?
12418 How do you test to see whether the machine has come up again?
12419
12420 You jump to the server buffer (@pxref{Server Buffer}) and poke it
12421 with the following commands:
12422
12423 @table @kbd
12424
12425 @item O
12426 @kindex O (Server)
12427 @findex gnus-server-open-server
12428 Try to establish connection to the server on the current line
12429 (@code{gnus-server-open-server}).
12430
12431 @item C
12432 @kindex C (Server)
12433 @findex gnus-server-close-server
12434 Close the connection (if any) to the server
12435 (@code{gnus-server-close-server}).
12436
12437 @item D
12438 @kindex D (Server)
12439 @findex gnus-server-deny-server
12440 Mark the current server as unreachable
12441 (@code{gnus-server-deny-server}).
12442
12443 @item M-o
12444 @kindex M-o (Server)
12445 @findex gnus-server-open-all-servers
12446 Open the connections to all servers in the buffer
12447 (@code{gnus-server-open-all-servers}).
12448
12449 @item M-c
12450 @kindex M-c (Server)
12451 @findex gnus-server-close-all-servers
12452 Close the connections to all servers in the buffer
12453 (@code{gnus-server-close-all-servers}).
12454
12455 @item R
12456 @kindex R (Server)
12457 @findex gnus-server-remove-denials
12458 Remove all marks to whether Gnus was denied connection from any servers
12459 (@code{gnus-server-remove-denials}).
12460
12461 @item L
12462 @kindex L (Server)
12463 @findex gnus-server-offline-server
12464 Set server status to offline (@code{gnus-server-offline-server}).
12465
12466 @end table
12467
12468
12469 @node Getting News
12470 @section Getting News
12471 @cindex reading news
12472 @cindex news back ends
12473
12474 A newsreader is normally used for reading news.  Gnus currently provides
12475 only two methods of getting news---it can read from an @acronym{NNTP} server,
12476 or it can read from a local spool.
12477
12478 @menu
12479 * NNTP::                        Reading news from an @acronym{NNTP} server.
12480 * News Spool::                  Reading news from the local spool.
12481 @end menu
12482
12483
12484 @node NNTP
12485 @subsection NNTP
12486 @cindex nntp
12487
12488 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
12489 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
12490 server as the, uhm, address.
12491
12492 If the @acronym{NNTP} server is located at a non-standard port, setting the
12493 third element of the select method to this port number should allow you
12494 to connect to the right port.  You'll have to edit the group info for
12495 that (@pxref{Foreign Groups}).
12496
12497 The name of the foreign group can be the same as a native group.  In
12498 fact, you can subscribe to the same group from as many different servers
12499 you feel like.  There will be no name collisions.
12500
12501 The following variables can be used to create a virtual @code{nntp}
12502 server:
12503
12504 @table @code
12505
12506 @item nntp-server-opened-hook
12507 @vindex nntp-server-opened-hook
12508 @cindex @sc{mode reader}
12509 @cindex authinfo
12510 @cindex authentification
12511 @cindex nntp authentification
12512 @findex nntp-send-authinfo
12513 @findex nntp-send-mode-reader
12514 is run after a connection has been made.  It can be used to send
12515 commands to the @acronym{NNTP} server after it has been contacted.  By
12516 default it sends the command @code{MODE READER} to the server with the
12517 @code{nntp-send-mode-reader} function.  This function should always be
12518 present in this hook.
12519
12520 @item nntp-authinfo-function
12521 @vindex nntp-authinfo-function
12522 @findex nntp-send-authinfo
12523 @vindex nntp-authinfo-file
12524 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
12525 server.  The default function is @code{nntp-send-authinfo}, which looks
12526 through your @file{~/.authinfo} (or whatever you've set the
12527 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
12528 are found, it will prompt you for a login name and a password.  The
12529 format of the @file{~/.authinfo} file is (almost) the same as the
12530 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
12531 manual page, but here are the salient facts:
12532
12533 @enumerate
12534 @item
12535 The file contains one or more line, each of which define one server.
12536
12537 @item
12538 Each line may contain an arbitrary number of token/value pairs.
12539
12540 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
12541 @samp{default}.  In addition Gnus introduces two new tokens, not present
12542 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
12543 @samp{force}.  (This is the only way the @file{.authinfo} file format
12544 deviates from the @file{.netrc} file format.)  @samp{port} is used to
12545 indicate what port on the server the credentials apply to and
12546 @samp{force} is explained below.
12547
12548 @end enumerate
12549
12550 Here's an example file:
12551
12552 @example
12553 machine news.uio.no login larsi password geheimnis
12554 machine nntp.ifi.uio.no login larsi force yes
12555 @end example
12556
12557 The token/value pairs may appear in any order; @samp{machine} doesn't
12558 have to be first, for instance.
12559
12560 In this example, both login name and password have been supplied for the
12561 former server, while the latter has only the login name listed, and the
12562 user will be prompted for the password.  The latter also has the
12563 @samp{force} tag, which means that the authinfo will be sent to the
12564 @var{nntp} server upon connection; the default (i.e., when there is not
12565 @samp{force} tag) is to not send authinfo to the @var{nntp} server
12566 until the @var{nntp} server asks for it.
12567
12568 You can also add @samp{default} lines that will apply to all servers
12569 that don't have matching @samp{machine} lines.
12570
12571 @example
12572 default force yes
12573 @end example
12574
12575 This will force sending @samp{AUTHINFO} commands to all servers not
12576 previously mentioned.
12577
12578 Remember to not leave the @file{~/.authinfo} file world-readable.
12579
12580 @item nntp-server-action-alist
12581 @vindex nntp-server-action-alist
12582 This is a list of regexps to match on server types and actions to be
12583 taken when matches are made.  For instance, if you want Gnus to beep
12584 every time you connect to innd, you could say something like:
12585
12586 @lisp
12587 (setq nntp-server-action-alist
12588       '(("innd" (ding))))
12589 @end lisp
12590
12591 You probably don't want to do that, though.
12592
12593 The default value is
12594
12595 @lisp
12596 '(("nntpd 1\\.5\\.11t"
12597    (remove-hook 'nntp-server-opened-hook
12598                 'nntp-send-mode-reader)))
12599 @end lisp
12600
12601 This ensures that Gnus doesn't send the @code{MODE READER} command to
12602 nntpd 1.5.11t, since that command chokes that server, I've been told.
12603
12604 @item nntp-maximum-request
12605 @vindex nntp-maximum-request
12606 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
12607 will collect headers by sending a series of @code{head} commands.  To
12608 speed things up, the back end sends lots of these commands without
12609 waiting for reply, and then reads all the replies.  This is controlled
12610 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
12611 your network is buggy, you should set this to 1.
12612
12613 @item nntp-connection-timeout
12614 @vindex nntp-connection-timeout
12615 If you have lots of foreign @code{nntp} groups that you connect to
12616 regularly, you're sure to have problems with @acronym{NNTP} servers not
12617 responding properly, or being too loaded to reply within reasonable
12618 time.  This is can lead to awkward problems, which can be helped
12619 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
12620 that says how many seconds the @code{nntp} back end should wait for a
12621 connection before giving up.  If it is @code{nil}, which is the default,
12622 no timeouts are done.
12623
12624 @c @item nntp-command-timeout
12625 @c @vindex nntp-command-timeout
12626 @c @cindex PPP connections
12627 @c @cindex dynamic IP addresses
12628 @c If you're running Gnus on a machine that has a dynamically assigned
12629 @c address, Gnus may become confused.  If the address of your machine
12630 @c changes after connecting to the @acronym{NNTP} server, Gnus will simply sit
12631 @c waiting forever for replies from the server.  To help with this
12632 @c unfortunate problem, you can set this command to a number.  Gnus will
12633 @c then, if it sits waiting for a reply from the server longer than that
12634 @c number of seconds, shut down the connection, start a new one, and resend
12635 @c the command.  This should hopefully be transparent to the user.  A
12636 @c likely number is 30 seconds.
12637 @c
12638 @c @item nntp-retry-on-break
12639 @c @vindex nntp-retry-on-break
12640 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12641 @c hangs.  This will have much the same effect as the command timeout
12642 @c described above.
12643
12644 @item nntp-server-hook
12645 @vindex nntp-server-hook
12646 This hook is run as the last step when connecting to an @acronym{NNTP}
12647 server.
12648
12649 @item nntp-buggy-select
12650 @vindex nntp-buggy-select
12651 Set this to non-@code{nil} if your select routine is buggy.
12652
12653 @item nntp-nov-is-evil
12654 @vindex nntp-nov-is-evil
12655 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
12656 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
12657 can be used.
12658
12659 @item nntp-xover-commands
12660 @vindex nntp-xover-commands
12661 @cindex @acronym{NOV}
12662 @cindex XOVER
12663 List of strings used as commands to fetch @acronym{NOV} lines from a
12664 server.  The default value of this variable is @code{("XOVER"
12665 "XOVERVIEW")}.
12666
12667 @item nntp-nov-gap
12668 @vindex nntp-nov-gap
12669 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
12670 the server.  The server responds with one huge list of lines.  However,
12671 if you have read articles 2-5000 in the group, and only want to read
12672 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
12673 lines that you will not need.  This variable says how
12674 big a gap between two consecutive articles is allowed to be before the
12675 @code{XOVER} request is split into several request.  Note that if your
12676 network is fast, setting this variable to a really small number means
12677 that fetching will probably be slower.  If this variable is @code{nil},
12678 @code{nntp} will never split requests.  The default is 5.
12679
12680 @item nntp-prepare-server-hook
12681 @vindex nntp-prepare-server-hook
12682 A hook run before attempting to connect to an @acronym{NNTP} server.
12683
12684 @item nntp-warn-about-losing-connection
12685 @vindex nntp-warn-about-losing-connection
12686 If this variable is non-@code{nil}, some noise will be made when a
12687 server closes connection.
12688
12689 @item nntp-record-commands
12690 @vindex nntp-record-commands
12691 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12692 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
12693 buffer.  This is useful if you are debugging a Gnus/@acronym{NNTP} connection
12694 that doesn't seem to work.
12695
12696 @item nntp-open-connection-function
12697 @vindex nntp-open-connection-function
12698 It is possible to customize how the connection to the nntp server will
12699 be opened.  If you specify an @code{nntp-open-connection-function}
12700 parameter, Gnus will use that function to establish the connection.
12701 Five pre-made functions are supplied.  These functions can be grouped in
12702 two categories: direct connection functions (three pre-made), and
12703 indirect ones (two pre-made).
12704
12705 @item nntp-prepare-post-hook
12706 @vindex nntp-prepare-post-hook
12707 A hook run just before posting an article.  If there is no
12708 @code{Message-ID} header in the article and the news server provides the
12709 recommended ID, it will be added to the article before running this
12710 hook.  It is useful to make @code{Cancel-Lock} headers even if you
12711 inhibit Gnus to add a @code{Message-ID} header, you could say:
12712
12713 @lisp
12714 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12715 @end lisp
12716
12717 Note that not all servers support the recommended ID.  This works for
12718 INN versions 2.3.0 and later, for instance.
12719
12720 @item nntp-read-timeout
12721 @vindex nntp-read-timeout
12722 How long nntp should wait between checking for the end of output.
12723 Shorter values mean quicker response, but is more CPU intensive.  The
12724 default is 0.1 seconds.  If you have a slow line to the server (and
12725 don't like to see Emacs eat your available CPU power), you might set
12726 this to, say, 1.
12727
12728 @end table
12729
12730 @menu
12731 * Direct Functions::            Connecting directly to the server.
12732 * Indirect Functions::          Connecting indirectly to the server.
12733 * Common Variables::            Understood by several connection functions.
12734 @end menu
12735
12736
12737 @node Direct Functions
12738 @subsubsection Direct Functions
12739 @cindex direct connection functions
12740
12741 These functions are called direct because they open a direct connection
12742 between your machine and the @acronym{NNTP} server.  The behavior of these
12743 functions is also affected by commonly understood variables
12744 (@pxref{Common Variables}).
12745
12746 @table @code
12747 @findex nntp-open-network-stream
12748 @item nntp-open-network-stream
12749 This is the default, and simply connects to some port or other on the
12750 remote system.
12751
12752 @findex nntp-open-tls-stream
12753 @item nntp-open-tls-stream
12754 Opens a connection to a server over a @dfn{secure} channel.  To use
12755 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
12756 installed.  You then define a server as follows:
12757
12758 @lisp
12759 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
12760 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
12761 ;;
12762 (nntp "snews.bar.com"
12763       (nntp-open-connection-function nntp-open-tls-stream)
12764       (nntp-port-number )
12765       (nntp-address "snews.bar.com"))
12766 @end lisp
12767
12768 @findex nntp-open-ssl-stream
12769 @item nntp-open-ssl-stream
12770 Opens a connection to a server over a @dfn{secure} channel.  To use
12771 this you must have @uref{http://www.openssl.org, OpenSSL} or
12772 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed.  You
12773 then define a server as follows:
12774
12775 @lisp
12776 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
12777 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
12778 ;;
12779 (nntp "snews.bar.com"
12780       (nntp-open-connection-function nntp-open-ssl-stream)
12781       (nntp-port-number 563)
12782       (nntp-address "snews.bar.com"))
12783 @end lisp
12784
12785 @findex nntp-open-telnet-stream
12786 @item nntp-open-telnet-stream
12787 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
12788 it.  You might wonder why this function exists, since we have the
12789 default @code{nntp-open-network-stream} which would do the job.  (One
12790 of) the reason(s) is that if you are behind a firewall but have direct
12791 connections to the outside world thanks to a command wrapper like
12792 @code{runsocks}, you can use it like this:
12793
12794 @lisp
12795 (nntp "socksified"
12796       (nntp-pre-command "runsocks")
12797       (nntp-open-connection-function nntp-open-telnet-stream)
12798       (nntp-address "the.news.server"))
12799 @end lisp
12800
12801 With the default method, you would need to wrap your whole Emacs
12802 session, which is not a good idea.
12803 @end table
12804
12805
12806 @node Indirect Functions
12807 @subsubsection Indirect Functions
12808 @cindex indirect connection functions
12809
12810 These functions are called indirect because they connect to an
12811 intermediate host before actually connecting to the @acronym{NNTP} server.
12812 All of these functions and related variables are also said to belong to
12813 the ``via'' family of connection: they're all prefixed with ``via'' to make
12814 things cleaner.  The behavior of these functions is also affected by
12815 commonly understood variables (@pxref{Common Variables}).
12816
12817 @table @code
12818 @item nntp-open-via-rlogin-and-telnet
12819 @findex nntp-open-via-rlogin-and-telnet
12820 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12821 to the real @acronym{NNTP} server from there.  This is useful for instance if
12822 you need to connect to a firewall machine first.
12823
12824 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12825
12826 @table @code
12827 @item nntp-via-rlogin-command
12828 @vindex nntp-via-rlogin-command
12829 Command used to log in on the intermediate host.  The default is
12830 @samp{rsh}, but @samp{ssh} is a popular alternative.
12831
12832 @item nntp-via-rlogin-command-switches
12833 @vindex nntp-via-rlogin-command-switches
12834 List of strings to be used as the switches to
12835 @code{nntp-via-rlogin-command}.  The default is @code{nil}.  If you use
12836 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
12837 @samp{("-C")} in order to compress all data connections, otherwise set
12838 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
12839 the telnet command requires a pseudo-tty allocation on an intermediate
12840 host.
12841 @end table
12842
12843 @item nntp-open-via-telnet-and-telnet
12844 @findex nntp-open-via-telnet-and-telnet
12845 Does essentially the same, but uses @samp{telnet} instead of
12846 @samp{rlogin} to connect to the intermediate host.
12847
12848 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12849
12850 @table @code
12851 @item nntp-via-telnet-command
12852 @vindex nntp-via-telnet-command
12853 Command used to @code{telnet} the intermediate host.  The default is
12854 @samp{telnet}.
12855
12856 @item nntp-via-telnet-switches
12857 @vindex nntp-via-telnet-switches
12858 List of strings to be used as the switches to the
12859 @code{nntp-via-telnet-command} command.  The default is @samp{("-8")}.
12860
12861 @item nntp-via-user-password
12862 @vindex nntp-via-user-password
12863 Password to use when logging in on the intermediate host.
12864
12865 @item nntp-via-envuser
12866 @vindex nntp-via-envuser
12867 If non-@code{nil}, the intermediate @code{telnet} session (client and
12868 server both) will support the @code{ENVIRON} option and not prompt for
12869 login name.  This works for Solaris @code{telnet}, for instance.
12870
12871 @item nntp-via-shell-prompt
12872 @vindex nntp-via-shell-prompt
12873 Regexp matching the shell prompt on the intermediate host.  The default
12874 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12875
12876 @end table
12877
12878 @end table
12879
12880
12881 Here are some additional variables that are understood by all the above
12882 functions:
12883
12884 @table @code
12885
12886 @item nntp-via-user-name
12887 @vindex nntp-via-user-name
12888 User name to use when connecting to the intermediate host.
12889
12890 @item nntp-via-address
12891 @vindex nntp-via-address
12892 Address of the intermediate host to connect to.
12893
12894 @end table
12895
12896
12897 @node Common Variables
12898 @subsubsection Common Variables
12899
12900 The following variables affect the behavior of all, or several of the
12901 pre-made connection functions.  When not specified, all functions are
12902 affected.
12903
12904 @table @code
12905
12906 @item nntp-pre-command
12907 @vindex nntp-pre-command
12908 A command wrapper to use when connecting through a non native
12909 connection function (all except @code{nntp-open-network-stream},
12910 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}.  This is
12911 where you would put a @samp{SOCKS} wrapper for instance.
12912
12913 @item nntp-address
12914 @vindex nntp-address
12915 The address of the @acronym{NNTP} server.
12916
12917 @item nntp-port-number
12918 @vindex nntp-port-number
12919 Port number to connect to the @acronym{NNTP} server.  The default is
12920 @samp{nntp}.  If you use @acronym{NNTP} over
12921 @acronym{tls}/@acronym{ssl}, you may want to use integer ports rather
12922 than named ports (i.e, use @samp{563} instead of @samp{snews} or
12923 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
12924 not work with named ports.
12925
12926 @item nntp-end-of-line
12927 @vindex nntp-end-of-line
12928 String to use as end-of-line marker when talking to the @acronym{NNTP}
12929 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
12930 using a non native connection function.
12931
12932 @item nntp-telnet-command
12933 @vindex nntp-telnet-command
12934 Command to use when connecting to the @acronym{NNTP} server through
12935 @samp{telnet}.  This is @emph{not} for an intermediate host.  This is
12936 just for the real @acronym{NNTP} server.  The default is
12937 @samp{telnet}.
12938
12939 @item nntp-telnet-switches
12940 @vindex nntp-telnet-switches
12941 A list of switches to pass to @code{nntp-telnet-command}.  The default
12942 is @samp{("-8")}.
12943
12944 @end table
12945
12946
12947 @node News Spool
12948 @subsection News Spool
12949 @cindex nnspool
12950 @cindex news spool
12951
12952 Subscribing to a foreign group from the local spool is extremely easy,
12953 and might be useful, for instance, to speed up reading groups that
12954 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
12955 instance.
12956
12957 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
12958 anything else) as the address.
12959
12960 If you have access to a local spool, you should probably use that as the
12961 native select method (@pxref{Finding the News}).  It is normally faster
12962 than using an @code{nntp} select method, but might not be.  It depends.
12963 You just have to try to find out what's best at your site.
12964
12965 @table @code
12966
12967 @item nnspool-inews-program
12968 @vindex nnspool-inews-program
12969 Program used to post an article.
12970
12971 @item nnspool-inews-switches
12972 @vindex nnspool-inews-switches
12973 Parameters given to the inews program when posting an article.
12974
12975 @item nnspool-spool-directory
12976 @vindex nnspool-spool-directory
12977 Where @code{nnspool} looks for the articles.  This is normally
12978 @file{/usr/spool/news/}.
12979
12980 @item nnspool-nov-directory
12981 @vindex nnspool-nov-directory
12982 Where @code{nnspool} will look for @acronym{NOV} files.  This is normally@*
12983 @file{/usr/spool/news/over.view/}.
12984
12985 @item nnspool-lib-dir
12986 @vindex nnspool-lib-dir
12987 Where the news lib dir is (@file{/usr/lib/news/} by default).
12988
12989 @item nnspool-active-file
12990 @vindex nnspool-active-file
12991 The name of the active file.
12992
12993 @item nnspool-newsgroups-file
12994 @vindex nnspool-newsgroups-file
12995 The name of the group descriptions file.
12996
12997 @item nnspool-history-file
12998 @vindex nnspool-history-file
12999 The name of the news history file.
13000
13001 @item nnspool-active-times-file
13002 @vindex nnspool-active-times-file
13003 The name of the active date file.
13004
13005 @item nnspool-nov-is-evil
13006 @vindex nnspool-nov-is-evil
13007 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13008 that it finds.
13009
13010 @item nnspool-sift-nov-with-sed
13011 @vindex nnspool-sift-nov-with-sed
13012 @cindex sed
13013 If non-@code{nil}, which is the default, use @code{sed} to get the
13014 relevant portion from the overview file.  If @code{nil},
13015 @code{nnspool} will load the entire file into a buffer and process it
13016 there.
13017
13018 @end table
13019
13020
13021 @node Getting Mail
13022 @section Getting Mail
13023 @cindex reading mail
13024 @cindex mail
13025
13026 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13027 course.
13028
13029 @menu
13030 * Mail in a Newsreader::        Important introductory notes.
13031 * Getting Started Reading Mail::  A simple cookbook example.
13032 * Splitting Mail::              How to create mail groups.
13033 * Mail Sources::                How to tell Gnus where to get mail from.
13034 * Mail Back End Variables::     Variables for customizing mail handling.
13035 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
13036 * Group Mail Splitting::        Use group customize to drive mail splitting.
13037 * Incorporating Old Mail::      What about the old mail you have?
13038 * Expiring Mail::               Getting rid of unwanted mail.
13039 * Washing Mail::                Removing cruft from the mail you get.
13040 * Duplicates::                  Dealing with duplicated mail.
13041 * Not Reading Mail::            Using mail back ends for reading other files.
13042 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
13043 @end menu
13044
13045
13046 @node Mail in a Newsreader
13047 @subsection Mail in a Newsreader
13048
13049 If you are used to traditional mail readers, but have decided to switch
13050 to reading mail with Gnus, you may find yourself experiencing something
13051 of a culture shock.
13052
13053 Gnus does not behave like traditional mail readers.  If you want to make
13054 it behave that way, you can, but it's an uphill battle.
13055
13056 Gnus, by default, handles all its groups using the same approach.  This
13057 approach is very newsreaderly---you enter a group, see the new/unread
13058 messages, and when you read the messages, they get marked as read, and
13059 you don't see them any more.  (Unless you explicitly ask for them.)
13060
13061 In particular, you do not do anything explicitly to delete messages.
13062
13063 Does this mean that all the messages that have been marked as read are
13064 deleted?  How awful!
13065
13066 But, no, it means that old messages are @dfn{expired} according to some
13067 scheme or other.  For news messages, the expire process is controlled by
13068 the news administrator; for mail, the expire process is controlled by
13069 you.  The expire process for mail is covered in depth in @ref{Expiring
13070 Mail}.
13071
13072 What many Gnus users find, after using it a while for both news and
13073 mail, is that the transport mechanism has very little to do with how
13074 they want to treat a message.
13075
13076 Many people subscribe to several mailing lists.  These are transported
13077 via @acronym{SMTP}, and are therefore mail.  But we might go for weeks without
13078 answering, or even reading these messages very carefully.  We may not
13079 need to save them because if we should need to read one again, they are
13080 archived somewhere else.
13081
13082 Some people have local news groups which have only a handful of readers.
13083 These are transported via @acronym{NNTP}, and are therefore news.  But we may need
13084 to read and answer a large fraction of the messages very carefully in
13085 order to do our work.  And there may not be an archive, so we may need
13086 to save the interesting messages the same way we would personal mail.
13087
13088 The important distinction turns out to be not the transport mechanism,
13089 but other factors such as how interested we are in the subject matter,
13090 or how easy it is to retrieve the message if we need to read it again.
13091
13092 Gnus provides many options for sorting mail into ``groups'' which behave
13093 like newsgroups, and for treating each group (whether mail or news)
13094 differently.
13095
13096 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13097 that Gnus should grow up and be a male, er, mail reader.  It is possible
13098 to whip Gnus into a more mailreaderly being, but, as said before, it's
13099 not easy.  People who prefer proper mail readers should try @sc{vm}
13100 instead, which is an excellent, and proper, mail reader.
13101
13102 I don't mean to scare anybody off, but I want to make it clear that you
13103 may be required to learn a new way of thinking about messages.  After
13104 you've been subjected to The Gnus Way, you will come to love it.  I can
13105 guarantee it.  (At least the guy who sold me the Emacs Subliminal
13106 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
13107 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
13108 You Do.)
13109
13110
13111 @node Getting Started Reading Mail
13112 @subsection Getting Started Reading Mail
13113
13114 It's quite easy to use Gnus to read your new mail.  You just plonk the
13115 mail back end of your choice into @code{gnus-secondary-select-methods},
13116 and things will happen automatically.
13117
13118 For instance, if you want to use @code{nnml} (which is a ``one file per
13119 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13120
13121 @lisp
13122 (setq gnus-secondary-select-methods '((nnml "")))
13123 @end lisp
13124
13125 Now, the next time you start Gnus, this back end will be queried for new
13126 articles, and it will move all the messages in your spool file to its
13127 directory, which is @file{~/Mail/} by default.  The new group that will
13128 be created (@samp{mail.misc}) will be subscribed, and you can read it
13129 like any other group.
13130
13131 You will probably want to split the mail into several groups, though:
13132
13133 @lisp
13134 (setq nnmail-split-methods
13135       '(("junk" "^From:.*Lars Ingebrigtsen")
13136         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
13137         ("other" "")))
13138 @end lisp
13139
13140 This will result in three new @code{nnml} mail groups being created:
13141 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
13142 mail that doesn't fit into the first two groups will be placed in the
13143 last group.
13144
13145 This should be sufficient for reading mail with Gnus.  You might want to
13146 give the other sections in this part of the manual a perusal, though.
13147 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
13148
13149
13150 @node Splitting Mail
13151 @subsection Splitting Mail
13152 @cindex splitting mail
13153 @cindex mail splitting
13154 @cindex mail filtering (splitting)
13155
13156 @vindex nnmail-split-methods
13157 The @code{nnmail-split-methods} variable says how the incoming mail is
13158 to be split into groups.
13159
13160 @lisp
13161 (setq nnmail-split-methods
13162   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
13163     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
13164     ("mail.other" "")))
13165 @end lisp
13166
13167 This variable is a list of lists, where the first element of each of
13168 these lists is the name of the mail group (they do not have to be called
13169 something beginning with @samp{mail}, by the way), and the second
13170 element is a regular expression used on the header of each mail to
13171 determine if it belongs in this mail group.  The first string may
13172 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
13173 insert sub-expressions from the matched text.  For instance:
13174
13175 @lisp
13176 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
13177 @end lisp
13178
13179 The second element can also be a function.  In that case, it will be
13180 called narrowed to the headers with the first element of the rule as the
13181 argument.  It should return a non-@code{nil} value if it thinks that the
13182 mail belongs in that group.
13183
13184 The last of these groups should always be a general one, and the regular
13185 expression should @emph{always} be @samp{*} so that it matches any mails
13186 that haven't been matched by any of the other regexps.  (These rules are
13187 processed from the beginning of the alist toward the end.  The first
13188 rule to make a match will ``win'', unless you have crossposting enabled.
13189 In that case, all matching rules will ``win''.)
13190
13191 If you like to tinker with this yourself, you can set this variable to a
13192 function of your choice.  This function will be called without any
13193 arguments in a buffer narrowed to the headers of an incoming mail
13194 message.  The function should return a list of group names that it
13195 thinks should carry this mail message.
13196
13197 Note that the mail back ends are free to maul the poor, innocent,
13198 incoming headers all they want to.  They all add @code{Lines} headers;
13199 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
13200 @code{From<SPACE>} line to something else.
13201
13202 @vindex nnmail-crosspost
13203 The mail back ends all support cross-posting.  If several regexps match,
13204 the mail will be ``cross-posted'' to all those groups.
13205 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
13206 that no articles are crossposted to the general (@samp{*}) group.
13207
13208 @vindex nnmail-crosspost-link-function
13209 @cindex crosspost
13210 @cindex links
13211 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
13212 the crossposted articles.  However, not all file systems support hard
13213 links.  If that's the case for you, set
13214 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
13215 variable is @code{add-name-to-file} by default.)
13216
13217 @kindex M-x nnmail-split-history
13218 @findex nnmail-split-history
13219 If you wish to see where the previous mail split put the messages, you
13220 can use the @kbd{M-x nnmail-split-history} command.  If you wish to see
13221 where re-spooling messages would put the messages, you can use
13222 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
13223 Group Commands}).
13224
13225 @vindex nnmail-split-header-length-limit
13226 Header lines longer than the value of
13227 @code{nnmail-split-header-length-limit} are excluded from the split
13228 function.
13229
13230 @vindex nnmail-mail-splitting-charset
13231 @vindex nnmail-mail-splitting-decodes
13232 By default the splitting codes @acronym{MIME} decodes headers so you
13233 can match on non-@acronym{ASCII} strings.  The
13234 @code{nnmail-mail-splitting-charset} variable specifies the default
13235 charset for decoding.  The behaviour can be turned off completely by
13236 binding @code{nnmail-mail-splitting-decodes} to @code{nil}, which is
13237 useful if you want to match articles based on the raw header data.
13238
13239 @vindex nnmail-resplit-incoming
13240 By default, splitting is performed on all incoming messages.  If you
13241 specify a @code{directory} entry for the variable @code{mail-sources}
13242 (@pxref{Mail Source Specifiers}), however, then splitting does
13243 @emph{not} happen by default.  You can set the variable
13244 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
13245 splitting happen even in this case.  (This variable has no effect on
13246 other kinds of entries.)
13247
13248 Gnus gives you all the opportunity you could possibly want for shooting
13249 yourself in the foot.  Let's say you create a group that will contain
13250 all the mail you get from your boss.  And then you accidentally
13251 unsubscribe from the group.  Gnus will still put all the mail from your
13252 boss in the unsubscribed group, and so, when your boss mails you ``Have
13253 that report ready by Monday or you're fired!'', you'll never see it and,
13254 come Tuesday, you'll still believe that you're gainfully employed while
13255 you really should be out collecting empty bottles to save up for next
13256 month's rent money.
13257
13258
13259 @node Mail Sources
13260 @subsection Mail Sources
13261
13262 Mail can be gotten from many different sources---the mail spool, from
13263 a @acronym{POP} mail server, from a procmail directory, or from a
13264 maildir, for instance.
13265
13266 @menu
13267 * Mail Source Specifiers::      How to specify what a mail source is.
13268 * Mail Source Customization::   Some variables that influence things.
13269 * Fetching Mail::               Using the mail source specifiers.
13270 @end menu
13271
13272
13273 @node Mail Source Specifiers
13274 @subsubsection Mail Source Specifiers
13275 @cindex POP
13276 @cindex mail server
13277 @cindex procmail
13278 @cindex mail spool
13279 @cindex mail source
13280
13281 You tell Gnus how to fetch mail by setting @code{mail-sources}
13282 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
13283
13284 Here's an example:
13285
13286 @lisp
13287 (pop :server "pop3.mailserver.com" :user "myname")
13288 @end lisp
13289
13290 As can be observed, a mail source specifier is a list where the first
13291 element is a @dfn{mail source type}, followed by an arbitrary number of
13292 @dfn{keywords}.  Keywords that are not explicitly specified are given
13293 default values.
13294
13295 The following mail source types are available:
13296
13297 @table @code
13298 @item file
13299 Get mail from a single file; typically from the mail spool.
13300
13301 Keywords:
13302
13303 @table @code
13304 @item :path
13305 The file name.  Defaults to the value of the @env{MAIL}
13306 environment variable or the value of @code{rmail-spool-directory}
13307 (usually something like @file{/usr/mail/spool/user-name}).
13308
13309 @item :prescript
13310 @itemx :postscript
13311 Script run before/after fetching mail.
13312 @end table
13313
13314 An example file mail source:
13315
13316 @lisp
13317 (file :path "/usr/spool/mail/user-name")
13318 @end lisp
13319
13320 Or using the default file name:
13321
13322 @lisp
13323 (file)
13324 @end lisp
13325
13326 If the mail spool file is not located on the local machine, it's best
13327 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
13328 You can not use ange-ftp file names here---it has no way to lock the
13329 mail spool while moving the mail.
13330
13331 If it's impossible to set up a proper server, you can use ssh instead.
13332
13333 @lisp
13334 (setq mail-sources
13335       '((file :prescript "ssh host bin/getmail >%t")))
13336 @end lisp
13337
13338 The @samp{getmail} script would look something like the following:
13339
13340 @example
13341 #!/bin/sh
13342 #  getmail - move mail from spool to stdout
13343 #  flu@@iki.fi
13344
13345 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
13346 TMP=$HOME/Mail/tmp
13347 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
13348 @end example
13349
13350 Alter this script to fit find the @samp{movemail} you want to use.
13351
13352
13353 @item directory
13354 @vindex nnmail-scan-directory-mail-source-once
13355 Get mail from several files in a directory.  This is typically used
13356 when you have procmail split the incoming mail into several files.
13357 That is, there is a one-to-one correspondence between files in that
13358 directory and groups, so that mail from the file @file{foo.bar.spool}
13359 will be put in the group @code{foo.bar}.  (You can change the suffix
13360 to be used instead of @code{.spool}.)  Setting
13361 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
13362 Gnus to scan the mail source only once.  This is particularly useful
13363 if you want to scan mail groups at a specified level.
13364
13365 @vindex nnmail-resplit-incoming
13366 There is also the variable @code{nnmail-resplit-incoming}, if you set
13367 that to a non-@code{nil} value, then the normal splitting process is
13368 applied to all the files from the directory, @ref{Splitting Mail}.
13369
13370 Keywords:
13371
13372 @table @code
13373 @item :path
13374 The name of the directory where the files are.  There is no default
13375 value.
13376
13377 @item :suffix
13378 Only files ending with this suffix are used.  The default is
13379 @samp{.spool}.
13380
13381 @item :predicate
13382 Only files that have this predicate return non-@code{nil} are returned.
13383 The default is @code{identity}.  This is used as an additional
13384 filter---only files that have the right suffix @emph{and} satisfy this
13385 predicate are considered.
13386
13387 @item :prescript
13388 @itemx :postscript
13389 Script run before/after fetching mail.
13390
13391 @end table
13392
13393 An example directory mail source:
13394
13395 @lisp
13396 (directory :path "/home/user-name/procmail-dir/"
13397            :suffix ".prcml")
13398 @end lisp
13399
13400 @item pop
13401 Get mail from a @acronym{POP} server.
13402
13403 Keywords:
13404
13405 @table @code
13406 @item :server
13407 The name of the @acronym{POP} server.  The default is taken from the
13408 @env{MAILHOST} environment variable.
13409
13410 @item :port
13411 The port number of the @acronym{POP} server.  This can be a number (eg,
13412 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}).  If it is a
13413 string, it should be a service name as listed in @file{/etc/services} on
13414 Unix systems.  The default is @samp{"pop3"}.  On some systems you might
13415 need to specify it as @samp{"pop-3"} instead.
13416
13417 @item :user
13418 The user name to give to the @acronym{POP} server.  The default is the login
13419 name.
13420
13421 @item :password
13422 The password to give to the @acronym{POP} server.  If not specified,
13423 the user is prompted.
13424
13425 @item :program
13426 The program to use to fetch mail from the @acronym{POP} server.  This
13427 should be a @code{format}-like string.  Here's an example:
13428
13429 @example
13430 fetchmail %u@@%s -P %p %t
13431 @end example
13432
13433 The valid format specifier characters are:
13434
13435 @table @samp
13436 @item t
13437 The name of the file the mail is to be moved to.  This must always be
13438 included in this string.
13439
13440 @item s
13441 The name of the server.
13442
13443 @item P
13444 The port number of the server.
13445
13446 @item u
13447 The user name to use.
13448
13449 @item p
13450 The password to use.
13451 @end table
13452
13453 The values used for these specs are taken from the values you give the
13454 corresponding keywords.
13455
13456 @item :prescript
13457 A script to be run before fetching the mail.  The syntax is the same as
13458 the @code{:program} keyword.  This can also be a function to be run.
13459
13460 @item :postscript
13461 A script to be run after fetching the mail.  The syntax is the same as
13462 the @code{:program} keyword.  This can also be a function to be run.
13463
13464 @item :function
13465 The function to use to fetch mail from the @acronym{POP} server.  The
13466 function is called with one parameter---the name of the file where the
13467 mail should be moved to.
13468
13469 @item :authentication
13470 This can be either the symbol @code{password} or the symbol @code{apop}
13471 and says what authentication scheme to use.  The default is
13472 @code{password}.
13473
13474 @end table
13475
13476 If the @code{:program} and @code{:function} keywords aren't specified,
13477 @code{pop3-movemail} will be used.
13478
13479 Here are some examples.  Fetch from the default @acronym{POP} server,
13480 using the default user name, and default fetcher:
13481
13482 @lisp
13483 (pop)
13484 @end lisp
13485
13486 Fetch from a named server with a named user and password:
13487
13488 @lisp
13489 (pop :server "my.pop.server"
13490      :user "user-name" :password "secret")
13491 @end lisp
13492
13493 Use @samp{movemail} to move the mail:
13494
13495 @lisp
13496 (pop :program "movemail po:%u %t %p")
13497 @end lisp
13498
13499 @item maildir
13500 Get mail from a maildir.  This is a type of mailbox that is supported by
13501 at least qmail and postfix, where each file in a special directory
13502 contains exactly one mail.
13503
13504 Keywords:
13505
13506 @table @code
13507 @item :path
13508 The name of the directory where the mails are stored.  The default is
13509 taken from the @env{MAILDIR} environment variable or
13510 @file{~/Maildir/}.
13511 @item :subdirs
13512 The subdirectories of the Maildir.  The default is
13513 @samp{("new" "cur")}.
13514
13515 @c If you sometimes look at your mail through a pop3 daemon before fetching
13516 @c them with Gnus, you may also have to fetch your mails from the
13517 @c @code{cur} directory inside the maildir, like in the first example
13518 @c below.
13519
13520 You can also get mails from remote hosts (because maildirs don't suffer
13521 from locking problems).
13522
13523 @end table
13524
13525 Two example maildir mail sources:
13526
13527 @lisp
13528 (maildir :path "/home/user-name/Maildir/"
13529          :subdirs ("cur" "new"))
13530 @end lisp
13531
13532 @lisp
13533 (maildir :path "/user@@remotehost.org:~/Maildir/"
13534          :subdirs ("new"))
13535 @end lisp
13536
13537 @item imap
13538 Get mail from a @acronym{IMAP} server.  If you don't want to use
13539 @acronym{IMAP} as intended, as a network mail reading protocol (ie
13540 with nnimap), for some reason or other, Gnus let you treat it similar
13541 to a @acronym{POP} server and fetches articles from a given
13542 @acronym{IMAP} mailbox.  @xref{IMAP}, for more information.
13543
13544 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
13545 may need external programs and libraries, @xref{IMAP}.
13546
13547 Keywords:
13548
13549 @table @code
13550 @item :server
13551 The name of the @acronym{IMAP} server.  The default is taken from the
13552 @env{MAILHOST} environment variable.
13553
13554 @item :port
13555 The port number of the @acronym{IMAP} server.  The default is @samp{143}, or
13556 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
13557
13558 @item :user
13559 The user name to give to the @acronym{IMAP} server.  The default is the login
13560 name.
13561
13562 @item :password
13563 The password to give to the @acronym{IMAP} server.  If not specified, the user is
13564 prompted.
13565
13566 @item :stream
13567 What stream to use for connecting to the server, this is one of the
13568 symbols in @code{imap-stream-alist}.  Right now, this means
13569 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
13570 @samp{ssl}, @samp{shell} or the default @samp{network}.
13571
13572 @item :authentication
13573 Which authenticator to use for authenticating to the server, this is
13574 one of the symbols in @code{imap-authenticator-alist}.  Right now,
13575 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13576 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13577
13578 @item :program
13579 When using the `shell' :stream, the contents of this variable is
13580 mapped into the @code{imap-shell-program} variable.  This should be a
13581 @code{format}-like string (or list of strings).  Here's an example:
13582
13583 @example
13584 ssh %s imapd
13585 @end example
13586
13587 The valid format specifier characters are:
13588
13589 @table @samp
13590 @item s
13591 The name of the server.
13592
13593 @item l
13594 User name from @code{imap-default-user}.
13595
13596 @item p
13597 The port number of the server.
13598 @end table
13599
13600 The values used for these specs are taken from the values you give the
13601 corresponding keywords.
13602
13603 @item :mailbox
13604 The name of the mailbox to get mail from.  The default is @samp{INBOX}
13605 which normally is the mailbox which receive incoming mail.
13606
13607 @item :predicate
13608 The predicate used to find articles to fetch.  The default, @samp{UNSEEN
13609 UNDELETED}, is probably the best choice for most people, but if you
13610 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
13611 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13612 Then all articles in the mailbox is fetched, no matter what.  For a
13613 complete list of predicates, see RFC 2060 section 6.4.4.
13614
13615 @item :fetchflag
13616 How to flag fetched articles on the server, the default @samp{\Deleted}
13617 will mark them as deleted, an alternative would be @samp{\Seen} which
13618 would simply mark them as read.  These are the two most likely choices,
13619 but more flags are defined in RFC 2060 section 2.3.2.
13620
13621 @item :dontexpunge
13622 If non-@code{nil}, don't remove all articles marked as deleted in the
13623 mailbox after finishing the fetch.
13624
13625 @end table
13626
13627 An example @acronym{IMAP} mail source:
13628
13629 @lisp
13630 (imap :server "mail.mycorp.com"
13631       :stream kerberos4
13632       :fetchflag "\\Seen")
13633 @end lisp
13634
13635 @item webmail
13636 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
13637 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
13638 @uref{http://mail.yahoo.com/}.
13639
13640 NOTE: Webmail largely depends on cookies.  A "one-line-cookie" patch is
13641 required for url "4.0pre.46".
13642
13643 WARNING: Mails may be lost.  NO WARRANTY.
13644
13645 Keywords:
13646
13647 @table @code
13648 @item :subtype
13649 The type of the webmail server.  The default is @code{hotmail}.  The
13650 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13651
13652 @item :user
13653 The user name to give to the webmail server.  The default is the login
13654 name.
13655
13656 @item :password
13657 The password to give to the webmail server.  If not specified, the user is
13658 prompted.
13659
13660 @item :dontexpunge
13661 If non-@code{nil}, only fetch unread articles and don't move them to
13662 trash folder after finishing the fetch.
13663
13664 @end table
13665
13666 An example webmail source:
13667
13668 @lisp
13669 (webmail :subtype 'hotmail
13670          :user "user-name"
13671          :password "secret")
13672 @end lisp
13673 @end table
13674
13675 @table @dfn
13676 @item Common Keywords
13677 Common keywords can be used in any type of mail source.
13678
13679 Keywords:
13680
13681 @table @code
13682 @item :plugged
13683 If non-@code{nil}, fetch the mail even when Gnus is unplugged.  If you
13684 use directory source to get mail, you can specify it as in this
13685 example:
13686
13687 @lisp
13688 (setq mail-sources
13689       '((directory :path "/home/pavel/.Spool/"
13690                    :suffix ""
13691                    :plugged t)))
13692 @end lisp
13693
13694 Gnus will then fetch your mail even when you are unplugged.  This is
13695 useful when you use local mail and news.
13696
13697 @end table
13698 @end table
13699
13700 @subsubsection Function Interface
13701
13702 Some of the above keywords specify a Lisp function to be executed.
13703 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13704 the value of the keyword while the function is executing.  For example,
13705 consider the following mail-source setting:
13706
13707 @lisp
13708 (setq mail-sources '((pop :user "jrl"
13709                           :server "pophost" :function fetchfunc)))
13710 @end lisp
13711
13712 While the function @code{fetchfunc} is executing, the symbol @code{user}
13713 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13714 @code{"pophost"}.  The symbols @code{port}, @code{password},
13715 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13716 and @code{authentication} are also bound (to their default values).
13717
13718 See above for a list of keywords for each type of mail source.
13719
13720
13721 @node Mail Source Customization
13722 @subsubsection Mail Source Customization
13723
13724 The following is a list of variables that influence how the mail is
13725 fetched.  You would normally not need to set or change any of these
13726 variables.
13727
13728 @table @code
13729 @item mail-source-crash-box
13730 @vindex mail-source-crash-box
13731 File where mail will be stored while processing it.  The default is@*
13732 @file{~/.emacs-mail-crash-box}.
13733
13734 @item mail-source-delete-incoming
13735 @vindex mail-source-delete-incoming
13736 If non-@code{nil}, delete incoming files after handling them.  If
13737 @code{t}, delete the files immediately, if @code{nil}, never delete any
13738 files.  If a positive number, delete files older than number of days
13739 (This will only happen, when receiving new mail).  You may also set
13740 @code{mail-source-delete-incoming} to @code{nil} and call
13741 @code{mail-source-delete-old-incoming} from a hook or interactively.
13742
13743 @item mail-source-delete-old-incoming-confirm
13744 @vindex mail-source-delete-old-incoming-confirm
13745 If non-@code{nil}, ask for for confirmation before deleting old incoming
13746 files.  This variable only applies when
13747 @code{mail-source-delete-incoming} is a positive number.
13748
13749 @item mail-source-ignore-errors
13750 @vindex mail-source-ignore-errors
13751 If non-@code{nil}, ignore errors when reading mail from a mail source.
13752
13753 @item mail-source-directory
13754 @vindex mail-source-directory
13755 Directory where files (if any) will be stored.  The default is
13756 @file{~/Mail/}.  At present, the only thing this is used for is to say
13757 where the incoming files will be stored if the previous variable is
13758 @code{nil}.
13759
13760 @item mail-source-incoming-file-prefix
13761 @vindex mail-source-incoming-file-prefix
13762 Prefix for file name for storing incoming mail.  The default is
13763 @file{Incoming}, in which case files will end up with names like
13764 @file{Incoming30630D_} or @file{Incoming298602ZD}.  This is really only
13765 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13766
13767 @item mail-source-default-file-modes
13768 @vindex mail-source-default-file-modes
13769 All new mail files will get this file mode.  The default is 384.
13770
13771 @item mail-source-movemail-program
13772 @vindex mail-source-movemail-program
13773 If non-@code{nil}, name of program for fetching new mail.  If
13774 @code{nil}, @code{movemail} in @var{exec-directory}.
13775
13776 @end table
13777
13778
13779 @node Fetching Mail
13780 @subsubsection Fetching Mail
13781
13782 @vindex mail-sources
13783 @vindex nnmail-spool-file
13784 The way to actually tell Gnus where to get new mail from is to set
13785 @code{mail-sources} to a list of mail source specifiers
13786 (@pxref{Mail Source Specifiers}).
13787
13788 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13789 @code{nil}, the mail back ends will never attempt to fetch mail by
13790 themselves.
13791
13792 If you want to fetch mail both from your local spool as well as a
13793 @acronym{POP} mail server, you'd say something like:
13794
13795 @lisp
13796 (setq mail-sources
13797       '((file)
13798         (pop :server "pop3.mail.server"
13799              :password "secret")))
13800 @end lisp
13801
13802 Or, if you don't want to use any of the keyword defaults:
13803
13804 @lisp
13805 (setq mail-sources
13806       '((file :path "/var/spool/mail/user-name")
13807         (pop :server "pop3.mail.server"
13808              :user "user-name"
13809              :port "pop3"
13810              :password "secret")))
13811 @end lisp
13812
13813
13814 When you use a mail back end, Gnus will slurp all your mail from your
13815 inbox and plonk it down in your home directory.  Gnus doesn't move any
13816 mail if you're not using a mail back end---you have to do a lot of magic
13817 invocations first.  At the time when you have finished drawing the
13818 pentagram, lightened the candles, and sacrificed the goat, you really
13819 shouldn't be too surprised when Gnus moves your mail.
13820
13821
13822
13823 @node Mail Back End Variables
13824 @subsection Mail Back End Variables
13825
13826 These variables are (for the most part) pertinent to all the various
13827 mail back ends.
13828
13829 @table @code
13830 @vindex nnmail-read-incoming-hook
13831 @item nnmail-read-incoming-hook
13832 The mail back ends all call this hook after reading new mail.  You can
13833 use this hook to notify any mail watch programs, if you want to.
13834
13835 @vindex nnmail-split-hook
13836 @item nnmail-split-hook
13837 @findex gnus-article-decode-encoded-words
13838 @cindex RFC 1522 decoding
13839 @cindex RFC 2047 decoding
13840 Hook run in the buffer where the mail headers of each message is kept
13841 just before the splitting based on these headers is done.  The hook is
13842 free to modify the buffer contents in any way it sees fit---the buffer
13843 is discarded after the splitting has been done, and no changes performed
13844 in the buffer will show up in any files.
13845 @code{gnus-article-decode-encoded-words} is one likely function to add
13846 to this hook.
13847
13848 @vindex nnmail-pre-get-new-mail-hook
13849 @vindex nnmail-post-get-new-mail-hook
13850 @item nnmail-pre-get-new-mail-hook
13851 @itemx nnmail-post-get-new-mail-hook
13852 These are two useful hooks executed when treating new incoming
13853 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13854 starting to handle the new mail) and
13855 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13856 is done).  Here's and example of using these two hooks to change the
13857 default file modes the new mail files get:
13858
13859 @lisp
13860 (add-hook 'nnmail-pre-get-new-mail-hook
13861           (lambda () (set-default-file-modes 511)))
13862
13863 (add-hook 'nnmail-post-get-new-mail-hook
13864           (lambda () (set-default-file-modes 551)))
13865 @end lisp
13866
13867 @item nnmail-use-long-file-names
13868 @vindex nnmail-use-long-file-names
13869 If non-@code{nil}, the mail back ends will use long file and directory
13870 names.  Groups like @samp{mail.misc} will end up in directories
13871 (assuming use of @code{nnml} back end) or files (assuming use of
13872 @code{nnfolder} back end) like @file{mail.misc}.  If it is @code{nil},
13873 the same group will end up in @file{mail/misc}.
13874
13875 @item nnmail-delete-file-function
13876 @vindex nnmail-delete-file-function
13877 @findex delete-file
13878 Function called to delete files.  It is @code{delete-file} by default.
13879
13880 @item nnmail-cache-accepted-message-ids
13881 @vindex nnmail-cache-accepted-message-ids
13882 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
13883 the back end (via @code{Gcc}, for instance) into the mail duplication
13884 discovery cache.  The default is @code{nil}.
13885
13886 @item nnmail-cache-ignore-groups
13887 @vindex nnmail-cache-ignore-groups
13888 This can be a regular expression or a list of regular expressions.
13889 Group names that match any of the regular expressions will never be
13890 recorded in the @code{Message-ID} cache.
13891
13892 This can be useful, for example, when using Fancy Splitting
13893 (@pxref{Fancy Mail Splitting}) together with the function
13894 @code{nnmail-split-fancy-with-parent}.
13895
13896 @end table
13897
13898
13899 @node Fancy Mail Splitting
13900 @subsection Fancy Mail Splitting
13901 @cindex mail splitting
13902 @cindex fancy mail splitting
13903
13904 @vindex nnmail-split-fancy
13905 @findex nnmail-split-fancy
13906 If the rather simple, standard method for specifying how to split mail
13907 doesn't allow you to do what you want, you can set
13908 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
13909 play with the @code{nnmail-split-fancy} variable.
13910
13911 Let's look at an example value of this variable first:
13912
13913 @lisp
13914 ;; @r{Messages from the mailer daemon are not crossposted to any of}
13915 ;; @r{the ordinary groups.  Warnings are put in a separate group}
13916 ;; @r{from real errors.}
13917 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
13918                    "mail.misc"))
13919    ;; @r{Non-error messages are crossposted to all relevant}
13920    ;; @r{groups, but we don't crosspost between the group for the}
13921    ;; @r{(ding) list and the group for other (ding) related mail.}
13922    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
13923          ("subject" "ding" "ding.misc"))
13924       ;; @r{Other mailing lists@dots{}}
13925       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
13926       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
13927       ;; @r{Both lists below have the same suffix, so prevent}
13928       ;; @r{cross-posting to mkpkg.list of messages posted only to}
13929       ;; @r{the bugs- list, but allow cross-posting when the}
13930       ;; @r{message was really cross-posted.}
13931       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
13932       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
13933       ;; @r{People@dots{}}
13934       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
13935    ;; @r{Unmatched mail goes to the catch all group.}
13936    "misc.misc")
13937 @end lisp
13938
13939 This variable has the format of a @dfn{split}.  A split is a
13940 (possibly) recursive structure where each split may contain other
13941 splits.  Here are the possible split syntaxes:
13942
13943 @table @code
13944
13945 @item group 
13946 If the split is a string, that will be taken as a group name.  Normal
13947 regexp match expansion will be done.  See below for examples.
13948
13949 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split})
13950 If the split is a list, the first element of which is a string, then
13951 store the message as specified by @var{split}, if header @var{field}
13952 (a regexp) contains @var{value} (also a regexp).  If @var{restrict}
13953 (yet another regexp) matches some string after @var{field} and before
13954 the end of the matched @var{value}, the @var{split} is ignored.  If
13955 none of the @var{restrict} clauses match, @var{split} is processed.
13956
13957 @item (| @var{split} @dots{})
13958 If the split is a list, and the first element is @code{|} (vertical
13959 bar), then process each @var{split} until one of them matches.  A
13960 @var{split} is said to match if it will cause the mail message to be
13961 stored in one or more groups.
13962
13963 @item (& @var{split} @dots{})
13964 If the split is a list, and the first element is @code{&}, then
13965 process all @var{split}s in the list.
13966
13967 @item junk
13968 If the split is the symbol @code{junk}, then don't save (i.e., delete)
13969 this message.  Use with extreme caution.
13970
13971 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
13972 If the split is a list, and the first element is @samp{:}, then the
13973 second element will be called as a function with @var{args} given as
13974 arguments.  The function should return a @var{split}.
13975
13976 @cindex body split
13977 For instance, the following function could be used to split based on the
13978 body of the messages:
13979
13980 @lisp
13981 (defun split-on-body ()
13982   (save-excursion
13983     (save-restriction
13984       (widen)
13985       (goto-char (point-min))
13986       (when (re-search-forward "Some.*string" nil t)
13987         "string.group"))))
13988 @end lisp
13989
13990 The buffer is narrowed to the message in question when @var{function}
13991 is run.  That's why @code{(widen)} needs to be called after
13992 @code{save-excursion} and @code{save-restriction} in the example
13993 above.  Also note that with the nnimap backend, message bodies will
13994 not be downloaded by default.  You need to set
13995 @code{nnimap-split-download-body} to @code{t} to do that
13996 (@pxref{Splitting in IMAP}).
13997
13998 @item (! @var{func} @var{split})
13999 If the split is a list, and the first element is @code{!}, then
14000 @var{split} will be processed, and @var{func} will be called as a
14001 function with the result of @var{split} as argument.  @var{func}
14002 should return a split.
14003
14004 @item nil
14005 If the split is @code{nil}, it is ignored.
14006
14007 @end table
14008
14009 In these splits, @var{field} must match a complete field name.
14010 @var{value} must match a complete word according to the fundamental mode
14011 syntax table.  You can use @code{.*} in the regexps to match partial
14012 field names or words.  In other words, all @var{value}'s are wrapped in
14013 @samp{\<} and @samp{\>} pairs.
14014
14015 @vindex nnmail-split-abbrev-alist
14016 @var{field} and @var{value} can also be Lisp symbols, in that case
14017 they are expanded as specified by the variable
14018 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells,
14019 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14020 contains the associated value.  Predefined entries in
14021 @code{nnmail-split-abbrev-alist} include:
14022
14023 @table @code
14024 @item from
14025 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14026 @item to
14027 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14028 @samp{Resent-To} and @samp{Resent-Cc} fields.
14029 @item any
14030 Is the union of the @code{from} and @code{to} entries.
14031 @end table
14032
14033 @vindex nnmail-split-fancy-syntax-table
14034 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14035 when all this splitting is performed.
14036
14037 If you want to have Gnus create groups dynamically based on some
14038 information in the headers (i.e., do @code{replace-match}-like
14039 substitutions in the group names), you can say things like:
14040
14041 @example
14042 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
14043 @end example
14044
14045 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
14046 will be filed in @samp{mail.debian.foo}.
14047
14048 If the string contains the element @samp{\&}, then the previously
14049 matched string will be substituted.  Similarly, the elements @samp{\\1}
14050 up to @samp{\\9} will be substituted with the text matched by the
14051 groupings 1 through 9.
14052
14053 @vindex nnmail-split-fancy-match-partial-words
14054 @code{nnmail-split-fancy-match-partial-words} controls whether partial
14055 words are matched during fancy splitting.
14056
14057 Normally, regular expressions given in @code{nnmail-split-fancy} are
14058 implicitly surrounded by @code{\<...\>} markers, which are word
14059 delimiters.  If this variable is true, they are not implicitly
14060 surrounded by anything.
14061
14062 @example
14063 (any "joe" "joemail")
14064 @end example
14065
14066 In this example, messages sent from @samp{joedavis@@foo.org} will
14067 normally not be filed in @samp{joemail}.  With
14068 @code{nnmail-split-fancy-match-partial-words} set to t, however, the
14069 match will happen.  In effect, the requirement of a word boundary is
14070 removed and instead the match becomes more like a grep.
14071
14072 @findex nnmail-split-fancy-with-parent
14073 @code{nnmail-split-fancy-with-parent} is a function which allows you to
14074 split followups into the same groups their parents are in.  Sometimes
14075 you can't make splitting rules for all your mail.  For example, your
14076 boss might send you personal mail regarding different projects you are
14077 working on, and as you can't tell your boss to put a distinguishing
14078 string into the subject line, you have to resort to manually moving the
14079 messages into the right group.  With this function, you only have to do
14080 it once per thread.
14081
14082 To use this feature, you have to set @code{nnmail-treat-duplicates}
14083 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
14084 value.  And then you can include @code{nnmail-split-fancy-with-parent}
14085 using the colon feature, like so:
14086 @lisp
14087 (setq nnmail-treat-duplicates 'warn     ; @r{or @code{delete}}
14088       nnmail-cache-accepted-message-ids t
14089       nnmail-split-fancy
14090       '(| (: nnmail-split-fancy-with-parent)
14091           ;; @r{other splits go here}
14092         ))
14093 @end lisp
14094
14095 This feature works as follows: when @code{nnmail-treat-duplicates} is
14096 non-@code{nil}, Gnus records the message id of every message it sees
14097 in the file specified by the variable
14098 @code{nnmail-message-id-cache-file}, together with the group it is in
14099 (the group is omitted for non-mail messages).  When mail splitting is
14100 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
14101 at the References (and In-Reply-To) header of each message to split
14102 and searches the file specified by @code{nnmail-message-id-cache-file}
14103 for the message ids.  When it has found a parent, it returns the
14104 corresponding group name unless the group name matches the regexp
14105 @code{nnmail-split-fancy-with-parent-ignore-groups}.  It is
14106 recommended that you set @code{nnmail-message-id-cache-length} to a
14107 somewhat higher number than the default so that the message ids are
14108 still in the cache.  (A value of 5000 appears to create a file some
14109 300 kBytes in size.)
14110 @vindex nnmail-cache-accepted-message-ids
14111 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
14112 also records the message ids of moved articles, so that the followup
14113 messages goes into the new group.
14114
14115 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
14116 want certain groups to be recorded in the cache.  For example, if all
14117 outgoing messages are written to an ``outgoing'' group, you could set
14118 @code{nnmail-cache-ignore-groups} to match that group name.
14119 Otherwise, answers to all your messages would end up in the
14120 ``outgoing'' group.
14121
14122
14123 @node Group Mail Splitting
14124 @subsection Group Mail Splitting
14125 @cindex mail splitting
14126 @cindex group mail splitting
14127
14128 @findex gnus-group-split
14129 If you subscribe to dozens of mailing lists but you don't want to
14130 maintain mail splitting rules manually, group mail splitting is for you.
14131 You just have to set @code{to-list} and/or @code{to-address} in group
14132 parameters or group customization and set @code{nnmail-split-methods} to
14133 @code{gnus-group-split}.  This splitting function will scan all groups
14134 for those parameters and split mail accordingly, i.e., messages posted
14135 from or to the addresses specified in the parameters @code{to-list} or
14136 @code{to-address} of a mail group will be stored in that group.
14137
14138 Sometimes, mailing lists have multiple addresses, and you may want mail
14139 splitting to recognize them all: just set the @code{extra-aliases} group
14140 parameter to the list of additional addresses and it's done.  If you'd
14141 rather use a regular expression, set @code{split-regexp}.
14142
14143 All these parameters in a group will be used to create an
14144 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
14145 the @var{value} is a single regular expression that matches
14146 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
14147 matches of @code{split-regexp}, and the @var{split} is the name of the
14148 group.  @var{restrict}s are also supported: just set the
14149 @code{split-exclude} parameter to a list of regular expressions.
14150
14151 If you can't get the right split to be generated using all these
14152 parameters, or you just need something fancier, you can set the
14153 parameter @code{split-spec} to an @code{nnmail-split-fancy} split.  In
14154 this case, all other aforementioned parameters will be ignored by
14155 @code{gnus-group-split}.  In particular, @code{split-spec} may be set to
14156 @code{nil}, in which case the group will be ignored by
14157 @code{gnus-group-split}.
14158
14159 @vindex gnus-group-split-default-catch-all-group
14160 @code{gnus-group-split} will do cross-posting on all groups that match,
14161 by defining a single @code{&} fancy split containing one split for each
14162 group.  If a message doesn't match any split, it will be stored in the
14163 group named in @code{gnus-group-split-default-catch-all-group}, unless
14164 some group has @code{split-spec} set to @code{catch-all}, in which case
14165 that group is used as the catch-all group.  Even though this variable is
14166 often used just to name a group, it may also be set to an arbitrarily
14167 complex fancy split (after all, a group name is a fancy split), and this
14168 may be useful to split mail that doesn't go to any mailing list to
14169 personal mail folders.  Note that this fancy split is added as the last
14170 element of a @code{|} split list that also contains a @code{&} split
14171 with the rules extracted from group parameters.
14172
14173 It's time for an example.  Assume the following group parameters have
14174 been defined:
14175
14176 @example
14177 nnml:mail.bar:
14178 ((to-address . "bar@@femail.com")
14179  (split-regexp . ".*@@femail\\.com"))
14180 nnml:mail.foo:
14181 ((to-list . "foo@@nowhere.gov")
14182  (extra-aliases "foo@@localhost" "foo-redist@@home")
14183  (split-exclude "bugs-foo" "rambling-foo")
14184  (admin-address . "foo-request@@nowhere.gov"))
14185 nnml:mail.others:
14186 ((split-spec . catch-all))
14187 @end example
14188
14189 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
14190 behave as if @code{nnmail-split-fancy} had been selected and variable
14191 @code{nnmail-split-fancy} had been set as follows:
14192
14193 @lisp
14194 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
14195       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
14196            - "bugs-foo" - "rambling-foo" "mail.foo"))
14197    "mail.others")
14198 @end lisp
14199
14200 @findex gnus-group-split-fancy
14201 If you'd rather not use group splitting for all your mail groups, you
14202 may use it for only some of them, by using @code{nnmail-split-fancy}
14203 splits like this:
14204
14205 @lisp
14206 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
14207 @end lisp
14208
14209 @var{groups} may be a regular expression or a list of group names whose
14210 parameters will be scanned to generate the output split.
14211 @var{no-crosspost} can be used to disable cross-posting; in this case, a
14212 single @code{|} split will be output.  @var{catch-all} is the fall back
14213 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
14214 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
14215 empty string in any selected group, no catch-all split will be issued.
14216 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
14217 this group will override the value of the @var{catch-all} argument.
14218
14219 @findex gnus-group-split-setup
14220 Unfortunately, scanning all groups and their parameters can be quite
14221 slow, especially considering that it has to be done for every message.
14222 But don't despair!  The function @code{gnus-group-split-setup} can be
14223 used to enable @code{gnus-group-split} in a much more efficient way.  It
14224 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
14225 @code{nnmail-split-fancy} to the split produced by
14226 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
14227 scanned once, no matter how many messages are split.
14228
14229 @findex gnus-group-split-update
14230 However, if you change group parameters, you'd have to update
14231 @code{nnmail-split-fancy} manually.  You can do it by running
14232 @code{gnus-group-split-update}.  If you'd rather have it updated
14233 automatically, just tell @code{gnus-group-split-setup} to do it for
14234 you.  For example, add to your @file{~/.gnus.el}:
14235
14236 @lisp
14237 (gnus-group-split-setup @var{auto-update} @var{catch-all})
14238 @end lisp
14239
14240 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
14241 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
14242 have to worry about updating @code{nnmail-split-fancy} again.  If you
14243 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
14244 @code{gnus-group-split-default-catch-all-group} will be set to its
14245 value.
14246
14247 @vindex gnus-group-split-updated-hook
14248 Because you may want to change @code{nnmail-split-fancy} after it is set
14249 by @code{gnus-group-split-update}, this function will run
14250 @code{gnus-group-split-updated-hook} just before finishing.
14251
14252 @node Incorporating Old Mail
14253 @subsection Incorporating Old Mail
14254 @cindex incorporating old mail
14255 @cindex import old mail
14256
14257 Most people have lots of old mail stored in various file formats.  If
14258 you have set up Gnus to read mail using one of the spiffy Gnus mail
14259 back ends, you'll probably wish to have that old mail incorporated into
14260 your mail groups.
14261
14262 Doing so can be quite easy.
14263
14264 To take an example: You're reading mail using @code{nnml}
14265 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
14266 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
14267 file filled with important, but old, mail.  You want to move it into
14268 your @code{nnml} groups.
14269
14270 Here's how:
14271
14272 @enumerate
14273 @item
14274 Go to the group buffer.
14275
14276 @item
14277 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
14278 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
14279
14280 @item
14281 Type @kbd{SPACE} to enter the newly created group.
14282
14283 @item
14284 Type @kbd{M P b} to process-mark all articles in this group's buffer
14285 (@pxref{Setting Process Marks}).
14286
14287 @item
14288 Type @kbd{B r} to respool all the process-marked articles, and answer
14289 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
14290 @end enumerate
14291
14292 All the mail messages in the mbox file will now also be spread out over
14293 all your @code{nnml} groups.  Try entering them and check whether things
14294 have gone without a glitch.  If things look ok, you may consider
14295 deleting the mbox file, but I wouldn't do that unless I was absolutely
14296 sure that all the mail has ended up where it should be.
14297
14298 Respooling is also a handy thing to do if you're switching from one mail
14299 back end to another.  Just respool all the mail in the old mail groups
14300 using the new mail back end.
14301
14302
14303 @node Expiring Mail
14304 @subsection Expiring Mail
14305 @cindex article expiry
14306
14307 Traditional mail readers have a tendency to remove mail articles when
14308 you mark them as read, in some way.  Gnus takes a fundamentally
14309 different approach to mail reading.
14310
14311 Gnus basically considers mail just to be news that has been received in
14312 a rather peculiar manner.  It does not think that it has the power to
14313 actually change the mail, or delete any mail messages.  If you enter a
14314 mail group, and mark articles as ``read'', or kill them in some other
14315 fashion, the mail articles will still exist on the system.  I repeat:
14316 Gnus will not delete your old, read mail.  Unless you ask it to, of
14317 course.
14318
14319 To make Gnus get rid of your unwanted mail, you have to mark the
14320 articles as @dfn{expirable}.  (With the default key bindings, this means
14321 that you have to type @kbd{E}.)  This does not mean that the articles
14322 will disappear right away, however.  In general, a mail article will be
14323 deleted from your system if, 1) it is marked as expirable, AND 2) it is
14324 more than one week old.  If you do not mark an article as expirable, it
14325 will remain on your system until hell freezes over.  This bears
14326 repeating one more time, with some spurious capitalizations: IF you do
14327 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
14328
14329 You do not have to mark articles as expirable by hand.  Gnus provides
14330 two features, called ``auto-expire'' and ``total-expire'', that can help you
14331 with this.  In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
14332 for you when you select an article.  And ``total-expire'' means that Gnus
14333 considers all articles as expirable that are read.  So, in addition to
14334 the articles marked @samp{E}, also the articles marked @samp{r},
14335 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
14336 expirable.
14337
14338 When should either auto-expire or total-expire be used?  Most people
14339 who are subscribed to mailing lists split each list into its own group
14340 and then turn on auto-expire or total-expire for those groups.
14341 (@xref{Splitting Mail}, for more information on splitting each list
14342 into its own group.)
14343
14344 Which one is better, auto-expire or total-expire?  It's not easy to
14345 answer.  Generally speaking, auto-expire is probably faster.  Another
14346 advantage of auto-expire is that you get more marks to work with: for
14347 the articles that are supposed to stick around, you can still choose
14348 between tick and dormant and read marks.  But with total-expire, you
14349 only have dormant and ticked to choose from.  The advantage of
14350 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
14351 Scoring}).  Auto-expire works with normal scoring but not with adaptive
14352 scoring.
14353
14354 @vindex gnus-auto-expirable-newsgroups
14355 Groups that match the regular expression
14356 @code{gnus-auto-expirable-newsgroups} will have all articles that you
14357 read marked as expirable automatically.  All articles marked as
14358 expirable have an @samp{E} in the first column in the summary buffer.
14359
14360 By default, if you have auto expiry switched on, Gnus will mark all the
14361 articles you read as expirable, no matter if they were read or unread
14362 before.  To avoid having articles marked as read marked as expirable
14363 automatically, you can put something like the following in your
14364 @file{~/.gnus.el} file:
14365
14366 @vindex gnus-mark-article-hook
14367 @lisp
14368 (remove-hook 'gnus-mark-article-hook
14369              'gnus-summary-mark-read-and-unread-as-read)
14370 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
14371 @end lisp
14372
14373 Note that making a group auto-expirable doesn't mean that all read
14374 articles are expired---only the articles marked as expirable
14375 will be expired.  Also note that using the @kbd{d} command won't make
14376 articles expirable---only semi-automatic marking of articles as read will
14377 mark the articles as expirable in auto-expirable groups.
14378
14379 Let's say you subscribe to a couple of mailing lists, and you want the
14380 articles you have read to disappear after a while:
14381
14382 @lisp
14383 (setq gnus-auto-expirable-newsgroups
14384       "mail.nonsense-list\\|mail.nice-list")
14385 @end lisp
14386
14387 Another way to have auto-expiry happen is to have the element
14388 @code{auto-expire} in the group parameters of the group.
14389
14390 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
14391 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
14392 don't really mix very well.
14393
14394 @vindex nnmail-expiry-wait
14395 The @code{nnmail-expiry-wait} variable supplies the default time an
14396 expirable article has to live.  Gnus starts counting days from when the
14397 message @emph{arrived}, not from when it was sent.  The default is seven
14398 days.
14399
14400 Gnus also supplies a function that lets you fine-tune how long articles
14401 are to live, based on what group they are in.  Let's say you want to
14402 have one month expiry period in the @samp{mail.private} group, a one day
14403 expiry period in the @samp{mail.junk} group, and a six day expiry period
14404 everywhere else:
14405
14406 @vindex nnmail-expiry-wait-function
14407 @lisp
14408 (setq nnmail-expiry-wait-function
14409       (lambda (group)
14410        (cond ((string= group "mail.private")
14411                31)
14412              ((string= group "mail.junk")
14413                1)
14414              ((string= group "important")
14415                'never)
14416              (t
14417                6))))
14418 @end lisp
14419
14420 The group names this function is fed are ``unadorned'' group
14421 names---no @samp{nnml:} prefixes and the like.
14422
14423 The @code{nnmail-expiry-wait} variable and
14424 @code{nnmail-expiry-wait-function} function can either be a number (not
14425 necessarily an integer) or one of the symbols @code{immediate} or
14426 @code{never}.
14427
14428 You can also use the @code{expiry-wait} group parameter to selectively
14429 change the expiry period (@pxref{Group Parameters}).
14430
14431 @vindex nnmail-expiry-target
14432 The normal action taken when expiring articles is to delete them.
14433 However, in some circumstances it might make more sense to move them
14434 to other groups instead of deleting them.  The variable
14435 @code{nnmail-expiry-target} (and the @code{expiry-target} group
14436 parameter) controls this.  The variable supplies a default value for
14437 all groups, which can be overridden for specific groups by the group
14438 parameter.  default value is @code{delete}, but this can also be a
14439 string (which should be the name of the group the message should be
14440 moved to), or a function (which will be called in a buffer narrowed to
14441 the message in question, and with the name of the group being moved
14442 from as its parameter) which should return a target---either a group
14443 name or @code{delete}.
14444
14445 Here's an example for specifying a group name:
14446 @lisp
14447 (setq nnmail-expiry-target "nnml:expired")
14448 @end lisp
14449
14450 @findex nnmail-fancy-expiry-target
14451 @vindex nnmail-fancy-expiry-targets
14452 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
14453 expire mail to groups according to the variable
14454 @code{nnmail-fancy-expiry-targets}.  Here's an example:
14455
14456 @lisp
14457  (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
14458        nnmail-fancy-expiry-targets
14459        '((to-from "boss" "nnfolder:Work")
14460          ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
14461          ("from" ".*" "nnfolder:Archive-%Y")))
14462 @end lisp
14463
14464 With this setup, any mail that has @code{IMPORTANT} in its Subject
14465 header and was sent in the year @code{YYYY} and month @code{MMM}, will
14466 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}.  If its
14467 From or To header contains the string @code{boss}, it will get expired
14468 to @code{nnfolder:Work}.  All other mail will get expired to
14469 @code{nnfolder:Archive-YYYY}.
14470
14471 @vindex nnmail-keep-last-article
14472 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
14473 expire the final article in a mail newsgroup.  This is to make life
14474 easier for procmail users.
14475
14476 @vindex gnus-total-expirable-newsgroups
14477 By the way: That line up there, about Gnus never expiring non-expirable
14478 articles, is a lie.  If you put @code{total-expire} in the group
14479 parameters, articles will not be marked as expirable, but all read
14480 articles will be put through the expiry process.  Use with extreme
14481 caution.  Even more dangerous is the
14482 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
14483 this regexp will have all read articles put through the expiry process,
14484 which means that @emph{all} old mail articles in the groups in question
14485 will be deleted after a while.  Use with extreme caution, and don't come
14486 crying to me when you discover that the regexp you used matched the
14487 wrong group and all your important mail has disappeared.  Be a
14488 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
14489 with!  So there!
14490
14491 Most people make most of their mail groups total-expirable, though.
14492
14493 @vindex gnus-inhibit-user-auto-expire
14494 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
14495 commands will not mark an article as expirable, even if the group has
14496 auto-expire turned on.
14497
14498
14499 @node Washing Mail
14500 @subsection Washing Mail
14501 @cindex mail washing
14502 @cindex list server brain damage
14503 @cindex incoming mail treatment
14504
14505 Mailers and list servers are notorious for doing all sorts of really,
14506 really stupid things with mail.  ``Hey, RFC 822 doesn't explicitly
14507 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
14508 end of all lines passing through our server, so let's do that!!!!1!''
14509 Yes, but RFC 822 wasn't designed to be read by morons.  Things that were
14510 considered to be self-evident were not discussed.  So.  Here we are.
14511
14512 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
14513 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
14514 be shocked and dismayed by this, but I haven't got the energy.  It is to
14515 laugh.
14516
14517 Gnus provides a plethora of functions for washing articles while
14518 displaying them, but it might be nicer to do the filtering before
14519 storing the mail to disk.  For that purpose, we have three hooks and
14520 various functions that can be put in these hooks.
14521
14522 @table @code
14523 @item nnmail-prepare-incoming-hook
14524 @vindex nnmail-prepare-incoming-hook
14525 This hook is called before doing anything with the mail and is meant for
14526 grand, sweeping gestures.  It is called in a buffer that contains all
14527 the new, incoming mail.  Functions to be used include:
14528
14529 @table @code
14530 @item nnheader-ms-strip-cr
14531 @findex nnheader-ms-strip-cr
14532 Remove trailing carriage returns from each line.  This is default on
14533 Emacs running on MS machines.
14534
14535 @end table
14536
14537 @item nnmail-prepare-incoming-header-hook
14538 @vindex nnmail-prepare-incoming-header-hook
14539 This hook is called narrowed to each header.  It can be used when
14540 cleaning up the headers.  Functions that can be used include:
14541
14542 @table @code
14543 @item nnmail-remove-leading-whitespace
14544 @findex nnmail-remove-leading-whitespace
14545 Clear leading white space that ``helpful'' listservs have added to the
14546 headers to make them look nice.  Aaah.
14547
14548 (Note that this function works on both the header on the body of all
14549 messages, so it is a potentially dangerous function to use (if a body
14550 of a message contains something that looks like a header line).  So
14551 rather than fix the bug, it is of course the right solution to make it
14552 into a feature by documenting it.)
14553
14554 @item nnmail-remove-list-identifiers
14555 @findex nnmail-remove-list-identifiers
14556 Some list servers add an identifier---for example, @samp{(idm)}---to the
14557 beginning of all @code{Subject} headers.  I'm sure that's nice for
14558 people who use stone age mail readers.  This function will remove
14559 strings that match the @code{nnmail-list-identifiers} regexp, which can
14560 also be a list of regexp.  @code{nnmail-list-identifiers} may not contain
14561 @code{\\(..\\)}.
14562
14563 For instance, if you want to remove the @samp{(idm)} and the
14564 @samp{nagnagnag} identifiers:
14565
14566 @lisp
14567 (setq nnmail-list-identifiers
14568       '("(idm)" "nagnagnag"))
14569 @end lisp
14570
14571 This can also be done non-destructively with
14572 @code{gnus-list-identifiers}, @xref{Article Hiding}.
14573
14574 @item nnmail-remove-tabs
14575 @findex nnmail-remove-tabs
14576 Translate all @samp{TAB} characters into @samp{SPACE} characters.
14577
14578 @item nnmail-fix-eudora-headers
14579 @findex nnmail-fix-eudora-headers
14580 @cindex Eudora
14581 Eudora produces broken @code{References} headers, but OK
14582 @code{In-Reply-To} headers.  This function will get rid of the
14583 @code{References} headers.
14584
14585 @end table
14586
14587 @item nnmail-prepare-incoming-message-hook
14588 @vindex nnmail-prepare-incoming-message-hook
14589 This hook is called narrowed to each message.  Functions to be used
14590 include:
14591
14592 @table @code
14593 @item article-de-quoted-unreadable
14594 @findex article-de-quoted-unreadable
14595 Decode Quoted Readable encoding.
14596
14597 @end table
14598 @end table
14599
14600
14601 @node Duplicates
14602 @subsection Duplicates
14603
14604 @vindex nnmail-treat-duplicates
14605 @vindex nnmail-message-id-cache-length
14606 @vindex nnmail-message-id-cache-file
14607 @cindex duplicate mails
14608 If you are a member of a couple of mailing lists, you will sometimes
14609 receive two copies of the same mail.  This can be quite annoying, so
14610 @code{nnmail} checks for and treats any duplicates it might find.  To do
14611 this, it keeps a cache of old @code{Message-ID}s---
14612 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
14613 default.  The approximate maximum number of @code{Message-ID}s stored
14614 there is controlled by the @code{nnmail-message-id-cache-length}
14615 variable, which is 1000 by default.  (So 1000 @code{Message-ID}s will be
14616 stored.) If all this sounds scary to you, you can set
14617 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
14618 default), and @code{nnmail} won't delete duplicate mails.  Instead it
14619 will insert a warning into the head of the mail saying that it thinks
14620 that this is a duplicate of a different message.
14621
14622 This variable can also be a function.  If that's the case, the function
14623 will be called from a buffer narrowed to the message in question with
14624 the @code{Message-ID} as a parameter.  The function must return either
14625 @code{nil}, @code{warn}, or @code{delete}.
14626
14627 You can turn this feature off completely by setting the variable to
14628 @code{nil}.
14629
14630 If you want all the duplicate mails to be put into a special
14631 @dfn{duplicates} group, you could do that using the normal mail split
14632 methods:
14633
14634 @lisp
14635 (setq nnmail-split-fancy
14636       '(| ;; @r{Messages duplicates go to a separate group.}
14637         ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14638         ;; @r{Message from daemons, postmaster, and the like to another.}
14639         (any mail "mail.misc")
14640         ;; @r{Other rules.}
14641         [...] ))
14642 @end lisp
14643 @noindent
14644 Or something like:
14645 @lisp
14646 (setq nnmail-split-methods
14647       '(("duplicates" "^Gnus-Warning:.*duplicate")
14648         ;; @r{Other rules.}
14649         [...]))
14650 @end lisp
14651
14652 Here's a neat feature: If you know that the recipient reads her mail
14653 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14654 @code{delete}, you can send her as many insults as you like, just by
14655 using a @code{Message-ID} of a mail that you know that she's already
14656 received.  Think of all the fun!  She'll never see any of it!  Whee!
14657
14658
14659 @node Not Reading Mail
14660 @subsection Not Reading Mail
14661
14662 If you start using any of the mail back ends, they have the annoying
14663 habit of assuming that you want to read mail with them.  This might not
14664 be unreasonable, but it might not be what you want.
14665
14666 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14667 @code{nil}, none of the back ends will ever attempt to read incoming
14668 mail, which should help.
14669
14670 @vindex nnbabyl-get-new-mail
14671 @vindex nnmbox-get-new-mail
14672 @vindex nnml-get-new-mail
14673 @vindex nnmh-get-new-mail
14674 @vindex nnfolder-get-new-mail
14675 This might be too much, if, for instance, you are reading mail quite
14676 happily with @code{nnml} and just want to peek at some old Rmail
14677 file you have stashed away with @code{nnbabyl}.  All back ends have
14678 variables called back-end-@code{get-new-mail}.  If you want to disable
14679 the @code{nnbabyl} mail reading, you edit the virtual server for the
14680 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14681
14682 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14683 narrowed to the article to be saved before saving it when reading
14684 incoming mail.
14685
14686
14687 @node Choosing a Mail Back End
14688 @subsection Choosing a Mail Back End
14689
14690 Gnus will read the mail spool when you activate a mail group.  The mail
14691 file is first copied to your home directory.  What happens after that
14692 depends on what format you want to store your mail in.
14693
14694 There are six different mail back ends in the standard Gnus, and more
14695 back ends are available separately.  The mail back end most people use
14696 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14697 Spool}).
14698
14699 @menu
14700 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
14701 * Rmail Babyl::                 Emacs programs use the Rmail Babyl format.
14702 * Mail Spool::                  Store your mail in a private spool?
14703 * MH Spool::                    An mhspool-like back end.
14704 * Maildir::                     Another one-file-per-message format.
14705 * Mail Folders::                Having one file for each group.
14706 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
14707 @end menu
14708
14709
14710 @node Unix Mail Box
14711 @subsubsection Unix Mail Box
14712 @cindex nnmbox
14713 @cindex unix mail box
14714
14715 @vindex nnmbox-active-file
14716 @vindex nnmbox-mbox-file
14717 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14718 mail.  @code{nnmbox} will add extra headers to each mail article to say
14719 which group it belongs in.
14720
14721 Virtual server settings:
14722
14723 @table @code
14724 @item nnmbox-mbox-file
14725 @vindex nnmbox-mbox-file
14726 The name of the mail box in the user's home directory.  Default is
14727 @file{~/mbox}.
14728
14729 @item nnmbox-active-file
14730 @vindex nnmbox-active-file
14731 The name of the active file for the mail box.  Default is
14732 @file{~/.mbox-active}.
14733
14734 @item nnmbox-get-new-mail
14735 @vindex nnmbox-get-new-mail
14736 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14737 into groups.  Default is @code{t}.
14738 @end table
14739
14740
14741 @node Rmail Babyl
14742 @subsubsection Rmail Babyl
14743 @cindex nnbabyl
14744 @cindex Rmail mbox
14745
14746 @vindex nnbabyl-active-file
14747 @vindex nnbabyl-mbox-file
14748 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
14749 mbox}) to store mail.  @code{nnbabyl} will add extra headers to each
14750 mail article to say which group it belongs in.
14751
14752 Virtual server settings:
14753
14754 @table @code
14755 @item nnbabyl-mbox-file
14756 @vindex nnbabyl-mbox-file
14757 The name of the Rmail mbox file.  The default is @file{~/RMAIL}
14758
14759 @item nnbabyl-active-file
14760 @vindex nnbabyl-active-file
14761 The name of the active file for the rmail box.  The default is
14762 @file{~/.rmail-active}
14763
14764 @item nnbabyl-get-new-mail
14765 @vindex nnbabyl-get-new-mail
14766 If non-@code{nil}, @code{nnbabyl} will read incoming mail.  Default is
14767 @code{t}
14768 @end table
14769
14770
14771 @node Mail Spool
14772 @subsubsection Mail Spool
14773 @cindex nnml
14774 @cindex mail @acronym{NOV} spool
14775
14776 The @dfn{nnml} spool mail format isn't compatible with any other known
14777 format.  It should be used with some caution.
14778
14779 @vindex nnml-directory
14780 If you use this back end, Gnus will split all incoming mail into files,
14781 one file for each mail, and put the articles into the corresponding
14782 directories under the directory specified by the @code{nnml-directory}
14783 variable.  The default value is @file{~/Mail/}.
14784
14785 You do not have to create any directories beforehand; Gnus will take
14786 care of all that.
14787
14788 If you have a strict limit as to how many files you are allowed to store
14789 in your account, you should not use this back end.  As each mail gets its
14790 own file, you might very well occupy thousands of inodes within a few
14791 weeks.  If this is no problem for you, and it isn't a problem for you
14792 having your friendly systems administrator walking around, madly,
14793 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14794 know that this is probably the fastest format to use.  You do not have
14795 to trudge through a big mbox file just to read your new mail.
14796
14797 @code{nnml} is probably the slowest back end when it comes to article
14798 splitting.  It has to create lots of files, and it also generates
14799 @acronym{NOV} databases for the incoming mails.  This makes it possibly the
14800 fastest back end when it comes to reading mail.
14801
14802 @cindex self contained nnml servers
14803 @cindex marks
14804 When the marks file is used (which it is by default), @code{nnml}
14805 servers have the property that you may backup them using @code{tar} or
14806 similar, and later be able to restore them into Gnus (by adding the
14807 proper @code{nnml} server) and have all your marks be preserved.  Marks
14808 for a group is usually stored in the @code{.marks} file (but see
14809 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14810 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14811 to restore the group (after restoring the backup into the nnml
14812 directory).
14813
14814 If for some reason you believe your @file{.marks} files are screwed
14815 up, you can just delete them all.  Gnus will then correctly regenerate
14816 them next time it starts.
14817
14818 Virtual server settings:
14819
14820 @table @code
14821 @item nnml-directory
14822 @vindex nnml-directory
14823 All @code{nnml} directories will be placed under this directory.  The
14824 default is the value of @code{message-directory} (whose default value
14825 is @file{~/Mail}).
14826
14827 @item nnml-active-file
14828 @vindex nnml-active-file
14829 The active file for the @code{nnml} server.  The default is
14830 @file{~/Mail/active}.
14831
14832 @item nnml-newsgroups-file
14833 @vindex nnml-newsgroups-file
14834 The @code{nnml} group descriptions file.  @xref{Newsgroups File
14835 Format}.  The default is @file{~/Mail/newsgroups}.
14836
14837 @item nnml-get-new-mail
14838 @vindex nnml-get-new-mail
14839 If non-@code{nil}, @code{nnml} will read incoming mail.  The default is
14840 @code{t}.
14841
14842 @item nnml-nov-is-evil
14843 @vindex nnml-nov-is-evil
14844 If non-@code{nil}, this back end will ignore any @acronym{NOV} files.  The
14845 default is @code{nil}.
14846
14847 @item nnml-nov-file-name
14848 @vindex nnml-nov-file-name
14849 The name of the @acronym{NOV} files.  The default is @file{.overview}.
14850
14851 @item nnml-prepare-save-mail-hook
14852 @vindex nnml-prepare-save-mail-hook
14853 Hook run narrowed to an article before saving.
14854
14855 @item nnml-marks-is-evil
14856 @vindex nnml-marks-is-evil
14857 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
14858 default is @code{nil}.
14859
14860 @item nnml-marks-file-name
14861 @vindex nnml-marks-file-name
14862 The name of the @dfn{marks} files.  The default is @file{.marks}.
14863
14864 @item nnml-use-compressed-files
14865 @vindex nnml-use-compressed-files
14866 If non-@code{nil}, @code{nnml} will allow using compressed message
14867 files.
14868
14869 @end table
14870
14871 @findex nnml-generate-nov-databases
14872 If your @code{nnml} groups and @acronym{NOV} files get totally out of
14873 whack, you can do a complete update by typing @kbd{M-x
14874 nnml-generate-nov-databases}.  This command will trawl through the
14875 entire @code{nnml} hierarchy, looking at each and every article, so it
14876 might take a while to complete.  A better interface to this
14877 functionality can be found in the server buffer (@pxref{Server
14878 Commands}).
14879
14880
14881 @node MH Spool
14882 @subsubsection MH Spool
14883 @cindex nnmh
14884 @cindex mh-e mail spool
14885
14886 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
14887 @acronym{NOV} databases and it doesn't keep an active file or marks
14888 file.  This makes @code{nnmh} a @emph{much} slower back end than
14889 @code{nnml}, but it also makes it easier to write procmail scripts
14890 for.
14891
14892 Virtual server settings:
14893
14894 @table @code
14895 @item nnmh-directory
14896 @vindex nnmh-directory
14897 All @code{nnmh} directories will be located under this directory.  The
14898 default is the value of @code{message-directory} (whose default is
14899 @file{~/Mail})
14900
14901 @item nnmh-get-new-mail
14902 @vindex nnmh-get-new-mail
14903 If non-@code{nil}, @code{nnmh} will read incoming mail.  The default is
14904 @code{t}.
14905
14906 @item nnmh-be-safe
14907 @vindex nnmh-be-safe
14908 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
14909 sure that the articles in the folder are actually what Gnus thinks
14910 they are.  It will check date stamps and stat everything in sight, so
14911 setting this to @code{t} will mean a serious slow-down.  If you never
14912 use anything but Gnus to read the @code{nnmh} articles, you do not
14913 have to set this variable to @code{t}.  The default is @code{nil}.
14914 @end table
14915
14916
14917 @node Maildir
14918 @subsubsection Maildir
14919 @cindex nnmaildir
14920 @cindex maildir
14921
14922 @code{nnmaildir} stores mail in the maildir format, with each maildir
14923 corresponding to a group in Gnus.  This format is documented here:
14924 @uref{http://cr.yp.to/proto/maildir.html} and here:
14925 @uref{http://www.qmail.org/man/man5/maildir.html}.  @code{nnmaildir}
14926 also stores extra information in the @file{.nnmaildir/} directory
14927 within a maildir.
14928
14929 Maildir format was designed to allow concurrent deliveries and
14930 reading, without needing locks.  With other back ends, you would have
14931 your mail delivered to a spool of some kind, and then you would
14932 configure Gnus to split mail from that spool into your groups.  You
14933 can still do that with @code{nnmaildir}, but the more common
14934 configuration is to have your mail delivered directly to the maildirs
14935 that appear as group in Gnus.
14936
14937 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
14938 never corrupt its data in memory, and @code{SIGKILL} will never
14939 corrupt its data in the filesystem.
14940
14941 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
14942 maildir.  So you can copy a whole maildir from one Gnus setup to
14943 another, and you will keep your marks.
14944
14945 Virtual server settings:
14946
14947 @table @code
14948 @item directory
14949 For each of your @code{nnmaildir} servers (it's very unlikely that
14950 you'd need more than one), you need to create a directory and populate
14951 it with maildirs or symlinks to maildirs (and nothing else; do not
14952 choose a directory already used for other purposes).  Each maildir
14953 will be represented in Gnus as a newsgroup on that server; the
14954 filename of the symlink will be the name of the group.  Any filenames
14955 in the directory starting with @samp{.} are ignored.  The directory is
14956 scanned when you first start Gnus, and each time you type @kbd{g} in
14957 the group buffer; if any maildirs have been removed or added,
14958 @code{nnmaildir} notices at these times.
14959
14960 The value of the @code{directory} parameter should be a Lisp form
14961 which is processed by @code{eval} and @code{expand-file-name} to get
14962 the path of the directory for this server.  The form is @code{eval}ed
14963 only when the server is opened; the resulting string is used until the
14964 server is closed.  (If you don't know about forms and @code{eval},
14965 don't worry---a simple string will work.)  This parameter is not
14966 optional; you must specify it.  I don't recommend using
14967 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
14968 use that directory by default for various things, and may get confused
14969 if @code{nnmaildir} uses it too.  @code{"~/.nnmaildir"} is a typical
14970 value.
14971
14972 @item target-prefix
14973 This should be a Lisp form which is processed by @code{eval} and
14974 @code{expand-file-name}.  The form is @code{eval}ed only when the
14975 server is opened; the resulting string is used until the server is
14976 closed.
14977
14978 When you create a group on an @code{nnmaildir} server, the maildir is
14979 created with @code{target-prefix} prepended to its name, and a symlink
14980 pointing to that maildir is created, named with the plain group name.
14981 So if @code{directory} is @code{"~/.nnmaildir"} and
14982 @code{target-prefix} is @code{"../maildirs/"}, then when you create
14983 the group @code{foo}, @code{nnmaildir} will create
14984 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
14985 @file{~/.nnmaildir/foo} as a symlink pointing to
14986 @file{../maildirs/foo}.
14987
14988 You can set @code{target-prefix} to a string without any slashes to
14989 create both maildirs and symlinks in the same @code{directory}; in
14990 this case, any maildirs found in @code{directory} whose names start
14991 with @code{target-prefix} will not be listed as groups (but the
14992 symlinks pointing to them will be).
14993
14994 As a special case, if @code{target-prefix} is @code{""} (the default),
14995 then when you create a group, the maildir will be created in
14996 @code{directory} without a corresponding symlink.  Beware that you
14997 cannot use @code{gnus-group-delete-group} on such groups without the
14998 @code{force} argument.
14999
15000 @item directory-files
15001 This should be a function with the same interface as
15002 @code{directory-files} (such as @code{directory-files} itself).  It is
15003 used to scan the server's @code{directory} for maildirs.  This
15004 parameter is optional; the default is
15005 @code{nnheader-directory-files-safe} if
15006 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15007 @code{directory-files} otherwise.
15008 (@code{nnheader-directory-files-is-safe} is checked only once when the
15009 server is opened; if you want to check it each time the directory is
15010 scanned, you'll have to provide your own function that does that.)
15011
15012 @item get-new-mail
15013 If non-@code{nil}, then after scanning for new mail in the group
15014 maildirs themselves as usual, this server will also incorporate mail
15015 the conventional Gnus way, from @code{mail-sources} according to
15016 @code{nnmail-split-methods} or @code{nnmail-split-fancy}.  The default
15017 value is @code{nil}.
15018
15019 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15020 an @code{nnmaildir} group.  The results might happen to be useful, but
15021 that would be by chance, not by design, and the results might be
15022 different in the future.  If your split rules create new groups,
15023 remember to supply a @code{create-directory} server parameter.
15024 @end table
15025
15026 @subsubsection Group parameters
15027
15028 @code{nnmaildir} uses several group parameters.  It's safe to ignore
15029 all this; the default behavior for @code{nnmaildir} is the same as the
15030 default behavior for other mail back ends: articles are deleted after
15031 one week, etc.  Except for the expiry parameters, all this
15032 functionality is unique to @code{nnmaildir}, so you can ignore it if
15033 you're just trying to duplicate the behavior you already have with
15034 another back end.
15035
15036 If the value of any of these parameters is a vector, the first element
15037 is evaluated as a Lisp form and the result is used, rather than the
15038 original value.  If the value is not a vector, the value itself is
15039 evaluated as a Lisp form.  (This is why these parameters use names
15040 different from those of other, similar parameters supported by other
15041 back ends: they have different, though similar, meanings.)  (For
15042 numbers, strings, @code{nil}, and @code{t}, you can ignore the
15043 @code{eval} business again; for other values, remember to use an extra
15044 quote and wrap the value in a vector when appropriate.)
15045
15046 @table @code
15047 @item expire-age
15048 An integer specifying the minimum age, in seconds, of an article
15049 before it will be expired, or the symbol @code{never} to specify that
15050 articles should never be expired.  If this parameter is not set,
15051 @code{nnmaildir} falls back to the usual
15052 @code{nnmail-expiry-wait}(@code{-function}) variables (overrideable by
15053 the @code{expiry-wait}(@code{-function}) group parameters.  If you
15054 wanted a value of 3 days, you could use something like @code{[(* 3 24
15055 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
15056 An article's age is measured starting from the article file's
15057 modification time.  Normally, this is the same as the article's
15058 delivery time, but editing an article makes it younger.  Moving an
15059 article (other than via expiry) may also make an article younger.
15060
15061 @item expire-group
15062 If this is set to a string such as a full Gnus group name, like
15063 @example
15064 "backend+server.address.string:group.name"
15065 @end example
15066 and if it is not the name of the same group that the parameter belongs
15067 to, then articles will be moved to the specified group during expiry
15068 before being deleted.  @emph{If this is set to an @code{nnmaildir}
15069 group, the article will be just as old in the destination group as it
15070 was in the source group.}  So be careful with @code{expire-age} in the
15071 destination group.  If this is set to the name of the same group that
15072 the parameter belongs to, then the article is not expired at all.  If
15073 you use the vector form, the first element is evaluated once for each
15074 article.  So that form can refer to
15075 @code{nnmaildir-article-file-name}, etc., to decide where to put the
15076 article.  @emph{If this parameter is not set, @code{nnmaildir} does
15077 not fall back to the @code{expiry-target} group parameter or the
15078 @code{nnmail-expiry-target} variable.}
15079
15080 @item read-only
15081 If this is set to @code{t}, @code{nnmaildir} will treat the articles
15082 in this maildir as read-only.  This means: articles are not renamed
15083 from @file{new/} into @file{cur/}; articles are only found in
15084 @file{new/}, not @file{cur/}; articles are never deleted; articles
15085 cannot be edited.  @file{new/} is expected to be a symlink to the
15086 @file{new/} directory of another maildir---e.g., a system-wide mailbox
15087 containing a mailing list of common interest.  Everything in the
15088 maildir outside @file{new/} is @emph{not} treated as read-only, so for
15089 a shared mailbox, you do still need to set up your own maildir (or
15090 have write permission to the shared mailbox); your maildir just won't
15091 contain extra copies of the articles.
15092
15093 @item directory-files
15094 A function with the same interface as @code{directory-files}.  It is
15095 used to scan the directories in the maildir corresponding to this
15096 group to find articles.  The default is the function specified by the
15097 server's @code{directory-files} parameter.
15098
15099 @item distrust-Lines:
15100 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
15101 article, rather than use the @code{Lines:} header field.  If
15102 @code{nil}, the header field will be used if present.
15103
15104 @item always-marks
15105 A list of mark symbols, such as @code{['(read expire)]}.  Whenever
15106 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15107 say that all articles have these marks, regardless of whether the
15108 marks stored in the filesystem say so.  This is a proof-of-concept
15109 feature that will probably be removed eventually; it ought to be done
15110 in Gnus proper, or abandoned if it's not worthwhile.
15111
15112 @item never-marks
15113 A list of mark symbols, such as @code{['(tick expire)]}.  Whenever
15114 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
15115 say that no articles have these marks, regardless of whether the marks
15116 stored in the filesystem say so.  @code{never-marks} overrides
15117 @code{always-marks}.  This is a proof-of-concept feature that will
15118 probably be removed eventually; it ought to be done in Gnus proper, or
15119 abandoned if it's not worthwhile.
15120
15121 @item nov-cache-size
15122 An integer specifying the size of the @acronym{NOV} memory cache.  To
15123 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
15124 for a limited number of articles in each group.  (This is probably not
15125 worthwhile, and will probably be removed in the future.)  This
15126 parameter's value is noticed only the first time a group is seen after
15127 the server is opened---i.e., when you first start Gnus, typically.
15128 The @acronym{NOV} cache is never resized until the server is closed
15129 and reopened.  The default is an estimate of the number of articles
15130 that would be displayed in the summary buffer: a count of articles
15131 that are either marked with @code{tick} or not marked with
15132 @code{read}, plus a little extra.
15133 @end table
15134
15135 @subsubsection Article identification
15136 Articles are stored in the @file{cur/} subdirectory of each maildir.
15137 Each article file is named like @code{uniq:info}, where @code{uniq}
15138 contains no colons.  @code{nnmaildir} ignores, but preserves, the
15139 @code{:info} part.  (Other maildir readers typically use this part of
15140 the filename to store marks.)  The @code{uniq} part uniquely
15141 identifies the article, and is used in various places in the
15142 @file{.nnmaildir/} subdirectory of the maildir to store information
15143 about the corresponding article.  The full pathname of an article is
15144 available in the variable @code{nnmaildir-article-file-name} after you
15145 request the article in the summary buffer.
15146
15147 @subsubsection NOV data
15148 An article identified by @code{uniq} has its @acronym{NOV} data (used
15149 to generate lines in the summary buffer) stored in
15150 @code{.nnmaildir/nov/uniq}.  There is no
15151 @code{nnmaildir-generate-nov-databases} function.  (There isn't much
15152 need for it---an article's @acronym{NOV} data is updated automatically
15153 when the article or @code{nnmail-extra-headers} has changed.)  You can
15154 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
15155 single article simply by deleting the corresponding @acronym{NOV}
15156 file, but @emph{beware}: this will also cause @code{nnmaildir} to
15157 assign a new article number for this article, which may cause trouble
15158 with @code{seen} marks, the Agent, and the cache.
15159
15160 @subsubsection Article marks
15161 An article identified by @code{uniq} is considered to have the mark
15162 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
15163 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
15164 looks for such files and reports the set of marks it finds.  When Gnus
15165 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
15166 creates and deletes the corresponding files as needed.  (Actually,
15167 rather than create a new file for each mark, it just creates hard
15168 links to @file{.nnmaildir/markfile}, to save inodes.)
15169
15170 You can invent new marks by creating a new directory in
15171 @file{.nnmaildir/marks/}.  You can tar up a maildir and remove it from
15172 your server, untar it later, and keep your marks.  You can add and
15173 remove marks yourself by creating and deleting mark files.  If you do
15174 this while Gnus is running and your @code{nnmaildir} server is open,
15175 it's best to exit all summary buffers for @code{nnmaildir} groups and
15176 type @kbd{s} in the group buffer first, and to type @kbd{g} or
15177 @kbd{M-g} in the group buffer afterwards.  Otherwise, Gnus might not
15178 pick up the changes, and might undo them.
15179
15180
15181 @node Mail Folders
15182 @subsubsection Mail Folders
15183 @cindex nnfolder
15184 @cindex mbox folders
15185 @cindex mail folders
15186
15187 @code{nnfolder} is a back end for storing each mail group in a
15188 separate file.  Each file is in the standard Un*x mbox format.
15189 @code{nnfolder} will add extra headers to keep track of article
15190 numbers and arrival dates.
15191
15192 @cindex self contained nnfolder servers
15193 @cindex marks
15194 When the marks file is used (which it is by default), @code{nnfolder}
15195 servers have the property that you may backup them using @code{tar} or
15196 similar, and later be able to restore them into Gnus (by adding the
15197 proper @code{nnfolder} server) and have all your marks be preserved.
15198 Marks for a group is usually stored in a file named as the mbox file
15199 with @code{.mrk} concatenated to it (but see
15200 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
15201 directory.  Individual @code{nnfolder} groups are also possible to
15202 backup, use @kbd{G m} to restore the group (after restoring the backup
15203 into the @code{nnfolder} directory).
15204
15205 Virtual server settings:
15206
15207 @table @code
15208 @item nnfolder-directory
15209 @vindex nnfolder-directory
15210 All the @code{nnfolder} mail boxes will be stored under this
15211 directory.  The default is the value of @code{message-directory}
15212 (whose default is @file{~/Mail})
15213
15214 @item nnfolder-active-file
15215 @vindex nnfolder-active-file
15216 The name of the active file.  The default is @file{~/Mail/active}.
15217
15218 @item nnfolder-newsgroups-file
15219 @vindex nnfolder-newsgroups-file
15220 The name of the group descriptions file.  @xref{Newsgroups File
15221 Format}.  The default is @file{~/Mail/newsgroups}
15222
15223 @item nnfolder-get-new-mail
15224 @vindex nnfolder-get-new-mail
15225 If non-@code{nil}, @code{nnfolder} will read incoming mail.  The
15226 default is @code{t}
15227
15228 @item nnfolder-save-buffer-hook
15229 @vindex nnfolder-save-buffer-hook
15230 @cindex backup files
15231 Hook run before saving the folders.  Note that Emacs does the normal
15232 backup renaming of files even with the @code{nnfolder} buffers.  If
15233 you wish to switch this off, you could say something like the
15234 following in your @file{.emacs} file:
15235
15236 @lisp
15237 (defun turn-off-backup ()
15238   (set (make-local-variable 'backup-inhibited) t))
15239
15240 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
15241 @end lisp
15242
15243 @item nnfolder-delete-mail-hook
15244 @vindex nnfolder-delete-mail-hook
15245 Hook run in a buffer narrowed to the message that is to be deleted.
15246 This function can be used to copy the message to somewhere else, or to
15247 extract some information from it before removing it.
15248
15249 @item nnfolder-nov-is-evil
15250 @vindex nnfolder-nov-is-evil
15251 If non-@code{nil}, this back end will ignore any @acronym{NOV} files.  The
15252 default is @code{nil}.
15253
15254 @item nnfolder-nov-file-suffix
15255 @vindex nnfolder-nov-file-suffix
15256 The extension for @acronym{NOV} files.  The default is @file{.nov}.
15257
15258 @item nnfolder-nov-directory
15259 @vindex nnfolder-nov-directory
15260 The directory where the @acronym{NOV} files should be stored.  If
15261 @code{nil}, @code{nnfolder-directory} is used.
15262
15263 @item nnfolder-marks-is-evil
15264 @vindex nnfolder-marks-is-evil
15265 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
15266 default is @code{nil}.
15267
15268 @item nnfolder-marks-file-suffix
15269 @vindex nnfolder-marks-file-suffix
15270 The extension for @sc{marks} files.  The default is @file{.mrk}.
15271
15272 @item nnfolder-marks-directory
15273 @vindex nnfolder-marks-directory
15274 The directory where the @sc{marks} files should be stored.  If
15275 @code{nil}, @code{nnfolder-directory} is used.
15276
15277 @end table
15278
15279
15280 @findex nnfolder-generate-active-file
15281 @kindex M-x nnfolder-generate-active-file
15282 If you have lots of @code{nnfolder}-like files you'd like to read with
15283 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
15284 command to make @code{nnfolder} aware of all likely files in
15285 @code{nnfolder-directory}.  This only works if you use long file names,
15286 though.
15287
15288 @node Comparing Mail Back Ends
15289 @subsubsection Comparing Mail Back Ends
15290
15291 First, just for terminology, the @dfn{back end} is the common word for a
15292 low-level access method---a transport, if you will, by which something
15293 is acquired.  The sense is that one's mail has to come from somewhere,
15294 and so selection of a suitable back end is required in order to get that
15295 mail within spitting distance of Gnus.
15296
15297 The same concept exists for Usenet itself: Though access to articles is
15298 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
15299 in the world got at Usenet by running a reader on the machine where the
15300 articles lay (the machine which today we call an @acronym{NNTP} server), and
15301 access was by the reader stepping into the articles' directory spool
15302 area directly.  One can still select between either the @code{nntp} or
15303 @code{nnspool} back ends, to select between these methods, if one happens
15304 actually to live on the server (or can see its spool directly, anyway,
15305 via NFS).
15306
15307 The goal in selecting a mail back end is to pick one which
15308 simultaneously represents a suitable way of dealing with the original
15309 format plus leaving mail in a form that is convenient to use in the
15310 future.  Here are some high and low points on each:
15311
15312 @table @code
15313 @item nnmbox
15314
15315 UNIX systems have historically had a single, very common, and well-
15316 defined format.  All messages arrive in a single @dfn{spool file}, and
15317 they are delineated by a line whose regular expression matches
15318 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
15319 to make it clear in this instance that this is not the RFC-specified
15320 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
15321 historically from the Unix environment, it is simplest if one does not
15322 mess a great deal with the original mailbox format, so if one chooses
15323 this back end, Gnus' primary activity in getting mail from the real spool
15324 area to Gnus' preferred directory is simply to copy it, with no
15325 (appreciable) format change in the process.  It is the ``dumbest'' way
15326 to move mail into availability in the Gnus environment.  This makes it
15327 fast to move into place, but slow to parse, when Gnus has to look at
15328 what's where.
15329
15330 @item nnbabyl
15331
15332 Once upon a time, there was the DEC-10 and DEC-20, running operating
15333 systems called TOPS and related things, and the usual (only?) mail
15334 reading environment was a thing called Babyl.  I don't know what format
15335 was used for mail landing on the system, but Babyl had its own internal
15336 format to which mail was converted, primarily involving creating a
15337 spool-file-like entity with a scheme for inserting Babyl-specific
15338 headers and status bits above the top of each message in the file.
15339 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
15340 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
15341 to understand the mail files folks already had in existence.  Gnus (and
15342 VM, for that matter) continue to support this format because it's
15343 perceived as having some good qualities in those mailer-specific
15344 headers/status bits stuff.  Rmail itself still exists as well, of
15345 course, and is still maintained by Stallman.
15346
15347 Both of the above forms leave your mail in a single file on your
15348 file system, and they must parse that entire file each time you take a
15349 look at your mail.
15350
15351 @item nnml
15352
15353 @code{nnml} is the back end which smells the most as though you were
15354 actually operating with an @code{nnspool}-accessed Usenet system.  (In
15355 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
15356 lo these years ago.)  One's mail is taken from the original spool file,
15357 and is then cut up into individual message files, 1:1.  It maintains a
15358 Usenet-style active file (analogous to what one finds in an INN- or
15359 CNews-based news system in (for instance) @file{/var/lib/news/active},
15360 or what is returned via the @samp{NNTP LIST} verb) and also creates
15361 @dfn{overview} files for efficient group entry, as has been defined for
15362 @acronym{NNTP} servers for some years now.  It is slower in mail-splitting,
15363 due to the creation of lots of files, updates to the @code{nnml} active
15364 file, and additions to overview files on a per-message basis, but it is
15365 extremely fast on access because of what amounts to the indexing support
15366 provided by the active file and overviews.
15367
15368 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
15369 resource which defines available places in the file system to put new
15370 files.  Sysadmins take a dim view of heavy inode occupation within
15371 tight, shared file systems.  But if you live on a personal machine where
15372 the file system is your own and space is not at a premium, @code{nnml}
15373 wins big.
15374
15375 It is also problematic using this back end if you are living in a
15376 FAT16-based Windows world, since much space will be wasted on all these
15377 tiny files.
15378
15379 @item nnmh
15380
15381 The Rand MH mail-reading system has been around UNIX systems for a very
15382 long time; it operates by splitting one's spool file of messages into
15383 individual files, but with little or no indexing support---@code{nnmh}
15384 is considered to be semantically equivalent to ``@code{nnml} without
15385 active file or overviews''.  This is arguably the worst choice, because
15386 one gets the slowness of individual file creation married to the
15387 slowness of access parsing when learning what's new in one's groups.
15388
15389 @item nnfolder
15390
15391 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
15392 method described above) on a per-group basis.  That is, @code{nnmbox}
15393 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
15394 little bit of optimization to this so that each of one's mail groups has
15395 a Unix mail box file.  It's faster than @code{nnmbox} because each group
15396 can be parsed separately, and still provides the simple Unix mail box
15397 format requiring minimal effort in moving the mail around.  In addition,
15398 it maintains an ``active'' file making it much faster for Gnus to figure
15399 out how many messages there are in each separate group.
15400
15401 If you have groups that are expected to have a massive amount of
15402 messages, @code{nnfolder} is not the best choice, but if you receive
15403 only a moderate amount of mail, @code{nnfolder} is probably the most
15404 friendly mail back end all over.
15405
15406 @item nnmaildir
15407
15408 For configuring expiry and other things, @code{nnmaildir} uses
15409 incompatible group parameters, slightly different from those of other
15410 mail back ends.
15411
15412 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
15413 differences.  Each message is stored in a separate file, but the
15414 filename is unrelated to the article number in Gnus.  @code{nnmaildir}
15415 also stores the equivalent of @code{nnml}'s overview files in one file
15416 per article, so it uses about twice as many inodes as @code{nnml}.  (Use
15417 @code{df -i} to see how plentiful your inode supply is.)  If this slows
15418 you down or takes up very much space, consider switching to
15419 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
15420 file system.
15421
15422 Since maildirs don't require locking for delivery, the maildirs you use
15423 as groups can also be the maildirs your mail is directly delivered to.
15424 This means you can skip Gnus' mail splitting if your mail is already
15425 organized into different mailboxes during delivery.  A @code{directory}
15426 entry in @code{mail-sources} would have a similar effect, but would
15427 require one set of mailboxes for spooling deliveries (in mbox format,
15428 thus damaging message bodies), and another set to be used as groups (in
15429 whatever format you like).  A maildir has a built-in spool, in the
15430 @code{new/} subdirectory.  Beware that currently, mail moved from
15431 @code{new/} to @code{cur/} instead of via mail splitting will not
15432 undergo treatment such as duplicate checking.
15433
15434 @code{nnmaildir} stores article marks for a given group in the
15435 corresponding maildir, in a way designed so that it's easy to manipulate
15436 them from outside Gnus.  You can tar up a maildir, unpack it somewhere
15437 else, and still have your marks.  @code{nnml} also stores marks, but
15438 it's not as easy to work with them from outside Gnus as with
15439 @code{nnmaildir}.
15440
15441 @code{nnmaildir} uses a significant amount of memory to speed things up.
15442 (It keeps in memory some of the things that @code{nnml} stores in files
15443 and that @code{nnmh} repeatedly parses out of message files.)  If this
15444 is a problem for you, you can set the @code{nov-cache-size} group
15445 parameter to something small (0 would probably not work, but 1 probably
15446 would) to make it use less memory.  This caching will probably be
15447 removed in the future.
15448
15449 Startup is likely to be slower with @code{nnmaildir} than with other
15450 back ends.  Everything else is likely to be faster, depending in part
15451 on your file system.
15452
15453 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
15454 to write an @code{nnmaildir}-derived back end.
15455
15456 @end table
15457
15458
15459 @node Browsing the Web
15460 @section Browsing the Web
15461 @cindex web
15462 @cindex browsing the web
15463 @cindex www
15464 @cindex http
15465
15466 Web-based discussion forums are getting more and more popular.  On many
15467 subjects, the web-based forums have become the most important forums,
15468 eclipsing the importance of mailing lists and news groups.  The reason
15469 is easy to understand---they are friendly to new users; you just point
15470 and click, and there's the discussion.  With mailing lists, you have to
15471 go through a cumbersome subscription procedure, and most people don't
15472 even know what a news group is.
15473
15474 The problem with this scenario is that web browsers are not very good at
15475 being newsreaders.  They do not keep track of what articles you've read;
15476 they do not allow you to score on subjects you're interested in; they do
15477 not allow off-line browsing; they require you to click around and drive
15478 you mad in the end.
15479
15480 So---if web browsers suck at reading discussion forums, why not use Gnus
15481 to do it instead?
15482
15483 Gnus has been getting a bit of a collection of back ends for providing
15484 interfaces to these sources.
15485
15486 @menu
15487 * Archiving Mail::
15488 * Web Searches::                Creating groups from articles that match a string.
15489 * Slashdot::                    Reading the Slashdot comments.
15490 * Ultimate::                    The Ultimate Bulletin Board systems.
15491 * Web Archive::                 Reading mailing list archived on web.
15492 * RSS::                         Reading RDF site summary.
15493 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
15494 @end menu
15495
15496 All the web sources require Emacs/w3 and the url library to work.
15497
15498 The main caveat with all these web sources is that they probably won't
15499 work for a very long time.  Gleaning information from the @acronym{HTML} data
15500 is guesswork at best, and when the layout is altered, the Gnus back end
15501 will fail.  If you have reasonably new versions of these back ends,
15502 though, you should be ok.
15503
15504 One thing all these Web methods have in common is that the Web sources
15505 are often down, unavailable or just plain too slow to be fun.  In those
15506 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
15507 Unplugged}) handle downloading articles, and then you can read them at
15508 leisure from your local disk.  No more World Wide Wait for you.
15509
15510 @node Archiving Mail
15511 @subsection Archiving Mail
15512 @cindex archiving mail
15513 @cindex backup of mail
15514
15515 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
15516 @code{nnmaildir}, now actually store the article marks with each group.
15517 For these servers, archiving and restoring a group while preserving
15518 marks is fairly simple.
15519
15520 (Preserving the group level and group parameters as well still
15521 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
15522 though.)
15523
15524 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
15525 server, take a recursive copy of the server directory.  There is no need
15526 to shut down Gnus, so archiving may be invoked by @code{cron} or
15527 similar.  You restore the data by restoring the directory tree, and
15528 adding a server definition pointing to that directory in Gnus.  The
15529 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
15530 might interfere with overwriting data, so you may want to shut down Gnus
15531 before you restore the data.
15532
15533 It is also possible to archive individual @code{nnml},
15534 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
15535 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
15536 directory.  For @code{nnfolder} you need to copy both the base folder
15537 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
15538 this example).  Restoring the group is done with @kbd{G m} from the Group
15539 buffer.  The last step makes Gnus notice the new directory.
15540 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
15541 is unnecessary in that case.
15542
15543 @node Web Searches
15544 @subsection Web Searches
15545 @cindex nnweb
15546 @cindex Google
15547 @cindex dejanews
15548 @cindex gmane
15549 @cindex Usenet searches
15550 @cindex searching the Usenet
15551
15552 It's, like, too neat to search the Usenet for articles that match a
15553 string, but it, like, totally @emph{sucks}, like, totally, to use one of
15554 those, like, Web browsers, and you, like, have to, rilly, like, look at
15555 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
15556 searches without having to use a browser.
15557
15558 The @code{nnweb} back end allows an easy interface to the mighty search
15559 engine.  You create an @code{nnweb} group, enter a search pattern, and
15560 then enter the group and read the articles like you would any normal
15561 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
15562 Groups}) will do this in an easy-to-use fashion.
15563
15564 @code{nnweb} groups don't really lend themselves to being solid
15565 groups---they have a very fleeting idea of article numbers.  In fact,
15566 each time you enter an @code{nnweb} group (not even changing the search
15567 pattern), you are likely to get the articles ordered in a different
15568 manner.  Not even using duplicate suppression (@pxref{Duplicate
15569 Suppression}) will help, since @code{nnweb} doesn't even know the
15570 @code{Message-ID} of the articles before reading them using some search
15571 engines (Google, for instance).  The only possible way to keep track
15572 of which articles you've read is by scoring on the @code{Date}
15573 header---mark all articles posted before the last date you read the
15574 group as read.
15575
15576 If the search engine changes its output substantially, @code{nnweb}
15577 won't be able to parse it and will fail.  One could hardly fault the Web
15578 providers if they were to do this---their @emph{raison d'être} is to
15579 make money off of advertisements, not to provide services to the
15580 community.  Since @code{nnweb} washes the ads off all the articles, one
15581 might think that the providers might be somewhat miffed.  We'll see.
15582
15583 You must have the @code{url} and @code{w3} package installed to be able
15584 to use @code{nnweb}.
15585
15586 Virtual server variables:
15587
15588 @table @code
15589 @item nnweb-type
15590 @vindex nnweb-type
15591 What search engine type is being used.  The currently supported types
15592 are @code{google}, @code{dejanews}, and @code{gmane}.  Note that
15593 @code{dejanews} is an alias to @code{google}.
15594
15595 @item nnweb-search
15596 @vindex nnweb-search
15597 The search string to feed to the search engine.
15598
15599 @item nnweb-max-hits
15600 @vindex nnweb-max-hits
15601 Advisory maximum number of hits per search to display.  The default is
15602 999.
15603
15604 @item nnweb-type-definition
15605 @vindex nnweb-type-definition
15606 Type-to-definition alist.  This alist says what @code{nnweb} should do
15607 with the various search engine types.  The following elements must be
15608 present:
15609
15610 @table @code
15611 @item article
15612 Function to decode the article and provide something that Gnus
15613 understands.
15614
15615 @item map
15616 Function to create an article number to message header and URL alist.
15617
15618 @item search
15619 Function to send the search string to the search engine.
15620
15621 @item address
15622 The address the aforementioned function should send the search string
15623 to.
15624
15625 @item id
15626 Format string URL to fetch an article by @code{Message-ID}.
15627 @end table
15628
15629 @end table
15630
15631
15632 @node Slashdot
15633 @subsection Slashdot
15634 @cindex Slashdot
15635 @cindex nnslashdot
15636
15637 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
15638 lively discussion following the news articles.  @code{nnslashdot} will
15639 let you read this forum in a convenient manner.
15640
15641 The easiest way to read this source is to put something like the
15642 following in your @file{~/.gnus.el} file:
15643
15644 @lisp
15645 (setq gnus-secondary-select-methods
15646       '((nnslashdot "")))
15647 @end lisp
15648
15649 This will make Gnus query the @code{nnslashdot} back end for new comments
15650 and groups.  The @kbd{F} command will subscribe each new news article as
15651 a new Gnus group, and you can read the comments by entering these
15652 groups.  (Note that the default subscription method is to subscribe new
15653 groups as zombies.  Other methods are available (@pxref{Subscription
15654 Methods}).
15655
15656 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
15657 command is the most handy tool (@pxref{Foreign Groups}).
15658
15659 When following up to @code{nnslashdot} comments (or posting new
15660 comments), some light @acronym{HTML}izations will be performed.  In
15661 particular, text quoted with @samp{> } will be quoted with
15662 @samp{blockquote} instead, and signatures will have @samp{br} added to
15663 the end of each line.  Other than that, you can just write @acronym{HTML}
15664 directly into the message buffer.  Note that Slashdot filters out some
15665 @acronym{HTML} forms.
15666
15667 The following variables can be altered to change its behavior:
15668
15669 @table @code
15670 @item nnslashdot-threaded
15671 Whether @code{nnslashdot} should display threaded groups or not.  The
15672 default is @code{t}.  To be able to display threads, @code{nnslashdot}
15673 has to retrieve absolutely all comments in a group upon entry.  If a
15674 threaded display is not required, @code{nnslashdot} will only retrieve
15675 the comments that are actually wanted by the user.  Threading is nicer,
15676 but much, much slower than unthreaded.
15677
15678 @item nnslashdot-login-name
15679 @vindex nnslashdot-login-name
15680 The login name to use when posting.
15681
15682 @item nnslashdot-password
15683 @vindex nnslashdot-password
15684 The password to use when posting.
15685
15686 @item nnslashdot-directory
15687 @vindex nnslashdot-directory
15688 Where @code{nnslashdot} will store its files.  The default is
15689 @file{~/News/slashdot/}.
15690
15691 @item nnslashdot-active-url
15692 @vindex nnslashdot-active-url
15693 The @acronym{URL} format string that will be used to fetch the
15694 information on news articles and comments.  The default is@*
15695 @samp{http://slashdot.org/search.pl?section=&min=%d}.
15696
15697 @item nnslashdot-comments-url
15698 @vindex nnslashdot-comments-url
15699 The @acronym{URL} format string that will be used to fetch comments.
15700
15701 @item nnslashdot-article-url
15702 @vindex nnslashdot-article-url
15703 The @acronym{URL} format string that will be used to fetch the news
15704 article.  The default is
15705 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
15706
15707 @item nnslashdot-threshold
15708 @vindex nnslashdot-threshold
15709 The score threshold.  The default is -1.
15710
15711 @item nnslashdot-group-number
15712 @vindex nnslashdot-group-number
15713 The number of old groups, in addition to the ten latest, to keep
15714 updated.  The default is 0.
15715
15716 @end table
15717
15718
15719
15720 @node Ultimate
15721 @subsection Ultimate
15722 @cindex nnultimate
15723 @cindex Ultimate Bulletin Board
15724
15725 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
15726 probably the most popular Web bulletin board system used.  It has a
15727 quite regular and nice interface, and it's possible to get the
15728 information Gnus needs to keep groups updated.
15729
15730 The easiest way to get started with @code{nnultimate} is to say
15731 something like the following in the group buffer:  @kbd{B nnultimate RET
15732 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @acronym{URL}
15733 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
15734 you're interested in; there's quite a list of them on the Ultimate web
15735 site.)  Then subscribe to the groups you're interested in from the
15736 server buffer, and read them from the group buffer.
15737
15738 The following @code{nnultimate} variables can be altered:
15739
15740 @table @code
15741 @item nnultimate-directory
15742 @vindex nnultimate-directory
15743 The directory where @code{nnultimate} stores its files.  The default is@*
15744 @file{~/News/ultimate/}.
15745 @end table
15746
15747
15748 @node Web Archive
15749 @subsection Web Archive
15750 @cindex nnwarchive
15751 @cindex Web Archive
15752
15753 Some mailing lists only have archives on Web servers, such as
15754 @uref{http://www.egroups.com/} and
15755 @uref{http://www.mail-archive.com/}.  It has a quite regular and nice
15756 interface, and it's possible to get the information Gnus needs to keep
15757 groups updated.
15758
15759 @findex gnus-group-make-warchive-group
15760 The easiest way to get started with @code{nnwarchive} is to say
15761 something like the following in the group buffer: @kbd{M-x
15762 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
15763 www.egroups.com RET @var{your@@email.address} RET}.  (Substitute the
15764 @var{an_egroup} with the mailing list you subscribed, the
15765 @var{your@@email.address} with your email address.), or to browse the
15766 back end by @kbd{B nnwarchive RET mail-archive RET}.
15767
15768 The following @code{nnwarchive} variables can be altered:
15769
15770 @table @code
15771 @item nnwarchive-directory
15772 @vindex nnwarchive-directory
15773 The directory where @code{nnwarchive} stores its files.  The default is@*
15774 @file{~/News/warchive/}.
15775
15776 @item nnwarchive-login
15777 @vindex nnwarchive-login
15778 The account name on the web server.
15779
15780 @item nnwarchive-passwd
15781 @vindex nnwarchive-passwd
15782 The password for your account on the web server.
15783 @end table
15784
15785 @node RSS
15786 @subsection RSS
15787 @cindex nnrss
15788 @cindex RSS
15789
15790 Some web sites have an RDF Site Summary (@acronym{RSS}).
15791 @acronym{RSS} is a format for summarizing headlines from news related
15792 sites (such as BBC or CNN).  But basically anything list-like can be
15793 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
15794 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
15795
15796 @acronym{RSS} has a quite regular and nice interface, and it's
15797 possible to get the information Gnus needs to keep groups updated.
15798
15799 @kindex G R (Summary)
15800 Use @kbd{G R} from the summary buffer to subscribe to a feed---you
15801 will be prompted for the location of the feed.
15802
15803 An easy way to get started with @code{nnrss} is to say something like
15804 the following in the group buffer: @kbd{B nnrss RET y}, then
15805 subscribe to groups.
15806
15807 The following @code{nnrss} variables can be altered:
15808
15809 @table @code
15810 @item nnrss-directory
15811 @vindex nnrss-directory
15812 The directory where @code{nnrss} stores its files.  The default is
15813 @file{~/News/rss/}.
15814
15815 @item nnrss-use-local
15816 @vindex nnrss-use-local
15817 @findex nnrss-generate-download-script
15818 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
15819 the feeds from local files in @code{nnrss-directory}.  You can use
15820 the command @code{nnrss-generate-download-script} to generate a
15821 download script using @command{wget}.
15822 @end table
15823
15824 The following code may be helpful, if you want to show the description in
15825 the summary buffer.
15826
15827 @lisp
15828 (add-to-list 'nnmail-extra-headers nnrss-description-field)
15829 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
15830
15831 (defun gnus-user-format-function-X (header)
15832   (let ((descr
15833          (assq nnrss-description-field (mail-header-extra header))))
15834     (if descr (concat "\n\t" (cdr descr)) "")))
15835 @end lisp
15836
15837 The following code may be useful to open an nnrss url directly from the
15838 summary buffer.
15839 @lisp
15840 (require 'browse-url)
15841
15842 (defun browse-nnrss-url( arg )
15843   (interactive "p")
15844   (let ((url (assq nnrss-url-field
15845                    (mail-header-extra
15846                     (gnus-data-header
15847                      (assq (gnus-summary-article-number)
15848                            gnus-newsgroup-data))))))
15849     (if url
15850         (progn
15851           (browse-url (cdr url))
15852           (gnus-summary-mark-as-read-forward 1))
15853       (gnus-summary-scroll-up arg))))
15854
15855 (eval-after-load "gnus"
15856   #'(define-key gnus-summary-mode-map
15857       (kbd "<RET>") 'browse-nnrss-url))
15858 (add-to-list 'nnmail-extra-headers nnrss-url-field)
15859 @end lisp
15860
15861 @node Customizing w3
15862 @subsection Customizing w3
15863 @cindex w3
15864 @cindex html
15865 @cindex url
15866 @cindex Netscape
15867
15868 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
15869 pages.  Emacs/w3 is documented in its own manual, but there are some
15870 things that may be more relevant for Gnus users.
15871
15872 For instance, a common question is how to make Emacs/w3 follow links
15873 using the @code{browse-url} functions (which will call some external web
15874 browser like Netscape).  Here's one way:
15875
15876 @lisp
15877 (eval-after-load "w3"
15878   '(progn
15879     (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
15880     (defun w3-fetch (&optional url target)
15881       (interactive (list (w3-read-url-with-default)))
15882       (if (eq major-mode 'gnus-article-mode)
15883           (browse-url url)
15884         (w3-fetch-orig url target)))))
15885 @end lisp
15886
15887 Put that in your @file{.emacs} file, and hitting links in w3-rendered
15888 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
15889 follow the link.
15890
15891
15892 @node IMAP
15893 @section IMAP
15894 @cindex nnimap
15895 @cindex @acronym{IMAP}
15896
15897 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
15898 think of it as a modernized @acronym{NNTP}.  Connecting to a @acronym{IMAP}
15899 server is much similar to connecting to a news server, you just
15900 specify the network address of the server.
15901
15902 @acronym{IMAP} has two properties.  First, @acronym{IMAP} can do
15903 everything that @acronym{POP} can, it can hence be viewed as a
15904 @acronym{POP++}.  Secondly, @acronym{IMAP} is a mail storage protocol,
15905 similar to @acronym{NNTP} being a news storage protocol---however,
15906 @acronym{IMAP} offers more features than @acronym{NNTP} because news
15907 is more or less read-only whereas mail is read-write.
15908
15909 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
15910 entry in @code{mail-sources}.  With this, Gnus will fetch mails from
15911 the @acronym{IMAP} server and store them on the local disk.  This is
15912 not the usage described in this section---@xref{Mail Sources}.
15913
15914 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
15915 entry in @code{gnus-secondary-select-methods}.  With this, Gnus will
15916 manipulate mails stored on the @acronym{IMAP} server.  This is the kind of
15917 usage explained in this section.
15918
15919 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
15920 servers might look something like the following.  (Note that for
15921 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
15922 see below.)
15923
15924 @lisp
15925 (setq gnus-secondary-select-methods
15926       '((nnimap "simpleserver") ; @r{no special configuration}
15927         ; @r{perhaps a ssh port forwarded server:}
15928         (nnimap "dolk"
15929                 (nnimap-address "localhost")
15930                 (nnimap-server-port 1430))
15931         ; @r{a UW server running on localhost}
15932         (nnimap "barbar"
15933                 (nnimap-server-port 143)
15934                 (nnimap-address "localhost")
15935                 (nnimap-list-pattern ("INBOX" "mail/*")))
15936         ; @r{anonymous public cyrus server:}
15937         (nnimap "cyrus.andrew.cmu.edu"
15938                 (nnimap-authenticator anonymous)
15939                 (nnimap-list-pattern "archive.*")
15940                 (nnimap-stream network))
15941         ; @r{a ssl server on a non-standard port:}
15942         (nnimap "vic20"
15943                 (nnimap-address "vic20.somewhere.com")
15944                 (nnimap-server-port 9930)
15945                 (nnimap-stream ssl))))
15946 @end lisp
15947
15948 After defining the new server, you can subscribe to groups on the
15949 server using normal Gnus commands such as @kbd{U} in the Group Buffer
15950 (@pxref{Subscription Commands}) or via the Server Buffer
15951 (@pxref{Server Buffer}).
15952
15953 The following variables can be used to create a virtual @code{nnimap}
15954 server:
15955
15956 @table @code
15957
15958 @item nnimap-address
15959 @vindex nnimap-address
15960
15961 The address of the remote @acronym{IMAP} server.  Defaults to the virtual
15962 server name if not specified.
15963
15964 @item nnimap-server-port
15965 @vindex nnimap-server-port
15966 Port on server to contact.  Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
15967
15968 Note that this should be an integer, example server specification:
15969
15970 @lisp
15971 (nnimap "mail.server.com"
15972         (nnimap-server-port 4711))
15973 @end lisp
15974
15975 @item nnimap-list-pattern
15976 @vindex nnimap-list-pattern
15977 String or list of strings of mailboxes to limit available groups to.
15978 This is used when the server has very many mailboxes and you're only
15979 interested in a few---some servers export your home directory via
15980 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
15981 @file{~/Mail/*} then.
15982
15983 The string can also be a cons of REFERENCE and the string as above, what
15984 REFERENCE is used for is server specific, but on the University of
15985 Washington server it's a directory that will be concatenated with the
15986 mailbox.
15987
15988 Example server specification:
15989
15990 @lisp
15991 (nnimap "mail.server.com"
15992         (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
15993                                ("~friend/Mail/" . "list/*"))))
15994 @end lisp
15995
15996 @item nnimap-stream
15997 @vindex nnimap-stream
15998 The type of stream used to connect to your server.  By default, nnimap
15999 will detect and automatically use all of the below, with the exception
16000 of @acronym{TLS}/@acronym{SSL}.  (@acronym{IMAP} over
16001 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
16002 be automatically detected, but it's not widely deployed yet.)
16003
16004 Example server specification:
16005
16006 @lisp
16007 (nnimap "mail.server.com"
16008         (nnimap-stream ssl))
16009 @end lisp
16010
16011 Please note that the value of @code{nnimap-stream} is a symbol!
16012
16013 @itemize @bullet
16014 @item
16015 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5).  Requires the
16016 @samp{gsasl} or @samp{imtest} program.
16017 @item
16018 @dfn{kerberos4:} Connect with Kerberos 4.  Requires the @samp{imtest} program.
16019 @item
16020 @dfn{starttls:} Connect via the STARTTLS extension (similar to
16021 @acronym{TLS}/@acronym{SSL}).  Requires the external library @samp{starttls.el} and program
16022 @samp{starttls}.
16023 @item
16024 @dfn{tls:} Connect through @acronym{TLS}.  Requires GNUTLS (the program
16025 @samp{gnutls-cli}).
16026 @item
16027 @dfn{ssl:} Connect through @acronym{SSL}.  Requires OpenSSL (the program
16028 @samp{openssl}) or SSLeay (@samp{s_client}).
16029 @item
16030 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
16031 @item
16032 @dfn{network:} Plain, TCP/IP network connection.
16033 @end itemize
16034
16035 @vindex imap-kerberos4-program
16036 The @samp{imtest} program is shipped with Cyrus IMAPD.  If you're
16037 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
16038 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
16039 to make @code{imap.el} use a pty instead of a pipe when communicating
16040 with @samp{imtest}.  You will then suffer from a line length
16041 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
16042 indefinitely if you have many articles in a mailbox.  The variable
16043 @code{imap-kerberos4-program} contain parameters to pass to the imtest
16044 program.
16045
16046 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
16047 needed.  It is available from
16048 @uref{http://www.gnu.org/software/gnutls/}.
16049
16050 @vindex imap-gssapi-program
16051 This parameter specifies a list of command lines that invoke a GSSAPI
16052 authenticated @acronym{IMAP} stream in a subshell.  They are tried
16053 sequentially until a connection is made, or the list has been
16054 exhausted.  By default, @samp{gsasl} from GNU SASL, available from
16055 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
16056 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
16057 tried.
16058
16059 @vindex imap-ssl-program
16060 For @acronym{SSL} connections, the OpenSSL program is available from
16061 @uref{http://www.openssl.org/}.  OpenSSL was formerly known as SSLeay,
16062 and nnimap support it too---although the most recent versions of
16063 SSLeay, 0.9.x, are known to have serious bugs making it
16064 useless.  Earlier versions, especially 0.8.x, of SSLeay are known to
16065 work.  The variable @code{imap-ssl-program} contain parameters to pass
16066 to OpenSSL/SSLeay.
16067
16068 @vindex imap-shell-program
16069 @vindex imap-shell-host
16070 For @acronym{IMAP} connections using the @code{shell} stream, the variable
16071 @code{imap-shell-program} specify what program to call.
16072
16073 @item nnimap-authenticator
16074 @vindex nnimap-authenticator
16075
16076 The authenticator used to connect to the server.  By default, nnimap
16077 will use the most secure authenticator your server is capable of.
16078
16079 Example server specification:
16080
16081 @lisp
16082 (nnimap "mail.server.com"
16083         (nnimap-authenticator anonymous))
16084 @end lisp
16085
16086 Please note that the value of @code{nnimap-authenticator} is a symbol!
16087
16088 @itemize @bullet
16089 @item
16090 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication.  Requires
16091 external program @code{gsasl} or @code{imtest}.
16092 @item
16093 @dfn{kerberos4:} Kerberos 4 authentication.  Requires external program
16094 @code{imtest}.
16095 @item
16096 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5.  Requires
16097 external library @code{digest-md5.el}.
16098 @item
16099 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
16100 @item
16101 @dfn{login:} Plain-text username/password via LOGIN.
16102 @item
16103 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
16104 @end itemize
16105
16106 @item nnimap-expunge-on-close
16107 @cindex expunging
16108 @vindex nnimap-expunge-on-close
16109 Unlike Parmenides the @acronym{IMAP} designers have decided things that
16110 don't exist actually do exist.  More specifically, @acronym{IMAP} has
16111 this concept of marking articles @code{Deleted} which doesn't actually
16112 delete them, and this (marking them @code{Deleted}, that is) is what
16113 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
16114 similar).
16115
16116 Since the articles aren't really removed when we mark them with the
16117 @code{Deleted} flag we'll need a way to actually delete them.  Feel like
16118 running in circles yet?
16119
16120 Traditionally, nnimap has removed all articles marked as @code{Deleted}
16121 when closing a mailbox but this is now configurable by this server
16122 variable.
16123
16124 The possible options are:
16125
16126 @table @code
16127
16128 @item always
16129 The default behavior, delete all articles marked as ``Deleted'' when
16130 closing a mailbox.
16131 @item never
16132 Never actually delete articles.  Currently there is no way of showing
16133 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
16134 may allow you to do this.  If you ever want to run the EXPUNGE command
16135 manually, @xref{Expunging mailboxes}.
16136 @item ask
16137 When closing mailboxes, nnimap will ask if you wish to expunge deleted
16138 articles or not.
16139
16140 @end table
16141
16142 @item nnimap-importantize-dormant
16143 @vindex nnimap-importantize-dormant
16144
16145 If non-@code{nil} (the default), marks dormant articles as ticked (as
16146 well), for other @acronym{IMAP} clients.  Within Gnus, dormant articles will
16147 naturally still (only) be marked as dormant.  This is to make dormant
16148 articles stand out, just like ticked articles, in other @acronym{IMAP}
16149 clients.  (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
16150 has only one.)
16151
16152 Probably the only reason for frobing this would be if you're trying
16153 enable per-user persistent dormant flags, using something like:
16154
16155 @lisp
16156 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
16157         (format "gnus-dormant-%s" (user-login-name)))
16158 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
16159         (format "KEYWORD gnus-dormant-%s" (user-login-name)))
16160 @end lisp
16161
16162 In this case, you would not want the per-user dormant flag showing up
16163 as ticked for other users.
16164
16165 @item nnimap-expunge-search-string
16166 @cindex expunging
16167 @vindex nnimap-expunge-search-string
16168
16169 This variable contain the @acronym{IMAP} search command sent to server when
16170 searching for articles eligible for expiring.  The default is
16171 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
16172 UID set and the second @code{%s} is replaced by a date.
16173
16174 Probably the only useful value to change this to is
16175 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
16176 messages instead of the internal article date.  See section 6.4.4 of
16177 RFC 2060 for more information on valid strings.
16178
16179 @item nnimap-authinfo-file
16180 @vindex nnimap-authinfo-file
16181
16182 A file containing credentials used to log in on servers.  The format is
16183 (almost) the same as the @code{ftp} @file{~/.netrc} file.  See the
16184 variable @code{nntp-authinfo-file} for exact syntax; also see
16185 @ref{NNTP}.
16186
16187 @item nnimap-need-unselect-to-notice-new-mail
16188 @vindex nnimap-need-unselect-to-notice-new-mail
16189
16190 Unselect mailboxes before looking for new mail in them.  Some servers
16191 seem to need this under some circumstances; it was reported that
16192 Courier 1.7.1 did.
16193
16194 @end table
16195
16196 @menu
16197 * Splitting in IMAP::           Splitting mail with nnimap.
16198 * Expiring in IMAP::            Expiring mail with nnimap.
16199 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
16200 * Expunging mailboxes::         Equivalent of a ``compress mailbox'' button.
16201 * A note on namespaces::        How to (not) use @acronym{IMAP} namespace in Gnus.
16202 * Debugging IMAP::              What to do when things don't work.
16203 @end menu
16204
16205
16206
16207 @node Splitting in IMAP
16208 @subsection Splitting in IMAP
16209 @cindex splitting imap mail
16210
16211 Splitting is something Gnus users have loved and used for years, and now
16212 the rest of the world is catching up.  Yeah, dream on, not many
16213 @acronym{IMAP} servers have server side splitting and those that have
16214 splitting seem to use some non-standard protocol.  This means that
16215 @acronym{IMAP} support for Gnus has to do its own splitting.
16216
16217 And it does.
16218
16219 (Incidentally, people seem to have been dreaming on, and Sieve has
16220 gaining a market share and is supported by several IMAP servers.
16221 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
16222
16223 Here are the variables of interest:
16224
16225 @table @code
16226
16227 @item nnimap-split-crosspost
16228 @cindex splitting, crosspost
16229 @cindex crosspost
16230 @vindex nnimap-split-crosspost
16231
16232 If non-@code{nil}, do crossposting if several split methods match the
16233 mail.  If @code{nil}, the first match in @code{nnimap-split-rule}
16234 found will be used.
16235
16236 Nnmail equivalent: @code{nnmail-crosspost}.
16237
16238 @item nnimap-split-inbox
16239 @cindex splitting, inbox
16240 @cindex inbox
16241 @vindex nnimap-split-inbox
16242
16243 A string or a list of strings that gives the name(s) of @acronym{IMAP}
16244 mailboxes to split from.  Defaults to @code{nil}, which means that
16245 splitting is disabled!
16246
16247 @lisp
16248 (setq nnimap-split-inbox
16249       '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
16250 @end lisp
16251
16252 No nnmail equivalent.
16253
16254 @item nnimap-split-rule
16255 @cindex splitting, rules
16256 @vindex nnimap-split-rule
16257
16258 New mail found in @code{nnimap-split-inbox} will be split according to
16259 this variable.
16260
16261 This variable contains a list of lists, where the first element in the
16262 sublist gives the name of the @acronym{IMAP} mailbox to move articles
16263 matching the regexp in the second element in the sublist.  Got that?
16264 Neither did I, we need examples.
16265
16266 @lisp
16267 (setq nnimap-split-rule
16268       '(("INBOX.nnimap"
16269          "^Sender: owner-nnimap@@vic20.globalcom.se")
16270         ("INBOX.junk"    "^Subject:.*MAKE MONEY")
16271         ("INBOX.private" "")))
16272 @end lisp
16273
16274 This will put all articles from the nnimap mailing list into mailbox
16275 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
16276 into INBOX.junk and everything else in INBOX.private.
16277
16278 The first string may contain @samp{\\1} forms, like the ones used by
16279 replace-match to insert sub-expressions from the matched text.  For
16280 instance:
16281
16282 @lisp
16283 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
16284 @end lisp
16285
16286 The first element can also be the symbol @code{junk} to indicate that
16287 matching messages should simply be deleted.  Use with care.
16288
16289 The second element can also be a function.  In that case, it will be
16290 called with the first element of the rule as the argument, in a buffer
16291 containing the headers of the article.  It should return a
16292 non-@code{nil} value if it thinks that the mail belongs in that group.
16293
16294 Nnmail users might recollect that the last regexp had to be empty to
16295 match all articles (like in the example above).  This is not required in
16296 nnimap.  Articles not matching any of the regexps will not be moved out
16297 of your inbox.  (This might affect performance if you keep lots of
16298 unread articles in your inbox, since the splitting code would go over
16299 them every time you fetch new mail.)
16300
16301 These rules are processed from the beginning of the alist toward the
16302 end.  The first rule to make a match will ``win'', unless you have
16303 crossposting enabled.  In that case, all matching rules will ``win''.
16304
16305 This variable can also have a function as its value, the function will
16306 be called with the headers narrowed and should return a group where it
16307 thinks the article should be split to.  See @code{nnimap-split-fancy}.
16308
16309 The splitting code tries to create mailboxes if it needs to.
16310
16311 To allow for different split rules on different virtual servers, and
16312 even different split rules in different inboxes on the same server,
16313 the syntax of this variable have been extended along the lines of:
16314
16315 @lisp
16316 (setq nnimap-split-rule
16317       '(("my1server"    (".*" (("ding"    "ding@@gnus.org")
16318                                ("junk"    "From:.*Simon"))))
16319         ("my2server"    ("INBOX" nnimap-split-fancy))
16320         ("my[34]server" (".*" (("private" "To:.*Simon")
16321                                ("junk"    my-junk-func))))))
16322 @end lisp
16323
16324 The virtual server name is in fact a regexp, so that the same rules
16325 may apply to several servers.  In the example, the servers
16326 @code{my3server} and @code{my4server} both use the same rules.
16327 Similarly, the inbox string is also a regexp.  The actual splitting
16328 rules are as before, either a function, or a list with group/regexp or
16329 group/function elements.
16330
16331 Nnmail equivalent: @code{nnmail-split-methods}.
16332
16333 @item nnimap-split-predicate
16334 @cindex splitting
16335 @vindex nnimap-split-predicate
16336
16337 Mail matching this predicate in @code{nnimap-split-inbox} will be
16338 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
16339
16340 This might be useful if you use another @acronym{IMAP} client to read mail in
16341 your inbox but would like Gnus to split all articles in the inbox
16342 regardless of readedness.  Then you might change this to
16343 @samp{UNDELETED}.
16344
16345 @item nnimap-split-fancy
16346 @cindex splitting, fancy
16347 @findex nnimap-split-fancy
16348 @vindex nnimap-split-fancy
16349
16350 It's possible to set @code{nnimap-split-rule} to
16351 @code{nnmail-split-fancy} if you want to use fancy
16352 splitting.  @xref{Fancy Mail Splitting}.
16353
16354 However, to be able to have different fancy split rules for nnmail and
16355 nnimap back ends you can set @code{nnimap-split-rule} to
16356 @code{nnimap-split-fancy} and define the nnimap specific fancy split
16357 rule in @code{nnimap-split-fancy}.
16358
16359 Example:
16360
16361 @lisp
16362 (setq nnimap-split-rule 'nnimap-split-fancy
16363       nnimap-split-fancy ...)
16364 @end lisp
16365
16366 Nnmail equivalent: @code{nnmail-split-fancy}.
16367
16368 @item nnimap-split-download-body
16369 @findex nnimap-split-download-body
16370 @vindex nnimap-split-download-body
16371
16372 Set to non-@code{nil} to download entire articles during splitting.
16373 This is generally not required, and will slow things down
16374 considerably.  You may need it if you want to use an advanced
16375 splitting function that analyses the body to split the article.
16376
16377 @end table
16378
16379 @node Expiring in IMAP
16380 @subsection Expiring in IMAP
16381 @cindex expiring imap mail
16382
16383 Even though @code{nnimap} is not a proper @code{nnmail} derived back
16384 end, it supports most features in regular expiring (@pxref{Expiring
16385 Mail}).  Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
16386 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
16387 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables.  What
16388 follows below are the variables used by the @code{nnimap} expiry
16389 process.
16390
16391 A note on how the expire mark is stored on the @acronym{IMAP} server is
16392 appropriate here as well.  The expire mark is translated into a
16393 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
16394 message.  This means that likely only Gnus will understand and treat
16395 the @code{gnus-expire} mark properly, although other clients may allow
16396 you to view client specific flags on the message.  It also means that
16397 your server must support permanent storage of client specific flags on
16398 messages.  Most do, fortunately.
16399
16400 @table @code
16401
16402 @item nnmail-expiry-wait
16403 @item nnmail-expiry-wait-function
16404
16405 These variables are fully supported.  The expire value can be a
16406 number, the symbol @code{immediate} or @code{never}.
16407
16408 @item nnmail-expiry-target
16409
16410 This variable is supported, and internally implemented by calling the
16411 @code{nnmail} functions that handle this.  It contains an optimization
16412 that if the destination is a @acronym{IMAP} group on the same server, the
16413 article is copied instead of appended (that is, uploaded again).
16414
16415 @end table
16416
16417 @node Editing IMAP ACLs
16418 @subsection Editing IMAP ACLs
16419 @cindex editing imap acls
16420 @cindex Access Control Lists
16421 @cindex Editing @acronym{IMAP} ACLs
16422 @kindex G l (Group)
16423 @findex gnus-group-nnimap-edit-acl
16424
16425 ACL stands for Access Control List.  ACLs are used in @acronym{IMAP} for
16426 limiting (or enabling) other users access to your mail boxes.  Not all
16427 @acronym{IMAP} servers support this, this function will give an error if it
16428 doesn't.
16429
16430 To edit an ACL for a mailbox, type @kbd{G l}
16431 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
16432 editing window with detailed instructions.
16433
16434 Some possible uses:
16435
16436 @itemize @bullet
16437 @item
16438 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
16439 on your mailing list mailboxes enables other users on the same server to
16440 follow the list without subscribing to it.
16441 @item
16442 At least with the Cyrus server, you are required to give the user
16443 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
16444 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
16445 INBOX.mailbox).
16446 @end itemize
16447
16448 @node Expunging mailboxes
16449 @subsection Expunging mailboxes
16450 @cindex expunging
16451
16452 @cindex expunge
16453 @cindex manual expunging
16454 @kindex G x (Group)
16455 @findex gnus-group-nnimap-expunge
16456
16457 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
16458 you may want the option of expunging all deleted articles in a mailbox
16459 manually.  This is exactly what @kbd{G x} does.
16460
16461 Currently there is no way of showing deleted articles, you can just
16462 delete them.
16463
16464 @node A note on namespaces
16465 @subsection A note on namespaces
16466 @cindex IMAP namespace
16467 @cindex namespaces
16468
16469 The @acronym{IMAP} protocol has a concept called namespaces, described
16470 by the following text in the RFC:
16471
16472 @display
16473 5.1.2.  Mailbox Namespace Naming Convention
16474
16475    By convention, the first hierarchical element of any mailbox name
16476    which begins with "#" identifies the "namespace" of the remainder of
16477    the name.  This makes it possible to disambiguate between different
16478    types of mailbox stores, each of which have their own namespaces.
16479
16480       For example, implementations which offer access to USENET
16481       newsgroups MAY use the "#news" namespace to partition the USENET
16482       newsgroup namespace from that of other mailboxes.  Thus, the
16483       comp.mail.misc newsgroup would have an mailbox name of
16484       "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
16485       to a different object (e.g. a user's private mailbox).
16486 @end display
16487
16488 While there is nothing in this text that warrants concern for the
16489 @acronym{IMAP} implementation in Gnus, some servers use namespace
16490 prefixes in a way that does not work with how Gnus uses mailbox names.
16491
16492 Specifically, University of Washington's @acronym{IMAP} server uses
16493 mailbox names like @code{#driver.mbx/read-mail} which are valid only
16494 in the @sc{create} and @sc{append} commands.  After the mailbox is
16495 created (or a messages is appended to a mailbox), it must be accessed
16496 without the namespace prefix, i.e. @code{read-mail}.  Since Gnus do
16497 not make it possible for the user to guarantee that user entered
16498 mailbox names will only be used with the CREATE and APPEND commands,
16499 you should simply not use the namespace prefixed mailbox names in
16500 Gnus.
16501
16502 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
16503 for more information on how to use the prefixes.  They are a power
16504 tool and should be used only if you are sure what the effects are.
16505
16506 @node Debugging IMAP
16507 @subsection Debugging IMAP
16508 @cindex IMAP debugging
16509 @cindex protocol dump (IMAP)
16510
16511 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
16512 @acronym{POP3}.  Implementation bugs are not unlikely, and we do our
16513 best to fix them right away.  If you encounter odd behaviour, chances
16514 are that either the server or Gnus is buggy.
16515
16516 If you are familiar with network protocols in general, you will
16517 probably be able to extract some clues from the protocol dump of the
16518 exchanges between Gnus and the server.  Even if you are not familiar
16519 with network protocols, when you include the protocol dump in
16520 @acronym{IMAP}-related bug reports you are helping us with data
16521 critical to solving the problem.  Therefore, we strongly encourage you
16522 to include the protocol dump when reporting IMAP bugs in Gnus.
16523
16524
16525 @vindex imap-log
16526 Because the protocol dump, when enabled, generates lots of data, it is
16527 disabled by default.  You can enable it by setting @code{imap-log} as
16528 follows: 
16529
16530 @lisp
16531 (setq imap-log t)
16532 @end lisp
16533
16534 This instructs the @code{imap.el} package to log any exchanges with
16535 the server.  The log is stored in the buffer @samp{*imap-log*}.  Look
16536 for error messages, which sometimes are tagged with the keyword
16537 @code{BAD}---but when submitting a bug, make sure to include all the
16538 data.
16539
16540 @node Other Sources
16541 @section Other Sources
16542
16543 Gnus can do more than just read news or mail.  The methods described
16544 below allow Gnus to view directories and files as if they were
16545 newsgroups.
16546
16547 @menu
16548 * Directory Groups::            You can read a directory as if it was a newsgroup.
16549 * Anything Groups::             Dired?  Who needs dired?
16550 * Document Groups::             Single files can be the basis of a group.
16551 * SOUP::                        Reading @sc{soup} packets ``offline''.
16552 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
16553 @end menu
16554
16555
16556 @node Directory Groups
16557 @subsection Directory Groups
16558 @cindex nndir
16559 @cindex directory groups
16560
16561 If you have a directory that has lots of articles in separate files in
16562 it, you might treat it as a newsgroup.  The files have to have numerical
16563 names, of course.
16564
16565 This might be an opportune moment to mention @code{ange-ftp} (and its
16566 successor @code{efs}), that most wonderful of all wonderful Emacs
16567 packages.  When I wrote @code{nndir}, I didn't think much about it---a
16568 back end to read directories.  Big deal.
16569
16570 @code{ange-ftp} changes that picture dramatically.  For instance, if you
16571 enter the @code{ange-ftp} file name
16572 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
16573 @code{ange-ftp} or @code{efs} will actually allow you to read this
16574 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
16575
16576 @code{nndir} will use @acronym{NOV} files if they are present.
16577
16578 @code{nndir} is a ``read-only'' back end---you can't delete or expire
16579 articles with this method.  You can use @code{nnmh} or @code{nnml} for
16580 whatever you use @code{nndir} for, so you could switch to any of those
16581 methods if you feel the need to have a non-read-only @code{nndir}.
16582
16583
16584 @node Anything Groups
16585 @subsection Anything Groups
16586 @cindex nneething
16587
16588 From the @code{nndir} back end (which reads a single spool-like
16589 directory), it's just a hop and a skip to @code{nneething}, which
16590 pretends that any arbitrary directory is a newsgroup.  Strange, but
16591 true.
16592
16593 When @code{nneething} is presented with a directory, it will scan this
16594 directory and assign article numbers to each file.  When you enter such
16595 a group, @code{nneething} must create ``headers'' that Gnus can use.
16596 After all, Gnus is a newsreader, in case you're forgetting.
16597 @code{nneething} does this in a two-step process.  First, it snoops each
16598 file in question.  If the file looks like an article (i.e., the first
16599 few lines look like headers), it will use this as the head.  If this is
16600 just some arbitrary file without a head (e.g. a C source file),
16601 @code{nneething} will cobble up a header out of thin air.  It will use
16602 file ownership, name and date and do whatever it can with these
16603 elements.
16604
16605 All this should happen automatically for you, and you will be presented
16606 with something that looks very much like a newsgroup.  Totally like a
16607 newsgroup, to be precise.  If you select an article, it will be displayed
16608 in the article buffer, just as usual.
16609
16610 If you select a line that represents a directory, Gnus will pop you into
16611 a new summary buffer for this @code{nneething} group.  And so on.  You can
16612 traverse the entire disk this way, if you feel like, but remember that
16613 Gnus is not dired, really, and does not intend to be, either.
16614
16615 There are two overall modes to this action---ephemeral or solid.  When
16616 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
16617 will not store information on what files you have read, and what files
16618 are new, and so on.  If you create a solid @code{nneething} group the
16619 normal way with @kbd{G m}, Gnus will store a mapping table between
16620 article numbers and file names, and you can treat this group like any
16621 other groups.  When you activate a solid @code{nneething} group, you will
16622 be told how many unread articles it contains, etc., etc.
16623
16624 Some variables:
16625
16626 @table @code
16627 @item nneething-map-file-directory
16628 @vindex nneething-map-file-directory
16629 All the mapping files for solid @code{nneething} groups will be stored
16630 in this directory, which defaults to @file{~/.nneething/}.
16631
16632 @item nneething-exclude-files
16633 @vindex nneething-exclude-files
16634 All files that match this regexp will be ignored.  Nice to use to exclude
16635 auto-save files and the like, which is what it does by default.
16636
16637 @item nneething-include-files
16638 @vindex nneething-include-files
16639 Regexp saying what files to include in the group.  If this variable is
16640 non-@code{nil}, only files matching this regexp will be included.
16641
16642 @item nneething-map-file
16643 @vindex nneething-map-file
16644 Name of the map files.
16645 @end table
16646
16647
16648 @node Document Groups
16649 @subsection Document Groups
16650 @cindex nndoc
16651 @cindex documentation group
16652 @cindex help group
16653
16654 @code{nndoc} is a cute little thing that will let you read a single file
16655 as a newsgroup.  Several files types are supported:
16656
16657 @table @code
16658 @cindex Babyl
16659 @cindex Rmail mbox
16660
16661 @item babyl
16662 The Babyl (Rmail) mail box.
16663 @cindex mbox
16664 @cindex Unix mbox
16665
16666 @item mbox
16667 The standard Unix mbox file.
16668
16669 @cindex MMDF mail box
16670 @item mmdf
16671 The MMDF mail box format.
16672
16673 @item news
16674 Several news articles appended into a file.
16675
16676 @item rnews
16677 @cindex rnews batch files
16678 The rnews batch transport format.
16679 @cindex forwarded messages
16680
16681 @item forward
16682 Forwarded articles.
16683
16684 @item nsmail
16685 Netscape mail boxes.
16686
16687 @item mime-parts
16688 @acronym{MIME} multipart messages.
16689
16690 @item standard-digest
16691 The standard (RFC 1153) digest format.
16692
16693 @item mime-digest
16694 A @acronym{MIME} digest of messages.
16695
16696 @item lanl-gov-announce
16697 Announcement messages from LANL Gov Announce.
16698
16699 @item rfc822-forward
16700 A message forwarded according to RFC822.
16701
16702 @item outlook
16703 The Outlook mail box.
16704
16705 @item oe-dbx
16706 The Outlook Express dbx mail box.
16707
16708 @item exim-bounce
16709 A bounce message from the Exim MTA.
16710
16711 @item forward
16712 A message forwarded according to informal rules.
16713
16714 @item rfc934
16715 An RFC934-forwarded message.
16716
16717 @item mailman
16718 A mailman digest.
16719
16720 @item clari-briefs
16721 A digest of Clarinet brief news items.
16722
16723 @item slack-digest
16724 Non-standard digest format---matches most things, but does it badly.
16725
16726 @item mail-in-mail
16727 The last resort.
16728 @end table
16729
16730 You can also use the special ``file type'' @code{guess}, which means
16731 that @code{nndoc} will try to guess what file type it is looking at.
16732 @code{digest} means that @code{nndoc} should guess what digest type the
16733 file is.
16734
16735 @code{nndoc} will not try to change the file or insert any extra headers into
16736 it---it will simply, like, let you use the file as the basis for a
16737 group.  And that's it.
16738
16739 If you have some old archived articles that you want to insert into your
16740 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
16741 that.  Say you have an old @file{RMAIL} file with mail that you now want
16742 to split into your new @code{nnml} groups.  You look at that file using
16743 @code{nndoc} (using the @kbd{G f} command in the group buffer
16744 (@pxref{Foreign Groups})), set the process mark on all the articles in
16745 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
16746 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
16747 file is now also stored in lots of @code{nnml} directories, and you can
16748 delete that pesky @file{RMAIL} file.  If you have the guts!
16749
16750 Virtual server variables:
16751
16752 @table @code
16753 @item nndoc-article-type
16754 @vindex nndoc-article-type
16755 This should be one of @code{mbox}, @code{babyl}, @code{digest},
16756 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
16757 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
16758 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
16759 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
16760
16761 @item nndoc-post-type
16762 @vindex nndoc-post-type
16763 This variable says whether Gnus is to consider the group a news group or
16764 a mail group.  There are two valid values:  @code{mail} (the default)
16765 and @code{news}.
16766 @end table
16767
16768 @menu
16769 * Document Server Internals::   How to add your own document types.
16770 @end menu
16771
16772
16773 @node Document Server Internals
16774 @subsubsection Document Server Internals
16775
16776 Adding new document types to be recognized by @code{nndoc} isn't
16777 difficult.  You just have to whip up a definition of what the document
16778 looks like, write a predicate function to recognize that document type,
16779 and then hook into @code{nndoc}.
16780
16781 First, here's an example document type definition:
16782
16783 @example
16784 (mmdf
16785  (article-begin .  "^\^A\^A\^A\^A\n")
16786  (body-end .  "^\^A\^A\^A\^A\n"))
16787 @end example
16788
16789 The definition is simply a unique @dfn{name} followed by a series of
16790 regexp pseudo-variable settings.  Below are the possible
16791 variables---don't be daunted by the number of variables; most document
16792 types can be defined with very few settings:
16793
16794 @table @code
16795 @item first-article
16796 If present, @code{nndoc} will skip past all text until it finds
16797 something that match this regexp.  All text before this will be
16798 totally ignored.
16799
16800 @item article-begin
16801 This setting has to be present in all document type definitions.  It
16802 says what the beginning of each article looks like.
16803
16804 @item head-begin-function
16805 If present, this should be a function that moves point to the head of
16806 the article.
16807
16808 @item nndoc-head-begin
16809 If present, this should be a regexp that matches the head of the
16810 article.
16811
16812 @item nndoc-head-end
16813 This should match the end of the head of the article.  It defaults to
16814 @samp{^$}---the empty line.
16815
16816 @item body-begin-function
16817 If present, this function should move point to the beginning of the body
16818 of the article.
16819
16820 @item body-begin
16821 This should match the beginning of the body of the article.  It defaults
16822 to @samp{^\n}.
16823
16824 @item body-end-function
16825 If present, this function should move point to the end of the body of
16826 the article.
16827
16828 @item body-end
16829 If present, this should match the end of the body of the article.
16830
16831 @item file-end
16832 If present, this should match the end of the file.  All text after this
16833 regexp will be totally ignored.
16834
16835 @end table
16836
16837 So, using these variables @code{nndoc} is able to dissect a document
16838 file into a series of articles, each with a head and a body.  However, a
16839 few more variables are needed since not all document types are all that
16840 news-like---variables needed to transform the head or the body into
16841 something that's palatable for Gnus:
16842
16843 @table @code
16844 @item prepare-body-function
16845 If present, this function will be called when requesting an article.  It
16846 will be called with point at the start of the body, and is useful if the
16847 document has encoded some parts of its contents.
16848
16849 @item article-transform-function
16850 If present, this function is called when requesting an article.  It's
16851 meant to be used for more wide-ranging transformation of both head and
16852 body of the article.
16853
16854 @item generate-head-function
16855 If present, this function is called to generate a head that Gnus can
16856 understand.  It is called with the article number as a parameter, and is
16857 expected to generate a nice head for the article in question.  It is
16858 called when requesting the headers of all articles.
16859
16860 @end table
16861
16862 Let's look at the most complicated example I can come up with---standard
16863 digests:
16864
16865 @example
16866 (standard-digest
16867  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
16868  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
16869  (prepare-body-function . nndoc-unquote-dashes)
16870  (body-end-function . nndoc-digest-body-end)
16871  (head-end . "^ ?$")
16872  (body-begin . "^ ?\n")
16873  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
16874  (subtype digest guess))
16875 @end example
16876
16877 We see that all text before a 70-width line of dashes is ignored; all
16878 text after a line that starts with that @samp{^End of} is also ignored;
16879 each article begins with a 30-width line of dashes; the line separating
16880 the head from the body may contain a single space; and that the body is
16881 run through @code{nndoc-unquote-dashes} before being delivered.
16882
16883 To hook your own document definition into @code{nndoc}, use the
16884 @code{nndoc-add-type} function.  It takes two parameters---the first
16885 is the definition itself and the second (optional) parameter says
16886 where in the document type definition alist to put this definition.
16887 The alist is traversed sequentially, and
16888 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
16889 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
16890 @code{mmdf} type, and so on.  These type predicates should return
16891 @code{nil} if the document is not of the correct type; @code{t} if it
16892 is of the correct type; and a number if the document might be of the
16893 correct type.  A high number means high probability; a low number
16894 means low probability with @samp{0} being the lowest valid number.
16895
16896
16897 @node SOUP
16898 @subsection SOUP
16899 @cindex SOUP
16900 @cindex offline
16901
16902 In the PC world people often talk about ``offline'' newsreaders.  These
16903 are thingies that are combined reader/news transport monstrosities.
16904 With built-in modem programs.  Yecchh!
16905
16906 Of course, us Unix Weenie types of human beans use things like
16907 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
16908 transport things like Ghod intended.  And then we just use normal
16909 newsreaders.
16910
16911 However, it can sometimes be convenient to do something that's a bit
16912 easier on the brain if you have a very slow modem, and you're not really
16913 that interested in doing things properly.
16914
16915 A file format called @sc{soup} has been developed for transporting news
16916 and mail from servers to home machines and back again.  It can be a bit
16917 fiddly.
16918
16919 First some terminology:
16920
16921 @table @dfn
16922
16923 @item server
16924 This is the machine that is connected to the outside world and where you
16925 get news and/or mail from.
16926
16927 @item home machine
16928 This is the machine that you want to do the actual reading and responding
16929 on.  It is typically not connected to the rest of the world in any way.
16930
16931 @item packet
16932 Something that contains messages and/or commands.  There are two kinds
16933 of packets:
16934
16935 @table @dfn
16936 @item message packets
16937 These are packets made at the server, and typically contain lots of
16938 messages for you to read.  These are called @file{SoupoutX.tgz} by
16939 default, where @var{x} is a number.
16940
16941 @item response packets
16942 These are packets made at the home machine, and typically contains
16943 replies that you've written.  These are called @file{SoupinX.tgz} by
16944 default, where @var{x} is a number.
16945
16946 @end table
16947
16948 @end table
16949
16950
16951 @enumerate
16952
16953 @item
16954 You log in on the server and create a @sc{soup} packet.  You can either
16955 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
16956 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
16957 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
16958
16959 @item
16960 You transfer the packet home.  Rail, boat, car or modem will do fine.
16961
16962 @item
16963 You put the packet in your home directory.
16964
16965 @item
16966 You fire up Gnus on your home machine using the @code{nnsoup} back end as
16967 the native or secondary server.
16968
16969 @item
16970 You read articles and mail and answer and followup to the things you
16971 want (@pxref{SOUP Replies}).
16972
16973 @item
16974 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
16975 packet.
16976
16977 @item
16978 You transfer this packet to the server.
16979
16980 @item
16981 You use Gnus to mail this packet out with the @kbd{G s s} command.
16982
16983 @item
16984 You then repeat until you die.
16985
16986 @end enumerate
16987
16988 So you basically have a bipartite system---you use @code{nnsoup} for
16989 reading and Gnus for packing/sending these @sc{soup} packets.
16990
16991 @menu
16992 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
16993 * SOUP Groups::                 A back end for reading @sc{soup} packets.
16994 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
16995 @end menu
16996
16997
16998 @node SOUP Commands
16999 @subsubsection SOUP Commands
17000
17001 These are commands for creating and manipulating @sc{soup} packets.
17002
17003 @table @kbd
17004 @item G s b
17005 @kindex G s b (Group)
17006 @findex gnus-group-brew-soup
17007 Pack all unread articles in the current group
17008 (@code{gnus-group-brew-soup}).  This command understands the
17009 process/prefix convention.
17010
17011 @item G s w
17012 @kindex G s w (Group)
17013 @findex gnus-soup-save-areas
17014 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
17015
17016 @item G s s
17017 @kindex G s s (Group)
17018 @findex gnus-soup-send-replies
17019 Send all replies from the replies packet
17020 (@code{gnus-soup-send-replies}).
17021
17022 @item G s p
17023 @kindex G s p (Group)
17024 @findex gnus-soup-pack-packet
17025 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
17026
17027 @item G s r
17028 @kindex G s r (Group)
17029 @findex nnsoup-pack-replies
17030 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
17031
17032 @item O s
17033 @kindex O s (Summary)
17034 @findex gnus-soup-add-article
17035 This summary-mode command adds the current article to a @sc{soup} packet
17036 (@code{gnus-soup-add-article}).  It understands the process/prefix
17037 convention (@pxref{Process/Prefix}).
17038
17039 @end table
17040
17041
17042 There are a few variables to customize where Gnus will put all these
17043 thingies:
17044
17045 @table @code
17046
17047 @item gnus-soup-directory
17048 @vindex gnus-soup-directory
17049 Directory where Gnus will save intermediate files while composing
17050 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
17051
17052 @item gnus-soup-replies-directory
17053 @vindex gnus-soup-replies-directory
17054 This is what Gnus will use as a temporary directory while sending our
17055 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
17056
17057 @item gnus-soup-prefix-file
17058 @vindex gnus-soup-prefix-file
17059 Name of the file where Gnus stores the last used prefix.  The default is
17060 @samp{gnus-prefix}.
17061
17062 @item gnus-soup-packer
17063 @vindex gnus-soup-packer
17064 A format string command for packing a @sc{soup} packet.  The default is
17065 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
17066
17067 @item gnus-soup-unpacker
17068 @vindex gnus-soup-unpacker
17069 Format string command for unpacking a @sc{soup} packet.  The default is
17070 @samp{gunzip -c %s | tar xvf -}.
17071
17072 @item gnus-soup-packet-directory
17073 @vindex gnus-soup-packet-directory
17074 Where Gnus will look for reply packets.  The default is @file{~/}.
17075
17076 @item gnus-soup-packet-regexp
17077 @vindex gnus-soup-packet-regexp
17078 Regular expression matching @sc{soup} reply packets in
17079 @code{gnus-soup-packet-directory}.
17080
17081 @end table
17082
17083
17084 @node SOUP Groups
17085 @subsubsection SOUP Groups
17086 @cindex nnsoup
17087
17088 @code{nnsoup} is the back end for reading @sc{soup} packets.  It will
17089 read incoming packets, unpack them, and put them in a directory where
17090 you can read them at leisure.
17091
17092 These are the variables you can use to customize its behavior:
17093
17094 @table @code
17095
17096 @item nnsoup-tmp-directory
17097 @vindex nnsoup-tmp-directory
17098 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
17099 directory.  (@file{/tmp/} by default.)
17100
17101 @item nnsoup-directory
17102 @vindex nnsoup-directory
17103 @code{nnsoup} then moves each message and index file to this directory.
17104 The default is @file{~/SOUP/}.
17105
17106 @item nnsoup-replies-directory
17107 @vindex nnsoup-replies-directory
17108 All replies will be stored in this directory before being packed into a
17109 reply packet.  The default is @file{~/SOUP/replies/}.
17110
17111 @item nnsoup-replies-format-type
17112 @vindex nnsoup-replies-format-type
17113 The @sc{soup} format of the replies packets.  The default is @samp{?n}
17114 (rnews), and I don't think you should touch that variable.  I probably
17115 shouldn't even have documented it.  Drats!  Too late!
17116
17117 @item nnsoup-replies-index-type
17118 @vindex nnsoup-replies-index-type
17119 The index type of the replies packet.  The default is @samp{?n}, which
17120 means ``none''.  Don't fiddle with this one either!
17121
17122 @item nnsoup-active-file
17123 @vindex nnsoup-active-file
17124 Where @code{nnsoup} stores lots of information.  This is not an ``active
17125 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
17126 this file or mess it up in any way, you're dead.  The default is
17127 @file{~/SOUP/active}.
17128
17129 @item nnsoup-packer
17130 @vindex nnsoup-packer
17131 Format string command for packing a reply @sc{soup} packet.  The default
17132 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
17133
17134 @item nnsoup-unpacker
17135 @vindex nnsoup-unpacker
17136 Format string command for unpacking incoming @sc{soup} packets.  The
17137 default is @samp{gunzip -c %s | tar xvf -}.
17138
17139 @item nnsoup-packet-directory
17140 @vindex nnsoup-packet-directory
17141 Where @code{nnsoup} will look for incoming packets.  The default is
17142 @file{~/}.
17143
17144 @item nnsoup-packet-regexp
17145 @vindex nnsoup-packet-regexp
17146 Regular expression matching incoming @sc{soup} packets.  The default is
17147 @samp{Soupout}.
17148
17149 @item nnsoup-always-save
17150 @vindex nnsoup-always-save
17151 If non-@code{nil}, save the replies buffer after each posted message.
17152
17153 @end table
17154
17155
17156 @node SOUP Replies
17157 @subsubsection SOUP Replies
17158
17159 Just using @code{nnsoup} won't mean that your postings and mailings end
17160 up in @sc{soup} reply packets automagically.  You have to work a bit
17161 more for that to happen.
17162
17163 @findex nnsoup-set-variables
17164 The @code{nnsoup-set-variables} command will set the appropriate
17165 variables to ensure that all your followups and replies end up in the
17166 @sc{soup} system.
17167
17168 In specific, this is what it does:
17169
17170 @lisp
17171 (setq message-send-news-function 'nnsoup-request-post)
17172 (setq message-send-mail-function 'nnsoup-request-mail)
17173 @end lisp
17174
17175 And that's it, really.  If you only want news to go into the @sc{soup}
17176 system you just use the first line.  If you only want mail to be
17177 @sc{soup}ed you use the second.
17178
17179
17180 @node Mail-To-News Gateways
17181 @subsection Mail-To-News Gateways
17182 @cindex mail-to-news gateways
17183 @cindex gateways
17184
17185 If your local @code{nntp} server doesn't allow posting, for some reason
17186 or other, you can post using one of the numerous mail-to-news gateways.
17187 The @code{nngateway} back end provides the interface.
17188
17189 Note that you can't read anything from this back end---it can only be
17190 used to post with.
17191
17192 Server variables:
17193
17194 @table @code
17195 @item nngateway-address
17196 @vindex nngateway-address
17197 This is the address of the mail-to-news gateway.
17198
17199 @item nngateway-header-transformation
17200 @vindex nngateway-header-transformation
17201 News headers often have to be transformed in some odd way or other
17202 for the mail-to-news gateway to accept it.  This variable says what
17203 transformation should be called, and defaults to
17204 @code{nngateway-simple-header-transformation}.  The function is called
17205 narrowed to the headers to be transformed and with one parameter---the
17206 gateway address.
17207
17208 This default function just inserts a new @code{To} header based on the
17209 @code{Newsgroups} header and the gateway address.
17210 For instance, an article with this @code{Newsgroups} header:
17211
17212 @example
17213 Newsgroups: alt.religion.emacs
17214 @end example
17215
17216 will get this @code{To} header inserted:
17217
17218 @example
17219 To: alt-religion-emacs@@GATEWAY
17220 @end example
17221
17222 The following pre-defined functions exist:
17223
17224 @findex nngateway-simple-header-transformation
17225 @table @code
17226
17227 @item nngateway-simple-header-transformation
17228 Creates a @code{To} header that looks like
17229 @var{newsgroup}@@@code{nngateway-address}.
17230
17231 @findex nngateway-mail2news-header-transformation
17232
17233 @item nngateway-mail2news-header-transformation
17234 Creates a @code{To} header that looks like
17235 @code{nngateway-address}.
17236 @end table
17237
17238 @end table
17239
17240 Here's an example:
17241
17242 @lisp
17243 (setq gnus-post-method
17244       '(nngateway
17245         "mail2news@@replay.com"
17246         (nngateway-header-transformation
17247          nngateway-mail2news-header-transformation)))
17248 @end lisp
17249
17250 So, to use this, simply say something like:
17251
17252 @lisp
17253 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17254 @end lisp
17255
17256
17257
17258 @node Combined Groups
17259 @section Combined Groups
17260
17261 Gnus allows combining a mixture of all the other group types into bigger
17262 groups.
17263
17264 @menu
17265 * Virtual Groups::              Combining articles from many groups.
17266 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
17267 @end menu
17268
17269
17270 @node Virtual Groups
17271 @subsection Virtual Groups
17272 @cindex nnvirtual
17273 @cindex virtual groups
17274 @cindex merging groups
17275
17276 An @dfn{nnvirtual group} is really nothing more than a collection of
17277 other groups.
17278
17279 For instance, if you are tired of reading many small groups, you can
17280 put them all in one big group, and then grow tired of reading one
17281 big, unwieldy group.  The joys of computing!
17282
17283 You specify @code{nnvirtual} as the method.  The address should be a
17284 regexp to match component groups.
17285
17286 All marks in the virtual group will stick to the articles in the
17287 component groups.  So if you tick an article in a virtual group, the
17288 article will also be ticked in the component group from whence it
17289 came.  (And vice versa---marks from the component groups will also be
17290 shown in the virtual group.).  To create an empty virtual group, run
17291 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17292 and edit the method regexp with @kbd{M-e}
17293 (@code{gnus-group-edit-group-method})
17294
17295 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17296 newsgroups into one, big, happy newsgroup:
17297
17298 @lisp
17299 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17300 @end lisp
17301
17302 The component groups can be native or foreign; everything should work
17303 smoothly, but if your computer explodes, it was probably my fault.
17304
17305 Collecting the same group from several servers might actually be a good
17306 idea if users have set the Distribution header to limit distribution.
17307 If you would like to read @samp{soc.motss} both from a server in Japan
17308 and a server in Norway, you could use the following as the group regexp:
17309
17310 @example
17311 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17312 @end example
17313
17314 (Remember, though, that if you're creating the group with @kbd{G m}, you
17315 shouldn't double the backslashes, and you should leave off the quote
17316 characters at the beginning and the end of the string.)
17317
17318 This should work kinda smoothly---all articles from both groups should
17319 end up in this one, and there should be no duplicates.  Threading (and
17320 the rest) will still work as usual, but there might be problems with the
17321 sequence of articles.  Sorting on date might be an option here
17322 (@pxref{Selecting a Group}).
17323
17324 One limitation, however---all groups included in a virtual
17325 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
17326 zombie groups can't be component groups for @code{nnvirtual} groups.
17327
17328 @vindex nnvirtual-always-rescan
17329 If the @code{nnvirtual-always-rescan} is non-@code{nil},
17330 @code{nnvirtual} will always scan groups for unread articles when
17331 entering a virtual group.  If this variable is @code{nil} (which is the
17332 default) and you read articles in a component group after the virtual
17333 group has been activated, the read articles from the component group
17334 will show up when you enter the virtual group.  You'll also see this
17335 effect if you have two virtual groups that have a component group in
17336 common.  If that's the case, you should set this variable to @code{t}.
17337 Or you can just tap @code{M-g} on the virtual group every time before
17338 you enter it---it'll have much the same effect.
17339
17340 @code{nnvirtual} can have both mail and news groups as component groups.
17341 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17342 has to ask the back end of the component group the article comes from
17343 whether it is a news or mail back end.  However, when you do a @kbd{^},
17344 there is typically no sure way for the component back end to know this,
17345 and in that case @code{nnvirtual} tells Gnus that the article came from a
17346 not-news back end.  (Just to be on the safe side.)
17347
17348 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17349 line from the article you respond to in these cases.
17350
17351 @code{nnvirtual} groups do not inherit anything but articles and marks
17352 from component groups---group parameters, for instance, are not
17353 inherited.
17354
17355
17356 @node Kibozed Groups
17357 @subsection Kibozed Groups
17358 @cindex nnkiboze
17359 @cindex kibozing
17360
17361 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
17362 (parts of) the news feed''.  @code{nnkiboze} is a back end that will
17363 do this for you.  Oh joy!  Now you can grind any @acronym{NNTP} server
17364 down to a halt with useless requests!  Oh happiness!
17365
17366 @kindex G k (Group)
17367 To create a kibozed group, use the @kbd{G k} command in the group
17368 buffer.
17369
17370 The address field of the @code{nnkiboze} method is, as with
17371 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
17372 @code{nnkiboze} group.  That's where most similarities between
17373 @code{nnkiboze} and @code{nnvirtual} end.
17374
17375 In addition to this regexp detailing component groups, an
17376 @code{nnkiboze} group must have a score file to say what articles are
17377 to be included in the group (@pxref{Scoring}).
17378
17379 @kindex M-x nnkiboze-generate-groups
17380 @findex nnkiboze-generate-groups
17381 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
17382 @code{nnkiboze} groups you want to have.  This command will take time.
17383 Lots of time.  Oodles and oodles of time.  Gnus has to fetch the
17384 headers from all the articles in all the component groups and run them
17385 through the scoring process to determine if there are any articles in
17386 the groups that are to be part of the @code{nnkiboze} groups.
17387
17388 Please limit the number of component groups by using restrictive
17389 regexps.  Otherwise your sysadmin may become annoyed with you, and the
17390 @acronym{NNTP} site may throw you off and never let you back in again.
17391 Stranger things have happened.
17392
17393 @code{nnkiboze} component groups do not have to be alive---they can be dead,
17394 and they can be foreign.  No restrictions.
17395
17396 @vindex nnkiboze-directory
17397 The generation of an @code{nnkiboze} group means writing two files in
17398 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
17399 One contains the @acronym{NOV} header lines for all the articles in
17400 the group, and the other is an additional @file{.newsrc} file to store
17401 information on what groups have been searched through to find
17402 component articles.
17403
17404 Articles marked as read in the @code{nnkiboze} group will have
17405 their @acronym{NOV} lines removed from the @acronym{NOV} file.
17406
17407
17408 @node Gnus Unplugged
17409 @section Gnus Unplugged
17410 @cindex offline
17411 @cindex unplugged
17412 @cindex agent
17413 @cindex Gnus agent
17414 @cindex Gnus unplugged
17415
17416 In olden times (ca. February '88), people used to run their newsreaders
17417 on big machines with permanent connections to the net.  News transport
17418 was dealt with by news servers, and all the newsreaders had to do was to
17419 read news.  Believe it or not.
17420
17421 Nowadays most people read news and mail at home, and use some sort of
17422 modem to connect to the net.  To avoid running up huge phone bills, it
17423 would be nice to have a way to slurp down all the news and mail, hang up
17424 the phone, read for several hours, and then upload any responses you
17425 have to make.  And then you repeat the procedure.
17426
17427 Of course, you can use news servers for doing this as well.  I've used
17428 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
17429 for some years, but doing that's a bore.  Moving the news server
17430 functionality up to the newsreader makes sense if you're the only person
17431 reading news on a machine.
17432
17433 Setting up Gnus as an ``offline'' newsreader is quite simple.  In
17434 fact, you don't even have to configure anything.
17435
17436 Of course, to use it as such, you have to learn a few new commands.
17437
17438 @menu
17439 * Agent Basics::                How it all is supposed to work.
17440 * Agent Categories::            How to tell the Gnus Agent what to download.
17441 * Agent Commands::              New commands for all the buffers.
17442 * Agent Visuals::               Ways that the agent may effect your summary buffer.
17443 * Agent as Cache::              The Agent is a big cache too.
17444 * Agent Expiry::                How to make old articles go away.
17445 * Agent Regeneration::          How to recover from lost connections and other accidents.
17446 * Agent and IMAP::              How to use the Agent with @acronym{IMAP}.
17447 * Outgoing Messages::           What happens when you post/mail something?
17448 * Agent Variables::             Customizing is fun.
17449 * Example Setup::               An example @file{~/.gnus.el} file for offline people.
17450 * Batching Agents::             How to fetch news from a @code{cron} job.
17451 * Agent Caveats::               What you think it'll do and what it does.
17452 @end menu
17453
17454
17455 @node Agent Basics
17456 @subsection Agent Basics
17457
17458 First, let's get some terminology out of the way.
17459
17460 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
17461 connection to the net (and notified the Agent that this is the case).
17462 When the connection to the net is up again (and Gnus knows this), the
17463 Agent is @dfn{plugged}.
17464
17465 The @dfn{local} machine is the one you're running on, and which isn't
17466 connected to the net continuously.
17467
17468 @dfn{Downloading} means fetching things from the net to your local
17469 machine.  @dfn{Uploading} is doing the opposite.
17470
17471 You know that Gnus gives you all the opportunity you'd ever want for
17472 shooting yourself in the foot.  Some people call it flexibility.  Gnus
17473 is also customizable to a great extent, which means that the user has a
17474 say on how Gnus behaves.  Other newsreaders might unconditionally shoot
17475 you in your foot, but with Gnus, you have a choice!
17476
17477 Gnus is never really in plugged or unplugged state.  Rather, it applies
17478 that state to each server individually.  This means that some servers
17479 can be plugged while others can be unplugged.  Additionally, some
17480 servers can be ignored by the Agent altogether (which means that
17481 they're kinda like plugged always).
17482
17483 So when you unplug the Agent and then wonder why is Gnus opening a
17484 connection to the Net, the next step to do is to look whether all
17485 servers are agentized.  If there is an unagentized server, you found
17486 the culprit.
17487
17488 Another thing is the @dfn{offline} state.  Sometimes, servers aren't
17489 reachable.  When Gnus notices this, it asks you whether you want the
17490 server to be switched to offline state.  If you say yes, then the
17491 server will behave somewhat as if it was unplugged, except that Gnus
17492 will ask you whether you want to switch it back online again.
17493
17494 Let's take a typical Gnus session using the Agent.
17495
17496 @itemize @bullet
17497
17498 @item
17499 @findex gnus-unplugged
17500 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
17501 Agent in a disconnected state.  You can read all the news that you have
17502 already fetched while in this mode.
17503
17504 @item
17505 You then decide to see whether any new news has arrived.  You connect
17506 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
17507 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
17508 as usual.  To check for new mail in unplugged mode (@pxref{Mail
17509 Source Specifiers}).
17510
17511 @item
17512 You can then read the new news immediately, or you can download the
17513 news onto your local machine.  If you want to do the latter, you press
17514 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
17515 all the eligible articles in all the groups.  (To let Gnus know which
17516 articles you want to download, @pxref{Agent Categories}).
17517
17518 @item
17519 After fetching the articles, you press @kbd{J j} to make Gnus become
17520 unplugged again, and you shut down the PPP thing (or whatever).  And
17521 then you read the news offline.
17522
17523 @item
17524 And then you go to step 2.
17525 @end itemize
17526
17527 Here are some things you should do the first time (or so) that you use
17528 the Agent.
17529
17530 @itemize @bullet
17531
17532 @item
17533 Decide which servers should be covered by the Agent.  If you have a mail
17534 back end, it would probably be nonsensical to have it covered by the
17535 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
17536 @kbd{J a} on the server (or servers) that you wish to have covered by the
17537 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
17538 added servers you do not wish to have covered by the Agent.  By default,
17539 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
17540 @code{gnus-secondary-select-methods} are agentized.
17541
17542 @item
17543 Decide on download policy.  It's fairly simple once you decide whether
17544 you are going to use agent categories, topic parameters, and/or group
17545 parameters to implement your policy.  If you're new to gnus, it
17546 is probably best to start with a category, @xref{Agent Categories}.
17547
17548 Both topic parameters (@pxref{Topic Parameters}) and agent categories
17549 (@pxref{Agent Categories}) provide for setting a policy that applies
17550 to multiple groups.  Which you use is entirely up to you.  Topic
17551 parameters do override categories so, if you mix the two, you'll have
17552 to take that into account.  If you have a few groups that deviate from
17553 your policy, you can use group parameters (@pxref{Group Parameters}) to
17554 configure them.
17555
17556 @item
17557 Uhm@dots{} that's it.
17558 @end itemize
17559
17560
17561 @node Agent Categories
17562 @subsection Agent Categories
17563
17564 One of the main reasons to integrate the news transport layer into the
17565 newsreader is to allow greater control over what articles to download.
17566 There's not much point in downloading huge amounts of articles, just to
17567 find out that you're not interested in reading any of them.  It's better
17568 to be somewhat more conservative in choosing what to download, and then
17569 mark the articles for downloading manually if it should turn out that
17570 you're interested in the articles anyway.
17571
17572 One of the more effective methods for controlling what is to be
17573 downloaded is to create a @dfn{category} and then assign some (or all)
17574 groups to this category.  Groups that do not belong in any other
17575 category belong to the @code{default} category.  Gnus has its own
17576 buffer for creating and managing categories.
17577
17578 If you prefer, you can also use group parameters (@pxref{Group
17579 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
17580 alternative approach to controlling the agent.  The only real
17581 difference is that categories are specific to the agent (so there is
17582 less to learn) while group and topic parameters include the kitchen
17583 sink.
17584
17585 Since you can set agent parameters in several different places we have
17586 a rule to decide which source to believe.  This rule specifies that
17587 the parameter sources are checked in the following order: group
17588 parameters, topic parameters, agent category, and finally customizable
17589 variables.  So you can mix all of these sources to produce a wide range
17590 of behavior, just don't blame me if you don't remember where you put
17591 your settings.
17592
17593 @menu
17594 * Category Syntax::             What a category looks like.
17595 * Category Buffer::             A buffer for maintaining categories.
17596 * Category Variables::          Customize'r'Us.
17597 @end menu
17598
17599
17600 @node Category Syntax
17601 @subsubsection Category Syntax
17602
17603 A category consists of a name, the list of groups belonging to the
17604 category, and a number of optional parameters that override the
17605 customizable variables.  The complete list of agent parameters are
17606 listed below.
17607
17608 @cindex Agent Parameters
17609 @table @code
17610 @item agent-cat-name
17611 The name of the category.
17612
17613 @item agent-groups
17614 The list of groups that are in this category.
17615
17616 @item agent-predicate
17617 A predicate which (generally) gives a rough outline of which articles
17618 are eligible for downloading; and
17619
17620 @item agent-score-file
17621 a score rule which (generally) gives you a finer granularity when
17622 deciding what articles to download.  (Note that this @dfn{download
17623 score} is not necessarily related to normal scores.)
17624
17625 @item agent-enable-expiration
17626 a boolean indicating whether the agent should expire old articles in
17627 this group.  Most groups should be expired to conserve disk space.  In
17628 fact, its probably safe to say that the gnus.* hierarchy contains the
17629 only groups that should not be expired.
17630
17631 @item agent-days-until-old
17632 an integer indicating the number of days that the agent should wait
17633 before deciding that a read article is safe to expire.
17634
17635 @item agent-low-score
17636 an integer that overrides the value of @code{gnus-agent-low-score}.
17637
17638 @item agent-high-score
17639 an integer that overrides the value of @code{gnus-agent-high-score}.
17640
17641 @item agent-length-when-short
17642 an integer that overrides the value of
17643 @code{gnus-agent-short-article}.
17644
17645 @item agent-length-when-long
17646 an integer that overrides the value of @code{gnus-agent-long-article}.
17647
17648 @item agent-enable-undownloaded-faces
17649 a symbol indicating whether the summary buffer should display
17650 undownloaded articles using the gnus-summary-*-undownloaded-face
17651 faces. Any symbol other than nil will enable the use of undownloaded
17652 faces.
17653 @end table
17654
17655 The name of a category can not be changed once the category has been
17656 created.
17657
17658 Each category maintains a list of groups that are exclusive members of
17659 that category.  The exclusivity rule is automatically enforced, add a
17660 group to a new category and it is automatically removed from its old
17661 category.
17662
17663 A predicate in its simplest form can be a single predicate such as
17664 @code{true} or @code{false}.  These two will download every available
17665 article or nothing respectively.  In the case of these two special
17666 predicates an additional score rule is superfluous.
17667
17668 Predicates of @code{high} or @code{low} download articles in respect of
17669 their scores in relationship to @code{gnus-agent-high-score} and
17670 @code{gnus-agent-low-score} as described below.
17671
17672 To gain even finer control of what is to be regarded eligible for
17673 download a predicate can consist of a number of predicates with logical
17674 operators sprinkled in between.
17675
17676 Perhaps some examples are in order.
17677
17678 Here's a simple predicate.  (It's the default predicate, in fact, used
17679 for all groups that don't belong to any other category.)
17680
17681 @lisp
17682 short
17683 @end lisp
17684
17685 Quite simple, eh?  This predicate is true if and only if the article is
17686 short (for some value of ``short'').
17687
17688 Here's a more complex predicate:
17689
17690 @lisp
17691 (or high
17692     (and
17693      (not low)
17694      (not long)))
17695 @end lisp
17696
17697 This means that an article should be downloaded if it has a high score,
17698 or if the score is not low and the article is not long.  You get the
17699 drift.
17700
17701 The available logical operators are @code{or}, @code{and} and
17702 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
17703 @samp{|}, @code{&} and @code{!} instead.)
17704
17705 The following predicates are pre-defined, but if none of these fit what
17706 you want to do, you can write your own.
17707
17708 When evaluating each of these predicates, the named constant will be
17709 bound to the value determined by calling
17710 @code{gnus-agent-find-parameter} on the appropriate parameter.  For
17711 example, gnus-agent-short-article will be bound to
17712 @code{(gnus-agent-find-parameter group 'agent-short-article)}.  This
17713 means that you can specify a predicate in your category then tune that
17714 predicate to individual groups.
17715
17716 @table @code
17717 @item short
17718 True iff the article is shorter than @code{gnus-agent-short-article}
17719 lines; default 100.
17720
17721 @item long
17722 True iff the article is longer than @code{gnus-agent-long-article}
17723 lines; default 200.
17724
17725 @item low
17726 True iff the article has a download score less than
17727 @code{gnus-agent-low-score}; default 0.
17728
17729 @item high
17730 True iff the article has a download score greater than
17731 @code{gnus-agent-high-score}; default 0.
17732
17733 @item spam
17734 True iff the Gnus Agent guesses that the article is spam.  The
17735 heuristics may change over time, but at present it just computes a
17736 checksum and sees whether articles match.
17737
17738 @item true
17739 Always true.
17740
17741 @item false
17742 Always false.
17743 @end table
17744
17745 If you want to create your own predicate function, here's what you have
17746 to know:  The functions are called with no parameters, but the
17747 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
17748 useful values.
17749
17750 For example, you could decide that you don't want to download articles
17751 that were posted more than a certain number of days ago (e.g. posted
17752 more than @code{gnus-agent-expire-days} ago) you might write a function
17753 something along the lines of the following:
17754
17755 @lisp
17756 (defun my-article-old-p ()
17757   "Say whether an article is old."
17758   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
17759      (- (time-to-days (current-time)) gnus-agent-expire-days)))
17760 @end lisp
17761
17762 with the predicate then defined as:
17763
17764 @lisp
17765 (not my-article-old-p)
17766 @end lisp
17767
17768 or you could append your predicate to the predefined
17769 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
17770 wherever.
17771
17772 @lisp
17773 (require 'gnus-agent)
17774 (setq  gnus-category-predicate-alist
17775   (append gnus-category-predicate-alist
17776          '((old . my-article-old-p))))
17777 @end lisp
17778
17779 and simply specify your predicate as:
17780
17781 @lisp
17782 (not old)
17783 @end lisp
17784
17785 If/when using something like the above, be aware that there are many
17786 misconfigured systems/mailers out there and so an article's date is not
17787 always a reliable indication of when it was posted.  Hell, some people
17788 just don't give a damn.
17789
17790 The above predicates apply to @emph{all} the groups which belong to the
17791 category.  However, if you wish to have a specific predicate for an
17792 individual group within a category, or you're just too lazy to set up a
17793 new category, you can enter a group's individual predicate in its group
17794 parameters like so:
17795
17796 @lisp
17797 (agent-predicate . short)
17798 @end lisp
17799
17800 This is the group/topic parameter equivalent of the agent category default.
17801 Note that when specifying a single word predicate like this, the
17802 @code{agent-predicate} specification must be in dotted pair notation.
17803
17804 The equivalent of the longer example from above would be:
17805
17806 @lisp
17807 (agent-predicate or high (and (not low) (not long)))
17808 @end lisp
17809
17810 The outer parenthesis required in the category specification are not
17811 entered here as, not being in dotted pair notation, the value of the
17812 predicate is assumed to be a list.
17813
17814
17815 Now, the syntax of the download score is the same as the syntax of
17816 normal score files, except that all elements that require actually
17817 seeing the article itself are verboten.  This means that only the
17818 following headers can be scored on: @code{Subject}, @code{From},
17819 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
17820 @code{Lines}, and @code{Xref}.
17821
17822 As with predicates, the specification of the @code{download score rule}
17823 to use in respect of a group can be in either the category definition if
17824 it's to be applicable to all groups in therein, or a group's parameters
17825 if it's to be specific to that group.
17826
17827 In both of these places the @code{download score rule} can take one of
17828 three forms:
17829
17830 @enumerate
17831 @item
17832 Score rule
17833
17834 This has the same syntax as a normal Gnus score file except only a
17835 subset of scoring keywords are available as mentioned above.
17836
17837 example:
17838
17839 @itemize @bullet
17840 @item
17841 Category specification
17842
17843 @lisp
17844 (("from"
17845        ("Lars Ingebrigtsen" 1000000 nil s))
17846 ("lines"
17847        (500 -100 nil <)))
17848 @end lisp
17849
17850 @item
17851 Group/Topic Parameter specification
17852
17853 @lisp
17854 (agent-score ("from"
17855                    ("Lars Ingebrigtsen" 1000000 nil s))
17856              ("lines"
17857                    (500 -100 nil <)))
17858 @end lisp
17859
17860 Again, note the omission of the outermost parenthesis here.
17861 @end itemize
17862
17863 @item
17864 Agent score file
17865
17866 These score files must @emph{only} contain the permitted scoring
17867 keywords stated above.
17868
17869 example:
17870
17871 @itemize @bullet
17872 @item
17873 Category specification
17874
17875 @lisp
17876 ("~/News/agent.SCORE")
17877 @end lisp
17878
17879 or perhaps
17880
17881 @lisp
17882 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
17883 @end lisp
17884
17885 @item
17886 Group Parameter specification
17887
17888 @lisp
17889 (agent-score "~/News/agent.SCORE")
17890 @end lisp
17891
17892 Additional score files can be specified as above.  Need I say anything
17893 about parenthesis?
17894 @end itemize
17895
17896 @item
17897 Use @code{normal} score files
17898
17899 If you don't want to maintain two sets of scoring rules for a group, and
17900 your desired @code{downloading} criteria for a group are the same as your
17901 @code{reading} criteria then you can tell the agent to refer to your
17902 @code{normal} score files when deciding what to download.
17903
17904 These directives in either the category definition or a group's
17905 parameters will cause the agent to read in all the applicable score
17906 files for a group, @emph{filtering out} those sections that do not
17907 relate to one of the permitted subset of scoring keywords.
17908
17909 @itemize @bullet
17910 @item
17911 Category Specification
17912
17913 @lisp
17914 file
17915 @end lisp
17916
17917 @item
17918 Group Parameter specification
17919
17920 @lisp
17921 (agent-score . file)
17922 @end lisp
17923 @end itemize
17924 @end enumerate
17925
17926 @node Category Buffer
17927 @subsubsection Category Buffer
17928
17929 You'd normally do all category maintenance from the category buffer.
17930 When you enter it for the first time (with the @kbd{J c} command from
17931 the group buffer), you'll only see the @code{default} category.
17932
17933 The following commands are available in this buffer:
17934
17935 @table @kbd
17936 @item q
17937 @kindex q (Category)
17938 @findex gnus-category-exit
17939 Return to the group buffer (@code{gnus-category-exit}).
17940
17941 @item e
17942 @kindex e (Category)
17943 @findex gnus-category-customize-category
17944 Use a customization buffer to set all of the selected category's
17945 parameters at one time (@code{gnus-category-customize-category}).
17946
17947 @item k
17948 @kindex k (Category)
17949 @findex gnus-category-kill
17950 Kill the current category (@code{gnus-category-kill}).
17951
17952 @item c
17953 @kindex c (Category)
17954 @findex gnus-category-copy
17955 Copy the current category (@code{gnus-category-copy}).
17956
17957 @item a
17958 @kindex a (Category)
17959 @findex gnus-category-add
17960 Add a new category (@code{gnus-category-add}).
17961
17962 @item p
17963 @kindex p (Category)
17964 @findex gnus-category-edit-predicate
17965 Edit the predicate of the current category
17966 (@code{gnus-category-edit-predicate}).
17967
17968 @item g
17969 @kindex g (Category)
17970 @findex gnus-category-edit-groups
17971 Edit the list of groups belonging to the current category
17972 (@code{gnus-category-edit-groups}).
17973
17974 @item s
17975 @kindex s (Category)
17976 @findex gnus-category-edit-score
17977 Edit the download score rule of the current category
17978 (@code{gnus-category-edit-score}).
17979
17980 @item l
17981 @kindex l (Category)
17982 @findex gnus-category-list
17983 List all the categories (@code{gnus-category-list}).
17984 @end table
17985
17986
17987 @node Category Variables
17988 @subsubsection Category Variables
17989
17990 @table @code
17991 @item gnus-category-mode-hook
17992 @vindex gnus-category-mode-hook
17993 Hook run in category buffers.
17994
17995 @item gnus-category-line-format
17996 @vindex gnus-category-line-format
17997 Format of the lines in the category buffer (@pxref{Formatting
17998 Variables}).  Valid elements are:
17999
18000 @table @samp
18001 @item c
18002 The name of the category.
18003
18004 @item g
18005 The number of groups in the category.
18006 @end table
18007
18008 @item gnus-category-mode-line-format
18009 @vindex gnus-category-mode-line-format
18010 Format of the category mode line (@pxref{Mode Line Formatting}).
18011
18012 @item gnus-agent-short-article
18013 @vindex gnus-agent-short-article
18014 Articles that have fewer lines than this are short.  Default 100.
18015
18016 @item gnus-agent-long-article
18017 @vindex gnus-agent-long-article
18018 Articles that have more lines than this are long.  Default 200.
18019
18020 @item gnus-agent-low-score
18021 @vindex gnus-agent-low-score
18022 Articles that have a score lower than this have a low score.  Default
18023 0.
18024
18025 @item gnus-agent-high-score
18026 @vindex gnus-agent-high-score
18027 Articles that have a score higher than this have a high score.  Default
18028 0.
18029
18030 @item gnus-agent-expire-days
18031 @vindex gnus-agent-expire-days
18032 The number of days that a @samp{read} article must stay in the agent's
18033 local disk before becoming eligible for expiration (While the name is
18034 the same, this doesn't mean expiring the article on the server.  It
18035 just means deleting the local copy of the article).  What is also
18036 important to understand is that the counter starts with the time the
18037 article was written to the local disk and not the time the article was
18038 read.
18039 Default 7.
18040
18041 @item gnus-agent-enable-expiration
18042 @vindex gnus-agent-enable-expiration
18043 Determines whether articles in a group are, by default, expired or
18044 retained indefinitely.  The default is @code{ENABLE} which means that
18045 you'll have to disable expiration when desired.  On the other hand,
18046 you could set this to @code{DISABLE}.  In that case, you would then
18047 have to enable expiration in selected groups.
18048
18049 @end table
18050
18051
18052 @node Agent Commands
18053 @subsection Agent Commands
18054 @findex gnus-agent-toggle-plugged
18055 @kindex J j (Agent)
18056
18057 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
18058 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18059 toggles the plugged/unplugged state of the Gnus Agent.
18060
18061
18062 @menu
18063 * Group Agent Commands::        Configure groups and fetch their contents.
18064 * Summary Agent Commands::      Manually select then fetch specific articles.
18065 * Server Agent Commands::       Select the servers that are supported by the agent.
18066 @end menu
18067
18068
18069
18070
18071 @node Group Agent Commands
18072 @subsubsection Group Agent Commands
18073
18074 @table @kbd
18075 @item J u
18076 @kindex J u (Agent Group)
18077 @findex gnus-agent-fetch-groups
18078 Fetch all eligible articles in the current group
18079 (@code{gnus-agent-fetch-groups}).
18080
18081 @item J c
18082 @kindex J c (Agent Group)
18083 @findex gnus-enter-category-buffer
18084 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18085
18086 @item J s
18087 @kindex J s (Agent Group)
18088 @findex gnus-agent-fetch-session
18089 Fetch all eligible articles in all groups
18090 (@code{gnus-agent-fetch-session}).
18091
18092 @item J S
18093 @kindex J S (Agent Group)
18094 @findex gnus-group-send-queue
18095 Send all sendable messages in the queue group
18096 (@code{gnus-group-send-queue}).  @xref{Drafts}.
18097
18098 @item J a
18099 @kindex J a (Agent Group)
18100 @findex gnus-agent-add-group
18101 Add the current group to an Agent category
18102 (@code{gnus-agent-add-group}).  This command understands the
18103 process/prefix convention (@pxref{Process/Prefix}).
18104
18105 @item J r
18106 @kindex J r (Agent Group)
18107 @findex gnus-agent-remove-group
18108 Remove the current group from its category, if any
18109 (@code{gnus-agent-remove-group}).  This command understands the
18110 process/prefix convention (@pxref{Process/Prefix}).
18111
18112 @item J Y
18113 @kindex J Y (Agent Group)
18114 @findex gnus-agent-synchronize-flags
18115 Synchronize flags changed while unplugged with remote server, if any.
18116
18117
18118 @end table
18119
18120
18121 @node Summary Agent Commands
18122 @subsubsection Summary Agent Commands
18123
18124 @table @kbd
18125 @item J #
18126 @kindex J # (Agent Summary)
18127 @findex gnus-agent-mark-article
18128 Mark the article for downloading (@code{gnus-agent-mark-article}).
18129
18130 @item J M-#
18131 @kindex J M-# (Agent Summary)
18132 @findex gnus-agent-unmark-article
18133 Remove the downloading mark from the article
18134 (@code{gnus-agent-unmark-article}).
18135
18136 @cindex %
18137 @item @@
18138 @kindex @@ (Agent Summary)
18139 @findex gnus-agent-toggle-mark
18140 Toggle whether to download the article
18141 (@code{gnus-agent-toggle-mark}).  The download mark is @samp{%} by
18142 default.
18143
18144 @item J c
18145 @kindex J c (Agent Summary)
18146 @findex gnus-agent-catchup
18147 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18148
18149 @item J S
18150 @kindex J S (Agent Summary)
18151 @findex gnus-agent-fetch-group
18152 Download all eligible (@pxref{Agent Categories}) articles in this group.
18153 (@code{gnus-agent-fetch-group}).
18154
18155 @item J s
18156 @kindex J s (Agent Summary)
18157 @findex gnus-agent-fetch-series
18158 Download all processable articles in this group.
18159 (@code{gnus-agent-fetch-series}).
18160
18161 @item J u
18162 @kindex J u (Agent Summary)
18163 @findex gnus-agent-summary-fetch-group
18164 Download all downloadable articles in the current group
18165 (@code{gnus-agent-summary-fetch-group}).
18166
18167 @end table
18168
18169
18170 @node Server Agent Commands
18171 @subsubsection Server Agent Commands
18172
18173 @table @kbd
18174 @item J a
18175 @kindex J a (Agent Server)
18176 @findex gnus-agent-add-server
18177 Add the current server to the list of servers covered by the Gnus Agent
18178 (@code{gnus-agent-add-server}).
18179
18180 @item J r
18181 @kindex J r (Agent Server)
18182 @findex gnus-agent-remove-server
18183 Remove the current server from the list of servers covered by the Gnus
18184 Agent (@code{gnus-agent-remove-server}).
18185
18186 @end table
18187
18188
18189 @node Agent Visuals
18190 @subsection Agent Visuals
18191
18192 If you open a summary while unplugged and, Gnus knows from the group's
18193 active range that there are more articles than the headers currently
18194 stored in the Agent, you may see some articles whose subject looks
18195 something like @samp{[Undownloaded article #####]}.  These are
18196 placeholders for the missing headers.  Aside from setting a mark,
18197 there is not much that can be done with one of these placeholders.
18198 When Gnus finally gets a chance to fetch the group's headers, the
18199 placeholders will automatically be replaced by the actual headers.
18200 You can configure the summary buffer's maneuvering to skip over the
18201 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18202
18203 While it may be obvious to all, the only headers and articles
18204 available while unplugged are those headers and articles that were
18205 fetched into the Agent while previously plugged.  To put it another
18206 way, "If you forget to fetch something while plugged, you might have a
18207 less than satisfying unplugged session".  For this reason, the Agent
18208 adds two visual effects to your summary buffer.  These effects display
18209 the download status of each article so that you always know which
18210 articles will be available when unplugged.
18211
18212 The first visual effect is the @samp{%O} spec.  If you customize
18213 @code{gnus-summary-line-format} to include this specifier, you will add
18214 a single character field that indicates an article's download status.
18215 Articles that have been fetched into either the Agent or the Cache,
18216 will display @code{gnus-downloaded-mark} (defaults to @samp{+}).  All
18217 other articles will display @code{gnus-undownloaded-mark} (defaults to
18218 @samp{-}).  If you open a group that has not been agentized, a space
18219 (@samp{ }) will be displayed.
18220
18221 The second visual effect are the undownloaded faces.  The faces, there
18222 are three indicating the article's score (low, normal, high), seem to
18223 result in a love/hate response from many Gnus users.  The problem is
18224 that the face selection is controlled by a list of condition tests and
18225 face names (See @code{gnus-summary-highlight}).  Each condition is
18226 tested in the order in which it appears in the list so early
18227 conditions have precedence over later conditions.  All of this means
18228 that, if you tick an undownloaded article, the article will continue
18229 to be displayed in the undownloaded face rather than the ticked face.
18230
18231 If you use the Agent as a cache (to avoid downloading the same article
18232 each time you visit it or to minimize your connection time), the
18233 undownloaded face will probably seem like a good idea.  The reason
18234 being that you do all of our work (marking, reading, deleting) with
18235 downloaded articles so the normal faces always appear.  For those
18236 users using the agent to improve online performance by caching the NOV
18237 database (most users since 5.10.2), the undownloaded faces may appear
18238 to be an absolutely horrible idea.  The issue being that, since none
18239 of their articles have been fetched into the Agent, all of the
18240 normal faces will be obscured by the undownloaded faces.
18241
18242 If you would like to use the undownloaded faces, you must enable the
18243 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18244 group parameter to t.  This parameter, like all other agent
18245 parameters, may be set on an Agent Category (@pxref{Agent
18246 Categories}), a Group Topic (@pxref{Topic Parameters}), or an
18247 individual group (@pxref{Group Parameters}).
18248
18249 @node Agent as Cache
18250 @subsection Agent as Cache
18251
18252 When Gnus is plugged, it is not efficient to download headers or
18253 articles from the server again, if they are already stored in the
18254 Agent.  So, Gnus normally only downloads headers once, and stores them
18255 in the Agent.  These headers are later used when generating the summary
18256 buffer, regardless of whether you are plugged or unplugged.  Articles
18257 are not cached in the Agent by default though (that would potentially
18258 consume lots of disk space), but if you have already downloaded an
18259 article into the Agent, Gnus will not download the article from the
18260 server again but use the locally stored copy instead.
18261
18262 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18263 @pxref{Agent Variables}) to always download headers and articles while
18264 plugged.  Gnus will almost certainly be slower, but it will be kept
18265 synchronized with the server.  That last point probably won't make any
18266 sense if you are using a nntp or nnimap back end.
18267
18268 @node Agent Expiry
18269 @subsection Agent Expiry
18270
18271 @vindex gnus-agent-expire-days
18272 @findex gnus-agent-expire
18273 @kindex M-x gnus-agent-expire
18274 @kindex M-x gnus-agent-expire-group
18275 @findex gnus-agent-expire-group
18276 @cindex agent expiry
18277 @cindex Gnus agent expiry
18278 @cindex expiry
18279
18280 The Agent back end, @code{nnagent}, doesn't handle expiry.  Well, at
18281 least it doesn't handle it like other back ends.  Instead, there are
18282 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
18283 commands that will expire all read articles that are older than
18284 @code{gnus-agent-expire-days} days.  They can be run whenever you feel
18285 that you're running out of space.  Neither are particularly fast or
18286 efficient, and it's not a particularly good idea to interrupt them (with
18287 @kbd{C-g} or anything else) once you've started one of them.
18288
18289 Note that other functions, e.g. @code{gnus-request-expire-articles},
18290 might run @code{gnus-agent-expire} for you to keep the agent
18291 synchronized with the group.
18292
18293 The agent parameter @code{agent-enable-expiration} may be used to
18294 prevent expiration in selected groups.
18295
18296 @vindex gnus-agent-expire-all
18297 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
18298 expiration commands will expire all articles---unread, read, ticked
18299 and dormant.  If @code{nil} (which is the default), only read articles
18300 are eligible for expiry, and unread, ticked and dormant articles will
18301 be kept indefinitely.
18302
18303 If you find that some articles eligible for expiry are never expired,
18304 perhaps some Gnus Agent files are corrupted.  There's are special
18305 commands, @code{gnus-agent-regenerate} and
18306 @code{gnus-agent-regenerate-group}, to fix possible problems.
18307
18308 @node Agent Regeneration
18309 @subsection Agent Regeneration
18310
18311 @cindex agent regeneration
18312 @cindex Gnus agent regeneration
18313 @cindex regeneration
18314
18315 The local data structures used by @code{nnagent} may become corrupted
18316 due to certain exceptional conditions.  When this happens,
18317 @code{nnagent} functionality may degrade or even fail.  The solution
18318 to this problem is to repair the local data structures by removing all
18319 internal inconsistencies.
18320
18321 For example, if your connection to your server is lost while
18322 downloaded articles into the agent, the local data structures will not
18323 know about articles successfully downloaded prior to the connection
18324 failure.  Running @code{gnus-agent-regenerate} or
18325 @code{gnus-agent-regenerate-group} will update the data structures
18326 such that you don't need to download these articles a second time.
18327
18328 @findex gnus-agent-regenerate
18329 @kindex M-x gnus-agent-regenerate
18330 The command @code{gnus-agent-regenerate} will perform
18331 @code{gnus-agent-regenerate-group} on every agentized group.  While
18332 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
18333 recommended that you first close all summary buffers.
18334
18335 @findex gnus-agent-regenerate-group
18336 @kindex M-x gnus-agent-regenerate-group
18337 The command @code{gnus-agent-regenerate-group} uses the local copies
18338 of individual articles to repair the local @acronym{NOV}(header) database.  It
18339 then updates the internal data structures that document which articles
18340 are stored locally.  An optional argument will mark articles in the
18341 agent as unread.
18342
18343 @node Agent and IMAP
18344 @subsection Agent and IMAP
18345
18346 The Agent works with any Gnus back end, including nnimap.  However,
18347 since there are some conceptual differences between @acronym{NNTP} and
18348 @acronym{IMAP}, this section (should) provide you with some information to
18349 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
18350
18351 The first thing to keep in mind is that all flags (read, ticked, etc)
18352 are kept on the @acronym{IMAP} server, rather than in @file{.newsrc} as is the
18353 case for nntp.  Thus Gnus need to remember flag changes when
18354 disconnected, and synchronize these flags when you plug back in.
18355
18356 Gnus keeps track of flag changes when reading nnimap groups under the
18357 Agent.  When you plug back in, Gnus will check if you have any changed
18358 any flags and ask if you wish to synchronize these with the server.
18359 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
18360
18361 @vindex gnus-agent-synchronize-flags
18362 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
18363 never automatically synchronize flags.  If it is @code{ask}, which is
18364 the default, the Agent will check if you made any changes and if so
18365 ask if you wish to synchronize these when you re-connect.  If it has
18366 any other value, all flags will be synchronized automatically.
18367
18368 If you do not wish to synchronize flags automatically when you
18369 re-connect, you can do it manually with the
18370 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
18371 in the group buffer.
18372
18373 Some things are currently not implemented in the Agent that you'd might
18374 expect from a disconnected @acronym{IMAP} client, including:
18375
18376 @itemize @bullet
18377
18378 @item
18379 Copying/moving articles into nnimap groups when unplugged.
18380
18381 @item
18382 Creating/deleting nnimap groups when unplugged.
18383
18384 @end itemize
18385
18386 Technical note: the synchronization algorithm does not work by ``pushing''
18387 all local flags to the server, but rather incrementally update the
18388 server view of flags by changing only those flags that were changed by
18389 the user.  Thus, if you set one flag on an article, quit the group and
18390 re-select the group and remove the flag; the flag will be set and
18391 removed from the server when you ``synchronize''.  The queued flag
18392 operations can be found in the per-server @code{flags} file in the Agent
18393 directory.  It's emptied when you synchronize flags.
18394
18395
18396 @node Outgoing Messages
18397 @subsection Outgoing Messages
18398
18399 By default, when Gnus is unplugged, all outgoing messages (both mail
18400 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
18401 You can view them there after posting, and edit them at will.
18402
18403 You can control the circumstances under which outgoing mail is queued
18404 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}).  Outgoing
18405 news is always queued when Gnus is unplugged, and never otherwise.
18406
18407 You can send the messages either from the draft group with the special
18408 commands available there, or you can use the @kbd{J S} command in the
18409 group buffer to send all the sendable messages in the draft group.
18410 Posting news will only work when Gnus is plugged, but you can send
18411 mail at any time.
18412
18413 If sending mail while unplugged does not work for you and you worry
18414 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
18415 ask you to confirm your action (see
18416 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
18417
18418 @node Agent Variables
18419 @subsection Agent Variables
18420
18421 @table @code
18422 @item gnus-agent-directory
18423 @vindex gnus-agent-directory
18424 Where the Gnus Agent will store its files.  The default is
18425 @file{~/News/agent/}.
18426
18427 @item gnus-agent-handle-level
18428 @vindex gnus-agent-handle-level
18429 Groups on levels (@pxref{Group Levels}) higher than this variable will
18430 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
18431 which means that only subscribed group will be considered by the Agent
18432 by default.
18433
18434 @item gnus-agent-plugged-hook
18435 @vindex gnus-agent-plugged-hook
18436 Hook run when connecting to the network.
18437
18438 @item gnus-agent-unplugged-hook
18439 @vindex gnus-agent-unplugged-hook
18440 Hook run when disconnecting from the network.
18441
18442 @item gnus-agent-fetched-hook
18443 @vindex gnus-agent-fetched-hook
18444 Hook run when finished fetching articles.
18445
18446 @item gnus-agent-cache
18447 @vindex gnus-agent-cache
18448 Variable to control whether use the locally stored @acronym{NOV} and
18449 articles when plugged, e.g. essentially using the Agent as a cache.
18450 The default is non-@code{nil}, which means to use the Agent as a cache.
18451
18452 @item gnus-agent-go-online
18453 @vindex gnus-agent-go-online
18454 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
18455 automatically switch offline servers into online status.  If it is
18456 @code{ask}, the default, the Agent will ask if you wish to switch
18457 offline servers into online status when you re-connect.  If it has any
18458 other value, all offline servers will be automatically switched into
18459 online status.
18460
18461 @item gnus-agent-mark-unread-after-downloaded
18462 @vindex gnus-agent-mark-unread-after-downloaded
18463 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
18464 mark articles as unread after downloading.  This is usually a safe
18465 thing to do as the newly downloaded article has obviously not been
18466 read.  The default is t.
18467
18468 @item gnus-agent-consider-all-articles
18469 @vindex gnus-agent-consider-all-articles
18470 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
18471 agent will let the agent predicate decide whether articles need to be
18472 downloaded or not, for all articles.  When @code{nil}, the default,
18473 the agent will only let the predicate decide whether unread articles
18474 are downloaded or not.  If you enable this, you may also want to look
18475 into the agent expiry settings (@pxref{Category Variables}), so that
18476 the agent doesn't download articles which the agent will later expire,
18477 over and over again.
18478
18479 @item gnus-agent-max-fetch-size
18480 @vindex gnus-agent-max-fetch-size
18481 The agent fetches articles into a temporary buffer prior to parsing
18482 them into individual files.  To avoid exceeding the max. buffer size,
18483 the agent alternates between fetching and parsing until all articles
18484 have been fetched.  @code{gnus-agent-max-fetch-size} provides a size
18485 limit to control how often the cycling occurs.  A large value improves
18486 performance.  A small value minimizes the time lost should the
18487 connection be lost while fetching (You may need to run
18488 @code{gnus-agent-regenerate-group} to update the group's state.
18489 However, all articles parsed prior to loosing the connection will be
18490 available while unplugged).  The default is 10M so it is unusual to
18491 see any cycling.
18492
18493 @item gnus-server-unopen-status
18494 @vindex gnus-server-unopen-status
18495 Perhaps not an Agent variable, but closely related to the Agent, this
18496 variable says what will happen if Gnus cannot open a server.  If the
18497 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
18498 whether to deny the server or whether to unplug the agent.  If the
18499 Agent is disabled, Gnus always simply deny the server.  Other choices
18500 for this variable include @code{denied} and @code{offline} the latter
18501 is only valid if the Agent is used.
18502
18503 @item gnus-auto-goto-ignores
18504 @vindex gnus-auto-goto-ignores
18505 Another variable that isn't an Agent variable, yet so closely related
18506 that most will look for it here, this variable tells the summary
18507 buffer how to maneuver around undownloaded (only headers stored in the
18508 agent) and unfetched (neither article nor headers stored) articles.
18509
18510 The legal values are @code{nil} (maneuver to any article),
18511 @code{undownloaded} (maneuvering while unplugged ignores articles that
18512 have not been fetched), @code{always-undownloaded} (maneuvering always
18513 ignores articles that have not been fetched), @code{unfetched}
18514 (maneuvering ignores articles whose headers have not been fetched).
18515
18516 @item gnus-agent-queue-mail
18517 @vindex gnus-agent-queue-mail
18518 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
18519 queue mail rather than sending it straight away.  When @code{t}, Gnus
18520 will queue mail when unplugged only.  When @code{nil}, never queue
18521 mail.  The default is @code{t}.
18522
18523 @item gnus-agent-prompt-send-queue
18524 @vindex gnus-agent-prompt-send-queue
18525 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
18526 prompt you to confirm that you really wish to proceed if you hit
18527 @kbd{J S} while unplugged.  The default is @code{nil}.
18528
18529 @item gnus-agent-auto-agentize-methods
18530 @vindex gnus-agent-auto-agentize-methods
18531 If you have never used the Agent before (or more technically, if
18532 @file{~/News/agent/lib/servers} does not exist), Gnus will
18533 automatically agentize a few servers for you.  This variable control
18534 which backends should be auto-agentized.  It is typically only useful
18535 to agentize remote backends.  The auto-agentizing has the same effect
18536 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
18537 If the file exist, you must manage the servers manually by adding or
18538 removing them, this variable is only applicable the first time you
18539 start Gnus.  The default is @samp{(nntp nnimap)}.
18540
18541 @end table
18542
18543
18544 @node Example Setup
18545 @subsection Example Setup
18546
18547 If you don't want to read this manual, and you have a fairly standard
18548 setup, you may be able to use something like the following as your
18549 @file{~/.gnus.el} file to get started.
18550
18551 @lisp
18552 ;;; @r{Define how Gnus is to fetch news.  We do this over @acronym{NNTP}}
18553 ;;; @r{from your ISP's server.}
18554 (setq gnus-select-method '(nntp "news.your-isp.com"))
18555
18556 ;;; @r{Define how Gnus is to read your mail.  We read mail from}
18557 ;;; @r{your ISP's @acronym{POP} server.}
18558 (setq mail-sources '((pop :server "pop.your-isp.com")))
18559
18560 ;;; @r{Say how Gnus is to store the mail.  We use nnml groups.}
18561 (setq gnus-secondary-select-methods '((nnml "")))
18562
18563 ;;; @r{Make Gnus into an offline newsreader.}
18564 ;;; (gnus-agentize) ; @r{The obsolete setting.}
18565 ;;; (setq gnus-agent t) ; @r{Now the default.}
18566 @end lisp
18567
18568 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
18569 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
18570 gnus}.
18571
18572 If this is the first time you've run Gnus, you will be subscribed
18573 automatically to a few default newsgroups.  You'll probably want to
18574 subscribe to more groups, and to do that, you have to query the
18575 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
18576 command.  This usually takes quite a while, but you only have to do it
18577 once.
18578
18579 After reading and parsing a while, you'll be presented with a list of
18580 groups.  Subscribe to the ones you want to read with the @kbd{u}
18581 command.  @kbd{l} to make all the killed groups disappear after you've
18582 subscribe to all the groups you want to read.  (@kbd{A k} will bring
18583 back all the killed groups.)
18584
18585 You can now read the groups at once, or you can download the articles
18586 with the @kbd{J s} command.  And then read the rest of this manual to
18587 find out which of the other gazillion things you want to customize.
18588
18589
18590 @node Batching Agents
18591 @subsection Batching Agents
18592 @findex gnus-agent-batch
18593
18594 Having the Gnus Agent fetch articles (and post whatever messages you've
18595 written) is quite easy once you've gotten things set up properly.  The
18596 following shell script will do everything that is necessary:
18597
18598 You can run a complete batch command from the command line with the
18599 following incantation:
18600
18601 @example
18602 #!/bin/sh
18603 emacs -batch -l ~/.emacs -l ~/.gnus.el gnus-agent-batch >/dev/null 2>&1
18604 @end example
18605
18606
18607 @node Agent Caveats
18608 @subsection Agent Caveats
18609
18610 The Gnus Agent doesn't seem to work like most other offline
18611 newsreaders.  Here are some common questions that some imaginary people
18612 may ask:
18613
18614 @table @dfn
18615 @item If I read an article while plugged, do they get entered into the Agent?
18616
18617 @strong{No}.  If you want this behaviour, add
18618 @code{gnus-agent-fetch-selected-article} to
18619 @code{gnus-select-article-hook}.
18620
18621 @item If I read an article while plugged, and the article already exists in
18622 the Agent, will it get downloaded once more?
18623
18624 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
18625
18626 @end table
18627
18628 In short, when Gnus is unplugged, it only looks into the locally stored
18629 articles; when it's plugged, it talks to your ISP and may also use the
18630 locally stored articles.
18631
18632
18633 @node Scoring
18634 @chapter Scoring
18635 @cindex scoring
18636
18637 Other people use @dfn{kill files}, but we here at Gnus Towers like
18638 scoring better than killing, so we'd rather switch than fight.  They do
18639 something completely different as well, so sit up straight and pay
18640 attention!
18641
18642 @vindex gnus-summary-mark-below
18643 All articles have a default score (@code{gnus-summary-default-score}),
18644 which is 0 by default.  This score may be raised or lowered either
18645 interactively or by score files.  Articles that have a score lower than
18646 @code{gnus-summary-mark-below} are marked as read.
18647
18648 Gnus will read any @dfn{score files} that apply to the current group
18649 before generating the summary buffer.
18650
18651 There are several commands in the summary buffer that insert score
18652 entries based on the current article.  You can, for instance, ask Gnus to
18653 lower or increase the score of all articles with a certain subject.
18654
18655 There are two sorts of scoring entries: Permanent and temporary.
18656 Temporary score entries are self-expiring entries.  Any entries that are
18657 temporary and have not been used for, say, a week, will be removed
18658 silently to help keep the sizes of the score files down.
18659
18660 @menu
18661 * Summary Score Commands::      Adding score entries for the current group.
18662 * Group Score Commands::        General score commands.
18663 * Score Variables::             Customize your scoring.  (My, what terminology).
18664 * Score File Format::           What a score file may contain.
18665 * Score File Editing::          You can edit score files by hand as well.
18666 * Adaptive Scoring::            Big Sister Gnus knows what you read.
18667 * Home Score File::             How to say where new score entries are to go.
18668 * Followups To Yourself::       Having Gnus notice when people answer you.
18669 * Scoring On Other Headers::    Scoring on non-standard headers.
18670 * Scoring Tips::                How to score effectively.
18671 * Reverse Scoring::             That problem child of old is not problem.
18672 * Global Score Files::          Earth-spanning, ear-splitting score files.
18673 * Kill Files::                  They are still here, but they can be ignored.
18674 * Converting Kill Files::       Translating kill files to score files.
18675 * Advanced Scoring::            Using logical expressions to build score rules.
18676 * Score Decays::                It can be useful to let scores wither away.
18677 @end menu
18678
18679
18680 @node Summary Score Commands
18681 @section Summary Score Commands
18682 @cindex score commands
18683
18684 The score commands that alter score entries do not actually modify real
18685 score files.  That would be too inefficient.  Gnus maintains a cache of
18686 previously loaded score files, one of which is considered the
18687 @dfn{current score file alist}.  The score commands simply insert
18688 entries into this list, and upon group exit, this list is saved.
18689
18690 The current score file is by default the group's local score file, even
18691 if no such score file actually exists.  To insert score commands into
18692 some other score file (e.g. @file{all.SCORE}), you must first make this
18693 score file the current one.
18694
18695 General score commands that don't actually change the score file:
18696
18697 @table @kbd
18698
18699 @item V s
18700 @kindex V s (Summary)
18701 @findex gnus-summary-set-score
18702 Set the score of the current article (@code{gnus-summary-set-score}).
18703
18704 @item V S
18705 @kindex V S (Summary)
18706 @findex gnus-summary-current-score
18707 Display the score of the current article
18708 (@code{gnus-summary-current-score}).
18709
18710 @item V t
18711 @kindex V t (Summary)
18712 @findex gnus-score-find-trace
18713 Display all score rules that have been used on the current article
18714 (@code{gnus-score-find-trace}).  In the @code{*Score Trace*} buffer, you
18715 may type @kbd{e} to edit score file corresponding to the score rule on
18716 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
18717 score file and edit it.
18718
18719 @item V w
18720 @kindex V w (Summary)
18721 @findex gnus-score-find-favourite-words
18722 List words used in scoring (@code{gnus-score-find-favourite-words}).
18723
18724 @item V R
18725 @kindex V R (Summary)
18726 @findex gnus-summary-rescore
18727 Run the current summary through the scoring process
18728 (@code{gnus-summary-rescore}).  This might be useful if you're playing
18729 around with your score files behind Gnus' back and want to see the
18730 effect you're having.
18731
18732 @item V c
18733 @kindex V c (Summary)
18734 @findex gnus-score-change-score-file
18735 Make a different score file the current
18736 (@code{gnus-score-change-score-file}).
18737
18738 @item V e
18739 @kindex V e (Summary)
18740 @findex gnus-score-edit-current-scores
18741 Edit the current score file (@code{gnus-score-edit-current-scores}).
18742 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
18743 File Editing}).
18744
18745 @item V f
18746 @kindex V f (Summary)
18747 @findex gnus-score-edit-file
18748 Edit a score file and make this score file the current one
18749 (@code{gnus-score-edit-file}).
18750
18751 @item V F
18752 @kindex V F (Summary)
18753 @findex gnus-score-flush-cache
18754 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
18755 after editing score files.
18756
18757 @item V C
18758 @kindex V C (Summary)
18759 @findex gnus-score-customize
18760 Customize a score file in a visually pleasing manner
18761 (@code{gnus-score-customize}).
18762
18763 @end table
18764
18765 The rest of these commands modify the local score file.
18766
18767 @table @kbd
18768
18769 @item V m
18770 @kindex V m (Summary)
18771 @findex gnus-score-set-mark-below
18772 Prompt for a score, and mark all articles with a score below this as
18773 read (@code{gnus-score-set-mark-below}).
18774
18775 @item V x
18776 @kindex V x (Summary)
18777 @findex gnus-score-set-expunge-below
18778 Prompt for a score, and add a score rule to the current score file to
18779 expunge all articles below this score
18780 (@code{gnus-score-set-expunge-below}).
18781 @end table
18782
18783 The keystrokes for actually making score entries follow a very regular
18784 pattern, so there's no need to list all the commands.  (Hundreds of
18785 them.)
18786
18787 @findex gnus-summary-increase-score
18788 @findex gnus-summary-lower-score
18789
18790 @enumerate
18791 @item
18792 The first key is either @kbd{I} (upper case i) for increasing the score
18793 or @kbd{L} for lowering the score.
18794 @item
18795 The second key says what header you want to score on.  The following
18796 keys are available:
18797 @table @kbd
18798
18799 @item a
18800 Score on the author name.
18801
18802 @item s
18803 Score on the subject line.
18804
18805 @item x
18806 Score on the @code{Xref} line---i.e., the cross-posting line.
18807
18808 @item r
18809 Score on the @code{References} line.
18810
18811 @item d
18812 Score on the date.
18813
18814 @item l
18815 Score on the number of lines.
18816
18817 @item i
18818 Score on the @code{Message-ID} header.
18819
18820 @item e
18821 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
18822 if your @acronym{NNTP} server tracks additional header data in overviews.
18823
18824 @item f
18825 Score on followups---this matches the author name, and adds scores to
18826 the followups to this author.  (Using this key leads to the creation of
18827 @file{ADAPT} files.)
18828
18829 @item b
18830 Score on the body.
18831
18832 @item h
18833 Score on the head.
18834
18835 @item t
18836 Score on thread.  (Using this key leads to the creation of @file{ADAPT}
18837 files.)
18838
18839 @end table
18840
18841 @item
18842 The third key is the match type.  Which match types are valid depends on
18843 what headers you are scoring on.
18844
18845 @table @code
18846
18847 @item strings
18848
18849 @table @kbd
18850
18851 @item e
18852 Exact matching.
18853
18854 @item s
18855 Substring matching.
18856
18857 @item f
18858 Fuzzy matching (@pxref{Fuzzy Matching}).
18859
18860 @item r
18861 Regexp matching
18862 @end table
18863
18864 @item date
18865 @table @kbd
18866
18867 @item b
18868 Before date.
18869
18870 @item a
18871 After date.
18872
18873 @item n
18874 This date.
18875 @end table
18876
18877 @item number
18878 @table @kbd
18879
18880 @item <
18881 Less than number.
18882
18883 @item =
18884 Equal to number.
18885
18886 @item >
18887 Greater than number.
18888 @end table
18889 @end table
18890
18891 @item
18892 The fourth and usually final key says whether this is a temporary (i.e.,
18893 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
18894 or whether it is to be done immediately, without adding to the score
18895 file.
18896 @table @kbd
18897
18898 @item t
18899 Temporary score entry.
18900
18901 @item p
18902 Permanent score entry.
18903
18904 @item i
18905 Immediately scoring.
18906 @end table
18907
18908 @item
18909 If you are scoring on `e' (extra) headers, you will then be prompted for
18910 the header name on which you wish to score.  This must be a header named
18911 in gnus-extra-headers, and @samp{TAB} completion is available.
18912
18913 @end enumerate
18914
18915 So, let's say you want to increase the score on the current author with
18916 exact matching permanently: @kbd{I a e p}.  If you want to lower the
18917 score based on the subject line, using substring matching, and make a
18918 temporary score entry: @kbd{L s s t}.  Pretty easy.
18919
18920 To make things a bit more complicated, there are shortcuts.  If you use
18921 a capital letter on either the second or third keys, Gnus will use
18922 defaults for the remaining one or two keystrokes.  The defaults are
18923 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
18924 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
18925
18926 These functions take both the numerical prefix and the symbolic prefix
18927 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
18928 (or increase) the score of the article.  A symbolic prefix of @code{a}
18929 says to use the @file{all.SCORE} file for the command instead of the
18930 current score file.
18931
18932 @vindex gnus-score-mimic-keymap
18933 The @code{gnus-score-mimic-keymap} says whether these commands will
18934 pretend they are keymaps or not.
18935
18936
18937 @node Group Score Commands
18938 @section Group Score Commands
18939 @cindex group score commands
18940
18941 There aren't many of these as yet, I'm afraid.
18942
18943 @table @kbd
18944
18945 @item W e
18946 @kindex W e (Group)
18947 @findex gnus-score-edit-all-score
18948 Edit the apply-to-all-groups all.SCORE file.  You will be popped into
18949 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
18950
18951 @item W f
18952 @kindex W f (Group)
18953 @findex gnus-score-flush-cache
18954 Gnus maintains a cache of score alists to avoid having to reload them
18955 all the time.  This command will flush the cache
18956 (@code{gnus-score-flush-cache}).
18957
18958 @end table
18959
18960 You can do scoring from the command line by saying something like:
18961
18962 @findex gnus-batch-score
18963 @cindex batch scoring
18964 @example
18965 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
18966 @end example
18967
18968
18969 @node Score Variables
18970 @section Score Variables
18971 @cindex score variables
18972
18973 @table @code
18974
18975 @item gnus-use-scoring
18976 @vindex gnus-use-scoring
18977 If @code{nil}, Gnus will not check for score files, and will not, in
18978 general, do any score-related work.  This is @code{t} by default.
18979
18980 @item gnus-kill-killed
18981 @vindex gnus-kill-killed
18982 If this variable is @code{nil}, Gnus will never apply score files to
18983 articles that have already been through the kill process.  While this
18984 may save you lots of time, it also means that if you apply a kill file
18985 to a group, and then change the kill file and want to run it over you
18986 group again to kill more articles, it won't work.  You have to set this
18987 variable to @code{t} to do that.  (It is @code{t} by default.)
18988
18989 @item gnus-kill-files-directory
18990 @vindex gnus-kill-files-directory
18991 All kill and score files will be stored in this directory, which is
18992 initialized from the @env{SAVEDIR} environment variable by default.
18993 This is @file{~/News/} by default.
18994
18995 @item gnus-score-file-suffix
18996 @vindex gnus-score-file-suffix
18997 Suffix to add to the group name to arrive at the score file name
18998 (@file{SCORE} by default.)
18999
19000 @item gnus-score-uncacheable-files
19001 @vindex gnus-score-uncacheable-files
19002 @cindex score cache
19003 All score files are normally cached to avoid excessive re-loading of
19004 score files.  However, if this might make your Emacs grow big and
19005 bloated, so this regexp can be used to weed out score files unlikely
19006 to be needed again.  It would be a bad idea to deny caching of
19007 @file{all.SCORE}, while it might be a good idea to not cache
19008 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
19009 variable is @samp{ADAPT$} by default, so no adaptive score files will
19010 be cached.
19011
19012 @item gnus-save-score
19013 @vindex gnus-save-score
19014 If you have really complicated score files, and do lots of batch
19015 scoring, then you might set this variable to @code{t}.  This will make
19016 Gnus save the scores into the @file{.newsrc.eld} file.
19017
19018 If you do not set this to @code{t}, then manual scores (like those set
19019 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19020 across group visits.
19021
19022 @item gnus-score-interactive-default-score
19023 @vindex gnus-score-interactive-default-score
19024 Score used by all the interactive raise/lower commands to raise/lower
19025 score with.  Default is 1000, which may seem excessive, but this is to
19026 ensure that the adaptive scoring scheme gets enough room to play with.
19027 We don't want the small changes from the adaptive scoring to overwrite
19028 manually entered data.
19029
19030 @item gnus-summary-default-score
19031 @vindex gnus-summary-default-score
19032 Default score of an article, which is 0 by default.
19033
19034 @item gnus-summary-expunge-below
19035 @vindex gnus-summary-expunge-below
19036 Don't display the summary lines of articles that have scores lower than
19037 this variable.  This is @code{nil} by default, which means that no
19038 articles will be hidden.  This variable is local to the summary buffers,
19039 and has to be set from @code{gnus-summary-mode-hook}.
19040
19041 @item gnus-score-over-mark
19042 @vindex gnus-score-over-mark
19043 Mark (in the third column) used for articles with a score over the
19044 default.  Default is @samp{+}.
19045
19046 @item gnus-score-below-mark
19047 @vindex gnus-score-below-mark
19048 Mark (in the third column) used for articles with a score below the
19049 default.  Default is @samp{-}.
19050
19051 @item gnus-score-find-score-files-function
19052 @vindex gnus-score-find-score-files-function
19053 Function used to find score files for the current group.  This function
19054 is called with the name of the group as the argument.
19055
19056 Predefined functions available are:
19057 @table @code
19058
19059 @item gnus-score-find-single
19060 @findex gnus-score-find-single
19061 Only apply the group's own score file.
19062
19063 @item gnus-score-find-bnews
19064 @findex gnus-score-find-bnews
19065 Apply all score files that match, using bnews syntax.  This is the
19066 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
19067 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19068 @file{gnu.all.SCORE} would all apply.  In short, the instances of
19069 @samp{all} in the score file names are translated into @samp{.*}, and
19070 then a regexp match is done.
19071
19072 This means that if you have some score entries that you want to apply to
19073 all groups, then you put those entries in the @file{all.SCORE} file.
19074
19075 The score files are applied in a semi-random order, although Gnus will
19076 try to apply the more general score files before the more specific score
19077 files.  It does this by looking at the number of elements in the score
19078 file names---discarding the @samp{all} elements.
19079
19080 @item gnus-score-find-hierarchical
19081 @findex gnus-score-find-hierarchical
19082 Apply all score files from all the parent groups.  This means that you
19083 can't have score files like @file{all.SCORE}, but you can have
19084 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19085 server.
19086
19087 @end table
19088 This variable can also be a list of functions.  In that case, all
19089 these functions will be called with the group name as argument, and
19090 all the returned lists of score files will be applied.  These
19091 functions can also return lists of lists of score alists directly.  In
19092 that case, the functions that return these non-file score alists
19093 should probably be placed before the ``real'' score file functions, to
19094 ensure that the last score file returned is the local score file.
19095 Phu.
19096
19097 For example, to do hierarchical scoring but use a non-server-specific
19098 overall score file, you could use the value
19099 @example
19100 (list (lambda (group) ("all.SCORE"))
19101       'gnus-score-find-hierarchical)
19102 @end example
19103
19104 @item gnus-score-expiry-days
19105 @vindex gnus-score-expiry-days
19106 This variable says how many days should pass before an unused score file
19107 entry is expired.  If this variable is @code{nil}, no score file entries
19108 are expired.  It's 7 by default.
19109
19110 @item gnus-update-score-entry-dates
19111 @vindex gnus-update-score-entry-dates
19112 If this variable is non-@code{nil}, temporary score entries that have
19113 been triggered (matched) will have their dates updated.  (This is how Gnus
19114 controls expiry---all non-matched-entries will become too old while
19115 matched entries will stay fresh and young.)  However, if you set this
19116 variable to @code{nil}, even matched entries will grow old and will
19117 have to face that oh-so grim reaper.
19118
19119 @item gnus-score-after-write-file-function
19120 @vindex gnus-score-after-write-file-function
19121 Function called with the name of the score file just written.
19122
19123 @item gnus-score-thread-simplify
19124 @vindex gnus-score-thread-simplify
19125 If this variable is non-@code{nil}, article subjects will be
19126 simplified for subject scoring purposes in the same manner as with
19127 threading---according to the current value of
19128 @code{gnus-simplify-subject-functions}.  If the scoring entry uses
19129 @code{substring} or @code{exact} matching, the match will also be
19130 simplified in this manner.
19131
19132 @end table
19133
19134
19135 @node Score File Format
19136 @section Score File Format
19137 @cindex score file format
19138
19139 A score file is an @code{emacs-lisp} file that normally contains just a
19140 single form.  Casual users are not expected to edit these files;
19141 everything can be changed from the summary buffer.
19142
19143 Anyway, if you'd like to dig into it yourself, here's an example:
19144
19145 @lisp
19146 (("from"
19147   ("Lars Ingebrigtsen" -10000)
19148   ("Per Abrahamsen")
19149   ("larsi\\|lmi" -50000 nil R))
19150  ("subject"
19151   ("Ding is Badd" nil 728373))
19152  ("xref"
19153   ("alt.politics" -1000 728372 s))
19154  ("lines"
19155   (2 -100 nil <))
19156  (mark 0)
19157  (expunge -1000)
19158  (mark-and-expunge -10)
19159  (read-only nil)
19160  (orphan -10)
19161  (adapt t)
19162  (files "/hom/larsi/News/gnu.SCORE")
19163  (exclude-files "all.SCORE")
19164  (local (gnus-newsgroup-auto-expire t)
19165         (gnus-summary-make-false-root empty))
19166  (eval (ding)))
19167 @end lisp
19168
19169 This example demonstrates most score file elements.  @xref{Advanced
19170 Scoring}, for a different approach.
19171
19172 Even though this looks much like Lisp code, nothing here is actually
19173 @code{eval}ed.  The Lisp reader is used to read this form, though, so it
19174 has to be valid syntactically, if not semantically.
19175
19176 Six keys are supported by this alist:
19177
19178 @table @code
19179
19180 @item STRING
19181 If the key is a string, it is the name of the header to perform the
19182 match on.  Scoring can only be performed on these eight headers:
19183 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19184 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
19185 these headers, there are three strings to tell Gnus to fetch the entire
19186 article and do the match on larger parts of the article: @code{Body}
19187 will perform the match on the body of the article, @code{Head} will
19188 perform the match on the head of the article, and @code{All} will
19189 perform the match on the entire article.  Note that using any of these
19190 last three keys will slow down group entry @emph{considerably}.  The
19191 final ``header'' you can score on is @code{Followup}.  These score
19192 entries will result in new score entries being added for all follow-ups
19193 to articles that matches these score entries.
19194
19195 Following this key is an arbitrary number of score entries, where each
19196 score entry has one to four elements.
19197 @enumerate
19198
19199 @item
19200 The first element is the @dfn{match element}.  On most headers this will
19201 be a string, but on the Lines and Chars headers, this must be an
19202 integer.
19203
19204 @item
19205 If the second element is present, it should be a number---the @dfn{score
19206 element}.  This number should be an integer in the neginf to posinf
19207 interval.  This number is added to the score of the article if the match
19208 is successful.  If this element is not present, the
19209 @code{gnus-score-interactive-default-score} number will be used
19210 instead.  This is 1000 by default.
19211
19212 @item
19213 If the third element is present, it should be a number---the @dfn{date
19214 element}.  This date says when the last time this score entry matched,
19215 which provides a mechanism for expiring the score entries.  It this
19216 element is not present, the score entry is permanent.  The date is
19217 represented by the number of days since December 31, 1 BCE.
19218
19219 @item
19220 If the fourth element is present, it should be a symbol---the @dfn{type
19221 element}.  This element specifies what function should be used to see
19222 whether this score entry matches the article.  What match types that can
19223 be used depends on what header you wish to perform the match on.
19224 @table @dfn
19225
19226 @item From, Subject, References, Xref, Message-ID
19227 For most header types, there are the @code{r} and @code{R} (regexp), as
19228 well as @code{s} and @code{S} (substring) types, and @code{e} and
19229 @code{E} (exact match), and @code{w} (word match) types.  If this
19230 element is not present, Gnus will assume that substring matching should
19231 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
19232 that the matches will be done in a case-sensitive manner.  All these
19233 one-letter types are really just abbreviations for the @code{regexp},
19234 @code{string}, @code{exact}, and @code{word} types, which you can use
19235 instead, if you feel like.
19236
19237 @item Extra
19238 Just as for the standard string overview headers, if you are using
19239 gnus-extra-headers, you can score on these headers' values.  In this
19240 case, there is a 5th element in the score entry, being the name of the
19241 header to be scored.  The following entry is useful in your
19242 @file{all.SCORE} file in case of spam attacks from a single origin
19243 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19244 overviews:
19245
19246 @lisp
19247 ("111.222.333.444" -1000 nil s
19248  "NNTP-Posting-Host")
19249 @end lisp
19250
19251 @item Lines, Chars
19252 These two headers use different match types: @code{<}, @code{>},
19253 @code{=}, @code{>=} and @code{<=}.
19254
19255 These predicates are true if
19256
19257 @example
19258 (PREDICATE HEADER MATCH)
19259 @end example
19260
19261 evaluates to non-@code{nil}.  For instance, the advanced match
19262 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
19263 following form:
19264
19265 @lisp
19266 (< header-value 4)
19267 @end lisp
19268
19269 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
19270 the match, we get the score added if the article has less than 4 lines.
19271 (It's easy to get confused and think it's the other way around.  But
19272 it's not.  I think.)
19273
19274 When matching on @code{Lines}, be careful because some back ends (like
19275 @code{nndir}) do not generate @code{Lines} header, so every article ends
19276 up being marked as having 0 lines.  This can lead to strange results if
19277 you happen to lower score of the articles with few lines.
19278
19279 @item Date
19280 For the Date header we have three kinda silly match types:
19281 @code{before}, @code{at} and @code{after}.  I can't really imagine this
19282 ever being useful, but, like, it would feel kinda silly not to provide
19283 this function.  Just in case.  You never know.  Better safe than sorry.
19284 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
19285 sex on a first date.  (I have been told that at least one person, and I
19286 quote, ``found this function indispensable'', however.)
19287
19288 @cindex ISO8601
19289 @cindex date
19290 A more useful match type is @code{regexp}.  With it, you can match the
19291 date string using a regular expression.  The date is normalized to
19292 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
19293 you want to match all articles that have been posted on April 1st in
19294 every year, you could use @samp{....0401.........} as a match string,
19295 for instance.  (Note that the date is kept in its original time zone, so
19296 this will match articles that were posted when it was April 1st where
19297 the article was posted from.  Time zones are such wholesome fun for the
19298 whole family, eh?)
19299
19300 @item Head, Body, All
19301 These three match keys use the same match types as the @code{From} (etc)
19302 header uses.
19303
19304 @item Followup
19305 This match key is somewhat special, in that it will match the
19306 @code{From} header, and affect the score of not only the matching
19307 articles, but also all followups to the matching articles.  This allows
19308 you e.g. increase the score of followups to your own articles, or
19309 decrease the score of followups to the articles of some known
19310 trouble-maker.  Uses the same match types as the @code{From} header
19311 uses.  (Using this match key will lead to creation of @file{ADAPT}
19312 files.)
19313
19314 @item Thread
19315 This match key works along the same lines as the @code{Followup} match
19316 key.  If you say that you want to score on a (sub-)thread started by an
19317 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
19318 match.  This will add a new @samp{thread} match for each article that
19319 has @var{x} in its @code{References} header.  (These new @samp{thread}
19320 matches will use the @code{Message-ID}s of these matching articles.)
19321 This will ensure that you can raise/lower the score of an entire thread,
19322 even though some articles in the thread may not have complete
19323 @code{References} headers.  Note that using this may lead to
19324 undeterministic scores of the articles in the thread.  (Using this match
19325 key will lead to creation of @file{ADAPT} files.)
19326 @end table
19327 @end enumerate
19328
19329 @cindex score file atoms
19330 @item mark
19331 The value of this entry should be a number.  Any articles with a score
19332 lower than this number will be marked as read.
19333
19334 @item expunge
19335 The value of this entry should be a number.  Any articles with a score
19336 lower than this number will be removed from the summary buffer.
19337
19338 @item mark-and-expunge
19339 The value of this entry should be a number.  Any articles with a score
19340 lower than this number will be marked as read and removed from the
19341 summary buffer.
19342
19343 @item thread-mark-and-expunge
19344 The value of this entry should be a number.  All articles that belong to
19345 a thread that has a total score below this number will be marked as read
19346 and removed from the summary buffer.  @code{gnus-thread-score-function}
19347 says how to compute the total score for a thread.
19348
19349 @item files
19350 The value of this entry should be any number of file names.  These files
19351 are assumed to be score files as well, and will be loaded the same way
19352 this one was.
19353
19354 @item exclude-files
19355 The clue of this entry should be any number of files.  These files will
19356 not be loaded, even though they would normally be so, for some reason or
19357 other.
19358
19359 @item eval
19360 The value of this entry will be @code{eval}el.  This element will be
19361 ignored when handling global score files.
19362
19363 @item read-only
19364 Read-only score files will not be updated or saved.  Global score files
19365 should feature this atom (@pxref{Global Score Files}).  (Note:
19366 @dfn{Global} here really means @dfn{global}; not your personal
19367 apply-to-all-groups score files.)
19368
19369 @item orphan
19370 The value of this entry should be a number.  Articles that do not have
19371 parents will get this number added to their scores.  Imagine you follow
19372 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
19373 will only follow a few of the threads, also want to see any new threads.
19374
19375 You can do this with the following two score file entries:
19376
19377 @example
19378         (orphan -500)
19379         (mark-and-expunge -100)
19380 @end example
19381
19382 When you enter the group the first time, you will only see the new
19383 threads.  You then raise the score of the threads that you find
19384 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
19385 rest.  Next time you enter the group, you will see new articles in the
19386 interesting threads, plus any new threads.
19387
19388 I.e.---the orphan score atom is for high-volume groups where a few
19389 interesting threads which can't be found automatically by ordinary
19390 scoring rules exist.
19391
19392 @item adapt
19393 This entry controls the adaptive scoring.  If it is @code{t}, the
19394 default adaptive scoring rules will be used.  If it is @code{ignore}, no
19395 adaptive scoring will be performed on this group.  If it is a list, this
19396 list will be used as the adaptive scoring rules.  If it isn't present,
19397 or is something other than @code{t} or @code{ignore}, the default
19398 adaptive scoring rules will be used.  If you want to use adaptive
19399 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
19400 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
19401 not want adaptive scoring.  If you only want adaptive scoring in a few
19402 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
19403 insert @code{(adapt t)} in the score files of the groups where you want
19404 it.
19405
19406 @item adapt-file
19407 All adaptive score entries will go to the file named by this entry.  It
19408 will also be applied when entering the group.  This atom might be handy
19409 if you want to adapt on several groups at once, using the same adaptive
19410 file for a number of groups.
19411
19412 @item local
19413 @cindex local variables
19414 The value of this entry should be a list of @code{(@var{var}
19415 @var{value})} pairs.  Each @var{var} will be made buffer-local to the
19416 current summary buffer, and set to the value specified.  This is a
19417 convenient, if somewhat strange, way of setting variables in some
19418 groups if you don't like hooks much.  Note that the @var{value} won't
19419 be evaluated.
19420 @end table
19421
19422
19423 @node Score File Editing
19424 @section Score File Editing
19425
19426 You normally enter all scoring commands from the summary buffer, but you
19427 might feel the urge to edit them by hand as well, so we've supplied you
19428 with a mode for that.
19429
19430 It's simply a slightly customized @code{emacs-lisp} mode, with these
19431 additional commands:
19432
19433 @table @kbd
19434
19435 @item C-c C-c
19436 @kindex C-c C-c (Score)
19437 @findex gnus-score-edit-done
19438 Save the changes you have made and return to the summary buffer
19439 (@code{gnus-score-edit-done}).
19440
19441 @item C-c C-d
19442 @kindex C-c C-d (Score)
19443 @findex gnus-score-edit-insert-date
19444 Insert the current date in numerical format
19445 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
19446 you were wondering.
19447
19448 @item C-c C-p
19449 @kindex C-c C-p (Score)
19450 @findex gnus-score-pretty-print
19451 The adaptive score files are saved in an unformatted fashion.  If you
19452 intend to read one of these files, you want to @dfn{pretty print} it
19453 first.  This command (@code{gnus-score-pretty-print}) does that for
19454 you.
19455
19456 @end table
19457
19458 Type @kbd{M-x gnus-score-mode} to use this mode.
19459
19460 @vindex gnus-score-mode-hook
19461 @code{gnus-score-menu-hook} is run in score mode buffers.
19462
19463 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
19464 @kbd{V t} to begin editing score files.
19465
19466
19467 @node Adaptive Scoring
19468 @section Adaptive Scoring
19469 @cindex adaptive scoring
19470
19471 If all this scoring is getting you down, Gnus has a way of making it all
19472 happen automatically---as if by magic.  Or rather, as if by artificial
19473 stupidity, to be precise.
19474
19475 @vindex gnus-use-adaptive-scoring
19476 When you read an article, or mark an article as read, or kill an
19477 article, you leave marks behind.  On exit from the group, Gnus can sniff
19478 these marks and add score elements depending on what marks it finds.
19479 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
19480 @code{t} or @code{(line)}.  If you want score adaptively on separate
19481 words appearing in the subjects, you should set this variable to
19482 @code{(word)}.  If you want to use both adaptive methods, set this
19483 variable to @code{(word line)}.
19484
19485 @vindex gnus-default-adaptive-score-alist
19486 To give you complete control over the scoring process, you can customize
19487 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
19488 might look something like this:
19489
19490 @lisp
19491 (setq gnus-default-adaptive-score-alist
19492   '((gnus-unread-mark)
19493     (gnus-ticked-mark (from 4))
19494     (gnus-dormant-mark (from 5))
19495     (gnus-del-mark (from -4) (subject -1))
19496     (gnus-read-mark (from 4) (subject 2))
19497     (gnus-expirable-mark (from -1) (subject -1))
19498     (gnus-killed-mark (from -1) (subject -3))
19499     (gnus-kill-file-mark)
19500     (gnus-ancient-mark)
19501     (gnus-low-score-mark)
19502     (gnus-catchup-mark (from -1) (subject -1))))
19503 @end lisp
19504
19505 As you see, each element in this alist has a mark as a key (either a
19506 variable name or a ``real'' mark---a character).  Following this key is
19507 a arbitrary number of header/score pairs.  If there are no header/score
19508 pairs following the key, no adaptive scoring will be done on articles
19509 that have that key as the article mark.  For instance, articles with
19510 @code{gnus-unread-mark} in the example above will not get adaptive score
19511 entries.
19512
19513 Each article can have only one mark, so just a single of these rules
19514 will be applied to each article.
19515
19516 To take @code{gnus-del-mark} as an example---this alist says that all
19517 articles that have that mark (i.e., are marked with @samp{e}) will have a
19518 score entry added to lower based on the @code{From} header by -4, and
19519 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
19520
19521 If you have marked 10 articles with the same subject with
19522 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
19523 That means that that subject will get a score of ten times -1, which
19524 should be, unless I'm much mistaken, -10.
19525
19526 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
19527 the read articles will be marked with the @samp{E} mark.  This'll
19528 probably make adaptive scoring slightly impossible, so auto-expiring and
19529 adaptive scoring doesn't really mix very well.
19530
19531 The headers you can score on are @code{from}, @code{subject},
19532 @code{message-id}, @code{references}, @code{xref}, @code{lines},
19533 @code{chars} and @code{date}.  In addition, you can score on
19534 @code{followup}, which will create an adaptive score entry that matches
19535 on the @code{References} header using the @code{Message-ID} of the
19536 current article, thereby matching the following thread.
19537
19538 If you use this scheme, you should set the score file atom @code{mark}
19539 to something small---like -300, perhaps, to avoid having small random
19540 changes result in articles getting marked as read.
19541
19542 After using adaptive scoring for a week or so, Gnus should start to
19543 become properly trained and enhance the authors you like best, and kill
19544 the authors you like least, without you having to say so explicitly.
19545
19546 You can control what groups the adaptive scoring is to be performed on
19547 by using the score files (@pxref{Score File Format}).  This will also
19548 let you use different rules in different groups.
19549
19550 @vindex gnus-adaptive-file-suffix
19551 The adaptive score entries will be put into a file where the name is the
19552 group name with @code{gnus-adaptive-file-suffix} appended.  The default
19553 is @file{ADAPT}.
19554
19555 @vindex gnus-score-exact-adapt-limit
19556 When doing adaptive scoring, substring or fuzzy matching would probably
19557 give you the best results in most cases.  However, if the header one
19558 matches is short, the possibility for false positives is great, so if
19559 the length of the match is less than
19560 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
19561 this variable is @code{nil}, exact matching will always be used to avoid
19562 this problem.
19563
19564 @vindex gnus-default-adaptive-word-score-alist
19565 As mentioned above, you can adapt either on individual words or entire
19566 headers.  If you adapt on words, the
19567 @code{gnus-default-adaptive-word-score-alist} variable says what score
19568 each instance of a word should add given a mark.
19569
19570 @lisp
19571 (setq gnus-default-adaptive-word-score-alist
19572       `((,gnus-read-mark . 30)
19573         (,gnus-catchup-mark . -10)
19574         (,gnus-killed-mark . -20)
19575         (,gnus-del-mark . -15)))
19576 @end lisp
19577
19578 This is the default value.  If you have adaption on words enabled, every
19579 word that appears in subjects of articles marked with
19580 @code{gnus-read-mark} will result in a score rule that increase the
19581 score with 30 points.
19582
19583 @vindex gnus-default-ignored-adaptive-words
19584 @vindex gnus-ignored-adaptive-words
19585 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
19586 will be ignored.  If you wish to add more words to be ignored, use the
19587 @code{gnus-ignored-adaptive-words} list instead.
19588
19589 @vindex gnus-adaptive-word-length-limit
19590 Some may feel that short words shouldn't count when doing adaptive
19591 scoring.  If so, you may set @code{gnus-adaptive-word-length-limit} to
19592 an integer.  Words shorter than this number will be ignored.  This
19593 variable defaults to @code{nil}.
19594
19595 @vindex gnus-adaptive-word-syntax-table
19596 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
19597 syntax table in effect.  It is similar to the standard syntax table, but
19598 it considers numbers to be non-word-constituent characters.
19599
19600 @vindex gnus-adaptive-word-minimum
19601 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
19602 word scoring process will never bring down the score of an article to
19603 below this number.  The default is @code{nil}.
19604
19605 @vindex gnus-adaptive-word-no-group-words
19606 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
19607 won't adaptively word score any of the words in the group name.  Useful
19608 for groups like @samp{comp.editors.emacs}, where most of the subject
19609 lines contain the word @samp{emacs}.
19610
19611 After using this scheme for a while, it might be nice to write a
19612 @code{gnus-psychoanalyze-user} command to go through the rules and see
19613 what words you like and what words you don't like.  Or perhaps not.
19614
19615 Note that the adaptive word scoring thing is highly experimental and is
19616 likely to change in the future.  Initial impressions seem to indicate
19617 that it's totally useless as it stands.  Some more work (involving more
19618 rigorous statistical methods) will have to be done to make this useful.
19619
19620
19621 @node Home Score File
19622 @section Home Score File
19623
19624 The score file where new score file entries will go is called the
19625 @dfn{home score file}.  This is normally (and by default) the score file
19626 for the group itself.  For instance, the home score file for
19627 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
19628
19629 However, this may not be what you want.  It is often convenient to share
19630 a common home score file among many groups---all @samp{emacs} groups
19631 could perhaps use the same home score file.
19632
19633 @vindex gnus-home-score-file
19634 The variable that controls this is @code{gnus-home-score-file}.  It can
19635 be:
19636
19637 @enumerate
19638 @item
19639 A string.  Then this file will be used as the home score file for all
19640 groups.
19641
19642 @item
19643 A function.  The result of this function will be used as the home score
19644 file.  The function will be called with the name of the group as the
19645 parameter.
19646
19647 @item
19648 A list.  The elements in this list can be:
19649
19650 @enumerate
19651 @item
19652 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
19653 group name, the @var{file-name} will be used as the home score file.
19654
19655 @item
19656 A function.  If the function returns non-@code{nil}, the result will
19657 be used as the home score file.
19658
19659 @item
19660 A string.  Use the string as the home score file.
19661 @end enumerate
19662
19663 The list will be traversed from the beginning towards the end looking
19664 for matches.
19665
19666 @end enumerate
19667
19668 So, if you want to use just a single score file, you could say:
19669
19670 @lisp
19671 (setq gnus-home-score-file
19672       "my-total-score-file.SCORE")
19673 @end lisp
19674
19675 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
19676 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
19677
19678 @findex gnus-hierarchial-home-score-file
19679 @lisp
19680 (setq gnus-home-score-file
19681       'gnus-hierarchial-home-score-file)
19682 @end lisp
19683
19684 This is a ready-made function provided for your convenience.
19685 Other functions include
19686
19687 @table @code
19688 @item gnus-current-home-score-file
19689 @findex gnus-current-home-score-file
19690 Return the ``current'' regular score file.  This will make scoring
19691 commands add entry to the ``innermost'' matching score file.
19692
19693 @end table
19694
19695 If you want to have one score file for the @samp{emacs} groups and
19696 another for the @samp{comp} groups, while letting all other groups use
19697 their own home score files:
19698
19699 @lisp
19700 (setq gnus-home-score-file
19701       ;; @r{All groups that match the regexp @code{"\\.emacs"}}
19702       '(("\\.emacs" "emacs.SCORE")
19703         ;; @r{All the comp groups in one score file}
19704         ("^comp" "comp.SCORE")))
19705 @end lisp
19706
19707 @vindex gnus-home-adapt-file
19708 @code{gnus-home-adapt-file} works exactly the same way as
19709 @code{gnus-home-score-file}, but says what the home adaptive score file
19710 is instead.  All new adaptive file entries will go into the file
19711 specified by this variable, and the same syntax is allowed.
19712
19713 In addition to using @code{gnus-home-score-file} and
19714 @code{gnus-home-adapt-file}, you can also use group parameters
19715 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
19716 Parameters}) to achieve much the same.  Group and topic parameters take
19717 precedence over this variable.
19718
19719
19720 @node Followups To Yourself
19721 @section Followups To Yourself
19722
19723 Gnus offers two commands for picking out the @code{Message-ID} header in
19724 the current buffer.  Gnus will then add a score rule that scores using
19725 this @code{Message-ID} on the @code{References} header of other
19726 articles.  This will, in effect, increase the score of all articles that
19727 respond to the article in the current buffer.  Quite useful if you want
19728 to easily note when people answer what you've said.
19729
19730 @table @code
19731
19732 @item gnus-score-followup-article
19733 @findex gnus-score-followup-article
19734 This will add a score to articles that directly follow up your own
19735 article.
19736
19737 @item gnus-score-followup-thread
19738 @findex gnus-score-followup-thread
19739 This will add a score to all articles that appear in a thread ``below''
19740 your own article.
19741 @end table
19742
19743 @vindex message-sent-hook
19744 These two functions are both primarily meant to be used in hooks like
19745 @code{message-sent-hook}, like this:
19746 @lisp
19747 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
19748 @end lisp
19749
19750
19751 If you look closely at your own @code{Message-ID}, you'll notice that
19752 the first two or three characters are always the same.  Here's two of
19753 mine:
19754
19755 @example
19756 <x6u3u47icf.fsf@@eyesore.no>
19757 <x6sp9o7ibw.fsf@@eyesore.no>
19758 @end example
19759
19760 So ``my'' ident on this machine is @samp{x6}.  This can be
19761 exploited---the following rule will raise the score on all followups to
19762 myself:
19763
19764 @lisp
19765 ("references"
19766  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
19767   1000 nil r))
19768 @end lisp
19769
19770 Whether it's the first two or first three characters that are ``yours''
19771 is system-dependent.
19772
19773
19774 @node Scoring On Other Headers
19775 @section Scoring On Other Headers
19776 @cindex scoring on other headers
19777
19778 Gnus is quite fast when scoring the ``traditional''
19779 headers---@samp{From}, @samp{Subject} and so on.  However, scoring
19780 other headers requires writing a @code{head} scoring rule, which means
19781 that Gnus has to request every single article from the back end to find
19782 matches.  This takes a long time in big groups.
19783
19784 Now, there's not much you can do about this for news groups, but for
19785 mail groups, you have greater control.  In @ref{To From Newsgroups},
19786 it's explained in greater detail what this mechanism does, but here's
19787 a cookbook example for @code{nnml} on how to allow scoring on the
19788 @samp{To} and @samp{Cc} headers.
19789
19790 Put the following in your @file{~/.gnus.el} file.
19791
19792 @lisp
19793 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
19794       nnmail-extra-headers gnus-extra-headers)
19795 @end lisp
19796
19797 Restart Gnus and rebuild your @code{nnml} overview files with the
19798 @kbd{M-x nnml-generate-nov-databases} command.  This will take a long
19799 time if you have much mail.
19800
19801 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
19802 so: @kbd{I e s p To RET <your name> RET}.
19803
19804 See?  Simple.
19805
19806
19807 @node Scoring Tips
19808 @section Scoring Tips
19809 @cindex scoring tips
19810
19811 @table @dfn
19812
19813 @item Crossposts
19814 @cindex crossposts
19815 @cindex scoring crossposts
19816 If you want to lower the score of crossposts, the line to match on is
19817 the @code{Xref} header.
19818 @lisp
19819 ("xref" (" talk.politics.misc:" -1000))
19820 @end lisp
19821
19822 @item Multiple crossposts
19823 If you want to lower the score of articles that have been crossposted to
19824 more than, say, 3 groups:
19825 @lisp
19826 ("xref"
19827   ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
19828    -1000 nil r))
19829 @end lisp
19830
19831 @item Matching on the body
19832 This is generally not a very good idea---it takes a very long time.
19833 Gnus actually has to fetch each individual article from the server.  But
19834 you might want to anyway, I guess.  Even though there are three match
19835 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
19836 and stick with it in each score file.  If you use any two, each article
19837 will be fetched @emph{twice}.  If you want to match a bit on the
19838 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
19839 the matches.
19840
19841 @item Marking as read
19842 You will probably want to mark articles that have scores below a certain
19843 number as read.  This is most easily achieved by putting the following
19844 in your @file{all.SCORE} file:
19845 @lisp
19846 ((mark -100))
19847 @end lisp
19848 You may also consider doing something similar with @code{expunge}.
19849
19850 @item Negated character classes
19851 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
19852 That will match newlines, which might lead to, well, The Unknown.  Say
19853 @code{[^abcd\n]*} instead.
19854 @end table
19855
19856
19857 @node Reverse Scoring
19858 @section Reverse Scoring
19859 @cindex reverse scoring
19860
19861 If you want to keep just articles that have @samp{Sex with Emacs} in the
19862 subject header, and expunge all other articles, you could put something
19863 like this in your score file:
19864
19865 @lisp
19866 (("subject"
19867   ("Sex with Emacs" 2))
19868  (mark 1)
19869  (expunge 1))
19870 @end lisp
19871
19872 So, you raise all articles that match @samp{Sex with Emacs} and mark the
19873 rest as read, and expunge them to boot.
19874
19875
19876 @node Global Score Files
19877 @section Global Score Files
19878 @cindex global score files
19879
19880 Sure, other newsreaders have ``global kill files''.  These are usually
19881 nothing more than a single kill file that applies to all groups, stored
19882 in the user's home directory.  Bah!  Puny, weak newsreaders!
19883
19884 What I'm talking about here are Global Score Files.  Score files from
19885 all over the world, from users everywhere, uniting all nations in one
19886 big, happy score file union!  Ange-score!  New and untested!
19887
19888 @vindex gnus-global-score-files
19889 All you have to do to use other people's score files is to set the
19890 @code{gnus-global-score-files} variable.  One entry for each score file,
19891 or each score file directory.  Gnus will decide by itself what score
19892 files are applicable to which group.
19893
19894 To use the score file
19895 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
19896 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
19897 say this:
19898
19899 @lisp
19900 (setq gnus-global-score-files
19901       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
19902         "/ftp@@ftp.some-where:/pub/score/"))
19903 @end lisp
19904
19905 @findex gnus-score-search-global-directories
19906 @noindent
19907 Simple, eh?  Directory names must end with a @samp{/}.  These
19908 directories are typically scanned only once during each Gnus session.
19909 If you feel the need to manually re-scan the remote directories, you can
19910 use the @code{gnus-score-search-global-directories} command.
19911
19912 Note that, at present, using this option will slow down group entry
19913 somewhat.  (That is---a lot.)
19914
19915 If you want to start maintaining score files for other people to use,
19916 just put your score file up for anonymous ftp and announce it to the
19917 world.  Become a retro-moderator!  Participate in the retro-moderator
19918 wars sure to ensue, where retro-moderators battle it out for the
19919 sympathy of the people, luring them to use their score files on false
19920 premises!  Yay!  The net is saved!
19921
19922 Here are some tips for the would-be retro-moderator, off the top of my
19923 head:
19924
19925 @itemize @bullet
19926
19927 @item
19928 Articles heavily crossposted are probably junk.
19929 @item
19930 To lower a single inappropriate article, lower by @code{Message-ID}.
19931 @item
19932 Particularly brilliant authors can be raised on a permanent basis.
19933 @item
19934 Authors that repeatedly post off-charter for the group can safely be
19935 lowered out of existence.
19936 @item
19937 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
19938 articles completely.
19939
19940 @item
19941 Use expiring score entries to keep the size of the file down.  You
19942 should probably have a long expiry period, though, as some sites keep
19943 old articles for a long time.
19944 @end itemize
19945
19946 @dots{} I wonder whether other newsreaders will support global score files
19947 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
19948 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
19949 holding our breath yet?
19950
19951
19952 @node Kill Files
19953 @section Kill Files
19954 @cindex kill files
19955
19956 Gnus still supports those pesky old kill files.  In fact, the kill file
19957 entries can now be expiring, which is something I wrote before Daniel
19958 Quinlan thought of doing score files, so I've left the code in there.
19959
19960 In short, kill processing is a lot slower (and I do mean @emph{a lot})
19961 than score processing, so it might be a good idea to rewrite your kill
19962 files into score files.
19963
19964 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
19965 forms into this file, which means that you can use kill files as some
19966 sort of primitive hook function to be run on group entry, even though
19967 that isn't a very good idea.
19968
19969 Normal kill files look like this:
19970
19971 @lisp
19972 (gnus-kill "From" "Lars Ingebrigtsen")
19973 (gnus-kill "Subject" "ding")
19974 (gnus-expunge "X")
19975 @end lisp
19976
19977 This will mark every article written by me as read, and remove the
19978 marked articles from the summary buffer.  Very useful, you'll agree.
19979
19980 Other programs use a totally different kill file syntax.  If Gnus
19981 encounters what looks like a @code{rn} kill file, it will take a stab at
19982 interpreting it.
19983
19984 Two summary functions for editing a @sc{gnus} kill file:
19985
19986 @table @kbd
19987
19988 @item M-k
19989 @kindex M-k (Summary)
19990 @findex gnus-summary-edit-local-kill
19991 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
19992
19993 @item M-K
19994 @kindex M-K (Summary)
19995 @findex gnus-summary-edit-global-kill
19996 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
19997 @end table
19998
19999 Two group mode functions for editing the kill files:
20000
20001 @table @kbd
20002
20003 @item M-k
20004 @kindex M-k (Group)
20005 @findex gnus-group-edit-local-kill
20006 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20007
20008 @item M-K
20009 @kindex M-K (Group)
20010 @findex gnus-group-edit-global-kill
20011 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20012 @end table
20013
20014 Kill file variables:
20015
20016 @table @code
20017 @item gnus-kill-file-name
20018 @vindex gnus-kill-file-name
20019 A kill file for the group @samp{soc.motss} is normally called
20020 @file{soc.motss.KILL}.  The suffix appended to the group name to get
20021 this file name is detailed by the @code{gnus-kill-file-name} variable.
20022 The ``global'' kill file (not in the score file sense of ``global'', of
20023 course) is just called @file{KILL}.
20024
20025 @vindex gnus-kill-save-kill-file
20026 @item gnus-kill-save-kill-file
20027 If this variable is non-@code{nil}, Gnus will save the
20028 kill file after processing, which is necessary if you use expiring
20029 kills.
20030
20031 @item gnus-apply-kill-hook
20032 @vindex gnus-apply-kill-hook
20033 @findex gnus-apply-kill-file-unless-scored
20034 @findex gnus-apply-kill-file
20035 A hook called to apply kill files to a group.  It is
20036 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
20037 kill file if you have a score file for the same group, you can set this
20038 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
20039 kill files to be processed, you should set this variable to @code{nil}.
20040
20041 @item gnus-kill-file-mode-hook
20042 @vindex gnus-kill-file-mode-hook
20043 A hook called in kill-file mode buffers.
20044
20045 @end table
20046
20047
20048 @node Converting Kill Files
20049 @section Converting Kill Files
20050 @cindex kill files
20051 @cindex converting kill files
20052
20053 If you have loads of old kill files, you may want to convert them into
20054 score files.  If they are ``regular'', you can use
20055 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20056 by hand.
20057
20058 The kill to score conversion package isn't included in Gnus by default.
20059 You can fetch it from
20060 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20061
20062 If your old kill files are very complex---if they contain more
20063 non-@code{gnus-kill} forms than not, you'll have to convert them by
20064 hand.  Or just let them be as they are.  Gnus will still use them as
20065 before.
20066
20067
20068 @node Advanced Scoring
20069 @section Advanced Scoring
20070
20071 Scoring on Subjects and From headers is nice enough, but what if you're
20072 really interested in what a person has to say only when she's talking
20073 about a particular subject?  Or what if you really don't want to
20074 read what person A has to say when she's following up to person B, but
20075 want to read what she says when she's following up to person C?
20076
20077 By using advanced scoring rules you may create arbitrarily complex
20078 scoring patterns.
20079
20080 @menu
20081 * Advanced Scoring Syntax::     A definition.
20082 * Advanced Scoring Examples::   What they look like.
20083 * Advanced Scoring Tips::       Getting the most out of it.
20084 @end menu
20085
20086
20087 @node Advanced Scoring Syntax
20088 @subsection Advanced Scoring Syntax
20089
20090 Ordinary scoring rules have a string as the first element in the rule.
20091 Advanced scoring rules have a list as the first element.  The second
20092 element is the score to be applied if the first element evaluated to a
20093 non-@code{nil} value.
20094
20095 These lists may consist of three logical operators, one redirection
20096 operator, and various match operators.
20097
20098 Logical operators:
20099
20100 @table @code
20101 @item &
20102 @itemx and
20103 This logical operator will evaluate each of its arguments until it finds
20104 one that evaluates to @code{false}, and then it'll stop.  If all arguments
20105 evaluate to @code{true} values, then this operator will return
20106 @code{true}.
20107
20108 @item |
20109 @itemx or
20110 This logical operator will evaluate each of its arguments until it finds
20111 one that evaluates to @code{true}.  If no arguments are @code{true},
20112 then this operator will return @code{false}.
20113
20114 @item !
20115 @itemx not
20116 @itemx Â¬
20117 This logical operator only takes a single argument.  It returns the
20118 logical negation of the value of its argument.
20119
20120 @end table
20121
20122 There is an @dfn{indirection operator} that will make its arguments
20123 apply to the ancestors of the current article being scored.  For
20124 instance, @code{1-} will make score rules apply to the parent of the
20125 current article.  @code{2-} will make score rules apply to the
20126 grandparent of the current article.  Alternatively, you can write
20127 @code{^^}, where the number of @code{^}s (carets) says how far back into
20128 the ancestry you want to go.
20129
20130 Finally, we have the match operators.  These are the ones that do the
20131 real work.  Match operators are header name strings followed by a match
20132 and a match type.  A typical match operator looks like @samp{("from"
20133 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
20134 simple scoring, and the match types are also the same.
20135
20136
20137 @node Advanced Scoring Examples
20138 @subsection Advanced Scoring Examples
20139
20140 Please note that the following examples are score file rules.  To
20141 make a complete score file from them, surround them with another pair
20142 of parentheses.
20143
20144 Let's say you want to increase the score of articles written by Lars
20145 when he's talking about Gnus:
20146
20147 @example
20148 @group
20149 ((&
20150   ("from" "Lars Ingebrigtsen")
20151   ("subject" "Gnus"))
20152  1000)
20153 @end group
20154 @end example
20155
20156 Quite simple, huh?
20157
20158 When he writes long articles, he sometimes has something nice to say:
20159
20160 @example
20161 ((&
20162   ("from" "Lars Ingebrigtsen")
20163   (|
20164    ("subject" "Gnus")
20165    ("lines" 100 >)))
20166  1000)
20167 @end example
20168
20169 However, when he responds to things written by Reig Eigil Logge, you
20170 really don't want to read what he's written:
20171
20172 @example
20173 ((&
20174   ("from" "Lars Ingebrigtsen")
20175   (1- ("from" "Reig Eigir Logge")))
20176  -100000)
20177 @end example
20178
20179 Everybody that follows up Redmondo when he writes about disappearing
20180 socks should have their scores raised, but only when they talk about
20181 white socks.  However, when Lars talks about socks, it's usually not
20182 very interesting:
20183
20184 @example
20185 ((&
20186   (1-
20187    (&
20188     ("from" "redmondo@@.*no" r)
20189     ("body" "disappearing.*socks" t)))
20190   (! ("from" "Lars Ingebrigtsen"))
20191   ("body" "white.*socks"))
20192  1000)
20193 @end example
20194
20195 The possibilities are endless.
20196
20197
20198 @node Advanced Scoring Tips
20199 @subsection Advanced Scoring Tips
20200
20201 The @code{&} and @code{|} logical operators do short-circuit logic.
20202 That is, they stop processing their arguments when it's clear what the
20203 result of the operation will be.  For instance, if one of the arguments
20204 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20205 the rest of the arguments.  This means that you should put slow matches
20206 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20207 @samp{subject}) first.
20208
20209 The indirection arguments (@code{1-} and so on) will make their
20210 arguments work on previous generations of the thread.  If you say
20211 something like:
20212
20213 @example
20214 ...
20215 (1-
20216  (1-
20217   ("from" "lars")))
20218 ...
20219 @end example
20220
20221 Then that means "score on the from header of the grandparent of the
20222 current article".  An indirection is quite fast, but it's better to say:
20223
20224 @example
20225 (1-
20226  (&
20227   ("from" "Lars")
20228   ("subject" "Gnus")))
20229 @end example
20230
20231 than it is to say:
20232
20233 @example
20234 (&
20235  (1- ("from" "Lars"))
20236  (1- ("subject" "Gnus")))
20237 @end example
20238
20239
20240 @node Score Decays
20241 @section Score Decays
20242 @cindex score decays
20243 @cindex decays
20244
20245 You may find that your scores have a tendency to grow without
20246 bounds, especially if you're using adaptive scoring.  If scores get too
20247 big, they lose all meaning---they simply max out and it's difficult to
20248 use them in any sensible way.
20249
20250 @vindex gnus-decay-scores
20251 @findex gnus-decay-score
20252 @vindex gnus-decay-score-function
20253 Gnus provides a mechanism for decaying scores to help with this problem.
20254 When score files are loaded and @code{gnus-decay-scores} is
20255 non-@code{nil}, Gnus will run the score files through the decaying
20256 mechanism thereby lowering the scores of all non-permanent score rules.
20257 The decay itself if performed by the @code{gnus-decay-score-function}
20258 function, which is @code{gnus-decay-score} by default.  Here's the
20259 definition of that function:
20260
20261 @lisp
20262 (defun gnus-decay-score (score)
20263   "Decay SCORE according to `gnus-score-decay-constant'
20264 and `gnus-score-decay-scale'."
20265   (let ((n (- score
20266               (* (if (< score 0) -1 1)
20267                  (min (abs score)
20268                       (max gnus-score-decay-constant
20269                            (* (abs score)
20270                               gnus-score-decay-scale)))))))
20271     (if (and (featurep 'xemacs)
20272              ;; XEmacs' floor can handle only the floating point
20273              ;; number below the half of the maximum integer.
20274              (> (abs n) (lsh -1 -2)))
20275         (string-to-number
20276          (car (split-string (number-to-string n) "\\.")))
20277       (floor n))))
20278 @end lisp
20279
20280 @vindex gnus-score-decay-scale
20281 @vindex gnus-score-decay-constant
20282 @code{gnus-score-decay-constant} is 3 by default and
20283 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
20284
20285 @enumerate
20286 @item
20287 Scores between -3 and 3 will be set to 0 when this function is called.
20288
20289 @item
20290 Scores with magnitudes between 3 and 60 will be shrunk by 3.
20291
20292 @item
20293 Scores with magnitudes greater than 60 will be shrunk by 5% of the
20294 score.
20295 @end enumerate
20296
20297 If you don't like this decay function, write your own.  It is called
20298 with the score to be decayed as its only parameter, and it should return
20299 the new score, which should be an integer.
20300
20301 Gnus will try to decay scores once a day.  If you haven't run Gnus for
20302 four days, Gnus will decay the scores four times, for instance.
20303
20304 @iftex
20305 @iflatex
20306 @chapter Message
20307 @include message.texi
20308 @chapter Emacs MIME
20309 @include emacs-mime.texi
20310 @chapter Sieve
20311 @include sieve.texi
20312 @chapter PGG
20313 @include pgg.texi
20314 @chapter SASL
20315 @include sasl.texi
20316 @end iflatex
20317 @end iftex
20318
20319 @node Various
20320 @chapter Various
20321
20322 @menu
20323 * Process/Prefix::              A convention used by many treatment commands.
20324 * Interactive::                 Making Gnus ask you many questions.
20325 * Symbolic Prefixes::           How to supply some Gnus functions with options.
20326 * Formatting Variables::        You can specify what buffers should look like.
20327 * Window Layout::               Configuring the Gnus buffer windows.
20328 * Faces and Fonts::             How to change how faces look.
20329 * Compilation::                 How to speed Gnus up.
20330 * Mode Lines::                  Displaying information in the mode lines.
20331 * Highlighting and Menus::      Making buffers look all nice and cozy.
20332 * Buttons::                     Get tendinitis in ten easy steps!
20333 * Daemons::                     Gnus can do things behind your back.
20334 * NoCeM::                       How to avoid spam and other fatty foods.
20335 * Undo::                        Some actions can be undone.
20336 * Predicate Specifiers::        Specifying predicates.
20337 * Moderation::                  What to do if you're a moderator.
20338 * Image Enhancements::          Modern versions of Emacs/XEmacs can display images.
20339 * Fuzzy Matching::              What's the big fuzz?
20340 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
20341 * Other modes::                 Interaction with other modes.
20342 * Various Various::             Things that are really various.
20343 @end menu
20344
20345
20346 @node Process/Prefix
20347 @section Process/Prefix
20348 @cindex process/prefix convention
20349
20350 Many functions, among them functions for moving, decoding and saving
20351 articles, use what is known as the @dfn{Process/Prefix convention}.
20352
20353 This is a method for figuring out what articles the user wants the
20354 command to be performed on.
20355
20356 It goes like this:
20357
20358 If the numeric prefix is N, perform the operation on the next N
20359 articles, starting with the current one.  If the numeric prefix is
20360 negative, perform the operation on the previous N articles, starting
20361 with the current one.
20362
20363 @vindex transient-mark-mode
20364 If @code{transient-mark-mode} in non-@code{nil} and the region is
20365 active, all articles in the region will be worked upon.
20366
20367 If there is no numeric prefix, but some articles are marked with the
20368 process mark, perform the operation on the articles marked with
20369 the process mark.
20370
20371 If there is neither a numeric prefix nor any articles marked with the
20372 process mark, just perform the operation on the current article.
20373
20374 Quite simple, really, but it needs to be made clear so that surprises
20375 are avoided.
20376
20377 Commands that react to the process mark will push the current list of
20378 process marked articles onto a stack and will then clear all process
20379 marked articles.  You can restore the previous configuration with the
20380 @kbd{M P y} command (@pxref{Setting Process Marks}).
20381
20382 @vindex gnus-summary-goto-unread
20383 One thing that seems to shock & horrify lots of people is that, for
20384 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
20385 Since each @kbd{d} (which marks the current article as read) by default
20386 goes to the next unread article after marking, this means that @kbd{3 d}
20387 will mark the next three unread articles as read, no matter what the
20388 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
20389 @code{nil} for a more straightforward action.
20390
20391 Many commands do not use the process/prefix convention.  All commands
20392 that do explicitly say so in this manual.  To apply the process/prefix
20393 convention to commands that do not use it, you can use the @kbd{M-&}
20394 command.  For instance, to mark all the articles in the group as
20395 expirable, you could say @kbd{M P b M-& E}.
20396
20397
20398 @node Interactive
20399 @section Interactive
20400 @cindex interaction
20401
20402 @table @code
20403
20404 @item gnus-novice-user
20405 @vindex gnus-novice-user
20406 If this variable is non-@code{nil}, you are either a newcomer to the
20407 World of Usenet, or you are very cautious, which is a nice thing to be,
20408 really.  You will be given questions of the type ``Are you sure you want
20409 to do this?'' before doing anything dangerous.  This is @code{t} by
20410 default.
20411
20412 @item gnus-expert-user
20413 @vindex gnus-expert-user
20414 If this variable is non-@code{nil}, you will seldom be asked any
20415 questions by Gnus.  It will simply assume you know what you're doing, no
20416 matter how strange.
20417
20418 @item gnus-interactive-catchup
20419 @vindex gnus-interactive-catchup
20420 Require confirmation before catching up a group if non-@code{nil}.  It
20421 is @code{t} by default.
20422
20423 @item gnus-interactive-exit
20424 @vindex gnus-interactive-exit
20425 Require confirmation before exiting Gnus.  This variable is @code{t} by
20426 default.
20427 @end table
20428
20429
20430 @node Symbolic Prefixes
20431 @section Symbolic Prefixes
20432 @cindex symbolic prefixes
20433
20434 Quite a lot of Emacs commands react to the (numeric) prefix.  For
20435 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
20436 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
20437 rule of 900 to the current article.
20438
20439 This is all nice and well, but what if you want to give a command some
20440 additional information?  Well, what most commands do is interpret the
20441 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
20442 doesn't want a backup file to be created when saving the current buffer,
20443 for instance.  But what if you want to save without making a backup
20444 file, and you want Emacs to flash lights and play a nice tune at the
20445 same time?  You can't, and you're probably perfectly happy that way.
20446
20447 @kindex M-i (Summary)
20448 @findex gnus-symbolic-argument
20449 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
20450 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
20451 character typed in is the value.  You can stack as many @kbd{M-i}
20452 prefixes as you want.  @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
20453 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b C-M-u} means
20454 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
20455 @code{b}''.  You get the drift.
20456
20457 Typing in symbolic prefixes to commands that don't accept them doesn't
20458 hurt, but it doesn't do any good either.  Currently not many Gnus
20459 functions make use of the symbolic prefix.
20460
20461 If you're interested in how Gnus implements this, @pxref{Extended
20462 Interactive}.
20463
20464
20465 @node Formatting Variables
20466 @section Formatting Variables
20467 @cindex formatting variables
20468
20469 Throughout this manual you've probably noticed lots of variables called
20470 things like @code{gnus-group-line-format} and
20471 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
20472 output lines in the various buffers.  There's quite a lot of them.
20473 Fortunately, they all use the same syntax, so there's not that much to
20474 be annoyed by.
20475
20476 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
20477 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
20478 lots of percentages everywhere.
20479
20480 @menu
20481 * Formatting Basics::           A formatting variable is basically a format string.
20482 * Mode Line Formatting::        Some rules about mode line formatting variables.
20483 * Advanced Formatting::         Modifying output in various ways.
20484 * User-Defined Specs::          Having Gnus call your own functions.
20485 * Formatting Fonts::            Making the formatting look colorful and nice.
20486 * Positioning Point::           Moving point to a position after an operation.
20487 * Tabulation::                  Tabulating your output.
20488 * Wide Characters::             Dealing with wide characters.
20489 @end menu
20490
20491 Currently Gnus uses the following formatting variables:
20492 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
20493 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
20494 @code{gnus-group-mode-line-format},
20495 @code{gnus-summary-mode-line-format},
20496 @code{gnus-article-mode-line-format},
20497 @code{gnus-server-mode-line-format}, and
20498 @code{gnus-summary-pick-line-format}.
20499
20500 All these format variables can also be arbitrary elisp forms.  In that
20501 case, they will be @code{eval}ed to insert the required lines.
20502
20503 @kindex M-x gnus-update-format
20504 @findex gnus-update-format
20505 Gnus includes a command to help you while creating your own format
20506 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
20507 update the spec in question and pop you to a buffer where you can
20508 examine the resulting Lisp code to be run to generate the line.
20509
20510
20511
20512 @node Formatting Basics
20513 @subsection Formatting Basics
20514
20515 Each @samp{%} element will be replaced by some string or other when the
20516 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
20517 spec, and pad with spaces to get a 5-character field''.
20518
20519 As with normal C and Emacs Lisp formatting strings, the numerical
20520 modifier between the @samp{%} and the formatting type character will
20521 @dfn{pad} the output so that it is always at least that long.
20522 @samp{%5y} will make the field always (at least) five characters wide by
20523 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
20524 the right instead.
20525
20526 You may also wish to limit the length of the field to protect against
20527 particularly wide values.  For that you can say @samp{%4,6y}, which
20528 means that the field will never be more than 6 characters wide and never
20529 less than 4 characters wide.
20530
20531 Also Gnus supports some extended format specifications, such as
20532 @samp{%&user-date;}.
20533
20534
20535 @node Mode Line Formatting
20536 @subsection Mode Line Formatting
20537
20538 Mode line formatting variables (e.g.,
20539 @code{gnus-summary-mode-line-format}) follow the same rules as other,
20540 buffer line oriented formatting variables (@pxref{Formatting Basics})
20541 with the following two differences:
20542
20543 @enumerate
20544
20545 @item
20546 There must be no newline (@samp{\n}) at the end.
20547
20548 @item
20549 The special @samp{%%b} spec can be used to display the buffer name.
20550 Well, it's no spec at all, really---@samp{%%} is just a way to quote
20551 @samp{%} to allow it to pass through the formatting machinery unmangled,
20552 so that Emacs receives @samp{%b}, which is something the Emacs mode line
20553 display interprets to mean ``show the buffer name''.  For a full list of
20554 mode line specs Emacs understands, see the documentation of the
20555 @code{mode-line-format} variable.
20556
20557 @end enumerate
20558
20559
20560 @node Advanced Formatting
20561 @subsection Advanced Formatting
20562
20563 It is frequently useful to post-process the fields in some way.
20564 Padding, limiting, cutting off parts and suppressing certain values can
20565 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
20566 look like @samp{%~(cut 3)~(ignore "0")y}.
20567
20568 These are the valid modifiers:
20569
20570 @table @code
20571 @item pad
20572 @itemx pad-left
20573 Pad the field to the left with spaces until it reaches the required
20574 length.
20575
20576 @item pad-right
20577 Pad the field to the right with spaces until it reaches the required
20578 length.
20579
20580 @item max
20581 @itemx max-left
20582 Cut off characters from the left until it reaches the specified length.
20583
20584 @item max-right
20585 Cut off characters from the right until it reaches the specified
20586 length.
20587
20588 @item cut
20589 @itemx cut-left
20590 Cut off the specified number of characters from the left.
20591
20592 @item cut-right
20593 Cut off the specified number of characters from the right.
20594
20595 @item ignore
20596 Return an empty string if the field is equal to the specified value.
20597
20598 @item form
20599 Use the specified form as the field value when the @samp{@@} spec is
20600 used.
20601
20602 Here's an example:
20603
20604 @lisp
20605 "~(form (current-time-string))@@"
20606 @end lisp
20607
20608 @end table
20609
20610 Let's take an example.  The @samp{%o} spec in the summary mode lines
20611 will return a date in compact ISO8601 format---@samp{19960809T230410}.
20612 This is quite a mouthful, so we want to shave off the century number and
20613 the time, leaving us with a six-character date.  That would be
20614 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
20615 maxing, and we need the padding to ensure that the date is never less
20616 than 6 characters to make it look nice in columns.)
20617
20618 Ignoring is done first; then cutting; then maxing; and then as the very
20619 last operation, padding.
20620
20621 If you use lots of these advanced thingies, you'll find that Gnus gets
20622 quite slow.  This can be helped enormously by running @kbd{M-x
20623 gnus-compile} when you are satisfied with the look of your lines.
20624 @xref{Compilation}.
20625
20626
20627 @node User-Defined Specs
20628 @subsection User-Defined Specs
20629
20630 All the specs allow for inserting user defined specifiers---@samp{u}.
20631 The next character in the format string should be a letter.  Gnus
20632 will call the function @code{gnus-user-format-function-}@samp{X}, where
20633 @samp{X} is the letter following @samp{%u}.  The function will be passed
20634 a single parameter---what the parameter means depends on what buffer
20635 it's being called from.  The function should return a string, which will
20636 be inserted into the buffer just like information from any other
20637 specifier.  This function may also be called with dummy values, so it
20638 should protect against that.
20639
20640 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
20641 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
20642
20643 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
20644 much the same without defining new functions.  Here's an example:
20645 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
20646 given here will be evaluated to yield the current line number, and then
20647 inserted.
20648
20649
20650 @node Formatting Fonts
20651 @subsection Formatting Fonts
20652
20653 There are specs for highlighting, and these are shared by all the format
20654 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
20655 the special @code{mouse-face} property set, which means that it will be
20656 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
20657 over it.
20658
20659 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
20660 normal faces set using @code{gnus-face-0}, which is @code{bold} by
20661 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
20662 and so on.  Create as many faces as you wish.  The same goes for the
20663 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
20664 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
20665
20666 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
20667 special @code{balloon-help} property set to
20668 @code{gnus-balloon-face-0}.  If you say @samp{%1<<}, you'll get
20669 @code{gnus-balloon-face-1} and so on.  The @code{gnus-balloon-face-*}
20670 variables should be either strings or symbols naming functions that
20671 return a string.  When the mouse passes over text with this property
20672 set, a balloon window will appear and display the string.  Please
20673 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
20674 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
20675 XEmacs) for more information on this.  (For technical reasons, the
20676 guillemets have been approximated as @samp{<<} and @samp{>>} in this
20677 paragraph.)
20678
20679 Here's an alternative recipe for the group buffer:
20680
20681 @lisp
20682 ;; @r{Create three face types.}
20683 (setq gnus-face-1 'bold)
20684 (setq gnus-face-3 'italic)
20685
20686 ;; @r{We want the article count to be in}
20687 ;; @r{a bold and green face.  So we create}
20688 ;; @r{a new face called @code{my-green-bold}.}
20689 (copy-face 'bold 'my-green-bold)
20690 ;; @r{Set the color.}
20691 (set-face-foreground 'my-green-bold "ForestGreen")
20692 (setq gnus-face-2 'my-green-bold)
20693
20694 ;; @r{Set the new & fancy format.}
20695 (setq gnus-group-line-format
20696       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
20697 @end lisp
20698
20699 I'm sure you'll be able to use this scheme to create totally unreadable
20700 and extremely vulgar displays.  Have fun!
20701
20702 Note that the @samp{%(} specs (and friends) do not make any sense on the
20703 mode-line variables.
20704
20705 @node Positioning Point
20706 @subsection Positioning Point
20707
20708 Gnus usually moves point to a pre-defined place on each line in most
20709 buffers.  By default, point move to the first colon character on the
20710 line.  You can customize this behaviour in three different ways.
20711
20712 You can move the colon character to somewhere else on the line.
20713
20714 @findex gnus-goto-colon
20715 You can redefine the function that moves the point to the colon.  The
20716 function is called @code{gnus-goto-colon}.
20717
20718 But perhaps the most convenient way to deal with this, if you don't want
20719 to have a colon in your line, is to use the @samp{%*} specifier.  If you
20720 put a @samp{%*} somewhere in your format line definition, Gnus will
20721 place point there.
20722
20723
20724 @node Tabulation
20725 @subsection Tabulation
20726
20727 You can usually line up your displays by padding and cutting your
20728 strings.  However, when combining various strings of different size, it
20729 can often be more convenient to just output the strings, and then worry
20730 about lining up the following text afterwards.
20731
20732 To do that, Gnus supplies tabulator specs---@samp{%=}.  There are two
20733 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
20734
20735 @samp{%50=} will insert space characters to pad the line up to column
20736 50.  If the text is already past column 50, nothing will be inserted.
20737 This is the soft tabulator.
20738
20739 @samp{%-50=} will insert space characters to pad the line up to column
20740 50.  If the text is already past column 50, the excess text past column
20741 50 will be removed.  This is the hard tabulator.
20742
20743
20744 @node Wide Characters
20745 @subsection Wide Characters
20746
20747 Fixed width fonts in most countries have characters of the same width.
20748 Some countries, however, use Latin characters mixed with wider
20749 characters---most notable East Asian countries.
20750
20751 The problem is that when formatting, Gnus assumes that if a string is 10
20752 characters wide, it'll be 10 Latin characters wide on the screen.  In
20753 these countries, that's not true.
20754
20755 @vindex gnus-use-correct-string-widths
20756 To help fix this, you can set @code{gnus-use-correct-string-widths} to
20757 @code{t}.  This makes buffer generation slower, but the results will be
20758 prettier.  The default value under XEmacs is @code{t} but @code{nil}
20759 for Emacs.
20760
20761
20762 @node Window Layout
20763 @section Window Layout
20764 @cindex window layout
20765
20766 No, there's nothing here about X, so be quiet.
20767
20768 @vindex gnus-use-full-window
20769 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
20770 other windows and occupy the entire Emacs screen by itself.  It is
20771 @code{t} by default.
20772
20773 Setting this variable to @code{nil} kinda works, but there are
20774 glitches.  Use at your own peril.
20775
20776 @vindex gnus-buffer-configuration
20777 @code{gnus-buffer-configuration} describes how much space each Gnus
20778 buffer should be given.  Here's an excerpt of this variable:
20779
20780 @lisp
20781 ((group (vertical 1.0 (group 1.0 point)
20782                       (if gnus-carpal (group-carpal 4))))
20783  (article (vertical 1.0 (summary 0.25 point)
20784                         (article 1.0))))
20785 @end lisp
20786
20787 This is an alist.  The @dfn{key} is a symbol that names some action or
20788 other.  For instance, when displaying the group buffer, the window
20789 configuration function will use @code{group} as the key.  A full list of
20790 possible names is listed below.
20791
20792 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
20793 should occupy.  To take the @code{article} split as an example -
20794
20795 @lisp
20796 (article (vertical 1.0 (summary 0.25 point)
20797                        (article 1.0)))
20798 @end lisp
20799
20800 This @dfn{split} says that the summary buffer should occupy 25% of upper
20801 half of the screen, and that it is placed over the article buffer.  As
20802 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
20803 reaching for that calculator there).  However, the special number
20804 @code{1.0} is used to signal that this buffer should soak up all the
20805 rest of the space available after the rest of the buffers have taken
20806 whatever they need.  There should be only one buffer with the @code{1.0}
20807 size spec per split.
20808
20809 Point will be put in the buffer that has the optional third element
20810 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
20811 split where the tag @code{frame-focus} is a member (i.e. is the third or
20812 fourth element in the list, depending on whether the @code{point} tag is
20813 present) gets focus.
20814
20815 Here's a more complicated example:
20816
20817 @lisp
20818 (article (vertical 1.0 (group 4)
20819                        (summary 0.25 point)
20820                        (if gnus-carpal (summary-carpal 4))
20821                        (article 1.0)))
20822 @end lisp
20823
20824 If the size spec is an integer instead of a floating point number,
20825 then that number will be used to say how many lines a buffer should
20826 occupy, not a percentage.
20827
20828 If the @dfn{split} looks like something that can be @code{eval}ed (to be
20829 precise---if the @code{car} of the split is a function or a subr), this
20830 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
20831 be used as a split.  This means that there will be three buffers if
20832 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
20833 is non-@code{nil}.
20834
20835 Not complicated enough for you?  Well, try this on for size:
20836
20837 @lisp
20838 (article (horizontal 1.0
20839              (vertical 0.5
20840                  (group 1.0)
20841                  (gnus-carpal 4))
20842              (vertical 1.0
20843                  (summary 0.25 point)
20844                  (summary-carpal 4)
20845                  (article 1.0))))
20846 @end lisp
20847
20848 Whoops.  Two buffers with the mystery 100% tag.  And what's that
20849 @code{horizontal} thingie?
20850
20851 If the first element in one of the split is @code{horizontal}, Gnus will
20852 split the window horizontally, giving you two windows side-by-side.
20853 Inside each of these strips you may carry on all you like in the normal
20854 fashion.  The number following @code{horizontal} says what percentage of
20855 the screen is to be given to this strip.
20856
20857 For each split, there @emph{must} be one element that has the 100% tag.
20858 The splitting is never accurate, and this buffer will eat any leftover
20859 lines from the splits.
20860
20861 To be slightly more formal, here's a definition of what a valid split
20862 may look like:
20863
20864 @example
20865 @group
20866 split      = frame | horizontal | vertical | buffer | form
20867 frame      = "(frame " size *split ")"
20868 horizontal = "(horizontal " size *split ")"
20869 vertical   = "(vertical " size *split ")"
20870 buffer     = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
20871 size       = number | frame-params
20872 buf-name   = group | article | summary ...
20873 @end group
20874 @end example
20875
20876 The limitations are that the @code{frame} split can only appear as the
20877 top-level split.  @var{form} should be an Emacs Lisp form that should
20878 return a valid split.  We see that each split is fully recursive, and
20879 may contain any number of @code{vertical} and @code{horizontal} splits.
20880
20881 @vindex gnus-window-min-width
20882 @vindex gnus-window-min-height
20883 @cindex window height
20884 @cindex window width
20885 Finding the right sizes can be a bit complicated.  No window may be less
20886 than @code{gnus-window-min-height} (default 1) characters high, and all
20887 windows must be at least @code{gnus-window-min-width} (default 1)
20888 characters wide.  Gnus will try to enforce this before applying the
20889 splits.  If you want to use the normal Emacs window width/height limit,
20890 you can just set these two variables to @code{nil}.
20891
20892 If you're not familiar with Emacs terminology, @code{horizontal} and
20893 @code{vertical} splits may work the opposite way of what you'd expect.
20894 Windows inside a @code{horizontal} split are shown side-by-side, and
20895 windows within a @code{vertical} split are shown above each other.
20896
20897 @findex gnus-configure-frame
20898 If you want to experiment with window placement, a good tip is to call
20899 @code{gnus-configure-frame} directly with a split.  This is the function
20900 that does all the real work when splitting buffers.  Below is a pretty
20901 nonsensical configuration with 5 windows; two for the group buffer and
20902 three for the article buffer.  (I said it was nonsensical.)  If you
20903 @code{eval} the statement below, you can get an idea of how that would
20904 look straight away, without going through the normal Gnus channels.
20905 Play with it until you're satisfied, and then use
20906 @code{gnus-add-configuration} to add your new creation to the buffer
20907 configuration list.
20908
20909 @lisp
20910 (gnus-configure-frame
20911  '(horizontal 1.0
20912     (vertical 10
20913       (group 1.0)
20914       (article 0.3 point))
20915     (vertical 1.0
20916       (article 1.0)
20917       (horizontal 4
20918         (group 1.0)
20919         (article 10)))))
20920 @end lisp
20921
20922 You might want to have several frames as well.  No prob---just use the
20923 @code{frame} split:
20924
20925 @lisp
20926 (gnus-configure-frame
20927  '(frame 1.0
20928          (vertical 1.0
20929                    (summary 0.25 point frame-focus)
20930                    (article 1.0))
20931          (vertical ((height . 5) (width . 15)
20932                     (user-position . t)
20933                     (left . -1) (top . 1))
20934                    (picon 1.0))))
20935
20936 @end lisp
20937
20938 This split will result in the familiar summary/article window
20939 configuration in the first (or ``main'') frame, while a small additional
20940 frame will be created where picons will be shown.  As you can see,
20941 instead of the normal @code{1.0} top-level spec, each additional split
20942 should have a frame parameter alist as the size spec.
20943 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
20944 Reference Manual}.  Under XEmacs, a frame property list will be
20945 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
20946 is such a plist.
20947 The list of all possible keys for @code{gnus-buffer-configuration} can
20948 be found in its default value.
20949
20950 Note that the @code{message} key is used for both
20951 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
20952 it is desirable to distinguish between the two, something like this
20953 might be used:
20954
20955 @lisp
20956 (message (horizontal 1.0
20957                      (vertical 1.0 (message 1.0 point))
20958                      (vertical 0.24
20959                                (if (buffer-live-p gnus-summary-buffer)
20960                                    '(summary 0.5))
20961                                (group 1.0))))
20962 @end lisp
20963
20964 One common desire for a multiple frame split is to have a separate frame
20965 for composing mail and news while leaving the original frame intact.  To
20966 accomplish that, something like the following can be done:
20967
20968 @lisp
20969 (message
20970   (frame 1.0
20971          (if (not (buffer-live-p gnus-summary-buffer))
20972              (car (cdr (assoc 'group gnus-buffer-configuration)))
20973            (car (cdr (assoc 'summary gnus-buffer-configuration))))
20974          (vertical ((user-position . t) (top . 1) (left . 1)
20975                     (name . "Message"))
20976                    (message 1.0 point))))
20977 @end lisp
20978
20979 @findex gnus-add-configuration
20980 Since the @code{gnus-buffer-configuration} variable is so long and
20981 complicated, there's a function you can use to ease changing the config
20982 of a single setting: @code{gnus-add-configuration}.  If, for instance,
20983 you want to change the @code{article} setting, you could say:
20984
20985 @lisp
20986 (gnus-add-configuration
20987  '(article (vertical 1.0
20988                (group 4)
20989                (summary .25 point)
20990                (article 1.0))))
20991 @end lisp
20992
20993 You'd typically stick these @code{gnus-add-configuration} calls in your
20994 @file{~/.gnus.el} file or in some startup hook---they should be run after
20995 Gnus has been loaded.
20996
20997 @vindex gnus-always-force-window-configuration
20998 If all windows mentioned in the configuration are already visible, Gnus
20999 won't change the window configuration.  If you always want to force the
21000 ``right'' window configuration, you can set
21001 @code{gnus-always-force-window-configuration} to non-@code{nil}.
21002
21003 If you're using tree displays (@pxref{Tree Display}), and the tree
21004 window is displayed vertically next to another window, you may also want
21005 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
21006 windows resized.
21007
21008 @subsection Example Window Configurations
21009
21010 @itemize @bullet
21011 @item
21012 Narrow left hand side occupied by group buffer.  Right hand side split
21013 between summary buffer (top one-sixth) and article buffer (bottom).
21014
21015 @ifinfo
21016 @example
21017 +---+---------+
21018 | G | Summary |
21019 | r +---------+
21020 | o |         |
21021 | u | Article |
21022 | p |         |
21023 +---+---------+
21024 @end example
21025 @end ifinfo
21026
21027 @lisp
21028 (gnus-add-configuration
21029  '(article
21030    (horizontal 1.0
21031                (vertical 25 (group 1.0))
21032                (vertical 1.0
21033                          (summary 0.16 point)
21034                          (article 1.0)))))
21035
21036 (gnus-add-configuration
21037  '(summary
21038    (horizontal 1.0
21039                (vertical 25 (group 1.0))
21040                (vertical 1.0 (summary 1.0 point)))))
21041 @end lisp
21042
21043 @end itemize
21044
21045
21046 @node Faces and Fonts
21047 @section Faces and Fonts
21048 @cindex faces
21049 @cindex fonts
21050 @cindex colors
21051
21052 Fiddling with fonts and faces used to be very difficult, but these days
21053 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
21054 the face you want to alter, and alter it via the standard Customize
21055 interface.
21056
21057
21058 @node Compilation
21059 @section Compilation
21060 @cindex compilation
21061 @cindex byte-compilation
21062
21063 @findex gnus-compile
21064
21065 Remember all those line format specification variables?
21066 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
21067 on.  Now, Gnus will of course heed whatever these variables are, but,
21068 unfortunately, changing them will mean a quite significant slow-down.
21069 (The default values of these variables have byte-compiled functions
21070 associated with them, while the user-generated versions do not, of
21071 course.)
21072
21073 To help with this, you can run @kbd{M-x gnus-compile} after you've
21074 fiddled around with the variables and feel that you're (kind of)
21075 satisfied.  This will result in the new specs being byte-compiled, and
21076 you'll get top speed again.  Gnus will save these compiled specs in the
21077 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
21078 this function, though---you should compile them yourself by sticking
21079 them into the @file{~/.gnus.el} file and byte-compiling that file.)
21080
21081
21082 @node Mode Lines
21083 @section Mode Lines
21084 @cindex mode lines
21085
21086 @vindex gnus-updated-mode-lines
21087 @code{gnus-updated-mode-lines} says what buffers should keep their mode
21088 lines updated.  It is a list of symbols.  Supported symbols include
21089 @code{group}, @code{article}, @code{summary}, @code{server},
21090 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
21091 Gnus will keep that mode line updated with information that may be
21092 pertinent.  If this variable is @code{nil}, screen refresh may be
21093 quicker.
21094
21095 @cindex display-time
21096
21097 @vindex gnus-mode-non-string-length
21098 By default, Gnus displays information on the current article in the mode
21099 lines of the summary and article buffers.  The information Gnus wishes
21100 to display (e.g. the subject of the article) is often longer than the
21101 mode lines, and therefore have to be cut off at some point.  The
21102 @code{gnus-mode-non-string-length} variable says how long the other
21103 elements on the line is (i.e., the non-info part).  If you put
21104 additional elements on the mode line (e.g. a clock), you should modify
21105 this variable:
21106
21107 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
21108 @lisp
21109 (add-hook 'display-time-hook
21110           (lambda () (setq gnus-mode-non-string-length
21111                            (+ 21
21112                               (if line-number-mode 5 0)
21113                               (if column-number-mode 4 0)
21114                               (length display-time-string)))))
21115 @end lisp
21116
21117 If this variable is @code{nil} (which is the default), the mode line
21118 strings won't be chopped off, and they won't be padded either.  Note
21119 that the default is unlikely to be desirable, as even the percentage
21120 complete in the buffer may be crowded off the mode line; the user should
21121 configure this variable appropriately for her configuration.
21122
21123
21124 @node Highlighting and Menus
21125 @section Highlighting and Menus
21126 @cindex visual
21127 @cindex highlighting
21128 @cindex menus
21129
21130 @vindex gnus-visual
21131 The @code{gnus-visual} variable controls most of the Gnus-prettifying
21132 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
21133 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
21134 file.
21135
21136 This variable can be a list of visual properties that are enabled.  The
21137 following elements are valid, and are all included by default:
21138
21139 @table @code
21140 @item group-highlight
21141 Do highlights in the group buffer.
21142 @item summary-highlight
21143 Do highlights in the summary buffer.
21144 @item article-highlight
21145 Do highlights in the article buffer.
21146 @item highlight
21147 Turn on highlighting in all buffers.
21148 @item group-menu
21149 Create menus in the group buffer.
21150 @item summary-menu
21151 Create menus in the summary buffers.
21152 @item article-menu
21153 Create menus in the article buffer.
21154 @item browse-menu
21155 Create menus in the browse buffer.
21156 @item server-menu
21157 Create menus in the server buffer.
21158 @item score-menu
21159 Create menus in the score buffers.
21160 @item menu
21161 Create menus in all buffers.
21162 @end table
21163
21164 So if you only want highlighting in the article buffer and menus in all
21165 buffers, you could say something like:
21166
21167 @lisp
21168 (setq gnus-visual '(article-highlight menu))
21169 @end lisp
21170
21171 If you want highlighting only and no menus whatsoever, you'd say:
21172
21173 @lisp
21174 (setq gnus-visual '(highlight))
21175 @end lisp
21176
21177 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
21178 in all Gnus buffers.
21179
21180 Other general variables that influence the look of all buffers include:
21181
21182 @table @code
21183 @item gnus-mouse-face
21184 @vindex gnus-mouse-face
21185 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
21186 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
21187
21188 @end table
21189
21190 There are hooks associated with the creation of all the different menus:
21191
21192 @table @code
21193
21194 @item gnus-article-menu-hook
21195 @vindex gnus-article-menu-hook
21196 Hook called after creating the article mode menu.
21197
21198 @item gnus-group-menu-hook
21199 @vindex gnus-group-menu-hook
21200 Hook called after creating the group mode menu.
21201
21202 @item gnus-summary-menu-hook
21203 @vindex gnus-summary-menu-hook
21204 Hook called after creating the summary mode menu.
21205
21206 @item gnus-server-menu-hook
21207 @vindex gnus-server-menu-hook
21208 Hook called after creating the server mode menu.
21209
21210 @item gnus-browse-menu-hook
21211 @vindex gnus-browse-menu-hook
21212 Hook called after creating the browse mode menu.
21213
21214 @item gnus-score-menu-hook
21215 @vindex gnus-score-menu-hook
21216 Hook called after creating the score mode menu.
21217
21218 @end table
21219
21220
21221 @node Buttons
21222 @section Buttons
21223 @cindex buttons
21224 @cindex mouse
21225 @cindex click
21226
21227 Those new-fangled @dfn{mouse} contraptions is very popular with the
21228 young, hep kids who don't want to learn the proper way to do things
21229 these days.  Why, I remember way back in the summer of '89, when I was
21230 using Emacs on a Tops 20 system.  Three hundred users on one single
21231 machine, and every user was running Simula compilers.  Bah!
21232
21233 Right.
21234
21235 @vindex gnus-carpal
21236 Well, you can make Gnus display bufferfuls of buttons you can click to
21237 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
21238 really.  Tell the chiropractor I sent you.
21239
21240
21241 @table @code
21242
21243 @item gnus-carpal-mode-hook
21244 @vindex gnus-carpal-mode-hook
21245 Hook run in all carpal mode buffers.
21246
21247 @item gnus-carpal-button-face
21248 @vindex gnus-carpal-button-face
21249 Face used on buttons.
21250
21251 @item gnus-carpal-header-face
21252 @vindex gnus-carpal-header-face
21253 Face used on carpal buffer headers.
21254
21255 @item gnus-carpal-group-buffer-buttons
21256 @vindex gnus-carpal-group-buffer-buttons
21257 Buttons in the group buffer.
21258
21259 @item gnus-carpal-summary-buffer-buttons
21260 @vindex gnus-carpal-summary-buffer-buttons
21261 Buttons in the summary buffer.
21262
21263 @item gnus-carpal-server-buffer-buttons
21264 @vindex gnus-carpal-server-buffer-buttons
21265 Buttons in the server buffer.
21266
21267 @item gnus-carpal-browse-buffer-buttons
21268 @vindex gnus-carpal-browse-buffer-buttons
21269 Buttons in the browse buffer.
21270 @end table
21271
21272 All the @code{buttons} variables are lists.  The elements in these list
21273 are either cons cells where the @code{car} contains a text to be displayed and
21274 the @code{cdr} contains a function symbol, or a simple string.
21275
21276
21277 @node Daemons
21278 @section Daemons
21279 @cindex demons
21280 @cindex daemons
21281
21282 Gnus, being larger than any program ever written (allegedly), does lots
21283 of strange stuff that you may wish to have done while you're not
21284 present.  For instance, you may want it to check for new mail once in a
21285 while.  Or you may want it to close down all connections to all servers
21286 when you leave Emacs idle.  And stuff like that.
21287
21288 Gnus will let you do stuff like that by defining various
21289 @dfn{handlers}.  Each handler consists of three elements:  A
21290 @var{function}, a @var{time}, and an @var{idle} parameter.
21291
21292 Here's an example of a handler that closes connections when Emacs has
21293 been idle for thirty minutes:
21294
21295 @lisp
21296 (gnus-demon-close-connections nil 30)
21297 @end lisp
21298
21299 Here's a handler that scans for @acronym{PGP} headers every hour when
21300 Emacs is idle:
21301
21302 @lisp
21303 (gnus-demon-scan-pgp 60 t)
21304 @end lisp
21305
21306 This @var{time} parameter and that @var{idle} parameter work together
21307 in a strange, but wonderful fashion.  Basically, if @var{idle} is
21308 @code{nil}, then the function will be called every @var{time} minutes.
21309
21310 If @var{idle} is @code{t}, then the function will be called after
21311 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
21312 the function will never be called.  But once Emacs goes idle, the
21313 function will be called every @var{time} minutes.
21314
21315 If @var{idle} is a number and @var{time} is a number, the function will
21316 be called every @var{time} minutes only when Emacs has been idle for
21317 @var{idle} minutes.
21318
21319 If @var{idle} is a number and @var{time} is @code{nil}, the function
21320 will be called once every time Emacs has been idle for @var{idle}
21321 minutes.
21322
21323 And if @var{time} is a string, it should look like @samp{07:31}, and
21324 the function will then be called once every day somewhere near that
21325 time.  Modified by the @var{idle} parameter, of course.
21326
21327 @vindex gnus-demon-timestep
21328 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
21329 seconds.  This is 60 by default.  If you change that variable,
21330 all the timings in the handlers will be affected.)
21331
21332 So, if you want to add a handler, you could put something like this in
21333 your @file{~/.gnus.el} file:
21334
21335 @findex gnus-demon-add-handler
21336 @lisp
21337 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
21338 @end lisp
21339
21340 @findex gnus-demon-add-nocem
21341 @findex gnus-demon-add-scanmail
21342 @findex gnus-demon-add-rescan
21343 @findex gnus-demon-add-scan-timestamps
21344 @findex gnus-demon-add-disconnection
21345 Some ready-made functions to do this have been created:
21346 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
21347 @code{gnus-demon-add-nntp-close-connection},
21348 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
21349 @code{gnus-demon-add-scanmail}.  Just put those functions in your
21350 @file{~/.gnus.el} if you want those abilities.
21351
21352 @findex gnus-demon-init
21353 @findex gnus-demon-cancel
21354 @vindex gnus-demon-handlers
21355 If you add handlers to @code{gnus-demon-handlers} directly, you should
21356 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
21357 daemons, you can use the @code{gnus-demon-cancel} function.
21358
21359 Note that adding daemons can be pretty naughty if you over do it.  Adding
21360 functions that scan all news and mail from all servers every two seconds
21361 is a sure-fire way of getting booted off any respectable system.  So
21362 behave.
21363
21364
21365 @node NoCeM
21366 @section NoCeM
21367 @cindex nocem
21368 @cindex spam
21369
21370 @dfn{Spamming} is posting the same article lots and lots of times.
21371 Spamming is bad.  Spamming is evil.
21372
21373 Spamming is usually canceled within a day or so by various anti-spamming
21374 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
21375 NoCeM is pronounced ``no see-'em'', and means what the name
21376 implies---these are messages that make the offending articles, like, go
21377 away.
21378
21379 What use are these NoCeM messages if the articles are canceled anyway?
21380 Some sites do not honor cancel messages and some sites just honor cancels
21381 from a select few people.  Then you may wish to make use of the NoCeM
21382 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
21383
21384 Gnus can read and parse the messages in this group automatically, and
21385 this will make spam disappear.
21386
21387 There are some variables to customize, of course:
21388
21389 @table @code
21390 @item gnus-use-nocem
21391 @vindex gnus-use-nocem
21392 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
21393 by default.
21394
21395 @item gnus-nocem-groups
21396 @vindex gnus-nocem-groups
21397 Gnus will look for NoCeM messages in the groups in this list.  The
21398 default is
21399 @lisp
21400 ("news.lists.filters" "news.admin.net-abuse.bulletins"
21401  "alt.nocem.misc" "news.admin.net-abuse.announce")
21402 @end lisp
21403
21404 @item gnus-nocem-issuers
21405 @vindex gnus-nocem-issuers
21406 There are many people issuing NoCeM messages.  This list says what
21407 people you want to listen to.  The default is
21408 @lisp
21409 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
21410  "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
21411 @end lisp
21412 fine, upstanding citizens all of them.
21413
21414 Known despammers that you can put in this list are listed at@*
21415 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
21416
21417 You do not have to heed NoCeM messages from all these people---just the
21418 ones you want to listen to.  You also don't have to accept all NoCeM
21419 messages from the people you like.  Each NoCeM message has a @dfn{type}
21420 header that gives the message a (more or less, usually less) rigorous
21421 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
21422 @samp{binary}, and @samp{troll}.  To specify this, you have to use
21423 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
21424 Each condition is either a string (which is a regexp that matches types
21425 you want to use) or a list on the form @code{(not @var{string})}, where
21426 @var{string} is a regexp that matches types you don't want to use.
21427
21428 For instance, if you want all NoCeM messages from Chris Lewis except his
21429 @samp{troll} messages, you'd say:
21430
21431 @lisp
21432 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
21433 @end lisp
21434
21435 On the other hand, if you just want nothing but his @samp{spam} and
21436 @samp{spew} messages, you'd say:
21437
21438 @lisp
21439 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
21440 @end lisp
21441
21442 The specs are applied left-to-right.
21443
21444
21445 @item gnus-nocem-verifyer
21446 @vindex gnus-nocem-verifyer
21447 @findex mc-verify
21448 This should be a function for verifying that the NoCeM issuer is who she
21449 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
21450 function.  If this is too slow and you don't care for verification
21451 (which may be dangerous), you can set this variable to @code{nil}.
21452
21453 If you want signed NoCeM messages to be verified and unsigned messages
21454 not to be verified (but used anyway), you could do something like:
21455
21456 @lisp
21457 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
21458
21459 (defun my-gnus-mc-verify ()
21460   (not (eq 'forged
21461            (ignore-errors
21462              (if (mc-verify)
21463                  t
21464                'forged)))))
21465 @end lisp
21466
21467 This might be dangerous, though.
21468
21469 @item gnus-nocem-directory
21470 @vindex gnus-nocem-directory
21471 This is where Gnus will store its NoCeM cache files.  The default is@*
21472 @file{~/News/NoCeM/}.
21473
21474 @item gnus-nocem-expiry-wait
21475 @vindex gnus-nocem-expiry-wait
21476 The number of days before removing old NoCeM entries from the cache.
21477 The default is 15.  If you make it shorter Gnus will be faster, but you
21478 might then see old spam.
21479
21480 @item gnus-nocem-check-from
21481 @vindex gnus-nocem-check-from
21482 Non-@code{nil} means check for valid issuers in message bodies.
21483 Otherwise don't bother fetching articles unless their author matches a
21484 valid issuer; that is much faster if you are selective about the
21485 issuers.
21486
21487 @item gnus-nocem-check-article-limit
21488 @vindex gnus-nocem-check-article-limit
21489 If non-@code{nil}, the maximum number of articles to check in any NoCeM
21490 group.  NoCeM groups can be huge and very slow to process.
21491
21492 @end table
21493
21494 Using NoCeM could potentially be a memory hog.  If you have many living
21495 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
21496 big.  If this is a problem, you should kill off all (or most) of your
21497 unsubscribed groups (@pxref{Subscription Commands}).
21498
21499
21500 @node Undo
21501 @section Undo
21502 @cindex undo
21503
21504 It is very useful to be able to undo actions one has done.  In normal
21505 Emacs buffers, it's easy enough---you just push the @code{undo} button.
21506 In Gnus buffers, however, it isn't that simple.
21507
21508 The things Gnus displays in its buffer is of no value whatsoever to
21509 Gnus---it's all just data designed to look nice to the user.
21510 Killing a group in the group buffer with @kbd{C-k} makes the line
21511 disappear, but that's just a side-effect of the real action---the
21512 removal of the group in question from the internal Gnus structures.
21513 Undoing something like that can't be done by the normal Emacs
21514 @code{undo} function.
21515
21516 Gnus tries to remedy this somewhat by keeping track of what the user
21517 does and coming up with actions that would reverse the actions the user
21518 takes.  When the user then presses the @code{undo} key, Gnus will run
21519 the code to reverse the previous action, or the previous actions.
21520 However, not all actions are easily reversible, so Gnus currently offers
21521 a few key functions to be undoable.  These include killing groups,
21522 yanking groups, and changing the list of read articles of groups.
21523 That's it, really.  More functions may be added in the future, but each
21524 added function means an increase in data to be stored, so Gnus will
21525 never be totally undoable.
21526
21527 @findex gnus-undo-mode
21528 @vindex gnus-use-undo
21529 @findex gnus-undo
21530 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
21531 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
21532 default.  The @kbd{C-M-_} key performs the @code{gnus-undo}
21533 command, which should feel kinda like the normal Emacs @code{undo}
21534 command.
21535
21536
21537 @node Predicate Specifiers
21538 @section Predicate Specifiers
21539 @cindex predicate specifiers
21540
21541 Some Gnus variables are @dfn{predicate specifiers}.  This is a special
21542 form that allows flexible specification of predicates without having
21543 to type all that much.
21544
21545 These specifiers are lists consisting of functions, symbols and lists.
21546
21547 Here's an example:
21548
21549 @lisp
21550 (or gnus-article-unseen-p
21551     gnus-article-unread-p)
21552 @end lisp
21553
21554 The available symbols are @code{or}, @code{and} and @code{not}.  The
21555 functions all take one parameter.
21556
21557 @findex gnus-make-predicate
21558 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
21559 to create a function that can be called.  This input parameter to this
21560 function will be passed along to all the functions in the predicate
21561 specifier.
21562
21563
21564 @node Moderation
21565 @section Moderation
21566 @cindex moderation
21567
21568 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
21569 It is not included in the standard Gnus package.  Write a mail to
21570 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
21571 get a copy.
21572
21573 The moderation package is implemented as a minor mode for summary
21574 buffers.  Put
21575
21576 @lisp
21577 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
21578 @end lisp
21579
21580 in your @file{~/.gnus.el} file.
21581
21582 If you are the moderator of @samp{rec.zoofle}, this is how it's
21583 supposed to work:
21584
21585 @enumerate
21586 @item
21587 You split your incoming mail by matching on
21588 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
21589 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
21590
21591 @item
21592 You enter that group once in a while and post articles using the @kbd{e}
21593 (edit-and-post) or @kbd{s} (just send unedited) commands.
21594
21595 @item
21596 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
21597 articles that weren't approved by you, you can cancel them with the
21598 @kbd{c} command.
21599 @end enumerate
21600
21601 To use moderation mode in these two groups, say:
21602
21603 @lisp
21604 (setq gnus-moderated-list
21605       "^nnml:rec.zoofle$\\|^rec.zoofle$")
21606 @end lisp
21607
21608
21609 @node Image Enhancements
21610 @section Image Enhancements
21611
21612 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
21613 support images yet.}, is able to display pictures and stuff, so Gnus has
21614 taken advantage of that.
21615
21616 @menu
21617 * X-Face::                      Display a funky, teensy black-and-white image.
21618 * Face::                        Display a funkier, teensier colored image.
21619 * Smileys::                     Show all those happy faces the way they were meant to be shown.
21620 * Picons::                      How to display pictures of what you're reading.
21621 * XVarious::                    Other XEmacsy Gnusey variables.
21622 @end menu
21623
21624
21625 @node X-Face
21626 @subsection X-Face
21627 @cindex x-face
21628
21629 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
21630 depth) image that's supposed to represent the author of the message.
21631 It seems to be supported by an ever-growing number of mail and news
21632 readers.
21633
21634 @cindex x-face
21635 @findex gnus-article-display-x-face
21636 @vindex gnus-article-x-face-command
21637 @vindex gnus-article-x-face-too-ugly
21638 @iftex
21639 @iflatex
21640 \include{xface}
21641 @end iflatex
21642 @end iftex
21643 @c @anchor{X-Face}
21644
21645 Gnus now uses the internal ELisp-based @code{uncompface} program for
21646 decoding an @code{X-Face} header normally in Emacs.  While it doesn't
21647 require any other external program, you may feel it is slow if you are
21648 using a slow machine.  In such a case, you can modify the following
21649 variables:
21650
21651 @table @code
21652 @item uncompface-use-external
21653 @vindex uncompface-use-external
21654 Specify which of the internal or the external decoder should be used.
21655 @code{nil} means to use the internal ELisp-based @code{uncompface}
21656 program.  @code{t} means to use the external decoder.  The default value
21657 is normally @code{undecided} which means to determine it by checking
21658 whether the host machine is slow, being controlled by
21659 @code{uncompface-use-external-threshold} (which see).
21660
21661 @item uncompface-use-external-threshold
21662 @vindex uncompface-use-external-threshold
21663 A number of seconds to check whether the host machine is slow.  If the
21664 host takes time larger than this value for decoding an @code{X-Face}
21665 using the internal ELisp-based @code{uncompface} program, it will be
21666 changed to using the external decoder.
21667 @end table
21668
21669 If the internal decoder is invalidated or if you are using XEmacs,
21670 decoding an @code{X-Face} header either requires an Emacs that has
21671 @samp{compface} support (which most XEmacs versions has), or that you
21672 have @samp{compface} installed on your system.  If either is true,
21673 Gnus will default to displaying @code{X-Face} headers.
21674
21675 The variable that controls this is the
21676 @code{gnus-article-x-face-command} variable.  If this variable is a
21677 string, this string will be executed in a sub-shell.  If it is a
21678 function, this function will be called with the face as the argument.
21679 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
21680 the @code{From} header, the face will not be shown.
21681
21682 The default action under Emacs 20 is to fork off the @code{display}
21683 program@footnote{@code{display} is from the ImageMagick package.  For
21684 the @code{uncompface} and @code{icontopbm} programs look for a package
21685 like @code{compface} or @code{faces-xface} on a GNU/Linux system.}  to
21686 view the face.
21687
21688 Under XEmacs or Emacs 21+ with suitable image support, the default
21689 action is to display the face before the @code{From} header.  (It's
21690 nicer if XEmacs has been compiled with @code{X-Face} support---that
21691 will make display somewhat faster.  If there's no native @code{X-Face}
21692 support, Gnus will try to convert the @code{X-Face} header using
21693 external programs from the @code{pbmplus} package and
21694 friends.@footnote{On a GNU/Linux system look for packages with names
21695 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
21696
21697 (Note: @code{x-face} is used in the variable/function names, not
21698 @code{xface}).
21699
21700 Gnus provides a few convenience functions and variables to allow
21701 easier insertion of X-Face headers in outgoing messages.
21702
21703 @findex gnus-random-x-face
21704 @vindex gnus-convert-pbm-to-x-face-command
21705 @vindex gnus-x-face-directory
21706 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
21707 @code{gnus-x-face-directory} and picks one at random, and then
21708 converts it to the X-Face format by using the
21709 @code{gnus-convert-pbm-to-x-face-command} shell command.  The
21710 @samp{pbm} files should be 48x48 pixels big.  It returns the X-Face
21711 header data as a string.
21712
21713 @findex gnus-insert-random-x-face-header
21714 @code{gnus-insert-random-x-face-header} calls
21715 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
21716 randomly generated data.
21717
21718 @findex gnus-x-face-from-file
21719 @vindex gnus-convert-image-to-x-face-command
21720 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
21721 converts the file to X-Face format by using the
21722 @code{gnus-convert-image-to-x-face-command} shell command.
21723
21724 Here's how you would typically use the first function.  Put something
21725 like the following in your @file{~/.gnus.el} file:
21726
21727 @lisp
21728 (setq message-required-news-headers
21729       (nconc message-required-news-headers
21730              (list '(X-Face . gnus-random-x-face))))
21731 @end lisp
21732
21733 Using the last function would be something like this:
21734
21735 @lisp
21736 (setq message-required-news-headers
21737       (nconc message-required-news-headers
21738              (list '(X-Face . (lambda ()
21739                                 (gnus-x-face-from-file
21740                                  "~/My-face.gif"))))))
21741 @end lisp
21742
21743
21744 @node Face
21745 @subsection Face
21746 @cindex face
21747
21748 @c #### FIXME: faces and x-faces'implementations should really be harmonized.
21749
21750 @code{Face} headers are essentially a funkier version of @code{X-Face}
21751 ones. They describe a 48x48 pixel colored image that's supposed to
21752 represent the author of the message.
21753
21754 @cindex face
21755 @findex gnus-article-display-face
21756 The contents of a @code{Face} header must be a base64 encoded PNG image.
21757 See @uref{http://quimby.gnus.org/circus/face/} for the precise
21758 specifications.
21759
21760 Gnus provides a few convenience functions and variables to allow
21761 easier insertion of Face headers in outgoing messages.
21762
21763 @findex gnus-convert-png-to-face
21764 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
21765 726 bytes long, and converts it to a face.
21766
21767 @findex gnus-face-from-file
21768 @vindex gnus-convert-image-to-face-command
21769 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
21770 converts the file to Face format by using the
21771 @code{gnus-convert-image-to-face-command} shell command.
21772
21773 Here's how you would typically use this function. Put something like the
21774 following in your @file{~/.gnus.el} file:
21775
21776 @lisp
21777 (setq message-required-news-headers
21778       (nconc message-required-news-headers
21779              (list '(Face . (lambda ()
21780                               (gnus-face-from-file "~/face.jpg"))))))
21781 @end lisp
21782
21783
21784 @node Smileys
21785 @subsection Smileys
21786 @cindex smileys
21787
21788 @iftex
21789 @iflatex
21790 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
21791 \input{smiley}
21792 @end iflatex
21793 @end iftex
21794
21795 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
21796 currently the only package that uses Smiley, it is documented here.
21797
21798 In short---to use Smiley in Gnus, put the following in your
21799 @file{~/.gnus.el} file:
21800
21801 @lisp
21802 (setq gnus-treat-display-smileys t)
21803 @end lisp
21804
21805 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
21806 the like---to pictures and displays those instead of the text smiley
21807 faces.  The conversion is controlled by a list of regexps that matches
21808 text and maps that to file names.
21809
21810 @vindex smiley-regexp-alist
21811 The alist used is specified by the @code{smiley-regexp-alist}
21812 variable.  The first item in each element is the regexp to be matched;
21813 the second element is the regexp match group that is to be replaced by
21814 the picture; and the third element is the name of the file to be
21815 displayed.
21816
21817 The following variables customize where Smiley will look for these
21818 files:
21819
21820 @table @code
21821
21822 @item smiley-data-directory
21823 @vindex smiley-data-directory
21824 Where Smiley will look for smiley faces files.
21825
21826 @item gnus-smiley-file-types
21827 @vindex gnus-smiley-file-types
21828 List of suffixes on smiley file names to try.
21829
21830 @end table
21831
21832
21833 @node Picons
21834 @subsection Picons
21835
21836 @iftex
21837 @iflatex
21838 \include{picons}
21839 @end iflatex
21840 @end iftex
21841
21842 So@dots{}  You want to slow down your news reader even more!  This is a
21843 good way to do so.  It's also a great way to impress people staring
21844 over your shoulder as you read news.
21845
21846 What are Picons?  To quote directly from the Picons Web site:
21847
21848 @iftex
21849 @iflatex
21850 \margindex{}
21851 @end iflatex
21852 @end iftex
21853
21854 @quotation
21855 @dfn{Picons} is short for ``personal icons''.  They're small,
21856 constrained images used to represent users and domains on the net,
21857 organized into databases so that the appropriate image for a given
21858 e-mail address can be found.  Besides users and domains, there are picon
21859 databases for Usenet newsgroups and weather forecasts.  The picons are
21860 in either monochrome @code{XBM} format or color @code{XPM} and
21861 @code{GIF} formats.
21862 @end quotation
21863
21864 @vindex gnus-picon-databases
21865 For instructions on obtaining and installing the picons databases,
21866 point your Web browser at
21867 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
21868
21869 If you are using Debian GNU/Linux, saying @samp{apt-get install
21870 picons.*} will install the picons where Gnus can find them.
21871
21872 To enable displaying picons, simply make sure that
21873 @code{gnus-picon-databases} points to the directory containing the
21874 Picons databases.
21875
21876 The following variables offer control over where things are located.
21877
21878 @table @code
21879
21880 @item gnus-picon-databases
21881 @vindex gnus-picon-databases
21882 The location of the picons database.  This is a list of directories
21883 containing the @file{news}, @file{domains}, @file{users} (and so on)
21884 subdirectories.  Defaults to @code{("/usr/lib/picon"
21885 "/usr/local/faces")}.
21886
21887 @item gnus-picon-news-directories
21888 @vindex gnus-picon-news-directories
21889 List of subdirectories to search in @code{gnus-picon-databases} for
21890 newsgroups faces.  @code{("news")} is the default.
21891
21892 @item gnus-picon-user-directories
21893 @vindex gnus-picon-user-directories
21894 List of subdirectories to search in @code{gnus-picon-databases} for user
21895 faces.  @code{("users" "usenix" "local" "misc")} is the default.
21896
21897 @item gnus-picon-domain-directories
21898 @vindex gnus-picon-domain-directories
21899 List of subdirectories to search in @code{gnus-picon-databases} for
21900 domain name faces.  Defaults to @code{("domains")}.  Some people may
21901 want to add @samp{"unknown"} to this list.
21902
21903 @item gnus-picon-file-types
21904 @vindex gnus-picon-file-types
21905 Ordered list of suffixes on picon file names to try.  Defaults to
21906 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
21907
21908 @end table
21909
21910
21911 @node XVarious
21912 @subsection Various XEmacs Variables
21913
21914 @table @code
21915 @item gnus-xmas-glyph-directory
21916 @vindex gnus-xmas-glyph-directory
21917 This is where Gnus will look for pictures.  Gnus will normally
21918 auto-detect this directory, but you may set it manually if you have an
21919 unusual directory structure.
21920
21921 @item gnus-xmas-logo-color-alist
21922 @vindex gnus-xmas-logo-color-alist
21923 This is an alist where the key is a type symbol and the values are the
21924 foreground and background color of the splash page glyph.
21925
21926 @item gnus-xmas-logo-color-style
21927 @vindex gnus-xmas-logo-color-style
21928 This is the key used to look up the color in the alist described above.
21929 Valid values include @code{flame}, @code{pine}, @code{moss},
21930 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
21931 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
21932
21933 @item gnus-xmas-modeline-glyph
21934 @vindex gnus-xmas-modeline-glyph
21935 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
21936 default.
21937
21938 @end table
21939
21940 @subsubsection Toolbar
21941
21942 @table @code
21943
21944 @item gnus-use-toolbar
21945 @vindex gnus-use-toolbar
21946 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
21947 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
21948 @code{right-toolbar}, or @code{left-toolbar}.
21949
21950 @item gnus-group-toolbar
21951 @vindex gnus-group-toolbar
21952 The toolbar in the group buffer.
21953
21954 @item gnus-summary-toolbar
21955 @vindex gnus-summary-toolbar
21956 The toolbar in the summary buffer.
21957
21958 @item gnus-summary-mail-toolbar
21959 @vindex gnus-summary-mail-toolbar
21960 The toolbar in the summary buffer of mail groups.
21961
21962 @end table
21963
21964 @iftex
21965 @iflatex
21966 \margindex{}
21967 @end iflatex
21968 @end iftex
21969
21970
21971 @node Fuzzy Matching
21972 @section Fuzzy Matching
21973 @cindex fuzzy matching
21974
21975 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
21976 things like scoring, thread gathering and thread comparison.
21977
21978 As opposed to regular expression matching, fuzzy matching is very fuzzy.
21979 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
21980 means, and the implementation has changed over time.
21981
21982 Basically, it tries to remove all noise from lines before comparing.
21983 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
21984 out of the strings before comparing the results.  This often leads to
21985 adequate results---even when faced with strings generated by text
21986 manglers masquerading as newsreaders.
21987
21988
21989 @node Thwarting Email Spam
21990 @section Thwarting Email Spam
21991 @cindex email spam
21992 @cindex spam
21993 @cindex UCE
21994 @cindex unsolicited commercial email
21995
21996 In these last days of the Usenet, commercial vultures are hanging about
21997 and grepping through news like crazy to find email addresses they can
21998 foist off their scams and products to.  As a reaction to this, many
21999 people have started putting nonsense addresses into their @code{From}
22000 lines.  I think this is counterproductive---it makes it difficult for
22001 people to send you legitimate mail in response to things you write, as
22002 well as making it difficult to see who wrote what.  This rewriting may
22003 perhaps be a bigger menace than the unsolicited commercial email itself
22004 in the end.
22005
22006 The biggest problem I have with email spam is that it comes in under
22007 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
22008 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
22009 mail group, only to find two pyramid schemes, seven advertisements
22010 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
22011 and one mail asking me to repent and find some god.
22012
22013 This is annoying.  Here's what you can do about it.
22014
22015 @menu
22016 * The problem of spam::         Some background, and some solutions
22017 * Anti-Spam Basics::            Simple steps to reduce the amount of spam.
22018 * SpamAssassin::                How to use external anti-spam tools.
22019 * Hashcash::                    Reduce spam by burning CPU time.
22020 * Filtering Spam Using The Spam ELisp Package::
22021 * Filtering Spam Using Statistics with spam-stat::
22022 @end menu
22023
22024 @node The problem of spam
22025 @subsection The problem of spam
22026 @cindex email spam
22027 @cindex spam filtering approaches
22028 @cindex filtering approaches, spam
22029 @cindex UCE
22030 @cindex unsolicited commercial email
22031
22032 First, some background on spam.
22033
22034 If you have access to e-mail, you are familiar with spam (technically
22035 termed @acronym{UCE}, Unsolicited Commercial E-mail).  Simply put, it
22036 exists because e-mail delivery is very cheap compared to paper mail,
22037 so only a very small percentage of people need to respond to an UCE to
22038 make it worthwhile to the advertiser.  Ironically, one of the most
22039 common spams is the one offering a database of e-mail addresses for
22040 further spamming.  Senders of spam are usually called @emph{spammers},
22041 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
22042 @emph{morons} are in common use as well.
22043
22044 Spam comes from a wide variety of sources.  It is simply impossible to
22045 dispose of all spam without discarding useful messages.  A good
22046 example is the TMDA system, which requires senders
22047 unknown to you to confirm themselves as legitimate senders before
22048 their e-mail can reach you.  Without getting into the technical side
22049 of TMDA, a downside is clearly that e-mail from legitimate sources may
22050 be discarded if those sources can't or won't confirm themselves
22051 through the TMDA system.  Another problem with TMDA is that it
22052 requires its users to have a basic understanding of e-mail delivery
22053 and processing.
22054
22055 The simplest approach to filtering spam is filtering, at the mail
22056 server or when you sort through incoming mail.  If you get 200 spam
22057 messages per day from @samp{random-address@@vmadmin.com}, you block
22058 @samp{vmadmin.com}.  If you get 200 messages about @samp{VIAGRA}, you
22059 discard all messages with @samp{VIAGRA} in the message.  If you get
22060 lots of spam from Bulgaria, for example, you try to filter all mail
22061 from Bulgarian IPs.  
22062
22063 This, unfortunately, is a great way to discard legitimate e-mail.  The
22064 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
22065 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
22066 you should be obvious, so don't do it if you have the choice.
22067
22068 In another instance, the very informative and useful RISKS digest has
22069 been blocked by overzealous mail filters because it @strong{contained}
22070 words that were common in spam messages.  Nevertheless, in isolated
22071 cases, with great care, direct filtering of mail can be useful.
22072
22073 Another approach to filtering e-mail is the distributed spam
22074 processing, for instance DCC implements such a system.  In essence,
22075 @var{N} systems around the world agree that a machine @var{X} in
22076 Ghana, Estonia, or California is sending out spam e-mail, and these
22077 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
22078 database.  The criteria for spam detection vary---it may be the number
22079 of messages sent, the content of the messages, and so on.  When a user
22080 of the distributed processing system wants to find out if a message is
22081 spam, he consults one of those @var{N} systems.
22082
22083 Distributed spam processing works very well against spammers that send
22084 a large number of messages at once, but it requires the user to set up
22085 fairly complicated checks.  There are commercial and free distributed
22086 spam processing systems.  Distributed spam processing has its risks as
22087 well.  For instance legitimate e-mail senders have been accused of
22088 sending spam, and their web sites and mailing lists have been shut
22089 down for some time because of the incident.
22090
22091 The statistical approach to spam filtering is also popular.  It is
22092 based on a statistical analysis of previous spam messages.  Usually
22093 the analysis is a simple word frequency count, with perhaps pairs of
22094 words or 3-word combinations thrown into the mix.  Statistical
22095 analysis of spam works very well in most of the cases, but it can
22096 classify legitimate e-mail as spam in some cases.  It takes time to
22097 run the analysis, the full message must be analyzed, and the user has
22098 to store the database of spam analyses.  Statistical analysis on the
22099 server is gaining popularity.  This has the advantage of letting the
22100 user Just Read Mail, but has the disadvantage that it's harder to tell
22101 the server that it has misclassified mail.
22102
22103 Fighting spam is not easy, no matter what anyone says.  There is no
22104 magic switch that will distinguish Viagra ads from Mom's e-mails.
22105 Even people are having a hard time telling spam apart from non-spam,
22106 because spammers are actively looking to fool us into thinking they
22107 are Mom, essentially.  Spamming is irritating, irresponsible, and
22108 idiotic behavior from a bunch of people who think the world owes them
22109 a favor.  We hope the following sections will help you in fighting the
22110 spam plague.
22111
22112 @node Anti-Spam Basics
22113 @subsection Anti-Spam Basics
22114 @cindex email spam
22115 @cindex spam
22116 @cindex UCE
22117 @cindex unsolicited commercial email
22118
22119 One way of dealing with spam is having Gnus split out all spam into a
22120 @samp{spam} mail group (@pxref{Splitting Mail}).
22121
22122 First, pick one (1) valid mail address that you can be reached at, and
22123 put it in your @code{From} header of all your news articles.  (I've
22124 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
22125 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
22126 sysadmin whether your sendmail installation accepts keywords in the local
22127 part of the mail address.)
22128
22129 @lisp
22130 (setq message-default-news-headers
22131       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
22132 @end lisp
22133
22134 Then put the following split rule in @code{nnmail-split-fancy}
22135 (@pxref{Fancy Mail Splitting}):
22136
22137 @lisp
22138 (...
22139  (to "larsi@@trym.ifi.uio.no"
22140      (| ("subject" "re:.*" "misc")
22141         ("references" ".*@@.*" "misc")
22142         "spam"))
22143  ...)
22144 @end lisp
22145
22146 This says that all mail to this address is suspect, but if it has a
22147 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
22148 header, it's probably ok.  All the rest goes to the @samp{spam} group.
22149 (This idea probably comes from Tim Pierce.)
22150
22151 In addition, many mail spammers talk directly to your @acronym{SMTP} server
22152 and do not include your email address explicitly in the @code{To}
22153 header.  Why they do this is unknown---perhaps it's to thwart this
22154 thwarting scheme?  In any case, this is trivial to deal with---you just
22155 put anything not addressed to you in the @samp{spam} group by ending
22156 your fancy split rule in this way:
22157
22158 @lisp
22159 (
22160  ...
22161  (to "larsi" "misc")
22162  "spam")
22163 @end lisp
22164
22165 In my experience, this will sort virtually everything into the right
22166 group.  You still have to check the @samp{spam} group from time to time to
22167 check for legitimate mail, though.  If you feel like being a good net
22168 citizen, you can even send off complaints to the proper authorities on
22169 each unsolicited commercial email---at your leisure.
22170
22171 This works for me.  It allows people an easy way to contact me (they can
22172 just press @kbd{r} in the usual way), and I'm not bothered at all with
22173 spam.  It's a win-win situation.  Forging @code{From} headers to point
22174 to non-existent domains is yucky, in my opinion.
22175
22176 Be careful with this approach.  Spammers are wise to it.
22177
22178
22179 @node SpamAssassin
22180 @subsection SpamAssassin, Vipul's Razor, DCC, etc
22181 @cindex SpamAssassin
22182 @cindex Vipul's Razor
22183 @cindex DCC
22184
22185 The days where the hints in the previous section were sufficient in
22186 avoiding spam are coming to an end.  There are many tools out there
22187 that claim to reduce the amount of spam you get.  This section could
22188 easily become outdated fast, as new products replace old, but
22189 fortunately most of these tools seem to have similar interfaces.  Even
22190 though this section will use SpamAssassin as an example, it should be
22191 easy to adapt it to most other tools.
22192
22193 Note that this section does not involve the @code{spam.el} package,
22194 which is discussed in the next section.  If you don't care for all
22195 the features of @code{spam.el}, you can make do with these simple
22196 recipes.
22197
22198 If the tool you are using is not installed on the mail server, you
22199 need to invoke it yourself.  Ideas on how to use the
22200 @code{:postscript} mail source parameter (@pxref{Mail Source
22201 Specifiers}) follow.
22202
22203 @lisp
22204 (setq mail-sources
22205       '((file :prescript "formail -bs spamassassin < /var/mail/%u")
22206         (pop :user "jrl"
22207              :server "pophost"
22208              :postscript
22209              "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
22210 @end lisp
22211
22212 Once you manage to process your incoming spool somehow, thus making
22213 the mail contain e.g.@: a header indicating it is spam, you are ready to
22214 filter it out.  Using normal split methods (@pxref{Splitting Mail}):
22215
22216 @lisp
22217 (setq nnmail-split-methods '(("spam"  "^X-Spam-Flag: YES")
22218                              ...))
22219 @end lisp
22220
22221 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
22222
22223 @lisp
22224 (setq nnmail-split-methods 'nnmail-split-fancy
22225       nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
22226                              ...))
22227 @end lisp
22228
22229 Some people might not like the idea of piping the mail through various
22230 programs using a @code{:prescript} (if some program is buggy, you
22231 might lose all mail).  If you are one of them, another solution is to
22232 call the external tools during splitting.  Example fancy split method:
22233
22234 @lisp
22235 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
22236                              ...))
22237 (defun kevin-spamassassin ()
22238   (save-excursion
22239     (save-restriction
22240       (widen)
22241       (if (eq 1 (call-process-region (point-min) (point-max)
22242                                      "spamc" nil nil nil "-c"))
22243           "spam"))))
22244 @end lisp
22245
22246 Note that with the nnimap backend, message bodies will not be
22247 downloaded by default.  You need to set
22248 @code{nnimap-split-download-body} to @code{t} to do that
22249 (@pxref{Splitting in IMAP}).
22250
22251 That is about it.  As some spam is likely to get through anyway, you
22252 might want to have a nifty function to call when you happen to read
22253 spam.  And here is the nifty function:
22254
22255 @lisp
22256  (defun my-gnus-raze-spam ()
22257   "Submit SPAM to Vipul's Razor, then mark it as expirable."
22258   (interactive)
22259   (gnus-summary-show-raw-article)
22260   (gnus-summary-save-in-pipe "razor-report -f -d")
22261   (gnus-summary-mark-as-expirable 1))
22262 @end lisp
22263
22264 @node Hashcash
22265 @subsection Hashcash
22266 @cindex hashcash
22267
22268 A novel technique to fight spam is to require senders to do something
22269 costly for each message they send.  This has the obvious drawback that
22270 you cannot rely on everyone in the world using this technique,
22271 since it is not part of the Internet standards, but it may be useful
22272 in smaller communities.
22273
22274 While the tools in the previous section work well in practice, they
22275 work only because the tools are constantly maintained and updated as
22276 new form of spam appears.  This means that a small percentage of spam
22277 will always get through.  It also means that somewhere, someone needs
22278 to read lots of spam to update these tools.  Hashcash avoids that, but
22279 instead prefers that everyone you contact through e-mail supports the
22280 scheme.  You can view the two approaches as pragmatic vs dogmatic.
22281 The approaches have their own advantages and disadvantages, but as
22282 often in the real world, a combination of them is stronger than either
22283 one of them separately.
22284
22285 @cindex X-Hashcash
22286 The ``something costly'' is to burn CPU time, more specifically to
22287 compute a hash collision up to a certain number of bits.  The
22288 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
22289 header.  For more details, and for the external application
22290 @code{hashcash} you need to install to use this feature, see
22291 @uref{http://www.cypherspace.org/~adam/hashcash/}.  Even more
22292 information can be found at @uref{http://www.camram.org/}.
22293
22294 If you wish to call hashcash for each message you send, say something
22295 like:
22296
22297 @lisp
22298 (require 'hashcash)
22299 (add-hook 'message-send-hook 'mail-add-payment)
22300 @end lisp
22301
22302 The @file{hashcash.el} library can be found in the Gnus development
22303 contrib directory or at
22304 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}.
22305
22306 You will need to set up some additional variables as well:
22307
22308 @table @code
22309
22310 @item hashcash-default-payment
22311 @vindex hashcash-default-payment
22312 This variable indicates the default number of bits the hash collision
22313 should consist of.  By default this is 0, meaning nothing will be
22314 done.  Suggested useful values include 17 to 29.
22315
22316 @item hashcash-payment-alist
22317 @vindex hashcash-payment-alist
22318 Some receivers may require you to spend burn more CPU time than the
22319 default.  This variable contains a list of @samp{(@var{addr}
22320 @var{amount})} cells, where @var{addr} is the receiver (email address
22321 or newsgroup) and @var{amount} is the number of bits in the collision
22322 that is needed.  It can also contain @samp{(@var{addr} @var{string}
22323 @var{amount})} cells, where the @var{string} is the string to use
22324 (normally the email address or newsgroup name is used).
22325
22326 @item hashcash
22327 @vindex hashcash
22328 Where the @code{hashcash} binary is installed.
22329
22330 @end table
22331
22332 Currently there is no built in functionality in Gnus to verify
22333 hashcash cookies, it is expected that this is performed by your hand
22334 customized mail filtering scripts.  Improvements in this area would be
22335 a useful contribution, however.
22336
22337 @node Filtering Spam Using The Spam ELisp Package
22338 @subsection Filtering Spam Using The Spam ELisp Package
22339 @cindex spam filtering
22340 @cindex spam
22341
22342 The idea behind @file{spam.el} is to have a control center for spam detection
22343 and filtering in Gnus.  To that end, @file{spam.el} does two things: it
22344 filters new mail, and it analyzes mail known to be spam or ham.
22345 @dfn{Ham} is the name used throughout @file{spam.el} to indicate
22346 non-spam messages.
22347
22348 First of all, you @strong{must} run the function
22349 @code{spam-initialize} to autoload @code{spam.el} and to install the
22350 @code{spam.el} hooks.  There is one exception: if you use the
22351 @code{spam-use-stat} (@pxref{spam-stat spam filtering}) setting, you
22352 should turn it on before @code{spam-initialize}:
22353
22354 @example
22355 (setq spam-use-stat t) ;; if needed
22356 (spam-initialize)
22357 @end example
22358
22359 So, what happens when you load @file{spam.el}?
22360
22361 First, some hooks will get installed by @code{spam-initialize}.  There
22362 are some hooks for @code{spam-stat} so it can save its databases, and
22363 there are hooks so interesting things will happen when you enter and
22364 leave a group.  More on the sequence of events later (@pxref{Spam
22365 ELisp Package Sequence of Events}).
22366
22367 You get the following keyboard commands:
22368
22369 @table @kbd
22370
22371 @item M-d
22372 @itemx M s x
22373 @itemx S x
22374 @kindex M-d
22375 @kindex S x
22376 @kindex M s x
22377 @findex gnus-summary-mark-as-spam
22378 @code{gnus-summary-mark-as-spam}.
22379
22380 Mark current article as spam, showing it with the @samp{$} mark.
22381 Whenever you see a spam article, make sure to mark its summary line
22382 with @kbd{M-d} before leaving the group.  This is done automatically
22383 for unread articles in @emph{spam} groups.
22384
22385 @item M s t
22386 @itemx S t
22387 @kindex M s t
22388 @kindex S t
22389 @findex spam-bogofilter-score
22390 @code{spam-bogofilter-score}.
22391
22392 You must have Bogofilter installed for that command to work properly.
22393
22394 @xref{Bogofilter}.
22395
22396 @end table
22397
22398 Also, when you load @file{spam.el}, you will be able to customize its
22399 variables.  Try @code{customize-group} on the @samp{spam} variable
22400 group.
22401
22402 @menu
22403 * Spam ELisp Package Sequence of Events::  
22404 * Spam ELisp Package Filtering of Incoming Mail::  
22405 * Spam ELisp Package Global Variables::  
22406 * Spam ELisp Package Configuration Examples::  
22407 * Blacklists and Whitelists::   
22408 * BBDB Whitelists::             
22409 * Gmane Spam Reporting::        
22410 * Anti-spam Hashcash Payments::  
22411 * Blackholes::                  
22412 * Regular Expressions Header Matching::  
22413 * Bogofilter::                  
22414 * ifile spam filtering::        
22415 * spam-stat spam filtering::    
22416 * SpamOracle::                  
22417 * Extending the Spam ELisp package::  
22418 @end menu 
22419
22420 @node Spam ELisp Package Sequence of Events
22421 @subsubsection Spam ELisp Package Sequence of Events
22422 @cindex spam filtering
22423 @cindex spam filtering sequence of events
22424 @cindex spam
22425
22426 You must read this section to understand how @code{spam.el} works.
22427 Do not skip, speed-read, or glance through this section.
22428
22429 There are two @emph{contact points}, if you will, between
22430 @code{spam.el} and the rest of Gnus: checking new mail for spam, and
22431 leaving a group.
22432
22433 Getting new mail is done in one of two ways.  You can either split
22434 your incoming mail or you can classify new articles as ham or spam
22435 when you enter the group.
22436
22437 Splitting incoming mail is better suited to mail backends such as
22438 @code{nnml} or @code{nnimap} where new mail appears in a single file
22439 called a @dfn{Spool File}.  See @xref{Spam ELisp Package Filtering of
22440 Incoming Mail}.
22441
22442 For backends such as @code{nntp} there is no incoming mail spool, so
22443 an alternate mechanism must be used.  This may also happen for
22444 backends where the server is in charge of splitting incoming mail, and
22445 Gnus does not do further splitting.  The @code{spam-autodetect} and
22446 @code{spam-autodetect-methods} group parameters (accessible with
22447 @kbd{G c} and @kbd{G p} as usual), and the corresponding variables
22448 @code{gnus-spam-autodetect} and
22449 @code{gnus-spam-autodetect-methods} (accessible with @kbd{M-x
22450 customize-variable} as usual).
22451
22452 When @code{spam-autodetect} is used, it hooks into the process of
22453 entering a group.  Thus, entering a group with unseen or unread
22454 articles becomes the substitute for checking incoming mail.  Whether
22455 only unseen articles or all unread articles will be processed is
22456 determined by the @code{spam-autodetect-recheck-messages}.  When set
22457 to @code{t}, unread messages will be rechecked.
22458
22459 @code{spam-autodetect} grants the user at once more and less control
22460 of spam filtering.  The user will have more control over each group's
22461 spam methods, so for instance the @samp{ding} group may have
22462 @code{spam-use-BBDB} as the autodetection method, while the
22463 @samp{suspect} group may have the @code{spam-use-blacklist} and
22464 @code{spam-use-bogofilter} methods enabled.  Every article detected to
22465 be spam will be marked with the spam mark @samp{$} and processed on
22466 exit from the group as normal spam.  The user has less control over
22467 the @emph{sequence} of checks, as he might with @code{spam-split}.
22468
22469 When the newly split mail goes into groups, or messages are
22470 autodetected to be ham or spam, those groups must be exited (after
22471 entering, if needed) for further spam processing to happen.  It
22472 matters whether the group is considered a ham group, a spam group, or
22473 is unclassified, based on its @code{spam-content} parameter
22474 (@pxref{Spam ELisp Package Global Variables}).  Spam groups have the
22475 additional characteristic that, when entered, any unseen or unread
22476 articles (depending on the @code{spam-mark-only-unseen-as-spam}
22477 variable) will be marked as spam.  Thus, mail split into a spam group
22478 gets automatically marked as spam when you enter the group.
22479
22480 So, when you exit a group, the @code{spam-processors} are applied, if
22481 any are set, and the processed mail is moved to the
22482 @code{ham-process-destination} or the @code{spam-process-destination}
22483 depending on the article's classification.  If the
22484 @code{ham-process-destination} or the @code{spam-process-destination},
22485 whichever is appropriate, are @code{nil}, the article is left in the
22486 current group.
22487
22488 If a spam is found in any group (this can be changed to only non-spam
22489 groups with @code{spam-move-spam-nonspam-groups-only}), it is
22490 processed by the active @code{spam-processors} (@pxref{Spam ELisp
22491 Package Global Variables}) when the group is exited.  Furthermore, the
22492 spam is moved to the @code{spam-process-destination} (@pxref{Spam
22493 ELisp Package Global Variables}) for further training or deletion.
22494 You have to load the @code{gnus-registry.el} package and enable the
22495 @code{spam-log-to-registry} variable if you want spam to be processed
22496 no more than once.  Thus, spam is detected and processed everywhere,
22497 which is what most people want.  If the
22498 @code{spam-process-destination} is @code{nil}, the spam is marked as
22499 expired, which is usually the right thing to do.
22500
22501 If spam can not be moved---because of a read-only backend such as
22502 @acronym{NNTP}, for example, it will be copied.
22503
22504 If a ham mail is found in a ham group, as determined by the
22505 @code{ham-marks} parameter, it is processed as ham by the active ham
22506 @code{spam-processor} when the group is exited.  With the variables
22507 @code{spam-process-ham-in-spam-groups} and
22508 @code{spam-process-ham-in-nonham-groups} the behavior can be further
22509 altered so ham found anywhere can be processed.  You have to load the
22510 @code{gnus-registry.el} package and enable the
22511 @code{spam-log-to-registry} variable if you want ham to be processed
22512 no more than once.  Thus, ham is detected and processed only when
22513 necessary, which is what most people want.  More on this in
22514 @xref{Spam ELisp Package Configuration Examples}.
22515
22516 If ham can not be moved---because of a read-only backend such as
22517 @acronym{NNTP}, for example, it will be copied.
22518
22519 If all this seems confusing, don't worry.  Soon it will be as natural
22520 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
22521 50 years in the future yet.  Just trust us, it's not so bad.
22522
22523 @node Spam ELisp Package Filtering of Incoming Mail
22524 @subsubsection Spam ELisp Package Filtering of Incoming Mail
22525 @cindex spam filtering
22526 @cindex spam filtering incoming mail
22527 @cindex spam
22528
22529 To use the @file{spam.el} facilities for incoming mail filtering, you
22530 must add the following to your fancy split list
22531 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
22532
22533 @example
22534 (: spam-split)
22535 @end example
22536
22537 Note that the fancy split may be called @code{nnmail-split-fancy} or
22538 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
22539 nnimap back ends to retrieve your mail.
22540
22541 Also, @code{spam-split} will not modify incoming mail in any way.
22542
22543 The @code{spam-split} function will process incoming mail and send the
22544 mail considered to be spam into the group name given by the variable
22545 @code{spam-split-group}.  By default that group name is @samp{spam},
22546 but you can customize @code{spam-split-group}.  Make sure the contents
22547 of @code{spam-split-group} are an @emph{unqualified} group name, for
22548 instance in an @code{nnimap} server @samp{your-server} the value
22549 @samp{spam} will turn out to be @samp{nnimap+your-server:spam}.  The
22550 value @samp{nnimap+server:spam}, therefore, is wrong and will
22551 actually give you the group
22552 @samp{nnimap+your-server:nnimap+server:spam} which may or may not
22553 work depending on your server's tolerance for strange group names.
22554
22555 You can also give @code{spam-split} a parameter,
22556 e.g. @code{spam-use-regex-headers} or @code{"maybe-spam"}.  Why is
22557 this useful?
22558
22559 Take these split rules (with @code{spam-use-regex-headers} and
22560 @code{spam-use-blackholes} set):
22561
22562 @example
22563  nnimap-split-fancy '(|
22564                       (any "ding" "ding")
22565                       (: spam-split)
22566                       ;; @r{default mailbox}
22567                       "mail")
22568 @end example
22569
22570 Now, the problem is that you want all ding messages to make it to the
22571 ding folder.  But that will let obvious spam (for example, spam
22572 detected by SpamAssassin, and @code{spam-use-regex-headers}) through,
22573 when it's sent to the ding list.  On the other hand, some messages to
22574 the ding list are from a mail server in the blackhole list, so the
22575 invocation of @code{spam-split} can't be before the ding rule.
22576
22577 You can let SpamAssassin headers supersede ding rules, but all other
22578 @code{spam-split} rules (including a second invocation of the
22579 regex-headers check) will be after the ding rule:
22580
22581 @example
22582 nnimap-split-fancy
22583       '(|
22584         ;; @r{all spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
22585         (: spam-split "regex-spam" 'spam-use-regex-headers)
22586         (any "ding" "ding")
22587         ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
22588         (: spam-split)
22589         ;; @r{default mailbox}
22590         "mail")
22591 @end example
22592
22593 This lets you invoke specific @code{spam-split} checks depending on
22594 your particular needs, and to target the results of those checks to a
22595 particular spam group.  You don't have to throw all mail into all the
22596 spam tests.  Another reason why this is nice is that messages to
22597 mailing lists you have rules for don't have to have resource-intensive
22598 blackhole checks performed on them.  You could also specify different
22599 spam checks for your nnmail split vs. your nnimap split.  Go crazy.
22600
22601 You should still have specific checks such as
22602 @code{spam-use-regex-headers} set to @code{t}, even if you
22603 specifically invoke @code{spam-split} with the check.  The reason is
22604 that when loading @file{spam.el}, some conditional loading is done
22605 depending on what @code{spam-use-xyz} variables you have set.  This
22606 is usually not critical, though.
22607
22608 @emph{Note for IMAP users}
22609
22610 The boolean variable @code{nnimap-split-download-body} needs to be
22611 set, if you want to split based on the whole message instead of just
22612 the headers.  By default, the nnimap back end will only retrieve the
22613 message headers.  If you use @code{spam-check-bogofilter},
22614 @code{spam-check-ifile}, or @code{spam-check-stat} (the splitters that
22615 can benefit from the full message body), you should set this variable.
22616 It is not set by default because it will slow @acronym{IMAP} down, and
22617 that is not an appropriate decision to make on behalf of the user.
22618
22619 @xref{Splitting in IMAP}.
22620
22621 @emph{TODO: spam.el needs to provide a uniform way of training all the
22622 statistical databases.  Some have that functionality built-in, others
22623 don't.}
22624
22625 @node Spam ELisp Package Global Variables
22626 @subsubsection Spam ELisp Package Global Variables
22627 @cindex spam filtering
22628 @cindex spam filtering variables
22629 @cindex spam variables
22630 @cindex spam
22631
22632 @vindex gnus-spam-process-newsgroups
22633 The concepts of ham processors and spam processors are very important.
22634 Ham processors and spam processors for a group can be set with the
22635 @code{spam-process} group parameter, or the
22636 @code{gnus-spam-process-newsgroups} variable.  Ham processors take
22637 mail known to be non-spam (@emph{ham}) and process it in some way so
22638 that later similar mail will also be considered non-spam.  Spam
22639 processors take mail known to be spam and process it so similar spam
22640 will be detected later.
22641
22642 The format of the spam or ham processor entry used to be a symbol,
22643 but now it is a @sc{cons} cell.  See the individual spam processor entries
22644 for more information.
22645
22646 @vindex gnus-spam-newsgroup-contents
22647 Gnus learns from the spam you get.  You have to collect your spam in
22648 one or more spam groups, and set or customize the variable
22649 @code{spam-junk-mailgroups} as appropriate.  You can also declare
22650 groups to contain spam by setting their group parameter
22651 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
22652 by customizing the corresponding variable
22653 @code{gnus-spam-newsgroup-contents}.  The @code{spam-contents} group
22654 parameter and the @code{gnus-spam-newsgroup-contents} variable can
22655 also be used to declare groups as @emph{ham} groups if you set their
22656 classification to @code{gnus-group-spam-classification-ham}.  If
22657 groups are not classified by means of @code{spam-junk-mailgroups},
22658 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
22659 considered @emph{unclassified}.  All groups are unclassified by
22660 default.
22661
22662 @vindex gnus-spam-mark
22663 @cindex $
22664 In spam groups, all messages are considered to be spam by default:
22665 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
22666 group.  If you have seen a message, had it marked as spam, then
22667 unmarked it, it won't be marked as spam when you enter the group
22668 thereafter.  You can disable that behavior, so all unread messages
22669 will get the @samp{$} mark, if you set the
22670 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}.  You
22671 should remove the @samp{$} mark when you are in the group summary
22672 buffer for every message that is not spam after all.  To remove the
22673 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
22674 @kbd{d} for declaring it read the non-spam way.  When you leave a
22675 group, all spam-marked (@samp{$}) articles are sent to a spam
22676 processor which will study them as spam samples.
22677
22678 Messages may also be deleted in various other ways, and unless
22679 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
22680 and @samp{r} for default read or explicit delete, marks @samp{X} and
22681 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
22682 low scores, are all considered to be associated with articles which
22683 are not spam.  This assumption might be false, in particular if you
22684 use kill files or score files as means for detecting genuine spam, you
22685 should then adjust the @code{ham-marks} group parameter.
22686
22687 @defvar ham-marks
22688 You can customize this group or topic parameter to be the list of
22689 marks you want to consider ham.  By default, the list contains the
22690 deleted, read, killed, kill-filed, and low-score marks (the idea is
22691 that these articles have been read, but are not spam).  It can be
22692 useful to also include the tick mark in the ham marks.  It is not
22693 recommended to make the unread mark a ham mark, because it normally
22694 indicates a lack of classification.  But you can do it, and we'll be
22695 happy for you.
22696 @end defvar
22697
22698 @defvar spam-marks
22699 You can customize this group or topic parameter to be the list of
22700 marks you want to consider spam.  By default, the list contains only
22701 the spam mark.  It is not recommended to change that, but you can if
22702 you really want to.
22703 @end defvar
22704
22705 When you leave @emph{any} group, regardless of its
22706 @code{spam-contents} classification, all spam-marked articles are sent
22707 to a spam processor, which will study these as spam samples.  If you
22708 explicit kill a lot, you might sometimes end up with articles marked
22709 @samp{K} which you never saw, and which might accidentally contain
22710 spam.  Best is to make sure that real spam is marked with @samp{$},
22711 and nothing else.
22712
22713 @vindex gnus-ham-process-destinations
22714 When you leave a @emph{spam} group, all spam-marked articles are
22715 marked as expired after processing with the spam processor.  This is
22716 not done for @emph{unclassified} or @emph{ham} groups.  Also, any
22717 @strong{ham} articles in a spam group will be moved to a location
22718 determined by either the @code{ham-process-destination} group
22719 parameter or a match in the @code{gnus-ham-process-destinations}
22720 variable, which is a list of regular expressions matched with group
22721 names (it's easiest to customize this variable with @kbd{M-x
22722 customize-variable @key{RET} gnus-ham-process-destinations}).  Each
22723 newsgroup specification has the format @code{(@var{regexp}
22724 @var{processor})} in a standard Lisp list, if you prefer to customize
22725 the variable manually.  The ultimate location is a group name or
22726 names.  If the @code{ham-process-destination} parameter is not set,
22727 ham articles are left in place.  If the
22728 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
22729 set, the ham articles are marked as unread before being moved.
22730
22731 If ham can not be moved---because of a read-only backend such as
22732 @acronym{NNTP}, for example, it will be copied.
22733
22734 Note that you can use multiples destinations per group or regular
22735 expression!  This enables you to send your ham to a regular mail
22736 group and to a @emph{ham training} group.
22737
22738 When you leave a @emph{ham} group, all ham-marked articles are sent to
22739 a ham processor, which will study these as non-spam samples.
22740
22741 @vindex spam-process-ham-in-spam-groups
22742 By default the variable @code{spam-process-ham-in-spam-groups} is
22743 @code{nil}.  Set it to @code{t} if you want ham found in spam groups
22744 to be processed.  Normally this is not done, you are expected instead
22745 to send your ham to a ham group and process it there.
22746
22747 @vindex spam-process-ham-in-nonham-groups
22748 By default the variable @code{spam-process-ham-in-nonham-groups} is
22749 @code{nil}.  Set it to @code{t} if you want ham found in non-ham (spam
22750 or unclassified) groups to be processed.  Normally this is not done,
22751 you are expected instead to send your ham to a ham group and process
22752 it there.
22753
22754 @vindex gnus-spam-process-destinations
22755 When you leave a @emph{ham} or @emph{unclassified} group, all
22756 @strong{spam} articles are moved to a location determined by either
22757 the @code{spam-process-destination} group parameter or a match in the
22758 @code{gnus-spam-process-destinations} variable, which is a list of
22759 regular expressions matched with group names (it's easiest to
22760 customize this variable with @kbd{M-x customize-variable @key{RET}
22761 gnus-spam-process-destinations}).  Each newsgroup specification has
22762 the repeated format @code{(@var{regexp} @var{group})} and they are all
22763 in a standard Lisp list, if you prefer to customize the variable
22764 manually.  The ultimate location is a group name or names.  If the
22765 @code{spam-process-destination} parameter is not set, the spam
22766 articles are only expired.  The group name is fully qualified, meaning
22767 that if you see @samp{nntp:servername} before the group name in the
22768 group buffer then you need it here as well.
22769
22770 If spam can not be moved---because of a read-only backend such as
22771 @acronym{NNTP}, for example, it will be copied.
22772
22773 Note that you can use multiples destinations per group or regular
22774 expression!  This enables you to send your spam to multiple @emph{spam
22775 training} groups.
22776
22777 @vindex spam-log-to-registry
22778 The problem with processing ham and spam is that Gnus doesn't track
22779 this processing by default.  Enable the @code{spam-log-to-registry}
22780 variable so @code{spam.el} will use @code{gnus-registry.el} to track
22781 what articles have been processed, and avoid processing articles
22782 multiple times.  Keep in mind that if you limit the number of registry
22783 entries, this won't work as well as it does without a limit.
22784
22785 @vindex spam-mark-only-unseen-as-spam
22786 Set this variable if you want only unseen articles in spam groups to
22787 be marked as spam.  By default, it is set.  If you set it to
22788 @code{nil}, unread articles will also be marked as spam.
22789
22790 @vindex spam-mark-ham-unread-before-move-from-spam-group
22791 Set this variable if you want ham to be unmarked before it is moved
22792 out of the spam group.  This is very useful when you use something
22793 like the tick mark @samp{!} to mark ham---the article will be placed
22794 in your @code{ham-process-destination}, unmarked as if it came fresh
22795 from the mail server.
22796
22797 @vindex spam-autodetect-recheck-messages
22798 When autodetecting spam, this variable tells @code{spam.el} whether
22799 only unseen articles or all unread articles should be checked for
22800 spam.  It is recommended that you leave it off.
22801
22802 @node Spam ELisp Package Configuration Examples
22803 @subsubsection Spam ELisp Package Configuration Examples
22804 @cindex spam filtering
22805 @cindex spam filtering configuration examples
22806 @cindex spam configuration examples
22807 @cindex spam
22808
22809 @subsubheading Ted's setup
22810
22811 From Ted Zlatanov <tzz@@lifelogs.com>.
22812 @example
22813 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
22814 ;; @r{see @file{gnus-registry.el} for more information}
22815 (gnus-registry-initialize)
22816 (spam-initialize)
22817
22818 ;; @r{I like @kbd{C-s} for marking spam}
22819 (define-key gnus-summary-mode-map "\C-s" 'gnus-summary-mark-as-spam)
22820
22821 (setq
22822  spam-log-to-registry t     ; @r{for spam autodetection}
22823  spam-use-BBDB t
22824  spam-use-regex-headers t   ; @r{catch X-Spam-Flag (SpamAssassin)}
22825  ;; @r{all groups with @samp{spam} in the name contain spam}
22826  gnus-spam-newsgroup-contents
22827   '(("spam" gnus-group-spam-classification-spam))
22828  ;; @r{see documentation for these}
22829  spam-move-spam-nonspam-groups-only nil
22830  spam-mark-only-unseen-as-spam t
22831  spam-mark-ham-unread-before-move-from-spam-group t
22832  nnimap-split-rule 'nnimap-split-fancy
22833  ;; @r{understand what this does before you copy it to your own setup!}
22834  nnimap-split-fancy '(|
22835                       ;; @r{trace references to parents and put in their group}
22836                       (: gnus-registry-split-fancy-with-parent)
22837                       ;; @r{this will catch server-side SpamAssassin tags}
22838                       (: spam-split 'spam-use-regex-headers)
22839                       (any "ding" "ding")
22840                       ;; @r{note that spam by default will go to @samp{spam}}
22841                       (: spam-split)
22842                       ;; @r{default mailbox}
22843                       "mail"))
22844
22845 ;; @r{my parameters, set with @kbd{G p}}
22846
22847 ;; @r{all nnml groups, and all nnimap groups except}
22848 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
22849 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
22850 ;; @r{because it must have been detected manually}
22851
22852 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
22853
22854 ;; @r{all @acronym{NNTP} groups}
22855 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
22856 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
22857 ;; @r{send all spam to the training group}
22858  (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
22859
22860 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
22861 ((spam-autodetect . t))
22862
22863 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
22864
22865 ;; @r{this is a spam group}
22866 ((spam-contents gnus-group-spam-classification-spam)
22867
22868  ;; @r{any spam (which happens when I enter for all unseen messages,}
22869  ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
22870  ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
22871
22872  (spam-process-destination "nnimap+mail.lifelogs.com:train")
22873
22874  ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
22875  ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
22876
22877  (ham-process-destination "nnimap+mail.lifelogs.com:mail" 
22878                           "nnimap+mail.lifelogs.com:trainham")
22879  ;; @r{in this group, only @samp{!} marks are ham}
22880  (ham-marks
22881   (gnus-ticked-mark))
22882  ;; @r{remembers senders in the blacklist on the way out---this is}
22883  ;; @r{definitely not needed, it just makes me feel better}
22884  (spam-process (gnus-group-spam-exit-processor-blacklist)))
22885
22886 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
22887 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
22888 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
22889
22890 @end example
22891
22892 @subsubheading Using @file{spam.el} on an IMAP server with a statistical filter on the server
22893 From Reiner Steib <reiner.steib@@gmx.de>.
22894
22895 My provider has set up bogofilter (in combination with @acronym{DCC}) on
22896 the mail server (@acronym{IMAP}).  Recognized spam goes to
22897 @samp{spam.detected}, the rest goes through the normal filter rules,
22898 i.e. to @samp{some.folder} or to @samp{INBOX}.  Training on false
22899 positives or negatives is done by copying or moving the article to
22900 @samp{training.ham} or @samp{training.spam} respectively.  A cron job on
22901 the server feeds those to bogofilter with the suitable ham or spam
22902 options and deletes them from the @samp{training.ham} and
22903 @samp{training.spam} folders.
22904
22905 With the following entries in @code{gnus-parameters}, @code{spam.el}
22906 does most of the job for me:
22907
22908 @lisp
22909    ("nnimap:spam\\.detected"
22910     (gnus-article-sort-functions '(gnus-article-sort-by-chars))
22911     (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
22912     (spam-contents gnus-group-spam-classification-spam))
22913    ("nnimap:\\(INBOX\\|other-folders\\)"
22914     (spam-process-destination . "nnimap:training.spam")
22915     (spam-contents gnus-group-spam-classification-ham))
22916 @end lisp
22917
22918 @itemize 
22919
22920 @item @b{The Spam folder:}
22921
22922 In the folder @samp{spam.detected}, I have to check for false positives
22923 (i.e. legitimate mails, that were wrongly judged as spam by
22924 bogofilter or DCC).
22925
22926 Because of the @code{gnus-group-spam-classification-spam} entry, all
22927 messages are marked as spam (with @code{$}).  When I find a false
22928 positive, I mark the message with some other ham mark (@code{ham-marks},
22929 @ref{Spam ELisp Package Global Variables}).  On group exit, those
22930 messages are copied to both groups, @samp{INBOX} (where I want to have
22931 the article) and @samp{training.ham} (for training bogofilter) and
22932 deleted from the @samp{spam.detected} folder.
22933
22934 The @code{gnus-article-sort-by-chars} entry simplifies detection of
22935 false positives for me.  I receive lots of worms (sweN, @dots{}), that all
22936 have a similar size.  Grouping them by size (i.e. chars) makes finding
22937 other false positives easier.  (Of course worms aren't @i{spam}
22938 (@acronym{UCE}, @acronym{UBE}) strictly speaking.  Anyhow, bogofilter is
22939 an excellent tool for filtering those unwanted mails for me.)
22940
22941 @item @b{Ham folders:}
22942
22943 In my ham folders, I just hit @kbd{S x}
22944 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
22945 mail (false negative).  On group exit, those messages are moved to
22946 @samp{training.ham}.
22947 @end itemize
22948
22949 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
22950
22951 From Reiner Steib <reiner.steib@@gmx.de>.
22952
22953 With following entry in @code{gnus-parameters}, @kbd{S x}
22954 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
22955 groups as spam and reports the to Gmane at group exit:
22956
22957 @lisp
22958    ("^gmane\\."
22959     (spam-process (gnus-group-spam-exit-processor-report-gmane)))
22960 @end lisp
22961
22962 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
22963 because I don't read the groups directly from news.gmane.org, but
22964 through my local news server (leafnode).  I.e. the article numbers are
22965 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
22966 the @code{X-Report-Spam} header to find the correct number.
22967
22968 @node Blacklists and Whitelists
22969 @subsubsection Blacklists and Whitelists
22970 @cindex spam filtering
22971 @cindex whitelists, spam filtering
22972 @cindex blacklists, spam filtering
22973 @cindex spam
22974
22975 @defvar spam-use-blacklist
22976
22977 Set this variable to @code{t} if you want to use blacklists when
22978 splitting incoming mail.  Messages whose senders are in the blacklist
22979 will be sent to the @code{spam-split-group}.  This is an explicit
22980 filter, meaning that it acts only on mail senders @emph{declared} to
22981 be spammers.
22982
22983 @end defvar
22984
22985 @defvar spam-use-whitelist
22986
22987 Set this variable to @code{t} if you want to use whitelists when
22988 splitting incoming mail.  Messages whose senders are not in the
22989 whitelist will be sent to the next spam-split rule.  This is an
22990 explicit filter, meaning that unless someone is in the whitelist, their
22991 messages are not assumed to be spam or ham.
22992
22993 @end defvar
22994
22995 @defvar spam-use-whitelist-exclusive
22996
22997 Set this variable to @code{t} if you want to use whitelists as an
22998 implicit filter, meaning that every message will be considered spam
22999 unless the sender is in the whitelist.  Use with care.
23000
23001 @end defvar
23002
23003 @defvar gnus-group-spam-exit-processor-blacklist
23004
23005 Add this symbol to a group's @code{spam-process} parameter by
23006 customizing the group parameters or the
23007 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23008 added to a group's @code{spam-process} parameter, the senders of
23009 spam-marked articles will be added to the blacklist.
23010
23011 @emph{WARNING} 
23012
23013 Instead of the obsolete
23014 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
23015 that you use @code{'(spam spam-use-blacklist)}.  Everything will work
23016 the same way, we promise.
23017
23018 @end defvar
23019
23020 @defvar gnus-group-ham-exit-processor-whitelist
23021
23022 Add this symbol to a group's @code{spam-process} parameter by
23023 customizing the group parameters or the
23024 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23025 added to a group's @code{spam-process} parameter, the senders of
23026 ham-marked articles in @emph{ham} groups will be added to the
23027 whitelist.  Note that this ham processor has no effect in @emph{spam}
23028 or @emph{unclassified} groups.
23029
23030 @emph{WARNING} 
23031
23032 Instead of the obsolete
23033 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
23034 that you use @code{'(ham spam-use-whitelist)}.  Everything will work
23035 the same way, we promise.
23036
23037 @end defvar
23038
23039 Blacklists are lists of regular expressions matching addresses you
23040 consider to be spam senders.  For instance, to block mail from any
23041 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
23042 blacklist.  You start out with an empty blacklist.  Blacklist entries
23043 use the Emacs regular expression syntax.
23044
23045 Conversely, whitelists tell Gnus what addresses are considered
23046 legitimate.  All messages from whitelisted addresses are considered
23047 non-spam.  Also see @ref{BBDB Whitelists}.  Whitelist entries use the
23048 Emacs regular expression syntax.
23049
23050 The blacklist and whitelist file locations can be customized with the
23051 @code{spam-directory} variable (@file{~/News/spam} by default), or
23052 the @code{spam-whitelist} and @code{spam-blacklist} variables
23053 directly.  The whitelist and blacklist files will by default be in the
23054 @code{spam-directory} directory, named @file{whitelist} and
23055 @file{blacklist} respectively.
23056
23057 @node BBDB Whitelists
23058 @subsubsection BBDB Whitelists
23059 @cindex spam filtering
23060 @cindex BBDB whitelists, spam filtering
23061 @cindex BBDB, spam filtering
23062 @cindex spam
23063
23064 @defvar spam-use-BBDB
23065
23066 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
23067 Whitelists}), but uses the BBDB as the source of whitelisted
23068 addresses, without regular expressions.  You must have the BBDB loaded
23069 for @code{spam-use-BBDB} to work properly.  Messages whose senders are
23070 not in the BBDB will be sent to the next spam-split rule.  This is an
23071 explicit filter, meaning that unless someone is in the BBDB, their
23072 messages are not assumed to be spam or ham.
23073
23074 @end defvar
23075
23076 @defvar spam-use-BBDB-exclusive
23077
23078 Set this variable to @code{t} if you want to use the BBDB as an
23079 implicit filter, meaning that every message will be considered spam
23080 unless the sender is in the BBDB.  Use with care.  Only sender
23081 addresses in the BBDB will be allowed through; all others will be
23082 classified as spammers.
23083
23084 @end defvar
23085
23086 @defvar gnus-group-ham-exit-processor-BBDB
23087
23088 Add this symbol to a group's @code{spam-process} parameter by
23089 customizing the group parameters or the
23090 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23091 added to a group's @code{spam-process} parameter, the senders of
23092 ham-marked articles in @emph{ham} groups will be added to the
23093 BBDB.  Note that this ham processor has no effect in @emph{spam}
23094 or @emph{unclassified} groups.
23095
23096 @emph{WARNING} 
23097
23098 Instead of the obsolete
23099 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
23100 that you use @code{'(ham spam-use-BBDB)}.  Everything will work
23101 the same way, we promise.
23102
23103 @end defvar
23104
23105 @node Gmane Spam Reporting
23106 @subsubsection Gmane Spam Reporting
23107 @cindex spam reporting
23108 @cindex Gmane, spam reporting
23109 @cindex Gmane, spam reporting
23110 @cindex spam
23111
23112 @defvar gnus-group-spam-exit-processor-report-gmane
23113
23114 Add this symbol to a group's @code{spam-process} parameter by
23115 customizing the group parameters or the
23116 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23117 added to a group's @code{spam-process} parameter, the spam-marked
23118 articles groups will be reported to the Gmane administrators via a
23119 HTTP request.
23120
23121 Gmane can be found at @uref{http://gmane.org}.
23122
23123 @emph{WARNING} 
23124
23125 Instead of the obsolete
23126 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
23127 that you use @code{'(spam spam-use-gmane)}.  Everything will work the
23128 same way, we promise.
23129
23130 @end defvar
23131
23132 @defvar spam-report-gmane-use-article-number
23133
23134 This variable is @code{t} by default.  Set it to @code{nil} if you are
23135 running your own news server, for instance, and the local article
23136 numbers don't correspond to the Gmane article numbers.  When
23137 @code{spam-report-gmane-use-article-number} is @code{nil},
23138 @code{spam-report.el} will use the @code{X-Report-Spam} header that
23139 Gmane provides.
23140
23141 @end defvar
23142
23143 @node Anti-spam Hashcash Payments
23144 @subsubsection Anti-spam Hashcash Payments
23145 @cindex spam filtering
23146 @cindex hashcash, spam filtering
23147 @cindex spam
23148
23149 @defvar spam-use-hashcash
23150
23151 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
23152 Whitelists}), but uses hashcash tokens for whitelisting messages
23153 instead of the sender address.  You must have the @code{hashcash.el}
23154 package loaded for @code{spam-use-hashcash} to work properly.
23155 Messages without a hashcash payment token will be sent to the next
23156 spam-split rule.  This is an explicit filter, meaning that unless a
23157 hashcash token is found, the messages are not assumed to be spam or
23158 ham.
23159
23160 @end defvar
23161
23162 @node Blackholes
23163 @subsubsection Blackholes
23164 @cindex spam filtering
23165 @cindex blackholes, spam filtering
23166 @cindex spam
23167
23168 @defvar spam-use-blackholes
23169
23170 This option is disabled by default.  You can let Gnus consult the
23171 blackhole-type distributed spam processing systems (DCC, for instance)
23172 when you set this option.  The variable @code{spam-blackhole-servers}
23173 holds the list of blackhole servers Gnus will consult.  The current
23174 list is fairly comprehensive, but make sure to let us know if it
23175 contains outdated servers.
23176
23177 The blackhole check uses the @code{dig.el} package, but you can tell
23178 @file{spam.el} to use @code{dns.el} instead for better performance if
23179 you set @code{spam-use-dig} to @code{nil}.  It is not recommended at
23180 this time to set @code{spam-use-dig} to @code{nil} despite the
23181 possible performance improvements, because some users may be unable to
23182 use it, but you can try it and see if it works for you.
23183
23184 @end defvar
23185
23186 @defvar spam-blackhole-servers
23187
23188 The list of servers to consult for blackhole checks.
23189
23190 @end defvar
23191
23192 @defvar spam-blackhole-good-server-regex
23193
23194 A regular expression for IPs that should not be checked against the
23195 blackhole server list.  When set to @code{nil}, it has no effect.
23196
23197 @end defvar
23198
23199 @defvar spam-use-dig
23200
23201 Use the @code{dig.el} package instead of the @code{dns.el} package.
23202 The default setting of @code{t} is recommended.
23203
23204 @end defvar
23205
23206 Blackhole checks are done only on incoming mail.  There is no spam or
23207 ham processor for blackholes.
23208
23209 @node Regular Expressions Header Matching
23210 @subsubsection Regular Expressions Header Matching
23211 @cindex spam filtering
23212 @cindex regular expressions header matching, spam filtering
23213 @cindex spam
23214
23215 @defvar spam-use-regex-headers
23216
23217 This option is disabled by default.  You can let Gnus check the
23218 message headers against lists of regular expressions when you set this
23219 option.  The variables @code{spam-regex-headers-spam} and
23220 @code{spam-regex-headers-ham} hold the list of regular expressions.
23221 Gnus will check against the message headers to determine if the
23222 message is spam or ham, respectively.
23223
23224 @end defvar
23225
23226 @defvar spam-regex-headers-spam
23227
23228 The list of regular expressions that, when matched in the headers of
23229 the message, positively identify it as spam.
23230
23231 @end defvar
23232
23233 @defvar spam-regex-headers-ham
23234
23235 The list of regular expressions that, when matched in the headers of
23236 the message, positively identify it as ham.
23237
23238 @end defvar
23239
23240 Regular expression header checks are done only on incoming mail.
23241 There is no specific spam or ham processor for regular expressions.
23242
23243 @node Bogofilter
23244 @subsubsection Bogofilter
23245 @cindex spam filtering
23246 @cindex bogofilter, spam filtering
23247 @cindex spam
23248
23249 @defvar spam-use-bogofilter
23250
23251 Set this variable if you want @code{spam-split} to use Eric Raymond's
23252 speedy Bogofilter.
23253
23254 With a minimum of care for associating the @samp{$} mark for spam
23255 articles only, Bogofilter training all gets fairly automatic.  You
23256 should do this until you get a few hundreds of articles in each
23257 category, spam or not.  The command @kbd{S t} in summary mode, either
23258 for debugging or for curiosity, shows the @emph{spamicity} score of
23259 the current article (between 0.0 and 1.0).
23260
23261 Bogofilter determines if a message is spam based on a specific
23262 threshold.  That threshold can be customized, consult the Bogofilter
23263 documentation.
23264
23265 If the @code{bogofilter} executable is not in your path, Bogofilter
23266 processing will be turned off.
23267
23268 You should not enable this if you use @code{spam-use-bogofilter-headers}.
23269
23270 @end defvar
23271
23272 @defvar spam-use-bogofilter-headers
23273
23274 Set this variable if you want @code{spam-split} to use Eric Raymond's
23275 speedy Bogofilter, looking only at the message headers.  It works
23276 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
23277 must be in the message already.  Normally you would do this with a
23278 procmail recipe or something similar; consult the Bogofilter
23279 installation documents for details.
23280
23281 You should not enable this if you use @code{spam-use-bogofilter}.
23282
23283 @end defvar
23284
23285 @defvar gnus-group-spam-exit-processor-bogofilter
23286 Add this symbol to a group's @code{spam-process} parameter by
23287 customizing the group parameters or the
23288 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23289 added to a group's @code{spam-process} parameter, spam-marked articles
23290 will be added to the Bogofilter spam database.
23291
23292 @emph{WARNING} 
23293
23294 Instead of the obsolete
23295 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
23296 that you use @code{'(spam spam-use-bogofilter)}.  Everything will work
23297 the same way, we promise.
23298 @end defvar
23299
23300 @defvar gnus-group-ham-exit-processor-bogofilter
23301 Add this symbol to a group's @code{spam-process} parameter by
23302 customizing the group parameters or the
23303 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23304 added to a group's @code{spam-process} parameter, the ham-marked
23305 articles in @emph{ham} groups will be added to the Bogofilter database
23306 of non-spam messages.  Note that this ham processor has no effect in
23307 @emph{spam} or @emph{unclassified} groups.
23308
23309 @emph{WARNING} 
23310
23311 Instead of the obsolete
23312 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
23313 that you use @code{'(ham spam-use-bogofilter)}.  Everything will work
23314 the same way, we promise.
23315 @end defvar
23316
23317 @defvar spam-bogofilter-database-directory
23318
23319 This is the directory where Bogofilter will store its databases.  It
23320 is not specified by default, so Bogofilter will use its own default
23321 database directory.
23322
23323 @end defvar
23324
23325 The Bogofilter mail classifier is similar to @command{ifile} in intent and
23326 purpose.  A ham and a spam processor are provided, plus the
23327 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
23328 variables to indicate to spam-split that Bogofilter should either be
23329 used, or has already been used on the article.  The 0.9.2.1 version of
23330 Bogofilter was used to test this functionality.
23331
23332 @node ifile spam filtering
23333 @subsubsection ifile spam filtering
23334 @cindex spam filtering
23335 @cindex ifile, spam filtering
23336 @cindex spam
23337
23338 @defvar spam-use-ifile
23339
23340 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
23341 statistical analyzer similar to Bogofilter.
23342
23343 @end defvar
23344
23345 @defvar spam-ifile-all-categories
23346
23347 Enable this variable if you want @code{spam-use-ifile} to give you all
23348 the ifile categories, not just spam/non-spam.  If you use this, make
23349 sure you train ifile as described in its documentation.
23350
23351 @end defvar
23352
23353 @defvar spam-ifile-spam-category
23354
23355 This is the category of spam messages as far as ifile is concerned.
23356 The actual string used is irrelevant, but you probably want to leave
23357 the default value of @samp{spam}.
23358 @end defvar
23359
23360 @defvar spam-ifile-database-path
23361
23362 This is the filename for the ifile database.  It is not specified by
23363 default, so ifile will use its own default database name.
23364
23365 @end defvar
23366
23367 The ifile mail classifier is similar to Bogofilter in intent and
23368 purpose.  A ham and a spam processor are provided, plus the
23369 @code{spam-use-ifile} variable to indicate to spam-split that ifile
23370 should be used.  The 1.2.1 version of ifile was used to test this
23371 functionality.
23372
23373 @node spam-stat spam filtering
23374 @subsubsection spam-stat spam filtering
23375 @cindex spam filtering
23376 @cindex spam-stat, spam filtering
23377 @cindex spam-stat
23378 @cindex spam
23379
23380 @xref{Filtering Spam Using Statistics with spam-stat}.
23381
23382 @defvar spam-use-stat
23383
23384 Enable this variable if you want @code{spam-split} to use
23385 spam-stat.el, an Emacs Lisp statistical analyzer.
23386
23387 @end defvar
23388
23389 @defvar gnus-group-spam-exit-processor-stat
23390 Add this symbol to a group's @code{spam-process} parameter by
23391 customizing the group parameters or the
23392 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23393 added to a group's @code{spam-process} parameter, the spam-marked
23394 articles will be added to the spam-stat database of spam messages.
23395
23396 @emph{WARNING} 
23397
23398 Instead of the obsolete
23399 @code{gnus-group-spam-exit-processor-stat}, it is recommended
23400 that you use @code{'(spam spam-use-stat)}.  Everything will work
23401 the same way, we promise.
23402 @end defvar
23403
23404 @defvar gnus-group-ham-exit-processor-stat
23405 Add this symbol to a group's @code{spam-process} parameter by
23406 customizing the group parameters or the
23407 @code{gnus-spam-process-newsgroups} variable.  When this symbol is
23408 added to a group's @code{spam-process} parameter, the ham-marked
23409 articles in @emph{ham} groups will be added to the spam-stat database
23410 of non-spam messages.  Note that this ham processor has no effect in
23411 @emph{spam} or @emph{unclassified} groups.
23412
23413 @emph{WARNING} 
23414
23415 Instead of the obsolete
23416 @code{gnus-group-ham-exit-processor-stat}, it is recommended
23417 that you use @code{'(ham spam-use-stat)}.  Everything will work
23418 the same way, we promise.
23419 @end defvar
23420
23421 This enables @file{spam.el} to cooperate with @file{spam-stat.el}.
23422 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
23423 which unlike ifile or Bogofilter does not require external programs.
23424 A spam and a ham processor, and the @code{spam-use-stat} variable for
23425 @code{spam-split} are provided.
23426
23427 @node SpamOracle
23428 @subsubsection Using SpamOracle with Gnus
23429 @cindex spam filtering
23430 @cindex SpamOracle
23431 @cindex spam
23432
23433 An easy way to filter out spam is to use SpamOracle.  SpamOracle is an
23434 statistical mail filtering tool written by Xavier Leroy and needs to be
23435 installed separately.
23436
23437 There are several ways to use SpamOracle with Gnus.  In all cases, your
23438 mail is piped through SpamOracle in its @emph{mark} mode.  SpamOracle will
23439 then enter an @samp{X-Spam} header indicating whether it regards the
23440 mail as a spam mail or not.
23441
23442 One possibility is to run SpamOracle as a @code{:prescript} from the
23443 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}).  This method has
23444 the advantage that the user can see the @emph{X-Spam} headers.
23445
23446 The easiest method is to make @file{spam.el} (@pxref{Filtering Spam
23447 Using The Spam ELisp Package}) call SpamOracle.
23448
23449 @vindex spam-use-spamoracle
23450 To enable SpamOracle usage by @file{spam.el}, set the variable
23451 @code{spam-use-spamoracle} to @code{t} and configure the
23452 @code{nnmail-split-fancy} or @code{nnimap-split-fancy} as described in
23453 the section @xref{Filtering Spam Using The Spam ELisp Package}.  In
23454 this example the @samp{INBOX} of an nnimap server is filtered using
23455 SpamOracle.  Mails recognized as spam mails will be moved to
23456 @code{spam-split-group}, @samp{Junk} in this case.  Ham messages stay
23457 in @samp{INBOX}:
23458
23459 @example
23460 (setq spam-use-spamoracle t
23461       spam-split-group "Junk"
23462       nnimap-split-inbox '("INBOX")
23463       nnimap-split-rule 'nnimap-split-fancy
23464       nnimap-split-fancy '(| (: spam-split) "INBOX"))
23465 @end example
23466
23467 @defvar spam-use-spamoracle
23468 Set to @code{t} if you want Gnus to enable spam filtering using
23469 SpamOracle.
23470 @end defvar
23471
23472 @defvar spam-spamoracle-binary
23473 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
23474 user's PATH.  Using the variable @code{spam-spamoracle-binary}, this
23475 can be customized.
23476 @end defvar
23477
23478 @defvar spam-spamoracle-database
23479 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
23480 store its analyses.  This is controlled by the variable
23481 @code{spam-spamoracle-database} which defaults to @code{nil}.  That means
23482 the default SpamOracle database will be used.  In case you want your
23483 database to live somewhere special, set
23484 @code{spam-spamoracle-database} to this path.
23485 @end defvar
23486
23487 SpamOracle employs a statistical algorithm to determine whether a
23488 message is spam or ham.  In order to get good results, meaning few
23489 false hits or misses, SpamOracle needs training.  SpamOracle learns the
23490 characteristics of your spam mails.  Using the @emph{add} mode
23491 (training mode) one has to feed good (ham) and spam mails to
23492 SpamOracle.  This can be done by pressing @kbd{|} in the Summary buffer
23493 and pipe the mail to a SpamOracle process or using @file{spam.el}'s
23494 spam- and ham-processors, which is much more convenient.  For a
23495 detailed description of spam- and ham-processors, @xref{Filtering Spam
23496 Using The Spam ELisp Package}.
23497
23498 @defvar gnus-group-spam-exit-processor-spamoracle
23499 Add this symbol to a group's @code{spam-process} parameter by
23500 customizing the group parameter or the
23501 @code{gnus-spam-process-newsgroups} variable.  When this symbol is added
23502 to a group's @code{spam-process} parameter, spam-marked articles will be
23503 sent to SpamOracle as spam samples.
23504
23505 @emph{WARNING} 
23506
23507 Instead of the obsolete
23508 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
23509 that you use @code{'(spam spam-use-spamoracle)}.  Everything will work
23510 the same way, we promise.
23511 @end defvar
23512
23513 @defvar gnus-group-ham-exit-processor-spamoracle
23514 Add this symbol to a group's @code{spam-process} parameter by
23515 customizing the group parameter or the
23516 @code{gnus-spam-process-newsgroups} variable.  When this symbol is added
23517 to a group's @code{spam-process} parameter, the ham-marked articles in
23518 @emph{ham} groups will be sent to the SpamOracle as samples of ham
23519 messages.  Note that this ham processor has no effect in @emph{spam} or
23520 @emph{unclassified} groups.
23521
23522 @emph{WARNING} 
23523
23524 Instead of the obsolete
23525 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
23526 that you use @code{'(ham spam-use-spamoracle)}.  Everything will work
23527 the same way, we promise.
23528 @end defvar
23529
23530 @emph{Example:} These are the Group Parameters of a group that has been
23531 classified as a ham group, meaning that it should only contain ham
23532 messages.
23533 @example
23534  ((spam-contents gnus-group-spam-classification-ham)
23535   (spam-process ((ham spam-use-spamoracle)
23536                  (spam spam-use-spamoracle))))
23537 @end example
23538 For this group the @code{spam-use-spamoracle} is installed for both
23539 ham and spam processing.  If the group contains spam message
23540 (e.g. because SpamOracle has not had enough sample messages yet) and
23541 the user marks some messages as spam messages, these messages will be
23542 processed by SpamOracle.  The processor sends the messages to
23543 SpamOracle as new samples for spam.
23544
23545 @node Extending the Spam ELisp package
23546 @subsubsection Extending the Spam ELisp package
23547 @cindex spam filtering
23548 @cindex spam elisp package, extending
23549 @cindex extending the spam elisp package
23550
23551 Say you want to add a new back end called blackbox.  For filtering
23552 incoming mail, provide the following:
23553
23554 @enumerate
23555
23556 @item
23557 Code
23558
23559 @lisp
23560 (defvar spam-use-blackbox nil
23561   "True if blackbox should be used.")
23562 @end lisp
23563
23564 Add
23565 @lisp
23566 (spam-use-blackbox   . spam-check-blackbox)
23567 @end lisp
23568 to @code{spam-list-of-checks}.
23569
23570 Add
23571 @lisp
23572 (gnus-group-ham-exit-processor-blackbox  ham spam-use-blackbox)
23573 (gnus-group-spam-exit-processor-blackbox spam spam-use-blackbox)
23574 @end lisp
23575
23576 to @code{spam-list-of-processors}.
23577
23578 Add
23579 @lisp
23580 (spam-use-blackbox spam-blackbox-register-routine
23581                    nil
23582                    spam-blackbox-unregister-routine
23583                    nil)
23584 @end lisp
23585
23586 to @code{spam-registration-functions}.  Write the register/unregister
23587 routines using the bogofilter register/unregister routines as a
23588 start, or other restister/unregister routines more appropriate to
23589 Blackbox.
23590
23591 @item
23592 Functionality
23593
23594 Write the @code{spam-check-blackbox} function.  It should return
23595 @samp{nil} or @code{spam-split-group}, observing the other
23596 conventions.  See the existing @code{spam-check-*} functions for
23597 examples of what you can do, and stick to the template unless you
23598 fully understand the reasons why you aren't.
23599
23600 Make sure to add @code{spam-use-blackbox} to
23601 @code{spam-list-of-statistical-checks} if Blackbox is a statistical
23602 mail analyzer that needs the full message body to operate.
23603
23604 @end enumerate
23605
23606 For processing spam and ham messages, provide the following:
23607
23608 @enumerate
23609
23610 @item
23611 Code
23612
23613 Note you don't have to provide a spam or a ham processor.  Only
23614 provide them if Blackbox supports spam or ham processing.
23615
23616 Also, ham and spam processors are being phased out as single
23617 variables.  Instead the form @code{'(spam spam-use-blackbox)} or 
23618 @code{'(ham spam-use-blackbox)} is favored.  For now, spam/ham
23619 processor variables are still around but they won't be for long.
23620
23621 @lisp
23622 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
23623   "The Blackbox summary exit spam processor.
23624 Only applicable to spam groups.")
23625
23626 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
23627   "The whitelist summary exit ham processor.
23628 Only applicable to non-spam (unclassified and ham) groups.")
23629
23630 @end lisp
23631
23632 @item
23633 Gnus parameters
23634
23635 Add
23636 @lisp
23637 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
23638 (const :tag "Ham: Blackbox"  (ham spam-use-blackbox))
23639 @end lisp
23640 to the @code{spam-process} group parameter in @code{gnus.el}.  Make
23641 sure you do it twice, once for the parameter and once for the
23642 variable customization.
23643
23644 Add
23645 @lisp
23646 (variable-item spam-use-blackbox)
23647 @end lisp
23648 to the @code{spam-autodetect-methods} group parameter in
23649 @code{gnus.el}.
23650
23651 @end enumerate
23652
23653
23654 @node Filtering Spam Using Statistics with spam-stat
23655 @subsection Filtering Spam Using Statistics with spam-stat
23656 @cindex Paul Graham
23657 @cindex Graham, Paul
23658 @cindex naive Bayesian spam filtering
23659 @cindex Bayesian spam filtering, naive
23660 @cindex spam filtering, naive Bayesian
23661
23662 Paul Graham has written an excellent essay about spam filtering using
23663 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
23664 Spam}.  In it he describes the inherent deficiency of rule-based
23665 filtering as used by SpamAssassin, for example: Somebody has to write
23666 the rules, and everybody else has to install these rules.  You are
23667 always late.  It would be much better, he argues, to filter mail based
23668 on whether it somehow resembles spam or non-spam.  One way to measure
23669 this is word distribution.  He then goes on to describe a solution
23670 that checks whether a new mail resembles any of your other spam mails
23671 or not.
23672
23673 The basic idea is this:  Create a two collections of your mail, one
23674 with spam, one with non-spam.  Count how often each word appears in
23675 either collection, weight this by the total number of mails in the
23676 collections, and store this information in a dictionary.  For every
23677 word in a new mail, determine its probability to belong to a spam or a
23678 non-spam mail.  Use the 15 most conspicuous words, compute the total
23679 probability of the mail being spam.  If this probability is higher
23680 than a certain threshold, the mail is considered to be spam.
23681
23682 Gnus supports this kind of filtering.  But it needs some setting up.
23683 First, you need two collections of your mail, one with spam, one with
23684 non-spam.  Then you need to create a dictionary using these two
23685 collections, and save it.  And last but not least, you need to use
23686 this dictionary in your fancy mail splitting rules.
23687
23688 @menu
23689 * Creating a spam-stat dictionary::
23690 * Splitting mail using spam-stat::
23691 * Low-level interface to the spam-stat dictionary::
23692 @end menu
23693
23694 @node Creating a spam-stat dictionary
23695 @subsubsection Creating a spam-stat dictionary
23696
23697 Before you can begin to filter spam based on statistics, you must
23698 create these statistics based on two mail collections, one with spam,
23699 one with non-spam.  These statistics are then stored in a dictionary
23700 for later use.  In order for these statistics to be meaningful, you
23701 need several hundred emails in both collections.
23702
23703 Gnus currently supports only the nnml back end for automated dictionary
23704 creation.  The nnml back end stores all mails in a directory, one file
23705 per mail.  Use the following:
23706
23707 @defun spam-stat-process-spam-directory
23708 Create spam statistics for every file in this directory.  Every file
23709 is treated as one spam mail.
23710 @end defun
23711
23712 @defun spam-stat-process-non-spam-directory
23713 Create non-spam statistics for every file in this directory.  Every
23714 file is treated as one non-spam mail.
23715 @end defun
23716
23717 Usually you would call @code{spam-stat-process-spam-directory} on a
23718 directory such as @file{~/Mail/mail/spam} (this usually corresponds
23719 the the group @samp{nnml:mail.spam}), and you would call
23720 @code{spam-stat-process-non-spam-directory} on a directory such as
23721 @file{~/Mail/mail/misc} (this usually corresponds the the group
23722 @samp{nnml:mail.misc}).
23723
23724 When you are using @acronym{IMAP}, you won't have the mails available
23725 locally, so that will not work.  One solution is to use the Gnus Agent
23726 to cache the articles.  Then you can use directories such as
23727 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
23728 @code{spam-stat-process-spam-directory}.  @xref{Agent as Cache}.
23729
23730 @defvar spam-stat
23731 This variable holds the hash-table with all the statistics---the
23732 dictionary we have been talking about.  For every word in either
23733 collection, this hash-table stores a vector describing how often the
23734 word appeared in spam and often it appeared in non-spam mails.
23735 @end defvar
23736
23737 If you want to regenerate the statistics from scratch, you need to
23738 reset the dictionary.
23739
23740 @defun spam-stat-reset
23741 Reset the @code{spam-stat} hash-table, deleting all the statistics.
23742 @end defun
23743
23744 When you are done, you must save the dictionary.  The dictionary may
23745 be rather large.  If you will not update the dictionary incrementally
23746 (instead, you will recreate it once a month, for example), then you
23747 can reduce the size of the dictionary by deleting all words that did
23748 not appear often enough or that do not clearly belong to only spam or
23749 only non-spam mails.
23750
23751 @defun spam-stat-reduce-size
23752 Reduce the size of the dictionary.  Use this only if you do not want
23753 to update the dictionary incrementally.
23754 @end defun
23755
23756 @defun spam-stat-save
23757 Save the dictionary.
23758 @end defun
23759
23760 @defvar spam-stat-file
23761 The filename used to store the dictionary.  This defaults to
23762 @file{~/.spam-stat.el}.
23763 @end defvar
23764
23765 @node Splitting mail using spam-stat
23766 @subsubsection Splitting mail using spam-stat
23767
23768 In order to use @code{spam-stat} to split your mail, you need to add the
23769 following to your @file{~/.gnus.el} file:
23770
23771 @lisp
23772 (require 'spam-stat)
23773 (spam-stat-load)
23774 @end lisp
23775
23776 This will load the necessary Gnus code, and the dictionary you
23777 created.
23778
23779 Next, you need to adapt your fancy splitting rules:  You need to
23780 determine how to use @code{spam-stat}.  The following examples are for
23781 the nnml back end.  Using the nnimap back end works just as well.  Just
23782 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
23783
23784 In the simplest case, you only have two groups, @samp{mail.misc} and
23785 @samp{mail.spam}.  The following expression says that mail is either
23786 spam or it should go into @samp{mail.misc}.  If it is spam, then
23787 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
23788
23789 @lisp
23790 (setq nnmail-split-fancy
23791       `(| (: spam-stat-split-fancy)
23792           "mail.misc"))
23793 @end lisp
23794
23795 @defvar spam-stat-split-fancy-spam-group
23796 The group to use for spam.  Default is @samp{mail.spam}.
23797 @end defvar
23798
23799 If you also filter mail with specific subjects into other groups, use
23800 the following expression.  Only mails not matching the regular
23801 expression are considered potential spam.
23802
23803 @lisp
23804 (setq nnmail-split-fancy
23805       `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
23806           (: spam-stat-split-fancy)
23807           "mail.misc"))
23808 @end lisp
23809
23810 If you want to filter for spam first, then you must be careful when
23811 creating the dictionary.  Note that @code{spam-stat-split-fancy} must
23812 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
23813 non-spam, therefore both should be in your collection of non-spam
23814 mails, when creating the dictionary!
23815
23816 @lisp
23817 (setq nnmail-split-fancy
23818       `(| (: spam-stat-split-fancy)
23819           ("Subject" "\\bspam-stat\\b" "mail.emacs")
23820           "mail.misc"))
23821 @end lisp
23822
23823 You can combine this with traditional filtering.  Here, we move all
23824 HTML-only mails into the @samp{mail.spam.filtered} group.  Note that since
23825 @code{spam-stat-split-fancy} will never see them, the mails in
23826 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
23827 nor in your collection of non-spam mails, when creating the
23828 dictionary!
23829
23830 @lisp
23831 (setq nnmail-split-fancy
23832       `(| ("Content-Type" "text/html" "mail.spam.filtered")
23833           (: spam-stat-split-fancy)
23834           ("Subject" "\\bspam-stat\\b" "mail.emacs")
23835           "mail.misc"))
23836 @end lisp
23837
23838
23839 @node Low-level interface to the spam-stat dictionary
23840 @subsubsection Low-level interface to the spam-stat dictionary
23841
23842 The main interface to using @code{spam-stat}, are the following functions:
23843
23844 @defun spam-stat-buffer-is-spam
23845 Called in a buffer, that buffer is considered to be a new spam mail.
23846 Use this for new mail that has not been processed before.
23847 @end defun
23848
23849 @defun spam-stat-buffer-is-no-spam
23850 Called in a buffer, that buffer is considered to be a new non-spam
23851 mail.  Use this for new mail that has not been processed before.
23852 @end defun
23853
23854 @defun spam-stat-buffer-change-to-spam
23855 Called in a buffer, that buffer is no longer considered to be normal
23856 mail but spam.  Use this to change the status of a mail that has
23857 already been processed as non-spam.
23858 @end defun
23859
23860 @defun spam-stat-buffer-change-to-non-spam
23861 Called in a buffer, that buffer is no longer considered to be spam but
23862 normal mail.  Use this to change the status of a mail that has already
23863 been processed as spam.
23864 @end defun
23865
23866 @defun spam-stat-save
23867 Save the hash table to the file.  The filename used is stored in the
23868 variable @code{spam-stat-file}.
23869 @end defun
23870
23871 @defun spam-stat-load
23872 Load the hash table from a file.  The filename used is stored in the
23873 variable @code{spam-stat-file}.
23874 @end defun
23875
23876 @defun spam-stat-score-word
23877 Return the spam score for a word.
23878 @end defun
23879
23880 @defun spam-stat-score-buffer
23881 Return the spam score for a buffer.
23882 @end defun
23883
23884 @defun spam-stat-split-fancy
23885 Use this function for fancy mail splitting.  Add the rule @samp{(:
23886 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
23887 @end defun
23888
23889 Make sure you load the dictionary before using it.  This requires the
23890 following in your @file{~/.gnus.el} file:
23891
23892 @lisp
23893 (require 'spam-stat)
23894 (spam-stat-load)
23895 @end lisp
23896
23897 Typical test will involve calls to the following functions:
23898
23899 @smallexample
23900 Reset: (setq spam-stat (make-hash-table :test 'equal))
23901 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
23902 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
23903 Save table: (spam-stat-save)
23904 File size: (nth 7 (file-attributes spam-stat-file))
23905 Number of words: (hash-table-count spam-stat)
23906 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
23907 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
23908 Reduce table size: (spam-stat-reduce-size)
23909 Save table: (spam-stat-save)
23910 File size: (nth 7 (file-attributes spam-stat-file))
23911 Number of words: (hash-table-count spam-stat)
23912 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
23913 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
23914 @end smallexample
23915
23916 Here is how you would create your dictionary:
23917
23918 @smallexample
23919 Reset: (setq spam-stat (make-hash-table :test 'equal))
23920 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
23921 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
23922 Repeat for any other non-spam group you need...
23923 Reduce table size: (spam-stat-reduce-size)
23924 Save table: (spam-stat-save)
23925 @end smallexample
23926
23927 @node Other modes
23928 @section Interaction with other modes
23929
23930 @subsection Dired
23931 @cindex dired
23932
23933 @code{gnus-dired-minor-mode} provided some useful functions for dired
23934 buffers.  It is enabled with
23935 @lisp
23936 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
23937 @end lisp
23938
23939 @table @kbd
23940 @item C-c C-m C-a
23941 @findex gnus-dired-attach
23942 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
23943 You will be prompted for a message buffer.
23944
23945 @item C-c C-m C-l
23946 @findex gnus-dired-find-file-mailcap
23947 Visit a file according to the appropriate mailcap entry
23948 (@code{gnus-dired-find-file-mailcap}).  With prefix, open file in a new
23949 buffer.
23950
23951 @item C-c C-m C-p
23952 @findex gnus-dired-print
23953 Print file according to the mailcap entry (@code{gnus-dired-print}).  If
23954 there is no print command, print in a PostScript image.
23955 @end table
23956
23957 @node Various Various
23958 @section Various Various
23959 @cindex mode lines
23960 @cindex highlights
23961
23962 @table @code
23963
23964 @item gnus-home-directory
23965 @vindex gnus-home-directory
23966 All Gnus file and directory variables will be initialized from this
23967 variable, which defaults to @file{~/}.
23968
23969 @item gnus-directory
23970 @vindex gnus-directory
23971 Most Gnus storage file and directory variables will be initialized from
23972 this variable, which defaults to the @env{SAVEDIR} environment
23973 variable, or @file{~/News/} if that variable isn't set.
23974
23975 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
23976 This means that other directory variables that are initialized from this
23977 variable won't be set properly if you set this variable in
23978 @file{~/.gnus.el}.  Set this variable in @file{.emacs} instead.
23979
23980 @item gnus-default-directory
23981 @vindex gnus-default-directory
23982 Not related to the above variable at all---this variable says what the
23983 default directory of all Gnus buffers should be.  If you issue commands
23984 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
23985 default directory.  If this variable is @code{nil} (which is the
23986 default), the default directory will be the default directory of the
23987 buffer you were in when you started Gnus.
23988
23989 @item gnus-verbose
23990 @vindex gnus-verbose
23991 This variable is an integer between zero and ten.  The higher the value,
23992 the more messages will be displayed.  If this variable is zero, Gnus
23993 will never flash any messages, if it is seven (which is the default),
23994 most important messages will be shown, and if it is ten, Gnus won't ever
23995 shut up, but will flash so many messages it will make your head swim.
23996
23997 @item gnus-verbose-backends
23998 @vindex gnus-verbose-backends
23999 This variable works the same way as @code{gnus-verbose}, but it applies
24000 to the Gnus back ends instead of Gnus proper.
24001
24002 @item nnheader-max-head-length
24003 @vindex nnheader-max-head-length
24004 When the back ends read straight heads of articles, they all try to read
24005 as little as possible.  This variable (default 4096) specifies
24006 the absolute max length the back ends will try to read before giving up
24007 on finding a separator line between the head and the body.  If this
24008 variable is @code{nil}, there is no upper read bound.  If it is
24009 @code{t}, the back ends won't try to read the articles piece by piece,
24010 but read the entire articles.  This makes sense with some versions of
24011 @code{ange-ftp} or @code{efs}.
24012
24013 @item nnheader-head-chop-length
24014 @vindex nnheader-head-chop-length
24015 This variable (default 2048) says how big a piece of each article to
24016 read when doing the operation described above.
24017
24018 @item nnheader-file-name-translation-alist
24019 @vindex nnheader-file-name-translation-alist
24020 @cindex file names
24021 @cindex invalid characters in file names
24022 @cindex characters in file names
24023 This is an alist that says how to translate characters in file names.
24024 For instance, if @samp{:} is invalid as a file character in file names
24025 on your system (you OS/2 user you), you could say something like:
24026
24027 @lisp
24028 @group
24029 (setq nnheader-file-name-translation-alist
24030       '((?: . ?_)))
24031 @end group
24032 @end lisp
24033
24034 In fact, this is the default value for this variable on OS/2 and MS
24035 Windows (phooey) systems.
24036
24037 @item gnus-hidden-properties
24038 @vindex gnus-hidden-properties
24039 This is a list of properties to use to hide ``invisible'' text.  It is
24040 @code{(invisible t intangible t)} by default on most systems, which
24041 makes invisible text invisible and intangible.
24042
24043 @item gnus-parse-headers-hook
24044 @vindex gnus-parse-headers-hook
24045 A hook called before parsing headers.  It can be used, for instance, to
24046 gather statistics on the headers fetched, or perhaps you'd like to prune
24047 some headers.  I don't see why you'd want that, though.
24048
24049 @item gnus-shell-command-separator
24050 @vindex gnus-shell-command-separator
24051 String used to separate two shell commands.  The default is @samp{;}.
24052
24053 @item gnus-invalid-group-regexp
24054 @vindex gnus-invalid-group-regexp
24055
24056 Regexp to match ``invalid'' group names when querying user for a group
24057 name.  The default value catches some @strong{really} invalid group
24058 names who could possibly mess up Gnus internally (like allowing
24059 @samp{:} in a group name, which is normally used to delimit method and
24060 group).
24061
24062 @acronym{IMAP} users might want to allow @samp{/} in group names though.
24063
24064
24065 @end table
24066
24067 @node The End
24068 @chapter The End
24069
24070 Well, that's the manual---you can get on with your life now.  Keep in
24071 touch.  Say hello to your cats from me.
24072
24073 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
24074
24075 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
24076
24077 @quotation
24078 @strong{Te Deum}
24079
24080 @sp 1
24081 Not because of victories @*
24082 I sing,@*
24083 having none,@*
24084 but for the common sunshine,@*
24085 the breeze,@*
24086 the largess of the spring.
24087
24088 @sp 1
24089 Not for victory@*
24090 but for the day's work done@*
24091 as well as I was able;@*
24092 not for a seat upon the dais@*
24093 but at the common table.@*
24094 @end quotation
24095
24096
24097 @node Appendices
24098 @chapter Appendices
24099
24100 @menu
24101 * XEmacs::                      Requirements for installing under XEmacs.
24102 * History::                     How Gnus got where it is today.
24103 * On Writing Manuals::          Why this is not a beginner's guide.
24104 * Terminology::                 We use really difficult, like, words here.
24105 * Customization::               Tailoring Gnus to your needs.
24106 * Troubleshooting::             What you might try if things do not work.
24107 * Gnus Reference Guide::        Rilly, rilly technical stuff.
24108 * Emacs for Heathens::          A short introduction to Emacsian terms.
24109 * Frequently Asked Questions::  The Gnus FAQ
24110 @end menu
24111
24112
24113 @node XEmacs
24114 @section XEmacs
24115 @cindex XEmacs
24116 @cindex installing under XEmacs
24117
24118 XEmacs is distributed as a collection of packages.  You should install
24119 whatever packages the Gnus XEmacs package requires.  The current
24120 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
24121 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
24122 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{w3},
24123 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
24124
24125
24126 @node History
24127 @section History
24128
24129 @cindex history
24130 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
24131 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
24132
24133 If you want to investigate the person responsible for this outrage,
24134 you can point your (feh!) web browser to
24135 @uref{http://quimby.gnus.org/}.  This is also the primary
24136 distribution point for the new and spiffy versions of Gnus, and is
24137 known as The Site That Destroys Newsrcs And Drives People Mad.
24138
24139 During the first extended alpha period of development, the new Gnus was
24140 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
24141 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
24142 (Besides, the ``Gnus'' in this abbreviation should probably be
24143 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
24144 appropriate name, don't you think?)
24145
24146 In any case, after spending all that energy on coming up with a new and
24147 spunky name, we decided that the name was @emph{too} spunky, so we
24148 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
24149 ``@sc{gnus}''.  New vs. old.
24150
24151 @menu
24152 * Gnus Versions::               What Gnus versions have been released.
24153 * Other Gnus Versions::         Other Gnus versions that also have been released.
24154 * Why?::                        What's the point of Gnus?
24155 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
24156 * Conformity::                  Gnus tries to conform to all standards.
24157 * Emacsen::                     Gnus can be run on a few modern Emacsen.
24158 * Gnus Development::            How Gnus is developed.
24159 * Contributors::                Oodles of people.
24160 * New Features::                Pointers to some of the new stuff in Gnus.
24161 @end menu
24162
24163
24164 @node Gnus Versions
24165 @subsection Gnus Versions
24166 @cindex ding Gnus
24167 @cindex September Gnus
24168 @cindex Red Gnus
24169 @cindex Quassia Gnus
24170 @cindex Pterodactyl Gnus
24171 @cindex Oort Gnus
24172 @cindex No Gnus
24173 @cindex Gnus versions
24174
24175 The first ``proper'' release of Gnus 5 was done in November 1995 when it
24176 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
24177 plus 15 Gnus 5.0 releases).
24178
24179 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
24180 releases)) was released under the name ``Gnus 5.2'' (40 releases).
24181
24182 On July 28th 1996 work on Red Gnus was begun, and it was released on
24183 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
24184
24185 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
24186 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
24187
24188 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
24189 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
24190 1999.
24191
24192 On the 26th of October 2000, Oort Gnus was begun.
24193
24194 If you happen upon a version of Gnus that has a prefixed name --
24195 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
24196 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic.  Don't let it know
24197 that you're frightened.  Back away.  Slowly.  Whatever you do, don't
24198 run.  Walk away, calmly, until you're out of its reach.  Find a proper
24199 released version of Gnus and snuggle up to that instead.
24200
24201
24202 @node Other Gnus Versions
24203 @subsection Other Gnus Versions
24204 @cindex Semi-gnus
24205
24206 In addition to the versions of Gnus which have had their releases
24207 coordinated by Lars, one major development has been Semi-gnus from
24208 Japan.  It's based on a library called @acronym{SEMI}, which provides
24209 @acronym{MIME} capabilities.
24210
24211 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
24212 Collectively, they are called ``Semi-gnus'', and different strains are
24213 called T-gnus, ET-gnus, Nana-gnus and Chaos.  These provide powerful
24214 @acronym{MIME} and multilingualization things, especially important for
24215 Japanese users.
24216
24217
24218 @node Why?
24219 @subsection Why?
24220
24221 What's the point of Gnus?
24222
24223 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
24224 newsreader, that lets you do anything you can think of.  That was my
24225 original motivation, but while working on Gnus, it has become clear to
24226 me that this generation of newsreaders really belong in the stone age.
24227 Newsreaders haven't developed much since the infancy of the net.  If the
24228 volume continues to rise with the current rate of increase, all current
24229 newsreaders will be pretty much useless.  How do you deal with
24230 newsgroups that have thousands of new articles each day?  How do you
24231 keep track of millions of people who post?
24232
24233 Gnus offers no real solutions to these questions, but I would very much
24234 like to see Gnus being used as a testing ground for new methods of
24235 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
24236 to separate the newsreader from the back ends, Gnus now offers a simple
24237 interface for anybody who wants to write new back ends for fetching mail
24238 and news from different sources.  I have added hooks for customizations
24239 everywhere I could imagine it being useful.  By doing so, I'm inviting
24240 every one of you to explore and invent.
24241
24242 May Gnus never be complete.  @kbd{C-u 100 M-x all-hail-emacs} and
24243 @kbd{C-u 100 M-x all-hail-xemacs}.
24244
24245
24246 @node Compatibility
24247 @subsection Compatibility
24248
24249 @cindex compatibility
24250 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
24251 bindings have been kept.  More key bindings have been added, of course,
24252 but only in one or two obscure cases have old bindings been changed.
24253
24254 Our motto is:
24255 @quotation
24256 @cartouche
24257 @center In a cloud bones of steel.
24258 @end cartouche
24259 @end quotation
24260
24261 All commands have kept their names.  Some internal functions have changed
24262 their names.
24263
24264 The @code{gnus-uu} package has changed drastically.  @xref{Decoding
24265 Articles}.
24266
24267 One major compatibility question is the presence of several summary
24268 buffers.  All variables relevant while reading a group are
24269 buffer-local to the summary buffer they belong in.  Although many
24270 important variables have their values copied into their global
24271 counterparts whenever a command is executed in the summary buffer, this
24272 change might lead to incorrect values being used unless you are careful.
24273
24274 All code that relies on knowledge of @sc{gnus} internals will probably
24275 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
24276 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
24277 maintains a hash table that points to the entries in this alist (which
24278 speeds up many functions), and changing the alist directly will lead to
24279 peculiar results.
24280
24281 @cindex hilit19
24282 @cindex highlighting
24283 Old hilit19 code does not work at all.  In fact, you should probably
24284 remove all hilit code from all Gnus hooks
24285 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
24286 Gnus provides various integrated functions for highlighting.  These are
24287 faster and more accurate.  To make life easier for everybody, Gnus will
24288 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
24289 Away!
24290
24291 Packages like @code{expire-kill} will no longer work.  As a matter of
24292 fact, you should probably remove all old @sc{gnus} packages (and other
24293 code) when you start using Gnus.  More likely than not, Gnus already
24294 does what you have written code to make @sc{gnus} do.  (Snicker.)
24295
24296 Even though old methods of doing things are still supported, only the
24297 new methods are documented in this manual.  If you detect a new method of
24298 doing something while reading this manual, that does not mean you have
24299 to stop doing it the old way.
24300
24301 Gnus understands all @sc{gnus} startup files.
24302
24303 @kindex M-x gnus-bug
24304 @findex gnus-bug
24305 @cindex reporting bugs
24306 @cindex bugs
24307 Overall, a casual user who hasn't written much code that depends on
24308 @sc{gnus} internals should suffer no problems.  If problems occur,
24309 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
24310
24311 @vindex gnus-bug-create-help-buffer
24312 If you are in the habit of sending bug reports @emph{very} often, you
24313 may find the helpful help buffer annoying after a while.  If so, set
24314 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
24315 up at you.
24316
24317
24318 @node Conformity
24319 @subsection Conformity
24320
24321 No rebels without a clue here, ma'am.  We conform to all standards known
24322 to (wo)man.  Except for those standards and/or conventions we disagree
24323 with, of course.
24324
24325 @table @strong
24326
24327 @item RFC (2)822
24328 @cindex RFC 822
24329 @cindex RFC 2822
24330 There are no known breaches of this standard.
24331
24332 @item RFC 1036
24333 @cindex RFC 1036
24334 There are no known breaches of this standard, either.
24335
24336 @item Son-of-RFC 1036
24337 @cindex Son-of-RFC 1036
24338 We do have some breaches to this one.
24339
24340 @table @emph
24341
24342 @item X-Newsreader
24343 @itemx User-Agent
24344 These are considered to be ``vanity headers'', while I consider them
24345 to be consumer information.  After seeing so many badly formatted
24346 articles coming from @code{tin} and @code{Netscape} I know not to use
24347 either of those for posting articles.  I would not have known that if
24348 it wasn't for the @code{X-Newsreader} header.
24349 @end table
24350
24351 @item USEFOR
24352 @cindex USEFOR
24353 USEFOR is an IETF working group writing a successor to RFC 1036, based
24354 on Son-of-RFC 1036.  They have produced a number of drafts proposing
24355 various changes to the format of news articles.  The Gnus towers will
24356 look into implementing the changes when the draft is accepted as an RFC.
24357
24358 @item MIME - RFC 2045-2049 etc
24359 @cindex @acronym{MIME}
24360 All the various @acronym{MIME} RFCs are supported.
24361
24362 @item Disposition Notifications - RFC 2298
24363 Message Mode is able to request notifications from the receiver.
24364
24365 @item PGP - RFC 1991 and RFC 2440
24366 @cindex RFC 1991
24367 @cindex RFC 2440
24368 RFC 1991 is the original @acronym{PGP} message specification,
24369 published as an informational RFC.  RFC 2440 was the follow-up, now
24370 called Open PGP, and put on the Standards Track.  Both document a
24371 non-@acronym{MIME} aware @acronym{PGP} format.  Gnus supports both
24372 encoding (signing and encryption) and decoding (verification and
24373 decryption).
24374
24375 @item PGP/MIME - RFC 2015/3156
24376 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
24377 1991) describes the @acronym{MIME}-wrapping around the RF 1991/2440 format.
24378 Gnus supports both encoding and decoding.
24379
24380 @item S/MIME - RFC 2633
24381 RFC 2633 describes the @acronym{S/MIME} format.
24382
24383 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
24384 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
24385 (@acronym{IMAP} 4 revision 1).  RFC 2195 describes CRAM-MD5
24386 authentication for @acronym{IMAP}.  RFC 2086 describes access control
24387 lists (ACLs) for @acronym{IMAP}.  RFC 2359 describes a @acronym{IMAP}
24388 protocol enhancement.  RFC 2595 describes the proper @acronym{TLS}
24389 integration (STARTTLS) with @acronym{IMAP}.  RFC 1731 describes the
24390 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
24391
24392 @end table
24393
24394 If you ever notice Gnus acting non-compliant with regards to the texts
24395 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
24396 know.
24397
24398
24399 @node Emacsen
24400 @subsection Emacsen
24401 @cindex Emacsen
24402 @cindex XEmacs
24403 @cindex Mule
24404 @cindex Emacs
24405
24406 Gnus should work on:
24407
24408 @itemize @bullet
24409
24410 @item
24411 Emacs 21.1 and up.
24412
24413 @item
24414 XEmacs 21.4 and up.
24415
24416 @end itemize
24417
24418 This Gnus version will absolutely not work on any Emacsen older than
24419 that.  Not reliably, at least.  Older versions of Gnus may work on older
24420 Emacs versions.
24421
24422 There are some vague differences between Gnus on the various
24423 platforms---XEmacs features more graphics (a logo and a toolbar)---but
24424 other than that, things should look pretty much the same under all
24425 Emacsen.
24426
24427
24428 @node Gnus Development
24429 @subsection Gnus Development
24430
24431 Gnus is developed in a two-phased cycle.  The first phase involves much
24432 discussion on the @samp{ding@@gnus.org} mailing list, where people
24433 propose changes and new features, post patches and new back ends.  This
24434 phase is called the @dfn{alpha} phase, since the Gnusae released in this
24435 phase are @dfn{alpha releases}, or (perhaps more commonly in other
24436 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
24437 unstable and should not be used by casual users.  Gnus alpha releases
24438 have names like ``Red Gnus'' and ``Quassia Gnus''.
24439
24440 After futzing around for 50-100 alpha releases, Gnus is declared
24441 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
24442 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
24443 supposed to be able to use these, and these are mostly discussed on the
24444 @samp{gnu.emacs.gnus} newsgroup.
24445
24446 @cindex Incoming*
24447 @vindex mail-source-delete-incoming
24448 Some variable defaults differ between alpha Gnusae and released Gnusae.
24449 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
24450 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
24451 lossage of mail if an alpha release hiccups while handling the mail.
24452
24453 The division of discussion between the ding mailing list and the Gnus
24454 newsgroup is not purely based on publicity concerns.  It's true that
24455 having people write about the horrible things that an alpha Gnus release
24456 can do (sometimes) in a public forum may scare people off, but more
24457 importantly, talking about new experimental features that have been
24458 introduced may confuse casual users.  New features are frequently
24459 introduced, fiddled with, and judged to be found wanting, and then
24460 either discarded or totally rewritten.  People reading the mailing list
24461 usually keep up with these rapid changes, while people on the newsgroup
24462 can't be assumed to do so.
24463
24464
24465
24466 @node Contributors
24467 @subsection Contributors
24468 @cindex contributors
24469
24470 The new Gnus version couldn't have been done without the help of all the
24471 people on the (ding) mailing list.  Every day for over a year I have
24472 gotten billions of nice bug reports from them, filling me with joy,
24473 every single one of them.  Smooches.  The people on the list have been
24474 tried beyond endurance, what with my ``oh, that's a neat idea <type
24475 type>, yup, I'll release it right away <ship off> no wait, that doesn't
24476 work at all <type type>, yup, I'll ship that one off right away <ship
24477 off> no, wait, that absolutely does not work'' policy for releases.
24478 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
24479 ``worser''? ``much worser''?  ``worsest''?)
24480
24481 I would like to take this opportunity to thank the Academy for@dots{}  oops,
24482 wrong show.
24483
24484 @itemize @bullet
24485
24486 @item
24487 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
24488
24489 @item
24490 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
24491 nnwarchive and many, many other things connected with @acronym{MIME} and
24492 other types of en/decoding, as well as general bug fixing, new
24493 functionality and stuff.
24494
24495 @item
24496 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
24497 well as numerous other things).
24498
24499 @item
24500 Luis Fernandes---design and graphics.
24501
24502 @item
24503 Joe Reiss---creator of the smiley faces.
24504
24505 @item
24506 Justin Sheehy---the @acronym{FAQ} maintainer.
24507
24508 @item
24509 Erik Naggum---help, ideas, support, code and stuff.
24510
24511 @item
24512 Wes Hardaker---@file{gnus-picon.el} and the manual section on
24513 @dfn{picons} (@pxref{Picons}).
24514
24515 @item
24516 Kim-Minh Kaplan---further work on the picon code.
24517
24518 @item
24519 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
24520
24521 @item
24522 Sudish Joseph---innumerable bug fixes.
24523
24524 @item
24525 Ilja Weis---@file{gnus-topic.el}.
24526
24527 @item
24528 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
24529
24530 @item
24531 Vladimir Alexiev---the refcard and reference booklets.
24532
24533 @item
24534 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
24535 distribution by Felix Lee and JWZ.
24536
24537 @item
24538 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
24539
24540 @item
24541 Peter Mutsaers---orphan article scoring code.
24542
24543 @item
24544 Ken Raeburn---POP mail support.
24545
24546 @item
24547 Hallvard B Furuseth---various bits and pieces, especially dealing with
24548 .newsrc files.
24549
24550 @item
24551 Brian Edmonds---@file{gnus-bbdb.el}.
24552
24553 @item
24554 David Moore---rewrite of @file{nnvirtual.el} and many other things.
24555
24556 @item
24557 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
24558
24559 @item
24560 François Pinard---many, many interesting and thorough bug reports, as
24561 well as autoconf support.
24562
24563 @end itemize
24564
24565 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
24566 Borges, and Jost Krieger proof-reading parts of the manual.
24567
24568 The following people have contributed many patches and suggestions:
24569
24570 Christopher Davis,
24571 Andrew Eskilsson,
24572 Kai Grossjohann,
24573 Kevin Greiner,
24574 Jesper Harder,
24575 Paul Jarc,
24576 Simon Josefsson,
24577 David KÃ¥gedal,
24578 Richard Pieri,
24579 Fabrice Popineau,
24580 Daniel Quinlan,
24581 Michael Shields,
24582 Reiner Steib,
24583 Jason L. Tibbitts, III,
24584 Jack Vinson,
24585 Katsumi Yamaoka, @c Yamaoka
24586 and
24587 Teodor Zlatanov.
24588
24589 Also thanks to the following for patches and stuff:
24590
24591 Jari Aalto,
24592 Adrian Aichner,
24593 Vladimir Alexiev,
24594 Russ Allbery,
24595 Peter Arius,
24596 Matt Armstrong,
24597 Marc Auslander,
24598 Miles Bader,
24599 Alexei V. Barantsev,
24600 Frank Bennett,
24601 Robert Bihlmeyer,
24602 Chris Bone,
24603 Mark Borges,
24604 Mark Boyns,
24605 Lance A. Brown,
24606 Rob Browning,
24607 Kees de Bruin,
24608 Martin Buchholz,
24609 Joe Buehler,
24610 Kevin Buhr,
24611 Alastair Burt,
24612 Joao Cachopo,
24613 Zlatko Calusic,
24614 Massimo Campostrini,
24615 Castor,
24616 David Charlap,
24617 Dan Christensen,
24618 Kevin Christian,
24619 Jae-you Chung, @c ?
24620 James H. Cloos, Jr.,
24621 Laura Conrad,
24622 Michael R. Cook,
24623 Glenn Coombs,
24624 Andrew J. Cosgriff,
24625 Neil Crellin,
24626 Frank D. Cringle,
24627 Geoffrey T. Dairiki,
24628 Andre Deparade,
24629 Ulrik Dickow,
24630 Dave Disser,
24631 Rui-Tao Dong, @c ?
24632 Joev Dubach,
24633 Michael Welsh Duggan,
24634 Dave Edmondson,
24635 Paul Eggert,
24636 Mark W. Eichin,
24637 Karl Eichwalder,
24638 Enami Tsugutomo, @c Enami
24639 Michael Ernst,
24640 Luc Van Eycken,
24641 Sam Falkner,
24642 Nelson Jose dos Santos Ferreira,
24643 Sigbjorn Finne,
24644 Sven Fischer,
24645 Paul Fisher,
24646 Decklin Foster,
24647 Gary D. Foster,
24648 Paul Franklin,
24649 Guy Geens,
24650 Arne Georg Gleditsch,
24651 David S. Goldberg,
24652 Michelangelo Grigni,
24653 Dale Hagglund,
24654 D. Hall,
24655 Magnus Hammerin,
24656 Kenichi Handa, @c Handa
24657 Raja R. Harinath,
24658 Yoshiki Hayashi, @c Hayashi
24659 P. E. Jareth Hein,
24660 Hisashige Kenji, @c Hisashige
24661 Scott Hofmann,
24662 Marc Horowitz,
24663 Gunnar Horrigmo,
24664 Richard Hoskins,
24665 Brad Howes,
24666 Miguel de Icaza,
24667 François Felix Ingrand,
24668 Tatsuya Ichikawa, @c Ichikawa
24669 Ishikawa Ichiro, @c Ishikawa
24670 Lee Iverson,
24671 Iwamuro Motonori, @c Iwamuro
24672 Rajappa Iyer,
24673 Andreas Jaeger,
24674 Adam P. Jenkins,
24675 Randell Jesup,
24676 Fred Johansen,
24677 Gareth Jones,
24678 Greg Klanderman,
24679 Karl Kleinpaste,
24680 Michael Klingbeil,
24681 Peter Skov Knudsen,
24682 Shuhei Kobayashi, @c Kobayashi
24683 Petr Konecny,
24684 Koseki Yoshinori, @c Koseki
24685 Thor Kristoffersen,
24686 Jens Lautenbacher,
24687 Martin Larose,
24688 Seokchan Lee, @c Lee
24689 Joerg Lenneis,
24690 Carsten Leonhardt,
24691 James LewisMoss,
24692 Christian Limpach,
24693 Markus Linnala,
24694 Dave Love,
24695 Mike McEwan,
24696 Tonny Madsen,
24697 Shlomo Mahlab,
24698 Nat Makarevitch,
24699 Istvan Marko,
24700 David Martin,
24701 Jason R. Mastaler,
24702 Gordon Matzigkeit,
24703 Timo Metzemakers,
24704 Richard Mlynarik,
24705 Lantz Moore,
24706 Morioka Tomohiko, @c Morioka
24707 Erik Toubro Nielsen,
24708 Hrvoje Niksic,
24709 Andy Norman,
24710 Fred Oberhauser,
24711 C. R. Oldham,
24712 Alexandre Oliva,
24713 Ken Olstad,
24714 Masaharu Onishi, @c Onishi
24715 Hideki Ono, @c Ono
24716 Ettore Perazzoli,
24717 William Perry,
24718 Stephen Peters,
24719 Jens-Ulrik Holger Petersen,
24720 Ulrich Pfeifer,
24721 Matt Pharr,
24722 Andy Piper,
24723 John McClary Prevost,
24724 Bill Pringlemeir,
24725 Mike Pullen,
24726 Jim Radford,
24727 Colin Rafferty,
24728 Lasse Rasinen,
24729 Lars Balker Rasmussen,
24730 Joe Reiss,
24731 Renaud Rioboo,
24732 Roland B. Roberts,
24733 Bart Robinson,
24734 Christian von Roques,
24735 Markus Rost,
24736 Jason Rumney,
24737 Wolfgang Rupprecht,
24738 Jay Sachs,
24739 Dewey M. Sasser,
24740 Conrad Sauerwald,
24741 Loren Schall,
24742 Dan Schmidt,
24743 Ralph Schleicher,
24744 Philippe Schnoebelen,
24745 Andreas Schwab,
24746 Randal L. Schwartz,
24747 Danny Siu,
24748 Matt Simmons,
24749 Paul D. Smith,
24750 Jeff Sparkes,
24751 Toby Speight,
24752 Michael Sperber,
24753 Darren Stalder,
24754 Richard Stallman,
24755 Greg Stark,
24756 Sam Steingold,
24757 Paul Stevenson,
24758 Jonas Steverud,
24759 Paul Stodghill,
24760 Kiyokazu Suto, @c Suto
24761 Kurt Swanson,
24762 Samuel Tardieu,
24763 Teddy,
24764 Chuck Thompson,
24765 Tozawa Akihiko, @c Tozawa
24766 Philippe Troin,
24767 James Troup,
24768 Trung Tran-Duc,
24769 Jack Twilley,
24770 Aaron M. Ucko,
24771 Aki Vehtari,
24772 Didier Verna,
24773 Vladimir Volovich,
24774 Jan Vroonhof,
24775 Stefan Waldherr,
24776 Pete Ware,
24777 Barry A. Warsaw,
24778 Christoph Wedler,
24779 Joe Wells,
24780 Lee Willis,
24781 and
24782 Lloyd Zusman.
24783
24784
24785 For a full overview of what each person has done, the ChangeLogs
24786 included in the Gnus alpha distributions should give ample reading
24787 (550kB and counting).
24788
24789 Apologies to everybody that I've forgotten, of which there are many, I'm
24790 sure.
24791
24792 Gee, that's quite a list of people.  I guess that must mean that there
24793 actually are people who are using Gnus.  Who'd'a thunk it!
24794
24795
24796 @node New Features
24797 @subsection New Features
24798 @cindex new features
24799
24800 @menu
24801 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
24802 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
24803 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
24804 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
24805 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
24806 * Oort Gnus::                   It's big.  It's far out.  Gnus 5.10.
24807 * No Gnus::                     Lars, FIXME!
24808 @end menu
24809
24810 These lists are, of course, just @emph{short} overviews of the
24811 @emph{most} important new features.  No, really.  There are tons more.
24812 Yes, we have feeping creaturism in full effect.
24813
24814 @node ding Gnus
24815 @subsubsection (ding) Gnus
24816
24817 New features in Gnus 5.0/5.1:
24818
24819 @itemize @bullet
24820
24821 @item
24822 The look of all buffers can be changed by setting format-like variables
24823 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
24824
24825 @item
24826 Local spool and several @acronym{NNTP} servers can be used at once
24827 (@pxref{Select Methods}).
24828
24829 @item
24830 You can combine groups into virtual groups (@pxref{Virtual Groups}).
24831
24832 @item
24833 You can read a number of different mail formats (@pxref{Getting Mail}).
24834 All the mail back ends implement a convenient mail expiry scheme
24835 (@pxref{Expiring Mail}).
24836
24837 @item
24838 Gnus can use various strategies for gathering threads that have lost
24839 their roots (thereby gathering loose sub-threads into one thread) or it
24840 can go back and retrieve enough headers to build a complete thread
24841 (@pxref{Customizing Threading}).
24842
24843 @item
24844 Killed groups can be displayed in the group buffer, and you can read
24845 them as well (@pxref{Listing Groups}).
24846
24847 @item
24848 Gnus can do partial group updates---you do not have to retrieve the
24849 entire active file just to check for new articles in a few groups
24850 (@pxref{The Active File}).
24851
24852 @item
24853 Gnus implements a sliding scale of subscribedness to groups
24854 (@pxref{Group Levels}).
24855
24856 @item
24857 You can score articles according to any number of criteria
24858 (@pxref{Scoring}).  You can even get Gnus to find out how to score
24859 articles for you (@pxref{Adaptive Scoring}).
24860
24861 @item
24862 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
24863 manner, so it should be difficult to lose much data on what you have
24864 read if your machine should go down (@pxref{Auto Save}).
24865
24866 @item
24867 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
24868 cluttering up the @file{.emacs} file.
24869
24870 @item
24871 You can set the process mark on both groups and articles and perform
24872 operations on all the marked items (@pxref{Process/Prefix}).
24873
24874 @item
24875 You can grep through a subset of groups and create a group from the
24876 results (@pxref{Kibozed Groups}).
24877
24878 @item
24879 You can list subsets of groups according to, well, anything
24880 (@pxref{Listing Groups}).
24881
24882 @item
24883 You can browse foreign servers and subscribe to groups from those
24884 servers (@pxref{Browse Foreign Server}).
24885
24886 @item
24887 Gnus can fetch articles, asynchronously, on a second connection to the
24888 server (@pxref{Asynchronous Fetching}).
24889
24890 @item
24891 You can cache articles locally (@pxref{Article Caching}).
24892
24893 @item
24894 The uudecode functions have been expanded and generalized
24895 (@pxref{Decoding Articles}).
24896
24897 @item
24898 You can still post uuencoded articles, which was a little-known feature
24899 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
24900
24901 @item
24902 Fetching parents (and other articles) now actually works without
24903 glitches (@pxref{Finding the Parent}).
24904
24905 @item
24906 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
24907
24908 @item
24909 Digests (and other files) can be used as the basis for groups
24910 (@pxref{Document Groups}).
24911
24912 @item
24913 Articles can be highlighted and customized (@pxref{Customizing
24914 Articles}).
24915
24916 @item
24917 URLs and other external references can be buttonized (@pxref{Article
24918 Buttons}).
24919
24920 @item
24921 You can do lots of strange stuff with the Gnus window & frame
24922 configuration (@pxref{Window Layout}).
24923
24924 @item
24925 You can click on buttons instead of using the keyboard
24926 (@pxref{Buttons}).
24927
24928 @end itemize
24929
24930
24931 @node September Gnus
24932 @subsubsection September Gnus
24933
24934 @iftex
24935 @iflatex
24936 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
24937 @end iflatex
24938 @end iftex
24939
24940 New features in Gnus 5.2/5.3:
24941
24942 @itemize @bullet
24943
24944 @item
24945 A new message composition mode is used.  All old customization variables
24946 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
24947 now obsolete.
24948
24949 @item
24950 Gnus is now able to generate @dfn{sparse} threads---threads where
24951 missing articles are represented by empty nodes (@pxref{Customizing
24952 Threading}).
24953
24954 @lisp
24955 (setq gnus-build-sparse-threads 'some)
24956 @end lisp
24957
24958 @item
24959 Outgoing articles are stored on a special archive server
24960 (@pxref{Archived Messages}).
24961
24962 @item
24963 Partial thread regeneration now happens when articles are
24964 referred.
24965
24966 @item
24967 Gnus can make use of GroupLens predictions.
24968
24969 @item
24970 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
24971
24972 @item
24973 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
24974
24975 @lisp
24976 (setq gnus-use-trees t)
24977 @end lisp
24978
24979 @item
24980 An @code{nn}-like pick-and-read minor mode is available for the summary
24981 buffers (@pxref{Pick and Read}).
24982
24983 @lisp
24984 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
24985 @end lisp
24986
24987 @item
24988 In binary groups you can use a special binary minor mode (@pxref{Binary
24989 Groups}).
24990
24991 @item
24992 Groups can be grouped in a folding topic hierarchy (@pxref{Group
24993 Topics}).
24994
24995 @lisp
24996 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
24997 @end lisp
24998
24999 @item
25000 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
25001
25002 @item
25003 Groups can now have a score, and bubbling based on entry frequency
25004 is possible (@pxref{Group Score}).
25005
25006 @lisp
25007 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
25008 @end lisp
25009
25010 @item
25011 Groups can be process-marked, and commands can be performed on
25012 groups of groups (@pxref{Marking Groups}).
25013
25014 @item
25015 Caching is possible in virtual groups.
25016
25017 @item
25018 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
25019 news batches, ClariNet briefs collections, and just about everything
25020 else (@pxref{Document Groups}).
25021
25022 @item
25023 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
25024 (@pxref{SOUP}).
25025
25026 @item
25027 The Gnus cache is much faster.
25028
25029 @item
25030 Groups can be sorted according to many criteria (@pxref{Sorting
25031 Groups}).
25032
25033 @item
25034 New group parameters have been introduced to set list-addresses and
25035 expiry times (@pxref{Group Parameters}).
25036
25037 @item
25038 All formatting specs allow specifying faces to be used
25039 (@pxref{Formatting Fonts}).
25040
25041 @item
25042 There are several more commands for setting/removing/acting on process
25043 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
25044
25045 @item
25046 The summary buffer can be limited to show parts of the available
25047 articles based on a wide range of criteria.  These commands have been
25048 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
25049
25050 @item
25051 Articles can be made persistent with the @kbd{*} command
25052 (@pxref{Persistent Articles}).
25053
25054 @item
25055 All functions for hiding article elements are now toggles.
25056
25057 @item
25058 Article headers can be buttonized (@pxref{Article Washing}).
25059
25060 @item
25061 All mail back ends support fetching articles by @code{Message-ID}.
25062
25063 @item
25064 Duplicate mail can now be treated properly (@pxref{Duplicates}).
25065
25066 @item
25067 All summary mode commands are available directly from the article
25068 buffer (@pxref{Article Keymap}).
25069
25070 @item
25071 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
25072 Layout}).
25073
25074 @item
25075 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
25076 @iftex
25077 @iflatex
25078 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
25079 @end iflatex
25080 @end iftex
25081
25082 @item
25083 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
25084
25085 @lisp
25086 (setq gnus-use-nocem t)
25087 @end lisp
25088
25089 @item
25090 Groups can be made permanently visible (@pxref{Listing Groups}).
25091
25092 @lisp
25093 (setq gnus-permanently-visible-groups "^nnml:")
25094 @end lisp
25095
25096 @item
25097 Many new hooks have been introduced to make customizing easier.
25098
25099 @item
25100 Gnus respects the @code{Mail-Copies-To} header.
25101
25102 @item
25103 Threads can be gathered by looking at the @code{References} header
25104 (@pxref{Customizing Threading}).
25105
25106 @lisp
25107 (setq gnus-summary-thread-gathering-function
25108       'gnus-gather-threads-by-references)
25109 @end lisp
25110
25111 @item
25112 Read articles can be stored in a special backlog buffer to avoid
25113 refetching (@pxref{Article Backlog}).
25114
25115 @lisp
25116 (setq gnus-keep-backlog 50)
25117 @end lisp
25118
25119 @item
25120 A clean copy of the current article is always stored in a separate
25121 buffer to allow easier treatment.
25122
25123 @item
25124 Gnus can suggest where to save articles (@pxref{Saving Articles}).
25125
25126 @item
25127 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
25128 Articles}).
25129
25130 @lisp
25131 (setq gnus-prompt-before-saving t)
25132 @end lisp
25133
25134 @item
25135 @code{gnus-uu} can view decoded files asynchronously while fetching
25136 articles (@pxref{Other Decode Variables}).
25137
25138 @lisp
25139 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
25140 @end lisp
25141
25142 @item
25143 Filling in the article buffer now works properly on cited text
25144 (@pxref{Article Washing}).
25145
25146 @item
25147 Hiding cited text adds buttons to toggle hiding, and how much
25148 cited text to hide is now customizable (@pxref{Article Hiding}).
25149
25150 @lisp
25151 (setq gnus-cited-lines-visible 2)
25152 @end lisp
25153
25154 @item
25155 Boring headers can be hidden (@pxref{Article Hiding}).
25156
25157 @item
25158 Default scoring values can now be set from the menu bar.
25159
25160 @item
25161 Further syntax checking of outgoing articles have been added.
25162
25163 @end itemize
25164
25165
25166 @node Red Gnus
25167 @subsubsection Red Gnus
25168
25169 New features in Gnus 5.4/5.5:
25170
25171 @iftex
25172 @iflatex
25173 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
25174 @end iflatex
25175 @end iftex
25176
25177 @itemize @bullet
25178
25179 @item
25180 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
25181
25182 @item
25183 Article prefetching functionality has been moved up into
25184 Gnus (@pxref{Asynchronous Fetching}).
25185
25186 @item
25187 Scoring can now be performed with logical operators like @code{and},
25188 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
25189 Scoring}).
25190
25191 @item
25192 Article washing status can be displayed in the
25193 article mode line (@pxref{Misc Article}).
25194
25195 @item
25196 @file{gnus.el} has been split into many smaller files.
25197
25198 @item
25199 Suppression of duplicate articles based on Message-ID can be done
25200 (@pxref{Duplicate Suppression}).
25201
25202 @lisp
25203 (setq gnus-suppress-duplicates t)
25204 @end lisp
25205
25206 @item
25207 New variables for specifying what score and adapt files are to be
25208 considered home score and adapt files (@pxref{Home Score File}) have
25209 been added.
25210
25211 @item
25212 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
25213 Server Internals}).
25214
25215 @item
25216 Groups can inherit group parameters from parent topics (@pxref{Topic
25217 Parameters}).
25218
25219 @item
25220 Article editing has been revamped and is now actually usable.
25221
25222 @item
25223 Signatures can be recognized in more intelligent fashions
25224 (@pxref{Article Signature}).
25225
25226 @item
25227 Summary pick mode has been made to look more @code{nn}-like.  Line
25228 numbers are displayed and the @kbd{.} command can be used to pick
25229 articles (@code{Pick and Read}).
25230
25231 @item
25232 Commands for moving the @file{.newsrc.eld} from one server to
25233 another have been added (@pxref{Changing Servers}).
25234
25235 @item
25236 There's a way now to specify that ``uninteresting'' fields be suppressed
25237 when generating lines in buffers (@pxref{Advanced Formatting}).
25238
25239 @item
25240 Several commands in the group buffer can be undone with @kbd{C-M-_}
25241 (@pxref{Undo}).
25242
25243 @item
25244 Scoring can be done on words using the new score type @code{w}
25245 (@pxref{Score File Format}).
25246
25247 @item
25248 Adaptive scoring can be done on a Subject word-by-word basis
25249 (@pxref{Adaptive Scoring}).
25250
25251 @lisp
25252 (setq gnus-use-adaptive-scoring '(word))
25253 @end lisp
25254
25255 @item
25256 Scores can be decayed (@pxref{Score Decays}).
25257
25258 @lisp
25259 (setq gnus-decay-scores t)
25260 @end lisp
25261
25262 @item
25263 Scoring can be performed using a regexp on the Date header.  The Date is
25264 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
25265
25266 @item
25267 A new command has been added to remove all data on articles from
25268 the native server (@pxref{Changing Servers}).
25269
25270 @item
25271 A new command for reading collections of documents
25272 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
25273 (@pxref{Really Various Summary Commands}).
25274
25275 @item
25276 Process mark sets can be pushed and popped (@pxref{Setting Process
25277 Marks}).
25278
25279 @item
25280 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
25281 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
25282
25283 @item
25284 A new back end for reading searches from Web search engines
25285 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
25286 (@pxref{Web Searches}).
25287
25288 @item
25289 Groups inside topics can now be sorted using the standard sorting
25290 functions, and each topic can be sorted independently (@pxref{Topic
25291 Sorting}).
25292
25293 @item
25294 Subsets of the groups can be sorted independently (@code{Sorting
25295 Groups}).
25296
25297 @item
25298 Cached articles can be pulled into the groups (@pxref{Summary Generation
25299 Commands}).
25300 @iftex
25301 @iflatex
25302 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
25303 @end iflatex
25304 @end iftex
25305
25306 @item
25307 Score files are now applied in a more reliable order (@pxref{Score
25308 Variables}).
25309
25310 @item
25311 Reports on where mail messages end up can be generated (@pxref{Splitting
25312 Mail}).
25313
25314 @item
25315 More hooks and functions have been added to remove junk from incoming
25316 mail before saving the mail (@pxref{Washing Mail}).
25317
25318 @item
25319 Emphasized text can be properly fontisized:
25320
25321 @end itemize
25322
25323
25324 @node Quassia Gnus
25325 @subsubsection Quassia Gnus
25326
25327 New features in Gnus 5.6:
25328
25329 @itemize @bullet
25330
25331 @item
25332 New functionality for using Gnus as an offline newsreader has been
25333 added.  A plethora of new commands and modes have been added.
25334 @xref{Gnus Unplugged}, for the full story.
25335
25336 @item
25337 The @code{nndraft} back end has returned, but works differently than
25338 before.  All Message buffers are now also articles in the @code{nndraft}
25339 group, which is created automatically.
25340
25341 @item
25342 @code{gnus-alter-header-function} can now be used to alter header
25343 values.
25344
25345 @item
25346 @code{gnus-summary-goto-article} now accept Message-ID's.
25347
25348 @item
25349 A new Message command for deleting text in the body of a message
25350 outside the region: @kbd{C-c C-v}.
25351
25352 @item
25353 You can now post to component group in @code{nnvirtual} groups with
25354 @kbd{C-u C-c C-c}.
25355
25356 @item
25357  @code{nntp-rlogin-program}---new variable to ease customization.
25358
25359 @item
25360 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
25361 re-highlighting of the article buffer.
25362
25363 @item
25364 New element in @code{gnus-boring-article-headers}---@code{long-to}.
25365
25366 @item
25367 @kbd{M-i} symbolic prefix command.  @xref{Symbolic Prefixes}, for
25368 details.
25369
25370 @item
25371 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
25372 @kbd{a} to add the score rule to the @file{all.SCORE} file.
25373
25374 @item
25375 @code{gnus-simplify-subject-functions} variable to allow greater
25376 control over simplification.
25377
25378 @item
25379 @kbd{A T}---new command for fetching the current thread.
25380
25381 @item
25382 @kbd{/ T}---new command for including the current thread in the
25383 limit.
25384
25385 @item
25386 @kbd{M-RET} is a new Message command for breaking cited text.
25387
25388 @item
25389 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
25390
25391 @item
25392 The @code{custom-face-lookup} function has been removed.
25393 If you used this function in your initialization files, you must
25394 rewrite them to use @code{face-spec-set} instead.
25395
25396 @item
25397 Canceling now uses the current select method.  Symbolic prefix
25398 @kbd{a} forces normal posting method.
25399
25400 @item
25401 New command to translate M******** sm*rtq**t*s into proper
25402 text---@kbd{W d}.
25403
25404 @item
25405 For easier debugging of @code{nntp}, you can set
25406 @code{nntp-record-commands} to a non-@code{nil} value.
25407
25408 @item
25409 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
25410 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
25411
25412 @item
25413 A command for editing group parameters from the summary buffer
25414 has been added.
25415
25416 @item
25417 A history of where mails have been split is available.
25418
25419 @item
25420 A new article date command has been added---@code{article-date-iso8601}.
25421
25422 @item
25423 Subjects can be simplified when threading by setting
25424 @code{gnus-score-thread-simplify}.
25425
25426 @item
25427 A new function for citing in Message has been
25428 added---@code{message-cite-original-without-signature}.
25429
25430 @item
25431 @code{article-strip-all-blank-lines}---new article command.
25432
25433 @item
25434 A new Message command to kill to the end of the article has
25435 been added.
25436
25437 @item
25438 A minimum adaptive score can be specified by using the
25439 @code{gnus-adaptive-word-minimum} variable.
25440
25441 @item
25442 The ``lapsed date'' article header can be kept continually
25443 updated by the @code{gnus-start-date-timer} command.
25444
25445 @item
25446 Web listserv archives can be read with the @code{nnlistserv} back end.
25447
25448 @item
25449 Old dejanews archives can now be read by @code{nnweb}.
25450
25451 @end itemize
25452
25453 @node Pterodactyl Gnus
25454 @subsubsection Pterodactyl Gnus
25455
25456 New features in Gnus 5.8:
25457
25458 @itemize @bullet
25459
25460 @item
25461 The mail-fetching functions have changed.  See the manual for the
25462 many details.  In particular, all procmail fetching variables are gone.
25463
25464 If you used procmail like in
25465
25466 @lisp
25467 (setq nnmail-use-procmail t)
25468 (setq nnmail-spool-file 'procmail)
25469 (setq nnmail-procmail-directory "~/mail/incoming/")
25470 (setq nnmail-procmail-suffix "\\.in")
25471 @end lisp
25472
25473 this now has changed to
25474
25475 @lisp
25476 (setq mail-sources
25477       '((directory :path "~/mail/incoming/"
25478                    :suffix ".in")))
25479 @end lisp
25480
25481 @xref{Mail Source Specifiers}.
25482
25483 @item
25484 Gnus is now a @acronym{MIME}-capable reader.  This affects many parts of
25485 Gnus, and adds a slew of new commands.  See the manual for details.
25486
25487 @item
25488 Gnus has also been multilingualized.  This also affects too
25489 many parts of Gnus to summarize here, and adds many new variables.
25490
25491 @item
25492 @code{gnus-auto-select-first} can now be a function to be
25493 called to position point.
25494
25495 @item
25496 The user can now decide which extra headers should be included in
25497 summary buffers and @acronym{NOV} files.
25498
25499 @item
25500 @code{gnus-article-display-hook} has been removed.  Instead, a number
25501 of variables starting with @code{gnus-treat-} have been added.
25502
25503 @item
25504 The Gnus posting styles have been redone again and now works in a
25505 subtly different manner.
25506
25507 @item
25508 New web-based back ends have been added: @code{nnslashdot},
25509 @code{nnwarchive} and @code{nnultimate}.  nnweb has been revamped,
25510 again, to keep up with ever-changing layouts.
25511
25512 @item
25513 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
25514
25515 @end itemize
25516
25517 @node Oort Gnus
25518 @subsubsection Oort Gnus
25519 @cindex Oort Gnus
25520
25521 New features in Gnus 5.10:
25522
25523 @itemize @bullet
25524
25525 @item
25526 @code{gnus-group-read-ephemeral-group} can be called interactively,
25527 using @kbd{G M}.
25528
25529 @item
25530 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
25531 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
25532
25533 @item
25534 The revised Gnus @acronym{FAQ} is included in the manual,
25535 @xref{Frequently Asked Questions}.
25536
25537 @item
25538 Upgrading from previous (stable) version if you have used Oort.
25539
25540 If you have tried Oort (the unstable Gnus branch leading to this
25541 release) but went back to a stable version, be careful when upgrading to
25542 this version.  In particular, you will probably want to remove all
25543 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
25544 read from your @file{.newsrc.eld} instead of from the
25545 @file{.marks}/@file{.mrk} file where this release store flags.  See a
25546 later entry for more information about marks.  Note that downgrading
25547 isn't save in general.
25548
25549 @item
25550 Article Buttons
25551
25552 More buttons for URLs, mail addresses, Message-IDs, Info links, man
25553 pages and Emacs or Gnus related references.  @xref{Article Buttons}.  The
25554 variables @code{gnus-button-@var{*}-level} can be used to control the
25555 appearance of all article buttons.  @xref{Article Button Levels}.
25556
25557 @item
25558 Dired integration
25559
25560 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
25561 bindings in dired buffers to send a file as an attachment, open a file
25562 using the appropriate mailcap entry, and print a file using the mailcap
25563 entry.
25564
25565 @item
25566 Gnus can display RSS newsfeeds as a newsgroup.  @xref{RSS}.
25567
25568 @item
25569 Single-part yenc encoded attachments can be decoded.
25570
25571 @item
25572 Picons
25573
25574 The picons code has been reimplemented to work in GNU Emacs---some of
25575 the previous options have been removed or renamed.
25576
25577 Picons are small ``personal icons'' representing users, domain and
25578 newsgroups, which can be displayed in the Article buffer.
25579 @xref{Picons}.
25580
25581 @item
25582 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
25583 boundary line is drawn at the end of the headers.
25584
25585 @item
25586 Retrieval of charters and control messages
25587
25588 There are new commands for fetching newsgroup charters (@kbd{H c}) and
25589 control messages (@kbd{H C}).
25590
25591 @item
25592 Delayed articles
25593
25594 You can delay the sending of a message with @kbd{C-c C-j} in the Message
25595 buffer.  The messages are delivered at specified time.  This is useful
25596 for sending yourself reminders.  @xref{Delayed Articles}.
25597
25598 @item
25599 If @code{auto-compression-mode} is enabled, attachments are automatically
25600 decompressed when activated.
25601
25602 @item
25603 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
25604 the nnml back end allows compressed message files.
25605
25606 @item
25607 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
25608
25609 @item
25610 The Summary Buffer uses an arrow in the fringe to indicate the current
25611 article.  Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
25612
25613 @item
25614 Warn about email replies to news
25615
25616 Do you often find yourself replying to news by email by mistake?  Then
25617 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
25618 you.
25619
25620 @item
25621 If the new option @code{gnus-summary-display-while-building} is
25622 non-@code{nil}, the summary buffer is shown and updated as it's being
25623 built.
25624
25625 @item
25626 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
25627 opposed to old but unread messages).
25628
25629 @item
25630 The new option @code{gnus-gcc-mark-as-read} automatically marks
25631 Gcc articles as read.
25632
25633 @item
25634 The nndoc back end now supports mailman digests and exim bounces.
25635
25636 @item
25637 Gnus supports RFC 2369 mailing list headers, and adds a number of
25638 related commands in mailing list groups.  @xref{Mailing List}.
25639
25640 @item
25641 The Date header can be displayed in a format that can be read aloud
25642 in English.  @xref{Article Date}.
25643
25644 @item
25645 The envelope sender address can be customized when using Sendmail.
25646 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
25647
25648 @item
25649 diffs are automatically highlighted in groups matching
25650 @code{mm-uu-diff-groups-regexp}
25651
25652 @item
25653 @acronym{TLS} wrapper shipped with Gnus
25654
25655 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
25656 @acronym{NNTP} via @file{tls.el} and GNUTLS.  The old
25657 @acronym{TLS}/@acronym{SSL} support via (external third party)
25658 @file{ssl.el} and OpenSSL still works.
25659
25660 @item
25661 New @file{make.bat} for compiling and installing Gnus under MS Windows
25662
25663 Use @file{make.bat} if you want to install Gnus under MS Windows, the
25664 first argument to the batch-program should be the directory where
25665 @file{xemacs.exe} respectively @file{emacs.exe} is located, iff you want
25666 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
25667 the second parameter.
25668
25669 @file{make.bat} has been rewritten from scratch, it now features
25670 automatic recognition of XEmacs and GNU Emacs, generates
25671 @file{gnus-load.el}, checks if errors occur while compilation and
25672 generation of info files and reports them at the end of the build
25673 process.  It now uses @code{makeinfo} if it is available and falls
25674 back to @file{infohack.el} otherwise.  @file{make.bat} should now
25675 install all files which are necessary to run Gnus and be generally a
25676 complete replacement for the @code{configure; make; make install}
25677 cycle used under Unix systems.
25678
25679 The new @file{make.bat} makes @file{make-x.bat} superfluous, so it has
25680 been removed.
25681
25682 @item
25683 Support for non-@acronym{ASCII} domain names
25684
25685 Message supports non-@acronym{ASCII} domain names in From:, To: and
25686 Cc: and will query you whether to perform encoding when you try to
25687 send a message.  The variable @code{message-use-idna} controls this.
25688 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
25689 and Cc: when you view a message.  The variable @code{gnus-use-idna}
25690 controls this.
25691
25692 @item
25693 Better handling of Microsoft citation styles
25694
25695 Gnus now tries to recognize the mangled header block that some Microsoft
25696 mailers use to indicate that the rest of the message is a citation, even
25697 though it is not quoted in any way.  The variable
25698 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
25699 citations.
25700
25701 @item
25702 @code{gnus-article-skip-boring}
25703
25704 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
25705 not scroll down to show you a page that contains only boring text,
25706 which by default means cited text and signature.  You can customize
25707 what is skippable using @code{gnus-article-boring-faces}.
25708
25709 This feature is especially useful if you read many articles that
25710 consist of a little new content at the top with a long, untrimmed
25711 message cited below.
25712
25713 @item
25714 The format spec @code{%C} for positioning point has changed to @code{%*}.
25715
25716 @item
25717 The new variable @code{gnus-parameters} can be used to set group parameters.
25718
25719 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
25720 the parameters in @file{~/.newsrc.eld}, but via this variable you can
25721 enjoy the powers of customize, and simplified backups since you set the
25722 variable in @file{~/.emacs} instead of @file{~/.newsrc.eld}.  The
25723 variable maps regular expressions matching group names to group
25724 parameters, a'la:
25725 @lisp
25726 (setq gnus-parameters
25727       '(("mail\\..*"
25728          (gnus-show-threads nil)
25729          (gnus-use-scoring nil))
25730         ("^nnimap:\\(foo.bar\\)$"
25731          (to-group . "\\1"))))
25732 @end lisp
25733
25734 @item
25735 Smileys (@samp{:-)}, @samp{;-)} etc) are now iconized for Emacs too.
25736
25737 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.emacs} to
25738 disable it.
25739
25740 @item
25741 Gnus no longer generate the Sender: header automatically.
25742
25743 Earlier it was generated iff the user configurable email address was
25744 different from the Gnus guessed default user address.  As the guessing
25745 algorithm is rarely correct these days, and (more controversially) the
25746 only use of the Sender: header was to check if you are entitled to
25747 cancel/supersede news (which is now solved by Cancel Locks instead,
25748 see another entry), generation of the header has been disabled by
25749 default.  See the variables @code{message-required-headers},
25750 @code{message-required-news-headers}, and
25751 @code{message-required-mail-headers}.
25752
25753 @item
25754 Features from third party @file{message-utils.el} added to @file{message.el}.
25755
25756 Message now asks if you wish to remove @samp{(was: <old subject>)} from
25757 subject lines (see @code{message-subject-trailing-was-query}).  @kbd{C-c
25758 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
25759 @kbd{C-c C-f a} adds a X-No-Archive: header.  @kbd{C-c C-f x} inserts
25760 appropriate headers and a note in the body for cross-postings and
25761 followups (see the variables @code{message-cross-post-@var{*}}).
25762
25763 @item
25764 References and X-Draft-Headers are no longer generated when you start
25765 composing messages and @code{message-generate-headers-first} is
25766 @code{nil}.
25767
25768 @item
25769 Improved anti-spam features.
25770
25771 Gnus is now able to take out spam from your mail and news streams
25772 using a wide variety of programs and filter rules.  Among the supported
25773 methods are RBL blocklists, bogofilter and white/blacklists.  Hooks
25774 for easy use of external packages such as SpamAssassin and Hashcash
25775 are also new.  @xref{Thwarting Email Spam}.
25776
25777 @item
25778 Easy inclusion of X-Faces headers.
25779
25780 @item
25781 Face headers handling.
25782
25783 @item
25784 In the summary buffer, the new command @kbd{/ N} inserts new messages
25785 and @kbd{/ o} inserts old messages.
25786
25787 @item
25788 Gnus decodes morse encoded messages if you press @kbd{W m}.
25789
25790 @item
25791 Unread count correct in nnimap groups.
25792
25793 The estimated number of unread articles in the group buffer should now
25794 be correct for nnimap groups.  This is achieved by calling
25795 @code{nnimap-fixup-unread-after-getting-new-news} from the
25796 @code{gnus-setup-news-hook} (called on startup) and
25797 @code{gnus-after-getting-new-news-hook}. (called after getting new
25798 mail).  If you have modified those variables from the default, you may
25799 want to add @code{nnimap-fixup-unread-after-getting-new-news} again.  If
25800 you were happy with the estimate and want to save some (minimal) time
25801 when getting new mail, remove the function.
25802
25803 @item
25804 Group Carbon Copy (GCC) quoting
25805
25806 To support groups that contains SPC and other weird characters, groups
25807 are quoted before they are placed in the Gcc: header.  This means
25808 variables such as @code{gnus-message-archive-group} should no longer
25809 contain quote characters to make groups containing SPC work.  Also, if
25810 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
25811 into two groups) you must change it to return the list
25812 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
25813 incorrectly.  Note that returning the string @samp{nnml:foo, nnml:bar}
25814 was incorrect earlier, it just didn't generate any problems since it
25815 was inserted directly.
25816
25817 @item
25818 @file{~/News/overview/} not used.
25819
25820 As a result of the following change, the @file{~/News/overview/}
25821 directory is not used any more.  You can safely delete the entire
25822 hierarchy.
25823
25824 @item
25825 @code{gnus-agent}
25826
25827 The Gnus Agent has seen a major updated and is now enabled by default,
25828 and all nntp and nnimap servers from @code{gnus-select-method} and
25829 @code{gnus-secondary-select-method} are agentized by default.  Earlier
25830 only the server in @code{gnus-select-method} was agentized by the
25831 default, and the agent was disabled by default.  When the agent is
25832 enabled, headers are now also retrieved from the Agent cache instead
25833 of the back ends when possible.  Earlier this only happened in the
25834 unplugged state.  You can enroll or remove servers with @kbd{J a} and
25835 @kbd{J r} in the server buffer.  Gnus will not download articles into
25836 the Agent cache, unless you instruct it to do so, though, by using
25837 @kbd{J u} or @kbd{J s} from the Group buffer.  You revert to the old
25838 behaviour of having the Agent disabled with @code{(setq gnus-agent
25839 nil)}.  Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
25840 is not needed any more.
25841
25842 @item
25843 @code{gnus-summary-line-format}
25844
25845 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
25846 %s\n}.  Moreover @code{gnus-extra-headers},
25847 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
25848 changed their default so that the users name will be replaced by the
25849 recipient's name or the group name posting to for @acronym{NNTP}
25850 groups.
25851
25852 @item
25853 @file{deuglify.el} (@code{gnus-article-outlook-deuglify-article})
25854
25855 A new file from Raymond Scholz @email{rscholz@@zonix.de} for deuglifying
25856 broken Outlook (Express) articles.
25857
25858 @item
25859 @code{(require 'gnus-load)}
25860
25861 If you use a stand-alone Gnus distribution, you'd better add
25862 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
25863 lisp directory into load-path.
25864
25865 File @file{gnus-load.el} contains autoload commands, functions and variables,
25866 some of which may not be included in distributions of Emacsen.
25867
25868 @item
25869 @code{gnus-slave-unplugged}
25870
25871 A new command which starts Gnus offline in slave mode.
25872
25873 @item
25874 @code{message-insinuate-rmail}
25875
25876 Adding @code{(message-insinuate-rmail)} and @code{(setq
25877 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
25878 compose, reply and forward messages in message-mode, where you can
25879 enjoy the power of @acronym{MML}.
25880
25881 @item
25882 @code{message-minibuffer-local-map}
25883
25884 The line below enables BBDB in resending a message:
25885 @lisp
25886 (define-key message-minibuffer-local-map [(tab)]
25887   'bbdb-complete-name)
25888 @end lisp
25889
25890 @item
25891 Externalizing and deleting of attachments.
25892
25893 If @code{gnus-gcc-externalize-attachments} or
25894 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
25895 local files as external parts.
25896
25897 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
25898 on @acronym{MIME} buttons) saves a part and replaces the part with an
25899 external one.  @code{gnus-mime-delete-part} (bound to @kbd{d} on
25900 @acronym{MIME} buttons) removes a part.  It works only on back ends
25901 that support editing.
25902
25903 @item
25904 @code{gnus-default-charset}
25905
25906 The default value is determined from the
25907 @code{current-language-environment} variable, instead of
25908 @code{iso-8859-1}.  Also the @samp{.*} item in
25909 @code{gnus-group-charset-alist} is removed.
25910
25911 @item
25912 @code{gnus-posting-styles}
25913
25914 Add a new format of match like
25915 @lisp
25916 ((header "to" "larsi.*org")
25917  (Organization "Somewhere, Inc."))
25918 @end lisp
25919 The old format like the lines below is obsolete, but still accepted.
25920 @lisp
25921 (header "to" "larsi.*org"
25922         (Organization "Somewhere, Inc."))
25923 @end lisp
25924
25925 @item
25926 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
25927
25928 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
25929 added into these two variables.  If you customized those, perhaps you
25930 need add those two headers too.
25931
25932 @item
25933 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
25934
25935 If one reads an article while plugged, and the article already exists
25936 in the Agent, it won't get downloaded once more.  @code{(setq
25937 gnus-agent-cache nil)} reverts to the old behavior.
25938
25939 @item
25940 Gnus supports the ``format=flowed'' (RFC 2646) parameter.  On
25941 composing messages, it is enabled by @code{use-hard-newlines}.
25942 Decoding format=flowed was present but not documented in earlier
25943 versions.
25944
25945 @item
25946 Gnus supports the generation of RFC 2298 Disposition Notification requests.
25947
25948 This is invoked with the @kbd{C-c M-n} key binding from message mode.
25949
25950 @item
25951 Gnus supports Maildir groups.
25952
25953 Gnus includes a new back end @file{nnmaildir.el}.  @xref{Maildir}.
25954
25955 @item
25956 Printing capabilities are enhanced.
25957
25958 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
25959 Article buffers.  Also, each individual @acronym{MIME} part can be
25960 printed using @kbd{p} on the @acronym{MIME} button.
25961
25962 @item
25963 Message supports the Importance: (RFC 2156) header.
25964
25965 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
25966 the valid values.
25967
25968 @item
25969 Gnus supports Cancel Locks in News.
25970
25971 This means a header @samp{Cancel-Lock} is inserted in news posting.  It is
25972 used to determine if you wrote an article or not (for canceling and
25973 superseding).  Gnus generates a random password string the first time
25974 you post a message, and saves it in your @file{~/.emacs} using the Custom
25975 system.  While the variable is called @code{canlock-password}, it is not
25976 security sensitive data.  Publishing your canlock string on the web
25977 will not allow anyone to be able to anything she could not already do.
25978 The behaviour can be changed by customizing @code{message-insert-canlock}.
25979
25980 @item
25981 Gnus supports server-side mail filtering using Sieve.
25982
25983 Sieve rules can be added as Group Parameters for groups, and the
25984 complete Sieve script is generated using @kbd{D g} from the Group
25985 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
25986 generated Sieve buffer.  @xref{Sieve Commands}, and the new Sieve
25987 manual @ref{Top, , Top, sieve, Emacs Sieve}.
25988
25989 @item
25990 Extended format specs.
25991
25992 Format spec @samp{%&user-date;} is added into
25993 @code{gnus-summary-line-format-alist}.  Also, user defined extended
25994 format specs are supported.  The extended format specs look like
25995 @samp{%u&foo;}, which invokes function
25996 @code{gnus-user-format-function-@var{foo}}.  Because @samp{&} is used as the
25997 escape character, old user defined format @samp{%u&} is no longer supported.
25998
25999 @item
26000 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
26001
26002 It was aliased to @kbd{Y c}
26003 (@code{gnus-summary-insert-cached-articles}).  The new function filters
26004 out other articles.
26005
26006 @item Some limiting commands accept a @kbd{C-u} prefix to negate the match.
26007
26008 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
26009 s}, @kbd{/ a}, and @kbd{/ x}
26010 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
26011 result will be to display all articles that do not match the expression.
26012
26013 @item
26014 Group names are treated as UTF-8 by default.
26015
26016 This is supposedly what USEFOR wanted to migrate to.  See
26017 @code{gnus-group-name-charset-group-alist} and
26018 @code{gnus-group-name-charset-method-alist} for customization.
26019
26020 @item
26021 The nnml and nnfolder back ends store marks for each groups.
26022
26023 This makes it possible to take backup of nnml/nnfolder servers/groups
26024 separately of @file{~/.newsrc.eld}, while preserving marks.  It also
26025 makes it possible to share articles and marks between users (without
26026 sharing the @file{~/.newsrc.eld} file) within e.g. a department.  It
26027 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
26028 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
26029 nnfolder, named @var{groupname}).  If the nnml/nnfolder is moved to
26030 another machine, Gnus will automatically use the @file{.marks} or
26031 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
26032 The new server variables @code{nnml-marks-is-evil} and
26033 @code{nnfolder-marks-is-evil} can be used to disable this feature.
26034
26035 @item
26036 The menu bar item (in Group and Summary buffer) named ``Misc'' has
26037 been renamed to ``Gnus''.
26038
26039 @item
26040 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
26041 renamed to ``Attachments''.  Note that this menu also contains security
26042 related stuff, like signing and encryption (@pxref{Security, Security,,
26043 message, Message Manual}).
26044
26045 @item
26046 @code{gnus-group-charset-alist} and
26047 @code{gnus-group-ignored-charsets-alist}.
26048
26049 The regexps in these variables are compared with full group names
26050 instead of real group names in 5.8.  Users who customize these
26051 variables should change those regexps accordingly.  For example:
26052 @lisp
26053 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
26054 @end lisp
26055
26056 @item
26057 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
26058 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
26059
26060 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
26061 additional Lisp libraries.  This add several menu items to the
26062 Attachments menu, and @kbd{C-c RET} key bindings, when composing
26063 messages.  This also obsoletes @code{gnus-article-hide-pgp-hook}.
26064
26065 @item
26066 Gnus inlines external parts (message/external).
26067
26068 @item
26069 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
26070 C-m}.
26071
26072 This change was made to avoid conflict with the standard binding of
26073 @code{back-to-indentation}, which is also useful in message mode.
26074
26075 @item
26076 The default for @code{message-forward-show-mml} changed to symbol @code{best}.
26077
26078 The behaviour for the @code{best} value is to show @acronym{MML} (i.e.,
26079 convert to @acronym{MIME}) when appropriate.  @acronym{MML} will not be
26080 used when forwarding signed or encrypted messages, as the conversion
26081 invalidate the digital signature.
26082 @end itemize
26083
26084 @node No Gnus
26085 @subsubsection No Gnus
26086 @cindex No Gnus
26087
26088 New features in No Gnus:
26089 @c FIXME: Gnus 5.12?
26090
26091 @include gnus-news.texi
26092
26093 @iftex
26094
26095 @page
26096 @node The Manual
26097 @section The Manual
26098 @cindex colophon
26099 @cindex manual
26100
26101 This manual was generated from a TeXinfo file and then run through
26102 either @code{texi2dvi}
26103 @iflatex
26104 or my own home-brewed TeXinfo to \LaTeX\ transformer,
26105 and then run through @code{latex} and @code{dvips}
26106 @end iflatex
26107 to get what you hold in your hands now.
26108
26109 The following conventions have been used:
26110
26111 @enumerate
26112
26113 @item
26114 This is a @samp{string}
26115
26116 @item
26117 This is a @kbd{keystroke}
26118
26119 @item
26120 This is a @file{file}
26121
26122 @item
26123 This is a @code{symbol}
26124
26125 @end enumerate
26126
26127 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
26128 mean:
26129
26130 @lisp
26131 (setq flargnoze "yes")
26132 @end lisp
26133
26134 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
26135
26136 @lisp
26137 (setq flumphel 'yes)
26138 @end lisp
26139
26140 @samp{yes} and @code{yes} are two @emph{very} different things---don't
26141 ever get them confused.
26142
26143 @iflatex
26144 @c @head
26145 Of course, everything in this manual is of vital interest, so you should
26146 read it all.  Several times.  However, if you feel like skimming the
26147 manual, look for that gnu head you should see in the margin over
26148 there---it means that what's being discussed is of more importance than
26149 the rest of the stuff.  (On the other hand, if everything is infinitely
26150 important, how can anything be more important than that?  Just one more
26151 of the mysteries of this world, I guess.)
26152 @end iflatex
26153
26154 @end iftex
26155
26156
26157 @node On Writing Manuals
26158 @section On Writing Manuals
26159
26160 I guess most manuals are written after-the-fact; documenting a program
26161 that's already there.  This is not how this manual is written.  When
26162 implementing something, I write the manual entry for that something
26163 straight away.  I then see that it's difficult to explain the
26164 functionality, so I write how it's supposed to be, and then I change the
26165 implementation.  Writing the documentation and writing the code goes
26166 hand in hand.
26167
26168 This, of course, means that this manual has no, or little, flow.  It
26169 documents absolutely everything in Gnus, but often not where you're
26170 looking for it.  It is a reference manual, and not a guide to how to get
26171 started with Gnus.
26172
26173 That would be a totally different book, that should be written using the
26174 reference manual as source material.  It would look quite differently.
26175
26176
26177 @page
26178 @node Terminology
26179 @section Terminology
26180
26181 @cindex terminology
26182 @table @dfn
26183
26184 @item news
26185 @cindex news
26186 This is what you are supposed to use this thing for---reading news.
26187 News is generally fetched from a nearby @acronym{NNTP} server, and is
26188 generally publicly available to everybody.  If you post news, the entire
26189 world is likely to read just what you have written, and they'll all
26190 snigger mischievously.  Behind your back.
26191
26192 @item mail
26193 @cindex mail
26194 Everything that's delivered to you personally is mail.  Some news/mail
26195 readers (like Gnus) blur the distinction between mail and news, but
26196 there is a difference.  Mail is private.  News is public.  Mailing is
26197 not posting, and replying is not following up.
26198
26199 @item reply
26200 @cindex reply
26201 Send a mail to the person who has written what you are reading.
26202
26203 @item follow up
26204 @cindex follow up
26205 Post an article to the current newsgroup responding to the article you
26206 are reading.
26207
26208 @item back end
26209 @cindex back end
26210 Gnus considers mail and news to be mostly the same, really.  The only
26211 difference is how to access the actual articles.  News articles are
26212 commonly fetched via the protocol @acronym{NNTP}, whereas mail
26213 messages could be read from a file on the local disk.  The internal
26214 architecture of Gnus thus comprises a ``front end'' and a number of
26215 ``back ends''.  Internally, when you enter a group (by hitting
26216 @key{RET}, say), you thereby invoke a function in the front end in
26217 Gnus.  The front end then ``talks'' to a back end and says things like
26218 ``Give me the list of articles in the foo group'' or ``Show me article
26219 number 4711''.
26220
26221 So a back end mainly defines either a protocol (the @code{nntp} back
26222 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
26223 accesses mail via @acronym{IMAP}) or a file format and directory
26224 layout (the @code{nnspool} back end accesses news via the common
26225 ``spool directory'' format, the @code{nnml} back end access mail via a
26226 file format and directory layout that's quite similar).
26227
26228 Gnus does not handle the underlying media, so to speak---this is all
26229 done by the back ends.  A back end is a collection of functions to
26230 access the articles.
26231
26232 However, sometimes the term ``back end'' is also used where ``server''
26233 would have been more appropriate.  And then there is the term ``select
26234 method'' which can mean either.  The Gnus terminology can be quite
26235 confusing.
26236
26237 @item native
26238 @cindex native
26239 Gnus will always use one method (and back end) as the @dfn{native}, or
26240 default, way of getting news.
26241
26242 @item foreign
26243 @cindex foreign
26244 You can also have any number of foreign groups active at the same time.
26245 These are groups that use non-native non-secondary back ends for getting
26246 news.
26247
26248 @item secondary
26249 @cindex secondary
26250 Secondary back ends are somewhere half-way between being native and being
26251 foreign, but they mostly act like they are native.
26252
26253 @item article
26254 @cindex article
26255 A message that has been posted as news.
26256
26257 @item mail message
26258 @cindex mail message
26259 A message that has been mailed.
26260
26261 @item message
26262 @cindex message
26263 A mail message or news article
26264
26265 @item head
26266 @cindex head
26267 The top part of a message, where administrative information (etc.) is
26268 put.
26269
26270 @item body
26271 @cindex body
26272 The rest of an article.  Everything not in the head is in the
26273 body.
26274
26275 @item header
26276 @cindex header
26277 A line from the head of an article.
26278
26279 @item headers
26280 @cindex headers
26281 A collection of such lines, or a collection of heads.  Or even a
26282 collection of @acronym{NOV} lines.
26283
26284 @item @acronym{NOV}
26285 @cindex @acronym{NOV}
26286 When Gnus enters a group, it asks the back end for the headers of all
26287 unread articles in the group.  Most servers support the News OverView
26288 format, which is more compact and much faster to read and parse than the
26289 normal @sc{head} format.
26290
26291 @item level
26292 @cindex levels
26293 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
26294 that have a lower level are ``more'' subscribed than the groups with a
26295 higher level.  In fact, groups on levels 1-5 are considered
26296 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
26297 are @dfn{killed}.  Commands for listing groups and scanning for new
26298 articles will all use the numeric prefix as @dfn{working level}.
26299
26300 @item killed groups
26301 @cindex killed groups
26302 No information on killed groups is stored or updated, which makes killed
26303 groups much easier to handle than subscribed groups.
26304
26305 @item zombie groups
26306 @cindex zombie groups
26307 Just like killed groups, only slightly less dead.
26308
26309 @item active file
26310 @cindex active file
26311 The news server has to keep track of what articles it carries, and what
26312 groups exist.  All this information in stored in the active file, which
26313 is rather large, as you might surmise.
26314
26315 @item bogus groups
26316 @cindex bogus groups
26317 A group that exists in the @file{.newsrc} file, but isn't known to the
26318 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
26319 This means that the group probably doesn't exist (any more).
26320
26321 @item activating
26322 @cindex activating groups
26323 The act of asking the server for info on a group and computing the
26324 number of unread articles is called @dfn{activating the group}.
26325 Un-activated groups are listed with @samp{*} in the group buffer.
26326
26327 @item server
26328 @cindex server
26329 A machine one can connect to and get news (or mail) from.
26330
26331 @item select method
26332 @cindex select method
26333 A structure that specifies the back end, the server and the virtual
26334 server settings.
26335
26336 @item virtual server
26337 @cindex virtual server
26338 A named select method.  Since a select method defines all there is to
26339 know about connecting to a (physical) server, taking the thing as a
26340 whole is a virtual server.
26341
26342 @item washing
26343 @cindex washing
26344 Taking a buffer and running it through a filter of some sort.  The
26345 result will (more often than not) be cleaner and more pleasing than the
26346 original.
26347
26348 @item ephemeral groups
26349 @cindex ephemeral groups
26350 @cindex temporary groups
26351 Most groups store data on what articles you have read.  @dfn{Ephemeral}
26352 groups are groups that will have no data stored---when you exit the
26353 group, it'll disappear into the aether.
26354
26355 @item solid groups
26356 @cindex solid groups
26357 This is the opposite of ephemeral groups.  All groups listed in the
26358 group buffer are solid groups.
26359
26360 @item sparse articles
26361 @cindex sparse articles
26362 These are article placeholders shown in the summary buffer when
26363 @code{gnus-build-sparse-threads} has been switched on.
26364
26365 @item threading
26366 @cindex threading
26367 To put responses to articles directly after the articles they respond
26368 to---in a hierarchical fashion.
26369
26370 @item root
26371 @cindex root
26372 @cindex thread root
26373 The first article in a thread is the root.  It is the ancestor of all
26374 articles in the thread.
26375
26376 @item parent
26377 @cindex parent
26378 An article that has responses.
26379
26380 @item child
26381 @cindex child
26382 An article that responds to a different article---its parent.
26383
26384 @item digest
26385 @cindex digest
26386 A collection of messages in one file.  The most common digest format is
26387 specified by RFC 1153.
26388
26389 @item splitting
26390 @cindex splitting, terminolgy
26391 @cindex mail sorting
26392 @cindex mail filtering (splitting)
26393 The action of sorting your emails according to certain rules. Sometimes
26394 incorrectly called mail filtering.
26395
26396 @end table
26397
26398
26399 @page
26400 @node Customization
26401 @section Customization
26402 @cindex general customization
26403
26404 All variables are properly documented elsewhere in this manual.  This
26405 section is designed to give general pointers on how to customize Gnus
26406 for some quite common situations.
26407
26408 @menu
26409 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
26410 * Slow Terminal Connection::    You run a remote Emacs.
26411 * Little Disk Space::           You feel that having large setup files is icky.
26412 * Slow Machine::                You feel like buying a faster machine.
26413 @end menu
26414
26415
26416 @node Slow/Expensive Connection
26417 @subsection Slow/Expensive NNTP Connection
26418
26419 If you run Emacs on a machine locally, and get your news from a machine
26420 over some very thin strings, you want to cut down on the amount of data
26421 Gnus has to get from the @acronym{NNTP} server.
26422
26423 @table @code
26424
26425 @item gnus-read-active-file
26426 Set this to @code{nil}, which will inhibit Gnus from requesting the
26427 entire active file from the server.  This file is often v.  large.  You
26428 also have to set @code{gnus-check-new-newsgroups} and
26429 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
26430 doesn't suddenly decide to fetch the active file anyway.
26431
26432 @item gnus-nov-is-evil
26433 This one has to be @code{nil}.  If not, grabbing article headers from
26434 the @acronym{NNTP} server will not be very fast.  Not all @acronym{NNTP} servers
26435 support @sc{xover}; Gnus will detect this by itself.
26436 @end table
26437
26438
26439 @node Slow Terminal Connection
26440 @subsection Slow Terminal Connection
26441
26442 Let's say you use your home computer for dialing up the system that runs
26443 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
26444 possible) the amount of data sent over the wires.
26445
26446 @table @code
26447
26448 @item gnus-auto-center-summary
26449 Set this to @code{nil} to inhibit Gnus from re-centering the summary
26450 buffer all the time.  If it is @code{vertical}, do only vertical
26451 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
26452 horizontal and vertical recentering.
26453
26454 @item gnus-visible-headers
26455 Cut down on the headers included in the articles to the
26456 minimum.  You can, in fact, make do without them altogether---most of the
26457 useful data is in the summary buffer, anyway.  Set this variable to
26458 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
26459
26460 Set this hook to all the available hiding commands:
26461 @lisp
26462 (setq gnus-treat-hide-headers 'head
26463       gnus-treat-hide-signature t
26464       gnus-treat-hide-citation t)
26465 @end lisp
26466
26467 @item gnus-use-full-window
26468 By setting this to @code{nil}, you can make all the windows smaller.
26469 While this doesn't really cut down much generally, it means that you
26470 have to see smaller portions of articles before deciding that you didn't
26471 want to read them anyway.
26472
26473 @item gnus-thread-hide-subtree
26474 If this is non-@code{nil}, all threads in the summary buffer will be
26475 hidden initially.
26476
26477
26478 @item gnus-updated-mode-lines
26479 If this is @code{nil}, Gnus will not put information in the buffer mode
26480 lines, which might save some time.
26481 @end table
26482
26483
26484 @node Little Disk Space
26485 @subsection Little Disk Space
26486 @cindex disk space
26487
26488 The startup files can get rather large, so you may want to cut their
26489 sizes a bit if you are running out of space.
26490
26491 @table @code
26492
26493 @item gnus-save-newsrc-file
26494 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
26495 only save @file{.newsrc.eld}.  This means that you will not be able to
26496 use any other newsreaders than Gnus.  This variable is @code{t} by
26497 default.
26498
26499 @item gnus-read-newsrc-file
26500 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
26501 only read @file{.newsrc.eld}.  This means that you will not be able to
26502 use any other newsreaders than Gnus.  This variable is @code{t} by
26503 default.
26504
26505 @item gnus-save-killed-list
26506 If this is @code{nil}, Gnus will not save the list of dead groups.  You
26507 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
26508 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
26509 variable to @code{nil}.  This variable is @code{t} by default.
26510
26511 @end table
26512
26513
26514 @node Slow Machine
26515 @subsection Slow Machine
26516 @cindex slow machine
26517
26518 If you have a slow machine, or are just really impatient, there are a
26519 few things you can do to make Gnus run faster.
26520
26521 Set @code{gnus-check-new-newsgroups} and
26522 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
26523
26524 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
26525 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
26526 summary buffer faster.
26527
26528 Gnus uses the internal ELisp-based @code{uncompface} program for
26529 decoding an @code{X-Face} header normally in Emacs.  If you feel it is
26530 slow, set @code{uncompface-use-external} to @code{t}.  @xref{X-Face}.
26531
26532
26533 @page
26534 @node Troubleshooting
26535 @section Troubleshooting
26536 @cindex troubleshooting
26537
26538 Gnus works @emph{so} well straight out of the box---I can't imagine any
26539 problems, really.
26540
26541 Ahem.
26542
26543 @enumerate
26544
26545 @item
26546 Make sure your computer is switched on.
26547
26548 @item
26549 Make sure that you really load the current Gnus version.  If you have
26550 been running @sc{gnus}, you need to exit Emacs and start it up again before
26551 Gnus will work.
26552
26553 @item
26554 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
26555 like @samp{Gnus v5.10.6} you have the right files loaded.  Otherwise
26556 you have some old @file{.el} files lying around.  Delete these.
26557
26558 @item
26559 Read the help group (@kbd{G h} in the group buffer) for a
26560 @acronym{FAQ} and a how-to.
26561
26562 @item
26563 @vindex max-lisp-eval-depth
26564 Gnus works on many recursive structures, and in some extreme (and very
26565 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
26566 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
26567 something like that.
26568 @end enumerate
26569
26570 If all else fails, report the problem as a bug.
26571
26572 @cindex bugs
26573 @cindex reporting bugs
26574
26575 @kindex M-x gnus-bug
26576 @findex gnus-bug
26577 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
26578 command.  @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
26579 me the backtrace.  I will fix bugs, but I can only fix them if you send
26580 me a precise description as to how to reproduce the bug.
26581
26582 You really can never be too detailed in a bug report.  Always use the
26583 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
26584 a 10Kb mail each time you use it, and even if you have sent me your
26585 environment 500 times before.  I don't care.  I want the full info each
26586 time.
26587
26588 It is also important to remember that I have no memory whatsoever.  If
26589 you send a bug report, and I send you a reply, and then you just send
26590 back ``No, it's not! Moron!'', I will have no idea what you are
26591 insulting me about.  Always over-explain everything.  It's much easier
26592 for all of us---if I don't have all the information I need, I will just
26593 mail you and ask for more info, and everything takes more time.
26594
26595 If the problem you're seeing is very visual, and you can't quite explain
26596 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
26597 it somewhere it can be reached, and include the URL of the picture in
26598 the bug report.
26599
26600 @cindex patches
26601 If you would like to contribute a patch to fix bugs or make
26602 improvements, please produce the patch using @samp{diff -u}.
26603
26604 @cindex edebug
26605 If you want to debug your problem further before reporting, possibly
26606 in order to solve the problem yourself and send a patch, you can use
26607 edebug.  Debugging Lisp code is documented in the Elisp manual
26608 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
26609 Lisp Reference Manual}).  To get you started with edebug, consider if
26610 you discover some weird behaviour when pressing @kbd{c}, the first
26611 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
26612 the documentation buffer that leads you to the function definition,
26613 then press @kbd{M-x edebug-defun RET} with point inside that function,
26614 return to Gnus and press @kbd{c} to invoke the code.  You will be
26615 placed in the lisp buffer and can single step using @kbd{SPC} and
26616 evaluate expressions using @kbd{M-:} or inspect variables using
26617 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
26618 @kbd{c} or @kbd{g}.
26619
26620 @cindex elp
26621 @cindex profile
26622 @cindex slow
26623 Sometimes, a problem do not directly generate an elisp error but
26624 manifests itself by causing Gnus to be very slow.  In these cases, you
26625 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
26626 slow, and then try to analyze the backtrace (repeating the procedure
26627 helps isolating the real problem areas).
26628
26629 A fancier approach is to use the elisp profiler, ELP.  The profiler is
26630 (or should be) fully documented elsewhere, but to get you started
26631 there are a few steps that need to be followed.  First, instrument the
26632 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
26633 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
26634 RET message}.  Then perform the operation that is slow and press
26635 @kbd{M-x elp-results}.  You will then see which operations that takes
26636 time, and can debug them further.  If the entire operation takes much
26637 longer than the time spent in the slowest function in the profiler
26638 output, you probably profiled the wrong part of Gnus.  To reset
26639 profiling statistics, use @kbd{M-x elp-reset-all}.  @kbd{M-x
26640 elp-restore-all} is supposed to remove profiling, but given the
26641 complexities and dynamic code generation in Gnus, it might not always
26642 work perfectly.
26643
26644 @cindex gnu.emacs.gnus
26645 @cindex ding mailing list
26646 If you just need help, you are better off asking on
26647 @samp{gnu.emacs.gnus}.  I'm not very helpful.  You can also ask on
26648 @email{ding@@gnus.org, the ding mailing list}.  Write to
26649 @email{ding-request@@gnus.org} to subscribe.
26650
26651
26652 @page
26653 @node Gnus Reference Guide
26654 @section Gnus Reference Guide
26655
26656 It is my hope that other people will figure out smart stuff that Gnus
26657 can do, and that other people will write those smart things as well.  To
26658 facilitate that I thought it would be a good idea to describe the inner
26659 workings of Gnus.  And some of the not-so-inner workings, while I'm at
26660 it.
26661
26662 You can never expect the internals of a program not to change, but I
26663 will be defining (in some details) the interface between Gnus and its
26664 back ends (this is written in stone), the format of the score files
26665 (ditto), data structures (some are less likely to change than others)
26666 and general methods of operation.
26667
26668 @menu
26669 * Gnus Utility Functions::      Common functions and variable to use.
26670 * Back End Interface::          How Gnus communicates with the servers.
26671 * Score File Syntax::           A BNF definition of the score file standard.
26672 * Headers::                     How Gnus stores headers internally.
26673 * Ranges::                      A handy format for storing mucho numbers.
26674 * Group Info::                  The group info format.
26675 * Extended Interactive::        Symbolic prefixes and stuff.
26676 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
26677 * Various File Formats::        Formats of files that Gnus use.
26678 @end menu
26679
26680
26681 @node Gnus Utility Functions
26682 @subsection Gnus Utility Functions
26683 @cindex Gnus utility functions
26684 @cindex utility functions
26685 @cindex functions
26686 @cindex internal variables
26687
26688 When writing small functions to be run from hooks (and stuff), it's
26689 vital to have access to the Gnus internal functions and variables.
26690 Below is a list of the most common ones.
26691
26692 @table @code
26693
26694 @item gnus-newsgroup-name
26695 @vindex gnus-newsgroup-name
26696 This variable holds the name of the current newsgroup.
26697
26698 @item gnus-find-method-for-group
26699 @findex gnus-find-method-for-group
26700 A function that returns the select method for @var{group}.
26701
26702 @item gnus-group-real-name
26703 @findex gnus-group-real-name
26704 Takes a full (prefixed) Gnus group name, and returns the unprefixed
26705 name.
26706
26707 @item gnus-group-prefixed-name
26708 @findex gnus-group-prefixed-name
26709 Takes an unprefixed group name and a select method, and returns the full
26710 (prefixed) Gnus group name.
26711
26712 @item gnus-get-info
26713 @findex gnus-get-info
26714 Returns the group info list for @var{group}.
26715
26716 @item gnus-group-unread
26717 @findex gnus-group-unread
26718 The number of unread articles in @var{group}, or @code{t} if that is
26719 unknown.
26720
26721 @item gnus-active
26722 @findex gnus-active
26723 The active entry for @var{group}.
26724
26725 @item gnus-set-active
26726 @findex gnus-set-active
26727 Set the active entry for @var{group}.
26728
26729 @item gnus-add-current-to-buffer-list
26730 @findex gnus-add-current-to-buffer-list
26731 Adds the current buffer to the list of buffers to be killed on Gnus
26732 exit.
26733
26734 @item gnus-continuum-version
26735 @findex gnus-continuum-version
26736 Takes a Gnus version string as a parameter and returns a floating point
26737 number.  Earlier versions will always get a lower number than later
26738 versions.
26739
26740 @item gnus-group-read-only-p
26741 @findex gnus-group-read-only-p
26742 Says whether @var{group} is read-only or not.
26743
26744 @item gnus-news-group-p
26745 @findex gnus-news-group-p
26746 Says whether @var{group} came from a news back end.
26747
26748 @item gnus-ephemeral-group-p
26749 @findex gnus-ephemeral-group-p
26750 Says whether @var{group} is ephemeral or not.
26751
26752 @item gnus-server-to-method
26753 @findex gnus-server-to-method
26754 Returns the select method corresponding to @var{server}.
26755
26756 @item gnus-server-equal
26757 @findex gnus-server-equal
26758 Says whether two virtual servers are equal.
26759
26760 @item gnus-group-native-p
26761 @findex gnus-group-native-p
26762 Says whether @var{group} is native or not.
26763
26764 @item gnus-group-secondary-p
26765 @findex gnus-group-secondary-p
26766 Says whether @var{group} is secondary or not.
26767
26768 @item gnus-group-foreign-p
26769 @findex gnus-group-foreign-p
26770 Says whether @var{group} is foreign or not.
26771
26772 @item gnus-group-find-parameter
26773 @findex gnus-group-find-parameter
26774 Returns the parameter list of @var{group}.  If given a second parameter,
26775 returns the value of that parameter for @var{group}.
26776
26777 @item gnus-group-set-parameter
26778 @findex gnus-group-set-parameter
26779 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
26780
26781 @item gnus-narrow-to-body
26782 @findex gnus-narrow-to-body
26783 Narrows the current buffer to the body of the article.
26784
26785 @item gnus-check-backend-function
26786 @findex gnus-check-backend-function
26787 Takes two parameters, @var{function} and @var{group}.  If the back end
26788 @var{group} comes from supports @var{function}, return non-@code{nil}.
26789
26790 @lisp
26791 (gnus-check-backend-function "request-scan" "nnml:misc")
26792 @result{} t
26793 @end lisp
26794
26795 @item gnus-read-method
26796 @findex gnus-read-method
26797 Prompts the user for a select method.
26798
26799 @end table
26800
26801
26802 @node Back End Interface
26803 @subsection Back End Interface
26804
26805 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
26806 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
26807 server is a @dfn{back end} and some @dfn{back end variables}.  As examples
26808 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
26809 examples of the latter we have @code{nntp-port-number} and
26810 @code{nnmbox-directory}.
26811
26812 When Gnus asks for information from a back end---say @code{nntp}---on
26813 something, it will normally include a virtual server name in the
26814 function parameters.  (If not, the back end should use the ``current''
26815 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
26816 server as its only (optional) parameter.  If this virtual server hasn't
26817 been opened, the function should fail.
26818
26819 Note that a virtual server name has no relation to some physical server
26820 name.  Take this example:
26821
26822 @lisp
26823 (nntp "odd-one"
26824       (nntp-address "ifi.uio.no")
26825       (nntp-port-number 4324))
26826 @end lisp
26827
26828 Here the virtual server name is @samp{odd-one} while the name of
26829 the physical server is @samp{ifi.uio.no}.
26830
26831 The back ends should be able to switch between several virtual servers.
26832 The standard back ends implement this by keeping an alist of virtual
26833 server environments that they pull down/push up when needed.
26834
26835 There are two groups of interface functions: @dfn{required functions},
26836 which must be present, and @dfn{optional functions}, which Gnus will
26837 always check for presence before attempting to call 'em.
26838
26839 All these functions are expected to return data in the buffer
26840 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
26841 unfortunately named, but we'll have to live with it.  When I talk about
26842 @dfn{resulting data}, I always refer to the data in that buffer.  When I
26843 talk about @dfn{return value}, I talk about the function value returned by
26844 the function call.  Functions that fail should return @code{nil} as the
26845 return value.
26846
26847 Some back ends could be said to be @dfn{server-forming} back ends, and
26848 some might be said not to be.  The latter are back ends that generally
26849 only operate on one group at a time, and have no concept of ``server''
26850 ---they have a group, and they deliver info on that group and nothing
26851 more.
26852
26853 Gnus identifies each message by way of group name and article number.  A
26854 few remarks about these article numbers might be useful.  First of all,
26855 the numbers are positive integers.  Secondly, it is normally not
26856 possible for later articles to ``re-use'' older article numbers without
26857 confusing Gnus.  That is, if a group has ever contained a message
26858 numbered 42, then no other message may get that number, or Gnus will get
26859 mightily confused.@footnote{See the function
26860 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
26861 Third, article numbers must be assigned in order of arrival in the
26862 group; this is not necessarily the same as the date of the message.
26863
26864 The previous paragraph already mentions all the ``hard'' restrictions that
26865 article numbers must fulfill.  But it seems that it might be useful to
26866 assign @emph{consecutive} article numbers, for Gnus gets quite confused
26867 if there are holes in the article numbering sequence.  However, due to
26868 the ``no-reuse'' restriction, holes cannot be avoided altogether.  It's
26869 also useful for the article numbers to start at 1 to avoid running out
26870 of numbers as long as possible.
26871
26872 Note that by convention, back ends are named @code{nnsomething}, but
26873 Gnus also comes with some @code{nnnotbackends}, such as
26874 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
26875
26876 In the examples and definitions I will refer to the imaginary back end
26877 @code{nnchoke}.
26878
26879 @cindex @code{nnchoke}
26880
26881 @menu
26882 * Required Back End Functions::  Functions that must be implemented.
26883 * Optional Back End Functions::  Functions that need not be implemented.
26884 * Error Messaging::             How to get messages and report errors.
26885 * Writing New Back Ends::       Extending old back ends.
26886 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
26887 * Mail-like Back Ends::         Some tips on mail back ends.
26888 @end menu
26889
26890
26891 @node Required Back End Functions
26892 @subsubsection Required Back End Functions
26893
26894 @table @code
26895
26896 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
26897
26898 @var{articles} is either a range of article numbers or a list of
26899 @code{Message-ID}s.  Current back ends do not fully support either---only
26900 sequences (lists) of article numbers, and most back ends do not support
26901 retrieval of @code{Message-ID}s.  But they should try for both.
26902
26903 The result data should either be HEADs or @acronym{NOV} lines, and the result
26904 value should either be @code{headers} or @code{nov} to reflect this.
26905 This might later be expanded to @code{various}, which will be a mixture
26906 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
26907
26908 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
26909 headers'', in some meaning of the word.  This is generally done by
26910 fetching (at most) @var{fetch-old} extra headers less than the smallest
26911 article number in @code{articles}, and filling the gaps as well.  The
26912 presence of this parameter can be ignored if the back end finds it
26913 cumbersome to follow the request.  If this is non-@code{nil} and not a
26914 number, do maximum fetches.
26915
26916 Here's an example HEAD:
26917
26918 @example
26919 221 1056 Article retrieved.
26920 Path: ifi.uio.no!sturles
26921 From: sturles@@ifi.uio.no (Sturle Sunde)
26922 Newsgroups: ifi.discussion
26923 Subject: Re: Something very droll
26924 Date: 27 Oct 1994 14:02:57 +0100
26925 Organization: Dept. of Informatics, University of Oslo, Norway
26926 Lines: 26
26927 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
26928 References: <38jdmq$4qu@@visbur.ifi.uio.no>
26929 NNTP-Posting-Host: holmenkollen.ifi.uio.no
26930 .
26931 @end example
26932
26933 So a @code{headers} return value would imply that there's a number of
26934 these in the data buffer.
26935
26936 Here's a BNF definition of such a buffer:
26937
26938 @example
26939 headers        = *head
26940 head           = error / valid-head
26941 error-message  = [ "4" / "5" ] 2number " " <error message> eol
26942 valid-head     = valid-message *header "." eol
26943 valid-message  = "221 " <number> " Article retrieved." eol
26944 header         = <text> eol
26945 @end example
26946
26947 @cindex BNF
26948 (The version of BNF used here is the one used in RFC822.)
26949
26950 If the return value is @code{nov}, the data buffer should contain
26951 @dfn{network overview database} lines.  These are basically fields
26952 separated by tabs.
26953
26954 @example
26955 nov-buffer = *nov-line
26956 nov-line   = field 7*8[ <TAB> field ] eol
26957 field      = <text except TAB>
26958 @end example
26959
26960 For a closer look at what should be in those fields,
26961 @pxref{Headers}.
26962
26963
26964 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
26965
26966 @var{server} is here the virtual server name.  @var{definitions} is a
26967 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
26968
26969 If the server can't be opened, no error should be signaled.  The back end
26970 may then choose to refuse further attempts at connecting to this
26971 server.  In fact, it should do so.
26972
26973 If the server is opened already, this function should return a
26974 non-@code{nil} value.  There should be no data returned.
26975
26976
26977 @item (nnchoke-close-server &optional SERVER)
26978
26979 Close connection to @var{server} and free all resources connected
26980 to it.  Return @code{nil} if the server couldn't be closed for some
26981 reason.
26982
26983 There should be no data returned.
26984
26985
26986 @item (nnchoke-request-close)
26987
26988 Close connection to all servers and free all resources that the back end
26989 have reserved.  All buffers that have been created by that back end
26990 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
26991 function is generally only called when Gnus is shutting down.
26992
26993 There should be no data returned.
26994
26995
26996 @item (nnchoke-server-opened &optional SERVER)
26997
26998 If @var{server} is the current virtual server, and the connection to the
26999 physical server is alive, then this function should return a
27000 non-@code{nil} value.  This function should under no circumstances
27001 attempt to reconnect to a server we have lost connection to.
27002
27003 There should be no data returned.
27004
27005
27006 @item (nnchoke-status-message &optional SERVER)
27007
27008 This function should return the last error message from @var{server}.
27009
27010 There should be no data returned.
27011
27012
27013 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
27014
27015 The result data from this function should be the article specified by
27016 @var{article}.  This might either be a @code{Message-ID} or a number.
27017 It is optional whether to implement retrieval by @code{Message-ID}, but
27018 it would be nice if that were possible.
27019
27020 If @var{to-buffer} is non-@code{nil}, the result data should be returned
27021 in this buffer instead of the normal data buffer.  This is to make it
27022 possible to avoid copying large amounts of data from one buffer to
27023 another, while Gnus mainly requests articles to be inserted directly
27024 into its article buffer.
27025
27026 If it is at all possible, this function should return a cons cell where
27027 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
27028 the article number.  This will enable Gnus to find out what the real
27029 group and article numbers are when fetching articles by
27030 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
27031 on successful article retrieval.
27032
27033
27034 @item (nnchoke-request-group GROUP &optional SERVER FAST)
27035
27036 Get data on @var{group}.  This function also has the side effect of
27037 making @var{group} the current group.
27038
27039 If @var{fast}, don't bother to return useful data, just make @var{group}
27040 the current group.
27041
27042 Here's an example of some result data and a definition of the same:
27043
27044 @example
27045 211 56 1000 1059 ifi.discussion
27046 @end example
27047
27048 The first number is the status, which should be 211.  Next is the
27049 total number of articles in the group, the lowest article number, the
27050 highest article number, and finally the group name.  Note that the total
27051 number of articles may be less than one might think while just
27052 considering the highest and lowest article numbers, but some articles
27053 may have been canceled.  Gnus just discards the total-number, so
27054 whether one should take the bother to generate it properly (if that is a
27055 problem) is left as an exercise to the reader.  If the group contains no
27056 articles, the lowest article number should be reported as 1 and the
27057 highest as 0.
27058
27059 @example
27060 group-status = [ error / info ] eol
27061 error        = [ "4" / "5" ] 2<number> " " <Error message>
27062 info         = "211 " 3* [ <number> " " ] <string>
27063 @end example
27064
27065
27066 @item (nnchoke-close-group GROUP &optional SERVER)
27067
27068 Close @var{group} and free any resources connected to it.  This will be
27069 a no-op on most back ends.
27070
27071 There should be no data returned.
27072
27073
27074 @item (nnchoke-request-list &optional SERVER)
27075
27076 Return a list of all groups available on @var{server}.  And that means
27077 @emph{all}.
27078
27079 Here's an example from a server that only carries two groups:
27080
27081 @example
27082 ifi.test 0000002200 0000002000 y
27083 ifi.discussion 3324 3300 n
27084 @end example
27085
27086 On each line we have a group name, then the highest article number in
27087 that group, the lowest article number, and finally a flag.  If the group
27088 contains no articles, the lowest article number should be reported as 1
27089 and the highest as 0.
27090
27091 @example
27092 active-file = *active-line
27093 active-line = name " " <number> " " <number> " " flags eol
27094 name        = <string>
27095 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
27096 @end example
27097
27098 The flag says whether the group is read-only (@samp{n}), is moderated
27099 (@samp{m}), is dead (@samp{x}), is aliased to some other group
27100 (@samp{=other-group}) or none of the above (@samp{y}).
27101
27102
27103 @item (nnchoke-request-post &optional SERVER)
27104
27105 This function should post the current buffer.  It might return whether
27106 the posting was successful or not, but that's not required.  If, for
27107 instance, the posting is done asynchronously, it has generally not been
27108 completed by the time this function concludes.  In that case, this
27109 function should set up some kind of sentinel to beep the user loud and
27110 clear if the posting could not be completed.
27111
27112 There should be no result data from this function.
27113
27114 @end table
27115
27116
27117 @node Optional Back End Functions
27118 @subsubsection Optional Back End Functions
27119
27120 @table @code
27121
27122 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
27123
27124 @var{groups} is a list of groups, and this function should request data
27125 on all those groups.  How it does it is of no concern to Gnus, but it
27126 should attempt to do this in a speedy fashion.
27127
27128 The return value of this function can be either @code{active} or
27129 @code{group}, which says what the format of the result data is.  The
27130 former is in the same format as the data from
27131 @code{nnchoke-request-list}, while the latter is a buffer full of lines
27132 in the same format as @code{nnchoke-request-group} gives.
27133
27134 @example
27135 group-buffer = *active-line / *group-status
27136 @end example
27137
27138
27139 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
27140
27141 A Gnus group info (@pxref{Group Info}) is handed to the back end for
27142 alterations.  This comes in handy if the back end really carries all
27143 the information (as is the case with virtual and imap groups).  This
27144 function should destructively alter the info to suit its needs, and
27145 should return a non-@code{nil} value.
27146
27147 There should be no result data from this function.
27148
27149
27150 @item (nnchoke-request-type GROUP &optional ARTICLE)
27151
27152 When the user issues commands for ``sending news'' (@kbd{F} in the
27153 summary buffer, for instance), Gnus has to know whether the article the
27154 user is following up on is news or mail.  This function should return
27155 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
27156 is mail and @code{unknown} if the type can't be decided.  (The
27157 @var{article} parameter is necessary in @code{nnvirtual} groups which
27158 might very well combine mail groups and news groups.)  Both @var{group}
27159 and @var{article} may be @code{nil}.
27160
27161 There should be no result data from this function.
27162
27163
27164 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
27165
27166 Set/remove/add marks on articles.  Normally Gnus handles the article
27167 marks (such as read, ticked, expired etc) internally, and store them in
27168 @file{~/.newsrc.eld}.  Some back ends (such as @acronym{IMAP}) however carry
27169 all information about the articles on the server, so Gnus need to
27170 propagate the mark information to the server.
27171
27172 @var{action} is a list of mark setting requests, having this format:
27173
27174 @example
27175 (RANGE ACTION MARK)
27176 @end example
27177
27178 @var{range} is a range of articles you wish to update marks on.
27179 @var{action} is @code{add} or @code{del}, used to add marks or remove
27180 marks (preserving all marks not mentioned).  @var{mark} is a list of
27181 marks; where each mark is a symbol.  Currently used marks are
27182 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
27183 @code{dormant}, @code{save}, @code{download}, @code{unsend},
27184 @code{forward} and @code{recent}, but your back end should, if
27185 possible, not limit itself to these.
27186
27187 Given contradictory actions, the last action in the list should be the
27188 effective one.  That is, if your action contains a request to add the
27189 @code{tick} mark on article 1 and, later in the list, a request to
27190 remove the mark on the same article, the mark should in fact be removed.
27191
27192 An example action list:
27193
27194 @example
27195 (((5 12 30) 'del '(tick))
27196  ((10 . 90) 'add '(read expire))
27197  ((92 94) 'del '(read)))
27198 @end example
27199
27200 The function should return a range of articles it wasn't able to set the
27201 mark on (currently not used for anything).
27202
27203 There should be no result data from this function.
27204
27205 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
27206
27207 If the user tries to set a mark that the back end doesn't like, this
27208 function may change the mark.  Gnus will use whatever this function
27209 returns as the mark for @var{article} instead of the original
27210 @var{mark}.  If the back end doesn't care, it must return the original
27211 @var{mark}, and not @code{nil} or any other type of garbage.
27212
27213 The only use for this I can see is what @code{nnvirtual} does with
27214 it---if a component group is auto-expirable, marking an article as read
27215 in the virtual group should result in the article being marked as
27216 expirable.
27217
27218 There should be no result data from this function.
27219
27220
27221 @item (nnchoke-request-scan &optional GROUP SERVER)
27222
27223 This function may be called at any time (by Gnus or anything else) to
27224 request that the back end check for incoming articles, in one way or
27225 another.  A mail back end will typically read the spool file or query
27226 the @acronym{POP} server when this function is invoked.  The
27227 @var{group} doesn't have to be heeded---if the back end decides that
27228 it is too much work just scanning for a single group, it may do a
27229 total scan of all groups.  It would be nice, however, to keep things
27230 local if that's practical.
27231
27232 There should be no result data from this function.
27233
27234
27235 @item (nnchoke-request-group-description GROUP &optional SERVER)
27236
27237 The result data from this function should be a description of
27238 @var{group}.
27239
27240 @example
27241 description-line = name <TAB> description eol
27242 name             = <string>
27243 description      = <text>
27244 @end example
27245
27246 @item (nnchoke-request-list-newsgroups &optional SERVER)
27247
27248 The result data from this function should be the description of all
27249 groups available on the server.
27250
27251 @example
27252 description-buffer = *description-line
27253 @end example
27254
27255
27256 @item (nnchoke-request-newgroups DATE &optional SERVER)
27257
27258 The result data from this function should be all groups that were
27259 created after @samp{date}, which is in normal human-readable date format
27260 (i.e., the date format used in mail and news headers, and returned by
27261 the function @code{message-make-date} by default).  The data should be
27262 in the active buffer format.
27263
27264 It is okay for this function to return ``too many'' groups; some back ends
27265 might find it cheaper to return the full list of groups, rather than
27266 just the new groups.  But don't do this for back ends with many groups.
27267 Normally, if the user creates the groups herself, there won't be too
27268 many groups, so @code{nnml} and the like are probably safe.  But for
27269 back ends like @code{nntp}, where the groups have been created by the
27270 server, it is quite likely that there can be many groups.
27271
27272
27273 @item (nnchoke-request-create-group GROUP &optional SERVER)
27274
27275 This function should create an empty group with name @var{group}.
27276
27277 There should be no return data.
27278
27279
27280 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
27281
27282 This function should run the expiry process on all articles in the
27283 @var{articles} range (which is currently a simple list of article
27284 numbers.)  It is left up to the back end to decide how old articles
27285 should be before they are removed by this function.  If @var{force} is
27286 non-@code{nil}, all @var{articles} should be deleted, no matter how new
27287 they are.
27288
27289 This function should return a list of articles that it did not/was not
27290 able to delete.
27291
27292 There should be no result data returned.
27293
27294
27295 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
27296
27297 This function should move @var{article} (which is a number) from
27298 @var{group} by calling @var{accept-form}.
27299
27300 This function should ready the article in question for moving by
27301 removing any header lines it has added to the article, and generally
27302 should ``tidy up'' the article.  Then it should @code{eval}
27303 @var{accept-form} in the buffer where the ``tidy'' article is.  This
27304 will do the actual copying.  If this @code{eval} returns a
27305 non-@code{nil} value, the article should be removed.
27306
27307 If @var{last} is @code{nil}, that means that there is a high likelihood
27308 that there will be more requests issued shortly, so that allows some
27309 optimizations.
27310
27311 The function should return a cons where the @code{car} is the group name and
27312 the @code{cdr} is the article number that the article was entered as.
27313
27314 There should be no data returned.
27315
27316
27317 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
27318
27319 This function takes the current buffer and inserts it into @var{group}.
27320 If @var{last} in @code{nil}, that means that there will be more calls to
27321 this function in short order.
27322
27323 The function should return a cons where the @code{car} is the group name and
27324 the @code{cdr} is the article number that the article was entered as.
27325
27326 The group should exist before the back end is asked to accept the
27327 article for that group.
27328
27329 There should be no data returned.
27330
27331
27332 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
27333
27334 This function should remove @var{article} (which is a number) from
27335 @var{group} and insert @var{buffer} there instead.
27336
27337 There should be no data returned.
27338
27339
27340 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
27341
27342 This function should delete @var{group}.  If @var{force}, it should
27343 really delete all the articles in the group, and then delete the group
27344 itself.  (If there is such a thing as ``the group itself''.)
27345
27346 There should be no data returned.
27347
27348
27349 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
27350
27351 This function should rename @var{group} into @var{new-name}.  All
27352 articles in @var{group} should move to @var{new-name}.
27353
27354 There should be no data returned.
27355
27356 @end table
27357
27358
27359 @node Error Messaging
27360 @subsubsection Error Messaging
27361
27362 @findex nnheader-report
27363 @findex nnheader-get-report
27364 The back ends should use the function @code{nnheader-report} to report
27365 error conditions---they should not raise errors when they aren't able to
27366 perform a request.  The first argument to this function is the back end
27367 symbol, and the rest are interpreted as arguments to @code{format} if
27368 there are multiple of them, or just a string if there is one of them.
27369 This function must always returns @code{nil}.
27370
27371 @lisp
27372 (nnheader-report 'nnchoke "You did something totally bogus")
27373
27374 (nnheader-report 'nnchoke "Could not request group %s" group)
27375 @end lisp
27376
27377 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
27378 @code{nil} back from a server, and this function returns the most
27379 recently reported message for the back end in question.  This function
27380 takes one argument---the server symbol.
27381
27382 Internally, these functions access @var{back-end}@code{-status-string},
27383 so the @code{nnchoke} back end will have its error message stored in
27384 @code{nnchoke-status-string}.
27385
27386
27387 @node Writing New Back Ends
27388 @subsubsection Writing New Back Ends
27389
27390 Many back ends are quite similar.  @code{nnml} is just like
27391 @code{nnspool}, but it allows you to edit the articles on the server.
27392 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
27393 and it doesn't maintain overview databases.  @code{nndir} is just like
27394 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
27395 editing articles.
27396
27397 It would make sense if it were possible to ``inherit'' functions from
27398 back ends when writing new back ends.  And, indeed, you can do that if you
27399 want to.  (You don't have to if you don't want to, of course.)
27400
27401 All the back ends declare their public variables and functions by using a
27402 package called @code{nnoo}.
27403
27404 To inherit functions from other back ends (and allow other back ends to
27405 inherit functions from the current back end), you should use the
27406 following macros:
27407
27408 @table @code
27409
27410 @item nnoo-declare
27411 This macro declares the first parameter to be a child of the subsequent
27412 parameters.  For instance:
27413
27414 @lisp
27415 (nnoo-declare nndir
27416   nnml nnmh)
27417 @end lisp
27418
27419 @code{nndir} has declared here that it intends to inherit functions from
27420 both @code{nnml} and @code{nnmh}.
27421
27422 @item defvoo
27423 This macro is equivalent to @code{defvar}, but registers the variable as
27424 a public server variable.  Most state-oriented variables should be
27425 declared with @code{defvoo} instead of @code{defvar}.
27426
27427 In addition to the normal @code{defvar} parameters, it takes a list of
27428 variables in the parent back ends to map the variable to when executing
27429 a function in those back ends.
27430
27431 @lisp
27432 (defvoo nndir-directory nil
27433   "Where nndir will look for groups."
27434   nnml-current-directory nnmh-current-directory)
27435 @end lisp
27436
27437 This means that @code{nnml-current-directory} will be set to
27438 @code{nndir-directory} when an @code{nnml} function is called on behalf
27439 of @code{nndir}.  (The same with @code{nnmh}.)
27440
27441 @item nnoo-define-basics
27442 This macro defines some common functions that almost all back ends should
27443 have.
27444
27445 @lisp
27446 (nnoo-define-basics nndir)
27447 @end lisp
27448
27449 @item deffoo
27450 This macro is just like @code{defun} and takes the same parameters.  In
27451 addition to doing the normal @code{defun} things, it registers the
27452 function as being public so that other back ends can inherit it.
27453
27454 @item nnoo-map-functions
27455 This macro allows mapping of functions from the current back end to
27456 functions from the parent back ends.
27457
27458 @lisp
27459 (nnoo-map-functions nndir
27460   (nnml-retrieve-headers 0 nndir-current-group 0 0)
27461   (nnmh-request-article 0 nndir-current-group 0 0))
27462 @end lisp
27463
27464 This means that when @code{nndir-retrieve-headers} is called, the first,
27465 third, and fourth parameters will be passed on to
27466 @code{nnml-retrieve-headers}, while the second parameter is set to the
27467 value of @code{nndir-current-group}.
27468
27469 @item nnoo-import
27470 This macro allows importing functions from back ends.  It should be the
27471 last thing in the source file, since it will only define functions that
27472 haven't already been defined.
27473
27474 @lisp
27475 (nnoo-import nndir
27476   (nnmh
27477    nnmh-request-list
27478    nnmh-request-newgroups)
27479   (nnml))
27480 @end lisp
27481
27482 This means that calls to @code{nndir-request-list} should just be passed
27483 on to @code{nnmh-request-list}, while all public functions from
27484 @code{nnml} that haven't been defined in @code{nndir} yet should be
27485 defined now.
27486
27487 @end table
27488
27489 Below is a slightly shortened version of the @code{nndir} back end.
27490
27491 @lisp
27492 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
27493 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
27494
27495 ;;; @r{Code:}
27496
27497 (require 'nnheader)
27498 (require 'nnmh)
27499 (require 'nnml)
27500 (require 'nnoo)
27501 (eval-when-compile (require 'cl))
27502
27503 (nnoo-declare nndir
27504   nnml nnmh)
27505
27506 (defvoo nndir-directory nil
27507   "Where nndir will look for groups."
27508   nnml-current-directory nnmh-current-directory)
27509
27510 (defvoo nndir-nov-is-evil nil
27511   "*Non-nil means that nndir will never retrieve NOV headers."
27512   nnml-nov-is-evil)
27513
27514 (defvoo nndir-current-group ""
27515   nil
27516   nnml-current-group nnmh-current-group)
27517 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
27518 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
27519
27520 (defvoo nndir-status-string "" nil nnmh-status-string)
27521 (defconst nndir-version "nndir 1.0")
27522
27523 ;;; @r{Interface functions.}
27524
27525 (nnoo-define-basics nndir)
27526
27527 (deffoo nndir-open-server (server &optional defs)
27528   (setq nndir-directory
27529         (or (cadr (assq 'nndir-directory defs))
27530             server))
27531   (unless (assq 'nndir-directory defs)
27532     (push `(nndir-directory ,server) defs))
27533   (push `(nndir-current-group
27534           ,(file-name-nondirectory
27535             (directory-file-name nndir-directory)))
27536         defs)
27537   (push `(nndir-top-directory
27538           ,(file-name-directory (directory-file-name nndir-directory)))
27539         defs)
27540   (nnoo-change-server 'nndir server defs))
27541
27542 (nnoo-map-functions nndir
27543   (nnml-retrieve-headers 0 nndir-current-group 0 0)
27544   (nnmh-request-article 0 nndir-current-group 0 0)
27545   (nnmh-request-group nndir-current-group 0 0)
27546   (nnmh-close-group nndir-current-group 0))
27547
27548 (nnoo-import nndir
27549   (nnmh
27550    nnmh-status-message
27551    nnmh-request-list
27552    nnmh-request-newgroups))
27553
27554 (provide 'nndir)
27555 @end lisp
27556
27557
27558 @node Hooking New Back Ends Into Gnus
27559 @subsubsection Hooking New Back Ends Into Gnus
27560
27561 @vindex gnus-valid-select-methods
27562 @findex gnus-declare-backend
27563 Having Gnus start using your new back end is rather easy---you just
27564 declare it with the @code{gnus-declare-backend} functions.  This will
27565 enter the back end into the @code{gnus-valid-select-methods} variable.
27566
27567 @code{gnus-declare-backend} takes two parameters---the back end name and
27568 an arbitrary number of @dfn{abilities}.
27569
27570 Here's an example:
27571
27572 @lisp
27573 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
27574 @end lisp
27575
27576 The above line would then go in the @file{nnchoke.el} file.
27577
27578 The abilities can be:
27579
27580 @table @code
27581 @item mail
27582 This is a mailish back end---followups should (probably) go via mail.
27583 @item post
27584 This is a newsish back end---followups should (probably) go via news.
27585 @item post-mail
27586 This back end supports both mail and news.
27587 @item none
27588 This is neither a post nor mail back end---it's something completely
27589 different.
27590 @item respool
27591 It supports respooling---or rather, it is able to modify its source
27592 articles and groups.
27593 @item address
27594 The name of the server should be in the virtual server name.  This is
27595 true for almost all back ends.
27596 @item prompt-address
27597 The user should be prompted for an address when doing commands like
27598 @kbd{B} in the group buffer.  This is true for back ends like
27599 @code{nntp}, but not @code{nnmbox}, for instance.
27600 @end table
27601
27602
27603 @node Mail-like Back Ends
27604 @subsubsection Mail-like Back Ends
27605
27606 One of the things that separate the mail back ends from the rest of the
27607 back ends is the heavy dependence by most of the mail back ends on
27608 common functions in @file{nnmail.el}.  For instance, here's the
27609 definition of @code{nnml-request-scan}:
27610
27611 @lisp
27612 (deffoo nnml-request-scan (&optional group server)
27613   (setq nnml-article-file-alist nil)
27614   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
27615 @end lisp
27616
27617 It simply calls @code{nnmail-get-new-mail} with a few parameters,
27618 and @code{nnmail} takes care of all the moving and splitting of the
27619 mail.
27620
27621 This function takes four parameters.
27622
27623 @table @var
27624 @item method
27625 This should be a symbol to designate which back end is responsible for
27626 the call.
27627
27628 @item exit-function
27629 This function should be called after the splitting has been performed.
27630
27631 @item temp-directory
27632 Where the temporary files should be stored.
27633
27634 @item group
27635 This optional argument should be a group name if the splitting is to be
27636 performed for one group only.
27637 @end table
27638
27639 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
27640 save each article.  @var{back-end}@code{-active-number} will be called to
27641 find the article number assigned to this article.
27642
27643 The function also uses the following variables:
27644 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
27645 this back end); and @var{back-end}@code{-group-alist} and
27646 @var{back-end}@code{-active-file} to generate the new active file.
27647 @var{back-end}@code{-group-alist} should be a group-active alist, like
27648 this:
27649
27650 @example
27651 (("a-group" (1 . 10))
27652  ("some-group" (34 . 39)))
27653 @end example
27654
27655
27656 @node Score File Syntax
27657 @subsection Score File Syntax
27658
27659 Score files are meant to be easily parseable, but yet extremely
27660 mallable.  It was decided that something that had the same read syntax
27661 as an Emacs Lisp list would fit that spec.
27662
27663 Here's a typical score file:
27664
27665 @lisp
27666 (("summary"
27667   ("win95" -10000 nil s)
27668   ("Gnus"))
27669  ("from"
27670   ("Lars" -1000))
27671  (mark -100))
27672 @end lisp
27673
27674 BNF definition of a score file:
27675
27676 @example
27677 score-file      = "" / "(" *element ")"
27678 element         = rule / atom
27679 rule            = string-rule / number-rule / date-rule
27680 string-rule     = "(" quote string-header quote space *string-match ")"
27681 number-rule     = "(" quote number-header quote space *number-match ")"
27682 date-rule       = "(" quote date-header quote space *date-match ")"
27683 quote           = <ascii 34>
27684 string-header   = "subject" / "from" / "references" / "message-id" /
27685                   "xref" / "body" / "head" / "all" / "followup"
27686 number-header   = "lines" / "chars"
27687 date-header     = "date"
27688 string-match    = "(" quote <string> quote [ "" / [ space score [ "" /
27689                   space date [ "" / [ space string-match-t ] ] ] ] ] ")"
27690 score           = "nil" / <integer>
27691 date            = "nil" / <natural number>
27692 string-match-t  = "nil" / "s" / "substring" / "S" / "Substring" /
27693                   "r" / "regex" / "R" / "Regex" /
27694                   "e" / "exact" / "E" / "Exact" /
27695                   "f" / "fuzzy" / "F" / "Fuzzy"
27696 number-match    = "(" <integer> [ "" / [ space score [ "" /
27697                   space date [ "" / [ space number-match-t ] ] ] ] ] ")"
27698 number-match-t  = "nil" / "=" / "<" / ">" / ">=" / "<="
27699 date-match      = "(" quote <string> quote [ "" / [ space score [ "" /
27700                   space date [ "" / [ space date-match-t ] ] ] ] ")"
27701 date-match-t    = "nil" / "at" / "before" / "after"
27702 atom            = "(" [ required-atom / optional-atom ] ")"
27703 required-atom   = mark / expunge / mark-and-expunge / files /
27704                   exclude-files / read-only / touched
27705 optional-atom   = adapt / local / eval
27706 mark            = "mark" space nil-or-number
27707 nil-or-number   = "nil" / <integer>
27708 expunge         = "expunge" space nil-or-number
27709 mark-and-expunge = "mark-and-expunge" space nil-or-number
27710 files           = "files" *[ space <string> ]
27711 exclude-files   = "exclude-files" *[ space <string> ]
27712 read-only       = "read-only" [ space "nil" / space "t" ]
27713 adapt        = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
27714 adapt-rule      = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
27715 local           = "local" *[ space "(" <string> space <form> ")" ]
27716 eval            = "eval" space <form>
27717 space           = *[ " " / <TAB> / <NEWLINE> ]
27718 @end example
27719
27720 Any unrecognized elements in a score file should be ignored, but not
27721 discarded.
27722
27723 As you can see, white space is needed, but the type and amount of white
27724 space is irrelevant.  This means that formatting of the score file is
27725 left up to the programmer---if it's simpler to just spew it all out on
27726 one looong line, then that's ok.
27727
27728 The meaning of the various atoms are explained elsewhere in this
27729 manual (@pxref{Score File Format}).
27730
27731
27732 @node Headers
27733 @subsection Headers
27734
27735 Internally Gnus uses a format for storing article headers that
27736 corresponds to the @acronym{NOV} format in a mysterious fashion.  One could
27737 almost suspect that the author looked at the @acronym{NOV} specification and
27738 just shamelessly @emph{stole} the entire thing, and one would be right.
27739
27740 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
27741 RFC 1036 to talk about lines in the head of an article (e.g.,
27742 @code{From}).  It is used by many people as a synonym for
27743 ``head''---``the header and the body''.  (That should be avoided, in my
27744 opinion.)  And Gnus uses a format internally that it calls ``header'',
27745 which is what I'm talking about here.  This is a 9-element vector,
27746 basically, with each header (ouch) having one slot.
27747
27748 These slots are, in order: @code{number}, @code{subject}, @code{from},
27749 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
27750 @code{xref}, and @code{extra}.  There are macros for accessing and
27751 setting these slots---they all have predictable names beginning with
27752 @code{mail-header-} and @code{mail-header-set-}, respectively.
27753
27754 All these slots contain strings, except the @code{extra} slot, which
27755 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
27756
27757
27758 @node Ranges
27759 @subsection Ranges
27760
27761 @sc{gnus} introduced a concept that I found so useful that I've started
27762 using it a lot and have elaborated on it greatly.
27763
27764 The question is simple: If you have a large amount of objects that are
27765 identified by numbers (say, articles, to take a @emph{wild} example)
27766 that you want to qualify as being ``included'', a normal sequence isn't
27767 very useful.  (A 200,000 length sequence is a bit long-winded.)
27768
27769 The solution is as simple as the question: You just collapse the
27770 sequence.
27771
27772 @example
27773 (1 2 3 4 5 6 10 11 12)
27774 @end example
27775
27776 is transformed into
27777
27778 @example
27779 ((1 . 6) (10 . 12))
27780 @end example
27781
27782 To avoid having those nasty @samp{(13 . 13)} elements to denote a
27783 lonesome object, a @samp{13} is a valid element:
27784
27785 @example
27786 ((1 . 6) 7 (10 . 12))
27787 @end example
27788
27789 This means that comparing two ranges to find out whether they are equal
27790 is slightly tricky:
27791
27792 @example
27793 ((1 . 5) 7 8 (10 . 12))
27794 @end example
27795
27796 and
27797
27798 @example
27799 ((1 . 5) (7 . 8) (10 . 12))
27800 @end example
27801
27802 are equal.  In fact, any non-descending list is a range:
27803
27804 @example
27805 (1 2 3 4 5)
27806 @end example
27807
27808 is a perfectly valid range, although a pretty long-winded one.  This is
27809 also valid:
27810
27811 @example
27812 (1 . 5)
27813 @end example
27814
27815 and is equal to the previous range.
27816
27817 Here's a BNF definition of ranges.  Of course, one must remember the
27818 semantic requirement that the numbers are non-descending.  (Any number
27819 of repetition of the same number is allowed, but apt to disappear in
27820 range handling.)
27821
27822 @example
27823 range           = simple-range / normal-range
27824 simple-range    = "(" number " . " number ")"
27825 normal-range    = "(" start-contents ")"
27826 contents        = "" / simple-range *[ " " contents ] /
27827                   number *[ " " contents ]
27828 @end example
27829
27830 Gnus currently uses ranges to keep track of read articles and article
27831 marks.  I plan on implementing a number of range operators in C if The
27832 Powers That Be are willing to let me.  (I haven't asked yet, because I
27833 need to do some more thinking on what operators I need to make life
27834 totally range-based without ever having to convert back to normal
27835 sequences.)
27836
27837
27838 @node Group Info
27839 @subsection Group Info
27840
27841 Gnus stores all permanent info on groups in a @dfn{group info} list.
27842 This list is from three to six elements (or more) long and exhaustively
27843 describes the group.
27844
27845 Here are two example group infos; one is a very simple group while the
27846 second is a more complex one:
27847
27848 @example
27849 ("no.group" 5 ((1 . 54324)))
27850
27851 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
27852                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
27853                 (nnml "")
27854                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
27855 @end example
27856
27857 The first element is the @dfn{group name}---as Gnus knows the group,
27858 anyway.  The second element is the @dfn{subscription level}, which
27859 normally is a small integer.  (It can also be the @dfn{rank}, which is a
27860 cons cell where the @code{car} is the level and the @code{cdr} is the
27861 score.)  The third element is a list of ranges of read articles.  The
27862 fourth element is a list of lists of article marks of various kinds.
27863 The fifth element is the select method (or virtual server, if you like).
27864 The sixth element is a list of @dfn{group parameters}, which is what
27865 this section is about.
27866
27867 Any of the last three elements may be missing if they are not required.
27868 In fact, the vast majority of groups will normally only have the first
27869 three elements, which saves quite a lot of cons cells.
27870
27871 Here's a BNF definition of the group info format:
27872
27873 @example
27874 info          = "(" group space ralevel space read
27875                 [ "" / [ space marks-list [ "" / [ space method [ "" /
27876                 space parameters ] ] ] ] ] ")"
27877 group         = quote <string> quote
27878 ralevel       = rank / level
27879 level         = <integer in the range of 1 to inf>
27880 rank          = "(" level "." score ")"
27881 score         = <integer in the range of 1 to inf>
27882 read          = range
27883 marks-lists   = nil / "(" *marks ")"
27884 marks         = "(" <string> range ")"
27885 method        = "(" <string> *elisp-forms ")"
27886 parameters    = "(" *elisp-forms ")"
27887 @end example
27888
27889 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
27890 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
27891 in pseudo-BNF.
27892
27893 If you have a Gnus info and want to access the elements, Gnus offers a
27894 series of macros for getting/setting these elements.
27895
27896 @table @code
27897 @item gnus-info-group
27898 @itemx gnus-info-set-group
27899 @findex gnus-info-group
27900 @findex gnus-info-set-group
27901 Get/set the group name.
27902
27903 @item gnus-info-rank
27904 @itemx gnus-info-set-rank
27905 @findex gnus-info-rank
27906 @findex gnus-info-set-rank
27907 Get/set the group rank (@pxref{Group Score}).
27908
27909 @item gnus-info-level
27910 @itemx gnus-info-set-level
27911 @findex gnus-info-level
27912 @findex gnus-info-set-level
27913 Get/set the group level.
27914
27915 @item gnus-info-score
27916 @itemx gnus-info-set-score
27917 @findex gnus-info-score
27918 @findex gnus-info-set-score
27919 Get/set the group score (@pxref{Group Score}).
27920
27921 @item gnus-info-read
27922 @itemx gnus-info-set-read
27923 @findex gnus-info-read
27924 @findex gnus-info-set-read
27925 Get/set the ranges of read articles.
27926
27927 @item gnus-info-marks
27928 @itemx gnus-info-set-marks
27929 @findex gnus-info-marks
27930 @findex gnus-info-set-marks
27931 Get/set the lists of ranges of marked articles.
27932
27933 @item gnus-info-method
27934 @itemx gnus-info-set-method
27935 @findex gnus-info-method
27936 @findex gnus-info-set-method
27937 Get/set the group select method.
27938
27939 @item gnus-info-params
27940 @itemx gnus-info-set-params
27941 @findex gnus-info-params
27942 @findex gnus-info-set-params
27943 Get/set the group parameters.
27944 @end table
27945
27946 All the getter functions take one parameter---the info list.  The setter
27947 functions take two parameters---the info list and the new value.
27948
27949 The last three elements in the group info aren't mandatory, so it may be
27950 necessary to extend the group info before setting the element.  If this
27951 is necessary, you can just pass on a non-@code{nil} third parameter to
27952 the three final setter functions to have this happen automatically.
27953
27954
27955 @node Extended Interactive
27956 @subsection Extended Interactive
27957 @cindex interactive
27958 @findex gnus-interactive
27959
27960 Gnus extends the standard Emacs @code{interactive} specification
27961 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
27962 Prefixes}).  Here's an example of how this is used:
27963
27964 @lisp
27965 (defun gnus-summary-increase-score (&optional score symp)
27966   (interactive (gnus-interactive "P\ny"))
27967   ...
27968   )
27969 @end lisp
27970
27971 The best thing to do would have been to implement
27972 @code{gnus-interactive} as a macro which would have returned an
27973 @code{interactive} form, but this isn't possible since Emacs checks
27974 whether a function is interactive or not by simply doing an @code{assq}
27975 on the lambda form.  So, instead we have @code{gnus-interactive}
27976 function that takes a string and returns values that are usable to
27977 @code{interactive}.
27978
27979 This function accepts (almost) all normal @code{interactive} specs, but
27980 adds a few more.
27981
27982 @table @samp
27983 @item y
27984 @vindex gnus-current-prefix-symbol
27985 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
27986 variable.
27987
27988 @item Y
27989 @vindex gnus-current-prefix-symbols
27990 A list of the current symbolic prefixes---the
27991 @code{gnus-current-prefix-symbol} variable.
27992
27993 @item A
27994 The current article number---the @code{gnus-summary-article-number}
27995 function.
27996
27997 @item H
27998 The current article header---the @code{gnus-summary-article-header}
27999 function.
28000
28001 @item g
28002 The current group name---the @code{gnus-group-group-name}
28003 function.
28004
28005 @end table
28006
28007
28008 @node Emacs/XEmacs Code
28009 @subsection Emacs/XEmacs Code
28010 @cindex XEmacs
28011 @cindex Emacsen
28012
28013 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
28014 platforms must be the primary one.  I chose Emacs.  Not because I don't
28015 like XEmacs or Mule, but because it comes first alphabetically.
28016
28017 This means that Gnus will byte-compile under Emacs with nary a warning,
28018 while XEmacs will pump out gigabytes of warnings while byte-compiling.
28019 As I use byte-compilation warnings to help me root out trivial errors in
28020 Gnus, that's very useful.
28021
28022 I've also consistently used Emacs function interfaces, but have used
28023 Gnusey aliases for the functions.  To take an example:  Emacs defines a
28024 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
28025 function.  I then define a function called @code{gnus-run-at-time} that
28026 takes the same parameters as the Emacs @code{run-at-time}.  When running
28027 Gnus under Emacs, the former function is just an alias for the latter.
28028 However, when running under XEmacs, the former is an alias for the
28029 following function:
28030
28031 @lisp
28032 (defun gnus-xmas-run-at-time (time repeat function &rest args)
28033   (start-itimer
28034    "gnus-run-at-time"
28035    `(lambda ()
28036       (,function ,@@args))
28037    time repeat))
28038 @end lisp
28039
28040 This sort of thing has been done for bunches of functions.  Gnus does
28041 not redefine any native Emacs functions while running under XEmacs---it
28042 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
28043 all over.
28044
28045 In the cases where the XEmacs function interface was obviously cleaner,
28046 I used it instead.  For example @code{gnus-region-active-p} is an alias
28047 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
28048
28049 Of course, I could have chosen XEmacs as my native platform and done
28050 mapping functions the other way around.  But I didn't.  The performance
28051 hit these indirections impose on Gnus under XEmacs should be slight.
28052
28053
28054 @node Various File Formats
28055 @subsection Various File Formats
28056
28057 @menu
28058 * Active File Format::          Information on articles and groups available.
28059 * Newsgroups File Format::      Group descriptions.
28060 @end menu
28061
28062
28063 @node Active File Format
28064 @subsubsection Active File Format
28065
28066 The active file lists all groups available on the server in
28067 question.  It also lists the highest and lowest current article numbers
28068 in each group.
28069
28070 Here's an excerpt from a typical active file:
28071
28072 @example
28073 soc.motss 296030 293865 y
28074 alt.binaries.pictures.fractals 3922 3913 n
28075 comp.sources.unix 1605 1593 m
28076 comp.binaries.ibm.pc 5097 5089 y
28077 no.general 1000 900 y
28078 @end example
28079
28080 Here's a pseudo-BNF definition of this file:
28081
28082 @example
28083 active      = *group-line
28084 group-line  = group spc high-number spc low-number spc flag <NEWLINE>
28085 group       = <non-white-space string>
28086 spc         = " "
28087 high-number = <non-negative integer>
28088 low-number  = <positive integer>
28089 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
28090 @end example
28091
28092 For a full description of this file, see the manual pages for
28093 @samp{innd}, in particular @samp{active(5)}.
28094
28095
28096 @node Newsgroups File Format
28097 @subsubsection Newsgroups File Format
28098
28099 The newsgroups file lists groups along with their descriptions.  Not all
28100 groups on the server have to be listed,  and not all groups in the file
28101 have to exist on the server.  The file is meant purely as information to
28102 the user.
28103
28104 The format is quite simple; a group name, a tab, and the description.
28105 Here's the definition:
28106
28107 @example
28108 newsgroups    = *line
28109 line          = group tab description <NEWLINE>
28110 group         = <non-white-space string>
28111 tab           = <TAB>
28112 description   = <string>
28113 @end example
28114
28115
28116 @page
28117 @node Emacs for Heathens
28118 @section Emacs for Heathens
28119
28120 Believe it or not, but some people who use Gnus haven't really used
28121 Emacs much before they embarked on their journey on the Gnus Love Boat.
28122 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
28123 region'', and ``set @code{gnus-flargblossen} to an alist where the key
28124 is a regexp that is used for matching on the group name'' are magical
28125 phrases with little or no meaning, then this appendix is for you.  If
28126 you are already familiar with Emacs, just ignore this and go fondle your
28127 cat instead.
28128
28129 @menu
28130 * Keystrokes::                  Entering text and executing commands.
28131 * Emacs Lisp::                  The built-in Emacs programming language.
28132 @end menu
28133
28134
28135 @node Keystrokes
28136 @subsection Keystrokes
28137
28138 @itemize @bullet
28139 @item
28140 Q: What is an experienced Emacs user?
28141
28142 @item
28143 A: A person who wishes that the terminal had pedals.
28144 @end itemize
28145
28146 Yes, when you use Emacs, you are apt to use the control key, the shift
28147 key and the meta key a lot.  This is very annoying to some people
28148 (notably @code{vi}le users), and the rest of us just love the hell out
28149 of it.  Just give up and submit.  Emacs really does stand for
28150 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
28151 may have heard from other disreputable sources (like the Emacs author).
28152
28153 The shift keys are normally located near your pinky fingers, and are
28154 normally used to get capital letters and stuff.  You probably use it all
28155 the time.  The control key is normally marked ``CTRL'' or something like
28156 that.  The meta key is, funnily enough, never marked as such on any
28157 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
28158 which is the meta key on this keyboard.  It's usually located somewhere
28159 to the left hand side of the keyboard, usually on the bottom row.
28160
28161 Now, us Emacs people don't say ``press the meta-control-m key'',
28162 because that's just too inconvenient.  We say ``press the @kbd{C-M-m}
28163 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
28164 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
28165 down the control key, and hold it down while you press @kbd{k}''.
28166 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
28167 the control key and then press @kbd{k}''.  Simple, ay?
28168
28169 This is somewhat complicated by the fact that not all keyboards have a
28170 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
28171 means ``press escape, release escape, press @kbd{k}''.  That's much more
28172 work than if you have a meta key, so if that's the case, I respectfully
28173 suggest you get a real keyboard with a meta key.  You can't live without
28174 it.
28175
28176
28177
28178 @node Emacs Lisp
28179 @subsection Emacs Lisp
28180
28181 Emacs is the King of Editors because it's really a Lisp interpreter.
28182 Each and every key you tap runs some Emacs Lisp code snippet, and since
28183 Emacs Lisp is an interpreted language, that means that you can configure
28184 any key to run any arbitrary code.  You just, like, do it.
28185
28186 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
28187 functions.  (These are byte-compiled for speed, but it's still
28188 interpreted.)  If you decide that you don't like the way Gnus does
28189 certain things, it's trivial to have it do something a different way.
28190 (Well, at least if you know how to write Lisp code.)  However, that's
28191 beyond the scope of this manual, so we are simply going to talk about
28192 some common constructs that you normally use in your @file{.emacs} file
28193 to customize Gnus.
28194
28195 If you want to set the variable @code{gnus-florgbnize} to four (4), you
28196 write the following:
28197
28198 @lisp
28199 (setq gnus-florgbnize 4)
28200 @end lisp
28201
28202 This function (really ``special form'') @code{setq} is the one that can
28203 set a variable to some value.  This is really all you need to know.  Now
28204 you can go and fill your @file{.emacs} file with lots of these to change
28205 how Gnus works.
28206
28207 If you have put that thing in your @file{.emacs} file, it will be read
28208 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
28209 start Emacs.  If you want to change the variable right away, simply say
28210 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
28211 previous ``form'', which is a simple @code{setq} statement here.
28212
28213 Go ahead---just try it, if you're located at your Emacs.  After you
28214 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
28215 is the return value of the form you @code{eval}ed.
28216
28217 Some pitfalls:
28218
28219 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
28220 that means:
28221
28222 @lisp
28223 (setq gnus-read-active-file 'some)
28224 @end lisp
28225
28226 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
28227 @samp{nntp.ifi.uio.no}'', that means:
28228
28229 @lisp
28230 (setq gnus-nntp-server "nntp.ifi.uio.no")
28231 @end lisp
28232
28233 So be careful not to mix up strings (the latter) with symbols (the
28234 former).  The manual is unambiguous, but it can be confusing.
28235
28236 @page
28237 @include gnus-faq.texi
28238
28239 @node Index
28240 @chapter Index
28241 @printindex cp
28242
28243 @node Key Index
28244 @chapter Key Index
28245 @printindex ky
28246
28247 @summarycontents
28248 @contents
28249 @bye
28250
28251 @iftex
28252 @iflatex
28253 \end{document}
28254 @end iflatex
28255 @end iftex
28256
28257 @c Local Variables:
28258 @c mode: texinfo
28259 @c coding: iso-8859-1
28260 @c End: