b31153e76d65f3be1bf6d0b6180dd27328a05127
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo
2
3 @setfilename gnus
4 @settitle T-gnus 6.15 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @dircategory Emacs
9 @direntry
10 * Gnus: (gnus).         The newsreader Gnus.
11 @end direntry
12 @iftex
13 @finalout
14 @end iftex
15 @setchapternewpage odd
16
17 @iftex
18 @iflatex
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
22 \usepackage{epsfig}
23 \usepackage{pixidx}
24 \input{gnusconfig.tex}
25
26 \ifx\pdfoutput\undefined
27 \else
28 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
29 \usepackage{thumbpdf}
30 \pdfcompresslevel=9
31 \fi
32
33 \makeindex
34 \begin{document}
35
36 \newcommand{\gnusversionname}{Oort Gnus v0.10}
37 \newcommand{\gnuschaptername}{}
38 \newcommand{\gnussectionname}{}
39
40 \newcommand{\gnusbackslash}{/}
41
42 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
43 \ifx\pdfoutput\undefined
44 \newcommand{\gnusuref}[1]{\gnustt{#1}}
45 \else
46 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
47 \fi
48 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
49 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
50
51 \newcommand{\gnuskindex}[1]{\index{#1}}
52 \newcommand{\gnusindex}[1]{\index{#1}}
53
54 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
55 \newcommand{\gnuscode}[1]{\gnustt{#1}}
56 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
57 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
58 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
59 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
60 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
61 \newcommand{\gnusdfn}[1]{\textit{#1}}
62 \newcommand{\gnusi}[1]{\textit{#1}}
63 \newcommand{\gnusstrong}[1]{\textbf{#1}}
64 \newcommand{\gnusemph}[1]{\textit{#1}}
65 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
66 \newcommand{\gnussc}[1]{\textsc{#1}}
67 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
68 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
69 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
70 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
71
72 \newcommand{\gnusbullet}{{${\bullet}$}}
73 \newcommand{\gnusdollar}{\$}
74 \newcommand{\gnusampersand}{\&}
75 \newcommand{\gnuspercent}{\%}
76 \newcommand{\gnushash}{\#}
77 \newcommand{\gnushat}{\symbol{"5E}}
78 \newcommand{\gnusunderline}{\symbol{"5F}}
79 \newcommand{\gnusnot}{$\neg$}
80 \newcommand{\gnustilde}{\symbol{"7E}}
81 \newcommand{\gnusless}{{$<$}}
82 \newcommand{\gnusgreater}{{$>$}}
83 \newcommand{\gnusbraceleft}{{$>$}}
84 \newcommand{\gnusbraceright}{{$>$}}
85
86 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
87 \newcommand{\gnusinteresting}{
88 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
89 }
90
91 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
92
93 \newcommand{\gnuspagechapter}[1]{
94 {\mbox{}}
95 }
96
97 \newdimen{\gnusdimen}
98 \gnusdimen 0pt
99
100 \newcommand{\gnuschapter}[2]{
101 \gnuscleardoublepage
102 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
103 \chapter{#2}
104 \renewcommand{\gnussectionname}{}
105 \renewcommand{\gnuschaptername}{#2}
106 \thispagestyle{empty}
107 \hspace*{-2cm}
108 \begin{picture}(500,500)(0,0)
109 \put(480,350){\makebox(0,0)[tr]{#1}}
110 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
111 \end{picture}
112 \clearpage
113 }
114
115 \newcommand{\gnusfigure}[3]{
116 \begin{figure}
117 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
118 #3
119 \end{picture}
120 \caption{#1}
121 \end{figure}
122 }
123
124 \newcommand{\gnusicon}[1]{
125 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
126 }
127
128 \newcommand{\gnuspicon}[1]{
129 \margindex{\epsfig{figure=#1,width=2cm}}
130 }
131
132 \newcommand{\gnusxface}[2]{
133 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
134 }
135
136 \newcommand{\gnussmiley}[2]{
137 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
138 }
139
140 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
141
142 \newcommand{\gnussection}[1]{
143 \renewcommand{\gnussectionname}{#1}
144 \section{#1}
145 }
146
147 \newenvironment{codelist}%
148 {\begin{list}{}{
149 }
150 }{\end{list}}
151
152 \newenvironment{kbdlist}%
153 {\begin{list}{}{
154 \labelwidth=0cm
155 }
156 }{\end{list}}
157
158 \newenvironment{dfnlist}%
159 {\begin{list}{}{
160 }
161 }{\end{list}}
162
163 \newenvironment{stronglist}%
164 {\begin{list}{}{
165 }
166 }{\end{list}}
167
168 \newenvironment{samplist}%
169 {\begin{list}{}{
170 }
171 }{\end{list}}
172
173 \newenvironment{varlist}%
174 {\begin{list}{}{
175 }
176 }{\end{list}}
177
178 \newenvironment{emphlist}%
179 {\begin{list}{}{
180 }
181 }{\end{list}}
182
183 \newlength\gnusheadtextwidth
184 \setlength{\gnusheadtextwidth}{\headtextwidth}
185 \addtolength{\gnusheadtextwidth}{1cm}
186
187 \newpagestyle{gnuspreamble}%
188 {
189 {
190 \ifodd\count0
191 {
192 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
193 }
194 \else
195 {
196 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
197 }
198 }
199 \fi
200 }
201 }
202 {
203 \ifodd\count0
204 \mbox{} \hfill
205 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
206 \else
207 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
208 \hfill \mbox{}
209 \fi
210 }
211
212 \newpagestyle{gnusindex}%
213 {
214 {
215 \ifodd\count0
216 {
217 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
218 }
219 \else
220 {
221 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
222 }
223 \fi
224 }
225 }
226 {
227 \ifodd\count0
228 \mbox{} \hfill
229 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
230 \else
231 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
232 \hfill \mbox{}
233 \fi
234 }
235
236 \newpagestyle{gnus}%
237 {
238 {
239 \ifodd\count0
240 {
241 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
242 }
243 \else
244 {
245 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
246 }
247 \fi
248 }
249 }
250 {
251 \ifodd\count0
252 \mbox{} \hfill
253 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
254 \else
255 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
256 \hfill \mbox{}
257 \fi
258 }
259
260 \pagenumbering{roman}
261 \pagestyle{gnuspreamble}
262
263 @end iflatex
264 @end iftex
265
266 @iftex
267 @iflatex
268 \begin{titlepage}
269 {
270
271 %\addtolength{\oddsidemargin}{-5cm}
272 %\addtolength{\evensidemargin}{-5cm}
273 \parindent=0cm
274 \addtolength{\textheight}{2cm}
275
276 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
277 \rule{15cm}{1mm}\\
278 \vfill
279 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
280 \vfill
281 \rule{15cm}{1mm}\\
282 \gnusauthor{by Lars Magne Ingebrigtsen}
283 \newpage
284 }
285
286 \mbox{}
287 \vfill
288
289 \thispagestyle{empty}
290
291 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
292 Free Software Foundation, Inc.
293
294
295 Permission is granted to copy, distribute and/or modify this document
296 under the terms of the GNU Free Documentation License, Version 1.1 or
297 any later version published by the Free Software Foundation; with no
298 Invariant Sections, with the Front-Cover texts being ``A GNU
299 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
300 license is included in the section entitled ``GNU Free Documentation
301 License'' in the Emacs manual.
302
303 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
304 this GNU Manual, like GNU software.  Copies published by the Free
305 Software Foundation raise funds for GNU development.''
306
307 This document is part of a collection distributed under the GNU Free
308 Documentation License.  If you want to distribute this document
309 separately from the collection, you can do so by adding a copy of the
310 license to the document, as described in section 6 of the license.
311 \newpage
312 \end{titlepage}
313 @end iflatex
314 @end iftex
315
316 @ifnottex
317
318 This file documents gnus, the GNU Emacs newsreader.
319
320 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
321         Free Software Foundation, Inc.
322
323 Permission is granted to copy, distribute and/or modify this document
324 under the terms of the GNU Free Documentation License, Version 1.1 or
325 any later version published by the Free Software Foundation; with the
326 Invariant Sections being none, with the Front-Cover texts being ``A GNU
327 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
328 license is included in the section entitled ``GNU Free Documentation
329 License'' in the Emacs manual.
330
331 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
332 this GNU Manual, like GNU software.  Copies published by the Free
333 Software Foundation raise funds for GNU development.''
334
335 This document is part of a collection distributed under the GNU Free
336 Documentation License.  If you want to distribute this document
337 separately from the collection, you can do so by adding a copy of the
338 license to the document, as described in section 6 of the license.
339 @end ifnottex
340
341 @tex
342
343 @titlepage
344 @title T-gnus 6.15 Manual
345
346 @author by Lars Magne Ingebrigtsen
347 @page
348
349 @vskip 0pt plus 1filll
350 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002
351         Free Software Foundation, Inc.
352
353 Permission is granted to copy, distribute and/or modify this document
354 under the terms of the GNU Free Documentation License, Version 1.1 or
355 any later version published by the Free Software Foundation; with no
356 Invariant Sections, with the Front-Cover texts being ``A GNU
357 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
358 license is included in the section entitled ``GNU Free Documentation
359 License'' in the Emacs manual.
360
361 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
362 this GNU Manual, like GNU software.  Copies published by the Free
363 Software Foundation raise funds for GNU development.''
364
365 This document is part of a collection distributed under the GNU Free
366 Documentation License.  If you want to distribute this document
367 separately from the collection, you can do so by adding a copy of the
368 license to the document, as described in section 6 of the license.
369
370 @end titlepage
371 @page
372
373 @end tex
374
375
376 @node Top
377 @top The gnus Newsreader
378
379 @ifinfo
380
381 You can read news (and mail) from within Emacs by using gnus.  The news
382 can be gotten by any nefarious means you can think of---@sc{nntp}, local
383 spool or your mbox file.  All at the same time, if you want to push your
384 luck.
385
386 T-gnus provides @sc{mime} features based on @sc{semi} API.  So T-gnus
387 supports your right to read strange messages including big images or
388 other various kinds of formats.  T-gnus also supports
389 internationalization/localization and multiscript features based on MULE
390 API.  So T-gnus does not discriminate various language communities.
391 Oh, if you are a Klingon, please wait Unicode Next Generation.
392
393 This manual corresponds to T-gnus 6.15.
394
395 @end ifinfo
396
397 @iftex
398
399 @iflatex
400 \tableofcontents
401 \gnuscleardoublepage
402 @end iflatex
403
404 Gnus is the advanced, self-documenting, customizable, extensible
405 unreal-time newsreader for GNU Emacs.
406
407 Oops.  That sounds oddly familiar, so let's start over again to avoid
408 being accused of plagiarism:
409
410 Gnus is a message-reading laboratory.  It will let you look at just
411 about anything as if it were a newsgroup.  You can read mail with it,
412 you can browse directories with it, you can @code{ftp} with it---you
413 can even read news with it!
414
415 Gnus tries to empower people who read news the same way Emacs empowers
416 people who edit text.  Gnus sets no limits to what the user should be
417 allowed to do.  Users are encouraged to extend gnus to make it behave
418 like they want it to behave.  A program should not control people;
419 people should be empowered to do what they want by using (or abusing)
420 the program.
421
422 @end iftex
423
424 @menu
425 * Starting Up::                 Finding news can be a pain.
426 * Group Buffer::                Selecting, subscribing and killing groups.
427 * Summary Buffer::              Reading, saving and posting articles.
428 * Article Buffer::              Displaying and handling articles.
429 * Composing Messages::          Information on sending mail and news.
430 * Select Methods::              Gnus reads all messages from various select methods.
431 * Scoring::                     Assigning values to articles.
432 * Various::                     General purpose settings.
433 * The End::                     Farewell and goodbye.
434 * Appendices::                  Terminology, Emacs intro, FAQ, History, Internals.
435 * Index::                       Variable, function and concept index.
436 * Key Index::                   Key Index.
437
438 Other related manuals
439
440 * Message:(message).            Composing messages.
441 * Emacs-MIME:(emacs-mime).      Composing messages; MIME-specific parts.
442 * Sieve:(sieve).                Managing Sieve scripts in Emacs.
443 * PGG:(pgg).                    PGP/MIME with Gnus.
444
445 @detailmenu
446  --- The Detailed Node Listing ---
447
448 Starting Gnus
449
450 * Finding the News::            Choosing a method for getting news.
451 * The First Time::              What does Gnus do the first time you start it?
452 * The Server is Down::          How can I read my mail then?
453 * Slave Gnusae::                You can have more than one Gnus active at a time.
454 * Fetching a Group::            Starting Gnus just to read a group.
455 * New Groups::                  What is Gnus supposed to do with new groups?
456 * Changing Servers::            You may want to move from one server to another.
457 * Startup Files::               Those pesky startup files---@file{.newsrc}.
458 * Auto Save::                   Recovering from a crash.
459 * The Active File::             Reading the active file over a slow line Takes Time.
460 * Startup Variables::           Other variables you might change.
461
462 New Groups
463
464 * Checking New Groups::         Determining what groups are new.
465 * Subscription Methods::        What Gnus should do with new groups.
466 * Filtering New Groups::        Making Gnus ignore certain new groups.
467
468 Group Buffer
469
470 * Group Buffer Format::         Information listed and how you can change it.
471 * Group Maneuvering::           Commands for moving in the group buffer.
472 * Selecting a Group::           Actually reading news.
473 * Subscription Commands::       Unsubscribing, killing, subscribing.
474 * Group Data::                  Changing the info for a group.
475 * Group Levels::                Levels? What are those, then?
476 * Group Score::                 A mechanism for finding out what groups you like.
477 * Marking Groups::              You can mark groups for later processing.
478 * Foreign Groups::              Creating and editing groups.
479 * Group Parameters::            Each group may have different parameters set.
480 * Listing Groups::              Gnus can list various subsets of the groups.
481 * Sorting Groups::              Re-arrange the group order.
482 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
483 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
484 * Exiting Gnus::                Stop reading news and get some work done.
485 * Group Topics::                A folding group mode divided into topics.
486 * Misc Group Stuff::            Other stuff that you can to do.
487
488 Group Buffer Format
489
490 * Group Line Specification::    Deciding how the group buffer is to look.
491 * Group Modeline Specification::  The group buffer modeline.
492 * Group Highlighting::          Having nice colors in the group buffer.
493
494 Group Topics
495
496 * Topic Commands::              Interactive E-Z commands.
497 * Topic Variables::             How to customize the topics the Lisp Way.
498 * Topic Sorting::               Sorting each topic individually.
499 * Topic Topology::              A map of the world.
500 * Topic Parameters::            Parameters that apply to all groups in a topic.
501
502 Misc Group Stuff
503
504 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
505 * Group Information::           Information and help on groups and Gnus.
506 * Group Timestamp::             Making Gnus keep track of when you last read a group.
507 * File Commands::               Reading and writing the Gnus files.
508 * Sieve Commands::              Managing Sieve scripts.
509
510 Summary Buffer
511
512 * Summary Buffer Format::       Deciding how the summary buffer is to look.
513 * Summary Maneuvering::         Moving around the summary buffer.
514 * Choosing Articles::           Reading articles.
515 * Paging the Article::          Scrolling the current article.
516 * Reply Followup and Post::     Posting articles.
517 * Delayed Articles::            Send articles at a later time.
518 * Marking Articles::            Marking articles as read, expirable, etc.
519 * Limiting::                    You can limit the summary buffer.
520 * Threading::                   How threads are made.
521 * Sorting the Summary Buffer::  How articles and threads are sorted.
522 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
523 * Article Caching::             You may store articles in a cache.
524 * Persistent Articles::         Making articles expiry-resistant.
525 * Article Backlog::             Having already read articles hang around.
526 * Saving Articles::             Ways of customizing article saving.
527 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
528 * Article Treatment::           The article buffer can be mangled at will.
529 * MIME Commands::               Doing MIMEy things with the articles.
530 * Charsets::                    Character set issues.
531 * Article Commands::            Doing various things with the article buffer.
532 * Summary Sorting::             Sorting the summary buffer in various ways.
533 * Finding the Parent::          No child support? Get the parent.
534 * Alternative Approaches::      Reading using non-default summaries.
535 * Tree Display::                A more visual display of threads.
536 * Mail Group Commands::         Some commands can only be used in mail groups.
537 * Various Summary Stuff::       What didn't fit anywhere else.
538 * Exiting the Summary Buffer::  Returning to the Group buffer,
539                                 or reselecting the current group.
540 * Crosspost Handling::          How crossposted articles are dealt with.
541 * Duplicate Suppression::       An alternative when crosspost handling fails.
542 * Security::                    Decrypt and Verify.
543 * Mailing List::                Mailing list minor mode.
544
545 Summary Buffer Format
546
547 * Summary Buffer Lines::        You can specify how summary lines should look.
548 * To From Newsgroups::          How to not display your own name.
549 * Summary Buffer Mode Line::    You can say how the mode line should look.
550 * Summary Highlighting::        Making the summary buffer all pretty and nice.
551
552 Choosing Articles
553
554 * Choosing Commands::           Commands for choosing articles.
555 * Choosing Variables::          Variables that influence these commands.
556
557 Reply, Followup and Post
558
559 * Summary Mail Commands::       Sending mail.
560 * Summary Post Commands::       Sending news.
561 * Summary Message Commands::    Other Message-related commands.
562 * Canceling and Superseding::   
563
564 Marking Articles
565
566 * Unread Articles::             Marks for unread articles.
567 * Read Articles::               Marks for read articles.
568 * Other Marks::                 Marks that do not affect readedness.
569 * Setting Marks::               
570 * Generic Marking Commands::    
571 * Setting Process Marks::       
572
573 Marking Articles
574
575 * Setting Marks::             How to set and remove marks.
576 * Generic Marking Commands::  How to customize the marking.
577 * Setting Process Marks::     How to mark articles for later processing.
578
579 Threading
580
581 * Customizing Threading::       Variables you can change to affect the threading.
582 * Thread Commands::             Thread based commands in the summary buffer.
583
584 Customizing Threading
585
586 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
587 * Filling In Threads::          Making the threads displayed look fuller.
588 * More Threading::              Even more variables for fiddling with threads.
589 * Low-Level Threading::         You thought it was over... but you were wrong!
590
591 Decoding Articles
592
593 * Uuencoded Articles::          Uudecode articles.
594 * Shell Archives::              Unshar articles.
595 * PostScript Files::            Split PostScript.
596 * Other Files::                 Plain save and binhex.
597 * Decoding Variables::          Variables for a happy decoding.
598 * Viewing Files::               You want to look at the result of the decoding?
599
600 Decoding Variables
601
602 * Rule Variables::              Variables that say how a file is to be viewed.
603 * Other Decode Variables::      Other decode variables.
604 * Uuencoding and Posting::      Variables for customizing uuencoding.
605
606 Article Treatment
607
608 * Article Highlighting::        You want to make the article look like fruit salad.
609 * Article Fontisizing::         Making emphasized text look nice.
610 * Article Hiding::              You also want to make certain info go away.
611 * Article Washing::             Lots of way-neat functions to make life better.
612 * Article Header::              Doing various header transformations.
613 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
614 * Article Date::                Grumble, UT!
615 * Article Display::             Display various stuff---X-Face, Picons, Smileys
616 * Article Signature::           What is a signature?
617 * Article Miscellania::         Various other stuff.
618
619 Alternative Approaches
620
621 * Pick and Read::               First mark articles and then read them.
622 * Binary Groups::               Auto-decode all articles.
623
624 Various Summary Stuff
625
626 * Summary Group Information::   Information oriented commands.
627 * Searching for Articles::      Multiple article commands.
628 * Summary Generation Commands::  
629 * Really Various Summary Commands::  Those pesky non-conformant commands.
630
631 Article Buffer
632
633 * Hiding Headers::              Deciding what headers should be displayed.
634 * Using MIME::                  Pushing articles through @sc{mime} before reading them.
635 * Customizing Articles::        Tailoring the look of the articles.
636 * Article Keymap::              Keystrokes available in the article buffer.
637 * Misc Article::                Other stuff.
638
639 Composing Messages
640
641 * Mail::                        Mailing and replying.
642 * Posting Server::              What server should you post and mail via?
643 * Mail and Post::               Mailing and posting at the same time.
644 * Archived Messages::           Where Gnus stores the messages you've sent.
645 * Posting Styles::              An easier way to specify who you are.
646 * Drafts::                      Postponing messages and rejected messages.
647 * Rejected Articles::           What happens if the server doesn't like your article?
648 * Signing and encrypting::      How to compose secure messages.
649
650 Select Methods
651
652 * Server Buffer::               Making and editing virtual servers.
653 * Getting News::                Reading USENET news with Gnus.
654 * Getting Mail::                Reading your personal mail with Gnus.
655 * Browsing the Web::            Getting messages from a plethora of Web sources.
656 * IMAP::                        Using Gnus as a @sc{imap} client.
657 * Other Sources::               Reading directories, files, SOUP packets.
658 * Combined Groups::             Combining groups into one group.
659 * Gnus Unplugged::              Reading news and mail offline.
660
661 Server Buffer
662
663 * Server Buffer Format::        You can customize the look of this buffer.
664 * Server Commands::             Commands to manipulate servers.
665 * Example Methods::             Examples server specifications.
666 * Creating a Virtual Server::   An example session.
667 * Server Variables::            Which variables to set.
668 * Servers and Methods::         You can use server names as select methods.
669 * Unavailable Servers::         Some servers you try to contact may be down.
670
671 Getting News
672
673 * NNTP::                        Reading news from an @sc{nntp} server.
674 * News Spool::                  Reading news from the local spool.
675
676 @sc{nntp}
677
678 * Direct Functions::            Connecting directly to the server.
679 * Indirect Functions::          Connecting indirectly to the server.
680 * Common Variables::            Understood by several connection functions.
681
682 Getting Mail
683
684 * Mail in a Newsreader::        Important introductory notes.
685 * Getting Started Reading Mail::  A simple cookbook example.
686 * Splitting Mail::              How to create mail groups.
687 * Mail Sources::                How to tell Gnus where to get mail from.
688 * Mail Back End Variables::     Variables for customizing mail handling.
689 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
690 * Group Mail Splitting::        Use group customize to drive mail splitting.
691 * Incorporating Old Mail::      What about the old mail you have?
692 * Expiring Mail::               Getting rid of unwanted mail.
693 * Washing Mail::                Removing gruft from the mail you get.
694 * Duplicates::                  Dealing with duplicated mail.
695 * Not Reading Mail::            Using mail back ends for reading other files.
696 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
697
698 Mail Sources
699
700 * Mail Source Specifiers::      How to specify what a mail source is.
701 * Mail Source Customization::   Some variables that influence things.
702 * Fetching Mail::               Using the mail source specifiers.
703
704 Choosing a Mail Back End
705
706 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
707 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
708 * Mail Spool::                  Store your mail in a private spool?
709 * MH Spool::                    An mhspool-like back end.
710 * Mail Folders::                Having one file for each group.
711 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
712
713 Browsing the Web
714
715 * Archiving Mail::              
716 * Web Searches::                Creating groups from articles that match a string.
717 * Slashdot::                    Reading the Slashdot comments.
718 * Ultimate::                    The Ultimate Bulletin Board systems.
719 * Web Archive::                 Reading mailing list archived on web.
720 * RSS::                         Reading RDF site summary.
721 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
722
723 @sc{imap}
724
725 * Splitting in IMAP::           Splitting mail with nnimap.
726 * Expiring in IMAP::            Expiring mail with nnimap.
727 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
728 * Expunging mailboxes::         Equivalent of a "compress mailbox" button.
729 * A note on namespaces::        How to (not) use IMAP namespace in Gnus.
730
731 Other Sources
732
733 * Directory Groups::            You can read a directory as if it was a newsgroup.
734 * Anything Groups::             Dired?  Who needs dired?
735 * Document Groups::             Single files can be the basis of a group.
736 * SOUP::                        Reading @sc{soup} packets ``offline''.
737 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
738
739 Document Groups
740
741 * Document Server Internals::   How to add your own document types.
742
743 SOUP
744
745 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
746 * SOUP Groups::                 A back end for reading @sc{soup} packets.
747 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
748
749 Combined Groups
750
751 * Virtual Groups::              Combining articles from many groups.
752 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
753
754 Gnus Unplugged
755
756 * Agent Basics::                How it all is supposed to work.
757 * Agent Categories::            How to tell the Gnus Agent what to download.
758 * Agent Commands::              New commands for all the buffers.
759 * Agent as Cache::              The Agent is a big cache too.
760 * Agent Expiry::                How to make old articles go away.
761 * Agent and IMAP::              How to use the Agent with IMAP.
762 * Outgoing Messages::           What happens when you post/mail something?
763 * Agent Variables::             Customizing is fun.
764 * Example Setup::               An example @file{.gnus.el} file for offline people.
765 * Batching Agents::             How to fetch news from a @code{cron} job.
766 * Agent Caveats::               What you think it'll do and what it does.
767
768 Agent Categories
769
770 * Category Syntax::             What a category looks like.
771 * Category Buffer::             A buffer for maintaining categories.
772 * Category Variables::          Customize'r'Us.
773
774 Agent Commands
775
776 * Group Agent Commands::        
777 * Summary Agent Commands::      
778 * Server Agent Commands::       
779
780 Scoring
781
782 * Summary Score Commands::      Adding score entries for the current group.
783 * Group Score Commands::        General score commands.
784 * Score Variables::             Customize your scoring.  (My, what terminology).
785 * Score File Format::           What a score file may contain.
786 * Score File Editing::          You can edit score files by hand as well.
787 * Adaptive Scoring::            Big Sister Gnus knows what you read.
788 * Home Score File::             How to say where new score entries are to go.
789 * Followups To Yourself::       Having Gnus notice when people answer you.
790 * Scoring On Other Headers::    Scoring on non-standard headers.
791 * Scoring Tips::                How to score effectively.
792 * Reverse Scoring::             That problem child of old is not problem.
793 * Global Score Files::          Earth-spanning, ear-splitting score files.
794 * Kill Files::                  They are still here, but they can be ignored.
795 * Converting Kill Files::       Translating kill files to score files.
796 * GroupLens::                   Getting predictions on what you like to read.
797 * Advanced Scoring::            Using logical expressions to build score rules.
798 * Score Decays::                It can be useful to let scores wither away.
799
800 GroupLens
801
802 * Using GroupLens::             How to make Gnus use GroupLens.
803 * Rating Articles::             Letting GroupLens know how you rate articles.
804 * Displaying Predictions::      Displaying predictions given by GroupLens.
805 * GroupLens Variables::         Customizing GroupLens.
806
807 Advanced Scoring
808
809 * Advanced Scoring Syntax::     A definition.
810 * Advanced Scoring Examples::   What they look like.
811 * Advanced Scoring Tips::       Getting the most out of it.
812
813 Various
814
815 * Process/Prefix::              A convention used by many treatment commands.
816 * Interactive::                 Making Gnus ask you many questions.
817 * Symbolic Prefixes::           How to supply some Gnus functions with options.
818 * Formatting Variables::        You can specify what buffers should look like.
819 * Window Layout::               Configuring the Gnus buffer windows.
820 * Faces and Fonts::             How to change how faces look.
821 * Compilation::                 How to speed Gnus up.
822 * Mode Lines::                  Displaying information in the mode lines.
823 * Highlighting and Menus::      Making buffers look all nice and cozy.
824 * Buttons::                     Get tendinitis in ten easy steps!
825 * Daemons::                     Gnus can do things behind your back.
826 * NoCeM::                       How to avoid spam and other fatty foods.
827 * Undo::                        Some actions can be undone.
828 * Predicate Specifiers::        Specifying predicates.
829 * Moderation::                  What to do if you're a moderator.
830 * Image Enhancements::          Modern versions of Emacs/XEmacs can display images.
831 * Fuzzy Matching::              What's the big fuzz?
832 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
833 * Various Various::             Things that are really various.
834
835 Formatting Variables
836
837 * Formatting Basics::           A formatting variable is basically a format string.
838 * Mode Line Formatting::        Some rules about mode line formatting variables.
839 * Advanced Formatting::         Modifying output in various ways.
840 * User-Defined Specs::          Having Gnus call your own functions.
841 * Formatting Fonts::            Making the formatting look colorful and nice.
842 * Positioning Point::           Moving point to a position after an operation.
843 * Tabulation::                  Tabulating your output.
844 * Wide Characters::             Dealing with wide characters.
845
846 Image Enhancements
847
848 * Picons::                      How to display pictures of what you're reading.
849 * Smileys::                     Show all those happy faces the way they were meant to be shown.
850 * X-Face::                      Display a funky, teensy black-and-white image.
851 * Toolbar::                     Click'n'drool.
852 * XVarious::                    Other XEmacsy Gnusey variables.
853
854 Picons
855
856 * Picon Basics::                What are picons and How do I get them.
857 * Picon Requirements::          Don't go further if you aren't using XEmacs.
858 * Easy Picons::                 Displaying Picons---the easy way.
859 * Hard Picons::                 The way you should do it.  You'll learn something.
860 * Picon Useless Configuration::  Other variables you can trash/tweak/munge/play with.
861
862 Thwarting Email Spam
863
864 * The problem of spam::         Some background, and some solutions
865 * Anti-Spam Basics::            Simple steps to reduce the amount of spam.
866 * SpamAssassin::                How to use external anti-spam tools.
867 * Hashcash::                    Reduce spam by burning CPU time.
868 * Filtering Spam Using spam.el::  
869 * Filtering Spam Using Statistics (spam-stat.el)::  
870
871 Appendices
872
873 * XEmacs::                      Requirements for installing under XEmacs.
874 * History::                     How Gnus got where it is today.
875 * On Writing Manuals::          Why this is not a beginner's guide.
876 * Terminology::                 We use really difficult, like, words here.
877 * Customization::               Tailoring Gnus to your needs.
878 * Troubleshooting::             What you might try if things do not work.
879 * Gnus Reference Guide::        Rilly, rilly technical stuff.
880 * Emacs for Heathens::          A short introduction to Emacsian terms.
881 * Frequently Asked Questions::
882
883 History
884
885 * Gnus Versions::               What Gnus versions have been released.
886 * Other Gnus Versions::         Other Gnus versions that also have been released.
887 * Why?::                        What's the point of Gnus?
888 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
889 * Conformity::                  Gnus tries to conform to all standards.
890 * Emacsen::                     Gnus can be run on a few modern Emacsen.
891 * Gnus Development::            How Gnus is developed.
892 * Contributors::                Oodles of people.
893 * New Features::                Pointers to some of the new stuff in Gnus.
894
895 New Features
896
897 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
898 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
899 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
900 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
901 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
902
903 Customization
904
905 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
906 * Slow Terminal Connection::    You run a remote Emacs.
907 * Little Disk Space::           You feel that having large setup files is icky.
908 * Slow Machine::                You feel like buying a faster machine.
909
910 Gnus Reference Guide
911
912 * Gnus Utility Functions::      Common functions and variable to use.
913 * Back End Interface::          How Gnus communicates with the servers.
914 * Score File Syntax::           A BNF definition of the score file standard.
915 * Headers::                     How Gnus stores headers internally.
916 * Ranges::                      A handy format for storing mucho numbers.
917 * Group Info::                  The group info format.
918 * Extended Interactive::        Symbolic prefixes and stuff.
919 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
920 * Various File Formats::        Formats of files that Gnus use.
921
922 Back End Interface
923
924 * Required Back End Functions::  Functions that must be implemented.
925 * Optional Back End Functions::  Functions that need not be implemented.
926 * Error Messaging::             How to get messages and report errors.
927 * Writing New Back Ends::       Extending old back ends.
928 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
929 * Mail-like Back Ends::         Some tips on mail back ends.
930
931 Various File Formats
932
933 * Active File Format::          Information on articles and groups available.
934 * Newsgroups File Format::      Group descriptions.
935
936 Emacs for Heathens
937
938 * Keystrokes::                  Entering text and executing commands.
939 * Emacs Lisp::                  The built-in Emacs programming language.
940
941 @end detailmenu
942 @end menu
943
944 @node Starting Up
945 @chapter Starting gnus
946 @cindex starting up
947
948 @kindex M-x gnus
949 @findex gnus
950 If your system administrator has set things up properly, starting gnus
951 and reading news is extremely easy---you just type @kbd{M-x gnus} in
952 your Emacs.
953
954 @findex gnus-other-frame
955 @kindex M-x gnus-other-frame
956 If you want to start gnus in a different frame, you can use the command
957 @kbd{M-x gnus-other-frame} instead.
958
959 If things do not go smoothly at startup, you have to twiddle some
960 variables in your @file{~/.gnus} file.  This file is similar to
961 @file{~/.emacs}, but is read when gnus starts.
962
963 If you puzzle at any terms used in this manual, please refer to the
964 terminology section (@pxref{Terminology}).
965
966 @menu
967 * Finding the News::            Choosing a method for getting news.
968 * The First Time::              What does Gnus do the first time you start it?
969 * The Server is Down::          How can I read my mail then?
970 * Slave Gnusae::                You can have more than one Gnus active at a time.
971 * Fetching a Group::            Starting Gnus just to read a group.
972 * New Groups::                  What is Gnus supposed to do with new groups?
973 * Changing Servers::            You may want to move from one server to another.
974 * Startup Files::               Those pesky startup files---@file{.newsrc}.
975 * Auto Save::                   Recovering from a crash.
976 * The Active File::             Reading the active file over a slow line Takes Time.
977 * Startup Variables::           Other variables you might change.
978 @end menu
979
980
981 @node Finding the News
982 @section Finding the News
983 @cindex finding news
984
985 @vindex gnus-select-method
986 @c @head
987 The @code{gnus-select-method} variable says where gnus should look for
988 news.  This variable should be a list where the first element says
989 @dfn{how} and the second element says @dfn{where}.  This method is your
990 native method.  All groups not fetched with this method are
991 foreign groups.
992
993 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
994 you want to get your daily dosage of news from, you'd say:
995
996 @lisp
997 (setq gnus-select-method '(nntp "news.somewhere.edu"))
998 @end lisp
999
1000 If you want to read directly from the local spool, say:
1001
1002 @lisp
1003 (setq gnus-select-method '(nnspool ""))
1004 @end lisp
1005
1006 If you can use a local spool, you probably should, as it will almost
1007 certainly be much faster.  But do not use the local spool if your
1008 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
1009
1010 @vindex gnus-nntpserver-file
1011 @cindex NNTPSERVER
1012 @cindex @sc{nntp} server
1013 If this variable is not set, gnus will take a look at the
1014 @code{NNTPSERVER} environment variable.  If that variable isn't set,
1015 gnus will see whether @code{gnus-nntpserver-file}
1016 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
1017 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
1018
1019 @vindex gnus-nntp-server
1020 If @code{gnus-nntp-server} is set, this variable will override
1021 @code{gnus-select-method}.  You should therefore set
1022 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1023
1024 @vindex gnus-secondary-servers
1025 @vindex gnus-nntp-server
1026 You can also make gnus prompt you interactively for the name of an
1027 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
1028 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1029 in the @code{gnus-secondary-servers} list (if any).  You can also just
1030 type in the name of any server you feel like visiting.  (Note that this
1031 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1032 gnus} later in the same Emacs session, Gnus will contact the same
1033 server.)
1034
1035 @findex gnus-group-browse-foreign-server
1036 @kindex B (Group)
1037 However, if you use one @sc{nntp} server regularly and are just
1038 interested in a couple of groups from a different server, you would be
1039 better served by using the @kbd{B} command in the group buffer.  It will
1040 let you have a look at what groups are available, and you can subscribe
1041 to any of the groups you want to.  This also makes @file{.newsrc}
1042 maintenance much tidier.  @xref{Foreign Groups}.
1043
1044 @vindex gnus-secondary-select-methods
1045 @c @head
1046 A slightly different approach to foreign groups is to set the
1047 @code{gnus-secondary-select-methods} variable.  The select methods
1048 listed in this variable are in many ways just as native as the
1049 @code{gnus-select-method} server.  They will also be queried for active
1050 files during startup (if that's required), and new newsgroups that
1051 appear on these servers will be subscribed (or not) just as native
1052 groups are.
1053
1054 For instance, if you use the @code{nnmbox} back end to read your mail,
1055 you would typically set this variable to
1056
1057 @lisp
1058 (setq gnus-secondary-select-methods '((nnmbox "")))
1059 @end lisp
1060
1061
1062 @node The First Time
1063 @section The First Time
1064 @cindex first time usage
1065
1066 If no startup files exist, gnus will try to determine what groups should
1067 be subscribed by default.
1068
1069 @vindex gnus-default-subscribed-newsgroups
1070 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1071 will subscribe you to just those groups in that list, leaving the rest
1072 killed.  Your system administrator should have set this variable to
1073 something useful.
1074
1075 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1076 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
1077 here as @dfn{whatever Lars thinks you should read}.)
1078
1079 You'll also be subscribed to the gnus documentation group, which should
1080 help you with most common problems.
1081
1082 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1083 use the normal functions for handling new groups, and not do anything
1084 special.
1085
1086
1087 @node The Server is Down
1088 @section The Server is Down
1089 @cindex server errors
1090
1091 If the default server is down, gnus will understandably have some
1092 problems starting.  However, if you have some mail groups in addition to
1093 the news groups, you may want to start gnus anyway.
1094
1095 Gnus, being the trusting sort of program, will ask whether to proceed
1096 without a native select method if that server can't be contacted.  This
1097 will happen whether the server doesn't actually exist (i.e., you have
1098 given the wrong address) or the server has just momentarily taken ill
1099 for some reason or other.  If you decide to continue and have no foreign
1100 groups, you'll find it difficult to actually do anything in the group
1101 buffer.  But, hey, that's your problem.  Blllrph!
1102
1103 @findex gnus-no-server
1104 @kindex M-x gnus-no-server
1105 @c @head
1106 If you know that the server is definitely down, or you just want to read
1107 your mail without bothering with the server at all, you can use the
1108 @code{gnus-no-server} command to start gnus.  That might come in handy
1109 if you're in a hurry as well.  This command will not attempt to contact
1110 your primary server---instead, it will just activate all groups on level
1111 1 and 2.  (You should preferably keep no native groups on those two
1112 levels.) Also @pxref{Group Levels}.
1113
1114
1115 @node Slave Gnusae
1116 @section Slave Gnusae
1117 @cindex slave
1118
1119 You might want to run more than one Emacs with more than one gnus at the
1120 same time.  If you are using different @file{.newsrc} files (e.g., if you
1121 are using the two different gnusae to read from two different servers),
1122 that is no problem whatsoever.  You just do it.
1123
1124 The problem appears when you want to run two Gnusae that use the same
1125 @code{.newsrc} file.
1126
1127 To work around that problem some, we here at the Think-Tank at the gnus
1128 Towers have come up with a new concept: @dfn{Masters} and
1129 @dfn{slaves}.  (We have applied for a patent on this concept, and have
1130 taken out a copyright on those words.  If you wish to use those words in
1131 conjunction with each other, you have to send $1 per usage instance to
1132 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
1133 Applications}) will be much more expensive, of course.)
1134
1135 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1136 however you do it).  Each subsequent slave gnusae should be started with
1137 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
1138 files, but instead save @dfn{slave files} that contain information only
1139 on what groups have been read in the slave session.  When a master gnus
1140 starts, it will read (and delete) these slave files, incorporating all
1141 information from them.  (The slave files will be read in the sequence
1142 they were created, so the latest changes will have precedence.)
1143
1144 Information from the slave files has, of course, precedence over the
1145 information in the normal (i.e., master) @code{.newsrc} file.
1146
1147 If the @code{.newsrc*} files have not been saved in the master when the
1148 slave starts, you may be prompted as to whether to read an auto-save
1149 file.  If you answer "yes", the unsaved changes to the master will be
1150 incorporated into the slave.  If you answer "no", the slave may see some
1151 messages as unread that have been read in the master.
1152
1153 @node Fetching a Group
1154 @section Fetching a Group
1155 @cindex fetching a group
1156
1157 @findex gnus-fetch-group
1158 It is sometimes convenient to be able to just say ``I want to read this
1159 group and I don't care whether gnus has been started or not''.  This is
1160 perhaps more useful for people who write code than for users, but the
1161 command @code{gnus-fetch-group} provides this functionality in any case.
1162 It takes the group name as a parameter.
1163
1164
1165 @node New Groups
1166 @section New Groups
1167 @cindex new groups
1168 @cindex subscription
1169
1170 @vindex gnus-check-new-newsgroups
1171 If you are satisfied that you really never want to see any new groups,
1172 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
1173 also save you some time at startup.  Even if this variable is
1174 @code{nil}, you can always subscribe to the new groups just by pressing
1175 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
1176 is @code{ask-server} by default.  If you set this variable to
1177 @code{always}, then Gnus will query the back ends for new groups even
1178 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1179
1180 @menu
1181 * Checking New Groups::         Determining what groups are new.
1182 * Subscription Methods::        What Gnus should do with new groups.
1183 * Filtering New Groups::        Making Gnus ignore certain new groups.
1184 @end menu
1185
1186
1187 @node Checking New Groups
1188 @subsection Checking New Groups
1189
1190 Gnus normally determines whether a group is new or not by comparing the
1191 list of groups from the active file(s) with the lists of subscribed and
1192 dead groups.  This isn't a particularly fast method.  If
1193 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1194 server for new groups since the last time.  This is both faster and
1195 cheaper.  This also means that you can get rid of the list of killed
1196 groups altogether, so you may set @code{gnus-save-killed-list} to
1197 @code{nil}, which will save time both at startup, at exit, and all over.
1198 Saves disk space, too.  Why isn't this the default, then?
1199 Unfortunately, not all servers support this command.
1200
1201 I bet I know what you're thinking now: How do I find out whether my
1202 server supports @code{ask-server}?  No?  Good, because I don't have a
1203 fail-safe answer.  I would suggest just setting this variable to
1204 @code{ask-server} and see whether any new groups appear within the next
1205 few days.  If any do, then it works.  If none do, then it doesn't
1206 work.  I could write a function to make gnus guess whether the server
1207 supports @code{ask-server}, but it would just be a guess.  So I won't.
1208 You could @code{telnet} to the server and say @code{HELP} and see
1209 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
1210 it does, then it might work.  (But there are servers that lists
1211 @samp{NEWGROUPS} without supporting the function properly.)
1212
1213 This variable can also be a list of select methods.  If so, gnus will
1214 issue an @code{ask-server} command to each of the select methods, and
1215 subscribe them (or not) using the normal methods.  This might be handy
1216 if you are monitoring a few servers for new groups.  A side effect is
1217 that startup will take much longer, so you can meditate while waiting.
1218 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1219
1220
1221 @node Subscription Methods
1222 @subsection Subscription Methods
1223
1224 @vindex gnus-subscribe-newsgroup-method
1225 What gnus does when it encounters a new group is determined by the
1226 @code{gnus-subscribe-newsgroup-method} variable.
1227
1228 This variable should contain a function.  This function will be called
1229 with the name of the new group as the only parameter.
1230
1231 Some handy pre-fab functions are:
1232
1233 @table @code
1234
1235 @item gnus-subscribe-zombies
1236 @vindex gnus-subscribe-zombies
1237 Make all new groups zombies.  This is the default.  You can browse the
1238 zombies later (with @kbd{A z}) and either kill them all off properly
1239 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1240
1241 @item gnus-subscribe-randomly
1242 @vindex gnus-subscribe-randomly
1243 Subscribe all new groups in arbitrary order.  This really means that all
1244 new groups will be added at ``the top'' of the group buffer.
1245
1246 @item gnus-subscribe-alphabetically
1247 @vindex gnus-subscribe-alphabetically
1248 Subscribe all new groups in alphabetical order.
1249
1250 @item gnus-subscribe-hierarchically
1251 @vindex gnus-subscribe-hierarchically
1252 Subscribe all new groups hierarchically.  The difference between this
1253 function and @code{gnus-subscribe-alphabetically} is slight.
1254 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1255 alphabetical fashion, while this function will enter groups into its
1256 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
1257 @samp{comp} hierarchy, this function will not mess that configuration
1258 up.  Or something like that.
1259
1260 @item gnus-subscribe-interactively
1261 @vindex gnus-subscribe-interactively
1262 Subscribe new groups interactively.  This means that gnus will ask
1263 you about @strong{all} new groups.  The groups you choose to subscribe
1264 to will be subscribed hierarchically.
1265
1266 @item gnus-subscribe-killed
1267 @vindex gnus-subscribe-killed
1268 Kill all new groups.
1269
1270 @item gnus-subscribe-topics
1271 @vindex gnus-subscribe-topics
1272 Put the groups into the topic that has a matching @code{subscribe} topic
1273 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
1274 topic parameter that looks like
1275
1276 @example
1277 "nnslashdot"
1278 @end example
1279
1280 will mean that all groups that match that regex will be subscribed under
1281 that topic.
1282
1283 If no topics match the groups, the groups will be subscribed in the
1284 top-level topic.
1285
1286 @end table
1287
1288 @vindex gnus-subscribe-hierarchical-interactive
1289 A closely related variable is
1290 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
1291 mouthful.)  If this variable is non-@code{nil}, gnus will ask you in a
1292 hierarchical fashion whether to subscribe to new groups or not.  Gnus
1293 will ask you for each sub-hierarchy whether you want to descend the
1294 hierarchy or not.
1295
1296 One common mistake is to set the variable a few paragraphs above
1297 (@code{gnus-subscribe-newsgroup-method}) to
1298 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
1299 will not work.  This is ga-ga.  So don't do it.
1300
1301
1302 @node Filtering New Groups
1303 @subsection Filtering New Groups
1304
1305 A nice and portable way to control which new newsgroups should be
1306 subscribed (or ignored) is to put an @dfn{options} line at the start of
1307 the @file{.newsrc} file.  Here's an example:
1308
1309 @example
1310 options -n !alt.all !rec.all sci.all
1311 @end example
1312
1313 @vindex gnus-subscribe-options-newsgroup-method
1314 This line obviously belongs to a serious-minded intellectual scientific
1315 person (or she may just be plain old boring), because it says that all
1316 groups that have names beginning with @samp{alt} and @samp{rec} should
1317 be ignored, and all groups with names beginning with @samp{sci} should
1318 be subscribed.  Gnus will not use the normal subscription method for
1319 subscribing these groups.
1320 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
1321 variable defaults to @code{gnus-subscribe-alphabetically}.
1322
1323 @vindex gnus-options-not-subscribe
1324 @vindex gnus-options-subscribe
1325 If you don't want to mess with your @file{.newsrc} file, you can just
1326 set the two variables @code{gnus-options-subscribe} and
1327 @code{gnus-options-not-subscribe}.  These two variables do exactly the
1328 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
1329 and if the new group matches the former, it will be unconditionally
1330 subscribed, and if it matches the latter, it will be ignored.
1331
1332 @vindex gnus-auto-subscribed-groups
1333 Yet another variable that meddles here is
1334 @code{gnus-auto-subscribed-groups}.  It works exactly like
1335 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1336 thought it would be nice to have two of these.  This variable is more
1337 meant for setting some ground rules, while the other variable is used
1338 more for user fiddling.  By default this variable makes all new groups
1339 that come from mail back ends (@code{nnml}, @code{nnbabyl},
1340 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1341 subscribed.  If you don't like that, just set this variable to
1342 @code{nil}.
1343
1344 New groups that match this regexp are subscribed using
1345 @code{gnus-subscribe-options-newsgroup-method}.
1346
1347
1348 @node Changing Servers
1349 @section Changing Servers
1350 @cindex changing servers
1351
1352 Sometimes it is necessary to move from one @sc{nntp} server to another.
1353 This happens very rarely, but perhaps you change jobs, or one server is
1354 very flaky and you want to use another.
1355
1356 Changing the server is pretty easy, right?  You just change
1357 @code{gnus-select-method} to point to the new server?
1358
1359 @emph{Wrong!}
1360
1361 Article numbers are not (in any way) kept synchronized between different
1362 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1363 you have read is by keeping track of article numbers.  So when you
1364 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1365 worthless.
1366
1367 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1368 file from one server to another.  They all have one thing in
1369 common---they take a looong time to run.  You don't want to use these
1370 functions more than absolutely necessary.
1371
1372 @kindex M-x gnus-change-server
1373 @findex gnus-change-server
1374 If you have access to both servers, Gnus can request the headers for all
1375 the articles you have read and compare @code{Message-ID}s and map the
1376 article numbers of the read articles and article marks.  The @kbd{M-x
1377 gnus-change-server} command will do this for all your native groups.  It
1378 will prompt for the method you want to move to.
1379
1380 @kindex M-x gnus-group-move-group-to-server
1381 @findex gnus-group-move-group-to-server
1382 You can also move individual groups with the @kbd{M-x
1383 gnus-group-move-group-to-server} command.  This is useful if you want to
1384 move a (foreign) group from one server to another.
1385
1386 @kindex M-x gnus-group-clear-data-on-native-groups
1387 @findex gnus-group-clear-data-on-native-groups
1388 If you don't have access to both the old and new server, all your marks
1389 and read ranges have become worthless.  You can use the @kbd{M-x
1390 gnus-group-clear-data-on-native-groups} command to clear out all data
1391 that you have on your native groups.  Use with caution.
1392
1393 @kindex M-x gnus-group-clear-data
1394 @findex gnus-group-clear-data
1395 Clear the data from the current group only---nix out marks and the
1396 list of read articles (@code{gnus-group-clear-data}).
1397
1398 After changing servers, you @strong{must} move the cache hierarchy away,
1399 since the cached articles will have wrong article numbers, which will
1400 affect which articles Gnus thinks are read.
1401 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1402 to have it done automatically; for @code{gnus-group-clear-data}, you
1403 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1404 cache for all groups).
1405
1406
1407 @node Startup Files
1408 @section Startup Files
1409 @cindex startup files
1410 @cindex .newsrc
1411 @cindex .newsrc.el
1412 @cindex .newsrc.eld
1413
1414 Now, you all know about the @file{.newsrc} file.  All subscription
1415 information is traditionally stored in this file.
1416
1417 Things got a bit more complicated with @sc{gnus}.  In addition to
1418 keeping the @file{.newsrc} file updated, it also used a file called
1419 @file{.newsrc.el} for storing all the information that didn't fit into
1420 the @file{.newsrc} file.  (Actually, it also duplicated everything in
1421 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
1422 files was the most recently saved, which enabled people to swap between
1423 @sc{gnus} and other newsreaders.
1424
1425 That was kinda silly, so Gnus went one better: In addition to the
1426 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1427 @file{.newsrc.eld}.  It will read whichever of these files that are most
1428 recent, but it will never write a @file{.newsrc.el} file.  You should
1429 never delete the @file{.newsrc.eld} file---it contains much information
1430 not stored in the @file{.newsrc} file.
1431
1432 @vindex gnus-save-newsrc-file
1433 @vindex gnus-read-newsrc-file
1434 You can turn off writing the @file{.newsrc} file by setting
1435 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1436 the file and save some space, as well as exiting from gnus faster.
1437 However, this will make it impossible to use other newsreaders than
1438 gnus.  But hey, who would want to, right?  Similarly, setting
1439 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1440 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1441 convenient if you have a tendency to use Netscape once in a while.
1442
1443 @vindex gnus-save-killed-list
1444 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1445 will not save the list of killed groups to the startup file.  This will
1446 save both time (when starting and quitting) and space (on disk).  It
1447 will also mean that Gnus has no record of what groups are new or old,
1448 so the automatic new groups subscription methods become meaningless.
1449 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1450 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1451 Groups}).  This variable can also be a regular expression.  If that's
1452 the case, remove all groups that do not match this regexp before
1453 saving.  This can be useful in certain obscure situations that involve
1454 several servers where not all servers support @code{ask-server}.
1455
1456 @vindex gnus-startup-file
1457 The @code{gnus-startup-file} variable says where the startup files are.
1458 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1459 file being whatever that one is, with a @samp{.eld} appended.
1460
1461 @vindex gnus-save-newsrc-hook
1462 @vindex gnus-save-quick-newsrc-hook
1463 @vindex gnus-save-standard-newsrc-hook
1464 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1465 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1466 saving the @file{.newsrc.eld} file, and
1467 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1468 @file{.newsrc} file.  The latter two are commonly used to turn version
1469 control on or off.  Version control is on by default when saving the
1470 startup files.  If you want to turn backup creation off, say something like:
1471
1472 @lisp
1473 (defun turn-off-backup ()
1474   (set (make-local-variable 'backup-inhibited) t))
1475
1476 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1477 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1478 @end lisp
1479
1480 @vindex gnus-init-file
1481 When gnus starts, it will read the @code{gnus-site-init-file}
1482 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1483 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
1484 and can be used to avoid cluttering your @file{~/.emacs} and
1485 @file{site-init} files with gnus stuff.  Gnus will also check for files
1486 with the same names as these, but with @file{.elc} and @file{.el}
1487 suffixes.  In other words, if you have set @code{gnus-init-file} to
1488 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1489 and finally @file{~/.gnus} (in this order).
1490
1491
1492
1493 @node Auto Save
1494 @section Auto Save
1495 @cindex dribble file
1496 @cindex auto-save
1497
1498 Whenever you do something that changes the gnus data (reading articles,
1499 catching up, killing/subscribing groups), the change is added to a
1500 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
1501 Emacs way.  If your Emacs should crash before you have saved the
1502 @file{.newsrc} files, all changes you have made can be recovered from
1503 this file.
1504
1505 If gnus detects this file at startup, it will ask the user whether to
1506 read it.  The auto save file is deleted whenever the real startup file is
1507 saved.
1508
1509 @vindex gnus-use-dribble-file
1510 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1511 maintain a dribble buffer.  The default is @code{t}.
1512
1513 @vindex gnus-dribble-directory
1514 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
1515 this variable is @code{nil}, which it is by default, gnus will dribble
1516 into the directory where the @file{.newsrc} file is located.  (This is
1517 normally the user's home directory.)  The dribble file will get the same
1518 file permissions as the @code{.newsrc} file.
1519
1520 @vindex gnus-always-read-dribble-file
1521 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1522 read the dribble file on startup without querying the user.
1523
1524
1525 @node The Active File
1526 @section The Active File
1527 @cindex active file
1528 @cindex ignored groups
1529
1530 When gnus starts, or indeed whenever it tries to determine whether new
1531 articles have arrived, it reads the active file.  This is a very large
1532 file that lists all the active groups and articles on the server.
1533
1534 @vindex gnus-ignored-newsgroups
1535 Before examining the active file, gnus deletes all lines that match the
1536 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
1537 any groups with bogus names, but you can use this variable to make gnus
1538 ignore hierarchies you aren't ever interested in.  However, this is not
1539 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
1540 Groups} for an overview of other variables that can be used instead.
1541
1542 @c This variable is
1543 @c @code{nil} by default, and will slow down active file handling somewhat
1544 @c if you set it to anything else.
1545
1546 @vindex gnus-read-active-file
1547 @c @head
1548 The active file can be rather Huge, so if you have a slow network, you
1549 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1550 reading the active file.  This variable is @code{some} by default.
1551
1552 Gnus will try to make do by getting information just on the groups that
1553 you actually subscribe to.
1554
1555 Note that if you subscribe to lots and lots of groups, setting this
1556 variable to @code{nil} will probably make gnus slower, not faster.  At
1557 present, having this variable @code{nil} will slow gnus down
1558 considerably, unless you read news over a 2400 baud modem.
1559
1560 This variable can also have the value @code{some}.  Gnus will then
1561 attempt to read active info only on the subscribed groups.  On some
1562 servers this is quite fast (on sparkling, brand new INN servers that
1563 support the @code{LIST ACTIVE group} command), on others this isn't fast
1564 at all.  In any case, @code{some} should be faster than @code{nil}, and
1565 is certainly faster than @code{t} over slow lines.
1566
1567 Some news servers (old versions of Leafnode and old versions of INN, for
1568 instance) do not support the @code{LIST ACTIVE group}.  For these
1569 servers, @code{nil} is probably the most efficient value for this
1570 variable.
1571
1572 If this variable is @code{nil}, gnus will ask for group info in total
1573 lock-step, which isn't very fast.  If it is @code{some} and you use an
1574 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1575 read all the replies in one swoop.  This will normally result in better
1576 performance, but if the server does not support the aforementioned
1577 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1578
1579 If you think that starting up Gnus takes too long, try all the three
1580 different values for this variable and see what works best for you.
1581
1582 In any case, if you use @code{some} or @code{nil}, you should definitely
1583 kill all groups that you aren't interested in to speed things up.
1584
1585 Note that this variable also affects active file retrieval from
1586 secondary select methods.
1587
1588
1589 @node Startup Variables
1590 @section Startup Variables
1591
1592 @table @code
1593
1594 @item gnus-load-hook
1595 @vindex gnus-load-hook
1596 A hook run while gnus is being loaded.  Note that this hook will
1597 normally be run just once in each Emacs session, no matter how many
1598 times you start gnus.
1599
1600 @item gnus-before-startup-hook
1601 @vindex gnus-before-startup-hook
1602 A hook run after starting up gnus successfully.
1603
1604 @item gnus-startup-hook
1605 @vindex gnus-startup-hook
1606 A hook run as the very last thing after starting up gnus
1607
1608 @item gnus-started-hook
1609 @vindex gnus-started-hook
1610 A hook that is run as the very last thing after starting up gnus
1611 successfully.
1612
1613 @item gnus-setup-news-hook
1614 @vindex gnus-setup-news-hook
1615 A hook that is run after reading the @file{.newsrc} file(s), but before
1616 generating the group buffer.
1617
1618 @item gnus-check-bogus-newsgroups
1619 @vindex gnus-check-bogus-newsgroups
1620 If non-@code{nil}, gnus will check for and delete all bogus groups at
1621 startup.  A @dfn{bogus group} is a group that you have in your
1622 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1623 bogus groups can take quite a while, so to save time and resources it's
1624 best to leave this option off, and do the checking for bogus groups once
1625 in a while from the group buffer instead (@pxref{Group Maintenance}).
1626
1627 @item gnus-inhibit-startup-message
1628 @vindex gnus-inhibit-startup-message
1629 If non-@code{nil}, the startup message won't be displayed.  That way,
1630 your boss might not notice as easily that you are reading news instead
1631 of doing your job.  Note that this variable is used before
1632 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1633
1634 @item gnus-no-groups-message
1635 @vindex gnus-no-groups-message
1636 Message displayed by gnus when no groups are available.
1637
1638 @item gnus-play-startup-jingle
1639 @vindex gnus-play-startup-jingle
1640 If non-@code{nil}, play the gnus jingle at startup.
1641
1642 @item gnus-startup-jingle
1643 @vindex gnus-startup-jingle
1644 Jingle to be played if the above variable is non-@code{nil}.  The
1645 default is @samp{Tuxedomoon.Jingle4.au}.
1646
1647 @end table
1648
1649
1650 @node Group Buffer
1651 @chapter Group Buffer
1652 @cindex group buffer
1653
1654 @c Alex Schroeder suggests to rearrange this as follows:
1655 @c
1656 @c <kensanata> ok, just save it for reference.  I'll go to bed in a minute.
1657 @c   1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1658 @c   4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1659 @c   7. Group Score, 8. Group Buffer Format
1660 @c <kensanata> Group Levels should have more information on levels 5 to 9.  I
1661 @c   suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1662 @c <kensanata> First, "Gnus considers groups... (default 9)."
1663 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1664 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1665 @c <kensanata> Then expand the next paragraph or add some more to it.
1666 @c    This short one sentence explains levels 1 and 2, therefore I understand
1667 @c    that I should keep important news at 3 and boring news at 4.
1668 @c    Say so!  Then go on to explain why I should bother with levels 6 to 9.
1669 @c    Maybe keep those that you don't want to read temporarily at 6,
1670 @c    those that you never want to read at 8, those that offend your
1671 @c    human rights at 9...
1672
1673
1674 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1675 is the first buffer shown when gnus starts, and will never be killed as
1676 long as gnus is active.
1677
1678 @iftex
1679 @iflatex
1680 \gnusfigure{The Group Buffer}{320}{
1681 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1682 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1683 \put(120,38){\vector(1,2){10}}
1684 \put(40,60){\makebox(0,0)[r]{Mode line}}
1685 \put(40,58){\vector(1,0){30}}
1686 \put(200,28){\makebox(0,0)[t]{Native select method}}
1687 \put(200,26){\vector(-1,2){15}}
1688 }
1689 @end iflatex
1690 @end iftex
1691
1692 @menu
1693 * Group Buffer Format::         Information listed and how you can change it.
1694 * Group Maneuvering::           Commands for moving in the group buffer.
1695 * Selecting a Group::           Actually reading news.
1696 * Subscription Commands::       Unsubscribing, killing, subscribing.
1697 * Group Data::                  Changing the info for a group.
1698 * Group Levels::                Levels? What are those, then?
1699 * Group Score::                 A mechanism for finding out what groups you like.
1700 * Marking Groups::              You can mark groups for later processing.
1701 * Foreign Groups::              Creating and editing groups.
1702 * Group Parameters::            Each group may have different parameters set.
1703 * Listing Groups::              Gnus can list various subsets of the groups.
1704 * Sorting Groups::              Re-arrange the group order.
1705 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
1706 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
1707 * Exiting Gnus::                Stop reading news and get some work done.
1708 * Group Topics::                A folding group mode divided into topics.
1709 * Misc Group Stuff::            Other stuff that you can to do.
1710 @end menu
1711
1712
1713 @node Group Buffer Format
1714 @section Group Buffer Format
1715
1716 @menu
1717 * Group Line Specification::    Deciding how the group buffer is to look.
1718 * Group Modeline Specification::  The group buffer modeline.
1719 * Group Highlighting::          Having nice colors in the group buffer.
1720 @end menu
1721
1722
1723 @node Group Line Specification
1724 @subsection Group Line Specification
1725 @cindex group buffer format
1726
1727 The default format of the group buffer is nice and dull, but you can
1728 make it as exciting and ugly as you feel like.
1729
1730 Here's a couple of example group lines:
1731
1732 @example
1733      25: news.announce.newusers
1734  *    0: alt.fan.andrea-dworkin
1735 @end example
1736
1737 Quite simple, huh?
1738
1739 You can see that there are 25 unread articles in
1740 @samp{news.announce.newusers}.  There are no unread articles, but some
1741 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1742 asterisk at the beginning of the line?).
1743
1744 @vindex gnus-group-line-format
1745 You can change that format to whatever you want by fiddling with the
1746 @code{gnus-group-line-format} variable.  This variable works along the
1747 lines of a @code{format} specification, which is pretty much the same as
1748 a @code{printf} specifications, for those of you who use (feh!) C.
1749 @xref{Formatting Variables}.
1750
1751 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1752
1753 There should always be a colon on the line; the cursor always moves to
1754 the colon after performing an operation.  @xref{Positioning
1755 Point}. Nothing else is required---not even the group name.  All
1756 displayed text is just window dressing, and is never examined by Gnus.
1757 Gnus stores all real information it needs using text properties.
1758
1759 (Note that if you make a really strange, wonderful, spreadsheet-like
1760 layout, everybody will believe you are hard at work with the accounting
1761 instead of wasting time reading news.)
1762
1763 Here's a list of all available format characters:
1764
1765 @table @samp
1766
1767 @item M
1768 An asterisk if the group only has marked articles.
1769
1770 @item S
1771 Whether the group is subscribed.
1772
1773 @item L
1774 Level of subscribedness.
1775
1776 @item N
1777 Number of unread articles.
1778
1779 @item I
1780 Number of dormant articles.
1781
1782 @item T
1783 Number of ticked articles.
1784
1785 @item R
1786 Number of read articles.
1787
1788 @item t
1789 Estimated total number of articles.  (This is really @var{max-number}
1790 minus @var{min-number} plus 1.)
1791
1792 Gnus uses this estimation because the @sc{nntp} protocol provides
1793 efficient access to @var{max-number} and @var{min-number} but getting
1794 the true unread message count is not possible efficiently.  For
1795 hysterical raisins, even the mail back ends, where the true number of
1796 unread messages might be available efficiently, use the same limited
1797 interface.  To remove this restriction from Gnus means that the back
1798 end interface has to be changed, which is not an easy job.  If you
1799 want to work on this, please contact the Gnus mailing list.
1800
1801 @item y
1802 Number of unread, unticked, non-dormant articles.
1803
1804 @item i
1805 Number of ticked and dormant articles.
1806
1807 @item g
1808 Full group name.
1809
1810 @item G
1811 Group name.
1812
1813 @item C
1814 Group comment (@pxref{Group Parameters}) or group name if there is no
1815 comment element in the group parameters.
1816
1817 @item D
1818 Newsgroup description.
1819
1820 @item o
1821 @samp{m} if moderated.
1822
1823 @item O
1824 @samp{(m)} if moderated.
1825
1826 @item s
1827 Select method.
1828
1829 @item B
1830 If the summary buffer for the group is open or not.
1831
1832 @item n
1833 Select from where.
1834
1835 @item z
1836 A string that looks like @samp{<%s:%n>} if a foreign select method is
1837 used.
1838
1839 @item P
1840 Indentation based on the level of the topic (@pxref{Group Topics}).
1841
1842 @item c
1843 @vindex gnus-group-uncollapsed-levels
1844 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1845 variable says how many levels to leave at the end of the group name.
1846 The default is 1---this will mean that group names like
1847 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1848
1849 @item m
1850 @vindex gnus-new-mail-mark
1851 @cindex %
1852 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1853 the group lately.
1854
1855 @item p
1856 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1857
1858 @item d
1859 A string that says when you last read the group (@pxref{Group
1860 Timestamp}).
1861
1862 @item u
1863 User defined specifier.  The next character in the format string should
1864 be a letter.  Gnus will call the function
1865 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1866 following @samp{%u}.  The function will be passed a single dummy
1867 parameter as argument.  The function should return a string, which will
1868 be inserted into the buffer just like information from any other
1869 specifier.
1870 @end table
1871
1872 @cindex *
1873 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1874 if no info is available---for instance, if it is a non-activated foreign
1875 group, or a bogus native group.
1876
1877
1878 @node Group Modeline Specification
1879 @subsection Group Modeline Specification
1880 @cindex group modeline
1881
1882 @vindex gnus-group-mode-line-format
1883 The mode line can be changed by setting
1884 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1885 doesn't understand that many format specifiers:
1886
1887 @table @samp
1888 @item S
1889 The native news server.
1890 @item M
1891 The native select method.
1892 @end table
1893
1894
1895 @node Group Highlighting
1896 @subsection Group Highlighting
1897 @cindex highlighting
1898 @cindex group highlighting
1899
1900 @vindex gnus-group-highlight
1901 Highlighting in the group buffer is controlled by the
1902 @code{gnus-group-highlight} variable.  This is an alist with elements
1903 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1904 something non-@code{nil}, the @var{face} will be used on the line.
1905
1906 Here's an example value for this variable that might look nice if the
1907 background is dark:
1908
1909 @lisp
1910 (cond (window-system
1911        (setq custom-background-mode 'light)
1912        (defface my-group-face-1
1913          '((t (:foreground "Red" :bold t))) "First group face")
1914        (defface my-group-face-2
1915          '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1916        (defface my-group-face-3
1917          '((t (:foreground "Green4" :bold t))) "Third group face")
1918        (defface my-group-face-4
1919          '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1920        (defface my-group-face-5
1921          '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1922
1923 (setq gnus-group-highlight
1924       '(((> unread 200) . my-group-face-1)
1925         ((and (< level 3) (zerop unread)) . my-group-face-2)
1926         ((< level 3) . my-group-face-3)
1927         ((zerop unread) . my-group-face-4)
1928         (t . my-group-face-5)))
1929 @end lisp
1930
1931 Also @pxref{Faces and Fonts}.
1932
1933 Variables that are dynamically bound when the forms are evaluated
1934 include:
1935
1936 @table @code
1937 @item group
1938 The group name.
1939 @item unread
1940 The number of unread articles in the group.
1941 @item method
1942 The select method.
1943 @item mailp
1944 Whether the group is a mail group.
1945 @item level
1946 The level of the group.
1947 @item score
1948 The score of the group.
1949 @item ticked
1950 The number of ticked articles in the group.
1951 @item total
1952 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1953 MIN-NUMBER plus one.
1954 @item topic
1955 When using the topic minor mode, this variable is bound to the current
1956 topic being inserted.
1957 @end table
1958
1959 When the forms are @code{eval}ed, point is at the beginning of the line
1960 of the group in question, so you can use many of the normal gnus
1961 functions for snarfing info on the group.
1962
1963 @vindex gnus-group-update-hook
1964 @findex gnus-group-highlight-line
1965 @code{gnus-group-update-hook} is called when a group line is changed.
1966 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1967 calls @code{gnus-group-highlight-line} by default.
1968
1969
1970 @node Group Maneuvering
1971 @section Group Maneuvering
1972 @cindex group movement
1973
1974 All movement commands understand the numeric prefix and will behave as
1975 expected, hopefully.
1976
1977 @table @kbd
1978
1979 @item n
1980 @kindex n (Group)
1981 @findex gnus-group-next-unread-group
1982 Go to the next group that has unread articles
1983 (@code{gnus-group-next-unread-group}).
1984
1985 @item p
1986 @itemx DEL
1987 @kindex DEL (Group)
1988 @kindex p (Group)
1989 @findex gnus-group-prev-unread-group
1990 Go to the previous group that has unread articles
1991 (@code{gnus-group-prev-unread-group}).
1992
1993 @item N
1994 @kindex N (Group)
1995 @findex gnus-group-next-group
1996 Go to the next group (@code{gnus-group-next-group}).
1997
1998 @item P
1999 @kindex P (Group)
2000 @findex gnus-group-prev-group
2001 Go to the previous group (@code{gnus-group-prev-group}).
2002
2003 @item M-n
2004 @kindex M-n (Group)
2005 @findex gnus-group-next-unread-group-same-level
2006 Go to the next unread group on the same (or lower) level
2007 (@code{gnus-group-next-unread-group-same-level}).
2008
2009 @item M-p
2010 @kindex M-p (Group)
2011 @findex gnus-group-prev-unread-group-same-level
2012 Go to the previous unread group on the same (or lower) level
2013 (@code{gnus-group-prev-unread-group-same-level}).
2014 @end table
2015
2016 Three commands for jumping to groups:
2017
2018 @table @kbd
2019
2020 @item j
2021 @kindex j (Group)
2022 @findex gnus-group-jump-to-group
2023 Jump to a group (and make it visible if it isn't already)
2024 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
2025 like living groups.
2026
2027 @item ,
2028 @kindex , (Group)
2029 @findex gnus-group-best-unread-group
2030 Jump to the unread group with the lowest level
2031 (@code{gnus-group-best-unread-group}).
2032
2033 @item .
2034 @kindex . (Group)
2035 @findex gnus-group-first-unread-group
2036 Jump to the first group with unread articles
2037 (@code{gnus-group-first-unread-group}).
2038 @end table
2039
2040 @vindex gnus-group-goto-unread
2041 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2042 commands will move to the next group, not the next unread group.  Even
2043 the commands that say they move to the next unread group.  The default
2044 is @code{t}.
2045
2046
2047 @node Selecting a Group
2048 @section Selecting a Group
2049 @cindex group selection
2050
2051 @table @kbd
2052
2053 @item SPACE
2054 @kindex SPACE (Group)
2055 @findex gnus-group-read-group
2056 Select the current group, switch to the summary buffer and display the
2057 first unread article (@code{gnus-group-read-group}).  If there are no
2058 unread articles in the group, or if you give a non-numerical prefix to
2059 this command, gnus will offer to fetch all the old articles in this
2060 group from the server.  If you give a numerical prefix @var{N}, @var{N}
2061 determines the number of articles gnus will fetch.  If @var{N} is
2062 positive, gnus fetches the @var{N} newest articles, if @var{N} is
2063 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
2064
2065 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2066 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2067 - 4 2 SPC} fetches the 42 oldest ones.
2068
2069 When you are in the group (in the Summary buffer), you can type
2070 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2071 ones.
2072
2073 @item RET
2074 @kindex RET (Group)
2075 @findex gnus-group-select-group
2076 Select the current group and switch to the summary buffer
2077 (@code{gnus-group-select-group}).  Takes the same arguments as
2078 @code{gnus-group-read-group}---the only difference is that this command
2079 does not display the first unread article automatically upon group
2080 entry.
2081
2082 @item M-RET
2083 @kindex M-RET (Group)
2084 @findex gnus-group-quick-select-group
2085 This does the same as the command above, but tries to do it with the
2086 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
2087 scoring/killing will be performed, there will be no highlights and no
2088 expunging.  This might be useful if you're in a real hurry and have to
2089 enter some humongous group.  If you give a 0 prefix to this command
2090 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2091 which is useful if you want to toggle threading before generating the
2092 summary buffer (@pxref{Summary Generation Commands}).
2093
2094 @item M-SPACE
2095 @kindex M-SPACE (Group)
2096 @findex gnus-group-visible-select-group
2097 This is yet one more command that does the same as the @kbd{RET}
2098 command, but this one does it without expunging and hiding dormants
2099 (@code{gnus-group-visible-select-group}).
2100
2101 @item C-M-RET
2102 @kindex C-M-RET (Group)
2103 @findex gnus-group-select-group-ephemerally
2104 Finally, this command selects the current group ephemerally without
2105 doing any processing of its contents
2106 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
2107 turned off.  Everything you do in the group after selecting it in this
2108 manner will have no permanent effects.
2109
2110 @end table
2111
2112 @vindex gnus-large-newsgroup
2113 The @code{gnus-large-newsgroup} variable says what gnus should consider
2114 to be a big group.  This is 200 by default.  If the group has more
2115 (unread and/or ticked) articles than this, gnus will query the user
2116 before entering the group.  The user can then specify how many articles
2117 should be fetched from the server.  If the user specifies a negative
2118 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
2119 is positive, the @code{n} articles that have arrived most recently will
2120 be fetched.
2121
2122 @vindex gnus-select-group-hook
2123 @vindex gnus-auto-select-first
2124 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2125 automatically when entering a group with the @kbd{SPACE} command.
2126 Which article this is is controlled by the
2127 @code{gnus-auto-select-subject} variable.  Valid values for this
2128 variable is:
2129
2130 @table @code
2131
2132 @item unread
2133 Place point on the subject line of the first unread article.
2134
2135 @item first
2136 Place point on the subject line of the first article.
2137
2138 @item unseen
2139 Place point on the subject line of the first unseen article.
2140
2141 @item unseen-or-unread
2142 Place point on the subject line of the first unseen article, and if
2143 there is no such article, place point on the subject line of the first
2144 unread article.
2145
2146 @item best
2147 Place point on the subject line of the highest-scored unread article.
2148
2149 @end table
2150
2151 This variable can also be a function.  In that case, that function
2152 will be called to place point on a subject line.
2153
2154 If you want to prevent automatic selection in some group (say, in a
2155 binary group with Huge articles) you can set the
2156 @code{gnus-auto-select-first} variable to @code{nil} in
2157 @code{gnus-select-group-hook}, which is called when a group is
2158 selected.
2159
2160
2161 @node Subscription Commands
2162 @section Subscription Commands
2163 @cindex subscription
2164
2165 @table @kbd
2166
2167 @item S t
2168 @itemx u
2169 @kindex S t (Group)
2170 @kindex u (Group)
2171 @findex gnus-group-unsubscribe-current-group
2172 @c @icon{gnus-group-unsubscribe}
2173 Toggle subscription to the current group
2174 (@code{gnus-group-unsubscribe-current-group}).
2175
2176 @item S s
2177 @itemx U
2178 @kindex S s (Group)
2179 @kindex U (Group)
2180 @findex gnus-group-unsubscribe-group
2181 Prompt for a group to subscribe, and then subscribe it.  If it was
2182 subscribed already, unsubscribe it instead
2183 (@code{gnus-group-unsubscribe-group}).
2184
2185 @item S k
2186 @itemx C-k
2187 @kindex S k (Group)
2188 @kindex C-k (Group)
2189 @findex gnus-group-kill-group
2190 @c @icon{gnus-group-kill-group}
2191 Kill the current group (@code{gnus-group-kill-group}).
2192
2193 @item S y
2194 @itemx C-y
2195 @kindex S y (Group)
2196 @kindex C-y (Group)
2197 @findex gnus-group-yank-group
2198 Yank the last killed group (@code{gnus-group-yank-group}).
2199
2200 @item C-x C-t
2201 @kindex C-x C-t (Group)
2202 @findex gnus-group-transpose-groups
2203 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
2204 really a subscription command, but you can use it instead of a
2205 kill-and-yank sequence sometimes.
2206
2207 @item S w
2208 @itemx C-w
2209 @kindex S w (Group)
2210 @kindex C-w (Group)
2211 @findex gnus-group-kill-region
2212 Kill all groups in the region (@code{gnus-group-kill-region}).
2213
2214 @item S z
2215 @kindex S z (Group)
2216 @findex gnus-group-kill-all-zombies
2217 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2218
2219 @item S C-k
2220 @kindex S C-k (Group)
2221 @findex gnus-group-kill-level
2222 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2223 These groups can't be yanked back after killing, so this command should
2224 be used with some caution.  The only time where this command comes in
2225 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2226 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
2227 kill off all unsubscribed groups that do not have message numbers in the
2228 @file{.newsrc} file.
2229
2230 @end table
2231
2232 Also @pxref{Group Levels}.
2233
2234
2235 @node Group Data
2236 @section Group Data
2237
2238 @table @kbd
2239
2240 @item c
2241 @kindex c (Group)
2242 @findex gnus-group-catchup-current
2243 @vindex gnus-group-catchup-group-hook
2244 @c @icon{gnus-group-catchup-current}
2245 Mark all unticked articles in this group as read
2246 (@code{gnus-group-catchup-current}).
2247 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2248 the group buffer.
2249
2250 @item C
2251 @kindex C (Group)
2252 @findex gnus-group-catchup-current-all
2253 Mark all articles in this group, even the ticked ones, as read
2254 (@code{gnus-group-catchup-current-all}).
2255
2256 @item M-c
2257 @kindex M-c (Group)
2258 @findex gnus-group-clear-data
2259 Clear the data from the current group---nix out marks and the list of
2260 read articles (@code{gnus-group-clear-data}).
2261
2262 @item M-x gnus-group-clear-data-on-native-groups
2263 @kindex M-x gnus-group-clear-data-on-native-groups
2264 @findex gnus-group-clear-data-on-native-groups
2265 If you have switched from one @sc{nntp} server to another, all your marks
2266 and read ranges have become worthless.  You can use this command to
2267 clear out all data that you have on your native groups.  Use with
2268 caution.
2269
2270 @end table
2271
2272
2273 @node Group Levels
2274 @section Group Levels
2275 @cindex group level
2276 @cindex level
2277
2278 All groups have a level of @dfn{subscribedness}.  For instance, if a
2279 group is on level 2, it is more subscribed than a group on level 5.  You
2280 can ask gnus to just list groups on a given level or lower
2281 (@pxref{Listing Groups}), or to just check for new articles in groups on
2282 a given level or lower (@pxref{Scanning New Messages}).
2283
2284 Remember:  The higher the level of the group, the less important it is.
2285
2286 @table @kbd
2287
2288 @item S l
2289 @kindex S l (Group)
2290 @findex gnus-group-set-current-level
2291 Set the level of the current group.  If a numeric prefix is given, the
2292 next @var{n} groups will have their levels set.  The user will be
2293 prompted for a level.
2294 @end table
2295
2296 @vindex gnus-level-killed
2297 @vindex gnus-level-zombie
2298 @vindex gnus-level-unsubscribed
2299 @vindex gnus-level-subscribed
2300 Gnus considers groups from levels 1 to
2301 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2302 @code{gnus-level-subscribed} (exclusive) and
2303 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2304 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2305 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2306 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
2307 same, but zombie and killed groups have no information on what articles
2308 you have read, etc, stored.  This distinction between dead and living
2309 groups isn't done because it is nice or clever, it is done purely for
2310 reasons of efficiency.
2311
2312 It is recommended that you keep all your mail groups (if any) on quite
2313 low levels (e.g. 1 or 2).
2314
2315 Maybe the following description of the default behavior of Gnus helps to
2316 understand what these levels are all about.  By default, Gnus shows you
2317 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2318 empty subscribed groups and unsubscribed groups, too.  Type @kbd{l} to
2319 go back to showing nonempty subscribed groups again.  Thus, unsubscribed
2320 groups are hidden, in a way.
2321
2322 Zombie and killed groups are similar to unsubscribed groups in that they
2323 are hidden by default.  But they are different from subscribed and
2324 unsubscribed groups in that Gnus doesn't ask the news server for
2325 information (number of messages, number of unread messages) on zombie
2326 and killed groups.  Normally, you use @kbd{C-k} to kill the groups you
2327 aren't interested in.  If most groups are killed, Gnus is faster.
2328
2329 Why does Gnus distinguish between zombie and killed groups?  Well, when
2330 a new group arrives on the server, Gnus by default makes it a zombie
2331 group.  This means that you are normally not bothered with new groups,
2332 but you can type @kbd{A z} to get a list of all new groups.  Subscribe
2333 the ones you like and kill the ones you don't want.  (@kbd{A k} shows a
2334 list of killed groups.)
2335
2336 If you want to play with the level variables, you should show some care.
2337 Set them once, and don't touch them ever again.  Better yet, don't touch
2338 them at all unless you know exactly what you're doing.
2339
2340 @vindex gnus-level-default-unsubscribed
2341 @vindex gnus-level-default-subscribed
2342 Two closely related variables are @code{gnus-level-default-subscribed}
2343 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2344 which are the levels that new groups will be put on if they are
2345 (un)subscribed.  These two variables should, of course, be inside the
2346 relevant valid ranges.
2347
2348 @vindex gnus-keep-same-level
2349 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2350 will only move to groups of the same level (or lower).  In
2351 particular, going from the last article in one group to the next group
2352 will go to the next group of the same level (or lower).  This might be
2353 handy if you want to read the most important groups before you read the
2354 rest.
2355
2356 If this variable is @code{best}, Gnus will make the next newsgroup the
2357 one with the best level.
2358
2359 @vindex gnus-group-default-list-level
2360 All groups with a level less than or equal to
2361 @code{gnus-group-default-list-level} will be listed in the group buffer
2362 by default.
2363
2364 @vindex gnus-group-list-inactive-groups
2365 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2366 groups will be listed along with the unread groups.  This variable is
2367 @code{t} by default.  If it is @code{nil}, inactive groups won't be
2368 listed.
2369
2370 @vindex gnus-group-use-permanent-levels
2371 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2372 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2373 use this level as the ``work'' level.
2374
2375 @vindex gnus-activate-level
2376 Gnus will normally just activate (i. e., query the server about) groups
2377 on level @code{gnus-activate-level} or less.  If you don't want to
2378 activate unsubscribed groups, for instance, you might set this variable
2379 to 5.  The default is 6.
2380
2381
2382 @node Group Score
2383 @section Group Score
2384 @cindex group score
2385 @cindex group rank
2386 @cindex rank
2387
2388 You would normally keep important groups on high levels, but that scheme
2389 is somewhat restrictive.  Don't you wish you could have Gnus sort the
2390 group buffer according to how often you read groups, perhaps?  Within
2391 reason?
2392
2393 This is what @dfn{group score} is for.  You can have Gnus assign a score
2394 to each group through the mechanism described below.  You can then sort
2395 the group buffer based on this score.  Alternatively, you can sort on
2396 score and then level.  (Taken together, the level and the score is
2397 called the @dfn{rank} of the group.  A group that is on level 4 and has
2398 a score of 1 has a higher rank than a group on level 5 that has a score
2399 of 300.  (The level is the most significant part and the score is the
2400 least significant part.))
2401
2402 @findex gnus-summary-bubble-group
2403 If you want groups you read often to get higher scores than groups you
2404 read seldom you can add the @code{gnus-summary-bubble-group} function to
2405 the @code{gnus-summary-exit-hook} hook.  This will result (after
2406 sorting) in a bubbling sort of action.  If you want to see that in
2407 action after each summary exit, you can add
2408 @code{gnus-group-sort-groups-by-rank} or
2409 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2410 slow things down somewhat.
2411
2412
2413 @node Marking Groups
2414 @section Marking Groups
2415 @cindex marking groups
2416
2417 If you want to perform some command on several groups, and they appear
2418 subsequently in the group buffer, you would normally just give a
2419 numerical prefix to the command.  Most group commands will then do your
2420 bidding on those groups.
2421
2422 However, if the groups are not in sequential order, you can still
2423 perform a command on several groups.  You simply mark the groups first
2424 with the process mark and then execute the command.
2425
2426 @table @kbd
2427
2428 @item #
2429 @kindex # (Group)
2430 @itemx M m
2431 @kindex M m (Group)
2432 @findex gnus-group-mark-group
2433 Set the mark on the current group (@code{gnus-group-mark-group}).
2434
2435 @item M-#
2436 @kindex M-# (Group)
2437 @itemx M u
2438 @kindex M u (Group)
2439 @findex gnus-group-unmark-group
2440 Remove the mark from the current group
2441 (@code{gnus-group-unmark-group}).
2442
2443 @item M U
2444 @kindex M U (Group)
2445 @findex gnus-group-unmark-all-groups
2446 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2447
2448 @item M w
2449 @kindex M w (Group)
2450 @findex gnus-group-mark-region
2451 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2452
2453 @item M b
2454 @kindex M b (Group)
2455 @findex gnus-group-mark-buffer
2456 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2457
2458 @item M r
2459 @kindex M r (Group)
2460 @findex gnus-group-mark-regexp
2461 Mark all groups that match some regular expression
2462 (@code{gnus-group-mark-regexp}).
2463 @end table
2464
2465 Also @pxref{Process/Prefix}.
2466
2467 @findex gnus-group-universal-argument
2468 If you want to execute some command on all groups that have been marked
2469 with the process mark, you can use the @kbd{M-&}
2470 (@code{gnus-group-universal-argument}) command.  It will prompt you for
2471 the command to be executed.
2472
2473
2474 @node Foreign Groups
2475 @section Foreign Groups
2476 @cindex foreign groups
2477
2478 Below are some group mode commands for making and editing general foreign
2479 groups, as well as commands to ease the creation of a few
2480 special-purpose groups.  All these commands insert the newly created
2481 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2482 consulted.
2483
2484 @table @kbd
2485
2486 @item G m
2487 @kindex G m (Group)
2488 @findex gnus-group-make-group
2489 @cindex making groups
2490 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
2491 for a name, a method and possibly an @dfn{address}.  For an easier way
2492 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2493
2494 @item G r
2495 @kindex G r (Group)
2496 @findex gnus-group-rename-group
2497 @cindex renaming groups
2498 Rename the current group to something else
2499 (@code{gnus-group-rename-group}).  This is valid only on some
2500 groups---mail groups mostly.  This command might very well be quite slow
2501 on some back ends.
2502
2503 @item G c
2504 @kindex G c (Group)
2505 @cindex customizing
2506 @findex gnus-group-customize
2507 Customize the group parameters (@code{gnus-group-customize}).
2508
2509 @item G e
2510 @kindex G e (Group)
2511 @findex gnus-group-edit-group-method
2512 @cindex renaming groups
2513 Enter a buffer where you can edit the select method of the current
2514 group (@code{gnus-group-edit-group-method}).
2515
2516 @item G p
2517 @kindex G p (Group)
2518 @findex gnus-group-edit-group-parameters
2519 Enter a buffer where you can edit the group parameters
2520 (@code{gnus-group-edit-group-parameters}).
2521
2522 @item G E
2523 @kindex G E (Group)
2524 @findex gnus-group-edit-group
2525 Enter a buffer where you can edit the group info
2526 (@code{gnus-group-edit-group}).
2527
2528 @item G d
2529 @kindex G d (Group)
2530 @findex gnus-group-make-directory-group
2531 @cindex nndir
2532 Make a directory group (@pxref{Directory Groups}).  You will be prompted
2533 for a directory name (@code{gnus-group-make-directory-group}).
2534
2535 @item G h
2536 @kindex G h (Group)
2537 @cindex help group
2538 @findex gnus-group-make-help-group
2539 Make the gnus help group (@code{gnus-group-make-help-group}).
2540
2541 @item G a
2542 @kindex G a (Group)
2543 @cindex (ding) archive
2544 @cindex archive group
2545 @findex gnus-group-make-archive-group
2546 @vindex gnus-group-archive-directory
2547 @vindex gnus-group-recent-archive-directory
2548 Make a gnus archive group (@code{gnus-group-make-archive-group}).  By
2549 default a group pointing to the most recent articles will be created
2550 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2551 group will be created from @code{gnus-group-archive-directory}.
2552
2553 @item G k
2554 @kindex G k (Group)
2555 @findex gnus-group-make-kiboze-group
2556 @cindex nnkiboze
2557 Make a kiboze group.  You will be prompted for a name, for a regexp to
2558 match groups to be ``included'' in the kiboze group, and a series of
2559 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2560 @xref{Kibozed Groups}.
2561
2562 @item G D
2563 @kindex G D (Group)
2564 @findex gnus-group-enter-directory
2565 @cindex nneething
2566 Read an arbitrary directory as if it were a newsgroup with the
2567 @code{nneething} back end (@code{gnus-group-enter-directory}).
2568 @xref{Anything Groups}.
2569
2570 @item G f
2571 @kindex G f (Group)
2572 @findex gnus-group-make-doc-group
2573 @cindex ClariNet Briefs
2574 @cindex nndoc
2575 Make a group based on some file or other
2576 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
2577 command, you will be prompted for a file name and a file type.
2578 Currently supported types are @code{mbox}, @code{babyl},
2579 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2580 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2581 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2582 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}.  If
2583 you run this command without a prefix, Gnus will guess at the file
2584 type.  @xref{Document Groups}.
2585
2586 @item G u
2587 @kindex G u (Group)
2588 @vindex gnus-useful-groups
2589 @findex gnus-group-make-useful-group
2590 Create one of the groups mentioned in @code{gnus-useful-groups}
2591 (@code{gnus-group-make-useful-group}).
2592
2593 @item G w
2594 @kindex G w (Group)
2595 @findex gnus-group-make-web-group
2596 @cindex Google
2597 @cindex nnweb
2598 @cindex gmane
2599 Make an ephemeral group based on a web search
2600 (@code{gnus-group-make-web-group}).  If you give a prefix to this
2601 command, make a solid group instead.  You will be prompted for the
2602 search engine type and the search string.  Valid search engine types
2603 include @code{google}, @code{dejanews}, and @code{gmane}.
2604 @xref{Web Searches}.
2605
2606 If you use the @code{google} search engine, you can limit the search
2607 to a particular group by using a match string like
2608 @samp{shaving group:alt.sysadmin.recovery}.
2609
2610 @item G DEL
2611 @kindex G DEL (Group)
2612 @findex gnus-group-delete-group
2613 This function will delete the current group
2614 (@code{gnus-group-delete-group}).  If given a prefix, this function will
2615 actually delete all the articles in the group, and forcibly remove the
2616 group itself from the face of the Earth.  Use a prefix only if you are
2617 absolutely sure of what you are doing.  This command can't be used on
2618 read-only groups (like @code{nntp} group), though.
2619
2620 @item G V
2621 @kindex G V (Group)
2622 @findex gnus-group-make-empty-virtual
2623 Make a new, fresh, empty @code{nnvirtual} group
2624 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
2625
2626 @item G v
2627 @kindex G v (Group)
2628 @findex gnus-group-add-to-virtual
2629 Add the current group to an @code{nnvirtual} group
2630 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2631 @end table
2632
2633 @xref{Select Methods}, for more information on the various select
2634 methods.
2635
2636 @vindex gnus-activate-foreign-newsgroups
2637 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2638 gnus will check all foreign groups with this level or lower at startup.
2639 This might take quite a while, especially if you subscribe to lots of
2640 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
2641 @code{gnus-activate-level} also affects activation of foreign
2642 newsgroups.
2643
2644
2645 @node Group Parameters
2646 @section Group Parameters
2647 @cindex group parameters
2648
2649 The group parameters store information local to a particular group.
2650 Here's an example group parameter list:
2651
2652 @example
2653 ((to-address . "ding@@gnus.org")
2654  (auto-expire . t))
2655 @end example
2656
2657 We see that each element consists of a "dotted pair"---the thing before
2658 the dot is the key, while the thing after the dot is the value.  All the
2659 parameters have this form @emph{except} local variable specs, which are
2660 not dotted pairs, but proper lists.
2661
2662 Some parameters have correspondant customizable variables, each of which
2663 is an alist of regexps and values.
2664
2665 The following group parameters can be used:
2666
2667 @table @code
2668 @item to-address
2669 @cindex to-address
2670 Address used by when doing followups and new posts.
2671
2672 @example
2673 (to-address . "some@@where.com")
2674 @end example
2675
2676 This is primarily useful in mail groups that represent closed mailing
2677 lists---mailing lists where it's expected that everybody that writes to
2678 the mailing list is subscribed to it.  Since using this parameter
2679 ensures that the mail only goes to the mailing list itself, it means
2680 that members won't receive two copies of your followups.
2681
2682 Using @code{to-address} will actually work whether the group is foreign
2683 or not.  Let's say there's a group on the server that is called
2684 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2685 the articles from a mail-to-news gateway.  Posting directly to this
2686 group is therefore impossible---you have to send mail to the mailing
2687 list address instead.
2688
2689 See also @code{gnus-parameter-to-address-alist}.
2690
2691 @item to-list
2692 @cindex to-list
2693 Address used when doing @kbd{a} in that group.
2694
2695 @example
2696 (to-list . "some@@where.com")
2697 @end example
2698
2699 It is totally ignored
2700 when doing a followup---except that if it is present in a news group,
2701 you'll get mail group semantics when doing @kbd{f}.
2702
2703 If you do an @kbd{a} command in a mail group and you have neither a
2704 @code{to-list} group parameter nor a @code{to-address} group parameter,
2705 then a @code{to-list} group parameter will be added automatically upon
2706 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2707 @vindex gnus-add-to-list
2708
2709 If you do an @kbd{a} command in a mail group and you don't have a
2710 @code{to-list} group parameter, one will be added automatically upon
2711 sending the message.
2712
2713 @findex gnus-mailing-list-mode
2714 @cindex Mail List Groups
2715 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2716 entering summary buffer.
2717
2718 See also @code{gnus-parameter-to-list-alist}.
2719
2720 @anchor{subscribed}
2721 @item subscribed
2722 @cindex subscribed
2723 If this parameter is set to @code{t}, Gnus will consider the
2724 to-address and to-list parameters for this group as addresses of
2725 mailing lists you are subscribed to.  Giving Gnus this information is
2726 (only) a first step in getting it to generate correct Mail-Followup-To
2727 headers for your posts to these lists.  Look here @pxref{(message)Mailing
2728 Lists} for a complete treatment of available MFT support.
2729
2730 See also @code{gnus-find-subscribed-addresses}, the function that
2731 directly uses this group parameter.
2732
2733 @item visible
2734 @cindex visible
2735 If the group parameter list has the element @code{(visible . t)},
2736 that group will always be visible in the Group buffer, regardless
2737 of whether it has any unread articles.
2738
2739 @item broken-reply-to
2740 @cindex broken-reply-to
2741 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2742 headers in this group are to be ignored.  This can be useful if you're
2743 reading a mailing list group where the listserv has inserted
2744 @code{Reply-To} headers that point back to the listserv itself.  This is
2745 broken behavior.  So there!
2746
2747 @item to-group
2748 @cindex to-group
2749 Elements like @code{(to-group . "some.group.name")} means that all
2750 posts in that group will be sent to @code{some.group.name}.
2751
2752 @item newsgroup
2753 @cindex newsgroup
2754 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2755 will treat all responses as if they were responses to news articles.
2756 This can be useful if you have a mail group that's really a mirror of a
2757 news group.
2758
2759 @item gcc-self
2760 @cindex gcc-self
2761 If @code{(gcc-self . t)} is present in the group parameter list, newly
2762 composed messages will be @code{Gcc}'d to the current group.  If
2763 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2764 generated, if @code{(gcc-self . "string")} is present, this string will
2765 be inserted literally as a @code{gcc} header.  This parameter takes
2766 precedence over any default @code{Gcc} rules as described later
2767 (@pxref{Archived Messages}).  CAVEAT:: It yields an error putting
2768 @code{(gcc-self . t)} in groups of a @code{nntp} server or so, because
2769 a @code{nntp} server doesn't accept articles.
2770
2771 @item auto-expire
2772 @cindex auto-expire
2773 If the group parameter has an element that looks like @code{(auto-expire
2774 . t)}, all articles read will be marked as expirable.  For an
2775 alternative approach, @pxref{Expiring Mail}.
2776
2777 See also @code{gnus-auto-expirable-newsgroups}.
2778
2779 @item total-expire
2780 @cindex total-expire
2781 If the group parameter has an element that looks like
2782 @code{(total-expire . t)}, all read articles will be put through the
2783 expiry process, even if they are not marked as expirable.  Use with
2784 caution.  Unread, ticked and dormant articles are not eligible for
2785 expiry.
2786
2787 See also @code{gnus-total-expirable-newsgroups}.
2788
2789 @item expiry-wait
2790 @cindex expiry-wait
2791 @vindex nnmail-expiry-wait-function
2792 If the group parameter has an element that looks like
2793 @code{(expiry-wait . 10)}, this value will override any
2794 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2795 (@pxref{Expiring Mail}) when expiring expirable messages.  The value
2796 can either be a number of days (not necessarily an integer) or the
2797 symbols @code{never} or @code{immediate}.
2798
2799 @item score-file
2800 @cindex score file group parameter
2801 Elements that look like @code{(score-file . "file")} will make
2802 @file{file} into the current score file for the group in question.  All
2803 interactive score entries will be put into this file.
2804
2805 @item adapt-file
2806 @cindex adapt file group parameter
2807 Elements that look like @code{(adapt-file . "file")} will make
2808 @file{file} into the current adaptive file for the group in question.
2809 All adaptive score entries will be put into this file.
2810
2811 @item admin-address
2812 @cindex admin-address
2813 When unsubscribing from a mailing list you should never send the
2814 unsubscription notice to the mailing list itself.  Instead, you'd send
2815 messages to the administrative address.  This parameter allows you to
2816 put the admin address somewhere convenient.
2817
2818 @item display
2819 @cindex display
2820 Elements that look like @code{(display . MODE)} say which articles to
2821 display on entering the group.  Valid values are:
2822
2823 @table @code
2824 @item all
2825 Display all articles, both read and unread.
2826
2827 @item an integer
2828 Display the last INTEGER articles in the group.  This is the same as
2829 entering the group with C-u INTEGER.
2830
2831 @item default
2832 Display the default visible articles, which normally includes unread and
2833 ticked articles.
2834
2835 @item an array
2836 Display articles that satisfy a predicate.
2837
2838 Here are some examples:
2839
2840 @table @code
2841 @item [unread]
2842 Display only unread articles.
2843
2844 @item [not expire]
2845 Display everything except expirable articles.
2846
2847 @item [and (not reply) (not expire)]
2848 Display everything except expirable and articles you've already
2849 responded to.
2850 @end table
2851
2852 The available operators are @code{not}, @code{and} and @code{or}.
2853 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2854 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2855 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2856 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2857
2858 @end table
2859
2860 The @code{display} parameter works by limiting the summary buffer to
2861 the subset specified.  You can pop the limit by using the @kbd{/ w}
2862 command (@pxref{Limiting}).
2863
2864 @item comment
2865 @cindex comment
2866 Elements that look like @code{(comment . "This is a comment")} are
2867 arbitrary comments on the group.  You can display comments in the
2868 group line (@pxref{Group Line Specification}).
2869
2870 @item charset
2871 @cindex charset
2872 Elements that look like @code{(charset . iso-8859-1)} will make
2873 @code{iso-8859-1} the default charset; that is, the charset that will be
2874 used for all articles that do not specify a charset.
2875
2876 See also @code{gnus-group-charset-alist}.
2877
2878 @item ignored-charsets
2879 @cindex ignored-charset
2880 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2881 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2882 default charset will be used for decoding articles.
2883
2884 See also @code{gnus-group-ignored-charsets-alist}.
2885
2886 @item posting-style
2887 @cindex posting-style
2888 You can store additional posting style information for this group only
2889 here (@pxref{Posting Styles}).  The format is that of an entry in the
2890 @code{gnus-posting-styles} alist, except that there's no regexp matching
2891 the group name (of course).  Style elements in this group parameter will
2892 take precedence over the ones found in @code{gnus-posting-styles}.
2893
2894 For instance, if you want a funky name and signature in this group only,
2895 instead of hacking @code{gnus-posting-styles}, you could put something
2896 like this in the group parameters:
2897
2898 @example
2899 (posting-style
2900   (name "Funky Name")
2901   (signature "Funky Signature"))
2902 @end example
2903
2904 @item post-method
2905 @cindex post-method
2906 If it is set, the value is used as the method for posting message
2907 instead of @code{gnus-post-method}.
2908
2909 @item banner
2910 @cindex banner
2911 An item like @code{(banner . "regex")} causes any part of an article
2912 that matches the regular expression "regex" to be stripped. Instead of
2913 "regex", you can also use the symbol @code{signature} which strips the
2914 last signature or any of the elements of the alist
2915 @code{gnus-article-banner-alist}.
2916
2917 @item sieve
2918 @cindex sieve
2919 This parameter contains a Sieve test that should match incoming mail
2920 that should be placed in this group.  From this group parameter, a
2921 Sieve @samp{IF} control structure is generated, having the test as the
2922 condition and @samp{fileinto "group.name";} as the body.
2923
2924 For example, if the INBOX.list.sieve group has the @code{(sieve
2925 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2926 translating the group parameter into a Sieve script (@pxref{Sieve
2927 Commands}) the following Sieve code is generated:
2928
2929 @example
2930 if address \"sender\" \"sieve-admin@@extundo.com\" @{
2931         fileinto \"INBOX.list.sieve\";
2932 @}
2933 @end example
2934
2935 The Sieve language is described in RFC 3028.  @xref{Top, , Top, sieve,
2936 Emacs Sieve}.
2937
2938 @item (@var{variable} @var{form})
2939 You can use the group parameters to set variables local to the group you
2940 are entering.  If you want to turn threading off in @samp{news.answers},
2941 you could put @code{(gnus-show-threads nil)} in the group parameters of
2942 that group.  @code{gnus-show-threads} will be made into a local variable
2943 in the summary buffer you enter, and the form @code{nil} will be
2944 @code{eval}ed there.
2945
2946 @vindex gnus-list-identifiers
2947 A use for this feature, is to remove a mailing list identifier tag in
2948 the subject fields of articles.   E.g. if the news group
2949 @samp{nntp+news.gnus.org:gmane.text.docbook.apps} has the tag
2950 @samp{DOC-BOOK-APPS:} in the subject of all articles, this tag can be
2951 removed from the article subjects in the summary buffer for the group by
2952 putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")} into the group
2953 parameters for the group.
2954
2955
2956 This can also be used as a group-specific hook function, if you'd like.
2957 If you want to hear a beep when you enter a group, you could put
2958 something like @code{(dummy-variable (ding))} in the parameters of that
2959 group.  @code{dummy-variable} will be set to the result of the
2960 @code{(ding)} form, but who cares?
2961
2962 @end table
2963
2964 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2965 group.  (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2966 presents you with a Customize-like interface.  The latter helps avoid
2967 silly Lisp errors.)  You might also be interested in reading about topic
2968 parameters (@pxref{Topic Parameters}).
2969
2970 Group parameters can be set via the @code{gnus-parameters} variable too.
2971 But some variables, such as @code{visible}, have no effect.  For
2972 example:
2973
2974 @example
2975 (setq gnus-parameters
2976       '(("mail\\..*"
2977          (gnus-show-threads nil)
2978          (gnus-use-scoring nil)
2979          (gnus-summary-line-format
2980           "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
2981          (gcc-self . t)
2982          (display . all))
2983
2984         ("^nnimap:\\(foo.bar\\)$"
2985          (to-group . "\\1"))
2986
2987         ("mail\\.me"
2988          (gnus-use-scoring  t))
2989
2990         ("list\\..*"
2991          (total-expire . t)
2992          (broken-reply-to . t))))
2993 @end example
2994
2995 String value of parameters will be subjected to regexp substitution, as
2996 the @code{to-group} example shows.
2997
2998
2999 @node Listing Groups
3000 @section Listing Groups
3001 @cindex group listing
3002
3003 These commands all list various slices of the groups available.
3004
3005 @table @kbd
3006
3007 @item l
3008 @itemx A s
3009 @kindex A s (Group)
3010 @kindex l (Group)
3011 @findex gnus-group-list-groups
3012 List all groups that have unread articles
3013 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
3014 command will list only groups of level ARG and lower.  By default, it
3015 only lists groups of level five (i. e.,
3016 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3017 groups).
3018
3019 @item L
3020 @itemx A u
3021 @kindex A u (Group)
3022 @kindex L (Group)
3023 @findex gnus-group-list-all-groups
3024 List all groups, whether they have unread articles or not
3025 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
3026 this command will list only groups of level ARG and lower.  By default,
3027 it lists groups of level seven or lower (i.e., just subscribed and
3028 unsubscribed groups).
3029
3030 @item A l
3031 @kindex A l (Group)
3032 @findex gnus-group-list-level
3033 List all unread groups on a specific level
3034 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
3035 with no unread articles.
3036
3037 @item A k
3038 @kindex A k (Group)
3039 @findex gnus-group-list-killed
3040 List all killed groups (@code{gnus-group-list-killed}).  If given a
3041 prefix argument, really list all groups that are available, but aren't
3042 currently (un)subscribed.  This could entail reading the active file
3043 from the server.
3044
3045 @item A z
3046 @kindex A z (Group)
3047 @findex gnus-group-list-zombies
3048 List all zombie groups (@code{gnus-group-list-zombies}).
3049
3050 @item A m
3051 @kindex A m (Group)
3052 @findex gnus-group-list-matching
3053 List all unread, subscribed groups with names that match a regexp
3054 (@code{gnus-group-list-matching}).
3055
3056 @item A M
3057 @kindex A M (Group)
3058 @findex gnus-group-list-all-matching
3059 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3060
3061 @item A A
3062 @kindex A A (Group)
3063 @findex gnus-group-list-active
3064 List absolutely all groups in the active file(s) of the
3065 server(s) you are connected to (@code{gnus-group-list-active}).  This
3066 might very well take quite a while.  It might actually be a better idea
3067 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3068 thing to match on.  Also note that this command may list groups that
3069 don't exist (yet)---these will be listed as if they were killed groups.
3070 Take the output with some grains of salt.
3071
3072 @item A a
3073 @kindex A a (Group)
3074 @findex gnus-group-apropos
3075 List all groups that have names that match a regexp
3076 (@code{gnus-group-apropos}).
3077
3078 @item A d
3079 @kindex A d (Group)
3080 @findex gnus-group-description-apropos
3081 List all groups that have names or descriptions that match a regexp
3082 (@code{gnus-group-description-apropos}).
3083
3084 @item A c
3085 @kindex A c (Group)
3086 @findex gnus-group-list-cached
3087 List all groups with cached articles (@code{gnus-group-list-cached}).
3088
3089 @item A ?
3090 @kindex A ? (Group)
3091 @findex gnus-group-list-dormant
3092 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3093
3094 @item A /
3095 @kindex A / (Group)
3096 @findex gnus-group-list-limit
3097 List groups limited within the current selection
3098 (@code{gnus-group-list-limit}).
3099
3100 @item A f
3101 @kindex A f (Group)
3102 @findex gnus-group-list-flush
3103 Flush groups from the current selection (@code{gnus-group-list-flush}).
3104
3105 @item A p
3106 @kindex A p (Group)
3107 @findex gnus-group-list-plus
3108 List groups plus the current selection (@code{gnus-group-list-plus}).
3109
3110 @end table
3111
3112 @vindex gnus-permanently-visible-groups
3113 @cindex visible group parameter
3114 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3115 always be shown, whether they have unread articles or not.  You can also
3116 add the @code{visible} element to the group parameters in question to
3117 get the same effect.
3118
3119 @vindex gnus-list-groups-with-ticked-articles
3120 Groups that have just ticked articles in it are normally listed in the
3121 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
3122 @code{nil}, these groups will be treated just like totally empty
3123 groups.  It is @code{t} by default.
3124
3125
3126 @node Sorting Groups
3127 @section Sorting Groups
3128 @cindex sorting groups
3129
3130 @kindex C-c C-s (Group)
3131 @findex gnus-group-sort-groups
3132 @vindex gnus-group-sort-function
3133 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3134 group buffer according to the function(s) given by the
3135 @code{gnus-group-sort-function} variable.  Available sorting functions
3136 include:
3137
3138 @table @code
3139
3140 @item gnus-group-sort-by-alphabet
3141 @findex gnus-group-sort-by-alphabet
3142 Sort the group names alphabetically.  This is the default.
3143
3144 @item gnus-group-sort-by-real-name
3145 @findex gnus-group-sort-by-real-name
3146 Sort the group alphabetically on the real (unprefixed) group names.
3147
3148 @item gnus-group-sort-by-level
3149 @findex gnus-group-sort-by-level
3150 Sort by group level.
3151
3152 @item gnus-group-sort-by-score
3153 @findex gnus-group-sort-by-score
3154 Sort by group score.  @xref{Group Score}.
3155
3156 @item gnus-group-sort-by-rank
3157 @findex gnus-group-sort-by-rank
3158 Sort by group score and then the group level.  The level and the score
3159 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
3160
3161 @item gnus-group-sort-by-unread
3162 @findex gnus-group-sort-by-unread
3163 Sort by number of unread articles.
3164
3165 @item gnus-group-sort-by-method
3166 @findex gnus-group-sort-by-method
3167 Sort alphabetically on the select method.
3168
3169 @item gnus-group-sort-by-server
3170 @findex gnus-group-sort-by-server
3171 Sort alphabetically on the Gnus server name.
3172
3173
3174 @end table
3175
3176 @code{gnus-group-sort-function} can also be a list of sorting
3177 functions.  In that case, the most significant sort key function must be
3178 the last one.
3179
3180
3181 There are also a number of commands for sorting directly according to
3182 some sorting criteria:
3183
3184 @table @kbd
3185 @item G S a
3186 @kindex G S a (Group)
3187 @findex gnus-group-sort-groups-by-alphabet
3188 Sort the group buffer alphabetically by group name
3189 (@code{gnus-group-sort-groups-by-alphabet}).
3190
3191 @item G S u
3192 @kindex G S u (Group)
3193 @findex gnus-group-sort-groups-by-unread
3194 Sort the group buffer by the number of unread articles
3195 (@code{gnus-group-sort-groups-by-unread}).
3196
3197 @item G S l
3198 @kindex G S l (Group)
3199 @findex gnus-group-sort-groups-by-level
3200 Sort the group buffer by group level
3201 (@code{gnus-group-sort-groups-by-level}).
3202
3203 @item G S v
3204 @kindex G S v (Group)
3205 @findex gnus-group-sort-groups-by-score
3206 Sort the group buffer by group score
3207 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
3208
3209 @item G S r
3210 @kindex G S r (Group)
3211 @findex gnus-group-sort-groups-by-rank
3212 Sort the group buffer by group rank
3213 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
3214
3215 @item G S m
3216 @kindex G S m (Group)
3217 @findex gnus-group-sort-groups-by-method
3218 Sort the group buffer alphabetically by back end name
3219 (@code{gnus-group-sort-groups-by-method}).
3220
3221 @item G S n
3222 @kindex G S n (Group)
3223 @findex gnus-group-sort-groups-by-real-name
3224 Sort the group buffer alphabetically by real (unprefixed) group name
3225 (@code{gnus-group-sort-groups-by-real-name}).
3226
3227 @end table
3228
3229 All the commands below obey the process/prefix convention
3230 (@pxref{Process/Prefix}).
3231
3232 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3233 commands will sort in reverse order.
3234
3235 You can also sort a subset of the groups:
3236
3237 @table @kbd
3238 @item G P a
3239 @kindex G P a (Group)
3240 @findex gnus-group-sort-selected-groups-by-alphabet
3241 Sort the groups alphabetically by group name
3242 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3243
3244 @item G P u
3245 @kindex G P u (Group)
3246 @findex gnus-group-sort-selected-groups-by-unread
3247 Sort the groups by the number of unread articles
3248 (@code{gnus-group-sort-selected-groups-by-unread}).
3249
3250 @item G P l
3251 @kindex G P l (Group)
3252 @findex gnus-group-sort-selected-groups-by-level
3253 Sort the groups by group level
3254 (@code{gnus-group-sort-selected-groups-by-level}).
3255
3256 @item G P v
3257 @kindex G P v (Group)
3258 @findex gnus-group-sort-selected-groups-by-score
3259 Sort the groups by group score
3260 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
3261
3262 @item G P r
3263 @kindex G P r (Group)
3264 @findex gnus-group-sort-selected-groups-by-rank
3265 Sort the groups by group rank
3266 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
3267
3268 @item G P m
3269 @kindex G P m (Group)
3270 @findex gnus-group-sort-selected-groups-by-method
3271 Sort the groups alphabetically by back end name
3272 (@code{gnus-group-sort-selected-groups-by-method}).
3273
3274 @item G P n
3275 @kindex G P n (Group)
3276 @findex gnus-group-sort-selected-groups-by-real-name
3277 Sort the groups alphabetically by real (unprefixed) group name
3278 (@code{gnus-group-sort-selected-groups-by-real-name}).
3279
3280 @item G P s
3281 @kindex G P s (Group)
3282 @findex gnus-group-sort-selected-groups
3283 Sort the groups according to @code{gnus-group-sort-function}.
3284
3285 @end table
3286
3287 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3288 move groups around.
3289
3290
3291 @node Group Maintenance
3292 @section Group Maintenance
3293 @cindex bogus groups
3294
3295 @table @kbd
3296 @item b
3297 @kindex b (Group)
3298 @findex gnus-group-check-bogus-groups
3299 Find bogus groups and delete them
3300 (@code{gnus-group-check-bogus-groups}).
3301
3302 @item F
3303 @kindex F (Group)
3304 @findex gnus-group-find-new-groups
3305 Find new groups and process them (@code{gnus-group-find-new-groups}).
3306 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3307 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
3308 to query the server for new groups, and subscribe the new groups as
3309 zombies.
3310
3311 @item C-c C-x
3312 @kindex C-c C-x (Group)
3313 @findex gnus-group-expire-articles
3314 Run all expirable articles in the current group through the expiry
3315 process (if any) (@code{gnus-group-expire-articles}).  That is, delete
3316 all expirable articles in the group that have been around for a while.
3317 (@pxref{Expiring Mail}).
3318
3319 @item C-c C-M-x
3320 @kindex C-c C-M-x (Group)
3321 @findex gnus-group-expire-all-groups
3322 Run all expirable articles in all groups through the expiry process
3323 (@code{gnus-group-expire-all-groups}).
3324
3325 @end table
3326
3327
3328 @node Browse Foreign Server
3329 @section Browse Foreign Server
3330 @cindex foreign servers
3331 @cindex browsing servers
3332
3333 @table @kbd
3334 @item B
3335 @kindex B (Group)
3336 @findex gnus-group-browse-foreign-server
3337 You will be queried for a select method and a server name.  Gnus will
3338 then attempt to contact this server and let you browse the groups there
3339 (@code{gnus-group-browse-foreign-server}).
3340 @end table
3341
3342 @findex gnus-browse-mode
3343 A new buffer with a list of available groups will appear.  This buffer
3344 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
3345 a lot) like a normal group buffer.
3346
3347 Here's a list of keystrokes available in the browse mode:
3348
3349 @table @kbd
3350 @item n
3351 @kindex n (Browse)
3352 @findex gnus-group-next-group
3353 Go to the next group (@code{gnus-group-next-group}).
3354
3355 @item p
3356 @kindex p (Browse)
3357 @findex gnus-group-prev-group
3358 Go to the previous group (@code{gnus-group-prev-group}).
3359
3360 @item SPACE
3361 @kindex SPACE (Browse)
3362 @findex gnus-browse-read-group
3363 Enter the current group and display the first article
3364 (@code{gnus-browse-read-group}).
3365
3366 @item RET
3367 @kindex RET (Browse)
3368 @findex gnus-browse-select-group
3369 Enter the current group (@code{gnus-browse-select-group}).
3370
3371 @item u
3372 @kindex u (Browse)
3373 @findex gnus-browse-unsubscribe-current-group
3374 Unsubscribe to the current group, or, as will be the case here,
3375 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3376
3377 @item l
3378 @itemx q
3379 @kindex q (Browse)
3380 @kindex l (Browse)
3381 @findex gnus-browse-exit
3382 Exit browse mode (@code{gnus-browse-exit}).
3383
3384 @item d
3385 @kindex d (Browse)
3386 @findex gnus-browse-describe-group
3387 Describe the current group (@code{gnus-browse-describe-group}).
3388
3389 @item ?
3390 @kindex ? (Browse)
3391 @findex gnus-browse-describe-briefly
3392 Describe browse mode briefly (well, there's not much to describe, is
3393 there) (@code{gnus-browse-describe-briefly}).
3394 @end table
3395
3396
3397 @node Exiting Gnus
3398 @section Exiting gnus
3399 @cindex exiting gnus
3400
3401 Yes, gnus is ex(c)iting.
3402
3403 @table @kbd
3404 @item z
3405 @kindex z (Group)
3406 @findex gnus-group-suspend
3407 Suspend gnus (@code{gnus-group-suspend}).  This doesn't really exit gnus,
3408 but it kills all buffers except the Group buffer.  I'm not sure why this
3409 is a gain, but then who am I to judge?
3410
3411 @item q
3412 @kindex q (Group)
3413 @findex gnus-group-exit
3414 @c @icon{gnus-group-exit}
3415 Quit gnus (@code{gnus-group-exit}).
3416
3417 @item Q
3418 @kindex Q (Group)
3419 @findex gnus-group-quit
3420 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3421 The dribble file will be saved, though (@pxref{Auto Save}).
3422 @end table
3423
3424 @vindex gnus-exit-gnus-hook
3425 @vindex gnus-suspend-gnus-hook
3426 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3427 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3428 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3429 exiting gnus.
3430
3431 @findex gnus-unload
3432 @cindex unloading
3433 If you wish to completely unload gnus and all its adherents, you can use
3434 the @code{gnus-unload} command.  This command is also very handy when
3435 trying to customize meta-variables.
3436
3437 Note:
3438
3439 @quotation
3440 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3441 numbly heavy and herself fall into a hazy trance as the boy sitting
3442 behind her drew repeated lines with his pencil across the back of her
3443 plastic chair.
3444 @end quotation
3445
3446
3447 @node Group Topics
3448 @section Group Topics
3449 @cindex topics
3450
3451 If you read lots and lots of groups, it might be convenient to group
3452 them hierarchically according to topics.  You put your Emacs groups over
3453 here, your sex groups over there, and the rest (what, two groups or so?)
3454 you put in some misc section that you never bother with anyway.  You can
3455 even group the Emacs sex groups as a sub-topic to either the Emacs
3456 groups or the sex groups---or both!  Go wild!
3457
3458 @iftex
3459 @iflatex
3460 \gnusfigure{Group Topics}{400}{
3461 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3462 }
3463 @end iflatex
3464 @end iftex
3465
3466 Here's an example:
3467
3468 @example
3469 Gnus
3470   Emacs -- I wuw it!
3471      3: comp.emacs
3472      2: alt.religion.emacs
3473     Naughty Emacs
3474      452: alt.sex.emacs
3475        0: comp.talk.emacs.recovery
3476   Misc
3477      8: comp.binaries.fractals
3478     13: comp.sources.unix
3479 @end example
3480
3481 @findex gnus-topic-mode
3482 @kindex t (Group)
3483 To get this @emph{fab} functionality you simply turn on (ooh!) the
3484 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
3485 is a toggling command.)
3486
3487 Go ahead, just try it.  I'll still be here when you get back.  La de
3488 dum...  Nice tune, that...  la la la...  What, you're back?  Yes, and
3489 now press @kbd{l}.  There.  All your groups are now listed under
3490 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
3491 bothered?
3492
3493 If you want this permanently enabled, you should add that minor mode to
3494 the hook for the group mode.  Put the following line in your
3495 @file{~/.gnus} file:
3496
3497 @lisp
3498 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3499 @end lisp
3500
3501 @menu
3502 * Topic Commands::              Interactive E-Z commands.
3503 * Topic Variables::             How to customize the topics the Lisp Way.
3504 * Topic Sorting::               Sorting each topic individually.
3505 * Topic Topology::              A map of the world.
3506 * Topic Parameters::            Parameters that apply to all groups in a topic.
3507 @end menu
3508
3509
3510 @node Topic Commands
3511 @subsection Topic Commands
3512 @cindex topic commands
3513
3514 When the topic minor mode is turned on, a new @kbd{T} submap will be
3515 available.  In addition, a few of the standard keys change their
3516 definitions slightly.
3517
3518 In general, the following kinds of operations are possible on topics.
3519 First of all, you want to create topics.  Secondly, you want to put
3520 groups in topics and to move them around until you have an order you
3521 like.  The third kind of operation is to show/hide parts of the whole
3522 shebang.  You might want to hide a topic including its subtopics and
3523 groups, to get a better overview of the other groups.
3524
3525 Here is a list of the basic keys that you might need to set up topics
3526 the way you like.
3527
3528 @table @kbd
3529
3530 @item T n
3531 @kindex T n (Topic)
3532 @findex gnus-topic-create-topic
3533 Prompt for a new topic name and create it
3534 (@code{gnus-topic-create-topic}).
3535
3536 @item T TAB
3537 @itemx TAB
3538 @kindex T TAB (Topic)
3539 @kindex TAB (Topic)
3540 @findex gnus-topic-indent
3541 ``Indent'' the current topic so that it becomes a sub-topic of the
3542 previous topic (@code{gnus-topic-indent}).  If given a prefix,
3543 ``un-indent'' the topic instead.
3544
3545 @item M-TAB
3546 @kindex M-TAB (Topic)
3547 @findex gnus-topic-unindent
3548 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3549 parent of its current parent (@code{gnus-topic-unindent}).
3550
3551 @end table
3552
3553 The following two keys can be used to move groups and topics around.
3554 They work like the well-known cut and paste.  @kbd{C-k} is like cut and
3555 @kbd{C-y} is like paste.  Of course, this being Emacs, we use the terms
3556 kill and yank rather than cut and paste.
3557
3558 @table @kbd
3559
3560 @item C-k
3561 @kindex C-k (Topic)
3562 @findex gnus-topic-kill-group
3563 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
3564 topic will be removed along with the topic.
3565
3566 @item C-y
3567 @kindex C-y (Topic)
3568 @findex gnus-topic-yank-group
3569 Yank the previously killed group or topic
3570 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
3571 before all groups.
3572
3573 So, to move a topic to the beginning of the list of topics, just hit
3574 @kbd{C-k} on it.  This is like the `cut' part of cut and paste.  Then,
3575 move the cursor to the beginning of the buffer (just below the `Gnus'
3576 topic) and hit @kbd{C-y}.  This is like the `paste' part of cut and
3577 paste.  Like I said -- E-Z.
3578
3579 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics.  So
3580 you can move topics around as well as groups.
3581
3582 @end table
3583
3584 After setting up the topics the way you like them, you might wish to
3585 hide a topic, or to show it again.  That's why we have the following
3586 key.
3587
3588 @table @kbd
3589
3590 @item RET
3591 @kindex RET (Topic)
3592 @findex gnus-topic-select-group
3593 @itemx SPACE
3594 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3595 When you perform this command on a group, you'll enter the group, as
3596 usual.  When done on a topic line, the topic will be folded (if it was
3597 visible) or unfolded (if it was folded already).  So it's basically a
3598 toggling command on topics.  In addition, if you give a numerical
3599 prefix, group on that level (and lower) will be displayed.
3600
3601 @end table
3602
3603 Now for a list of other commands, in no particular order.
3604
3605 @table @kbd
3606
3607 @item T m
3608 @kindex T m (Topic)
3609 @findex gnus-topic-move-group
3610 Move the current group to some other topic
3611 (@code{gnus-topic-move-group}).  This command uses the process/prefix
3612 convention (@pxref{Process/Prefix}).
3613
3614 @item T j
3615 @kindex T j (Topic)
3616 @findex gnus-topic-jump-to-topic
3617 Go to a topic (@code{gnus-topic-jump-to-topic}).
3618
3619 @item T c
3620 @kindex T c (Topic)
3621 @findex gnus-topic-copy-group
3622 Copy the current group to some other topic
3623 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
3624 convention (@pxref{Process/Prefix}).
3625
3626 @item T h
3627 @kindex T h (Topic)
3628 @findex gnus-topic-hide-topic
3629 Hide the current topic (@code{gnus-topic-hide-topic}).  If given
3630 a prefix, hide the topic permanently.
3631
3632 @item T s
3633 @kindex T s (Topic)
3634 @findex gnus-topic-show-topic
3635 Show the current topic (@code{gnus-topic-show-topic}).  If given
3636 a prefix, show the topic permanently.
3637
3638 @item T D
3639 @kindex T D (Topic)
3640 @findex gnus-topic-remove-group
3641 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3642 This command is mainly useful if you have the same group in several
3643 topics and wish to remove it from one of the topics.  You may also
3644 remove a group from all topics, but in that case, Gnus will add it to
3645 the root topic the next time you start Gnus.  In fact, all new groups
3646 (which, naturally, don't belong to any topic) will show up in the root
3647 topic.
3648
3649 This command uses the process/prefix convention
3650 (@pxref{Process/Prefix}).
3651
3652 @item T M
3653 @kindex T M (Topic)
3654 @findex gnus-topic-move-matching
3655 Move all groups that match some regular expression to a topic
3656 (@code{gnus-topic-move-matching}).
3657
3658 @item T C
3659 @kindex T C (Topic)
3660 @findex gnus-topic-copy-matching
3661 Copy all groups that match some regular expression to a topic
3662 (@code{gnus-topic-copy-matching}).
3663
3664 @item T H
3665 @kindex T H (Topic)
3666 @findex gnus-topic-toggle-display-empty-topics
3667 Toggle hiding empty topics
3668 (@code{gnus-topic-toggle-display-empty-topics}).
3669
3670 @item T #
3671 @kindex T # (Topic)
3672 @findex gnus-topic-mark-topic
3673 Mark all groups in the current topic with the process mark
3674 (@code{gnus-topic-mark-topic}).
3675
3676 @item T M-#
3677 @kindex T M-# (Topic)
3678 @findex gnus-topic-unmark-topic
3679 Remove the process mark from all groups in the current topic
3680 (@code{gnus-topic-unmark-topic}).
3681
3682 @item C-c C-x
3683 @kindex C-c C-x (Topic)
3684 @findex gnus-topic-expire-articles
3685 Run all expirable articles in the current group or topic through the
3686 expiry process (if any)
3687 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3688
3689 @item T r
3690 @kindex T r (Topic)
3691 @findex gnus-topic-rename
3692 Rename a topic (@code{gnus-topic-rename}).
3693
3694 @item T DEL
3695 @kindex T DEL (Topic)
3696 @findex gnus-topic-delete
3697 Delete an empty topic (@code{gnus-topic-delete}).
3698
3699 @item A T
3700 @kindex A T (Topic)
3701 @findex gnus-topic-list-active
3702 List all groups that gnus knows about in a topics-ified way
3703 (@code{gnus-topic-list-active}).
3704
3705 @item T M-n
3706 @kindex T M-n (Topic)
3707 @findex gnus-topic-goto-next-topic
3708 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3709
3710 @item T M-p
3711 @kindex T M-p (Topic)
3712 @findex gnus-topic-goto-previous-topic
3713 Go to the next topic (@code{gnus-topic-goto-previous-topic}).
3714
3715 @item G p
3716 @kindex G p (Topic)
3717 @findex gnus-topic-edit-parameters
3718 @cindex group parameters
3719 @cindex topic parameters
3720 @cindex parameters
3721 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3722 @xref{Topic Parameters}.
3723
3724 @end table
3725
3726
3727 @node Topic Variables
3728 @subsection Topic Variables
3729 @cindex topic variables
3730
3731 The previous section told you how to tell Gnus which topics to display.
3732 This section explains how to tell Gnus what to display about each topic.
3733
3734 @vindex gnus-topic-line-format
3735 The topic lines themselves are created according to the
3736 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3737 Valid elements are:
3738
3739 @table @samp
3740 @item i
3741 Indentation.
3742 @item n
3743 Topic name.
3744 @item v
3745 Visibility.
3746 @item l
3747 Level.
3748 @item g
3749 Number of groups in the topic.
3750 @item a
3751 Number of unread articles in the topic.
3752 @item A
3753 Number of unread articles in the topic and all its subtopics.
3754 @end table
3755
3756 @vindex gnus-topic-indent-level
3757 Each sub-topic (and the groups in the sub-topics) will be indented with
3758 @code{gnus-topic-indent-level} times the topic level number of spaces.
3759 The default is 2.
3760
3761 @vindex gnus-topic-mode-hook
3762 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3763
3764 @vindex gnus-topic-display-empty-topics
3765 The @code{gnus-topic-display-empty-topics} says whether to display even
3766 topics that have no unread articles in them.  The default is @code{t}.
3767
3768
3769 @node Topic Sorting
3770 @subsection Topic Sorting
3771 @cindex topic sorting
3772
3773 You can sort the groups in each topic individually with the following
3774 commands:
3775
3776
3777 @table @kbd
3778 @item T S a
3779 @kindex T S a (Topic)
3780 @findex gnus-topic-sort-groups-by-alphabet
3781 Sort the current topic alphabetically by group name
3782 (@code{gnus-topic-sort-groups-by-alphabet}).
3783
3784 @item T S u
3785 @kindex T S u (Topic)
3786 @findex gnus-topic-sort-groups-by-unread
3787 Sort the current topic by the number of unread articles
3788 (@code{gnus-topic-sort-groups-by-unread}).
3789
3790 @item T S l
3791 @kindex T S l (Topic)
3792 @findex gnus-topic-sort-groups-by-level
3793 Sort the current topic by group level
3794 (@code{gnus-topic-sort-groups-by-level}).
3795
3796 @item T S v
3797 @kindex T S v (Topic)
3798 @findex gnus-topic-sort-groups-by-score
3799 Sort the current topic by group score
3800 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
3801
3802 @item T S r
3803 @kindex T S r (Topic)
3804 @findex gnus-topic-sort-groups-by-rank
3805 Sort the current topic by group rank
3806 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
3807
3808 @item T S m
3809 @kindex T S m (Topic)
3810 @findex gnus-topic-sort-groups-by-method
3811 Sort the current topic alphabetically by back end name
3812 (@code{gnus-topic-sort-groups-by-method}).
3813
3814 @item T S e
3815 @kindex T S e (Topic)
3816 @findex gnus-topic-sort-groups-by-server
3817 Sort the current topic alphabetically by server name
3818 (@code{gnus-topic-sort-groups-by-server}).
3819
3820 @item T S s
3821 @kindex T S s
3822 @findex gnus-topic-sort-groups
3823 Sort the current topic according to the function(s) given by the
3824 @code{gnus-group-sort-function} variable
3825 (@code{gnus-topic-sort-groups}).
3826
3827 @end table
3828
3829 When given a prefix argument, all these commands will sort in reverse
3830 order.  @xref{Sorting Groups}, for more information about group
3831 sorting.
3832
3833
3834 @node Topic Topology
3835 @subsection Topic Topology
3836 @cindex topic topology
3837 @cindex topology
3838
3839 So, let's have a look at an example group buffer:
3840
3841 @example
3842 Gnus
3843   Emacs -- I wuw it!
3844      3: comp.emacs
3845      2: alt.religion.emacs
3846     Naughty Emacs
3847      452: alt.sex.emacs
3848        0: comp.talk.emacs.recovery
3849   Misc
3850      8: comp.binaries.fractals
3851     13: comp.sources.unix
3852 @end example
3853
3854 So, here we have one top-level topic (@samp{Gnus}), two topics under
3855 that, and one sub-topic under one of the sub-topics.  (There is always
3856 just one (1) top-level topic).  This topology can be expressed as
3857 follows:
3858
3859 @lisp
3860 (("Gnus" visible)
3861  (("Emacs -- I wuw it!" visible)
3862   (("Naughty Emacs" visible)))
3863  (("Misc" visible)))
3864 @end lisp
3865
3866 @vindex gnus-topic-topology
3867 This is in fact how the variable @code{gnus-topic-topology} would look
3868 for the display above.  That variable is saved in the @file{.newsrc.eld}
3869 file, and shouldn't be messed with manually---unless you really want
3870 to.  Since this variable is read from the @file{.newsrc.eld} file,
3871 setting it in any other startup files will have no effect.
3872
3873 This topology shows what topics are sub-topics of what topics (right),
3874 and which topics are visible.  Two settings are currently
3875 allowed---@code{visible} and @code{invisible}.
3876
3877
3878 @node Topic Parameters
3879 @subsection Topic Parameters
3880 @cindex topic parameters
3881
3882 All groups in a topic will inherit group parameters from the parent (and
3883 ancestor) topic parameters.  All valid group parameters are valid topic
3884 parameters (@pxref{Group Parameters}).
3885
3886 In addition, the following parameters are only valid as topic
3887 parameters:
3888
3889 @table @code
3890 @item subscribe
3891 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3892 @code{subscribe} topic parameter says what groups go in what topic.  Its
3893 value should be a regexp to match the groups that should go in that
3894 topic.
3895
3896 @item subscribe-level
3897 When subscribing new groups by topic (see the @code{subscribe} parameter),
3898 the group will be subscribed with the level specified in the
3899 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
3900
3901 @end table
3902
3903 Group parameters (of course) override topic parameters, and topic
3904 parameters in sub-topics override topic parameters in super-topics.  You
3905 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
3906 verb, although you may feel free to disagree with me here.)
3907
3908 @example
3909 Gnus
3910   Emacs
3911      3: comp.emacs
3912      2: alt.religion.emacs
3913    452: alt.sex.emacs
3914     Relief
3915      452: alt.sex.emacs
3916        0: comp.talk.emacs.recovery
3917   Misc
3918      8: comp.binaries.fractals
3919     13: comp.sources.unix
3920    452: alt.sex.emacs
3921 @end example
3922
3923 The @samp{Emacs} topic has the topic parameter @code{(score-file
3924 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3925 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3926 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
3927 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3928 . "religion.SCORE")}.
3929
3930 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3931 will get the @file{relief.SCORE} home score file.  If you enter the same
3932 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3933 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
3934 get the @file{religion.SCORE} home score file.
3935
3936 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
3937 there are some problems, especially with the @code{total-expiry}
3938 parameter.  Say you have a mail group in two topics; one with
3939 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
3940 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
3941 of these topics you mean to expire articles from, so anything may
3942 happen.  In fact, I hereby declare that it is @dfn{undefined} what
3943 happens.  You just have to be careful if you do stuff like that.
3944
3945
3946 @node Misc Group Stuff
3947 @section Misc Group Stuff
3948
3949 @menu
3950 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
3951 * Group Information::           Information and help on groups and Gnus.
3952 * Group Timestamp::             Making Gnus keep track of when you last read a group.
3953 * File Commands::               Reading and writing the Gnus files.
3954 * Sieve Commands::              Managing Sieve scripts.
3955 @end menu
3956
3957 @table @kbd
3958
3959 @item ^
3960 @kindex ^ (Group)
3961 @findex gnus-group-enter-server-mode
3962 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3963 @xref{Server Buffer}.
3964
3965 @item a
3966 @kindex a (Group)
3967 @findex gnus-group-post-news
3968 Start composing a message (a news by default)
3969 (@code{gnus-group-post-news}).  If given a prefix, post to the group
3970 under the point.  If the prefix is 1, prompt for a group to post to.
3971 Contrary to what the name of this function suggests, the prepared
3972 article might be a mail instead of a news, if a mail group is specified
3973 with the prefix argument.  @xref{Composing Messages}.
3974
3975 @item m
3976 @kindex m (Group)
3977 @findex gnus-group-mail
3978 Mail a message somewhere (@code{gnus-group-mail}).  If given a prefix,
3979 use the posting style of the group under the point.  If the prefix is 1,
3980 prompt for a group name to find the posting style.
3981 @xref{Composing Messages}.
3982
3983 @item i
3984 @kindex i (Group)
3985 @findex gnus-group-news
3986 Start composing a news (@code{gnus-group-news}).  If given a prefix,
3987 post to the group under the point.  If the prefix is 1, prompt
3988 for group to post to.  @xref{Composing Messages}.
3989
3990 This function actually prepares a news even when using mail groups.
3991 This is useful for "posting" messages to mail groups without actually
3992 sending them over the network: they're just saved directly to the group
3993 in question.  The corresponding back end must have a request-post method
3994 for this to work though.
3995
3996 @end table
3997
3998 Variables for the group buffer:
3999
4000 @table @code
4001
4002 @item gnus-group-mode-hook
4003 @vindex gnus-group-mode-hook
4004 is called after the group buffer has been
4005 created.
4006
4007 @item gnus-group-prepare-hook
4008 @vindex gnus-group-prepare-hook
4009 is called after the group buffer is
4010 generated.  It may be used to modify the buffer in some strange,
4011 unnatural way.
4012
4013 @item gnus-group-prepared-hook
4014 @vindex gnus-group-prepare-hook
4015 is called as the very last thing after the group buffer has been
4016 generated.  It may be used to move point around, for instance.
4017
4018 @item gnus-permanently-visible-groups
4019 @vindex gnus-permanently-visible-groups
4020 Groups matching this regexp will always be listed in the group buffer,
4021 whether they are empty or not.
4022
4023 @item gnus-group-name-charset-method-alist
4024 @vindex gnus-group-name-charset-method-alist
4025 An alist of method and the charset for group names. It is used to show
4026 non-ASCII group names.
4027
4028 For example:
4029 @lisp
4030 (setq gnus-group-name-charset-method-alist
4031     '(((nntp "news.com.cn") . cn-gb-2312)))
4032 @end lisp
4033
4034 @item gnus-group-name-charset-group-alist
4035 @cindex UTF-8 group names
4036 @vindex gnus-group-name-charset-group-alist
4037 An alist of regexp of group name and the charset for group names.  It
4038 is used to show non-ASCII group names.  @code{((".*" utf-8))} is the
4039 default value if UTF-8 is supported, otherwise the default is nil.
4040
4041 For example:
4042 @lisp
4043 (setq gnus-group-name-charset-group-alist
4044     '(("\\.com\\.cn:" . cn-gb-2312)))
4045 @end lisp
4046
4047 @end table
4048
4049 @node Scanning New Messages
4050 @subsection Scanning New Messages
4051 @cindex new messages
4052 @cindex scanning new news
4053
4054 @table @kbd
4055
4056 @item g
4057 @kindex g (Group)
4058 @findex gnus-group-get-new-news
4059 @c @icon{gnus-group-get-new-news}
4060 Check the server(s) for new articles.  If the numerical prefix is used,
4061 this command will check only groups of level @var{arg} and lower
4062 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
4063 command will force a total re-reading of the active file(s) from the
4064 back end(s).
4065
4066 @item M-g
4067 @kindex M-g (Group)
4068 @findex gnus-group-get-new-news-this-group
4069 @vindex gnus-goto-next-group-when-activating
4070 @c @icon{gnus-group-get-new-news-this-group}
4071 Check whether new articles have arrived in the current group
4072 (@code{gnus-group-get-new-news-this-group}).
4073 @code{gnus-goto-next-group-when-activating} says whether this command is
4074 to move point to the next group or not.  It is @code{t} by default.
4075
4076 @findex gnus-activate-all-groups
4077 @cindex activating groups
4078 @item C-c M-g
4079 @kindex C-c M-g (Group)
4080 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4081
4082 @item R
4083 @kindex R (Group)
4084 @cindex restarting
4085 @findex gnus-group-restart
4086 Restart gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
4087 file(s), closes the connection to all servers, clears up all run-time
4088 gnus variables, and then starts gnus all over again.
4089
4090 @end table
4091
4092 @vindex gnus-get-new-news-hook
4093 @code{gnus-get-new-news-hook} is run just before checking for new news.
4094
4095 @vindex gnus-after-getting-new-news-hook
4096 @code{gnus-after-getting-new-news-hook} is run after checking for new
4097 news.
4098
4099
4100 @node Group Information
4101 @subsection Group Information
4102 @cindex group information
4103 @cindex information on groups
4104
4105 @table @kbd
4106
4107
4108 @item H f
4109 @kindex H f (Group)
4110 @findex gnus-group-fetch-faq
4111 @vindex gnus-group-faq-directory
4112 @cindex FAQ
4113 @cindex ange-ftp
4114 Try to fetch the FAQ for the current group
4115 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
4116 @code{gnus-group-faq-directory}, which is usually a directory on a
4117 remote machine.  This variable can also be a list of directories.  In
4118 that case, giving a prefix to this command will allow you to choose
4119 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
4120 for fetching the file.
4121
4122 If fetching from the first site is unsuccessful, gnus will attempt to go
4123 through @code{gnus-group-faq-directory} and try to open them one by one.
4124
4125 @item H c
4126 @kindex H c (Group)
4127 @findex gnus-group-fetch-charter
4128 @vindex gnus-group-charter-alist
4129 @cindex charter
4130 Try to open the charter for the current group in a web browser
4131 (@code{gnus-group-fetch-charter}).  Query for a group if given a
4132 prefix argument.
4133
4134 Gnus will use @code{gnus-group-charter-alist} to find the location of
4135 the charter.  If no location is known, Gnus will fetch the control
4136 messages for the group, which in some cases includes the charter.
4137
4138 @item H C
4139 @kindex H C (Group)
4140 @findex gnus-group-fetch-control
4141 @vindex gnus-group-fetch-control-use-browse-url
4142 @cindex control message
4143 Fetch the control messages for the group from the archive at
4144 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4145 group if given a prefix argument.
4146
4147 If @code{gnus-group-fetch-control-use-browse-url} is non-nil, Gnus
4148 will open the control messages in a browser using @code{browse-url}.
4149 Otherwise they are fetched using @code{ange-ftp} and displayed in an
4150 ephemeral group.
4151
4152 Note that the control messages are compressed.  To use this command
4153 you need to turn on @code{auto-compression-mode}
4154 (@pxref{(emacs)Compressed Files}).
4155
4156 @item H d
4157 @itemx C-c C-d
4158 @c @icon{gnus-group-describe-group}
4159 @kindex H d (Group)
4160 @kindex C-c C-d (Group)
4161 @cindex describing groups
4162 @cindex group description
4163 @findex gnus-group-describe-group
4164 Describe the current group (@code{gnus-group-describe-group}).  If given
4165 a prefix, force Gnus to re-read the description from the server.
4166
4167 @item M-d
4168 @kindex M-d (Group)
4169 @findex gnus-group-describe-all-groups
4170 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
4171 prefix, force gnus to re-read the description file from the server.
4172
4173 @item H v
4174 @itemx V
4175 @kindex V (Group)
4176 @kindex H v (Group)
4177 @cindex version
4178 @findex gnus-version
4179 Display current gnus version numbers (@code{gnus-version}).
4180
4181 @item ?
4182 @kindex ? (Group)
4183 @findex gnus-group-describe-briefly
4184 Give a very short help message (@code{gnus-group-describe-briefly}).
4185
4186 @item C-c C-i
4187 @kindex C-c C-i (Group)
4188 @cindex info
4189 @cindex manual
4190 @findex gnus-info-find-node
4191 Go to the gnus info node (@code{gnus-info-find-node}).
4192 @end table
4193
4194
4195 @node Group Timestamp
4196 @subsection Group Timestamp
4197 @cindex timestamps
4198 @cindex group timestamps
4199
4200 It can be convenient to let gnus keep track of when you last read a
4201 group.  To set the ball rolling, you should add
4202 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4203
4204 @lisp
4205 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4206 @end lisp
4207
4208 After doing this, each time you enter a group, it'll be recorded.
4209
4210 This information can be displayed in various ways---the easiest is to
4211 use the @samp{%d} spec in the group line format:
4212
4213 @lisp
4214 (setq gnus-group-line-format
4215       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4216 @end lisp
4217
4218 This will result in lines looking like:
4219
4220 @example
4221 *        0: mail.ding                                19961002T012943
4222          0: custom                                   19961002T012713
4223 @end example
4224
4225 As you can see, the date is displayed in compact ISO 8601 format.  This
4226 may be a bit too much, so to just display the date, you could say
4227 something like:
4228
4229 @lisp
4230 (setq gnus-group-line-format
4231       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4232 @end lisp
4233
4234 If you would like greater control of the time format, you can use a
4235 user-defined format spec.  Something like the following should do the
4236 trick:
4237
4238 @lisp
4239 (setq gnus-group-line-format
4240       "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4241 (defun gnus-user-format-function-d (headers)
4242   (let ((time (gnus-group-timestamp gnus-tmp-group)))
4243     (if time
4244         (format-time-string "%b %d  %H:%M" time)
4245       "")))
4246 @end lisp
4247
4248
4249 @node File Commands
4250 @subsection File Commands
4251 @cindex file commands
4252
4253 @table @kbd
4254
4255 @item r
4256 @kindex r (Group)
4257 @findex gnus-group-read-init-file
4258 @vindex gnus-init-file
4259 @cindex reading init file
4260 Re-read the init file (@code{gnus-init-file}, which defaults to
4261 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
4262
4263 @item s
4264 @kindex s (Group)
4265 @findex gnus-group-save-newsrc
4266 @cindex saving .newsrc
4267 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4268 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
4269 file(s) whether Gnus thinks it is necessary or not.
4270
4271 @c @item Z
4272 @c @kindex Z (Group)
4273 @c @findex gnus-group-clear-dribble
4274 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4275
4276 @end table
4277
4278
4279 @node Sieve Commands
4280 @subsection Sieve Commands
4281 @cindex group sieve commands
4282
4283 Sieve is a server-side mail filtering language.  In Gnus you can use
4284 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4285 sieve rules that should apply to each group.  Gnus provides two
4286 commands to translate all these group parameters into a proper Sieve
4287 script that can be transfered to the server somehow.
4288
4289 @vindex gnus-sieve-file
4290 @vindex gnus-sieve-region-start
4291 @vindex gnus-sieve-region-end
4292 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4293 default @file{~/.sieve}).  The Sieve code that Gnus generate is placed
4294 between two delimiters, @code{gnus-sieve-region-start} and
4295 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4296 outside these delimiters that will not be removed the next time you
4297 regenerate the Sieve script.
4298
4299 @vindex gnus-sieve-crosspost
4300 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4301 is generated.  If it is non-nil (the default) articles is placed in
4302 all groups that have matching rules, otherwise the article is only
4303 placed in the group with the first matching rule.  For example, the
4304 group parameter @samp{(sieve address "sender"
4305 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4306 code if @code{gnus-sieve-crosspost} is nil. (When
4307 @code{gnus-sieve-crosspost} is non-nil, it looks the same except that
4308 the line containing the call to @code{stop} is removed.)
4309
4310 @example
4311 if address "sender" "owner-ding@@hpc.uh.edu" @{
4312         fileinto "INBOX.ding";
4313         stop;
4314 @}
4315 @end example
4316
4317 @xref{Top, ,Top, sieve, Emacs Sieve}.
4318
4319 @table @kbd
4320
4321 @item D g
4322 @kindex D g (Group)
4323 @findex gnus-sieve-generate
4324 @vindex gnus-sieve-file
4325 @cindex generating sieve script
4326 Regenerate a Sieve script from the @code{sieve} group parameters and
4327 put you into the @code{gnus-sieve-file} without saving it.
4328
4329 @item D u
4330 @kindex D u (Group)
4331 @findex gnus-sieve-update
4332 @vindex gnus-sieve-file
4333 @cindex updating sieve script
4334 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4335 @code{sieve} group parameters, save the file and upload it to the
4336 server using the @code{sieveshell} program.
4337
4338 @end table
4339
4340
4341 @node Summary Buffer
4342 @chapter Summary Buffer
4343 @cindex summary buffer
4344
4345 A line for each article is displayed in the summary buffer.  You can
4346 move around, read articles, post articles and reply to articles.
4347
4348 The most common way to a summary buffer is to select a group from the
4349 group buffer (@pxref{Selecting a Group}).
4350
4351 You can have as many summary buffers open as you wish.
4352
4353 @menu
4354 * Summary Buffer Format::       Deciding how the summary buffer is to look.
4355 * Summary Maneuvering::         Moving around the summary buffer.
4356 * Choosing Articles::           Reading articles.
4357 * Paging the Article::          Scrolling the current article.
4358 * Reply Followup and Post::     Posting articles.
4359 * Delayed Articles::            Send articles at a later time.
4360 * Marking Articles::            Marking articles as read, expirable, etc.
4361 * Limiting::                    You can limit the summary buffer.
4362 * Threading::                   How threads are made.
4363 * Sorting the Summary Buffer::  How articles and threads are sorted.
4364 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
4365 * Article Caching::             You may store articles in a cache.
4366 * Persistent Articles::         Making articles expiry-resistant.
4367 * Article Backlog::             Having already read articles hang around.
4368 * Saving Articles::             Ways of customizing article saving.
4369 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
4370 * Article Treatment::           The article buffer can be mangled at will.
4371 * MIME Commands::               Doing MIMEy things with the articles.
4372 * Charsets::                    Character set issues.
4373 * Article Commands::            Doing various things with the article buffer.
4374 * Summary Sorting::             Sorting the summary buffer in various ways.
4375 * Finding the Parent::          No child support? Get the parent.
4376 * Alternative Approaches::      Reading using non-default summaries.
4377 * Tree Display::                A more visual display of threads.
4378 * Mail Group Commands::         Some commands can only be used in mail groups.
4379 * Various Summary Stuff::       What didn't fit anywhere else.
4380 * Exiting the Summary Buffer::  Returning to the Group buffer,
4381                                 or reselecting the current group.
4382 * Crosspost Handling::          How crossposted articles are dealt with.
4383 * Duplicate Suppression::       An alternative when crosspost handling fails.
4384 * Security::                    Decrypt and Verify.
4385 * Mailing List::                Mailing list minor mode.
4386 @end menu
4387
4388
4389 @node Summary Buffer Format
4390 @section Summary Buffer Format
4391 @cindex summary buffer format
4392
4393 @iftex
4394 @iflatex
4395 \gnusfigure{The Summary Buffer}{180}{
4396 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4397 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4398 }
4399 @end iflatex
4400 @end iftex
4401
4402 @menu
4403 * Summary Buffer Lines::        You can specify how summary lines should look.
4404 * To From Newsgroups::          How to not display your own name.
4405 * Summary Buffer Mode Line::    You can say how the mode line should look.
4406 * Summary Highlighting::        Making the summary buffer all pretty and nice.
4407 @end menu
4408
4409 @findex mail-extract-address-components
4410 @findex gnus-extract-address-components
4411 @vindex gnus-extract-address-components
4412 Gnus will use the value of the @code{gnus-extract-address-components}
4413 variable as a function for getting the name and address parts of a
4414 @code{From} header.  Three pre-defined functions exist:
4415 @code{gnus-extract-address-components}, which is the default, quite
4416 fast, and too simplistic solution;
4417 @code{mail-extract-address-components}, which works nicely, but is
4418 slower; and @code{std11-extract-address-components}, which works very
4419 nicely, but is slower.  The default function will return the wrong
4420 answer in 5% of the cases.  If this is unacceptable to you, use the
4421 other function instead:
4422
4423 @lisp
4424 (setq gnus-extract-address-components
4425       'mail-extract-address-components)
4426 @end lisp
4427
4428 @vindex gnus-summary-same-subject
4429 @code{gnus-summary-same-subject} is a string indicating that the current
4430 article has the same subject as the previous.  This string will be used
4431 with those specs that require it.  The default is @code{""}.
4432
4433
4434 @node Summary Buffer Lines
4435 @subsection Summary Buffer Lines
4436
4437 @vindex gnus-summary-line-format
4438 You can change the format of the lines in the summary buffer by changing
4439 the @code{gnus-summary-line-format} variable.  It works along the same
4440 lines as a normal @code{format} string, with some extensions
4441 (@pxref{Formatting Variables}).
4442
4443 There should always be a colon or a point position marker on the line;
4444 the cursor always moves to the point position marker or the colon after
4445 performing an operation.  (Of course, Gnus wouldn't be Gnus if it wasn't
4446 possible to change this.  Just write a new function
4447 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4448 @xref{Positioning Point}.
4449
4450 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4451
4452 The following format specification characters and extended format
4453 specification(s) are understood:
4454
4455 @table @samp
4456 @item N
4457 Article number.
4458 @item S
4459 Subject string.  List identifiers stripped,
4460 @code{gnus-list-identifies}.  @xref{Article Hiding}.
4461 @item s
4462 Subject if the article is the root of the thread or the previous article
4463 had a different subject, @code{gnus-summary-same-subject} otherwise.
4464 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4465 @item F
4466 Full @code{From} header.
4467 @item n
4468 The name (from the @code{From} header).
4469 @item f
4470 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4471 From Newsgroups}).
4472 @item a
4473 The name (from the @code{From} header).  This differs from the @code{n}
4474 spec in that it uses the function designated by the
4475 @code{gnus-extract-address-components} variable, which is slower, but
4476 may be more thorough.
4477 @item A
4478 The address (from the @code{From} header).  This works the same way as
4479 the @code{a} spec.
4480 @item L
4481 Number of lines in the article.
4482 @item c
4483 Number of characters in the article. This specifier is not supported
4484 in some methods (like nnfolder).
4485 @item k
4486 Pretty-printed version of the number of characters in the article;
4487 for example, @samp{1.2k} or @samp{0.4M}.
4488 @item I
4489 Indentation based on thread level (@pxref{Customizing Threading}).
4490 @item B
4491 A complex trn-style thread tree, showing response-connecting trace
4492 lines.
4493 @item T
4494 Nothing if the article is a root and lots of spaces if it isn't (it
4495 pushes everything after it off the screen).
4496 @item [
4497 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4498 for adopted articles (@pxref{Customizing Threading}).
4499 @item ]
4500 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4501 for adopted articles.
4502 @item >
4503 One space for each thread level.
4504 @item <
4505 Twenty minus thread level spaces.
4506 @item U
4507 Unread. @xref{Read Articles}.
4508
4509 @item R
4510 This misleadingly named specifier is the @dfn{secondary mark}.  This
4511 mark will say whether the article has been replied to, has been cached,
4512 or has been saved.  @xref{Other Marks}.
4513
4514 @item i
4515 Score as a number (@pxref{Scoring}).
4516 @item z
4517 @vindex gnus-summary-zcore-fuzz
4518 Zcore, @samp{+} if above the default level and @samp{-} if below the
4519 default level.  If the difference between
4520 @code{gnus-summary-default-score} and the score is less than
4521 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4522 @item V
4523 Total thread score.
4524 @item x
4525 @code{Xref}.
4526 @item D
4527 @code{Date}.
4528 @item d
4529 The @code{Date} in @code{DD-MMM} format.
4530 @item o
4531 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4532 @item M
4533 @code{Message-ID}.
4534 @item r
4535 @code{References}.
4536 @item t
4537 Number of articles in the current sub-thread.  Using this spec will slow
4538 down summary buffer generation somewhat.
4539 @item e
4540 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4541 article has any children.
4542 @item P
4543 The line number.
4544 @item O
4545 Download mark.
4546 @item &user-date;
4547 Age sensitive date format.  Various date format is defined in
4548 @code{gnus-user-date-format-alist}.
4549 @item u
4550 User defined specifier.  The next character in the format string should
4551 be a letter.  Gnus will call the function
4552 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4553 following @samp{%u}.  The function will be passed the current header as
4554 argument.  The function should return a string, which will be inserted
4555 into the summary just like information from any other summary specifier.
4556 @end table
4557
4558 Text between @samp{%(} and @samp{%)} will be highlighted with
4559 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4560 There can only be one such area.
4561
4562 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4563 have to be handled with care.  For reasons of efficiency, gnus will
4564 compute what column these characters will end up in, and ``hard-code''
4565 that.  This means that it is invalid to have these specs after a
4566 variable-length spec.  Well, you might not be arrested, but your summary
4567 buffer will look strange, which is bad enough.
4568
4569 The smart choice is to have these specs as far to the left as possible.
4570 (Isn't that the case with everything, though?  But I digress.)
4571
4572 This restriction may disappear in later versions of gnus.
4573
4574
4575 @node To From Newsgroups
4576 @subsection To From Newsgroups
4577 @cindex To
4578 @cindex Newsgroups
4579
4580 In some groups (particularly in archive groups), the @code{From} header
4581 isn't very interesting, since all the articles there are written by
4582 you.  To display the information in the @code{To} or @code{Newsgroups}
4583 headers instead, you need to decide three things: What information to
4584 gather; where to display it; and when to display it.
4585
4586 @enumerate
4587 @item
4588 @vindex gnus-extra-headers
4589 The reading of extra header information is controlled by the
4590 @code{gnus-extra-headers}.  This is a list of header symbols.  For
4591 instance:
4592
4593 @lisp
4594 (setq gnus-extra-headers
4595       '(To Newsgroups X-Newsreader))
4596 @end lisp
4597
4598 This will result in Gnus trying to obtain these three headers, and
4599 storing it in header structures for later easy retrieval.
4600
4601 @item
4602 @findex gnus-extra-header
4603 The value of these extra headers can be accessed via the
4604 @code{gnus-extra-header} function.  Here's a format line spec that will
4605 access the @code{X-Newsreader} header:
4606
4607 @example
4608 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4609 @end example
4610
4611 @item
4612 @vindex gnus-ignored-from-addresses
4613 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4614 summary line spec returns the @code{To}, @code{Newsreader} or
4615 @code{From} header.  If this regexp matches the contents of the
4616 @code{From} header, the value of the @code{To} or @code{Newsreader}
4617 headers are used instead.
4618
4619 @end enumerate
4620
4621 @vindex nnmail-extra-headers
4622 A related variable is @code{nnmail-extra-headers}, which controls when
4623 to include extra headers when generating overview (@sc{nov}) files.  If
4624 you have old overview files, you should regenerate them after changing
4625 this variable, by entering the server buffer using `^', and then `g' on
4626 the appropriate mail server (e.g. nnml) to cause regeneration.
4627
4628 @vindex gnus-summary-line-format
4629 You also have to instruct Gnus to display the data by changing the
4630 @code{%n} spec to the @code{%f} spec in the
4631 @code{gnus-summary-line-format} variable.
4632
4633 In summary, you'd typically put something like the following in
4634 @file{~/.gnus}:
4635
4636 @lisp
4637 (setq gnus-extra-headers
4638       '(To Newsgroups))
4639 (setq nnmail-extra-headers gnus-extra-headers)
4640 (setq gnus-summary-line-format
4641       "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4642 (setq gnus-ignored-from-addresses
4643       "Your Name Here")
4644 @end lisp
4645
4646 (The values listed above are the default values in Gnus.  Alter them
4647 to fit your needs.)
4648
4649 A note for news server administrators, or for users who wish to try to
4650 convince their news server administrator to provide some additional
4651 support:
4652
4653 The above is mostly useful for mail groups, where you have control over
4654 the @sc{nov} files that are created.  However, if you can persuade your
4655 nntp admin to add (in the usual implementation, notably INN):
4656
4657 @example
4658 Newsgroups:full
4659 @end example
4660
4661 to the end of her @file{overview.fmt} file, then you can use that just
4662 as you would the extra headers from the mail groups.
4663
4664
4665 @node Summary Buffer Mode Line
4666 @subsection Summary Buffer Mode Line
4667
4668 @vindex gnus-summary-mode-line-format
4669 You can also change the format of the summary mode bar (@pxref{Mode Line
4670 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
4671 like.  The default is @samp{Gnus: %%b [%A] %Z}.
4672
4673 Here are the elements you can play with:
4674
4675 @table @samp
4676 @item G
4677 Group name.
4678 @item p
4679 Unprefixed group name.
4680 @item A
4681 Current article number.
4682 @item z
4683 Current article score.
4684 @item V
4685 Gnus version.
4686 @item U
4687 Number of unread articles in this group.
4688 @item e
4689 Number of unread articles in this group that aren't displayed in the
4690 summary buffer.
4691 @item Z
4692 A string with the number of unread and unselected articles represented
4693 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4694 articles, and just as @samp{<%U more>} if there are just unread articles
4695 and no unselected ones.
4696 @item g
4697 Shortish group name.  For instance, @samp{rec.arts.anime} will be
4698 shortened to @samp{r.a.anime}.
4699 @item S
4700 Subject of the current article.
4701 @item u
4702 User-defined spec (@pxref{User-Defined Specs}).
4703 @item s
4704 Name of the current score file (@pxref{Scoring}).
4705 @item d
4706 Number of dormant articles (@pxref{Unread Articles}).
4707 @item t
4708 Number of ticked articles (@pxref{Unread Articles}).
4709 @item r
4710 Number of articles that have been marked as read in this session.
4711 @item E
4712 Number of articles expunged by the score files.
4713 @end table
4714
4715
4716 @node Summary Highlighting
4717 @subsection Summary Highlighting
4718
4719 @table @code
4720
4721 @item gnus-visual-mark-article-hook
4722 @vindex gnus-visual-mark-article-hook
4723 This hook is run after selecting an article.  It is meant to be used for
4724 highlighting the article in some way.  It is not run if
4725 @code{gnus-visual} is @code{nil}.
4726
4727 @item gnus-summary-update-hook
4728 @vindex gnus-summary-update-hook
4729 This hook is called when a summary line is changed.  It is not run if
4730 @code{gnus-visual} is @code{nil}.
4731
4732 @item gnus-summary-selected-face
4733 @vindex gnus-summary-selected-face
4734 This is the face (or @dfn{font} as some people call it) used to
4735 highlight the current article in the summary buffer.
4736
4737 @item gnus-summary-highlight
4738 @vindex gnus-summary-highlight
4739 Summary lines are highlighted according to this variable, which is a
4740 list where the elements are of the format @code{(@var{form}
4741 . @var{face})}.  If you would, for instance, like ticked articles to be
4742 italic and high-scored articles to be bold, you could set this variable
4743 to something like
4744 @lisp
4745 (((eq mark gnus-ticked-mark) . italic)
4746  ((> score default) . bold))
4747 @end lisp
4748 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4749 @var{face} will be applied to the line.
4750 @end table
4751
4752
4753 @node Summary Maneuvering
4754 @section Summary Maneuvering
4755 @cindex summary movement
4756
4757 All the straight movement commands understand the numeric prefix and
4758 behave pretty much as you'd expect.
4759
4760 None of these commands select articles.
4761
4762 @table @kbd
4763 @item G M-n
4764 @itemx M-n
4765 @kindex M-n (Summary)
4766 @kindex G M-n (Summary)
4767 @findex gnus-summary-next-unread-subject
4768 Go to the next summary line of an unread article
4769 (@code{gnus-summary-next-unread-subject}).
4770
4771 @item G M-p
4772 @itemx M-p
4773 @kindex M-p (Summary)
4774 @kindex G M-p (Summary)
4775 @findex gnus-summary-prev-unread-subject
4776 Go to the previous summary line of an unread article
4777 (@code{gnus-summary-prev-unread-subject}).
4778
4779 @item G g
4780 @kindex G g (Summary)
4781 @findex gnus-summary-goto-subject
4782 Ask for an article number and then go to the summary line of that article
4783 without displaying the article (@code{gnus-summary-goto-subject}).
4784 @end table
4785
4786 If gnus asks you to press a key to confirm going to the next group, you
4787 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4788 buffer, searching for the next group to read without actually returning
4789 to the group buffer.
4790
4791 Variables related to summary movement:
4792
4793 @table @code
4794
4795 @vindex gnus-auto-select-next
4796 @item gnus-auto-select-next
4797 If you issue one of the movement commands (like @kbd{n}) and there are
4798 no more unread articles after the current one, gnus will offer to go to
4799 the next group.  If this variable is @code{t} and the next group is
4800 empty, gnus will exit summary mode and return to the group buffer.  If
4801 this variable is neither @code{t} nor @code{nil}, gnus will select the
4802 next group with unread articles.  As a special case, if this variable
4803 is @code{quietly}, Gnus will select the next group without asking for
4804 confirmation.  If this variable is @code{almost-quietly}, the same
4805 will happen only if you are located on the last article in the group.
4806 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
4807 command will go to the next group without confirmation.  Also
4808 @pxref{Group Levels}.
4809
4810 @item gnus-auto-select-same
4811 @vindex gnus-auto-select-same
4812 If non-@code{nil}, all the movement commands will try to go to the next
4813 article with the same subject as the current.  (@dfn{Same} here might
4814 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
4815 for details (@pxref{Customizing Threading}).)  If there are no more
4816 articles with the same subject, go to the first unread article.
4817
4818 This variable is not particularly useful if you use a threaded display.
4819
4820 @item gnus-summary-check-current
4821 @vindex gnus-summary-check-current
4822 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4823 to the next (or previous) article if the current article is unread.
4824 Instead, they will choose the current article.
4825
4826 @item gnus-auto-center-summary
4827 @vindex gnus-auto-center-summary
4828 If non-@code{nil}, gnus will keep the point in the summary buffer
4829 centered at all times.  This makes things quite tidy, but if you have a
4830 slow network connection, or simply do not like this un-Emacsism, you can
4831 set this variable to @code{nil} to get the normal Emacs scrolling
4832 action.  This will also inhibit horizontal re-centering of the summary
4833 buffer, which might make it more inconvenient to read extremely long
4834 threads.
4835
4836 This variable can also be a number.  In that case, center the window at
4837 the given number of lines from the top.
4838
4839 @end table
4840
4841
4842 @node Choosing Articles
4843 @section Choosing Articles
4844 @cindex selecting articles
4845
4846 @menu
4847 * Choosing Commands::           Commands for choosing articles.
4848 * Choosing Variables::          Variables that influence these commands.
4849 @end menu
4850
4851
4852 @node Choosing Commands
4853 @subsection Choosing Commands
4854
4855 None of the following movement commands understand the numeric prefix,
4856 and they all select and display an article.
4857
4858 If you want to fetch new articles or redisplay the group, see
4859 @ref{Exiting the Summary Buffer}.
4860
4861 @table @kbd
4862 @item SPACE
4863 @kindex SPACE (Summary)
4864 @findex gnus-summary-next-page
4865 Select the current article, or, if that one's read already, the next
4866 unread article (@code{gnus-summary-next-page}).
4867
4868 @item G n
4869 @itemx n
4870 @kindex n (Summary)
4871 @kindex G n (Summary)
4872 @findex gnus-summary-next-unread-article
4873 @c @icon{gnus-summary-next-unread}
4874 Go to next unread article (@code{gnus-summary-next-unread-article}).
4875
4876 @item G p
4877 @itemx p
4878 @kindex p (Summary)
4879 @findex gnus-summary-prev-unread-article
4880 @c @icon{gnus-summary-prev-unread}
4881 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4882
4883 @item G N
4884 @itemx N
4885 @kindex N (Summary)
4886 @kindex G N (Summary)
4887 @findex gnus-summary-next-article
4888 Go to the next article (@code{gnus-summary-next-article}).
4889
4890 @item G P
4891 @itemx P
4892 @kindex P (Summary)
4893 @kindex G P (Summary)
4894 @findex gnus-summary-prev-article
4895 Go to the previous article (@code{gnus-summary-prev-article}).
4896
4897 @item G C-n
4898 @kindex G C-n (Summary)
4899 @findex gnus-summary-next-same-subject
4900 Go to the next article with the same subject
4901 (@code{gnus-summary-next-same-subject}).
4902
4903 @item G C-p
4904 @kindex G C-p (Summary)
4905 @findex gnus-summary-prev-same-subject
4906 Go to the previous article with the same subject
4907 (@code{gnus-summary-prev-same-subject}).
4908
4909 @item G f
4910 @itemx .
4911 @kindex G f  (Summary)
4912 @kindex .  (Summary)
4913 @findex gnus-summary-first-unread-article
4914 Go to the first unread article
4915 (@code{gnus-summary-first-unread-article}).
4916
4917 @item G b
4918 @itemx ,
4919 @kindex G b (Summary)
4920 @kindex , (Summary)
4921 @findex gnus-summary-best-unread-article
4922 Go to the unread article with the highest score
4923 (@code{gnus-summary-best-unread-article}).  If given a prefix argument,
4924 go to the first unread article that has a score over the default score.
4925
4926 @item G l
4927 @itemx l
4928 @kindex l (Summary)
4929 @kindex G l (Summary)
4930 @findex gnus-summary-goto-last-article
4931 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4932
4933 @item G o
4934 @kindex G o (Summary)
4935 @findex gnus-summary-pop-article
4936 @cindex history
4937 @cindex article history
4938 Pop an article off the summary history and go to this article
4939 (@code{gnus-summary-pop-article}).  This command differs from the
4940 command above in that you can pop as many previous articles off the
4941 history as you like, while @kbd{l} toggles the two last read articles.
4942 For a somewhat related issue (if you use these commands a lot),
4943 @pxref{Article Backlog}.
4944
4945 @item G j
4946 @itemx j
4947 @kindex j (Summary)
4948 @kindex G j (Summary)
4949 @findex gnus-summary-goto-article
4950 Ask for an article number or @code{Message-ID}, and then go to that
4951 article (@code{gnus-summary-goto-article}).
4952
4953 @end table
4954
4955
4956 @node Choosing Variables
4957 @subsection Choosing Variables
4958
4959 Some variables relevant for moving and selecting articles:
4960
4961 @table @code
4962 @item gnus-auto-extend-newsgroup
4963 @vindex gnus-auto-extend-newsgroup
4964 All the movement commands will try to go to the previous (or next)
4965 article, even if that article isn't displayed in the Summary buffer if
4966 this variable is non-@code{nil}.  Gnus will then fetch the article from
4967 the server and display it in the article buffer.
4968
4969 @item gnus-select-article-hook
4970 @vindex gnus-select-article-hook
4971 This hook is called whenever an article is selected.  By default it
4972 exposes any threads hidden under the selected article.
4973
4974 @item gnus-mark-article-hook
4975 @vindex gnus-mark-article-hook
4976 @findex gnus-summary-mark-unread-as-read
4977 @findex gnus-summary-mark-read-and-unread-as-read
4978 @findex gnus-unread-mark
4979 This hook is called whenever an article is selected.  It is intended to
4980 be used for marking articles as read.  The default value is
4981 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4982 mark of almost any article you read to @code{gnus-unread-mark}.  The
4983 only articles not affected by this function are ticked, dormant, and
4984 expirable articles.  If you'd instead like to just have unread articles
4985 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4986 instead.  It will leave marks like @code{gnus-low-score-mark},
4987 @code{gnus-del-mark} (and so on) alone.
4988
4989 @end table
4990
4991
4992 @node Paging the Article
4993 @section Scrolling the Article
4994 @cindex article scrolling
4995
4996 @table @kbd
4997
4998 @item SPACE
4999 @kindex SPACE (Summary)
5000 @findex gnus-summary-next-page
5001 Pressing @kbd{SPACE} will scroll the current article forward one page,
5002 or, if you have come to the end of the current article, will choose the
5003 next article (@code{gnus-summary-next-page}).
5004
5005 @item DEL
5006 @kindex DEL (Summary)
5007 @findex gnus-summary-prev-page
5008 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5009
5010 @item RET
5011 @kindex RET (Summary)
5012 @findex gnus-summary-scroll-up
5013 Scroll the current article one line forward
5014 (@code{gnus-summary-scroll-up}).
5015
5016 @item M-RET
5017 @kindex M-RET (Summary)
5018 @findex gnus-summary-scroll-down
5019 Scroll the current article one line backward
5020 (@code{gnus-summary-scroll-down}).
5021
5022 @item A g
5023 @itemx g
5024 @kindex A g (Summary)
5025 @kindex g (Summary)
5026 @findex gnus-summary-show-article
5027 @vindex gnus-summary-show-article-charset-alist
5028 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
5029 given a prefix, fetch the current article, but don't run any of the
5030 article treatment functions.  This will give you a ``raw'' article, just
5031 the way it came from the server.
5032
5033 If given a numerical prefix, you can do semi-manual charset stuff.
5034 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5035 encoded in the @code{cn-gb-2312} charset.  If you have
5036
5037 @lisp
5038 (setq gnus-summary-show-article-charset-alist
5039       '((1 . cn-gb-2312)
5040         (2 . big5)))
5041 @end lisp
5042
5043 then you can say @kbd{C-u 1 g} to get the same effect.
5044
5045 @item A <
5046 @itemx <
5047 @kindex < (Summary)
5048 @kindex A < (Summary)
5049 @findex gnus-summary-beginning-of-article
5050 Scroll to the beginning of the article
5051 (@code{gnus-summary-beginning-of-article}).
5052
5053 @item A >
5054 @itemx >
5055 @kindex > (Summary)
5056 @kindex A > (Summary)
5057 @findex gnus-summary-end-of-article
5058 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5059
5060 @item A s
5061 @itemx s
5062 @kindex A s (Summary)
5063 @kindex s (Summary)
5064 @findex gnus-summary-isearch-article
5065 Perform an isearch in the article buffer
5066 (@code{gnus-summary-isearch-article}).
5067
5068 @item h
5069 @kindex h (Summary)
5070 @findex gnus-summary-select-article-buffer
5071 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5072
5073 @end table
5074
5075
5076 @node Reply Followup and Post
5077 @section Reply, Followup and Post
5078
5079 @menu
5080 * Summary Mail Commands::       Sending mail.
5081 * Summary Post Commands::       Sending news.
5082 * Summary Message Commands::    Other Message-related commands.
5083 * Canceling and Superseding::   
5084 @end menu
5085
5086
5087 @node Summary Mail Commands
5088 @subsection Summary Mail Commands
5089 @cindex mail
5090 @cindex composing mail
5091
5092 Commands for composing a mail message:
5093
5094 @table @kbd
5095
5096 @item S r
5097 @itemx r
5098 @kindex S r (Summary)
5099 @kindex r (Summary)
5100 @findex gnus-summary-reply
5101 @c @icon{gnus-summary-mail-reply}
5102 @c @icon{gnus-summary-reply}
5103 Mail a reply to the author of the current article
5104 (@code{gnus-summary-reply}).
5105
5106 @item S R
5107 @itemx R
5108 @kindex R (Summary)
5109 @kindex S R (Summary)
5110 @findex gnus-summary-reply-with-original
5111 @c @icon{gnus-summary-reply-with-original}
5112 Mail a reply to the author of the current article and include the
5113 original message (@code{gnus-summary-reply-with-original}).  This
5114 command uses the process/prefix convention.
5115
5116 @item S w
5117 @kindex S w (Summary)
5118 @findex gnus-summary-wide-reply
5119 Mail a wide reply to the author of the current article
5120 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
5121 goes out to all people listed in the @code{To}, @code{From} (or
5122 @code{Reply-to}) and @code{Cc} headers.
5123
5124 @item S W
5125 @kindex S W (Summary)
5126 @findex gnus-summary-wide-reply-with-original
5127 Mail a wide reply to the current article and include the original
5128 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
5129 the process/prefix convention.
5130
5131 @item S v
5132 @kindex S v (Summary)
5133 @findex gnus-summary-very-wide-reply
5134 Mail a very wide reply to the author of the current article
5135 (@code{gnus-summary-wide-reply}).  A @dfn{very wide reply} is a reply
5136 that goes out to all people listed in the @code{To}, @code{From} (or
5137 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5138 articles.  This command uses the process/prefix convention.
5139
5140 @item S V
5141 @kindex S V (Summary)
5142 @findex gnus-summary-very-wide-reply-with-original
5143 Mail a very wide reply to the author of the current article and include the
5144 original message (@code{gnus-summary-very-wide-reply-with-original}).  This
5145 command uses the process/prefix convention.
5146
5147 @item S B r
5148 @kindex S B r (Summary)
5149 @findex gnus-summary-reply-broken-reply-to
5150 Mail a reply to the author of the current article but ignore the
5151 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5152
5153 @item S B R
5154 @kindex S B R (Summary)
5155 @findex gnus-summary-reply-broken-reply-to-with-original
5156 Mail a reply to the author of the current article and include the
5157 original message but ignore the @code{Reply-To} field
5158 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5159
5160 @item S o m
5161 @itemx C-c C-f
5162 @kindex S o m (Summary)
5163 @kindex C-c C-f (Summary)
5164 @findex gnus-summary-mail-forward
5165 @c @icon{gnus-summary-mail-forward}
5166 Forward the current article to some other person
5167 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
5168 headers of the forwarded article.
5169
5170 @item S m
5171 @itemx m
5172 @kindex m (Summary)
5173 @kindex S m (Summary)
5174 @findex gnus-summary-mail-other-window
5175 @c @icon{gnus-summary-mail-originate}
5176 Prepare a mail (@code{gnus-summary-mail-other-window}).  By default, use
5177 the posting style of the current group.  If given a prefix, disable that.
5178 If the prefix is 1, prompt for a group name to find the posting style.
5179
5180 @item S i
5181 @itemx i
5182 @kindex i (Summary)
5183 @kindex S i (Summary)
5184 @findex gnus-summary-news-other-window
5185 Prepare a news (@code{gnus-summary-news-other-window}).  By default,
5186 post to the current group.  If given a prefix, disable that.  If the
5187 prefix is 1, prompt for a group to post to.
5188
5189 This function actually prepares a news even when using mail groups.
5190 This is useful for "posting" messages to mail groups without actually
5191 sending them over the network: they're just saved directly to the group
5192 in question.  The corresponding back end must have a request-post method
5193 for this to work though.
5194
5195 @item S D b
5196 @kindex S D b (Summary)
5197 @findex gnus-summary-resend-bounced-mail
5198 @cindex bouncing mail
5199 If you have sent a mail, but the mail was bounced back to you for some
5200 reason (wrong address, transient failure), you can use this command to
5201 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
5202 will be popped into a mail buffer where you can edit the headers before
5203 sending the mail off again.  If you give a prefix to this command, and
5204 the bounced mail is a reply to some other mail, gnus will try to fetch
5205 that mail and display it for easy perusal of its headers.  This might
5206 very well fail, though.
5207
5208 @item S D r
5209 @kindex S D r (Summary)
5210 @findex gnus-summary-resend-message
5211 Not to be confused with the previous command,
5212 @code{gnus-summary-resend-message} will prompt you for an address to
5213 send the current message off to, and then send it to that place.  The
5214 headers of the message won't be altered---but lots of headers that say
5215 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
5216 means that you actually send a mail to someone that has a @code{To}
5217 header that (probably) points to yourself.  This will confuse people.
5218 So, natcherly you'll only do that if you're really eVIl.
5219
5220 This command is mainly used if you have several accounts and want to
5221 ship a mail to a different account of yours.  (If you're both
5222 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5223 to the @code{root} account, you may want to resend it to
5224 @code{postmaster}.  Ordnung muss sein!
5225
5226 This command understands the process/prefix convention
5227 (@pxref{Process/Prefix}).
5228
5229 @item S O m
5230 @kindex S O m (Summary)
5231 @findex gnus-summary-digest-mail-forward
5232 Digest the current series (@pxref{Decoding Articles}) and forward the
5233 result using mail (@code{gnus-summary-digest-mail-forward}).  This
5234 command uses the process/prefix convention (@pxref{Process/Prefix}).
5235
5236 @item S M-c
5237 @kindex S M-c (Summary)
5238 @findex gnus-summary-mail-crosspost-complaint
5239 @cindex crossposting
5240 @cindex excessive crossposting
5241 Send a complaint about excessive crossposting to the author of the
5242 current article (@code{gnus-summary-mail-crosspost-complaint}).
5243
5244 @findex gnus-crosspost-complaint
5245 This command is provided as a way to fight back against the current
5246 crossposting pandemic that's sweeping Usenet.  It will compose a reply
5247 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
5248 command understands the process/prefix convention
5249 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5250
5251 @end table
5252
5253 Also @xref{Header Commands, ,Header Commands, message, The Message
5254 Manual}, for more information.
5255
5256
5257 @node Summary Post Commands
5258 @subsection Summary Post Commands
5259 @cindex post
5260 @cindex composing news
5261
5262 Commands for posting a news article:
5263
5264 @table @kbd
5265 @item S p
5266 @itemx a
5267 @kindex a (Summary)
5268 @kindex S p (Summary)
5269 @findex gnus-summary-post-news
5270 @c @icon{gnus-summary-post-news}
5271 Prepare for posting an article (@code{gnus-summary-post-news}).  By
5272 default, post to the current group.  If given a prefix, disable that.
5273 If the prefix is 1, prompt for another group instead.
5274
5275 @item S f
5276 @itemx f
5277 @kindex f (Summary)
5278 @kindex S f (Summary)
5279 @findex gnus-summary-followup
5280 @c @icon{gnus-summary-followup}
5281 Post a followup to the current article (@code{gnus-summary-followup}).
5282
5283 @item S F
5284 @itemx F
5285 @kindex S F (Summary)
5286 @kindex F (Summary)
5287 @c @icon{gnus-summary-followup-with-original}
5288 @findex gnus-summary-followup-with-original
5289 Post a followup to the current article and include the original message
5290 (@code{gnus-summary-followup-with-original}).   This command uses the
5291 process/prefix convention.
5292
5293 @item S n
5294 @kindex S n (Summary)
5295 @findex gnus-summary-followup-to-mail
5296 Post a followup to the current article via news, even if you got the
5297 message through mail (@code{gnus-summary-followup-to-mail}).
5298
5299 @item S N
5300 @kindex S N (Summary)
5301 @findex gnus-summary-followup-to-mail-with-original
5302 Post a followup to the current article via news, even if you got the
5303 message through mail and include the original message
5304 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
5305 the process/prefix convention.
5306
5307 @item S o p
5308 @kindex S o p (Summary)
5309 @findex gnus-summary-post-forward
5310 Forward the current article to a newsgroup
5311 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
5312 headers of the forwarded article.
5313
5314 @item S O p
5315 @kindex S O p (Summary)
5316 @findex gnus-summary-digest-post-forward
5317 @cindex digests
5318 @cindex making digests
5319 Digest the current series and forward the result to a newsgroup
5320 (@code{gnus-summary-digest-post-forward}).  This command uses the
5321 process/prefix convention.
5322
5323 @item S u
5324 @kindex S u (Summary)
5325 @findex gnus-uu-post-news
5326 @c @icon{gnus-uu-post-news}
5327 Uuencode a file, split it into parts, and post it as a series
5328 (@code{gnus-uu-post-news}).  (@pxref{Uuencoding and Posting}).
5329 @end table
5330
5331 Also @xref{Header Commands, ,Header Commands, message, The Message
5332 Manual}, for more information.
5333
5334
5335 @node Summary Message Commands
5336 @subsection Summary Message Commands
5337
5338 @table @kbd
5339 @item S y
5340 @kindex S y (Summary)
5341 @findex gnus-summary-yank-message
5342 Yank the current article into an already existing Message composition
5343 buffer (@code{gnus-summary-yank-message}).  This command prompts for
5344 what message buffer you want to yank into, and understands the
5345 process/prefix convention (@pxref{Process/Prefix}).
5346
5347 @end table
5348
5349
5350 @node Canceling and Superseding
5351 @subsection Canceling Articles
5352 @cindex canceling articles
5353 @cindex superseding articles
5354
5355 Have you ever written something, and then decided that you really,
5356 really, really wish you hadn't posted that?
5357
5358 Well, you can't cancel mail, but you can cancel posts.
5359
5360 @findex gnus-summary-cancel-article
5361 @kindex C (Summary)
5362 @c @icon{gnus-summary-cancel-article}
5363 Find the article you wish to cancel (you can only cancel your own
5364 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
5365 c} (@code{gnus-summary-cancel-article}).  Your article will be
5366 canceled---machines all over the world will be deleting your article.
5367 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5368
5369 Be aware, however, that not all sites honor cancels, so your article may
5370 live on here and there, while most sites will delete the article in
5371 question.
5372
5373 Gnus will use the ``current'' select method when canceling.  If you
5374 want to use the standard posting method, use the @samp{a} symbolic
5375 prefix (@pxref{Symbolic Prefixes}).
5376
5377 If you discover that you have made some mistakes and want to do some
5378 corrections, you can post a @dfn{superseding} article that will replace
5379 your original article.
5380
5381 @findex gnus-summary-supersede-article
5382 @kindex S (Summary)
5383 Go to the original article and press @kbd{S s}
5384 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
5385 where you can edit the article all you want before sending it off the
5386 usual way.
5387
5388 The same goes for superseding as for canceling, only more so: Some
5389 sites do not honor superseding.  On those sites, it will appear that you
5390 have posted almost the same article twice.
5391
5392 If you have just posted the article, and change your mind right away,
5393 there is a trick you can use to cancel/supersede the article without
5394 waiting for the article to appear on your site first.  You simply return
5395 to the post buffer (which is called @code{*sent ...*}).  There you will
5396 find the article you just posted, with all the headers intact.  Change
5397 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5398 header by substituting one of those words for the word
5399 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
5400 you would do normally.  The previous article will be
5401 canceled/superseded.
5402
5403 Just remember, kids: There is no 'c' in 'supersede'.
5404
5405 @node Delayed Articles
5406 @section Delayed Articles
5407 @cindex delayed sending
5408 @cindex send delayed
5409
5410 Sometimes, you might wish to delay the sending of a message.  For
5411 example, you might wish to arrange for a message to turn up just in time
5412 to remind your about the birthday of your Significant Other.  For this,
5413 there is the @code{gnus-delay} package.  Setup is simple:
5414
5415 @lisp
5416 (gnus-delay-initialize)
5417 @end lisp
5418
5419 @findex gnus-delay-article
5420 Normally, to send a message you use the @kbd{C-c C-c} command from
5421 Message mode.  To delay a message, use @kbd{C-c C-j}
5422 (@code{gnus-delay-article}) instead.  This will ask you for how long the
5423 message should be delayed.  Possible answers are:
5424
5425 @itemize @bullet
5426 @item
5427 A time span.  Consists of an integer and a letter.  For example,
5428 @code{42d} means to delay for 42 days.  Available letters are @code{m}
5429 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5430 (months) and @code{Y} (years).
5431
5432 @item
5433 A specific date.  Looks like @code{YYYYY-MM-DD}.  The message will be
5434 delayed until that day, at a specific time (eight o'clock by default).
5435 See also @code{gnus-delay-default-hour}.
5436
5437 @item
5438 A specific time of day.  Given in @code{hh:mm} format, 24h, no am/pm
5439 stuff.  The deadline will be at that time today, except if that time has
5440 already passed, then it's at the given time tomorrow.  So if it's ten
5441 o'clock in the morning and you specify @code{11:15}, then the deadline
5442 is one hour and fifteen minutes hence.  But if you specify @code{9:20},
5443 that means a time tomorrow.
5444 @end itemize
5445
5446 The action of the @code{gnus-delay-article} command is influenced by a
5447 couple of variables:
5448
5449 @table @code
5450 @item gnus-delay-default-hour
5451 @vindex gnus-delay-default-hour
5452 When you specify a specific date, the message will be due on that hour
5453 on the given date.  Possible values are integers 0 through 23.
5454
5455 @item gnus-delay-default-delay
5456 @vindex gnus-delay-default-delay
5457 This is a string and gives the default delay.  It can be of any of the
5458 formats described above.
5459
5460 @item gnus-delay-group
5461 @vindex gnus-delay-group
5462 Delayed articles will be kept in this group on the drafts server until
5463 they are due.  You probably don't need to change this.  The default
5464 value is @code{"delayed"}.
5465
5466 @item gnus-delay-header
5467 @vindex gnus-delay-header
5468 The deadline for each article will be stored in a header.  This variable
5469 is a string and gives the header name.  You probably don't need to
5470 change this.  The default value is @code{"X-Gnus-Delayed"}.
5471 @end table
5472
5473 The way delaying works is like this: when you use the
5474 @code{gnus-delay-article} command, you give a certain delay.  Gnus
5475 calculates the deadline of the message and stores it in the
5476 @code{X-Gnus-Delayed} header and puts the message in the
5477 @code{nndraft:delayed} group.
5478
5479 And whenever you get new news, Gnus looks through the group for articles
5480 which are due and sends them.  It uses the @code{gnus-delay-send-queue}
5481 function for this.  By default, this function is added to the hook
5482 @code{gnus-get-new-news-hook}.  But of course, you can change this.
5483 Maybe you want to use the demon to send drafts?  Just tell the demon to
5484 execute the @code{gnus-delay-send-queue} function.
5485
5486 @table @code
5487 @item gnus-delay-initialize
5488 @findex gnus-delay-initialize
5489
5490 By default, this function installs @code{gnus-delay-send-queue} in
5491 @code{gnus-get-new-news-hook}.  But it accepts the optional second
5492 argument @code{no-check}.  If it is non-nil,
5493 @code{gnus-get-new-news-hook} is not changed.  The optional first
5494 argument is ignored.
5495
5496 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5497 Presumably, you want to use the demon for sending due delayed articles.
5498 Just don't forget to set that up :-)
5499 @end table
5500
5501
5502 @node Marking Articles
5503 @section Marking Articles
5504 @cindex article marking
5505 @cindex article ticking
5506 @cindex marks
5507
5508 There are several marks you can set on an article.
5509
5510 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5511 neologism ohoy!) of the article.  Alphabetic marks generally mean
5512 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5513
5514 In addition, you also have marks that do not affect readedness.
5515
5516 @menu
5517 * Unread Articles::             Marks for unread articles.
5518 * Read Articles::               Marks for read articles.
5519 * Other Marks::                 Marks that do not affect readedness.
5520 @end menu
5521
5522 @ifinfo
5523 There's a plethora of commands for manipulating these marks:
5524 @end ifinfo
5525
5526 @menu
5527 * Setting Marks::             How to set and remove marks.
5528 * Generic Marking Commands::  How to customize the marking.
5529 * Setting Process Marks::     How to mark articles for later processing.
5530 @end menu
5531
5532
5533 @node Unread Articles
5534 @subsection Unread Articles
5535
5536 The following marks mark articles as (kinda) unread, in one form or
5537 other.
5538
5539 @table @samp
5540 @item !
5541 @vindex gnus-ticked-mark
5542 Marked as ticked (@code{gnus-ticked-mark}).
5543
5544 @dfn{Ticked articles} are articles that will remain visible always.  If
5545 you see an article that you find interesting, or you want to put off
5546 reading it, or replying to it, until sometime later, you'd typically
5547 tick it.  However, articles can be expired (from news servers by the
5548 news server software, Gnus itself never expires ticked messages), so if
5549 you want to keep an article forever, you'll have to make it persistent
5550 (@pxref{Persistent Articles}).
5551
5552 @item ?
5553 @vindex gnus-dormant-mark
5554 Marked as dormant (@code{gnus-dormant-mark}).
5555
5556 @dfn{Dormant articles} will only appear in the summary buffer if there
5557 are followups to it.  If you want to see them even if they don't have
5558 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5559 Otherwise (except for the visibility issue), they are just like ticked
5560 messages.
5561
5562 @item SPACE
5563 @vindex gnus-unread-mark
5564 Marked as unread (@code{gnus-unread-mark}).
5565
5566 @dfn{Unread articles} are articles that haven't been read at all yet.
5567 @end table
5568
5569
5570 @node Read Articles
5571 @subsection Read Articles
5572 @cindex expirable mark
5573
5574 All the following marks mark articles as read.
5575
5576 @table @samp
5577
5578 @item r
5579 @vindex gnus-del-mark
5580 These are articles that the user has marked as read with the @kbd{d}
5581 command manually, more or less (@code{gnus-del-mark}).
5582
5583 @item R
5584 @vindex gnus-read-mark
5585 Articles that have actually been read (@code{gnus-read-mark}).
5586
5587 @item O
5588 @vindex gnus-ancient-mark
5589 Articles that were marked as read in previous sessions and are now
5590 @dfn{old} (@code{gnus-ancient-mark}).
5591
5592 @item K
5593 @vindex gnus-killed-mark
5594 Marked as killed (@code{gnus-killed-mark}).
5595
5596 @item X
5597 @vindex gnus-kill-file-mark
5598 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5599
5600 @item Y
5601 @vindex gnus-low-score-mark
5602 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5603
5604 @item C
5605 @vindex gnus-catchup-mark
5606 Marked as read by a catchup (@code{gnus-catchup-mark}).
5607
5608 @item G
5609 @vindex gnus-canceled-mark
5610 Canceled article (@code{gnus-canceled-mark})
5611
5612 @item F
5613 @vindex gnus-souped-mark
5614 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
5615
5616 @item Q
5617 @vindex gnus-sparse-mark
5618 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
5619 Threading}.
5620
5621 @item M
5622 @vindex gnus-duplicate-mark
5623 Article marked as read by duplicate suppression
5624 (@code{gnus-duplicate-mark}).  @xref{Duplicate Suppression}.
5625
5626 @end table
5627
5628 All these marks just mean that the article is marked as read, really.
5629 They are interpreted differently when doing adaptive scoring, though.
5630
5631 One more special mark, though:
5632
5633 @table @samp
5634 @item E
5635 @vindex gnus-expirable-mark
5636 Marked as expirable (@code{gnus-expirable-mark}).
5637
5638 Marking articles as @dfn{expirable} (or have them marked as such
5639 automatically) doesn't make much sense in normal groups---a user doesn't
5640 control expiring of news articles, but in mail groups, for instance,
5641 articles marked as @dfn{expirable} can be deleted by gnus at
5642 any time.
5643 @end table
5644
5645
5646 @node Other Marks
5647 @subsection Other Marks
5648 @cindex process mark
5649 @cindex bookmarks
5650
5651 There are some marks that have nothing to do with whether the article is
5652 read or not.
5653
5654 @itemize @bullet
5655
5656 @item
5657 You can set a bookmark in the current article.  Say you are reading a
5658 long thesis on cats' urinary tracts, and have to go home for dinner
5659 before you've finished reading the thesis.  You can then set a bookmark
5660 in the article, and gnus will jump to this bookmark the next time it
5661 encounters the article.  @xref{Setting Marks}.
5662
5663 @item
5664 @vindex gnus-replied-mark
5665 All articles that you have replied to or made a followup to (i.e., have
5666 answered) will be marked with an @samp{A} in the second column
5667 (@code{gnus-replied-mark}).
5668
5669 @item
5670 @vindex gnus-forwarded-mark
5671 All articles that you have forwarded will be marked with an @samp{F} in
5672 the second column (@code{gnus-forwarded-mark}).
5673
5674 @item
5675 @vindex gnus-cached-mark
5676 Articles stored in the article cache will be marked with an @samp{*} in
5677 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
5678
5679 @item
5680 @vindex gnus-saved-mark
5681 Articles ``saved'' (in some manner or other; not necessarily
5682 religiously) are marked with an @samp{S} in the second column
5683 (@code{gnus-saved-mark}).
5684
5685 @item
5686 @vindex gnus-recent-mark
5687 Articles that according to the server haven't been shown to the user
5688 before are marked with a @samp{N} in the second column
5689 (@code{gnus-recent-mark}).  Note that not all servers support this
5690 mark, in which case it simply never appears. Compare with
5691 @code{gnus-unseen-mark}.
5692
5693 @item
5694 @vindex gnus-unseen-mark
5695 Articles that haven't been seen before in Gnus by the user are marked
5696 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
5697 Compare with @code{gnus-recent-mark}.
5698
5699 @item
5700 @vindex gnus-undownloaded-mark
5701 When using the Gnus agent @pxref{Agent Basics}, some articles might not
5702 have been downloaded.  Such articles cannot be viewed while you are
5703 offline (unplugged).  These articles get the @samp{@@} mark in the
5704 first column.  (The variable @code{gnus-undownloaded-mark} controls
5705 which character to use.)
5706
5707 @item
5708 @vindex gnus-downloadable-mark
5709 The Gnus agent @pxref{Agent Basics} downloads some articles
5710 automatically, but it is also possible to explicitly mark articles for
5711 download, even if they would not be downloaded automatically.  Such
5712 explicitly-marked articles get the @samp{%} mark in the first column.
5713 (The variable @code{gnus-downloadable-mark} controls which character to
5714 use.)
5715
5716 @item
5717 @vindex gnus-not-empty-thread-mark
5718 @vindex gnus-empty-thread-mark
5719 If the @samp{%e} spec is used, the presence of threads or not will be
5720 marked with @code{gnus-not-empty-thread-mark} and
5721 @code{gnus-empty-thread-mark} in the third column, respectively.
5722
5723 @item
5724 @vindex gnus-process-mark
5725 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
5726 variety of commands react to the presence of the process mark.  For
5727 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5728 all articles that have been marked with the process mark.  Articles
5729 marked with the process mark have a @samp{#} in the second column.
5730
5731 @end itemize
5732
5733 You might have noticed that most of these ``non-readedness'' marks
5734 appear in the second column by default.  So if you have a cached, saved,
5735 replied article that you have process-marked, what will that look like?
5736
5737 Nothing much.  The precedence rules go as follows: process -> cache ->
5738 replied -> saved.  So if the article is in the cache and is replied,
5739 you'll only see the cache mark and not the replied mark.
5740
5741
5742 @node Setting Marks
5743 @subsection Setting Marks
5744 @cindex setting marks
5745
5746 All the marking commands understand the numeric prefix.
5747
5748 @table @kbd
5749 @item M c
5750 @itemx M-u
5751 @kindex M c (Summary)
5752 @kindex M-u (Summary)
5753 @findex gnus-summary-clear-mark-forward
5754 @cindex mark as unread
5755 Clear all readedness-marks from the current article
5756 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
5757 article as unread.
5758
5759 @item M t
5760 @itemx !
5761 @kindex ! (Summary)
5762 @kindex M t (Summary)
5763 @findex gnus-summary-tick-article-forward
5764 Tick the current article (@code{gnus-summary-tick-article-forward}).
5765 @xref{Article Caching}.
5766
5767 @item M ?
5768 @itemx ?
5769 @kindex ? (Summary)
5770 @kindex M ? (Summary)
5771 @findex gnus-summary-mark-as-dormant
5772 Mark the current article as dormant
5773 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
5774
5775 @item M d
5776 @itemx d
5777 @kindex M d (Summary)
5778 @kindex d (Summary)
5779 @findex gnus-summary-mark-as-read-forward
5780 Mark the current article as read
5781 (@code{gnus-summary-mark-as-read-forward}).
5782
5783 @item D
5784 @kindex D (Summary)
5785 @findex gnus-summary-mark-as-read-backward
5786 Mark the current article as read and move point to the previous line
5787 (@code{gnus-summary-mark-as-read-backward}).
5788
5789 @item M k
5790 @itemx k
5791 @kindex k (Summary)
5792 @kindex M k (Summary)
5793 @findex gnus-summary-kill-same-subject-and-select
5794 Mark all articles that have the same subject as the current one as read,
5795 and then select the next unread article
5796 (@code{gnus-summary-kill-same-subject-and-select}).
5797
5798 @item M K
5799 @itemx C-k
5800 @kindex M K (Summary)
5801 @kindex C-k (Summary)
5802 @findex gnus-summary-kill-same-subject
5803 Mark all articles that have the same subject as the current one as read
5804 (@code{gnus-summary-kill-same-subject}).
5805
5806 @item M C
5807 @kindex M C (Summary)
5808 @findex gnus-summary-catchup
5809 @c @icon{gnus-summary-catchup}
5810 Mark all unread articles as read (@code{gnus-summary-catchup}).
5811
5812 @item M C-c
5813 @kindex M C-c (Summary)
5814 @findex gnus-summary-catchup-all
5815 Mark all articles in the group as read---even the ticked and dormant
5816 articles (@code{gnus-summary-catchup-all}).
5817
5818 @item M H
5819 @kindex M H (Summary)
5820 @findex gnus-summary-catchup-to-here
5821 Catchup the current group to point (before the point)
5822 (@code{gnus-summary-catchup-to-here}).
5823
5824 @item M h
5825 @kindex M h (Summary)
5826 @findex gnus-summary-catchup-from-here
5827 Catchup the current group from point (after the point)
5828 (@code{gnus-summary-catchup-from-here}).
5829
5830 @item C-w
5831 @kindex C-w (Summary)
5832 @findex gnus-summary-mark-region-as-read
5833 Mark all articles between point and mark as read
5834 (@code{gnus-summary-mark-region-as-read}).
5835
5836 @item M V k
5837 @kindex M V k (Summary)
5838 @findex gnus-summary-kill-below
5839 Kill all articles with scores below the default score (or below the
5840 numeric prefix) (@code{gnus-summary-kill-below}).
5841
5842 @item M e
5843 @itemx E
5844 @kindex M e (Summary)
5845 @kindex E (Summary)
5846 @findex gnus-summary-mark-as-expirable
5847 Mark the current article as expirable
5848 (@code{gnus-summary-mark-as-expirable}).
5849
5850 @item M b
5851 @kindex M b (Summary)
5852 @findex gnus-summary-set-bookmark
5853 Set a bookmark in the current article
5854 (@code{gnus-summary-set-bookmark}).
5855
5856 @item M B
5857 @kindex M B (Summary)
5858 @findex gnus-summary-remove-bookmark
5859 Remove the bookmark from the current article
5860 (@code{gnus-summary-remove-bookmark}).
5861
5862 @item M V c
5863 @kindex M V c (Summary)
5864 @findex gnus-summary-clear-above
5865 Clear all marks from articles with scores over the default score (or
5866 over the numeric prefix) (@code{gnus-summary-clear-above}).
5867
5868 @item M V u
5869 @kindex M V u (Summary)
5870 @findex gnus-summary-tick-above
5871 Tick all articles with scores over the default score (or over the
5872 numeric prefix) (@code{gnus-summary-tick-above}).
5873
5874 @item M V m
5875 @kindex M V m (Summary)
5876 @findex gnus-summary-mark-above
5877 Prompt for a mark, and mark all articles with scores over the default
5878 score (or over the numeric prefix) with this mark
5879 (@code{gnus-summary-clear-above}).
5880 @end table
5881
5882 @vindex gnus-summary-goto-unread
5883 The @code{gnus-summary-goto-unread} variable controls what action should
5884 be taken after setting a mark.  If non-@code{nil}, point will move to
5885 the next/previous unread article.  If @code{nil}, point will just move
5886 one line up or down.  As a special case, if this variable is
5887 @code{never}, all the marking commands as well as other commands (like
5888 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5889 The default is @code{t}.
5890
5891
5892 @node Generic Marking Commands
5893 @subsection Generic Marking Commands
5894
5895 Some people would like the command that ticks an article (@kbd{!}) go to
5896 the next article.  Others would like it to go to the next unread
5897 article.  Yet others would like it to stay on the current article.  And
5898 even though I haven't heard of anybody wanting it to go to the
5899 previous (unread) article, I'm sure there are people that want that as
5900 well.
5901
5902 Multiply these five behaviors with five different marking commands, and
5903 you get a potentially complex set of variable to control what each
5904 command should do.
5905
5906 To sidestep that mess, Gnus provides commands that do all these
5907 different things.  They can be found on the @kbd{M M} map in the summary
5908 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
5909 to list in this manual.
5910
5911 While you can use these commands directly, most users would prefer
5912 altering the summary mode keymap.  For instance, if you would like the
5913 @kbd{!} command to go to the next article instead of the next unread
5914 article, you could say something like:
5915
5916 @lisp
5917 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5918 (defun my-alter-summary-map ()
5919   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5920 @end lisp
5921
5922 or
5923
5924 @lisp
5925 (defun my-alter-summary-map ()
5926   (local-set-key "!" "MM!n"))
5927 @end lisp
5928
5929
5930 @node Setting Process Marks
5931 @subsection Setting Process Marks
5932 @cindex setting process marks
5933
5934 @table @kbd
5935
5936 @item M P p
5937 @itemx #
5938 @kindex # (Summary)
5939 @kindex M P p (Summary)
5940 @findex gnus-summary-mark-as-processable
5941 Mark the current article with the process mark
5942 (@code{gnus-summary-mark-as-processable}).
5943 @findex gnus-summary-unmark-as-processable
5944
5945 @item M P u
5946 @itemx M-#
5947 @kindex M P u (Summary)
5948 @kindex M-# (Summary)
5949 Remove the process mark, if any, from the current article
5950 (@code{gnus-summary-unmark-as-processable}).
5951
5952 @item M P U
5953 @kindex M P U (Summary)
5954 @findex gnus-summary-unmark-all-processable
5955 Remove the process mark from all articles
5956 (@code{gnus-summary-unmark-all-processable}).
5957
5958 @item M P i
5959 @kindex M P i (Summary)
5960 @findex gnus-uu-invert-processable
5961 Invert the list of process marked articles
5962 (@code{gnus-uu-invert-processable}).
5963
5964 @item M P R
5965 @kindex M P R (Summary)
5966 @findex gnus-uu-mark-by-regexp
5967 Mark articles that have a @code{Subject} header that matches a regular
5968 expression (@code{gnus-uu-mark-by-regexp}).
5969
5970 @item M P G
5971 @kindex M P G (Summary)
5972 @findex gnus-uu-unmark-by-regexp
5973 Unmark articles that have a @code{Subject} header that matches a regular
5974 expression (@code{gnus-uu-unmark-by-regexp}).
5975
5976 @item M P r
5977 @kindex M P r (Summary)
5978 @findex gnus-uu-mark-region
5979 Mark articles in region (@code{gnus-uu-mark-region}).
5980
5981 @item M P g
5982 @kindex M P g
5983 @findex gnus-uu-unmark-region
5984 Unmark articles in region (@code{gnus-uu-unmark-region}).
5985
5986 @item M P t
5987 @kindex M P t (Summary)
5988 @findex gnus-uu-mark-thread
5989 Mark all articles in the current (sub)thread
5990 (@code{gnus-uu-mark-thread}).
5991
5992 @item M P T
5993 @kindex M P T (Summary)
5994 @findex gnus-uu-unmark-thread
5995 Unmark all articles in the current (sub)thread
5996 (@code{gnus-uu-unmark-thread}).
5997
5998 @item M P v
5999 @kindex M P v (Summary)
6000 @findex gnus-uu-mark-over
6001 Mark all articles that have a score above the prefix argument
6002 (@code{gnus-uu-mark-over}).
6003
6004 @item M P s
6005 @kindex M P s (Summary)
6006 @findex gnus-uu-mark-series
6007 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6008
6009 @item M P S
6010 @kindex M P S (Summary)
6011 @findex gnus-uu-mark-sparse
6012 Mark all series that have already had some articles marked
6013 (@code{gnus-uu-mark-sparse}).
6014
6015 @item M P a
6016 @kindex M P a (Summary)
6017 @findex gnus-uu-mark-all
6018 Mark all articles in series order (@code{gnus-uu-mark-series}).
6019
6020 @item M P b
6021 @kindex M P b (Summary)
6022 @findex gnus-uu-mark-buffer
6023 Mark all articles in the buffer in the order they appear
6024 (@code{gnus-uu-mark-buffer}).
6025
6026 @item M P k
6027 @kindex M P k (Summary)
6028 @findex gnus-summary-kill-process-mark
6029 Push the current process mark set onto the stack and unmark all articles
6030 (@code{gnus-summary-kill-process-mark}).
6031
6032 @item M P y
6033 @kindex M P y (Summary)
6034 @findex gnus-summary-yank-process-mark
6035 Pop the previous process mark set from the stack and restore it
6036 (@code{gnus-summary-yank-process-mark}).
6037
6038 @item M P w
6039 @kindex M P w (Summary)
6040 @findex gnus-summary-save-process-mark
6041 Push the current process mark set onto the stack
6042 (@code{gnus-summary-save-process-mark}).
6043
6044 @end table
6045
6046 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
6047 set process marks based on article body contents.
6048
6049
6050 @node Limiting
6051 @section Limiting
6052 @cindex limiting
6053
6054 It can be convenient to limit the summary buffer to just show some
6055 subset of the articles currently in the group.  The effect most limit
6056 commands have is to remove a few (or many) articles from the summary
6057 buffer.
6058
6059 All limiting commands work on subsets of the articles already fetched
6060 from the servers.  None of these commands query the server for
6061 additional articles.
6062
6063 @table @kbd
6064
6065 @item / /
6066 @itemx / s
6067 @kindex / / (Summary)
6068 @findex gnus-summary-limit-to-subject
6069 Limit the summary buffer to articles that match some subject
6070 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6071 matching articles.
6072
6073 @item / a
6074 @kindex / a (Summary)
6075 @findex gnus-summary-limit-to-author
6076 Limit the summary buffer to articles that match some author
6077 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6078 matching articles.
6079
6080 @item / x
6081 @kindex / x (Summary)
6082 @findex gnus-summary-limit-to-extra
6083 Limit the summary buffer to articles that match one of the ``extra''
6084 headers (@pxref{To From Newsgroups})
6085 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6086 matching articles.
6087
6088 @item / u
6089 @itemx x
6090 @kindex / u (Summary)
6091 @kindex x (Summary)
6092 @findex gnus-summary-limit-to-unread
6093 Limit the summary buffer to articles not marked as read
6094 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
6095 buffer to articles strictly unread.  This means that ticked and
6096 dormant articles will also be excluded.
6097
6098 @item / m
6099 @kindex / m (Summary)
6100 @findex gnus-summary-limit-to-marks
6101 Ask for a mark and then limit to all articles that have been marked
6102 with that mark (@code{gnus-summary-limit-to-marks}).
6103
6104 @item / t
6105 @kindex / t (Summary)
6106 @findex gnus-summary-limit-to-age
6107 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6108 (@code{gnus-summary-limit-to-age}).  If given a prefix, limit to
6109 articles younger than that number of days.
6110
6111 @item / n
6112 @kindex / n (Summary)
6113 @findex gnus-summary-limit-to-articles
6114 Limit the summary buffer to the current article
6115 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
6116 convention (@pxref{Process/Prefix}).
6117
6118 @item / w
6119 @kindex / w (Summary)
6120 @findex gnus-summary-pop-limit
6121 Pop the previous limit off the stack and restore it
6122 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
6123 the stack.
6124
6125 @item / .
6126 @kindex / . (Summary)
6127 @findex gnus-summary-limit-to-unseen
6128 Limit the summary buffer to the unseen articles
6129 (@code{gnus-summary-limit-to-unseen}).
6130
6131 @item / v
6132 @kindex / v (Summary)
6133 @findex gnus-summary-limit-to-score
6134 Limit the summary buffer to articles that have a score at or above some
6135 score (@code{gnus-summary-limit-to-score}).
6136
6137 @item / p
6138 @kindex / p (Summary)
6139 @findex gnus-summary-limit-to-display-predicate
6140 Limit the summary buffer to articles that satisfy the @code{display}
6141 group parameter predicate
6142 (@code{gnus-summary-limit-to-display-predicate}).  See @pxref{Group
6143 Parameters} for more on this predicate.
6144
6145 @item / E
6146 @itemx M S
6147 @kindex M S (Summary)
6148 @kindex / E (Summary)
6149 @findex gnus-summary-limit-include-expunged
6150 Include all expunged articles in the limit
6151 (@code{gnus-summary-limit-include-expunged}).
6152
6153 @item / D
6154 @kindex / D (Summary)
6155 @findex gnus-summary-limit-include-dormant
6156 Include all dormant articles in the limit
6157 (@code{gnus-summary-limit-include-dormant}).
6158
6159 @item / *
6160 @kindex / * (Summary)
6161 @findex gnus-summary-limit-include-cached
6162 Include all cached articles in the limit
6163 (@code{gnus-summary-limit-include-cached}).
6164
6165 @item / d
6166 @kindex / d (Summary)
6167 @findex gnus-summary-limit-exclude-dormant
6168 Exclude all dormant articles from the limit
6169 (@code{gnus-summary-limit-exclude-dormant}).
6170
6171 @item / M
6172 @kindex / M (Summary)
6173 @findex gnus-summary-limit-exclude-marks
6174 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6175
6176 @item / T
6177 @kindex / T (Summary)
6178 @findex gnus-summary-limit-include-thread
6179 Include all the articles in the current thread in the limit.
6180
6181 @item / c
6182 @kindex / c (Summary)
6183 @findex gnus-summary-limit-exclude-childless-dormant
6184 Exclude all dormant articles that have no children from the limit
6185 (@code{gnus-summary-limit-exclude-childless-dormant}).
6186
6187 @item / C
6188 @kindex / C (Summary)
6189 @findex gnus-summary-limit-mark-excluded-as-read
6190 Mark all excluded unread articles as read
6191 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
6192 also mark excluded ticked and dormant articles as read.
6193
6194 @item / N
6195 @kindex / N (Summary)
6196 @findex gnus-summary-insert-new-articles
6197 Insert all new articles in the summary buffer. It scans for new emails
6198 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6199
6200 @item / o
6201 @kindex / o (Summary)
6202 @findex gnus-summary-insert-old-articles
6203 Insert all old articles in the summary buffer. If given a numbered
6204 prefix, fetch this number of articles.
6205
6206 @end table
6207
6208
6209 @node Threading
6210 @section Threading
6211 @cindex threading
6212 @cindex article threading
6213
6214 Gnus threads articles by default.  @dfn{To thread} is to put responses
6215 to articles directly after the articles they respond to---in a
6216 hierarchical fashion.
6217
6218 Threading is done by looking at the @code{References} headers of the
6219 articles.  In a perfect world, this would be enough to build pretty
6220 trees, but unfortunately, the @code{References} header is often broken
6221 or simply missing.  Weird news propagation exacerbates the problem,
6222 so one has to employ other heuristics to get pleasing results.  A
6223 plethora of approaches exists, as detailed in horrible detail in
6224 @pxref{Customizing Threading}.
6225
6226 First, a quick overview of the concepts:
6227
6228 @table @dfn
6229 @item root
6230 The top-most article in a thread; the first article in the thread.
6231
6232 @item thread
6233 A tree-like article structure.
6234
6235 @item sub-thread
6236 A small(er) section of this tree-like structure.
6237
6238 @item loose threads
6239 Threads often lose their roots due to article expiry, or due to the root
6240 already having been read in a previous session, and not displayed in the
6241 summary buffer.  We then typically have many sub-threads that really
6242 belong to one thread, but are without connecting roots.  These are
6243 called loose threads.
6244
6245 @item thread gathering
6246 An attempt to gather loose threads into bigger threads.
6247
6248 @item sparse threads
6249 A thread where the missing articles have been ``guessed'' at, and are
6250 displayed as empty lines in the summary buffer.
6251
6252 @end table
6253
6254
6255 @menu
6256 * Customizing Threading::       Variables you can change to affect the threading.
6257 * Thread Commands::             Thread based commands in the summary buffer.
6258 @end menu
6259
6260
6261 @node Customizing Threading
6262 @subsection Customizing Threading
6263 @cindex customizing threading
6264
6265 @menu
6266 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
6267 * Filling In Threads::          Making the threads displayed look fuller.
6268 * More Threading::              Even more variables for fiddling with threads.
6269 * Low-Level Threading::         You thought it was over... but you were wrong!
6270 @end menu
6271
6272
6273 @node Loose Threads
6274 @subsubsection Loose Threads
6275 @cindex <
6276 @cindex >
6277 @cindex loose threads
6278
6279 @table @code
6280 @item gnus-summary-make-false-root
6281 @vindex gnus-summary-make-false-root
6282 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6283 and create a dummy root at the top.  (Wait a minute.  Root at the top?
6284 Yup.)  Loose subtrees occur when the real root has expired, or you've
6285 read or killed the root in a previous session.
6286
6287 When there is no real root of a thread, gnus will have to fudge
6288 something.  This variable says what fudging method gnus should use.
6289 There are four possible values:
6290
6291 @iftex
6292 @iflatex
6293 \gnusfigure{The Summary Buffer}{390}{
6294 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6295 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6296 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6297 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6298 }
6299 @end iflatex
6300 @end iftex
6301
6302 @cindex adopting articles
6303
6304 @table @code
6305
6306 @item adopt
6307 Gnus will make the first of the orphaned articles the parent.  This
6308 parent will adopt all the other articles.  The adopted articles will be
6309 marked as such by pointy brackets (@samp{<>}) instead of the standard
6310 square brackets (@samp{[]}).  This is the default method.
6311
6312 @item dummy
6313 @vindex gnus-summary-dummy-line-format
6314 @vindex gnus-summary-make-false-root-always
6315 Gnus will create a dummy summary line that will pretend to be the
6316 parent.  This dummy line does not correspond to any real article, so
6317 selecting it will just select the first real article after the dummy
6318 article.  @code{gnus-summary-dummy-line-format} is used to specify the
6319 format of the dummy roots.  It accepts only one format spec:  @samp{S},
6320 which is the subject of the article.  @xref{Formatting Variables}.
6321 If you want all threads to have a dummy root, even the non-gathered
6322 ones, set @code{gnus-summary-make-false-root-always} to t.
6323
6324 @item empty
6325 Gnus won't actually make any article the parent, but simply leave the
6326 subject field of all orphans except the first empty.  (Actually, it will
6327 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6328 Buffer Format}).)
6329
6330 @item none
6331 Don't make any article parent at all.  Just gather the threads and
6332 display them after one another.
6333
6334 @item nil
6335 Don't gather loose threads.
6336 @end table
6337
6338 @item gnus-summary-gather-subject-limit
6339 @vindex gnus-summary-gather-subject-limit
6340 Loose threads are gathered by comparing subjects of articles.  If this
6341 variable is @code{nil}, gnus requires an exact match between the
6342 subjects of the loose threads before gathering them into one big
6343 super-thread.  This might be too strict a requirement, what with the
6344 presence of stupid newsreaders that chop off long subject lines.  If
6345 you think so, set this variable to, say, 20 to require that only the
6346 first 20 characters of the subjects have to match.  If you set this
6347 variable to a really low number, you'll find that gnus will gather
6348 everything in sight into one thread, which isn't very helpful.
6349
6350 @cindex fuzzy article gathering
6351 If you set this variable to the special value @code{fuzzy}, gnus will
6352 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6353 Matching}).
6354
6355 @item gnus-simplify-subject-fuzzy-regexp
6356 @vindex gnus-simplify-subject-fuzzy-regexp
6357 This can either be a regular expression or list of regular expressions
6358 that match strings that will be removed from subjects if fuzzy subject
6359 simplification is used.
6360
6361 @item gnus-simplify-ignored-prefixes
6362 @vindex gnus-simplify-ignored-prefixes
6363 If you set @code{gnus-summary-gather-subject-limit} to something as low
6364 as 10, you might consider setting this variable to something sensible:
6365
6366 @c Written by Michael Ernst <mernst@cs.rice.edu>
6367 @lisp
6368 (setq gnus-simplify-ignored-prefixes
6369       (concat
6370        "\\`\\[?\\("
6371        (mapconcat
6372         'identity
6373         '("looking"
6374           "wanted" "followup" "summary\\( of\\)?"
6375           "help" "query" "problem" "question"
6376           "answer" "reference" "announce"
6377           "How can I" "How to" "Comparison of"
6378           ;; ...
6379           )
6380         "\\|")
6381        "\\)\\s *\\("
6382        (mapconcat 'identity
6383                   '("for" "for reference" "with" "about")
6384                   "\\|")
6385        "\\)?\\]?:?[ \t]*"))
6386 @end lisp
6387
6388 All words that match this regexp will be removed before comparing two
6389 subjects.
6390
6391 @item gnus-simplify-subject-functions
6392 @vindex gnus-simplify-subject-functions
6393 If non-@code{nil}, this variable overrides
6394 @code{gnus-summary-gather-subject-limit}.  This variable should be a
6395 list of functions to apply to the @code{Subject} string iteratively to
6396 arrive at the simplified version of the string.
6397
6398 Useful functions to put in this list include:
6399
6400 @table @code
6401 @item gnus-simplify-subject-re
6402 @findex gnus-simplify-subject-re
6403 Strip the leading @samp{Re:}.
6404
6405 @item gnus-simplify-subject-fuzzy
6406 @findex gnus-simplify-subject-fuzzy
6407 Simplify fuzzily.
6408
6409 @item gnus-simplify-whitespace
6410 @findex gnus-simplify-whitespace
6411 Remove excessive whitespace.
6412
6413 @item gnus-simplify-all-whitespace
6414 @findex gnus-simplify-all-whitespace
6415 Remove all whitespace.
6416 @end table
6417
6418 You may also write your own functions, of course.
6419
6420
6421 @item gnus-summary-gather-exclude-subject
6422 @vindex gnus-summary-gather-exclude-subject
6423 Since loose thread gathering is done on subjects only, that might lead
6424 to many false hits, especially with certain common subjects like
6425 @samp{} and @samp{(none)}.  To make the situation slightly better,
6426 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6427 what subjects should be excluded from the gathering process.@*
6428 The default is @samp{^ *$\\|^(none)$}.
6429
6430 @item gnus-summary-thread-gathering-function
6431 @vindex gnus-summary-thread-gathering-function
6432 Gnus gathers threads by looking at @code{Subject} headers.  This means
6433 that totally unrelated articles may end up in the same ``thread'', which
6434 is confusing.  An alternate approach is to look at all the
6435 @code{Message-ID}s in all the @code{References} headers to find matches.
6436 This will ensure that no gathered threads ever include unrelated
6437 articles, but it also means that people who have posted with broken
6438 newsreaders won't be gathered properly.  The choice is yours---plague or
6439 cholera:
6440
6441 @table @code
6442 @item gnus-gather-threads-by-subject
6443 @findex gnus-gather-threads-by-subject
6444 This function is the default gathering function and looks at
6445 @code{Subject}s exclusively.
6446
6447 @item gnus-gather-threads-by-references
6448 @findex gnus-gather-threads-by-references
6449 This function looks at @code{References} headers exclusively.
6450 @end table
6451
6452 If you want to test gathering by @code{References}, you could say
6453 something like:
6454
6455 @lisp
6456 (setq gnus-summary-thread-gathering-function
6457       'gnus-gather-threads-by-references)
6458 @end lisp
6459
6460 @end table
6461
6462
6463 @node Filling In Threads
6464 @subsubsection Filling In Threads
6465
6466 @table @code
6467 @item gnus-fetch-old-headers
6468 @vindex gnus-fetch-old-headers
6469 If non-@code{nil}, gnus will attempt to build old threads by fetching
6470 more old headers---headers to articles marked as read.  If you
6471 would like to display as few summary lines as possible, but still
6472 connect as many loose threads as possible, you should set this variable
6473 to @code{some} or a number.  If you set it to a number, no more than
6474 that number of extra old headers will be fetched.  In either case,
6475 fetching old headers only works if the back end you are using carries
6476 overview files---this would normally be @code{nntp}, @code{nnspool},
6477 @code{nnml}, and @code{nnmaildir}.  Also remember that if the root of
6478 the thread has been expired by the server, there's not much Gnus can do
6479 about that.
6480
6481 This variable can also be set to @code{invisible}.  This won't have any
6482 visible effects, but is useful if you use the @kbd{A T} command a lot
6483 (@pxref{Finding the Parent}).
6484
6485 @item gnus-build-sparse-threads
6486 @vindex gnus-build-sparse-threads
6487 Fetching old headers can be slow.  A low-rent similar effect can be
6488 gotten by setting this variable to @code{some}.  Gnus will then look at
6489 the complete @code{References} headers of all articles and try to string
6490 together articles that belong in the same thread.  This will leave
6491 @dfn{gaps} in the threading display where gnus guesses that an article
6492 is missing from the thread.  (These gaps appear like normal summary
6493 lines.  If you select a gap, gnus will try to fetch the article in
6494 question.)  If this variable is @code{t}, gnus will display all these
6495 ``gaps'' without regard for whether they are useful for completing the
6496 thread or not.  Finally, if this variable is @code{more}, gnus won't cut
6497 off sparse leaf nodes that don't lead anywhere.  This variable is
6498 @code{nil} by default.
6499
6500 @item gnus-read-all-available-headers
6501 @vindex gnus-read-all-available-headers
6502 This is a rather obscure variable that few will find useful.  It's
6503 intended for those non-news newsgroups where the back end has to fetch
6504 quite a lot to present the summary buffer, and where it's impossible to
6505 go back to parents of articles.  This is mostly the case in the
6506 web-based groups, like the @code{nnultimate} groups.
6507
6508 If you don't use those, then it's safe to leave this as the default
6509 @code{nil}.  If you want to use this variable, it should be a regexp
6510 that matches the group name, or @code{t} for all groups.
6511
6512 @end table
6513
6514
6515 @node More Threading
6516 @subsubsection More Threading
6517
6518 @table @code
6519 @item gnus-show-threads
6520 @vindex gnus-show-threads
6521 If this variable is @code{nil}, no threading will be done, and all of
6522 the rest of the variables here will have no effect.  Turning threading
6523 off will speed group selection up a bit, but it is sure to make reading
6524 slower and more awkward.
6525
6526 @item gnus-thread-hide-subtree
6527 @vindex gnus-thread-hide-subtree
6528 If non-@code{nil}, all threads will be hidden when the summary buffer is
6529 generated.
6530
6531 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
6532 Available predicates are @code{gnus-article-unread-p} and
6533 @code{gnus-article-unseen-p}).
6534
6535 Here's an example:
6536
6537 @lisp
6538 (setq gnus-thread-hide-subtree
6539       '(or gnus-article-unread-p
6540            gnus-article-unseen-p))
6541 @end lisp
6542
6543 (It's a pretty nonsensical example, since all unseen articles are also
6544 unread, but you get my drift.)
6545
6546
6547 @item gnus-thread-expunge-below
6548 @vindex gnus-thread-expunge-below
6549 All threads that have a total score (as defined by
6550 @code{gnus-thread-score-function}) less than this number will be
6551 expunged.  This variable is @code{nil} by default, which means that no
6552 threads are expunged.
6553
6554 @item gnus-thread-hide-killed
6555 @vindex gnus-thread-hide-killed
6556 if you kill a thread and this variable is non-@code{nil}, the subtree
6557 will be hidden.
6558
6559 @item gnus-thread-ignore-subject
6560 @vindex gnus-thread-ignore-subject
6561 Sometimes somebody changes the subject in the middle of a thread.  If
6562 this variable is non-@code{nil}, which is the default, the subject
6563 change is ignored.  If it is @code{nil}, a change in the subject will
6564 result in a new thread.
6565
6566 @item gnus-thread-indent-level
6567 @vindex gnus-thread-indent-level
6568 This is a number that says how much each sub-thread should be indented.
6569 The default is 4.
6570
6571 @item gnus-sort-gathered-threads-function
6572 @vindex gnus-sort-gathered-threads-function
6573 Sometimes, particularly with mailing lists, the order in which mails
6574 arrive locally is not necessarily the same as the order in which they
6575 arrived on the mailing list.  Consequently, when sorting sub-threads
6576 using the default @code{gnus-thread-sort-by-number}, responses can end
6577 up appearing before the article to which they are responding to.
6578 Setting this variable to an alternate value
6579 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6580 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6581 more logical sub-thread ordering in such instances.
6582
6583 @end table
6584
6585
6586 @node Low-Level Threading
6587 @subsubsection Low-Level Threading
6588
6589 @table @code
6590
6591 @item gnus-parse-headers-hook
6592 @vindex gnus-parse-headers-hook
6593 Hook run before parsing any headers.  The default value is
6594 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6595 @code{default-mime-charset} in summary buffer based on variable
6596 @code{gnus-newsgroup-default-charset-alist}.
6597
6598 @item gnus-alter-header-function
6599 @vindex gnus-alter-header-function
6600 If non-@code{nil}, this function will be called to allow alteration of
6601 article header structures.  The function is called with one parameter,
6602 the article header vector, which it may alter in any way.  For instance,
6603 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6604 in systematic ways (by adding prefixes and such), you can use this
6605 variable to un-scramble the @code{Message-ID}s so that they are more
6606 meaningful.  Here's one example:
6607
6608 @lisp
6609 (setq gnus-alter-header-function 'my-alter-message-id)
6610
6611 (defun my-alter-message-id (header)
6612   (let ((id (mail-header-id header)))
6613     (when (string-match
6614            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6615       (mail-header-set-id
6616        (concat (match-string 1 id) "@@" (match-string 2 id))
6617        header))))
6618 @end lisp
6619
6620 @end table
6621
6622
6623 @node Thread Commands
6624 @subsection Thread Commands
6625 @cindex thread commands
6626
6627 @table @kbd
6628
6629 @item T k
6630 @itemx C-M-k
6631 @kindex T k (Summary)
6632 @kindex C-M-k (Summary)
6633 @findex gnus-summary-kill-thread
6634 Mark all articles in the current (sub-)thread as read
6635 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
6636 remove all marks instead.  If the prefix argument is negative, tick
6637 articles instead.
6638
6639 @item T l
6640 @itemx C-M-l
6641 @kindex T l (Summary)
6642 @kindex C-M-l (Summary)
6643 @findex gnus-summary-lower-thread
6644 Lower the score of the current (sub-)thread
6645 (@code{gnus-summary-lower-thread}).
6646
6647 @item T i
6648 @kindex T i (Summary)
6649 @findex gnus-summary-raise-thread
6650 Increase the score of the current (sub-)thread
6651 (@code{gnus-summary-raise-thread}).
6652
6653 @item T #
6654 @kindex T # (Summary)
6655 @findex gnus-uu-mark-thread
6656 Set the process mark on the current (sub-)thread
6657 (@code{gnus-uu-mark-thread}).
6658
6659 @item T M-#
6660 @kindex T M-# (Summary)
6661 @findex gnus-uu-unmark-thread
6662 Remove the process mark from the current (sub-)thread
6663 (@code{gnus-uu-unmark-thread}).
6664
6665 @item T T
6666 @kindex T T (Summary)
6667 @findex gnus-summary-toggle-threads
6668 Toggle threading (@code{gnus-summary-toggle-threads}).
6669
6670 @item T s
6671 @kindex T s (Summary)
6672 @findex gnus-summary-show-thread
6673 Expose the (sub-)thread hidden under the current article, if any
6674 (@code{gnus-summary-show-thread}).
6675
6676 @item T h
6677 @kindex T h (Summary)
6678 @findex gnus-summary-hide-thread
6679 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6680
6681 @item T S
6682 @kindex T S (Summary)
6683 @findex gnus-summary-show-all-threads
6684 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6685
6686 @item T H
6687 @kindex T H (Summary)
6688 @findex gnus-summary-hide-all-threads
6689 Hide all threads (@code{gnus-summary-hide-all-threads}).
6690
6691 @item T t
6692 @kindex T t (Summary)
6693 @findex gnus-summary-rethread-current
6694 Re-thread the current article's thread
6695 (@code{gnus-summary-rethread-current}).  This works even when the
6696 summary buffer is otherwise unthreaded.
6697
6698 @item T ^
6699 @kindex T ^ (Summary)
6700 @findex gnus-summary-reparent-thread
6701 Make the current article the child of the marked (or previous) article
6702 (@code{gnus-summary-reparent-thread}).
6703
6704 @end table
6705
6706 The following commands are thread movement commands.  They all
6707 understand the numeric prefix.
6708
6709 @table @kbd
6710
6711 @item T n
6712 @kindex T n (Summary)
6713 @itemx C-M-f
6714 @kindex C-M-n (Summary)
6715 @itemx M-down
6716 @kindex M-down (Summary)
6717 @findex gnus-summary-next-thread
6718 Go to the next thread (@code{gnus-summary-next-thread}).
6719
6720 @item T p
6721 @kindex T p (Summary)
6722 @itemx C-M-b
6723 @kindex C-M-p (Summary)
6724 @itemx M-up
6725 @kindex M-up (Summary)
6726 @findex gnus-summary-prev-thread
6727 Go to the previous thread (@code{gnus-summary-prev-thread}).
6728
6729 @item T d
6730 @kindex T d (Summary)
6731 @findex gnus-summary-down-thread
6732 Descend the thread (@code{gnus-summary-down-thread}).
6733
6734 @item T u
6735 @kindex T u (Summary)
6736 @findex gnus-summary-up-thread
6737 Ascend the thread (@code{gnus-summary-up-thread}).
6738
6739 @item T o
6740 @kindex T o (Summary)
6741 @findex gnus-summary-top-thread
6742 Go to the top of the thread (@code{gnus-summary-top-thread}).
6743 @end table
6744
6745 @vindex gnus-thread-operation-ignore-subject
6746 If you ignore subject while threading, you'll naturally end up with
6747 threads that have several different subjects in them.  If you then issue
6748 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6749 wish to kill the entire thread, but just those parts of the thread that
6750 have the same subject as the current article.  If you like this idea,
6751 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
6752 is non-@code{nil} (which it is by default), subjects will be ignored
6753 when doing thread commands.  If this variable is @code{nil}, articles in
6754 the same thread with different subjects will not be included in the
6755 operation in question.  If this variable is @code{fuzzy}, only articles
6756 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6757 Matching}).
6758
6759
6760 @node Sorting the Summary Buffer
6761 @section Sorting the Summary Buffer
6762
6763 @findex gnus-thread-sort-by-total-score
6764 @findex gnus-thread-sort-by-date
6765 @findex gnus-thread-sort-by-score
6766 @findex gnus-thread-sort-by-subject
6767 @findex gnus-thread-sort-by-author
6768 @findex gnus-thread-sort-by-number
6769 @findex gnus-thread-sort-by-random
6770 @vindex gnus-thread-sort-functions
6771 @findex gnus-thread-sort-by-most-recent-thread
6772 If you are using a threaded summary display, you can sort the threads by
6773 setting @code{gnus-thread-sort-functions}, which can be either a single
6774 function, a list of functions, or a list containing functions and
6775 @code{(not some-function)} elements.
6776
6777 By default, sorting is done on article numbers.  Ready-made sorting
6778 predicate functions include @code{gnus-thread-sort-by-number},
6779 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6780 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score},
6781 @code{gnus-thread-sort-by-most-recent-number},
6782 @code{gnus-thread-sort-by-most-recent-date},
6783 @code{gnus-thread-sort-by-random} and
6784 @code{gnus-thread-sort-by-total-score}.
6785
6786 Each function takes two threads and returns non-@code{nil} if the first
6787 thread should be sorted before the other.  Note that sorting really is
6788 normally done by looking only at the roots of each thread.
6789
6790 If you use more than one function, the primary sort key should be the
6791 last function in the list.  You should probably always include
6792 @code{gnus-thread-sort-by-number} in the list of sorting
6793 functions---preferably first.  This will ensure that threads that are
6794 equal with respect to the other sort criteria will be displayed in
6795 ascending article order.
6796
6797 If you would like to sort by reverse score, then by subject, and finally
6798 by number, you could do something like:
6799
6800 @lisp
6801 (setq gnus-thread-sort-functions
6802       '(gnus-thread-sort-by-number
6803         gnus-thread-sort-by-subject
6804         (not gnus-thread-sort-by-total-score)))
6805 @end lisp
6806
6807 The threads that have highest score will be displayed first in the
6808 summary buffer.  When threads have the same score, they will be sorted
6809 alphabetically.  The threads that have the same score and the same
6810 subject will be sorted by number, which is (normally) the sequence in
6811 which the articles arrived.
6812
6813 If you want to sort by score and then reverse arrival order, you could
6814 say something like:
6815
6816 @lisp
6817 (setq gnus-thread-sort-functions
6818       '((lambda (t1 t2)
6819           (not (gnus-thread-sort-by-number t1 t2)))
6820         gnus-thread-sort-by-score))
6821 @end lisp
6822
6823 @vindex gnus-thread-score-function
6824 The function in the @code{gnus-thread-score-function} variable (default
6825 @code{+}) is used for calculating the total score of a thread.  Useful
6826 functions might be @code{max}, @code{min}, or squared means, or whatever
6827 tickles your fancy.
6828
6829 @findex gnus-article-sort-functions
6830 @findex gnus-article-sort-by-date
6831 @findex gnus-article-sort-by-score
6832 @findex gnus-article-sort-by-subject
6833 @findex gnus-article-sort-by-author
6834 @findex gnus-article-sort-by-random
6835 @findex gnus-article-sort-by-number
6836 If you are using an unthreaded display for some strange reason or
6837 other, you have to fiddle with the @code{gnus-article-sort-functions}
6838 variable.  It is very similar to the
6839 @code{gnus-thread-sort-functions}, except that it uses slightly
6840 different functions for article comparison.  Available sorting
6841 predicate functions are @code{gnus-article-sort-by-number},
6842 @code{gnus-article-sort-by-author},
6843 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
6844 @code{gnus-article-sort-by-random}, and
6845 @code{gnus-article-sort-by-score}.
6846
6847 If you want to sort an unthreaded summary display by subject, you could
6848 say something like:
6849
6850 @lisp
6851 (setq gnus-article-sort-functions
6852       '(gnus-article-sort-by-number
6853         gnus-article-sort-by-subject))
6854 @end lisp
6855
6856
6857
6858 @node Asynchronous Fetching
6859 @section Asynchronous Article Fetching
6860 @cindex asynchronous article fetching
6861 @cindex article pre-fetch
6862 @cindex pre-fetch
6863
6864 If you read your news from an @sc{nntp} server that's far away, the
6865 network latencies may make reading articles a chore.  You have to wait
6866 for a while after pressing @kbd{n} to go to the next article before the
6867 article appears.  Why can't gnus just go ahead and fetch the article
6868 while you are reading the previous one?  Why not, indeed.
6869
6870 First, some caveats.  There are some pitfalls to using asynchronous
6871 article fetching, especially the way gnus does it.
6872
6873 Let's say you are reading article 1, which is short, and article 2 is
6874 quite long, and you are not interested in reading that.  Gnus does not
6875 know this, so it goes ahead and fetches article 2.  You decide to read
6876 article 3, but since gnus is in the process of fetching article 2, the
6877 connection is blocked.
6878
6879 To avoid these situations, gnus will open two (count 'em two)
6880 connections to the server.  Some people may think this isn't a very nice
6881 thing to do, but I don't see any real alternatives.  Setting up that
6882 extra connection takes some time, so gnus startup will be slower.
6883
6884 Gnus will fetch more articles than you will read.  This will mean that
6885 the link between your machine and the @sc{nntp} server will become more
6886 loaded than if you didn't use article pre-fetch.  The server itself will
6887 also become more loaded---both with the extra article requests, and the
6888 extra connection.
6889
6890 Ok, so now you know that you shouldn't really use this thing...  unless
6891 you really want to.
6892
6893 @vindex gnus-asynchronous
6894 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
6895 happen automatically.
6896
6897 @vindex gnus-use-article-prefetch
6898 You can control how many articles are to be pre-fetched by setting
6899 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
6900 that when you read an article in the group, the back end will pre-fetch
6901 the next 30 articles.  If this variable is @code{t}, the back end will
6902 pre-fetch all the articles it can without bound.  If it is
6903 @code{nil}, no pre-fetching will be done.
6904
6905 @vindex gnus-async-prefetch-article-p
6906 @findex gnus-async-read-p
6907 There are probably some articles that you don't want to pre-fetch---read
6908 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
6909 return non-@code{nil} when the article in question is to be
6910 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
6911 @code{nil} on read articles.  The function is called with an article
6912 data structure as the only parameter.
6913
6914 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6915
6916 @lisp
6917 (defun my-async-short-unread-p (data)
6918   "Return non-nil for short, unread articles."
6919   (and (gnus-data-unread-p data)
6920        (< (mail-header-lines (gnus-data-header data))
6921           100)))
6922
6923 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6924 @end lisp
6925
6926 These functions will be called many, many times, so they should
6927 preferably be short and sweet to avoid slowing down gnus too much.
6928 It's probably a good idea to byte-compile things like this.
6929
6930 @vindex gnus-prefetched-article-deletion-strategy
6931 Articles have to be removed from the asynch buffer sooner or later.  The
6932 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6933 articles.  This is a list that may contain the following elements:
6934
6935 @table @code
6936 @item read
6937 Remove articles when they are read.
6938
6939 @item exit
6940 Remove articles when exiting the group.
6941 @end table
6942
6943 The default value is @code{(read exit)}.
6944
6945 @c @vindex gnus-use-header-prefetch
6946 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6947 @c from the next group.
6948
6949
6950 @node Article Caching
6951 @section Article Caching
6952 @cindex article caching
6953 @cindex caching
6954
6955 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6956 consider turning article caching on.  Each article will then be stored
6957 locally under your home directory.  As you may surmise, this could
6958 potentially use @emph{huge} amounts of disk space, as well as eat up all
6959 your inodes so fast it will make your head swim.  In vodka.
6960
6961 Used carefully, though, it could be just an easier way to save articles.
6962
6963 @vindex gnus-use-long-file-name
6964 @vindex gnus-cache-directory
6965 @vindex gnus-use-cache
6966 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
6967 all articles ticked or marked as dormant will then be copied
6968 over to your local cache (@code{gnus-cache-directory}).  Whether this
6969 cache is flat or hierarchical is controlled by the
6970 @code{gnus-use-long-file-name} variable, as usual.
6971
6972 When re-selecting a ticked or dormant article, it will be fetched from the
6973 cache instead of from the server.  As articles in your cache will never
6974 expire, this might serve as a method of saving articles while still
6975 keeping them where they belong.  Just mark all articles you want to save
6976 as dormant, and don't worry.
6977
6978 When an article is marked as read, is it removed from the cache.
6979
6980 @vindex gnus-cache-remove-articles
6981 @vindex gnus-cache-enter-articles
6982 The entering/removal of articles from the cache is controlled by the
6983 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6984 variables.  Both are lists of symbols.  The first is @code{(ticked
6985 dormant)} by default, meaning that ticked and dormant articles will be
6986 put in the cache.  The latter is @code{(read)} by default, meaning that
6987 articles marked as read are removed from the cache.  Possibly
6988 symbols in these two lists are @code{ticked}, @code{dormant},
6989 @code{unread} and @code{read}.
6990
6991 @findex gnus-jog-cache
6992 So where does the massive article-fetching and storing come into the
6993 picture?  The @code{gnus-jog-cache} command will go through all
6994 subscribed newsgroups, request all unread articles, score them, and
6995 store them in the cache.  You should only ever, ever ever ever, use this
6996 command if 1) your connection to the @sc{nntp} server is really, really,
6997 really slow and 2) you have a really, really, really huge disk.
6998 Seriously.  One way to cut down on the number of articles downloaded is
6999 to score unwanted articles down and have them marked as read.  They will
7000 not then be downloaded by this command.
7001
7002 @vindex gnus-uncacheable-groups
7003 @vindex gnus-cacheable-groups
7004 It is likely that you do not want caching on all groups.  For instance,
7005 if your @code{nnml} mail is located under your home directory, it makes no
7006 sense to cache it somewhere else under your home directory.  Unless you
7007 feel that it's neat to use twice as much space.
7008
7009 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7010 regexp of groups to cache, @samp{^nntp} for instance, or set the
7011 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7012 Both variables are @code{nil} by default.  If a group matches both
7013 variables, the group is not cached.
7014
7015 @findex gnus-cache-generate-nov-databases
7016 @findex gnus-cache-generate-active
7017 @vindex gnus-cache-active-file
7018 The cache stores information on what articles it contains in its active
7019 file (@code{gnus-cache-active-file}).  If this file (or any other parts
7020 of the cache) becomes all messed up for some reason or other, gnus
7021 offers two functions that will try to set things right.  @kbd{M-x
7022 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
7023 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7024 file.
7025
7026 @findex gnus-cache-move-cache
7027 @code{gnus-cache-move-cache} will move your whole
7028 @code{gnus-cache-directory} to some other location. You get asked to
7029 where, isn't that cool?
7030
7031 @node Persistent Articles
7032 @section Persistent Articles
7033 @cindex persistent articles
7034
7035 Closely related to article caching, we have @dfn{persistent articles}.
7036 In fact, it's just a different way of looking at caching, and much more
7037 useful in my opinion.
7038
7039 Say you're reading a newsgroup, and you happen on to some valuable gem
7040 that you want to keep and treasure forever.  You'd normally just save it
7041 (using one of the many saving commands) in some file.  The problem with
7042 that is that it's just, well, yucky.  Ideally you'd prefer just having
7043 the article remain in the group where you found it forever; untouched by
7044 the expiry going on at the news server.
7045
7046 This is what a @dfn{persistent article} is---an article that just won't
7047 be deleted.  It's implemented using the normal cache functions, but
7048 you use two explicit commands for managing persistent articles:
7049
7050 @table @kbd
7051
7052 @item *
7053 @kindex * (Summary)
7054 @findex gnus-cache-enter-article
7055 Make the current article persistent (@code{gnus-cache-enter-article}).
7056
7057 @item M-*
7058 @kindex M-* (Summary)
7059 @findex gnus-cache-remove-article
7060 Remove the current article from the persistent articles
7061 (@code{gnus-cache-remove-article}).  This will normally delete the
7062 article.
7063 @end table
7064
7065 Both these commands understand the process/prefix convention.
7066
7067 To avoid having all ticked articles (and stuff) entered into the cache,
7068 you should set @code{gnus-use-cache} to @code{passive} if you're just
7069 interested in persistent articles:
7070
7071 @lisp
7072 (setq gnus-use-cache 'passive)
7073 @end lisp
7074
7075
7076 @node Article Backlog
7077 @section Article Backlog
7078 @cindex backlog
7079 @cindex article backlog
7080
7081 If you have a slow connection, but the idea of using caching seems
7082 unappealing to you (and it is, really), you can help the situation some
7083 by switching on the @dfn{backlog}.  This is where gnus will buffer
7084 already read articles so that it doesn't have to re-fetch articles
7085 you've already read.  This only helps if you are in the habit of
7086 re-selecting articles you've recently read, of course.  If you never do
7087 that, turning the backlog on will slow gnus down a little bit, and
7088 increase memory usage some.
7089
7090 @vindex gnus-keep-backlog
7091 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
7092 at most @var{n} old articles in a buffer for later re-fetching.  If this
7093 variable is non-@code{nil} and is not a number, gnus will store
7094 @emph{all} read articles, which means that your Emacs will grow without
7095 bound before exploding and taking your machine down with you.  I put
7096 that in there just to keep y'all on your toes.
7097
7098 This variable is @code{nil} by default.
7099
7100
7101 @node Saving Articles
7102 @section Saving Articles
7103 @cindex saving articles
7104
7105 Gnus can save articles in a number of ways.  Below is the documentation
7106 for saving articles in a fairly straight-forward fashion (i.e., little
7107 processing of the article is done before it is saved).  For a different
7108 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7109 (@pxref{Decoding Articles}).
7110
7111 For the commands listed here, the target is a file.  If you want to
7112 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7113 command (@pxref{Mail Group Commands}).
7114
7115 @vindex gnus-save-all-headers
7116 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
7117 unwanted headers before saving the article.
7118
7119 @vindex gnus-saved-headers
7120 If the preceding variable is @code{nil}, all headers that match the
7121 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7122 deleted before saving.
7123
7124 @table @kbd
7125
7126 @item O o
7127 @itemx o
7128 @kindex O o (Summary)
7129 @kindex o (Summary)
7130 @findex gnus-summary-save-article
7131 @c @icon{gnus-summary-save-article}
7132 Save the current article using the default article saver
7133 (@code{gnus-summary-save-article}).
7134
7135 @item O m
7136 @kindex O m (Summary)
7137 @findex gnus-summary-save-article-mail
7138 Save the current article in mail format
7139 (@code{gnus-summary-save-article-mail}).
7140
7141 @item O r
7142 @kindex O r (Summary)
7143 @findex gnus-summary-save-article-rmail
7144 Save the current article in rmail format
7145 (@code{gnus-summary-save-article-rmail}).
7146
7147 @item O f
7148 @kindex O f (Summary)
7149 @findex gnus-summary-save-article-file
7150 @c @icon{gnus-summary-save-article-file}
7151 Save the current article in plain file format
7152 (@code{gnus-summary-save-article-file}).
7153
7154 @item O F
7155 @kindex O F (Summary)
7156 @findex gnus-summary-write-article-file
7157 Write the current article in plain file format, overwriting any previous
7158 file contents (@code{gnus-summary-write-article-file}).
7159
7160 @item O b
7161 @kindex O b (Summary)
7162 @findex gnus-summary-save-article-body-file
7163 Save the current article body in plain file format
7164 (@code{gnus-summary-save-article-body-file}).
7165
7166 @item O h
7167 @kindex O h (Summary)
7168 @findex gnus-summary-save-article-folder
7169 Save the current article in mh folder format
7170 (@code{gnus-summary-save-article-folder}).
7171
7172 @item O v
7173 @kindex O v (Summary)
7174 @findex gnus-summary-save-article-vm
7175 Save the current article in a VM folder
7176 (@code{gnus-summary-save-article-vm}).
7177
7178 @item O p
7179 @itemx |
7180 @kindex O p (Summary)
7181 @kindex | (Summary)
7182 @findex gnus-summary-pipe-output
7183 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
7184 the current article to a process (@code{gnus-summary-pipe-output}).
7185 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7186 complete headers in the piped output.
7187
7188 @item O P
7189 @kindex O P (Summary)
7190 @findex gnus-summary-muttprint
7191 @vindex gnus-summary-muttprint-program
7192 Save the current article into muttprint. That is, print it using the
7193 external program Muttprint (see
7194 @uref{http://muttprint.sourceforge.net/}). The program name and
7195 options to use is controlled by the variable
7196 @code{gnus-summary-muttprint-program}. (@code{gnus-summary-muttprint}).
7197
7198 @end table
7199
7200 @vindex gnus-prompt-before-saving
7201 All these commands use the process/prefix convention
7202 (@pxref{Process/Prefix}).  If you save bunches of articles using these
7203 functions, you might get tired of being prompted for files to save each
7204 and every article in.  The prompting action is controlled by
7205 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7206 default, giving you that excessive prompting action you know and
7207 loathe.  If you set this variable to @code{t} instead, you'll be prompted
7208 just once for each series of articles you save.  If you like to really
7209 have Gnus do all your thinking for you, you can even set this variable
7210 to @code{nil}, which means that you will never be prompted for files to
7211 save articles in.  Gnus will simply save all the articles in the default
7212 files.
7213
7214
7215 @vindex gnus-default-article-saver
7216 You can customize the @code{gnus-default-article-saver} variable to make
7217 gnus do what you want it to.  You can use any of the six ready-made
7218 functions below, or you can create your own.
7219
7220 @table @code
7221
7222 @item gnus-summary-save-in-rmail
7223 @findex gnus-summary-save-in-rmail
7224 @vindex gnus-rmail-save-name
7225 @findex gnus-plain-save-name
7226 This is the default format, @dfn{babyl}.  Uses the function in the
7227 @code{gnus-rmail-save-name} variable to get a file name to save the
7228 article in.  The default is @code{gnus-plain-save-name}.
7229
7230 @item gnus-summary-save-in-mail
7231 @findex gnus-summary-save-in-mail
7232 @vindex gnus-mail-save-name
7233 Save in a Unix mail (mbox) file.  Uses the function in the
7234 @code{gnus-mail-save-name} variable to get a file name to save the
7235 article in.  The default is @code{gnus-plain-save-name}.
7236
7237 @item gnus-summary-save-in-file
7238 @findex gnus-summary-save-in-file
7239 @vindex gnus-file-save-name
7240 @findex gnus-numeric-save-name
7241 Append the article straight to an ordinary file.  Uses the function in
7242 the @code{gnus-file-save-name} variable to get a file name to save the
7243 article in.  The default is @code{gnus-numeric-save-name}.
7244
7245 @item gnus-summary-write-to-file
7246 @findex gnus-summary-write-to-file
7247 Write the article straight to an ordinary file.  The file is
7248 overwritten if it exists.  Uses the function in the
7249 @code{gnus-file-save-name} variable to get a file name to save the
7250 article in.  The default is @code{gnus-numeric-save-name}.
7251
7252 @item gnus-summary-save-body-in-file
7253 @findex gnus-summary-save-body-in-file
7254 Append the article body to an ordinary file.  Uses the function in the
7255 @code{gnus-file-save-name} variable to get a file name to save the
7256 article in.  The default is @code{gnus-numeric-save-name}.
7257
7258 @item gnus-summary-save-in-folder
7259 @findex gnus-summary-save-in-folder
7260 @findex gnus-folder-save-name
7261 @findex gnus-Folder-save-name
7262 @vindex gnus-folder-save-name
7263 @cindex rcvstore
7264 @cindex MH folders
7265 Save the article to an MH folder using @code{rcvstore} from the MH
7266 library.  Uses the function in the @code{gnus-folder-save-name} variable
7267 to get a file name to save the article in.  The default is
7268 @code{gnus-folder-save-name}, but you can also use
7269 @code{gnus-Folder-save-name}, which creates capitalized names.
7270
7271 @item gnus-summary-save-in-vm
7272 @findex gnus-summary-save-in-vm
7273 Save the article in a VM folder.  You have to have the VM mail
7274 reader to use this setting.
7275 @end table
7276
7277 @vindex gnus-article-save-directory
7278 All of these functions, except for the last one, will save the article
7279 in the @code{gnus-article-save-directory}, which is initialized from the
7280 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
7281 default.
7282
7283 As you can see above, the functions use different functions to find a
7284 suitable name of a file to save the article in.  Below is a list of
7285 available functions that generate names:
7286
7287 @table @code
7288
7289 @item gnus-Numeric-save-name
7290 @findex gnus-Numeric-save-name
7291 File names like @file{~/News/Alt.andrea-dworkin/45}.
7292
7293 @item gnus-numeric-save-name
7294 @findex gnus-numeric-save-name
7295 File names like @file{~/News/alt.andrea-dworkin/45}.
7296
7297 @item gnus-Plain-save-name
7298 @findex gnus-Plain-save-name
7299 File names like @file{~/News/Alt.andrea-dworkin}.
7300
7301 @item gnus-plain-save-name
7302 @findex gnus-plain-save-name
7303 File names like @file{~/News/alt.andrea-dworkin}.
7304
7305 @item gnus-sender-save-name
7306 @findex gnus-sender-save-name
7307 File names like @file{~/News/larsi}.
7308 @end table
7309
7310 @vindex gnus-split-methods
7311 You can have gnus suggest where to save articles by plonking a regexp into
7312 the @code{gnus-split-methods} alist.  For instance, if you would like to
7313 save articles related to gnus in the file @file{gnus-stuff}, and articles
7314 related to VM in @code{vm-stuff}, you could set this variable to something
7315 like:
7316
7317 @lisp
7318 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7319  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7320  (my-choosing-function "../other-dir/my-stuff")
7321  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7322 @end lisp
7323
7324 We see that this is a list where each element is a list that has two
7325 elements---the @dfn{match} and the @dfn{file}.  The match can either be
7326 a string (in which case it is used as a regexp to match on the article
7327 head); it can be a symbol (which will be called as a function with the
7328 group name as a parameter); or it can be a list (which will be
7329 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
7330 the @dfn{file} will be used as a default prompt.  In addition, the
7331 result of the operation itself will be used if the function or form
7332 called returns a string or a list of strings.
7333
7334 You basically end up with a list of file names that might be used when
7335 saving the current article.  (All ``matches'' will be used.)  You will
7336 then be prompted for what you really want to use as a name, with file
7337 name completion over the results from applying this variable.
7338
7339 This variable is @code{((gnus-article-archive-name))} by default, which
7340 means that gnus will look at the articles it saves for an
7341 @code{Archive-name} line and use that as a suggestion for the file
7342 name.
7343
7344 Here's an example function to clean up file names somewhat.  If you have
7345 lots of mail groups called things like
7346 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7347 these group names before creating the file name to save to.  The
7348 following will do just that:
7349
7350 @lisp
7351 (defun my-save-name (group)
7352   (when (string-match "^nnml:mail." group)
7353     (substring group (match-end 0))))
7354
7355 (setq gnus-split-methods
7356       '((gnus-article-archive-name)
7357         (my-save-name)))
7358 @end lisp
7359
7360
7361 @vindex gnus-use-long-file-name
7362 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
7363 @code{nil}, all the preceding functions will replace all periods
7364 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7365 the functions will generate hierarchies of directories instead of having
7366 all the files in the top level directory
7367 (@file{~/News/alt/andrea-dworkin} instead of
7368 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
7369 on most systems.  However, for historical reasons, this is @code{nil} on
7370 Xenix and usg-unix-v machines by default.
7371
7372 This function also affects kill and score file names.  If this variable
7373 is a list, and the list contains the element @code{not-score}, long file
7374 names will not be used for score files, if it contains the element
7375 @code{not-save}, long file names will not be used for saving, and if it
7376 contains the element @code{not-kill}, long file names will not be used
7377 for kill files.
7378
7379 If you'd like to save articles in a hierarchy that looks something like
7380 a spool, you could
7381
7382 @lisp
7383 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
7384 (setq gnus-default-article-saver
7385       'gnus-summary-save-in-file) ; no encoding
7386 @end lisp
7387
7388 Then just save with @kbd{o}.  You'd then read this hierarchy with
7389 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7390 the top level directory as the argument (@file{~/News/}).  Then just walk
7391 around to the groups/directories with @code{nneething}.
7392
7393
7394 @node Decoding Articles
7395 @section Decoding Articles
7396 @cindex decoding articles
7397
7398 Sometime users post articles (or series of articles) that have been
7399 encoded in some way or other.  Gnus can decode them for you.
7400
7401 @menu
7402 * Uuencoded Articles::          Uudecode articles.
7403 * Shell Archives::              Unshar articles.
7404 * PostScript Files::            Split PostScript.
7405 * Other Files::                 Plain save and binhex.
7406 * Decoding Variables::          Variables for a happy decoding.
7407 * Viewing Files::               You want to look at the result of the decoding?
7408 @end menu
7409
7410 @cindex series
7411 @cindex article series
7412 All these functions use the process/prefix convention
7413 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7414 the extension that a ``single article'' means ``a single series''.  Gnus
7415 can find out by itself what articles belong to a series, decode all the
7416 articles and unpack/view/save the resulting file(s).
7417
7418 Gnus guesses what articles are in the series according to the following
7419 simplish rule: The subjects must be (nearly) identical, except for the
7420 last two numbers of the line.  (Spaces are largely ignored, however.)
7421
7422 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7423 will find all the articles that match the regexp @samp{^cat.gif
7424 ([0-9]+/[0-9]+).*$}.
7425
7426 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7427 series}, will not be properly recognized by any of the automatic viewing
7428 commands, and you have to mark the articles manually with @kbd{#}.
7429
7430
7431 @node Uuencoded Articles
7432 @subsection Uuencoded Articles
7433 @cindex uudecode
7434 @cindex uuencoded articles
7435
7436 @table @kbd
7437
7438 @item X u
7439 @kindex X u (Summary)
7440 @findex gnus-uu-decode-uu
7441 @c @icon{gnus-uu-decode-uu}
7442 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7443
7444 @item X U
7445 @kindex X U (Summary)
7446 @findex gnus-uu-decode-uu-and-save
7447 Uudecodes and saves the current series
7448 (@code{gnus-uu-decode-uu-and-save}).
7449
7450 @item X v u
7451 @kindex X v u (Summary)
7452 @findex gnus-uu-decode-uu-view
7453 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7454
7455 @item X v U
7456 @kindex X v U (Summary)
7457 @findex gnus-uu-decode-uu-and-save-view
7458 Uudecodes, views and saves the current series
7459 (@code{gnus-uu-decode-uu-and-save-view}).
7460
7461 @end table
7462
7463 Remember that these all react to the presence of articles marked with
7464 the process mark.  If, for instance, you'd like to decode and save an
7465 entire newsgroup, you'd typically do @kbd{M P a}
7466 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7467 (@code{gnus-uu-decode-uu-and-save}).
7468
7469 All this is very much different from how @code{gnus-uu} worked with
7470 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7471 the sun.  This version of @code{gnus-uu} generally assumes that you mark
7472 articles in some way (@pxref{Setting Process Marks}) and then press
7473 @kbd{X u}.
7474
7475 @vindex gnus-uu-notify-files
7476 Note: When trying to decode articles that have names matching
7477 @code{gnus-uu-notify-files}, which is hard-coded to
7478 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7479 automatically post an article on @samp{comp.unix.wizards} saying that
7480 you have just viewed the file in question.  This feature can't be turned
7481 off.
7482
7483
7484 @node Shell Archives
7485 @subsection Shell Archives
7486 @cindex unshar
7487 @cindex shell archives
7488 @cindex shared articles
7489
7490 Shell archives (``shar files'') used to be a popular way to distribute
7491 sources, but it isn't used all that much today.  In any case, we have
7492 some commands to deal with these:
7493
7494 @table @kbd
7495
7496 @item X s
7497 @kindex X s (Summary)
7498 @findex gnus-uu-decode-unshar
7499 Unshars the current series (@code{gnus-uu-decode-unshar}).
7500
7501 @item X S
7502 @kindex X S (Summary)
7503 @findex gnus-uu-decode-unshar-and-save
7504 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7505
7506 @item X v s
7507 @kindex X v s (Summary)
7508 @findex gnus-uu-decode-unshar-view
7509 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7510
7511 @item X v S
7512 @kindex X v S (Summary)
7513 @findex gnus-uu-decode-unshar-and-save-view
7514 Unshars, views and saves the current series
7515 (@code{gnus-uu-decode-unshar-and-save-view}).
7516 @end table
7517
7518
7519 @node PostScript Files
7520 @subsection PostScript Files
7521 @cindex PostScript
7522
7523 @table @kbd
7524
7525 @item X p
7526 @kindex X p (Summary)
7527 @findex gnus-uu-decode-postscript
7528 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7529
7530 @item X P
7531 @kindex X P (Summary)
7532 @findex gnus-uu-decode-postscript-and-save
7533 Unpack and save the current PostScript series
7534 (@code{gnus-uu-decode-postscript-and-save}).
7535
7536 @item X v p
7537 @kindex X v p (Summary)
7538 @findex gnus-uu-decode-postscript-view
7539 View the current PostScript series
7540 (@code{gnus-uu-decode-postscript-view}).
7541
7542 @item X v P
7543 @kindex X v P (Summary)
7544 @findex gnus-uu-decode-postscript-and-save-view
7545 View and save the current PostScript series
7546 (@code{gnus-uu-decode-postscript-and-save-view}).
7547 @end table
7548
7549
7550 @node Other Files
7551 @subsection Other Files
7552
7553 @table @kbd
7554 @item X o
7555 @kindex X o (Summary)
7556 @findex gnus-uu-decode-save
7557 Save the current series
7558 (@code{gnus-uu-decode-save}).
7559
7560 @item X b
7561 @kindex X b (Summary)
7562 @findex gnus-uu-decode-binhex
7563 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
7564 doesn't really work yet.
7565 @end table
7566
7567
7568 @node Decoding Variables
7569 @subsection Decoding Variables
7570
7571 Adjective, not verb.
7572
7573 @menu
7574 * Rule Variables::              Variables that say how a file is to be viewed.
7575 * Other Decode Variables::      Other decode variables.
7576 * Uuencoding and Posting::      Variables for customizing uuencoding.
7577 @end menu
7578
7579
7580 @node Rule Variables
7581 @subsubsection Rule Variables
7582 @cindex rule variables
7583
7584 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
7585 variables are of the form
7586
7587 @lisp
7588       (list '(regexp1 command2)
7589             '(regexp2 command2)
7590             ...)
7591 @end lisp
7592
7593 @table @code
7594
7595 @item gnus-uu-user-view-rules
7596 @vindex gnus-uu-user-view-rules
7597 @cindex sox
7598 This variable is consulted first when viewing files.  If you wish to use,
7599 for instance, @code{sox} to convert an @samp{.au} sound file, you could
7600 say something like:
7601 @lisp
7602 (setq gnus-uu-user-view-rules
7603       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7604 @end lisp
7605
7606 @item gnus-uu-user-view-rules-end
7607 @vindex gnus-uu-user-view-rules-end
7608 This variable is consulted if gnus couldn't make any matches from the
7609 user and default view rules.
7610
7611 @item gnus-uu-user-archive-rules
7612 @vindex gnus-uu-user-archive-rules
7613 This variable can be used to say what commands should be used to unpack
7614 archives.
7615 @end table
7616
7617
7618 @node Other Decode Variables
7619 @subsubsection Other Decode Variables
7620
7621 @table @code
7622 @vindex gnus-uu-grabbed-file-functions
7623
7624 @item gnus-uu-grabbed-file-functions
7625 All functions in this list will be called right after each file has been
7626 successfully decoded---so that you can move or view files right away,
7627 and don't have to wait for all files to be decoded before you can do
7628 anything.  Ready-made functions you can put in this list are:
7629
7630 @table @code
7631
7632 @item gnus-uu-grab-view
7633 @findex gnus-uu-grab-view
7634 View the file.
7635
7636 @item gnus-uu-grab-move
7637 @findex gnus-uu-grab-move
7638 Move the file (if you're using a saving function.)
7639 @end table
7640
7641 @item gnus-uu-be-dangerous
7642 @vindex gnus-uu-be-dangerous
7643 Specifies what to do if unusual situations arise during decoding.  If
7644 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
7645 that didn't work, and overwrite existing files.  Otherwise, ask each
7646 time.
7647
7648 @item gnus-uu-ignore-files-by-name
7649 @vindex gnus-uu-ignore-files-by-name
7650 Files with name matching this regular expression won't be viewed.
7651
7652 @item gnus-uu-ignore-files-by-type
7653 @vindex gnus-uu-ignore-files-by-type
7654 Files with a @sc{mime} type matching this variable won't be viewed.
7655 Note that Gnus tries to guess what type the file is based on the name.
7656 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
7657 kludgey.
7658
7659 @item gnus-uu-tmp-dir
7660 @vindex gnus-uu-tmp-dir
7661 Where @code{gnus-uu} does its work.
7662
7663 @item gnus-uu-do-not-unpack-archives
7664 @vindex gnus-uu-do-not-unpack-archives
7665 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7666 looking for files to display.
7667
7668 @item gnus-uu-view-and-save
7669 @vindex gnus-uu-view-and-save
7670 Non-@code{nil} means that the user will always be asked to save a file
7671 after viewing it.
7672
7673 @item gnus-uu-ignore-default-view-rules
7674 @vindex gnus-uu-ignore-default-view-rules
7675 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7676 rules.
7677
7678 @item gnus-uu-ignore-default-archive-rules
7679 @vindex gnus-uu-ignore-default-archive-rules
7680 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7681 unpacking commands.
7682
7683 @item gnus-uu-kill-carriage-return
7684 @vindex gnus-uu-kill-carriage-return
7685 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7686 from articles.
7687
7688 @item gnus-uu-unmark-articles-not-decoded
7689 @vindex gnus-uu-unmark-articles-not-decoded
7690 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7691 decoded articles as unread.
7692
7693 @item gnus-uu-correct-stripped-uucode
7694 @vindex gnus-uu-correct-stripped-uucode
7695 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7696 uuencoded files that have had trailing spaces deleted.
7697
7698 @item gnus-uu-pre-uudecode-hook
7699 @vindex gnus-uu-pre-uudecode-hook
7700 Hook run before sending a message to @code{uudecode}.
7701
7702 @item gnus-uu-view-with-metamail
7703 @vindex gnus-uu-view-with-metamail
7704 @cindex metamail
7705 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7706 commands defined by the rule variables and just fudge a @sc{mime}
7707 content type based on the file name.  The result will be fed to
7708 @code{metamail} for viewing.
7709
7710 @item gnus-uu-save-in-digest
7711 @vindex gnus-uu-save-in-digest
7712 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7713 decoding, will save in digests.  If this variable is @code{nil},
7714 @code{gnus-uu} will just save everything in a file without any
7715 embellishments.  The digesting almost conforms to RFC 1153---no easy way
7716 to specify any meaningful volume and issue numbers were found, so I
7717 simply dropped them.
7718
7719 @end table
7720
7721
7722 @node Uuencoding and Posting
7723 @subsubsection Uuencoding and Posting
7724
7725 @table @code
7726
7727 @item gnus-uu-post-include-before-composing
7728 @vindex gnus-uu-post-include-before-composing
7729 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7730 before you compose the article.  If this variable is @code{t}, you can
7731 either include an encoded file with @kbd{C-c C-i} or have one included
7732 for you when you post the article.
7733
7734 @item gnus-uu-post-length
7735 @vindex gnus-uu-post-length
7736 Maximum length of an article.  The encoded file will be split into how
7737 many articles it takes to post the entire file.
7738
7739 @item gnus-uu-post-threaded
7740 @vindex gnus-uu-post-threaded
7741 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7742 thread.  This may not be smart, as no other decoder I have seen is able
7743 to follow threads when collecting uuencoded articles.  (Well, I have
7744 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7745 think that counts...) Default is @code{nil}.
7746
7747 @item gnus-uu-post-separate-description
7748 @vindex gnus-uu-post-separate-description
7749 Non-@code{nil} means that the description will be posted in a separate
7750 article.  The first article will typically be numbered (0/x).  If this
7751 variable is @code{nil}, the description the user enters will be included
7752 at the beginning of the first article, which will be numbered (1/x).
7753 Default is @code{t}.
7754
7755 @end table
7756
7757
7758 @node Viewing Files
7759 @subsection Viewing Files
7760 @cindex viewing files
7761 @cindex pseudo-articles
7762
7763 After decoding, if the file is some sort of archive, gnus will attempt
7764 to unpack the archive and see if any of the files in the archive can be
7765 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
7766 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7767 uncompress and de-tar the main file, and then view the two pictures.
7768 This unpacking process is recursive, so if the archive contains archives
7769 of archives, it'll all be unpacked.
7770
7771 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7772 extracted file into the summary buffer.  If you go to these
7773 ``articles'', you will be prompted for a command to run (usually Gnus
7774 will make a suggestion), and then the command will be run.
7775
7776 @vindex gnus-view-pseudo-asynchronously
7777 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7778 until the viewing is done before proceeding.
7779
7780 @vindex gnus-view-pseudos
7781 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7782 the pseudo-articles into the summary buffer, but view them
7783 immediately.  If this variable is @code{not-confirm}, the user won't even
7784 be asked for a confirmation before viewing is done.
7785
7786 @vindex gnus-view-pseudos-separately
7787 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7788 pseudo-article will be created for each file to be viewed.  If
7789 @code{nil}, all files that use the same viewing command will be given as
7790 a list of parameters to that command.
7791
7792 @vindex gnus-insert-pseudo-articles
7793 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7794 pseudo-articles when decoding.  It is @code{t} by default.
7795
7796 So; there you are, reading your @emph{pseudo-articles} in your
7797 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7798 Why isn't anything real anymore? How did we get here?
7799
7800
7801 @node Article Treatment
7802 @section Article Treatment
7803
7804 Reading through this huge manual, you may have quite forgotten that the
7805 object of newsreaders is to actually, like, read what people have
7806 written.  Reading articles.  Unfortunately, people are quite bad at
7807 writing, so there are tons of functions and variables to make reading
7808 these articles easier.
7809
7810 @menu
7811 * Article Highlighting::        You want to make the article look like fruit salad.
7812 * Article Fontisizing::         Making emphasized text look nice.
7813 * Article Hiding::              You also want to make certain info go away.
7814 * Article Washing::             Lots of way-neat functions to make life better.
7815 * Article Header::              Doing various header transformations.
7816 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
7817 * Article Date::                Grumble, UT!
7818 * Article Display::             Display various stuff---X-Face, Picons, Smileys
7819 * Article Signature::           What is a signature?
7820 * Article Miscellania::         Various other stuff.
7821 @end menu
7822
7823
7824 @node Article Highlighting
7825 @subsection Article Highlighting
7826 @cindex highlighting
7827
7828 Not only do you want your article buffer to look like fruit salad, but
7829 you want it to look like technicolor fruit salad.
7830
7831 @table @kbd
7832
7833 @item W H a
7834 @kindex W H a (Summary)
7835 @findex gnus-article-highlight
7836 @findex gnus-article-maybe-highlight
7837 Do much highlighting of the current article
7838 (@code{gnus-article-highlight}).  This function highlights header, cited
7839 text, the signature, and adds buttons to the body and the head.
7840
7841 @item W H h
7842 @kindex W H h (Summary)
7843 @findex gnus-article-highlight-headers
7844 @vindex gnus-header-face-alist
7845 Highlight the headers (@code{gnus-article-highlight-headers}).  The
7846 highlighting will be done according to the @code{gnus-header-face-alist}
7847 variable, which is a list where each element has the form
7848 @code{(@var{regexp} @var{name} @var{content})}.
7849 @var{regexp} is a regular expression for matching the
7850 header, @var{name} is the face used for highlighting the header name
7851 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7852 the header value.  The first match made will be used.  Note that
7853 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7854
7855 @item W H c
7856 @kindex W H c (Summary)
7857 @findex gnus-article-highlight-citation
7858 Highlight cited text (@code{gnus-article-highlight-citation}).
7859
7860 Some variables to customize the citation highlights:
7861
7862 @table @code
7863 @vindex gnus-cite-parse-max-size
7864
7865 @item gnus-cite-parse-max-size
7866 If the article size if bigger than this variable (which is 25000 by
7867 default), no citation highlighting will be performed.
7868
7869 @item gnus-cite-max-prefix
7870 @vindex gnus-cite-max-prefix
7871 Maximum possible length for a citation prefix (default 20).
7872
7873 @item gnus-cite-face-list
7874 @vindex gnus-cite-face-list
7875 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7876 When there are citations from multiple articles in the same message,
7877 gnus will try to give each citation from each article its own face.
7878 This should make it easier to see who wrote what.
7879
7880 @item gnus-supercite-regexp
7881 @vindex gnus-supercite-regexp
7882 Regexp matching normal Supercite attribution lines.
7883
7884 @item gnus-supercite-secondary-regexp
7885 @vindex gnus-supercite-secondary-regexp
7886 Regexp matching mangled Supercite attribution lines.
7887
7888 @item gnus-cite-minimum-match-count
7889 @vindex gnus-cite-minimum-match-count
7890 Minimum number of identical prefixes we have to see before we believe
7891 that it's a citation.
7892
7893 @item gnus-cite-attribution-prefix
7894 @vindex gnus-cite-attribution-prefix
7895 Regexp matching the beginning of an attribution line.
7896
7897 @item gnus-cite-attribution-suffix
7898 @vindex gnus-cite-attribution-suffix
7899 Regexp matching the end of an attribution line.
7900
7901 @item gnus-cite-attribution-face
7902 @vindex gnus-cite-attribution-face
7903 Face used for attribution lines.  It is merged with the face for the
7904 cited text belonging to the attribution.
7905
7906 @end table
7907
7908
7909 @item W H s
7910 @kindex W H s (Summary)
7911 @vindex gnus-signature-separator
7912 @vindex gnus-signature-face
7913 @findex gnus-article-highlight-signature
7914 Highlight the signature (@code{gnus-article-highlight-signature}).
7915 Everything after @code{gnus-signature-separator} (@pxref{Article
7916 Signature}) in an article will be considered a signature and will be
7917 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7918 default.
7919
7920 @end table
7921
7922 @xref{Customizing Articles}, for how to highlight articles automatically.
7923
7924
7925 @node Article Fontisizing
7926 @subsection Article Fontisizing
7927 @cindex emphasis
7928 @cindex article emphasis
7929
7930 @findex gnus-article-emphasize
7931 @kindex W e (Summary)
7932 People commonly add emphasis to words in news articles by writing things
7933 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
7934 this look nicer by running the article through the @kbd{W e}
7935 (@code{gnus-article-emphasize}) command.
7936
7937 @vindex gnus-emphasis-alist
7938 How the emphasis is computed is controlled by the
7939 @code{gnus-emphasis-alist} variable.  This is an alist where the first
7940 element is a regular expression to be matched.  The second is a number
7941 that says what regular expression grouping is used to find the entire
7942 emphasized word.  The third is a number that says what regexp grouping
7943 should be displayed and highlighted.  (The text between these two
7944 groupings will be hidden.)  The fourth is the face used for
7945 highlighting.
7946
7947 @lisp
7948 (setq gnus-emphasis-alist
7949       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7950         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7951 @end lisp
7952
7953 @cindex slash
7954 @cindex asterisk
7955 @cindex underline
7956 @cindex /
7957 @cindex *
7958
7959 @vindex gnus-emphasis-underline
7960 @vindex gnus-emphasis-bold
7961 @vindex gnus-emphasis-italic
7962 @vindex gnus-emphasis-underline-bold
7963 @vindex gnus-emphasis-underline-italic
7964 @vindex gnus-emphasis-bold-italic
7965 @vindex gnus-emphasis-underline-bold-italic
7966 By default, there are seven rules, and they use the following faces:
7967 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7968 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7969 @code{gnus-emphasis-underline-italic},
7970 @code{gnus-emphasis-underline-bold}, and
7971 @code{gnus-emphasis-underline-bold-italic}.
7972
7973 If you want to change these faces, you can either use @kbd{M-x
7974 customize}, or you can use @code{copy-face}.  For instance, if you want
7975 to make @code{gnus-emphasis-italic} use a red face instead, you could
7976 say something like:
7977
7978 @lisp
7979 (copy-face 'red 'gnus-emphasis-italic)
7980 @end lisp
7981
7982 @vindex gnus-group-highlight-words-alist
7983
7984 If you want to highlight arbitrary words, you can use the
7985 @code{gnus-group-highlight-words-alist} variable, which uses the same
7986 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
7987 parameter (@pxref{Group Parameters}) can also be used.
7988
7989 @xref{Customizing Articles}, for how to fontize articles automatically.
7990
7991
7992 @node Article Hiding
7993 @subsection Article Hiding
7994 @cindex article hiding
7995
7996 Or rather, hiding certain things in each article.  There usually is much
7997 too much cruft in most articles.
7998
7999 @table @kbd
8000
8001 @item W W a
8002 @kindex W W a (Summary)
8003 @findex gnus-article-hide
8004 Do quite a lot of hiding on the article buffer
8005 (@kbd{gnus-article-hide}).  In particular, this function will hide
8006 headers, PGP, cited text and the signature.
8007
8008 @item W W h
8009 @kindex W W h (Summary)
8010 @findex gnus-article-hide-headers
8011 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
8012 Headers}.
8013
8014 @item W W b
8015 @kindex W W b (Summary)
8016 @findex gnus-article-hide-boring-headers
8017 Hide headers that aren't particularly interesting
8018 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
8019
8020 @item W W s
8021 @kindex W W s (Summary)
8022 @findex gnus-article-hide-signature
8023 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
8024 Signature}.
8025
8026 @item W W l
8027 @kindex W W l (Summary)
8028 @findex gnus-article-hide-list-identifiers
8029 @vindex gnus-list-identifiers
8030 Strip list identifiers specified in @code{gnus-list-identifiers}.  These
8031 are strings some mailing list servers add to the beginning of all
8032 @code{Subject} headers---for example, @samp{[zebra 4711]}.  Any leading
8033 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8034 may not contain @code{\\(..\\)}.
8035
8036 @table @code
8037
8038 @item gnus-list-identifiers
8039 @vindex gnus-list-identifiers
8040 A regular expression that matches list identifiers to be removed from
8041 subject.  This can also be a list of regular expressions.
8042
8043 @end table
8044
8045 @item W W p
8046 @kindex W W p (Summary)
8047 @findex gnus-article-hide-pgp
8048 @vindex gnus-article-hide-pgp-hook
8049 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
8050 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
8051 signature has been hidden.  For example, to automatically verify
8052 articles that have signatures in them do:
8053 @lisp
8054 ;;; Hide pgp cruft if any.
8055
8056 (setq gnus-treat-strip-pgp t)
8057
8058 ;;; After hiding pgp, verify the message;
8059 ;;; only happens if pgp signature is found.
8060
8061 (add-hook 'gnus-article-hide-pgp-hook
8062           (lambda ()
8063             (save-excursion
8064               (set-buffer gnus-original-article-buffer)
8065               (mc-verify))))
8066 @end lisp
8067
8068 @item W W P
8069 @kindex W W P (Summary)
8070 @findex gnus-article-hide-pem
8071 Hide @sc{pem} (privacy enhanced messages) cruft
8072 (@code{gnus-article-hide-pem}).
8073
8074 @item W W B
8075 @kindex W W B (Summary)
8076 @findex gnus-article-strip-banner
8077 @vindex gnus-article-banner-alist
8078 @vindex gnus-article-address-banner-alist
8079 @cindex banner
8080 @cindex OneList
8081 @cindex stripping advertisements
8082 @cindex advertisements
8083 Strip the banner specified by the @code{banner} group parameter
8084 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
8085 annoying banners and/or signatures that some mailing lists and moderated
8086 groups adds to all the messages.  The way to use this function is to add
8087 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8088 group you want banners stripped from.  The parameter either be a string,
8089 which will be interpreted as a regular expression matching text to be
8090 removed, or the symbol @code{signature}, meaning that the (last)
8091 signature should be removed, or other symbol, meaning that the
8092 corresponding regular expression in @code{gnus-article-banner-alist} is
8093 used.
8094
8095 Regardless of a group, you can hide things like advertisements only when
8096 the sender of an article has a certain mail address specified in
8097 @code{gnus-article-address-banner-alist}.
8098
8099 @table @code
8100
8101 @item gnus-article-address-banner-alist
8102 @vindex gnus-article-address-banner-alist
8103 Alist of mail addresses and banners.  Each element has the form
8104 @code{(ADDRESS . BANNER)}, where ADDRESS is a regexp matching a mail
8105 address in the From header, BANNER is one of a symbol @code{signature},
8106 an item in @code{gnus-article-banner-alist}, a regexp and @code{nil}.
8107 If ADDRESS matches author's mail address, it will remove things like
8108 advertisements.  For example, if a sender has the mail address
8109 @samp{hail@@yoo-hoo.co.jp} and there is a banner something like
8110 @samp{Do You Yoo-hoo!?} in all articles he sends, you can use the
8111 following element to remove them:
8112
8113 @lisp
8114 ("@@yoo-hoo\\.co\\.jp\\'" . "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8115 @end lisp
8116
8117 @end table
8118
8119 @item W W c
8120 @kindex W W c (Summary)
8121 @findex gnus-article-hide-citation
8122 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
8123 customizing the hiding:
8124
8125 @table @code
8126
8127 @item gnus-cited-opened-text-button-line-format
8128 @itemx gnus-cited-closed-text-button-line-format
8129 @vindex gnus-cited-closed-text-button-line-format
8130 @vindex gnus-cited-opened-text-button-line-format
8131 Gnus adds buttons to show where the cited text has been hidden, and to
8132 allow toggle hiding the text.  The format of the variable is specified
8133 by these format-like variable (@pxref{Formatting Variables}).  These
8134 specs are valid:
8135
8136 @table @samp
8137 @item b
8138 Starting point of the hidden text.
8139 @item e
8140 Ending point of the hidden text.
8141 @item l
8142 Number of characters in the hidden region.
8143 @item n
8144 Number of lines of hidden text.
8145 @end table
8146
8147 @item gnus-cited-lines-visible
8148 @vindex gnus-cited-lines-visible
8149 The number of lines at the beginning of the cited text to leave
8150 shown. This can also be a cons cell with the number of lines at the top
8151 and bottom of the text, respectively, to remain visible.
8152
8153 @end table
8154
8155 @item W W C-c
8156 @kindex W W C-c (Summary)
8157 @findex gnus-article-hide-citation-maybe
8158
8159 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8160 following two variables:
8161
8162 @table @code
8163 @item gnus-cite-hide-percentage
8164 @vindex gnus-cite-hide-percentage
8165 If the cited text is of a bigger percentage than this variable (default
8166 50), hide the cited text.
8167
8168 @item gnus-cite-hide-absolute
8169 @vindex gnus-cite-hide-absolute
8170 The cited text must have at least this length (default 10) before it
8171 is hidden.
8172 @end table
8173
8174 @item W W C
8175 @kindex W W C (Summary)
8176 @findex gnus-article-hide-citation-in-followups
8177 Hide cited text in articles that aren't roots
8178 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
8179 useful as an interactive command, but might be a handy function to stick
8180 have happen automatically (@pxref{Customizing Articles}).
8181
8182 @end table
8183
8184 All these ``hiding'' commands are toggles, but if you give a negative
8185 prefix to these commands, they will show what they have previously
8186 hidden.  If you give a positive prefix, they will always hide.
8187
8188 Also @pxref{Article Highlighting} for further variables for
8189 citation customization.
8190
8191 @xref{Customizing Articles}, for how to hide article elements
8192 automatically.
8193
8194
8195 @node Article Washing
8196 @subsection Article Washing
8197 @cindex washing
8198 @cindex article washing
8199
8200 We call this ``article washing'' for a really good reason.  Namely, the
8201 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8202
8203 @dfn{Washing} is defined by us as ``changing something from something to
8204 something else'', but normally results in something looking better.
8205 Cleaner, perhaps.
8206
8207 @xref{Customizing Articles}, if you want to change how Gnus displays
8208 articles by default.
8209
8210 @table @kbd
8211
8212 @item C-u g
8213 This is not really washing, it's sort of the opposite of washing.  If
8214 you type this, you see the article exactly as it exists on disk or on
8215 the server.
8216
8217 @item W l
8218 @kindex W l (Summary)
8219 @findex gnus-summary-stop-page-breaking
8220 Remove page breaks from the current article
8221 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
8222 delimiters.
8223
8224 @item W r
8225 @kindex W r (Summary)
8226 @findex gnus-summary-caesar-message
8227 @c @icon{gnus-summary-caesar-message}
8228 Do a Caesar rotate (rot13) on the article buffer
8229 (@code{gnus-summary-caesar-message}).
8230 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8231 (Typically offensive jokes and such.)
8232
8233 It's commonly called ``rot13'' because each letter is rotated 13
8234 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8235 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
8236 is rumored to have employed this form of, uh, somewhat weak encryption.
8237
8238 @item W m
8239 @kindex W m (Summary)
8240 @findex gnus-summary-morse-message
8241 @c @icon{gnus-summary-morse-message}
8242 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8243
8244 @item W t
8245 @item t
8246 @kindex W t (Summary)
8247 @kindex t (Summary)
8248 @findex gnus-summary-toggle-header
8249 Toggle whether to display all headers in the article buffer
8250 (@code{gnus-summary-toggle-header}).
8251
8252 @item W v
8253 @kindex W v (Summary)
8254 @findex gnus-summary-verbose-headers
8255 Toggle whether to display all headers in the article buffer permanently
8256 (@code{gnus-summary-verbose-headers}).
8257
8258 @item W m
8259 @kindex W m (Summary)
8260 @findex gnus-summary-toggle-mime
8261 Toggle whether to run the article through @sc{mime} before displaying
8262 (@code{gnus-summary-toggle-mime}).
8263
8264 @item W o
8265 @kindex W o (Summary)
8266 @findex gnus-article-treat-overstrike
8267 Treat overstrike (@code{gnus-article-treat-overstrike}).
8268
8269 @item W d
8270 @kindex W d (Summary)
8271 @findex gnus-article-treat-dumbquotes
8272 @vindex gnus-article-dumbquotes-map
8273 @cindex Smartquotes
8274 @cindex M****s*** sm*rtq**t*s
8275 @cindex Latin 1
8276 Treat M****s*** sm*rtq**t*s according to
8277 @code{gnus-article-dumbquotes-map}
8278 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
8279 whether a character is a sm*rtq**t* or not, so it should only be used
8280 interactively.
8281
8282 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8283 an attempt to provide more quoting characters.  If you see something
8284 like @code{\222} or @code{\264} where you're expecting some kind of
8285 apostrophe or quotation mark, then try this wash.
8286
8287 @item W k
8288 @kindex W k (Summary)
8289 @findex gnus-article-outlook-deuglify-article
8290 @cindex Outlook Express
8291 Deuglify broken Outlook (Express) articles and redisplay
8292 (@code{gnus-article-outlook-deuglify-article}).
8293
8294 @item W w
8295 @kindex W w (Summary)
8296 @findex gnus-article-fill-cited-article
8297 Do word wrap (@code{gnus-article-fill-cited-article}).
8298
8299 You can give the command a numerical prefix to specify the width to use
8300 when filling.
8301
8302 @item W Q
8303 @kindex W Q (Summary)
8304 @findex gnus-article-fill-long-lines
8305 Fill long lines (@code{gnus-article-fill-long-lines}).
8306
8307 @item W C
8308 @kindex W C (Summary)
8309 @findex gnus-article-capitalize-sentences
8310 Capitalize the first word in each sentence
8311 (@code{gnus-article-capitalize-sentences}).
8312
8313 @item W c
8314 @kindex W c (Summary)
8315 @findex gnus-article-remove-cr
8316 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8317 (this takes care of DOS line endings), and then translate any remaining
8318 CRs into LF (this takes care of Mac line endings)
8319 (@code{gnus-article-remove-cr}).
8320
8321 @item W 6
8322 @kindex W 6 (Summary)
8323 @findex gnus-article-de-base64-unreadable
8324 Treat base64 (@code{gnus-article-de-base64-unreadable}).
8325 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
8326 (i. e., 8-bit) articles.  Note that this is usually done
8327 automatically by Gnus if the message in question has a
8328 @code{Content-Transfer-Encoding} header that says that this encoding has
8329 been done.
8330 If a prefix is given, a charset will be asked for.
8331
8332 @item W Z
8333 @kindex W Z (Summary)
8334 @findex gnus-article-decode-HZ
8335 Treat HZ or HZP (@code{gnus-article-decode-HZ}).  HZ (or HZP) is one
8336 common encoding employed when sending Chinese articles.  It typically
8337 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8338
8339 @item W u
8340 @kindex W u (Summary)
8341 @findex gnus-article-unsplit-urls
8342 Remove newlines from within URLs.  Some mailers insert newlines into
8343 outgoing email messages to keep lines short.  This reformatting can
8344 split long URLs onto multiple lines.  Repair those URLs by removing
8345 the newlines (@code{gnus-article-unsplit-urls}).
8346
8347 @item W h
8348 @kindex W h (Summary)
8349 @findex gnus-article-wash-html
8350 Treat @sc{html} (@code{gnus-article-wash-html}).  Note that this is
8351 usually done automatically by Gnus if the message in question has a
8352 @code{Content-Type} header that says that the message is @sc{html}.
8353
8354 If a prefix is given, a charset will be asked for.
8355
8356 @vindex gnus-article-wash-function
8357 The default is to use the function specified by
8358 @code{mm-inline-text-html-renderer} (@pxref{Customization, , , emacs-mime})
8359 to convert the @sc{html}, but this is controlled by the
8360 @code{gnus-article-wash-function} variable.  Pre-defined functions you
8361 can use include:
8362
8363 @table @code
8364 @item w3
8365 Use Emacs/w3.
8366
8367 @item w3m
8368 Use emacs-w3m (see @uref{http://emacs-w3m.namazu.org/} for more
8369 information).
8370
8371 @item links
8372 Use Links (see @uref{http://artax.karlin.mff.cuni.cz/~mikulas/links/}).
8373
8374 @item lynx
8375 Use Lynx (see @uref{http://lynx.browser.org/}).
8376
8377 @item html2text
8378 Use html2text -- a simple @sc{html} converter included with Gnus.
8379
8380 @end table
8381
8382 @item W b
8383 @kindex W b (Summary)
8384 @findex gnus-article-add-buttons
8385 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8386 @xref{Article Buttons}.
8387
8388 @item W B
8389 @kindex W B (Summary)
8390 @findex gnus-article-add-buttons-to-head
8391 Add clickable buttons to the article headers
8392 (@code{gnus-article-add-buttons-to-head}).
8393
8394 @item W p
8395 @kindex W p (Summary)
8396 @findex gnus-article-verify-x-pgp-sig
8397 Verify a signed control message (@code{gnus-article-verify-x-pgp-sig}).
8398 Control messages such as @code{newgroup} and @code{checkgroups} are
8399 usually signed by the hierarchy maintainer.  You need to add the PGP
8400 public key of the maintainer to your keyring to verify the
8401 message.@footnote{PGP keys for many hierarchies are available at
8402 @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8403
8404 @item W s
8405 @kindex W s (Summary)
8406 @findex gnus-summary-force-verify-and-decrypt
8407 Verify a signed (PGP, @sc{pgp/mime} or @sc{s/mime}) message
8408 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
8409
8410 @item W a
8411 @kindex W a (Summary)
8412 @findex gnus-article-strip-headers-in-body
8413 Strip headers like the @code{X-No-Archive} header from the beginning of
8414 article bodies (@code{gnus-article-strip-headers-in-body}).
8415
8416 @item W E l
8417 @kindex W E l (Summary)
8418 @findex gnus-article-strip-leading-blank-lines
8419 Remove all blank lines from the beginning of the article
8420 (@code{gnus-article-strip-leading-blank-lines}).
8421
8422 @item W E m
8423 @kindex W E m (Summary)
8424 @findex gnus-article-strip-multiple-blank-lines
8425 Replace all blank lines with empty lines and then all multiple empty
8426 lines with a single empty line.
8427 (@code{gnus-article-strip-multiple-blank-lines}).
8428
8429 @item W E t
8430 @kindex W E t (Summary)
8431 @findex gnus-article-remove-trailing-blank-lines
8432 Remove all blank lines at the end of the article
8433 (@code{gnus-article-remove-trailing-blank-lines}).
8434
8435 @item W E a
8436 @kindex W E a (Summary)
8437 @findex gnus-article-strip-blank-lines
8438 Do all the three commands above
8439 (@code{gnus-article-strip-blank-lines}).
8440
8441 @item W E A
8442 @kindex W E A (Summary)
8443 @findex gnus-article-strip-all-blank-lines
8444 Remove all blank lines
8445 (@code{gnus-article-strip-all-blank-lines}).
8446
8447 @item W E s
8448 @kindex W E s (Summary)
8449 @findex gnus-article-strip-leading-space
8450 Remove all white space from the beginning of all lines of the article
8451 body (@code{gnus-article-strip-leading-space}).
8452
8453 @item W E e
8454 @kindex W E e (Summary)
8455 @findex gnus-article-strip-trailing-space
8456 Remove all white space from the end of all lines of the article
8457 body (@code{gnus-article-strip-trailing-space}).
8458
8459 @end table
8460
8461 @xref{Customizing Articles}, for how to wash articles automatically.
8462
8463
8464 @node Article Header
8465 @subsection Article Header
8466
8467 These commands perform various transformations of article header.
8468
8469 @table @kbd
8470
8471 @item W G u
8472 @kindex W G u (Summary)
8473 @findex gnus-article-treat-unfold-headers
8474 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
8475
8476 @item W G n
8477 @kindex W G n (Summary)
8478 @findex gnus-article-treat-fold-newsgroups
8479 Fold the @code{Newsgroups} and @code{Followup-To} headers
8480 (@code{gnus-article-treat-fold-newsgroups}).
8481
8482 @item W G f
8483 @kindex W G f (Summary)
8484 @findex gnus-article-treat-fold-headers
8485 Fold all the message headers
8486 (@code{gnus-article-treat-fold-headers}).
8487
8488 @item W E w
8489 @kindex W E w
8490 @findex gnus-article-remove-leading-whitespace
8491 Remove excessive whitespace from all headers
8492 (@code{gnus-article-remove-leading-whitespace}).
8493
8494 @end table
8495
8496
8497 @node Article Buttons
8498 @subsection Article Buttons
8499 @cindex buttons
8500
8501 People often include references to other stuff in articles, and it would
8502 be nice if Gnus could just fetch whatever it is that people talk about
8503 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8504 button on these references.
8505
8506 @vindex gnus-button-man-handler
8507 Gnus adds @dfn{buttons} to certain standard references by default:
8508 Well-formed URLs, mail addresses, Message-IDs, Info links and man pages.
8509 This is controlled by two variables, one that handles article bodies and
8510 one that handles article heads:
8511
8512 @table @code
8513
8514 @item gnus-button-alist
8515 @vindex gnus-button-alist
8516 This is an alist where each entry has this form:
8517
8518 @lisp
8519 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8520 @end lisp
8521
8522 @table @var
8523
8524 @item regexp
8525 All text that match this regular expression (case insensitive) will be
8526 considered an external reference.  Here's a typical regexp that matches
8527 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}.  This can also be a
8528 variable containing a regexp, useful variables to use include
8529 @code{gnus-button-url-regexp}.
8530
8531 @item button-par
8532 Gnus has to know which parts of the matches is to be highlighted.  This
8533 is a number that says what sub-expression of the regexp is to be
8534 highlighted.  If you want it all highlighted, you use 0 here.
8535
8536 @item use-p
8537 This form will be @code{eval}ed, and if the result is non-@code{nil},
8538 this is considered a match.  This is useful if you want extra sifting to
8539 avoid false matches.
8540
8541 @item function
8542 This function will be called when you click on this button.
8543
8544 @item data-par
8545 As with @var{button-par}, this is a sub-expression number, but this one
8546 says which part of the match is to be sent as data to @var{function}.
8547
8548 @end table
8549
8550 So the full entry for buttonizing URLs is then
8551
8552 @lisp
8553 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8554 @end lisp
8555
8556 @item gnus-header-button-alist
8557 @vindex gnus-header-button-alist
8558 This is just like the other alist, except that it is applied to the
8559 article head only, and that each entry has an additional element that is
8560 used to say what headers to apply the buttonize coding to:
8561
8562 @lisp
8563 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8564 @end lisp
8565
8566 @var{header} is a regular expression.
8567
8568 @item gnus-button-url-regexp
8569 @vindex gnus-button-url-regexp
8570 A regular expression that matches embedded URLs.  It is used in the
8571 default values of the variables above.
8572
8573 @item gnus-article-button-face
8574 @vindex gnus-article-button-face
8575 Face used on buttons.
8576
8577 @item gnus-article-mouse-face
8578 @vindex gnus-article-mouse-face
8579 Face used when the mouse cursor is over a button.
8580
8581 @end table
8582
8583 @xref{Customizing Articles}, for how to buttonize articles automatically.
8584
8585
8586 @node Article Date
8587 @subsection Article Date
8588
8589 The date is most likely generated in some obscure timezone you've never
8590 heard of, so it's quite nice to be able to find out what the time was
8591 when the article was sent.
8592
8593 @table @kbd
8594
8595 @item W T u
8596 @kindex W T u (Summary)
8597 @findex gnus-article-date-ut
8598 Display the date in UT (aka. GMT, aka ZULU)
8599 (@code{gnus-article-date-ut}).
8600
8601 @item W T i
8602 @kindex W T i (Summary)
8603 @findex gnus-article-date-iso8601
8604 @cindex ISO 8601
8605 Display the date in international format, aka. ISO 8601
8606 (@code{gnus-article-date-iso8601}).
8607
8608 @item W T l
8609 @kindex W T l (Summary)
8610 @findex gnus-article-date-local
8611 Display the date in the local timezone (@code{gnus-article-date-local}).
8612
8613 @item W T p
8614 @kindex W T p (Summary)
8615 @findex gnus-article-date-english
8616 Display the date in a format that's easily pronounceable in English
8617 (@code{gnus-article-date-english}).
8618
8619 @item W T s
8620 @kindex W T s (Summary)
8621 @vindex gnus-article-time-format
8622 @findex gnus-article-date-user
8623 @findex format-time-string
8624 Display the date using a user-defined format
8625 (@code{gnus-article-date-user}).  The format is specified by the
8626 @code{gnus-article-time-format} variable, and is a string that's passed
8627 to @code{format-time-string}.  See the documentation of that variable
8628 for a list of possible format specs.
8629
8630 @item W T e
8631 @kindex W T e (Summary)
8632 @findex gnus-article-date-lapsed
8633 @findex gnus-start-date-timer
8634 @findex gnus-stop-date-timer
8635 Say how much time has elapsed between the article was posted and now
8636 (@code{gnus-article-date-lapsed}).  It looks something like:
8637
8638 @example
8639 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
8640 @end example
8641
8642 The value of @code{gnus-article-date-lapsed-new-header} determines
8643 whether this header will just be added below the old Date one, or will
8644 replace it.
8645
8646 An advantage of using Gnus to read mail is that it converts simple bugs
8647 into wonderful absurdities.
8648
8649 If you want to have this line updated continually, you can put
8650
8651 @lisp
8652 (gnus-start-date-timer)
8653 @end lisp
8654
8655 in your @file{.gnus.el} file, or you can run it off of some hook.  If
8656 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
8657 command.
8658
8659 @item W T o
8660 @kindex W T o (Summary)
8661 @findex gnus-article-date-original
8662 Display the original date (@code{gnus-article-date-original}).  This can
8663 be useful if you normally use some other conversion function and are
8664 worried that it might be doing something totally wrong.  Say, claiming
8665 that the article was posted in 1854.  Although something like that is
8666 @emph{totally} impossible.  Don't you trust me? *titter*
8667
8668 @end table
8669
8670 @xref{Customizing Articles}, for how to display the date in your
8671 preferred format automatically.
8672
8673
8674 @node Article Display
8675 @subsection Article Display
8676 @cindex picons
8677 @cindex x-face
8678 @cindex smileys
8679
8680 These commands add various frivolous display gimmicks to the article
8681 buffer in Emacs versions that support them.
8682
8683 @code{X-Face} headers are small black-and-white images supplied by the
8684 message headers (@pxref{X-Face}).
8685
8686 Picons, on the other hand, reside on your own system, and Gnus will
8687 try to match the headers to what you have (@pxref{Picons}).
8688
8689 Smileys are those little @samp{:-)} symbols that people like to litter
8690 their messages with (@pxref{Smileys}).
8691
8692 All these functions are toggles--if the elements already exist,
8693 they'll be removed.
8694
8695 @table @kbd
8696 @item W D x
8697 @kindex W D x (Summary)
8698 @findex gnus-article-display-x-face
8699 Display an @code{X-Face} in the @code{From} header.
8700 (@code{gnus-article-display-x-face}).
8701
8702 @item W D s
8703 @kindex W D s (Summary)
8704 @findex gnus-treat-smiley
8705 Display smileys (@code{gnus-treat-smiley}).
8706
8707 @item W D f
8708 @kindex W D f (Summary)
8709 @findex gnus-treat-from-picon
8710 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
8711
8712 @item W D m
8713 @kindex W D m (Summary)
8714 @findex gnus-treat-mail-picon
8715 Piconify all mail headers (i. e., @code{Cc}, @code{To})
8716 (@code{gnus-treat-mail-picon}).
8717
8718 @item W D n
8719 @kindex W D n (Summary)
8720 @findex gnus-treat-newsgroups-picon
8721 Piconify all news headers (i. e., @code{Newsgroups} and
8722 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
8723
8724 @item W D D
8725 @kindex W D D (Summary)
8726 @findex gnus-article-remove-images
8727 Remove all images from the article buffer
8728 (@code{gnus-article-remove-images}).
8729
8730 @end table
8731
8732
8733
8734 @node Article Signature
8735 @subsection Article Signature
8736 @cindex signatures
8737 @cindex article signature
8738
8739 @vindex gnus-signature-separator
8740 Each article is divided into two parts---the head and the body.  The
8741 body can be divided into a signature part and a text part.  The variable
8742 that says what is to be considered a signature is
8743 @code{gnus-signature-separator}.  This is normally the standard
8744 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
8745 non-standard signature separators, so this variable can also be a list
8746 of regular expressions to be tested, one by one.  (Searches are done
8747 from the end of the body towards the beginning.)  One likely value is:
8748
8749 @lisp
8750 (setq gnus-signature-separator
8751       '("^-- $"         ; The standard
8752         "^-- *$"        ; A common mangling
8753         "^-------*$"    ; Many people just use a looong
8754                         ; line of dashes.  Shame!
8755         "^ *--------*$" ; Double-shame!
8756         "^________*$"   ; Underscores are also popular
8757         "^========*$")) ; Pervert!
8758 @end lisp
8759
8760 The more permissive you are, the more likely it is that you'll get false
8761 positives.
8762
8763 @vindex gnus-signature-limit
8764 @code{gnus-signature-limit} provides a limit to what is considered a
8765 signature when displaying articles.
8766
8767 @enumerate
8768 @item
8769 If it is an integer, no signature may be longer (in characters) than
8770 that integer.
8771 @item
8772 If it is a floating point number, no signature may be longer (in lines)
8773 than that number.
8774 @item
8775 If it is a function, the function will be called without any parameters,
8776 and if it returns @code{nil}, there is no signature in the buffer.
8777 @item
8778 If it is a string, it will be used as a regexp.  If it matches, the text
8779 in question is not a signature.
8780 @end enumerate
8781
8782 This variable can also be a list where the elements may be of the types
8783 listed above.  Here's an example:
8784
8785 @lisp
8786 (setq gnus-signature-limit
8787       '(200.0 "^---*Forwarded article"))
8788 @end lisp
8789
8790 This means that if there are more than 200 lines after the signature
8791 separator, or the text after the signature separator is matched by
8792 the regular expression @samp{^---*Forwarded article}, then it isn't a
8793 signature after all.
8794
8795
8796 @node Article Miscellania
8797 @subsection Article Miscellania
8798
8799 @table @kbd
8800 @item A t
8801 @kindex A t (Summary)
8802 @findex gnus-article-babel
8803 Translate the article from one language to another
8804 (@code{gnus-article-babel}).
8805
8806 @end table
8807
8808
8809 @node MIME Commands
8810 @section MIME Commands
8811 @cindex MIME decoding
8812 @cindex attachments
8813 @cindex viewing attachments
8814
8815 The following commands all understand the numerical prefix.  For
8816 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
8817
8818 @table @kbd
8819 @item b
8820 @itemx K v
8821 @kindex b (Summary)
8822 @kindex K v (Summary)
8823 View the @sc{mime} part.
8824
8825 @item K o
8826 @kindex K o (Summary)
8827 Save the @sc{mime} part.
8828
8829 @item K c
8830 @kindex K c (Summary)
8831 Copy the @sc{mime} part.
8832
8833 @item K e
8834 @kindex K e (Summary)
8835 View the @sc{mime} part externally.
8836
8837 @item K i
8838 @kindex K i (Summary)
8839 View the @sc{mime} part internally.
8840
8841 @item K |
8842 @kindex K | (Summary)
8843 Pipe the @sc{mime} part to an external command.
8844 @end table
8845
8846 The rest of these @sc{mime} commands do not use the numerical prefix in
8847 the same manner:
8848
8849 @table @kbd
8850 @item K b
8851 @kindex K b (Summary)
8852 Make all the @sc{mime} parts have buttons in front of them.  This is
8853 mostly useful if you wish to save (or perform other actions) on inlined
8854 parts.
8855
8856 @item K m
8857 @kindex K m (Summary)
8858 @findex gnus-summary-repair-multipart
8859 Some multipart messages are transmitted with missing or faulty headers.
8860 This command will attempt to ``repair'' these messages so that they can
8861 be viewed in a more pleasant manner
8862 (@code{gnus-summary-repair-multipart}).
8863
8864 @item X m
8865 @kindex X m (Summary)
8866 @findex gnus-summary-save-parts
8867 Save all parts matching a @sc{mime} type to a directory
8868 (@code{gnus-summary-save-parts}).  Understands the process/prefix
8869 convention (@pxref{Process/Prefix}).
8870
8871 @item M-t
8872 @kindex M-t (Summary)
8873 @findex gnus-summary-toggle-display-buttonized
8874 Toggle the buttonized display of the article buffer
8875 (@code{gnus-summary-toggle-display-buttonized}).
8876
8877 @item W M w
8878 @kindex W M w (Summary)
8879 @findex gnus-article-decode-mime-words
8880 Decode RFC 2047-encoded words in the article headers
8881 (@code{gnus-article-decode-mime-words}).
8882
8883 @item W M c
8884 @kindex W M c (Summary)
8885 @findex gnus-article-decode-charset
8886 Decode encoded article bodies as well as charsets
8887 (@code{gnus-article-decode-charset}).
8888
8889 This command looks in the @code{Content-Type} header to determine the
8890 charset.  If there is no such header in the article, you can give it a
8891 prefix, which will prompt for the charset to decode as.  In regional
8892 groups where people post using some common encoding (but do not
8893 include @sc{mime} headers), you can set the @code{charset} group/topic
8894 parameter to the required charset (@pxref{Group Parameters}).
8895
8896 @item W M v
8897 @kindex W M v (Summary)
8898 @findex gnus-mime-view-all-parts
8899 View all the @sc{mime} parts in the current article
8900 (@code{gnus-mime-view-all-parts}).
8901
8902 @end table
8903
8904 Relevant variables:
8905
8906 @table @code
8907 @item gnus-ignored-mime-types
8908 @vindex gnus-ignored-mime-types
8909 This is a list of regexps.  @sc{mime} types that match a regexp from
8910 this list will be completely ignored by Gnus.  The default value is
8911 @code{nil}.
8912
8913 To have all Vcards be ignored, you'd say something like this:
8914
8915 @lisp
8916 (setq gnus-ignored-mime-types
8917       '("text/x-vcard"))
8918 @end lisp
8919
8920 @item gnus-unbuttonized-mime-types
8921 @vindex gnus-unbuttonized-mime-types
8922 This is a list of regexps.  @sc{mime} types that match a regexp from
8923 this list won't have @sc{mime} buttons inserted unless they aren't
8924 displayed or this variable is overridden by
8925 @code{gnus-buttonized-mime-types}.  The default value is
8926 @code{(".*/.*")}.
8927
8928 @item gnus-buttonized-mime-types
8929 @vindex gnus-buttonized-mime-types
8930 This is a list of regexps.  @sc{mime} types that match a regexp from
8931 this list will have @sc{mime} buttons inserted unless they aren't
8932 displayed.  This variable overrides
8933 @code{gnus-unbuttonized-mime-types}.  The default value is @code{nil}.
8934
8935 To see e.g. security buttons but no other buttons, you could set this
8936 variable to @code{("multipart/signed")} and leave
8937 @code{gnus-unbuttonized-mime-types} at the default value.
8938
8939 @item gnus-inhibit-mime-unbuttonizing
8940 @vindex gnus-inhibit-mime-unbuttonizing
8941 If this is non-nil, then all @sc{mime} parts get buttons.  The default
8942 value is @code{nil}.
8943
8944 @item gnus-article-mime-part-function
8945 @vindex gnus-article-mime-part-function
8946 For each @sc{mime} part, this function will be called with the @sc{mime}
8947 handle as the parameter.  The function is meant to be used to allow
8948 users to gather information from the article (e. g., add Vcard info to
8949 the bbdb database) or to do actions based on parts (e. g., automatically
8950 save all jpegs into some directory).
8951
8952 Here's an example function the does the latter:
8953
8954 @lisp
8955 (defun my-save-all-jpeg-parts (handle)
8956   (when (equal (car (mm-handle-type handle)) "image/jpeg")
8957     (with-temp-buffer
8958       (insert (mm-get-part handle))
8959       (write-region (point-min) (point-max)
8960                     (read-file-name "Save jpeg to: ")))))
8961 (setq gnus-article-mime-part-function
8962       'my-save-all-jpeg-parts)
8963 @end lisp
8964
8965 @vindex gnus-mime-multipart-functions
8966 @item gnus-mime-multipart-functions
8967 Alist of @sc{mime} multipart types and functions to handle them.
8968
8969 @vindex mm-file-name-rewrite-functions
8970 @item mm-file-name-rewrite-functions
8971 List of functions used for rewriting file names of @sc{mime} parts.
8972 Each function takes a file name as input and returns a file name.
8973
8974 Ready-made functions include@*
8975 @code{mm-file-name-delete-whitespace},
8976 @code{mm-file-name-trim-whitespace},
8977 @code{mm-file-name-collapse-whitespace}, and
8978 @code{mm-file-name-replace-whitespace}.  The later uses the value of
8979 the variable @code{mm-file-name-replace-whitespace} to replace each
8980 whitespace character in a file name with that string; default value
8981 is @code{"_"} (a single underscore).
8982 @findex mm-file-name-delete-whitespace
8983 @findex mm-file-name-trim-whitespace
8984 @findex mm-file-name-collapse-whitespace
8985 @findex mm-file-name-replace-whitespace
8986 @vindex mm-file-name-replace-whitespace
8987
8988 The standard functions @code{capitalize}, @code{downcase},
8989 @code{upcase}, and @code{upcase-initials} may be useful, too.
8990
8991 Everybody knows that whitespace characters in file names are evil,
8992 except those who don't know.  If you receive lots of attachments from
8993 such unenlightened users, you can make live easier by adding
8994
8995 @lisp
8996 (setq mm-file-name-rewrite-functions
8997       '(mm-file-name-trim-whitespace
8998         mm-file-name-collapse-whitespace
8999         mm-file-name-replace-whitespace))
9000 @end lisp
9001
9002 @noindent
9003 to your @file{.gnus} file.
9004
9005 @end table
9006
9007
9008 @node Charsets
9009 @section Charsets
9010 @cindex charsets
9011
9012 People use different charsets, and we have @sc{mime} to let us know what
9013 charsets they use.  Or rather, we wish we had.  Many people use
9014 newsreaders and mailers that do not understand or use @sc{mime}, and
9015 just send out messages without saying what character sets they use.  To
9016 help a bit with this, some local news hierarchies have policies that say
9017 what character set is the default.  For instance, the @samp{fj}
9018 hierarchy uses @code{iso-2022-jp-2}.
9019
9020 @vindex gnus-group-charset-alist
9021 This knowledge is encoded in the @code{gnus-group-charset-alist}
9022 variable, which is an alist of regexps (use the first item to match full
9023 group names) and default charsets to be used when reading these groups.
9024
9025 In addition, some people do use soi-disant @sc{mime}-aware agents that
9026 aren't.  These blithely mark messages as being in @code{iso-8859-1}
9027 even if they really are in @code{koi-8}.  To help here, the
9028 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
9029 charsets that are listed here will be ignored.  The variable can be
9030 set on a group-by-group basis using the group parameters (@pxref{Group
9031 Parameters}).  The default value is @code{(unknown-8bit x-unknown)},
9032 which includes values some agents insist on having in there.
9033
9034 @vindex gnus-group-posting-charset-alist
9035 When posting, @code{gnus-group-posting-charset-alist} is used to
9036 determine which charsets should not be encoded using the @sc{mime}
9037 encodings.  For instance, some hierarchies discourage using
9038 quoted-printable header encoding.
9039
9040 This variable is an alist of regexps and permitted unencoded charsets
9041 for posting.  Each element of the alist has the form @code{(}@var{test
9042 header body-list}@code{)}, where:
9043
9044 @table @var
9045 @item test
9046 is either a regular expression matching the newsgroup header or a
9047 variable to query,
9048 @item header
9049 is the charset which may be left unencoded in the header (@code{nil}
9050 means encode all charsets),
9051 @item body-list
9052 is a list of charsets which may be encoded using 8bit content-transfer
9053 encoding in the body, or one of the special values @code{nil} (always
9054 encode using quoted-printable) or @code{t} (always use 8bit).
9055 @end table
9056
9057 @cindex Russian
9058 @cindex koi8-r
9059 @cindex koi8-u
9060 @cindex iso-8859-5
9061 @cindex coding system aliases
9062 @cindex preferred charset
9063
9064 Other charset tricks that may be useful, although not Gnus-specific:
9065
9066 If there are several @sc{mime} charsets that encode the same Emacs
9067 charset, you can choose what charset to use by saying the following:
9068
9069 @lisp
9070 (put-charset-property 'cyrillic-iso8859-5
9071                       'preferred-coding-system 'koi8-r)
9072 @end lisp
9073
9074 This means that Russian will be encoded using @code{koi8-r} instead of
9075 the default @code{iso-8859-5} @sc{mime} charset.
9076
9077 If you want to read messages in @code{koi8-u}, you can cheat and say
9078
9079 @lisp
9080 (define-coding-system-alias 'koi8-u 'koi8-r)
9081 @end lisp
9082
9083 This will almost do the right thing.
9084
9085 And finally, to read charsets like @code{windows-1251}, you can say
9086 something like
9087
9088 @lisp
9089 (codepage-setup 1251)
9090 (define-coding-system-alias 'windows-1251 'cp1251)
9091 @end lisp
9092
9093
9094 @node Article Commands
9095 @section Article Commands
9096
9097 @table @kbd
9098
9099 @item A P
9100 @cindex PostScript
9101 @cindex printing
9102 @kindex A P (Summary)
9103 @vindex gnus-ps-print-hook
9104 @findex gnus-summary-print-article
9105 Generate and print a PostScript image of the article buffer
9106 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will
9107 be run just before printing the buffer.  An alternative way to print
9108 article is to use Muttprint (@pxref{Saving Articles}).
9109
9110 @end table
9111
9112
9113 @node Summary Sorting
9114 @section Summary Sorting
9115 @cindex summary sorting
9116
9117 You can have the summary buffer sorted in various ways, even though I
9118 can't really see why you'd want that.
9119
9120 @table @kbd
9121
9122 @item C-c C-s C-n
9123 @kindex C-c C-s C-n (Summary)
9124 @findex gnus-summary-sort-by-number
9125 Sort by article number (@code{gnus-summary-sort-by-number}).
9126
9127 @item C-c C-s C-a
9128 @kindex C-c C-s C-a (Summary)
9129 @findex gnus-summary-sort-by-author
9130 Sort by author (@code{gnus-summary-sort-by-author}).
9131
9132 @item C-c C-s C-s
9133 @kindex C-c C-s C-s (Summary)
9134 @findex gnus-summary-sort-by-subject
9135 Sort by subject (@code{gnus-summary-sort-by-subject}).
9136
9137 @item C-c C-s C-d
9138 @kindex C-c C-s C-d (Summary)
9139 @findex gnus-summary-sort-by-date
9140 Sort by date (@code{gnus-summary-sort-by-date}).
9141
9142 @item C-c C-s C-l
9143 @kindex C-c C-s C-l (Summary)
9144 @findex gnus-summary-sort-by-lines
9145 Sort by lines (@code{gnus-summary-sort-by-lines}).
9146
9147 @item C-c C-s C-c
9148 @kindex C-c C-s C-c (Summary)
9149 @findex gnus-summary-sort-by-chars
9150 Sort by article length (@code{gnus-summary-sort-by-chars}).
9151
9152 @item C-c C-s C-i
9153 @kindex C-c C-s C-i (Summary)
9154 @findex gnus-summary-sort-by-score
9155 Sort by score (@code{gnus-summary-sort-by-score}).
9156
9157 @item C-c C-s C-r
9158 @kindex C-c C-s C-r (Summary)
9159 @findex gnus-summary-sort-by-random
9160 Randomize (@code{gnus-summary-sort-by-random}).
9161
9162 @item C-c C-s C-o
9163 @kindex C-c C-s C-o (Summary)
9164 @findex gnus-summary-sort-by-original
9165 Sort using the default sorting method
9166 (@code{gnus-summary-sort-by-original}).
9167 @end table
9168
9169 These functions will work both when you use threading and when you don't
9170 use threading.  In the latter case, all summary lines will be sorted,
9171 line by line.  In the former case, sorting will be done on a
9172 root-by-root basis, which might not be what you were looking for.  To
9173 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
9174 Commands}).
9175
9176
9177 @node Finding the Parent
9178 @section Finding the Parent
9179 @cindex parent articles
9180 @cindex referring articles
9181
9182 @table @kbd
9183 @item ^
9184 @kindex ^ (Summary)
9185 @findex gnus-summary-refer-parent-article
9186 If you'd like to read the parent of the current article, and it is not
9187 displayed in the summary buffer, you might still be able to.  That is,
9188 if the current group is fetched by @sc{nntp}, the parent hasn't expired
9189 and the @code{References} in the current article are not mangled, you
9190 can just press @kbd{^} or @kbd{A r}
9191 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
9192 you'll get the parent.  If the parent is already displayed in the
9193 summary buffer, point will just move to this article.
9194
9195 If given a positive numerical prefix, fetch that many articles back into
9196 the ancestry.  If given a negative numerical prefix, fetch just that
9197 ancestor.  So if you say @kbd{3 ^}, gnus will fetch the parent, the
9198 grandparent and the grandgrandparent of the current article.  If you say
9199 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
9200 article.
9201
9202 @item A R (Summary)
9203 @findex gnus-summary-refer-references
9204 @kindex A R (Summary)
9205 Fetch all articles mentioned in the @code{References} header of the
9206 article (@code{gnus-summary-refer-references}).
9207
9208 @item A T (Summary)
9209 @findex gnus-summary-refer-thread
9210 @kindex A T (Summary)
9211 Display the full thread where the current article appears
9212 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
9213 headers in the current group to work, so it usually takes a while.  If
9214 you do it often, you may consider setting @code{gnus-fetch-old-headers}
9215 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
9216 visible effects normally, but it'll make this command work a whole lot
9217 faster.  Of course, it'll make group entry somewhat slow.
9218
9219 @vindex gnus-refer-thread-limit
9220 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
9221 articles before the first displayed in the current group) headers to
9222 fetch when doing this command.  The default is 200.  If @code{t}, all
9223 the available headers will be fetched.  This variable can be overridden
9224 by giving the @kbd{A T} command a numerical prefix.
9225
9226 @item M-^ (Summary)
9227 @findex gnus-summary-refer-article
9228 @kindex M-^ (Summary)
9229 @cindex Message-ID
9230 @cindex fetching by Message-ID
9231 You can also ask the @sc{nntp} server for an arbitrary article, no
9232 matter what group it belongs to.  @kbd{M-^}
9233 (@code{gnus-summary-refer-article}) will ask you for a
9234 @code{Message-ID}, which is one of those long, hard-to-read thingies
9235 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
9236 have to get it all exactly right.  No fuzzy searches, I'm afraid.
9237 @end table
9238
9239 The current select method will be used when fetching by
9240 @code{Message-ID} from non-news select method, but you can override this
9241 by giving this command a prefix.
9242
9243 @vindex gnus-refer-article-method
9244 If the group you are reading is located on a back end that does not
9245 support fetching by @code{Message-ID} very well (like @code{nnspool}),
9246 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
9247 would, perhaps, be best if the @sc{nntp} server you consult is the one
9248 updating the spool you are reading from, but that's not really
9249 necessary.
9250
9251 It can also be a list of select methods, as well as the special symbol
9252 @code{current}, which means to use the current select method.  If it
9253 is a list, Gnus will try all the methods in the list until it finds a
9254 match.
9255
9256 Here's an example setting that will first try the current method, and
9257 then ask Google if that fails:
9258
9259 @lisp
9260 (setq gnus-refer-article-method
9261       '(current
9262         (nnweb "google" (nnweb-type google))))
9263 @end lisp
9264
9265 Most of the mail back ends support fetching by @code{Message-ID}, but
9266 do not do a particularly excellent job at it.  That is, @code{nnmbox},
9267 @code{nnbabyl}, and @code{nnmaildir} are able to locate articles from
9268 any groups, while @code{nnml}, @code{nnfolder}, and @code{nnimap} are
9269 only able to locate articles that have been posted to the current group.
9270 (Anything else would be too time consuming.)  @code{nnmh} does not
9271 support this at all.
9272
9273
9274 @node Alternative Approaches
9275 @section Alternative Approaches
9276
9277 Different people like to read news using different methods.  This being
9278 gnus, we offer a small selection of minor modes for the summary buffers.
9279
9280 @menu
9281 * Pick and Read::               First mark articles and then read them.
9282 * Binary Groups::               Auto-decode all articles.
9283 @end menu
9284
9285
9286 @node Pick and Read
9287 @subsection Pick and Read
9288 @cindex pick and read
9289
9290 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
9291 a two-phased reading interface.  The user first marks in a summary
9292 buffer the articles she wants to read.  Then she starts reading the
9293 articles with just an article buffer displayed.
9294
9295 @findex gnus-pick-mode
9296 @kindex M-x gnus-pick-mode
9297 Gnus provides a summary buffer minor mode that allows
9298 this---@code{gnus-pick-mode}.  This basically means that a few process
9299 mark commands become one-keystroke commands to allow easy marking, and
9300 it provides one additional command for switching to the summary buffer.
9301
9302 Here are the available keystrokes when using pick mode:
9303
9304 @table @kbd
9305 @item .
9306 @kindex . (Pick)
9307 @findex gnus-pick-article-or-thread
9308 Pick the article or thread on the current line
9309 (@code{gnus-pick-article-or-thread}).  If the variable
9310 @code{gnus-thread-hide-subtree} is true, then this key selects the
9311 entire thread when used at the first article of the thread.  Otherwise,
9312 it selects just the article.  If given a numerical prefix, go to that
9313 thread or article and pick it.  (The line number is normally displayed
9314 at the beginning of the summary pick lines.)
9315
9316 @item SPACE
9317 @kindex SPACE (Pick)
9318 @findex gnus-pick-next-page
9319 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
9320 at the end of the buffer, start reading the picked articles.
9321
9322 @item u
9323 @kindex u (Pick)
9324 @findex gnus-pick-unmark-article-or-thread.
9325 Unpick the thread or article
9326 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
9327 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
9328 thread if used at the first article of the thread.  Otherwise it unpicks
9329 just the article.  You can give this key a numerical prefix to unpick
9330 the thread or article at that line.
9331
9332 @item RET
9333 @kindex RET (Pick)
9334 @findex gnus-pick-start-reading
9335 @vindex gnus-pick-display-summary
9336 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
9337 given a prefix, mark all unpicked articles as read first.  If
9338 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
9339 will still be visible when you are reading.
9340
9341 @end table
9342
9343 All the normal summary mode commands are still available in the
9344 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
9345 which is mapped to the same function
9346 @code{gnus-summary-tick-article-forward}.
9347
9348 If this sounds like a good idea to you, you could say:
9349
9350 @lisp
9351 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
9352 @end lisp
9353
9354 @vindex gnus-pick-mode-hook
9355 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
9356
9357 @vindex gnus-mark-unpicked-articles-as-read
9358 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
9359 all unpicked articles as read.  The default is @code{nil}.
9360
9361 @vindex gnus-summary-pick-line-format
9362 The summary line format in pick mode is slightly different from the
9363 standard format.  At the beginning of each line the line number is
9364 displayed.  The pick mode line format is controlled by the
9365 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
9366 Variables}).  It accepts the same format specs that
9367 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
9368
9369
9370 @node Binary Groups
9371 @subsection Binary Groups
9372 @cindex binary groups
9373
9374 @findex gnus-binary-mode
9375 @kindex M-x gnus-binary-mode
9376 If you spend much time in binary groups, you may grow tired of hitting
9377 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
9378 is a minor mode for summary buffers that makes all ordinary Gnus article
9379 selection functions uudecode series of articles and display the result
9380 instead of just displaying the articles the normal way.
9381
9382 @kindex g (Binary)
9383 @findex gnus-binary-show-article
9384 The only way, in fact, to see the actual articles is the @kbd{g}
9385 command, when you have turned on this mode
9386 (@code{gnus-binary-show-article}).
9387
9388 @vindex gnus-binary-mode-hook
9389 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
9390
9391
9392 @node Tree Display
9393 @section Tree Display
9394 @cindex trees
9395
9396 @vindex gnus-use-trees
9397 If you don't like the normal gnus summary display, you might try setting
9398 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
9399 additional @dfn{tree buffer}.  You can execute all summary mode commands
9400 in the tree buffer.
9401
9402 There are a few variables to customize the tree display, of course:
9403
9404 @table @code
9405 @item gnus-tree-mode-hook
9406 @vindex gnus-tree-mode-hook
9407 A hook called in all tree mode buffers.
9408
9409 @item gnus-tree-mode-line-format
9410 @vindex gnus-tree-mode-line-format
9411 A format string for the mode bar in the tree mode buffers (@pxref{Mode
9412 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
9413 of valid specs, @pxref{Summary Buffer Mode Line}.
9414
9415 @item gnus-selected-tree-face
9416 @vindex gnus-selected-tree-face
9417 Face used for highlighting the selected article in the tree buffer.  The
9418 default is @code{modeline}.
9419
9420 @item gnus-tree-line-format
9421 @vindex gnus-tree-line-format
9422 A format string for the tree nodes.  The name is a bit of a misnomer,
9423 though---it doesn't define a line, but just the node.  The default value
9424 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
9425 the name of the poster.  It is vital that all nodes are of the same
9426 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
9427
9428 Valid specs are:
9429
9430 @table @samp
9431 @item n
9432 The name of the poster.
9433 @item f
9434 The @code{From} header.
9435 @item N
9436 The number of the article.
9437 @item [
9438 The opening bracket.
9439 @item ]
9440 The closing bracket.
9441 @item s
9442 The subject.
9443 @end table
9444
9445 @xref{Formatting Variables}.
9446
9447 Variables related to the display are:
9448
9449 @table @code
9450 @item gnus-tree-brackets
9451 @vindex gnus-tree-brackets
9452 This is used for differentiating between ``real'' articles and
9453 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
9454 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
9455 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
9456
9457 @item gnus-tree-parent-child-edges
9458 @vindex gnus-tree-parent-child-edges
9459 This is a list that contains the characters used for connecting parent
9460 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
9461
9462 @end table
9463
9464 @item gnus-tree-minimize-window
9465 @vindex gnus-tree-minimize-window
9466 If this variable is non-@code{nil}, gnus will try to keep the tree
9467 buffer as small as possible to allow more room for the other gnus
9468 windows.  If this variable is a number, the tree buffer will never be
9469 higher than that number.  The default is @code{t}.  Note that if you
9470 have several windows displayed side-by-side in a frame and the tree
9471 buffer is one of these, minimizing the tree window will also resize all
9472 other windows displayed next to it.
9473
9474 You may also wish to add the following hook to keep the window minimized
9475 at all times:
9476
9477 @lisp
9478 (add-hook 'gnus-configure-windows-hook
9479           'gnus-tree-perhaps-minimize)
9480 @end lisp
9481
9482 @item gnus-generate-tree-function
9483 @vindex gnus-generate-tree-function
9484 @findex gnus-generate-horizontal-tree
9485 @findex gnus-generate-vertical-tree
9486 The function that actually generates the thread tree.  Two predefined
9487 functions are available: @code{gnus-generate-horizontal-tree} and
9488 @code{gnus-generate-vertical-tree} (which is the default).
9489
9490 @end table
9491
9492 Here's an example from a horizontal tree buffer:
9493
9494 @example
9495 @{***@}-(***)-[odd]-[Gun]
9496      |      \[Jan]
9497      |      \[odd]-[Eri]
9498      |      \(***)-[Eri]
9499      |            \[odd]-[Paa]
9500      \[Bjo]
9501      \[Gun]
9502      \[Gun]-[Jor]
9503 @end example
9504
9505 Here's the same thread displayed in a vertical tree buffer:
9506
9507 @example
9508 @{***@}
9509   |--------------------------\-----\-----\
9510 (***)                         [Bjo] [Gun] [Gun]
9511   |--\-----\-----\                          |
9512 [odd] [Jan] [odd] (***)                   [Jor]
9513   |           |     |--\
9514 [Gun]       [Eri] [Eri] [odd]
9515                           |
9516                         [Paa]
9517 @end example
9518
9519 If you're using horizontal trees, it might be nice to display the trees
9520 side-by-side with the summary buffer.  You could add something like the
9521 following to your @file{.gnus.el} file:
9522
9523 @lisp
9524 (setq gnus-use-trees t
9525       gnus-generate-tree-function 'gnus-generate-horizontal-tree
9526       gnus-tree-minimize-window nil)
9527 (gnus-add-configuration
9528  '(article
9529    (vertical 1.0
9530              (horizontal 0.25
9531                          (summary 0.75 point)
9532                          (tree 1.0))
9533              (article 1.0))))
9534 @end lisp
9535
9536 @xref{Window Layout}.
9537
9538
9539 @node Mail Group Commands
9540 @section Mail Group Commands
9541 @cindex mail group commands
9542
9543 Some commands only make sense in mail groups.  If these commands are
9544 invalid in the current group, they will raise a hell and let you know.
9545
9546 All these commands (except the expiry and edit commands) use the
9547 process/prefix convention (@pxref{Process/Prefix}).
9548
9549 @table @kbd
9550
9551 @item B e
9552 @kindex B e (Summary)
9553 @findex gnus-summary-expire-articles
9554 Run all expirable articles in the current group through the expiry
9555 process (@code{gnus-summary-expire-articles}).  That is, delete all
9556 expirable articles in the group that have been around for a while.
9557 (@pxref{Expiring Mail}).
9558
9559 @item B C-M-e
9560 @kindex B C-M-e (Summary)
9561 @findex gnus-summary-expire-articles-now
9562 Delete all the expirable articles in the group
9563 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
9564 articles eligible for expiry in the current group will
9565 disappear forever into that big @file{/dev/null} in the sky.
9566
9567 @item B DEL
9568 @kindex B DEL (Summary)
9569 @findex gnus-summary-delete-article
9570 @c @icon{gnus-summary-mail-delete}
9571 Delete the mail article.  This is ``delete'' as in ``delete it from your
9572 disk forever and ever, never to return again.'' Use with caution.
9573 (@code{gnus-summary-delete-article}).
9574
9575 @item B m
9576 @kindex B m (Summary)
9577 @cindex move mail
9578 @findex gnus-summary-move-article
9579 @vindex gnus-preserve-marks
9580 Move the article from one mail group to another
9581 (@code{gnus-summary-move-article}).  Marks will be preserved if
9582 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9583
9584 @item B c
9585 @kindex B c (Summary)
9586 @cindex copy mail
9587 @findex gnus-summary-copy-article
9588 @c @icon{gnus-summary-mail-copy}
9589 Copy the article from one group (mail group or not) to a mail group
9590 (@code{gnus-summary-copy-article}).  Marks will be preserved if
9591 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
9592
9593 @item B B
9594 @kindex B B (Summary)
9595 @cindex crosspost mail
9596 @findex gnus-summary-crosspost-article
9597 Crosspost the current article to some other group
9598 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
9599 the article in the other group, and the Xref headers of the article will
9600 be properly updated.
9601
9602 @item B i
9603 @kindex B i (Summary)
9604 @findex gnus-summary-import-article
9605 Import an arbitrary file into the current mail newsgroup
9606 (@code{gnus-summary-import-article}).  You will be prompted for a file
9607 name, a @code{From} header and a @code{Subject} header.
9608
9609 @item B I
9610 @kindex B I (Summary)
9611 @findex gnus-summary-create-article
9612 Create an empty article in the current mail newsgroups
9613 (@code{gnus-summary-create-article}).  You will be prompted for a
9614 @code{From} header and a @code{Subject} header.
9615
9616 @item B r
9617 @kindex B r (Summary)
9618 @findex gnus-summary-respool-article
9619 Respool the mail article (@code{gnus-summary-respool-article}).
9620 @code{gnus-summary-respool-default-method} will be used as the default
9621 select method when respooling.  This variable is @code{nil} by default,
9622 which means that the current group select method will be used instead.
9623 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
9624 (which is the default).
9625
9626 @item B w
9627 @itemx e
9628 @kindex B w (Summary)
9629 @kindex e (Summary)
9630 @findex gnus-summary-edit-article
9631 @kindex C-c C-c (Article)
9632 @findex gnus-summary-edit-article-done
9633 Edit the current article (@code{gnus-summary-edit-article}).  To finish
9634 editing and make the changes permanent, type @kbd{C-c C-c}
9635 (@code{gnus-summary-edit-article-done}).  If you give a prefix to the
9636 @kbd{C-c C-c} command, gnus won't re-highlight the article.
9637
9638 @item B q
9639 @kindex B q (Summary)
9640 @findex gnus-summary-respool-query
9641 If you want to re-spool an article, you might be curious as to what group
9642 the article will end up in before you do the re-spooling.  This command
9643 will tell you (@code{gnus-summary-respool-query}).
9644
9645 @item B t
9646 @kindex B t (Summary)
9647 @findex gnus-summary-respool-trace
9648 Similarly, this command will display all fancy splitting patterns used
9649 when repooling, if any (@code{gnus-summary-respool-trace}).
9650
9651 @item B p
9652 @kindex B p (Summary)
9653 @findex gnus-summary-article-posted-p
9654 Some people have a tendency to send you "courtesy" copies when they
9655 follow up to articles you have posted.  These usually have a
9656 @code{Newsgroups} header in them, but not always.  This command
9657 (@code{gnus-summary-article-posted-p}) will try to fetch the current
9658 article from your news server (or rather, from
9659 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
9660 report back whether it found the article or not.  Even if it says that
9661 it didn't find the article, it may have been posted anyway---mail
9662 propagation is much faster than news propagation, and the news copy may
9663 just not have arrived yet.
9664
9665 @item K E
9666 @kindex K E (Summary)
9667 @findex gnus-article-encrypt-body
9668 @vindex gnus-article-encrypt-protocol
9669 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
9670 The body is encrypted with the encryption protocol specified by the
9671 variable @code{gnus-article-encrypt-protocol}.
9672
9673 @end table
9674
9675 @vindex gnus-move-split-methods
9676 @cindex moving articles
9677 If you move (or copy) articles regularly, you might wish to have gnus
9678 suggest where to put the articles.  @code{gnus-move-split-methods} is a
9679 variable that uses the same syntax as @code{gnus-split-methods}
9680 (@pxref{Saving Articles}).  You may customize that variable to create
9681 suggestions you find reasonable.  (Note that
9682 @code{gnus-move-split-methods} uses group names where
9683 @code{gnus-split-methods} uses file names.)
9684
9685 @lisp
9686 (setq gnus-move-split-methods
9687       '(("^From:.*Lars Magne" "nnml:junk")
9688         ("^Subject:.*gnus" "nnfolder:important")
9689         (".*" "nnml:misc")))
9690 @end lisp
9691
9692
9693 @node Various Summary Stuff
9694 @section Various Summary Stuff
9695
9696 @menu
9697 * Summary Group Information::   Information oriented commands.
9698 * Searching for Articles::      Multiple article commands.
9699 * Summary Generation Commands::  
9700 * Really Various Summary Commands::  Those pesky non-conformant commands.
9701 @end menu
9702
9703 @table @code
9704 @vindex gnus-summary-mode-hook
9705 @item gnus-summary-mode-hook
9706 This hook is called when creating a summary mode buffer.
9707
9708 @vindex gnus-summary-generate-hook
9709 @item gnus-summary-generate-hook
9710 This is called as the last thing before doing the threading and the
9711 generation of the summary buffer.  It's quite convenient for customizing
9712 the threading variables based on what data the newsgroup has.  This hook
9713 is called from the summary buffer after most summary buffer variables
9714 have been set.
9715
9716 @vindex gnus-summary-prepare-hook
9717 @item gnus-summary-prepare-hook
9718 It is called after the summary buffer has been generated.  You might use
9719 it to, for instance, highlight lines or modify the look of the buffer in
9720 some other ungodly manner.  I don't care.
9721
9722 @vindex gnus-summary-prepared-hook
9723 @item gnus-summary-prepared-hook
9724 A hook called as the very last thing after the summary buffer has been
9725 generated.
9726
9727 @vindex gnus-summary-ignore-duplicates
9728 @item gnus-summary-ignore-duplicates
9729 When gnus discovers two articles that have the same @code{Message-ID},
9730 it has to do something drastic.  No articles are allowed to have the
9731 same @code{Message-ID}, but this may happen when reading mail from some
9732 sources.  Gnus allows you to customize what happens with this variable.
9733 If it is @code{nil} (which is the default), gnus will rename the
9734 @code{Message-ID} (for display purposes only) and display the article as
9735 any other article.  If this variable is @code{t}, it won't display the
9736 article---it'll be as if it never existed.
9737
9738 @vindex gnus-alter-articles-to-read-function
9739 @item gnus-alter-articles-to-read-function
9740 This function, which takes two parameters (the group name and the list
9741 of articles to be selected), is called to allow the user to alter the
9742 list of articles to be selected.
9743
9744 For instance, the following function adds the list of cached articles to
9745 the list in one particular group:
9746
9747 @lisp
9748 (defun my-add-cached-articles (group articles)
9749   (if (string= group "some.group")
9750       (append gnus-newsgroup-cached articles)
9751     articles))
9752 @end lisp
9753
9754 @vindex gnus-newsgroup-variables
9755 @item gnus-newsgroup-variables
9756 A list of newsgroup (summary buffer) local variables, or cons of
9757 variables and their default values (when the default values are not
9758 nil), that should be made global while the summary buffer is active.
9759 These variables can be used to set variables in the group parameters
9760 while still allowing them to affect operations done in other
9761 buffers. For example:
9762
9763 @lisp
9764 (setq gnus-newsgroup-variables
9765      '(message-use-followup-to
9766        (gnus-visible-headers .
9767          "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
9768 @end lisp
9769
9770 @end table
9771
9772
9773 @node Summary Group Information
9774 @subsection Summary Group Information
9775
9776 @table @kbd
9777
9778 @item H f
9779 @kindex H f (Summary)
9780 @findex gnus-summary-fetch-faq
9781 @vindex gnus-group-faq-directory
9782 Try to fetch the FAQ (list of frequently asked questions) for the
9783 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
9784 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
9785 on a remote machine.  This variable can also be a list of directories.
9786 In that case, giving a prefix to this command will allow you to choose
9787 between the various sites.  @code{ange-ftp} or @code{efs} will probably
9788 be used for fetching the file.
9789
9790 @item H d
9791 @kindex H d (Summary)
9792 @findex gnus-summary-describe-group
9793 Give a brief description of the current group
9794 (@code{gnus-summary-describe-group}).  If given a prefix, force
9795 rereading the description from the server.
9796
9797 @item H h
9798 @kindex H h (Summary)
9799 @findex gnus-summary-describe-briefly
9800 Give an extremely brief description of the most important summary
9801 keystrokes (@code{gnus-summary-describe-briefly}).
9802
9803 @item H i
9804 @kindex H i (Summary)
9805 @findex gnus-info-find-node
9806 Go to the gnus info node (@code{gnus-info-find-node}).
9807 @end table
9808
9809
9810 @node Searching for Articles
9811 @subsection Searching for Articles
9812
9813 @table @kbd
9814
9815 @item M-s
9816 @kindex M-s (Summary)
9817 @findex gnus-summary-search-article-forward
9818 Search through all subsequent (raw) articles for a regexp
9819 (@code{gnus-summary-search-article-forward}).
9820
9821 @item M-r
9822 @kindex M-r (Summary)
9823 @findex gnus-summary-search-article-backward
9824 Search through all previous (raw) articles for a regexp
9825 (@code{gnus-summary-search-article-backward}).
9826
9827 @item &
9828 @kindex & (Summary)
9829 @findex gnus-summary-execute-command
9830 This command will prompt you for a header, a regular expression to match
9831 on this field, and a command to be executed if the match is made
9832 (@code{gnus-summary-execute-command}).  If the header is an empty
9833 string, the match is done on the entire article.  If given a prefix,
9834 search backward instead.
9835
9836 For instance, @kbd{& RET some.*string #} will put the process mark on
9837 all articles that have heads or bodies that match @samp{some.*string}.
9838
9839 @item M-&
9840 @kindex M-& (Summary)
9841 @findex gnus-summary-universal-argument
9842 Perform any operation on all articles that have been marked with
9843 the process mark (@code{gnus-summary-universal-argument}).
9844 @end table
9845
9846 @node Summary Generation Commands
9847 @subsection Summary Generation Commands
9848
9849 @table @kbd
9850
9851 @item Y g
9852 @kindex Y g (Summary)
9853 @findex gnus-summary-prepare
9854 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
9855
9856 @item Y c
9857 @kindex Y c (Summary)
9858 @findex gnus-summary-insert-cached-articles
9859 Pull all cached articles (for the current group) into the summary buffer
9860 (@code{gnus-summary-insert-cached-articles}).
9861
9862 @item Y d
9863 @kindex Y d (Summary)
9864 @findex gnus-summary-insert-dormant-articles
9865 Pull all dormant articles (for the current group) into the summary buffer
9866 (@code{gnus-summary-insert-dormant-articles}).
9867
9868 @end table
9869
9870
9871 @node Really Various Summary Commands
9872 @subsection Really Various Summary Commands
9873
9874 @table @kbd
9875
9876 @item A D
9877 @itemx C-d
9878 @kindex C-d (Summary)
9879 @kindex A D (Summary)
9880 @findex gnus-summary-enter-digest-group
9881 If the current article is a collection of other articles (for instance,
9882 a digest), you might use this command to enter a group based on the that
9883 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
9884 guess what article type is currently displayed unless you give a prefix
9885 to this command, which forces a ``digest'' interpretation.  Basically,
9886 whenever you see a message that is a collection of other messages of
9887 some format, you @kbd{C-d} and read these messages in a more convenient
9888 fashion.
9889
9890 @item C-M-d
9891 @kindex C-M-d (Summary)
9892 @findex gnus-summary-read-document
9893 This command is very similar to the one above, but lets you gather
9894 several documents into one biiig group
9895 (@code{gnus-summary-read-document}).  It does this by opening several
9896 @code{nndoc} groups for each document, and then opening an
9897 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
9898 command understands the process/prefix convention
9899 (@pxref{Process/Prefix}).
9900
9901 @item C-t
9902 @kindex C-t (Summary)
9903 @findex gnus-summary-toggle-truncation
9904 Toggle truncation of summary lines
9905 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
9906 line centering function in the summary buffer, so it's not a good idea
9907 to have truncation switched off while reading articles.
9908
9909 @item =
9910 @kindex = (Summary)
9911 @findex gnus-summary-expand-window
9912 Expand the summary buffer window (@code{gnus-summary-expand-window}).
9913 If given a prefix, force an @code{article} window configuration.
9914
9915 @item C-M-e
9916 @kindex C-M-e (Summary)
9917 @findex gnus-summary-edit-parameters
9918 Edit the group parameters (@pxref{Group Parameters}) of the current
9919 group (@code{gnus-summary-edit-parameters}).
9920
9921 @item C-M-a
9922 @kindex C-M-a (Summary)
9923 @findex gnus-summary-customize-parameters
9924 Customize the group parameters (@pxref{Group Parameters}) of the current
9925 group (@code{gnus-summary-customize-parameters}).
9926
9927 @end table
9928
9929
9930 @node Exiting the Summary Buffer
9931 @section Exiting the Summary Buffer
9932 @cindex summary exit
9933 @cindex exiting groups
9934
9935 Exiting from the summary buffer will normally update all info on the
9936 group and return you to the group buffer.
9937
9938 @table @kbd
9939
9940 @item Z Z
9941 @itemx q
9942 @kindex Z Z (Summary)
9943 @kindex q (Summary)
9944 @findex gnus-summary-exit
9945 @vindex gnus-summary-exit-hook
9946 @vindex gnus-summary-prepare-exit-hook
9947 @c @icon{gnus-summary-exit}
9948 Exit the current group and update all information on the group
9949 (@code{gnus-summary-exit}).  @code{gnus-summary-prepare-exit-hook} is
9950 called before doing much of the exiting, which calls
9951 @code{gnus-summary-expire-articles} by default.
9952 @code{gnus-summary-exit-hook} is called after finishing the exit
9953 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
9954 group mode having no more (unread) groups.
9955
9956 @item Z E
9957 @itemx Q
9958 @kindex Z E (Summary)
9959 @kindex Q (Summary)
9960 @findex gnus-summary-exit-no-update
9961 Exit the current group without updating any information on the group
9962 (@code{gnus-summary-exit-no-update}).
9963
9964 @item Z c
9965 @itemx c
9966 @kindex Z c (Summary)
9967 @kindex c (Summary)
9968 @findex gnus-summary-catchup-and-exit
9969 @c @icon{gnus-summary-catchup-and-exit}
9970 Mark all unticked articles in the group as read and then exit
9971 (@code{gnus-summary-catchup-and-exit}).
9972
9973 @item Z C
9974 @kindex Z C (Summary)
9975 @findex gnus-summary-catchup-all-and-exit
9976 Mark all articles, even the ticked ones, as read and then exit
9977 (@code{gnus-summary-catchup-all-and-exit}).
9978
9979 @item Z n
9980 @kindex Z n (Summary)
9981 @findex gnus-summary-catchup-and-goto-next-group
9982 Mark all articles as read and go to the next group
9983 (@code{gnus-summary-catchup-and-goto-next-group}).
9984
9985 @item Z R
9986 @kindex Z R (Summary)
9987 @findex gnus-summary-reselect-current-group
9988 Exit this group, and then enter it again
9989 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
9990 all articles, both read and unread.
9991
9992 @item Z G
9993 @itemx M-g
9994 @kindex Z G (Summary)
9995 @kindex M-g (Summary)
9996 @findex gnus-summary-rescan-group
9997 @c @icon{gnus-summary-mail-get}
9998 Exit the group, check for new articles in the group, and select the
9999 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
10000 articles, both read and unread.
10001
10002 @item Z N
10003 @kindex Z N (Summary)
10004 @findex gnus-summary-next-group
10005 Exit the group and go to the next group
10006 (@code{gnus-summary-next-group}).
10007
10008 @item Z P
10009 @kindex Z P (Summary)
10010 @findex gnus-summary-prev-group
10011 Exit the group and go to the previous group
10012 (@code{gnus-summary-prev-group}).
10013
10014 @item Z s
10015 @kindex Z s (Summary)
10016 @findex gnus-summary-save-newsrc
10017 Save the current number of read/marked articles in the dribble buffer
10018 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
10019 given a prefix, also save the @file{.newsrc} file(s).  Using this
10020 command will make exit without updating (the @kbd{Q} command) worthless.
10021 @end table
10022
10023 @vindex gnus-exit-group-hook
10024 @code{gnus-exit-group-hook} is called when you exit the current group
10025 with an ``updating'' exit.  For instance @kbd{Q}
10026 (@code{gnus-summary-exit-no-update}) does not call this hook.
10027
10028 @findex gnus-summary-wake-up-the-dead
10029 @findex gnus-dead-summary-mode
10030 @vindex gnus-kill-summary-on-exit
10031 If you're in the habit of exiting groups, and then changing your mind
10032 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
10033 If you do that, gnus won't kill the summary buffer when you exit it.
10034 (Quelle surprise!)  Instead it will change the name of the buffer to
10035 something like @samp{*Dead Summary ... *} and install a minor mode
10036 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
10037 buffer, you'll find that all keys are mapped to a function called
10038 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
10039 summary buffer will result in a live, normal summary buffer.
10040
10041 There will never be more than one dead summary buffer at any one time.
10042
10043 @vindex gnus-use-cross-reference
10044 The data on the current group will be updated (which articles you have
10045 read, which articles you have replied to, etc.) when you exit the
10046 summary buffer.  If the @code{gnus-use-cross-reference} variable is
10047 @code{t} (which is the default), articles that are cross-referenced to
10048 this group and are marked as read, will also be marked as read in the
10049 other subscribed groups they were cross-posted to.  If this variable is
10050 neither @code{nil} nor @code{t}, the article will be marked as read in
10051 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
10052
10053
10054 @node Crosspost Handling
10055 @section Crosspost Handling
10056
10057 @cindex velveeta
10058 @cindex spamming
10059 Marking cross-posted articles as read ensures that you'll never have to
10060 read the same article more than once.  Unless, of course, somebody has
10061 posted it to several groups separately.  Posting the same article to
10062 several groups (not cross-posting) is called @dfn{spamming}, and you are
10063 by law required to send nasty-grams to anyone who perpetrates such a
10064 heinous crime.  You may want to try NoCeM handling to filter out spam
10065 (@pxref{NoCeM}).
10066
10067 Remember: Cross-posting is kinda ok, but posting the same article
10068 separately to several groups is not.  Massive cross-posting (aka.
10069 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
10070 @code{gnus-summary-mail-crosspost-complaint} command to complain about
10071 excessive crossposting (@pxref{Summary Mail Commands}).
10072
10073 @cindex cross-posting
10074 @cindex Xref
10075 @cindex @sc{nov}
10076 One thing that may cause Gnus to not do the cross-posting thing
10077 correctly is if you use an @sc{nntp} server that supports @sc{xover}
10078 (which is very nice, because it speeds things up considerably) which
10079 does not include the @code{Xref} header in its @sc{nov} lines.  This is
10080 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
10081 even with @sc{xover} by registering the @code{Xref} lines of all
10082 articles you actually read, but if you kill the articles, or just mark
10083 them as read without reading them, Gnus will not get a chance to snoop
10084 the @code{Xref} lines out of these articles, and will be unable to use
10085 the cross reference mechanism.
10086
10087 @cindex LIST overview.fmt
10088 @cindex overview.fmt
10089 To check whether your @sc{nntp} server includes the @code{Xref} header
10090 in its overview files, try @samp{telnet your.nntp.server nntp},
10091 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
10092 overview.fmt}.  This may not work, but if it does, and the last line you
10093 get does not read @samp{Xref:full}, then you should shout and whine at
10094 your news admin until she includes the @code{Xref} header in the
10095 overview files.
10096
10097 @vindex gnus-nov-is-evil
10098 If you want Gnus to get the @code{Xref}s right all the time, you have to
10099 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
10100 considerably.
10101
10102 C'est la vie.
10103
10104 For an alternative approach, @pxref{Duplicate Suppression}.
10105
10106
10107 @node Duplicate Suppression
10108 @section Duplicate Suppression
10109
10110 By default, gnus tries to make sure that you don't have to read the same
10111 article more than once by utilizing the crossposting mechanism
10112 (@pxref{Crosspost Handling}).  However, that simple and efficient
10113 approach may not work satisfactory for some users for various
10114 reasons.
10115
10116 @enumerate
10117 @item
10118 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
10119 is evil and not very common.
10120
10121 @item
10122 The @sc{nntp} server may fail to include the @code{Xref} header in the
10123 @file{.overview} data bases.  This is evil and all too common, alas.
10124
10125 @item
10126 You may be reading the same group (or several related groups) from
10127 different @sc{nntp} servers.
10128
10129 @item
10130 You may be getting mail that duplicates articles posted to groups.
10131 @end enumerate
10132
10133 I'm sure there are other situations where @code{Xref} handling fails as
10134 well, but these four are the most common situations.
10135
10136 If, and only if, @code{Xref} handling fails for you, then you may
10137 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
10138 will remember the @code{Message-ID}s of all articles you have read or
10139 otherwise marked as read, and then, as if by magic, mark them as read
10140 all subsequent times you see them---in @emph{all} groups.  Using this
10141 mechanism is quite likely to be somewhat inefficient, but not overly
10142 so.  It's certainly preferable to reading the same articles more than
10143 once.
10144
10145 Duplicate suppression is not a very subtle instrument.  It's more like a
10146 sledge hammer than anything else.  It works in a very simple
10147 fashion---if you have marked an article as read, it adds this Message-ID
10148 to a cache.  The next time it sees this Message-ID, it will mark the
10149 article as read with the @samp{M} mark.  It doesn't care what group it
10150 saw the article in.
10151
10152 @table @code
10153 @item gnus-suppress-duplicates
10154 @vindex gnus-suppress-duplicates
10155 If non-@code{nil}, suppress duplicates.
10156
10157 @item gnus-save-duplicate-list
10158 @vindex gnus-save-duplicate-list
10159 If non-@code{nil}, save the list of duplicates to a file.  This will
10160 make startup and shutdown take longer, so the default is @code{nil}.
10161 However, this means that only duplicate articles read in a single gnus
10162 session are suppressed.
10163
10164 @item gnus-duplicate-list-length
10165 @vindex gnus-duplicate-list-length
10166 This variable says how many @code{Message-ID}s to keep in the duplicate
10167 suppression list.  The default is 10000.
10168
10169 @item gnus-duplicate-file
10170 @vindex gnus-duplicate-file
10171 The name of the file to store the duplicate suppression list in.  The
10172 default is @file{~/News/suppression}.
10173 @end table
10174
10175 If you have a tendency to stop and start gnus often, setting
10176 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
10177 you leave gnus running for weeks on end, you may have it @code{nil}.  On
10178 the other hand, saving the list makes startup and shutdown much slower,
10179 so that means that if you stop and start gnus often, you should set
10180 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
10181 to you to figure out, I think.
10182
10183 @node Security
10184 @section Security
10185
10186 Gnus is able to verify signed messages or decrypt encrypted messages.
10187 The formats that are supported are PGP, @sc{pgp/mime} and @sc{s/mime},
10188 however you need some external programs to get things to work:
10189
10190 @enumerate
10191 @item
10192 To handle PGP messages, you have to install mailcrypt or gpg.el as
10193 well as a OpenPGP implementation (such as GnuPG).
10194
10195 @item
10196 To handle @sc{s/mime} message, you need to install OpenSSL.  OpenSSL 0.9.6
10197 or newer is recommended.
10198
10199 @end enumerate
10200
10201 More information on how to set things up can be found in the message
10202 manual (@pxref{Security, ,Security, message, Message Manual}).
10203
10204 @table @code
10205 @item mm-verify-option
10206 @vindex mm-verify-option
10207 Option of verifying signed parts.  @code{never}, not verify;
10208 @code{always}, always verify; @code{known}, only verify known
10209 protocols. Otherwise, ask user.
10210
10211 @item mm-decrypt-option
10212 @vindex mm-decrypt-option
10213 Option of decrypting encrypted parts.  @code{never}, no decryption;
10214 @code{always}, always decrypt; @code{known}, only decrypt known
10215 protocols. Otherwise, ask user.
10216
10217 @end table
10218
10219 @node Mailing List
10220 @section Mailing List
10221
10222 @kindex A M (summary)
10223 @findex gnus-mailing-list-insinuate
10224 Gnus understands some mailing list fields of RFC 2369.  To enable it,
10225 either add a `to-list' group parameter (@pxref{Group Parameters}),
10226 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
10227 summary buffer, or say:
10228
10229 @lisp
10230 (add-hook 'gnus-summary-mode-hook 'turn-on-gnus-mailing-list-mode)
10231 @end lisp
10232
10233 That enables the following commands to the summary buffer:
10234
10235 @table @kbd
10236
10237 @item C-c C-n h
10238 @kindex C-c C-n h (Summary)
10239 @findex gnus-mailing-list-help
10240 Send a message to fetch mailing list help, if List-Help field exists.
10241
10242 @item C-c C-n s
10243 @kindex C-c C-n s (Summary)
10244 @findex gnus-mailing-list-subscribe
10245 Send a message to subscribe the mailing list, if List-Subscribe field exists.
10246
10247 @item C-c C-n u
10248 @kindex C-c C-n u (Summary)
10249 @findex gnus-mailing-list-unsubscribe
10250 Send a message to unsubscribe the mailing list, if List-Unsubscribe
10251 field exists.
10252
10253 @item C-c C-n p
10254 @kindex C-c C-n p (Summary)
10255 @findex gnus-mailing-list-post
10256 Post to the mailing list, if List-Post field exists.
10257
10258 @item C-c C-n o
10259 @kindex C-c C-n o (Summary)
10260 @findex gnus-mailing-list-owner
10261 Send a message to the mailing list owner, if List-Owner field exists.
10262
10263 @item C-c C-n a
10264 @kindex C-c C-n a (Summary)
10265 @findex gnus-mailing-list-owner
10266 Browse the mailing list archive, if List-Archive field exists.
10267
10268 @end table
10269
10270 @node Article Buffer
10271 @chapter Article Buffer
10272 @cindex article buffer
10273
10274 The articles are displayed in the article buffer, of which there is only
10275 one.  All the summary buffers share the same article buffer unless you
10276 tell gnus otherwise.
10277
10278 @menu
10279 * Hiding Headers::              Deciding what headers should be displayed.
10280 * Using MIME::                  Pushing articles through @sc{mime} before reading them.
10281 * Customizing Articles::        Tailoring the look of the articles.
10282 * Article Keymap::              Keystrokes available in the article buffer.
10283 * Misc Article::                Other stuff.
10284 @end menu
10285
10286
10287 @node Hiding Headers
10288 @section Hiding Headers
10289 @cindex hiding headers
10290 @cindex deleting headers
10291
10292 The top section of each article is the @dfn{head}.  (The rest is the
10293 @dfn{body}, but you may have guessed that already.)
10294
10295 @vindex gnus-show-all-headers
10296 There is a lot of useful information in the head: the name of the person
10297 who wrote the article, the date it was written and the subject of the
10298 article.  That's well and nice, but there's also lots of information
10299 most people do not want to see---what systems the article has passed
10300 through before reaching you, the @code{Message-ID}, the
10301 @code{References}, etc. ad nauseum---and you'll probably want to get rid
10302 of some of those lines.  If you want to keep all those lines in the
10303 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
10304
10305 Gnus provides you with two variables for sifting headers:
10306
10307 @table @code
10308
10309 @item gnus-visible-headers
10310 @vindex gnus-visible-headers
10311 If this variable is non-@code{nil}, it should be a regular expression
10312 that says what headers you wish to keep in the article buffer.  All
10313 headers that do not match this variable will be hidden.
10314
10315 For instance, if you only want to see the name of the person who wrote
10316 the article and the subject, you'd say:
10317
10318 @lisp
10319 (setq gnus-visible-headers "^From:\\|^Subject:")
10320 @end lisp
10321
10322 This variable can also be a list of regexps to match headers to
10323 remain visible.
10324
10325 @item gnus-ignored-headers
10326 @vindex gnus-ignored-headers
10327 This variable is the reverse of @code{gnus-visible-headers}.  If this
10328 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
10329 should be a regular expression that matches all lines that you want to
10330 hide.  All lines that do not match this variable will remain visible.
10331
10332 For instance, if you just want to get rid of the @code{References} field
10333 and the @code{Xref} field, you might say:
10334
10335 @lisp
10336 (setq gnus-ignored-headers "^References:\\|^Xref:")
10337 @end lisp
10338
10339 This variable can also be a list of regexps to match headers to
10340 be removed.
10341
10342 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
10343 variable will have no effect.
10344
10345 @end table
10346
10347 @vindex gnus-sorted-header-list
10348 Gnus can also sort the headers for you.  (It does this by default.)  You
10349 can control the sorting by setting the @code{gnus-sorted-header-list}
10350 variable.  It is a list of regular expressions that says in what order
10351 the headers are to be displayed.
10352
10353 For instance, if you want the name of the author of the article first,
10354 and then the subject, you might say something like:
10355
10356 @lisp
10357 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
10358 @end lisp
10359
10360 Any headers that are to remain visible, but are not listed in this
10361 variable, will be displayed in random order after all the headers listed in this variable.
10362
10363 @findex gnus-article-hide-boring-headers
10364 @vindex gnus-boring-article-headers
10365 You can hide further boring headers by setting
10366 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
10367 does depends on the @code{gnus-boring-article-headers} variable.  It's a
10368 list, but this list doesn't actually contain header names.  Instead is
10369 lists various @dfn{boring conditions} that Gnus can check and remove
10370 from sight.
10371
10372 These conditions are:
10373 @table @code
10374 @item empty
10375 Remove all empty headers.
10376 @item followup-to
10377 Remove the @code{Followup-To} header if it is identical to the
10378 @code{Newsgroups} header.
10379 @item reply-to
10380 Remove the @code{Reply-To} header if it lists the same address as the
10381 @code{From} header.
10382 @item newsgroups
10383 Remove the @code{Newsgroups} header if it only contains the current group
10384 name.
10385 @item to-address
10386 Remove the @code{To} header if it only contains the address identical to
10387 the current groups's @code{to-address} parameter.
10388 @item date
10389 Remove the @code{Date} header if the article is less than three days
10390 old.
10391 @item long-to
10392 Remove the @code{To} header if it is very long.
10393 @item many-to
10394 Remove all @code{To} headers if there are more than one.
10395 @end table
10396
10397 To include these three elements, you could say something like:
10398
10399 @lisp
10400 (setq gnus-boring-article-headers
10401       '(empty followup-to reply-to))
10402 @end lisp
10403
10404 This is also the default value for this variable.
10405
10406
10407 @node Using MIME
10408 @section Using MIME
10409 @cindex @sc{mime}
10410
10411 Mime is a standard for waving your hands through the air, aimlessly,
10412 while people stand around yawning.
10413
10414 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
10415 while all newsreaders die of fear.
10416
10417 @sc{mime} may specify what character set the article uses, the encoding
10418 of the characters, and it also makes it possible to embed pictures and
10419 other naughty stuff in innocent-looking articles.
10420
10421 @vindex gnus-show-mime
10422 @vindex gnus-article-display-method-for-mime
10423 @findex gnus-article-display-mime-message
10424 Gnus handles @sc{mime} by pushing the articles through
10425 @code{gnus-article-display-method-for-mime}, which is
10426 @code{gnus-article-display-mime-message} by default.  This function
10427 calls the @sc{semi} MIME-View program to actually do the work.  For more
10428 information on @sc{semi} MIME-View, see its manual page (however it is
10429 not existed yet, sorry).
10430
10431 Set @code{gnus-show-mime} to @code{t} if you want to use
10432 @sc{mime} all the time.  If you have @code{gnus-show-mime} set, then
10433 you'll see some unfortunate display glitches in the article buffer.
10434 These can't be avoided.
10435
10436 In GNUS or Gnus, it might be best to just use the toggling functions
10437 from the summary buffer to avoid getting nasty surprises. (For instance,
10438 you enter the group @samp{alt.sing-a-long} and, before you know it,
10439 @sc{mime} has decoded the sound file in the article and some horrible
10440 sing-a-long song comes screaming out your speakers, and you can't find
10441 the volume button, because there isn't one, and people are starting to
10442 look at you, and you try to stop the program, but you can't, and you
10443 can't find the program to control the volume, and everybody else in the
10444 room suddenly decides to look at you disdainfully, and you'll feel
10445 rather stupid.)
10446
10447 Any similarity to real events and people is purely coincidental.  Ahem.
10448
10449 To avoid such kind of situation, gnus stops to use
10450 @code{metamail-buffer}.  So now, you can set @code{gnus-show-mime} to
10451 non-@code{nil} every-time, then you can push button in the article
10452 buffer when there are nobody else.
10453
10454 Also see @pxref{MIME Commands}.
10455
10456
10457 @node Customizing Articles
10458 @section Customizing Articles
10459 @cindex article customization
10460
10461 A slew of functions for customizing how the articles are to look like
10462 exist.  You can call these functions interactively, or you can have them
10463 called automatically when you select the articles.
10464
10465 To have them called automatically, you should set the corresponding
10466 ``treatment'' variable.  For instance, to have headers hidden, you'd set
10467 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
10468 be set, but first we discuss the values these variables can have.
10469
10470 Note: Some values, while valid, make little sense.  Check the list below
10471 for sensible values.
10472
10473 @enumerate
10474 @item
10475 @code{nil}: Don't do this treatment.
10476
10477 @item
10478 @code{t}: Do this treatment on all body parts.
10479
10480 @item
10481 @code{head}: Do the treatment on the headers.
10482
10483 @item
10484 @code{last}: Do this treatment on the last part.
10485
10486 @item
10487 An integer: Do this treatment on all body parts that have a length less
10488 than this number.
10489
10490 @item
10491 A list of strings: Do this treatment on all body parts that are in
10492 articles that are read in groups that have names that match one of the
10493 regexps in the list.
10494
10495 @item
10496 A list where the first element is not a string:
10497
10498 The list is evaluated recursively.  The first element of the list is a
10499 predicate.  The following predicates are recognized: @code{or},
10500 @code{and}, @code{not} and @code{typep}.  Here's an example:
10501
10502 @lisp
10503 (or last
10504     (typep "text/x-vcard"))
10505 @end lisp
10506
10507 @item
10508 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
10509 non-nil.
10510
10511 @end enumerate
10512
10513 You may have noticed that the word @dfn{part} is used here.  This refers
10514 to the fact that some messages are @sc{mime} multipart articles that may
10515 be divided into several parts.  Articles that are not multiparts are
10516 considered to contain just a single part.
10517
10518 @vindex gnus-article-treat-types
10519 Are the treatments applied to all sorts of multipart parts?  Yes, if you
10520 want to, but by default, only @samp{text/plain} parts are given the
10521 treatment.  This is controlled by the @code{gnus-article-treat-types}
10522 variable, which is a list of regular expressions that are matched to the
10523 type of the part.  This variable is ignored if the value of the
10524 controlling variable is a predicate list, as described above.
10525
10526 The following treatment options are available.  The easiest way to
10527 customize this is to examine the @code{gnus-article-treat} customization
10528 group.  Values in parenthesis are suggested sensible values.  Others are
10529 possible but those listed are probably sufficient for most people.
10530
10531 @table @code
10532 @item gnus-treat-buttonize (t, integer)
10533 @item gnus-treat-buttonize-head (head)
10534
10535 @xref{Article Buttons}.
10536
10537 @item gnus-treat-capitalize-sentences (t, integer)
10538 @item gnus-treat-overstrike (t, integer)
10539 @item gnus-treat-strip-cr (t, integer)
10540 @item gnus-treat-strip-headers-in-body (t, integer)
10541 @item gnus-treat-strip-leading-blank-lines (t, integer)
10542 @item gnus-treat-strip-multiple-blank-lines (t, integer)
10543 @item gnus-treat-strip-pem (t, last, integer)
10544 @item gnus-treat-strip-pgp (t, last, integer)
10545 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
10546 @item gnus-treat-unsplit-urls (t, integer)
10547 @item gnus-treat-wash-html (t, integer)
10548 @item gnus-treat-decode-article-as-default-mime-charset (t, integer)
10549
10550 @xref{Article Washing}.
10551
10552 @item gnus-treat-date-english (head)
10553 @item gnus-treat-date-iso8601 (head)
10554 @item gnus-treat-date-lapsed (head)
10555 @item gnus-treat-date-local (head)
10556 @item gnus-treat-date-original (head)
10557 @item gnus-treat-date-user-defined (head)
10558 @item gnus-treat-date-ut (head)
10559
10560 @xref{Article Date}.
10561
10562 @item gnus-treat-from-picon (head)
10563 @item gnus-treat-mail-picon (head)
10564 @item gnus-treat-newsgroups-picon (head)
10565
10566 @xref{Picons}.
10567
10568 @item gnus-treat-display-smileys (t, integer)
10569
10570 @item gnus-treat-body-boundary (head)
10571
10572 @vindex gnus-body-boundary-delimiter
10573 Adds a delimiter between header and body, the string used as delimiter
10574 is controlled by @code{gnus-body-boundary-delimiter}.
10575
10576 @xref{Smileys}.
10577
10578 @item gnus-treat-display-xface (head)
10579
10580 @xref{X-Face}.
10581
10582 @item gnus-treat-emphasize (t, head, integer)
10583 @item gnus-treat-fill-article (t, integer)
10584 @item gnus-treat-fill-long-lines (t, integer)
10585 @item gnus-treat-hide-boring-headers (head)
10586 @item gnus-treat-hide-citation (t, integer)
10587 @item gnus-treat-hide-citation-maybe (t, integer)
10588 @item gnus-treat-hide-headers (head)
10589 @item gnus-treat-hide-signature (t, last)
10590
10591 @xref{Article Hiding}.
10592
10593 @item gnus-treat-highlight-citation (t, integer)
10594 @item gnus-treat-highlight-headers (head)
10595 @item gnus-treat-highlight-signature (t, last, integer)
10596
10597 @xref{Article Highlighting}.
10598
10599 @item gnus-treat-play-sounds
10600 @item gnus-treat-translate
10601 @item gnus-treat-x-pgp-sig (head)
10602
10603 @item gnus-treat-unfold-headers (head)
10604 @item gnus-treat-fold-headers (head)
10605 @item gnus-treat-fold-newsgroups (head)
10606 @item gnus-treat-leading-whitespace (head)
10607
10608 @xref{Article Header}.
10609
10610
10611 @end table
10612
10613 @vindex gnus-part-display-hook
10614 You can, of course, write your own functions to be called from
10615 @code{gnus-part-display-hook}.  The functions are called narrowed to the
10616 part, and you can do anything you like, pretty much.  There is no
10617 information that you have to keep in the buffer---you can change
10618 everything.
10619
10620
10621 @node Article Keymap
10622 @section Article Keymap
10623
10624 Most of the keystrokes in the summary buffer can also be used in the
10625 article buffer.  They should behave as if you typed them in the summary
10626 buffer, which means that you don't actually have to have a summary
10627 buffer displayed while reading.  You can do it all from the article
10628 buffer.
10629
10630 A few additional keystrokes are available:
10631
10632 @table @kbd
10633
10634 @item SPACE
10635 @kindex SPACE (Article)
10636 @findex gnus-article-next-page
10637 Scroll forwards one page (@code{gnus-article-next-page}).
10638
10639 @item DEL
10640 @kindex DEL (Article)
10641 @findex gnus-article-prev-page
10642 Scroll backwards one page (@code{gnus-article-prev-page}).
10643
10644 @item C-c ^
10645 @kindex C-c ^ (Article)
10646 @findex gnus-article-refer-article
10647 If point is in the neighborhood of a @code{Message-ID} and you press
10648 @kbd{C-c ^}, Gnus will try to get that article from the server
10649 (@code{gnus-article-refer-article}).
10650
10651 @item C-c C-m
10652 @kindex C-c C-m (Article)
10653 @findex gnus-article-mail
10654 Send a reply to the address near point (@code{gnus-article-mail}).  If
10655 given a prefix, include the mail.
10656
10657 @item s
10658 @kindex s (Article)
10659 @findex gnus-article-show-summary
10660 Reconfigure the buffers so that the summary buffer becomes visible
10661 (@code{gnus-article-show-summary}).
10662
10663 @item ?
10664 @kindex ? (Article)
10665 @findex gnus-article-describe-briefly
10666 Give a very brief description of the available keystrokes
10667 (@code{gnus-article-describe-briefly}).
10668
10669 @item TAB
10670 @kindex TAB (Article)
10671 @findex gnus-article-next-button
10672 Go to the next button, if any (@code{gnus-article-next-button}).  This
10673 only makes sense if you have buttonizing turned on.
10674
10675 @item M-TAB
10676 @kindex M-TAB (Article)
10677 @findex gnus-article-prev-button
10678 Go to the previous button, if any (@code{gnus-article-prev-button}).
10679
10680 @item R
10681 @kindex R (Article)
10682 @findex gnus-article-reply-with-original
10683 Send a reply to the current article and yank the current article
10684 (@code{gnus-article-reply-with-original}).  If given a prefix, make a
10685 wide reply.  If the region is active, only yank the text in the
10686 region.
10687
10688 @item F
10689 @kindex F (Article)
10690 @findex gnus-article-followup-with-original
10691 Send a followup to the current article and yank the current article
10692 (@code{gnus-article-followup-with-original}).  If given a prefix, make
10693 a wide reply.  If the region is active, only yank the text in the
10694 region.
10695
10696
10697 @end table
10698
10699
10700 @node Misc Article
10701 @section Misc Article
10702
10703 @table @code
10704
10705 @item gnus-single-article-buffer
10706 @vindex gnus-single-article-buffer
10707 If non-@code{nil}, use the same article buffer for all the groups.
10708 (This is the default.)  If @code{nil}, each group will have its own
10709 article buffer.
10710
10711 @vindex gnus-article-decode-hook
10712 @item gnus-article-decode-hook
10713 @cindex MIME
10714 Hook used to decode @sc{mime} articles.  The default value is
10715 @code{(article-decode-charset article-decode-encoded-words)}
10716
10717 @vindex gnus-article-prepare-hook
10718 @item gnus-article-prepare-hook
10719 This hook is called right after the article has been inserted into the
10720 article buffer.  It is mainly intended for functions that do something
10721 depending on the contents; it should probably not be used for changing
10722 the contents of the article buffer.
10723
10724 @item gnus-article-mode-hook
10725 @vindex gnus-article-mode-hook
10726 Hook called in article mode buffers.
10727
10728 @item gnus-article-mode-syntax-table
10729 @vindex gnus-article-mode-syntax-table
10730 Syntax table used in article buffers.  It is initialized from
10731 @code{text-mode-syntax-table}.
10732
10733 @vindex gnus-article-mode-line-format
10734 @item gnus-article-mode-line-format
10735 This variable is a format string along the same lines as
10736 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
10737 accepts the same format specifications as that variable, with two
10738 extensions:
10739
10740 @table @samp
10741
10742 @item w
10743 The @dfn{wash status} of the article.  This is a short string with one
10744 character for each possible article wash operation that may have been
10745 performed.  The characters and their meaning:
10746
10747 @table @samp
10748
10749 @item c
10750 Displayed when cited text may be hidden in the article buffer.
10751
10752 @item h
10753 Displayed when headers are hidden in the article buffer.
10754
10755 @item p
10756 Displayed when article is digitally signed or encrypted, and Gnus has
10757 hidden the security headers.  (N.B. does not tell anything about
10758 security status, i.e. good or bad signature.)
10759
10760 @item s
10761 Displayed when the signature has been hidden in the Article buffer.
10762
10763 @item o
10764 Displayed when Gnus has treated overstrike characters in the article buffer.
10765
10766 @item e
10767 Displayed when Gnus has treated emphasised strings in the article buffer.
10768
10769 @end table
10770
10771 @item m
10772 The number of @sc{mime} parts in the article.
10773
10774 @end table
10775
10776 @vindex gnus-break-pages
10777
10778 @item gnus-break-pages
10779 Controls whether @dfn{page breaking} is to take place.  If this variable
10780 is non-@code{nil}, the articles will be divided into pages whenever a
10781 page delimiter appears in the article.  If this variable is @code{nil},
10782 paging will not be done.
10783
10784 @item gnus-page-delimiter
10785 @vindex gnus-page-delimiter
10786 This is the delimiter mentioned above.  By default, it is @samp{^L}
10787 (formfeed).
10788 @end table
10789
10790
10791 @node Composing Messages
10792 @chapter Composing Messages
10793 @cindex composing messages
10794 @cindex messages
10795 @cindex mail
10796 @cindex sending mail
10797 @cindex reply
10798 @cindex followup
10799 @cindex post
10800 @cindex using gpg
10801 @cindex using s/mime
10802 @cindex using smime
10803
10804 @kindex C-c C-c (Post)
10805 All commands for posting and mailing will put you in a message buffer
10806 where you can edit the article all you like, before you send the
10807 article by pressing @kbd{C-c C-c}.  @xref{Top, , Overview, message,
10808 Message Manual}.  Where the message will be posted/mailed to depends
10809 on your setup (@pxref{Posting Server}).
10810
10811 @menu
10812 * Mail::                        Mailing and replying.
10813 * Posting Server::              What server should you post and mail via?
10814 * Mail and Post::               Mailing and posting at the same time.
10815 * Archived Messages::           Where Gnus stores the messages you've sent.
10816 * Posting Styles::              An easier way to specify who you are.
10817 * Drafts::                      Postponing messages and rejected messages.
10818 * Rejected Articles::           What happens if the server doesn't like your article?
10819 * Signing and encrypting::      How to compose secure messages.
10820 @end menu
10821
10822 Also see @pxref{Canceling and Superseding} for information on how to
10823 remove articles you shouldn't have posted.
10824
10825
10826 @node Mail
10827 @section Mail
10828
10829 Variables for customizing outgoing mail:
10830
10831 @table @code
10832 @item gnus-uu-digest-headers
10833 @vindex gnus-uu-digest-headers
10834 List of regexps to match headers included in digested messages.  The
10835 headers will be included in the sequence they are matched.  If
10836 @code{nil} include all headers.
10837
10838 @item gnus-add-to-list
10839 @vindex gnus-add-to-list
10840 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
10841 that have none when you do a @kbd{a}.
10842
10843 @item gnus-confirm-mail-reply-to-news
10844 @vindex gnus-confirm-mail-reply-to-news
10845 If non-@code{nil}, Gnus requests confirmation when replying to news.
10846 If you find yourself never wanting to reply to mail, but occasionally
10847 press R anyway, this variable might be for you.
10848
10849 @end table
10850
10851
10852 @node Posting Server
10853 @section Posting Server
10854
10855 When you press those magical @kbd{C-c C-c} keys to ship off your latest
10856 (extremely intelligent, of course) article, where does it go?
10857
10858 Thank you for asking.  I hate you.
10859
10860 It can be quite complicated.
10861
10862 @vindex gnus-post-method
10863 When posting news, Message usually invokes @code{message-send-news}
10864 (@pxref{News Variables, , News Variables, message, Message Manual}).
10865 Normally, Gnus will post using the same select method as you're
10866 reading from (which might be convenient if you're reading lots of
10867 groups from different private servers).  However.  If the server
10868 you're reading from doesn't allow posting, just reading, you probably
10869 want to use some other server to post your (extremely intelligent and
10870 fabulously interesting) articles.  You can then set the
10871 @code{gnus-post-method} to some other method:
10872
10873 @lisp
10874 (setq gnus-post-method '(nnspool ""))
10875 @end lisp
10876
10877 Now, if you've done this, and then this server rejects your article, or
10878 this server is down, what do you do then?  To override this variable you
10879 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
10880 the ``current'' server, to get back the default behavior, for posting.
10881
10882 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
10883 gnus will prompt you for what method to use for posting.
10884
10885 You can also set @code{gnus-post-method} to a list of select methods.
10886 If that's the case, gnus will always prompt you for what method to use
10887 for posting.
10888
10889 Finally, if you want to always post using the native select method,
10890 you can set this variable to @code{native}.
10891
10892 When sending mail, Message invokes @code{message-send-mail-function}.
10893 The default function, @code{message-send-mail-with-sendmail}, pipes
10894 your article to the @code{sendmail} binary for further queuing and
10895 sending.  When your local system is not configured for sending mail
10896 using @code{sendmail}, and you have access to a remote @sc{smtp}
10897 server, you can set @code{message-send-mail-function} to
10898 @code{smtpmail-send-it} and make sure to setup the @code{smtpmail}
10899 package correctly.  An example:
10900
10901 @lisp
10902 (setq message-send-mail-function 'smtpmail-send-it
10903       smtpmail-default-smtp-server "YOUR SMTP HOST")
10904 @end lisp
10905
10906 To the thing similar to this, there is @code{message-smtpmail-send-it}.
10907 It is useful if your ISP requires the POP-before-SMTP authentication.
10908 See the documentation for the function @code{mail-source-touch-pop}.
10909
10910 Other possible choices for @code{message-send-mail-function} includes
10911 @code{message-send-mail-with-mh}, @code{message-send-mail-with-qmail},
10912 and @code{feedmail-send-it}.
10913
10914 @node Mail and Post
10915 @section Mail and Post
10916
10917 Here's a list of variables relevant to both mailing and
10918 posting:
10919
10920 @table @code
10921 @item gnus-mailing-list-groups
10922 @findex gnus-mailing-list-groups
10923 @cindex mailing lists
10924
10925 If your news server offers groups that are really mailing lists
10926 gatewayed to the @sc{nntp} server, you can read those groups without
10927 problems, but you can't post/followup to them without some difficulty.
10928 One solution is to add a @code{to-address} to the group parameters
10929 (@pxref{Group Parameters}).  An easier thing to do is set the
10930 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
10931 really are mailing lists.  Then, at least, followups to the mailing
10932 lists will work most of the time.  Posting to these groups (@kbd{a}) is
10933 still a pain, though.
10934
10935 @end table
10936
10937 You may want to do spell-checking on messages that you send out.  Or, if
10938 you don't want to spell-check by hand, you could add automatic
10939 spell-checking via the @code{ispell} package:
10940
10941 @cindex ispell
10942 @findex ispell-message
10943 @lisp
10944 (add-hook 'message-send-hook 'ispell-message)
10945 @end lisp
10946
10947 If you want to change the @code{ispell} dictionary based on what group
10948 you're in, you could say something like the following:
10949
10950 @lisp
10951 (add-hook 'gnus-select-group-hook
10952           (lambda ()
10953             (cond
10954              ((string-match
10955                "^de\\." (gnus-group-real-name gnus-newsgroup-name))
10956               (ispell-change-dictionary "deutsch"))
10957              (t
10958               (ispell-change-dictionary "english")))))
10959 @end lisp
10960
10961 Modify to suit your needs.
10962
10963
10964 @node Archived Messages
10965 @section Archived Messages
10966 @cindex archived messages
10967 @cindex sent messages
10968
10969 Gnus provides a few different methods for storing the mail and news you
10970 send.  The default method is to use the @dfn{archive virtual server} to
10971 store the messages.  If you want to disable this completely, the
10972 @code{gnus-message-archive-group} variable should be @code{nil}, which
10973 is the default.
10974
10975 For archiving interesting messages in a group you read, see the
10976 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
10977 Group Commands}).
10978
10979 @vindex gnus-message-archive-method
10980 @code{gnus-message-archive-method} says what virtual server gnus is to
10981 use to store sent messages.  The default is:
10982
10983 @lisp
10984 (nnfolder "archive"
10985           (nnfolder-directory   "~/Mail/archive")
10986           (nnfolder-active-file "~/Mail/archive/active")
10987           (nnfolder-get-new-mail nil)
10988           (nnfolder-inhibit-expiry t))
10989 @end lisp
10990
10991 You can, however, use any mail select method (@code{nnml},
10992 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likable select method
10993 for doing this sort of thing, though.  If you don't like the default
10994 directory chosen, you could say something like:
10995
10996 @lisp
10997 (setq gnus-message-archive-method
10998       '(nnfolder "archive"
10999                  (nnfolder-inhibit-expiry t)
11000                  (nnfolder-active-file "~/News/sent-mail/active")
11001                  (nnfolder-directory "~/News/sent-mail/")))
11002 @end lisp
11003
11004 @vindex gnus-message-archive-group
11005 @cindex Gcc
11006 Gnus will insert @code{Gcc} headers in all outgoing messages that point
11007 to one or more group(s) on that server.  Which group to use is
11008 determined by the @code{gnus-message-archive-group} variable.
11009
11010 This variable can be used to do the following:
11011
11012 @itemize @bullet
11013 @item
11014 a string
11015 Messages will be saved in that group.
11016
11017 Note that you can include a select method in the group name, then the
11018 message will not be stored in the select method given by
11019 @code{gnus-message-archive-method}, but in the select method specified
11020 by the group name, instead.  Suppose @code{gnus-message-archive-method}
11021 has the default value shown above.  Then setting
11022 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
11023 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
11024 value @code{"nnml:foo"}, then outgoing messages will be stored in
11025 @samp{nnml:foo}.
11026 @item
11027 a list of strings
11028 Messages will be saved in all those groups.
11029 @item
11030 an alist of regexps, functions and forms
11031 When a key ``matches'', the result is used.
11032 @item
11033 @code{nil}
11034 No message archiving will take place.  This is the default.
11035 @end itemize
11036
11037 Let's illustrate:
11038
11039 Just saving to a single group called @samp{MisK}:
11040 @lisp
11041 (setq gnus-message-archive-group "MisK")
11042 @end lisp
11043
11044 Saving to two groups, @samp{MisK} and @samp{safe}:
11045 @lisp
11046 (setq gnus-message-archive-group '("MisK" "safe"))
11047 @end lisp
11048
11049 Save to different groups based on what group you are in:
11050 @lisp
11051 (setq gnus-message-archive-group
11052       '(("^alt" "sent-to-alt")
11053         ("mail" "sent-to-mail")
11054         (".*" "sent-to-misc")))
11055 @end lisp
11056
11057 More complex stuff:
11058 @lisp
11059 (setq gnus-message-archive-group
11060       '((if (message-news-p)
11061             "misc-news"
11062           "misc-mail")))
11063 @end lisp
11064
11065 How about storing all news messages in one file, but storing all mail
11066 messages in one file per month:
11067
11068 @lisp
11069 (setq gnus-message-archive-group
11070       '((if (message-news-p)
11071             "misc-news"
11072           (concat "mail." (format-time-string "%Y-%m")))))
11073 @end lisp
11074
11075 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
11076 @c use a different value for @code{gnus-message-archive-group} there.)
11077
11078 Now, when you send a message off, it will be stored in the appropriate
11079 group.  (If you want to disable storing for just one particular message,
11080 you can just remove the @code{Gcc} header that has been inserted.)  The
11081 archive group will appear in the group buffer the next time you start
11082 gnus, or the next time you press @kbd{F} in the group buffer.  You can
11083 enter it and read the articles in it just like you'd read any other
11084 group.  If the group gets really big and annoying, you can simply rename
11085 if (using @kbd{G r} in the group buffer) to something
11086 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
11087 continue to be stored in the old (now empty) group.
11088
11089 That's the default method of archiving sent messages.  Gnus offers a
11090 different way for the people who don't like the default method.  In that
11091 case you should set @code{gnus-message-archive-group} to @code{nil};
11092 this will disable archiving.
11093
11094 @table @code
11095 @item gnus-outgoing-message-group
11096 @vindex gnus-outgoing-message-group
11097 All outgoing messages will be put in this group.  If you want to store
11098 all your outgoing mail and articles in the group @samp{nnml:archive},
11099 you set this variable to that value.  This variable can also be a list of
11100 group names.
11101
11102 If you want to have greater control over what group to put each
11103 message in, you can set this variable to a function that checks the
11104 current newsgroup name and then returns a suitable group name (or list
11105 of names).
11106
11107 This variable can be used instead of @code{gnus-message-archive-group},
11108 but the latter is the preferred method.
11109
11110 @item gnus-gcc-mark-as-read
11111 @vindex gnus-gcc-mark-as-read
11112 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
11113
11114 @item gnus-gcc-externalize-attachments
11115 @vindex gnus-gcc-externalize-attachments
11116 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
11117 and matches the Gcc group name, attach files as external parts; if it is
11118 @code{all}, attach local files as external parts; if it is other
11119 non-@code{nil}, the behavior is the same as @code{all}, but it may be
11120 changed in the future.
11121
11122 @end table
11123
11124
11125 @node Posting Styles
11126 @section Posting Styles
11127 @cindex posting styles
11128 @cindex styles
11129
11130 All them variables, they make my head swim.
11131
11132 So what if you want a different @code{Organization} and signature based
11133 on what groups you post to?  And you post both from your home machine
11134 and your work machine, and you want different @code{From} lines, and so
11135 on?
11136
11137 @vindex gnus-posting-styles
11138 One way to do stuff like that is to write clever hooks that change the
11139 variables you need to have changed.  That's a bit boring, so somebody
11140 came up with the bright idea of letting the user specify these things in
11141 a handy alist.  Here's an example of a @code{gnus-posting-styles}
11142 variable:
11143
11144 @lisp
11145 ((".*"
11146   (signature "Peace and happiness")
11147   (organization "What me?"))
11148  ("^comp"
11149   (signature "Death to everybody"))
11150  ("comp.emacs.i-love-it"
11151   (organization "Emacs is it")))
11152 @end lisp
11153
11154 As you might surmise from this example, this alist consists of several
11155 @dfn{styles}.  Each style will be applicable if the first element
11156 ``matches'', in some form or other.  The entire alist will be iterated
11157 over, from the beginning towards the end, and each match will be
11158 applied, which means that attributes in later styles that match override
11159 the same attributes in earlier matching styles.  So
11160 @samp{comp.programming.literate} will have the @samp{Death to everybody}
11161 signature and the @samp{What me?} @code{Organization} header.
11162
11163 The first element in each style is called the @code{match}.  If it's a
11164 string, then Gnus will try to regexp match it against the group name.
11165 If it is the form @code{(header MATCH REGEXP)}, then Gnus will look in
11166 the original article for a header whose name is MATCH and compare that
11167 REGEXP.  MATCH and REGEXP are strings.  (There original article is the
11168 one you are replying or following up to.  If you are not composing a
11169 reply or a followup, then there is nothing to match against.)  If the
11170 @code{match} is a function symbol, that function will be called with no
11171 arguments.  If it's a variable symbol, then the variable will be
11172 referenced.  If it's a list, then that list will be @code{eval}ed.  In
11173 any case, if this returns a non-@code{nil} value, then the style is said
11174 to @dfn{match}.
11175
11176 Each style may contain an arbitrary amount of @dfn{attributes}.  Each
11177 attribute consists of a @code{(@var{name} @var{value})} pair.  The
11178 attribute name can be one of @code{signature}, @code{signature-file},
11179 @code{x-face-file}, @code{address} (overriding
11180 @code{user-mail-address}), @code{name} (overriding
11181 @code{(user-full-name)}) or @code{body}.  The attribute name can also
11182 be a string or a symbol.  In that case, this will be used as a header
11183 name, and the value will be inserted in the headers of the article; if
11184 the value is @code{nil}, the header name will be removed.  If the
11185 attribute name is @code{eval}, the form is evaluated, and the result
11186 is thrown away.
11187
11188 The attribute value can be a string (used verbatim), a function with
11189 zero arguments (the return value will be used), a variable (its value
11190 will be used) or a list (it will be @code{eval}ed and the return value
11191 will be used).  The functions and sexps are called/@code{eval}ed in the
11192 message buffer that is being set up.  The headers of the current article
11193 are available through the @code{message-reply-headers} variable, which
11194 is a vector of the following headers: number subject from date id
11195 references chars lines xref extra.
11196
11197 @vindex message-reply-headers
11198
11199 If you wish to check whether the message you are about to compose is
11200 meant to be a news article or a mail message, you can check the values
11201 of the @code{message-news-p} and @code{message-mail-p} functions.
11202
11203 @findex message-mail-p
11204 @findex message-news-p
11205
11206 So here's a new example:
11207
11208 @lisp
11209 (setq gnus-posting-styles
11210       '((".*"
11211          (signature-file "~/.signature")
11212          (name "User Name")
11213          ("X-Home-Page" (getenv "WWW_HOME"))
11214          (organization "People's Front Against MWM"))
11215         ("^rec.humor"
11216          (signature my-funny-signature-randomizer))
11217         ((equal (system-name) "gnarly")  ;; A form
11218          (signature my-quote-randomizer))
11219         (message-news-p        ;; A function symbol
11220          (signature my-news-signature))
11221         (window-system         ;; A value symbol
11222          ("X-Window-System" (format "%s" window-system)))
11223         ;; If I'm replying to Larsi, set the Organization header.
11224         ((header "from" "larsi.*org")
11225          (Organization "Somewhere, Inc."))
11226         ((posting-from-work-p) ;; A user defined function
11227          (signature-file "~/.work-signature")
11228          (address "user@@bar.foo")
11229          (body "You are fired.\n\nSincerely, your boss.")
11230          (organization "Important Work, Inc"))
11231         ("nnml:.*"
11232          (From (save-excursion
11233                  (set-buffer gnus-article-buffer)
11234                  (message-fetch-field "to"))))
11235         ("^nn.+:"
11236          (signature-file "~/.mail-signature"))))
11237 @end lisp
11238
11239 The @samp{nnml:.*} rule means that you use the @code{To} address as the
11240 @code{From} address in all your outgoing replies, which might be handy
11241 if you fill many roles.
11242
11243 Setting the @code{gnus-named-posting-styles} variable will make
11244 posting-styles allow to have distinctive names.  You can specify an
11245 arbitrary posting-style when article posting with @kbd{S P} in the
11246 summary buffer.  @code{gnus-named-posting-styles} is an alist which maps
11247 the names to styles.  Once a posting-style is added to the alist, we can
11248 import it from @code{gnus-posting-styles}.  If an attribute whose name
11249 is @code{import} is found, Gnus will look for the attribute value in
11250 @code{gnus-named-posting-styles} and expand it in place.
11251
11252 Here's an example:
11253
11254 @lisp
11255 (setq gnus-named-posting-styles
11256       '(("Default"
11257          (signature-file "~/.signature")
11258          (name "User Name")
11259          ("X-Home-Page" (getenv "WWW_HOME"))
11260          (organization "People's Front Against MWM"))
11261         ("Emacs"
11262          (import "Default")
11263          (organization "The Church of Emacs"))))
11264 @end lisp
11265
11266 The posting-style named "Emacs" will inherit all the attributes from
11267 "Default" except @code{organization}.
11268
11269
11270 @node Drafts
11271 @section Drafts
11272 @cindex drafts
11273
11274 If you are writing a message (mail or news) and suddenly remember that
11275 you have a steak in the oven (or some pesto in the food processor, you
11276 craaazy vegetarians), you'll probably wish there was a method to save
11277 the message you are writing so that you can continue editing it some
11278 other day, and send it when you feel its finished.
11279
11280 Well, don't worry about it.  Whenever you start composing a message of
11281 some sort using the gnus mail and post commands, the buffer you get will
11282 automatically associate to an article in a special @dfn{draft} group.
11283 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
11284 article will be saved there.  (Auto-save files also go to the draft
11285 group.)
11286
11287 @cindex nndraft
11288 @vindex nndraft-directory
11289 The draft group is a special group (which is implemented as an
11290 @code{nndraft} group, if you absolutely have to know) called
11291 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
11292 @code{nndraft} is to store its files.  What makes this group special is
11293 that you can't tick any articles in it or mark any articles as
11294 read---all articles in the group are permanently unread.
11295
11296 If the group doesn't exist, it will be created and you'll be subscribed
11297 to it.  The only way to make it disappear from the Group buffer is to
11298 unsubscribe it.
11299
11300 @c @findex gnus-dissociate-buffer-from-draft
11301 @c @kindex C-c M-d (Mail)
11302 @c @kindex C-c M-d (Post)
11303 @c @findex gnus-associate-buffer-with-draft
11304 @c @kindex C-c C-d (Mail)
11305 @c @kindex C-c C-d (Post)
11306 @c If you're writing some super-secret message that you later want to
11307 @c encode with PGP before sending, you may wish to turn the auto-saving
11308 @c (and association with the draft group) off.  You never know who might be
11309 @c interested in reading all your extremely valuable and terribly horrible
11310 @c and interesting secrets.  The @kbd{C-c M-d}
11311 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
11312 @c If you change your mind and want to turn the auto-saving back on again,
11313 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
11314 @c
11315 @c @vindex gnus-use-draft
11316 @c To leave association with the draft group off by default, set
11317 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
11318
11319 @findex gnus-draft-edit-message
11320 @kindex D e (Draft)
11321 When you want to continue editing the article, you simply enter the
11322 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
11323 that.  You will be placed in a buffer where you left off.
11324
11325 Rejected articles will also be put in this draft group (@pxref{Rejected
11326 Articles}).
11327
11328 @findex gnus-draft-send-all-messages
11329 @findex gnus-draft-send-message
11330 If you have lots of rejected messages you want to post (or mail) without
11331 doing further editing, you can use the @kbd{D s} command
11332 (@code{gnus-draft-send-message}).  This command understands the
11333 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
11334 command (@code{gnus-draft-send-all-messages}) will ship off all messages
11335 in the buffer.
11336
11337 If you have some messages that you wish not to send, you can use the
11338 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
11339 as unsendable.  This is a toggling command.
11340
11341
11342 @node Rejected Articles
11343 @section Rejected Articles
11344 @cindex rejected articles
11345
11346 Sometimes a news server will reject an article.  Perhaps the server
11347 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
11348 @emph{there be demons}.  Perhaps you have included too much cited text.
11349 Perhaps the disk is full.  Perhaps the server is down.
11350
11351 These situations are, of course, totally beyond the control of gnus.
11352 (Gnus, of course, loves the way you look, always feels great, has angels
11353 fluttering around inside of it, doesn't care about how much cited text
11354 you include, never runs full and never goes down.)  So gnus saves these
11355 articles until some later time when the server feels better.
11356
11357 The rejected articles will automatically be put in a special draft group
11358 (@pxref{Drafts}).  When the server comes back up again, you'd then
11359 typically enter that group and send all the articles off.
11360
11361 @node Signing and encrypting
11362 @section Signing and encrypting
11363 @cindex using gpg
11364 @cindex using s/mime
11365 @cindex using smime
11366
11367 Gnus can digitally sign and encrypt your messages, using vanilla PGP
11368 format or @sc{pgp/mime} or @sc{s/mime}.  For decoding such messages,
11369 see the @code{mm-verify-option} and @code{mm-decrypt-option} options
11370 (@pxref{Security}).
11371
11372 For PGP, Gnus supports two external libraries, @sc{gpg.el} and
11373 @sc{Mailcrypt}, you need to install at least one of them.  The
11374 @sc{s/mime} support in Gnus requires the external program OpenSSL.
11375
11376 Often, you would like to sign replies to people who send you signed
11377 messages.  Even more often, you might want to encrypt messages which
11378 are in reply to encrypted messages.  Gnus offers
11379 @code{gnus-message-replysign} to enable the former, and
11380 @code{gnus-message-replyencrypt} for the latter.  In addition, setting
11381 @code{gnus-message-replysignencrypted} (on by default) will sign
11382 automatically encrypted messages.
11383
11384 Instructing MML to perform security operations on a @sc{mime} part is
11385 done using the @kbd{C-c C-m s} key map for signing and the @kbd{C-c
11386 C-m c} key map for encryption, as follows.
11387
11388 @table @kbd
11389
11390 @item C-c C-m s s
11391 @kindex C-c C-m s s
11392 @findex mml-secure-message-sign-smime
11393
11394 Digitally sign current message using @sc{s/mime}.
11395
11396 @item C-c C-m s o
11397 @kindex C-c C-m s o
11398 @findex mml-secure-message-sign-pgp
11399
11400 Digitally sign current message using PGP.
11401
11402 @item C-c C-m s p
11403 @kindex C-c C-m s p
11404 @findex mml-secure-message-sign-pgp
11405
11406 Digitally sign current message using @sc{pgp/mime}.
11407
11408 @item C-c C-m c s
11409 @kindex C-c C-m c s
11410 @findex mml-secure-message-encrypt-smime
11411
11412 Digitally encrypt current message using @sc{s/mime}.
11413
11414 @item C-c C-m c o
11415 @kindex C-c C-m c o
11416 @findex mml-secure-message-encrypt-pgp
11417
11418 Digitally encrypt current message using PGP.
11419
11420 @item C-c C-m c p
11421 @kindex C-c C-m c p
11422 @findex mml-secure-message-encrypt-pgpmime
11423
11424 Digitally encrypt current message using @sc{pgp/mime}.
11425
11426 @item C-c C-m C-n
11427 @kindex C-c C-m C-n
11428 @findex mml-unsecure-message
11429 Remove security related MML tags from message.
11430
11431 @end table
11432
11433 Also @xref{Security, ,Security, message, Message Manual}.
11434
11435 @node Select Methods
11436 @chapter Select Methods
11437 @cindex foreign groups
11438 @cindex select methods
11439
11440 A @dfn{foreign group} is a group not read by the usual (or
11441 default) means.  It could be, for instance, a group from a different
11442 @sc{nntp} server, it could be a virtual group, or it could be your own
11443 personal mail group.
11444
11445 A foreign group (or any group, really) is specified by a @dfn{name} and
11446 a @dfn{select method}.  To take the latter first, a select method is a
11447 list where the first element says what back end to use (e.g. @code{nntp},
11448 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
11449 name}.  There may be additional elements in the select method, where the
11450 value may have special meaning for the back end in question.
11451
11452 One could say that a select method defines a @dfn{virtual server}---so
11453 we do just that (@pxref{Server Buffer}).
11454
11455 The @dfn{name} of the group is the name the back end will recognize the
11456 group as.
11457
11458 For instance, the group @samp{soc.motss} on the @sc{nntp} server
11459 @samp{some.where.edu} will have the name @samp{soc.motss} and select
11460 method @code{(nntp "some.where.edu")}.  Gnus will call this group
11461 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
11462 back end just knows this group as @samp{soc.motss}.
11463
11464 The different methods all have their peculiarities, of course.
11465
11466 @menu
11467 * Server Buffer::               Making and editing virtual servers.
11468 * Getting News::                Reading USENET news with Gnus.
11469 * Getting Mail::                Reading your personal mail with Gnus.
11470 * Browsing the Web::            Getting messages from a plethora of Web sources.
11471 * IMAP::                        Using Gnus as a @sc{imap} client.
11472 * Other Sources::               Reading directories, files, SOUP packets.
11473 * Combined Groups::             Combining groups into one group.
11474 * Gnus Unplugged::              Reading news and mail offline.
11475 @end menu
11476
11477
11478 @node Server Buffer
11479 @section Server Buffer
11480
11481 Traditionally, a @dfn{server} is a machine or a piece of software that
11482 one connects to, and then requests information from.  Gnus does not
11483 connect directly to any real servers, but does all transactions through
11484 one back end or other.  But that's just putting one layer more between
11485 the actual media and Gnus, so we might just as well say that each
11486 back end represents a virtual server.
11487
11488 For instance, the @code{nntp} back end may be used to connect to several
11489 different actual @sc{nntp} servers, or, perhaps, to many different ports
11490 on the same actual @sc{nntp} server.  You tell Gnus which back end to
11491 use, and what parameters to set by specifying a @dfn{select method}.
11492
11493 These select method specifications can sometimes become quite
11494 complicated---say, for instance, that you want to read from the
11495 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
11496 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
11497 Anyway, if you had to specify that for each group that used this
11498 server, that would be too much work, so Gnus offers a way of naming
11499 select methods, which is what you do in the server buffer.
11500
11501 To enter the server buffer, use the @kbd{^}
11502 (@code{gnus-group-enter-server-mode}) command in the group buffer.
11503
11504 @menu
11505 * Server Buffer Format::        You can customize the look of this buffer.
11506 * Server Commands::             Commands to manipulate servers.
11507 * Example Methods::             Examples server specifications.
11508 * Creating a Virtual Server::   An example session.
11509 * Server Variables::            Which variables to set.
11510 * Servers and Methods::         You can use server names as select methods.
11511 * Unavailable Servers::         Some servers you try to contact may be down.
11512 @end menu
11513
11514 @vindex gnus-server-mode-hook
11515 @code{gnus-server-mode-hook} is run when creating the server buffer.
11516
11517
11518 @node Server Buffer Format
11519 @subsection Server Buffer Format
11520 @cindex server buffer format
11521
11522 @vindex gnus-server-line-format
11523 You can change the look of the server buffer lines by changing the
11524 @code{gnus-server-line-format} variable.  This is a @code{format}-like
11525 variable, with some simple extensions:
11526
11527 @table @samp
11528
11529 @item h
11530 How the news is fetched---the back end name.
11531
11532 @item n
11533 The name of this server.
11534
11535 @item w
11536 Where the news is to be fetched from---the address.
11537
11538 @item s
11539 The opened/closed/denied status of the server.
11540 @end table
11541
11542 @vindex gnus-server-mode-line-format
11543 The mode line can also be customized by using the
11544 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
11545 Formatting}).  The following specs are understood:
11546
11547 @table @samp
11548 @item S
11549 Server name.
11550
11551 @item M
11552 Server method.
11553 @end table
11554
11555 Also @pxref{Formatting Variables}.
11556
11557
11558 @node Server Commands
11559 @subsection Server Commands
11560 @cindex server commands
11561
11562 @table @kbd
11563
11564 @item a
11565 @kindex a (Server)
11566 @findex gnus-server-add-server
11567 Add a new server (@code{gnus-server-add-server}).
11568
11569 @item e
11570 @kindex e (Server)
11571 @findex gnus-server-edit-server
11572 Edit a server (@code{gnus-server-edit-server}).
11573
11574 @item SPACE
11575 @kindex SPACE (Server)
11576 @findex gnus-server-read-server
11577 Browse the current server (@code{gnus-server-read-server}).
11578
11579 @item q
11580 @kindex q (Server)
11581 @findex gnus-server-exit
11582 Return to the group buffer (@code{gnus-server-exit}).
11583
11584 @item k
11585 @kindex k (Server)
11586 @findex gnus-server-kill-server
11587 Kill the current server (@code{gnus-server-kill-server}).
11588
11589 @item y
11590 @kindex y (Server)
11591 @findex gnus-server-yank-server
11592 Yank the previously killed server (@code{gnus-server-yank-server}).
11593
11594 @item c
11595 @kindex c (Server)
11596 @findex gnus-server-copy-server
11597 Copy the current server (@code{gnus-server-copy-server}).
11598
11599 @item l
11600 @kindex l (Server)
11601 @findex gnus-server-list-servers
11602 List all servers (@code{gnus-server-list-servers}).
11603
11604 @item s
11605 @kindex s (Server)
11606 @findex gnus-server-scan-server
11607 Request that the server scan its sources for new articles
11608 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
11609 servers.
11610
11611 @item g
11612 @kindex g (Server)
11613 @findex gnus-server-regenerate-server
11614 Request that the server regenerate all its data structures
11615 (@code{gnus-server-regenerate-server}).  This can be useful if you have
11616 a mail back end that has gotten out of sync.
11617
11618 @end table
11619
11620
11621 @node Example Methods
11622 @subsection Example Methods
11623
11624 Most select methods are pretty simple and self-explanatory:
11625
11626 @lisp
11627 (nntp "news.funet.fi")
11628 @end lisp
11629
11630 Reading directly from the spool is even simpler:
11631
11632 @lisp
11633 (nnspool "")
11634 @end lisp
11635
11636 As you can see, the first element in a select method is the name of the
11637 back end, and the second is the @dfn{address}, or @dfn{name}, if you
11638 will.
11639
11640 After these two elements, there may be an arbitrary number of
11641 @code{(@var{variable} @var{form})} pairs.
11642
11643 To go back to the first example---imagine that you want to read from
11644 port 15 on that machine.  This is what the select method should
11645 look like then:
11646
11647 @lisp
11648 (nntp "news.funet.fi" (nntp-port-number 15))
11649 @end lisp
11650
11651 You should read the documentation to each back end to find out what
11652 variables are relevant, but here's an @code{nnmh} example:
11653
11654 @code{nnmh} is a mail back end that reads a spool-like structure.  Say
11655 you have two structures that you wish to access: One is your private
11656 mail spool, and the other is a public one.  Here's the possible spec for
11657 your private mail:
11658
11659 @lisp
11660 (nnmh "private" (nnmh-directory "~/private/mail/"))
11661 @end lisp
11662
11663 (This server is then called @samp{private}, but you may have guessed
11664 that.)
11665
11666 Here's the method for a public spool:
11667
11668 @lisp
11669 (nnmh "public"
11670       (nnmh-directory "/usr/information/spool/")
11671       (nnmh-get-new-mail nil))
11672 @end lisp
11673
11674 @cindex proxy
11675 @cindex firewall
11676
11677 If you are behind a firewall and only have access to the @sc{nntp}
11678 server from the firewall machine, you can instruct Gnus to @code{rlogin}
11679 on the firewall machine and telnet from there to the @sc{nntp} server.
11680 Doing this can be rather fiddly, but your virtual server definition
11681 should probably look something like this:
11682
11683 @lisp
11684 (nntp "firewall"
11685       (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
11686       (nntp-via-address "the.firewall.machine")
11687       (nntp-address "the.real.nntp.host")
11688       (nntp-end-of-line "\n"))
11689 @end lisp
11690
11691 If you want to use the wonderful @code{ssh} program to provide a
11692 compressed connection over the modem line, you could add the following
11693 configuration to the example above:
11694
11695 @lisp
11696       (nntp-via-rlogin-command "ssh")
11697 @end lisp
11698
11699 See also @code{nntp-via-rlogin-command-switches}.
11700
11701 If you're behind a firewall, but have direct access to the outside world
11702 through a wrapper command like "runsocks", you could open a socksified
11703 telnet connection to the news server as follows:
11704
11705 @lisp
11706 (nntp "outside"
11707       (nntp-pre-command "runsocks")
11708       (nntp-open-connection-function nntp-open-via-telnet)
11709       (nntp-address "the.news.server")
11710       (nntp-end-of-line "\n"))
11711 @end lisp
11712
11713 This means that you have to have set up @code{ssh-agent} correctly to
11714 provide automatic authorization, of course.  And to get a compressed
11715 connection, you have to have the @samp{Compression} option in the
11716 @code{ssh} @file{config} file.
11717
11718
11719 @node Creating a Virtual Server
11720 @subsection Creating a Virtual Server
11721
11722 If you're saving lots of articles in the cache by using persistent
11723 articles, you may want to create a virtual server to read the cache.
11724
11725 First you need to add a new server.  The @kbd{a} command does that.  It
11726 would probably be best to use @code{nnspool} to read the cache.  You
11727 could also use @code{nnml} or @code{nnmh}, though.
11728
11729 Type @kbd{a nnspool RET cache RET}.
11730
11731 You should now have a brand new @code{nnspool} virtual server called
11732 @samp{cache}.  You now need to edit it to have the right definitions.
11733 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
11734 will contain the following:
11735
11736 @lisp
11737 (nnspool "cache")
11738 @end lisp
11739
11740 Change that to:
11741
11742 @lisp
11743 (nnspool "cache"
11744          (nnspool-spool-directory "~/News/cache/")
11745          (nnspool-nov-directory "~/News/cache/")
11746          (nnspool-active-file "~/News/cache/active"))
11747 @end lisp
11748
11749 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
11750 @kbd{RET} over this virtual server, you should be entered into a browse
11751 buffer, and you should be able to enter any of the groups displayed.
11752
11753
11754 @node Server Variables
11755 @subsection Server Variables
11756
11757 One sticky point when defining variables (both on back ends and in Emacs
11758 in general) is that some variables are typically initialized from other
11759 variables when the definition of the variables is being loaded.  If you
11760 change the "base" variable after the variables have been loaded, you
11761 won't change the "derived" variables.
11762
11763 This typically affects directory and file variables.  For instance,
11764 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
11765 directory variables are initialized from that variable, so
11766 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
11767 new virtual @code{nnml} server, it will @emph{not} suffice to set just
11768 @code{nnml-directory}---you have to explicitly set all the file
11769 variables to be what you want them to be.  For a complete list of
11770 variables for each back end, see each back end's section later in this
11771 manual, but here's an example @code{nnml} definition:
11772
11773 @lisp
11774 (nnml "public"
11775       (nnml-directory "~/my-mail/")
11776       (nnml-active-file "~/my-mail/active")
11777       (nnml-newsgroups-file "~/my-mail/newsgroups"))
11778 @end lisp
11779
11780
11781 @node Servers and Methods
11782 @subsection Servers and Methods
11783
11784 Wherever you would normally use a select method
11785 (e.g. @code{gnus-secondary-select-method}, in the group select method,
11786 when browsing a foreign server) you can use a virtual server name
11787 instead.  This could potentially save lots of typing.  And it's nice all
11788 over.
11789
11790
11791 @node Unavailable Servers
11792 @subsection Unavailable Servers
11793
11794 If a server seems to be unreachable, Gnus will mark that server as
11795 @code{denied}.  That means that any subsequent attempt to make contact
11796 with that server will just be ignored.  ``It can't be opened,'' Gnus
11797 will tell you, without making the least effort to see whether that is
11798 actually the case or not.
11799
11800 That might seem quite naughty, but it does make sense most of the time.
11801 Let's say you have 10 groups subscribed to on server
11802 @samp{nephelococcygia.com}.  This server is located somewhere quite far
11803 away from you and the machine is quite slow, so it takes 1 minute just
11804 to find out that it refuses connection to you today.  If Gnus were to
11805 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
11806 attempt to do that.  Once it has gotten a single ``connection refused'',
11807 it will regard that server as ``down''.
11808
11809 So, what happens if the machine was only feeling unwell temporarily?
11810 How do you test to see whether the machine has come up again?
11811
11812 You jump to the server buffer (@pxref{Server Buffer}) and poke it
11813 with the following commands:
11814
11815 @table @kbd
11816
11817 @item O
11818 @kindex O (Server)
11819 @findex gnus-server-open-server
11820 Try to establish connection to the server on the current line
11821 (@code{gnus-server-open-server}).
11822
11823 @item C
11824 @kindex C (Server)
11825 @findex gnus-server-close-server
11826 Close the connection (if any) to the server
11827 (@code{gnus-server-close-server}).
11828
11829 @item D
11830 @kindex D (Server)
11831 @findex gnus-server-deny-server
11832 Mark the current server as unreachable
11833 (@code{gnus-server-deny-server}).
11834
11835 @item M-o
11836 @kindex M-o (Server)
11837 @findex gnus-server-open-all-servers
11838 Open the connections to all servers in the buffer
11839 (@code{gnus-server-open-all-servers}).
11840
11841 @item M-c
11842 @kindex M-c (Server)
11843 @findex gnus-server-close-all-servers
11844 Close the connections to all servers in the buffer
11845 (@code{gnus-server-close-all-servers}).
11846
11847 @item R
11848 @kindex R (Server)
11849 @findex gnus-server-remove-denials
11850 Remove all marks to whether Gnus was denied connection from any servers
11851 (@code{gnus-server-remove-denials}).
11852
11853 @item L
11854 @kindex L (Server)
11855 @findex gnus-server-offline-server
11856 Set server status to offline (@code{gnus-server-offline-server}).
11857
11858 @end table
11859
11860
11861 @node Getting News
11862 @section Getting News
11863 @cindex reading news
11864 @cindex news back ends
11865
11866 A newsreader is normally used for reading news.  Gnus currently provides
11867 only two methods of getting news---it can read from an @sc{nntp} server,
11868 or it can read from a local spool.
11869
11870 @menu
11871 * NNTP::                        Reading news from an @sc{nntp} server.
11872 * News Spool::                  Reading news from the local spool.
11873 @end menu
11874
11875
11876 @node NNTP
11877 @subsection NNTP
11878 @cindex nntp
11879
11880 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
11881 You just specify @code{nntp} as method and the address of the @sc{nntp}
11882 server as the, uhm, address.
11883
11884 If the @sc{nntp} server is located at a non-standard port, setting the
11885 third element of the select method to this port number should allow you
11886 to connect to the right port.  You'll have to edit the group info for
11887 that (@pxref{Foreign Groups}).
11888
11889 The name of the foreign group can be the same as a native group.  In
11890 fact, you can subscribe to the same group from as many different servers
11891 you feel like.  There will be no name collisions.
11892
11893 The following variables can be used to create a virtual @code{nntp}
11894 server:
11895
11896 @table @code
11897
11898 @item nntp-server-opened-hook
11899 @vindex nntp-server-opened-hook
11900 @cindex @sc{mode reader}
11901 @cindex authinfo
11902 @cindex authentification
11903 @cindex nntp authentification
11904 @findex nntp-send-authinfo
11905 @findex nntp-send-mode-reader
11906 is run after a connection has been made.  It can be used to send
11907 commands to the @sc{nntp} server after it has been contacted.  By
11908 default it sends the command @code{MODE READER} to the server with the
11909 @code{nntp-send-mode-reader} function.  This function should always be
11910 present in this hook.
11911
11912 @item nntp-authinfo-function
11913 @vindex nntp-authinfo-function
11914 @findex nntp-send-authinfo
11915 @vindex nntp-authinfo-file
11916 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
11917 server.  The default function is @code{nntp-send-authinfo}, which looks
11918 through your @file{~/.authinfo} (or whatever you've set the
11919 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
11920 are found, it will prompt you for a login name and a password.  The
11921 format of the @file{~/.authinfo} file is (almost) the same as the
11922 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
11923 manual page, but here are the salient facts:
11924
11925 @enumerate
11926 @item
11927 The file contains one or more line, each of which define one server.
11928
11929 @item
11930 Each line may contain an arbitrary number of token/value pairs.
11931
11932 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
11933 @samp{default}.  In addition Gnus introduces two new tokens, not present
11934 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
11935 @samp{force}.  (This is the only way the @file{.authinfo} file format
11936 deviates from the @file{.netrc} file format.)  @samp{port} is used to
11937 indicate what port on the server the credentials apply to and
11938 @samp{force} is explained below.
11939
11940 @end enumerate
11941
11942 Here's an example file:
11943
11944 @example
11945 machine news.uio.no login larsi password geheimnis
11946 machine nntp.ifi.uio.no login larsi force yes
11947 @end example
11948
11949 The token/value pairs may appear in any order; @samp{machine} doesn't
11950 have to be first, for instance.
11951
11952 In this example, both login name and password have been supplied for the
11953 former server, while the latter has only the login name listed, and the
11954 user will be prompted for the password.  The latter also has the
11955 @samp{force} tag, which means that the authinfo will be sent to the
11956 @var{nntp} server upon connection; the default (i.e., when there is not
11957 @samp{force} tag) is to not send authinfo to the @var{nntp} server
11958 until the @var{nntp} server asks for it.
11959
11960 You can also add @samp{default} lines that will apply to all servers
11961 that don't have matching @samp{machine} lines.
11962
11963 @example
11964 default force yes
11965 @end example
11966
11967 This will force sending @samp{AUTHINFO} commands to all servers not
11968 previously mentioned.
11969
11970 Remember to not leave the @file{~/.authinfo} file world-readable.
11971
11972 @item nntp-server-action-alist
11973 @vindex nntp-server-action-alist
11974 This is a list of regexps to match on server types and actions to be
11975 taken when matches are made.  For instance, if you want Gnus to beep
11976 every time you connect to innd, you could say something like:
11977
11978 @lisp
11979 (setq nntp-server-action-alist
11980       '(("innd" (ding))))
11981 @end lisp
11982
11983 You probably don't want to do that, though.
11984
11985 The default value is
11986
11987 @lisp
11988 '(("nntpd 1\\.5\\.11t"
11989    (remove-hook 'nntp-server-opened-hook
11990                 'nntp-send-mode-reader)))
11991 @end lisp
11992
11993 This ensures that Gnus doesn't send the @code{MODE READER} command to
11994 nntpd 1.5.11t, since that command chokes that server, I've been told.
11995
11996 @item nntp-maximum-request
11997 @vindex nntp-maximum-request
11998 If the @sc{nntp} server doesn't support @sc{nov} headers, this back end
11999 will collect headers by sending a series of @code{head} commands.  To
12000 speed things up, the back end sends lots of these commands without
12001 waiting for reply, and then reads all the replies.  This is controlled
12002 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
12003 your network is buggy, you should set this to 1.
12004
12005 @item nntp-connection-timeout
12006 @vindex nntp-connection-timeout
12007 If you have lots of foreign @code{nntp} groups that you connect to
12008 regularly, you're sure to have problems with @sc{nntp} servers not
12009 responding properly, or being too loaded to reply within reasonable
12010 time.  This is can lead to awkward problems, which can be helped
12011 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
12012 that says how many seconds the @code{nntp} back end should wait for a
12013 connection before giving up.  If it is @code{nil}, which is the default,
12014 no timeouts are done.
12015
12016 @c @item nntp-command-timeout
12017 @c @vindex nntp-command-timeout
12018 @c @cindex PPP connections
12019 @c @cindex dynamic IP addresses
12020 @c If you're running Gnus on a machine that has a dynamically assigned
12021 @c address, Gnus may become confused.  If the address of your machine
12022 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
12023 @c waiting forever for replies from the server.  To help with this
12024 @c unfortunate problem, you can set this command to a number.  Gnus will
12025 @c then, if it sits waiting for a reply from the server longer than that
12026 @c number of seconds, shut down the connection, start a new one, and resend
12027 @c the command.  This should hopefully be transparent to the user.  A
12028 @c likely number is 30 seconds.
12029 @c
12030 @c @item nntp-retry-on-break
12031 @c @vindex nntp-retry-on-break
12032 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
12033 @c hangs.  This will have much the same effect as the command timeout
12034 @c described above.
12035
12036 @item nntp-server-hook
12037 @vindex nntp-server-hook
12038 This hook is run as the last step when connecting to an @sc{nntp}
12039 server.
12040
12041 @item nntp-buggy-select
12042 @vindex nntp-buggy-select
12043 Set this to non-@code{nil} if your select routine is buggy.
12044
12045 @item nntp-nov-is-evil
12046 @vindex nntp-nov-is-evil
12047 If the @sc{nntp} server does not support @sc{nov}, you could set this
12048 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
12049 can be used.
12050
12051 @item nntp-xover-commands
12052 @vindex nntp-xover-commands
12053 @cindex nov
12054 @cindex XOVER
12055 List of strings used as commands to fetch @sc{nov} lines from a
12056 server.  The default value of this variable is @code{("XOVER"
12057 "XOVERVIEW")}.
12058
12059 @item nntp-nov-gap
12060 @vindex nntp-nov-gap
12061 @code{nntp} normally sends just one big request for @sc{nov} lines to
12062 the server.  The server responds with one huge list of lines.  However,
12063 if you have read articles 2-5000 in the group, and only want to read
12064 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
12065 lines that you will not need.  This variable says how
12066 big a gap between two consecutive articles is allowed to be before the
12067 @code{XOVER} request is split into several request.  Note that if your
12068 network is fast, setting this variable to a really small number means
12069 that fetching will probably be slower.  If this variable is @code{nil},
12070 @code{nntp} will never split requests.  The default is 5.
12071
12072 @item nntp-prepare-server-hook
12073 @vindex nntp-prepare-server-hook
12074 A hook run before attempting to connect to an @sc{nntp} server.
12075
12076 @item nntp-warn-about-losing-connection
12077 @vindex nntp-warn-about-losing-connection
12078 If this variable is non-@code{nil}, some noise will be made when a
12079 server closes connection.
12080
12081 @item nntp-record-commands
12082 @vindex nntp-record-commands
12083 If non-@code{nil}, @code{nntp} will log all commands it sends to the
12084 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
12085 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
12086 that doesn't seem to work.
12087
12088 @item nntp-open-connection-function
12089 @vindex nntp-open-connection-function
12090 It is possible to customize how the connection to the nntp server will
12091 be opened.  If you specify an @code{nntp-open-connection-function}
12092 parameter, Gnus will use that function to establish the connection.
12093 Five pre-made functions are supplied.  These functions can be grouped in
12094 two categories: direct connection functions (three pre-made), and
12095 indirect ones (two pre-made).
12096
12097 @item nntp-prepare-post-hook
12098 @vindex nntp-prepare-post-hook
12099 A hook run just before posting an article.  If there is no
12100 @code{Message-ID} header in the article and the news server provides the
12101 recommended ID, it will be added to the article before running this
12102 hook.  It is useful to make @code{Cancel-Lock} headers even if you
12103 inhibit Gnus to add a @code{Message-ID} header, you could say:
12104
12105 @lisp
12106 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
12107 @end lisp
12108
12109 Note that not all servers support the recommended ID.  This works for
12110 INN versions 2.3.0 and later, for instance.
12111
12112 @item nntp-list-options
12113 @vindex nntp-list-options
12114 List of newsgroup name used for a option of the LIST command to restrict
12115 the listing output to only the specified newsgroups.  Each newsgroup name
12116 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
12117 etc.  Fortunately, if the server can accept such a option, it will
12118 probably make gnus run faster.  You may use it as a server variable as
12119 follows:
12120
12121 @lisp
12122 (setq gnus-select-method
12123       '(nntp "news.somewhere.edu"
12124              (nntp-list-options ("fj.*" "japan.*"))))
12125 @end lisp
12126
12127 @item nntp-options-subscribe
12128 @vindex nntp-options-subscribe
12129 Regexp matching the newsgroup names which will be subscribed
12130 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
12131 It may be effective as well as @code{nntp-list-options} even though the
12132 server could not accept a shell-style wildcard as a option of the LIST
12133 command.  You may use it as a server variable as follows:
12134
12135 @lisp
12136 (setq gnus-select-method
12137       '(nntp "news.somewhere.edu"
12138              (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
12139 @end lisp
12140
12141 @item nntp-options-not-subscribe
12142 @vindex nntp-options-not-subscribe
12143 Regexp matching the newsgroup names which will not be subscribed
12144 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
12145 It may be effective as well as @code{nntp-list-options} even though the
12146 server could not accept a shell-style wildcard as a option of the LIST
12147 command.  You may use it as a server variable as follows:
12148
12149 @lisp
12150 (setq gnus-select-method
12151       '(nntp "news.somewhere.edu"
12152              (nntp-options-not-subscribe "\\.binaries\\.")))
12153 @end lisp
12154 @end table
12155
12156 @menu
12157 * Direct Functions::            Connecting directly to the server.
12158 * Indirect Functions::          Connecting indirectly to the server.
12159 * Common Variables::            Understood by several connection functions.
12160 @end menu
12161
12162
12163 @node Direct Functions
12164 @subsubsection Direct Functions
12165 @cindex direct connection functions
12166
12167 These functions are called direct because they open a direct connection
12168 between your machine and the @sc{nntp} server.  The behavior of these
12169 functions is also affected by commonly understood variables
12170 (@pxref{Common Variables}).
12171
12172 @table @code
12173 @findex nntp-open-network-stream
12174 @item nntp-open-network-stream
12175 This is the default, and simply connects to some port or other on the
12176 remote system.
12177
12178 @findex nntp-open-ssl-stream
12179 @item nntp-open-ssl-stream
12180 Opens a connection to a server over a @dfn{secure} channel.  To use
12181 this you must have OpenSSL (@uref{http://www.openssl.org}) or SSLeay
12182 installed (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also
12183 need @file{ssl.el} (from the W3 distribution, for instance).  You then
12184 define a server as follows:
12185
12186 @lisp
12187 ;; Type `C-c C-c' after you've finished editing.
12188 ;;
12189 ;; "snews" is port 563 and is predefined in our /etc/services
12190 ;; however, openssl s_client -port doesn't like named ports
12191 ;;
12192 (nntp "snews.bar.com"
12193       (nntp-open-connection-function nntp-open-ssl-stream)
12194       (nntp-port-number 563)
12195       (nntp-address "snews.bar.com"))
12196 @end lisp
12197
12198 @findex nntp-open-telnet-stream
12199 @item nntp-open-telnet-stream
12200 Opens a connection to an @sc{nntp} server by simply @samp{telnet}'ing
12201 it.  You might wonder why this function exists, since we have the
12202 default @code{nntp-open-network-stream} which would do the job.  (One
12203 of) the reason(s) is that if you are behind a firewall but have direct
12204 connections to the outside world thanks to a command wrapper like
12205 @code{runsocks}, you can use it like this:
12206
12207 @lisp
12208 (nntp "socksified"
12209       (nntp-pre-command "runsocks")
12210       (nntp-open-connection-function nntp-open-telnet-stream)
12211       (nntp-address "the.news.server"))
12212 @end lisp
12213
12214 With the default method, you would need to wrap your whole Emacs
12215 session, which is not a good idea.
12216 @end table
12217
12218
12219 @node Indirect Functions
12220 @subsubsection Indirect Functions
12221 @cindex indirect connection functions
12222
12223 These functions are called indirect because they connect to an
12224 intermediate host before actually connecting to the @sc{nntp} server.
12225 All of these functions and related variables are also said to belong to
12226 the "via" family of connection: they're all prefixed with "via" to make
12227 things cleaner.  The behavior of these functions is also affected by
12228 commonly understood variables (@pxref{Common Variables}).
12229
12230 @table @code
12231 @item nntp-open-via-rlogin-and-telnet
12232 @findex nntp-open-via-rlogin-and-telnet
12233 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
12234 to the real @sc{nntp} server from there.  This is useful for instance if
12235 you need to connect to a firewall machine first.
12236
12237 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
12238
12239 @table @code
12240 @item nntp-via-rlogin-command
12241 @vindex nntp-via-rlogin-command
12242 Command used to log in on the intermediate host.  The default is
12243 @samp{rsh}, but @samp{ssh} is a popular alternative.
12244
12245 @item nntp-via-rlogin-command-switches
12246 @vindex nntp-via-rlogin-command-switches
12247 List of strings to be used as the switches to
12248 @code{nntp-via-rlogin-command}.  The default is @code{nil}.  If you use
12249 @samp{ssh} for `nntp-via-rlogin-command', you may set this to
12250 @samp{("-C")} in order to compress all data connections, otherwise set
12251 this to @samp{("-t")} or @samp{("-C" "-t")} if the telnet command
12252 requires a pseudo-tty allocation on an intermediate host.
12253 @end table
12254
12255 @item nntp-open-via-telnet-and-telnet
12256 @findex nntp-open-via-telnet-and-telnet
12257 Does essentially the same, but uses @samp{telnet} instead of
12258 @samp{rlogin} to connect to the intermediate host.
12259
12260 @code{nntp-open-via-telnet-and-telnet}-specific variables:
12261
12262 @table @code
12263 @item nntp-via-telnet-command
12264 @vindex nntp-via-telnet-command
12265 Command used to @code{telnet} the intermediate host.  The default is
12266 @samp{telnet}.
12267
12268 @item nntp-via-telnet-switches
12269 @vindex nntp-via-telnet-switches
12270 List of strings to be used as the switches to the
12271 @code{nntp-via-telnet-command} command.  The default is @samp{("-8")}.
12272
12273 @item nntp-via-user-password
12274 @vindex nntp-via-user-password
12275 Password to use when logging in on the intermediate host.
12276
12277 @item nntp-via-envuser
12278 @vindex nntp-via-envuser
12279 If non-@code{nil}, the intermediate @code{telnet} session (client and
12280 server both) will support the @code{ENVIRON} option and not prompt for
12281 login name. This works for Solaris @code{telnet}, for instance.
12282
12283 @item nntp-via-shell-prompt
12284 @vindex nntp-via-shell-prompt
12285 Regexp matching the shell prompt on the intermediate host.  The default
12286 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
12287
12288 @end table
12289
12290 @end table
12291
12292
12293 Here are some additional variables that are understood by all the above
12294 functions:
12295
12296 @table @code
12297
12298 @item nntp-via-user-name
12299 @vindex nntp-via-user-name
12300 User name to use when connecting to the intermediate host.
12301
12302 @item nntp-via-address
12303 @vindex nntp-via-address
12304 Address of the intermediate host to connect to.
12305
12306 @end table
12307
12308
12309 @node Common Variables
12310 @subsubsection Common Variables
12311
12312 The following variables affect the behavior of all, or several of the
12313 pre-made connection functions. When not specified, all functions are
12314 affected.
12315
12316 @table @code
12317
12318 @item nntp-pre-command
12319 @vindex nntp-pre-command
12320 A command wrapper to use when connecting through a non native connection
12321 function (all except @code{nntp-open-network-stream} and
12322 @code{nntp-open-ssl-stream}.  This is where you would put a @samp{SOCKS}
12323 wrapper for instance.
12324
12325 @item nntp-address
12326 @vindex nntp-address
12327 The address of the @sc{nntp} server.
12328
12329 @item nntp-port-number
12330 @vindex nntp-port-number
12331 Port number to connect to the @sc{nntp} server.  The default is @samp{nntp}.
12332 If you use @sc{nntp} over @sc{ssl}, you may want to use integer ports rather
12333 than named ports (i.e, use @samp{563} instead of @samp{snews}), because
12334 external SSL tools may not work with named ports.
12335
12336 @item nntp-end-of-line
12337 @vindex nntp-end-of-line
12338 String to use as end-of-line marker when talking to the @sc{nntp}
12339 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
12340 using a non native connection function.
12341
12342 @item nntp-telnet-command
12343 @vindex nntp-telnet-command
12344 Command to use when connecting to the @sc{nntp} server through
12345 @samp{telnet}.  This is NOT for an intermediate host.  This is just for
12346 the real @sc{nntp} server.  The default is @samp{telnet}.
12347
12348 @item nntp-telnet-switches
12349 @vindex nntp-telnet-switches
12350 A list of switches to pass to @code{nntp-telnet-command}.  The default
12351 is @samp{("-8")}.
12352
12353 @end table
12354
12355
12356 @node News Spool
12357 @subsection News Spool
12358 @cindex nnspool
12359 @cindex news spool
12360
12361 Subscribing to a foreign group from the local spool is extremely easy,
12362 and might be useful, for instance, to speed up reading groups that
12363 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
12364 instance.
12365
12366 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
12367 anything else) as the address.
12368
12369 If you have access to a local spool, you should probably use that as the
12370 native select method (@pxref{Finding the News}).  It is normally faster
12371 than using an @code{nntp} select method, but might not be.  It depends.
12372 You just have to try to find out what's best at your site.
12373
12374 @table @code
12375
12376 @item nnspool-inews-program
12377 @vindex nnspool-inews-program
12378 Program used to post an article.
12379
12380 @item nnspool-inews-switches
12381 @vindex nnspool-inews-switches
12382 Parameters given to the inews program when posting an article.
12383
12384 @item nnspool-spool-directory
12385 @vindex nnspool-spool-directory
12386 Where @code{nnspool} looks for the articles.  This is normally
12387 @file{/usr/spool/news/}.
12388
12389 @item nnspool-nov-directory
12390 @vindex nnspool-nov-directory
12391 Where @code{nnspool} will look for @sc{nov} files.  This is normally
12392 @file{/usr/spool/news/over.view/}.
12393
12394 @item nnspool-lib-dir
12395 @vindex nnspool-lib-dir
12396 Where the news lib dir is (@file{/usr/lib/news/} by default).
12397
12398 @item nnspool-active-file
12399 @vindex nnspool-active-file
12400 The path to the active file.
12401
12402 @item nnspool-newsgroups-file
12403 @vindex nnspool-newsgroups-file
12404 The path to the group descriptions file.
12405
12406 @item nnspool-history-file
12407 @vindex nnspool-history-file
12408 The path to the news history file.
12409
12410 @item nnspool-active-times-file
12411 @vindex nnspool-active-times-file
12412 The path to the active date file.
12413
12414 @item nnspool-nov-is-evil
12415 @vindex nnspool-nov-is-evil
12416 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
12417 that it finds.
12418
12419 @item nnspool-sift-nov-with-sed
12420 @vindex nnspool-sift-nov-with-sed
12421 @cindex sed
12422 If non-@code{nil}, which is the default, use @code{sed} to get the
12423 relevant portion from the overview file.  If nil, @code{nnspool} will
12424 load the entire file into a buffer and process it there.
12425
12426 @end table
12427
12428
12429 @node Getting Mail
12430 @section Getting Mail
12431 @cindex reading mail
12432 @cindex mail
12433
12434 Reading mail with a newsreader---isn't that just plain WeIrD? But of
12435 course.
12436
12437 @menu
12438 * Mail in a Newsreader::        Important introductory notes.
12439 * Getting Started Reading Mail::  A simple cookbook example.
12440 * Splitting Mail::              How to create mail groups.
12441 * Mail Sources::                How to tell Gnus where to get mail from.
12442 * Mail Back End Variables::     Variables for customizing mail handling.
12443 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
12444 * Group Mail Splitting::        Use group customize to drive mail splitting.
12445 * Incorporating Old Mail::      What about the old mail you have?
12446 * Expiring Mail::               Getting rid of unwanted mail.
12447 * Washing Mail::                Removing gruft from the mail you get.
12448 * Duplicates::                  Dealing with duplicated mail.
12449 * Not Reading Mail::            Using mail back ends for reading other files.
12450 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
12451 @end menu
12452
12453
12454 @node Mail in a Newsreader
12455 @subsection Mail in a Newsreader
12456
12457 If you are used to traditional mail readers, but have decided to switch
12458 to reading mail with Gnus, you may find yourself experiencing something
12459 of a culture shock.
12460
12461 Gnus does not behave like traditional mail readers.  If you want to make
12462 it behave that way, you can, but it's an uphill battle.
12463
12464 Gnus, by default, handles all its groups using the same approach.  This
12465 approach is very newsreaderly---you enter a group, see the new/unread
12466 messages, and when you read the messages, they get marked as read, and
12467 you don't see them any more.  (Unless you explicitly ask for them.)
12468
12469 In particular, you do not do anything explicitly to delete messages.
12470
12471 Does this mean that all the messages that have been marked as read are
12472 deleted?  How awful!
12473
12474 But, no, it means that old messages are @dfn{expired} according to some
12475 scheme or other.  For news messages, the expire process is controlled by
12476 the news administrator; for mail, the expire process is controlled by
12477 you.  The expire process for mail is covered in depth in @pxref{Expiring
12478 Mail}.
12479
12480 What many Gnus users find, after using it a while for both news and
12481 mail, is that the transport mechanism has very little to do with how
12482 they want to treat a message.
12483
12484 Many people subscribe to several mailing lists.  These are transported
12485 via @sc{smtp}, and are therefore mail.  But we might go for weeks without
12486 answering, or even reading these messages very carefully.  We may not
12487 need to save them because if we should need to read one again, they are
12488 archived somewhere else.
12489
12490 Some people have local news groups which have only a handful of readers.
12491 These are transported via @sc{nntp}, and are therefore news.  But we may need
12492 to read and answer a large fraction of the messages very carefully in
12493 order to do our work.  And there may not be an archive, so we may need
12494 to save the interesting messages the same way we would personal mail.
12495
12496 The important distinction turns out to be not the transport mechanism,
12497 but other factors such as how interested we are in the subject matter,
12498 or how easy it is to retrieve the message if we need to read it again.
12499
12500 Gnus provides many options for sorting mail into ``groups'' which behave
12501 like newsgroups, and for treating each group (whether mail or news)
12502 differently.
12503
12504 Some users never get comfortable using the Gnus (ahem) paradigm and wish
12505 that Gnus should grow up and be a male, er, mail reader.  It is possible
12506 to whip Gnus into a more mailreaderly being, but, as said before, it's
12507 not easy.  People who prefer proper mail readers should try @sc{vm}
12508 instead, which is an excellent, and proper, mail reader.
12509
12510 I don't mean to scare anybody off, but I want to make it clear that you
12511 may be required to learn a new way of thinking about messages.  After
12512 you've been subjected to The Gnus Way, you will come to love it.  I can
12513 guarantee it.  (At least the guy who sold me the Emacs Subliminal
12514 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
12515 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
12516 You Do.)
12517
12518
12519 @node Getting Started Reading Mail
12520 @subsection Getting Started Reading Mail
12521
12522 It's quite easy to use Gnus to read your new mail.  You just plonk the
12523 mail back end of your choice into @code{gnus-secondary-select-methods},
12524 and things will happen automatically.
12525
12526 For instance, if you want to use @code{nnml} (which is a "one file per
12527 mail" back end), you could put the following in your @file{.gnus} file:
12528
12529 @lisp
12530 (setq gnus-secondary-select-methods '((nnml "")))
12531 @end lisp
12532
12533 Now, the next time you start Gnus, this back end will be queried for new
12534 articles, and it will move all the messages in your spool file to its
12535 directory, which is @code{~/Mail/} by default.  The new group that will
12536 be created (@samp{mail.misc}) will be subscribed, and you can read it
12537 like any other group.
12538
12539 You will probably want to split the mail into several groups, though:
12540
12541 @lisp
12542 (setq nnmail-split-methods
12543       '(("junk" "^From:.*Lars Ingebrigtsen")
12544         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
12545         ("other" "")))
12546 @end lisp
12547
12548 This will result in three new @code{nnml} mail groups being created:
12549 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
12550 mail that doesn't fit into the first two groups will be placed in the
12551 last group.
12552
12553 This should be sufficient for reading mail with Gnus.  You might want to
12554 give the other sections in this part of the manual a perusal, though.
12555 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
12556
12557
12558 @node Splitting Mail
12559 @subsection Splitting Mail
12560 @cindex splitting mail
12561 @cindex mail splitting
12562
12563 @vindex nnmail-split-methods
12564 The @code{nnmail-split-methods} variable says how the incoming mail is
12565 to be split into groups.
12566
12567 @lisp
12568 (setq nnmail-split-methods
12569   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
12570     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
12571     ("mail.other" "")))
12572 @end lisp
12573
12574 This variable is a list of lists, where the first element of each of
12575 these lists is the name of the mail group (they do not have to be called
12576 something beginning with @samp{mail}, by the way), and the second
12577 element is a regular expression used on the header of each mail to
12578 determine if it belongs in this mail group.  The first string may
12579 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
12580 insert sub-expressions from the matched text.  For instance:
12581
12582 @lisp
12583 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
12584 @end lisp
12585
12586 The second element can also be a function.  In that case, it will be
12587 called narrowed to the headers with the first element of the rule as the
12588 argument.  It should return a non-@code{nil} value if it thinks that the
12589 mail belongs in that group.
12590
12591 The last of these groups should always be a general one, and the regular
12592 expression should @emph{always} be @samp{} so that it matches any mails
12593 that haven't been matched by any of the other regexps.  (These rules are
12594 processed from the beginning of the alist toward the end.  The first
12595 rule to make a match will "win", unless you have crossposting enabled.
12596 In that case, all matching rules will "win".)
12597
12598 If you like to tinker with this yourself, you can set this variable to a
12599 function of your choice.  This function will be called without any
12600 arguments in a buffer narrowed to the headers of an incoming mail
12601 message.  The function should return a list of group names that it
12602 thinks should carry this mail message.
12603
12604 Note that the mail back ends are free to maul the poor, innocent,
12605 incoming headers all they want to.  They all add @code{Lines} headers;
12606 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
12607 @code{From<SPACE>} line to something else.
12608
12609 @vindex nnmail-crosspost
12610 The mail back ends all support cross-posting.  If several regexps match,
12611 the mail will be ``cross-posted'' to all those groups.
12612 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
12613 that no articles are crossposted to the general (@samp{}) group.
12614
12615 @vindex nnmail-crosspost-link-function
12616 @cindex crosspost
12617 @cindex links
12618 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
12619 the crossposted articles.  However, not all file systems support hard
12620 links.  If that's the case for you, set
12621 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
12622 variable is @code{add-name-to-file} by default.)
12623
12624 @kindex M-x nnmail-split-history
12625 @kindex nnmail-split-history
12626 If you wish to see where the previous mail split put the messages, you
12627 can use the @kbd{M-x nnmail-split-history} command.  If you wish to see
12628 where re-spooling messages would put the messages, you can use
12629 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
12630 Group Commands}).
12631
12632 @vindex nnmail-split-header-length-limit
12633 Header lines longer than the value of
12634 @code{nnmail-split-header-length-limit} are excluded from the split
12635 function.
12636
12637 @vindex nnmail-mail-splitting-charset
12638 @vindex nnmail-mail-splitting-decodes
12639 By default the splitting codes MIME decodes headers so you can match
12640 on non-ASCII strings.  The @code{nnmail-mail-splitting-charset}
12641 variable specifies the default charset for decoding.  The behaviour
12642 can be turned off completely by binding
12643 @code{nnmail-mail-splitting-decodes} to nil, which is useful if you
12644 want to match articles based on the raw header data.
12645
12646 @vindex nnmail-resplit-incoming
12647 By default, splitting is performed on all incoming messages.  If
12648 you specify a @code{directory} entry for the variable
12649 @code{mail-sources} @pxref{Mail Source Specifiers}, however, then
12650 splitting does @emph{not} happen by default.  You can set the variable
12651 @code{nnmail-resplit-incoming} to a non-nil value to make splitting
12652 happen even in this case.  (This variable has no effect on other kinds
12653 of entries.)
12654
12655 Gnus gives you all the opportunity you could possibly want for shooting
12656 yourself in the foot.  Let's say you create a group that will contain
12657 all the mail you get from your boss.  And then you accidentally
12658 unsubscribe from the group.  Gnus will still put all the mail from your
12659 boss in the unsubscribed group, and so, when your boss mails you ``Have
12660 that report ready by Monday or you're fired!'', you'll never see it and,
12661 come Tuesday, you'll still believe that you're gainfully employed while
12662 you really should be out collecting empty bottles to save up for next
12663 month's rent money.
12664
12665
12666 @node Mail Sources
12667 @subsection Mail Sources
12668
12669 Mail can be gotten from many different sources---the mail spool, from a
12670 POP mail server, from a procmail directory, or from a maildir, for
12671 instance.
12672
12673 @menu
12674 * Mail Source Specifiers::      How to specify what a mail source is.
12675 * Mail Source Customization::   Some variables that influence things.
12676 * Fetching Mail::               Using the mail source specifiers.
12677 @end menu
12678
12679
12680 @node Mail Source Specifiers
12681 @subsubsection Mail Source Specifiers
12682 @cindex POP
12683 @cindex mail server
12684 @cindex procmail
12685 @cindex mail spool
12686 @cindex mail source
12687
12688 You tell Gnus how to fetch mail by setting @code{mail-sources}
12689 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
12690
12691 Here's an example:
12692
12693 @lisp
12694 (pop :server "pop3.mailserver.com" :user "myname")
12695 @end lisp
12696
12697 As can be observed, a mail source specifier is a list where the first
12698 element is a @dfn{mail source type}, followed by an arbitrary number of
12699 @dfn{keywords}.  Keywords that are not explicitly specified are given
12700 default values.
12701
12702 The following mail source types are available:
12703
12704 @table @code
12705 @item file
12706 Get mail from a single file; typically from the mail spool.
12707
12708 Keywords:
12709
12710 @table @code
12711 @item :path
12712 The path of the file.  Defaults to the value of the @code{MAIL}
12713 environment variable or the value of @code{rmail-spool-directory}
12714 (usually something like @file{/usr/mail/spool/user-name}).
12715 @end table
12716
12717 An example file mail source:
12718
12719 @lisp
12720 (file :path "/usr/spool/mail/user-name")
12721 @end lisp
12722
12723 Or using the default path:
12724
12725 @lisp
12726 (file)
12727 @end lisp
12728
12729 If the mail spool file is not located on the local machine, it's best to
12730 use POP or @sc{imap} or the like to fetch the mail.  You can not use ange-ftp
12731 file names here---it has no way to lock the mail spool while moving the
12732 mail.
12733
12734 If it's impossible to set up a proper server, you can use ssh instead.
12735
12736 @lisp
12737 (setq mail-sources
12738       '((file :prescript "ssh host bin/getmail >%t")))
12739 @end lisp
12740
12741 The @samp{getmail} script would look something like the following:
12742
12743 @example
12744 #!/bin/sh
12745 #  getmail - move mail from spool to stdout
12746 #  flu@@iki.fi
12747
12748 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
12749 TMP=$HOME/Mail/tmp
12750 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
12751 @end example
12752
12753 Alter this script to fit find the @samp{movemail} you want to use.
12754
12755
12756 @item directory
12757 @vindex nnmail-scan-directory-mail-source-once
12758 Get mail from several files in a directory.  This is typically used when
12759 you have procmail split the incoming mail into several files.  That is,
12760 there is a one-to-one correspondence between files in that directory and
12761 groups, so that mail from the file @file{foo.bar.spool} will be put in
12762 the group @code{foo.bar}.  (You can change the suffix to be used instead
12763 of @code{.spool}.)  Setting
12764 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus to
12765 scan the mail source only once.  This is particularly useful if you want
12766 to scan mail groups at a specified level.
12767
12768 @vindex nnmail-resplit-incoming
12769 There is also the variable @code{nnmail-resplit-incoming}, if you set
12770 that to a non-nil value, then the normal splitting process is applied
12771 to all the files from the directory, @ref{Splitting Mail}.
12772
12773 Keywords:
12774
12775 @table @code
12776 @item :path
12777 The path of the directory where the files are.  There is no default
12778 value.
12779
12780 @item :suffix
12781 Only files ending with this suffix are used.  The default is
12782 @samp{.spool}.
12783
12784 @item :predicate
12785 Only files that have this predicate return non-@code{nil} are returned.
12786 The default is @code{identity}.  This is used as an additional
12787 filter---only files that have the right suffix @emph{and} satisfy this
12788 predicate are considered.
12789
12790 @item :prescript
12791 @itemx :postscript
12792 Script run before/after fetching mail.
12793
12794 @end table
12795
12796 An example directory mail source:
12797
12798 @lisp
12799 (directory :path "/home/user-name/procmail-dir/"
12800            :suffix ".prcml")
12801 @end lisp
12802
12803 @item pop
12804 Get mail from a POP server.
12805
12806 Keywords:
12807
12808 @table @code
12809 @item :server
12810 The name of the POP server.  The default is taken from the
12811 @code{MAILHOST} environment variable.
12812
12813 @item :port
12814 The port number of the POP server.  This can be a number (eg,
12815 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}).  If it is a
12816 string, it should be a service name as listed in @file{/etc/services} on
12817 Unix systems.  The default is @samp{"pop3"}.  On some systems you might
12818 need to specify it as @samp{"pop-3"} instead.
12819
12820 @item :user
12821 The user name to give to the POP server.  The default is the login
12822 name.
12823
12824 @item :password
12825 The password to give to the POP server.  If not specified, the user is
12826 prompted.
12827
12828 @item :program
12829 The program to use to fetch mail from the POP server.  This should be
12830 a @code{format}-like string.  Here's an example:
12831
12832 @example
12833 fetchmail %u@@%s -P %p %t
12834 @end example
12835
12836 The valid format specifier characters are:
12837
12838 @table @samp
12839 @item t
12840 The name of the file the mail is to be moved to.  This must always be
12841 included in this string.
12842
12843 @item s
12844 The name of the server.
12845
12846 @item P
12847 The port number of the server.
12848
12849 @item u
12850 The user name to use.
12851
12852 @item p
12853 The password to use.
12854 @end table
12855
12856 The values used for these specs are taken from the values you give the
12857 corresponding keywords.
12858
12859 @item :prescript
12860 A script to be run before fetching the mail.  The syntax is the same as
12861 the @code{:program} keyword.  This can also be a function to be run.
12862
12863 @item :postscript
12864 A script to be run after fetching the mail.  The syntax is the same as
12865 the @code{:program} keyword.  This can also be a function to be run.
12866
12867 @item :function
12868 The function to use to fetch mail from the POP server.  The function is
12869 called with one parameter---the name of the file where the mail should
12870 be moved to.
12871
12872 @item :authentication
12873 This can be either the symbol @code{password} or the symbol @code{apop}
12874 and says what authentication scheme to use.  The default is
12875 @code{password}.
12876
12877 @item :connection
12878 What stream to use for connecting to the server, this can be the symbol
12879 @code{ssl}, the symbol @code{tls} or others.  The default is @code{nil}
12880 and use insecure connections.  Note that for SSL/TLS, you need external
12881 programs and libraries:
12882
12883 @itemize @bullet
12884 @item
12885 @dfn{ssl:} Connect through SSL@. Requires OpenSSL (the program
12886 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
12887 library @samp{ssl.el}.
12888 @item
12889 @dfn{starttls:} Connect via the STARTTLS extension (similar to SSL)@.
12890 Requires the external library @samp{starttls.el} and program
12891 @samp{starttls}.
12892 @end itemize
12893
12894 @item :leave
12895 Non-@code{nil} if mail is to be left on the server and UIDL used for
12896 message retrieval.  The default is @code{nil}.
12897
12898 @end table
12899
12900 If the @code{:program} and @code{:function} keywords aren't specified,
12901 @code{pop3-movemail} will be used.
12902
12903 Here are some examples.  Fetch from the default POP server, using the
12904 default user name, and default fetcher:
12905
12906 @lisp
12907 (pop)
12908 @end lisp
12909
12910 Fetch from a named server with a named user and password:
12911
12912 @lisp
12913 (pop :server "my.pop.server"
12914      :user "user-name" :password "secret")
12915 @end lisp
12916
12917 Use @samp{movemail} to move the mail:
12918
12919 @lisp
12920 (pop :program "movemail po:%u %t %p")
12921 @end lisp
12922
12923 @item maildir
12924 Get mail from a maildir.  This is a type of mailbox that is supported by
12925 at least qmail and postfix, where each file in a special directory
12926 contains exactly one mail.
12927
12928 Keywords:
12929
12930 @table @code
12931 @item :path
12932 The path of the directory where the mails are stored.  The default is
12933 taken from the @code{MAILDIR} environment variable or
12934 @samp{~/Maildir/}.
12935 @item :subdirs
12936 The subdirectories of the Maildir.  The default is
12937 @samp{("new" "cur")}.
12938
12939 @c If you sometimes look at your mail through a pop3 daemon before fetching
12940 @c them with Gnus, you may also have to fetch your mails from the
12941 @c @code{cur} directory inside the maildir, like in the first example
12942 @c below.
12943
12944 You can also get mails from remote hosts (because maildirs don't suffer
12945 from locking problems).
12946
12947 @end table
12948
12949 Two example maildir mail sources:
12950
12951 @lisp
12952 (maildir :path "/home/user-name/Maildir/"
12953          :subdirs ("cur" "new"))
12954 @end lisp
12955
12956 @lisp
12957 (maildir :path "/user@@remotehost.org:~/Maildir/"
12958          :subdirs ("new"))
12959 @end lisp
12960
12961 @item imap
12962 Get mail from a @sc{imap} server.  If you don't want to use @sc{imap}
12963 as intended, as a network mail reading protocol (ie with nnimap), for
12964 some reason or other, Gnus let you treat it similar to a POP server
12965 and fetches articles from a given @sc{imap} mailbox.  @xref{IMAP}, for
12966 more information.
12967
12968 Note that for the Kerberos, GSSAPI, SSL/TLS and STARTTLS support you
12969 may need external programs and libraries, @xref{IMAP}.
12970
12971 Keywords:
12972
12973 @table @code
12974 @item :server
12975 The name of the @sc{imap} server.  The default is taken from the
12976 @code{MAILHOST} environment variable.
12977
12978 @item :port
12979 The port number of the @sc{imap} server.  The default is @samp{143}, or
12980 @samp{993} for SSL/TLS connections.
12981
12982 @item :user
12983 The user name to give to the @sc{imap} server.  The default is the login
12984 name.
12985
12986 @item :password
12987 The password to give to the @sc{imap} server.  If not specified, the user is
12988 prompted.
12989
12990 @item :stream
12991 What stream to use for connecting to the server, this is one of the
12992 symbols in @code{imap-stream-alist}.  Right now, this means
12993 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{ssl},
12994 @samp{shell} or the default @samp{network}.
12995
12996 @item :authentication
12997 Which authenticator to use for authenticating to the server, this is
12998 one of the symbols in @code{imap-authenticator-alist}.  Right now,
12999 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
13000 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
13001
13002 @item :program
13003 When using the `shell' :stream, the contents of this variable is
13004 mapped into the `imap-shell-program' variable.  This should be a
13005 @code{format}-like string (or list of strings).  Here's an example:
13006
13007 @example
13008 ssh %s imapd
13009 @end example
13010
13011 The valid format specifier characters are:
13012
13013 @table @samp
13014 @item s
13015 The name of the server.
13016
13017 @item l
13018 User name from `imap-default-user'.
13019
13020 @item p
13021 The port number of the server.
13022 @end table
13023
13024 The values used for these specs are taken from the values you give the
13025 corresponding keywords.
13026
13027 @item :mailbox
13028 The name of the mailbox to get mail from.  The default is @samp{INBOX}
13029 which normally is the mailbox which receive incoming mail.
13030
13031 @item :predicate
13032 The predicate used to find articles to fetch.  The default, @samp{UNSEEN
13033 UNDELETED}, is probably the best choice for most people, but if you
13034 sometimes peek in your mailbox with a @sc{imap} client and mark some
13035 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
13036 Then all articles in the mailbox is fetched, no matter what.  For a
13037 complete list of predicates, see RFC 2060 section 6.4.4.
13038
13039 @item :fetchflag
13040 How to flag fetched articles on the server, the default @samp{\Deleted}
13041 will mark them as deleted, an alternative would be @samp{\Seen} which
13042 would simply mark them as read.  These are the two most likely choices,
13043 but more flags are defined in RFC 2060 section 2.3.2.
13044
13045 @item :dontexpunge
13046 If non-nil, don't remove all articles marked as deleted in the mailbox
13047 after finishing the fetch.
13048
13049 @end table
13050
13051 An example @sc{imap} mail source:
13052
13053 @lisp
13054 (imap :server "mail.mycorp.com"
13055       :stream kerberos4
13056       :fetchflag "\\Seen")
13057 @end lisp
13058
13059 @item webmail
13060 Get mail from a webmail server, such as @uref{www.hotmail.com},
13061 @uref{webmail.netscape.com}, @uref{www.netaddress.com},
13062 @uref{mail.yahoo..com}.
13063
13064 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
13065 required for url "4.0pre.46".
13066
13067 WARNING: Mails may be lost.  NO WARRANTY.
13068
13069 Keywords:
13070
13071 @table @code
13072 @item :subtype
13073 The type of the webmail server.  The default is @code{hotmail}.  The
13074 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
13075
13076 @item :user
13077 The user name to give to the webmail server.  The default is the login
13078 name.
13079
13080 @item :password
13081 The password to give to the webmail server.  If not specified, the user is
13082 prompted.
13083
13084 @item :dontexpunge
13085 If non-nil, only fetch unread articles and don't move them to trash
13086 folder after finishing the fetch.
13087
13088 @end table
13089
13090 An example webmail source:
13091
13092 @lisp
13093 (webmail :subtype 'hotmail
13094          :user "user-name"
13095          :password "secret")
13096 @end lisp
13097 @end table
13098
13099 @table @dfn
13100 @item Common Keywords
13101 Common keywords can be used in any type of mail source.
13102
13103 Keywords:
13104
13105 @table @code
13106 @item :plugged
13107 If non-nil, fetch the mail even when Gnus is unplugged.  If you use
13108 directory source to get mail, you can specify it as in this example:
13109
13110 @lisp
13111 (setq mail-sources
13112       '((directory :path "/home/pavel/.Spool/"
13113                    :suffix ""
13114                    :plugged t)))
13115 @end lisp
13116
13117 Gnus will then fetch your mail even when you are unplugged.  This is
13118 useful when you use local mail and news.
13119
13120 @end table
13121 @end table
13122
13123 @subsubsection Function Interface
13124
13125 Some of the above keywords specify a Lisp function to be executed.
13126 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
13127 the value of the keyword while the function is executing.  For example,
13128 consider the following mail-source setting:
13129
13130 @lisp
13131 (setq mail-sources '((pop :user "jrl"
13132                           :server "pophost" :function fetchfunc)))
13133 @end lisp
13134
13135 While the function @code{fetchfunc} is executing, the symbol @code{user}
13136 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
13137 @code{"pophost"}.  The symbols @code{port}, @code{password},
13138 @code{program}, @code{prescript}, @code{postscript}, @code{function},
13139 and @code{authentication} are also bound (to their default values).
13140
13141 See above for a list of keywords for each type of mail source.
13142
13143
13144 @node Mail Source Customization
13145 @subsubsection Mail Source Customization
13146
13147 The following is a list of variables that influence how the mail is
13148 fetched.  You would normally not need to set or change any of these
13149 variables.
13150
13151 @table @code
13152 @item mail-source-crash-box
13153 @vindex mail-source-crash-box
13154 File where mail will be stored while processing it.  The default is
13155 @file{~/.emacs-mail-crash-box}.
13156
13157 @item mail-source-delete-incoming
13158 @vindex mail-source-delete-incoming
13159 If non-@code{nil}, delete incoming files after handling them.
13160
13161 @item mail-source-directory
13162 @vindex mail-source-directory
13163 Directory where files (if any) will be stored.  The default is
13164 @file{~/Mail/}.  At present, the only thing this is used for is to say
13165 where the incoming files will be stored if the previous variable is
13166 @code{nil}.
13167
13168 @item mail-source-incoming-file-prefix
13169 @vindex mail-source-incoming-file-prefix
13170 Prefix for file name for storing incoming mail.  The default is
13171 @file{Incoming}, in which case files will end up with names like
13172 @file{Incoming30630D_} or @file{Incoming298602ZD}.  This is really only
13173 relevant if @code{mail-source-delete-incoming} is @code{nil}.
13174
13175 @item mail-source-default-file-modes
13176 @vindex mail-source-default-file-modes
13177 All new mail files will get this file mode.  The default is 384.
13178
13179 @item mail-source-movemail-program
13180 @vindex mail-source-movemail-program
13181 If non-nil, name of program for fetching new mail.  If nil,
13182 @code{movemail} in @var{exec-directory}.
13183
13184 @end table
13185
13186
13187 @node Fetching Mail
13188 @subsubsection Fetching Mail
13189
13190 @vindex mail-sources
13191 @vindex nnmail-spool-file
13192 The way to actually tell Gnus where to get new mail from is to set
13193 @code{mail-sources} to a list of mail source specifiers
13194 (@pxref{Mail Source Specifiers}).
13195
13196 If this variable (and the obsolescent @code{nnmail-spool-file}) is
13197 @code{nil}, the mail back ends will never attempt to fetch mail by
13198 themselves.
13199
13200 If you want to fetch mail both from your local spool as well as a POP
13201 mail server, you'd say something like:
13202
13203 @lisp
13204 (setq mail-sources
13205       '((file)
13206         (pop :server "pop3.mail.server"
13207              :password "secret")))
13208 @end lisp
13209
13210 Or, if you don't want to use any of the keyword defaults:
13211
13212 @lisp
13213 (setq mail-sources
13214       '((file :path "/var/spool/mail/user-name")
13215         (pop :server "pop3.mail.server"
13216              :user "user-name"
13217              :port "pop3"
13218              :password "secret")))
13219 @end lisp
13220
13221
13222 When you use a mail back end, Gnus will slurp all your mail from your
13223 inbox and plonk it down in your home directory.  Gnus doesn't move any
13224 mail if you're not using a mail back end---you have to do a lot of magic
13225 invocations first.  At the time when you have finished drawing the
13226 pentagram, lightened the candles, and sacrificed the goat, you really
13227 shouldn't be too surprised when Gnus moves your mail.
13228
13229
13230
13231 @node Mail Back End Variables
13232 @subsection Mail Back End Variables
13233
13234 These variables are (for the most part) pertinent to all the various
13235 mail back ends.
13236
13237 @table @code
13238 @vindex nnmail-read-incoming-hook
13239 @item nnmail-read-incoming-hook
13240 The mail back ends all call this hook after reading new mail.  You can
13241 use this hook to notify any mail watch programs, if you want to.
13242
13243 @vindex nnmail-split-hook
13244 @item nnmail-split-hook
13245 @findex article-decode-encoded-words
13246 @findex RFC 1522 decoding
13247 @findex RFC 2047 decoding
13248 Hook run in the buffer where the mail headers of each message is kept
13249 just before the splitting based on these headers is done.  The hook is
13250 free to modify the buffer contents in any way it sees fit---the buffer
13251 is discarded after the splitting has been done, and no changes performed
13252 in the buffer will show up in any files.
13253 @code{gnus-article-decode-encoded-words} is one likely function to add
13254 to this hook.
13255
13256 @vindex nnmail-pre-get-new-mail-hook
13257 @vindex nnmail-post-get-new-mail-hook
13258 @item nnmail-pre-get-new-mail-hook
13259 @itemx nnmail-post-get-new-mail-hook
13260 These are two useful hooks executed when treating new incoming
13261 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
13262 starting to handle the new mail) and
13263 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
13264 is done).  Here's and example of using these two hooks to change the
13265 default file modes the new mail files get:
13266
13267 @lisp
13268 (add-hook 'nnmail-pre-get-new-mail-hook
13269           (lambda () (set-default-file-modes 511)))
13270
13271 (add-hook 'nnmail-post-get-new-mail-hook
13272           (lambda () (set-default-file-modes 551)))
13273 @end lisp
13274
13275 @item nnmail-use-long-file-names
13276 @vindex nnmail-use-long-file-names
13277 If non-@code{nil}, the mail back ends will use long file and directory
13278 names.  Groups like @samp{mail.misc} will end up in directories
13279 (assuming use of @code{nnml} back end) or files (assuming use of
13280 @code{nnfolder} back end) like @file{mail.misc}.  If it is @code{nil},
13281 the same group will end up in @file{mail/misc}.
13282
13283 @item nnmail-delete-file-function
13284 @vindex nnmail-delete-file-function
13285 @findex delete-file
13286 Function called to delete files.  It is @code{delete-file} by default.
13287
13288 @item nnmail-cache-accepted-message-ids
13289 @vindex nnmail-cache-accepted-message-ids
13290 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
13291 the back end (via @code{Gcc}, for instance) into the mail duplication
13292 discovery cache.  The default is @code{nil}.
13293
13294 @item nnmail-cache-ignore-groups
13295 @vindex nnmail-cache-ignore-groups
13296 This can be a regular expression or a list of regular expressions.
13297 Group names that match any of the regular expressions will never be
13298 recorded in the @code{Message-ID} cache.
13299
13300 This can be useful, for example, when using Fancy Splitting
13301 (@pxref{Fancy Mail Splitting}) together with the function
13302 @code{nnmail-split-fancy-with-parent}.
13303
13304 @end table
13305
13306
13307 @node Fancy Mail Splitting
13308 @subsection Fancy Mail Splitting
13309 @cindex mail splitting
13310 @cindex fancy mail splitting
13311
13312 @vindex nnmail-split-fancy
13313 @findex nnmail-split-fancy
13314 If the rather simple, standard method for specifying how to split mail
13315 doesn't allow you to do what you want, you can set
13316 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
13317 play with the @code{nnmail-split-fancy} variable.
13318
13319 Let's look at an example value of this variable first:
13320
13321 @lisp
13322 ;; Messages from the mailer daemon are not crossposted to any of
13323 ;; the ordinary groups.  Warnings are put in a separate group
13324 ;; from real errors.
13325 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
13326                    "mail.misc"))
13327    ;; Non-error messages are crossposted to all relevant
13328    ;; groups, but we don't crosspost between the group for the
13329    ;; (ding) list and the group for other (ding) related mail.
13330    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
13331          ("subject" "ding" "ding.misc"))
13332       ;; Other mailing lists...
13333       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
13334       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
13335       ;; Both lists below have the same suffix, so prevent
13336       ;; cross-posting to mkpkg.list of messages posted only to
13337       ;; the bugs- list, but allow cross-posting when the
13338       ;; message was really cross-posted.
13339       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
13340       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
13341       ;; People...
13342       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
13343    ;; Unmatched mail goes to the catch all group.
13344    "misc.misc")
13345 @end lisp
13346
13347 This variable has the format of a @dfn{split}.  A split is a (possibly)
13348 recursive structure where each split may contain other splits.  Here are
13349 the five possible split syntaxes:
13350
13351 @enumerate
13352
13353 @item
13354 @samp{group}: If the split is a string, that will be taken as a group
13355 name.  Normal regexp match expansion will be done.  See below for
13356 examples.
13357
13358 @item
13359 @code{(@var{field} @var{value} @code{[-} @var{restrict}
13360 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
13361 first element of which is a string, then store the message as
13362 specified by @var{split}, if header @var{field} (a regexp) contains
13363 @var{value} (also a regexp).  If @var{restrict} (yet another regexp)
13364 matches some string after @var{field} and before the end of the
13365 matched @var{value}, the @var{split} is ignored.  If none of the
13366 @var{restrict} clauses match, @var{split} is processed.
13367
13368 @item
13369 @code{(| @var{split}@dots{})}: If the split is a list, and the first
13370 element is @code{|} (vertical bar), then process each @var{split} until
13371 one of them matches.  A @var{split} is said to match if it will cause
13372 the mail message to be stored in one or more groups.
13373
13374 @item
13375 @code{(& @var{split}@dots{})}: If the split is a list, and the first
13376 element is @code{&}, then process all @var{split}s in the list.
13377
13378 @item
13379 @code{junk}: If the split is the symbol @code{junk}, then don't save
13380 (i.e., delete) this message.  Use with extreme caution.
13381
13382 @item
13383 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is
13384 a list, and the first element is @code{:}, then the second element will
13385 be called as a function with @var{args} given as arguments.  The
13386 function should return a @var{split}.
13387
13388 @cindex body split
13389 For instance, the following function could be used to split based on the
13390 body of the messages:
13391
13392 @lisp
13393 (defun split-on-body ()
13394   (save-excursion
13395     (set-buffer " *nnmail incoming*")
13396     (goto-char (point-min))
13397     (when (re-search-forward "Some.*string" nil t)
13398       "string.group")))
13399 @end lisp
13400
13401 The @samp{" *nnmail incoming*"} is narrowed to the message in question
13402 when the @code{:} function is run.
13403
13404 @item
13405 @code{(! @var{func} @var{split})}: If the split is a list, and the first
13406 element is @code{!}, then SPLIT will be processed, and FUNC will be
13407 called as a function with the result of SPLIT as argument.  FUNC should
13408 return a split.
13409
13410 @item
13411 @code{nil}: If the split is @code{nil}, it is ignored.
13412
13413 @end enumerate
13414
13415 In these splits, @var{field} must match a complete field name.
13416 @var{value} must match a complete word according to the fundamental mode
13417 syntax table.  You can use @code{.*} in the regexps to match partial
13418 field names or words.  In other words, all @var{value}'s are wrapped in
13419 @samp{\<} and @samp{\>} pairs.
13420
13421 @vindex nnmail-split-abbrev-alist
13422 @var{field} and @var{value} can also be lisp symbols, in that case they
13423 are expanded as specified by the variable
13424 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
13425 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
13426 value.
13427
13428 @vindex nnmail-split-fancy-syntax-table
13429 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
13430 when all this splitting is performed.
13431
13432 If you want to have Gnus create groups dynamically based on some
13433 information in the headers (i.e., do @code{replace-match}-like
13434 substitutions in the group names), you can say things like:
13435
13436 @example
13437 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
13438 @end example
13439
13440 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
13441 will be filed in @samp{mail.debian.foo}.
13442
13443 If the string contains the element @samp{\&}, then the previously
13444 matched string will be substituted.  Similarly, the elements @samp{\\1}
13445 up to @samp{\\9} will be substituted with the text matched by the
13446 groupings 1 through 9.
13447
13448 @findex nnmail-split-fancy-with-parent
13449 @code{nnmail-split-fancy-with-parent} is a function which allows you to
13450 split followups into the same groups their parents are in.  Sometimes
13451 you can't make splitting rules for all your mail.  For example, your
13452 boss might send you personal mail regarding different projects you are
13453 working on, and as you can't tell your boss to put a distinguishing
13454 string into the subject line, you have to resort to manually moving the
13455 messages into the right group.  With this function, you only have to do
13456 it once per thread.
13457
13458 To use this feature, you have to set @code{nnmail-treat-duplicates} and
13459 @code{nnmail-cache-accepted-message-ids} to a non-nil value.  And then
13460 you can include @code{nnmail-split-fancy-with-parent} using the colon
13461 feature, like so:
13462 @lisp
13463 (setq nnmail-treat-duplicates 'warn     ; or 'delete
13464       nnmail-cache-accepted-message-ids t
13465       nnmail-split-fancy
13466       '(| (: nnmail-split-fancy-with-parent)
13467           ;; other splits go here
13468         ))
13469 @end lisp
13470
13471 This feature works as follows: when @code{nnmail-treat-duplicates} is
13472 non-nil, Gnus records the message id of every message it sees in the
13473 file specified by the variable @code{nnmail-message-id-cache-file},
13474 together with the group it is in (the group is omitted for non-mail
13475 messages).  When mail splitting is invoked, the function
13476 @code{nnmail-split-fancy-with-parent} then looks at the References (and
13477 In-Reply-To) header of each message to split and searches the file
13478 specified by @code{nnmail-message-id-cache-file} for the message ids.
13479 When it has found a parent, it returns the corresponding group name
13480 unless the group name matches the regexp
13481 @code{nnmail-split-fancy-with-parent-ignore-groups}.  It is recommended
13482 that you set @code{nnmail-message-id-cache-length} to a somewhat higher
13483 number than the default so that the message ids are still in the cache.
13484 (A value of 5000 appears to create a file some 300 kBytes in size.)
13485 @vindex nnmail-cache-accepted-message-ids
13486 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
13487 also records the message ids of moved articles, so that the followup
13488 messages goes into the new group.
13489
13490 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
13491 want certain groups to be recorded in the cache.  For example, if all
13492 outgoing messages are written to an `outgoing' group, you could set
13493 @code{nnmail-cache-ignore-groups} to match that group name.
13494 Otherwise, answers to all your messages would end up in the
13495 `outgoing' group.
13496
13497
13498 @node Group Mail Splitting
13499 @subsection Group Mail Splitting
13500 @cindex mail splitting
13501 @cindex group mail splitting
13502
13503 @findex gnus-group-split
13504 If you subscribe to dozens of mailing lists but you don't want to
13505 maintain mail splitting rules manually, group mail splitting is for you.
13506 You just have to set @var{to-list} and/or @var{to-address} in group
13507 parameters or group customization and set @code{nnmail-split-methods} to
13508 @code{gnus-group-split}.  This splitting function will scan all groups
13509 for those parameters and split mail accordingly, i.e., messages posted
13510 from or to the addresses specified in the parameters @var{to-list} or
13511 @var{to-address} of a mail group will be stored in that group.
13512
13513 Sometimes, mailing lists have multiple addresses, and you may want mail
13514 splitting to recognize them all: just set the @var{extra-aliases} group
13515 parameter to the list of additional addresses and it's done.  If you'd
13516 rather use a regular expression, set @var{split-regexp}.
13517
13518 All these parameters in a group will be used to create an
13519 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
13520 the @var{value} is a single regular expression that matches
13521 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
13522 matches of @var{split-regexp}, and the @var{split} is the name of the
13523 group.  @var{restrict}s are also supported: just set the
13524 @var{split-exclude} parameter to a list of regular expressions.
13525
13526 If you can't get the right split to be generated using all these
13527 parameters, or you just need something fancier, you can set the
13528 parameter @var{split-spec} to an @code{nnmail-split-fancy} split.  In
13529 this case, all other aforementioned parameters will be ignored by
13530 @code{gnus-group-split}.  In particular, @var{split-spec} may be set to
13531 @code{nil}, in which case the group will be ignored by
13532 @code{gnus-group-split}.
13533
13534 @vindex gnus-group-split-default-catch-all-group
13535 @code{gnus-group-split} will do cross-posting on all groups that match,
13536 by defining a single @code{&} fancy split containing one split for each
13537 group.  If a message doesn't match any split, it will be stored in the
13538 group named in @code{gnus-group-split-default-catch-all-group}, unless
13539 some group has @var{split-spec} set to @code{catch-all}, in which case
13540 that group is used as the catch-all group.  Even though this variable is
13541 often used just to name a group, it may also be set to an arbitrarily
13542 complex fancy split (after all, a group name is a fancy split), and this
13543 may be useful to split mail that doesn't go to any mailing list to
13544 personal mail folders.  Note that this fancy split is added as the last
13545 element of a @code{|} split list that also contains a @code{&} split
13546 with the rules extracted from group parameters.
13547
13548 It's time for an example.  Assume the following group parameters have
13549 been defined:
13550
13551 @example
13552 nnml:mail.bar:
13553 ((to-address . "bar@@femail.com")
13554  (split-regexp . ".*@@femail\\.com"))
13555 nnml:mail.foo:
13556 ((to-list . "foo@@nowhere.gov")
13557  (extra-aliases "foo@@localhost" "foo-redist@@home")
13558  (split-exclude "bugs-foo" "rambling-foo")
13559  (admin-address . "foo-request@@nowhere.gov"))
13560 nnml:mail.others:
13561 ((split-spec . catch-all))
13562 @end example
13563
13564 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
13565 behave as if @code{nnmail-split-fancy} had been selected and variable
13566 @code{nnmail-split-fancy} had been set as follows:
13567
13568 @lisp
13569 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
13570       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
13571            - "bugs-foo" - "rambling-foo" "mail.foo"))
13572    "mail.others")
13573 @end lisp
13574
13575 @findex gnus-group-split-fancy
13576 If you'd rather not use group splitting for all your mail groups, you
13577 may use it for only some of them, by using @code{nnmail-split-fancy}
13578 splits like this:
13579
13580 @lisp
13581 (: gnus-group-split-fancy GROUPS NO-CROSSPOST CATCH-ALL)
13582 @end lisp
13583
13584 @var{groups} may be a regular expression or a list of group names whose
13585 parameters will be scanned to generate the output split.
13586 @var{no-crosspost} can be used to disable cross-posting; in this case, a
13587 single @code{|} split will be output.  @var{catch-all} is the fallback
13588 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
13589 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
13590 empty string in any selected group, no catch-all split will be issued.
13591 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
13592 this group will override the value of the @var{catch-all} argument.
13593
13594 @findex gnus-group-split-setup
13595 Unfortunately, scanning all groups and their parameters can be quite
13596 slow, especially considering that it has to be done for every message.
13597 But don't despair!  The function @code{gnus-group-split-setup} can be
13598 used to enable @code{gnus-group-split} in a much more efficient way.  It
13599 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
13600 @code{nnmail-split-fancy} to the split produced by
13601 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
13602 scanned once, no matter how many messages are split.
13603
13604 @findex gnus-group-split-update
13605 However, if you change group parameters, you'd have to update
13606 @code{nnmail-split-fancy} manually.  You can do it by running
13607 @code{gnus-group-split-update}.  If you'd rather have it updated
13608 automatically, just tell @code{gnus-group-split-setup} to do it for
13609 you.  For example, add to your @file{.gnus}:
13610
13611 @lisp
13612 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
13613 @end lisp
13614
13615 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
13616 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
13617 have to worry about updating @code{nnmail-split-fancy} again.  If you
13618 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
13619 @code{gnus-group-split-default-catch-all-group} will be set to its
13620 value.
13621
13622 @vindex gnus-group-split-updated-hook
13623 Because you may want to change @code{nnmail-split-fancy} after it is set
13624 by @code{gnus-group-split-update}, this function will run
13625 @code{gnus-group-split-updated-hook} just before finishing.
13626
13627 @node Incorporating Old Mail
13628 @subsection Incorporating Old Mail
13629 @cindex incorporating old mail
13630 @cindex import old mail
13631
13632 Most people have lots of old mail stored in various file formats.  If
13633 you have set up Gnus to read mail using one of the spiffy Gnus mail
13634 back ends, you'll probably wish to have that old mail incorporated into
13635 your mail groups.
13636
13637 Doing so can be quite easy.
13638
13639 To take an example: You're reading mail using @code{nnml}
13640 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
13641 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
13642 file filled with important, but old, mail.  You want to move it into
13643 your @code{nnml} groups.
13644
13645 Here's how:
13646
13647 @enumerate
13648 @item
13649 Go to the group buffer.
13650
13651 @item
13652 Type `G f' and give the path to the mbox file when prompted to create an
13653 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
13654
13655 @item
13656 Type `SPACE' to enter the newly created group.
13657
13658 @item
13659 Type `M P b' to process-mark all articles in this group's buffer
13660 (@pxref{Setting Process Marks}).
13661
13662 @item
13663 Type `B r' to respool all the process-marked articles, and answer
13664 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
13665 @end enumerate
13666
13667 All the mail messages in the mbox file will now also be spread out over
13668 all your @code{nnml} groups.  Try entering them and check whether things
13669 have gone without a glitch.  If things look ok, you may consider
13670 deleting the mbox file, but I wouldn't do that unless I was absolutely
13671 sure that all the mail has ended up where it should be.
13672
13673 Respooling is also a handy thing to do if you're switching from one mail
13674 back end to another.  Just respool all the mail in the old mail groups
13675 using the new mail back end.
13676
13677
13678 @node Expiring Mail
13679 @subsection Expiring Mail
13680 @cindex article expiry
13681
13682 Traditional mail readers have a tendency to remove mail articles when
13683 you mark them as read, in some way.  Gnus takes a fundamentally
13684 different approach to mail reading.
13685
13686 Gnus basically considers mail just to be news that has been received in
13687 a rather peculiar manner.  It does not think that it has the power to
13688 actually change the mail, or delete any mail messages.  If you enter a
13689 mail group, and mark articles as ``read'', or kill them in some other
13690 fashion, the mail articles will still exist on the system.  I repeat:
13691 Gnus will not delete your old, read mail.  Unless you ask it to, of
13692 course.
13693
13694 To make Gnus get rid of your unwanted mail, you have to mark the
13695 articles as @dfn{expirable}.  (With the default keybindings, this means
13696 that you have to type @kbd{E}.)  This does not mean that the articles
13697 will disappear right away, however.  In general, a mail article will be
13698 deleted from your system if, 1) it is marked as expirable, AND 2) it is
13699 more than one week old.  If you do not mark an article as expirable, it
13700 will remain on your system until hell freezes over.  This bears
13701 repeating one more time, with some spurious capitalizations: IF you do
13702 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
13703
13704 You do not have to mark articles as expirable by hand.  Gnus provides
13705 two features, called `auto-expire' and `total-expire', that can help you
13706 with this.  In a nutshell, `auto-expire' means that Gnus hits @kbd{E}
13707 for you when you select an article.  And `total-expire' means that Gnus
13708 considers all articles as expirable that are read.  So, in addition to
13709 the articles marked @samp{E}, also the articles marked @samp{r},
13710 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
13711 expirable.
13712
13713 When should either auto-expire or total-expire be used?  Most people
13714 who are subscribed to mailing lists split each list into its own group
13715 and then turn on auto-expire or total-expire for those groups.
13716 (@xref{Splitting Mail}, for more information on splitting each list
13717 into its own group.)
13718
13719 Which one is better, auto-expire or total-expire?  It's not easy to
13720 answer.  Generally speaking, auto-expire is probably faster.  Another
13721 advantage of auto-expire is that you get more marks to work with: for
13722 the articles that are supposed to stick around, you can still choose
13723 between tick and dormant and read marks.  But with total-expire, you
13724 only have dormant and ticked to choose from.  The advantage of
13725 total-expire is that it works well with adaptive scoring @pxref{Adaptive
13726 Scoring}.  Auto-expire works with normal scoring but not with adaptive
13727 scoring.
13728
13729 @vindex gnus-auto-expirable-newsgroups
13730 Groups that match the regular expression
13731 @code{gnus-auto-expirable-newsgroups} will have all articles that you
13732 read marked as expirable automatically.  All articles marked as
13733 expirable have an @samp{E} in the first column in the summary buffer.
13734
13735 By default, if you have auto expiry switched on, Gnus will mark all the
13736 articles you read as expirable, no matter if they were read or unread
13737 before.  To avoid having articles marked as read marked as expirable
13738 automatically, you can put something like the following in your
13739 @file{.gnus} file:
13740
13741 @vindex gnus-mark-article-hook
13742 @lisp
13743 (remove-hook 'gnus-mark-article-hook
13744              'gnus-summary-mark-read-and-unread-as-read)
13745 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
13746 @end lisp
13747
13748 Note that making a group auto-expirable doesn't mean that all read
13749 articles are expired---only the articles marked as expirable
13750 will be expired.  Also note that using the @kbd{d} command won't make
13751 articles expirable---only semi-automatic marking of articles as read will
13752 mark the articles as expirable in auto-expirable groups.
13753
13754 Let's say you subscribe to a couple of mailing lists, and you want the
13755 articles you have read to disappear after a while:
13756
13757 @lisp
13758 (setq gnus-auto-expirable-newsgroups
13759       "mail.nonsense-list\\|mail.nice-list")
13760 @end lisp
13761
13762 Another way to have auto-expiry happen is to have the element
13763 @code{auto-expire} in the group parameters of the group.
13764
13765 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
13766 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
13767 don't really mix very well.
13768
13769 @vindex nnmail-expiry-wait
13770 The @code{nnmail-expiry-wait} variable supplies the default time an
13771 expirable article has to live.  Gnus starts counting days from when the
13772 message @emph{arrived}, not from when it was sent.  The default is seven
13773 days.
13774
13775 Gnus also supplies a function that lets you fine-tune how long articles
13776 are to live, based on what group they are in.  Let's say you want to
13777 have one month expiry period in the @samp{mail.private} group, a one day
13778 expiry period in the @samp{mail.junk} group, and a six day expiry period
13779 everywhere else:
13780
13781 @vindex nnmail-expiry-wait-function
13782 @lisp
13783 (setq nnmail-expiry-wait-function
13784       (lambda (group)
13785        (cond ((string= group "mail.private")
13786                31)
13787              ((string= group "mail.junk")
13788                1)
13789              ((string= group "important")
13790                'never)
13791              (t
13792                6))))
13793 @end lisp
13794
13795 The group names this function is fed are ``unadorned'' group
13796 names---no @samp{nnml:} prefixes and the like.
13797
13798 The @code{nnmail-expiry-wait} variable and
13799 @code{nnmail-expiry-wait-function} function can either be a number (not
13800 necessarily an integer) or one of the symbols @code{immediate} or
13801 @code{never}.
13802
13803 You can also use the @code{expiry-wait} group parameter to selectively
13804 change the expiry period (@pxref{Group Parameters}).
13805
13806 @vindex nnmail-expiry-target
13807 The normal action taken when expiring articles is to delete them.
13808 However, in some circumstances it might make more sense to move them
13809 to other groups instead of deleting them.  The variable
13810 @code{nnmail-expiry-target} (and the @code{expiry-target} group
13811 parameter) controls this.  The variable supplies a default value for
13812 all groups, which can be overridden for specific groups by the group
13813 parameter.  default value is @code{delete}, but this can also be a
13814 string (which should be the name of the group the message should be
13815 moved to), or a function (which will be called in a buffer narrowed to
13816 the message in question, and with the name of the group being moved
13817 from as its parameter) which should return a target -- either a group
13818 name or @code{delete}.
13819
13820 Here's an example for specifying a group name:
13821 @lisp
13822 (setq nnmail-expiry-target "nnml:expired")
13823 @end lisp
13824
13825 @findex nnmail-fancy-expiry-target
13826 @vindex nnmail-fancy-expiry-targets
13827 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
13828 expire mail to groups according to the variable
13829 @code{nnmail-fancy-expiry-targets}.  Here's an example:
13830
13831 @lisp
13832  (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
13833        nnmail-fancy-expiry-targets
13834        '((to-from "boss" "nnfolder:Work")
13835          ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
13836          ("from" ".*" "nnfolder:Archive-%Y")))
13837 @end lisp
13838
13839 With this setup, any mail that has @code{IMPORTANT} in its Subject
13840 header and was sent in the year @code{YYYY} and month @code{MMM}, will
13841 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
13842 From or To header contains the string @code{boss}, it will get expired
13843 to @code{nnfolder:Work}. All other mail will get expired to
13844 @code{nnfolder:Archive-YYYY}.
13845
13846 @vindex nnmail-keep-last-article
13847 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
13848 expire the final article in a mail newsgroup.  This is to make life
13849 easier for procmail users.
13850
13851 @vindex gnus-total-expirable-newsgroups
13852 By the way: That line up there, about Gnus never expiring non-expirable
13853 articles, is a lie.  If you put @code{total-expire} in the group
13854 parameters, articles will not be marked as expirable, but all read
13855 articles will be put through the expiry process.  Use with extreme
13856 caution.  Even more dangerous is the
13857 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
13858 this regexp will have all read articles put through the expiry process,
13859 which means that @emph{all} old mail articles in the groups in question
13860 will be deleted after a while.  Use with extreme caution, and don't come
13861 crying to me when you discover that the regexp you used matched the
13862 wrong group and all your important mail has disappeared.  Be a
13863 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
13864 with!  So there!
13865
13866 Most people make most of their mail groups total-expirable, though.
13867
13868 @vindex gnus-inhibit-user-auto-expire
13869 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
13870 commands will not mark an article as expirable, even if the group has
13871 auto-expire turned on.
13872
13873
13874 @node Washing Mail
13875 @subsection Washing Mail
13876 @cindex mail washing
13877 @cindex list server brain damage
13878 @cindex incoming mail treatment
13879
13880 Mailers and list servers are notorious for doing all sorts of really,
13881 really stupid things with mail.  ``Hey, RFC 822 doesn't explicitly
13882 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
13883 end of all lines passing through our server, so let's do that!!!!1!''
13884 Yes, but RFC 822 wasn't designed to be read by morons.  Things that were
13885 considered to be self-evident were not discussed.  So.  Here we are.
13886
13887 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
13888 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
13889 be shocked and dismayed by this, but I haven't got the energy.  It is to
13890 laugh.
13891
13892 Gnus provides a plethora of functions for washing articles while
13893 displaying them, but it might be nicer to do the filtering before
13894 storing the mail to disk.  For that purpose, we have three hooks and
13895 various functions that can be put in these hooks.
13896
13897 @table @code
13898 @item nnmail-prepare-incoming-hook
13899 @vindex nnmail-prepare-incoming-hook
13900 This hook is called before doing anything with the mail and is meant for
13901 grand, sweeping gestures.  It is called in a buffer that contains all
13902 the new, incoming mail.  Functions to be used include:
13903
13904 @table @code
13905 @item nnheader-ms-strip-cr
13906 @findex nnheader-ms-strip-cr
13907 Remove trailing carriage returns from each line.  This is default on
13908 Emacs running on MS machines.
13909
13910 @end table
13911
13912 @item nnmail-prepare-incoming-header-hook
13913 @vindex nnmail-prepare-incoming-header-hook
13914 This hook is called narrowed to each header.  It can be used when
13915 cleaning up the headers.  Functions that can be used include:
13916
13917 @table @code
13918 @item nnmail-remove-leading-whitespace
13919 @findex nnmail-remove-leading-whitespace
13920 Clear leading white space that ``helpful'' listservs have added to the
13921 headers to make them look nice.  Aaah.
13922
13923 (Note that this function works on both the header on the body of all
13924 messages, so it is a potentially dangerous function to use (if a body
13925 of a message contains something that looks like a header line).  So
13926 rather than fix the bug, it is of course the right solution to make it
13927 into a feature by documenting it.)
13928
13929 @item nnmail-remove-list-identifiers
13930 @findex nnmail-remove-list-identifiers
13931 Some list servers add an identifier---for example, @samp{(idm)}---to the
13932 beginning of all @code{Subject} headers.  I'm sure that's nice for
13933 people who use stone age mail readers.  This function will remove
13934 strings that match the @code{nnmail-list-identifiers} regexp, which can
13935 also be a list of regexp.  @code{nnmail-list-identifiers} may not contain
13936 @code{\\(..\\)}.
13937
13938 For instance, if you want to remove the @samp{(idm)} and the
13939 @samp{nagnagnag} identifiers:
13940
13941 @lisp
13942 (setq nnmail-list-identifiers
13943       '("(idm)" "nagnagnag"))
13944 @end lisp
13945
13946 This can also be done non-destructively with
13947 @code{gnus-list-identifiers}, @xref{Article Hiding}.
13948
13949 @item nnmail-remove-tabs
13950 @findex nnmail-remove-tabs
13951 Translate all @samp{TAB} characters into @samp{SPACE} characters.
13952
13953 @item nnmail-fix-eudora-headers
13954 @findex nnmail-fix-eudora-headers
13955 @cindex Eudora
13956 Eudora produces broken @code{References} headers, but OK
13957 @code{In-Reply-To} headers.  This function will get rid of the
13958 @code{References} headers.
13959
13960 @end table
13961
13962 @item nnmail-prepare-incoming-message-hook
13963 @vindex nnmail-prepare-incoming-message-hook
13964 This hook is called narrowed to each message.  Functions to be used
13965 include:
13966
13967 @table @code
13968 @item article-de-quoted-unreadable
13969 @findex article-de-quoted-unreadable
13970 Decode Quoted Readable encoding.
13971
13972 @end table
13973 @end table
13974
13975
13976 @node Duplicates
13977 @subsection Duplicates
13978
13979 @vindex nnmail-treat-duplicates
13980 @vindex nnmail-message-id-cache-length
13981 @vindex nnmail-message-id-cache-file
13982 @cindex duplicate mails
13983 If you are a member of a couple of mailing lists, you will sometimes
13984 receive two copies of the same mail.  This can be quite annoying, so
13985 @code{nnmail} checks for and treats any duplicates it might find.  To do
13986 this, it keeps a cache of old @code{Message-ID}s---
13987 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
13988 default.  The approximate maximum number of @code{Message-ID}s stored
13989 there is controlled by the @code{nnmail-message-id-cache-length}
13990 variable, which is 1000 by default.  (So 1000 @code{Message-ID}s will be
13991 stored.) If all this sounds scary to you, you can set
13992 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
13993 default), and @code{nnmail} won't delete duplicate mails.  Instead it
13994 will insert a warning into the head of the mail saying that it thinks
13995 that this is a duplicate of a different message.
13996
13997 This variable can also be a function.  If that's the case, the function
13998 will be called from a buffer narrowed to the message in question with
13999 the @code{Message-ID} as a parameter.  The function must return either
14000 @code{nil}, @code{warn}, or @code{delete}.
14001
14002 You can turn this feature off completely by setting the variable to
14003 @code{nil}.
14004
14005 If you want all the duplicate mails to be put into a special
14006 @dfn{duplicates} group, you could do that using the normal mail split
14007 methods:
14008
14009 @lisp
14010 (setq nnmail-split-fancy
14011       '(| ;; Messages duplicates go to a separate group.
14012           ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
14013           ;; Message from daemons, postmaster, and the like to another.
14014           (any mail "mail.misc")
14015           ;; Other rules.
14016           [ ... ] ))
14017 @end lisp
14018
14019 Or something like:
14020 @lisp
14021 (setq nnmail-split-methods
14022       '(("duplicates" "^Gnus-Warning:.*duplicate")
14023         ;; Other rules.
14024         [...]))
14025 @end lisp
14026
14027 Here's a neat feature: If you know that the recipient reads her mail
14028 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
14029 @code{delete}, you can send her as many insults as you like, just by
14030 using a @code{Message-ID} of a mail that you know that she's already
14031 received.  Think of all the fun!  She'll never see any of it!  Whee!
14032
14033
14034 @node Not Reading Mail
14035 @subsection Not Reading Mail
14036
14037 If you start using any of the mail back ends, they have the annoying
14038 habit of assuming that you want to read mail with them.  This might not
14039 be unreasonable, but it might not be what you want.
14040
14041 If you set @code{mail-sources} and @code{nnmail-spool-file} to
14042 @code{nil}, none of the back ends will ever attempt to read incoming
14043 mail, which should help.
14044
14045 @vindex nnbabyl-get-new-mail
14046 @vindex nnmbox-get-new-mail
14047 @vindex nnml-get-new-mail
14048 @vindex nnmh-get-new-mail
14049 @vindex nnfolder-get-new-mail
14050 This might be too much, if, for instance, you are reading mail quite
14051 happily with @code{nnml} and just want to peek at some old @sc{rmail}
14052 file you have stashed away with @code{nnbabyl}.  All back ends have
14053 variables called back-end-@code{get-new-mail}.  If you want to disable
14054 the @code{nnbabyl} mail reading, you edit the virtual server for the
14055 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
14056
14057 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
14058 narrowed to the article to be saved before saving it when reading
14059 incoming mail.
14060
14061
14062 @node Choosing a Mail Back End
14063 @subsection Choosing a Mail Back End
14064
14065 Gnus will read the mail spool when you activate a mail group.  The mail
14066 file is first copied to your home directory.  What happens after that
14067 depends on what format you want to store your mail in.
14068
14069 There are six different mail back ends in the standard Gnus, and more
14070 back ends are available separately.  The mail back end most people use
14071 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
14072 Spool}).  You might notice that only five back ends are listed below;
14073 @code{nnmaildir}'s documentation has not yet been completely
14074 incorporated into this manual.  Until it is, you can find it at
14075 @uref{http://multivac.cwru.edu./nnmaildir/}.
14076
14077 @menu
14078 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
14079 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
14080 * Mail Spool::                  Store your mail in a private spool?
14081 * MH Spool::                    An mhspool-like back end.
14082 * Mail Folders::                Having one file for each group.
14083 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
14084 @end menu
14085
14086
14087 @node Unix Mail Box
14088 @subsubsection Unix Mail Box
14089 @cindex nnmbox
14090 @cindex unix mail box
14091
14092 @vindex nnmbox-active-file
14093 @vindex nnmbox-mbox-file
14094 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
14095 mail.  @code{nnmbox} will add extra headers to each mail article to say
14096 which group it belongs in.
14097
14098 Virtual server settings:
14099
14100 @table @code
14101 @item nnmbox-mbox-file
14102 @vindex nnmbox-mbox-file
14103 The name of the mail box in the user's home directory.  Default is
14104 @file{~/mbox}.
14105
14106 @item nnmbox-active-file
14107 @vindex nnmbox-active-file
14108 The name of the active file for the mail box.  Default is
14109 @file{~/.mbox-active}.
14110
14111 @item nnmbox-get-new-mail
14112 @vindex nnmbox-get-new-mail
14113 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
14114 into groups.  Default is @code{t}.
14115 @end table
14116
14117
14118 @node Rmail Babyl
14119 @subsubsection Rmail Babyl
14120 @cindex nnbabyl
14121 @cindex rmail mbox
14122
14123 @vindex nnbabyl-active-file
14124 @vindex nnbabyl-mbox-file
14125 The @dfn{nnbabyl} back end will use a babyl mail box (aka. @dfn{rmail
14126 mbox}) to store mail.  @code{nnbabyl} will add extra headers to each
14127 mail article to say which group it belongs in.
14128
14129 Virtual server settings:
14130
14131 @table @code
14132 @item nnbabyl-mbox-file
14133 @vindex nnbabyl-mbox-file
14134 The name of the rmail mbox file.  The default is @file{~/RMAIL}
14135
14136 @item nnbabyl-active-file
14137 @vindex nnbabyl-active-file
14138 The name of the active file for the rmail box.  The default is
14139 @file{~/.rmail-active}
14140
14141 @item nnbabyl-get-new-mail
14142 @vindex nnbabyl-get-new-mail
14143 If non-@code{nil}, @code{nnbabyl} will read incoming mail.  Default is
14144 @code{t}
14145 @end table
14146
14147
14148 @node Mail Spool
14149 @subsubsection Mail Spool
14150 @cindex nnml
14151 @cindex mail @sc{nov} spool
14152
14153 The @dfn{nnml} spool mail format isn't compatible with any other known
14154 format.  It should be used with some caution.
14155
14156 @vindex nnml-directory
14157 If you use this back end, Gnus will split all incoming mail into files,
14158 one file for each mail, and put the articles into the corresponding
14159 directories under the directory specified by the @code{nnml-directory}
14160 variable.  The default value is @file{~/Mail/}.
14161
14162 You do not have to create any directories beforehand; Gnus will take
14163 care of all that.
14164
14165 If you have a strict limit as to how many files you are allowed to store
14166 in your account, you should not use this back end.  As each mail gets its
14167 own file, you might very well occupy thousands of inodes within a few
14168 weeks.  If this is no problem for you, and it isn't a problem for you
14169 having your friendly systems administrator walking around, madly,
14170 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
14171 know that this is probably the fastest format to use.  You do not have
14172 to trudge through a big mbox file just to read your new mail.
14173
14174 @code{nnml} is probably the slowest back end when it comes to article
14175 splitting.  It has to create lots of files, and it also generates
14176 @sc{nov} databases for the incoming mails.  This makes it possibly the
14177 fastest back end when it comes to reading mail.
14178
14179 @cindex self contained nnml servers
14180 @cindex marks
14181 When the marks file is used (which it is by default), @code{nnml}
14182 servers have the property that you may backup them using @code{tar} or
14183 similar, and later be able to restore them into Gnus (by adding the
14184 proper @code{nnml} server) and have all your marks be preserved.  Marks
14185 for a group is usually stored in the @code{.marks} file (but see
14186 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
14187 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
14188 to restore the group (after restoring the backup into the nnml
14189 directory).
14190
14191 If for some reason you believe your @file{.marks} files are screwed
14192 up, you can just delete them all.  Gnus will then correctly regenerate
14193 them next time it starts.
14194
14195 Virtual server settings:
14196
14197 @table @code
14198 @item nnml-directory
14199 @vindex nnml-directory
14200 All @code{nnml} directories will be placed under this directory.
14201 The default is the value of `message-directory' (whose default value is
14202 @file{~/Mail}).
14203
14204 @item nnml-active-file
14205 @vindex nnml-active-file
14206 The active file for the @code{nnml} server.  The default is
14207 @file{~/Mail/active"}.
14208
14209 @item nnml-newsgroups-file
14210 @vindex nnml-newsgroups-file
14211 The @code{nnml} group descriptions file.  @xref{Newsgroups File
14212 Format}.  The default is @file{~/Mail/newsgroups"}.
14213
14214 @item nnml-get-new-mail
14215 @vindex nnml-get-new-mail
14216 If non-@code{nil}, @code{nnml} will read incoming mail.  The default is
14217 @code{t}.
14218
14219 @item nnml-nov-is-evil
14220 @vindex nnml-nov-is-evil
14221 If non-@code{nil}, this back end will ignore any @sc{nov} files.  The
14222 default is @code{nil}.
14223
14224 @item nnml-nov-file-name
14225 @vindex nnml-nov-file-name
14226 The name of the @sc{nov} files.  The default is @file{.overview}.
14227
14228 @item nnml-prepare-save-mail-hook
14229 @vindex nnml-prepare-save-mail-hook
14230 Hook run narrowed to an article before saving.
14231
14232 @item nnml-marks-is-evil
14233 @vindex nnml-marks-is-evil
14234 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
14235 default is @code{nil}.
14236
14237 @item nnml-marks-file-name
14238 @vindex nnml-marks-file-name
14239 The name of the @dfn{marks} files.  The default is @file{.marks}.
14240
14241 @item nnml-use-compressed-files
14242 @vindex nnml-use-compressed-files
14243 If non-@code{nil}, @code{nnml} will allow using compressed message
14244 files.
14245
14246 @end table
14247
14248 @findex nnml-generate-nov-databases
14249 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
14250 you can do a complete update by typing @kbd{M-x
14251 nnml-generate-nov-databases}.  This command will trawl through the
14252 entire @code{nnml} hierarchy, looking at each and every article, so it
14253 might take a while to complete.  A better interface to this
14254 functionality can be found in the server buffer (@pxref{Server
14255 Commands}).
14256
14257
14258 @node MH Spool
14259 @subsubsection MH Spool
14260 @cindex nnmh
14261 @cindex mh-e mail spool
14262
14263 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
14264 @sc{nov} databases and it doesn't keep an active file or marks file.
14265 This makes @code{nnmh} a @emph{much} slower back end than @code{nnml},
14266 but it also makes it easier to write procmail scripts for.
14267
14268 Virtual server settings:
14269
14270 @table @code
14271 @item nnmh-directory
14272 @vindex nnmh-directory
14273 All @code{nnmh} directories will be located under this directory.  The
14274 default is the value of @code{message-directory} (whose default is
14275 @file{~/Mail})
14276
14277 @item nnmh-get-new-mail
14278 @vindex nnmh-get-new-mail
14279 If non-@code{nil}, @code{nnmh} will read incoming mail.  The default is
14280 @code{t}.
14281
14282 @item nnmh-be-safe
14283 @vindex nnmh-be-safe
14284 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
14285 sure that the articles in the folder are actually what Gnus thinks they
14286 are.  It will check date stamps and stat everything in sight, so
14287 setting this to @code{t} will mean a serious slow-down.  If you never
14288 use anything but Gnus to read the @code{nnmh} articles, you do not have
14289 to set this variable to @code{t}.  The default is @code{nil}.
14290 @end table
14291
14292
14293 @node Mail Folders
14294 @subsubsection Mail Folders
14295 @cindex nnfolder
14296 @cindex mbox folders
14297 @cindex mail folders
14298
14299 @code{nnfolder} is a back end for storing each mail group in a separate
14300 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
14301 will add extra headers to keep track of article numbers and arrival
14302 dates.
14303
14304 @cindex self contained nnfolder servers
14305 @cindex marks
14306 When the marks file is used (which it is by default), @code{nnfolder}
14307 servers have the property that you may backup them using @code{tar} or
14308 similar, and later be able to restore them into Gnus (by adding the
14309 proper @code{nnfolder} server) and have all your marks be preserved.
14310 Marks for a group is usually stored in a file named as the mbox file
14311 with @code{.mrk} concatenated to it (but see
14312 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder} directory.
14313 Individual @code{nnfolder} groups are also possible to backup, use
14314 @kbd{G m} to restore the group (after restoring the backup into the
14315 @code{nnfolder} directory).
14316
14317 Virtual server settings:
14318
14319 @table @code
14320 @item nnfolder-directory
14321 @vindex nnfolder-directory
14322 All the @code{nnfolder} mail boxes will be stored under this directory.
14323 The default is the value of @code{message-directory} (whose default is
14324 @file{~/Mail})
14325
14326 @item nnfolder-active-file
14327 @vindex nnfolder-active-file
14328 The name of the active file.  The default is @file{~/Mail/active}.
14329
14330 @item nnfolder-newsgroups-file
14331 @vindex nnfolder-newsgroups-file
14332 The name of the group descriptions file.  @xref{Newsgroups File
14333 Format}.  The default is @file{~/Mail/newsgroups"}
14334
14335 @item nnfolder-get-new-mail
14336 @vindex nnfolder-get-new-mail
14337 If non-@code{nil}, @code{nnfolder} will read incoming mail.  The default
14338 is @code{t}
14339
14340 @item nnfolder-save-buffer-hook
14341 @vindex nnfolder-save-buffer-hook
14342 @cindex backup files
14343 Hook run before saving the folders.  Note that Emacs does the normal
14344 backup renaming of files even with the @code{nnfolder} buffers.  If you
14345 wish to switch this off, you could say something like the following in
14346 your @file{.emacs} file:
14347
14348 @lisp
14349 (defun turn-off-backup ()
14350   (set (make-local-variable 'backup-inhibited) t))
14351
14352 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
14353 @end lisp
14354
14355 @item nnfolder-delete-mail-hook
14356 @vindex nnfolder-delete-mail-hook
14357 Hook run in a buffer narrowed to the message that is to be deleted.
14358 This function can be used to copy the message to somewhere else, or to
14359 extract some information from it before removing it.
14360
14361 @item nnfolder-nov-is-evil
14362 @vindex nnfolder-nov-is-evil
14363 If non-@code{nil}, this back end will ignore any @sc{nov} files.  The
14364 default is @code{nil}.
14365
14366 @item nnfolder-nov-file-suffix
14367 @vindex nnfolder-nov-file-suffix
14368 The extension for @sc{nov} files.  The default is @file{.nov}.
14369
14370 @item nnfolder-nov-directory
14371 @vindex nnfolder-nov-directory
14372 The directory where the @sc{nov} files should be stored.  If nil,
14373 @code{nnfolder-directory} is used.
14374
14375 @item nnfolder-marks-is-evil
14376 @vindex nnfolder-marks-is-evil
14377 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
14378 default is @code{nil}.
14379
14380 @item nnfolder-marks-file-suffix
14381 @vindex nnfolder-marks-file-suffix
14382 The extension for @sc{marks} files.  The default is @file{.mrk}.
14383
14384 @item nnfolder-marks-directory
14385 @vindex nnfolder-marks-directory
14386 The directory where the @sc{marks} files should be stored.  If nil,
14387 @code{nnfolder-directory} is used.
14388
14389 @end table
14390
14391
14392 @findex nnfolder-generate-active-file
14393 @kindex M-x nnfolder-generate-active-file
14394 If you have lots of @code{nnfolder}-like files you'd like to read with
14395 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
14396 command to make @code{nnfolder} aware of all likely files in
14397 @code{nnfolder-directory}.  This only works if you use long file names,
14398 though.
14399
14400 @node Comparing Mail Back Ends
14401 @subsubsection Comparing Mail Back Ends
14402
14403 First, just for terminology, the @dfn{back end} is the common word for a
14404 low-level access method---a transport, if you will, by which something
14405 is acquired.  The sense is that one's mail has to come from somewhere,
14406 and so selection of a suitable back end is required in order to get that
14407 mail within spitting distance of Gnus.
14408
14409 The same concept exists for Usenet itself: Though access to articles is
14410 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
14411 in the world got at Usenet by running a reader on the machine where the
14412 articles lay (the machine which today we call an @sc{nntp} server), and
14413 access was by the reader stepping into the articles' directory spool
14414 area directly.  One can still select between either the @code{nntp} or
14415 @code{nnspool} back ends, to select between these methods, if one happens
14416 actually to live on the server (or can see its spool directly, anyway,
14417 via NFS).
14418
14419 The goal in selecting a mail back end is to pick one which
14420 simultaneously represents a suitable way of dealing with the original
14421 format plus leaving mail in a form that is convenient to use in the
14422 future.  Here are some high and low points on each:
14423
14424 @table @code
14425 @item nnmbox
14426
14427 UNIX systems have historically had a single, very common, and well-
14428 defined format.  All messages arrive in a single @dfn{spool file}, and
14429 they are delineated by a line whose regular expression matches
14430 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
14431 to make it clear in this instance that this is not the RFC-specified
14432 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
14433 historically from the Unix environment, it is simplest if one does not
14434 mess a great deal with the original mailbox format, so if one chooses
14435 this back end, Gnus' primary activity in getting mail from the real spool
14436 area to Gnus' preferred directory is simply to copy it, with no
14437 (appreciable) format change in the process.  It is the ``dumbest'' way
14438 to move mail into availability in the Gnus environment.  This makes it
14439 fast to move into place, but slow to parse, when Gnus has to look at
14440 what's where.
14441
14442 @item nnbabyl
14443
14444 Once upon a time, there was the DEC-10 and DEC-20, running operating
14445 systems called TOPS and related things, and the usual (only?) mail
14446 reading environment was a thing called Babyl.  I don't know what format
14447 was used for mail landing on the system, but Babyl had its own internal
14448 format to which mail was converted, primarily involving creating a
14449 spool-file-like entity with a scheme for inserting Babyl-specific
14450 headers and status bits above the top of each message in the file.
14451 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
14452 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
14453 to understand the mail files folks already had in existence.  Gnus (and
14454 VM, for that matter) continue to support this format because it's
14455 perceived as having some good qualities in those mailer-specific
14456 headers/status bits stuff.  RMAIL itself still exists as well, of
14457 course, and is still maintained by Stallman.
14458
14459 Both of the above forms leave your mail in a single file on your
14460 file system, and they must parse that entire file each time you take a
14461 look at your mail.
14462
14463 @item nnml
14464
14465 @code{nnml} is the back end which smells the most as though you were
14466 actually operating with an @code{nnspool}-accessed Usenet system.  (In
14467 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
14468 lo these years ago.)  One's mail is taken from the original spool file,
14469 and is then cut up into individual message files, 1:1.  It maintains a
14470 Usenet-style active file (analogous to what one finds in an INN- or
14471 CNews-based news system in (for instance) @file{/var/lib/news/active},
14472 or what is returned via the @samp{NNTP LIST} verb) and also creates
14473 @dfn{overview} files for efficient group entry, as has been defined for
14474 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
14475 due to the creation of lots of files, updates to the @code{nnml} active
14476 file, and additions to overview files on a per-message basis, but it is
14477 extremely fast on access because of what amounts to the indexing support
14478 provided by the active file and overviews.
14479
14480 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
14481 resource which defines available places in the file system to put new
14482 files.  Sysadmins take a dim view of heavy inode occupation within
14483 tight, shared file systems.  But if you live on a personal machine where
14484 the file system is your own and space is not at a premium, @code{nnml}
14485 wins big.
14486
14487 It is also problematic using this back end if you are living in a
14488 FAT16-based Windows world, since much space will be wasted on all these
14489 tiny files.
14490
14491 @item nnmh
14492
14493 The Rand MH mail-reading system has been around UNIX systems for a very
14494 long time; it operates by splitting one's spool file of messages into
14495 individual files, but with little or no indexing support -- @code{nnmh}
14496 is considered to be semantically equivalent to ``@code{nnml} without
14497 active file or overviews''.  This is arguably the worst choice, because
14498 one gets the slowness of individual file creation married to the
14499 slowness of access parsing when learning what's new in one's groups.
14500
14501 @item nnfolder
14502
14503 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
14504 method described above) on a per-group basis.  That is, @code{nnmbox}
14505 itself puts *all* one's mail in one file; @code{nnfolder} provides a
14506 little bit of optimization to this so that each of one's mail groups has
14507 a Unix mail box file.  It's faster than @code{nnmbox} because each group
14508 can be parsed separately, and still provides the simple Unix mail box
14509 format requiring minimal effort in moving the mail around.  In addition,
14510 it maintains an ``active'' file making it much faster for Gnus to figure
14511 out how many messages there are in each separate group.
14512
14513 If you have groups that are expected to have a massive amount of
14514 messages, @code{nnfolder} is not the best choice, but if you receive
14515 only a moderate amount of mail, @code{nnfolder} is probably the most
14516 friendly mail back end all over.
14517
14518 @item nnmaildir
14519
14520 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
14521 differences.  Each message is stored in a separate file, but the
14522 filename is unrelated to the article number in Gnus.  @code{nnmaildir}
14523 also stores the equivalent of @code{nnml}'s overview files in one file
14524 per article, so it uses about twice as many inodes as @code{nnml}.  (Use
14525 @code{df -i} to see how plentiful your inode supply is.)  If this slows
14526 you down or takes up very much space, consider switching to ReiserFS
14527 (@uref{http://www.namesys.com/}) or another non-block-structured
14528 file system.
14529
14530 Since maildirs don't require locking for delivery, the maildirs you use
14531 as groups can also be the maildirs your mail is directly delivered to.
14532 This means you can skip Gnus's mail splitting if your mail is already
14533 organized into different mailboxes during delivery.  A @code{directory}
14534 entry in @code{mail-sources} would have a similar effect, but would
14535 require one set of mailboxes for spooling deliveries (in mbox format,
14536 thus damaging message bodies), and another set to be used as groups (in
14537 whatever format you like).  A maildir has a built-in spool, in the
14538 @code{new/} subdirectory.  Beware that currently, mail moved from
14539 @code{new/} to @code{cur/} instead of via mail splitting will undergo
14540 treatment such as duplicate checking.
14541
14542 An article will not necessarily keep the same number across Gnus
14543 sessions; articles are renumbered starting from 1 for each Gnus session
14544 (more precisely, each time you open the @code{nnmaildir} server).  This
14545 way, you don't get gaps in your article number ranges, and when entering
14546 large groups, Gnus is likely to give a more accurate article count.  The
14547 price is that @code{nnmaildir} doesn't work with the cache or agent.
14548 This will probably be changed in the future.
14549
14550 @code{nnmaildir} stores article marks for a given group in the
14551 corresponding maildir, in a way designed so that it's easy to manipulate
14552 them from outside Gnus.  You can tar up a maildir, unpack it somewhere
14553 else, and still have your marks.  @code{nnml} also stores marks, but
14554 it's not as easy to work with them from outside Gnus as with
14555 @code{nnmaildir}.
14556
14557 For configuring expiry and other things, @code{nnmaildir} uses group
14558 parameters slightly different from those of other mail back ends.
14559
14560 @code{nnmaildir} uses a significant amount of memory to speed things up.
14561 (It keeps in memory some of the things that @code{nnml} stores in files
14562 and that @code{nnmh} repeatedly parses out of message files.)  If this
14563 is a problem for you, you can set the @code{nov-cache-size} group
14564 parameter to something small (0 would probably not work, but 1 probably
14565 would) to make it use less memory.
14566
14567 Startup and shutdown are likely to be slower with @code{nnmaildir} than
14568 with other back ends.  Everything in between is likely to be faster,
14569 depending in part on your file system.
14570
14571 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
14572 to write an @code{nnmaildir}-derived back end.
14573
14574 @end table
14575
14576
14577 @node Browsing the Web
14578 @section Browsing the Web
14579 @cindex web
14580 @cindex browsing the web
14581 @cindex www
14582 @cindex http
14583
14584 Web-based discussion forums are getting more and more popular.  On many
14585 subjects, the web-based forums have become the most important forums,
14586 eclipsing the importance of mailing lists and news groups.  The reason
14587 is easy to understand---they are friendly to new users; you just point
14588 and click, and there's the discussion.  With mailing lists, you have to
14589 go through a cumbersome subscription procedure, and most people don't
14590 even know what a news group is.
14591
14592 The problem with this scenario is that web browsers are not very good at
14593 being newsreaders.  They do not keep track of what articles you've read;
14594 they do not allow you to score on subjects you're interested in; they do
14595 not allow off-line browsing; they require you to click around and drive
14596 you mad in the end.
14597
14598 So---if web browsers suck at reading discussion forums, why not use Gnus
14599 to do it instead?
14600
14601 Gnus has been getting a bit of a collection of back ends for providing
14602 interfaces to these sources.
14603
14604 @menu
14605 * Archiving Mail::              
14606 * Web Searches::                Creating groups from articles that match a string.
14607 * Slashdot::                    Reading the Slashdot comments.
14608 * Ultimate::                    The Ultimate Bulletin Board systems.
14609 * Web Archive::                 Reading mailing list archived on web.
14610 * RSS::                         Reading RDF site summary.
14611 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
14612 @end menu
14613
14614 All the web sources require Emacs/w3 and the url library to work.
14615
14616 The main caveat with all these web sources is that they probably won't
14617 work for a very long time.  Gleaning information from the @sc{html} data
14618 is guesswork at best, and when the layout is altered, the Gnus back end
14619 will fail.  If you have reasonably new versions of these back ends,
14620 though, you should be ok.
14621
14622 One thing all these Web methods have in common is that the Web sources
14623 are often down, unavailable or just plain too slow to be fun.  In those
14624 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
14625 Unplugged}) handle downloading articles, and then you can read them at
14626 leisure from your local disk.  No more World Wide Wait for you.
14627
14628 @node Archiving Mail
14629 @subsection Archiving Mail
14630 @cindex archiving mail
14631 @cindex backup of mail
14632
14633 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
14634 @code{nnmaildir}, now actually store the article marks with each group.
14635 For these servers, archiving and restoring a group while preserving
14636 marks is fairly simple.
14637
14638 (Preserving the group level and group parameters as well still
14639 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
14640 though.)
14641
14642 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
14643 server, take a recursive copy of the server directory.  There is no need
14644 to shut down Gnus, so archiving may be invoked by @code{cron} or
14645 similar.  You restore the data by restoring the directory tree, and
14646 adding a server definition pointing to that directory in Gnus. The
14647 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
14648 might interfere with overwriting data, so you may want to shut down Gnus
14649 before you restore the data.
14650
14651 It is also possible to archive individual @code{nnml},
14652 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
14653 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
14654 directory.  For @code{nnfolder} you need to copy both the base folder
14655 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
14656 this example). Restoring the group is done with @kbd{G m} from the Group
14657 buffer.  The last step makes Gnus notice the new directory.
14658 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
14659 is unnecessary in that case.
14660
14661 @node Web Searches
14662 @subsection Web Searches
14663 @cindex nnweb
14664 @cindex Google
14665 @cindex dejanews
14666 @cindex gmane
14667 @cindex Usenet searches
14668 @cindex searching the Usenet
14669
14670 It's, like, too neat to search the Usenet for articles that match a
14671 string, but it, like, totally @emph{sucks}, like, totally, to use one of
14672 those, like, Web browsers, and you, like, have to, rilly, like, look at
14673 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
14674 searches without having to use a browser.
14675
14676 The @code{nnweb} back end allows an easy interface to the mighty search
14677 engine.  You create an @code{nnweb} group, enter a search pattern, and
14678 then enter the group and read the articles like you would any normal
14679 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
14680 Groups}) will do this in an easy-to-use fashion.
14681
14682 @code{nnweb} groups don't really lend themselves to being solid
14683 groups---they have a very fleeting idea of article numbers.  In fact,
14684 each time you enter an @code{nnweb} group (not even changing the search
14685 pattern), you are likely to get the articles ordered in a different
14686 manner.  Not even using duplicate suppression (@pxref{Duplicate
14687 Suppression}) will help, since @code{nnweb} doesn't even know the
14688 @code{Message-ID} of the articles before reading them using some search
14689 engines (Google, for instance).  The only possible way to keep track
14690 of which articles you've read is by scoring on the @code{Date}
14691 header---mark all articles posted before the last date you read the
14692 group as read.
14693
14694 If the search engine changes its output substantially, @code{nnweb}
14695 won't be able to parse it and will fail.  One could hardly fault the Web
14696 providers if they were to do this---their @emph{raison d'être} is to
14697 make money off of advertisements, not to provide services to the
14698 community.  Since @code{nnweb} washes the ads off all the articles, one
14699 might think that the providers might be somewhat miffed.  We'll see.
14700
14701 You must have the @code{url} and @code{w3} package installed to be able
14702 to use @code{nnweb}.
14703
14704 Virtual server variables:
14705
14706 @table @code
14707 @item nnweb-type
14708 @vindex nnweb-type
14709 What search engine type is being used.  The currently supported types
14710 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
14711 @code{dejanews} is an alias to @code{google}.
14712
14713 @item nnweb-search
14714 @vindex nnweb-search
14715 The search string to feed to the search engine.
14716
14717 @item nnweb-max-hits
14718 @vindex nnweb-max-hits
14719 Advisory maximum number of hits per search to display.  The default is
14720 999.
14721
14722 @item nnweb-type-definition
14723 @vindex nnweb-type-definition
14724 Type-to-definition alist.  This alist says what @code{nnweb} should do
14725 with the various search engine types.  The following elements must be
14726 present:
14727
14728 @table @code
14729 @item article
14730 Function to decode the article and provide something that Gnus
14731 understands.
14732
14733 @item map
14734 Function to create an article number to message header and URL alist.
14735
14736 @item search
14737 Function to send the search string to the search engine.
14738
14739 @item address
14740 The address the aforementioned function should send the search string
14741 to.
14742
14743 @item id
14744 Format string URL to fetch an article by @code{Message-ID}.
14745 @end table
14746
14747 @end table
14748
14749
14750 @node Slashdot
14751 @subsection Slashdot
14752 @cindex Slashdot
14753 @cindex nnslashdot
14754
14755 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
14756 lively discussion following the news articles.  @code{nnslashdot} will
14757 let you read this forum in a convenient manner.
14758
14759 The easiest way to read this source is to put something like the
14760 following in your @file{.gnus.el} file:
14761
14762 @lisp
14763 (setq gnus-secondary-select-methods
14764       '((nnslashdot "")))
14765 @end lisp
14766
14767 This will make Gnus query the @code{nnslashdot} back end for new comments
14768 and groups.  The @kbd{F} command will subscribe each new news article as
14769 a new Gnus group, and you can read the comments by entering these
14770 groups.  (Note that the default subscription method is to subscribe new
14771 groups as zombies.  Other methods are available (@pxref{Subscription
14772 Methods}).
14773
14774 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
14775 command is the most handy tool (@pxref{Foreign Groups}).
14776
14777 When following up to @code{nnslashdot} comments (or posting new
14778 comments), some light @sc{html}izations will be performed.  In
14779 particular, text quoted with @samp{> } will be quoted with
14780 @code{blockquote} instead, and signatures will have @code{br} added to
14781 the end of each line.  Other than that, you can just write @sc{html}
14782 directly into the message buffer.  Note that Slashdot filters out some
14783 @sc{html} forms.
14784
14785 The following variables can be altered to change its behavior:
14786
14787 @table @code
14788 @item nnslashdot-threaded
14789 Whether @code{nnslashdot} should display threaded groups or not.  The
14790 default is @code{t}.  To be able to display threads, @code{nnslashdot}
14791 has to retrieve absolutely all comments in a group upon entry.  If a
14792 threaded display is not required, @code{nnslashdot} will only retrieve
14793 the comments that are actually wanted by the user.  Threading is nicer,
14794 but much, much slower than unthreaded.
14795
14796 @item nnslashdot-login-name
14797 @vindex nnslashdot-login-name
14798 The login name to use when posting.
14799
14800 @item nnslashdot-password
14801 @vindex nnslashdot-password
14802 The password to use when posting.
14803
14804 @item nnslashdot-directory
14805 @vindex nnslashdot-directory
14806 Where @code{nnslashdot} will store its files.  The default is
14807 @samp{~/News/slashdot/}.
14808
14809 @item nnslashdot-active-url
14810 @vindex nnslashdot-active-url
14811 The @sc{url} format string that will be used to fetch the information on
14812 news articles and comments.  The default is
14813 @samp{http://slashdot.org/search.pl?section=&min=%d}.
14814
14815 @item nnslashdot-comments-url
14816 @vindex nnslashdot-comments-url
14817 The @sc{url} format string that will be used to fetch comments.  The
14818 default is
14819 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
14820
14821 @item nnslashdot-article-url
14822 @vindex nnslashdot-article-url
14823 The @sc{url} format string that will be used to fetch the news article.  The
14824 default is
14825 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
14826
14827 @item nnslashdot-threshold
14828 @vindex nnslashdot-threshold
14829 The score threshold.  The default is -1.
14830
14831 @item nnslashdot-group-number
14832 @vindex nnslashdot-group-number
14833 The number of old groups, in addition to the ten latest, to keep
14834 updated.  The default is 0.
14835
14836 @end table
14837
14838
14839
14840 @node Ultimate
14841 @subsection Ultimate
14842 @cindex nnultimate
14843 @cindex Ultimate Bulletin Board
14844
14845 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
14846 probably the most popular Web bulletin board system used.  It has a
14847 quite regular and nice interface, and it's possible to get the
14848 information Gnus needs to keep groups updated.
14849
14850 The easiest way to get started with @code{nnultimate} is to say
14851 something like the following in the group buffer:  @kbd{B nnultimate RET
14852 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @sc{url}
14853 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
14854 you're interested in; there's quite a list of them on the Ultimate web
14855 site.)  Then subscribe to the groups you're interested in from the
14856 server buffer, and read them from the group buffer.
14857
14858 The following @code{nnultimate} variables can be altered:
14859
14860 @table @code
14861 @item nnultimate-directory
14862 @vindex nnultimate-directory
14863 The directory where @code{nnultimate} stores its files.  The default is
14864 @samp{~/News/ultimate/}.
14865 @end table
14866
14867
14868 @node Web Archive
14869 @subsection Web Archive
14870 @cindex nnwarchive
14871 @cindex Web Archive
14872
14873 Some mailing lists only have archives on Web servers, such as
14874 @uref{http://www.egroups.com/} and
14875 @uref{http://www.mail-archive.com/}.  It has a quite regular and nice
14876 interface, and it's possible to get the information Gnus needs to keep
14877 groups updated.
14878
14879 The easiest way to get started with @code{nnwarchive} is to say
14880 something like the following in the group buffer: @kbd{M-x
14881 gnus-group-make-warchive-group RET an_egroup RET egroups RET
14882 www.egroups.com RET your@@email.address RET}.  (Substitute the
14883 @sc{an_egroup} with the mailing list you subscribed, the
14884 @sc{your@@email.address} with your email address.), or to browse the
14885 back end by @kbd{B nnwarchive RET mail-archive RET}.
14886
14887 The following @code{nnwarchive} variables can be altered:
14888
14889 @table @code
14890 @item nnwarchive-directory
14891 @vindex nnwarchive-directory
14892 The directory where @code{nnwarchive} stores its files.  The default is
14893 @samp{~/News/warchive/}.
14894
14895 @item nnwarchive-login
14896 @vindex nnwarchive-login
14897 The account name on the web server.
14898
14899 @item nnwarchive-passwd
14900 @vindex nnwarchive-passwd
14901 The password for your account on the web server.
14902 @end table
14903
14904 @node RSS
14905 @subsection RSS
14906 @cindex nnrss
14907 @cindex RSS
14908
14909 Some sites have RDF site summary (RSS)
14910 @uref{http://purl.org/rss/1.0/spec}.  It has a quite regular and nice
14911 interface, and it's possible to get the information Gnus needs to keep
14912 groups updated.
14913
14914 The easiest way to get started with @code{nnrss} is to say something
14915 like the following in the group buffer: @kbd{B nnrss RET RET}, then
14916 subscribe groups.
14917
14918 The following @code{nnrss} variables can be altered:
14919
14920 @table @code
14921 @item nnrss-directory
14922 @vindex nnrss-directory
14923 The directory where @code{nnrss} stores its files.  The default is
14924 @samp{~/News/rss/}.
14925
14926 @end table
14927
14928 The following code may be helpful, if you want to show the description in
14929 the summary buffer.
14930
14931 @lisp
14932 (add-to-list 'nnmail-extra-headers nnrss-description-field)
14933 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
14934
14935 (defun gnus-user-format-function-X (header)
14936   (let ((descr
14937          (assq nnrss-description-field (mail-header-extra header))))
14938     (if descr (concat "\n\t" (cdr descr)) "")))
14939 @end lisp
14940
14941 The following code may be useful to open an nnrss url directly from the
14942 summary buffer.
14943 @lisp
14944 (require 'browse-url)
14945
14946 (defun browse-nnrss-url( arg )
14947   (interactive "p")
14948   (let ((url (assq nnrss-url-field
14949                    (mail-header-extra
14950                     (gnus-data-header
14951                      (assq (gnus-summary-article-number)
14952                            gnus-newsgroup-data))))))
14953     (if url
14954         (progn
14955           (browse-url (cdr url))
14956           (gnus-summary-mark-as-read-forward 1))
14957       (gnus-summary-scroll-up arg))))
14958
14959 (eval-after-load "gnus"
14960   #'(define-key gnus-summary-mode-map
14961       (kbd "<RET>") 'browse-nnrss-url))
14962 (add-to-list 'nnmail-extra-headers nnrss-url-field)
14963 @end lisp
14964
14965 @node Customizing w3
14966 @subsection Customizing w3
14967 @cindex w3
14968 @cindex html
14969 @cindex url
14970 @cindex Netscape
14971
14972 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
14973 pages.  Emacs/w3 is documented in its own manual, but there are some
14974 things that may be more relevant for Gnus users.
14975
14976 For instance, a common question is how to make Emacs/w3 follow links
14977 using the @code{browse-url} functions (which will call some external web
14978 browser like Netscape).  Here's one way:
14979
14980 @lisp
14981 (eval-after-load "w3"
14982   '(progn
14983     (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
14984     (defun w3-fetch (&optional url target)
14985       (interactive (list (w3-read-url-with-default)))
14986       (if (eq major-mode 'gnus-article-mode)
14987           (browse-url url)
14988         (w3-fetch-orig url target)))))
14989 @end lisp
14990
14991 Put that in your @file{.emacs} file, and hitting links in w3-rendered
14992 @sc{html} in the Gnus article buffers will use @code{browse-url} to
14993 follow the link.
14994
14995
14996 @node IMAP
14997 @section IMAP
14998 @cindex nnimap
14999 @cindex @sc{imap}
15000
15001 @sc{imap} is a network protocol for reading mail (or news, or ...),
15002 think of it as a modernized @sc{nntp}.  Connecting to a @sc{imap}
15003 server is much similar to connecting to a news server, you just
15004 specify the network address of the server.
15005
15006 @sc{imap} has two properties.  First, @sc{imap} can do everything that
15007 POP can, it can hence be viewed as a POP++.  Secondly, @sc{imap} is a
15008 mail storage protocol, similar to @sc{nntp} being a news storage
15009 protocol -- however, @sc{imap} offers more features than @sc{nntp}
15010 because news is more or less read-only whereas mail is read-write.
15011
15012 If you want to use @sc{imap} as a POP++, use an imap entry in
15013 @code{mail-sources}.  With this, Gnus will fetch mails from the
15014 @sc{imap} server and store them on the local disk.  This is not the
15015 usage described in this section--@xref{Mail Sources}.
15016
15017 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
15018 entry in @code{gnus-secondary-select-methods}.  With this, Gnus will
15019 manipulate mails stored on the @sc{imap} server.  This is the kind of
15020 usage explained in this section.
15021
15022 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
15023 might look something like the following. (Note that for SSL/TLS, you
15024 need external programs and libraries, see below.)
15025
15026 @lisp
15027 (setq gnus-secondary-select-methods
15028       '((nnimap "simpleserver") ; no special configuration
15029         ; perhaps a ssh port forwarded server:
15030         (nnimap "dolk"
15031                 (nnimap-address "localhost")
15032                 (nnimap-server-port 1430))
15033         ; a UW server running on localhost
15034         (nnimap "barbar"
15035                 (nnimap-server-port 143)
15036                 (nnimap-address "localhost")
15037                 (nnimap-list-pattern ("INBOX" "mail/*")))
15038         ; anonymous public cyrus server:
15039         (nnimap "cyrus.andrew.cmu.edu"
15040                 (nnimap-authenticator anonymous)
15041                 (nnimap-list-pattern "archive.*")
15042                 (nnimap-stream network))
15043         ; a ssl server on a non-standard port:
15044         (nnimap "vic20"
15045                 (nnimap-address "vic20.somewhere.com")
15046                 (nnimap-server-port 9930)
15047                 (nnimap-stream ssl))))
15048 @end lisp
15049
15050 The following variables can be used to create a virtual @code{nnimap}
15051 server:
15052
15053 @table @code
15054
15055 @item nnimap-address
15056 @vindex nnimap-address
15057
15058 The address of the remote @sc{imap} server.  Defaults to the virtual
15059 server name if not specified.
15060
15061 @item nnimap-server-port
15062 @vindex nnimap-server-port
15063 Port on server to contact.  Defaults to port 143, or 993 for SSL.
15064
15065 Note that this should be an integer, example server specification:
15066
15067 @lisp
15068 (nnimap "mail.server.com"
15069         (nnimap-server-port 4711))
15070 @end lisp
15071
15072 @item nnimap-list-pattern
15073 @vindex nnimap-list-pattern
15074 String or list of strings of mailboxes to limit available groups to.
15075 This is used when the server has very many mailboxes and you're only
15076 interested in a few -- some servers export your home directory via
15077 @sc{imap}, you'll probably want to limit the mailboxes to those in
15078 @file{~/Mail/*} then.
15079
15080 The string can also be a cons of REFERENCE and the string as above, what
15081 REFERENCE is used for is server specific, but on the University of
15082 Washington server it's a directory that will be concatenated with the
15083 mailbox.
15084
15085 Example server specification:
15086
15087 @lisp
15088 (nnimap "mail.server.com"
15089         (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
15090                                ("~friend/Mail/" . "list/*"))))
15091 @end lisp
15092
15093 @item nnimap-stream
15094 @vindex nnimap-stream
15095 The type of stream used to connect to your server.  By default, nnimap
15096 will detect and automatically use all of the below, with the exception
15097 of SSL/TLS. (@sc{imap} over SSL/TLS is being replaced by STARTTLS, which
15098 can be automatically detected, but it's not widely deployed yet.)
15099
15100 Example server specification:
15101
15102 @lisp
15103 (nnimap "mail.server.com"
15104         (nnimap-stream ssl))
15105 @end lisp
15106
15107 Please note that the value of @code{nnimap-stream} is a symbol!
15108
15109 @itemize @bullet
15110 @item
15111 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
15112 @samp{imtest} program.
15113 @item
15114 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
15115 @item
15116 @dfn{starttls:} Connect via the STARTTLS extension (similar to
15117 SSL).  Requires the external library @samp{starttls.el} and program
15118 @samp{starttls}.
15119 @item
15120 @dfn{ssl:} Connect through SSL.  Requires OpenSSL (the program
15121 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
15122 library @samp{ssl.el}.
15123 @item
15124 @dfn{shell:} Use a shell command to start @sc{imap} connection.
15125 @item
15126 @dfn{network:} Plain, TCP/IP network connection.
15127 @end itemize
15128
15129 @vindex imap-kerberos4-program
15130 The @samp{imtest} program is shipped with Cyrus IMAPD.  If you're
15131 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
15132 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
15133 to make @code{imap.el} use a pty instead of a pipe when communicating
15134 with @samp{imtest}.  You will then suffer from a line length
15135 restrictions on @sc{imap} commands, which might make Gnus seem to hang
15136 indefinitely if you have many articles in a mailbox.  The variable
15137 @code{imap-kerberos4-program} contain parameters to pass to the imtest
15138 program.
15139
15140 @vindex imap-ssl-program
15141 For SSL connections, the OpenSSL program is available from
15142 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
15143 and nnimap support it too - although the most recent versions of
15144 SSLeay, 0.9.x, are known to have serious bugs making it
15145 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
15146 work. The variable @code{imap-ssl-program} contain parameters to pass
15147 to OpenSSL/SSLeay.  You also need @samp{ssl.el} (from the W3
15148 distribution, for instance).
15149
15150 @vindex imap-shell-program
15151 @vindex imap-shell-host
15152 For @sc{imap} connections using the @code{shell} stream, the variable
15153 @code{imap-shell-program} specify what program to call.
15154
15155 @item nnimap-authenticator
15156 @vindex nnimap-authenticator
15157
15158 The authenticator used to connect to the server.  By default, nnimap
15159 will use the most secure authenticator your server is capable of.
15160
15161 Example server specification:
15162
15163 @lisp
15164 (nnimap "mail.server.com"
15165         (nnimap-authenticator anonymous))
15166 @end lisp
15167
15168 Please note that the value of @code{nnimap-authenticator} is a symbol!
15169
15170 @itemize @bullet
15171 @item
15172 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
15173 external program @code{imtest}.
15174 @item
15175 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
15176 @code{imtest}.
15177 @item
15178 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
15179 external library @code{digest-md5.el}.
15180 @item
15181 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
15182 @item
15183 @dfn{login:} Plain-text username/password via LOGIN.
15184 @item
15185 @dfn{anonymous:} Login as `anonymous', supplying your email address as password.
15186 @end itemize
15187
15188 @item nnimap-expunge-on-close
15189 @cindex Expunging
15190 @vindex nnimap-expunge-on-close
15191 Unlike Parmenides the @sc{imap} designers has decided that things that
15192 doesn't exist actually does exist.  More specifically, @sc{imap} has
15193 this concept of marking articles @code{Deleted} which doesn't actually
15194 delete them, and this (marking them @code{Deleted}, that is) is what
15195 nnimap does when you delete a article in Gnus (with @kbd{B DEL} or
15196 similar).
15197
15198 Since the articles aren't really removed when we mark them with the
15199 @code{Deleted} flag we'll need a way to actually delete them.  Feel like
15200 running in circles yet?
15201
15202 Traditionally, nnimap has removed all articles marked as @code{Deleted}
15203 when closing a mailbox but this is now configurable by this server
15204 variable.
15205
15206 The possible options are:
15207
15208 @table @code
15209
15210 @item always
15211 The default behavior, delete all articles marked as "Deleted" when
15212 closing a mailbox.
15213 @item never
15214 Never actually delete articles.  Currently there is no way of showing
15215 the articles marked for deletion in nnimap, but other @sc{imap} clients
15216 may allow you to do this.  If you ever want to run the EXPUNGE command
15217 manually, @xref{Expunging mailboxes}.
15218 @item ask
15219 When closing mailboxes, nnimap will ask if you wish to expunge deleted
15220 articles or not.
15221
15222 @end table
15223
15224 @item nnimap-importantize-dormant
15225 @vindex nnimap-importantize-dormant
15226
15227 If non-nil (the default), marks dormant articles as ticked (as well),
15228 for other @sc{imap} clients. Within Gnus, dormant articles will
15229 naturally still (only) be marked as dormant.  This is to make dormant
15230 articles stand out, just like ticked articles, in other @sc{imap}
15231 clients. (In other words, Gnus has two ``Tick'' marks and @sc{imap}
15232 has only one.)
15233
15234 Probably the only reason for frobing this would be if you're trying
15235 enable per-user persistant dormant flags, using something like:
15236
15237 @lisp
15238 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
15239         (format "gnus-dormant-%s" (user-login-name)))
15240 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
15241         (format "KEYWORD gnus-dormant-%s" (user-login-name)))
15242 @end lisp
15243
15244 In this case, you would not want the per-user dormant flag showing up
15245 as ticked for other users.
15246
15247 @item nnimap-expunge-search-string
15248 @cindex Expunging
15249 @vindex nnimap-expunge-search-string
15250
15251 This variable contain the @sc{imap} search command sent to server when
15252 searching for articles eligible for expiring.  The default is
15253 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
15254 UID set and the second @code{%s} is replaced by a date.
15255
15256 Probably the only useful value to change this to is
15257 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
15258 messages instead of the internal article date. See section 6.4.4 of
15259 RFC 2060 for more information on valid strings.
15260
15261 @item nnimap-authinfo-file
15262 @vindex nnimap-authinfo-file
15263
15264 A file containing credentials used to log in on servers.  The format is
15265 (almost) the same as the @code{ftp} @file{~/.netrc} file.  See the
15266 variable @code{nntp-authinfo-file} for exact syntax; also see
15267 @ref{NNTP}.
15268
15269 @end table
15270
15271 @menu
15272 * Splitting in IMAP::           Splitting mail with nnimap.
15273 * Expiring in IMAP::            Expiring mail with nnimap.
15274 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
15275 * Expunging mailboxes::         Equivalent of a "compress mailbox" button.
15276 * A note on namespaces::        How to (not) use IMAP namespace in Gnus.
15277 @end menu
15278
15279
15280
15281 @node Splitting in IMAP
15282 @subsection Splitting in IMAP
15283 @cindex splitting imap mail
15284
15285 Splitting is something Gnus users has loved and used for years, and now
15286 the rest of the world is catching up.  Yeah, dream on, not many
15287 @sc{imap} server has server side splitting and those that have splitting
15288 seem to use some non-standard protocol.  This means that @sc{imap}
15289 support for Gnus has to do it's own splitting.
15290
15291 And it does.
15292
15293 Here are the variables of interest:
15294
15295 @table @code
15296
15297 @item nnimap-split-crosspost
15298 @cindex splitting, crosspost
15299 @cindex crosspost
15300 @vindex nnimap-split-crosspost
15301
15302 If non-nil, do crossposting if several split methods match the mail.  If
15303 nil, the first match in @code{nnimap-split-rule} found will be used.
15304
15305 Nnmail equivalent: @code{nnmail-crosspost}.
15306
15307 @item nnimap-split-inbox
15308 @cindex splitting, inbox
15309 @cindex inbox
15310 @vindex nnimap-split-inbox
15311
15312 A string or a list of strings that gives the name(s) of @sc{imap}
15313 mailboxes to split from.  Defaults to nil, which means that splitting is
15314 disabled!
15315
15316 @lisp
15317 (setq nnimap-split-inbox
15318       '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
15319 @end lisp
15320
15321 No nnmail equivalent.
15322
15323 @item nnimap-split-rule
15324 @cindex Splitting, rules
15325 @vindex nnimap-split-rule
15326
15327 New mail found in @code{nnimap-split-inbox} will be split according to
15328 this variable.
15329
15330 This variable contains a list of lists, where the first element in the
15331 sublist gives the name of the @sc{imap} mailbox to move articles
15332 matching the regexp in the second element in the sublist.  Got that?
15333 Neither did I, we need examples.
15334
15335 @lisp
15336 (setq nnimap-split-rule
15337       '(("INBOX.nnimap"
15338          "^Sender: owner-nnimap@@vic20.globalcom.se")
15339         ("INBOX.junk"    "^Subject:.*MAKE MONEY")
15340         ("INBOX.private" "")))
15341 @end lisp
15342
15343 This will put all articles from the nnimap mailing list into mailbox
15344 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
15345 into INBOX.junk and everything else in INBOX.private.
15346
15347 The first string may contain `\\1' forms, like the ones used by
15348 replace-match to insert sub-expressions from the matched text.  For
15349 instance:
15350
15351 @lisp
15352 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
15353 @end lisp
15354
15355 The first element can also be the symbol @code{junk} to indicate that
15356 matching messages should simply be deleted.  Use with care.
15357
15358 The second element can also be a function.  In that case, it will be
15359 called with the first element of the rule as the argument, in a buffer
15360 containing the headers of the article.  It should return a non-nil value
15361 if it thinks that the mail belongs in that group.
15362
15363 Nnmail users might recollect that the last regexp had to be empty to
15364 match all articles (like in the example above).  This is not required in
15365 nnimap.  Articles not matching any of the regexps will not be moved out
15366 of your inbox.  (This might affect performance if you keep lots of
15367 unread articles in your inbox, since the splitting code would go over
15368 them every time you fetch new mail.)
15369
15370 These rules are processed from the beginning of the alist toward the
15371 end.  The first rule to make a match will "win", unless you have
15372 crossposting enabled.  In that case, all matching rules will "win".
15373
15374 This variable can also have a function as its value, the function will
15375 be called with the headers narrowed and should return a group where it
15376 thinks the article should be split to.  See @code{nnimap-split-fancy}.
15377
15378 The splitting code tries to create mailboxes if it needs to.
15379
15380 To allow for different split rules on different virtual servers, and
15381 even different split rules in different inboxes on the same server,
15382 the syntax of this variable have been extended along the lines of:
15383
15384 @lisp
15385 (setq nnimap-split-rule
15386       '(("my1server"    (".*"    (("ding"    "ding@@gnus.org")
15387                                   ("junk"    "From:.*Simon")))
15388         ("my2server"    ("INBOX" nnimap-split-fancy))
15389         ("my[34]server" (".*"    (("private" "To:.*Simon")
15390                                   ("junk"    my-junk-func)))))
15391 @end lisp
15392
15393 The virtual server name is in fact a regexp, so that the same rules
15394 may apply to several servers.  In the example, the servers
15395 @code{my3server} and @code{my4server} both use the same rules.
15396 Similarly, the inbox string is also a regexp.  The actual splitting
15397 rules are as before, either a function, or a list with group/regexp or
15398 group/function elements.
15399
15400 Nnmail equivalent: @code{nnmail-split-methods}.
15401
15402 @item nnimap-split-predicate
15403 @cindex splitting
15404 @vindex nnimap-split-predicate
15405
15406 Mail matching this predicate in @code{nnimap-split-inbox} will be
15407 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
15408
15409 This might be useful if you use another @sc{imap} client to read mail in
15410 your inbox but would like Gnus to split all articles in the inbox
15411 regardless of readedness. Then you might change this to
15412 @samp{UNDELETED}.
15413
15414 @item nnimap-split-fancy
15415 @cindex splitting, fancy
15416 @findex nnimap-split-fancy
15417 @vindex nnimap-split-fancy
15418
15419 It's possible to set @code{nnimap-split-rule} to
15420 @code{nnmail-split-fancy} if you want to use fancy
15421 splitting. @xref{Fancy Mail Splitting}.
15422
15423 However, to be able to have different fancy split rules for nnmail and
15424 nnimap back ends you can set @code{nnimap-split-rule} to
15425 @code{nnimap-split-fancy} and define the nnimap specific fancy split
15426 rule in @code{nnimap-split-fancy}.
15427
15428 Example:
15429
15430 @lisp
15431 (setq nnimap-split-rule 'nnimap-split-fancy
15432       nnimap-split-fancy ...)
15433 @end lisp
15434
15435 Nnmail equivalent: @code{nnmail-split-fancy}.
15436
15437 @end table
15438
15439 @node Expiring in IMAP
15440 @subsection Expiring in IMAP
15441 @cindex expiring imap mail
15442
15443 Even though @sc{nnimap} is not a proper @sc{nnmail} derived back end,
15444 it supports most features in regular expiring (@pxref{Expiring Mail}).
15445 Unlike splitting in IMAP (@pxref{Splitting in IMAP}) it do not clone
15446 the @sc{nnmail} variables (i.e., creating @var{nnimap-expiry-wait})
15447 but reuse the @sc{nnmail} variables.  What follows below are the
15448 variables used by the @sc{nnimap} expiry process.
15449
15450 A note on how the expire mark is stored on the @sc{imap} server is
15451 appropriate here as well.  The expire mark is translated into a
15452 @sc{imap} client specific mark, @code{gnus-expire}, and stored on the
15453 message.  This means that likely only Gnus will understand and treat
15454 the @code{gnus-expire} mark properly, although other clients may allow
15455 you to view client specific flags on the message.  It also means that
15456 your server must support permanent storage of client specific flags on
15457 messages.  Most do, fortunately.
15458
15459 @table @code
15460
15461 @item nnmail-expiry-wait
15462 @item nnmail-expiry-wait-function
15463
15464 These variables are fully supported.  The expire value can be a
15465 number, the symbol @var{immediate} or @var{never}.
15466
15467 @item nnmail-expiry-target
15468
15469 This variable is supported, and internally implemented by calling the
15470 @sc{nnmail} functions that handle this.  It contains an optimization
15471 that if the destination is a IMAP group on the same server, the
15472 article is copied instead of appended (that is, uploaded again).
15473
15474 @end table
15475
15476 @node Editing IMAP ACLs
15477 @subsection Editing IMAP ACLs
15478 @cindex editing imap acls
15479 @cindex Access Control Lists
15480 @cindex Editing @sc{imap} ACLs
15481 @kindex G l
15482 @findex gnus-group-nnimap-edit-acl
15483
15484 ACL stands for Access Control List.  ACLs are used in @sc{imap} for
15485 limiting (or enabling) other users access to your mail boxes.  Not all
15486 @sc{imap} servers support this, this function will give an error if it
15487 doesn't.
15488
15489 To edit a ACL for a mailbox, type @kbd{G l}
15490 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
15491 editing window with detailed instructions.
15492
15493 Some possible uses:
15494
15495 @itemize @bullet
15496 @item
15497 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
15498 on your mailing list mailboxes enables other users on the same server to
15499 follow the list without subscribing to it.
15500 @item
15501 At least with the Cyrus server, you are required to give the user
15502 "anyone" posting ("p") capabilities to have "plussing" work (that is,
15503 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
15504 INBOX.mailbox).
15505 @end itemize
15506
15507 @node Expunging mailboxes
15508 @subsection Expunging mailboxes
15509 @cindex expunging
15510
15511 @cindex Expunge
15512 @cindex Manual expunging
15513 @kindex G x
15514 @findex gnus-group-nnimap-expunge
15515
15516 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
15517 you may want the option of expunging all deleted articles in a mailbox
15518 manually.  This is exactly what @kbd{G x} does.
15519
15520 Currently there is no way of showing deleted articles, you can just
15521 delete them.
15522
15523 @node A note on namespaces
15524 @subsection A note on namespaces
15525 @cindex IMAP namespace
15526 @cindex namespaces
15527
15528 The IMAP protocol has a concept called namespaces, described by the
15529 following text in the RFC:
15530
15531 @example
15532 5.1.2.  Mailbox Namespace Naming Convention
15533
15534    By convention, the first hierarchical element of any mailbox name
15535    which begins with "#" identifies the "namespace" of the remainder of
15536    the name.  This makes it possible to disambiguate between different
15537    types of mailbox stores, each of which have their own namespaces.
15538
15539       For example, implementations which offer access to USENET
15540       newsgroups MAY use the "#news" namespace to partition the USENET
15541       newsgroup namespace from that of other mailboxes.  Thus, the
15542       comp.mail.misc newsgroup would have an mailbox name of
15543       "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
15544       to a different object (e.g. a user's private mailbox).
15545 @end example
15546
15547 While there is nothing in this text that warrants concern for the IMAP
15548 implementation in Gnus, some servers use namespace prefixes in a way
15549 that does not work with how Gnus uses mailbox names.
15550
15551 Specifically, University of Washington's IMAP server uses mailbox
15552 names like @code{#driver.mbx/read-mail} which are valid only in the
15553 @sc{create} and @sc{append} commands.  After the mailbox is created
15554 (or a messages is appended to a mailbox), it must be accessed without
15555 the namespace prefix, i.e @code{read-mail}.  Since Gnus do not make it
15556 possible for the user to guarantee that user entered mailbox names
15557 will only be used with the CREATE and APPEND commands, you should
15558 simply not use the namespace prefixed mailbox names in Gnus.
15559
15560 See the UoW @sc{imapd} documentation for the @code{#driver.*/} prefix
15561 for more information on how to use the prefixes.  They are a power
15562 tool and should be used only if you are sure what the effects are.
15563
15564 @node Other Sources
15565 @section Other Sources
15566
15567 Gnus can do more than just read news or mail.  The methods described
15568 below allow Gnus to view directories and files as if they were
15569 newsgroups.
15570
15571 @menu
15572 * Directory Groups::            You can read a directory as if it was a newsgroup.
15573 * Anything Groups::             Dired?  Who needs dired?
15574 * Document Groups::             Single files can be the basis of a group.
15575 * SOUP::                        Reading @sc{soup} packets ``offline''.
15576 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
15577 @end menu
15578
15579
15580 @node Directory Groups
15581 @subsection Directory Groups
15582 @cindex nndir
15583 @cindex directory groups
15584
15585 If you have a directory that has lots of articles in separate files in
15586 it, you might treat it as a newsgroup.  The files have to have numerical
15587 names, of course.
15588
15589 This might be an opportune moment to mention @code{ange-ftp} (and its
15590 successor @code{efs}), that most wonderful of all wonderful Emacs
15591 packages.  When I wrote @code{nndir}, I didn't think much about it---a
15592 back end to read directories.  Big deal.
15593
15594 @code{ange-ftp} changes that picture dramatically.  For instance, if you
15595 enter the @code{ange-ftp} file name
15596 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
15597 @code{ange-ftp} or @code{efs} will actually allow you to read this
15598 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
15599
15600 @code{nndir} will use @sc{nov} files if they are present.
15601
15602 @code{nndir} is a ``read-only'' back end---you can't delete or expire
15603 articles with this method.  You can use @code{nnmh} or @code{nnml} for
15604 whatever you use @code{nndir} for, so you could switch to any of those
15605 methods if you feel the need to have a non-read-only @code{nndir}.
15606
15607
15608 @node Anything Groups
15609 @subsection Anything Groups
15610 @cindex nneething
15611
15612 From the @code{nndir} back end (which reads a single spool-like
15613 directory), it's just a hop and a skip to @code{nneething}, which
15614 pretends that any arbitrary directory is a newsgroup.  Strange, but
15615 true.
15616
15617 When @code{nneething} is presented with a directory, it will scan this
15618 directory and assign article numbers to each file.  When you enter such
15619 a group, @code{nneething} must create ``headers'' that Gnus can use.
15620 After all, Gnus is a newsreader, in case you're forgetting.
15621 @code{nneething} does this in a two-step process.  First, it snoops each
15622 file in question.  If the file looks like an article (i.e., the first
15623 few lines look like headers), it will use this as the head.  If this is
15624 just some arbitrary file without a head (e.g. a C source file),
15625 @code{nneething} will cobble up a header out of thin air.  It will use
15626 file ownership, name and date and do whatever it can with these
15627 elements.
15628
15629 All this should happen automatically for you, and you will be presented
15630 with something that looks very much like a newsgroup.  Totally like a
15631 newsgroup, to be precise.  If you select an article, it will be displayed
15632 in the article buffer, just as usual.
15633
15634 If you select a line that represents a directory, Gnus will pop you into
15635 a new summary buffer for this @code{nneething} group.  And so on.  You can
15636 traverse the entire disk this way, if you feel like, but remember that
15637 Gnus is not dired, really, and does not intend to be, either.
15638
15639 There are two overall modes to this action---ephemeral or solid.  When
15640 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
15641 will not store information on what files you have read, and what files
15642 are new, and so on.  If you create a solid @code{nneething} group the
15643 normal way with @kbd{G m}, Gnus will store a mapping table between
15644 article numbers and file names, and you can treat this group like any
15645 other groups.  When you activate a solid @code{nneething} group, you will
15646 be told how many unread articles it contains, etc., etc.
15647
15648 Some variables:
15649
15650 @table @code
15651 @item nneething-map-file-directory
15652 @vindex nneething-map-file-directory
15653 All the mapping files for solid @code{nneething} groups will be stored
15654 in this directory, which defaults to @file{~/.nneething/}.
15655
15656 @item nneething-exclude-files
15657 @vindex nneething-exclude-files
15658 All files that match this regexp will be ignored.  Nice to use to exclude
15659 auto-save files and the like, which is what it does by default.
15660
15661 @item nneething-include-files
15662 @vindex nneething-include-files
15663 Regexp saying what files to include in the group.  If this variable is
15664 non-@code{nil}, only files matching this regexp will be included.
15665
15666 @item nneething-map-file
15667 @vindex nneething-map-file
15668 Name of the map files.
15669 @end table
15670
15671
15672 @node Document Groups
15673 @subsection Document Groups
15674 @cindex nndoc
15675 @cindex documentation group
15676 @cindex help group
15677
15678 @code{nndoc} is a cute little thing that will let you read a single file
15679 as a newsgroup.  Several files types are supported:
15680
15681 @table @code
15682 @cindex babyl
15683 @cindex rmail mbox
15684
15685 @item babyl
15686 The babyl (rmail) mail box.
15687 @cindex mbox
15688 @cindex Unix mbox
15689
15690 @item mbox
15691 The standard Unix mbox file.
15692
15693 @cindex MMDF mail box
15694 @item mmdf
15695 The MMDF mail box format.
15696
15697 @item news
15698 Several news articles appended into a file.
15699
15700 @item rnews
15701 @cindex rnews batch files
15702 The rnews batch transport format.
15703 @cindex forwarded messages
15704
15705 @item forward
15706 Forwarded articles.
15707
15708 @item nsmail
15709 Netscape mail boxes.
15710
15711 @item mime-parts
15712 @sc{mime} multipart messages.
15713
15714 @item standard-digest
15715 The standard (RFC 1153) digest format.
15716
15717 @item mime-digest
15718 A @sc{mime} digest of messages.
15719
15720 @item lanl-gov-announce
15721 Announcement messages from LANL Gov Announce.
15722
15723 @item rfc822-forward
15724 A message forwarded according to RFC822.
15725
15726 @item outlook
15727 The Outlook mail box.
15728
15729 @item oe-dbx
15730 The Outlook Express dbx mail box.
15731
15732 @item exim-bounce
15733 A bounce message from the Exim MTA.
15734
15735 @item forward
15736 A message forwarded according to informal rules.
15737
15738 @item rfc934
15739 An RFC934-forwarded message.
15740
15741 @item mailman
15742 A mailman digest.
15743
15744 @item clari-briefs
15745 A digest of Clarinet brief news items.
15746
15747 @item slack-digest
15748 Non-standard digest format---matches most things, but does it badly.
15749
15750 @item mail-in-mail
15751 The last resort.
15752 @end table
15753
15754 You can also use the special ``file type'' @code{guess}, which means
15755 that @code{nndoc} will try to guess what file type it is looking at.
15756 @code{digest} means that @code{nndoc} should guess what digest type the
15757 file is.
15758
15759 @code{nndoc} will not try to change the file or insert any extra headers into
15760 it---it will simply, like, let you use the file as the basis for a
15761 group.  And that's it.
15762
15763 If you have some old archived articles that you want to insert into your
15764 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
15765 that.  Say you have an old @file{RMAIL} file with mail that you now want
15766 to split into your new @code{nnml} groups.  You look at that file using
15767 @code{nndoc} (using the @kbd{G f} command in the group buffer
15768 (@pxref{Foreign Groups})), set the process mark on all the articles in
15769 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
15770 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
15771 file is now also stored in lots of @code{nnml} directories, and you can
15772 delete that pesky @file{RMAIL} file.  If you have the guts!
15773
15774 Virtual server variables:
15775
15776 @table @code
15777 @item nndoc-article-type
15778 @vindex nndoc-article-type
15779 This should be one of @code{mbox}, @code{babyl}, @code{digest},
15780 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
15781 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
15782 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
15783 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
15784
15785 @item nndoc-post-type
15786 @vindex nndoc-post-type
15787 This variable says whether Gnus is to consider the group a news group or
15788 a mail group.  There are two valid values:  @code{mail} (the default)
15789 and @code{news}.
15790 @end table
15791
15792 @menu
15793 * Document Server Internals::   How to add your own document types.
15794 @end menu
15795
15796
15797 @node Document Server Internals
15798 @subsubsection Document Server Internals
15799
15800 Adding new document types to be recognized by @code{nndoc} isn't
15801 difficult.  You just have to whip up a definition of what the document
15802 looks like, write a predicate function to recognize that document type,
15803 and then hook into @code{nndoc}.
15804
15805 First, here's an example document type definition:
15806
15807 @example
15808 (mmdf
15809  (article-begin .  "^\^A\^A\^A\^A\n")
15810  (body-end .  "^\^A\^A\^A\^A\n"))
15811 @end example
15812
15813 The definition is simply a unique @dfn{name} followed by a series of
15814 regexp pseudo-variable settings.  Below are the possible
15815 variables---don't be daunted by the number of variables; most document
15816 types can be defined with very few settings:
15817
15818 @table @code
15819 @item first-article
15820 If present, @code{nndoc} will skip past all text until it finds
15821 something that match this regexp.  All text before this will be
15822 totally ignored.
15823
15824 @item article-begin
15825 This setting has to be present in all document type definitions.  It
15826 says what the beginning of each article looks like.
15827
15828 @item head-begin-function
15829 If present, this should be a function that moves point to the head of
15830 the article.
15831
15832 @item nndoc-head-begin
15833 If present, this should be a regexp that matches the head of the
15834 article.
15835
15836 @item nndoc-head-end
15837 This should match the end of the head of the article.  It defaults to
15838 @samp{^$}---the empty line.
15839
15840 @item body-begin-function
15841 If present, this function should move point to the beginning of the body
15842 of the article.
15843
15844 @item body-begin
15845 This should match the beginning of the body of the article.  It defaults
15846 to @samp{^\n}.
15847
15848 @item body-end-function
15849 If present, this function should move point to the end of the body of
15850 the article.
15851
15852 @item body-end
15853 If present, this should match the end of the body of the article.
15854
15855 @item file-end
15856 If present, this should match the end of the file.  All text after this
15857 regexp will be totally ignored.
15858
15859 @end table
15860
15861 So, using these variables @code{nndoc} is able to dissect a document
15862 file into a series of articles, each with a head and a body.  However, a
15863 few more variables are needed since not all document types are all that
15864 news-like---variables needed to transform the head or the body into
15865 something that's palatable for Gnus:
15866
15867 @table @code
15868 @item prepare-body-function
15869 If present, this function will be called when requesting an article.  It
15870 will be called with point at the start of the body, and is useful if the
15871 document has encoded some parts of its contents.
15872
15873 @item article-transform-function
15874 If present, this function is called when requesting an article.  It's
15875 meant to be used for more wide-ranging transformation of both head and
15876 body of the article.
15877
15878 @item generate-head-function
15879 If present, this function is called to generate a head that Gnus can
15880 understand.  It is called with the article number as a parameter, and is
15881 expected to generate a nice head for the article in question.  It is
15882 called when requesting the headers of all articles.
15883
15884 @end table
15885
15886 Let's look at the most complicated example I can come up with---standard
15887 digests:
15888
15889 @example
15890 (standard-digest
15891  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
15892  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
15893  (prepare-body-function . nndoc-unquote-dashes)
15894  (body-end-function . nndoc-digest-body-end)
15895  (head-end . "^ ?$")
15896  (body-begin . "^ ?\n")
15897  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
15898  (subtype digest guess))
15899 @end example
15900
15901 We see that all text before a 70-width line of dashes is ignored; all
15902 text after a line that starts with that @samp{^End of} is also ignored;
15903 each article begins with a 30-width line of dashes; the line separating
15904 the head from the body may contain a single space; and that the body is
15905 run through @code{nndoc-unquote-dashes} before being delivered.
15906
15907 To hook your own document definition into @code{nndoc}, use the
15908 @code{nndoc-add-type} function.  It takes two parameters---the first is
15909 the definition itself and the second (optional) parameter says where in
15910 the document type definition alist to put this definition.  The alist is
15911 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}.  So @code{nndoc-mmdf-type-p} is called to see whether a document
15912 is of @code{mmdf} type, and so on.  These type predicates should return
15913 @code{nil} if the document is not of the correct type; @code{t} if it is
15914 of the correct type; and a number if the document might be of the
15915 correct type.  A high number means high probability; a low number means
15916 low probability with @samp{0} being the lowest valid number.
15917
15918
15919 @node SOUP
15920 @subsection SOUP
15921 @cindex SOUP
15922 @cindex offline
15923
15924 In the PC world people often talk about ``offline'' newsreaders.  These
15925 are thingies that are combined reader/news transport monstrosities.
15926 With built-in modem programs.  Yecchh!
15927
15928 Of course, us Unix Weenie types of human beans use things like
15929 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
15930 transport things like Ghod intended.  And then we just use normal
15931 newsreaders.
15932
15933 However, it can sometimes be convenient to do something that's a bit
15934 easier on the brain if you have a very slow modem, and you're not really
15935 that interested in doing things properly.
15936
15937 A file format called @sc{soup} has been developed for transporting news
15938 and mail from servers to home machines and back again.  It can be a bit
15939 fiddly.
15940
15941 First some terminology:
15942
15943 @table @dfn
15944
15945 @item server
15946 This is the machine that is connected to the outside world and where you
15947 get news and/or mail from.
15948
15949 @item home machine
15950 This is the machine that you want to do the actual reading and responding
15951 on.  It is typically not connected to the rest of the world in any way.
15952
15953 @item packet
15954 Something that contains messages and/or commands.  There are two kinds
15955 of packets:
15956
15957 @table @dfn
15958 @item message packets
15959 These are packets made at the server, and typically contain lots of
15960 messages for you to read.  These are called @file{SoupoutX.tgz} by
15961 default, where @var{x} is a number.
15962
15963 @item response packets
15964 These are packets made at the home machine, and typically contains
15965 replies that you've written.  These are called @file{SoupinX.tgz} by
15966 default, where @var{x} is a number.
15967
15968 @end table
15969
15970 @end table
15971
15972
15973 @enumerate
15974
15975 @item
15976 You log in on the server and create a @sc{soup} packet.  You can either
15977 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
15978 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
15979 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
15980
15981 @item
15982 You transfer the packet home.  Rail, boat, car or modem will do fine.
15983
15984 @item
15985 You put the packet in your home directory.
15986
15987 @item
15988 You fire up Gnus on your home machine using the @code{nnsoup} back end as
15989 the native or secondary server.
15990
15991 @item
15992 You read articles and mail and answer and followup to the things you
15993 want (@pxref{SOUP Replies}).
15994
15995 @item
15996 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
15997 packet.
15998
15999 @item
16000 You transfer this packet to the server.
16001
16002 @item
16003 You use Gnus to mail this packet out with the @kbd{G s s} command.
16004
16005 @item
16006 You then repeat until you die.
16007
16008 @end enumerate
16009
16010 So you basically have a bipartite system---you use @code{nnsoup} for
16011 reading and Gnus for packing/sending these @sc{soup} packets.
16012
16013 @menu
16014 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
16015 * SOUP Groups::                 A back end for reading @sc{soup} packets.
16016 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
16017 @end menu
16018
16019
16020 @node SOUP Commands
16021 @subsubsection SOUP Commands
16022
16023 These are commands for creating and manipulating @sc{soup} packets.
16024
16025 @table @kbd
16026 @item G s b
16027 @kindex G s b (Group)
16028 @findex gnus-group-brew-soup
16029 Pack all unread articles in the current group
16030 (@code{gnus-group-brew-soup}).  This command understands the
16031 process/prefix convention.
16032
16033 @item G s w
16034 @kindex G s w (Group)
16035 @findex gnus-soup-save-areas
16036 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
16037
16038 @item G s s
16039 @kindex G s s (Group)
16040 @findex gnus-soup-send-replies
16041 Send all replies from the replies packet
16042 (@code{gnus-soup-send-replies}).
16043
16044 @item G s p
16045 @kindex G s p (Group)
16046 @findex gnus-soup-pack-packet
16047 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
16048
16049 @item G s r
16050 @kindex G s r (Group)
16051 @findex nnsoup-pack-replies
16052 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
16053
16054 @item O s
16055 @kindex O s (Summary)
16056 @findex gnus-soup-add-article
16057 This summary-mode command adds the current article to a @sc{soup} packet
16058 (@code{gnus-soup-add-article}).  It understands the process/prefix
16059 convention (@pxref{Process/Prefix}).
16060
16061 @end table
16062
16063
16064 There are a few variables to customize where Gnus will put all these
16065 thingies:
16066
16067 @table @code
16068
16069 @item gnus-soup-directory
16070 @vindex gnus-soup-directory
16071 Directory where Gnus will save intermediate files while composing
16072 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
16073
16074 @item gnus-soup-replies-directory
16075 @vindex gnus-soup-replies-directory
16076 This is what Gnus will use as a temporary directory while sending our
16077 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
16078
16079 @item gnus-soup-prefix-file
16080 @vindex gnus-soup-prefix-file
16081 Name of the file where Gnus stores the last used prefix.  The default is
16082 @samp{gnus-prefix}.
16083
16084 @item gnus-soup-packer
16085 @vindex gnus-soup-packer
16086 A format string command for packing a @sc{soup} packet.  The default is
16087 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
16088
16089 @item gnus-soup-unpacker
16090 @vindex gnus-soup-unpacker
16091 Format string command for unpacking a @sc{soup} packet.  The default is
16092 @samp{gunzip -c %s | tar xvf -}.
16093
16094 @item gnus-soup-packet-directory
16095 @vindex gnus-soup-packet-directory
16096 Where Gnus will look for reply packets.  The default is @file{~/}.
16097
16098 @item gnus-soup-packet-regexp
16099 @vindex gnus-soup-packet-regexp
16100 Regular expression matching @sc{soup} reply packets in
16101 @code{gnus-soup-packet-directory}.
16102
16103 @end table
16104
16105
16106 @node SOUP Groups
16107 @subsubsection SOUP Groups
16108 @cindex nnsoup
16109
16110 @code{nnsoup} is the back end for reading @sc{soup} packets.  It will
16111 read incoming packets, unpack them, and put them in a directory where
16112 you can read them at leisure.
16113
16114 These are the variables you can use to customize its behavior:
16115
16116 @table @code
16117
16118 @item nnsoup-tmp-directory
16119 @vindex nnsoup-tmp-directory
16120 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
16121 directory.  (@file{/tmp/} by default.)
16122
16123 @item nnsoup-directory
16124 @vindex nnsoup-directory
16125 @code{nnsoup} then moves each message and index file to this directory.
16126 The default is @file{~/SOUP/}.
16127
16128 @item nnsoup-replies-directory
16129 @vindex nnsoup-replies-directory
16130 All replies will be stored in this directory before being packed into a
16131 reply packet.  The default is @file{~/SOUP/replies/"}.
16132
16133 @item nnsoup-replies-format-type
16134 @vindex nnsoup-replies-format-type
16135 The @sc{soup} format of the replies packets.  The default is @samp{?n}
16136 (rnews), and I don't think you should touch that variable.  I probably
16137 shouldn't even have documented it.  Drats!  Too late!
16138
16139 @item nnsoup-replies-index-type
16140 @vindex nnsoup-replies-index-type
16141 The index type of the replies packet.  The default is @samp{?n}, which
16142 means ``none''.  Don't fiddle with this one either!
16143
16144 @item nnsoup-active-file
16145 @vindex nnsoup-active-file
16146 Where @code{nnsoup} stores lots of information.  This is not an ``active
16147 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
16148 this file or mess it up in any way, you're dead.  The default is
16149 @file{~/SOUP/active}.
16150
16151 @item nnsoup-packer
16152 @vindex nnsoup-packer
16153 Format string command for packing a reply @sc{soup} packet.  The default
16154 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
16155
16156 @item nnsoup-unpacker
16157 @vindex nnsoup-unpacker
16158 Format string command for unpacking incoming @sc{soup} packets.  The
16159 default is @samp{gunzip -c %s | tar xvf -}.
16160
16161 @item nnsoup-packet-directory
16162 @vindex nnsoup-packet-directory
16163 Where @code{nnsoup} will look for incoming packets.  The default is
16164 @file{~/}.
16165
16166 @item nnsoup-packet-regexp
16167 @vindex nnsoup-packet-regexp
16168 Regular expression matching incoming @sc{soup} packets.  The default is
16169 @samp{Soupout}.
16170
16171 @item nnsoup-always-save
16172 @vindex nnsoup-always-save
16173 If non-@code{nil}, save the replies buffer after each posted message.
16174
16175 @end table
16176
16177
16178 @node SOUP Replies
16179 @subsubsection SOUP Replies
16180
16181 Just using @code{nnsoup} won't mean that your postings and mailings end
16182 up in @sc{soup} reply packets automagically.  You have to work a bit
16183 more for that to happen.
16184
16185 @findex nnsoup-set-variables
16186 The @code{nnsoup-set-variables} command will set the appropriate
16187 variables to ensure that all your followups and replies end up in the
16188 @sc{soup} system.
16189
16190 In specific, this is what it does:
16191
16192 @lisp
16193 (setq message-send-news-function 'nnsoup-request-post)
16194 (setq message-send-mail-function 'nnsoup-request-mail)
16195 @end lisp
16196
16197 And that's it, really.  If you only want news to go into the @sc{soup}
16198 system you just use the first line.  If you only want mail to be
16199 @sc{soup}ed you use the second.
16200
16201
16202 @node Mail-To-News Gateways
16203 @subsection Mail-To-News Gateways
16204 @cindex mail-to-news gateways
16205 @cindex gateways
16206
16207 If your local @code{nntp} server doesn't allow posting, for some reason
16208 or other, you can post using one of the numerous mail-to-news gateways.
16209 The @code{nngateway} back end provides the interface.
16210
16211 Note that you can't read anything from this back end---it can only be
16212 used to post with.
16213
16214 Server variables:
16215
16216 @table @code
16217 @item nngateway-address
16218 @vindex nngateway-address
16219 This is the address of the mail-to-news gateway.
16220
16221 @item nngateway-header-transformation
16222 @vindex nngateway-header-transformation
16223 News headers often have to be transformed in some odd way or other
16224 for the mail-to-news gateway to accept it.  This variable says what
16225 transformation should be called, and defaults to
16226 @code{nngateway-simple-header-transformation}.  The function is called
16227 narrowed to the headers to be transformed and with one parameter---the
16228 gateway address.
16229
16230 This default function just inserts a new @code{To} header based on the
16231 @code{Newsgroups} header and the gateway address.
16232 For instance, an article with this @code{Newsgroups} header:
16233
16234 @example
16235 Newsgroups: alt.religion.emacs
16236 @end example
16237
16238 will get this @code{To} header inserted:
16239
16240 @example
16241 To: alt-religion-emacs@@GATEWAY
16242 @end example
16243
16244 The following pre-defined functions exist:
16245
16246 @findex nngateway-simple-header-transformation
16247 @table @code
16248
16249 @item nngateway-simple-header-transformation
16250 Creates a @code{To} header that looks like
16251 @var{newsgroup}@@@code{nngateway-address}.
16252
16253 @findex nngateway-mail2news-header-transformation
16254
16255 @item nngateway-mail2news-header-transformation
16256 Creates a @code{To} header that looks like
16257 @code{nngateway-address}.
16258
16259 Here's an example:
16260
16261 @lisp
16262 (setq gnus-post-method
16263       '(nngateway
16264         "mail2news@@replay.com"
16265         (nngateway-header-transformation
16266          nngateway-mail2news-header-transformation)))
16267 @end lisp
16268
16269 @end table
16270
16271
16272 @end table
16273
16274 So, to use this, simply say something like:
16275
16276 @lisp
16277 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
16278 @end lisp
16279
16280
16281
16282 @node Combined Groups
16283 @section Combined Groups
16284
16285 Gnus allows combining a mixture of all the other group types into bigger
16286 groups.
16287
16288 @menu
16289 * Virtual Groups::              Combining articles from many groups.
16290 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
16291 @end menu
16292
16293
16294 @node Virtual Groups
16295 @subsection Virtual Groups
16296 @cindex nnvirtual
16297 @cindex virtual groups
16298 @cindex merging groups
16299
16300 An @dfn{nnvirtual group} is really nothing more than a collection of
16301 other groups.
16302
16303 For instance, if you are tired of reading many small groups, you can
16304 put them all in one big group, and then grow tired of reading one
16305 big, unwieldy group.  The joys of computing!
16306
16307 You specify @code{nnvirtual} as the method.  The address should be a
16308 regexp to match component groups.
16309
16310 All marks in the virtual group will stick to the articles in the
16311 component groups.  So if you tick an article in a virtual group, the
16312 article will also be ticked in the component group from whence it
16313 came.  (And vice versa---marks from the component groups will also be
16314 shown in the virtual group.). To create an empty virtual group, run
16315 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
16316 and edit the method regexp with @kbd{M-e}
16317 (@code{gnus-group-edit-group-method})
16318
16319 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
16320 newsgroups into one, big, happy newsgroup:
16321
16322 @lisp
16323 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
16324 @end lisp
16325
16326 The component groups can be native or foreign; everything should work
16327 smoothly, but if your computer explodes, it was probably my fault.
16328
16329 Collecting the same group from several servers might actually be a good
16330 idea if users have set the Distribution header to limit distribution.
16331 If you would like to read @samp{soc.motss} both from a server in Japan
16332 and a server in Norway, you could use the following as the group regexp:
16333
16334 @example
16335 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
16336 @end example
16337
16338 (Remember, though, that if you're creating the group with @kbd{G m}, you
16339 shouldn't double the backslashes, and you should leave off the quote
16340 characters at the beginning and the end of the string.)
16341
16342 This should work kinda smoothly---all articles from both groups should
16343 end up in this one, and there should be no duplicates.  Threading (and
16344 the rest) will still work as usual, but there might be problems with the
16345 sequence of articles.  Sorting on date might be an option here
16346 (@pxref{Selecting a Group}).
16347
16348 One limitation, however---all groups included in a virtual
16349 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
16350 zombie groups can't be component groups for @code{nnvirtual} groups.
16351
16352 @vindex nnvirtual-always-rescan
16353 If the @code{nnvirtual-always-rescan} is non-@code{nil},
16354 @code{nnvirtual} will always scan groups for unread articles when
16355 entering a virtual group.  If this variable is @code{nil} (which is the
16356 default) and you read articles in a component group after the virtual
16357 group has been activated, the read articles from the component group
16358 will show up when you enter the virtual group.  You'll also see this
16359 effect if you have two virtual groups that have a component group in
16360 common.  If that's the case, you should set this variable to @code{t}.
16361 Or you can just tap @code{M-g} on the virtual group every time before
16362 you enter it---it'll have much the same effect.
16363
16364 @code{nnvirtual} can have both mail and news groups as component groups.
16365 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
16366 has to ask the back end of the component group the article comes from
16367 whether it is a news or mail back end.  However, when you do a @kbd{^},
16368 there is typically no sure way for the component back end to know this,
16369 and in that case @code{nnvirtual} tells Gnus that the article came from a
16370 not-news back end.  (Just to be on the safe side.)
16371
16372 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
16373 line from the article you respond to in these cases.
16374
16375 @code{nnvirtual} groups do not inherit anything but articles and marks
16376 from component groups---group parameters, for instance, are not
16377 inherited.
16378
16379
16380 @node Kibozed Groups
16381 @subsection Kibozed Groups
16382 @cindex nnkiboze
16383 @cindex kibozing
16384
16385 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
16386 the news feed''.  @code{nnkiboze} is a back end that will do this for
16387 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
16388 with useless requests!  Oh happiness!
16389
16390 @kindex G k (Group)
16391 To create a kibozed group, use the @kbd{G k} command in the group
16392 buffer.
16393
16394 The address field of the @code{nnkiboze} method is, as with
16395 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
16396 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
16397 and @code{nnvirtual} end.
16398
16399 In addition to this regexp detailing component groups, an @code{nnkiboze} group
16400 must have a score file to say what articles are to be included in
16401 the group (@pxref{Scoring}).
16402
16403 @kindex M-x nnkiboze-generate-groups
16404 @findex nnkiboze-generate-groups
16405 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
16406 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
16407 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
16408 all the articles in all the component groups and run them through the
16409 scoring process to determine if there are any articles in the groups
16410 that are to be part of the @code{nnkiboze} groups.
16411
16412 Please limit the number of component groups by using restrictive
16413 regexps.  Otherwise your sysadmin may become annoyed with you, and the
16414 @sc{nntp} site may throw you off and never let you back in again.
16415 Stranger things have happened.
16416
16417 @code{nnkiboze} component groups do not have to be alive---they can be dead,
16418 and they can be foreign.  No restrictions.
16419
16420 @vindex nnkiboze-directory
16421 The generation of an @code{nnkiboze} group means writing two files in
16422 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
16423 contains the @sc{nov} header lines for all the articles in the group,
16424 and the other is an additional @file{.newsrc} file to store information
16425 on what groups have been searched through to find component articles.
16426
16427 Articles marked as read in the @code{nnkiboze} group will have
16428 their @sc{nov} lines removed from the @sc{nov} file.
16429
16430
16431 @node Gnus Unplugged
16432 @section Gnus Unplugged
16433 @cindex offline
16434 @cindex unplugged
16435 @cindex Agent
16436 @cindex Gnus Agent
16437 @cindex Gnus Unplugged
16438
16439 In olden times (ca. February '88), people used to run their newsreaders
16440 on big machines with permanent connections to the net.  News transport
16441 was dealt with by news servers, and all the newsreaders had to do was to
16442 read news.  Believe it or not.
16443
16444 Nowadays most people read news and mail at home, and use some sort of
16445 modem to connect to the net.  To avoid running up huge phone bills, it
16446 would be nice to have a way to slurp down all the news and mail, hang up
16447 the phone, read for several hours, and then upload any responses you
16448 have to make.  And then you repeat the procedure.
16449
16450 Of course, you can use news servers for doing this as well.  I've used
16451 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
16452 for some years, but doing that's a bore.  Moving the news server
16453 functionality up to the newsreader makes sense if you're the only person
16454 reading news on a machine.
16455
16456 Setting up Gnus as an ``offline'' newsreader is quite simple.  In
16457 fact, you don't even have to configure anything.
16458
16459 Of course, to use it as such, you have to learn a few new commands.
16460
16461 @menu
16462 * Agent Basics::                How it all is supposed to work.
16463 * Agent Categories::            How to tell the Gnus Agent what to download.
16464 * Agent Commands::              New commands for all the buffers.
16465 * Agent as Cache::              The Agent is a big cache too.
16466 * Agent Expiry::                How to make old articles go away.
16467 * Agent and IMAP::              How to use the Agent with IMAP.
16468 * Outgoing Messages::           What happens when you post/mail something?
16469 * Agent Variables::             Customizing is fun.
16470 * Example Setup::               An example @file{.gnus.el} file for offline people.
16471 * Batching Agents::             How to fetch news from a @code{cron} job.
16472 * Agent Caveats::               What you think it'll do and what it does.
16473 @end menu
16474
16475
16476 @node Agent Basics
16477 @subsection Agent Basics
16478
16479 First, let's get some terminology out of the way.
16480
16481 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
16482 connection to the net (and notified the Agent that this is the case).
16483 When the connection to the net is up again (and Gnus knows this), the
16484 Agent is @dfn{plugged}.
16485
16486 The @dfn{local} machine is the one you're running on, and which isn't
16487 connected to the net continuously.
16488
16489 @dfn{Downloading} means fetching things from the net to your local
16490 machine.  @dfn{Uploading} is doing the opposite.
16491
16492 Let's take a typical Gnus session using the Agent.
16493
16494 @itemize @bullet
16495
16496 @item
16497 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
16498 Agent in a disconnected state.  You can read all the news that you have
16499 already fetched while in this mode.
16500
16501 @item
16502 You then decide to see whether any new news has arrived.  You connect
16503 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
16504 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
16505 as usual.  To check for new mail in unplugged mode, see (@pxref{Mail
16506 Source Specifiers}).
16507
16508 @item
16509 You can then read the new news immediately, or you can download the news
16510 onto your local machine.  If you want to do the latter, you press @kbd{g}
16511 to check if there are any new news and then @kbd{J
16512 s} to fetch all the eligible articles in all the groups.  (To let Gnus
16513 know which articles you want to download, @pxref{Agent Categories}.)
16514
16515 @item
16516 After fetching the articles, you press @kbd{J j} to make Gnus become
16517 unplugged again, and you shut down the PPP thing (or whatever).  And
16518 then you read the news offline.
16519
16520 @item
16521 And then you go to step 2.
16522 @end itemize
16523
16524 Here are some things you should do the first time (or so) that you use
16525 the Agent.
16526
16527 @itemize @bullet
16528
16529 @item
16530 Decide which servers should be covered by the Agent.  If you have a mail
16531 back end, it would probably be nonsensical to have it covered by the
16532 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
16533 @kbd{J a} on the server (or servers) that you wish to have covered by the
16534 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
16535 added servers you do not wish to have covered by the Agent.  By default,
16536 all @code{nntp} and @code{nnimap} groups in @code{gnus-select-method} and
16537 @code{gnus-secondary-select-methods} are agentized.
16538
16539 @item
16540 Decide on download policy.  @xref{Agent Categories}.
16541
16542 @item
16543 Uhm... that's it.
16544 @end itemize
16545
16546
16547 @node Agent Categories
16548 @subsection Agent Categories
16549
16550 One of the main reasons to integrate the news transport layer into the
16551 newsreader is to allow greater control over what articles to download.
16552 There's not much point in downloading huge amounts of articles, just to
16553 find out that you're not interested in reading any of them.  It's better
16554 to be somewhat more conservative in choosing what to download, and then
16555 mark the articles for downloading manually if it should turn out that
16556 you're interested in the articles anyway.
16557
16558 The main way to control what is to be downloaded is to create a
16559 @dfn{category} and then assign some (or all) groups to this category.
16560 Groups that do not belong in any other category belong to the
16561 @code{default} category.  Gnus has its own buffer for creating and
16562 managing categories.
16563
16564 @menu
16565 * Category Syntax::             What a category looks like.
16566 * Category Buffer::             A buffer for maintaining categories.
16567 * Category Variables::          Customize'r'Us.
16568 @end menu
16569
16570
16571 @node Category Syntax
16572 @subsubsection Category Syntax
16573
16574 A category consists of two things.
16575
16576 @enumerate
16577 @item
16578 A predicate which (generally) gives a rough outline of which articles
16579 are eligible for downloading; and
16580
16581 @item
16582 a score rule which (generally) gives you a finer granularity when
16583 deciding what articles to download.  (Note that this @dfn{download
16584 score} is not necessarily related to normal scores.)
16585 @end enumerate
16586
16587 A predicate in its simplest form can be a single predicate such as
16588 @code{true} or @code{false}.  These two will download every available
16589 article or nothing respectively.  In the case of these two special
16590 predicates an additional score rule is superfluous.
16591
16592 Predicates of @code{high} or @code{low} download articles in respect of
16593 their scores in relationship to @code{gnus-agent-high-score} and
16594 @code{gnus-agent-low-score} as described below.
16595
16596 To gain even finer control of what is to be regarded eligible for
16597 download a predicate can consist of a number of predicates with logical
16598 operators sprinkled in between.
16599
16600 Perhaps some examples are in order.
16601
16602 Here's a simple predicate.  (It's the default predicate, in fact, used
16603 for all groups that don't belong to any other category.)
16604
16605 @lisp
16606 short
16607 @end lisp
16608
16609 Quite simple, eh?  This predicate is true if and only if the article is
16610 short (for some value of ``short'').
16611
16612 Here's a more complex predicate:
16613
16614 @lisp
16615 (or high
16616     (and
16617      (not low)
16618      (not long)))
16619 @end lisp
16620
16621 This means that an article should be downloaded if it has a high score,
16622 or if the score is not low and the article is not long.  You get the
16623 drift.
16624
16625 The available logical operators are @code{or}, @code{and} and
16626 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
16627 @samp{|}, @code{&} and @code{!} instead.)
16628
16629 The following predicates are pre-defined, but if none of these fit what
16630 you want to do, you can write your own.
16631
16632 @table @code
16633 @item short
16634 True iff the article is shorter than @code{gnus-agent-short-article}
16635 lines; default 100.
16636
16637 @item long
16638 True iff the article is longer than @code{gnus-agent-long-article}
16639 lines; default 200.
16640
16641 @item low
16642 True iff the article has a download score less than
16643 @code{gnus-agent-low-score}; default 0.
16644
16645 @item high
16646 True iff the article has a download score greater than
16647 @code{gnus-agent-high-score}; default 0.
16648
16649 @item spam
16650 True iff the Gnus Agent guesses that the article is spam.  The
16651 heuristics may change over time, but at present it just computes a
16652 checksum and sees whether articles match.
16653
16654 @item true
16655 Always true.
16656
16657 @item false
16658 Always false.
16659 @end table
16660
16661 If you want to create your own predicate function, here's what you have
16662 to know:  The functions are called with no parameters, but the
16663 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
16664 useful values.
16665
16666 For example, you could decide that you don't want to download articles
16667 that were posted more than a certain number of days ago (e.g. posted
16668 more than @code{gnus-agent-expire-days} ago) you might write a function
16669 something along the lines of the following:
16670
16671 @lisp
16672 (defun my-article-old-p ()
16673   "Say whether an article is old."
16674   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
16675      (- (time-to-days (current-time)) gnus-agent-expire-days)))
16676 @end lisp
16677
16678 with the predicate then defined as:
16679
16680 @lisp
16681 (not my-article-old-p)
16682 @end lisp
16683
16684 or you could append your predicate to the predefined
16685 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
16686 wherever.
16687
16688 @lisp
16689 (require 'gnus-agent)
16690 (setq  gnus-category-predicate-alist
16691   (append gnus-category-predicate-alist
16692          '((old . my-article-old-p))))
16693 @end lisp
16694
16695 and simply specify your predicate as:
16696
16697 @lisp
16698 (not old)
16699 @end lisp
16700
16701 If/when using something like the above, be aware that there are many
16702 misconfigured systems/mailers out there and so an article's date is not
16703 always a reliable indication of when it was posted.  Hell, some people
16704 just don't give a damn.
16705
16706 The above predicates apply to *all* the groups which belong to the
16707 category.  However, if you wish to have a specific predicate for an
16708 individual group within a category, or you're just too lazy to set up a
16709 new category, you can enter a group's individual predicate in it's group
16710 parameters like so:
16711
16712 @lisp
16713 (agent-predicate . short)
16714 @end lisp
16715
16716 This is the group parameter equivalent of the agent category default.
16717 Note that when specifying a single word predicate like this, the
16718 @code{agent-predicate} specification must be in dotted pair notation.
16719
16720 The equivalent of the longer example from above would be:
16721
16722 @lisp
16723 (agent-predicate or high (and (not low) (not long)))
16724 @end lisp
16725
16726 The outer parenthesis required in the category specification are not
16727 entered here as, not being in dotted pair notation, the value of the
16728 predicate is assumed to be a list.
16729
16730
16731 Now, the syntax of the download score is the same as the syntax of
16732 normal score files, except that all elements that require actually
16733 seeing the article itself are verboten.  This means that only the
16734 following headers can be scored on: @code{Subject}, @code{From},
16735 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
16736 @code{Lines}, and @code{Xref}.
16737
16738 As with predicates, the specification of the @code{download score rule}
16739 to use in respect of a group can be in either the category definition if
16740 it's to be applicable to all groups in therein, or a group's parameters
16741 if it's to be specific to that group.
16742
16743 In both of these places the @code{download score rule} can take one of
16744 three forms:
16745
16746 @enumerate
16747 @item
16748 Score rule
16749
16750 This has the same syntax as a normal gnus score file except only a
16751 subset of scoring keywords are available as mentioned above.
16752
16753 example:
16754
16755 @itemize @bullet
16756 @item
16757 Category specification
16758
16759 @lisp
16760 (("from"
16761        ("Lars Ingebrigtsen" 1000000 nil s))
16762 ("lines"
16763        (500 -100 nil <)))
16764 @end lisp
16765
16766 @item
16767 Group Parameter specification
16768
16769 @lisp
16770 (agent-score ("from"
16771                    ("Lars Ingebrigtsen" 1000000 nil s))
16772              ("lines"
16773                    (500 -100 nil <)))
16774 @end lisp
16775
16776 Again, note the omission of the outermost parenthesis here.
16777 @end itemize
16778
16779 @item
16780 Agent score file
16781
16782 These score files must *only* contain the permitted scoring keywords
16783 stated above.
16784
16785 example:
16786
16787 @itemize @bullet
16788 @item
16789 Category specification
16790
16791 @lisp
16792 ("~/News/agent.SCORE")
16793 @end lisp
16794
16795 or perhaps
16796
16797 @lisp
16798 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
16799 @end lisp
16800
16801 @item
16802 Group Parameter specification
16803
16804 @lisp
16805 (agent-score "~/News/agent.SCORE")
16806 @end lisp
16807
16808 Additional score files can be specified as above.  Need I say anything
16809 about parenthesis?
16810 @end itemize
16811
16812 @item
16813 Use @code{normal} score files
16814
16815 If you don't want to maintain two sets of scoring rules for a group, and
16816 your desired @code{downloading} criteria for a group are the same as your
16817 @code{reading} criteria then you can tell the agent to refer to your
16818 @code{normal} score files when deciding what to download.
16819
16820 These directives in either the category definition or a group's
16821 parameters will cause the agent to read in all the applicable score
16822 files for a group, *filtering out* those sections that do not
16823 relate to one of the permitted subset of scoring keywords.
16824
16825 @itemize @bullet
16826 @item
16827 Category Specification
16828
16829 @lisp
16830 file
16831 @end lisp
16832
16833 @item
16834 Group Parameter specification
16835
16836 @lisp
16837 (agent-score . file)
16838 @end lisp
16839 @end itemize
16840 @end enumerate
16841
16842 @node Category Buffer
16843 @subsubsection Category Buffer
16844
16845 You'd normally do all category maintenance from the category buffer.
16846 When you enter it for the first time (with the @kbd{J c} command from
16847 the group buffer), you'll only see the @code{default} category.
16848
16849 The following commands are available in this buffer:
16850
16851 @table @kbd
16852 @item q
16853 @kindex q (Category)
16854 @findex gnus-category-exit
16855 Return to the group buffer (@code{gnus-category-exit}).
16856
16857 @item k
16858 @kindex k (Category)
16859 @findex gnus-category-kill
16860 Kill the current category (@code{gnus-category-kill}).
16861
16862 @item c
16863 @kindex c (Category)
16864 @findex gnus-category-copy
16865 Copy the current category (@code{gnus-category-copy}).
16866
16867 @item a
16868 @kindex a (Category)
16869 @findex gnus-category-add
16870 Add a new category (@code{gnus-category-add}).
16871
16872 @item p
16873 @kindex p (Category)
16874 @findex gnus-category-edit-predicate
16875 Edit the predicate of the current category
16876 (@code{gnus-category-edit-predicate}).
16877
16878 @item g
16879 @kindex g (Category)
16880 @findex gnus-category-edit-groups
16881 Edit the list of groups belonging to the current category
16882 (@code{gnus-category-edit-groups}).
16883
16884 @item s
16885 @kindex s (Category)
16886 @findex gnus-category-edit-score
16887 Edit the download score rule of the current category
16888 (@code{gnus-category-edit-score}).
16889
16890 @item l
16891 @kindex l (Category)
16892 @findex gnus-category-list
16893 List all the categories (@code{gnus-category-list}).
16894 @end table
16895
16896
16897 @node Category Variables
16898 @subsubsection Category Variables
16899
16900 @table @code
16901 @item gnus-category-mode-hook
16902 @vindex gnus-category-mode-hook
16903 Hook run in category buffers.
16904
16905 @item gnus-category-line-format
16906 @vindex gnus-category-line-format
16907 Format of the lines in the category buffer (@pxref{Formatting
16908 Variables}).  Valid elements are:
16909
16910 @table @samp
16911 @item c
16912 The name of the category.
16913
16914 @item g
16915 The number of groups in the category.
16916 @end table
16917
16918 @item gnus-category-mode-line-format
16919 @vindex gnus-category-mode-line-format
16920 Format of the category mode line (@pxref{Mode Line Formatting}).
16921
16922 @item gnus-agent-short-article
16923 @vindex gnus-agent-short-article
16924 Articles that have fewer lines than this are short.  Default 100.
16925
16926 @item gnus-agent-long-article
16927 @vindex gnus-agent-long-article
16928 Articles that have more lines than this are long.  Default 200.
16929
16930 @item gnus-agent-low-score
16931 @vindex gnus-agent-low-score
16932 Articles that have a score lower than this have a low score.  Default
16933 0.
16934
16935 @item gnus-agent-high-score
16936 @vindex gnus-agent-high-score
16937 Articles that have a score higher than this have a high score.  Default
16938 0.
16939
16940 @end table
16941
16942
16943 @node Agent Commands
16944 @subsection Agent Commands
16945
16946 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
16947 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
16948 toggles the plugged/unplugged state of the Gnus Agent.
16949
16950
16951 @menu
16952 * Group Agent Commands::        
16953 * Summary Agent Commands::      
16954 * Server Agent Commands::       
16955 @end menu
16956
16957 You can run a complete batch command from the command line with the
16958 following incantation:
16959
16960 @cindex gnus-agent-batch
16961 @example
16962 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch
16963 @end example
16964
16965
16966
16967 @node Group Agent Commands
16968 @subsubsection Group Agent Commands
16969
16970 @table @kbd
16971 @item J u
16972 @kindex J u (Agent Group)
16973 @findex gnus-agent-fetch-groups
16974 Fetch all eligible articles in the current group
16975 (@code{gnus-agent-fetch-groups}).
16976
16977 @item J c
16978 @kindex J c (Agent Group)
16979 @findex gnus-enter-category-buffer
16980 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
16981
16982 @item J s
16983 @kindex J s (Agent Group)
16984 @findex gnus-agent-fetch-session
16985 Fetch all eligible articles in all groups
16986 (@code{gnus-agent-fetch-session}).
16987
16988 @item J S
16989 @kindex J S (Agent Group)
16990 @findex gnus-group-send-queue
16991 Send all sendable messages in the queue group
16992 (@code{gnus-group-send-queue}).  @xref{Drafts}.
16993
16994 @item J a
16995 @kindex J a (Agent Group)
16996 @findex gnus-agent-add-group
16997 Add the current group to an Agent category
16998 (@code{gnus-agent-add-group}).  This command understands the
16999 process/prefix convention (@pxref{Process/Prefix}).
17000
17001 @item J r
17002 @kindex J r (Agent Group)
17003 @findex gnus-agent-remove-group
17004 Remove the current group from its category, if any
17005 (@code{gnus-agent-remove-group}).  This command understands the
17006 process/prefix convention (@pxref{Process/Prefix}).
17007
17008 @item J Y
17009 @kindex J Y (Agent Group)
17010 @findex gnus-agent-synchronize-flags
17011 Synchronize flags changed while unplugged with remote server, if any.
17012
17013
17014 @end table
17015
17016
17017 @node Summary Agent Commands
17018 @subsubsection Summary Agent Commands
17019
17020 @table @kbd
17021 @item J #
17022 @kindex J # (Agent Summary)
17023 @findex gnus-agent-mark-article
17024 Mark the article for downloading (@code{gnus-agent-mark-article}).
17025
17026 @item J M-#
17027 @kindex J M-# (Agent Summary)
17028 @findex gnus-agent-unmark-article
17029 Remove the downloading mark from the article
17030 (@code{gnus-agent-unmark-article}).
17031
17032 @item @@
17033 @kindex @@ (Agent Summary)
17034 @findex gnus-agent-toggle-mark
17035 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
17036
17037 @item J c
17038 @kindex J c (Agent Summary)
17039 @findex gnus-agent-catchup
17040 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
17041
17042 @item J u
17043 @kindex J u (Agent Summary)
17044 @findex gnus-agent-summary-fetch-group
17045 Download all downloadable articles in the current group
17046 (@code{gnus-agent-summary-fetch-group}).
17047
17048 @end table
17049
17050
17051 @node Server Agent Commands
17052 @subsubsection Server Agent Commands
17053
17054 @table @kbd
17055 @item J a
17056 @kindex J a (Agent Server)
17057 @findex gnus-agent-add-server
17058 Add the current server to the list of servers covered by the Gnus Agent
17059 (@code{gnus-agent-add-server}).
17060
17061 @item J r
17062 @kindex J r (Agent Server)
17063 @findex gnus-agent-remove-server
17064 Remove the current server from the list of servers covered by the Gnus
17065 Agent (@code{gnus-agent-remove-server}).
17066
17067 @end table
17068
17069
17070 @node Agent as Cache
17071 @subsection Agent as Cache
17072
17073 When Gnus is plugged, it is not efficient to download headers or
17074 articles from the server again, if they are already stored in the
17075 Agent.  So, Gnus normally only downloads headers once, and stores them
17076 in the Agent.  These headers are later used when generating the summary
17077 buffer, regardless of whether you are plugged or unplugged.  Articles
17078 are not cached in the Agent by default though (that would potentially
17079 consume lots of disk space), but if you have already downloaded an
17080 article into the Agent, Gnus will not download the article from the
17081 server again but use the locally stored copy instead.
17082
17083 This behaviour can be controlled by @code{gnus-agent-cache}
17084 (@pxref{Agent Variables}).
17085
17086 @node Agent Expiry
17087 @subsection Agent Expiry
17088
17089 @vindex gnus-agent-expire-days
17090 @findex gnus-agent-expire
17091 @kindex M-x gnus-agent-expire
17092 @cindex Agent expiry
17093 @cindex Gnus Agent expiry
17094 @cindex expiry
17095
17096 @code{nnagent} doesn't handle expiry.  Instead, there's a special
17097 @code{gnus-agent-expire} command that will expire all read articles that
17098 are older than @code{gnus-agent-expire-days} days.  It can be run
17099 whenever you feel that you're running out of space.  It's not
17100 particularly fast or efficient, and it's not a particularly good idea to
17101 interrupt it (with @kbd{C-g} or anything else) once you've started it.
17102
17103 @code{gnus-agent-expire-days} can also be a list of regexp/day pairs.
17104 The regexps will be matched against group names to allow differing
17105 expiry in different groups.
17106
17107 @lisp
17108 (setq gnus-agent-expire-days
17109       '(("alt\\." 7)
17110         (".*binary" 1)
17111         ("." 21)))
17112 @end lisp
17113
17114 If you use the list form, the last element must always be the default
17115 method---it must always match all groups.
17116
17117 @vindex gnus-agent-expire-all
17118 If @code{gnus-agent-expire-all} is non-@code{nil}, this command will
17119 expire all articles---unread, read, ticked and dormant.  If @code{nil}
17120 (which is the default), only read articles are eligible for expiry, and
17121 unread, ticked and dormant articles will be kept indefinitely.
17122
17123 @findex gnus-agent-regenerate
17124 If you find that some articles eligible for expiry are never expired,
17125 perhaps some Gnus Agent files are corrupted.  There's a special
17126 @code{gnus-agent-regenerate} command to fix possible problems.
17127
17128 @node Agent and IMAP
17129 @subsection Agent and IMAP
17130
17131 The Agent work with any Gnus back end, including nnimap.  However,
17132 since there are some conceptual differences between @sc{nntp} and
17133 @sc{imap}, this section (should) provide you with some information to
17134 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
17135
17136 The first thing to keep in mind is that all flags (read, ticked, etc)
17137 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
17138 case for nntp.  Thus Gnus need to remember flag changes when
17139 disconnected, and synchronize these flags when you plug back in.
17140
17141 Gnus keeps track of flag changes when reading nnimap groups under the
17142 Agent.  When you plug back in, Gnus will check if you have any changed
17143 any flags and ask if you wish to synchronize these with the server.
17144 The behavior is customizable by @code{gnus-agent-synchronize-flags}.
17145
17146 @vindex gnus-agent-synchronize-flags
17147 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
17148 never automatically synchronize flags.  If it is @code{ask}, which is
17149 the default, the Agent will check if you made any changes and if so
17150 ask if you wish to synchronize these when you re-connect.  If it has
17151 any other value, all flags will be synchronized automatically.
17152
17153 If you do not wish to synchronize flags automatically when you
17154 re-connect, you can do it manually with the
17155 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
17156 in the group buffer.
17157
17158 Some things are currently not implemented in the Agent that you'd might
17159 expect from a disconnected @sc{imap} client, including:
17160
17161 @itemize @bullet
17162
17163 @item
17164 Copying/moving articles into nnimap groups when unplugged.
17165
17166 @item
17167 Creating/deleting nnimap groups when unplugged.
17168
17169 @end itemize
17170
17171 Technical note: the synchronization algorithm does not work by "pushing"
17172 all local flags to the server, but rather incrementally update the
17173 server view of flags by changing only those flags that were changed by
17174 the user.  Thus, if you set one flag on a article, quit the group and
17175 re-select the group and remove the flag; the flag will be set and
17176 removed from the server when you "synchronize".  The queued flag
17177 operations can be found in the per-server @code{flags} file in the Agent
17178 directory.  It's emptied when you synchronize flags.
17179
17180
17181 @node Outgoing Messages
17182 @subsection Outgoing Messages
17183
17184 When Gnus is unplugged, all outgoing messages (both mail and news) are
17185 stored in the draft group ``queue'' (@pxref{Drafts}).  You can view
17186 them there after posting, and edit them at will.
17187
17188 When Gnus is plugged again, you can send the messages either from the
17189 draft group with the special commands available there, or you can use
17190 the @kbd{J S} command in the group buffer to send all the sendable
17191 messages in the draft group.
17192
17193
17194
17195 @node Agent Variables
17196 @subsection Agent Variables
17197
17198 @table @code
17199 @item gnus-agent-directory
17200 @vindex gnus-agent-directory
17201 Where the Gnus Agent will store its files.  The default is
17202 @file{~/News/agent/}.
17203
17204 @item gnus-agent-handle-level
17205 @vindex gnus-agent-handle-level
17206 Groups on levels (@pxref{Group Levels}) higher than this variable will
17207 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
17208 which means that only subscribed group will be considered by the Agent
17209 by default.
17210
17211 @item gnus-agent-plugged-hook
17212 @vindex gnus-agent-plugged-hook
17213 Hook run when connecting to the network.
17214
17215 @item gnus-agent-unplugged-hook
17216 @vindex gnus-agent-unplugged-hook
17217 Hook run when disconnecting from the network.
17218
17219 @item gnus-agent-fetched-hook
17220 @vindex gnus-agent-fetched-hook
17221 Hook run when after finishing fetching articles.
17222
17223 @item gnus-agent-cache
17224 @vindex gnus-agent-cache
17225 Variable to control whether use the locally stored @sc{nov} and
17226 articles when plugged, e.g. essentially using the Agent as a cache.
17227 The default is non-nil, which means to use the Agent as a cache.
17228
17229 @item gnus-agent-go-online
17230 @vindex gnus-agent-go-online
17231 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
17232 automatically switch offline servers into online status.  If it is
17233 @code{ask}, the default, the Agent will ask if you wish to switch
17234 offline servers into online status when you re-connect.  If it has any
17235 other value, all offline servers will be automatically switched into
17236 online status.
17237
17238 @item gnus-server-unopen-status
17239 @vindex gnus-server-unopen-status
17240 Perhaps not a Agent variable, but closely related to the Agent, this
17241 variable says what will happen if Gnus cannot open a server.  If the
17242 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
17243 whether to deny the server or whether to unplug the agent.  If the
17244 Agent is disabled, Gnus always simply deny the server.  Other choices
17245 for this variable include @code{denied} and @code{offline} the latter
17246 is only valid if the Agent is used.
17247
17248 @end table
17249
17250
17251 @node Example Setup
17252 @subsection Example Setup
17253
17254 If you don't want to read this manual, and you have a fairly standard
17255 setup, you may be able to use something like the following as your
17256 @file{.gnus.el} file to get started.
17257
17258 @lisp
17259 ;;; Define how Gnus is to fetch news.  We do this over @sc{nntp}
17260 ;;; from your ISP's server.
17261 (setq gnus-select-method '(nntp "news.your-isp.com"))
17262
17263 ;;; Define how Gnus is to read your mail.  We read mail from
17264 ;;; your ISP's POP server.
17265 (setq mail-sources '((pop :server "pop.your-isp.com")))
17266
17267 ;;; Say how Gnus is to store the mail.  We use nnml groups.
17268 (setq gnus-secondary-select-methods '((nnml "")))
17269
17270 ;;; Make Gnus into an offline newsreader.
17271 ;;; (gnus-agentize) ; The obsolete setting.
17272 ;;; (setq gnus-agent t) ; Now the default.
17273 @end lisp
17274
17275 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
17276 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
17277 gnus}.
17278
17279 If this is the first time you've run Gnus, you will be subscribed
17280 automatically to a few default newsgroups.  You'll probably want to
17281 subscribe to more groups, and to do that, you have to query the
17282 @sc{nntp} server for a complete list of groups with the @kbd{A A}
17283 command.  This usually takes quite a while, but you only have to do it
17284 once.
17285
17286 After reading and parsing a while, you'll be presented with a list of
17287 groups.  Subscribe to the ones you want to read with the @kbd{u}
17288 command.  @kbd{l} to make all the killed groups disappear after you've
17289 subscribe to all the groups you want to read.  (@kbd{A k} will bring
17290 back all the killed groups.)
17291
17292 You can now read the groups at once, or you can download the articles
17293 with the @kbd{J s} command.  And then read the rest of this manual to
17294 find out which of the other gazillion things you want to customize.
17295
17296
17297 @node Batching Agents
17298 @subsection Batching Agents
17299
17300 Having the Gnus Agent fetch articles (and post whatever messages you've
17301 written) is quite easy once you've gotten things set up properly.  The
17302 following shell script will do everything that is necessary:
17303
17304 @example
17305 #!/bin/sh
17306 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
17307 @end example
17308
17309
17310 @node Agent Caveats
17311 @subsection Agent Caveats
17312
17313 The Gnus Agent doesn't seem to work like most other offline
17314 newsreaders.  Here are some common questions that some imaginary people
17315 may ask:
17316
17317 @table @dfn
17318 @item If I read an article while plugged, do they get entered into the Agent?
17319
17320 @strong{No}.
17321
17322 @item If I read an article while plugged, and the article already exists in the Agent, will it get downloaded once more?
17323
17324 @strong{No}, unless @code{gnus-agent-cache} is `nil'.
17325
17326 @end table
17327
17328 In short, when Gnus is unplugged, it only looks into the locally stored
17329 articles; when it's plugged, it only talks to your ISP and also uses the
17330 locally stored articles.
17331
17332
17333 @node Scoring
17334 @chapter Scoring
17335 @cindex scoring
17336
17337 Other people use @dfn{kill files}, but we here at Gnus Towers like
17338 scoring better than killing, so we'd rather switch than fight.  They do
17339 something completely different as well, so sit up straight and pay
17340 attention!
17341
17342 @vindex gnus-summary-mark-below
17343 All articles have a default score (@code{gnus-summary-default-score}),
17344 which is 0 by default.  This score may be raised or lowered either
17345 interactively or by score files.  Articles that have a score lower than
17346 @code{gnus-summary-mark-below} are marked as read.
17347
17348 Gnus will read any @dfn{score files} that apply to the current group
17349 before generating the summary buffer.
17350
17351 There are several commands in the summary buffer that insert score
17352 entries based on the current article.  You can, for instance, ask Gnus to
17353 lower or increase the score of all articles with a certain subject.
17354
17355 There are two sorts of scoring entries: Permanent and temporary.
17356 Temporary score entries are self-expiring entries.  Any entries that are
17357 temporary and have not been used for, say, a week, will be removed
17358 silently to help keep the sizes of the score files down.
17359
17360 @menu
17361 * Summary Score Commands::      Adding score entries for the current group.
17362 * Group Score Commands::        General score commands.
17363 * Score Variables::             Customize your scoring.  (My, what terminology).
17364 * Score File Format::           What a score file may contain.
17365 * Score File Editing::          You can edit score files by hand as well.
17366 * Adaptive Scoring::            Big Sister Gnus knows what you read.
17367 * Home Score File::             How to say where new score entries are to go.
17368 * Followups To Yourself::       Having Gnus notice when people answer you.
17369 * Scoring On Other Headers::    Scoring on non-standard headers.
17370 * Scoring Tips::                How to score effectively.
17371 * Reverse Scoring::             That problem child of old is not problem.
17372 * Global Score Files::          Earth-spanning, ear-splitting score files.
17373 * Kill Files::                  They are still here, but they can be ignored.
17374 * Converting Kill Files::       Translating kill files to score files.
17375 * GroupLens::                   Getting predictions on what you like to read.
17376 * Advanced Scoring::            Using logical expressions to build score rules.
17377 * Score Decays::                It can be useful to let scores wither away.
17378 @end menu
17379
17380
17381 @node Summary Score Commands
17382 @section Summary Score Commands
17383 @cindex score commands
17384
17385 The score commands that alter score entries do not actually modify real
17386 score files.  That would be too inefficient.  Gnus maintains a cache of
17387 previously loaded score files, one of which is considered the
17388 @dfn{current score file alist}.  The score commands simply insert
17389 entries into this list, and upon group exit, this list is saved.
17390
17391 The current score file is by default the group's local score file, even
17392 if no such score file actually exists.  To insert score commands into
17393 some other score file (e.g. @file{all.SCORE}), you must first make this
17394 score file the current one.
17395
17396 General score commands that don't actually change the score file:
17397
17398 @table @kbd
17399
17400 @item V s
17401 @kindex V s (Summary)
17402 @findex gnus-summary-set-score
17403 Set the score of the current article (@code{gnus-summary-set-score}).
17404
17405 @item V S
17406 @kindex V S (Summary)
17407 @findex gnus-summary-current-score
17408 Display the score of the current article
17409 (@code{gnus-summary-current-score}).
17410
17411 @item V t
17412 @kindex V t (Summary)
17413 @findex gnus-score-find-trace
17414 Display all score rules that have been used on the current article
17415 (@code{gnus-score-find-trace}).
17416
17417 @item V w
17418 @kindex V w (Summary)
17419 @findex gnus-score-find-favourite-words
17420 List words used in scoring (@code{gnus-score-find-favourite-words}).
17421
17422 @item V R
17423 @kindex V R (Summary)
17424 @findex gnus-summary-rescore
17425 Run the current summary through the scoring process
17426 (@code{gnus-summary-rescore}).  This might be useful if you're playing
17427 around with your score files behind Gnus' back and want to see the
17428 effect you're having.
17429
17430 @item V c
17431 @kindex V c (Summary)
17432 @findex gnus-score-change-score-file
17433 Make a different score file the current
17434 (@code{gnus-score-change-score-file}).
17435
17436 @item V e
17437 @kindex V e (Summary)
17438 @findex gnus-score-edit-current-scores
17439 Edit the current score file (@code{gnus-score-edit-current-scores}).
17440 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
17441 File Editing}).
17442
17443 @item V f
17444 @kindex V f (Summary)
17445 @findex gnus-score-edit-file
17446 Edit a score file and make this score file the current one
17447 (@code{gnus-score-edit-file}).
17448
17449 @item V F
17450 @kindex V F (Summary)
17451 @findex gnus-score-flush-cache
17452 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
17453 after editing score files.
17454
17455 @item V C
17456 @kindex V C (Summary)
17457 @findex gnus-score-customize
17458 Customize a score file in a visually pleasing manner
17459 (@code{gnus-score-customize}).
17460
17461 @end table
17462
17463 The rest of these commands modify the local score file.
17464
17465 @table @kbd
17466
17467 @item V m
17468 @kindex V m (Summary)
17469 @findex gnus-score-set-mark-below
17470 Prompt for a score, and mark all articles with a score below this as
17471 read (@code{gnus-score-set-mark-below}).
17472
17473 @item V x
17474 @kindex V x (Summary)
17475 @findex gnus-score-set-expunge-below
17476 Prompt for a score, and add a score rule to the current score file to
17477 expunge all articles below this score
17478 (@code{gnus-score-set-expunge-below}).
17479 @end table
17480
17481 The keystrokes for actually making score entries follow a very regular
17482 pattern, so there's no need to list all the commands.  (Hundreds of
17483 them.)
17484
17485 @findex gnus-summary-increase-score
17486 @findex gnus-summary-lower-score
17487
17488 @enumerate
17489 @item
17490 The first key is either @kbd{I} (upper case i) for increasing the score
17491 or @kbd{L} for lowering the score.
17492 @item
17493 The second key says what header you want to score on.  The following
17494 keys are available:
17495 @table @kbd
17496
17497 @item a
17498 Score on the author name.
17499
17500 @item s
17501 Score on the subject line.
17502
17503 @item x
17504 Score on the @code{Xref} line---i.e., the cross-posting line.
17505
17506 @item r
17507 Score on the @code{References} line.
17508
17509 @item d
17510 Score on the date.
17511
17512 @item l
17513 Score on the number of lines.
17514
17515 @item i
17516 Score on the @code{Message-ID} header.
17517
17518 @item e
17519 Score on an "extra" header, that is, one of those in gnus-extra-headers,
17520 if your @sc{nntp} server tracks additional header data in overviews.
17521
17522 @item f
17523 Score on followups---this matches the author name, and adds scores to
17524 the followups to this author.  (Using this key leads to the creation of
17525 @file{ADAPT} files.)
17526
17527 @item b
17528 Score on the body.
17529
17530 @item h
17531 Score on the head.
17532
17533 @item t
17534 Score on thread.  (Using this key leads to the creation of @file{ADAPT}
17535 files.)
17536
17537 @end table
17538
17539 @item
17540 The third key is the match type.  Which match types are valid depends on
17541 what headers you are scoring on.
17542
17543 @table @code
17544
17545 @item strings
17546
17547 @table @kbd
17548
17549 @item e
17550 Exact matching.
17551
17552 @item s
17553 Substring matching.
17554
17555 @item f
17556 Fuzzy matching (@pxref{Fuzzy Matching}).
17557
17558 @item r
17559 Regexp matching
17560 @end table
17561
17562 @item date
17563 @table @kbd
17564
17565 @item b
17566 Before date.
17567
17568 @item a
17569 After date.
17570
17571 @item n
17572 This date.
17573 @end table
17574
17575 @item number
17576 @table @kbd
17577
17578 @item <
17579 Less than number.
17580
17581 @item =
17582 Equal to number.
17583
17584 @item >
17585 Greater than number.
17586 @end table
17587 @end table
17588
17589 @item
17590 The fourth and usually final key says whether this is a temporary (i.e.,
17591 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
17592 or whether it is to be done immediately, without adding to the score
17593 file.
17594 @table @kbd
17595
17596 @item t
17597 Temporary score entry.
17598
17599 @item p
17600 Permanent score entry.
17601
17602 @item i
17603 Immediately scoring.
17604 @end table
17605
17606 @item
17607 If you are scoring on `e' (extra) headers, you will then be prompted for
17608 the header name on which you wish to score.  This must be a header named
17609 in gnus-extra-headers, and @samp{TAB} completion is available.
17610
17611 @end enumerate
17612
17613 So, let's say you want to increase the score on the current author with
17614 exact matching permanently: @kbd{I a e p}.  If you want to lower the
17615 score based on the subject line, using substring matching, and make a
17616 temporary score entry: @kbd{L s s t}.  Pretty easy.
17617
17618 To make things a bit more complicated, there are shortcuts.  If you use
17619 a capital letter on either the second or third keys, Gnus will use
17620 defaults for the remaining one or two keystrokes.  The defaults are
17621 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
17622 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
17623
17624 These functions take both the numerical prefix and the symbolic prefix
17625 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
17626 (or increase) the score of the article.  A symbolic prefix of @code{a}
17627 says to use the @file{all.SCORE} file for the command instead of the
17628 current score file.
17629
17630 @vindex gnus-score-mimic-keymap
17631 The @code{gnus-score-mimic-keymap} says whether these commands will
17632 pretend they are keymaps or not.
17633
17634
17635 @node Group Score Commands
17636 @section Group Score Commands
17637 @cindex group score commands
17638
17639 There aren't many of these as yet, I'm afraid.
17640
17641 @table @kbd
17642
17643 @item W f
17644 @kindex W f (Group)
17645 @findex gnus-score-flush-cache
17646 Gnus maintains a cache of score alists to avoid having to reload them
17647 all the time.  This command will flush the cache
17648 (@code{gnus-score-flush-cache}).
17649
17650 @end table
17651
17652 You can do scoring from the command line by saying something like:
17653
17654 @findex gnus-batch-score
17655 @cindex batch scoring
17656 @example
17657 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
17658 @end example
17659
17660
17661 @node Score Variables
17662 @section Score Variables
17663 @cindex score variables
17664
17665 @table @code
17666
17667 @item gnus-use-scoring
17668 @vindex gnus-use-scoring
17669 If @code{nil}, Gnus will not check for score files, and will not, in
17670 general, do any score-related work.  This is @code{t} by default.
17671
17672 @item gnus-kill-killed
17673 @vindex gnus-kill-killed
17674 If this variable is @code{nil}, Gnus will never apply score files to
17675 articles that have already been through the kill process.  While this
17676 may save you lots of time, it also means that if you apply a kill file
17677 to a group, and then change the kill file and want to run it over you
17678 group again to kill more articles, it won't work.  You have to set this
17679 variable to @code{t} to do that.  (It is @code{t} by default.)
17680
17681 @item gnus-kill-files-directory
17682 @vindex gnus-kill-files-directory
17683 All kill and score files will be stored in this directory, which is
17684 initialized from the @code{SAVEDIR} environment variable by default.
17685 This is @file{~/News/} by default.
17686
17687 @item gnus-score-file-suffix
17688 @vindex gnus-score-file-suffix
17689 Suffix to add to the group name to arrive at the score file name
17690 (@samp{SCORE} by default.)
17691
17692 @item gnus-score-uncacheable-files
17693 @vindex gnus-score-uncacheable-files
17694 @cindex score cache
17695 All score files are normally cached to avoid excessive re-loading of
17696 score files.  However, if this might make your Emacs grow big and
17697 bloated, so this regexp can be used to weed out score files unlikely to be needed again.  It would be a bad idea to deny caching of
17698 @file{all.SCORE}, while it might be a good idea to not cache
17699 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
17700 variable is @samp{ADAPT$} by default, so no adaptive score files will
17701 be cached.
17702
17703 @item gnus-save-score
17704 @vindex gnus-save-score
17705 If you have really complicated score files, and do lots of batch
17706 scoring, then you might set this variable to @code{t}.  This will make
17707 Gnus save the scores into the @file{.newsrc.eld} file.
17708
17709 If you do not set this to @code{t}, then manual scores (like those set
17710 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
17711 across group visits.
17712
17713 @item gnus-score-interactive-default-score
17714 @vindex gnus-score-interactive-default-score
17715 Score used by all the interactive raise/lower commands to raise/lower
17716 score with.  Default is 1000, which may seem excessive, but this is to
17717 ensure that the adaptive scoring scheme gets enough room to play with.
17718 We don't want the small changes from the adaptive scoring to overwrite
17719 manually entered data.
17720
17721 @item gnus-summary-default-score
17722 @vindex gnus-summary-default-score
17723 Default score of an article, which is 0 by default.
17724
17725 @item gnus-summary-expunge-below
17726 @vindex gnus-summary-expunge-below
17727 Don't display the summary lines of articles that have scores lower than
17728 this variable.  This is @code{nil} by default, which means that no
17729 articles will be hidden.  This variable is local to the summary buffers,
17730 and has to be set from @code{gnus-summary-mode-hook}.
17731
17732 @item gnus-score-over-mark
17733 @vindex gnus-score-over-mark
17734 Mark (in the third column) used for articles with a score over the
17735 default.  Default is @samp{+}.
17736
17737 @item gnus-score-below-mark
17738 @vindex gnus-score-below-mark
17739 Mark (in the third column) used for articles with a score below the
17740 default.  Default is @samp{-}.
17741
17742 @item gnus-score-find-score-files-function
17743 @vindex gnus-score-find-score-files-function
17744 Function used to find score files for the current group.  This function
17745 is called with the name of the group as the argument.
17746
17747 Predefined functions available are:
17748 @table @code
17749
17750 @item gnus-score-find-single
17751 @findex gnus-score-find-single
17752 Only apply the group's own score file.
17753
17754 @item gnus-score-find-bnews
17755 @findex gnus-score-find-bnews
17756 Apply all score files that match, using bnews syntax.  This is the
17757 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
17758 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
17759 @file{gnu.all.SCORE} would all apply.  In short, the instances of
17760 @samp{all} in the score file names are translated into @samp{.*}, and
17761 then a regexp match is done.
17762
17763 This means that if you have some score entries that you want to apply to
17764 all groups, then you put those entries in the @file{all.SCORE} file.
17765
17766 The score files are applied in a semi-random order, although Gnus will
17767 try to apply the more general score files before the more specific score
17768 files.  It does this by looking at the number of elements in the score
17769 file names---discarding the @samp{all} elements.
17770
17771 @item gnus-score-find-hierarchical
17772 @findex gnus-score-find-hierarchical
17773 Apply all score files from all the parent groups.  This means that you
17774 can't have score files like @file{all.SCORE}, but you can have
17775 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
17776 server.
17777
17778 @end table
17779 This variable can also be a list of functions.  In that case, all
17780 these functions will be called with the group name as argument, and
17781 all the returned lists of score files will be applied.  These
17782 functions can also return lists of lists of score alists directly.  In
17783 that case, the functions that return these non-file score alists
17784 should probably be placed before the ``real'' score file functions, to
17785 ensure that the last score file returned is the local score file.
17786 Phu.
17787
17788 For example, to do hierarchical scoring but use a non-server-specific
17789 overall score file, you could use the value
17790 @example
17791 (list (lambda (group) ("all.SCORE"))
17792       'gnus-score-find-hierarchical)
17793 @end example
17794
17795 @item gnus-score-expiry-days
17796 @vindex gnus-score-expiry-days
17797 This variable says how many days should pass before an unused score file
17798 entry is expired.  If this variable is @code{nil}, no score file entries
17799 are expired.  It's 7 by default.
17800
17801 @item gnus-update-score-entry-dates
17802 @vindex gnus-update-score-entry-dates
17803 If this variable is non-@code{nil}, temporary score entries that have
17804 been triggered (matched) will have their dates updated.  (This is how Gnus
17805 controls expiry---all non-matched-entries will become too old while
17806 matched entries will stay fresh and young.)  However, if you set this
17807 variable to @code{nil}, even matched entries will grow old and will
17808 have to face that oh-so grim reaper.
17809
17810 @item gnus-score-after-write-file-function
17811 @vindex gnus-score-after-write-file-function
17812 Function called with the name of the score file just written.
17813
17814 @item gnus-score-thread-simplify
17815 @vindex gnus-score-thread-simplify
17816 If this variable is non-@code{nil}, article subjects will be simplified
17817 for subject scoring purposes in the same manner as with
17818 threading---according to the current value of
17819 gnus-simplify-subject-functions.  If the scoring entry uses
17820 @code{substring} or @code{exact} matching, the match will also be
17821 simplified in this manner.
17822
17823 @end table
17824
17825
17826 @node Score File Format
17827 @section Score File Format
17828 @cindex score file format
17829
17830 A score file is an @code{emacs-lisp} file that normally contains just a
17831 single form.  Casual users are not expected to edit these files;
17832 everything can be changed from the summary buffer.
17833
17834 Anyway, if you'd like to dig into it yourself, here's an example:
17835
17836 @lisp
17837 (("from"
17838   ("Lars Ingebrigtsen" -10000)
17839   ("Per Abrahamsen")
17840   ("larsi\\|lmi" -50000 nil R))
17841  ("subject"
17842   ("Ding is Badd" nil 728373))
17843  ("xref"
17844   ("alt.politics" -1000 728372 s))
17845  ("lines"
17846   (2 -100 nil <))
17847  (mark 0)
17848  (expunge -1000)
17849  (mark-and-expunge -10)
17850  (read-only nil)
17851  (orphan -10)
17852  (adapt t)
17853  (files "/hom/larsi/News/gnu.SCORE")
17854  (exclude-files "all.SCORE")
17855  (local (gnus-newsgroup-auto-expire t)
17856         (gnus-summary-make-false-root empty))
17857  (eval (ding)))
17858 @end lisp
17859
17860 This example demonstrates most score file elements.  For a different
17861 approach, see @pxref{Advanced Scoring}.
17862
17863 Even though this looks much like lisp code, nothing here is actually
17864 @code{eval}ed.  The lisp reader is used to read this form, though, so it
17865 has to be valid syntactically, if not semantically.
17866
17867 Six keys are supported by this alist:
17868
17869 @table @code
17870
17871 @item STRING
17872 If the key is a string, it is the name of the header to perform the
17873 match on.  Scoring can only be performed on these eight headers:
17874 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
17875 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
17876 these headers, there are three strings to tell Gnus to fetch the entire
17877 article and do the match on larger parts of the article: @code{Body}
17878 will perform the match on the body of the article, @code{Head} will
17879 perform the match on the head of the article, and @code{All} will
17880 perform the match on the entire article.  Note that using any of these
17881 last three keys will slow down group entry @emph{considerably}.  The
17882 final ``header'' you can score on is @code{Followup}.  These score
17883 entries will result in new score entries being added for all follow-ups
17884 to articles that matches these score entries.
17885
17886 Following this key is a arbitrary number of score entries, where each
17887 score entry has one to four elements.
17888 @enumerate
17889
17890 @item
17891 The first element is the @dfn{match element}.  On most headers this will
17892 be a string, but on the Lines and Chars headers, this must be an
17893 integer.
17894
17895 @item
17896 If the second element is present, it should be a number---the @dfn{score
17897 element}.  This number should be an integer in the neginf to posinf
17898 interval.  This number is added to the score of the article if the match
17899 is successful.  If this element is not present, the
17900 @code{gnus-score-interactive-default-score} number will be used
17901 instead.  This is 1000 by default.
17902
17903 @item
17904 If the third element is present, it should be a number---the @dfn{date
17905 element}.  This date says when the last time this score entry matched,
17906 which provides a mechanism for expiring the score entries.  It this
17907 element is not present, the score entry is permanent.  The date is
17908 represented by the number of days since December 31, 1 BCE.
17909
17910 @item
17911 If the fourth element is present, it should be a symbol---the @dfn{type
17912 element}.  This element specifies what function should be used to see
17913 whether this score entry matches the article.  What match types that can
17914 be used depends on what header you wish to perform the match on.
17915 @table @dfn
17916
17917 @item From, Subject, References, Xref, Message-ID
17918 For most header types, there are the @code{r} and @code{R} (regexp), as
17919 well as @code{s} and @code{S} (substring) types, and @code{e} and
17920 @code{E} (exact match), and @code{w} (word match) types.  If this
17921 element is not present, Gnus will assume that substring matching should
17922 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
17923 that the matches will be done in a case-sensitive manner.  All these
17924 one-letter types are really just abbreviations for the @code{regexp},
17925 @code{string}, @code{exact}, and @code{word} types, which you can use
17926 instead, if you feel like.
17927
17928 @item Extra
17929 Just as for the standard string overview headers, if you are using
17930 gnus-extra-headers, you can score on these headers' values.  In this
17931 case, there is a 5th element in the score entry, being the name of the
17932 header to be scored.  The following entry is useful in your
17933 @file{all.SCORE} file in case of spam attacks from a single origin host,
17934 if your @sc{nntp} server tracks NNTP-Posting-Host in overviews:
17935
17936 @lisp
17937 ("111.222.333.444" -1000 nil s "NNTP-Posting-Host")
17938 @end lisp
17939
17940 @item Lines, Chars
17941 These two headers use different match types: @code{<}, @code{>},
17942 @code{=}, @code{>=} and @code{<=}.
17943
17944 These predicates are true if
17945
17946 @example
17947 (PREDICATE HEADER MATCH)
17948 @end example
17949
17950 evaluates to non-@code{nil}.  For instance, the advanced match
17951 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
17952 following form:
17953
17954 @lisp
17955 (< header-value 4)
17956 @end lisp
17957
17958 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
17959 the match, we get the score added if the article has less than 4 lines.
17960 (It's easy to get confused and think it's the other way around.  But
17961 it's not.  I think.)
17962
17963 When matching on @code{Lines}, be careful because some back ends (like
17964 @code{nndir}) do not generate @code{Lines} header, so every article ends
17965 up being marked as having 0 lines.  This can lead to strange results if
17966 you happen to lower score of the articles with few lines.
17967
17968 @item Date
17969 For the Date header we have three kinda silly match types:
17970 @code{before}, @code{at} and @code{after}.  I can't really imagine this
17971 ever being useful, but, like, it would feel kinda silly not to provide
17972 this function.  Just in case.  You never know.  Better safe than sorry.
17973 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
17974 sex on a first date.  (I have been told that at least one person, and I
17975 quote, ``found this function indispensable'', however.)
17976
17977 @cindex ISO8601
17978 @cindex date
17979 A more useful match type is @code{regexp}.  With it, you can match the
17980 date string using a regular expression.  The date is normalized to
17981 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
17982 you want to match all articles that have been posted on April 1st in
17983 every year, you could use @samp{....0401.........} as a match string,
17984 for instance.  (Note that the date is kept in its original time zone, so
17985 this will match articles that were posted when it was April 1st where
17986 the article was posted from.  Time zones are such wholesome fun for the
17987 whole family, eh?)
17988
17989 @item Head, Body, All
17990 These three match keys use the same match types as the @code{From} (etc)
17991 header uses.
17992
17993 @item Followup
17994 This match key is somewhat special, in that it will match the
17995 @code{From} header, and affect the score of not only the matching
17996 articles, but also all followups to the matching articles.  This allows
17997 you e.g. increase the score of followups to your own articles, or
17998 decrease the score of followups to the articles of some known
17999 trouble-maker.  Uses the same match types as the @code{From} header
18000 uses.  (Using this match key will lead to creation of @file{ADAPT}
18001 files.)
18002
18003 @item Thread
18004 This match key works along the same lines as the @code{Followup} match
18005 key.  If you say that you want to score on a (sub-)thread started by an
18006 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
18007 match.  This will add a new @samp{thread} match for each article that
18008 has @var{x} in its @code{References} header.  (These new @samp{thread}
18009 matches will use the @code{Message-ID}s of these matching articles.)
18010 This will ensure that you can raise/lower the score of an entire thread,
18011 even though some articles in the thread may not have complete
18012 @code{References} headers.  Note that using this may lead to
18013 undeterministic scores of the articles in the thread.  (Using this match
18014 key will lead to creation of @file{ADAPT} files.)
18015 @end table
18016 @end enumerate
18017
18018 @cindex Score File Atoms
18019 @item mark
18020 The value of this entry should be a number.  Any articles with a score
18021 lower than this number will be marked as read.
18022
18023 @item expunge
18024 The value of this entry should be a number.  Any articles with a score
18025 lower than this number will be removed from the summary buffer.
18026
18027 @item mark-and-expunge
18028 The value of this entry should be a number.  Any articles with a score
18029 lower than this number will be marked as read and removed from the
18030 summary buffer.
18031
18032 @item thread-mark-and-expunge
18033 The value of this entry should be a number.  All articles that belong to
18034 a thread that has a total score below this number will be marked as read
18035 and removed from the summary buffer.  @code{gnus-thread-score-function}
18036 says how to compute the total score for a thread.
18037
18038 @item files
18039 The value of this entry should be any number of file names.  These files
18040 are assumed to be score files as well, and will be loaded the same way
18041 this one was.
18042
18043 @item exclude-files
18044 The clue of this entry should be any number of files.  These files will
18045 not be loaded, even though they would normally be so, for some reason or
18046 other.
18047
18048 @item eval
18049 The value of this entry will be @code{eval}el.  This element will be
18050 ignored when handling global score files.
18051
18052 @item read-only
18053 Read-only score files will not be updated or saved.  Global score files
18054 should feature this atom (@pxref{Global Score Files}).  (Note:
18055 @dfn{Global} here really means @dfn{global}; not your personal
18056 apply-to-all-groups score files.)
18057
18058 @item orphan
18059 The value of this entry should be a number.  Articles that do not have
18060 parents will get this number added to their scores.  Imagine you follow
18061 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
18062 will only follow a few of the threads, also want to see any new threads.
18063
18064 You can do this with the following two score file entries:
18065
18066 @example
18067         (orphan -500)
18068         (mark-and-expunge -100)
18069 @end example
18070
18071 When you enter the group the first time, you will only see the new
18072 threads.  You then raise the score of the threads that you find
18073 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
18074 rest.  Next time you enter the group, you will see new articles in the
18075 interesting threads, plus any new threads.
18076
18077 I.e.---the orphan score atom is for high-volume groups where a few
18078 interesting threads which can't be found automatically by ordinary
18079 scoring rules exist.
18080
18081 @item adapt
18082 This entry controls the adaptive scoring.  If it is @code{t}, the
18083 default adaptive scoring rules will be used.  If it is @code{ignore}, no
18084 adaptive scoring will be performed on this group.  If it is a list, this
18085 list will be used as the adaptive scoring rules.  If it isn't present,
18086 or is something other than @code{t} or @code{ignore}, the default
18087 adaptive scoring rules will be used.  If you want to use adaptive
18088 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
18089 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
18090 not want adaptive scoring.  If you only want adaptive scoring in a few
18091 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
18092 insert @code{(adapt t)} in the score files of the groups where you want
18093 it.
18094
18095 @item adapt-file
18096 All adaptive score entries will go to the file named by this entry.  It
18097 will also be applied when entering the group.  This atom might be handy
18098 if you want to adapt on several groups at once, using the same adaptive
18099 file for a number of groups.
18100
18101 @item local
18102 @cindex local variables
18103 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
18104 Each @var{var} will be made buffer-local to the current summary buffer,
18105 and set to the value specified.  This is a convenient, if somewhat
18106 strange, way of setting variables in some groups if you don't like hooks
18107 much.  Note that the @var{value} won't be evaluated.
18108 @end table
18109
18110
18111 @node Score File Editing
18112 @section Score File Editing
18113
18114 You normally enter all scoring commands from the summary buffer, but you
18115 might feel the urge to edit them by hand as well, so we've supplied you
18116 with a mode for that.
18117
18118 It's simply a slightly customized @code{emacs-lisp} mode, with these
18119 additional commands:
18120
18121 @table @kbd
18122
18123 @item C-c C-c
18124 @kindex C-c C-c (Score)
18125 @findex gnus-score-edit-done
18126 Save the changes you have made and return to the summary buffer
18127 (@code{gnus-score-edit-done}).
18128
18129 @item C-c C-d
18130 @kindex C-c C-d (Score)
18131 @findex gnus-score-edit-insert-date
18132 Insert the current date in numerical format
18133 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
18134 you were wondering.
18135
18136 @item C-c C-p
18137 @kindex C-c C-p (Score)
18138 @findex gnus-score-pretty-print
18139 The adaptive score files are saved in an unformatted fashion.  If you
18140 intend to read one of these files, you want to @dfn{pretty print} it
18141 first.  This command (@code{gnus-score-pretty-print}) does that for
18142 you.
18143
18144 @end table
18145
18146 Type @kbd{M-x gnus-score-mode} to use this mode.
18147
18148 @vindex gnus-score-mode-hook
18149 @code{gnus-score-menu-hook} is run in score mode buffers.
18150
18151 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
18152 e} to begin editing score files.
18153
18154
18155 @node Adaptive Scoring
18156 @section Adaptive Scoring
18157 @cindex adaptive scoring
18158
18159 If all this scoring is getting you down, Gnus has a way of making it all
18160 happen automatically---as if by magic.  Or rather, as if by artificial
18161 stupidity, to be precise.
18162
18163 @vindex gnus-use-adaptive-scoring
18164 When you read an article, or mark an article as read, or kill an
18165 article, you leave marks behind.  On exit from the group, Gnus can sniff
18166 these marks and add score elements depending on what marks it finds.
18167 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
18168 @code{t} or @code{(line)}.  If you want score adaptively on separate
18169 words appearing in the subjects, you should set this variable to
18170 @code{(word)}.  If you want to use both adaptive methods, set this
18171 variable to @code{(word line)}.
18172
18173 @vindex gnus-default-adaptive-score-alist
18174 To give you complete control over the scoring process, you can customize
18175 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
18176 might look something like this:
18177
18178 @lisp
18179 (setq gnus-default-adaptive-score-alist
18180   '((gnus-unread-mark)
18181     (gnus-ticked-mark (from 4))
18182     (gnus-dormant-mark (from 5))
18183     (gnus-del-mark (from -4) (subject -1))
18184     (gnus-read-mark (from 4) (subject 2))
18185     (gnus-expirable-mark (from -1) (subject -1))
18186     (gnus-killed-mark (from -1) (subject -3))
18187     (gnus-kill-file-mark)
18188     (gnus-ancient-mark)
18189     (gnus-low-score-mark)
18190     (gnus-catchup-mark (from -1) (subject -1))))
18191 @end lisp
18192
18193 As you see, each element in this alist has a mark as a key (either a
18194 variable name or a ``real'' mark---a character).  Following this key is
18195 a arbitrary number of header/score pairs.  If there are no header/score
18196 pairs following the key, no adaptive scoring will be done on articles
18197 that have that key as the article mark.  For instance, articles with
18198 @code{gnus-unread-mark} in the example above will not get adaptive score
18199 entries.
18200
18201 Each article can have only one mark, so just a single of these rules
18202 will be applied to each article.
18203
18204 To take @code{gnus-del-mark} as an example---this alist says that all
18205 articles that have that mark (i.e., are marked with @samp{D}) will have a
18206 score entry added to lower based on the @code{From} header by -4, and
18207 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
18208
18209 If you have marked 10 articles with the same subject with
18210 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
18211 That means that that subject will get a score of ten times -1, which
18212 should be, unless I'm much mistaken, -10.
18213
18214 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
18215 the read articles will be marked with the @samp{E} mark.  This'll
18216 probably make adaptive scoring slightly impossible, so auto-expiring and
18217 adaptive scoring doesn't really mix very well.
18218
18219 The headers you can score on are @code{from}, @code{subject},
18220 @code{message-id}, @code{references}, @code{xref}, @code{lines},
18221 @code{chars} and @code{date}.  In addition, you can score on
18222 @code{followup}, which will create an adaptive score entry that matches
18223 on the @code{References} header using the @code{Message-ID} of the
18224 current article, thereby matching the following thread.
18225
18226 You can also score on @code{thread}, which will try to score all
18227 articles that appear in a thread.  @code{thread} matches uses a
18228 @code{Message-ID} to match on the @code{References} header of the
18229 article.  If the match is made, the @code{Message-ID} of the article is
18230 added to the @code{thread} rule.  (Think about it.  I'd recommend two
18231 aspirins afterwards.)
18232
18233 If you use this scheme, you should set the score file atom @code{mark}
18234 to something small---like -300, perhaps, to avoid having small random
18235 changes result in articles getting marked as read.
18236
18237 After using adaptive scoring for a week or so, Gnus should start to
18238 become properly trained and enhance the authors you like best, and kill
18239 the authors you like least, without you having to say so explicitly.
18240
18241 You can control what groups the adaptive scoring is to be performed on
18242 by using the score files (@pxref{Score File Format}).  This will also
18243 let you use different rules in different groups.
18244
18245 @vindex gnus-adaptive-file-suffix
18246 The adaptive score entries will be put into a file where the name is the
18247 group name with @code{gnus-adaptive-file-suffix} appended.  The default
18248 is @samp{ADAPT}.
18249
18250 @vindex gnus-score-exact-adapt-limit
18251 When doing adaptive scoring, substring or fuzzy matching would probably
18252 give you the best results in most cases.  However, if the header one
18253 matches is short, the possibility for false positives is great, so if
18254 the length of the match is less than
18255 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
18256 this variable is @code{nil}, exact matching will always be used to avoid
18257 this problem.
18258
18259 @vindex gnus-default-adaptive-word-score-alist
18260 As mentioned above, you can adapt either on individual words or entire
18261 headers.  If you adapt on words, the
18262 @code{gnus-default-adaptive-word-score-alist} variable says what score
18263 each instance of a word should add given a mark.
18264
18265 @lisp
18266 (setq gnus-default-adaptive-word-score-alist
18267       `((,gnus-read-mark . 30)
18268         (,gnus-catchup-mark . -10)
18269         (,gnus-killed-mark . -20)
18270         (,gnus-del-mark . -15)))
18271 @end lisp
18272
18273 This is the default value.  If you have adaption on words enabled, every
18274 word that appears in subjects of articles marked with
18275 @code{gnus-read-mark} will result in a score rule that increase the
18276 score with 30 points.
18277
18278 @vindex gnus-default-ignored-adaptive-words
18279 @vindex gnus-ignored-adaptive-words
18280 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
18281 will be ignored.  If you wish to add more words to be ignored, use the
18282 @code{gnus-ignored-adaptive-words} list instead.
18283
18284 @vindex gnus-adaptive-word-length-limit
18285 Some may feel that short words shouldn't count when doing adaptive
18286 scoring.  If so, you may set @code{gnus-adaptive-word-length-limit} to
18287 an integer.  Words shorter than this number will be ignored.  This
18288 variable defaults to @code{nil}.
18289
18290 @vindex gnus-adaptive-word-syntax-table
18291 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
18292 syntax table in effect.  It is similar to the standard syntax table, but
18293 it considers numbers to be non-word-constituent characters.
18294
18295 @vindex gnus-adaptive-word-minimum
18296 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
18297 word scoring process will never bring down the score of an article to
18298 below this number.  The default is @code{nil}.
18299
18300 @vindex gnus-adaptive-word-no-group-words
18301 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
18302 won't adaptively word score any of the words in the group name.  Useful
18303 for groups like @samp{comp.editors.emacs}, where most of the subject
18304 lines contain the word @samp{emacs}.
18305
18306 After using this scheme for a while, it might be nice to write a
18307 @code{gnus-psychoanalyze-user} command to go through the rules and see
18308 what words you like and what words you don't like.  Or perhaps not.
18309
18310 Note that the adaptive word scoring thing is highly experimental and is
18311 likely to change in the future.  Initial impressions seem to indicate
18312 that it's totally useless as it stands.  Some more work (involving more
18313 rigorous statistical methods) will have to be done to make this useful.
18314
18315
18316 @node Home Score File
18317 @section Home Score File
18318
18319 The score file where new score file entries will go is called the
18320 @dfn{home score file}.  This is normally (and by default) the score file
18321 for the group itself.  For instance, the home score file for
18322 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
18323
18324 However, this may not be what you want.  It is often convenient to share
18325 a common home score file among many groups---all @samp{emacs} groups
18326 could perhaps use the same home score file.
18327
18328 @vindex gnus-home-score-file
18329 The variable that controls this is @code{gnus-home-score-file}.  It can
18330 be:
18331
18332 @enumerate
18333 @item
18334 A string.  Then this file will be used as the home score file for all
18335 groups.
18336
18337 @item
18338 A function.  The result of this function will be used as the home score
18339 file.  The function will be called with the name of the group as the
18340 parameter.
18341
18342 @item
18343 A list.  The elements in this list can be:
18344
18345 @enumerate
18346 @item
18347 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
18348 group name, the @var{file-name} will be used as the home score file.
18349
18350 @item
18351 A function.  If the function returns non-nil, the result will be used as
18352 the home score file.
18353
18354 @item
18355 A string.  Use the string as the home score file.
18356 @end enumerate
18357
18358 The list will be traversed from the beginning towards the end looking
18359 for matches.
18360
18361 @end enumerate
18362
18363 So, if you want to use just a single score file, you could say:
18364
18365 @lisp
18366 (setq gnus-home-score-file
18367       "my-total-score-file.SCORE")
18368 @end lisp
18369
18370 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
18371 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
18372
18373 @findex gnus-hierarchial-home-score-file
18374 @lisp
18375 (setq gnus-home-score-file
18376       'gnus-hierarchial-home-score-file)
18377 @end lisp
18378
18379 This is a ready-made function provided for your convenience.
18380 Other functions include
18381
18382 @table @code
18383 @item gnus-current-home-score-file
18384 @findex gnus-current-home-score-file
18385 Return the ``current'' regular score file.  This will make scoring
18386 commands add entry to the ``innermost'' matching score file.
18387
18388 @end table
18389
18390 If you want to have one score file for the @samp{emacs} groups and
18391 another for the @samp{comp} groups, while letting all other groups use
18392 their own home score files:
18393
18394 @lisp
18395 (setq gnus-home-score-file
18396       ;; All groups that match the regexp "\\.emacs"
18397       '(("\\.emacs" "emacs.SCORE")
18398         ;; All the comp groups in one score file
18399         ("^comp" "comp.SCORE")))
18400 @end lisp
18401
18402 @vindex gnus-home-adapt-file
18403 @code{gnus-home-adapt-file} works exactly the same way as
18404 @code{gnus-home-score-file}, but says what the home adaptive score file
18405 is instead.  All new adaptive file entries will go into the file
18406 specified by this variable, and the same syntax is allowed.
18407
18408 In addition to using @code{gnus-home-score-file} and
18409 @code{gnus-home-adapt-file}, you can also use group parameters
18410 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
18411 Parameters}) to achieve much the same.  Group and topic parameters take
18412 precedence over this variable.
18413
18414
18415 @node Followups To Yourself
18416 @section Followups To Yourself
18417
18418 Gnus offers two commands for picking out the @code{Message-ID} header in
18419 the current buffer.  Gnus will then add a score rule that scores using
18420 this @code{Message-ID} on the @code{References} header of other
18421 articles.  This will, in effect, increase the score of all articles that
18422 respond to the article in the current buffer.  Quite useful if you want
18423 to easily note when people answer what you've said.
18424
18425 @table @code
18426
18427 @item gnus-score-followup-article
18428 @findex gnus-score-followup-article
18429 This will add a score to articles that directly follow up your own
18430 article.
18431
18432 @item gnus-score-followup-thread
18433 @findex gnus-score-followup-thread
18434 This will add a score to all articles that appear in a thread ``below''
18435 your own article.
18436 @end table
18437
18438 @vindex message-sent-hook
18439 These two functions are both primarily meant to be used in hooks like
18440 @code{message-sent-hook}, like this:
18441 @lisp
18442 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
18443 @end lisp
18444
18445
18446 If you look closely at your own @code{Message-ID}, you'll notice that
18447 the first two or three characters are always the same.  Here's two of
18448 mine:
18449
18450 @example
18451 <x6u3u47icf.fsf@@eyesore.no>
18452 <x6sp9o7ibw.fsf@@eyesore.no>
18453 @end example
18454
18455 So ``my'' ident on this machine is @samp{x6}.  This can be
18456 exploited---the following rule will raise the score on all followups to
18457 myself:
18458
18459 @lisp
18460 ("references"
18461  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
18462   1000 nil r))
18463 @end lisp
18464
18465 Whether it's the first two or first three characters that are ``yours''
18466 is system-dependent.
18467
18468
18469 @node Scoring On Other Headers
18470 @section Scoring On Other Headers
18471 @cindex scoring on other headers
18472
18473 Gnus is quite fast when scoring the ``traditional''
18474 headers---@samp{From}, @samp{Subject} and so on.  However, scoring
18475 other headers requires writing a @code{head} scoring rule, which means
18476 that Gnus has to request every single article from the back end to find
18477 matches.  This takes a long time in big groups.
18478
18479 Now, there's not much you can do about this for news groups, but for
18480 mail groups, you have greater control.  In the @pxref{To From
18481 Newsgroups} section of the manual, it's explained in greater detail what
18482 this mechanism does, but here's a cookbook example for @code{nnml} on
18483 how to allow scoring on the @samp{To} and @samp{Cc} headers.
18484
18485 Put the following in your @file{.gnus.el} file.
18486
18487 @lisp
18488 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
18489       nnmail-extra-headers gnus-extra-headers)
18490 @end lisp
18491
18492 Restart Gnus and rebuild your @code{nnml} overview files with the
18493 @kbd{M-x nnml-generate-nov-databases} command.  This will take a long
18494 time if you have much mail.
18495
18496 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
18497 so: @kbd{I e s p To RET <your name> RET}.
18498
18499 See?  Simple.
18500
18501
18502 @node Scoring Tips
18503 @section Scoring Tips
18504 @cindex scoring tips
18505
18506 @table @dfn
18507
18508 @item Crossposts
18509 @cindex crossposts
18510 @cindex scoring crossposts
18511 If you want to lower the score of crossposts, the line to match on is
18512 the @code{Xref} header.
18513 @lisp
18514 ("xref" (" talk.politics.misc:" -1000))
18515 @end lisp
18516
18517 @item Multiple crossposts
18518 If you want to lower the score of articles that have been crossposted to
18519 more than, say, 3 groups:
18520 @lisp
18521 ("xref"
18522   ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
18523    -1000 nil r))
18524 @end lisp
18525
18526 @item Matching on the body
18527 This is generally not a very good idea---it takes a very long time.
18528 Gnus actually has to fetch each individual article from the server.  But
18529 you might want to anyway, I guess.  Even though there are three match
18530 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
18531 and stick with it in each score file.  If you use any two, each article
18532 will be fetched @emph{twice}.  If you want to match a bit on the
18533 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
18534 the matches.
18535
18536 @item Marking as read
18537 You will probably want to mark articles that have scores below a certain
18538 number as read.  This is most easily achieved by putting the following
18539 in your @file{all.SCORE} file:
18540 @lisp
18541 ((mark -100))
18542 @end lisp
18543 You may also consider doing something similar with @code{expunge}.
18544
18545 @item Negated character classes
18546 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
18547 That will match newlines, which might lead to, well, The Unknown.  Say
18548 @code{[^abcd\n]*} instead.
18549 @end table
18550
18551
18552 @node Reverse Scoring
18553 @section Reverse Scoring
18554 @cindex reverse scoring
18555
18556 If you want to keep just articles that have @samp{Sex with Emacs} in the
18557 subject header, and expunge all other articles, you could put something
18558 like this in your score file:
18559
18560 @lisp
18561 (("subject"
18562   ("Sex with Emacs" 2))
18563  (mark 1)
18564  (expunge 1))
18565 @end lisp
18566
18567 So, you raise all articles that match @samp{Sex with Emacs} and mark the
18568 rest as read, and expunge them to boot.
18569
18570
18571 @node Global Score Files
18572 @section Global Score Files
18573 @cindex global score files
18574
18575 Sure, other newsreaders have ``global kill files''.  These are usually
18576 nothing more than a single kill file that applies to all groups, stored
18577 in the user's home directory.  Bah!  Puny, weak newsreaders!
18578
18579 What I'm talking about here are Global Score Files.  Score files from
18580 all over the world, from users everywhere, uniting all nations in one
18581 big, happy score file union!  Ange-score!  New and untested!
18582
18583 @vindex gnus-global-score-files
18584 All you have to do to use other people's score files is to set the
18585 @code{gnus-global-score-files} variable.  One entry for each score file,
18586 or each score file directory.  Gnus will decide by itself what score
18587 files are applicable to which group.
18588
18589 To use the score file
18590 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
18591 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
18592 say this:
18593
18594 @lisp
18595 (setq gnus-global-score-files
18596       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
18597         "/ftp@@ftp.some-where:/pub/score/"))
18598 @end lisp
18599
18600 @findex gnus-score-search-global-directories
18601 @noindent
18602 Simple, eh?  Directory names must end with a @samp{/}.  These
18603 directories are typically scanned only once during each Gnus session.
18604 If you feel the need to manually re-scan the remote directories, you can
18605 use the @code{gnus-score-search-global-directories} command.
18606
18607 Note that, at present, using this option will slow down group entry
18608 somewhat.  (That is---a lot.)
18609
18610 If you want to start maintaining score files for other people to use,
18611 just put your score file up for anonymous ftp and announce it to the
18612 world.  Become a retro-moderator!  Participate in the retro-moderator
18613 wars sure to ensue, where retro-moderators battle it out for the
18614 sympathy of the people, luring them to use their score files on false
18615 premises!  Yay!  The net is saved!
18616
18617 Here are some tips for the would-be retro-moderator, off the top of my
18618 head:
18619
18620 @itemize @bullet
18621
18622 @item
18623 Articles heavily crossposted are probably junk.
18624 @item
18625 To lower a single inappropriate article, lower by @code{Message-ID}.
18626 @item
18627 Particularly brilliant authors can be raised on a permanent basis.
18628 @item
18629 Authors that repeatedly post off-charter for the group can safely be
18630 lowered out of existence.
18631 @item
18632 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
18633 articles completely.
18634
18635 @item
18636 Use expiring score entries to keep the size of the file down.  You
18637 should probably have a long expiry period, though, as some sites keep
18638 old articles for a long time.
18639 @end itemize
18640
18641 ... I wonder whether other newsreaders will support global score files
18642 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
18643 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
18644 holding our breath yet?
18645
18646
18647 @node Kill Files
18648 @section Kill Files
18649 @cindex kill files
18650
18651 Gnus still supports those pesky old kill files.  In fact, the kill file
18652 entries can now be expiring, which is something I wrote before Daniel
18653 Quinlan thought of doing score files, so I've left the code in there.
18654
18655 In short, kill processing is a lot slower (and I do mean @emph{a lot})
18656 than score processing, so it might be a good idea to rewrite your kill
18657 files into score files.
18658
18659 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
18660 forms into this file, which means that you can use kill files as some
18661 sort of primitive hook function to be run on group entry, even though
18662 that isn't a very good idea.
18663
18664 Normal kill files look like this:
18665
18666 @lisp
18667 (gnus-kill "From" "Lars Ingebrigtsen")
18668 (gnus-kill "Subject" "ding")
18669 (gnus-expunge "X")
18670 @end lisp
18671
18672 This will mark every article written by me as read, and remove the
18673 marked articles from the summary buffer.  Very useful, you'll agree.
18674
18675 Other programs use a totally different kill file syntax.  If Gnus
18676 encounters what looks like a @code{rn} kill file, it will take a stab at
18677 interpreting it.
18678
18679 Two summary functions for editing a GNUS kill file:
18680
18681 @table @kbd
18682
18683 @item M-k
18684 @kindex M-k (Summary)
18685 @findex gnus-summary-edit-local-kill
18686 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
18687
18688 @item M-K
18689 @kindex M-K (Summary)
18690 @findex gnus-summary-edit-global-kill
18691 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
18692 @end table
18693
18694 Two group mode functions for editing the kill files:
18695
18696 @table @kbd
18697
18698 @item M-k
18699 @kindex M-k (Group)
18700 @findex gnus-group-edit-local-kill
18701 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
18702
18703 @item M-K
18704 @kindex M-K (Group)
18705 @findex gnus-group-edit-global-kill
18706 Edit the general kill file (@code{gnus-group-edit-global-kill}).
18707 @end table
18708
18709 Kill file variables:
18710
18711 @table @code
18712 @item gnus-kill-file-name
18713 @vindex gnus-kill-file-name
18714 A kill file for the group @samp{soc.motss} is normally called
18715 @file{soc.motss.KILL}.  The suffix appended to the group name to get
18716 this file name is detailed by the @code{gnus-kill-file-name} variable.
18717 The ``global'' kill file (not in the score file sense of ``global'', of
18718 course) is just called @file{KILL}.
18719
18720 @vindex gnus-kill-save-kill-file
18721 @item gnus-kill-save-kill-file
18722 If this variable is non-@code{nil}, Gnus will save the
18723 kill file after processing, which is necessary if you use expiring
18724 kills.
18725
18726 @item gnus-apply-kill-hook
18727 @vindex gnus-apply-kill-hook
18728 @findex gnus-apply-kill-file-unless-scored
18729 @findex gnus-apply-kill-file
18730 A hook called to apply kill files to a group.  It is
18731 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
18732 kill file if you have a score file for the same group, you can set this
18733 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
18734 kill files to be processed, you should set this variable to @code{nil}.
18735
18736 @item gnus-kill-file-mode-hook
18737 @vindex gnus-kill-file-mode-hook
18738 A hook called in kill-file mode buffers.
18739
18740 @end table
18741
18742
18743 @node Converting Kill Files
18744 @section Converting Kill Files
18745 @cindex kill files
18746 @cindex converting kill files
18747
18748 If you have loads of old kill files, you may want to convert them into
18749 score files.  If they are ``regular'', you can use
18750 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
18751 by hand.
18752
18753 The kill to score conversion package isn't included in Gnus by default.
18754 You can fetch it from
18755 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
18756
18757 If your old kill files are very complex---if they contain more
18758 non-@code{gnus-kill} forms than not, you'll have to convert them by
18759 hand.  Or just let them be as they are.  Gnus will still use them as
18760 before.
18761
18762
18763 @node GroupLens
18764 @section GroupLens
18765 @cindex GroupLens
18766
18767 GroupLens (@uref{http://www.cs.umn.edu/Research/GroupLens/}) is a
18768 collaborative filtering system that helps you work together with other
18769 people to find the quality news articles out of the huge volume of
18770 news articles generated every day.
18771
18772 To accomplish this the GroupLens system combines your opinions about
18773 articles you have already read with the opinions of others who have done
18774 likewise and gives you a personalized prediction for each unread news
18775 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
18776 rate articles, and finds other people that rate articles the same way.
18777 Once it has found some people you agree with it tells you, in the form
18778 of a prediction, what they thought of the article.  You can use this
18779 prediction to help you decide whether or not you want to read the
18780 article.
18781
18782 @sc{Note:} Unfortunately the GroupLens system seems to have shut down,
18783 so this section is mostly of historical interest.
18784
18785 @menu
18786 * Using GroupLens::             How to make Gnus use GroupLens.
18787 * Rating Articles::             Letting GroupLens know how you rate articles.
18788 * Displaying Predictions::      Displaying predictions given by GroupLens.
18789 * GroupLens Variables::         Customizing GroupLens.
18790 @end menu
18791
18792
18793 @node Using GroupLens
18794 @subsection Using GroupLens
18795
18796 To use GroupLens you must register a pseudonym with your local Better
18797 Bit Bureau (BBB).
18798 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
18799 better bit in town at the moment.
18800
18801 Once you have registered you'll need to set a couple of variables.
18802
18803 @table @code
18804
18805 @item gnus-use-grouplens
18806 @vindex gnus-use-grouplens
18807 Setting this variable to a non-@code{nil} value will make Gnus hook into
18808 all the relevant GroupLens functions.
18809
18810 @item grouplens-pseudonym
18811 @vindex grouplens-pseudonym
18812 This variable should be set to the pseudonym you got when registering
18813 with the Better Bit Bureau.
18814
18815 @item grouplens-newsgroups
18816 @vindex grouplens-newsgroups
18817 A list of groups that you want to get GroupLens predictions for.
18818
18819 @end table
18820
18821 That's the minimum of what you need to get up and running with GroupLens.
18822 Once you've registered, GroupLens will start giving you scores for
18823 articles based on the average of what other people think.  But, to get
18824 the real benefit of GroupLens you need to start rating articles
18825 yourself.  Then the scores GroupLens gives you will be personalized for
18826 you, based on how the people you usually agree with have already rated.
18827
18828
18829 @node Rating Articles
18830 @subsection Rating Articles
18831
18832 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
18833 Where 1 means something like this article is a waste of bandwidth and 5
18834 means that the article was really good.  The basic question to ask
18835 yourself is, "on a scale from 1 to 5 would I like to see more articles
18836 like this one?"
18837
18838 There are four ways to enter a rating for an article in GroupLens.
18839
18840 @table @kbd
18841
18842 @item r
18843 @kindex r (GroupLens)
18844 @findex bbb-summary-rate-article
18845 This function will prompt you for a rating on a scale of one to five.
18846
18847 @item k
18848 @kindex k (GroupLens)
18849 @findex grouplens-score-thread
18850 This function will prompt you for a rating, and rate all the articles in
18851 the thread.  This is really useful for some of those long running giant
18852 threads in rec.humor.
18853
18854 @end table
18855
18856 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
18857 the score of the article you're reading.
18858
18859 @table @kbd
18860
18861 @item 1-5 n
18862 @kindex n (GroupLens)
18863 @findex grouplens-next-unread-article
18864 Rate the article and go to the next unread article.
18865
18866 @item 1-5 ,
18867 @kindex , (GroupLens)
18868 @findex grouplens-best-unread-article
18869 Rate the article and go to the next unread article with the highest score.
18870
18871 @end table
18872
18873 If you want to give the current article a score of 4 and then go to the
18874 next article, just type @kbd{4 n}.
18875
18876
18877 @node Displaying Predictions
18878 @subsection Displaying Predictions
18879
18880 GroupLens makes a prediction for you about how much you will like a
18881 news article.  The predictions from GroupLens are on a scale from 1 to
18882 5, where 1 is the worst and 5 is the best.  You can use the predictions
18883 from GroupLens in one of three ways controlled by the variable
18884 @code{gnus-grouplens-override-scoring}.
18885
18886 @vindex gnus-grouplens-override-scoring
18887 There are three ways to display predictions in grouplens.  You may
18888 choose to have the GroupLens scores contribute to, or override the
18889 regular gnus scoring mechanism.  override is the default; however, some
18890 people prefer to see the Gnus scores plus the grouplens scores.  To get
18891 the separate scoring behavior you need to set
18892 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
18893 GroupLens predictions combined with the grouplens scores set it to
18894 @code{'override} and to combine the scores set
18895 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
18896 the combine option you will also want to set the values for
18897 @code{grouplens-prediction-offset} and
18898 @code{grouplens-score-scale-factor}.
18899
18900 @vindex grouplens-prediction-display
18901 In either case, GroupLens gives you a few choices for how you would like
18902 to see your predictions displayed.  The display of predictions is
18903 controlled by the @code{grouplens-prediction-display} variable.
18904
18905 The following are valid values for that variable.
18906
18907 @table @code
18908 @item prediction-spot
18909 The higher the prediction, the further to the right an @samp{*} is
18910 displayed.
18911
18912 @item confidence-interval
18913 A numeric confidence interval.
18914
18915 @item prediction-bar
18916 The higher the prediction, the longer the bar.
18917
18918 @item confidence-bar
18919 Numerical confidence.
18920
18921 @item confidence-spot
18922 The spot gets bigger with more confidence.
18923
18924 @item prediction-num
18925 Plain-old numeric value.
18926
18927 @item confidence-plus-minus
18928 Prediction +/- confidence.
18929
18930 @end table
18931
18932
18933 @node GroupLens Variables
18934 @subsection GroupLens Variables
18935
18936 @table @code
18937
18938 @item gnus-summary-grouplens-line-format
18939 The summary line format used in GroupLens-enhanced summary buffers.  It
18940 accepts the same specs as the normal summary line format (@pxref{Summary
18941 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%)
18942 %s\n}.
18943
18944 @item grouplens-bbb-host
18945 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
18946 default.
18947
18948 @item grouplens-bbb-port
18949 Port of the host running the bbbd server.  The default is 9000.
18950
18951 @item grouplens-score-offset
18952 Offset the prediction by this value.  In other words, subtract the
18953 prediction value by this number to arrive at the effective score.  The
18954 default is 0.
18955
18956 @item grouplens-score-scale-factor
18957 This variable allows the user to magnify the effect of GroupLens scores.
18958 The scale factor is applied after the offset.  The default is 1.
18959
18960 @end table
18961
18962
18963 @node Advanced Scoring
18964 @section Advanced Scoring
18965
18966 Scoring on Subjects and From headers is nice enough, but what if you're
18967 really interested in what a person has to say only when she's talking
18968 about a particular subject?  Or what if you really don't want to
18969 read what person A has to say when she's following up to person B, but
18970 want to read what she says when she's following up to person C?
18971
18972 By using advanced scoring rules you may create arbitrarily complex
18973 scoring patterns.
18974
18975 @menu
18976 * Advanced Scoring Syntax::     A definition.
18977 * Advanced Scoring Examples::   What they look like.
18978 * Advanced Scoring Tips::       Getting the most out of it.
18979 @end menu
18980
18981
18982 @node Advanced Scoring Syntax
18983 @subsection Advanced Scoring Syntax
18984
18985 Ordinary scoring rules have a string as the first element in the rule.
18986 Advanced scoring rules have a list as the first element.  The second
18987 element is the score to be applied if the first element evaluated to a
18988 non-@code{nil} value.
18989
18990 These lists may consist of three logical operators, one redirection
18991 operator, and various match operators.
18992
18993 Logical operators:
18994
18995 @table @code
18996 @item &
18997 @itemx and
18998 This logical operator will evaluate each of its arguments until it finds
18999 one that evaluates to @code{false}, and then it'll stop.  If all arguments
19000 evaluate to @code{true} values, then this operator will return
19001 @code{true}.
19002
19003 @item |
19004 @itemx or
19005 This logical operator will evaluate each of its arguments until it finds
19006 one that evaluates to @code{true}.  If no arguments are @code{true},
19007 then this operator will return @code{false}.
19008
19009 @item !
19010 @itemx not
19011 @itemx Â¬
19012 This logical operator only takes a single argument.  It returns the
19013 logical negation of the value of its argument.
19014
19015 @end table
19016
19017 There is an @dfn{indirection operator} that will make its arguments
19018 apply to the ancestors of the current article being scored.  For
19019 instance, @code{1-} will make score rules apply to the parent of the
19020 current article.  @code{2-} will make score rules apply to the
19021 grandparent of the current article.  Alternatively, you can write
19022 @code{^^}, where the number of @code{^}s (carets) says how far back into
19023 the ancestry you want to go.
19024
19025 Finally, we have the match operators.  These are the ones that do the
19026 real work.  Match operators are header name strings followed by a match
19027 and a match type.  A typical match operator looks like @samp{("from"
19028 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
19029 simple scoring, and the match types are also the same.
19030
19031
19032 @node Advanced Scoring Examples
19033 @subsection Advanced Scoring Examples
19034
19035 Please note that the following examples are score file rules.  To
19036 make a complete score file from them, surround them with another pair
19037 of parentheses.
19038
19039 Let's say you want to increase the score of articles written by Lars
19040 when he's talking about Gnus:
19041
19042 @example
19043 ((&
19044   ("from" "Lars Ingebrigtsen")
19045   ("subject" "Gnus"))
19046  1000)
19047 @end example
19048
19049 Quite simple, huh?
19050
19051 When he writes long articles, he sometimes has something nice to say:
19052
19053 @example
19054 ((&
19055   ("from" "Lars Ingebrigtsen")
19056   (|
19057    ("subject" "Gnus")
19058    ("lines" 100 >)))
19059  1000)
19060 @end example
19061
19062 However, when he responds to things written by Reig Eigil Logge, you
19063 really don't want to read what he's written:
19064
19065 @example
19066 ((&
19067   ("from" "Lars Ingebrigtsen")
19068   (1- ("from" "Reig Eigir Logge")))
19069  -100000)
19070 @end example
19071
19072 Everybody that follows up Redmondo when he writes about disappearing
19073 socks should have their scores raised, but only when they talk about
19074 white socks.  However, when Lars talks about socks, it's usually not
19075 very interesting:
19076
19077 @example
19078 ((&
19079   (1-
19080    (&
19081     ("from" "redmondo@@.*no" r)
19082     ("body" "disappearing.*socks" t)))
19083   (! ("from" "Lars Ingebrigtsen"))
19084   ("body" "white.*socks"))
19085  1000)
19086 @end example
19087
19088 The possibilities are endless.
19089
19090
19091 @node Advanced Scoring Tips
19092 @subsection Advanced Scoring Tips
19093
19094 The @code{&} and @code{|} logical operators do short-circuit logic.
19095 That is, they stop processing their arguments when it's clear what the
19096 result of the operation will be.  For instance, if one of the arguments
19097 of an @code{&} evaluates to @code{false}, there's no point in evaluating
19098 the rest of the arguments.  This means that you should put slow matches
19099 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
19100 @samp{subject}) first.
19101
19102 The indirection arguments (@code{1-} and so on) will make their
19103 arguments work on previous generations of the thread.  If you say
19104 something like:
19105
19106 @example
19107 ...
19108 (1-
19109  (1-
19110   ("from" "lars")))
19111 ...
19112 @end example
19113
19114 Then that means "score on the from header of the grandparent of the
19115 current article".  An indirection is quite fast, but it's better to say:
19116
19117 @example
19118 (1-
19119  (&
19120   ("from" "Lars")
19121   ("subject" "Gnus")))
19122 @end example
19123
19124 than it is to say:
19125
19126 @example
19127 (&
19128  (1- ("from" "Lars"))
19129  (1- ("subject" "Gnus")))
19130 @end example
19131
19132
19133 @node Score Decays
19134 @section Score Decays
19135 @cindex score decays
19136 @cindex decays
19137
19138 You may find that your scores have a tendency to grow without
19139 bounds, especially if you're using adaptive scoring.  If scores get too
19140 big, they lose all meaning---they simply max out and it's difficult to
19141 use them in any sensible way.
19142
19143 @vindex gnus-decay-scores
19144 @findex gnus-decay-score
19145 @vindex gnus-decay-score-function
19146 Gnus provides a mechanism for decaying scores to help with this problem.
19147 When score files are loaded and @code{gnus-decay-scores} is
19148 non-@code{nil}, Gnus will run the score files through the decaying
19149 mechanism thereby lowering the scores of all non-permanent score rules.
19150 The decay itself if performed by the @code{gnus-decay-score-function}
19151 function, which is @code{gnus-decay-score} by default.  Here's the
19152 definition of that function:
19153
19154 @lisp
19155 (defun gnus-decay-score (score)
19156   "Decay SCORE.
19157 This is done according to `gnus-score-decay-constant'
19158 and `gnus-score-decay-scale'."
19159   (floor
19160    (- score
19161       (* (if (< score 0) 1 -1)
19162          (min (abs score)
19163               (max gnus-score-decay-constant
19164                    (* (abs score)
19165                       gnus-score-decay-scale)))))))
19166 @end lisp
19167
19168 @vindex gnus-score-decay-scale
19169 @vindex gnus-score-decay-constant
19170 @code{gnus-score-decay-constant} is 3 by default and
19171 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
19172
19173 @enumerate
19174 @item
19175 Scores between -3 and 3 will be set to 0 when this function is called.
19176
19177 @item
19178 Scores with magnitudes between 3 and 60 will be shrunk by 3.
19179
19180 @item
19181 Scores with magnitudes greater than 60 will be shrunk by 5% of the
19182 score.
19183 @end enumerate
19184
19185 If you don't like this decay function, write your own.  It is called
19186 with the score to be decayed as its only parameter, and it should return
19187 the new score, which should be an integer.
19188
19189 Gnus will try to decay scores once a day.  If you haven't run Gnus for
19190 four days, Gnus will decay the scores four times, for instance.
19191
19192 @iftex
19193 @iflatex
19194 @chapter Message
19195 @include message.texi
19196 @chapter Emacs MIME
19197 @include emacs-mime.texi
19198 @chapter Sieve
19199 @include sieve.texi
19200 @c @chapter PGG
19201 @c @include pgg.texi
19202 @end iflatex
19203 @end iftex
19204
19205 @node Various
19206 @chapter Various
19207
19208 @menu
19209 * Process/Prefix::              A convention used by many treatment commands.
19210 * Interactive::                 Making Gnus ask you many questions.
19211 * Symbolic Prefixes::           How to supply some Gnus functions with options.
19212 * Formatting Variables::        You can specify what buffers should look like.
19213 * Window Layout::               Configuring the Gnus buffer windows.
19214 * Faces and Fonts::             How to change how faces look.
19215 * Compilation::                 How to speed Gnus up.
19216 * Mode Lines::                  Displaying information in the mode lines.
19217 * Highlighting and Menus::      Making buffers look all nice and cozy.
19218 * Buttons::                     Get tendinitis in ten easy steps!
19219 * Daemons::                     Gnus can do things behind your back.
19220 * NoCeM::                       How to avoid spam and other fatty foods.
19221 * Undo::                        Some actions can be undone.
19222 * Predicate Specifiers::        Specifying predicates.
19223 * Moderation::                  What to do if you're a moderator.
19224 * Image Enhancements::          Modern versions of Emacs/XEmacs can display images.
19225 * Fuzzy Matching::              What's the big fuzz?
19226 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
19227 * Various Various::             Things that are really various.
19228 @end menu
19229
19230
19231 @node Process/Prefix
19232 @section Process/Prefix
19233 @cindex process/prefix convention
19234
19235 Many functions, among them functions for moving, decoding and saving
19236 articles, use what is known as the @dfn{Process/Prefix convention}.
19237
19238 This is a method for figuring out what articles the user wants the
19239 command to be performed on.
19240
19241 It goes like this:
19242
19243 If the numeric prefix is N, perform the operation on the next N
19244 articles, starting with the current one.  If the numeric prefix is
19245 negative, perform the operation on the previous N articles, starting
19246 with the current one.
19247
19248 @vindex transient-mark-mode
19249 If @code{transient-mark-mode} in non-@code{nil} and the region is
19250 active, all articles in the region will be worked upon.
19251
19252 If there is no numeric prefix, but some articles are marked with the
19253 process mark, perform the operation on the articles marked with
19254 the process mark.
19255
19256 If there is neither a numeric prefix nor any articles marked with the
19257 process mark, just perform the operation on the current article.
19258
19259 Quite simple, really, but it needs to be made clear so that surprises
19260 are avoided.
19261
19262 Commands that react to the process mark will push the current list of
19263 process marked articles onto a stack and will then clear all process
19264 marked articles.  You can restore the previous configuration with the
19265 @kbd{M P y} command (@pxref{Setting Process Marks}).
19266
19267 @vindex gnus-summary-goto-unread
19268 One thing that seems to shock & horrify lots of people is that, for
19269 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
19270 Since each @kbd{d} (which marks the current article as read) by default
19271 goes to the next unread article after marking, this means that @kbd{3 d}
19272 will mark the next three unread articles as read, no matter what the
19273 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
19274 @code{nil} for a more straightforward action.
19275
19276 Many commands do not use the process/prefix convention.  All commands
19277 that do explicitly say so in this manual.  To apply the process/prefix
19278 convention to commands that do not use it, you can use the @kbd{M-&}
19279 command.  For instance, to mark all the articles in the group as
19280 expirable, you could say `M P b M-& E'.
19281
19282
19283 @node Interactive
19284 @section Interactive
19285 @cindex interaction
19286
19287 @table @code
19288
19289 @item gnus-novice-user
19290 @vindex gnus-novice-user
19291 If this variable is non-@code{nil}, you are either a newcomer to the
19292 World of Usenet, or you are very cautious, which is a nice thing to be,
19293 really.  You will be given questions of the type ``Are you sure you want
19294 to do this?'' before doing anything dangerous.  This is @code{t} by
19295 default.
19296
19297 @item gnus-expert-user
19298 @vindex gnus-expert-user
19299 If this variable is non-@code{nil}, you will seldom be asked any
19300 questions by Gnus.  It will simply assume you know what you're doing, no
19301 matter how strange.
19302
19303 @item gnus-interactive-catchup
19304 @vindex gnus-interactive-catchup
19305 Require confirmation before catching up a group if non-@code{nil}.  It
19306 is @code{t} by default.
19307
19308 @item gnus-interactive-exit
19309 @vindex gnus-interactive-exit
19310 Require confirmation before exiting Gnus.  This variable is @code{t} by
19311 default.
19312 @end table
19313
19314
19315 @node Symbolic Prefixes
19316 @section Symbolic Prefixes
19317 @cindex symbolic prefixes
19318
19319 Quite a lot of Emacs commands react to the (numeric) prefix.  For
19320 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
19321 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
19322 rule of 900 to the current article.
19323
19324 This is all nice and well, but what if you want to give a command some
19325 additional information?  Well, what most commands do is interpret the
19326 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
19327 doesn't want a backup file to be created when saving the current buffer,
19328 for instance.  But what if you want to save without making a backup
19329 file, and you want Emacs to flash lights and play a nice tune at the
19330 same time?  You can't, and you're probably perfectly happy that way.
19331
19332 @kindex M-i (Summary)
19333 @findex gnus-symbolic-argument
19334 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
19335 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
19336 character typed in is the value.  You can stack as many @kbd{M-i}
19337 prefixes as you want.  @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
19338 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b C-M-u} means
19339 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
19340 @code{b}''.  You get the drift.
19341
19342 Typing in symbolic prefixes to commands that don't accept them doesn't
19343 hurt, but it doesn't do any good either.  Currently not many Gnus
19344 functions make use of the symbolic prefix.
19345
19346 If you're interested in how Gnus implements this, @pxref{Extended
19347 Interactive}.
19348
19349
19350 @node Formatting Variables
19351 @section Formatting Variables
19352 @cindex formatting variables
19353
19354 Throughout this manual you've probably noticed lots of variables called
19355 things like @code{gnus-group-line-format} and
19356 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
19357 output lines in the various buffers.  There's quite a lot of them.
19358 Fortunately, they all use the same syntax, so there's not that much to
19359 be annoyed by.
19360
19361 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
19362 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
19363 lots of percentages everywhere.
19364
19365 @menu
19366 * Formatting Basics::           A formatting variable is basically a format string.
19367 * Mode Line Formatting::        Some rules about mode line formatting variables.
19368 * Advanced Formatting::         Modifying output in various ways.
19369 * User-Defined Specs::          Having Gnus call your own functions.
19370 * Formatting Fonts::            Making the formatting look colorful and nice.
19371 * Positioning Point::           Moving point to a position after an operation.
19372 * Tabulation::                  Tabulating your output.
19373 * Wide Characters::             Dealing with wide characters.
19374 @end menu
19375
19376 Currently Gnus uses the following formatting variables:
19377 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
19378 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
19379 @code{gnus-group-mode-line-format},
19380 @code{gnus-summary-mode-line-format},
19381 @code{gnus-article-mode-line-format},
19382 @code{gnus-server-mode-line-format}, and
19383 @code{gnus-summary-pick-line-format}.
19384
19385 All these format variables can also be arbitrary elisp forms.  In that
19386 case, they will be @code{eval}ed to insert the required lines.
19387
19388 @kindex M-x gnus-update-format
19389 @findex gnus-update-format
19390 Gnus includes a command to help you while creating your own format
19391 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
19392 update the spec in question and pop you to a buffer where you can
19393 examine the resulting lisp code to be run to generate the line.
19394
19395
19396
19397 @node Formatting Basics
19398 @subsection Formatting Basics
19399
19400 Each @samp{%} element will be replaced by some string or other when the
19401 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
19402 spec, and pad with spaces to get a 5-character field''.
19403
19404 As with normal C and Emacs Lisp formatting strings, the numerical
19405 modifier between the @samp{%} and the formatting type character will
19406 @dfn{pad} the output so that it is always at least that long.
19407 @samp{%5y} will make the field always (at least) five characters wide by
19408 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
19409 the right instead.
19410
19411 You may also wish to limit the length of the field to protect against
19412 particularly wide values.  For that you can say @samp{%4,6y}, which
19413 means that the field will never be more than 6 characters wide and never
19414 less than 4 characters wide.
19415
19416 Also Gnus supports some extended format specifications, such as
19417 @samp{%&user-date;}.
19418
19419
19420 @node Mode Line Formatting
19421 @subsection Mode Line Formatting
19422
19423 Mode line formatting variables (e.g.,
19424 @code{gnus-summary-mode-line-format}) follow the same rules as other,
19425 buffer line oriented formatting variables (@pxref{Formatting Basics})
19426 with the following two differences:
19427
19428 @enumerate
19429
19430 @item
19431 There must be no newline (@samp{\n}) at the end.
19432
19433 @item
19434 The special @samp{%%b} spec can be used to display the buffer name.
19435 Well, it's no spec at all, really---@samp{%%} is just a way to quote
19436 @samp{%} to allow it to pass through the formatting machinery unmangled,
19437 so that Emacs receives @samp{%b}, which is something the Emacs mode line
19438 display interprets to mean ``show the buffer name''.  For a full list of
19439 mode line specs Emacs understands, see the documentation of the
19440 @code{mode-line-format} variable.
19441
19442 @end enumerate
19443
19444
19445 @node Advanced Formatting
19446 @subsection Advanced Formatting
19447
19448 It is frequently useful to post-process the fields in some way.
19449 Padding, limiting, cutting off parts and suppressing certain values can
19450 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
19451 look like @samp{%~(cut 3)~(ignore "0")y}.
19452
19453 These are the valid modifiers:
19454
19455 @table @code
19456 @item pad
19457 @itemx pad-left
19458 Pad the field to the left with spaces until it reaches the required
19459 length.
19460
19461 @item pad-right
19462 Pad the field to the right with spaces until it reaches the required
19463 length.
19464
19465 @item max
19466 @itemx max-left
19467 Cut off characters from the left until it reaches the specified length.
19468
19469 @item max-right
19470 Cut off characters from the right until it reaches the specified
19471 length.
19472
19473 @item cut
19474 @itemx cut-left
19475 Cut off the specified number of characters from the left.
19476
19477 @item cut-right
19478 Cut off the specified number of characters from the right.
19479
19480 @item ignore
19481 Return an empty string if the field is equal to the specified value.
19482
19483 @item form
19484 Use the specified form as the field value when the @samp{@@} spec is
19485 used.
19486
19487 Here's an example:
19488
19489 @lisp
19490 "~(form (current-time-string))@@"
19491 @end lisp
19492
19493 @end table
19494
19495 Let's take an example.  The @samp{%o} spec in the summary mode lines
19496 will return a date in compact ISO8601 format---@samp{19960809T230410}.
19497 This is quite a mouthful, so we want to shave off the century number and
19498 the time, leaving us with a six-character date.  That would be
19499 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
19500 maxing, and we need the padding to ensure that the date is never less
19501 than 6 characters to make it look nice in columns.)
19502
19503 Ignoring is done first; then cutting; then maxing; and then as the very
19504 last operation, padding.
19505
19506 @vindex gnus-compile-user-specs
19507 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
19508 default) with your strong personality, and use a lots of these advanced
19509 thingies, you'll find that Gnus gets quite slow.  This can be helped
19510 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
19511 the look of your lines.
19512 @xref{Compilation}.
19513
19514
19515 @node User-Defined Specs
19516 @subsection User-Defined Specs
19517
19518 All the specs allow for inserting user defined specifiers---@samp{u}.
19519 The next character in the format string should be a letter.  Gnus
19520 will call the function @code{gnus-user-format-function-}@samp{X}, where
19521 @samp{X} is the letter following @samp{%u}.  The function will be passed
19522 a single parameter---what the parameter means depends on what buffer
19523 it's being called from.  The function should return a string, which will
19524 be inserted into the buffer just like information from any other
19525 specifier.  This function may also be called with dummy values, so it
19526 should protect against that.
19527
19528 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
19529 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
19530
19531 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
19532 much the same without defining new functions.  Here's an example:
19533 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
19534 given here will be evaluated to yield the current line number, and then
19535 inserted.
19536
19537
19538 @node Formatting Fonts
19539 @subsection Formatting Fonts
19540
19541 There are specs for highlighting, and these are shared by all the format
19542 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
19543 the special @code{mouse-face} property set, which means that it will be
19544 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
19545 over it.
19546
19547 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
19548 normal faces set using @code{gnus-face-0}, which is @code{bold} by
19549 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
19550 and so on.  Create as many faces as you wish.  The same goes for the
19551 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
19552 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
19553
19554 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
19555 special @code{balloon-help} property set to @code{gnus-balloon-face-0}.
19556 If you say @samp{%1<<}, you'll get @code{gnus-balloon-face-1} and so on.
19557 The @code{gnus-balloon-face-*} variables should be either strings or
19558 symbols naming functions that return a string.  When the mouse passes
19559 over text with this property set, a balloon window will appear and
19560 display the string.  Please refer to @ref{(emacs)Help Echo} (in GNU
19561 Emacs) or the doc string of @code{balloon-help-mode} (in XEmacs) for
19562 more information on this.  (For technical reasons, the guillemets have
19563 been approximated as @samp{<<} and @samp{>>} in this paragraph.)
19564
19565 Here's an alternative recipe for the group buffer:
19566
19567 @lisp
19568 ;; Create three face types.
19569 (setq gnus-face-1 'bold)
19570 (setq gnus-face-3 'italic)
19571
19572 ;; We want the article count to be in
19573 ;; a bold and green face.  So we create
19574 ;; a new face called `my-green-bold'.
19575 (copy-face 'bold 'my-green-bold)
19576 ;; Set the color.
19577 (set-face-foreground 'my-green-bold "ForestGreen")
19578 (setq gnus-face-2 'my-green-bold)
19579
19580 ;; Set the new & fancy format.
19581 (setq gnus-group-line-format
19582       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
19583 @end lisp
19584
19585 I'm sure you'll be able to use this scheme to create totally unreadable
19586 and extremely vulgar displays.  Have fun!
19587
19588 Note that the @samp{%(} specs (and friends) do not make any sense on the
19589 mode-line variables.
19590
19591 @node Positioning Point
19592 @subsection Positioning Point
19593
19594 Gnus usually moves point to a pre-defined place on each line in most
19595 buffers.  By default, point move to the first colon character on the
19596 line.  You can customize this behaviour in three different ways.
19597
19598 You can move the colon character to somewhere else on the line.
19599
19600 @findex gnus-goto-colon
19601 You can redefine the function that moves the point to the colon.  The
19602 function is called @code{gnus-goto-colon}.
19603
19604 But perhaps the most convenient way to deal with this, if you don't want
19605 to have a colon in your line, is to use the @samp{%C} specifier.  If you
19606 put a @samp{%C} somewhere in your format line definition, Gnus will
19607 place point there.
19608
19609
19610 @node Tabulation
19611 @subsection Tabulation
19612
19613 You can usually line up your displays by padding and cutting your
19614 strings.  However, when combining various strings of different size, it
19615 can often be more convenient to just output the strings, and then worry
19616 about lining up the following text afterwards.
19617
19618 To do that, Gnus supplies tabulator specs--@samp{%=}.  There are two
19619 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
19620
19621 @samp{%50=} will insert space characters to pad the line up to column
19622 50.  If the text is already past column 50, nothing will be inserted.
19623 This is the soft tabulator.
19624
19625 @samp{%-50=} will insert space characters to pad the line up to column
19626 50.  If the text is already past column 50, the excess text past column
19627 50 will be removed.  This is the hard tabulator.
19628
19629
19630 @node Wide Characters
19631 @subsection Wide Characters
19632
19633 Proportional fonts in most countries have characters of the same width.
19634 Some countries, however, use Latin characters mixed with wider
19635 characters---most notable East Asian countries.
19636
19637 The problem is that when formatting, Gnus assumes that if a string is 10
19638 characters wide, it'll be 10 Latin characters wide on the screen.  In
19639 these countries, that's not true.
19640
19641 @vindex gnus-use-correct-string-widths
19642 To help fix this, you can set @code{gnus-use-correct-string-widths} to
19643 @code{t}.  This makes buffer generation slower, but the results will be
19644 prettier.  The default value under XEmacs is @code{t} but @code{nil}
19645 for Emacs.
19646
19647
19648 @node Window Layout
19649 @section Window Layout
19650 @cindex window layout
19651
19652 No, there's nothing here about X, so be quiet.
19653
19654 @vindex gnus-use-full-window
19655 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
19656 other windows and occupy the entire Emacs screen by itself.  It is
19657 @code{t} by default.
19658
19659 Setting this variable to @code{nil} kinda works, but there are
19660 glitches.  Use at your own peril.
19661
19662 @vindex gnus-buffer-configuration
19663 @code{gnus-buffer-configuration} describes how much space each Gnus
19664 buffer should be given.  Here's an excerpt of this variable:
19665
19666 @lisp
19667 ((group (vertical 1.0 (group 1.0 point)
19668                       (if gnus-carpal (group-carpal 4))))
19669  (article (vertical 1.0 (summary 0.25 point)
19670                         (article 1.0))))
19671 @end lisp
19672
19673 This is an alist.  The @dfn{key} is a symbol that names some action or
19674 other.  For instance, when displaying the group buffer, the window
19675 configuration function will use @code{group} as the key.  A full list of
19676 possible names is listed below.
19677
19678 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
19679 should occupy.  To take the @code{article} split as an example -
19680
19681 @lisp
19682 (article (vertical 1.0 (summary 0.25 point)
19683                        (article 1.0)))
19684 @end lisp
19685
19686 This @dfn{split} says that the summary buffer should occupy 25% of upper
19687 half of the screen, and that it is placed over the article buffer.  As
19688 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
19689 reaching for that calculator there).  However, the special number
19690 @code{1.0} is used to signal that this buffer should soak up all the
19691 rest of the space available after the rest of the buffers have taken
19692 whatever they need.  There should be only one buffer with the @code{1.0}
19693 size spec per split.
19694
19695 Point will be put in the buffer that has the optional third element
19696 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
19697 split where the tag @code{frame-focus} is a member (i.e. is the third or
19698 fourth element in the list, depending on whether the @code{point} tag is
19699 present) gets focus.
19700
19701 Here's a more complicated example:
19702
19703 @lisp
19704 (article (vertical 1.0 (group 4)
19705                        (summary 0.25 point)
19706                        (if gnus-carpal (summary-carpal 4))
19707                        (article 1.0)))
19708 @end lisp
19709
19710 If the size spec is an integer instead of a floating point number,
19711 then that number will be used to say how many lines a buffer should
19712 occupy, not a percentage.
19713
19714 If the @dfn{split} looks like something that can be @code{eval}ed (to be
19715 precise---if the @code{car} of the split is a function or a subr), this
19716 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
19717 be used as a split.  This means that there will be three buffers if
19718 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
19719 is non-@code{nil}.
19720
19721 Not complicated enough for you?  Well, try this on for size:
19722
19723 @lisp
19724 (article (horizontal 1.0
19725              (vertical 0.5
19726                  (group 1.0)
19727                  (gnus-carpal 4))
19728              (vertical 1.0
19729                  (summary 0.25 point)
19730                  (summary-carpal 4)
19731                  (article 1.0))))
19732 @end lisp
19733
19734 Whoops.  Two buffers with the mystery 100% tag.  And what's that
19735 @code{horizontal} thingie?
19736
19737 If the first element in one of the split is @code{horizontal}, Gnus will
19738 split the window horizontally, giving you two windows side-by-side.
19739 Inside each of these strips you may carry on all you like in the normal
19740 fashion.  The number following @code{horizontal} says what percentage of
19741 the screen is to be given to this strip.
19742
19743 For each split, there @emph{must} be one element that has the 100% tag.
19744 The splitting is never accurate, and this buffer will eat any leftover
19745 lines from the splits.
19746
19747 To be slightly more formal, here's a definition of what a valid split
19748 may look like:
19749
19750 @example
19751 split      = frame | horizontal | vertical | buffer | form
19752 frame      = "(frame " size *split ")"
19753 horizontal = "(horizontal " size *split ")"
19754 vertical   = "(vertical " size *split ")"
19755 buffer     = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
19756 size       = number | frame-params
19757 buf-name   = group | article | summary ...
19758 @end example
19759
19760 The limitations are that the @code{frame} split can only appear as the
19761 top-level split.  @var{form} should be an Emacs Lisp form that should
19762 return a valid split.  We see that each split is fully recursive, and
19763 may contain any number of @code{vertical} and @code{horizontal} splits.
19764
19765 @vindex gnus-window-min-width
19766 @vindex gnus-window-min-height
19767 @cindex window height
19768 @cindex window width
19769 Finding the right sizes can be a bit complicated.  No window may be less
19770 than @code{gnus-window-min-height} (default 1) characters high, and all
19771 windows must be at least @code{gnus-window-min-width} (default 1)
19772 characters wide.  Gnus will try to enforce this before applying the
19773 splits.  If you want to use the normal Emacs window width/height limit,
19774 you can just set these two variables to @code{nil}.
19775
19776 If you're not familiar with Emacs terminology, @code{horizontal} and
19777 @code{vertical} splits may work the opposite way of what you'd expect.
19778 Windows inside a @code{horizontal} split are shown side-by-side, and
19779 windows within a @code{vertical} split are shown above each other.
19780
19781 @findex gnus-configure-frame
19782 If you want to experiment with window placement, a good tip is to call
19783 @code{gnus-configure-frame} directly with a split.  This is the function
19784 that does all the real work when splitting buffers.  Below is a pretty
19785 nonsensical configuration with 5 windows; two for the group buffer and
19786 three for the article buffer.  (I said it was nonsensical.)  If you
19787 @code{eval} the statement below, you can get an idea of how that would
19788 look straight away, without going through the normal Gnus channels.
19789 Play with it until you're satisfied, and then use
19790 @code{gnus-add-configuration} to add your new creation to the buffer
19791 configuration list.
19792
19793 @lisp
19794 (gnus-configure-frame
19795  '(horizontal 1.0
19796     (vertical 10
19797       (group 1.0)
19798       (article 0.3 point))
19799     (vertical 1.0
19800       (article 1.0)
19801       (horizontal 4
19802         (group 1.0)
19803         (article 10)))))
19804 @end lisp
19805
19806 You might want to have several frames as well.  No prob---just use the
19807 @code{frame} split:
19808
19809 @lisp
19810 (gnus-configure-frame
19811  '(frame 1.0
19812          (vertical 1.0
19813                    (summary 0.25 point frame-focus)
19814                    (article 1.0))
19815          (vertical ((height . 5) (width . 15)
19816                     (user-position . t)
19817                     (left . -1) (top . 1))
19818                    (picon 1.0))))
19819
19820 @end lisp
19821
19822 This split will result in the familiar summary/article window
19823 configuration in the first (or ``main'') frame, while a small additional
19824 frame will be created where picons will be shown.  As you can see,
19825 instead of the normal @code{1.0} top-level spec, each additional split
19826 should have a frame parameter alist as the size spec.
19827 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
19828 Reference Manual}.  Under XEmacs, a frame property list will be
19829 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
19830 is such a plist.
19831 The list of all possible keys for @code{gnus-buffer-configuration} can
19832 be found in its default value.
19833
19834 Note that the @code{message} key is used for both
19835 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
19836 it is desirable to distinguish between the two, something like this
19837 might be used:
19838
19839 @lisp
19840 (message (horizontal 1.0
19841                      (vertical 1.0 (message 1.0 point))
19842                      (vertical 0.24
19843                                (if (buffer-live-p gnus-summary-buffer)
19844                                    '(summary 0.5))
19845                                (group 1.0)))))
19846 @end lisp
19847
19848 One common desire for a multiple frame split is to have a separate frame
19849 for composing mail and news while leaving the original frame intact.  To
19850 accomplish that, something like the following can be done:
19851
19852 @lisp
19853 (message
19854   (frame 1.0
19855          (if (not (buffer-live-p gnus-summary-buffer))
19856              (car (cdr (assoc 'group gnus-buffer-configuration)))
19857            (car (cdr (assoc 'summary gnus-buffer-configuration))))
19858          (vertical ((user-position . t) (top . 1) (left . 1)
19859                     (name . "Message"))
19860                    (message 1.0 point))))
19861 @end lisp
19862
19863 @findex gnus-add-configuration
19864 Since the @code{gnus-buffer-configuration} variable is so long and
19865 complicated, there's a function you can use to ease changing the config
19866 of a single setting: @code{gnus-add-configuration}.  If, for instance,
19867 you want to change the @code{article} setting, you could say:
19868
19869 @lisp
19870 (gnus-add-configuration
19871  '(article (vertical 1.0
19872                (group 4)
19873                (summary .25 point)
19874                (article 1.0))))
19875 @end lisp
19876
19877 You'd typically stick these @code{gnus-add-configuration} calls in your
19878 @file{.gnus.el} file or in some startup hook---they should be run after
19879 Gnus has been loaded.
19880
19881 @vindex gnus-always-force-window-configuration
19882 If all windows mentioned in the configuration are already visible, Gnus
19883 won't change the window configuration.  If you always want to force the
19884 ``right'' window configuration, you can set
19885 @code{gnus-always-force-window-configuration} to non-@code{nil}.
19886
19887 If you're using tree displays (@pxref{Tree Display}), and the tree
19888 window is displayed vertically next to another window, you may also want
19889 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
19890 windows resized.
19891
19892 @subsection Example Window Configurations
19893
19894 @itemize @bullet
19895 @item
19896 Narrow left hand side occupied by group buffer.  Right hand side split
19897 between summary buffer (top one-sixth) and article buffer (bottom).
19898
19899 @ifinfo
19900 @example
19901 +---+---------+
19902 | G | Summary |
19903 | r +---------+
19904 | o |         |
19905 | u | Article |
19906 | p |         |
19907 +---+---------+
19908 @end example
19909 @end ifinfo
19910
19911 @lisp
19912 (gnus-add-configuration
19913  '(article
19914    (horizontal 1.0
19915                (vertical 25 (group 1.0))
19916                (vertical 1.0
19917                          (summary 0.16 point)
19918                          (article 1.0)))))
19919
19920 (gnus-add-configuration
19921  '(summary
19922    (horizontal 1.0
19923                (vertical 25 (group 1.0))
19924                (vertical 1.0 (summary 1.0 point)))))
19925 @end lisp
19926
19927 @end itemize
19928
19929
19930 @node Faces and Fonts
19931 @section Faces and Fonts
19932 @cindex faces
19933 @cindex fonts
19934 @cindex colors
19935
19936 Fiddling with fonts and faces used to be very difficult, but these days
19937 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
19938 the face you want to alter, and alter it via the standard Customize
19939 interface.
19940
19941
19942 @node Compilation
19943 @section Compilation
19944 @cindex compilation
19945 @cindex byte-compilation
19946
19947 @findex gnus-compile
19948
19949 Remember all those line format specification variables?
19950 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
19951 on.  By default, T-gnus will use the byte-compiled codes of these
19952 variables and we can keep a slow-down to a minimum.  However, if you set
19953 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
19954 unfortunately, changing them will mean a quite significant slow-down.
19955 (The default values of these variables have byte-compiled functions
19956 associated with them, while the user-generated versions do not, of
19957 course.)
19958
19959 To help with this, you can run @kbd{M-x gnus-compile} after you've
19960 fiddled around with the variables and feel that you're (kind of)
19961 satisfied.  This will result in the new specs being byte-compiled, and
19962 you'll get top speed again.  Note that T-gnus will not save these
19963 compiled specs in the @file{.newsrc.eld} file.
19964
19965 @table @code
19966 @item gnus-compile-user-specs
19967 @vindex gnus-compile-user-specs
19968 If it is non-nil, the user-defined format specs will be byte-compiled
19969 automatically.  The default value of this variable is @code{t}.  It has
19970 an effect on the values of @code{gnus-*-line-format-spec}.
19971 @end table
19972
19973
19974 @node Mode Lines
19975 @section Mode Lines
19976 @cindex mode lines
19977
19978 @vindex gnus-updated-mode-lines
19979 @code{gnus-updated-mode-lines} says what buffers should keep their mode
19980 lines updated.  It is a list of symbols.  Supported symbols include
19981 @code{group}, @code{article}, @code{summary}, @code{server},
19982 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
19983 Gnus will keep that mode line updated with information that may be
19984 pertinent.  If this variable is @code{nil}, screen refresh may be
19985 quicker.
19986
19987 @cindex display-time
19988
19989 @vindex gnus-mode-non-string-length
19990 By default, Gnus displays information on the current article in the mode
19991 lines of the summary and article buffers.  The information Gnus wishes
19992 to display (e.g. the subject of the article) is often longer than the
19993 mode lines, and therefore have to be cut off at some point.  The
19994 @code{gnus-mode-non-string-length} variable says how long the other
19995 elements on the line is (i.e., the non-info part).  If you put
19996 additional elements on the mode line (e.g. a clock), you should modify
19997 this variable:
19998
19999 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
20000 @lisp
20001 (add-hook 'display-time-hook
20002           (lambda () (setq gnus-mode-non-string-length
20003                            (+ 21
20004                               (if line-number-mode 5 0)
20005                               (if column-number-mode 4 0)
20006                               (length display-time-string)))))
20007 @end lisp
20008
20009 If this variable is @code{nil} (which is the default), the mode line
20010 strings won't be chopped off, and they won't be padded either.  Note
20011 that the default is unlikely to be desirable, as even the percentage
20012 complete in the buffer may be crowded off the mode line; the user should
20013 configure this variable appropriately for her configuration.
20014
20015
20016 @node Highlighting and Menus
20017 @section Highlighting and Menus
20018 @cindex visual
20019 @cindex highlighting
20020 @cindex menus
20021
20022 @vindex gnus-visual
20023 The @code{gnus-visual} variable controls most of the Gnus-prettifying
20024 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
20025 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
20026 file.
20027
20028 This variable can be a list of visual properties that are enabled.  The
20029 following elements are valid, and are all included by default:
20030
20031 @table @code
20032 @item group-highlight
20033 Do highlights in the group buffer.
20034 @item summary-highlight
20035 Do highlights in the summary buffer.
20036 @item article-highlight
20037 Do highlights in the article buffer.
20038 @item highlight
20039 Turn on highlighting in all buffers.
20040 @item group-menu
20041 Create menus in the group buffer.
20042 @item summary-menu
20043 Create menus in the summary buffers.
20044 @item article-menu
20045 Create menus in the article buffer.
20046 @item browse-menu
20047 Create menus in the browse buffer.
20048 @item server-menu
20049 Create menus in the server buffer.
20050 @item score-menu
20051 Create menus in the score buffers.
20052 @item menu
20053 Create menus in all buffers.
20054 @end table
20055
20056 So if you only want highlighting in the article buffer and menus in all
20057 buffers, you could say something like:
20058
20059 @lisp
20060 (setq gnus-visual '(article-highlight menu))
20061 @end lisp
20062
20063 If you want highlighting only and no menus whatsoever, you'd say:
20064
20065 @lisp
20066 (setq gnus-visual '(highlight))
20067 @end lisp
20068
20069 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
20070 in all Gnus buffers.
20071
20072 Other general variables that influence the look of all buffers include:
20073
20074 @table @code
20075 @item gnus-mouse-face
20076 @vindex gnus-mouse-face
20077 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
20078 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
20079
20080 @end table
20081
20082 There are hooks associated with the creation of all the different menus:
20083
20084 @table @code
20085
20086 @item gnus-article-menu-hook
20087 @vindex gnus-article-menu-hook
20088 Hook called after creating the article mode menu.
20089
20090 @item gnus-group-menu-hook
20091 @vindex gnus-group-menu-hook
20092 Hook called after creating the group mode menu.
20093
20094 @item gnus-summary-menu-hook
20095 @vindex gnus-summary-menu-hook
20096 Hook called after creating the summary mode menu.
20097
20098 @item gnus-server-menu-hook
20099 @vindex gnus-server-menu-hook
20100 Hook called after creating the server mode menu.
20101
20102 @item gnus-browse-menu-hook
20103 @vindex gnus-browse-menu-hook
20104 Hook called after creating the browse mode menu.
20105
20106 @item gnus-score-menu-hook
20107 @vindex gnus-score-menu-hook
20108 Hook called after creating the score mode menu.
20109
20110 @end table
20111
20112
20113 @node Buttons
20114 @section Buttons
20115 @cindex buttons
20116 @cindex mouse
20117 @cindex click
20118
20119 Those new-fangled @dfn{mouse} contraptions is very popular with the
20120 young, hep kids who don't want to learn the proper way to do things
20121 these days.  Why, I remember way back in the summer of '89, when I was
20122 using Emacs on a Tops 20 system.  Three hundred users on one single
20123 machine, and every user was running Simula compilers.  Bah!
20124
20125 Right.
20126
20127 @vindex gnus-carpal
20128 Well, you can make Gnus display bufferfuls of buttons you can click to
20129 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
20130 really.  Tell the chiropractor I sent you.
20131
20132
20133 @table @code
20134
20135 @item gnus-carpal-mode-hook
20136 @vindex gnus-carpal-mode-hook
20137 Hook run in all carpal mode buffers.
20138
20139 @item gnus-carpal-button-face
20140 @vindex gnus-carpal-button-face
20141 Face used on buttons.
20142
20143 @item gnus-carpal-header-face
20144 @vindex gnus-carpal-header-face
20145 Face used on carpal buffer headers.
20146
20147 @item gnus-carpal-group-buffer-buttons
20148 @vindex gnus-carpal-group-buffer-buttons
20149 Buttons in the group buffer.
20150
20151 @item gnus-carpal-summary-buffer-buttons
20152 @vindex gnus-carpal-summary-buffer-buttons
20153 Buttons in the summary buffer.
20154
20155 @item gnus-carpal-server-buffer-buttons
20156 @vindex gnus-carpal-server-buffer-buttons
20157 Buttons in the server buffer.
20158
20159 @item gnus-carpal-browse-buffer-buttons
20160 @vindex gnus-carpal-browse-buffer-buttons
20161 Buttons in the browse buffer.
20162 @end table
20163
20164 All the @code{buttons} variables are lists.  The elements in these list
20165 are either cons cells where the @code{car} contains a text to be displayed and
20166 the @code{cdr} contains a function symbol, or a simple string.
20167
20168
20169 @node Daemons
20170 @section Daemons
20171 @cindex demons
20172 @cindex daemons
20173
20174 Gnus, being larger than any program ever written (allegedly), does lots
20175 of strange stuff that you may wish to have done while you're not
20176 present.  For instance, you may want it to check for new mail once in a
20177 while.  Or you may want it to close down all connections to all servers
20178 when you leave Emacs idle.  And stuff like that.
20179
20180 Gnus will let you do stuff like that by defining various
20181 @dfn{handlers}.  Each handler consists of three elements:  A
20182 @var{function}, a @var{time}, and an @var{idle} parameter.
20183
20184 Here's an example of a handler that closes connections when Emacs has
20185 been idle for thirty minutes:
20186
20187 @lisp
20188 (gnus-demon-close-connections nil 30)
20189 @end lisp
20190
20191 Here's a handler that scans for PGP headers every hour when Emacs is
20192 idle:
20193
20194 @lisp
20195 (gnus-demon-scan-pgp 60 t)
20196 @end lisp
20197
20198 This @var{time} parameter and than @var{idle} parameter work together
20199 in a strange, but wonderful fashion.  Basically, if @var{idle} is
20200 @code{nil}, then the function will be called every @var{time} minutes.
20201
20202 If @var{idle} is @code{t}, then the function will be called after
20203 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
20204 the function will never be called.  But once Emacs goes idle, the
20205 function will be called every @var{time} minutes.
20206
20207 If @var{idle} is a number and @var{time} is a number, the function will
20208 be called every @var{time} minutes only when Emacs has been idle for
20209 @var{idle} minutes.
20210
20211 If @var{idle} is a number and @var{time} is @code{nil}, the function
20212 will be called once every time Emacs has been idle for @var{idle}
20213 minutes.
20214
20215 And if @var{time} is a string, it should look like @samp{07:31}, and
20216 the function will then be called once every day somewhere near that
20217 time.  Modified by the @var{idle} parameter, of course.
20218
20219 @vindex gnus-demon-timestep
20220 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
20221 seconds.  This is 60 by default.  If you change that variable,
20222 all the timings in the handlers will be affected.)
20223
20224 So, if you want to add a handler, you could put something like this in
20225 your @file{.gnus} file:
20226
20227 @findex gnus-demon-add-handler
20228 @lisp
20229 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
20230 @end lisp
20231
20232 @findex gnus-demon-add-nocem
20233 @findex gnus-demon-add-scanmail
20234 @findex gnus-demon-add-rescan
20235 @findex gnus-demon-add-scan-timestamps
20236 @findex gnus-demon-add-disconnection
20237 Some ready-made functions to do this have been created:
20238 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
20239 @code{gnus-demon-add-nntp-close-connection},
20240 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
20241 @code{gnus-demon-add-scanmail}.  Just put those functions in your
20242 @file{.gnus} if you want those abilities.
20243
20244 @findex gnus-demon-init
20245 @findex gnus-demon-cancel
20246 @vindex gnus-demon-handlers
20247 If you add handlers to @code{gnus-demon-handlers} directly, you should
20248 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
20249 daemons, you can use the @code{gnus-demon-cancel} function.
20250
20251 Note that adding daemons can be pretty naughty if you over do it.  Adding
20252 functions that scan all news and mail from all servers every two seconds
20253 is a sure-fire way of getting booted off any respectable system.  So
20254 behave.
20255
20256
20257 @node NoCeM
20258 @section NoCeM
20259 @cindex nocem
20260 @cindex spam
20261
20262 @dfn{Spamming} is posting the same article lots and lots of times.
20263 Spamming is bad.  Spamming is evil.
20264
20265 Spamming is usually canceled within a day or so by various anti-spamming
20266 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
20267 NoCeM is pronounced ``no see-'em'', and means what the name
20268 implies---these are messages that make the offending articles, like, go
20269 away.
20270
20271 What use are these NoCeM messages if the articles are canceled anyway?
20272 Some sites do not honor cancel messages and some sites just honor cancels
20273 from a select few people.  Then you may wish to make use of the NoCeM
20274 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
20275
20276 Gnus can read and parse the messages in this group automatically, and
20277 this will make spam disappear.
20278
20279 There are some variables to customize, of course:
20280
20281 @table @code
20282 @item gnus-use-nocem
20283 @vindex gnus-use-nocem
20284 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
20285 by default.
20286
20287 @item gnus-nocem-groups
20288 @vindex gnus-nocem-groups
20289 Gnus will look for NoCeM messages in the groups in this list.  The
20290 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
20291 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
20292
20293 @item gnus-nocem-issuers
20294 @vindex gnus-nocem-issuers
20295 There are many people issuing NoCeM messages.  This list says what
20296 people you want to listen to.  The default is @code{("Automoose-1"
20297 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
20298 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
20299
20300 Known despammers that you can put in this list are listed at
20301 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
20302
20303 You do not have to heed NoCeM messages from all these people---just the
20304 ones you want to listen to.  You also don't have to accept all NoCeM
20305 messages from the people you like.  Each NoCeM message has a @dfn{type}
20306 header that gives the message a (more or less, usually less) rigorous
20307 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
20308 @samp{binary}, and @samp{troll}.  To specify this, you have to use
20309 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
20310 Each condition is either a string (which is a regexp that matches types
20311 you want to use) or a list on the form @code{(not @var{string})}, where
20312 @var{string} is a regexp that matches types you don't want to use.
20313
20314 For instance, if you want all NoCeM messages from Chris Lewis except his
20315 @samp{troll} messages, you'd say:
20316
20317 @lisp
20318 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
20319 @end lisp
20320
20321 On the other hand, if you just want nothing but his @samp{spam} and
20322 @samp{spew} messages, you'd say:
20323
20324 @lisp
20325 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
20326 @end lisp
20327
20328 The specs are applied left-to-right.
20329
20330
20331 @item gnus-nocem-verifyer
20332 @vindex gnus-nocem-verifyer
20333 @findex mc-verify
20334 This should be a function for verifying that the NoCeM issuer is who she
20335 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
20336 function.  If this is too slow and you don't care for verification
20337 (which may be dangerous), you can set this variable to @code{nil}.
20338
20339 If you want signed NoCeM messages to be verified and unsigned messages
20340 not to be verified (but used anyway), you could do something like:
20341
20342 @lisp
20343 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
20344
20345 (defun my-gnus-mc-verify ()
20346   (not (eq 'forged
20347            (ignore-errors
20348              (if (mc-verify)
20349                  t
20350                'forged)))))
20351 @end lisp
20352
20353 This might be dangerous, though.
20354
20355 @item gnus-nocem-directory
20356 @vindex gnus-nocem-directory
20357 This is where Gnus will store its NoCeM cache files.  The default is
20358 @file{~/News/NoCeM/}.
20359
20360 @item gnus-nocem-expiry-wait
20361 @vindex gnus-nocem-expiry-wait
20362 The number of days before removing old NoCeM entries from the cache.
20363 The default is 15.  If you make it shorter Gnus will be faster, but you
20364 might then see old spam.
20365
20366 @item gnus-nocem-check-from
20367 @vindex gnus-nocem-check-from
20368 Non-@code{nil} means check for valid issuers in message bodies.
20369 Otherwise don't bother fetching articles unless their author matches a
20370 valid issuer; that is much faster if you are selective about the
20371 issuers.
20372
20373 @item gnus-nocem-check-article-limit
20374 @vindex gnus-nocem-check-article-limit
20375 If non-@code{nil}, the maximum number of articles to check in any NoCeM
20376 group.  NoCeM groups can be huge and very slow to process.
20377
20378 @end table
20379
20380 Using NoCeM could potentially be a memory hog.  If you have many living
20381 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
20382 big.  If this is a problem, you should kill off all (or most) of your
20383 unsubscribed groups (@pxref{Subscription Commands}).
20384
20385
20386 @node Undo
20387 @section Undo
20388 @cindex undo
20389
20390 It is very useful to be able to undo actions one has done.  In normal
20391 Emacs buffers, it's easy enough---you just push the @code{undo} button.
20392 In Gnus buffers, however, it isn't that simple.
20393
20394 The things Gnus displays in its buffer is of no value whatsoever to
20395 Gnus---it's all just data designed to look nice to the user.
20396 Killing a group in the group buffer with @kbd{C-k} makes the line
20397 disappear, but that's just a side-effect of the real action---the
20398 removal of the group in question from the internal Gnus structures.
20399 Undoing something like that can't be done by the normal Emacs
20400 @code{undo} function.
20401
20402 Gnus tries to remedy this somewhat by keeping track of what the user
20403 does and coming up with actions that would reverse the actions the user
20404 takes.  When the user then presses the @code{undo} key, Gnus will run
20405 the code to reverse the previous action, or the previous actions.
20406 However, not all actions are easily reversible, so Gnus currently offers
20407 a few key functions to be undoable.  These include killing groups,
20408 yanking groups, and changing the list of read articles of groups.
20409 That's it, really.  More functions may be added in the future, but each
20410 added function means an increase in data to be stored, so Gnus will
20411 never be totally undoable.
20412
20413 @findex gnus-undo-mode
20414 @vindex gnus-use-undo
20415 @findex gnus-undo
20416 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
20417 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
20418 default.  The @kbd{C-M-_} key performs the @code{gnus-undo}
20419 command, which should feel kinda like the normal Emacs @code{undo}
20420 command.
20421
20422
20423 @node Predicate Specifiers
20424 @section Predicate Specifiers
20425 @cindex predicate specifiers
20426
20427 Some Gnus variables are @dfn{predicate specifiers}.  This is a special
20428 form that allows flexible specification of predicates without having
20429 to type all that much.
20430
20431 These specifiers are lists consisting of functions, symbols and lists.
20432
20433 Here's an example:
20434
20435 @lisp
20436 (or gnus-article-unseen-p
20437     gnus-article-unread-p)
20438 @end lisp
20439
20440 The available symbols are @code{or}, @code{and} and @code{not}.  The
20441 functions all take one parameter.
20442
20443 @findex gnus-make-predicate
20444 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
20445 to create a function that can be called.  This input parameter to this
20446 function will be passed along to all the functions in the predicate
20447 specifier.
20448
20449
20450 @node Moderation
20451 @section Moderation
20452 @cindex moderation
20453
20454 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
20455 It is not included in the standard Gnus package.  Write a mail to
20456 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
20457 get a copy.
20458
20459 The moderation package is implemented as a minor mode for summary
20460 buffers.  Put
20461
20462 @lisp
20463 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
20464 @end lisp
20465
20466 in your @file{.gnus.el} file.
20467
20468 If you are the moderator of @samp{rec.zoofle}, this is how it's
20469 supposed to work:
20470
20471 @enumerate
20472 @item
20473 You split your incoming mail by matching on
20474 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
20475 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
20476
20477 @item
20478 You enter that group once in a while and post articles using the @kbd{e}
20479 (edit-and-post) or @kbd{s} (just send unedited) commands.
20480
20481 @item
20482 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
20483 articles that weren't approved by you, you can cancel them with the
20484 @kbd{c} command.
20485 @end enumerate
20486
20487 To use moderation mode in these two groups, say:
20488
20489 @lisp
20490 (setq gnus-moderated-list
20491       "^nnml:rec.zoofle$\\|^rec.zoofle$")
20492 @end lisp
20493
20494
20495 @node Image Enhancements
20496 @section Image Enhancements
20497
20498 XEmacs, as well as Emacs 21, is able to display pictures and stuff, so
20499 Gnus has taken advantage of that.
20500
20501 @menu
20502 * Picons::                      How to display pictures of what you're reading.
20503 * Smileys::                     Show all those happy faces the way they were meant to be shown.
20504 * X-Face::                      Display a funky, teensy black-and-white image.
20505 * Toolbar::                     Click'n'drool.
20506 * XVarious::                    Other XEmacsy Gnusey variables.
20507 @end menu
20508
20509
20510 @node Picons
20511 @subsection Picons
20512
20513 @iftex
20514 @iflatex
20515 \include{picons}
20516 @end iflatex
20517 @end iftex
20518
20519 So@dots{}  You want to slow down your news reader even more!  This is a
20520 good way to do so.  Its also a great way to impress people staring
20521 over your shoulder as you read news.
20522
20523 @menu
20524 * Picon Basics::                What are picons and How do I get them.
20525 * Picon Requirements::          Don't go further if you aren't using XEmacs.
20526 * Easy Picons::                 Displaying Picons---the easy way.
20527 * Hard Picons::                 The way you should do it.  You'll learn something.
20528 * Picon Useless Configuration::  Other variables you can trash/tweak/munge/play with.
20529 @end menu
20530
20531
20532 @node Picon Basics
20533 @subsubsection Picon Basics
20534
20535 What are Picons?  To quote directly from the Picons Web site:
20536
20537 @iftex
20538 @iflatex
20539 \margindex{}
20540 @end iflatex
20541 @end iftex
20542
20543 @quotation
20544 @dfn{Picons} is short for ``personal icons''.  They're small,
20545 constrained images used to represent users and domains on the net,
20546 organized into databases so that the appropriate image for a given
20547 e-mail address can be found.  Besides users and domains, there are picon
20548 databases for Usenet newsgroups and weather forecasts.  The picons are
20549 in either monochrome @code{XBM} format or color @code{XPM} and
20550 @code{GIF} formats.
20551 @end quotation
20552
20553 @vindex gnus-picons-piconsearch-url
20554 If you have a permanent connection to the Internet you can use Steve
20555 Kinzler's Picons Search engine by setting
20556 @code{gnus-picons-piconsearch-url} to the string @*
20557 @uref{http://www.cs.indiana.edu/picons/search.html}.
20558
20559 @vindex gnus-picons-database
20560 Otherwise you need a local copy of his database.  For instructions on
20561 obtaining and installing the picons databases, point your Web browser at @*
20562 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
20563 picons to be installed into a location pointed to by
20564 @code{gnus-picons-database}.
20565
20566 If you are using Debian GNU/Linux, saying @samp{apt-get install
20567 picons.*} will install the picons where Gnus can find them.
20568
20569
20570 @node Picon Requirements
20571 @subsubsection Picon Requirements
20572
20573 To have Gnus display Picons for you, you must have @code{x} support
20574 compiled into XEmacs.  To display color picons which are much nicer
20575 than the black & white one, you also need one of @code{xpm} or
20576 @code{gif} compiled into XEmacs.
20577
20578 @vindex gnus-picons-convert-x-face
20579 If you want to display faces from @code{X-Face} headers, you should have
20580 the @code{xface} support compiled into XEmacs.  Otherwise you must have
20581 the @code{netpbm} utilities installed, or munge the
20582 @code{gnus-picons-convert-x-face} variable to use something else.
20583 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
20584
20585 @node Easy Picons
20586 @subsubsection Easy Picons
20587
20588 To enable displaying picons, simply put the following line in your
20589 @file{~/.gnus} file and start Gnus.
20590
20591 @lisp
20592 (setq gnus-use-picons t)
20593 (setq gnus-treat-display-picons t)
20594 @end lisp
20595
20596 and make sure @code{gnus-picons-database} points to the directory
20597 containing the Picons databases.
20598
20599 Alternatively if you want to use the web piconsearch engine add this:
20600
20601 @lisp
20602 (setq gnus-picons-piconsearch-url
20603       "http://www.cs.indiana.edu:800/piconsearch")
20604 @end lisp
20605
20606
20607 @node Hard Picons
20608 @subsubsection Hard Picons
20609
20610 @iftex
20611 @iflatex
20612 \margindex{}
20613 @end iflatex
20614 @end iftex
20615
20616 Gnus can display picons for you as you enter and leave groups and
20617 articles.  It knows how to interact with three sections of the picons
20618 database.  Namely, it can display the picons newsgroup pictures,
20619 author's face picture(s), and the authors domain.  To enable this
20620 feature, you need to select where to get the picons from, and where to
20621 display them.
20622
20623 @table @code
20624
20625 @item gnus-picons-database
20626 @vindex gnus-picons-database
20627 The location of the picons database.  Should point to a directory
20628 containing the @file{news}, @file{domains}, @file{users} (and so on)
20629 subdirectories.  This is only useful if
20630 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
20631 @file{/usr/local/faces/}.
20632
20633 @item gnus-picons-piconsearch-url
20634 @vindex gnus-picons-piconsearch-url
20635 The URL for the web picons search engine.  The only currently known
20636 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}.  To
20637 workaround network delays, icons will be fetched in the background.  If
20638 this is @code{nil} 'the default), then picons are fetched from local
20639 database indicated by @code{gnus-picons-database}.
20640
20641 @item gnus-picons-display-where
20642 @vindex gnus-picons-display-where
20643 Where the picon images should be displayed.  It is @code{picons} by
20644 default (which by default maps to the buffer @samp{*Picons*}).  Other
20645 valid places could be @code{article}, @code{summary}, or
20646 @samp{*scratch*} for all I care.  Just make sure that you've made the
20647 buffer visible using the standard Gnus window configuration
20648 routines---@pxref{Window Layout}.
20649
20650 @item gnus-picons-group-excluded-groups
20651 @vindex gnus-picons-group-excluded-groups
20652 Groups that are matched by this regexp won't have their group icons
20653 displayed.
20654
20655 @end table
20656
20657 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
20658 window configuration for you to include the @code{picons} buffer.
20659
20660 Now that you've made those decision, you need to add the following
20661 functions to the appropriate hooks so these pictures will get displayed
20662 at the right time.
20663
20664 @vindex gnus-picons-display-where
20665 @table @code
20666 @item gnus-article-display-picons
20667 @findex gnus-article-display-picons
20668 Looks up and displays the picons for the author and the author's domain
20669 in the @code{gnus-picons-display-where} buffer.
20670
20671 @item gnus-picons-article-display-x-face
20672 @findex gnus-picons-article-display-x-face
20673 Decodes and displays the X-Face header if present.
20674 (NOTE: @code{x-face} is used in the function name, not @code{xface})
20675
20676 @end table
20677
20678
20679
20680 @node Picon Useless Configuration
20681 @subsubsection Picon Useless Configuration
20682
20683 @iftex
20684 @iflatex
20685 \margindex{}
20686 @end iflatex
20687 @end iftex
20688
20689 The following variables offer further control over how things are
20690 done, where things are located, and other useless stuff you really
20691 don't need to worry about.
20692
20693 @table @code
20694
20695 @item gnus-picons-news-directories
20696 @vindex gnus-picons-news-directories
20697 List of subdirectories to search in @code{gnus-picons-database} for
20698 newsgroups faces.  @code{("news")} is the default.
20699
20700 @item gnus-picons-user-directories
20701 @vindex gnus-picons-user-directories
20702 List of subdirectories to search in @code{gnus-picons-database} for user
20703 faces.  @code{("local" "users" "usenix" "misc")} is the default.
20704
20705 @item gnus-picons-domain-directories
20706 @vindex gnus-picons-domain-directories
20707 List of subdirectories to search in @code{gnus-picons-database} for
20708 domain name faces.  Defaults to @code{("domains")}.  Some people may
20709 want to add @samp{"unknown"} to this list.
20710
20711 @item gnus-picons-convert-x-face
20712 @vindex gnus-picons-convert-x-face
20713 If you don't have @code{xface} support builtin XEmacs, this is the
20714 command to use to convert the @code{X-Face} header to an X bitmap
20715 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
20716 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
20717 gnus-picons-x-face-file-name)}
20718 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
20719
20720 @item gnus-picons-x-face-file-name
20721 @vindex gnus-picons-x-face-file-name
20722 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
20723 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
20724 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
20725
20726 @item gnus-picons-has-modeline-p
20727 @vindex gnus-picons-has-modeline-p
20728 If you have set @code{gnus-picons-display-where} to @code{picons}, your
20729 XEmacs frame will become really cluttered.  To alleviate this a bit you
20730 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
20731 remove the mode line from the Picons buffer.  This is only useful if
20732 @code{gnus-picons-display-where} is @code{picons}.
20733
20734 @item gnus-picons-refresh-before-display
20735 @vindex gnus-picons-refresh-before-display
20736 If non-nil, display the article buffer before computing the picons.
20737 Defaults to @code{nil}.
20738
20739 @item gnus-picons-display-as-address
20740 @vindex gnus-picons-display-as-address
20741 If @code{t} display textual email addresses along with pictures.
20742 Defaults to @code{t}.
20743
20744 @item gnus-picons-file-suffixes
20745 @vindex gnus-picons-file-suffixes
20746 Ordered list of suffixes on picon file names to try.  Defaults to
20747 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
20748
20749 @item gnus-picons-setup-hook
20750 @vindex gnus-picons-setup-hook
20751 Hook run in the picon buffer, if that is displayed.
20752
20753 @item gnus-picons-display-article-move-p
20754 @vindex gnus-picons-display-article-move-p
20755 Whether to move point to first empty line when displaying picons.  This
20756 has only an effect if `gnus-picons-display-where' has value `article'.
20757
20758 If @code{nil}, display the picons in the @code{From} and
20759 @code{Newsgroups} lines.  This is the default.
20760
20761 @item gnus-picons-clear-cache-on-shutdown
20762 @vindex gnus-picons-clear-cache-on-shutdown
20763 Whether to clear the picons cache when exiting gnus.  Gnus caches every
20764 picons it finds while it is running.  This saves some time in the search
20765 process but eats some memory.  If this variable is set to @code{nil},
20766 Gnus will never clear the cache itself; you will have to manually call
20767 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
20768 cleared every time you exit Gnus.  Defaults to @code{t}.
20769
20770 @iftex
20771 @iflatex
20772 \margindex{}
20773 @end iflatex
20774 @end iftex
20775
20776 @end table
20777
20778 @node Smileys
20779 @subsection Smileys
20780 @cindex smileys
20781
20782 @iftex
20783 @iflatex
20784 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
20785 \input{smiley}
20786 @end iflatex
20787 @end iftex
20788
20789 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
20790 currently the only package that uses Smiley, it is documented here.
20791
20792 In short---to use Smiley in Gnus, put the following in your
20793 @file{.gnus.el} file:
20794
20795 @lisp
20796 (setq gnus-treat-display-smileys t)
20797 @end lisp
20798
20799 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
20800 the like---to pictures and displays those instead of the text smiley
20801 faces.  The conversion is controlled by a list of regexps that matches
20802 text and maps that to file names.
20803
20804 @vindex smiley-nosey-regexp-alist
20805 @vindex smiley-deformed-regexp-alist
20806 Smiley supplies two example conversion alists by default:
20807 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
20808 and so on), and @code{smiley-nosey-regexp-alist} (which matches
20809 @samp{:-)}, @samp{:-(} and so on).
20810
20811 The alist used is specified by the @code{smiley-regexp-alist} variable,
20812 which defaults to the value of @code{smiley-deformed-regexp-alist}.
20813
20814 The first item in each element is the regexp to be matched; the second
20815 element is the regexp match group that is to be replaced by the picture;
20816 and the third element is the name of the file to be displayed.
20817
20818 The following variables customize where Smiley will look for these
20819 files, as well as the color to be used and stuff:
20820
20821 @table @code
20822
20823 @item smiley-data-directory
20824 @vindex smiley-data-directory
20825 Where Smiley will look for smiley faces files.
20826
20827 @item smiley-flesh-color
20828 @vindex smiley-flesh-color
20829 Skin color.  The default is @samp{yellow}, which is really racist.
20830
20831 @item smiley-features-color
20832 @vindex smiley-features-color
20833 Color of the features of the face.  The default is @samp{black}.
20834
20835 @item smiley-tongue-color
20836 @vindex smiley-tongue-color
20837 Color of the tongue.  The default is @samp{red}.
20838
20839 @item smiley-circle-color
20840 @vindex smiley-circle-color
20841 Color of the circle around the face.  The default is @samp{black}.
20842
20843 @item smiley-mouse-face
20844 @vindex smiley-mouse-face
20845 Face used for mouse highlighting over the smiley face.
20846
20847 @end table
20848
20849
20850 @node X-Face
20851 @subsection X-Face
20852 @cindex x-face
20853
20854 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
20855 depth) image that's supposed to represent the author of the message.
20856 It seems to be supported by an ever-growing number of mail and news
20857 readers.
20858
20859 @cindex x-face
20860 @findex gnus-article-display-x-face
20861 @findex gnus-article-x-face-command
20862 @vindex gnus-article-x-face-command
20863 @vindex gnus-article-x-face-too-ugly
20864 @iftex
20865 @iflatex
20866 \include{xface}
20867 @end iflatex
20868 @end iftex
20869 @c @anchor{X-Face}
20870
20871 Decoding an @code{X-Face} header either requires an Emacs that has
20872 @samp{compface} support (which most XEmacs versions has), or that you
20873 have @samp{compface} installed on your system.  If either is true,
20874 Gnus will default to displaying @code{X-Face} headers.
20875
20876 The variable that controls this is the
20877 @code{gnus-article-x-face-command} variable.  If this variable is a
20878 string, this string will be executed in a sub-shell.  If it is a
20879 function, this function will be called with the face as the argument.
20880 If the @code{gnus-article-x-face-too-ugly} (which is a regexp) matches
20881 the @code{From} header, the face will not be shown.
20882
20883 The default action under Emacs 20 is to fork off the @code{display}
20884 program@footnote{@code{display} is from the ImageMagick package.  For
20885 the @code{uncompface} and @code{icontopbm} programs look for a package
20886 like @code{compface} or @code{faces-xface} on a GNU/Linux system.}  to
20887 view the face.
20888
20889 Under XEmacs or Emacs 21+ with suitable image support, the default
20890 action is to display the face before the @code{From} header.  (It's
20891 nicer if XEmacs has been compiled with @code{X-Face} support---that
20892 will make display somewhat faster.  If there's no native @code{X-Face}
20893 support, Gnus will try to convert the @code{X-Face} header using
20894 external programs from the @code{pbmplus} package and
20895 friends.@footnote{On a GNU/Linux system look for packages with names
20896 like @code{netpbm}, @code{libgr-progs} and @code{compface}.})
20897
20898 (NOTE: @code{x-face} is used in the variable/function names, not
20899 @code{xface}).
20900
20901 Gnus provides a few convenience functions and variables to allow
20902 easier insertion of X-Face headers in outgoing messages.
20903
20904 @findex gnus-random-x-face
20905 @code{gnus-random-x-face} goes through all the @samp{pbm} files
20906 in @code{gnus-x-face-directory} and picks one at random, and then
20907 converts it to the X-Face format by using the
20908 @code{gnus-convert-pbm-to-x-face-command} shell command.  The
20909 @samp{pbm} files should be 48x48 pixels big.
20910
20911 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
20912 converts the file to X-Face format by using the
20913 @code{gnus-convert-image-to-x-face-command} shell command.
20914
20915 Here's how you would typically use the former function.  Put something
20916 like the following in your @file{.gnus.el} file:
20917
20918 @lisp
20919 (setq message-required-news-headers
20920       (nconc message-required-news-headers
20921              (list '(X-Face . gnus-random-x-face))))
20922 @end lisp
20923
20924 Using the latter function would be something like this:
20925
20926 @lisp
20927 (setq message-required-news-headers
20928       (nconc message-required-news-headers
20929              (list '(X-Face . (lambda ()
20930                                 (gnus-x-face-from-file
20931                                  "~/My-face.gif"))))))
20932 @end lisp
20933
20934
20935 @node Toolbar
20936 @subsection Toolbar
20937
20938 @table @code
20939
20940 @iftex
20941 @iflatex
20942 \margindex{}
20943 @end iflatex
20944 @end iftex
20945
20946 @item gnus-use-toolbar
20947 @vindex gnus-use-toolbar
20948 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
20949 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
20950 @code{right-toolbar}, or @code{left-toolbar}.
20951
20952 @item gnus-group-toolbar
20953 @vindex gnus-group-toolbar
20954 The toolbar in the group buffer.
20955
20956 @item gnus-summary-toolbar
20957 @vindex gnus-summary-toolbar
20958 The toolbar in the summary buffer.
20959
20960 @item gnus-summary-mail-toolbar
20961 @vindex gnus-summary-mail-toolbar
20962 The toolbar in the summary buffer of mail groups.
20963
20964 @end table
20965
20966
20967 @node XVarious
20968 @subsection Various XEmacs Variables
20969
20970 @table @code
20971 @item gnus-xmas-glyph-directory
20972 @vindex gnus-xmas-glyph-directory
20973 This is where Gnus will look for pictures.  Gnus will normally
20974 auto-detect this directory, but you may set it manually if you have an
20975 unusual directory structure.
20976
20977 @item gnus-xmas-logo-color-alist
20978 @vindex gnus-xmas-logo-color-alist
20979 This is an alist where the key is a type symbol and the values are the
20980 foreground and background color of the splash page glyph.
20981
20982 @item gnus-xmas-logo-color-style
20983 @vindex gnus-xmas-logo-color-style
20984 This is the key used to look up the color in the alist described above.
20985 Valid values include @code{flame}, @code{pine}, @code{moss},
20986 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
20987 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
20988
20989 @item gnus-xmas-modeline-glyph
20990 @vindex gnus-xmas-modeline-glyph
20991 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
20992 default.
20993
20994 @iftex
20995 @iflatex
20996 \margindex{}
20997 @end iflatex
20998 @end iftex
20999
21000 @end table
21001
21002
21003
21004
21005 @node Fuzzy Matching
21006 @section Fuzzy Matching
21007 @cindex fuzzy matching
21008
21009 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
21010 things like scoring, thread gathering and thread comparison.
21011
21012 As opposed to regular expression matching, fuzzy matching is very fuzzy.
21013 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
21014 means, and the implementation has changed over time.
21015
21016 Basically, it tries to remove all noise from lines before comparing.
21017 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
21018 out of the strings before comparing the results.  This often leads to
21019 adequate results---even when faced with strings generated by text
21020 manglers masquerading as newsreaders.
21021
21022
21023 @node Thwarting Email Spam
21024 @section Thwarting Email Spam
21025 @cindex email spam
21026 @cindex spam
21027 @cindex UCE
21028 @cindex unsolicited commercial email
21029
21030 In these last days of the Usenet, commercial vultures are hanging about
21031 and grepping through news like crazy to find email addresses they can
21032 foist off their scams and products to.  As a reaction to this, many
21033 people have started putting nonsense addresses into their @code{From}
21034 lines.  I think this is counterproductive---it makes it difficult for
21035 people to send you legitimate mail in response to things you write, as
21036 well as making it difficult to see who wrote what.  This rewriting may
21037 perhaps be a bigger menace than the unsolicited commercial email itself
21038 in the end.
21039
21040 The biggest problem I have with email spam is that it comes in under
21041 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
21042 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
21043 mail group, only to find two pyramid schemes, seven advertisements
21044 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
21045 and one mail asking me to repent and find some god.
21046
21047 This is annoying.  Here's what you can do about it.
21048
21049 @menu
21050 * The problem of spam::         Some background, and some solutions
21051 * Anti-Spam Basics::            Simple steps to reduce the amount of spam.
21052 * SpamAssassin::                How to use external anti-spam tools.
21053 * Hashcash::                    Reduce spam by burning CPU time.
21054 * Filtering Spam Using spam.el::  
21055 * Filtering Spam Using Statistics (spam-stat.el)::  
21056 @end menu
21057
21058 @node The problem of spam
21059 @subsection The problem of spam
21060 @cindex email spam
21061 @cindex spam filtering approaches
21062 @cindex filtering approaches, spam
21063 @cindex UCE
21064 @cindex unsolicited commercial email
21065
21066 First, some background on spam.
21067
21068 If you have access to e-mail, you are familiar with spam (technically
21069 termed @acronym{UCE}, Unsolicited Commercial E-mail).  Simply put, it exists
21070 because e-mail delivery is very cheap compared to paper mail, so only
21071 a very small percentage of people need to respond to an UCE to make it
21072 worthwhile to the advertiser.  Ironically, one of the most common
21073 spams is the one offering a database of e-mail addresses for further
21074 spamming.  Senders of spam are usually called @emph{spammers}, but terms like
21075 @emph{vermin}, @emph{scum}, and @emph{morons} are in common use as well.
21076
21077 Spam comes from a wide variety of sources.  It is simply impossible to
21078 dispose of all spam without discarding useful messages.  A good
21079 example is the TMDA system, which requires senders
21080 unknown to you to confirm themselves as legitimate senders before
21081 their e-mail can reach you.  Without getting into the technical side
21082 of TMDA, a downside is clearly that e-mail from legitimate sources may
21083 be discarded if those sources can't or won't confirm themselves
21084 through the TMDA system.  Another problem with TMDA is that it
21085 requires its users to have a basic understanding of e-mail delivery
21086 and processing.
21087
21088 The simplest approach to filtering spam is filtering.  If you get 200
21089 spam messages per day from @email{random-address@@vmadmin.com}, you
21090 block @samp{vmadmin.com}.  If you get 200 messages about
21091 @samp{VIAGRA}, you discard all messages with @samp{VIAGRA} in the
21092 message.  This, unfortunately, is a great way to discard legitimate
21093 e-mail.  For instance, the very informative and useful RISKS digest
21094 has been blocked by overzealous mail filters because it
21095 @strong{contained} words that were common in spam messages.
21096 Nevertheless, in isolated cases, with great care, direct filtering of
21097 mail can be useful.
21098
21099 Another approach to filtering e-mail is the distributed spam
21100 processing, for instance DCC implements such a system.  In essence,
21101 @code{N} systems around the world agree that a machine @samp{X} in
21102 China, Ghana, or California is sending out spam e-mail, and these
21103 @code{N} systems enter @samp{X} or the spam e-mail from @samp{X} into
21104 a database.  The criteria for spam detection vary - it may be the
21105 number of messages sent, the content of the messages, and so on.  When
21106 a user of the distributed processing system wants to find out if a
21107 message is spam, he consults one of those @code{N} systems.
21108
21109 Distributed spam processing works very well against spammers that send
21110 a large number of messages at once, but it requires the user to set up
21111 fairly complicated checks.  There are commercial and free distributed
21112 spam processing systems.  Distributed spam processing has its risks as
21113 well.  For instance legitimate e-mail senders have been accused of
21114 sending spam, and their web sites have been shut down for some time
21115 because of the incident.
21116
21117 The statistical approach to spam filtering is also popular.  It is
21118 based on a statistical analysis of previous spam messages.  Usually
21119 the analysis is a simple word frequency count, with perhaps pairs of
21120 words or 3-word combinations thrown into the mix.  Statistical
21121 analysis of spam works very well in most of the cases, but it can
21122 classify legitimate e-mail as spam in some cases.  It takes time to
21123 run the analysis, the full message must be analyzed, and the user has
21124 to store the database of spam analyses.
21125
21126 @node Anti-Spam Basics
21127 @subsection Anti-Spam Basics
21128 @cindex email spam
21129 @cindex spam
21130 @cindex UCE
21131 @cindex unsolicited commercial email
21132
21133 One way of dealing with spam is having Gnus split out all spam into a
21134 @samp{spam} mail group (@pxref{Splitting Mail}).
21135
21136 First, pick one (1) valid mail address that you can be reached at, and
21137 put it in your @code{From} header of all your news articles.  (I've
21138 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
21139 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
21140 sysadmin whether your sendmail installation accepts keywords in the local
21141 part of the mail address.)
21142
21143 @lisp
21144 (setq message-default-news-headers
21145       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
21146 @end lisp
21147
21148 Then put the following split rule in @code{nnmail-split-fancy}
21149 (@pxref{Fancy Mail Splitting}):
21150
21151 @lisp
21152 (
21153  ...
21154  (to "larsi@@trym.ifi.uio.no"
21155       (| ("subject" "re:.*" "misc")
21156          ("references" ".*@@.*" "misc")
21157          "spam"))
21158  ...
21159 )
21160 @end lisp
21161
21162 This says that all mail to this address is suspect, but if it has a
21163 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
21164 header, it's probably ok.  All the rest goes to the @samp{spam} group.
21165 (This idea probably comes from Tim Pierce.)
21166
21167 In addition, many mail spammers talk directly to your @sc{smtp} server
21168 and do not include your email address explicitly in the @code{To}
21169 header.  Why they do this is unknown---perhaps it's to thwart this
21170 thwarting scheme?  In any case, this is trivial to deal with---you just
21171 put anything not addressed to you in the @samp{spam} group by ending
21172 your fancy split rule in this way:
21173
21174 @lisp
21175 (
21176  ...
21177  (to "larsi" "misc")
21178  "spam")
21179 @end lisp
21180
21181 In my experience, this will sort virtually everything into the right
21182 group.  You still have to check the @samp{spam} group from time to time to
21183 check for legitimate mail, though.  If you feel like being a good net
21184 citizen, you can even send off complaints to the proper authorities on
21185 each unsolicited commercial email---at your leisure.
21186
21187 If you are also a lazy net citizen, you will probably prefer complaining
21188 automatically with the @file{gnus-junk.el} package, available FOR FREE
21189 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
21190 Since most e-mail spam is sent automatically, this may reconcile the
21191 cosmic balance somewhat.
21192
21193 This works for me.  It allows people an easy way to contact me (they can
21194 just press @kbd{r} in the usual way), and I'm not bothered at all with
21195 spam.  It's a win-win situation.  Forging @code{From} headers to point
21196 to non-existent domains is yucky, in my opinion.
21197
21198
21199
21200 @node SpamAssassin
21201 @subsection SpamAssassin, Vipul's Razor, DCC, etc
21202 @cindex SpamAssassin
21203 @cindex Vipul's Razor
21204 @cindex DCC
21205
21206 The days where the hints in the previous section was sufficient in
21207 avoiding spam is coming to an end.  There are many tools out there
21208 that claim to reduce the amount of spam you get.  This section could
21209 easily become outdated fast, as new products replace old, but
21210 fortunately most of these tools seem to have similar interfaces.  Even
21211 though this section will use SpamAssassin as an example, it should be
21212 easy to adapt it to most other tools.
21213
21214 If the tool you are using is not installed on the mail server, you
21215 need to invoke it yourself.  Ideas on how to use the
21216 @code{:postscript} mail source parameter (@pxref{Mail Source
21217 Specifiers}) follows.
21218
21219 @lisp
21220 (setq mail-sources
21221       '((file :prescript "formail -bs spamassassin < /var/mail/%u")
21222         (pop :user "jrl"
21223              :server "pophost"
21224              :postscript "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
21225 @end lisp
21226
21227 Once you managed to process your incoming spool somehow, thus making
21228 the mail contain e.g. a header indicating it is spam, you are ready to
21229 filter it out.  Using normal split methods (@pxref{Splitting Mail}):
21230
21231 @lisp
21232 (setq nnmail-split-methods '(("spam"  "^X-Spam-Flag: YES")
21233                              ...))
21234 @end lisp
21235
21236 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
21237
21238 @lisp
21239 (setq nnmail-split-methods 'nnmail-split-fancy
21240       nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
21241                              ...))
21242 @end lisp
21243
21244 Some people might not like the idea of piping the mail through various
21245 programs using a @code{:prescript} (if some program is buggy, you
21246 might lose all mail).  If you are one of them, another solution is to
21247 call the external tools during splitting.  Example fancy split method:
21248
21249 @lisp
21250 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
21251                              ...))
21252 (defun kevin-spamassassin ()
21253   (save-excursion
21254     (let ((buf (or (get-buffer " *nnmail incoming*")
21255                    (get-buffer " *nnml move*"))))
21256       (if (not buf)
21257           (progn (message "Oops, cannot find message buffer") nil)
21258         (set-buffer buf)
21259         (if (eq 1 (call-process-region (point-min) (point-max)
21260                                        "spamc" nil nil nil "-c"))
21261             "spam")))))
21262 @end lisp
21263
21264 That is about it.  As some spam is likely to get through anyway, you
21265 might want to have a nifty function to call when you happen to read
21266 spam.  And here is the nifty function:
21267
21268 @lisp
21269  (defun my-gnus-raze-spam ()
21270   "Submit SPAM to Vipul's Razor, then mark it as expirable."
21271   (interactive)
21272   (gnus-summary-show-raw-article)
21273   (gnus-summary-save-in-pipe "razor-report -f -d")
21274   (gnus-summary-mark-as-expirable 1))
21275 @end lisp
21276
21277 @node Hashcash
21278 @subsection Hashcash
21279 @cindex hashcash
21280
21281 A novel technique to fight spam is to require senders to do something
21282 costly for each message they send.  This has the obvious drawback that
21283 you cannot rely on that everyone in the world uses this technique,
21284 since it is not part of the Internet standards, but it may be useful
21285 in smaller communities.
21286
21287 While the tools in the previous section work well in practice, they
21288 work only because the tools are constantly maintained and updated as
21289 new form of spam appears.  This means that a small percentage of spam
21290 will always get through.  It also means that somewhere, someone needs
21291 to read lots of spam to update these tools.  Hashcash avoids that, but
21292 instead requires that everyone you communicate with supports the
21293 scheme.  You can view the two approaches as pragmatic vs dogmatic.
21294 The approaches have their own advantages and disadvantages, but as
21295 often in the real world, a combination of them is stronger than either
21296 one of them separately.
21297
21298 @cindex X-Hashcash
21299 The ``something costly'' is to burn CPU time, more specifically to
21300 compute a hash collision up to a certain number of bits.  The
21301 resulting hashcash cookie is inserted in a @samp{X-Hashcash:}
21302 header. For more details, and for the external application
21303 @code{hashcash} you need to install to use this feature, see
21304 @uref{http://www.cypherspace.org/~adam/hashcash/}.  Even more
21305 information can be found at @uref{http://www.camram.org/}.
21306
21307 If you wish to call hashcash for each message you send, say something
21308 like:
21309
21310 @lisp
21311 (require 'hashcash)
21312 (add-hook 'message-send-hook 'mail-add-payment)
21313 @end lisp
21314
21315 The @code{hashcash.el} library can be found at
21316 @uref{http://users.actrix.gen.nz/mycroft/hashcash.el}, or in the Gnus
21317 development contrib directory.
21318
21319 You will need to set up some additional variables as well:
21320
21321 @table @code
21322
21323 @item hashcash-default-payment
21324 @vindex hashcash-default-payment
21325 This variable indicates the default number of bits the hash collision
21326 should consist of.  By default this is 0, meaning nothing will be
21327 done.  Suggested useful values include 17 to 29.
21328
21329 @item hashcash-payment-alist
21330 @vindex hashcash-payment-alist
21331 Some receivers may require you to spend burn more CPU time than the
21332 default.  This variable contains a list of @samp{(ADDR AMOUNT)} cells,
21333 where ADDR is the receiver (email address or newsgroup) and AMOUNT is
21334 the number of bits in the collision that is needed.  It can also
21335 contain @samp{(ADDR STRING AMOUNT)} cells, where the STRING is the
21336 string to use (normally the email address or newsgroup name is used).
21337
21338 @item hashcash
21339 @vindex hashcash
21340 Where the @code{hashcash} binary is installed.
21341
21342 @end table
21343
21344 Currently there is no built in functionality in Gnus to verify
21345 hashcash cookies, it is expected that this is performed by your hand
21346 customized mail filtering scripts.  Improvements in this area would be
21347 a useful contribution, however.
21348
21349 @node Filtering Spam Using spam.el
21350 @subsection Filtering Spam Using spam.el
21351 @cindex spam filtering
21352 @cindex spam.el
21353
21354 The idea behind @code{spam.el} is to have a control center for spam detection
21355 and filtering in Gnus.  To that end, @code{spam.el} does two things: it
21356 filters incoming mail, and it analyzes mail known to be spam.
21357
21358 So, what happens when you load @code{spam.el}?  First of all, you get
21359 the following keyboard commands:
21360
21361 @table @kbd
21362
21363 @item M-d
21364 @itemx M s x
21365 @itemx S x
21366 @kindex M-d
21367 @kindex S x
21368 @kindex M s x
21369 @findex gnus-summary-mark-as-spam
21370 @code{gnus-summary-mark-as-spam}.
21371
21372 Mark current article as spam, showing it with the @samp{H} mark.
21373 Whenever you see a spam article, make sure to mark its summary line
21374 with @kbd{M-d} before leaving the group.
21375
21376 @item M s t
21377 @itemx S t
21378 @kindex M s t
21379 @kindex S t
21380 @findex spam-bogofilter-score
21381 @code{spam-bogofilter-score}.
21382
21383 You must have bogofilter processing enabled for that command to work
21384 properly.
21385
21386 @xref{Bogofilter}.
21387
21388 @end table
21389
21390 Gnus can learn from the spam you get.  All you have to do is collect
21391 your spam in one or more spam groups, and set the variable
21392 @code{spam-junk-mailgroups} as appropriate.  In these groups, all messages
21393 are considered to be spam by default: they get the @samp{H} mark.  You must
21394 review these messages from time to time and remove the @samp{H} mark for
21395 every message that is not spam after all.  When you leave a spam
21396 group, all messages that continue with the @samp{H} mark, are passed on to
21397 the spam-detection engine (bogofilter, ifile, and others).  To remove
21398 the @samp{H} mark, you can use @kbd{M-u} to "unread" the article, or @kbd{d} for
21399 declaring it read the non-spam way.  When you leave a group, all @samp{H}
21400 marked articles, saved or unsaved, are sent to Bogofilter or ifile
21401 (depending on @code{spam-use-bogofilter} and @code{spam-use-ifile}), which will study
21402 them as spam samples.
21403
21404 Messages may also be deleted in various other ways, and unless
21405 @code{spam-ham-marks-form} gets overridden below, marks @samp{R} and @samp{r} for
21406 default read or explicit delete, marks @samp{X} and @samp{K} for automatic or
21407 explicit kills, as well as mark @samp{Y} for low scores, are all considered
21408 to be associated with articles which are not spam.  This assumption
21409 might be false, in particular if you use kill files or score files as
21410 means for detecting genuine spam, you should then adjust
21411 @code{spam-ham-marks-form}.  When you leave a group, all _unsaved_ articles
21412 bearing any the above marks are sent to Bogofilter or ifile, which
21413 will study these as not-spam samples.  If you explicit kill a lot, you
21414 might sometimes end up with articles marked @samp{K} which you never saw,
21415 and which might accidentally contain spam.  Best is to make sure that
21416 real spam is marked with @samp{H}, and nothing else.
21417
21418 All other marks do not contribute to Bogofilter or ifile
21419 pre-conditioning.  In particular, ticked, dormant or souped articles
21420 are likely to contribute later, when they will get deleted for real,
21421 so there is no need to use them prematurely.  Explicitly expired
21422 articles do not contribute, command @kbd{E} is a way to get rid of an
21423 article without Bogofilter or ifile ever seeing it.
21424
21425 @strong{TODO: @code{spam-use-ifile} does not process spam articles on group exit.
21426 I'm waiting for info from the author of @code{ifile-gnus.el}, because I think
21427 that functionality should go in @code{ifile-gnus.el} rather than @code{spam.el}.}
21428
21429 To use the @code{spam.el} facilities for incoming mail filtering, you
21430 must add the following to your fancy split list
21431 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}:
21432
21433 @example
21434 (: spam-split)
21435 @end example
21436
21437 Note that the fancy split may be called @code{nnmail-split-fancy} or
21438 @code{nnimap-split-fancy}, depending on whether you use the nnmail or
21439 nnimap back ends to retrieve your mail.
21440
21441 The @code{spam-split} function will process incoming mail and send the mail
21442 considered to be spam into the group name given by the variable
21443 @code{spam-split-group}.  Usually that group name is @samp{spam}.
21444
21445 The following are the methods you can use to control the behavior of
21446 @code{spam-split}:
21447
21448 @menu
21449 * Blacklists and Whitelists::   
21450 * BBDB Whitelists::             
21451 * Blackholes::                  
21452 * Bogofilter::                  
21453 * Ifile spam filtering::        
21454 * Extending spam.el::           
21455 @end menu
21456
21457 @node Blacklists and Whitelists
21458 @subsubsection Blacklists and Whitelists
21459 @cindex spam filtering
21460 @cindex whitelists, spam filtering
21461 @cindex blacklists, spam filtering
21462 @cindex spam.el
21463
21464 @defvar spam-use-blacklist
21465 Set this variables to t (the default) if you want to use blacklists.
21466 @end defvar
21467
21468 @defvar spam-use-whitelist
21469 Set this variables to t if you want to use whitelists.
21470 @end defvar
21471
21472 Blacklists are lists of regular expressions matching addresses you
21473 consider to be spam senders.  For instance, to block mail from any
21474 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
21475 blacklist.  Since you start out with an empty blacklist, no harm is
21476 done by having the @code{spam-use-blacklist} variable set, so it is
21477 set by default.  Blacklist entries use the Emacs regular expression
21478 syntax.
21479
21480 Conversely, whitelists tell Gnus what addresses are considered
21481 legitimate.  All non-whitelisted addresses are considered spammers.
21482 This option is probably not useful for most Gnus users unless the
21483 whitelists is very comprehensive.  Also see @ref{BBDB Whitelists}.
21484 Whitelist entries use the Emacs regular expression syntax.
21485
21486 The Blacklist and whitelist location can be customized with the
21487 @code{spam-directory} variable (@file{~/News/spam} by default).  The whitelist
21488 and blacklist files will be in that directory, named @file{whitelist} and
21489 @file{blacklist} respectively.
21490
21491 @node BBDB Whitelists
21492 @subsubsection BBDB Whitelists
21493 @cindex spam filtering
21494 @cindex BBDB whitelists, spam filtering
21495 @cindex BBDB, spam filtering
21496 @cindex spam.el
21497
21498 @defvar spam-use-bbdb
21499
21500 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
21501 Whitelists}), but uses the BBDB as the source of whitelisted addresses,
21502 without regular expressions.  You must have the BBDB loaded for
21503 @code{spam-use-bbdb} to work properly.  Only addresses in the BBDB
21504 will be allowed through; all others will be classified as spam.
21505
21506 @end defvar
21507
21508 @node Blackholes
21509 @subsubsection Blackholes
21510 @cindex spam filtering
21511 @cindex blackholes, spam filtering
21512 @cindex spam.el
21513
21514 @defvar spam-use-blackholes
21515
21516 This option is disabled by default.  You can let Gnus consult the
21517 blackhole-type distributed spam processing systems (DCC, for instance)
21518 when you set this option.  The variable @code{spam-blackhole-servers}
21519 holds the list of blackhole servers Gnus will consult.  The current
21520 list is fairly comprehensive, but make sure to let us know if it
21521 contains outdated servers.
21522
21523 The blackhole check uses the @code{dig.el} package, but you can tell
21524 @code{spam.el} to use @code{dns.el} instead for better performance if
21525 you set @code{spam-use-dig} to nil.  It is not recommended at this
21526 time to set @code{spam-use-dig} to nil despite the possible
21527 performance improvements, because some users may be unable to use it,
21528 but you can try it and see if it works for you.
21529
21530 @end defvar
21531
21532 @node Bogofilter
21533 @subsubsection Bogofilter
21534 @cindex spam filtering
21535 @cindex bogofilter, spam filtering
21536 @cindex spam.el
21537
21538 @defvar spam-use-bogofilter
21539
21540 Set this variable if you want to use Eric Raymond's speedy Bogofilter.
21541 This has been tested with a locally patched copy of version 0.4.  Make
21542 sure to read the installation comments in @code{spam.el}.
21543
21544 With a minimum of care for associating the @samp{H} mark for spam
21545 articles only, Bogofilter training all gets fairly automatic.  You
21546 should do this until you get a few hundreds of articles in each
21547 category, spam or not.  The shell command @command{head -1
21548 ~/.bogofilter/*} shows both article counts.  The command @kbd{S t} in
21549 summary mode, either for debugging or for curiosity, triggers
21550 Bogofilter into displaying in another buffer the @emph{spamicity}
21551 score of the current article (between 0.0 and 1.0), together with the
21552 article words which most significantly contribute to the score.
21553
21554 @end defvar
21555
21556 @node Ifile spam filtering
21557 @subsubsection Ifile spam filtering
21558 @cindex spam filtering
21559 @cindex ifile, spam filtering
21560 @cindex spam.el
21561
21562 @defvar spam-use-ifile
21563
21564 Enable this variable if you want to use Ifile, a statistical analyzer
21565 similar to Bogofilter.  Currently you must have @code{ifile-gnus.el}
21566 loaded.  The integration of Ifile with @code{spam.el} is not finished
21567 yet, but you can use @code{ifile-gnus.el} on its own if you like.
21568
21569 @end defvar
21570
21571 @node Extending spam.el
21572 @subsubsection Extending spam.el
21573 @cindex spam filtering
21574 @cindex spam.el, extending
21575 @cindex extending spam.el
21576
21577 Say you want to add a new back end called blackbox.  Provide the following:
21578
21579 @enumerate
21580 @item
21581 documentation
21582
21583 @item
21584 code
21585
21586 @example
21587 (defvar spam-use-blackbox nil
21588   "True if blackbox should be used.")
21589 @end example
21590
21591 Add
21592 @example
21593     (spam-use-blackbox   . spam-check-blackbox)
21594 @end example
21595 to @code{spam-list-of-checks}.
21596
21597 @item
21598 functionality
21599
21600 Write the @code{spam-check-blackbox} function.  It should return
21601 @samp{nil} or @code{spam-split-group}.  See the existing
21602 @code{spam-check-*} functions for examples of what you can do.
21603 @end enumerate
21604
21605 @node Filtering Spam Using Statistics (spam-stat.el)
21606 @subsection Filtering Spam Using Statistics (spam-stat.el)
21607 @cindex Paul Graham
21608 @cindex Graham, Paul
21609 @cindex naive Bayesian spam filtering
21610 @cindex Bayesian spam filtering, naive
21611 @cindex spam filtering, naive Bayesian
21612
21613 Paul Graham has written an excellent essay about spam filtering using
21614 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
21615 Spam}.  In it he describes the inherent deficiency of rule-based
21616 filtering as used by SpamAssassin, for example: Somebody has to write
21617 the rules, and everybody else has to install these rules.  You are
21618 always late.  It would be much better, he argues, to filter mail based
21619 on whether it somehow resembles spam or non-spam.  One way to measure
21620 this is word distribution.  He then goes on to describe a solution
21621 that checks whether a new mail resembles any of your other spam mails
21622 or not.
21623
21624 The basic idea is this:  Create a two collections of your mail, one
21625 with spam, one with non-spam.  Count how often each word appears in
21626 either collection, weight this by the total number of mails in the
21627 collections, and store this information in a dictionary.  For every
21628 word in a new mail, determine its probability to belong to a spam or a
21629 non-spam mail.  Use the 15 most conspicuous words, compute the total
21630 probability of the mail being spam.  If this probability is higher
21631 than a certain threshold, the mail is considered to be spam.
21632
21633 Gnus supports this kind of filtering.  But it needs some setting up.
21634 First, you need two collections of your mail, one with spam, one with
21635 non-spam.  Then you need to create a dictionary using these two
21636 collections, and save it.  And last but not least, you need to use
21637 this dictionary in your fancy mail splitting rules.
21638
21639 @menu
21640 * Creating a spam-stat dictionary::  
21641 * Splitting mail using spam-stat::  
21642 * Low-level interface to the spam-stat dictionary::  
21643 @end menu
21644
21645 @node Creating a spam-stat dictionary
21646 @subsubsection Creating a spam-stat dictionary
21647
21648 Before you can begin to filter spam based on statistics, you must
21649 create these statistics based on two mail collections, one with spam,
21650 one with non-spam.  These statistics are then stored in a dictionary
21651 for later use.  In order for these statistics to be meaningful, you
21652 need several hundred emails in both collections.
21653
21654 Gnus currently supports only the nnml back end for automated dictionary
21655 creation.  The nnml back end stores all mails in a directory, one file
21656 per mail.  Use the following:
21657
21658 @defun spam-stat-process-spam-directory
21659 Create spam statistics for every file in this directory.  Every file
21660 is treated as one spam mail.
21661 @end defun
21662
21663 @defun spam-stat-process-non-spam-directory
21664 Create non-spam statistics for every file in this directory.  Every
21665 file is treated as one non-spam mail.
21666 @end defun
21667
21668 Usually you would call @code{spam-stat-process-spam-directory} on a
21669 directory such as @file{~/Mail/mail/spam} (this usually corresponds
21670 the the group @samp{nnml:mail.spam}), and you would call
21671 @code{spam-stat-process-non-spam-directory} on a directory such as
21672 @file{~/Mail/mail/misc} (this usually corresponds the the group
21673 @samp{nnml:mail.misc}).
21674
21675 @defvar spam-stat
21676 This variable holds the hash-table with all the statistics -- the
21677 dictionary we have been talking about.  For every word in either
21678 collection, this hash-table stores a vector describing how often the
21679 word appeared in spam and often it appeared in non-spam mails.
21680
21681 If you want to regenerate the statistics from scratch, you need to
21682 reset the dictionary.
21683
21684 @end defvar
21685
21686 @defun spam-stat-reset
21687 Reset the @code{spam-stat} hash-table, deleting all the statistics.
21688
21689 When you are done, you must save the dictionary.  The dictionary may
21690 be rather large.  If you will not update the dictionary incrementally
21691 (instead, you will recreate it once a month, for example), then you
21692 can reduce the size of the dictionary by deleting all words that did
21693 not appear often enough or that do not clearly belong to only spam or
21694 only non-spam mails.
21695 @end defun
21696
21697 @defun spam-stat-reduce-size
21698 Reduce the size of the dictionary.  Use this only if you do not want
21699 to update the dictionary incrementally.
21700 @end defun
21701
21702 @defun spam-stat-save
21703 Save the dictionary.
21704 @end defun
21705
21706 @defvar spam-stat-file
21707 The filename used to store the dictionary.  This defaults to
21708 @file{~/.spam-stat.el}.
21709 @end defvar
21710
21711 @node Splitting mail using spam-stat
21712 @subsubsection Splitting mail using spam-stat
21713
21714 In order to use @code{spam-stat} to split your mail, you need to add the
21715 following to your @file{~/.gnus} file:
21716
21717 @example
21718 (require 'spam-stat)
21719 (spam-stat-load)
21720 @end example
21721
21722 This will load the necessary Gnus code, and the dictionary you
21723 created.
21724
21725 Next, you need to adapt your fancy splitting rules:  You need to
21726 determine how to use @code{spam-stat}.  In the simplest case, you only have
21727 two groups, @samp{mail.misc} and @samp{mail.spam}.  The following expression says
21728 that mail is either spam or it should go into @samp{mail.misc}.  If it is
21729 spam, then @code{spam-stat-split-fancy} will return @samp{mail.spam}.
21730
21731 @example
21732 (setq nnmail-split-fancy
21733       `(| (: spam-stat-split-fancy)
21734           "mail.misc"))
21735 @end example
21736
21737 @defvar spam-stat-split-fancy-spam-group
21738 The group to use for spam.  Default is @samp{mail.spam}.
21739 @end defvar
21740
21741 If you also filter mail with specific subjects into other groups, use
21742 the following expression.  It only the mails not matching the regular
21743 expression are considered potential spam.
21744
21745 @example
21746 (setq nnmail-split-fancy
21747       `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
21748           (: spam-stat-split-fancy)
21749           "mail.misc"))
21750 @end example
21751
21752 If you want to filter for spam first, then you must be careful when
21753 creating the dictionary.  Note that @code{spam-stat-split-fancy} must
21754 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
21755 non-spam, therefore both should be in your collection of non-spam
21756 mails, when creating the dictionary!
21757
21758 @example
21759 (setq nnmail-split-fancy
21760       `(| (: spam-stat-split-fancy)
21761           ("Subject" "\\bspam-stat\\b" "mail.emacs")
21762           "mail.misc"))
21763 @end example
21764
21765 You can combine this with traditional filtering.  Here, we move all
21766 HTML-only mails into the @samp{mail.spam.filtered} group.  Note that since
21767 @code{spam-stat-split-fancy} will never see them, the mails in
21768 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
21769 nor in your collection of non-spam mails, when creating the
21770 dictionary!
21771
21772 @example
21773 (setq nnmail-split-fancy
21774       `(| ("Content-Type" "text/html" "mail.spam.filtered")
21775           (: spam-stat-split-fancy)
21776           ("Subject" "\\bspam-stat\\b" "mail.emacs")
21777           "mail.misc"))
21778 @end example
21779
21780
21781 @node Low-level interface to the spam-stat dictionary
21782 @subsubsection Low-level interface to the spam-stat dictionary
21783
21784 The main interface to using @code{spam-stat}, are the following functions:
21785
21786 @defun spam-stat-buffer-is-spam
21787 called in a buffer, that buffer is considered to be a new spam mail;
21788 use this for new mail that has not been processed before
21789
21790 @end defun
21791
21792 @defun spam-stat-buffer-is-no-spam
21793 called in a buffer, that buffer is considered to be a new non-spam
21794 mail; use this for new mail that has not been processed before
21795
21796 @end defun
21797
21798 @defun spam-stat-buffer-change-to-spam
21799 called in a buffer, that buffer is no longer considered to be normal
21800 mail but spam; use this to change the status of a mail that has
21801 already been processed as non-spam
21802
21803 @end defun
21804
21805 @defun spam-stat-buffer-change-to-non-spam
21806 called in a buffer, that buffer is no longer considered to be spam but
21807 normal mail; use this to change the status of a mail that has already
21808 been processed as spam
21809
21810 @end defun
21811
21812 @defun spam-stat-save
21813 save the hash table to the file; the filename used is stored in the
21814 variable @code{spam-stat-file}
21815
21816 @end defun
21817
21818 @defun spam-stat-load
21819 load the hash table from a file; the filename used is stored in the
21820 variable @code{spam-stat-file}
21821
21822 @end defun
21823
21824 @defun spam-stat-score-word
21825 return the spam score for a word
21826
21827 @end defun
21828
21829 @defun spam-stat-score-buffer
21830 return the spam score for a buffer
21831
21832 @end defun
21833
21834 @defun spam-stat-split-fancy
21835 for fancy mail splitting; add the rule @samp{(: spam-stat-split-fancy)} to
21836 @code{nnmail-split-fancy}
21837
21838 This requires the following in your @file{~/.gnus} file:
21839
21840 @example
21841 (require 'spam-stat)
21842 (spam-stat-load)
21843 @end example
21844
21845 @end defun
21846
21847 Typical test will involve calls to the following functions:
21848
21849 @example
21850 Reset: (setq spam-stat (make-hash-table :test 'equal))
21851 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
21852 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
21853 Save table: (spam-stat-save)
21854 File size: (nth 7 (file-attributes spam-stat-file))
21855 Number of words: (hash-table-count spam-stat)
21856 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
21857 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
21858 Reduce table size: (spam-stat-reduce-size)
21859 Save table: (spam-stat-save)
21860 File size: (nth 7 (file-attributes spam-stat-file))
21861 Number of words: (hash-table-count spam-stat)
21862 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
21863 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
21864 @end example
21865
21866 Here is how you would create your dictionary:
21867
21868 @example
21869 Reset: (setq spam-stat (make-hash-table :test 'equal))
21870 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
21871 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
21872 Repeat for any other non-spam group you need...
21873 Reduce table size: (spam-stat-reduce-size)
21874 Save table: (spam-stat-save)
21875 @end example
21876
21877 @node Various Various
21878 @section Various Various
21879 @cindex mode lines
21880 @cindex highlights
21881
21882 @table @code
21883
21884 @item gnus-home-directory
21885 All Gnus path variables will be initialized from this variable, which
21886 defaults to @file{~/}.
21887
21888 @item gnus-directory
21889 @vindex gnus-directory
21890 Most Gnus storage path variables will be initialized from this variable,
21891 which defaults to the @samp{SAVEDIR} environment variable, or
21892 @file{~/News/} if that variable isn't set.
21893
21894 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
21895 This means that other directory variables that are initialized from this
21896 variable won't be set properly if you set this variable in
21897 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
21898
21899 @item gnus-default-directory
21900 @vindex gnus-default-directory
21901 Not related to the above variable at all---this variable says what the
21902 default directory of all Gnus buffers should be.  If you issue commands
21903 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
21904 default directory.  If this variable is @code{nil} (which is the
21905 default), the default directory will be the default directory of the
21906 buffer you were in when you started Gnus.
21907
21908 @item gnus-verbose
21909 @vindex gnus-verbose
21910 This variable is an integer between zero and ten.  The higher the value,
21911 the more messages will be displayed.  If this variable is zero, Gnus
21912 will never flash any messages, if it is seven (which is the default),
21913 most important messages will be shown, and if it is ten, Gnus won't ever
21914 shut up, but will flash so many messages it will make your head swim.
21915
21916 @item gnus-verbose-backends
21917 @vindex gnus-verbose-backends
21918 This variable works the same way as @code{gnus-verbose}, but it applies
21919 to the Gnus back ends instead of Gnus proper.
21920
21921 @item nnheader-max-head-length
21922 @vindex nnheader-max-head-length
21923 When the back ends read straight heads of articles, they all try to read
21924 as little as possible.  This variable (default 4096) specifies
21925 the absolute max length the back ends will try to read before giving up
21926 on finding a separator line between the head and the body.  If this
21927 variable is @code{nil}, there is no upper read bound.  If it is
21928 @code{t}, the back ends won't try to read the articles piece by piece,
21929 but read the entire articles.  This makes sense with some versions of
21930 @code{ange-ftp} or @code{efs}.
21931
21932 @item nnheader-head-chop-length
21933 @vindex nnheader-head-chop-length
21934 This variable (default 2048) says how big a piece of each article to
21935 read when doing the operation described above.
21936
21937 @item nnheader-file-name-translation-alist
21938 @vindex nnheader-file-name-translation-alist
21939 @cindex file names
21940 @cindex invalid characters in file names
21941 @cindex characters in file names
21942 This is an alist that says how to translate characters in file names.
21943 For instance, if @samp{:} is invalid as a file character in file names
21944 on your system (you OS/2 user you), you could say something like:
21945
21946 @lisp
21947 (setq nnheader-file-name-translation-alist
21948       '((?: . ?_)))
21949 @end lisp
21950
21951 In fact, this is the default value for this variable on OS/2 and MS
21952 Windows (phooey) systems.
21953
21954 @item gnus-hidden-properties
21955 @vindex gnus-hidden-properties
21956 This is a list of properties to use to hide ``invisible'' text.  It is
21957 @code{(invisible t intangible t)} by default on most systems, which
21958 makes invisible text invisible and intangible.
21959
21960 @item gnus-parse-headers-hook
21961 @vindex gnus-parse-headers-hook
21962 A hook called before parsing headers.  It can be used, for instance, to
21963 gather statistics on the headers fetched, or perhaps you'd like to prune
21964 some headers.  I don't see why you'd want that, though.
21965
21966 @item gnus-shell-command-separator
21967 @vindex gnus-shell-command-separator
21968 String used to separate two shell commands.  The default is @samp{;}.
21969
21970 @item gnus-invalid-group-regexp
21971 @vindex gnus-invalid-group-regexp
21972
21973 Regexp to match ``invalid'' group names when querying user for a group
21974 name.  The default value catches some @strong{really} invalid group
21975 names who could possibly mess up Gnus internally (like allowing
21976 @samp{:} in a group name, which is normally used to delimit method and
21977 group).
21978
21979 @sc{imap} users might want to allow @samp{/} in group names though.
21980
21981
21982 @end table
21983
21984 @node The End
21985 @chapter The End
21986
21987 Well, that's the manual---you can get on with your life now.  Keep in
21988 touch.  Say hello to your cats from me.
21989
21990 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
21991
21992 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
21993
21994 @quotation
21995 @strong{Te Deum}
21996
21997 @sp 1
21998 Not because of victories @*
21999 I sing,@*
22000 having none,@*
22001 but for the common sunshine,@*
22002 the breeze,@*
22003 the largess of the spring.
22004
22005 @sp 1
22006 Not for victory@*
22007 but for the day's work done@*
22008 as well as I was able;@*
22009 not for a seat upon the dais@*
22010 but at the common table.@*
22011 @end quotation
22012
22013
22014 @node Appendices
22015 @chapter Appendices
22016
22017 @menu
22018 * XEmacs::                      Requirements for installing under XEmacs.
22019 * History::                     How Gnus got where it is today.
22020 * On Writing Manuals::          Why this is not a beginner's guide.
22021 * Terminology::                 We use really difficult, like, words here.
22022 * Customization::               Tailoring Gnus to your needs.
22023 * Troubleshooting::             What you might try if things do not work.
22024 * Gnus Reference Guide::        Rilly, rilly technical stuff.
22025 * Emacs for Heathens::          A short introduction to Emacsian terms.
22026 * Frequently Asked Questions::
22027 @end menu
22028
22029
22030 @node XEmacs
22031 @section XEmacs
22032 @cindex XEmacs
22033 @cindex Installing under XEmacs
22034
22035 XEmacs is distributed as a collection of packages.  You should install
22036 whatever packages the Gnus XEmacs package requires.  The current
22037 requirements are @samp{gnus}, @samp{w3}, @samp{mh-e},
22038 @samp{mailcrypt}, @samp{rmail}, @samp{eterm}, @samp{mail-lib},
22039 @samp{xemacs-base}, and @samp{fsf-compat}.  The @samp{misc-games}
22040 package is required for Morse decoding.
22041
22042
22043 @node History
22044 @section History
22045
22046 @cindex history
22047 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
22048 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
22049
22050 If you want to investigate the person responsible for this outrage,
22051 you can point your (feh!) web browser to
22052 @uref{http://quimby.gnus.org/}.  This is also the primary
22053 distribution point for the new and spiffy versions of Gnus, and is
22054 known as The Site That Destroys Newsrcs And Drives People Mad.
22055
22056 During the first extended alpha period of development, the new Gnus was
22057 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
22058 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
22059 (Besides, the ``Gnus'' in this abbreviation should probably be
22060 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
22061 appropriate name, don't you think?)
22062
22063 In any case, after spending all that energy on coming up with a new and
22064 spunky name, we decided that the name was @emph{too} spunky, so we
22065 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
22066 ``@sc{gnus}''.  New vs. old.
22067
22068 @menu
22069 * Gnus Versions::               What Gnus versions have been released.
22070 * Other Gnus Versions::         Other Gnus versions that also have been released.
22071 * Why?::                        What's the point of Gnus?
22072 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
22073 * Conformity::                  Gnus tries to conform to all standards.
22074 * Emacsen::                     Gnus can be run on a few modern Emacsen.
22075 * Gnus Development::            How Gnus is developed.
22076 * Contributors::                Oodles of people.
22077 * New Features::                Pointers to some of the new stuff in Gnus.
22078 @end menu
22079
22080
22081 @node Gnus Versions
22082 @subsection Gnus Versions
22083 @cindex ding Gnus
22084 @cindex September Gnus
22085 @cindex Red Gnus
22086 @cindex Quassia Gnus
22087 @cindex Pterodactyl Gnus
22088 @cindex Oort Gnus
22089 @cindex No Gnus
22090
22091 The first ``proper'' release of Gnus 5 was done in November 1995 when it
22092 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
22093 plus 15 Gnus 5.0 releases).
22094
22095 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
22096 releases)) was released under the name ``Gnus 5.2'' (40 releases).
22097
22098 On July 28th 1996 work on Red Gnus was begun, and it was released on
22099 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
22100
22101 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
22102 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
22103
22104 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
22105 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
22106 1999.
22107
22108 On the 26th of October 2000, Oort Gnus was begun.
22109
22110 If you happen upon a version of Gnus that has a prefixed name --
22111 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
22112 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic.  Don't let it know
22113 that you're frightened.  Back away.  Slowly.  Whatever you do, don't
22114 run.  Walk away, calmly, until you're out of its reach.  Find a proper
22115 released version of Gnus and snuggle up to that instead.
22116
22117
22118 @node Other Gnus Versions
22119 @subsection Other Gnus Versions
22120 @cindex Semi-gnus
22121
22122 In addition to the versions of Gnus which have had their releases
22123 coordinated by Lars, one major development has been Semi-gnus from
22124 Japan.  It's based on a library called @sc{semi}, which provides
22125 @sc{mime} capabilities.
22126
22127 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
22128 Collectively, they are called ``Semi-gnus'', and different strains are
22129 called T-gnus, ET-gnus, Nana-gnus and Chaos.  These provide powerful
22130 @sc{mime} and multilingualization things, especially important for
22131 Japanese users.
22132
22133
22134 @node Why?
22135 @subsection Why?
22136
22137 What's the point of Gnus?
22138
22139 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
22140 newsreader, that lets you do anything you can think of.  That was my
22141 original motivation, but while working on Gnus, it has become clear to
22142 me that this generation of newsreaders really belong in the stone age.
22143 Newsreaders haven't developed much since the infancy of the net.  If the
22144 volume continues to rise with the current rate of increase, all current
22145 newsreaders will be pretty much useless.  How do you deal with
22146 newsgroups that have thousands of new articles each day?  How do you
22147 keep track of millions of people who post?
22148
22149 Gnus offers no real solutions to these questions, but I would very much
22150 like to see Gnus being used as a testing ground for new methods of
22151 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
22152 to separate the newsreader from the back ends, Gnus now offers a simple
22153 interface for anybody who wants to write new back ends for fetching mail
22154 and news from different sources.  I have added hooks for customizations
22155 everywhere I could imagine it being useful.  By doing so, I'm inviting
22156 every one of you to explore and invent.
22157
22158 May Gnus never be complete.  @kbd{C-u 100 M-x all-hail-emacs} and
22159 @kbd{C-u 100 M-x all-hail-xemacs}.
22160
22161
22162 @node Compatibility
22163 @subsection Compatibility
22164
22165 @cindex compatibility
22166 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
22167 bindings have been kept.  More key bindings have been added, of course,
22168 but only in one or two obscure cases have old bindings been changed.
22169
22170 Our motto is:
22171 @quotation
22172 @cartouche
22173 @center In a cloud bones of steel.
22174 @end cartouche
22175 @end quotation
22176
22177 All commands have kept their names.  Some internal functions have changed
22178 their names.
22179
22180 The @code{gnus-uu} package has changed drastically.  @xref{Decoding
22181 Articles}.
22182
22183 One major compatibility question is the presence of several summary
22184 buffers.  All variables relevant while reading a group are
22185 buffer-local to the summary buffer they belong in.  Although many
22186 important variables have their values copied into their global
22187 counterparts whenever a command is executed in the summary buffer, this
22188 change might lead to incorrect values being used unless you are careful.
22189
22190 All code that relies on knowledge of @sc{gnus} internals will probably
22191 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
22192 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
22193 maintains a hash table that points to the entries in this alist (which
22194 speeds up many functions), and changing the alist directly will lead to
22195 peculiar results.
22196
22197 @cindex hilit19
22198 @cindex highlighting
22199 Old hilit19 code does not work at all.  In fact, you should probably
22200 remove all hilit code from all Gnus hooks
22201 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
22202 Gnus provides various integrated functions for highlighting.  These are
22203 faster and more accurate.  To make life easier for everybody, Gnus will
22204 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
22205 Away!
22206
22207 Packages like @code{expire-kill} will no longer work.  As a matter of
22208 fact, you should probably remove all old @sc{gnus} packages (and other
22209 code) when you start using Gnus.  More likely than not, Gnus already
22210 does what you have written code to make @sc{gnus} do.  (Snicker.)
22211
22212 Even though old methods of doing things are still supported, only the
22213 new methods are documented in this manual.  If you detect a new method of
22214 doing something while reading this manual, that does not mean you have
22215 to stop doing it the old way.
22216
22217 Gnus understands all @sc{gnus} startup files.
22218
22219 @kindex M-x gnus-bug
22220 @findex gnus-bug
22221 @cindex reporting bugs
22222 @cindex bugs
22223 Overall, a casual user who hasn't written much code that depends on
22224 @sc{gnus} internals should suffer no problems.  If problems occur,
22225 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
22226
22227 @vindex gnus-bug-create-help-buffer
22228 If you are in the habit of sending bug reports @emph{very} often, you
22229 may find the helpful help buffer annoying after a while.  If so, set
22230 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
22231 up at you.
22232
22233
22234 @node Conformity
22235 @subsection Conformity
22236
22237 No rebels without a clue here, ma'am.  We conform to all standards known
22238 to (wo)man.  Except for those standards and/or conventions we disagree
22239 with, of course.
22240
22241 @table @strong
22242
22243 @item RFC (2)822
22244 @cindex RFC 822
22245 @cindex RFC 2822
22246 There are no known breaches of this standard.
22247
22248 @item RFC 1036
22249 @cindex RFC 1036
22250 There are no known breaches of this standard, either.
22251
22252 @item Son-of-RFC 1036
22253 @cindex Son-of-RFC 1036
22254 We do have some breaches to this one.
22255
22256 @table @emph
22257
22258 @item X-Newsreader
22259 @itemx User-Agent
22260 These are considered to be ``vanity headers'', while I consider them
22261 to be consumer information.  After seeing so many badly formatted
22262 articles coming from @code{tin} and @code{Netscape} I know not to use
22263 either of those for posting articles.  I would not have known that if
22264 it wasn't for the @code{X-Newsreader} header.
22265 @end table
22266
22267 @item USEFOR
22268 @cindex USEFOR
22269 USEFOR is an IETF working group writing a successor to RFC 1036, based
22270 on Son-of-RFC 1036.  They have produced a number of drafts proposing
22271 various changes to the format of news articles.  The Gnus towers will
22272 look into implementing the changes when the draft is accepted as an RFC.
22273
22274 @item MIME - RFC 2045-2049 etc
22275 @cindex MIME
22276 All the various @sc{mime} RFCs are supported.
22277
22278 @item Disposition Notifications - RFC 2298
22279 Message Mode is able to request notifications from the receiver.
22280
22281 @item PGP - RFC 1991 and RFC 2440
22282 @cindex RFC 1991
22283 @cindex RFC 2440
22284 RFC 1991 is the original PGP message specification, published as a
22285 Information RFC.  RFC 2440 was the follow-up, now called Open PGP, and
22286 put on the Standards Track.  Both document a non-@sc{mime} aware PGP
22287 format.  Gnus supports both encoding (signing and encryption) and
22288 decoding (verification and decryption).
22289
22290 @item PGP/MIME - RFC 2015/3156
22291 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
22292 1991) describes the @sc{mime}-wrapping around the RF 1991/2440 format.
22293 Gnus supports both encoding and decoding.
22294
22295 @item S/MIME - RFC 2633
22296 RFC 2633 describes the @sc{s/mime} format.
22297
22298 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
22299 RFC 1730 is @sc{imap} version 4, updated somewhat by RFC 2060 (@sc{imap} 4
22300 revision 1).  RFC 2195 describes CRAM-MD5 authentication for @sc{imap}. RFC
22301 2086 describes access control lists (ACLs) for @sc{imap}. RFC 2359
22302 describes a @sc{imap} protocol enhancement.  RFC 2595 describes the proper
22303 TLS integration (STARTTLS) with @sc{imap}.  RFC 1731 describes the
22304 GSSAPI/Kerberos4 mechanisms for @sc{imap}.
22305
22306 @end table
22307
22308 If you ever notice Gnus acting non-compliant with regards to the texts
22309 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
22310 know.
22311
22312
22313 @node Emacsen
22314 @subsection Emacsen
22315 @cindex Emacsen
22316 @cindex XEmacs
22317 @cindex Mule
22318 @cindex Emacs
22319
22320 Gnus should work on :
22321
22322 @itemize @bullet
22323
22324 @item
22325 Emacs 20.3 and up.
22326
22327 @item
22328 XEmacs 21.1.1 and up.
22329
22330 @end itemize
22331
22332 This Gnus version will absolutely not work on any Emacsen older than
22333 that.  Not reliably, at least.  Older versions of Gnus may work on older
22334 Emacs versions.  However, T-gnus does support ``Mule 2.3 based on Emacs
22335 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
22336 See the file ``README'' in the T-gnus distribution for more details.
22337
22338 There are some vague differences between Gnus on the various
22339 platforms---XEmacs features more graphics (a logo and a toolbar)---but
22340 other than that, things should look pretty much the same under all
22341 Emacsen.
22342
22343
22344 @node Gnus Development
22345 @subsection Gnus Development
22346
22347 Gnus is developed in a two-phased cycle.  The first phase involves much
22348 discussion on the @samp{ding@@gnus.org} mailing list, where people
22349 propose changes and new features, post patches and new back ends.  This
22350 phase is called the @dfn{alpha} phase, since the Gnusae released in this
22351 phase are @dfn{alpha releases}, or (perhaps more commonly in other
22352 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
22353 unstable and should not be used by casual users.  Gnus alpha releases
22354 have names like ``Red Gnus'' and ``Quassia Gnus''.
22355
22356 After futzing around for 50-100 alpha releases, Gnus is declared
22357 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
22358 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
22359 supposed to be able to use these, and these are mostly discussed on the
22360 @samp{gnu.emacs.gnus} newsgroup.
22361
22362 @cindex Incoming*
22363 @vindex mail-source-delete-incoming
22364 Some variable defaults differ between alpha Gnusae and released Gnusae.
22365 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
22366 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
22367 lossage of mail if an alpha release hiccups while handling the mail.
22368
22369 The division of discussion between the ding mailing list and the Gnus
22370 newsgroup is not purely based on publicity concerns.  It's true that
22371 having people write about the horrible things that an alpha Gnus release
22372 can do (sometimes) in a public forum may scare people off, but more
22373 importantly, talking about new experimental features that have been
22374 introduced may confuse casual users.  New features are frequently
22375 introduced, fiddled with, and judged to be found wanting, and then
22376 either discarded or totally rewritten.  People reading the mailing list
22377 usually keep up with these rapid changes, while people on the newsgroup
22378 can't be assumed to do so.
22379
22380
22381
22382 @node Contributors
22383 @subsection Contributors
22384 @cindex contributors
22385
22386 The new Gnus version couldn't have been done without the help of all the
22387 people on the (ding) mailing list.  Every day for over a year I have
22388 gotten billions of nice bug reports from them, filling me with joy,
22389 every single one of them.  Smooches.  The people on the list have been
22390 tried beyond endurance, what with my ``oh, that's a neat idea <type
22391 type>, yup, I'll release it right away <ship off> no wait, that doesn't
22392 work at all <type type>, yup, I'll ship that one off right away <ship
22393 off> no, wait, that absolutely does not work'' policy for releases.
22394 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
22395 ``worser''? ``much worser''?  ``worsest''?)
22396
22397 I would like to take this opportunity to thank the Academy for...  oops,
22398 wrong show.
22399
22400 @itemize @bullet
22401
22402 @item
22403 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
22404
22405 @item
22406 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
22407 nnwarchive and many, many other things connected with @sc{mime} and
22408 other types of en/decoding, as well as general bug fixing, new
22409 functionality and stuff.
22410
22411 @item
22412 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
22413 well as numerous other things).
22414
22415 @item
22416 Luis Fernandes---design and graphics.
22417
22418 @item
22419 Joe Reiss---creator of the smiley faces.
22420
22421 @item
22422 Justin Sheehy--the FAQ maintainer.
22423
22424 @item
22425 Erik Naggum---help, ideas, support, code and stuff.
22426
22427 @item
22428 Wes Hardaker---@file{gnus-picon.el} and the manual section on
22429 @dfn{picons} (@pxref{Picons}).
22430
22431 @item
22432 Kim-Minh Kaplan---further work on the picon code.
22433
22434 @item
22435 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
22436 (@pxref{GroupLens}).
22437
22438 @item
22439 Sudish Joseph---innumerable bug fixes.
22440
22441 @item
22442 Ilja Weis---@file{gnus-topic.el}.
22443
22444 @item
22445 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
22446
22447 @item
22448 Vladimir Alexiev---the refcard and reference booklets.
22449
22450 @item
22451 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
22452 distribution by Felix Lee and JWZ.
22453
22454 @item
22455 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
22456
22457 @item
22458 Peter Mutsaers---orphan article scoring code.
22459
22460 @item
22461 Ken Raeburn---POP mail support.
22462
22463 @item
22464 Hallvard B Furuseth---various bits and pieces, especially dealing with
22465 .newsrc files.
22466
22467 @item
22468 Brian Edmonds---@file{gnus-bbdb.el}.
22469
22470 @item
22471 David Moore---rewrite of @file{nnvirtual.el} and many other things.
22472
22473 @item
22474 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
22475
22476 @item
22477 François Pinard---many, many interesting and thorough bug reports, as
22478 well as autoconf support.
22479
22480 @end itemize
22481
22482 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
22483 Borges, and Jost Krieger proof-reading parts of the manual.
22484
22485 The following people have contributed many patches and suggestions:
22486
22487 Christopher Davis,
22488 Andrew Eskilsson,
22489 Kai Grossjohann,
22490 David KÃ¥gedal,
22491 Richard Pieri,
22492 Fabrice Popineau,
22493 Daniel Quinlan,
22494 Jason L. Tibbitts, III,
22495 and
22496 Jack Vinson.
22497
22498 Also thanks to the following for patches and stuff:
22499
22500 Jari Aalto,
22501 Adrian Aichner,
22502 Vladimir Alexiev,
22503 Russ Allbery,
22504 Peter Arius,
22505 Matt Armstrong,
22506 Marc Auslander,
22507 Miles Bader,
22508 Alexei V. Barantsev,
22509 Frank Bennett,
22510 Robert Bihlmeyer,
22511 Chris Bone,
22512 Mark Borges,
22513 Mark Boyns,
22514 Lance A. Brown,
22515 Rob Browning,
22516 Kees de Bruin,
22517 Martin Buchholz,
22518 Joe Buehler,
22519 Kevin Buhr,
22520 Alastair Burt,
22521 Joao Cachopo,
22522 Zlatko Calusic,
22523 Massimo Campostrini,
22524 Castor,
22525 David Charlap,
22526 Dan Christensen,
22527 Kevin Christian,
22528 Jae-you Chung, @c ?
22529 James H. Cloos, Jr.,
22530 Laura Conrad,
22531 Michael R. Cook,
22532 Glenn Coombs,
22533 Andrew J. Cosgriff,
22534 Neil Crellin,
22535 Frank D. Cringle,
22536 Geoffrey T. Dairiki,
22537 Andre Deparade,
22538 Ulrik Dickow,
22539 Dave Disser,
22540 Rui-Tao Dong, @c ?
22541 Joev Dubach,
22542 Michael Welsh Duggan,
22543 Dave Edmondson,
22544 Paul Eggert,
22545 Mark W. Eichin,
22546 Karl Eichwalder,
22547 Enami Tsugutomo, @c Enami
22548 Michael Ernst,
22549 Luc Van Eycken,
22550 Sam Falkner,
22551 Nelson Jose dos Santos Ferreira,
22552 Sigbjorn Finne,
22553 Sven Fischer,
22554 Paul Fisher,
22555 Decklin Foster,
22556 Gary D. Foster,
22557 Paul Franklin,
22558 Guy Geens,
22559 Arne Georg Gleditsch,
22560 David S. Goldberg,
22561 Michelangelo Grigni,
22562 Dale Hagglund,
22563 D. Hall,
22564 Magnus Hammerin,
22565 Kenichi Handa, @c Handa
22566 Raja R. Harinath,
22567 Yoshiki Hayashi, @c ?
22568 P. E. Jareth Hein,
22569 Hisashige Kenji, @c Hisashige
22570 Scott Hofmann,
22571 Marc Horowitz,
22572 Gunnar Horrigmo,
22573 Richard Hoskins,
22574 Brad Howes,
22575 Miguel de Icaza,
22576 François Felix Ingrand,
22577 Tatsuya Ichikawa, @c ?
22578 Ishikawa Ichiro, @c Ishikawa
22579 Lee Iverson,
22580 Iwamuro Motonori, @c Iwamuro
22581 Rajappa Iyer,
22582 Andreas Jaeger,
22583 Adam P. Jenkins,
22584 Randell Jesup,
22585 Fred Johansen,
22586 Gareth Jones,
22587 Simon Josefsson,
22588 Greg Klanderman,
22589 Karl Kleinpaste,
22590 Michael Klingbeil,
22591 Peter Skov Knudsen,
22592 Shuhei Kobayashi, @c Kobayashi
22593 Petr Konecny,
22594 Koseki Yoshinori, @c Koseki
22595 Thor Kristoffersen,
22596 Jens Lautenbacher,
22597 Martin Larose,
22598 Seokchan Lee, @c Lee
22599 Joerg Lenneis,
22600 Carsten Leonhardt,
22601 James LewisMoss,
22602 Christian Limpach,
22603 Markus Linnala,
22604 Dave Love,
22605 Mike McEwan,
22606 Tonny Madsen,
22607 Shlomo Mahlab,
22608 Nat Makarevitch,
22609 Istvan Marko,
22610 David Martin,
22611 Jason R. Mastaler,
22612 Gordon Matzigkeit,
22613 Timo Metzemakers,
22614 Richard Mlynarik,
22615 Lantz Moore,
22616 Morioka Tomohiko, @c Morioka
22617 Erik Toubro Nielsen,
22618 Hrvoje Niksic,
22619 Andy Norman,
22620 Fred Oberhauser,
22621 C. R. Oldham,
22622 Alexandre Oliva,
22623 Ken Olstad,
22624 Masaharu Onishi, @c Onishi
22625 Hideki Ono, @c Ono
22626 Ettore Perazzoli,
22627 William Perry,
22628 Stephen Peters,
22629 Jens-Ulrik Holger Petersen,
22630 Ulrich Pfeifer,
22631 Matt Pharr,
22632 Andy Piper,
22633 John McClary Prevost,
22634 Bill Pringlemeir,
22635 Mike Pullen,
22636 Jim Radford,
22637 Colin Rafferty,
22638 Lasse Rasinen,
22639 Lars Balker Rasmussen,
22640 Joe Reiss,
22641 Renaud Rioboo,
22642 Roland B. Roberts,
22643 Bart Robinson,
22644 Christian von Roques,
22645 Markus Rost,
22646 Jason Rumney,
22647 Wolfgang Rupprecht,
22648 Jay Sachs,
22649 Dewey M. Sasser,
22650 Conrad Sauerwald,
22651 Loren Schall,
22652 Dan Schmidt,
22653 Ralph Schleicher,
22654 Philippe Schnoebelen,
22655 Andreas Schwab,
22656 Randal L. Schwartz,
22657 Danny Siu,
22658 Matt Simmons,
22659 Paul D. Smith,
22660 Jeff Sparkes,
22661 Toby Speight,
22662 Michael Sperber,
22663 Darren Stalder,
22664 Richard Stallman,
22665 Greg Stark,
22666 Sam Steingold,
22667 Paul Stevenson,
22668 Jonas Steverud,
22669 Paul Stodghill,
22670 Kiyokazu Suto, @c Suto
22671 Kurt Swanson,
22672 Samuel Tardieu,
22673 Teddy,
22674 Chuck Thompson,
22675 Tozawa Akihiko, @c Tozawa
22676 Philippe Troin,
22677 James Troup,
22678 Trung Tran-Duc,
22679 Jack Twilley,
22680 Aaron M. Ucko,
22681 Aki Vehtari,
22682 Didier Verna,
22683 Vladimir Volovich,
22684 Jan Vroonhof,
22685 Stefan Waldherr,
22686 Pete Ware,
22687 Barry A. Warsaw,
22688 Christoph Wedler,
22689 Joe Wells,
22690 Lee Willis,
22691 Katsumi Yamaoka @c Yamaoka
22692 and
22693 Lloyd Zusman.
22694
22695
22696 For a full overview of what each person has done, the ChangeLogs
22697 included in the Gnus alpha distributions should give ample reading
22698 (550kB and counting).
22699
22700 Apologies to everybody that I've forgotten, of which there are many, I'm
22701 sure.
22702
22703 Gee, that's quite a list of people.  I guess that must mean that there
22704 actually are people who are using Gnus.  Who'd'a thunk it!
22705
22706
22707 @node New Features
22708 @subsection New Features
22709 @cindex new features
22710
22711 @menu
22712 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
22713 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
22714 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
22715 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
22716 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
22717 @end menu
22718
22719 These lists are, of course, just @emph{short} overviews of the
22720 @emph{most} important new features.  No, really.  There are tons more.
22721 Yes, we have feeping creaturism in full effect.
22722
22723 @node ding Gnus
22724 @subsubsection (ding) Gnus
22725
22726 New features in Gnus 5.0/5.1:
22727
22728 @itemize @bullet
22729
22730 @item
22731 The look of all buffers can be changed by setting format-like variables
22732 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
22733
22734 @item
22735 Local spool and several @sc{nntp} servers can be used at once
22736 (@pxref{Select Methods}).
22737
22738 @item
22739 You can combine groups into virtual groups (@pxref{Virtual Groups}).
22740
22741 @item
22742 You can read a number of different mail formats (@pxref{Getting Mail}).
22743 All the mail back ends implement a convenient mail expiry scheme
22744 (@pxref{Expiring Mail}).
22745
22746 @item
22747 Gnus can use various strategies for gathering threads that have lost
22748 their roots (thereby gathering loose sub-threads into one thread) or it
22749 can go back and retrieve enough headers to build a complete thread
22750 (@pxref{Customizing Threading}).
22751
22752 @item
22753 Killed groups can be displayed in the group buffer, and you can read
22754 them as well (@pxref{Listing Groups}).
22755
22756 @item
22757 Gnus can do partial group updates---you do not have to retrieve the
22758 entire active file just to check for new articles in a few groups
22759 (@pxref{The Active File}).
22760
22761 @item
22762 Gnus implements a sliding scale of subscribedness to groups
22763 (@pxref{Group Levels}).
22764
22765 @item
22766 You can score articles according to any number of criteria
22767 (@pxref{Scoring}).  You can even get Gnus to find out how to score
22768 articles for you (@pxref{Adaptive Scoring}).
22769
22770 @item
22771 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
22772 manner, so it should be difficult to lose much data on what you have
22773 read if your machine should go down (@pxref{Auto Save}).
22774
22775 @item
22776 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
22777 the @file{.emacs} file.
22778
22779 @item
22780 You can set the process mark on both groups and articles and perform
22781 operations on all the marked items (@pxref{Process/Prefix}).
22782
22783 @item
22784 You can grep through a subset of groups and create a group from the
22785 results (@pxref{Kibozed Groups}).
22786
22787 @item
22788 You can list subsets of groups according to, well, anything
22789 (@pxref{Listing Groups}).
22790
22791 @item
22792 You can browse foreign servers and subscribe to groups from those
22793 servers (@pxref{Browse Foreign Server}).
22794
22795 @item
22796 Gnus can fetch articles, asynchronously, on a second connection to the
22797 server (@pxref{Asynchronous Fetching}).
22798
22799 @item
22800 You can cache articles locally (@pxref{Article Caching}).
22801
22802 @item
22803 The uudecode functions have been expanded and generalized
22804 (@pxref{Decoding Articles}).
22805
22806 @item
22807 You can still post uuencoded articles, which was a little-known feature
22808 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
22809
22810 @item
22811 Fetching parents (and other articles) now actually works without
22812 glitches (@pxref{Finding the Parent}).
22813
22814 @item
22815 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
22816
22817 @item
22818 Digests (and other files) can be used as the basis for groups
22819 (@pxref{Document Groups}).
22820
22821 @item
22822 Articles can be highlighted and customized (@pxref{Customizing
22823 Articles}).
22824
22825 @item
22826 URLs and other external references can be buttonized (@pxref{Article
22827 Buttons}).
22828
22829 @item
22830 You can do lots of strange stuff with the Gnus window & frame
22831 configuration (@pxref{Window Layout}).
22832
22833 @item
22834 You can click on buttons instead of using the keyboard
22835 (@pxref{Buttons}).
22836
22837 @end itemize
22838
22839
22840 @node September Gnus
22841 @subsubsection September Gnus
22842
22843 @iftex
22844 @iflatex
22845 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
22846 @end iflatex
22847 @end iftex
22848
22849 New features in Gnus 5.2/5.3:
22850
22851 @itemize @bullet
22852
22853 @item
22854 A new message composition mode is used.  All old customization variables
22855 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
22856 now obsolete.
22857
22858 @item
22859 Gnus is now able to generate @dfn{sparse} threads---threads where
22860 missing articles are represented by empty nodes (@pxref{Customizing
22861 Threading}).
22862
22863 @lisp
22864 (setq gnus-build-sparse-threads 'some)
22865 @end lisp
22866
22867 @item
22868 Outgoing articles are stored on a special archive server
22869 (@pxref{Archived Messages}).
22870
22871 @item
22872 Partial thread regeneration now happens when articles are
22873 referred.
22874
22875 @item
22876 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
22877
22878 @item
22879 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
22880
22881 @item
22882 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
22883
22884 @lisp
22885 (setq gnus-use-trees t)
22886 @end lisp
22887
22888 @item
22889 An @code{nn}-like pick-and-read minor mode is available for the summary
22890 buffers (@pxref{Pick and Read}).
22891
22892 @lisp
22893 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
22894 @end lisp
22895
22896 @item
22897 In binary groups you can use a special binary minor mode (@pxref{Binary
22898 Groups}).
22899
22900 @item
22901 Groups can be grouped in a folding topic hierarchy (@pxref{Group
22902 Topics}).
22903
22904 @lisp
22905 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
22906 @end lisp
22907
22908 @item
22909 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
22910
22911 @item
22912 Groups can now have a score, and bubbling based on entry frequency
22913 is possible (@pxref{Group Score}).
22914
22915 @lisp
22916 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
22917 @end lisp
22918
22919 @item
22920 Groups can be process-marked, and commands can be performed on
22921 groups of groups (@pxref{Marking Groups}).
22922
22923 @item
22924 Caching is possible in virtual groups.
22925
22926 @item
22927 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
22928 news batches, ClariNet briefs collections, and just about everything
22929 else (@pxref{Document Groups}).
22930
22931 @item
22932 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
22933 (@pxref{SOUP}).
22934
22935 @item
22936 The Gnus cache is much faster.
22937
22938 @item
22939 Groups can be sorted according to many criteria (@pxref{Sorting
22940 Groups}).
22941
22942 @item
22943 New group parameters have been introduced to set list-addresses and
22944 expiry times (@pxref{Group Parameters}).
22945
22946 @item
22947 All formatting specs allow specifying faces to be used
22948 (@pxref{Formatting Fonts}).
22949
22950 @item
22951 There are several more commands for setting/removing/acting on process
22952 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
22953
22954 @item
22955 The summary buffer can be limited to show parts of the available
22956 articles based on a wide range of criteria.  These commands have been
22957 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
22958
22959 @item
22960 Articles can be made persistent with the @kbd{*} command
22961 (@pxref{Persistent Articles}).
22962
22963 @item
22964 All functions for hiding article elements are now toggles.
22965
22966 @item
22967 Article headers can be buttonized (@pxref{Article Washing}).
22968
22969 @item
22970 All mail back ends support fetching articles by @code{Message-ID}.
22971
22972 @item
22973 Duplicate mail can now be treated properly (@pxref{Duplicates}).
22974
22975 @item
22976 All summary mode commands are available directly from the article
22977 buffer (@pxref{Article Keymap}).
22978
22979 @item
22980 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
22981 Layout}).
22982
22983 @item
22984 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
22985 @iftex
22986 @iflatex
22987 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
22988 @end iflatex
22989 @end iftex
22990
22991 @item
22992 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
22993
22994 @lisp
22995 (setq gnus-use-nocem t)
22996 @end lisp
22997
22998 @item
22999 Groups can be made permanently visible (@pxref{Listing Groups}).
23000
23001 @lisp
23002 (setq gnus-permanently-visible-groups "^nnml:")
23003 @end lisp
23004
23005 @item
23006 Many new hooks have been introduced to make customizing easier.
23007
23008 @item
23009 Gnus respects the @code{Mail-Copies-To} header.
23010
23011 @item
23012 Threads can be gathered by looking at the @code{References} header
23013 (@pxref{Customizing Threading}).
23014
23015 @lisp
23016 (setq gnus-summary-thread-gathering-function
23017       'gnus-gather-threads-by-references)
23018 @end lisp
23019
23020 @item
23021 Read articles can be stored in a special backlog buffer to avoid
23022 refetching (@pxref{Article Backlog}).
23023
23024 @lisp
23025 (setq gnus-keep-backlog 50)
23026 @end lisp
23027
23028 @item
23029 A clean copy of the current article is always stored in a separate
23030 buffer to allow easier treatment.
23031
23032 @item
23033 Gnus can suggest where to save articles (@pxref{Saving Articles}).
23034
23035 @item
23036 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
23037 Articles}).
23038
23039 @lisp
23040 (setq gnus-prompt-before-saving t)
23041 @end lisp
23042
23043 @item
23044 @code{gnus-uu} can view decoded files asynchronously while fetching
23045 articles (@pxref{Other Decode Variables}).
23046
23047 @lisp
23048 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
23049 @end lisp
23050
23051 @item
23052 Filling in the article buffer now works properly on cited text
23053 (@pxref{Article Washing}).
23054
23055 @item
23056 Hiding cited text adds buttons to toggle hiding, and how much
23057 cited text to hide is now customizable (@pxref{Article Hiding}).
23058
23059 @lisp
23060 (setq gnus-cited-lines-visible 2)
23061 @end lisp
23062
23063 @item
23064 Boring headers can be hidden (@pxref{Article Hiding}).
23065
23066 @item
23067 Default scoring values can now be set from the menu bar.
23068
23069 @item
23070 Further syntax checking of outgoing articles have been added.
23071
23072 @end itemize
23073
23074
23075 @node Red Gnus
23076 @subsubsection Red Gnus
23077
23078 New features in Gnus 5.4/5.5:
23079
23080 @iftex
23081 @iflatex
23082 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
23083 @end iflatex
23084 @end iftex
23085
23086 @itemize @bullet
23087
23088 @item
23089 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
23090
23091 @item
23092 Article prefetching functionality has been moved up into
23093 Gnus (@pxref{Asynchronous Fetching}).
23094
23095 @item
23096 Scoring can now be performed with logical operators like @code{and},
23097 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
23098 Scoring}).
23099
23100 @item
23101 Article washing status can be displayed in the
23102 article mode line (@pxref{Misc Article}).
23103
23104 @item
23105 @file{gnus.el} has been split into many smaller files.
23106
23107 @item
23108 Suppression of duplicate articles based on Message-ID can be done
23109 (@pxref{Duplicate Suppression}).
23110
23111 @lisp
23112 (setq gnus-suppress-duplicates t)
23113 @end lisp
23114
23115 @item
23116 New variables for specifying what score and adapt files are to be
23117 considered home score and adapt files (@pxref{Home Score File}) have
23118 been added.
23119
23120 @item
23121 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
23122 Server Internals}).
23123
23124 @item
23125 Groups can inherit group parameters from parent topics (@pxref{Topic
23126 Parameters}).
23127
23128 @item
23129 Article editing has been revamped and is now actually usable.
23130
23131 @item
23132 Signatures can be recognized in more intelligent fashions
23133 (@pxref{Article Signature}).
23134
23135 @item
23136 Summary pick mode has been made to look more @code{nn}-like.  Line
23137 numbers are displayed and the @kbd{.} command can be used to pick
23138 articles (@code{Pick and Read}).
23139
23140 @item
23141 Commands for moving the @file{.newsrc.eld} from one server to
23142 another have been added (@pxref{Changing Servers}).
23143
23144 @item
23145 There's a way now to specify that ``uninteresting'' fields be suppressed
23146 when generating lines in buffers (@pxref{Advanced Formatting}).
23147
23148 @item
23149 Several commands in the group buffer can be undone with @kbd{C-M-_}
23150 (@pxref{Undo}).
23151
23152 @item
23153 Scoring can be done on words using the new score type @code{w}
23154 (@pxref{Score File Format}).
23155
23156 @item
23157 Adaptive scoring can be done on a Subject word-by-word basis
23158 (@pxref{Adaptive Scoring}).
23159
23160 @lisp
23161 (setq gnus-use-adaptive-scoring '(word))
23162 @end lisp
23163
23164 @item
23165 Scores can be decayed (@pxref{Score Decays}).
23166
23167 @lisp
23168 (setq gnus-decay-scores t)
23169 @end lisp
23170
23171 @item
23172 Scoring can be performed using a regexp on the Date header.  The Date is
23173 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
23174
23175 @item
23176 A new command has been added to remove all data on articles from
23177 the native server (@pxref{Changing Servers}).
23178
23179 @item
23180 A new command for reading collections of documents
23181 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
23182 (@pxref{Really Various Summary Commands}).
23183
23184 @item
23185 Process mark sets can be pushed and popped (@pxref{Setting Process
23186 Marks}).
23187
23188 @item
23189 A new mail-to-news back end makes it possible to post even when the @sc{nntp}
23190 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
23191
23192 @item
23193 A new back end for reading searches from Web search engines
23194 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
23195 (@pxref{Web Searches}).
23196
23197 @item
23198 Groups inside topics can now be sorted using the standard sorting
23199 functions, and each topic can be sorted independently (@pxref{Topic
23200 Sorting}).
23201
23202 @item
23203 Subsets of the groups can be sorted independently (@code{Sorting
23204 Groups}).
23205
23206 @item
23207 Cached articles can be pulled into the groups (@pxref{Summary Generation
23208 Commands}).
23209 @iftex
23210 @iflatex
23211 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
23212 @end iflatex
23213 @end iftex
23214
23215 @item
23216 Score files are now applied in a more reliable order (@pxref{Score
23217 Variables}).
23218
23219 @item
23220 Reports on where mail messages end up can be generated (@pxref{Splitting
23221 Mail}).
23222
23223 @item
23224 More hooks and functions have been added to remove junk from incoming
23225 mail before saving the mail (@pxref{Washing Mail}).
23226
23227 @item
23228 Emphasized text can be properly fontisized:
23229
23230 @end itemize
23231
23232
23233 @node Quassia Gnus
23234 @subsubsection Quassia Gnus
23235
23236 New features in Gnus 5.6:
23237
23238 @itemize @bullet
23239
23240 @item
23241 New functionality for using Gnus as an offline newsreader has been
23242 added.  A plethora of new commands and modes have been added.  See
23243 @pxref{Gnus Unplugged} for the full story.
23244
23245 @item
23246  The @code{nndraft} back end has returned, but works differently than
23247 before.  All Message buffers are now also articles in the @code{nndraft}
23248 group, which is created automatically.
23249
23250 @item
23251 @code{gnus-alter-header-function} can now be used to alter header
23252 values.
23253
23254 @item
23255  @code{gnus-summary-goto-article} now accept Message-ID's.
23256
23257 @item
23258  A new Message command for deleting text in the body of a message
23259 outside the region: @kbd{C-c C-v}.
23260
23261 @item
23262  You can now post to component group in @code{nnvirtual} groups with
23263 @kbd{C-u C-c C-c}.
23264
23265 @item
23266  @code{nntp-rlogin-program}---new variable to ease customization.
23267
23268 @item
23269  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
23270 re-highlighting of the article buffer.
23271
23272 @item
23273  New element in @code{gnus-boring-article-headers}---@code{long-to}.
23274
23275 @item
23276  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
23277 Prefixes" in the Gnus manual for details.
23278
23279 @item
23280  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
23281 @kbd{a} to add the score rule to the "all.SCORE" file.
23282
23283 @item
23284  @code{gnus-simplify-subject-functions} variable to allow greater
23285 control over simplification.
23286
23287 @item
23288  @kbd{A T}---new command for fetching the current thread.
23289
23290 @item
23291  @kbd{/ T}---new command for including the current thread in the
23292 limit.
23293
23294 @item
23295  @kbd{M-RET} is a new Message command for breaking cited text.
23296
23297 @item
23298  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
23299
23300 @item
23301  The @code{custom-face-lookup} function has been removed.
23302 If you used this function in your initialization files, you must
23303 rewrite them to use @code{face-spec-set} instead.
23304
23305 @item
23306  Canceling now uses the current select method.  Symbolic prefix
23307 @kbd{a} forces normal posting method.
23308
23309 @item
23310  New command to translate M******** sm*rtq**t*s into proper
23311 text---@kbd{W d}.
23312
23313 @item
23314  For easier debugging of @code{nntp}, you can set
23315 @code{nntp-record-commands} to a non-@code{nil} value.
23316
23317 @item
23318  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
23319 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
23320
23321 @item
23322  A command for editing group parameters from the summary buffer
23323 has been added.
23324
23325 @item
23326  A history of where mails have been split is available.
23327
23328 @item
23329  A new article date command has been added---@code{article-date-iso8601}.
23330
23331 @item
23332  Subjects can be simplified when threading by setting
23333 @code{gnus-score-thread-simplify}.
23334
23335 @item
23336  A new function for citing in Message has been
23337 added---@code{message-cite-original-without-signature}.
23338
23339 @item
23340  @code{article-strip-all-blank-lines}---new article command.
23341
23342 @item
23343  A new Message command to kill to the end of the article has
23344 been added.
23345
23346 @item
23347  A minimum adaptive score can be specified by using the
23348 @code{gnus-adaptive-word-minimum} variable.
23349
23350 @item
23351  The "lapsed date" article header can be kept continually
23352 updated by the @code{gnus-start-date-timer} command.
23353
23354 @item
23355  Web listserv archives can be read with the @code{nnlistserv} back end.
23356
23357 @item
23358  Old dejanews archives can now be read by @code{nnweb}.
23359
23360 @end itemize
23361
23362 @node Pterodactyl Gnus
23363 @subsubsection Pterodactyl Gnus
23364
23365 New features in Gnus 5.8:
23366
23367 @itemize @bullet
23368
23369 @item
23370 The mail-fetching functions have changed.  See the manual for the
23371 many details.  In particular, all procmail fetching variables are gone.
23372
23373 If you used procmail like in
23374
23375 @lisp
23376 (setq nnmail-use-procmail t)
23377 (setq nnmail-spool-file 'procmail)
23378 (setq nnmail-procmail-directory "~/mail/incoming/")
23379 (setq nnmail-procmail-suffix "\\.in")
23380 @end lisp
23381
23382 this now has changed to
23383
23384 @lisp
23385 (setq mail-sources
23386       '((directory :path "~/mail/incoming/"
23387                    :suffix ".in")))
23388 @end lisp
23389
23390 More information is available in the info doc at Select Methods ->
23391 Getting Mail -> Mail Sources
23392
23393 @item
23394 Gnus is now a @sc{mime}-capable reader.  This affects many parts of
23395 Gnus, and adds a slew of new commands.  See the manual for details.
23396
23397 @item
23398 Gnus has also been multilingualized.  This also affects too
23399 many parts of Gnus to summarize here, and adds many new variables.
23400
23401 @item
23402 @code{gnus-auto-select-first} can now be a function to be
23403 called to position point.
23404
23405 @item
23406 The user can now decide which extra headers should be included in
23407 summary buffers and @sc{nov} files.
23408
23409 @item
23410 @code{gnus-article-display-hook} has been removed.  Instead, a number
23411 of variables starting with @code{gnus-treat-} have been added.
23412
23413 @item
23414 The Gnus posting styles have been redone again and now works in a
23415 subtly different manner.
23416
23417 @item
23418 New web-based back ends have been added: @code{nnslashdot},
23419 @code{nnwarchive} and @code{nnultimate}.  nnweb has been revamped,
23420 again, to keep up with ever-changing layouts.
23421
23422 @item
23423 Gnus can now read @sc{imap} mail via @code{nnimap}.
23424
23425 @end itemize
23426
23427 @iftex
23428
23429 @page
23430 @node The Manual
23431 @section The Manual
23432 @cindex colophon
23433 @cindex manual
23434
23435 This manual was generated from a TeXinfo file and then run through
23436 either @code{texi2dvi}
23437 @iflatex
23438 or my own home-brewed TeXinfo to \LaTeX\ transformer,
23439 and then run through @code{latex} and @code{dvips}
23440 @end iflatex
23441 to get what you hold in your hands now.
23442
23443 The following conventions have been used:
23444
23445 @enumerate
23446
23447 @item
23448 This is a @samp{string}
23449
23450 @item
23451 This is a @kbd{keystroke}
23452
23453 @item
23454 This is a @file{file}
23455
23456 @item
23457 This is a @code{symbol}
23458
23459 @end enumerate
23460
23461 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
23462 mean:
23463
23464 @lisp
23465 (setq flargnoze "yes")
23466 @end lisp
23467
23468 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
23469
23470 @lisp
23471 (setq flumphel 'yes)
23472 @end lisp
23473
23474 @samp{yes} and @code{yes} are two @emph{very} different things---don't
23475 ever get them confused.
23476
23477 @iflatex
23478 @c @head
23479 Of course, everything in this manual is of vital interest, so you should
23480 read it all.  Several times.  However, if you feel like skimming the
23481 manual, look for that gnu head you should see in the margin over
23482 there---it means that what's being discussed is of more importance than
23483 the rest of the stuff.  (On the other hand, if everything is infinitely
23484 important, how can anything be more important than that?  Just one more
23485 of the mysteries of this world, I guess.)
23486 @end iflatex
23487
23488 @end iftex
23489
23490
23491 @node On Writing Manuals
23492 @section On Writing Manuals
23493
23494 I guess most manuals are written after-the-fact; documenting a program
23495 that's already there.  This is not how this manual is written.  When
23496 implementing something, I write the manual entry for that something
23497 straight away.  I then see that it's difficult to explain the
23498 functionality, so I write how it's supposed to be, and then I change the
23499 implementation.  Writing the documentation and writing the code goes
23500 hand in hand.
23501
23502 This, of course, means that this manual has no, or little, flow.  It
23503 documents absolutely everything in Gnus, but often not where you're
23504 looking for it.  It is a reference manual, and not a guide to how to get
23505 started with Gnus.
23506
23507 That would be a totally different book, that should be written using the
23508 reference manual as source material.  It would look quite differently.
23509
23510
23511 @page
23512 @node Terminology
23513 @section Terminology
23514
23515 @cindex terminology
23516 @table @dfn
23517
23518 @item news
23519 @cindex news
23520 This is what you are supposed to use this thing for---reading news.
23521 News is generally fetched from a nearby @sc{nntp} server, and is
23522 generally publicly available to everybody.  If you post news, the entire
23523 world is likely to read just what you have written, and they'll all
23524 snigger mischievously.  Behind your back.
23525
23526 @item mail
23527 @cindex mail
23528 Everything that's delivered to you personally is mail.  Some news/mail
23529 readers (like Gnus) blur the distinction between mail and news, but
23530 there is a difference.  Mail is private.  News is public.  Mailing is
23531 not posting, and replying is not following up.
23532
23533 @item reply
23534 @cindex reply
23535 Send a mail to the person who has written what you are reading.
23536
23537 @item follow up
23538 @cindex follow up
23539 Post an article to the current newsgroup responding to the article you
23540 are reading.
23541
23542 @item back end
23543 @cindex back end
23544 Gnus considers mail and news to be mostly the same, really.  The only
23545 difference is how to access the actual articles.  News articles are
23546 commonly fetched via the protocol NNTP, whereas mail messages could be
23547 read from a file on the local disk.  The internal architecture of Gnus
23548 thus comprises a `front end' and a number of `back ends'.  Internally,
23549 when you enter a group (by hitting @key{RET}, say), you thereby invoke
23550 a function in the front end in Gnus.  The front end then `talks' to a
23551 back end and says things like ``Give me the list of articles in the foo
23552 group'' or ``Show me article number 4711''.
23553
23554 So a back end mainly defines either a protocol (the @code{nntp} back end
23555 accesses news via NNTP, the @code{nnimap} back end accesses mail via
23556 IMAP) or a file format and directory layout (the @code{nnspool} back end
23557 accesses news via the common `spool directory' format, the @code{nnml}
23558 back end access mail via a file format and directory layout that's
23559 quite similar).
23560
23561 Gnus does not handle the underlying media, so to speak---this is all
23562 done by the back ends.  A back end is a collection of functions to
23563 access the articles.
23564
23565 However, sometimes the term `back end' is also used where `server'
23566 would have been more appropriate.  And then there is the term `select
23567 method' which can mean either.  The Gnus terminology can be quite
23568 confusing.
23569
23570 @item native
23571 @cindex native
23572 Gnus will always use one method (and back end) as the @dfn{native}, or
23573 default, way of getting news.
23574
23575 @item foreign
23576 @cindex foreign
23577 You can also have any number of foreign groups active at the same time.
23578 These are groups that use non-native non-secondary back ends for getting
23579 news.
23580
23581 @item secondary
23582 @cindex secondary
23583 Secondary back ends are somewhere half-way between being native and being
23584 foreign, but they mostly act like they are native.
23585
23586 @item article
23587 @cindex article
23588 A message that has been posted as news.
23589
23590 @item mail message
23591 @cindex mail message
23592 A message that has been mailed.
23593
23594 @item message
23595 @cindex message
23596 A mail message or news article
23597
23598 @item head
23599 @cindex head
23600 The top part of a message, where administrative information (etc.) is
23601 put.
23602
23603 @item body
23604 @cindex body
23605 The rest of an article.  Everything not in the head is in the
23606 body.
23607
23608 @item header
23609 @cindex header
23610 A line from the head of an article.
23611
23612 @item headers
23613 @cindex headers
23614 A collection of such lines, or a collection of heads.  Or even a
23615 collection of @sc{nov} lines.
23616
23617 @item @sc{nov}
23618 @cindex nov
23619 When Gnus enters a group, it asks the back end for the headers of all
23620 unread articles in the group.  Most servers support the News OverView
23621 format, which is more compact and much faster to read and parse than the
23622 normal @sc{head} format.
23623
23624 @item level
23625 @cindex levels
23626 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
23627 that have a lower level are ``more'' subscribed than the groups with a
23628 higher level.  In fact, groups on levels 1-5 are considered
23629 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
23630 are @dfn{killed}.  Commands for listing groups and scanning for new
23631 articles will all use the numeric prefix as @dfn{working level}.
23632
23633 @item killed groups
23634 @cindex killed groups
23635 No information on killed groups is stored or updated, which makes killed
23636 groups much easier to handle than subscribed groups.
23637
23638 @item zombie groups
23639 @cindex zombie groups
23640 Just like killed groups, only slightly less dead.
23641
23642 @item active file
23643 @cindex active file
23644 The news server has to keep track of what articles it carries, and what
23645 groups exist.  All this information in stored in the active file, which
23646 is rather large, as you might surmise.
23647
23648 @item bogus groups
23649 @cindex bogus groups
23650 A group that exists in the @file{.newsrc} file, but isn't known to the
23651 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
23652 This means that the group probably doesn't exist (any more).
23653
23654 @item activating
23655 @cindex activating groups
23656 The act of asking the server for info on a group and computing the
23657 number of unread articles is called @dfn{activating the group}.
23658 Un-activated groups are listed with @samp{*} in the group buffer.
23659
23660 @item server
23661 @cindex server
23662 A machine one can connect to and get news (or mail) from.
23663
23664 @item select method
23665 @cindex select method
23666 A structure that specifies the back end, the server and the virtual
23667 server settings.
23668
23669 @item virtual server
23670 @cindex virtual server
23671 A named select method.  Since a select method defines all there is to
23672 know about connecting to a (physical) server, taking the thing as a
23673 whole is a virtual server.
23674
23675 @item washing
23676 @cindex washing
23677 Taking a buffer and running it through a filter of some sort.  The
23678 result will (more often than not) be cleaner and more pleasing than the
23679 original.
23680
23681 @item ephemeral groups
23682 @cindex ephemeral groups
23683 Most groups store data on what articles you have read.  @dfn{Ephemeral}
23684 groups are groups that will have no data stored---when you exit the
23685 group, it'll disappear into the aether.
23686
23687 @item solid groups
23688 @cindex solid groups
23689 This is the opposite of ephemeral groups.  All groups listed in the
23690 group buffer are solid groups.
23691
23692 @item sparse articles
23693 @cindex sparse articles
23694 These are article placeholders shown in the summary buffer when
23695 @code{gnus-build-sparse-threads} has been switched on.
23696
23697 @item threading
23698 @cindex threading
23699 To put responses to articles directly after the articles they respond
23700 to---in a hierarchical fashion.
23701
23702 @item root
23703 @cindex root
23704 @cindex thread root
23705 The first article in a thread is the root.  It is the ancestor of all
23706 articles in the thread.
23707
23708 @item parent
23709 @cindex parent
23710 An article that has responses.
23711
23712 @item child
23713 @cindex child
23714 An article that responds to a different article---its parent.
23715
23716 @item digest
23717 @cindex digest
23718 A collection of messages in one file.  The most common digest format is
23719 specified by RFC 1153.
23720
23721 @end table
23722
23723
23724 @page
23725 @node Customization
23726 @section Customization
23727 @cindex general customization
23728
23729 All variables are properly documented elsewhere in this manual.  This
23730 section is designed to give general pointers on how to customize Gnus
23731 for some quite common situations.
23732
23733 @menu
23734 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
23735 * Slow Terminal Connection::    You run a remote Emacs.
23736 * Little Disk Space::           You feel that having large setup files is icky.
23737 * Slow Machine::                You feel like buying a faster machine.
23738 @end menu
23739
23740
23741 @node Slow/Expensive Connection
23742 @subsection Slow/Expensive NNTP Connection
23743
23744 If you run Emacs on a machine locally, and get your news from a machine
23745 over some very thin strings, you want to cut down on the amount of data
23746 Gnus has to get from the @sc{nntp} server.
23747
23748 @table @code
23749
23750 @item gnus-read-active-file
23751 Set this to @code{nil}, which will inhibit Gnus from requesting the
23752 entire active file from the server.  This file is often v.  large.  You
23753 also have to set @code{gnus-check-new-newsgroups} and
23754 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
23755 doesn't suddenly decide to fetch the active file anyway.
23756
23757 @item gnus-nov-is-evil
23758 This one has to be @code{nil}.  If not, grabbing article headers from
23759 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
23760 support @sc{xover}; Gnus will detect this by itself.
23761 @end table
23762
23763
23764 @node Slow Terminal Connection
23765 @subsection Slow Terminal Connection
23766
23767 Let's say you use your home computer for dialing up the system that runs
23768 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
23769 possible) the amount of data sent over the wires.
23770
23771 @table @code
23772
23773 @item gnus-auto-center-summary
23774 Set this to @code{nil} to inhibit Gnus from re-centering the summary
23775 buffer all the time.  If it is @code{vertical}, do only vertical
23776 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
23777 horizontal and vertical recentering.
23778
23779 @item gnus-visible-headers
23780 Cut down on the headers included in the articles to the
23781 minimum.  You can, in fact, make do without them altogether---most of the
23782 useful data is in the summary buffer, anyway.  Set this variable to
23783 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
23784
23785 Set this hook to all the available hiding commands:
23786 @lisp
23787 (setq gnus-treat-hide-headers 'head
23788       gnus-treat-hide-signature t
23789       gnus-treat-hide-citation t)
23790 @end lisp
23791
23792 @item gnus-use-full-window
23793 By setting this to @code{nil}, you can make all the windows smaller.
23794 While this doesn't really cut down much generally, it means that you
23795 have to see smaller portions of articles before deciding that you didn't
23796 want to read them anyway.
23797
23798 @item gnus-thread-hide-subtree
23799 If this is non-@code{nil}, all threads in the summary buffer will be
23800 hidden initially.
23801
23802
23803 @item gnus-updated-mode-lines
23804 If this is @code{nil}, Gnus will not put information in the buffer mode
23805 lines, which might save some time.
23806 @end table
23807
23808
23809 @node Little Disk Space
23810 @subsection Little Disk Space
23811 @cindex disk space
23812
23813 The startup files can get rather large, so you may want to cut their
23814 sizes a bit if you are running out of space.
23815
23816 @table @code
23817
23818 @item gnus-save-newsrc-file
23819 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
23820 only save @file{.newsrc.eld}.  This means that you will not be able to
23821 use any other newsreaders than Gnus.  This variable is @code{t} by
23822 default.
23823
23824 @item gnus-read-newsrc-file
23825 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
23826 only read @file{.newsrc.eld}.  This means that you will not be able to
23827 use any other newsreaders than Gnus.  This variable is @code{t} by
23828 default.
23829
23830 @item gnus-save-killed-list
23831 If this is @code{nil}, Gnus will not save the list of dead groups.  You
23832 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
23833 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
23834 variable to @code{nil}.  This variable is @code{t} by default.
23835
23836 @end table
23837
23838
23839 @node Slow Machine
23840 @subsection Slow Machine
23841 @cindex slow machine
23842
23843 If you have a slow machine, or are just really impatient, there are a
23844 few things you can do to make Gnus run faster.
23845
23846 Set @code{gnus-check-new-newsgroups} and
23847 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
23848
23849 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
23850 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
23851 summary buffer faster.
23852
23853
23854 @page
23855 @node Troubleshooting
23856 @section Troubleshooting
23857 @cindex troubleshooting
23858
23859 Gnus works @emph{so} well straight out of the box---I can't imagine any
23860 problems, really.
23861
23862 Ahem.
23863
23864 @enumerate
23865
23866 @item
23867 Make sure your computer is switched on.
23868
23869 @item
23870 Make sure that you really load the current Gnus version.  If you have
23871 been running @sc{gnus}, you need to exit Emacs and start it up again before
23872 Gnus will work.
23873
23874 @item
23875 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
23876 like @samp{T-gnus 6.15.* (based on Oort Gnus v0.*; for SEMI 1.1*, FLIM
23877 1.1*)} you have the right files loaded.  If, on the other hand, you get
23878 something like @samp{NNTP 3.x} or @samp{nntp flee}, you have some old
23879 @file{.el} files lying around.  Delete these.
23880
23881 @item
23882 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
23883 how-to.
23884
23885 @item
23886 @vindex max-lisp-eval-depth
23887 Gnus works on many recursive structures, and in some extreme (and very
23888 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
23889 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
23890 something like that.
23891 @end enumerate
23892
23893 If all else fails, report the problem as a bug.
23894
23895 @cindex bugs
23896 @cindex reporting bugs
23897
23898 @kindex M-x gnus-bug
23899 @findex gnus-bug
23900 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
23901 command.  @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
23902 me the backtrace.  I will fix bugs, but I can only fix them if you send
23903 me a precise description as to how to reproduce the bug.
23904
23905 You really can never be too detailed in a bug report.  Always use the
23906 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
23907 a 10Kb mail each time you use it, and even if you have sent me your
23908 environment 500 times before.  I don't care.  I want the full info each
23909 time.
23910
23911 It is also important to remember that I have no memory whatsoever.  If
23912 you send a bug report, and I send you a reply, and then you just send
23913 back ``No, it's not! Moron!'', I will have no idea what you are
23914 insulting me about.  Always over-explain everything.  It's much easier
23915 for all of us---if I don't have all the information I need, I will just
23916 mail you and ask for more info, and everything takes more time.
23917
23918 If the problem you're seeing is very visual, and you can't quite explain
23919 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
23920 it somewhere it can be reached, and include the URL of the picture in
23921 the bug report.
23922
23923 @cindex patches
23924 If you would like to contribute a patch to fix bugs or make
23925 improvements, please produce the patch using @samp{diff -u}.
23926
23927 @cindex edebug
23928 If you want to debug your problem further before reporting, possibly
23929 in order to solve the problem yourself and send a patch, you can use
23930 edebug.  Debugging lisp code is documented in the Elisp manual
23931 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
23932 Lisp Reference Manual}).  To get you started with edebug, consider if
23933 you discover some weird behaviour when pressing @kbd{c}, the first
23934 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
23935 the documentation buffer that leads you to the function definition,
23936 then press @kbd{M-x edebug-defun RET} with point inside that function,
23937 return to Gnus and press @kbd{c} to invoke the code.  You will be
23938 placed in the lisp buffer and can single step using @kbd{SPC} and
23939 evaluate expressions using @kbd{M-:} or inspect variables using
23940 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
23941 @kbd{c} or @kbd{g}.
23942
23943 @cindex elp
23944 @cindex profile
23945 @cindex slow
23946 Sometimes, a problem do not directly generate a elisp error but
23947 manifests itself by causing Gnus to be very slow.  In these cases, you
23948 can use @kbd{M-x toggle-debug-on-quit} and press C-j when things are
23949 slow, and then try to analyze the backtrace (repeating the procedure
23950 helps isolating the real problem areas).  A fancier approach is to use
23951 the elisp profiler, ELP.  The profiler is (or should be) fully
23952 documented elsewhere, but to get you started there are a few steps
23953 that need to be followed.  First, instrument the part of Gnus you are
23954 interested in for profiling, e.g. @kbd{M-x elp-instrument-package RET
23955 gnus} or @kbd{M-x elp-instrument-packagre RET message}.  Then perform
23956 the operation that is slow and press @kbd{M-x elp-results}.  You will
23957 then see which operations that takes time, and can debug them further.
23958 If the entire operation takes much longer than the time spent in the
23959 slowest function in the profiler output, you probably profiled the
23960 wrong part of Gnus.  To reset profiling statistics, use @kbd{M-x
23961 elp-reset-all}.  @kbd{M-x elp-restore-all} is supposed to remove
23962 profiling, but given the complexities and dynamic code generation in
23963 Gnus, it might not always work perfectly.
23964
23965 If you just need help, you are better off asking on
23966 @samp{gnu.emacs.gnus}.  I'm not very helpful.
23967
23968 @cindex gnu.emacs.gnus
23969 @cindex ding mailing list
23970 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
23971 Write to @samp{ding-request@@gnus.org} to subscribe.
23972
23973
23974 @page
23975 @node Gnus Reference Guide
23976 @section Gnus Reference Guide
23977
23978 It is my hope that other people will figure out smart stuff that Gnus
23979 can do, and that other people will write those smart things as well.  To
23980 facilitate that I thought it would be a good idea to describe the inner
23981 workings of Gnus.  And some of the not-so-inner workings, while I'm at
23982 it.
23983
23984 You can never expect the internals of a program not to change, but I
23985 will be defining (in some details) the interface between Gnus and its
23986 back ends (this is written in stone), the format of the score files
23987 (ditto), data structures (some are less likely to change than others)
23988 and general methods of operation.
23989
23990 @menu
23991 * Gnus Utility Functions::      Common functions and variable to use.
23992 * Back End Interface::          How Gnus communicates with the servers.
23993 * Score File Syntax::           A BNF definition of the score file standard.
23994 * Headers::                     How Gnus stores headers internally.
23995 * Ranges::                      A handy format for storing mucho numbers.
23996 * Group Info::                  The group info format.
23997 * Extended Interactive::        Symbolic prefixes and stuff.
23998 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
23999 * Various File Formats::        Formats of files that Gnus use.
24000 @end menu
24001
24002
24003 @node Gnus Utility Functions
24004 @subsection Gnus Utility Functions
24005 @cindex Gnus utility functions
24006 @cindex utility functions
24007 @cindex functions
24008 @cindex internal variables
24009
24010 When writing small functions to be run from hooks (and stuff), it's
24011 vital to have access to the Gnus internal functions and variables.
24012 Below is a list of the most common ones.
24013
24014 @table @code
24015
24016 @item gnus-newsgroup-name
24017 @vindex gnus-newsgroup-name
24018 This variable holds the name of the current newsgroup.
24019
24020 @item gnus-find-method-for-group
24021 @findex gnus-find-method-for-group
24022 A function that returns the select method for @var{group}.
24023
24024 @item gnus-group-real-name
24025 @findex gnus-group-real-name
24026 Takes a full (prefixed) Gnus group name, and returns the unprefixed
24027 name.
24028
24029 @item gnus-group-prefixed-name
24030 @findex gnus-group-prefixed-name
24031 Takes an unprefixed group name and a select method, and returns the full
24032 (prefixed) Gnus group name.
24033
24034 @item gnus-get-info
24035 @findex gnus-get-info
24036 Returns the group info list for @var{group}.
24037
24038 @item gnus-group-unread
24039 @findex gnus-group-unread
24040 The number of unread articles in @var{group}, or @code{t} if that is
24041 unknown.
24042
24043 @item gnus-active
24044 @findex gnus-active
24045 The active entry for @var{group}.
24046
24047 @item gnus-set-active
24048 @findex gnus-set-active
24049 Set the active entry for @var{group}.
24050
24051 @item gnus-add-current-to-buffer-list
24052 @findex gnus-add-current-to-buffer-list
24053 Adds the current buffer to the list of buffers to be killed on Gnus
24054 exit.
24055
24056 @item gnus-continuum-version
24057 @findex gnus-continuum-version
24058 Takes a Gnus version string as a parameter and returns a floating point
24059 number.  Earlier versions will always get a lower number than later
24060 versions.
24061
24062 @item gnus-group-read-only-p
24063 @findex gnus-group-read-only-p
24064 Says whether @var{group} is read-only or not.
24065
24066 @item gnus-news-group-p
24067 @findex gnus-news-group-p
24068 Says whether @var{group} came from a news back end.
24069
24070 @item gnus-ephemeral-group-p
24071 @findex gnus-ephemeral-group-p
24072 Says whether @var{group} is ephemeral or not.
24073
24074 @item gnus-server-to-method
24075 @findex gnus-server-to-method
24076 Returns the select method corresponding to @var{server}.
24077
24078 @item gnus-server-equal
24079 @findex gnus-server-equal
24080 Says whether two virtual servers are equal.
24081
24082 @item gnus-group-native-p
24083 @findex gnus-group-native-p
24084 Says whether @var{group} is native or not.
24085
24086 @item gnus-group-secondary-p
24087 @findex gnus-group-secondary-p
24088 Says whether @var{group} is secondary or not.
24089
24090 @item gnus-group-foreign-p
24091 @findex gnus-group-foreign-p
24092 Says whether @var{group} is foreign or not.
24093
24094 @item group-group-find-parameter
24095 @findex group-group-find-parameter
24096 Returns the parameter list of @var{group}.  If given a second parameter,
24097 returns the value of that parameter for @var{group}.
24098
24099 @item gnus-group-set-parameter
24100 @findex gnus-group-set-parameter
24101 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
24102
24103 @item gnus-narrow-to-body
24104 @findex gnus-narrow-to-body
24105 Narrows the current buffer to the body of the article.
24106
24107 @item gnus-check-backend-function
24108 @findex gnus-check-backend-function
24109 Takes two parameters, @var{function} and @var{group}.  If the back end
24110 @var{group} comes from supports @var{function}, return non-@code{nil}.
24111
24112 @lisp
24113 (gnus-check-backend-function "request-scan" "nnml:misc")
24114 @result{} t
24115 @end lisp
24116
24117 @item gnus-read-method
24118 @findex gnus-read-method
24119 Prompts the user for a select method.
24120
24121 @end table
24122
24123
24124 @node Back End Interface
24125 @subsection Back End Interface
24126
24127 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
24128 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
24129 server is a @dfn{back end} and some @dfn{back end variables}.  As examples
24130 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
24131 examples of the latter we have @code{nntp-port-number} and
24132 @code{nnmbox-directory}.
24133
24134 When Gnus asks for information from a back end---say @code{nntp}---on
24135 something, it will normally include a virtual server name in the
24136 function parameters.  (If not, the back end should use the ``current''
24137 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
24138 server as its only (optional) parameter.  If this virtual server hasn't
24139 been opened, the function should fail.
24140
24141 Note that a virtual server name has no relation to some physical server
24142 name.  Take this example:
24143
24144 @lisp
24145 (nntp "odd-one"
24146       (nntp-address "ifi.uio.no")
24147       (nntp-port-number 4324))
24148 @end lisp
24149
24150 Here the virtual server name is @samp{odd-one} while the name of
24151 the physical server is @samp{ifi.uio.no}.
24152
24153 The back ends should be able to switch between several virtual servers.
24154 The standard back ends implement this by keeping an alist of virtual
24155 server environments that they pull down/push up when needed.
24156
24157 There are two groups of interface functions: @dfn{required functions},
24158 which must be present, and @dfn{optional functions}, which Gnus will
24159 always check for presence before attempting to call 'em.
24160
24161 All these functions are expected to return data in the buffer
24162 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
24163 unfortunately named, but we'll have to live with it.  When I talk about
24164 @dfn{resulting data}, I always refer to the data in that buffer.  When I
24165 talk about @dfn{return value}, I talk about the function value returned by
24166 the function call.  Functions that fail should return @code{nil} as the
24167 return value.
24168
24169 Some back ends could be said to be @dfn{server-forming} back ends, and
24170 some might be said not to be.  The latter are back ends that generally
24171 only operate on one group at a time, and have no concept of ``server''
24172 -- they have a group, and they deliver info on that group and nothing
24173 more.
24174
24175 Gnus identifies each message by way of group name and article number.  A
24176 few remarks about these article numbers might be useful.  First of all,
24177 the numbers are positive integers.  Secondly, it is normally not
24178 possible for later articles to `re-use' older article numbers without
24179 confusing Gnus.  That is, if a group has ever contained a message
24180 numbered 42, then no other message may get that number, or Gnus will get
24181 mightily confused.@footnote{See the function
24182 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
24183 Third, article numbers must be assigned in order of arrival in the
24184 group; this is not necessarily the same as the date of the message.
24185
24186 The previous paragraph already mentions all the `hard' restrictions that
24187 article numbers must fulfill.  But it seems that it might be useful to
24188 assign @emph{consecutive} article numbers, for Gnus gets quite confused
24189 if there are holes in the article numbering sequence.  However, due to
24190 the `no-reuse' restriction, holes cannot be avoided altogether.  It's
24191 also useful for the article numbers to start at 1 to avoid running out
24192 of numbers as long as possible.
24193
24194 Note that by convention, backends are named @code{nnsomething}, but
24195 Gnus also comes with some @code{nnnotbackends}, such as
24196 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
24197
24198 In the examples and definitions I will refer to the imaginary back end
24199 @code{nnchoke}.
24200
24201 @cindex @code{nnchoke}
24202
24203 @menu
24204 * Required Back End Functions::  Functions that must be implemented.
24205 * Optional Back End Functions::  Functions that need not be implemented.
24206 * Error Messaging::             How to get messages and report errors.
24207 * Writing New Back Ends::       Extending old back ends.
24208 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
24209 * Mail-like Back Ends::         Some tips on mail back ends.
24210 @end menu
24211
24212
24213 @node Required Back End Functions
24214 @subsubsection Required Back End Functions
24215
24216 @table @code
24217
24218 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
24219
24220 @var{articles} is either a range of article numbers or a list of
24221 @code{Message-ID}s.  Current back ends do not fully support either---only
24222 sequences (lists) of article numbers, and most back ends do not support
24223 retrieval of @code{Message-ID}s.  But they should try for both.
24224
24225 The result data should either be HEADs or @sc{nov} lines, and the result
24226 value should either be @code{headers} or @code{nov} to reflect this.
24227 This might later be expanded to @code{various}, which will be a mixture
24228 of HEADs and @sc{nov} lines, but this is currently not supported by Gnus.
24229
24230 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
24231 headers", in some meaning of the word.  This is generally done by
24232 fetching (at most) @var{fetch-old} extra headers less than the smallest
24233 article number in @code{articles}, and filling the gaps as well.  The
24234 presence of this parameter can be ignored if the back end finds it
24235 cumbersome to follow the request.  If this is non-@code{nil} and not a
24236 number, do maximum fetches.
24237
24238 Here's an example HEAD:
24239
24240 @example
24241 221 1056 Article retrieved.
24242 Path: ifi.uio.no!sturles
24243 From: sturles@@ifi.uio.no (Sturle Sunde)
24244 Newsgroups: ifi.discussion
24245 Subject: Re: Something very droll
24246 Date: 27 Oct 1994 14:02:57 +0100
24247 Organization: Dept. of Informatics, University of Oslo, Norway
24248 Lines: 26
24249 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
24250 References: <38jdmq$4qu@@visbur.ifi.uio.no>
24251 NNTP-Posting-Host: holmenkollen.ifi.uio.no
24252 .
24253 @end example
24254
24255 So a @code{headers} return value would imply that there's a number of
24256 these in the data buffer.
24257
24258 Here's a BNF definition of such a buffer:
24259
24260 @example
24261 headers        = *head
24262 head           = error / valid-head
24263 error-message  = [ "4" / "5" ] 2number " " <error message> eol
24264 valid-head     = valid-message *header "." eol
24265 valid-message  = "221 " <number> " Article retrieved." eol
24266 header         = <text> eol
24267 @end example
24268
24269 If the return value is @code{nov}, the data buffer should contain
24270 @dfn{network overview database} lines.  These are basically fields
24271 separated by tabs.
24272
24273 @example
24274 nov-buffer = *nov-line
24275 nov-line   = 8*9 [ field <TAB> ] eol
24276 field      = <text except TAB>
24277 @end example
24278
24279 For a closer look at what should be in those fields,
24280 @pxref{Headers}.
24281
24282
24283 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
24284
24285 @var{server} is here the virtual server name.  @var{definitions} is a
24286 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
24287
24288 If the server can't be opened, no error should be signaled.  The back end
24289 may then choose to refuse further attempts at connecting to this
24290 server.  In fact, it should do so.
24291
24292 If the server is opened already, this function should return a
24293 non-@code{nil} value.  There should be no data returned.
24294
24295
24296 @item (nnchoke-close-server &optional SERVER)
24297
24298 Close connection to @var{server} and free all resources connected
24299 to it.  Return @code{nil} if the server couldn't be closed for some
24300 reason.
24301
24302 There should be no data returned.
24303
24304
24305 @item (nnchoke-request-close)
24306
24307 Close connection to all servers and free all resources that the back end
24308 have reserved.  All buffers that have been created by that back end
24309 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
24310 function is generally only called when Gnus is shutting down.
24311
24312 There should be no data returned.
24313
24314
24315 @item (nnchoke-server-opened &optional SERVER)
24316
24317 If @var{server} is the current virtual server, and the connection to the
24318 physical server is alive, then this function should return a
24319 non-@code{nil} vlue.  This function should under no circumstances
24320 attempt to reconnect to a server we have lost connection to.
24321
24322 There should be no data returned.
24323
24324
24325 @item (nnchoke-status-message &optional SERVER)
24326
24327 This function should return the last error message from @var{server}.
24328
24329 There should be no data returned.
24330
24331
24332 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
24333
24334 The result data from this function should be the article specified by
24335 @var{article}.  This might either be a @code{Message-ID} or a number.
24336 It is optional whether to implement retrieval by @code{Message-ID}, but
24337 it would be nice if that were possible.
24338
24339 If @var{to-buffer} is non-@code{nil}, the result data should be returned
24340 in this buffer instead of the normal data buffer.  This is to make it
24341 possible to avoid copying large amounts of data from one buffer to
24342 another, while Gnus mainly requests articles to be inserted directly
24343 into its article buffer.
24344
24345 If it is at all possible, this function should return a cons cell where
24346 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
24347 the article number.  This will enable Gnus to find out what the real
24348 group and article numbers are when fetching articles by
24349 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
24350 on successful article retrieval.
24351
24352
24353 @item (nnchoke-request-group GROUP &optional SERVER FAST)
24354
24355 Get data on @var{group}.  This function also has the side effect of
24356 making @var{group} the current group.
24357
24358 If @var{fast}, don't bother to return useful data, just make @var{group}
24359 the current group.
24360
24361 Here's an example of some result data and a definition of the same:
24362
24363 @example
24364 211 56 1000 1059 ifi.discussion
24365 @end example
24366
24367 The first number is the status, which should be 211.  Next is the
24368 total number of articles in the group, the lowest article number, the
24369 highest article number, and finally the group name.  Note that the total
24370 number of articles may be less than one might think while just
24371 considering the highest and lowest article numbers, but some articles
24372 may have been canceled.  Gnus just discards the total-number, so
24373 whether one should take the bother to generate it properly (if that is a
24374 problem) is left as an exercise to the reader.  If the group contains no
24375 articles, the lowest article number should be reported as 1 and the
24376 highest as 0.
24377
24378 @example
24379 group-status = [ error / info ] eol
24380 error        = [ "4" / "5" ] 2<number> " " <Error message>
24381 info         = "211 " 3* [ <number> " " ] <string>
24382 @end example
24383
24384
24385 @item (nnchoke-close-group GROUP &optional SERVER)
24386
24387 Close @var{group} and free any resources connected to it.  This will be
24388 a no-op on most back ends.
24389
24390 There should be no data returned.
24391
24392
24393 @item (nnchoke-request-list &optional SERVER)
24394
24395 Return a list of all groups available on @var{server}.  And that means
24396 @emph{all}.
24397
24398 Here's an example from a server that only carries two groups:
24399
24400 @example
24401 ifi.test 0000002200 0000002000 y
24402 ifi.discussion 3324 3300 n
24403 @end example
24404
24405 On each line we have a group name, then the highest article number in
24406 that group, the lowest article number, and finally a flag.  If the group
24407 contains no articles, the lowest article number should be reported as 1
24408 and the highest as 0.
24409
24410 @example
24411 active-file = *active-line
24412 active-line = name " " <number> " " <number> " " flags eol
24413 name        = <string>
24414 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
24415 @end example
24416
24417 The flag says whether the group is read-only (@samp{n}), is moderated
24418 (@samp{m}), is dead (@samp{x}), is aliased to some other group
24419 (@samp{=other-group}) or none of the above (@samp{y}).
24420
24421
24422 @item (nnchoke-request-post &optional SERVER)
24423
24424 This function should post the current buffer.  It might return whether
24425 the posting was successful or not, but that's not required.  If, for
24426 instance, the posting is done asynchronously, it has generally not been
24427 completed by the time this function concludes.  In that case, this
24428 function should set up some kind of sentinel to beep the user loud and
24429 clear if the posting could not be completed.
24430
24431 There should be no result data from this function.
24432
24433 @end table
24434
24435
24436 @node Optional Back End Functions
24437 @subsubsection Optional Back End Functions
24438
24439 @table @code
24440
24441 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
24442
24443 @var{groups} is a list of groups, and this function should request data
24444 on all those groups.  How it does it is of no concern to Gnus, but it
24445 should attempt to do this in a speedy fashion.
24446
24447 The return value of this function can be either @code{active} or
24448 @code{group}, which says what the format of the result data is.  The
24449 former is in the same format as the data from
24450 @code{nnchoke-request-list}, while the latter is a buffer full of lines
24451 in the same format as @code{nnchoke-request-group} gives.
24452
24453 @example
24454 group-buffer = *active-line / *group-status
24455 @end example
24456
24457
24458 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
24459
24460 A Gnus group info (@pxref{Group Info}) is handed to the back end for
24461 alterations.  This comes in handy if the back end really carries all the
24462 information (as is the case with virtual and imap groups).  This
24463 function should destructively alter the info to suit its needs, and
24464 should return a non-nil value.
24465
24466 There should be no result data from this function.
24467
24468
24469 @item (nnchoke-request-type GROUP &optional ARTICLE)
24470
24471 When the user issues commands for ``sending news'' (@kbd{F} in the
24472 summary buffer, for instance), Gnus has to know whether the article the
24473 user is following up on is news or mail.  This function should return
24474 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
24475 is mail and @code{unknown} if the type can't be decided.  (The
24476 @var{article} parameter is necessary in @code{nnvirtual} groups which
24477 might very well combine mail groups and news groups.)  Both @var{group}
24478 and @var{article} may be @code{nil}.
24479
24480 There should be no result data from this function.
24481
24482
24483 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
24484
24485 Set/remove/add marks on articles.  Normally Gnus handles the article
24486 marks (such as read, ticked, expired etc) internally, and store them in
24487 @code{~/.newsrc.eld}.  Some back ends (such as @sc{imap}) however carry
24488 all information about the articles on the server, so Gnus need to
24489 propagate the mark information to the server.
24490
24491 ACTION is a list of mark setting requests, having this format:
24492
24493 @example
24494 (RANGE ACTION MARK)
24495 @end example
24496
24497 RANGE is a range of articles you wish to update marks on.  ACTION is
24498 @code{add} or @code{del}, used to add marks or remove marks
24499 (preserving all marks not mentioned).  MARK is a list of marks; where
24500 each mark is a symbol.  Currently used marks are @code{read},
24501 @code{tick}, @code{reply}, @code{expire}, @code{killed},
24502 @code{dormant}, @code{save}, @code{download}, @code{unsend},
24503 @code{forward} and @code{recent}, but your back end should, if
24504 possible, not limit itself to these.
24505
24506 Given contradictory actions, the last action in the list should be the
24507 effective one.  That is, if your action contains a request to add the
24508 @code{tick} mark on article 1 and, later in the list, a request to
24509 remove the mark on the same article, the mark should in fact be removed.
24510
24511 An example action list:
24512
24513 @example
24514 (((5 12 30) 'del '(tick))
24515  ((10 . 90) 'add '(read expire))
24516  ((92 94) 'del '(read)))
24517 @end example
24518
24519 The function should return a range of articles it wasn't able to set the
24520 mark on (currently not used for anything).
24521
24522 There should be no result data from this function.
24523
24524 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
24525
24526 If the user tries to set a mark that the back end doesn't like, this
24527 function may change the mark.  Gnus will use whatever this function
24528 returns as the mark for @var{article} instead of the original
24529 @var{mark}.  If the back end doesn't care, it must return the original
24530 @var{mark}, and not @code{nil} or any other type of garbage.
24531
24532 The only use for this I can see is what @code{nnvirtual} does with
24533 it---if a component group is auto-expirable, marking an article as read
24534 in the virtual group should result in the article being marked as
24535 expirable.
24536
24537 There should be no result data from this function.
24538
24539
24540 @item (nnchoke-request-scan &optional GROUP SERVER)
24541
24542 This function may be called at any time (by Gnus or anything else) to
24543 request that the back end check for incoming articles, in one way or
24544 another.  A mail back end will typically read the spool file or query the
24545 POP server when this function is invoked.  The @var{group} doesn't have
24546 to be heeded---if the back end decides that it is too much work just
24547 scanning for a single group, it may do a total scan of all groups.  It
24548 would be nice, however, to keep things local if that's practical.
24549
24550 There should be no result data from this function.
24551
24552
24553 @item (nnchoke-request-group-description GROUP &optional SERVER)
24554
24555 The result data from this function should be a description of
24556 @var{group}.
24557
24558 @example
24559 description-line = name <TAB> description eol
24560 name             = <string>
24561 description      = <text>
24562 @end example
24563
24564 @item (nnchoke-request-list-newsgroups &optional SERVER)
24565
24566 The result data from this function should be the description of all
24567 groups available on the server.
24568
24569 @example
24570 description-buffer = *description-line
24571 @end example
24572
24573
24574 @item (nnchoke-request-newgroups DATE &optional SERVER)
24575
24576 The result data from this function should be all groups that were
24577 created after @samp{date}, which is in normal human-readable date format
24578 (i.e., the date format used in mail and news headers, and returned by
24579 the function @code{message-make-date} by default).  The data should be
24580 in the active buffer format.
24581
24582 It is okay for this function to return `too many' groups; some back ends
24583 might find it cheaper to return the full list of groups, rather than
24584 just the new groups.  But don't do this for back ends with many groups.
24585 Normally, if the user creates the groups herself, there won't be too
24586 many groups, so @code{nnml} and the like are probably safe.  But for
24587 back ends like @code{nntp}, where the groups have been created by the
24588 server, it is quite likely that there can be many groups.
24589
24590
24591 @item (nnchoke-request-create-group GROUP &optional SERVER)
24592
24593 This function should create an empty group with name @var{group}.
24594
24595 There should be no return data.
24596
24597
24598 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
24599
24600 This function should run the expiry process on all articles in the
24601 @var{articles} range (which is currently a simple list of article
24602 numbers.)  It is left up to the back end to decide how old articles
24603 should be before they are removed by this function.  If @var{force} is
24604 non-@code{nil}, all @var{articles} should be deleted, no matter how new
24605 they are.
24606
24607 This function should return a list of articles that it did not/was not
24608 able to delete.
24609
24610 There should be no result data returned.
24611
24612
24613 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
24614 &optional LAST)
24615
24616 This function should move @var{article} (which is a number) from
24617 @var{group} by calling @var{accept-form}.
24618
24619 This function should ready the article in question for moving by
24620 removing any header lines it has added to the article, and generally
24621 should ``tidy up'' the article.  Then it should @code{eval}
24622 @var{accept-form} in the buffer where the ``tidy'' article is.  This
24623 will do the actual copying.  If this @code{eval} returns a
24624 non-@code{nil} value, the article should be removed.
24625
24626 If @var{last} is @code{nil}, that means that there is a high likelihood
24627 that there will be more requests issued shortly, so that allows some
24628 optimizations.
24629
24630 The function should return a cons where the @code{car} is the group name and
24631 the @code{cdr} is the article number that the article was entered as.
24632
24633 There should be no data returned.
24634
24635
24636 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
24637
24638 This function takes the current buffer and inserts it into @var{group}.
24639 If @var{last} in @code{nil}, that means that there will be more calls to
24640 this function in short order.
24641
24642 The function should return a cons where the @code{car} is the group name and
24643 the @code{cdr} is the article number that the article was entered as.
24644
24645 There should be no data returned.
24646
24647
24648 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
24649
24650 This function should remove @var{article} (which is a number) from
24651 @var{group} and insert @var{buffer} there instead.
24652
24653 There should be no data returned.
24654
24655
24656 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
24657
24658 This function should delete @var{group}.  If @var{force}, it should
24659 really delete all the articles in the group, and then delete the group
24660 itself.  (If there is such a thing as ``the group itself''.)
24661
24662 There should be no data returned.
24663
24664
24665 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
24666
24667 This function should rename @var{group} into @var{new-name}.  All
24668 articles in @var{group} should move to @var{new-name}.
24669
24670 There should be no data returned.
24671
24672 @end table
24673
24674
24675 @node Error Messaging
24676 @subsubsection Error Messaging
24677
24678 @findex nnheader-report
24679 @findex nnheader-get-report
24680 The back ends should use the function @code{nnheader-report} to report
24681 error conditions---they should not raise errors when they aren't able to
24682 perform a request.  The first argument to this function is the back end
24683 symbol, and the rest are interpreted as arguments to @code{format} if
24684 there are multiple of them, or just a string if there is one of them.
24685 This function must always returns @code{nil}.
24686
24687 @lisp
24688 (nnheader-report 'nnchoke "You did something totally bogus")
24689
24690 (nnheader-report 'nnchoke "Could not request group %s" group)
24691 @end lisp
24692
24693 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
24694 @code{nil} back from a server, and this function returns the most
24695 recently reported message for the back end in question.  This function
24696 takes one argument---the server symbol.
24697
24698 Internally, these functions access @var{back-end}@code{-status-string},
24699 so the @code{nnchoke} back end will have its error message stored in
24700 @code{nnchoke-status-string}.
24701
24702
24703 @node Writing New Back Ends
24704 @subsubsection Writing New Back Ends
24705
24706 Many back ends are quite similar.  @code{nnml} is just like
24707 @code{nnspool}, but it allows you to edit the articles on the server.
24708 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
24709 and it doesn't maintain overview databases.  @code{nndir} is just like
24710 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
24711 editing articles.
24712
24713 It would make sense if it were possible to ``inherit'' functions from
24714 back ends when writing new back ends.  And, indeed, you can do that if you
24715 want to.  (You don't have to if you don't want to, of course.)
24716
24717 All the back ends declare their public variables and functions by using a
24718 package called @code{nnoo}.
24719
24720 To inherit functions from other back ends (and allow other back ends to
24721 inherit functions from the current back end), you should use the
24722 following macros:
24723
24724 @table @code
24725
24726 @item nnoo-declare
24727 This macro declares the first parameter to be a child of the subsequent
24728 parameters.  For instance:
24729
24730 @lisp
24731 (nnoo-declare nndir
24732   nnml nnmh)
24733 @end lisp
24734
24735 @code{nndir} has declared here that it intends to inherit functions from
24736 both @code{nnml} and @code{nnmh}.
24737
24738 @item defvoo
24739 This macro is equivalent to @code{defvar}, but registers the variable as
24740 a public server variable.  Most state-oriented variables should be
24741 declared with @code{defvoo} instead of @code{defvar}.
24742
24743 In addition to the normal @code{defvar} parameters, it takes a list of
24744 variables in the parent back ends to map the variable to when executing
24745 a function in those back ends.
24746
24747 @lisp
24748 (defvoo nndir-directory nil
24749   "Where nndir will look for groups."
24750   nnml-current-directory nnmh-current-directory)
24751 @end lisp
24752
24753 This means that @code{nnml-current-directory} will be set to
24754 @code{nndir-directory} when an @code{nnml} function is called on behalf
24755 of @code{nndir}.  (The same with @code{nnmh}.)
24756
24757 @item nnoo-define-basics
24758 This macro defines some common functions that almost all back ends should
24759 have.
24760
24761 @example
24762 (nnoo-define-basics nndir)
24763 @end example
24764
24765 @item deffoo
24766 This macro is just like @code{defun} and takes the same parameters.  In
24767 addition to doing the normal @code{defun} things, it registers the
24768 function as being public so that other back ends can inherit it.
24769
24770 @item nnoo-map-functions
24771 This macro allows mapping of functions from the current back end to
24772 functions from the parent back ends.
24773
24774 @example
24775 (nnoo-map-functions nndir
24776   (nnml-retrieve-headers 0 nndir-current-group 0 0)
24777   (nnmh-request-article 0 nndir-current-group 0 0))
24778 @end example
24779
24780 This means that when @code{nndir-retrieve-headers} is called, the first,
24781 third, and fourth parameters will be passed on to
24782 @code{nnml-retrieve-headers}, while the second parameter is set to the
24783 value of @code{nndir-current-group}.
24784
24785 @item nnoo-import
24786 This macro allows importing functions from back ends.  It should be the
24787 last thing in the source file, since it will only define functions that
24788 haven't already been defined.
24789
24790 @example
24791 (nnoo-import nndir
24792   (nnmh
24793    nnmh-request-list
24794    nnmh-request-newgroups)
24795   (nnml))
24796 @end example
24797
24798 This means that calls to @code{nndir-request-list} should just be passed
24799 on to @code{nnmh-request-list}, while all public functions from
24800 @code{nnml} that haven't been defined in @code{nndir} yet should be
24801 defined now.
24802
24803 @end table
24804
24805 Below is a slightly shortened version of the @code{nndir} back end.
24806
24807 @lisp
24808 ;;; nndir.el --- single directory newsgroup access for Gnus
24809 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
24810
24811 ;;; Code:
24812
24813 (require 'nnheader)
24814 (require 'nnmh)
24815 (require 'nnml)
24816 (require 'nnoo)
24817 (eval-when-compile (require 'cl))
24818
24819 (nnoo-declare nndir
24820   nnml nnmh)
24821
24822 (defvoo nndir-directory nil
24823   "Where nndir will look for groups."
24824   nnml-current-directory nnmh-current-directory)
24825
24826 (defvoo nndir-nov-is-evil nil
24827   "*Non-nil means that nndir will never retrieve NOV headers."
24828   nnml-nov-is-evil)
24829
24830 (defvoo nndir-current-group ""
24831   nil
24832   nnml-current-group nnmh-current-group)
24833 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
24834 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
24835
24836 (defvoo nndir-status-string "" nil nnmh-status-string)
24837 (defconst nndir-version "nndir 1.0")
24838
24839 ;;; Interface functions.
24840
24841 (nnoo-define-basics nndir)
24842
24843 (deffoo nndir-open-server (server &optional defs)
24844   (setq nndir-directory
24845         (or (cadr (assq 'nndir-directory defs))
24846             server))
24847   (unless (assq 'nndir-directory defs)
24848     (push `(nndir-directory ,server) defs))
24849   (push `(nndir-current-group
24850           ,(file-name-nondirectory
24851             (directory-file-name nndir-directory)))
24852         defs)
24853   (push `(nndir-top-directory
24854           ,(file-name-directory (directory-file-name nndir-directory)))
24855         defs)
24856   (nnoo-change-server 'nndir server defs))
24857
24858 (nnoo-map-functions nndir
24859   (nnml-retrieve-headers 0 nndir-current-group 0 0)
24860   (nnmh-request-article 0 nndir-current-group 0 0)
24861   (nnmh-request-group nndir-current-group 0 0)
24862   (nnmh-close-group nndir-current-group 0))
24863
24864 (nnoo-import nndir
24865   (nnmh
24866    nnmh-status-message
24867    nnmh-request-list
24868    nnmh-request-newgroups))
24869
24870 (provide 'nndir)
24871 @end lisp
24872
24873
24874 @node Hooking New Back Ends Into Gnus
24875 @subsubsection Hooking New Back Ends Into Gnus
24876
24877 @vindex gnus-valid-select-methods
24878 @findex gnus-declare-backend
24879 Having Gnus start using your new back end is rather easy---you just
24880 declare it with the @code{gnus-declare-backend} functions.  This will
24881 enter the back end into the @code{gnus-valid-select-methods} variable.
24882
24883 @code{gnus-declare-backend} takes two parameters---the back end name and
24884 an arbitrary number of @dfn{abilities}.
24885
24886 Here's an example:
24887
24888 @lisp
24889 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
24890 @end lisp
24891
24892 The above line would then go in the @file{nnchoke.el} file.
24893
24894 The abilities can be:
24895
24896 @table @code
24897 @item mail
24898 This is a mailish back end---followups should (probably) go via mail.
24899 @item post
24900 This is a newsish back end---followups should (probably) go via news.
24901 @item post-mail
24902 This back end supports both mail and news.
24903 @item none
24904 This is neither a post nor mail back end---it's something completely
24905 different.
24906 @item respool
24907 It supports respooling---or rather, it is able to modify its source
24908 articles and groups.
24909 @item address
24910 The name of the server should be in the virtual server name.  This is
24911 true for almost all back ends.
24912 @item prompt-address
24913 The user should be prompted for an address when doing commands like
24914 @kbd{B} in the group buffer.  This is true for back ends like
24915 @code{nntp}, but not @code{nnmbox}, for instance.
24916 @end table
24917
24918
24919 @node Mail-like Back Ends
24920 @subsubsection Mail-like Back Ends
24921
24922 One of the things that separate the mail back ends from the rest of the
24923 back ends is the heavy dependence by most of the mail back ends on
24924 common functions in @file{nnmail.el}.  For instance, here's the
24925 definition of @code{nnml-request-scan}:
24926
24927 @lisp
24928 (deffoo nnml-request-scan (&optional group server)
24929   (setq nnml-article-file-alist nil)
24930   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
24931 @end lisp
24932
24933 It simply calls @code{nnmail-get-new-mail} with a few parameters,
24934 and @code{nnmail} takes care of all the moving and splitting of the
24935 mail.
24936
24937 This function takes four parameters.
24938
24939 @table @var
24940 @item method
24941 This should be a symbol to designate which back end is responsible for
24942 the call.
24943
24944 @item exit-function
24945 This function should be called after the splitting has been performed.
24946
24947 @item temp-directory
24948 Where the temporary files should be stored.
24949
24950 @item group
24951 This optional argument should be a group name if the splitting is to be
24952 performed for one group only.
24953 @end table
24954
24955 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
24956 save each article.  @var{back-end}@code{-active-number} will be called to
24957 find the article number assigned to this article.
24958
24959 The function also uses the following variables:
24960 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
24961 this back end); and @var{back-end}@code{-group-alist} and
24962 @var{back-end}@code{-active-file} to generate the new active file.
24963 @var{back-end}@code{-group-alist} should be a group-active alist, like
24964 this:
24965
24966 @example
24967 (("a-group" (1 . 10))
24968  ("some-group" (34 . 39)))
24969 @end example
24970
24971
24972 @node Score File Syntax
24973 @subsection Score File Syntax
24974
24975 Score files are meant to be easily parseable, but yet extremely
24976 mallable.   It was decided that something that had the same read syntax
24977 as an Emacs Lisp list would fit that spec.
24978
24979 Here's a typical score file:
24980
24981 @lisp
24982 (("summary"
24983   ("win95" -10000 nil s)
24984   ("Gnus"))
24985  ("from"
24986   ("Lars" -1000))
24987  (mark -100))
24988 @end lisp
24989
24990 BNF definition of a score file:
24991
24992 @example
24993 score-file      = "" / "(" *element ")"
24994 element         = rule / atom
24995 rule            = string-rule / number-rule / date-rule
24996 string-rule     = "(" quote string-header quote space *string-match ")"
24997 number-rule     = "(" quote number-header quote space *number-match ")"
24998 date-rule       = "(" quote date-header quote space *date-match ")"
24999 quote           = <ascii 34>
25000 string-header   = "subject" / "from" / "references" / "message-id" /
25001                   "xref" / "body" / "head" / "all" / "followup"
25002 number-header   = "lines" / "chars"
25003 date-header     = "date"
25004 string-match    = "(" quote <string> quote [ "" / [ space score [ "" /
25005                   space date [ "" / [ space string-match-t ] ] ] ] ] ")"
25006 score           = "nil" / <integer>
25007 date            = "nil" / <natural number>
25008 string-match-t  = "nil" / "s" / "substring" / "S" / "Substring" /
25009                   "r" / "regex" / "R" / "Regex" /
25010                   "e" / "exact" / "E" / "Exact" /
25011                   "f" / "fuzzy" / "F" / "Fuzzy"
25012 number-match    = "(" <integer> [ "" / [ space score [ "" /
25013                   space date [ "" / [ space number-match-t ] ] ] ] ] ")"
25014 number-match-t  = "nil" / "=" / "<" / ">" / ">=" / "<="
25015 date-match      = "(" quote <string> quote [ "" / [ space score [ "" /
25016                   space date [ "" / [ space date-match-t ] ] ] ] ")"
25017 date-match-t    = "nil" / "at" / "before" / "after"
25018 atom            = "(" [ required-atom / optional-atom ] ")"
25019 required-atom   = mark / expunge / mark-and-expunge / files /
25020                   exclude-files / read-only / touched
25021 optional-atom   = adapt / local / eval
25022 mark            = "mark" space nil-or-number
25023 nil-or-number   = "nil" / <integer>
25024 expunge         = "expunge" space nil-or-number
25025 mark-and-expunge = "mark-and-expunge" space nil-or-number
25026 files           = "files" *[ space <string> ]
25027 exclude-files   = "exclude-files" *[ space <string> ]
25028 read-only       = "read-only" [ space "nil" / space "t" ]
25029 adapt        = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
25030 adapt-rule      = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
25031 local           = "local" *[ space "(" <string> space <form> ")" ]
25032 eval            = "eval" space <form>
25033 space           = *[ " " / <TAB> / <NEWLINE> ]
25034 @end example
25035
25036 Any unrecognized elements in a score file should be ignored, but not
25037 discarded.
25038
25039 As you can see, white space is needed, but the type and amount of white
25040 space is irrelevant.  This means that formatting of the score file is
25041 left up to the programmer---if it's simpler to just spew it all out on
25042 one looong line, then that's ok.
25043
25044 The meaning of the various atoms are explained elsewhere in this
25045 manual (@pxref{Score File Format}).
25046
25047
25048 @node Headers
25049 @subsection Headers
25050
25051 Internally Gnus uses a format for storing article headers that
25052 corresponds to the @sc{nov} format in a mysterious fashion.  One could
25053 almost suspect that the author looked at the @sc{nov} specification and
25054 just shamelessly @emph{stole} the entire thing, and one would be right.
25055
25056 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
25057 RFC 1036 to talk about lines in the head of an article (e.g.,
25058 @code{From}).  It is used by many people as a synonym for
25059 ``head''---``the header and the body''.  (That should be avoided, in my
25060 opinion.)  And Gnus uses a format internally that it calls ``header'',
25061 which is what I'm talking about here.  This is a 9-element vector,
25062 basically, with each header (ouch) having one slot.
25063
25064 These slots are, in order: @code{number}, @code{subject}, @code{from},
25065 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
25066 @code{xref}, and @code{extra}.  There are macros for accessing and
25067 setting these slots---they all have predictable names beginning with
25068 @code{mail-header-} and @code{mail-header-set-}, respectively.
25069
25070 All these slots contain strings, except the @code{extra} slot, which
25071 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
25072
25073
25074 @node Ranges
25075 @subsection Ranges
25076
25077 @sc{gnus} introduced a concept that I found so useful that I've started
25078 using it a lot and have elaborated on it greatly.
25079
25080 The question is simple: If you have a large amount of objects that are
25081 identified by numbers (say, articles, to take a @emph{wild} example)
25082 that you want to qualify as being ``included'', a normal sequence isn't
25083 very useful.  (A 200,000 length sequence is a bit long-winded.)
25084
25085 The solution is as simple as the question: You just collapse the
25086 sequence.
25087
25088 @example
25089 (1 2 3 4 5 6 10 11 12)
25090 @end example
25091
25092 is transformed into
25093
25094 @example
25095 ((1 . 6) (10 . 12))
25096 @end example
25097
25098 To avoid having those nasty @samp{(13 . 13)} elements to denote a
25099 lonesome object, a @samp{13} is a valid element:
25100
25101 @example
25102 ((1 . 6) 7 (10 . 12))
25103 @end example
25104
25105 This means that comparing two ranges to find out whether they are equal
25106 is slightly tricky:
25107
25108 @example
25109 ((1 . 5) 7 8 (10 . 12))
25110 @end example
25111
25112 and
25113
25114 @example
25115 ((1 . 5) (7 . 8) (10 . 12))
25116 @end example
25117
25118 are equal.  In fact, any non-descending list is a range:
25119
25120 @example
25121 (1 2 3 4 5)
25122 @end example
25123
25124 is a perfectly valid range, although a pretty long-winded one.  This is
25125 also valid:
25126
25127 @example
25128 (1 . 5)
25129 @end example
25130
25131 and is equal to the previous range.
25132
25133 Here's a BNF definition of ranges.  Of course, one must remember the
25134 semantic requirement that the numbers are non-descending.  (Any number
25135 of repetition of the same number is allowed, but apt to disappear in
25136 range handling.)
25137
25138 @example
25139 range           = simple-range / normal-range
25140 simple-range    = "(" number " . " number ")"
25141 normal-range    = "(" start-contents ")"
25142 contents        = "" / simple-range *[ " " contents ] /
25143                   number *[ " " contents ]
25144 @end example
25145
25146 Gnus currently uses ranges to keep track of read articles and article
25147 marks.  I plan on implementing a number of range operators in C if The
25148 Powers That Be are willing to let me.  (I haven't asked yet, because I
25149 need to do some more thinking on what operators I need to make life
25150 totally range-based without ever having to convert back to normal
25151 sequences.)
25152
25153
25154 @node Group Info
25155 @subsection Group Info
25156
25157 Gnus stores all permanent info on groups in a @dfn{group info} list.
25158 This list is from three to six elements (or more) long and exhaustively
25159 describes the group.
25160
25161 Here are two example group infos; one is a very simple group while the
25162 second is a more complex one:
25163
25164 @example
25165 ("no.group" 5 ((1 . 54324)))
25166
25167 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
25168                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
25169                 (nnml "")
25170                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
25171 @end example
25172
25173 The first element is the @dfn{group name}---as Gnus knows the group,
25174 anyway.  The second element is the @dfn{subscription level}, which
25175 normally is a small integer.  (It can also be the @dfn{rank}, which is a
25176 cons cell where the @code{car} is the level and the @code{cdr} is the
25177 score.)  The third element is a list of ranges of read articles.  The
25178 fourth element is a list of lists of article marks of various kinds.
25179 The fifth element is the select method (or virtual server, if you like).
25180 The sixth element is a list of @dfn{group parameters}, which is what
25181 this section is about.
25182
25183 Any of the last three elements may be missing if they are not required.
25184 In fact, the vast majority of groups will normally only have the first
25185 three elements, which saves quite a lot of cons cells.
25186
25187 Here's a BNF definition of the group info format:
25188
25189 @example
25190 info          = "(" group space ralevel space read
25191                 [ "" / [ space marks-list [ "" / [ space method [ "" /
25192                 space parameters ] ] ] ] ] ")"
25193 group         = quote <string> quote
25194 ralevel       = rank / level
25195 level         = <integer in the range of 1 to inf>
25196 rank          = "(" level "." score ")"
25197 score         = <integer in the range of 1 to inf>
25198 read          = range
25199 marks-lists   = nil / "(" *marks ")"
25200 marks         = "(" <string> range ")"
25201 method        = "(" <string> *elisp-forms ")"
25202 parameters    = "(" *elisp-forms ")"
25203 @end example
25204
25205 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
25206 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
25207 in pseudo-BNF.
25208
25209 If you have a Gnus info and want to access the elements, Gnus offers a
25210 series of macros for getting/setting these elements.
25211
25212 @table @code
25213 @item gnus-info-group
25214 @itemx gnus-info-set-group
25215 @findex gnus-info-group
25216 @findex gnus-info-set-group
25217 Get/set the group name.
25218
25219 @item gnus-info-rank
25220 @itemx gnus-info-set-rank
25221 @findex gnus-info-rank
25222 @findex gnus-info-set-rank
25223 Get/set the group rank (@pxref{Group Score}).
25224
25225 @item gnus-info-level
25226 @itemx gnus-info-set-level
25227 @findex gnus-info-level
25228 @findex gnus-info-set-level
25229 Get/set the group level.
25230
25231 @item gnus-info-score
25232 @itemx gnus-info-set-score
25233 @findex gnus-info-score
25234 @findex gnus-info-set-score
25235 Get/set the group score (@pxref{Group Score}).
25236
25237 @item gnus-info-read
25238 @itemx gnus-info-set-read
25239 @findex gnus-info-read
25240 @findex gnus-info-set-read
25241 Get/set the ranges of read articles.
25242
25243 @item gnus-info-marks
25244 @itemx gnus-info-set-marks
25245 @findex gnus-info-marks
25246 @findex gnus-info-set-marks
25247 Get/set the lists of ranges of marked articles.
25248
25249 @item gnus-info-method
25250 @itemx gnus-info-set-method
25251 @findex gnus-info-method
25252 @findex gnus-info-set-method
25253 Get/set the group select method.
25254
25255 @item gnus-info-params
25256 @itemx gnus-info-set-params
25257 @findex gnus-info-params
25258 @findex gnus-info-set-params
25259 Get/set the group parameters.
25260 @end table
25261
25262 All the getter functions take one parameter---the info list.  The setter
25263 functions take two parameters---the info list and the new value.
25264
25265 The last three elements in the group info aren't mandatory, so it may be
25266 necessary to extend the group info before setting the element.  If this
25267 is necessary, you can just pass on a non-@code{nil} third parameter to
25268 the three final setter functions to have this happen automatically.
25269
25270
25271 @node Extended Interactive
25272 @subsection Extended Interactive
25273 @cindex interactive
25274 @findex gnus-interactive
25275
25276 Gnus extends the standard Emacs @code{interactive} specification
25277 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
25278 Prefixes}).  Here's an example of how this is used:
25279
25280 @lisp
25281 (defun gnus-summary-increase-score (&optional score symp)
25282   (interactive (gnus-interactive "P\ny"))
25283   ...
25284   )
25285 @end lisp
25286
25287 The best thing to do would have been to implement
25288 @code{gnus-interactive} as a macro which would have returned an
25289 @code{interactive} form, but this isn't possible since Emacs checks
25290 whether a function is interactive or not by simply doing an @code{assq}
25291 on the lambda form.  So, instead we have @code{gnus-interactive}
25292 function that takes a string and returns values that are usable to
25293 @code{interactive}.
25294
25295 This function accepts (almost) all normal @code{interactive} specs, but
25296 adds a few more.
25297
25298 @table @samp
25299 @item y
25300 @vindex gnus-current-prefix-symbol
25301 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
25302 variable.
25303
25304 @item Y
25305 @vindex gnus-current-prefix-symbols
25306 A list of the current symbolic prefixes---the
25307 @code{gnus-current-prefix-symbol} variable.
25308
25309 @item A
25310 The current article number---the @code{gnus-summary-article-number}
25311 function.
25312
25313 @item H
25314 The current article header---the @code{gnus-summary-article-header}
25315 function.
25316
25317 @item g
25318 The current group name---the @code{gnus-group-group-name}
25319 function.
25320
25321 @end table
25322
25323
25324 @node Emacs/XEmacs Code
25325 @subsection Emacs/XEmacs Code
25326 @cindex XEmacs
25327 @cindex Emacsen
25328
25329 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
25330 platforms must be the primary one.  I chose Emacs.  Not because I don't
25331 like XEmacs or Mule, but because it comes first alphabetically.
25332
25333 This means that Gnus will byte-compile under Emacs with nary a warning,
25334 while XEmacs will pump out gigabytes of warnings while byte-compiling.
25335 As I use byte-compilation warnings to help me root out trivial errors in
25336 Gnus, that's very useful.
25337
25338 I've also consistently used Emacs function interfaces, but have used
25339 Gnusey aliases for the functions.  To take an example:  Emacs defines a
25340 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
25341 function.  I then define a function called @code{gnus-run-at-time} that
25342 takes the same parameters as the Emacs @code{run-at-time}.  When running
25343 Gnus under Emacs, the former function is just an alias for the latter.
25344 However, when running under XEmacs, the former is an alias for the
25345 following function:
25346
25347 @lisp
25348 (defun gnus-xmas-run-at-time (time repeat function &rest args)
25349   (start-itimer
25350    "gnus-run-at-time"
25351    `(lambda ()
25352       (,function ,@@args))
25353    time repeat))
25354 @end lisp
25355
25356 This sort of thing has been done for bunches of functions.  Gnus does
25357 not redefine any native Emacs functions while running under XEmacs---it
25358 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
25359 all over.
25360
25361 In the cases where the XEmacs function interface was obviously cleaner,
25362 I used it instead.  For example @code{gnus-region-active-p} is an alias
25363 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
25364
25365 Of course, I could have chosen XEmacs as my native platform and done
25366 mapping functions the other way around.  But I didn't.  The performance
25367 hit these indirections impose on Gnus under XEmacs should be slight.
25368
25369
25370 @node Various File Formats
25371 @subsection Various File Formats
25372
25373 @menu
25374 * Active File Format::          Information on articles and groups available.
25375 * Newsgroups File Format::      Group descriptions.
25376 @end menu
25377
25378
25379 @node Active File Format
25380 @subsubsection Active File Format
25381
25382 The active file lists all groups available on the server in
25383 question.  It also lists the highest and lowest current article numbers
25384 in each group.
25385
25386 Here's an excerpt from a typical active file:
25387
25388 @example
25389 soc.motss 296030 293865 y
25390 alt.binaries.pictures.fractals 3922 3913 n
25391 comp.sources.unix 1605 1593 m
25392 comp.binaries.ibm.pc 5097 5089 y
25393 no.general 1000 900 y
25394 @end example
25395
25396 Here's a pseudo-BNF definition of this file:
25397
25398 @example
25399 active      = *group-line
25400 group-line  = group spc high-number spc low-number spc flag <NEWLINE>
25401 group       = <non-white-space string>
25402 spc         = " "
25403 high-number = <non-negative integer>
25404 low-number  = <positive integer>
25405 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
25406 @end example
25407
25408 For a full description of this file, see the manual pages for
25409 @samp{innd}, in particular @samp{active(5)}.
25410
25411
25412 @node Newsgroups File Format
25413 @subsubsection Newsgroups File Format
25414
25415 The newsgroups file lists groups along with their descriptions.  Not all
25416 groups on the server have to be listed,  and not all groups in the file
25417 have to exist on the server.  The file is meant purely as information to
25418 the user.
25419
25420 The format is quite simple; a group name, a tab, and the description.
25421 Here's the definition:
25422
25423 @example
25424 newsgroups    = *line
25425 line          = group tab description <NEWLINE>
25426 group         = <non-white-space string>
25427 tab           = <TAB>
25428 description   = <string>
25429 @end example
25430
25431
25432 @page
25433 @node Emacs for Heathens
25434 @section Emacs for Heathens
25435
25436 Believe it or not, but some people who use Gnus haven't really used
25437 Emacs much before they embarked on their journey on the Gnus Love Boat.
25438 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
25439 region'', and ``set @code{gnus-flargblossen} to an alist where the key
25440 is a regexp that is used for matching on the group name'' are magical
25441 phrases with little or no meaning, then this appendix is for you.  If
25442 you are already familiar with Emacs, just ignore this and go fondle your
25443 cat instead.
25444
25445 @menu
25446 * Keystrokes::                  Entering text and executing commands.
25447 * Emacs Lisp::                  The built-in Emacs programming language.
25448 @end menu
25449
25450
25451 @node Keystrokes
25452 @subsection Keystrokes
25453
25454 @itemize @bullet
25455 @item
25456 Q: What is an experienced Emacs user?
25457
25458 @item
25459 A: A person who wishes that the terminal had pedals.
25460 @end itemize
25461
25462 Yes, when you use Emacs, you are apt to use the control key, the shift
25463 key and the meta key a lot.  This is very annoying to some people
25464 (notably @code{vi}le users), and the rest of us just love the hell out
25465 of it.  Just give up and submit.  Emacs really does stand for
25466 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
25467 may have heard from other disreputable sources (like the Emacs author).
25468
25469 The shift keys are normally located near your pinky fingers, and are
25470 normally used to get capital letters and stuff.  You probably use it all
25471 the time.  The control key is normally marked ``CTRL'' or something like
25472 that.  The meta key is, funnily enough, never marked as such on any
25473 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
25474 which is the meta key on this keyboard.  It's usually located somewhere
25475 to the left hand side of the keyboard, usually on the bottom row.
25476
25477 Now, us Emacs people don't say ``press the meta-control-m key'',
25478 because that's just too inconvenient.  We say ``press the @kbd{C-M-m}
25479 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
25480 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
25481 down the control key, and hold it down while you press @kbd{k}''.
25482 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
25483 the control key and then press @kbd{k}''.  Simple, ay?
25484
25485 This is somewhat complicated by the fact that not all keyboards have a
25486 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
25487 means ``press escape, release escape, press @kbd{k}''.  That's much more
25488 work than if you have a meta key, so if that's the case, I respectfully
25489 suggest you get a real keyboard with a meta key.  You can't live without
25490 it.
25491
25492
25493
25494 @node Emacs Lisp
25495 @subsection Emacs Lisp
25496
25497 Emacs is the King of Editors because it's really a Lisp interpreter.
25498 Each and every key you tap runs some Emacs Lisp code snippet, and since
25499 Emacs Lisp is an interpreted language, that means that you can configure
25500 any key to run any arbitrary code.  You just, like, do it.
25501
25502 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
25503 functions.  (These are byte-compiled for speed, but it's still
25504 interpreted.)  If you decide that you don't like the way Gnus does
25505 certain things, it's trivial to have it do something a different way.
25506 (Well, at least if you know how to write Lisp code.)  However, that's
25507 beyond the scope of this manual, so we are simply going to talk about
25508 some common constructs that you normally use in your @file{.emacs} file
25509 to customize Gnus.
25510
25511 If you want to set the variable @code{gnus-florgbnize} to four (4), you
25512 write the following:
25513
25514 @lisp
25515 (setq gnus-florgbnize 4)
25516 @end lisp
25517
25518 This function (really ``special form'') @code{setq} is the one that can
25519 set a variable to some value.  This is really all you need to know.  Now
25520 you can go and fill your @code{.emacs} file with lots of these to change
25521 how Gnus works.
25522
25523 If you have put that thing in your @code{.emacs} file, it will be read
25524 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
25525 start Emacs.  If you want to change the variable right away, simply say
25526 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
25527 previous ``form'', which is a simple @code{setq} statement here.
25528
25529 Go ahead---just try it, if you're located at your Emacs.  After you
25530 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
25531 is the return value of the form you @code{eval}ed.
25532
25533 Some pitfalls:
25534
25535 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
25536 that means:
25537
25538 @lisp
25539 (setq gnus-read-active-file 'some)
25540 @end lisp
25541
25542 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
25543 @samp{nntp.ifi.uio.no}'', that means:
25544
25545 @lisp
25546 (setq gnus-nntp-server "nntp.ifi.uio.no")
25547 @end lisp
25548
25549 So be careful not to mix up strings (the latter) with symbols (the
25550 former).  The manual is unambiguous, but it can be confusing.
25551
25552 @page
25553 @include gnus-faq.texi
25554
25555 @node Index
25556 @chapter Index
25557 @printindex cp
25558
25559 @node Key Index
25560 @chapter Key Index
25561 @printindex ky
25562
25563 @summarycontents
25564 @contents
25565 @bye
25566
25567 @iftex
25568 @iflatex
25569 \end{document}
25570 @end iflatex
25571 @end iftex
25572
25573 @c Local Variables:
25574 @c mode: texinfo
25575 @c coding: iso-8859-1
25576 @c End:
25577 % LocalWords:  BNF mucho detailmenu cindex kindex kbd
25578 % LocalWords:  findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
25579 % LocalWords:  nnmbox newusers Blllrph NEWGROUPS dingnusdingnusdingnus
25580 % LocalWords:  pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
25581 % LocalWords:  nnfolder emph looong eld newsreaders defun init elc pxref