]> code.delx.au - gnu-emacs/blob - doc/misc/gnus.texi
lisp/international/mule.el (define-coding-system): Fix typos in the doc string.
[gnu-emacs] / doc / misc / gnus.texi
1 \input texinfo
2
3 @include gnus-overrides.texi
4
5 @setfilename ../../info/gnus
6 @settitle Gnus Manual
7 @syncodeindex fn cp
8 @syncodeindex vr cp
9 @syncodeindex pg cp
10
11 @documentencoding UTF-8
12
13 @copying
14 Copyright @copyright{} 1995--2014 Free Software Foundation, Inc.
15
16 @quotation
17 Permission is granted to copy, distribute and/or modify this document
18 under the terms of the GNU Free Documentation License, Version 1.3 or
19 any later version published by the Free Software Foundation; with no
20 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual'',
21 and with the Back-Cover Texts as in (a) below. A copy of the license
22 is included in the section entitled ``GNU Free Documentation License''.
23
24 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
25 modify this GNU manual.''
26 @end quotation
27 @end copying
28
29 @iftex
30 @iflatex
31 \documentclass[twoside,a4paper,openright,11pt]{book}
32 \usepackage[latin1]{inputenc}
33 \usepackage{pagestyle}
34 \usepackage{epsfig}
35 \usepackage{pixidx}
36 \input{gnusconfig.tex}
37
38 \ifx\pdfoutput\undefined
39 \else
40 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
41 \usepackage{thumbpdf}
42 \pdfcompresslevel=9
43 \fi
44
45 \makeindex
46 \begin{document}
47
48 % Adjust ../Makefile.in if you change the following line:
49 \newcommand{\gnusversionname}{Gnus v5.13}
50 \newcommand{\gnuschaptername}{}
51 \newcommand{\gnussectionname}{}
52
53 \newcommand{\gnusbackslash}{/}
54
55 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
56 \ifx\pdfoutput\undefined
57 \newcommand{\gnusuref}[1]{\gnustt{#1}}
58 \else
59 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
60 \fi
61 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
62 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
63
64 \newcommand{\gnuskindex}[1]{\index{#1}}
65 \newcommand{\gnusindex}[1]{\index{#1}}
66
67 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
68 \newcommand{\gnuscode}[1]{\gnustt{#1}}
69 \newcommand{\gnusasis}[1]{\gnustt{#1}}
70 \newcommand{\gnusurl}[1]{\gnustt{#1}}
71 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
72 \newcommand{\gnusenv}[1]{\gnustt{#1}}
73 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
74 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
75 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
76 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
77 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
78 \newcommand{\gnusdfn}[1]{\textit{#1}}
79 \newcommand{\gnusi}[1]{\textit{#1}}
80 \newcommand{\gnusr}[1]{\textrm{#1}}
81 \newcommand{\gnusstrong}[1]{\textbf{#1}}
82 \newcommand{\gnusemph}[1]{\textit{#1}}
83 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
84 \newcommand{\gnussc}[1]{\textsc{#1}}
85 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
86 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
87 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
88 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
89 \newcommand{\gnusacronym}[1]{\textsc{#1}}
90 \newcommand{\gnusemail}[1]{\textit{#1}}
91
92 \newcommand{\gnusbullet}{{${\bullet}$}}
93 \newcommand{\gnusdollar}{\$}
94 \newcommand{\gnusampersand}{\&}
95 \newcommand{\gnuspercent}{\%}
96 \newcommand{\gnushash}{\#}
97 \newcommand{\gnushat}{\symbol{"5E}}
98 \newcommand{\gnusunderline}{\symbol{"5F}}
99 \newcommand{\gnusnot}{$\neg$}
100 \newcommand{\gnustilde}{\symbol{"7E}}
101 \newcommand{\gnusless}{{$<$}}
102 \newcommand{\gnusgreater}{{$>$}}
103 \newcommand{\gnusbraceleft}{{$>$}}
104 \newcommand{\gnusbraceright}{{$>$}}
105
106 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
107 \newcommand{\gnusinteresting}{
108 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
109 }
110
111 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
112
113 \newcommand{\gnuspagechapter}[1]{
114 {\mbox{}}
115 }
116
117 \newdimen{\gnusdimen}
118 \gnusdimen 0pt
119
120 \newcommand{\gnuschapter}[2]{
121 \gnuscleardoublepage
122 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
123 \chapter{#2}
124 \renewcommand{\gnussectionname}{}
125 \renewcommand{\gnuschaptername}{#2}
126 \thispagestyle{empty}
127 \hspace*{-2cm}
128 \begin{picture}(500,500)(0,0)
129 \put(480,350){\makebox(0,0)[tr]{#1}}
130 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
131 \end{picture}
132 \clearpage
133 }
134
135 \newcommand{\gnusfigure}[3]{
136 \begin{figure}
137 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
138 #3
139 \end{picture}
140 \caption{#1}
141 \end{figure}
142 }
143
144 \newcommand{\gnusicon}[1]{
145 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
146 }
147
148 \newcommand{\gnuspicon}[1]{
149 \margindex{\epsfig{figure=#1,width=2cm}}
150 }
151
152 \newcommand{\gnusxface}[2]{
153 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
154 }
155
156 \newcommand{\gnussmiley}[2]{
157 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
158 }
159
160 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
161
162 \newcommand{\gnussection}[1]{
163 \renewcommand{\gnussectionname}{#1}
164 \section{#1}
165 }
166
167 \newenvironment{codelist}%
168 {\begin{list}{}{
169 }
170 }{\end{list}}
171
172 \newenvironment{asislist}%
173 {\begin{list}{}{
174 }
175 }{\end{list}}
176
177 \newenvironment{kbdlist}%
178 {\begin{list}{}{
179 \labelwidth=0cm
180 }
181 }{\end{list}}
182
183 \newenvironment{dfnlist}%
184 {\begin{list}{}{
185 }
186 }{\end{list}}
187
188 \newenvironment{stronglist}%
189 {\begin{list}{}{
190 }
191 }{\end{list}}
192
193 \newenvironment{samplist}%
194 {\begin{list}{}{
195 }
196 }{\end{list}}
197
198 \newenvironment{varlist}%
199 {\begin{list}{}{
200 }
201 }{\end{list}}
202
203 \newenvironment{emphlist}%
204 {\begin{list}{}{
205 }
206 }{\end{list}}
207
208 \newlength\gnusheadtextwidth
209 \setlength{\gnusheadtextwidth}{\headtextwidth}
210 \addtolength{\gnusheadtextwidth}{1cm}
211
212 \newpagestyle{gnuspreamble}%
213 {
214 {
215 \ifodd\count0
216 {
217 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
218 }
219 \else
220 {
221 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
222 }
223 }
224 \fi
225 }
226 }
227 {
228 \ifodd\count0
229 \mbox{} \hfill
230 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
231 \else
232 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
233 \hfill \mbox{}
234 \fi
235 }
236
237 \newpagestyle{gnusindex}%
238 {
239 {
240 \ifodd\count0
241 {
242 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
243 }
244 \else
245 {
246 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
247 }
248 \fi
249 }
250 }
251 {
252 \ifodd\count0
253 \mbox{} \hfill
254 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
255 \else
256 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
257 \hfill \mbox{}
258 \fi
259 }
260
261 \newpagestyle{gnus}%
262 {
263 {
264 \ifodd\count0
265 {
266 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
267 }
268 \else
269 {
270 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
271 }
272 \fi
273 }
274 }
275 {
276 \ifodd\count0
277 \mbox{} \hfill
278 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
279 \else
280 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
281 \hfill \mbox{}
282 \fi
283 }
284
285 \pagenumbering{roman}
286 \pagestyle{gnuspreamble}
287
288 @end iflatex
289 @end iftex
290
291 @iftex
292 @iflatex
293
294 \begin{titlepage}
295 {
296
297 %\addtolength{\oddsidemargin}{-5cm}
298 %\addtolength{\evensidemargin}{-5cm}
299 \parindent=0cm
300 \addtolength{\textheight}{2cm}
301
302 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
303 \rule{15cm}{1mm}\\
304 \vfill
305 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
306 \vfill
307 \rule{15cm}{1mm}\\
308 \gnusauthor{by Lars Magne Ingebrigtsen}
309 \newpage
310 }
311
312 \mbox{}
313 \vfill
314
315 \thispagestyle{empty}
316
317 @c @insertcopying
318 \newpage
319 \end{titlepage}
320 @end iflatex
321 @end iftex
322
323 @dircategory Emacs network features
324 @direntry
325 * Gnus: (gnus). The newsreader Gnus.
326 @end direntry
327 @iftex
328 @finalout
329 @end iftex
330
331
332 @titlepage
333 @ifset WEBHACKDEVEL
334 @title Gnus Manual (DEVELOPMENT VERSION)
335 @end ifset
336 @ifclear WEBHACKDEVEL
337 @title Gnus Manual
338 @end ifclear
339
340 @author by Lars Magne Ingebrigtsen
341 @page
342 @vskip 0pt plus 1filll
343 @insertcopying
344 @end titlepage
345
346 @summarycontents
347 @contents
348
349 @node Top
350 @top The Gnus Newsreader
351
352 @ifinfo
353
354 You can read news (and mail) from within Emacs by using Gnus. The news
355 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
356 spool or your mbox file. All at the same time, if you want to push your
357 luck.
358
359 @c Adjust ../Makefile.in if you change the following line:
360 This manual corresponds to Gnus v5.13
361
362 @ifnottex
363 @insertcopying
364 @end ifnottex
365
366 @end ifinfo
367
368 @iftex
369
370 @iflatex
371 \tableofcontents
372 \gnuscleardoublepage
373 @end iflatex
374
375 Gnus is the advanced, self-documenting, customizable, extensible
376 unreal-time newsreader for GNU Emacs.
377
378 Oops. That sounds oddly familiar, so let's start over again to avoid
379 being accused of plagiarism:
380
381 Gnus is a message-reading laboratory. It will let you look at just
382 about anything as if it were a newsgroup. You can read mail with it,
383 you can browse directories with it, you can @code{ftp} with it---you
384 can even read news with it!
385
386 Gnus tries to empower people who read news the same way Emacs empowers
387 people who edit text. Gnus sets no limits to what the user should be
388 allowed to do. Users are encouraged to extend Gnus to make it behave
389 like they want it to behave. A program should not control people;
390 people should be empowered to do what they want by using (or abusing)
391 the program.
392
393 @c Adjust ../Makefile.in if you change the following line:
394 This manual corresponds to Gnus v5.13
395
396 @heading Other related manuals
397 @itemize
398 @item Message manual: Composing messages
399 @item Emacs-MIME: Composing messages; @acronym{MIME}-specific parts.
400 @item Sieve: Managing Sieve scripts in Emacs.
401 @item EasyPG: @acronym{PGP/MIME} with Gnus.
402 @item SASL: @acronym{SASL} authentication in Emacs.
403 @end itemize
404
405 @end iftex
406
407 @menu
408 * Starting Up:: Finding news can be a pain.
409 * Group Buffer:: Selecting, subscribing and killing groups.
410 * Summary Buffer:: Reading, saving and posting articles.
411 * Article Buffer:: Displaying and handling articles.
412 * Composing Messages:: Information on sending mail and news.
413 * Select Methods:: Gnus reads all messages from various select methods.
414 * Scoring:: Assigning values to articles.
415 * Searching:: Mail and News search engines.
416 * Various:: General purpose settings.
417 * The End:: Farewell and goodbye.
418 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
419 * GNU Free Documentation License:: The license for this documentation.
420 * Index:: Variable, function and concept index.
421 * Key Index:: Key Index.
422
423 @c Doesn't work right in html.
424 @c FIXME Do this in a more standard way.
425 @ifinfo
426 Other related manuals
427
428 * Message:(message). Composing messages.
429 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
430 * Sieve:(sieve). Managing Sieve scripts in Emacs.
431 * EasyPG:(epa). @acronym{PGP/MIME} with Gnus.
432 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
433 @end ifinfo
434
435 @detailmenu
436 --- The Detailed Node Listing ---
437
438 Starting Gnus
439
440 * Finding the News:: Choosing a method for getting news.
441 * The Server is Down:: How can I read my mail then?
442 * Slave Gnusae:: You can have more than one Gnus active at a time.
443 * Fetching a Group:: Starting Gnus just to read a group.
444 * New Groups:: What is Gnus supposed to do with new groups?
445 * Changing Servers:: You may want to move from one server to another.
446 * Startup Files:: Those pesky startup files---@file{.newsrc}.
447 * Auto Save:: Recovering from a crash.
448 * The Active File:: Reading the active file over a slow line Takes Time.
449 * Startup Variables:: Other variables you might change.
450
451 New Groups
452
453 * Checking New Groups:: Determining what groups are new.
454 * Subscription Methods:: What Gnus should do with new groups.
455 * Filtering New Groups:: Making Gnus ignore certain new groups.
456
457 Group Buffer
458
459 * Group Buffer Format:: Information listed and how you can change it.
460 * Group Maneuvering:: Commands for moving in the group buffer.
461 * Selecting a Group:: Actually reading news.
462 * Subscription Commands:: Unsubscribing, killing, subscribing.
463 * Group Data:: Changing the info for a group.
464 * Group Levels:: Levels? What are those, then?
465 * Group Score:: A mechanism for finding out what groups you like.
466 * Marking Groups:: You can mark groups for later processing.
467 * Foreign Groups:: Creating and editing groups.
468 * Group Parameters:: Each group may have different parameters set.
469 * Listing Groups:: Gnus can list various subsets of the groups.
470 * Sorting Groups:: Re-arrange the group order.
471 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
472 * Browse Foreign Server:: You can browse a server. See what it has to offer.
473 * Exiting Gnus:: Stop reading news and get some work done.
474 * Group Topics:: A folding group mode divided into topics.
475 * Non-ASCII Group Names:: Accessing groups of non-English names.
476 * Misc Group Stuff:: Other stuff that you can to do.
477
478 Group Buffer Format
479
480 * Group Line Specification:: Deciding how the group buffer is to look.
481 * Group Mode Line Specification:: The group buffer mode line.
482 * Group Highlighting:: Having nice colors in the group buffer.
483
484 Group Topics
485
486 * Topic Commands:: Interactive E-Z commands.
487 * Topic Variables:: How to customize the topics the Lisp Way.
488 * Topic Sorting:: Sorting each topic individually.
489 * Topic Topology:: A map of the world.
490 * Topic Parameters:: Parameters that apply to all groups in a topic.
491
492 Misc Group Stuff
493
494 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
495 * Group Information:: Information and help on groups and Gnus.
496 * Group Timestamp:: Making Gnus keep track of when you last read a group.
497 * File Commands:: Reading and writing the Gnus files.
498 * Sieve Commands:: Managing Sieve scripts.
499
500 Summary Buffer
501
502 * Summary Buffer Format:: Deciding how the summary buffer is to look.
503 * Summary Maneuvering:: Moving around the summary buffer.
504 * Choosing Articles:: Reading articles.
505 * Paging the Article:: Scrolling the current article.
506 * Reply Followup and Post:: Posting articles.
507 * Delayed Articles:: Send articles at a later time.
508 * Marking Articles:: Marking articles as read, expirable, etc.
509 * Limiting:: You can limit the summary buffer.
510 * Threading:: How threads are made.
511 * Sorting the Summary Buffer:: How articles and threads are sorted.
512 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
513 * Article Caching:: You may store articles in a cache.
514 * Persistent Articles:: Making articles expiry-resistant.
515 * Sticky Articles:: Article buffers that are not reused.
516 * Article Backlog:: Having already read articles hang around.
517 * Saving Articles:: Ways of customizing article saving.
518 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
519 * Article Treatment:: The article buffer can be mangled at will.
520 * MIME Commands:: Doing MIMEy things with the articles.
521 * Charsets:: Character set issues.
522 * Article Commands:: Doing various things with the article buffer.
523 * Summary Sorting:: Sorting the summary buffer in various ways.
524 * Finding the Parent:: No child support? Get the parent.
525 * Alternative Approaches:: Reading using non-default summaries.
526 * Tree Display:: A more visual display of threads.
527 * Mail Group Commands:: Some commands can only be used in mail groups.
528 * Various Summary Stuff:: What didn't fit anywhere else.
529 * Exiting the Summary Buffer:: Returning to the Group buffer,
530 or reselecting the current group.
531 * Crosspost Handling:: How crossposted articles are dealt with.
532 * Duplicate Suppression:: An alternative when crosspost handling fails.
533 * Security:: Decrypt and Verify.
534 * Mailing List:: Mailing list minor mode.
535
536 Summary Buffer Format
537
538 * Summary Buffer Lines:: You can specify how summary lines should look.
539 * To From Newsgroups:: How to not display your own name.
540 * Summary Buffer Mode Line:: You can say how the mode line should look.
541 * Summary Highlighting:: Making the summary buffer all pretty and nice.
542
543 Choosing Articles
544
545 * Choosing Commands:: Commands for choosing articles.
546 * Choosing Variables:: Variables that influence these commands.
547
548 Reply, Followup and Post
549
550 * Summary Mail Commands:: Sending mail.
551 * Summary Post Commands:: Sending news.
552 * Summary Message Commands:: Other Message-related commands.
553 * Canceling and Superseding::
554
555 Marking Articles
556
557 * Unread Articles:: Marks for unread articles.
558 * Read Articles:: Marks for read articles.
559 * Other Marks:: Marks that do not affect readedness.
560 * Setting Marks:: How to set and remove marks.
561 * Generic Marking Commands:: How to customize the marking.
562 * Setting Process Marks:: How to mark articles for later processing.
563
564 Threading
565
566 * Customizing Threading:: Variables you can change to affect the threading.
567 * Thread Commands:: Thread based commands in the summary buffer.
568
569 Customizing Threading
570
571 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
572 * Filling In Threads:: Making the threads displayed look fuller.
573 * More Threading:: Even more variables for fiddling with threads.
574 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
575
576 Decoding Articles
577
578 * Uuencoded Articles:: Uudecode articles.
579 * Shell Archives:: Unshar articles.
580 * PostScript Files:: Split PostScript.
581 * Other Files:: Plain save and binhex.
582 * Decoding Variables:: Variables for a happy decoding.
583 * Viewing Files:: You want to look at the result of the decoding?
584
585 Decoding Variables
586
587 * Rule Variables:: Variables that say how a file is to be viewed.
588 * Other Decode Variables:: Other decode variables.
589 * Uuencoding and Posting:: Variables for customizing uuencoding.
590
591 Article Treatment
592
593 * Article Highlighting:: You want to make the article look like fruit salad.
594 * Article Fontisizing:: Making emphasized text look nice.
595 * Article Hiding:: You also want to make certain info go away.
596 * Article Washing:: Lots of way-neat functions to make life better.
597 * Article Header:: Doing various header transformations.
598 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
599 * Article Button Levels:: Controlling appearance of buttons.
600 * Article Date:: Grumble, UT!
601 * Article Display:: Display various stuff---X-Face, Picons, Smileys, Gravatars
602 * Article Signature:: What is a signature?
603 * Article Miscellanea:: Various other stuff.
604
605 Alternative Approaches
606
607 * Pick and Read:: First mark articles and then read them.
608 * Binary Groups:: Auto-decode all articles.
609
610 Various Summary Stuff
611
612 * Summary Group Information:: Information oriented commands.
613 * Searching for Articles:: Multiple article commands.
614 * Summary Generation Commands::
615 * Really Various Summary Commands:: Those pesky non-conformant commands.
616
617 Article Buffer
618
619 * Hiding Headers:: Deciding what headers should be displayed.
620 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
621 * HTML:: Reading @acronym{HTML} messages.
622 * Customizing Articles:: Tailoring the look of the articles.
623 * Article Keymap:: Keystrokes available in the article buffer.
624 * Misc Article:: Other stuff.
625
626 Composing Messages
627
628 * Mail:: Mailing and replying.
629 * Posting Server:: What server should you post and mail via?
630 * POP before SMTP:: You cannot send a mail unless you read a mail.
631 * Mail and Post:: Mailing and posting at the same time.
632 * Archived Messages:: Where Gnus stores the messages you've sent.
633 * Posting Styles:: An easier way to specify who you are.
634 * Drafts:: Postponing messages and rejected messages.
635 * Rejected Articles:: What happens if the server doesn't like your article?
636 * Signing and encrypting:: How to compose secure messages.
637
638 Select Methods
639
640 * Server Buffer:: Making and editing virtual servers.
641 * Getting News:: Reading USENET news with Gnus.
642 * Using IMAP:: Reading mail from @acronym{IMAP}.
643 * Getting Mail:: Reading your personal mail with Gnus.
644 * Browsing the Web:: Getting messages from a plethora of Web sources.
645 * Other Sources:: Reading directories, files.
646 * Combined Groups:: Combining groups into one group.
647 * Email Based Diary:: Using mails to manage diary events in Gnus.
648 * Gnus Unplugged:: Reading news and mail offline.
649
650 Server Buffer
651
652 * Server Buffer Format:: You can customize the look of this buffer.
653 * Server Commands:: Commands to manipulate servers.
654 * Example Methods:: Examples server specifications.
655 * Creating a Virtual Server:: An example session.
656 * Server Variables:: Which variables to set.
657 * Servers and Methods:: You can use server names as select methods.
658 * Unavailable Servers:: Some servers you try to contact may be down.
659
660 Getting News
661
662 * NNTP:: Reading news from an @acronym{NNTP} server.
663 * News Spool:: Reading news from the local spool.
664
665 @acronym{NNTP}
666
667 * Direct Functions:: Connecting directly to the server.
668 * Indirect Functions:: Connecting indirectly to the server.
669 * Common Variables:: Understood by several connection functions.
670
671 Getting Mail
672
673 * Mail in a Newsreader:: Important introductory notes.
674 * Getting Started Reading Mail:: A simple cookbook example.
675 * Splitting Mail:: How to create mail groups.
676 * Mail Sources:: How to tell Gnus where to get mail from.
677 * Mail Back End Variables:: Variables for customizing mail handling.
678 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
679 * Group Mail Splitting:: Use group customize to drive mail splitting.
680 * Incorporating Old Mail:: What about the old mail you have?
681 * Expiring Mail:: Getting rid of unwanted mail.
682 * Washing Mail:: Removing cruft from the mail you get.
683 * Duplicates:: Dealing with duplicated mail.
684 * Not Reading Mail:: Using mail back ends for reading other files.
685 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
686
687 Mail Sources
688
689 * Mail Source Specifiers:: How to specify what a mail source is.
690 * Mail Source Customization:: Some variables that influence things.
691 * Fetching Mail:: Using the mail source specifiers.
692
693 Choosing a Mail Back End
694
695 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
696 * Babyl:: Babyl was used by older versions of Rmail.
697 * Mail Spool:: Store your mail in a private spool?
698 * MH Spool:: An mhspool-like back end.
699 * Maildir:: Another one-file-per-message format.
700 * Mail Folders:: Having one file for each group.
701 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
702
703 Browsing the Web
704
705 * Archiving Mail::
706 * Web Searches:: Creating groups from articles that match a string.
707 * RSS:: Reading RDF site summary.
708 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
709
710 Other Sources
711
712 * Directory Groups:: You can read a directory as if it was a newsgroup.
713 * Anything Groups:: Dired? Who needs dired?
714 * Document Groups:: Single files can be the basis of a group.
715 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
716 * The Empty Backend:: The backend that never has any news.
717
718 Document Groups
719
720 * Document Server Internals:: How to add your own document types.
721
722 Combined Groups
723
724 * Virtual Groups:: Combining articles from many groups.
725
726 Email Based Diary
727
728 * The NNDiary Back End:: Basic setup and usage.
729 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
730 * Sending or Not Sending:: A final note on sending diary messages.
731
732 The NNDiary Back End
733
734 * Diary Messages:: What makes a message valid for nndiary.
735 * Running NNDiary:: NNDiary has two modes of operation.
736 * Customizing NNDiary:: Bells and whistles.
737
738 The Gnus Diary Library
739
740 * Diary Summary Line Format:: A nicer summary buffer line format.
741 * Diary Articles Sorting:: A nicer way to sort messages.
742 * Diary Headers Generation:: Not doing it manually.
743 * Diary Group Parameters:: Not handling them manually.
744
745 Gnus Unplugged
746
747 * Agent Basics:: How it all is supposed to work.
748 * Agent Categories:: How to tell the Gnus Agent what to download.
749 * Agent Commands:: New commands for all the buffers.
750 * Agent Visuals:: Ways that the agent may effect your summary buffer.
751 * Agent as Cache:: The Agent is a big cache too.
752 * Agent Expiry:: How to make old articles go away.
753 * Agent Regeneration:: How to recover from lost connections and other accidents.
754 * Agent and flags:: How the Agent maintains flags.
755 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
756 * Outgoing Messages:: What happens when you post/mail something?
757 * Agent Variables:: Customizing is fun.
758 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
759 * Batching Agents:: How to fetch news from a @code{cron} job.
760 * Agent Caveats:: What you think it'll do and what it does.
761
762 Agent Categories
763
764 * Category Syntax:: What a category looks like.
765 * Category Buffer:: A buffer for maintaining categories.
766 * Category Variables:: Customize'r'Us.
767
768 Agent Commands
769
770 * Group Agent Commands:: Configure groups and fetch their contents.
771 * Summary Agent Commands:: Manually select then fetch specific articles.
772 * Server Agent Commands:: Select the servers that are supported by the agent.
773
774 Scoring
775
776 * Summary Score Commands:: Adding score entries for the current group.
777 * Group Score Commands:: General score commands.
778 * Score Variables:: Customize your scoring. (My, what terminology).
779 * Score File Format:: What a score file may contain.
780 * Score File Editing:: You can edit score files by hand as well.
781 * Adaptive Scoring:: Big Sister Gnus knows what you read.
782 * Home Score File:: How to say where new score entries are to go.
783 * Followups To Yourself:: Having Gnus notice when people answer you.
784 * Scoring On Other Headers:: Scoring on non-standard headers.
785 * Scoring Tips:: How to score effectively.
786 * Reverse Scoring:: That problem child of old is not problem.
787 * Global Score Files:: Earth-spanning, ear-splitting score files.
788 * Kill Files:: They are still here, but they can be ignored.
789 * Converting Kill Files:: Translating kill files to score files.
790 * Advanced Scoring:: Using logical expressions to build score rules.
791 * Score Decays:: It can be useful to let scores wither away.
792
793 Advanced Scoring
794
795 * Advanced Scoring Syntax:: A definition.
796 * Advanced Scoring Examples:: What they look like.
797 * Advanced Scoring Tips:: Getting the most out of it.
798
799 Searching
800
801 * nnir:: Searching with various engines.
802 * nnmairix:: Searching with Mairix.
803
804 nnir
805
806 * What is nnir?:: What does nnir do.
807 * Basic Usage:: How to perform simple searches.
808 * Setting up nnir:: How to set up nnir.
809
810 Setting up nnir
811
812 * Associating Engines:: How to associate engines.
813
814 Various
815
816 * Process/Prefix:: A convention used by many treatment commands.
817 * Interactive:: Making Gnus ask you many questions.
818 * Symbolic Prefixes:: How to supply some Gnus functions with options.
819 * Formatting Variables:: You can specify what buffers should look like.
820 * Window Layout:: Configuring the Gnus buffer windows.
821 * Faces and Fonts:: How to change how faces look.
822 * Mode Lines:: Displaying information in the mode lines.
823 * Highlighting and Menus:: Making buffers look all nice and cozy.
824 * Daemons:: Gnus can do things behind your back.
825 * Undo:: Some actions can be undone.
826 * Predicate Specifiers:: Specifying predicates.
827 * Moderation:: What to do if you're a moderator.
828 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
829 * Fuzzy Matching:: What's the big fuzz?
830 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
831 * Spam Package:: A package for filtering and processing spam.
832 * The Gnus Registry:: A package for tracking messages by Message-ID.
833 * Other modes:: Interaction with other modes.
834 * Various Various:: Things that are really various.
835
836 Formatting Variables
837
838 * Formatting Basics:: A formatting variable is basically a format string.
839 * Mode Line Formatting:: Some rules about mode line formatting variables.
840 * Advanced Formatting:: Modifying output in various ways.
841 * User-Defined Specs:: Having Gnus call your own functions.
842 * Formatting Fonts:: Making the formatting look colorful and nice.
843 * Positioning Point:: Moving point to a position after an operation.
844 * Tabulation:: Tabulating your output.
845 * Wide Characters:: Dealing with wide characters.
846
847 Image Enhancements
848
849 * X-Face:: Display a funky, teensy black-and-white image.
850 * Face:: Display a funkier, teensier colored image.
851 * Smileys:: Show all those happy faces the way they were
852 meant to be shown.
853 * Picons:: How to display pictures of what you're reading.
854 * Gravatars:: Display the avatar of people you read.
855 * XVarious:: Other XEmacsy Gnusey variables.
856
857 Thwarting Email Spam
858
859 * The problem of spam:: Some background, and some solutions
860 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
861 * SpamAssassin:: How to use external anti-spam tools.
862 * Hashcash:: Reduce spam by burning CPU time.
863
864 Spam Package
865
866 * Spam Package Introduction::
867 * Filtering Incoming Mail::
868 * Detecting Spam in Groups::
869 * Spam and Ham Processors::
870 * Spam Package Configuration Examples::
871 * Spam Back Ends::
872 * Extending the Spam package::
873 * Spam Statistics Package::
874
875 Spam Statistics Package
876
877 * Creating a spam-stat dictionary::
878 * Splitting mail using spam-stat::
879 * Low-level interface to the spam-stat dictionary::
880
881 Appendices
882
883 * XEmacs:: Requirements for installing under XEmacs.
884 * History:: How Gnus got where it is today.
885 * On Writing Manuals:: Why this is not a beginner's guide.
886 * Terminology:: We use really difficult, like, words here.
887 * Customization:: Tailoring Gnus to your needs.
888 * Troubleshooting:: What you might try if things do not work.
889 * Gnus Reference Guide:: Rilly, rilly technical stuff.
890 * Emacs for Heathens:: A short introduction to Emacsian terms.
891 * Frequently Asked Questions:: The Gnus FAQ
892
893 History
894
895 * Gnus Versions:: What Gnus versions have been released.
896 * Why?:: What's the point of Gnus?
897 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
898 * Conformity:: Gnus tries to conform to all standards.
899 * Emacsen:: Gnus can be run on a few modern Emacsen.
900 * Gnus Development:: How Gnus is developed.
901 * Contributors:: Oodles of people.
902 * New Features:: Pointers to some of the new stuff in Gnus.
903
904 New Features
905
906 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
907 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
908 * Red Gnus:: Third time best---Gnus 5.4/5.5.
909 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
910 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
911 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
912 * No Gnus:: Very punny. Gnus 5.12/5.13
913 * Ma Gnus:: Celebrating 25 years of Gnus.
914
915 Customization
916
917 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
918 * Slow Terminal Connection:: You run a remote Emacs.
919 * Little Disk Space:: You feel that having large setup files is icky.
920 * Slow Machine:: You feel like buying a faster machine.
921
922 Gnus Reference Guide
923
924 * Gnus Utility Functions:: Common functions and variable to use.
925 * Back End Interface:: How Gnus communicates with the servers.
926 * Score File Syntax:: A BNF definition of the score file standard.
927 * Headers:: How Gnus stores headers internally.
928 * Ranges:: A handy format for storing mucho numbers.
929 * Group Info:: The group info format.
930 * Extended Interactive:: Symbolic prefixes and stuff.
931 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
932 * Various File Formats:: Formats of files that Gnus use.
933
934 Back End Interface
935
936 * Required Back End Functions:: Functions that must be implemented.
937 * Optional Back End Functions:: Functions that need not be implemented.
938 * Error Messaging:: How to get messages and report errors.
939 * Writing New Back Ends:: Extending old back ends.
940 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
941 * Mail-like Back Ends:: Some tips on mail back ends.
942
943 Various File Formats
944
945 * Active File Format:: Information on articles and groups available.
946 * Newsgroups File Format:: Group descriptions.
947
948 Emacs for Heathens
949
950 * Keystrokes:: Entering text and executing commands.
951 * Emacs Lisp:: The built-in Emacs programming language.
952
953 @end detailmenu
954 @end menu
955
956 @node Starting Up
957 @chapter Starting Gnus
958 @cindex starting up
959
960 If you haven't used Emacs much before using Gnus, read @ref{Emacs for
961 Heathens} first.
962
963 @kindex M-x gnus
964 @findex gnus
965 If your system administrator has set things up properly, starting Gnus
966 and reading news is extremely easy---you just type @kbd{M-x gnus} in
967 your Emacs. If not, you should customize the variable
968 @code{gnus-select-method} as described in @ref{Finding the News}. For a
969 minimal setup for posting should also customize the variables
970 @code{user-full-name} and @code{user-mail-address}.
971
972 @findex gnus-other-frame
973 @kindex M-x gnus-other-frame
974 If you want to start Gnus in a different frame, you can use the command
975 @kbd{M-x gnus-other-frame} instead.
976
977 If things do not go smoothly at startup, you have to twiddle some
978 variables in your @file{~/.gnus.el} file. This file is similar to
979 @file{~/.emacs}, but is read when Gnus starts.
980
981 If you puzzle at any terms used in this manual, please refer to the
982 terminology section (@pxref{Terminology}).
983
984 @menu
985 * Finding the News:: Choosing a method for getting news.
986 * The Server is Down:: How can I read my mail then?
987 * Slave Gnusae:: You can have more than one Gnus active at a time.
988 * New Groups:: What is Gnus supposed to do with new groups?
989 * Changing Servers:: You may want to move from one server to another.
990 * Startup Files:: Those pesky startup files---@file{.newsrc}.
991 * Auto Save:: Recovering from a crash.
992 * The Active File:: Reading the active file over a slow line Takes Time.
993 * Startup Variables:: Other variables you might change.
994 @end menu
995
996
997 @node Finding the News
998 @section Finding the News
999 @cindex finding news
1000
1001 First of all, you should know that there is a special buffer called
1002 @file{*Server*} that lists all the servers Gnus knows about. You can
1003 press @kbd{^} from the Group buffer to see it. In the Server buffer,
1004 you can press @kbd{RET} on a defined server to see all the groups it
1005 serves (subscribed or not!). You can also add or delete servers, edit
1006 a foreign server's definition, agentize or de-agentize a server, and
1007 do many other neat things. @xref{Server Buffer}.
1008 @xref{Foreign Groups}. @xref{Agent Basics}.
1009
1010 @vindex gnus-select-method
1011 @c @head
1012 The @code{gnus-select-method} variable says where Gnus should look for
1013 news. This variable should be a list where the first element says
1014 @dfn{how} and the second element says @dfn{where}. This method is your
1015 native method. All groups not fetched with this method are
1016 secondary or foreign groups.
1017
1018 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1019 you want to get your daily dosage of news from, you'd say:
1020
1021 @lisp
1022 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1023 @end lisp
1024
1025 If you want to read directly from the local spool, say:
1026
1027 @lisp
1028 (setq gnus-select-method '(nnspool ""))
1029 @end lisp
1030
1031 If you can use a local spool, you probably should, as it will almost
1032 certainly be much faster. But do not use the local spool if your
1033 server is running Leafnode (which is a simple, standalone private news
1034 server); in this case, use @code{(nntp "localhost")}.
1035
1036 @vindex gnus-nntpserver-file
1037 @cindex NNTPSERVER
1038 @cindex @acronym{NNTP} server
1039 If this variable is not set, Gnus will take a look at the
1040 @env{NNTPSERVER} environment variable. If that variable isn't set,
1041 Gnus will see whether @code{gnus-nntpserver-file}
1042 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1043 If that fails as well, Gnus will try to use the machine running Emacs
1044 as an @acronym{NNTP} server. That's a long shot, though.
1045
1046 @findex gnus-group-browse-foreign-server
1047 @kindex B (Group)
1048 However, if you use one @acronym{NNTP} server regularly and are just
1049 interested in a couple of groups from a different server, you would be
1050 better served by using the @kbd{B} command in the group buffer. It will
1051 let you have a look at what groups are available, and you can subscribe
1052 to any of the groups you want to. This also makes @file{.newsrc}
1053 maintenance much tidier. @xref{Foreign Groups}.
1054
1055 @vindex gnus-secondary-select-methods
1056 @c @head
1057 A slightly different approach to foreign groups is to set the
1058 @code{gnus-secondary-select-methods} variable. The select methods
1059 listed in this variable are in many ways just as native as the
1060 @code{gnus-select-method} server. They will also be queried for active
1061 files during startup (if that's required), and new newsgroups that
1062 appear on these servers will be subscribed (or not) just as native
1063 groups are.
1064
1065 For instance, if you use the @code{nnmbox} back end to read your mail,
1066 you would typically set this variable to
1067
1068 @lisp
1069 (setq gnus-secondary-select-methods '((nnmbox "")))
1070 @end lisp
1071
1072
1073
1074 @node The Server is Down
1075 @section The Server is Down
1076 @cindex server errors
1077
1078 If the default server is down, Gnus will understandably have some
1079 problems starting. However, if you have some mail groups in addition to
1080 the news groups, you may want to start Gnus anyway.
1081
1082 Gnus, being the trusting sort of program, will ask whether to proceed
1083 without a native select method if that server can't be contacted. This
1084 will happen whether the server doesn't actually exist (i.e., you have
1085 given the wrong address) or the server has just momentarily taken ill
1086 for some reason or other. If you decide to continue and have no foreign
1087 groups, you'll find it difficult to actually do anything in the group
1088 buffer. But, hey, that's your problem. Blllrph!
1089
1090 @findex gnus-no-server
1091 @kindex M-x gnus-no-server
1092 @c @head
1093 If you know that the server is definitely down, or you just want to read
1094 your mail without bothering with the server at all, you can use the
1095 @code{gnus-no-server} command to start Gnus. That might come in handy
1096 if you're in a hurry as well. This command will not attempt to contact
1097 your primary server---instead, it will just activate all groups on level
1098 1 and 2. (You should preferably keep no native groups on those two
1099 levels.) Also @pxref{Group Levels}.
1100
1101
1102 @node Slave Gnusae
1103 @section Slave Gnusae
1104 @cindex slave
1105
1106 You might want to run more than one Emacs with more than one Gnus at the
1107 same time. If you are using different @file{.newsrc} files (e.g., if you
1108 are using the two different Gnusae to read from two different servers),
1109 that is no problem whatsoever. You just do it.
1110
1111 The problem appears when you want to run two Gnusae that use the same
1112 @file{.newsrc} file.
1113
1114 To work around that problem some, we here at the Think-Tank at the Gnus
1115 Towers have come up with a new concept: @dfn{Masters} and
1116 @dfn{slaves}. (We have applied for a patent on this concept, and have
1117 taken out a copyright on those words. If you wish to use those words in
1118 conjunction with each other, you have to send $1 per usage instance to
1119 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1120 Applications}) will be much more expensive, of course.)
1121
1122 @findex gnus-slave
1123 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1124 however you do it). Each subsequent slave Gnusae should be started with
1125 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1126 files, but instead save @dfn{slave files} that contain information only
1127 on what groups have been read in the slave session. When a master Gnus
1128 starts, it will read (and delete) these slave files, incorporating all
1129 information from them. (The slave files will be read in the sequence
1130 they were created, so the latest changes will have precedence.)
1131
1132 Information from the slave files has, of course, precedence over the
1133 information in the normal (i.e., master) @file{.newsrc} file.
1134
1135 If the @file{.newsrc*} files have not been saved in the master when the
1136 slave starts, you may be prompted as to whether to read an auto-save
1137 file. If you answer ``yes'', the unsaved changes to the master will be
1138 incorporated into the slave. If you answer ``no'', the slave may see some
1139 messages as unread that have been read in the master.
1140
1141
1142
1143 @node New Groups
1144 @section New Groups
1145 @cindex new groups
1146 @cindex subscription
1147
1148 @vindex gnus-check-new-newsgroups
1149 If you are satisfied that you really never want to see any new groups,
1150 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1151 also save you some time at startup. Even if this variable is
1152 @code{nil}, you can always subscribe to the new groups just by pressing
1153 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1154 is @code{ask-server} by default. If you set this variable to
1155 @code{always}, then Gnus will query the back ends for new groups even
1156 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1157
1158 @menu
1159 * Checking New Groups:: Determining what groups are new.
1160 * Subscription Methods:: What Gnus should do with new groups.
1161 * Filtering New Groups:: Making Gnus ignore certain new groups.
1162 @end menu
1163
1164
1165 @node Checking New Groups
1166 @subsection Checking New Groups
1167
1168 Gnus normally determines whether a group is new or not by comparing
1169 the list of groups from the active file(s) with the lists of
1170 subscribed and dead groups. This isn't a particularly fast method.
1171 If @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will
1172 ask the server for new groups since the last time. This is both
1173 faster and cheaper. This also means that you can get rid of the list
1174 of killed groups (@pxref{Group Levels}) altogether, so you may set
1175 @code{gnus-save-killed-list} to @code{nil}, which will save time both
1176 at startup, at exit, and all over. Saves disk space, too. Why isn't
1177 this the default, then? Unfortunately, not all servers support this
1178 command.
1179
1180 I bet I know what you're thinking now: How do I find out whether my
1181 server supports @code{ask-server}? No? Good, because I don't have a
1182 fail-safe answer. I would suggest just setting this variable to
1183 @code{ask-server} and see whether any new groups appear within the next
1184 few days. If any do, then it works. If none do, then it doesn't
1185 work. I could write a function to make Gnus guess whether the server
1186 supports @code{ask-server}, but it would just be a guess. So I won't.
1187 You could @code{telnet} to the server and say @code{HELP} and see
1188 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1189 it does, then it might work. (But there are servers that lists
1190 @samp{NEWGROUPS} without supporting the function properly.)
1191
1192 This variable can also be a list of select methods. If so, Gnus will
1193 issue an @code{ask-server} command to each of the select methods, and
1194 subscribe them (or not) using the normal methods. This might be handy
1195 if you are monitoring a few servers for new groups. A side effect is
1196 that startup will take much longer, so you can meditate while waiting.
1197 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1198
1199
1200 @node Subscription Methods
1201 @subsection Subscription Methods
1202
1203 @vindex gnus-subscribe-newsgroup-method
1204 What Gnus does when it encounters a new group is determined by the
1205 @code{gnus-subscribe-newsgroup-method} variable.
1206
1207 This variable should contain a function. This function will be called
1208 with the name of the new group as the only parameter.
1209
1210 Some handy pre-fab functions are:
1211
1212 @table @code
1213
1214 @item gnus-subscribe-zombies
1215 @vindex gnus-subscribe-zombies
1216 Make all new groups zombies (@pxref{Group Levels}). This is the
1217 default. You can browse the zombies later (with @kbd{A z}) and either
1218 kill them all off properly (with @kbd{S z}), or subscribe to them
1219 (with @kbd{u}).
1220
1221 @item gnus-subscribe-randomly
1222 @vindex gnus-subscribe-randomly
1223 Subscribe all new groups in arbitrary order. This really means that all
1224 new groups will be added at ``the top'' of the group buffer.
1225
1226 @item gnus-subscribe-alphabetically
1227 @vindex gnus-subscribe-alphabetically
1228 Subscribe all new groups in alphabetical order.
1229
1230 @item gnus-subscribe-hierarchically
1231 @vindex gnus-subscribe-hierarchically
1232 Subscribe all new groups hierarchically. The difference between this
1233 function and @code{gnus-subscribe-alphabetically} is slight.
1234 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1235 alphabetical fashion, while this function will enter groups into its
1236 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1237 @samp{comp} hierarchy, this function will not mess that configuration
1238 up. Or something like that.
1239
1240 @item gnus-subscribe-interactively
1241 @vindex gnus-subscribe-interactively
1242 Subscribe new groups interactively. This means that Gnus will ask
1243 you about @strong{all} new groups. The groups you choose to subscribe
1244 to will be subscribed hierarchically.
1245
1246 @item gnus-subscribe-killed
1247 @vindex gnus-subscribe-killed
1248 Kill all new groups.
1249
1250 @item gnus-subscribe-topics
1251 @vindex gnus-subscribe-topics
1252 Put the groups into the topic that has a matching @code{subscribe} topic
1253 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1254 topic parameter that looks like
1255
1256 @example
1257 "nnml"
1258 @end example
1259
1260 will mean that all groups that match that regex will be subscribed under
1261 that topic.
1262
1263 If no topics match the groups, the groups will be subscribed in the
1264 top-level topic.
1265
1266 @end table
1267
1268 @vindex gnus-subscribe-hierarchical-interactive
1269 A closely related variable is
1270 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1271 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1272 hierarchical fashion whether to subscribe to new groups or not. Gnus
1273 will ask you for each sub-hierarchy whether you want to descend the
1274 hierarchy or not.
1275
1276 One common mistake is to set the variable a few paragraphs above
1277 (@code{gnus-subscribe-newsgroup-method}) to
1278 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1279 will not work. This is ga-ga. So don't do it.
1280
1281
1282 @node Filtering New Groups
1283 @subsection Filtering New Groups
1284
1285 A nice and portable way to control which new newsgroups should be
1286 subscribed (or ignored) is to put an @dfn{options} line at the start of
1287 the @file{.newsrc} file. Here's an example:
1288
1289 @example
1290 options -n !alt.all !rec.all sci.all
1291 @end example
1292
1293 @vindex gnus-subscribe-options-newsgroup-method
1294 This line obviously belongs to a serious-minded intellectual scientific
1295 person (or she may just be plain old boring), because it says that all
1296 groups that have names beginning with @samp{alt} and @samp{rec} should
1297 be ignored, and all groups with names beginning with @samp{sci} should
1298 be subscribed. Gnus will not use the normal subscription method for
1299 subscribing these groups.
1300 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1301 variable defaults to @code{gnus-subscribe-alphabetically}.
1302
1303 The ``options -n'' format is very simplistic. The syntax above is all
1304 that is supports: you can force-subscribe hierarchies, or you can
1305 deny hierarchies, and that's it.
1306
1307 @vindex gnus-options-not-subscribe
1308 @vindex gnus-options-subscribe
1309 If you don't want to mess with your @file{.newsrc} file, you can just
1310 set the two variables @code{gnus-options-subscribe} and
1311 @code{gnus-options-not-subscribe}. These two variables do exactly the
1312 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1313 and if the new group matches the former, it will be unconditionally
1314 subscribed, and if it matches the latter, it will be ignored.
1315
1316 @vindex gnus-auto-subscribed-groups
1317 Yet another variable that meddles here is
1318 @code{gnus-auto-subscribed-groups}. It works exactly like
1319 @code{gnus-options-subscribe}, and is therefore really superfluous,
1320 but I thought it would be nice to have two of these. This variable is
1321 more meant for setting some ground rules, while the other variable is
1322 used more for user fiddling. By default this variable makes all new
1323 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1324 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, @code{nnimap}, and
1325 @code{nnmaildir}) subscribed. If you don't like that, just set this
1326 variable to @code{nil}.
1327
1328 @vindex gnus-auto-subscribed-categories
1329 As if that wasn't enough, @code{gnus-auto-subscribed-categories} also
1330 allows you to specify that new groups should be subscribed based on the
1331 category their select methods belong to. The default is @samp{(mail
1332 post-mail)}, meaning that all new groups from mail-like backends
1333 should be subscribed automatically.
1334
1335 New groups that match these variables are subscribed using
1336 @code{gnus-subscribe-options-newsgroup-method}.
1337
1338
1339 @node Changing Servers
1340 @section Changing Servers
1341 @cindex changing servers
1342
1343 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1344 This happens very rarely, but perhaps you change jobs, or one server is
1345 very flaky and you want to use another.
1346
1347 Changing the server is pretty easy, right? You just change
1348 @code{gnus-select-method} to point to the new server?
1349
1350 @emph{Wrong!}
1351
1352 Article numbers are not (in any way) kept synchronized between different
1353 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1354 you have read is by keeping track of article numbers. So when you
1355 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1356 worthless.
1357
1358 @kindex M-x gnus-group-clear-data-on-native-groups
1359 @findex gnus-group-clear-data-on-native-groups
1360 You can use the @kbd{M-x gnus-group-clear-data-on-native-groups}
1361 command to clear out all data that you have on your native groups.
1362 Use with caution.
1363
1364 @kindex M-x gnus-group-clear-data
1365 @findex gnus-group-clear-data
1366 Clear the data from the current group only---nix out marks and the
1367 list of read articles (@code{gnus-group-clear-data}).
1368
1369 After changing servers, you @strong{must} move the cache hierarchy away,
1370 since the cached articles will have wrong article numbers, which will
1371 affect which articles Gnus thinks are read.
1372 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1373 to have it done automatically; for @code{gnus-group-clear-data}, you
1374 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1375 cache for all groups).
1376
1377
1378 @node Startup Files
1379 @section Startup Files
1380 @cindex startup files
1381 @cindex .newsrc
1382 @cindex .newsrc.el
1383 @cindex .newsrc.eld
1384
1385 Most common Unix news readers use a shared startup file called
1386 @file{.newsrc}. This file contains all the information about what
1387 groups are subscribed, and which articles in these groups have been
1388 read.
1389
1390 Things got a bit more complicated with @sc{gnus}. In addition to
1391 keeping the @file{.newsrc} file updated, it also used a file called
1392 @file{.newsrc.el} for storing all the information that didn't fit into
1393 the @file{.newsrc} file. (Actually, it also duplicated everything in
1394 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1395 files was the most recently saved, which enabled people to swap between
1396 @sc{gnus} and other newsreaders.
1397
1398 That was kinda silly, so Gnus went one better: In addition to the
1399 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1400 @file{.newsrc.eld}. It will read whichever of these files that are most
1401 recent, but it will never write a @file{.newsrc.el} file. You should
1402 never delete the @file{.newsrc.eld} file---it contains much information
1403 not stored in the @file{.newsrc} file.
1404
1405 @vindex gnus-save-newsrc-file
1406 @vindex gnus-read-newsrc-file
1407 You can turn off writing the @file{.newsrc} file by setting
1408 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1409 the file and save some space, as well as exiting from Gnus faster.
1410 However, this will make it impossible to use other newsreaders than
1411 Gnus. But hey, who would want to, right? Similarly, setting
1412 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1413 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1414 convenient if you use a different news reader occasionally, and you
1415 want to read a different subset of the available groups with that
1416 news reader.
1417
1418 @vindex gnus-save-killed-list
1419 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1420 will not save the list of killed groups to the startup file. This will
1421 save both time (when starting and quitting) and space (on disk). It
1422 will also mean that Gnus has no record of what groups are new or old,
1423 so the automatic new groups subscription methods become meaningless.
1424 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1425 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1426 Groups}). This variable can also be a regular expression. If that's
1427 the case, remove all groups that do not match this regexp before
1428 saving. This can be useful in certain obscure situations that involve
1429 several servers where not all servers support @code{ask-server}.
1430
1431 @vindex gnus-startup-file
1432 @vindex gnus-backup-startup-file
1433 @vindex version-control
1434 The @code{gnus-startup-file} variable says where the startup files are.
1435 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1436 file being whatever that one is, with a @samp{.eld} appended.
1437 If you want to keep multiple numbered backups of this file, set
1438 @code{gnus-backup-startup-file}. It respects the same values as the
1439 @code{version-control} variable.
1440
1441 @vindex gnus-save-newsrc-hook
1442 @vindex gnus-save-quick-newsrc-hook
1443 @vindex gnus-save-standard-newsrc-hook
1444 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1445 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1446 saving the @file{.newsrc.eld} file, and
1447 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1448 @file{.newsrc} file. The latter two are commonly used to turn version
1449 control on or off. Version control is on by default when saving the
1450 startup files. If you want to turn backup creation off, say something like:
1451
1452 @lisp
1453 (defun turn-off-backup ()
1454 (set (make-local-variable 'backup-inhibited) t))
1455
1456 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1457 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1458 @end lisp
1459
1460 @vindex gnus-init-file
1461 @vindex gnus-site-init-file
1462 When Gnus starts, it will read the @code{gnus-site-init-file}
1463 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1464 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1465 and can be used to avoid cluttering your @file{~/.emacs} and
1466 @file{site-init} files with Gnus stuff. Gnus will also check for files
1467 with the same names as these, but with @file{.elc} and @file{.el}
1468 suffixes. In other words, if you have set @code{gnus-init-file} to
1469 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1470 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1471 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1472 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1473 @code{gnus-init-file}.
1474
1475
1476 @node Auto Save
1477 @section Auto Save
1478 @cindex dribble file
1479 @cindex auto-save
1480
1481 Whenever you do something that changes the Gnus data (reading articles,
1482 catching up, killing/subscribing groups), the change is added to a
1483 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1484 Emacs way. If your Emacs should crash before you have saved the
1485 @file{.newsrc} files, all changes you have made can be recovered from
1486 this file.
1487
1488 If Gnus detects this file at startup, it will ask the user whether to
1489 read it. The auto save file is deleted whenever the real startup file is
1490 saved.
1491
1492 @vindex gnus-use-dribble-file
1493 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1494 maintain a dribble buffer. The default is @code{t}.
1495
1496 @vindex gnus-dribble-directory
1497 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1498 this variable is @code{nil}, which it is by default, Gnus will dribble
1499 into the directory where the @file{.newsrc} file is located. (This is
1500 normally the user's home directory.) The dribble file will get the same
1501 file permissions as the @file{.newsrc} file.
1502
1503 @vindex gnus-always-read-dribble-file
1504 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1505 read the dribble file on startup without querying the user.
1506
1507
1508 @node The Active File
1509 @section The Active File
1510 @cindex active file
1511 @cindex ignored groups
1512
1513 When Gnus starts, or indeed whenever it tries to determine whether new
1514 articles have arrived, it reads the active file. This is a very large
1515 file that lists all the active groups and articles on the server.
1516
1517 @vindex gnus-ignored-newsgroups
1518 Before examining the active file, Gnus deletes all lines that match the
1519 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1520 any groups with bogus names, but you can use this variable to make Gnus
1521 ignore hierarchies you aren't ever interested in. However, this is not
1522 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1523 Groups} for an overview of other variables that can be used instead.
1524
1525 @c This variable is
1526 @c @code{nil} by default, and will slow down active file handling somewhat
1527 @c if you set it to anything else.
1528
1529 @vindex gnus-read-active-file
1530 @c @head
1531 The active file can be rather Huge, so if you have a slow network, you
1532 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1533 reading the active file. This variable is @code{some} by default.
1534
1535 Gnus will try to make do by getting information just on the groups that
1536 you actually subscribe to.
1537
1538 Note that if you subscribe to lots and lots of groups, setting this
1539 variable to @code{nil} will probably make Gnus slower, not faster. At
1540 present, having this variable @code{nil} will slow Gnus down
1541 considerably, unless you read news over a 2400 baud modem.
1542
1543 This variable can also have the value @code{some}. Gnus will then
1544 attempt to read active info only on the subscribed groups. On some
1545 servers this is quite fast (on sparkling, brand new INN servers that
1546 support the @code{LIST ACTIVE group} command), on others this isn't fast
1547 at all. In any case, @code{some} should be faster than @code{nil}, and
1548 is certainly faster than @code{t} over slow lines.
1549
1550 Some news servers (old versions of Leafnode and old versions of INN, for
1551 instance) do not support the @code{LIST ACTIVE group}. For these
1552 servers, @code{nil} is probably the most efficient value for this
1553 variable.
1554
1555 If this variable is @code{nil}, Gnus will ask for group info in total
1556 lock-step, which isn't very fast. If it is @code{some} and you use an
1557 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1558 read all the replies in one swoop. This will normally result in better
1559 performance, but if the server does not support the aforementioned
1560 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1561
1562 If you think that starting up Gnus takes too long, try all the three
1563 different values for this variable and see what works best for you.
1564
1565 In any case, if you use @code{some} or @code{nil}, you should definitely
1566 kill all groups that you aren't interested in to speed things up.
1567
1568 Note that this variable also affects active file retrieval from
1569 secondary select methods.
1570
1571
1572 @node Startup Variables
1573 @section Startup Variables
1574
1575 @table @code
1576
1577 @item gnus-load-hook
1578 @vindex gnus-load-hook
1579 A hook run while Gnus is being loaded. Note that this hook will
1580 normally be run just once in each Emacs session, no matter how many
1581 times you start Gnus.
1582
1583 @item gnus-before-startup-hook
1584 @vindex gnus-before-startup-hook
1585 A hook called as the first thing when Gnus is started.
1586
1587 @item gnus-before-resume-hook
1588 @vindex gnus-before-resume-hook
1589 A hook called as the first thing when Gnus is resumed after a suspend.
1590
1591 @item gnus-startup-hook
1592 @vindex gnus-startup-hook
1593 A hook run as the very last thing after starting up Gnus
1594
1595 @item gnus-started-hook
1596 @vindex gnus-started-hook
1597 A hook that is run as the very last thing after starting up Gnus
1598 successfully.
1599
1600 @item gnus-setup-news-hook
1601 @vindex gnus-setup-news-hook
1602 A hook that is run after reading the @file{.newsrc} file(s), but before
1603 generating the group buffer.
1604
1605 @item gnus-check-bogus-newsgroups
1606 @vindex gnus-check-bogus-newsgroups
1607 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1608 startup. A @dfn{bogus group} is a group that you have in your
1609 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1610 bogus groups can take quite a while, so to save time and resources it's
1611 best to leave this option off, and do the checking for bogus groups once
1612 in a while from the group buffer instead (@pxref{Group Maintenance}).
1613
1614 @item gnus-inhibit-startup-message
1615 @vindex gnus-inhibit-startup-message
1616 If non-@code{nil}, the startup message won't be displayed. That way,
1617 your boss might not notice as easily that you are reading news instead
1618 of doing your job. Note that this variable is used before
1619 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1620
1621 @item gnus-no-groups-message
1622 @vindex gnus-no-groups-message
1623 Message displayed by Gnus when no groups are available.
1624
1625 @item gnus-use-backend-marks
1626 @vindex gnus-use-backend-marks
1627 If non-@code{nil}, Gnus will store article marks both in the
1628 @file{.newsrc.eld} file and in the backends. This will slow down
1629 group operation some.
1630
1631 @end table
1632
1633
1634 @node Group Buffer
1635 @chapter Group Buffer
1636 @cindex group buffer
1637
1638 @c Alex Schroeder suggests to rearrange this as follows:
1639 @c
1640 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1641 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1642 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1643 @c 7. Group Score, 8. Group Buffer Format
1644 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1645 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1646 @c <kensanata> First, "Gnus considers groups... (default 9)."
1647 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1648 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1649 @c <kensanata> Then expand the next paragraph or add some more to it.
1650 @c This short one sentence explains levels 1 and 2, therefore I understand
1651 @c that I should keep important news at 3 and boring news at 4.
1652 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1653 @c Maybe keep those that you don't want to read temporarily at 6,
1654 @c those that you never want to read at 8, those that offend your
1655 @c human rights at 9...
1656
1657
1658 The @dfn{group buffer} lists all (or parts) of the available groups. It
1659 is the first buffer shown when Gnus starts, and will never be killed as
1660 long as Gnus is active.
1661
1662 @iftex
1663 @iflatex
1664 \gnusfigure{The Group Buffer}{320}{
1665 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1666 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1667 \put(120,38){\vector(1,2){10}}
1668 \put(40,60){\makebox(0,0)[r]{Mode line}}
1669 \put(40,58){\vector(1,0){30}}
1670 \put(200,28){\makebox(0,0)[t]{Native select method}}
1671 \put(200,26){\vector(-1,2){15}}
1672 }
1673 @end iflatex
1674 @end iftex
1675
1676 @menu
1677 * Group Buffer Format:: Information listed and how you can change it.
1678 * Group Maneuvering:: Commands for moving in the group buffer.
1679 * Selecting a Group:: Actually reading news.
1680 * Subscription Commands:: Unsubscribing, killing, subscribing.
1681 * Group Data:: Changing the info for a group.
1682 * Group Levels:: Levels? What are those, then?
1683 * Group Score:: A mechanism for finding out what groups you like.
1684 * Marking Groups:: You can mark groups for later processing.
1685 * Foreign Groups:: Creating and editing groups.
1686 * Group Parameters:: Each group may have different parameters set.
1687 * Listing Groups:: Gnus can list various subsets of the groups.
1688 * Sorting Groups:: Re-arrange the group order.
1689 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1690 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1691 * Exiting Gnus:: Stop reading news and get some work done.
1692 * Group Topics:: A folding group mode divided into topics.
1693 * Non-ASCII Group Names:: Accessing groups of non-English names.
1694 * Misc Group Stuff:: Other stuff that you can to do.
1695 @end menu
1696
1697
1698 @node Group Buffer Format
1699 @section Group Buffer Format
1700
1701 @menu
1702 * Group Line Specification:: Deciding how the group buffer is to look.
1703 * Group Mode Line Specification:: The group buffer mode line.
1704 * Group Highlighting:: Having nice colors in the group buffer.
1705 @end menu
1706
1707 You can customize the Group Mode tool bar, see @kbd{M-x
1708 customize-apropos RET gnus-group-tool-bar}. This feature is only
1709 available in Emacs.
1710
1711 The tool bar icons are now (de)activated correctly depending on the
1712 cursor position. Therefore, moving around in the Group Buffer is
1713 slower. You can disable this via the variable
1714 @code{gnus-group-update-tool-bar}. Its default value depends on your
1715 Emacs version.
1716
1717 @node Group Line Specification
1718 @subsection Group Line Specification
1719 @cindex group buffer format
1720
1721 The default format of the group buffer is nice and dull, but you can
1722 make it as exciting and ugly as you feel like.
1723
1724 Here's a couple of example group lines:
1725
1726 @example
1727 25: news.announce.newusers
1728 * 0: alt.fan.andrea-dworkin
1729 @end example
1730
1731 Quite simple, huh?
1732
1733 You can see that there are 25 unread articles in
1734 @samp{news.announce.newusers}. There are no unread articles, but some
1735 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1736 asterisk at the beginning of the line?).
1737
1738 @vindex gnus-group-line-format
1739 You can change that format to whatever you want by fiddling with the
1740 @code{gnus-group-line-format} variable. This variable works along the
1741 lines of a @code{format} specification, which is pretty much the same as
1742 a @code{printf} specifications, for those of you who use (feh!) C@.
1743 @xref{Formatting Variables}.
1744
1745 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1746
1747 There should always be a colon on the line; the cursor always moves to
1748 the colon after performing an operation. @xref{Positioning
1749 Point}. Nothing else is required---not even the group name. All
1750 displayed text is just window dressing, and is never examined by Gnus.
1751 Gnus stores all real information it needs using text properties.
1752
1753 (Note that if you make a really strange, wonderful, spreadsheet-like
1754 layout, everybody will believe you are hard at work with the accounting
1755 instead of wasting time reading news.)
1756
1757 Here's a list of all available format characters:
1758
1759 @table @samp
1760
1761 @item M
1762 An asterisk if the group only has marked articles.
1763
1764 @item S
1765 Whether the group is subscribed.
1766
1767 @item L
1768 Level of subscribedness.
1769
1770 @item N
1771 Number of unread articles.
1772
1773 @item I
1774 Number of dormant articles.
1775
1776 @item T
1777 Number of ticked articles.
1778
1779 @item R
1780 Number of read articles.
1781
1782 @item U
1783 Number of unseen articles.
1784
1785 @item t
1786 Estimated total number of articles. (This is really @var{max-number}
1787 minus @var{min-number} plus 1.)
1788
1789 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1790 efficient access to @var{max-number} and @var{min-number} but getting
1791 the true unread message count is not possible efficiently. For
1792 hysterical raisins, even the mail back ends, where the true number of
1793 unread messages might be available efficiently, use the same limited
1794 interface. To remove this restriction from Gnus means that the back
1795 end interface has to be changed, which is not an easy job.
1796
1797 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1798 compaction'' which circumvents this deficiency: the idea is to
1799 renumber all articles from 1, removing all gaps between numbers, hence
1800 getting a correct total count. Other backends may support this in the
1801 future. In order to keep your total article count relatively up to
1802 date, you might want to compact your groups (or even directly your
1803 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1804
1805 @item y
1806 Number of unread, unticked, non-dormant articles.
1807
1808 @item i
1809 Number of ticked and dormant articles.
1810
1811 @item g
1812 Full group name.
1813
1814 @item G
1815 Group name.
1816
1817 @item C
1818 Group comment (@pxref{Group Parameters}) or group name if there is no
1819 comment element in the group parameters.
1820
1821 @item D
1822 Newsgroup description. You need to read the group descriptions
1823 before these will appear, and to do that, you either have to set
1824 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1825 command.
1826
1827 @item o
1828 @samp{m} if moderated.
1829
1830 @item O
1831 @samp{(m)} if moderated.
1832
1833 @item s
1834 Select method.
1835
1836 @item B
1837 If the summary buffer for the group is open or not.
1838
1839 @item n
1840 Select from where.
1841
1842 @item z
1843 A string that looks like @samp{<%s:%n>} if a foreign select method is
1844 used.
1845
1846 @item P
1847 Indentation based on the level of the topic (@pxref{Group Topics}).
1848
1849 @item c
1850 @vindex gnus-group-uncollapsed-levels
1851 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1852 variable says how many levels to leave at the end of the group name.
1853 The default is 1---this will mean that group names like
1854 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1855
1856 @item m
1857 @vindex gnus-new-mail-mark
1858 @cindex %
1859 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1860 the group lately.
1861
1862 @item p
1863 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1864
1865 @item d
1866 A string that says when you last read the group (@pxref{Group
1867 Timestamp}).
1868
1869 @item F
1870 The disk space used by the articles fetched by both the cache and
1871 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1872 megabytes(M), or gigabytes(G) to minimize the column width. A format
1873 of %7F is sufficient for a fixed-width column.
1874
1875 @item u
1876 User defined specifier. The next character in the format string should
1877 be a letter. Gnus will call the function
1878 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1879 following @samp{%u}. The function will be passed a single dummy
1880 parameter as argument. The function should return a string, which will
1881 be inserted into the buffer just like information from any other
1882 specifier.
1883 @end table
1884
1885 @cindex *
1886 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1887 if no info is available---for instance, if it is a non-activated foreign
1888 group, or a bogus native group.
1889
1890
1891 @node Group Mode Line Specification
1892 @subsection Group Mode Line Specification
1893 @cindex group mode line
1894
1895 @vindex gnus-group-mode-line-format
1896 The mode line can be changed by setting
1897 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1898 doesn't understand that many format specifiers:
1899
1900 @table @samp
1901 @item S
1902 The native news server.
1903 @item M
1904 The native select method.
1905 @end table
1906
1907
1908 @node Group Highlighting
1909 @subsection Group Highlighting
1910 @cindex highlighting
1911 @cindex group highlighting
1912
1913 @vindex gnus-group-highlight
1914 Highlighting in the group buffer is controlled by the
1915 @code{gnus-group-highlight} variable. This is an alist with elements
1916 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1917 something non-@code{nil}, the @var{face} will be used on the line.
1918
1919 Here's an example value for this variable that might look nice if the
1920 background is dark:
1921
1922 @lisp
1923 (cond (window-system
1924 (setq custom-background-mode 'light)
1925 (defface my-group-face-1
1926 '((t (:foreground "Red" :bold t))) "First group face")
1927 (defface my-group-face-2
1928 '((t (:foreground "DarkSeaGreen4" :bold t)))
1929 "Second group face")
1930 (defface my-group-face-3
1931 '((t (:foreground "Green4" :bold t))) "Third group face")
1932 (defface my-group-face-4
1933 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1934 (defface my-group-face-5
1935 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1936
1937 (setq gnus-group-highlight
1938 '(((> unread 200) . my-group-face-1)
1939 ((and (< level 3) (zerop unread)) . my-group-face-2)
1940 ((< level 3) . my-group-face-3)
1941 ((zerop unread) . my-group-face-4)
1942 (t . my-group-face-5)))
1943 @end lisp
1944
1945 Also @pxref{Faces and Fonts}.
1946
1947 Variables that are dynamically bound when the forms are evaluated
1948 include:
1949
1950 @table @code
1951 @item group
1952 The group name.
1953 @item unread
1954 The number of unread articles in the group.
1955 @item method
1956 The select method.
1957 @item mailp
1958 Whether the group is a mail group.
1959 @item level
1960 The level of the group.
1961 @item score
1962 The score of the group.
1963 @item ticked
1964 The number of ticked articles in the group.
1965 @item total
1966 The total number of articles in the group. Or rather,
1967 @var{max-number} minus @var{min-number} plus one.
1968 @item topic
1969 When using the topic minor mode, this variable is bound to the current
1970 topic being inserted.
1971 @end table
1972
1973 When the forms are @code{eval}ed, point is at the beginning of the line
1974 of the group in question, so you can use many of the normal Gnus
1975 functions for snarfing info on the group.
1976
1977 @vindex gnus-group-update-hook
1978 @findex gnus-group-highlight-line
1979 @code{gnus-group-update-hook} is called when a group line is changed.
1980 It will not be called when @code{gnus-visual} is @code{nil}.
1981
1982
1983 @node Group Maneuvering
1984 @section Group Maneuvering
1985 @cindex group movement
1986
1987 All movement commands understand the numeric prefix and will behave as
1988 expected, hopefully.
1989
1990 @table @kbd
1991
1992 @item n
1993 @kindex n (Group)
1994 @findex gnus-group-next-unread-group
1995 Go to the next group that has unread articles
1996 (@code{gnus-group-next-unread-group}).
1997
1998 @item p
1999 @itemx DEL
2000 @kindex DEL (Group)
2001 @kindex p (Group)
2002 @findex gnus-group-prev-unread-group
2003 Go to the previous group that has unread articles
2004 (@code{gnus-group-prev-unread-group}).
2005
2006 @item N
2007 @kindex N (Group)
2008 @findex gnus-group-next-group
2009 Go to the next group (@code{gnus-group-next-group}).
2010
2011 @item P
2012 @kindex P (Group)
2013 @findex gnus-group-prev-group
2014 Go to the previous group (@code{gnus-group-prev-group}).
2015
2016 @item M-n
2017 @kindex M-n (Group)
2018 @findex gnus-group-next-unread-group-same-level
2019 Go to the next unread group on the same (or lower) level
2020 (@code{gnus-group-next-unread-group-same-level}).
2021
2022 @item M-p
2023 @kindex M-p (Group)
2024 @findex gnus-group-prev-unread-group-same-level
2025 Go to the previous unread group on the same (or lower) level
2026 (@code{gnus-group-prev-unread-group-same-level}).
2027 @end table
2028
2029 Three commands for jumping to groups:
2030
2031 @table @kbd
2032
2033 @item j
2034 @kindex j (Group)
2035 @findex gnus-group-jump-to-group
2036 Jump to a group (and make it visible if it isn't already)
2037 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2038 like living groups.
2039
2040 @item ,
2041 @kindex , (Group)
2042 @findex gnus-group-best-unread-group
2043 Jump to the unread group with the lowest level
2044 (@code{gnus-group-best-unread-group}).
2045
2046 @item .
2047 @kindex . (Group)
2048 @findex gnus-group-first-unread-group
2049 Jump to the first group with unread articles
2050 (@code{gnus-group-first-unread-group}).
2051 @end table
2052
2053 @vindex gnus-group-goto-unread
2054 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2055 commands will move to the next group, not the next unread group. Even
2056 the commands that say they move to the next unread group. The default
2057 is @code{t}.
2058
2059 @vindex gnus-summary-next-group-on-exit
2060 If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is
2061 exited, the point in the group buffer is moved to the next unread group.
2062 Otherwise, the point is set to the group just exited. The default is
2063 @code{t}.
2064
2065 @node Selecting a Group
2066 @section Selecting a Group
2067 @cindex group selection
2068
2069 @table @kbd
2070
2071 @item SPACE
2072 @kindex SPACE (Group)
2073 @findex gnus-group-read-group
2074 Select the current group, switch to the summary buffer and display the
2075 first unread article (@code{gnus-group-read-group}). If there are no
2076 unread articles in the group, or if you give a non-numerical prefix to
2077 this command, Gnus will offer to fetch all the old articles in this
2078 group from the server. If you give a numerical prefix @var{n}, @var{n}
2079 determines the number of articles Gnus will fetch. If @var{n} is
2080 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2081 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2082
2083 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2084 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2085 - 4 2 SPC} fetches the 42 oldest ones.
2086
2087 When you are in the group (in the Summary buffer), you can type
2088 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2089 ones.
2090
2091 @item RET
2092 @kindex RET (Group)
2093 @findex gnus-group-select-group
2094 Select the current group and switch to the summary buffer
2095 (@code{gnus-group-select-group}). Takes the same arguments as
2096 @code{gnus-group-read-group}---the only difference is that this command
2097 does not display the first unread article automatically upon group
2098 entry.
2099
2100 @item M-RET
2101 @kindex M-RET (Group)
2102 @findex gnus-group-quick-select-group
2103 This does the same as the command above, but tries to do it with the
2104 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2105 scoring/killing will be performed, there will be no highlights and no
2106 expunging. This might be useful if you're in a real hurry and have to
2107 enter some humongous group. If you give a 0 prefix to this command
2108 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2109 which is useful if you want to toggle threading before generating the
2110 summary buffer (@pxref{Summary Generation Commands}).
2111
2112 @item M-SPACE
2113 @kindex M-SPACE (Group)
2114 @findex gnus-group-visible-select-group
2115 This is yet one more command that does the same as the @kbd{RET}
2116 command, but this one does it without expunging and hiding dormants
2117 (@code{gnus-group-visible-select-group}).
2118
2119 @item C-M-RET
2120 @kindex C-M-RET (Group)
2121 @findex gnus-group-select-group-ephemerally
2122 Finally, this command selects the current group ephemerally without
2123 doing any processing of its contents
2124 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2125 turned off. Everything you do in the group after selecting it in this
2126 manner will have no permanent effects.
2127
2128 @end table
2129
2130 @vindex gnus-large-newsgroup
2131 The @code{gnus-large-newsgroup} variable says what Gnus should
2132 consider to be a big group. If it is @code{nil}, no groups are
2133 considered big. The default value is 200. If the group has more
2134 (unread and/or ticked) articles than this, Gnus will query the user
2135 before entering the group. The user can then specify how many
2136 articles should be fetched from the server. If the user specifies a
2137 negative number (@var{-n}), the @var{n} oldest articles will be
2138 fetched. If it is positive, the @var{n} articles that have arrived
2139 most recently will be fetched.
2140
2141 @vindex gnus-large-ephemeral-newsgroup
2142 @code{gnus-large-ephemeral-newsgroup} is the same as
2143 @code{gnus-large-newsgroup}, but is only used for ephemeral
2144 newsgroups.
2145
2146 @vindex gnus-newsgroup-maximum-articles
2147 In groups in some news servers, there might be a big gap between a few
2148 very old articles that will never be expired and the recent ones. In
2149 such a case, the server will return the data like @code{(1 . 30000000)}
2150 for the @code{LIST ACTIVE group} command, for example. Even if there
2151 are actually only the articles 1--10 and 29999900--30000000, Gnus doesn't
2152 know it at first and prepares for getting 30000000 articles. However,
2153 it will consume hundreds megabytes of memories and might make Emacs get
2154 stuck as the case may be. If you use such news servers, set the
2155 variable @code{gnus-newsgroup-maximum-articles} to a positive number.
2156 The value means that Gnus ignores articles other than this number of the
2157 latest ones in every group. For instance, the value 10000 makes Gnus
2158 get only the articles 29990001--30000000 (if the latest article number is
2159 30000000 in a group). Note that setting this variable to a number might
2160 prevent you from reading very old articles. The default value of the
2161 variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which
2162 means Gnus never ignores old articles.
2163
2164 @vindex gnus-select-group-hook
2165 @vindex gnus-auto-select-first
2166 @vindex gnus-auto-select-subject
2167 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2168 automatically when entering a group with the @kbd{SPACE} command.
2169 Which article this is controlled by the
2170 @code{gnus-auto-select-subject} variable. Valid values for this
2171 variable are:
2172
2173 @table @code
2174
2175 @item unread
2176 Place point on the subject line of the first unread article.
2177
2178 @item first
2179 Place point on the subject line of the first article.
2180
2181 @item unseen
2182 Place point on the subject line of the first unseen article.
2183
2184 @item unseen-or-unread
2185 Place point on the subject line of the first unseen article, and if
2186 there is no such article, place point on the subject line of the first
2187 unread article.
2188
2189 @item best
2190 Place point on the subject line of the highest-scored unread article.
2191
2192 @end table
2193
2194 This variable can also be a function. In that case, that function
2195 will be called to place point on a subject line.
2196
2197 If you want to prevent automatic selection in some group (say, in a
2198 binary group with Huge articles) you can set the
2199 @code{gnus-auto-select-first} variable to @code{nil} in
2200 @code{gnus-select-group-hook}, which is called when a group is
2201 selected.
2202
2203
2204 @node Subscription Commands
2205 @section Subscription Commands
2206 @cindex subscription
2207
2208 The following commands allow for managing your subscriptions in the
2209 Group buffer. If you want to subscribe to many groups, it's probably
2210 more convenient to go to the @ref{Server Buffer}, and choose the
2211 server there using @kbd{RET} or @kbd{SPC}. Then you'll have the
2212 commands listed in @ref{Browse Foreign Server} at hand.
2213
2214 @table @kbd
2215
2216 @item S t
2217 @itemx u
2218 @kindex S t (Group)
2219 @kindex u (Group)
2220 @findex gnus-group-unsubscribe-current-group
2221 @c @icon{gnus-group-unsubscribe}
2222 Toggle subscription to the current group
2223 (@code{gnus-group-unsubscribe-current-group}).
2224
2225 @item S s
2226 @itemx U
2227 @kindex S s (Group)
2228 @kindex U (Group)
2229 @findex gnus-group-unsubscribe-group
2230 Prompt for a group to subscribe, and then subscribe it. If it was
2231 subscribed already, unsubscribe it instead
2232 (@code{gnus-group-unsubscribe-group}).
2233
2234 @item S k
2235 @itemx C-k
2236 @kindex S k (Group)
2237 @kindex C-k (Group)
2238 @findex gnus-group-kill-group
2239 @c @icon{gnus-group-kill-group}
2240 Kill the current group (@code{gnus-group-kill-group}).
2241
2242 @item S y
2243 @itemx C-y
2244 @kindex S y (Group)
2245 @kindex C-y (Group)
2246 @findex gnus-group-yank-group
2247 Yank the last killed group (@code{gnus-group-yank-group}).
2248
2249 @item C-x C-t
2250 @kindex C-x C-t (Group)
2251 @findex gnus-group-transpose-groups
2252 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2253 really a subscription command, but you can use it instead of a
2254 kill-and-yank sequence sometimes.
2255
2256 @item S w
2257 @itemx C-w
2258 @kindex S w (Group)
2259 @kindex C-w (Group)
2260 @findex gnus-group-kill-region
2261 Kill all groups in the region (@code{gnus-group-kill-region}).
2262
2263 @item S z
2264 @kindex S z (Group)
2265 @findex gnus-group-kill-all-zombies
2266 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2267
2268 @item S C-k
2269 @kindex S C-k (Group)
2270 @findex gnus-group-kill-level
2271 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2272 These groups can't be yanked back after killing, so this command should
2273 be used with some caution. The only time where this command comes in
2274 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2275 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2276 kill off all unsubscribed groups that do not have message numbers in the
2277 @file{.newsrc} file.
2278
2279 @end table
2280
2281 Also @pxref{Group Levels}.
2282
2283
2284 @node Group Data
2285 @section Group Data
2286
2287 @table @kbd
2288
2289 @item c
2290 @kindex c (Group)
2291 @findex gnus-group-catchup-current
2292 @vindex gnus-group-catchup-group-hook
2293 @c @icon{gnus-group-catchup-current}
2294 Mark all unticked articles in this group as read
2295 (@code{gnus-group-catchup-current}).
2296 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2297 the group buffer.
2298
2299 @item C
2300 @kindex C (Group)
2301 @findex gnus-group-catchup-current-all
2302 Mark all articles in this group, even the ticked ones, as read
2303 (@code{gnus-group-catchup-current-all}).
2304
2305 @item M-c
2306 @kindex M-c (Group)
2307 @findex gnus-group-clear-data
2308 Clear the data from the current group---nix out marks and the list of
2309 read articles (@code{gnus-group-clear-data}).
2310
2311 @item M-x gnus-group-clear-data-on-native-groups
2312 @kindex M-x gnus-group-clear-data-on-native-groups
2313 @findex gnus-group-clear-data-on-native-groups
2314 If you have switched from one @acronym{NNTP} server to another, all your marks
2315 and read ranges have become worthless. You can use this command to
2316 clear out all data that you have on your native groups. Use with
2317 caution.
2318
2319 @end table
2320
2321
2322 @node Group Levels
2323 @section Group Levels
2324 @cindex group level
2325 @cindex level
2326
2327 All groups have a level of @dfn{subscribedness}. For instance, if a
2328 group is on level 2, it is more subscribed than a group on level 5. You
2329 can ask Gnus to just list groups on a given level or lower
2330 (@pxref{Listing Groups}), or to just check for new articles in groups on
2331 a given level or lower (@pxref{Scanning New Messages}).
2332
2333 Remember: The higher the level of the group, the less important it is.
2334
2335 @table @kbd
2336
2337 @item S l
2338 @kindex S l (Group)
2339 @findex gnus-group-set-current-level
2340 Set the level of the current group. If a numeric prefix is given, the
2341 next @var{n} groups will have their levels set. The user will be
2342 prompted for a level.
2343 @end table
2344
2345 @vindex gnus-level-killed
2346 @vindex gnus-level-zombie
2347 @vindex gnus-level-unsubscribed
2348 @vindex gnus-level-subscribed
2349 Gnus considers groups from levels 1 to
2350 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2351 @code{gnus-level-subscribed} (exclusive) and
2352 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2353 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2354 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2355 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2356 same, but zombie and killed groups store no information on what articles
2357 you have read, etc. This distinction between dead and living
2358 groups isn't done because it is nice or clever, it is done purely for
2359 reasons of efficiency.
2360
2361 It is recommended that you keep all your mail groups (if any) on quite
2362 low levels (e.g., 1 or 2).
2363
2364 Maybe the following description of the default behavior of Gnus helps to
2365 understand what these levels are all about. By default, Gnus shows you
2366 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2367 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2368 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2369 groups are hidden, in a way.
2370
2371 @cindex zombie groups
2372 Zombie and killed groups are similar to unsubscribed groups in that they
2373 are hidden by default. But they are different from subscribed and
2374 unsubscribed groups in that Gnus doesn't ask the news server for
2375 information (number of messages, number of unread messages) on zombie
2376 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2377 aren't interested in. If most groups are killed, Gnus is faster.
2378
2379 Why does Gnus distinguish between zombie and killed groups? Well, when
2380 a new group arrives on the server, Gnus by default makes it a zombie
2381 group. This means that you are normally not bothered with new groups,
2382 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2383 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2384 list of killed groups.)
2385
2386 If you want to play with the level variables, you should show some care.
2387 Set them once, and don't touch them ever again. Better yet, don't touch
2388 them at all unless you know exactly what you're doing.
2389
2390 @vindex gnus-level-default-unsubscribed
2391 @vindex gnus-level-default-subscribed
2392 Two closely related variables are @code{gnus-level-default-subscribed}
2393 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2394 which are the levels that new groups will be put on if they are
2395 (un)subscribed. These two variables should, of course, be inside the
2396 relevant valid ranges.
2397
2398 @vindex gnus-keep-same-level
2399 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2400 will only move to groups of the same level (or lower). In
2401 particular, going from the last article in one group to the next group
2402 will go to the next group of the same level (or lower). This might be
2403 handy if you want to read the most important groups before you read the
2404 rest.
2405
2406 If this variable is @code{best}, Gnus will make the next newsgroup the
2407 one with the best level.
2408
2409 @vindex gnus-group-default-list-level
2410 All groups with a level less than or equal to
2411 @code{gnus-group-default-list-level} will be listed in the group buffer
2412 by default.
2413 This variable can also be a function. In that case, that function will
2414 be called and the result will be used as value.
2415
2416
2417 @vindex gnus-group-list-inactive-groups
2418 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2419 groups will be listed along with the unread groups. This variable is
2420 @code{t} by default. If it is @code{nil}, inactive groups won't be
2421 listed.
2422
2423 @vindex gnus-group-use-permanent-levels
2424 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2425 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2426 use this level as the ``work'' level.
2427
2428 @vindex gnus-activate-level
2429 Gnus will normally just activate (i.e., query the server about) groups
2430 on level @code{gnus-activate-level} or less. If you don't want to
2431 activate unsubscribed groups, for instance, you might set this variable
2432 to 5. The default is 6.
2433
2434
2435 @node Group Score
2436 @section Group Score
2437 @cindex group score
2438 @cindex group rank
2439 @cindex rank
2440
2441 You would normally keep important groups on high levels, but that scheme
2442 is somewhat restrictive. Don't you wish you could have Gnus sort the
2443 group buffer according to how often you read groups, perhaps? Within
2444 reason?
2445
2446 This is what @dfn{group score} is for. You can have Gnus assign a score
2447 to each group through the mechanism described below. You can then sort
2448 the group buffer based on this score. Alternatively, you can sort on
2449 score and then level. (Taken together, the level and the score is
2450 called the @dfn{rank} of the group. A group that is on level 4 and has
2451 a score of 1 has a higher rank than a group on level 5 that has a score
2452 of 300. (The level is the most significant part and the score is the
2453 least significant part.))
2454
2455 @findex gnus-summary-bubble-group
2456 If you want groups you read often to get higher scores than groups you
2457 read seldom you can add the @code{gnus-summary-bubble-group} function to
2458 the @code{gnus-summary-exit-hook} hook. This will result (after
2459 sorting) in a bubbling sort of action. If you want to see that in
2460 action after each summary exit, you can add
2461 @code{gnus-group-sort-groups-by-rank} or
2462 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2463 slow things down somewhat.
2464
2465
2466 @node Marking Groups
2467 @section Marking Groups
2468 @cindex marking groups
2469
2470 If you want to perform some command on several groups, and they appear
2471 subsequently in the group buffer, you would normally just give a
2472 numerical prefix to the command. Most group commands will then do your
2473 bidding on those groups.
2474
2475 However, if the groups are not in sequential order, you can still
2476 perform a command on several groups. You simply mark the groups first
2477 with the process mark and then execute the command.
2478
2479 @table @kbd
2480
2481 @item #
2482 @kindex # (Group)
2483 @itemx M m
2484 @kindex M m (Group)
2485 @findex gnus-group-mark-group
2486 Set the mark on the current group (@code{gnus-group-mark-group}).
2487
2488 @item M-#
2489 @kindex M-# (Group)
2490 @itemx M u
2491 @kindex M u (Group)
2492 @findex gnus-group-unmark-group
2493 Remove the mark from the current group
2494 (@code{gnus-group-unmark-group}).
2495
2496 @item M U
2497 @kindex M U (Group)
2498 @findex gnus-group-unmark-all-groups
2499 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2500
2501 @item M w
2502 @kindex M w (Group)
2503 @findex gnus-group-mark-region
2504 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2505
2506 @item M b
2507 @kindex M b (Group)
2508 @findex gnus-group-mark-buffer
2509 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2510
2511 @item M r
2512 @kindex M r (Group)
2513 @findex gnus-group-mark-regexp
2514 Mark all groups that match some regular expression
2515 (@code{gnus-group-mark-regexp}).
2516 @end table
2517
2518 Also @pxref{Process/Prefix}.
2519
2520 @findex gnus-group-universal-argument
2521 If you want to execute some command on all groups that have been marked
2522 with the process mark, you can use the @kbd{M-&}
2523 (@code{gnus-group-universal-argument}) command. It will prompt you for
2524 the command to be executed.
2525
2526
2527 @node Foreign Groups
2528 @section Foreign Groups
2529 @cindex foreign groups
2530
2531 If you recall how to subscribe to servers (@pxref{Finding the News})
2532 you will remember that @code{gnus-secondary-select-methods} and
2533 @code{gnus-select-method} let you write a definition in Emacs Lisp of
2534 what servers you want to see when you start up. The alternate
2535 approach is to use foreign servers and groups. ``Foreign'' here means
2536 they are not coming from the select methods. All foreign server
2537 configuration and subscriptions are stored only in the
2538 @file{~/.newsrc.eld} file.
2539
2540 Below are some group mode commands for making and editing general foreign
2541 groups, as well as commands to ease the creation of a few
2542 special-purpose groups. All these commands insert the newly created
2543 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2544 consulted.
2545
2546 Changes from the group editing commands are stored in
2547 @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the
2548 variable @code{gnus-parameters}, @xref{Group Parameters}.
2549
2550 @table @kbd
2551
2552 @item G m
2553 @kindex G m (Group)
2554 @findex gnus-group-make-group
2555 @cindex making groups
2556 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2557 for a name, a method and possibly an @dfn{address}. For an easier way
2558 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2559
2560 @item G M
2561 @kindex G M (Group)
2562 @findex gnus-group-read-ephemeral-group
2563 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2564 will prompt you for a name, a method and an @dfn{address}.
2565
2566 @item G r
2567 @kindex G r (Group)
2568 @findex gnus-group-rename-group
2569 @cindex renaming groups
2570 Rename the current group to something else
2571 (@code{gnus-group-rename-group}). This is valid only on some
2572 groups---mail groups mostly. This command might very well be quite slow
2573 on some back ends.
2574
2575 @item G c
2576 @kindex G c (Group)
2577 @cindex customizing
2578 @findex gnus-group-customize
2579 Customize the group parameters (@code{gnus-group-customize}).
2580
2581 @item G e
2582 @kindex G e (Group)
2583 @findex gnus-group-edit-group-method
2584 @cindex renaming groups
2585 Enter a buffer where you can edit the select method of the current
2586 group (@code{gnus-group-edit-group-method}).
2587
2588 @item G p
2589 @kindex G p (Group)
2590 @findex gnus-group-edit-group-parameters
2591 Enter a buffer where you can edit the group parameters
2592 (@code{gnus-group-edit-group-parameters}).
2593
2594 @item G E
2595 @kindex G E (Group)
2596 @findex gnus-group-edit-group
2597 Enter a buffer where you can edit the group info
2598 (@code{gnus-group-edit-group}).
2599
2600 @item G d
2601 @kindex G d (Group)
2602 @findex gnus-group-make-directory-group
2603 @cindex nndir
2604 Make a directory group (@pxref{Directory Groups}). You will be prompted
2605 for a directory name (@code{gnus-group-make-directory-group}).
2606
2607 @item G h
2608 @kindex G h (Group)
2609 @cindex help group
2610 @findex gnus-group-make-help-group
2611 Make the Gnus help group (@code{gnus-group-make-help-group}).
2612
2613 @item G D
2614 @kindex G D (Group)
2615 @findex gnus-group-enter-directory
2616 @cindex nneething
2617 Read an arbitrary directory as if it were a newsgroup with the
2618 @code{nneething} back end (@code{gnus-group-enter-directory}).
2619 @xref{Anything Groups}.
2620
2621 @item G f
2622 @kindex G f (Group)
2623 @findex gnus-group-make-doc-group
2624 @cindex ClariNet Briefs
2625 @cindex nndoc
2626 Make a group based on some file or other
2627 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2628 command, you will be prompted for a file name and a file type.
2629 Currently supported types are @code{mbox}, @code{babyl},
2630 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2631 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2632 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2633 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2634 you run this command without a prefix, Gnus will guess at the file
2635 type. @xref{Document Groups}.
2636
2637 @item G u
2638 @kindex G u (Group)
2639 @vindex gnus-useful-groups
2640 @findex gnus-group-make-useful-group
2641 Create one of the groups mentioned in @code{gnus-useful-groups}
2642 (@code{gnus-group-make-useful-group}).
2643
2644 @item G w
2645 @kindex G w (Group)
2646 @findex gnus-group-make-web-group
2647 @cindex Google
2648 @cindex nnweb
2649 @cindex gmane
2650 Make an ephemeral group based on a web search
2651 (@code{gnus-group-make-web-group}). If you give a prefix to this
2652 command, make a solid group instead. You will be prompted for the
2653 search engine type and the search string. Valid search engine types
2654 include @code{google}, @code{dejanews}, and @code{gmane}.
2655 @xref{Web Searches}.
2656
2657 If you use the @code{google} search engine, you can limit the search
2658 to a particular group by using a match string like
2659 @samp{shaving group:alt.sysadmin.recovery}.
2660
2661 @item G R
2662 @kindex G R (Group)
2663 @findex gnus-group-make-rss-group
2664 Make a group based on an @acronym{RSS} feed
2665 (@code{gnus-group-make-rss-group}). You will be prompted for an URL@.
2666 @xref{RSS}.
2667
2668 @item G DEL
2669 @kindex G DEL (Group)
2670 @findex gnus-group-delete-group
2671 This function will delete the current group
2672 (@code{gnus-group-delete-group}). If given a prefix, this function will
2673 actually delete all the articles in the group, and forcibly remove the
2674 group itself from the face of the Earth. Use a prefix only if you are
2675 absolutely sure of what you are doing. This command can't be used on
2676 read-only groups (like @code{nntp} groups), though.
2677
2678 @item G V
2679 @kindex G V (Group)
2680 @findex gnus-group-make-empty-virtual
2681 Make a new, fresh, empty @code{nnvirtual} group
2682 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2683
2684 @item G v
2685 @kindex G v (Group)
2686 @findex gnus-group-add-to-virtual
2687 Add the current group to an @code{nnvirtual} group
2688 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2689 @end table
2690
2691 @xref{Select Methods}, for more information on the various select
2692 methods.
2693
2694 @vindex gnus-activate-foreign-newsgroups
2695 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2696 Gnus will check all foreign groups with this level or lower at startup.
2697 This might take quite a while, especially if you subscribe to lots of
2698 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2699 @code{gnus-activate-level} also affects activation of foreign
2700 newsgroups.
2701
2702
2703 The following commands create ephemeral groups. They can be called not
2704 only from the Group buffer, but in any Gnus buffer.
2705
2706 @table @code
2707 @item gnus-read-ephemeral-gmane-group
2708 @findex gnus-read-ephemeral-gmane-group
2709 @vindex gnus-gmane-group-download-format
2710 Read an ephemeral group on Gmane.org. The articles are downloaded via
2711 HTTP using the URL specified by @code{gnus-gmane-group-download-format}.
2712 Gnus will prompt you for a group name, the start article number and an
2713 the article range.
2714
2715 @item gnus-read-ephemeral-gmane-group-url
2716 @findex gnus-read-ephemeral-gmane-group-url
2717 This command is similar to @code{gnus-read-ephemeral-gmane-group}, but
2718 the group name and the article number and range are constructed from a
2719 given @acronym{URL}. Supported @acronym{URL} formats include:
2720 @indicateurl{http://thread.gmane.org/gmane.foo.bar/12300/focus=12399},
2721 @indicateurl{http://thread.gmane.org/gmane.foo.bar/12345/},
2722 @indicateurl{http://article.gmane.org/gmane.foo.bar/12345/},
2723 @indicateurl{http://permalink.gmane.org/gmane.foo.bar/12345/}, and
2724 @indicateurl{http://news.gmane.org/group/gmane.foo.bar/thread=12345}.
2725
2726 @item gnus-read-ephemeral-emacs-bug-group
2727 @findex gnus-read-ephemeral-emacs-bug-group
2728 Read an Emacs bug report in an ephemeral group. Gnus will prompt for a
2729 bug number. The default is the number at point. The @acronym{URL} is
2730 specified in @code{gnus-bug-group-download-format-alist}.
2731
2732 @item gnus-read-ephemeral-debian-bug-group
2733 @findex gnus-read-ephemeral-debian-bug-group
2734 Read a Debian bug report in an ephemeral group. Analog to
2735 @code{gnus-read-ephemeral-emacs-bug-group}.
2736 @end table
2737
2738 Some of these command are also useful for article buttons, @xref{Article
2739 Buttons}.
2740
2741 Here is an example:
2742 @lisp
2743 (require 'gnus-art)
2744 (add-to-list
2745 'gnus-button-alist
2746 '("#\\([0-9]+\\)\\>" 1
2747 (string-match "\\<emacs\\>" (or gnus-newsgroup-name ""))
2748 gnus-read-ephemeral-emacs-bug-group 1))
2749 @end lisp
2750
2751
2752 @node Group Parameters
2753 @section Group Parameters
2754 @cindex group parameters
2755
2756 The group parameters store information local to a particular group.
2757
2758 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2759 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2760 presents you with a Customize-like interface. The latter helps avoid
2761 silly Lisp errors.) You might also be interested in reading about topic
2762 parameters (@pxref{Topic Parameters}).
2763 Additionally, you can set group parameters via the
2764 @code{gnus-parameters} variable, see below.
2765
2766 Here's an example group parameter list:
2767
2768 @example
2769 ((to-address . "ding@@gnus.org")
2770 (auto-expire . t))
2771 @end example
2772
2773 We see that each element consists of a ``dotted pair''---the thing before
2774 the dot is the key, while the thing after the dot is the value. All the
2775 parameters have this form @emph{except} local variable specs, which are
2776 not dotted pairs, but proper lists.
2777
2778 Some parameters have correspondent customizable variables, each of which
2779 is an alist of regexps and values.
2780
2781 The following group parameters can be used:
2782
2783 @table @code
2784 @item to-address
2785 @cindex to-address
2786 Address used by when doing followups and new posts.
2787
2788 @example
2789 (to-address . "some@@where.com")
2790 @end example
2791
2792 This is primarily useful in mail groups that represent closed mailing
2793 lists---mailing lists where it's expected that everybody that writes to
2794 the mailing list is subscribed to it. Since using this parameter
2795 ensures that the mail only goes to the mailing list itself, it means
2796 that members won't receive two copies of your followups.
2797
2798 Using @code{to-address} will actually work whether the group is foreign
2799 or not. Let's say there's a group on the server that is called
2800 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2801 the articles from a mail-to-news gateway. Posting directly to this
2802 group is therefore impossible---you have to send mail to the mailing
2803 list address instead.
2804
2805 See also @code{gnus-parameter-to-address-alist}.
2806
2807 @item to-list
2808 @cindex to-list
2809 Address used when doing @kbd{a} in that group.
2810
2811 @example
2812 (to-list . "some@@where.com")
2813 @end example
2814
2815 It is totally ignored
2816 when doing a followup---except that if it is present in a news group,
2817 you'll get mail group semantics when doing @kbd{f}.
2818
2819 If you do an @kbd{a} command in a mail group and you have neither a
2820 @code{to-list} group parameter nor a @code{to-address} group parameter,
2821 then a @code{to-list} group parameter will be added automatically upon
2822 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2823 @vindex gnus-add-to-list
2824
2825 @findex gnus-mailing-list-mode
2826 @cindex mail list groups
2827 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2828 entering summary buffer.
2829
2830 See also @code{gnus-parameter-to-list-alist}.
2831
2832 @anchor{subscribed}
2833 @item subscribed
2834 @cindex subscribed
2835 @cindex Mail-Followup-To
2836 @findex gnus-find-subscribed-addresses
2837 If this parameter is set to @code{t}, Gnus will consider the
2838 to-address and to-list parameters for this group as addresses of
2839 mailing lists you are subscribed to. Giving Gnus this information is
2840 (only) a first step in getting it to generate correct Mail-Followup-To
2841 headers for your posts to these lists. The second step is to put the
2842 following in your @file{.gnus.el}
2843
2844 @lisp
2845 (setq message-subscribed-address-functions
2846 '(gnus-find-subscribed-addresses))
2847 @end lisp
2848
2849 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2850 a complete treatment of available MFT support.
2851
2852 @item visible
2853 @cindex visible
2854 If the group parameter list has the element @code{(visible . t)},
2855 that group will always be visible in the Group buffer, regardless
2856 of whether it has any unread articles.
2857
2858 This parameter cannot be set via @code{gnus-parameters}. See
2859 @code{gnus-permanently-visible-groups} as an alternative.
2860
2861 @item broken-reply-to
2862 @cindex broken-reply-to
2863 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2864 headers in this group are to be ignored, and for the header to be hidden
2865 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2866 can be useful if you're reading a mailing list group where the listserv
2867 has inserted @code{Reply-To} headers that point back to the listserv
2868 itself. That is broken behavior. So there!
2869
2870 @item to-group
2871 @cindex to-group
2872 Elements like @code{(to-group . "some.group.name")} means that all
2873 posts in that group will be sent to @code{some.group.name}.
2874
2875 @item newsgroup
2876 @cindex newsgroup
2877 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2878 will treat all responses as if they were responses to news articles.
2879 This can be useful if you have a mail group that's really a mirror of a
2880 news group.
2881
2882 @item gcc-self
2883 @cindex gcc-self
2884 If @code{(gcc-self . t)} is present in the group parameter list, newly
2885 composed messages will be @code{Gcc}'d to the current group. If
2886 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2887 generated, if @code{(gcc-self . "string")} is present, this string will
2888 be inserted literally as a @code{gcc} header. This parameter takes
2889 precedence over any default @code{Gcc} rules as described later
2890 (@pxref{Archived Messages}), with the exception for messages to resend.
2891
2892 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2893 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2894 doesn't accept articles.
2895
2896 @item auto-expire
2897 @cindex auto-expire
2898 @cindex expiring mail
2899 If the group parameter has an element that looks like @code{(auto-expire
2900 . t)}, all articles read will be marked as expirable. For an
2901 alternative approach, @pxref{Expiring Mail}.
2902
2903 See also @code{gnus-auto-expirable-newsgroups}.
2904
2905 @item total-expire
2906 @cindex total-expire
2907 @cindex expiring mail
2908 If the group parameter has an element that looks like
2909 @code{(total-expire . t)}, all read articles will be put through the
2910 expiry process, even if they are not marked as expirable. Use with
2911 caution. Unread, ticked and dormant articles are not eligible for
2912 expiry.
2913
2914 See also @code{gnus-total-expirable-newsgroups}.
2915
2916 @item expiry-wait
2917 @cindex expiry-wait
2918 @vindex nnmail-expiry-wait-function
2919 If the group parameter has an element that looks like
2920 @code{(expiry-wait . 10)}, this value will override any
2921 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2922 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2923 can either be a number of days (not necessarily an integer) or the
2924 symbols @code{never} or @code{immediate}.
2925
2926 @item expiry-target
2927 @cindex expiry-target
2928 Where expired messages end up. This parameter overrides
2929 @code{nnmail-expiry-target}.
2930
2931 @item score-file
2932 @cindex score file group parameter
2933 Elements that look like @code{(score-file . "file")} will make
2934 @file{file} into the current score file for the group in question. All
2935 interactive score entries will be put into this file.
2936
2937 @item adapt-file
2938 @cindex adapt file group parameter
2939 Elements that look like @code{(adapt-file . "file")} will make
2940 @file{file} into the current adaptive file for the group in question.
2941 All adaptive score entries will be put into this file.
2942
2943 @item admin-address
2944 @cindex admin-address
2945 When unsubscribing from a mailing list you should never send the
2946 unsubscription notice to the mailing list itself. Instead, you'd send
2947 messages to the administrative address. This parameter allows you to
2948 put the admin address somewhere convenient.
2949
2950 @item display
2951 @cindex display
2952 Elements that look like @code{(display . MODE)} say which articles to
2953 display on entering the group. Valid values are:
2954
2955 @table @code
2956 @item all
2957 Display all articles, both read and unread.
2958
2959 @item an integer
2960 Display the last @var{integer} articles in the group. This is the same as
2961 entering the group with @kbd{C-u @var{integer}}.
2962
2963 @item default
2964 Display the default visible articles, which normally includes unread and
2965 ticked articles.
2966
2967 @item an array
2968 Display articles that satisfy a predicate.
2969
2970 Here are some examples:
2971
2972 @table @code
2973 @item [unread]
2974 Display only unread articles.
2975
2976 @item [not expire]
2977 Display everything except expirable articles.
2978
2979 @item [and (not reply) (not expire)]
2980 Display everything except expirable and articles you've already
2981 responded to.
2982 @end table
2983
2984 The available operators are @code{not}, @code{and} and @code{or}.
2985 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2986 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2987 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2988 @code{cache}, @code{forward}, and @code{unseen}.
2989
2990 @end table
2991
2992 The @code{display} parameter works by limiting the summary buffer to
2993 the subset specified. You can pop the limit by using the @kbd{/ w}
2994 command (@pxref{Limiting}).
2995
2996 @item comment
2997 @cindex comment
2998 Elements that look like @code{(comment . "This is a comment")} are
2999 arbitrary comments on the group. You can display comments in the
3000 group line (@pxref{Group Line Specification}).
3001
3002 @item charset
3003 @cindex charset
3004 Elements that look like @code{(charset . iso-8859-1)} will make
3005 @code{iso-8859-1} the default charset; that is, the charset that will be
3006 used for all articles that do not specify a charset.
3007
3008 See also @code{gnus-group-charset-alist}.
3009
3010 @item ignored-charsets
3011 @cindex ignored-charset
3012 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
3013 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
3014 default charset will be used for decoding articles.
3015
3016 See also @code{gnus-group-ignored-charsets-alist}.
3017
3018 @item posting-style
3019 @cindex posting-style
3020 You can store additional posting style information for this group
3021 here (@pxref{Posting Styles}). The format is that of an entry in the
3022 @code{gnus-posting-styles} alist, except that there's no regexp matching
3023 the group name (of course). Style elements in this group parameter will
3024 take precedence over the ones found in @code{gnus-posting-styles}.
3025
3026 For instance, if you want a funky name and signature in this group only,
3027 instead of hacking @code{gnus-posting-styles}, you could put something
3028 like this in the group parameters:
3029
3030 @example
3031 (posting-style
3032 (name "Funky Name")
3033 ("X-Message-SMTP-Method" "smtp smtp.example.org 587")
3034 ("X-My-Header" "Funky Value")
3035 (signature "Funky Signature"))
3036 @end example
3037
3038 If you're using topics to organize your group buffer
3039 (@pxref{Group Topics}), note that posting styles can also be set in
3040 the topics parameters. Posting styles in topic parameters apply to all
3041 groups in this topic. More precisely, the posting-style settings for a
3042 group result from the hierarchical merging of all posting-style
3043 entries in the parameters of this group and all the topics it belongs
3044 to.
3045
3046
3047 @item post-method
3048 @cindex post-method
3049 If it is set, the value is used as the method for posting message
3050 instead of @code{gnus-post-method}.
3051
3052 @item mail-source
3053 @cindex mail-source
3054 If it is set, and the setting of @code{mail-sources} includes a
3055 @code{group} mail source (@pxref{Mail Sources}), the value is a
3056 mail source for this group.
3057
3058 @item banner
3059 @cindex banner
3060 An item like @code{(banner . @var{regexp})} causes any part of an article
3061 that matches the regular expression @var{regexp} to be stripped. Instead of
3062 @var{regexp}, you can also use the symbol @code{signature} which strips the
3063 last signature or any of the elements of the alist
3064 @code{gnus-article-banner-alist}.
3065
3066 @item sieve
3067 @cindex sieve
3068 This parameter contains a Sieve test that should match incoming mail
3069 that should be placed in this group. From this group parameter, a
3070 Sieve @samp{IF} control structure is generated, having the test as the
3071 condition and @samp{fileinto "group.name";} as the body.
3072
3073 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3074 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3075 translating the group parameter into a Sieve script (@pxref{Sieve
3076 Commands}) the following Sieve code is generated:
3077
3078 @example
3079 if address "sender" "sieve-admin@@extundo.com" @{
3080 fileinto "INBOX.list.sieve";
3081 @}
3082 @end example
3083
3084 To generate tests for multiple email-addresses use a group parameter
3085 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3086 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3087 like the following is generated:
3088
3089 @example
3090 if address "sender" ["name@@one.org", "else@@two.org"] @{
3091 fileinto "INBOX.list.sieve";
3092 @}
3093 @end example
3094
3095 You can also use regexp expansions in the rules:
3096
3097 @example
3098 (sieve header :regex "list-id" "<c++std-\\1.accu.org>")
3099 @end example
3100
3101 See @pxref{Sieve Commands} for commands and variables that might be of
3102 interest in relation to the sieve parameter.
3103
3104 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3105 Top, sieve, Emacs Sieve}.
3106
3107 @item (agent parameters)
3108 If the agent has been enabled, you can set any of its parameters to
3109 control the behavior of the agent in individual groups. See Agent
3110 Parameters in @ref{Category Syntax}. Most users will choose to set
3111 agent parameters in either an agent category or group topic to
3112 minimize the configuration effort.
3113
3114 @item (@var{variable} @var{form})
3115 You can use the group parameters to set variables local to the group you
3116 are entering. If you want to turn threading off in @samp{news.answers},
3117 you could put @code{(gnus-show-threads nil)} in the group parameters of
3118 that group. @code{gnus-show-threads} will be made into a local variable
3119 in the summary buffer you enter, and the form @code{nil} will be
3120 @code{eval}ed there.
3121
3122 Note that this feature sets the variable locally to the summary buffer
3123 if and only if @var{variable} has been bound as a variable. Otherwise,
3124 only evaluating the form will take place. So, you may want to bind the
3125 variable in advance using @code{defvar} or other if the result of the
3126 form needs to be set to it.
3127
3128 But some variables are evaluated in the article buffer, or in the
3129 message buffer (of a reply or followup or otherwise newly created
3130 message). As a workaround, it might help to add the variable in
3131 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3132 Stuff}. So if you want to set @code{message-from-style} via the group
3133 parameters, then you may need the following statement elsewhere in your
3134 @file{~/.gnus.el} file:
3135
3136 @lisp
3137 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3138 @end lisp
3139
3140 @vindex gnus-list-identifiers
3141 A use for this feature is to remove a mailing list identifier tag in
3142 the subject fields of articles. E.g., if the news group
3143
3144 @example
3145 nntp+news.gnus.org:gmane.text.docbook.apps
3146 @end example
3147
3148 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3149 tag can be removed from the article subjects in the summary buffer for
3150 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3151 into the group parameters for the group.
3152
3153 This can also be used as a group-specific hook function. If you want to
3154 hear a beep when you enter a group, you could put something like
3155 @code{(dummy-variable (ding))} in the parameters of that group. If
3156 @code{dummy-variable} has been bound (see above), it will be set to the
3157 (meaningless) result of the @code{(ding)} form.
3158
3159 Alternatively, since the VARIABLE becomes local to the group, this
3160 pattern can be used to temporarily change a hook. For example, if the
3161 following is added to a group parameter
3162
3163 @lisp
3164 (gnus-summary-prepared-hook
3165 (lambda nil (local-set-key "d" (local-key-binding "n"))))
3166 @end lisp
3167
3168 when the group is entered, the 'd' key will not mark the article as
3169 expired.
3170
3171 @end table
3172
3173 @vindex gnus-parameters
3174 Group parameters can be set via the @code{gnus-parameters} variable too.
3175 But some variables, such as @code{visible}, have no effect (For this
3176 case see @code{gnus-permanently-visible-groups} as an alternative.).
3177 For example:
3178
3179 @lisp
3180 (setq gnus-parameters
3181 '(("mail\\..*"
3182 (gnus-show-threads nil)
3183 (gnus-use-scoring nil)
3184 (gnus-summary-line-format
3185 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3186 (gcc-self . t)
3187 (display . all))
3188
3189 ("^nnimap:\\(foo.bar\\)$"
3190 (to-group . "\\1"))
3191
3192 ("mail\\.me"
3193 (gnus-use-scoring t))
3194
3195 ("list\\..*"
3196 (total-expire . t)
3197 (broken-reply-to . t))))
3198 @end lisp
3199
3200 All clauses that matches the group name will be used, but the last
3201 setting ``wins''. So if you have two clauses that both match the
3202 group name, and both set, say @code{display}, the last setting will
3203 override the first.
3204
3205 Parameters that are strings will be subjected to regexp substitution,
3206 as the @code{to-group} example shows.
3207
3208 @vindex gnus-parameters-case-fold-search
3209 By default, whether comparing the group name and one of those regexps
3210 specified in @code{gnus-parameters} is done in a case-sensitive manner
3211 or a case-insensitive manner depends on the value of
3212 @code{case-fold-search} at the time when the comparison is done. The
3213 value of @code{case-fold-search} is typically @code{t}; it means, for
3214 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3215 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3216 group. If you want to make those regexps always case-sensitive, set the
3217 value of the @code{gnus-parameters-case-fold-search} variable to
3218 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3219 always in a case-insensitive manner.
3220
3221 You can define different sorting to different groups via
3222 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3223 group by reverse date to see the latest news at the top and an
3224 @acronym{RSS} group by subject. In this example, the first group is the
3225 Debian daily news group @code{gmane.linux.debian.user.news} from
3226 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3227 weekly news RSS feed
3228 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3229 @xref{RSS}.
3230
3231 @lisp
3232 (setq
3233 gnus-parameters
3234 '(("nntp.*gmane\\.debian\\.user\\.news"
3235 (gnus-show-threads nil)
3236 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3237 (gnus-use-adaptive-scoring nil)
3238 (gnus-use-scoring nil))
3239 ("nnrss.*debian"
3240 (gnus-show-threads nil)
3241 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3242 (gnus-use-adaptive-scoring nil)
3243 (gnus-use-scoring t)
3244 (gnus-score-find-score-files-function 'gnus-score-find-single)
3245 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3246 @end lisp
3247
3248
3249 @node Listing Groups
3250 @section Listing Groups
3251 @cindex group listing
3252
3253 These commands all list various slices of the groups available.
3254
3255 @table @kbd
3256
3257 @item l
3258 @itemx A s
3259 @kindex A s (Group)
3260 @kindex l (Group)
3261 @findex gnus-group-list-groups
3262 List all groups that have unread articles
3263 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3264 command will list only groups of level ARG and lower. By default, it
3265 only lists groups of level five (i.e.,
3266 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3267 groups).
3268
3269 @item L
3270 @itemx A u
3271 @kindex A u (Group)
3272 @kindex L (Group)
3273 @findex gnus-group-list-all-groups
3274 List all groups, whether they have unread articles or not
3275 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3276 this command will list only groups of level ARG and lower. By default,
3277 it lists groups of level seven or lower (i.e., just subscribed and
3278 unsubscribed groups).
3279
3280 @item A l
3281 @kindex A l (Group)
3282 @findex gnus-group-list-level
3283 List all unread groups on a specific level
3284 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3285 with no unread articles.
3286
3287 @item A k
3288 @kindex A k (Group)
3289 @findex gnus-group-list-killed
3290 List all killed groups (@code{gnus-group-list-killed}). If given a
3291 prefix argument, really list all groups that are available, but aren't
3292 currently (un)subscribed. This could entail reading the active file
3293 from the server.
3294
3295 @item A z
3296 @kindex A z (Group)
3297 @findex gnus-group-list-zombies
3298 List all zombie groups (@code{gnus-group-list-zombies}).
3299
3300 @item A m
3301 @kindex A m (Group)
3302 @findex gnus-group-list-matching
3303 List all unread, subscribed groups with names that match a regexp
3304 (@code{gnus-group-list-matching}).
3305
3306 @item A M
3307 @kindex A M (Group)
3308 @findex gnus-group-list-all-matching
3309 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3310
3311 @item A A
3312 @kindex A A (Group)
3313 @findex gnus-group-list-active
3314 List absolutely all groups in the active file(s) of the
3315 server(s) you are connected to (@code{gnus-group-list-active}). This
3316 might very well take quite a while. It might actually be a better idea
3317 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3318 thing to match on. Also note that this command may list groups that
3319 don't exist (yet)---these will be listed as if they were killed groups.
3320 Take the output with some grains of salt.
3321
3322 @item A a
3323 @kindex A a (Group)
3324 @findex gnus-group-apropos
3325 List all groups that have names that match a regexp
3326 (@code{gnus-group-apropos}).
3327
3328 @item A d
3329 @kindex A d (Group)
3330 @findex gnus-group-description-apropos
3331 List all groups that have names or descriptions that match a regexp
3332 (@code{gnus-group-description-apropos}).
3333
3334 @item A c
3335 @kindex A c (Group)
3336 @findex gnus-group-list-cached
3337 List all groups with cached articles (@code{gnus-group-list-cached}).
3338
3339 @item A ?
3340 @kindex A ? (Group)
3341 @findex gnus-group-list-dormant
3342 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3343
3344 @item A !
3345 @kindex A ! (Group)
3346 @findex gnus-group-list-ticked
3347 List all groups with ticked articles (@code{gnus-group-list-ticked}).
3348
3349 @item A /
3350 @kindex A / (Group)
3351 @findex gnus-group-list-limit
3352 Further limit groups within the current selection
3353 (@code{gnus-group-list-limit}). If you've first limited to groups
3354 with dormant articles with @kbd{A ?}, you can then further limit with
3355 @kbd{A / c}, which will then limit to groups with cached articles,
3356 giving you the groups that have both dormant articles and cached
3357 articles.
3358
3359 @item A f
3360 @kindex A f (Group)
3361 @findex gnus-group-list-flush
3362 Flush groups from the current selection (@code{gnus-group-list-flush}).
3363
3364 @item A p
3365 @kindex A p (Group)
3366 @findex gnus-group-list-plus
3367 List groups plus the current selection (@code{gnus-group-list-plus}).
3368
3369 @end table
3370
3371 @vindex gnus-permanently-visible-groups
3372 @cindex visible group parameter
3373 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3374 always be shown, whether they have unread articles or not. You can also
3375 add the @code{visible} element to the group parameters in question to
3376 get the same effect.
3377
3378 @vindex gnus-list-groups-with-ticked-articles
3379 Groups that have just ticked articles in it are normally listed in the
3380 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3381 @code{nil}, these groups will be treated just like totally empty
3382 groups. It is @code{t} by default.
3383
3384
3385 @node Sorting Groups
3386 @section Sorting Groups
3387 @cindex sorting groups
3388
3389 @kindex C-c C-s (Group)
3390 @findex gnus-group-sort-groups
3391 @vindex gnus-group-sort-function
3392 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3393 group buffer according to the function(s) given by the
3394 @code{gnus-group-sort-function} variable. Available sorting functions
3395 include:
3396
3397 @table @code
3398
3399 @item gnus-group-sort-by-alphabet
3400 @findex gnus-group-sort-by-alphabet
3401 Sort the group names alphabetically. This is the default.
3402
3403 @item gnus-group-sort-by-real-name
3404 @findex gnus-group-sort-by-real-name
3405 Sort the group alphabetically on the real (unprefixed) group names.
3406
3407 @item gnus-group-sort-by-level
3408 @findex gnus-group-sort-by-level
3409 Sort by group level.
3410
3411 @item gnus-group-sort-by-score
3412 @findex gnus-group-sort-by-score
3413 Sort by group score. @xref{Group Score}.
3414
3415 @item gnus-group-sort-by-rank
3416 @findex gnus-group-sort-by-rank
3417 Sort by group score and then the group level. The level and the score
3418 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3419
3420 @item gnus-group-sort-by-unread
3421 @findex gnus-group-sort-by-unread
3422 Sort by number of unread articles.
3423
3424 @item gnus-group-sort-by-method
3425 @findex gnus-group-sort-by-method
3426 Sort alphabetically on the select method.
3427
3428 @item gnus-group-sort-by-server
3429 @findex gnus-group-sort-by-server
3430 Sort alphabetically on the Gnus server name.
3431
3432
3433 @end table
3434
3435 @code{gnus-group-sort-function} can also be a list of sorting
3436 functions. In that case, the most significant sort key function must be
3437 the last one.
3438
3439
3440 There are also a number of commands for sorting directly according to
3441 some sorting criteria:
3442
3443 @table @kbd
3444 @item G S a
3445 @kindex G S a (Group)
3446 @findex gnus-group-sort-groups-by-alphabet
3447 Sort the group buffer alphabetically by group name
3448 (@code{gnus-group-sort-groups-by-alphabet}).
3449
3450 @item G S u
3451 @kindex G S u (Group)
3452 @findex gnus-group-sort-groups-by-unread
3453 Sort the group buffer by the number of unread articles
3454 (@code{gnus-group-sort-groups-by-unread}).
3455
3456 @item G S l
3457 @kindex G S l (Group)
3458 @findex gnus-group-sort-groups-by-level
3459 Sort the group buffer by group level
3460 (@code{gnus-group-sort-groups-by-level}).
3461
3462 @item G S v
3463 @kindex G S v (Group)
3464 @findex gnus-group-sort-groups-by-score
3465 Sort the group buffer by group score
3466 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3467
3468 @item G S r
3469 @kindex G S r (Group)
3470 @findex gnus-group-sort-groups-by-rank
3471 Sort the group buffer by group rank
3472 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3473
3474 @item G S m
3475 @kindex G S m (Group)
3476 @findex gnus-group-sort-groups-by-method
3477 Sort the group buffer alphabetically by back end name@*
3478 (@code{gnus-group-sort-groups-by-method}).
3479
3480 @item G S n
3481 @kindex G S n (Group)
3482 @findex gnus-group-sort-groups-by-real-name
3483 Sort the group buffer alphabetically by real (unprefixed) group name
3484 (@code{gnus-group-sort-groups-by-real-name}).
3485
3486 @end table
3487
3488 All the commands below obey the process/prefix convention
3489 (@pxref{Process/Prefix}).
3490
3491 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3492 commands will sort in reverse order.
3493
3494 You can also sort a subset of the groups:
3495
3496 @table @kbd
3497 @item G P a
3498 @kindex G P a (Group)
3499 @findex gnus-group-sort-selected-groups-by-alphabet
3500 Sort the groups alphabetically by group name
3501 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3502
3503 @item G P u
3504 @kindex G P u (Group)
3505 @findex gnus-group-sort-selected-groups-by-unread
3506 Sort the groups by the number of unread articles
3507 (@code{gnus-group-sort-selected-groups-by-unread}).
3508
3509 @item G P l
3510 @kindex G P l (Group)
3511 @findex gnus-group-sort-selected-groups-by-level
3512 Sort the groups by group level
3513 (@code{gnus-group-sort-selected-groups-by-level}).
3514
3515 @item G P v
3516 @kindex G P v (Group)
3517 @findex gnus-group-sort-selected-groups-by-score
3518 Sort the groups by group score
3519 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3520
3521 @item G P r
3522 @kindex G P r (Group)
3523 @findex gnus-group-sort-selected-groups-by-rank
3524 Sort the groups by group rank
3525 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3526
3527 @item G P m
3528 @kindex G P m (Group)
3529 @findex gnus-group-sort-selected-groups-by-method
3530 Sort the groups alphabetically by back end name@*
3531 (@code{gnus-group-sort-selected-groups-by-method}).
3532
3533 @item G P n
3534 @kindex G P n (Group)
3535 @findex gnus-group-sort-selected-groups-by-real-name
3536 Sort the groups alphabetically by real (unprefixed) group name
3537 (@code{gnus-group-sort-selected-groups-by-real-name}).
3538
3539 @item G P s
3540 @kindex G P s (Group)
3541 @findex gnus-group-sort-selected-groups
3542 Sort the groups according to @code{gnus-group-sort-function}.
3543
3544 @end table
3545
3546 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3547 move groups around.
3548
3549
3550 @node Group Maintenance
3551 @section Group Maintenance
3552 @cindex bogus groups
3553
3554 @table @kbd
3555 @item b
3556 @kindex b (Group)
3557 @findex gnus-group-check-bogus-groups
3558 Find bogus groups and delete them
3559 (@code{gnus-group-check-bogus-groups}).
3560
3561 @item F
3562 @kindex F (Group)
3563 @findex gnus-group-find-new-groups
3564 Find new groups and process them (@code{gnus-group-find-new-groups}).
3565 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3566 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3567 to query the server for new groups, and subscribe the new groups as
3568 zombies.
3569
3570 @item C-c C-x
3571 @kindex C-c C-x (Group)
3572 @findex gnus-group-expire-articles
3573 @cindex expiring mail
3574 Run all expirable articles in the current group through the expiry
3575 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3576 all expirable articles in the group that have been around for a while.
3577 (@pxref{Expiring Mail}).
3578
3579 @item C-c C-M-x
3580 @kindex C-c C-M-x (Group)
3581 @findex gnus-group-expire-all-groups
3582 @cindex expiring mail
3583 Run all expirable articles in all groups through the expiry process
3584 (@code{gnus-group-expire-all-groups}).
3585
3586 @end table
3587
3588
3589 @node Browse Foreign Server
3590 @section Browse Foreign Server
3591 @cindex foreign servers
3592 @cindex browsing servers
3593
3594 @table @kbd
3595 @item B
3596 @kindex B (Group)
3597 @findex gnus-group-browse-foreign-server
3598 You will be queried for a select method and a server name. Gnus will
3599 then attempt to contact this server and let you browse the groups there
3600 (@code{gnus-group-browse-foreign-server}).
3601 @end table
3602
3603 @findex gnus-browse-mode
3604 A new buffer with a list of available groups will appear. This buffer
3605 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3606 a lot) like a normal group buffer.
3607
3608 Here's a list of keystrokes available in the browse mode:
3609
3610 @table @kbd
3611 @item n
3612 @kindex n (Browse)
3613 @findex gnus-group-next-group
3614 Go to the next group (@code{gnus-group-next-group}).
3615
3616 @item p
3617 @kindex p (Browse)
3618 @findex gnus-group-prev-group
3619 Go to the previous group (@code{gnus-group-prev-group}).
3620
3621 @item SPACE
3622 @kindex SPACE (Browse)
3623 @findex gnus-browse-read-group
3624 Enter the current group and display the first article
3625 (@code{gnus-browse-read-group}).
3626
3627 @item RET
3628 @kindex RET (Browse)
3629 @findex gnus-browse-select-group
3630 Enter the current group (@code{gnus-browse-select-group}).
3631
3632 @item u
3633 @kindex u (Browse)
3634 @findex gnus-browse-unsubscribe-current-group
3635 @vindex gnus-browse-subscribe-newsgroup-method
3636 Unsubscribe to the current group, or, as will be the case here,
3637 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). You
3638 can affect the way the new group is entered into the Group buffer
3639 using the variable @code{gnus-browse-subscribe-newsgroup-method}. See
3640 @pxref{Subscription Methods} for available options.
3641
3642 @item l
3643 @itemx q
3644 @kindex q (Browse)
3645 @kindex l (Browse)
3646 @findex gnus-browse-exit
3647 Exit browse mode (@code{gnus-browse-exit}).
3648
3649 @item d
3650 @kindex d (Browse)
3651 @findex gnus-browse-describe-group
3652 Describe the current group (@code{gnus-browse-describe-group}).
3653
3654 @item ?
3655 @kindex ? (Browse)
3656 @findex gnus-browse-describe-briefly
3657 Describe browse mode briefly (well, there's not much to describe, is
3658 there) (@code{gnus-browse-describe-briefly}).
3659
3660 @item DEL
3661 @kindex DEL (Browse)
3662 @findex gnus-browse-delete-group
3663 This function will delete the current group
3664 (@code{gnus-browse-delete-group}). If given a prefix, this function
3665 will actually delete all the articles in the group, and forcibly
3666 remove the group itself from the face of the Earth. Use a prefix only
3667 if you are absolutely sure of what you are doing.
3668 @end table
3669
3670
3671 @node Exiting Gnus
3672 @section Exiting Gnus
3673 @cindex exiting Gnus
3674
3675 Yes, Gnus is ex(c)iting.
3676
3677 @table @kbd
3678 @item z
3679 @kindex z (Group)
3680 @findex gnus-group-suspend
3681 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3682 but it kills all buffers except the Group buffer. I'm not sure why this
3683 is a gain, but then who am I to judge?
3684
3685 @item q
3686 @kindex q (Group)
3687 @findex gnus-group-exit
3688 @c @icon{gnus-group-exit}
3689 Quit Gnus (@code{gnus-group-exit}).
3690
3691 @item Q
3692 @kindex Q (Group)
3693 @findex gnus-group-quit
3694 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3695 The dribble file will be saved, though (@pxref{Auto Save}).
3696 @end table
3697
3698 @vindex gnus-exit-gnus-hook
3699 @vindex gnus-suspend-gnus-hook
3700 @vindex gnus-after-exiting-gnus-hook
3701 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3702 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3703 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3704 exiting Gnus.
3705
3706 Note:
3707
3708 @quotation
3709 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3710 numbly heavy and herself fall into a hazy trance as the boy sitting
3711 behind her drew repeated lines with his pencil across the back of her
3712 plastic chair.
3713 @end quotation
3714
3715
3716 @node Group Topics
3717 @section Group Topics
3718 @cindex topics
3719
3720 If you read lots and lots of groups, it might be convenient to group
3721 them hierarchically according to topics. You put your Emacs groups over
3722 here, your sex groups over there, and the rest (what, two groups or so?)
3723 you put in some misc section that you never bother with anyway. You can
3724 even group the Emacs sex groups as a sub-topic to either the Emacs
3725 groups or the sex groups---or both! Go wild!
3726
3727 @iftex
3728 @iflatex
3729 \gnusfigure{Group Topics}{400}{
3730 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3731 }
3732 @end iflatex
3733 @end iftex
3734
3735 Here's an example:
3736
3737 @example
3738 Gnus
3739 Emacs -- I wuw it!
3740 3: comp.emacs
3741 2: alt.religion.emacs
3742 Naughty Emacs
3743 452: alt.sex.emacs
3744 0: comp.talk.emacs.recovery
3745 Misc
3746 8: comp.binaries.fractals
3747 13: comp.sources.unix
3748 @end example
3749
3750 @findex gnus-topic-mode
3751 @kindex t (Group)
3752 To get this @emph{fab} functionality you simply turn on (ooh!) the
3753 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3754 is a toggling command.)
3755
3756 Go ahead, just try it. I'll still be here when you get back. La de
3757 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3758 Yes, and now press @kbd{l}. There. All your groups are now listed
3759 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3760 Hot and bothered?
3761
3762 If you want this permanently enabled, you should add that minor mode to
3763 the hook for the group mode. Put the following line in your
3764 @file{~/.gnus.el} file:
3765
3766 @lisp
3767 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3768 @end lisp
3769
3770 @menu
3771 * Topic Commands:: Interactive E-Z commands.
3772 * Topic Variables:: How to customize the topics the Lisp Way.
3773 * Topic Sorting:: Sorting each topic individually.
3774 * Topic Topology:: A map of the world.
3775 * Topic Parameters:: Parameters that apply to all groups in a topic.
3776 @end menu
3777
3778
3779 @node Topic Commands
3780 @subsection Topic Commands
3781 @cindex topic commands
3782
3783 When the topic minor mode is turned on, a new @kbd{T} submap will be
3784 available. In addition, a few of the standard keys change their
3785 definitions slightly.
3786
3787 In general, the following kinds of operations are possible on topics.
3788 First of all, you want to create topics. Secondly, you want to put
3789 groups in topics and to move them around until you have an order you
3790 like. The third kind of operation is to show/hide parts of the whole
3791 shebang. You might want to hide a topic including its subtopics and
3792 groups, to get a better overview of the other groups.
3793
3794 Here is a list of the basic keys that you might need to set up topics
3795 the way you like.
3796
3797 @table @kbd
3798
3799 @item T n
3800 @kindex T n (Topic)
3801 @findex gnus-topic-create-topic
3802 Prompt for a new topic name and create it
3803 (@code{gnus-topic-create-topic}).
3804
3805 @item T TAB
3806 @itemx TAB
3807 @kindex T TAB (Topic)
3808 @kindex TAB (Topic)
3809 @findex gnus-topic-indent
3810 ``Indent'' the current topic so that it becomes a sub-topic of the
3811 previous topic (@code{gnus-topic-indent}). If given a prefix,
3812 ``un-indent'' the topic instead.
3813
3814 @item M-TAB
3815 @kindex M-TAB (Topic)
3816 @findex gnus-topic-unindent
3817 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3818 parent of its current parent (@code{gnus-topic-unindent}).
3819
3820 @end table
3821
3822 The following two keys can be used to move groups and topics around.
3823 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3824 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3825 kill and yank rather than cut and paste.
3826
3827 @table @kbd
3828
3829 @item C-k
3830 @kindex C-k (Topic)
3831 @findex gnus-topic-kill-group
3832 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3833 topic will be removed along with the topic.
3834
3835 @item C-y
3836 @kindex C-y (Topic)
3837 @findex gnus-topic-yank-group
3838 Yank the previously killed group or topic
3839 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3840 before all groups.
3841
3842 So, to move a topic to the beginning of the list of topics, just hit
3843 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3844 move the cursor to the beginning of the buffer (just below the ``Gnus''
3845 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3846 paste. Like I said---E-Z.
3847
3848 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3849 you can move topics around as well as groups.
3850
3851 @end table
3852
3853 After setting up the topics the way you like them, you might wish to
3854 hide a topic, or to show it again. That's why we have the following
3855 key.
3856
3857 @table @kbd
3858
3859 @item RET
3860 @kindex RET (Topic)
3861 @findex gnus-topic-select-group
3862 @itemx SPACE
3863 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3864 When you perform this command on a group, you'll enter the group, as
3865 usual. When done on a topic line, the topic will be folded (if it was
3866 visible) or unfolded (if it was folded already). So it's basically a
3867 toggling command on topics. In addition, if you give a numerical
3868 prefix, group on that level (and lower) will be displayed.
3869
3870 @end table
3871
3872 Now for a list of other commands, in no particular order.
3873
3874 @table @kbd
3875
3876 @item T m
3877 @kindex T m (Topic)
3878 @findex gnus-topic-move-group
3879 Move the current group to some other topic
3880 (@code{gnus-topic-move-group}). This command uses the process/prefix
3881 convention (@pxref{Process/Prefix}).
3882
3883 @item T j
3884 @kindex T j (Topic)
3885 @findex gnus-topic-jump-to-topic
3886 Go to a topic (@code{gnus-topic-jump-to-topic}).
3887
3888 @item T c
3889 @kindex T c (Topic)
3890 @findex gnus-topic-copy-group
3891 Copy the current group to some other topic
3892 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3893 convention (@pxref{Process/Prefix}).
3894
3895 @item T h
3896 @kindex T h (Topic)
3897 @findex gnus-topic-hide-topic
3898 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3899 a prefix, hide the topic permanently.
3900
3901 @item T s
3902 @kindex T s (Topic)
3903 @findex gnus-topic-show-topic
3904 Show the current topic (@code{gnus-topic-show-topic}). If given
3905 a prefix, show the topic permanently.
3906
3907 @item T D
3908 @kindex T D (Topic)
3909 @findex gnus-topic-remove-group
3910 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3911 This command is mainly useful if you have the same group in several
3912 topics and wish to remove it from one of the topics. You may also
3913 remove a group from all topics, but in that case, Gnus will add it to
3914 the root topic the next time you start Gnus. In fact, all new groups
3915 (which, naturally, don't belong to any topic) will show up in the root
3916 topic.
3917
3918 This command uses the process/prefix convention
3919 (@pxref{Process/Prefix}).
3920
3921 @item T M
3922 @kindex T M (Topic)
3923 @findex gnus-topic-move-matching
3924 Move all groups that match some regular expression to a topic
3925 (@code{gnus-topic-move-matching}).
3926
3927 @item T C
3928 @kindex T C (Topic)
3929 @findex gnus-topic-copy-matching
3930 Copy all groups that match some regular expression to a topic
3931 (@code{gnus-topic-copy-matching}).
3932
3933 @item T H
3934 @kindex T H (Topic)
3935 @findex gnus-topic-toggle-display-empty-topics
3936 Toggle hiding empty topics
3937 (@code{gnus-topic-toggle-display-empty-topics}).
3938
3939 @item T #
3940 @kindex T # (Topic)
3941 @findex gnus-topic-mark-topic
3942 Mark all groups in the current topic with the process mark
3943 (@code{gnus-topic-mark-topic}). This command works recursively on
3944 sub-topics unless given a prefix.
3945
3946 @item T M-#
3947 @kindex T M-# (Topic)
3948 @findex gnus-topic-unmark-topic
3949 Remove the process mark from all groups in the current topic
3950 (@code{gnus-topic-unmark-topic}). This command works recursively on
3951 sub-topics unless given a prefix.
3952
3953 @item C-c C-x
3954 @kindex C-c C-x (Topic)
3955 @findex gnus-topic-expire-articles
3956 @cindex expiring mail
3957 Run all expirable articles in the current group or topic through the
3958 expiry process (if any)
3959 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3960
3961 @item T r
3962 @kindex T r (Topic)
3963 @findex gnus-topic-rename
3964 Rename a topic (@code{gnus-topic-rename}).
3965
3966 @item T DEL
3967 @kindex T DEL (Topic)
3968 @findex gnus-topic-delete
3969 Delete an empty topic (@code{gnus-topic-delete}).
3970
3971 @item A T
3972 @kindex A T (Topic)
3973 @findex gnus-topic-list-active
3974 List all groups that Gnus knows about in a topics-ified way
3975 (@code{gnus-topic-list-active}).
3976
3977 @item T M-n
3978 @kindex T M-n (Topic)
3979 @findex gnus-topic-goto-next-topic
3980 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3981
3982 @item T M-p
3983 @kindex T M-p (Topic)
3984 @findex gnus-topic-goto-previous-topic
3985 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3986
3987 @item G p
3988 @kindex G p (Topic)
3989 @findex gnus-topic-edit-parameters
3990 @cindex group parameters
3991 @cindex topic parameters
3992 @cindex parameters
3993 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3994 @xref{Topic Parameters}.
3995
3996 @end table
3997
3998
3999 @node Topic Variables
4000 @subsection Topic Variables
4001 @cindex topic variables
4002
4003 The previous section told you how to tell Gnus which topics to display.
4004 This section explains how to tell Gnus what to display about each topic.
4005
4006 @vindex gnus-topic-line-format
4007 The topic lines themselves are created according to the
4008 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
4009 Valid elements are:
4010
4011 @table @samp
4012 @item i
4013 Indentation.
4014 @item n
4015 Topic name.
4016 @item v
4017 Visibility.
4018 @item l
4019 Level.
4020 @item g
4021 Number of groups in the topic.
4022 @item a
4023 Number of unread articles in the topic.
4024 @item A
4025 Number of unread articles in the topic and all its subtopics.
4026 @end table
4027
4028 @vindex gnus-topic-indent-level
4029 Each sub-topic (and the groups in the sub-topics) will be indented with
4030 @code{gnus-topic-indent-level} times the topic level number of spaces.
4031 The default is 2.
4032
4033 @vindex gnus-topic-mode-hook
4034 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
4035
4036 @vindex gnus-topic-display-empty-topics
4037 The @code{gnus-topic-display-empty-topics} says whether to display even
4038 topics that have no unread articles in them. The default is @code{t}.
4039
4040
4041 @node Topic Sorting
4042 @subsection Topic Sorting
4043 @cindex topic sorting
4044
4045 You can sort the groups in each topic individually with the following
4046 commands:
4047
4048
4049 @table @kbd
4050 @item T S a
4051 @kindex T S a (Topic)
4052 @findex gnus-topic-sort-groups-by-alphabet
4053 Sort the current topic alphabetically by group name
4054 (@code{gnus-topic-sort-groups-by-alphabet}).
4055
4056 @item T S u
4057 @kindex T S u (Topic)
4058 @findex gnus-topic-sort-groups-by-unread
4059 Sort the current topic by the number of unread articles
4060 (@code{gnus-topic-sort-groups-by-unread}).
4061
4062 @item T S l
4063 @kindex T S l (Topic)
4064 @findex gnus-topic-sort-groups-by-level
4065 Sort the current topic by group level
4066 (@code{gnus-topic-sort-groups-by-level}).
4067
4068 @item T S v
4069 @kindex T S v (Topic)
4070 @findex gnus-topic-sort-groups-by-score
4071 Sort the current topic by group score
4072 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
4073
4074 @item T S r
4075 @kindex T S r (Topic)
4076 @findex gnus-topic-sort-groups-by-rank
4077 Sort the current topic by group rank
4078 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
4079
4080 @item T S m
4081 @kindex T S m (Topic)
4082 @findex gnus-topic-sort-groups-by-method
4083 Sort the current topic alphabetically by back end name
4084 (@code{gnus-topic-sort-groups-by-method}).
4085
4086 @item T S e
4087 @kindex T S e (Topic)
4088 @findex gnus-topic-sort-groups-by-server
4089 Sort the current topic alphabetically by server name
4090 (@code{gnus-topic-sort-groups-by-server}).
4091
4092 @item T S s
4093 @kindex T S s (Topic)
4094 @findex gnus-topic-sort-groups
4095 Sort the current topic according to the function(s) given by the
4096 @code{gnus-group-sort-function} variable
4097 (@code{gnus-topic-sort-groups}).
4098
4099 @end table
4100
4101 When given a prefix argument, all these commands will sort in reverse
4102 order. @xref{Sorting Groups}, for more information about group
4103 sorting.
4104
4105
4106 @node Topic Topology
4107 @subsection Topic Topology
4108 @cindex topic topology
4109 @cindex topology
4110
4111 So, let's have a look at an example group buffer:
4112
4113 @example
4114 @group
4115 Gnus
4116 Emacs -- I wuw it!
4117 3: comp.emacs
4118 2: alt.religion.emacs
4119 Naughty Emacs
4120 452: alt.sex.emacs
4121 0: comp.talk.emacs.recovery
4122 Misc
4123 8: comp.binaries.fractals
4124 13: comp.sources.unix
4125 @end group
4126 @end example
4127
4128 So, here we have one top-level topic (@samp{Gnus}), two topics under
4129 that, and one sub-topic under one of the sub-topics. (There is always
4130 just one (1) top-level topic). This topology can be expressed as
4131 follows:
4132
4133 @lisp
4134 (("Gnus" visible)
4135 (("Emacs -- I wuw it!" visible)
4136 (("Naughty Emacs" visible)))
4137 (("Misc" visible)))
4138 @end lisp
4139
4140 @vindex gnus-topic-topology
4141 This is in fact how the variable @code{gnus-topic-topology} would look
4142 for the display above. That variable is saved in the @file{.newsrc.eld}
4143 file, and shouldn't be messed with manually---unless you really want
4144 to. Since this variable is read from the @file{.newsrc.eld} file,
4145 setting it in any other startup files will have no effect.
4146
4147 This topology shows what topics are sub-topics of what topics (right),
4148 and which topics are visible. Two settings are currently
4149 allowed---@code{visible} and @code{invisible}.
4150
4151
4152 @node Topic Parameters
4153 @subsection Topic Parameters
4154 @cindex topic parameters
4155
4156 All groups in a topic will inherit group parameters from the parent
4157 (and ancestor) topic parameters. All valid group parameters are valid
4158 topic parameters (@pxref{Group Parameters}). When the agent is
4159 enabled, all agent parameters (See Agent Parameters in @ref{Category
4160 Syntax}) are also valid topic parameters.
4161
4162 In addition, the following parameters are only valid as topic
4163 parameters:
4164
4165 @table @code
4166 @item subscribe
4167 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4168 @code{subscribe} topic parameter says what groups go in what topic. Its
4169 value should be a regexp to match the groups that should go in that
4170 topic.
4171
4172 @item subscribe-level
4173 When subscribing new groups by topic (see the @code{subscribe} parameter),
4174 the group will be subscribed with the level specified in the
4175 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4176
4177 @end table
4178
4179 Group parameters (of course) override topic parameters, and topic
4180 parameters in sub-topics override topic parameters in super-topics. You
4181 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4182 verb, although you may feel free to disagree with me here.)
4183
4184 @example
4185 @group
4186 Gnus
4187 Emacs
4188 3: comp.emacs
4189 2: alt.religion.emacs
4190 452: alt.sex.emacs
4191 Relief
4192 452: alt.sex.emacs
4193 0: comp.talk.emacs.recovery
4194 Misc
4195 8: comp.binaries.fractals
4196 13: comp.sources.unix
4197 452: alt.sex.emacs
4198 @end group
4199 @end example
4200
4201 The @samp{Emacs} topic has the topic parameter @code{(score-file
4202 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4203 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4204 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4205 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4206 . "religion.SCORE")}.
4207
4208 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4209 will get the @file{relief.SCORE} home score file. If you enter the same
4210 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4211 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4212 get the @file{religion.SCORE} home score file.
4213
4214 This seems rather simple and self-evident, doesn't it? Well, yes. But
4215 there are some problems, especially with the @code{total-expiry}
4216 parameter. Say you have a mail group in two topics; one with
4217 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4218 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4219 of these topics you mean to expire articles from, so anything may
4220 happen. In fact, I hereby declare that it is @dfn{undefined} what
4221 happens. You just have to be careful if you do stuff like that.
4222
4223
4224 @node Non-ASCII Group Names
4225 @section Accessing groups of non-English names
4226 @cindex non-ascii group names
4227
4228 There are some news servers that provide groups of which the names are
4229 expressed with their native languages in the world. For instance, in a
4230 certain news server there are some newsgroups of which the names are
4231 spelled in Chinese, where people are talking in Chinese. You can, of
4232 course, subscribe to such news groups using Gnus. Currently Gnus
4233 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4234 back end but also with the @code{nnml} back end and the @code{nnrss}
4235 back end.
4236
4237 Every such group name is encoded by a certain charset in the server
4238 side (in an @acronym{NNTP} server its administrator determines the
4239 charset, but for groups in the other back ends it is determined by you).
4240 Gnus has to display the decoded ones for you in the group buffer and the
4241 article buffer, and needs to use the encoded ones when communicating
4242 with servers. However, Gnus doesn't know what charset is used for each
4243 non-@acronym{ASCII} group name. The following two variables are just
4244 the ones for telling Gnus what charset should be used for each group:
4245
4246 @table @code
4247 @item gnus-group-name-charset-method-alist
4248 @vindex gnus-group-name-charset-method-alist
4249 An alist of select methods and charsets. The default value is
4250 @code{nil}. The names of groups in the server specified by that select
4251 method are all supposed to use the corresponding charset. For example:
4252
4253 @lisp
4254 (setq gnus-group-name-charset-method-alist
4255 '(((nntp "news.com.cn") . cn-gb-2312)))
4256 @end lisp
4257
4258 Charsets specified for groups with this variable are preferred to the
4259 ones specified for the same groups with the
4260 @code{gnus-group-name-charset-group-alist} variable (see below).
4261
4262 A select method can be very long, like:
4263
4264 @lisp
4265 (nntp "gmane"
4266 (nntp-address "news.gmane.org")
4267 (nntp-end-of-line "\n")
4268 (nntp-open-connection-function
4269 nntp-open-via-rlogin-and-telnet)
4270 (nntp-via-rlogin-command "ssh")
4271 (nntp-via-rlogin-command-switches
4272 ("-C" "-t" "-e" "none"))
4273 (nntp-via-address @dots{}))
4274 @end lisp
4275
4276 In that case, you can truncate it into @code{(nntp "gmane")} in this
4277 variable. That is, it is enough to contain only the back end name and
4278 the server name.
4279
4280 @item gnus-group-name-charset-group-alist
4281 @cindex UTF-8 group names
4282 @vindex gnus-group-name-charset-group-alist
4283 An alist of regexp of group name and the charset for group names.
4284 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4285 otherwise the default is @code{nil}. For example:
4286
4287 @lisp
4288 (setq gnus-group-name-charset-group-alist
4289 '(("\\.com\\.cn:" . cn-gb-2312)
4290 (".*" . utf-8)))
4291 @end lisp
4292
4293 Note that this variable is ignored if the match is made with
4294 @code{gnus-group-name-charset-method-alist}.
4295 @end table
4296
4297 Those two variables are used also to determine the charset for encoding
4298 and decoding non-@acronym{ASCII} group names that are in the back ends
4299 other than @code{nntp}. It means that it is you who determine it. If
4300 you do nothing, the charset used for group names in those back ends will
4301 all be @code{utf-8} because of the last element of
4302 @code{gnus-group-name-charset-group-alist}.
4303
4304 There is one more important variable for non-@acronym{ASCII} group
4305 names:
4306
4307 @table @code
4308 @item nnmail-pathname-coding-system
4309 @vindex nnmail-pathname-coding-system
4310 The value of this variable should be a coding system or @code{nil}. The
4311 default is @code{nil} in Emacs, or is the aliasee of the coding system
4312 named @code{file-name} (a certain coding system of which an alias is
4313 @code{file-name}) in XEmacs.
4314
4315 The @code{nnml} back end, the @code{nnrss} back end, the agent, and
4316 the cache use non-@acronym{ASCII} group names in those files and
4317 directories. This variable overrides the value of
4318 @code{file-name-coding-system} which specifies the coding system used
4319 when encoding and decoding those file names and directory names.
4320
4321 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4322 is the only means to specify the coding system used to encode and decode
4323 file names. On the other hand, Emacs uses the value of
4324 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4325 is @code{nil} or it is bound to the value of
4326 @code{nnmail-pathname-coding-system} which is @code{nil}.
4327
4328 Normally the value of @code{default-file-name-coding-system} in Emacs or
4329 @code{nnmail-pathname-coding-system} in XEmacs is initialized according
4330 to the locale, so you will need to do nothing if the value is suitable
4331 to encode and decode non-@acronym{ASCII} group names.
4332
4333 The value of this variable (or @code{default-file-name-coding-system})
4334 does not necessarily need to be the same value that is determined by
4335 @code{gnus-group-name-charset-method-alist} and
4336 @code{gnus-group-name-charset-group-alist}.
4337
4338 If @code{default-file-name-coding-system} or this variable is
4339 initialized by default to @code{iso-latin-1} for example, although you
4340 want to subscribe to the groups spelled in Chinese, that is the most
4341 typical case where you have to customize
4342 @code{nnmail-pathname-coding-system}. The @code{utf-8} coding system is
4343 a good candidate for it. Otherwise, you may change the locale in your
4344 system so that @code{default-file-name-coding-system} or this variable
4345 may be initialized to an appropriate value.
4346 @end table
4347
4348 Note that when you copy or move articles from a non-@acronym{ASCII}
4349 group to another group, the charset used to encode and decode group
4350 names should be the same in both groups. Otherwise the Newsgroups
4351 header will be displayed incorrectly in the article buffer.
4352
4353
4354 @node Misc Group Stuff
4355 @section Misc Group Stuff
4356
4357 @menu
4358 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4359 * Group Information:: Information and help on groups and Gnus.
4360 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4361 * File Commands:: Reading and writing the Gnus files.
4362 * Sieve Commands:: Managing Sieve scripts.
4363 @end menu
4364
4365 @table @kbd
4366
4367 @item v
4368 @kindex v (Group)
4369 @cindex keys, reserved for users (Group)
4370 The key @kbd{v} is reserved for users. You can bind it to some
4371 command or better use it as a prefix key. For example:
4372
4373 @lisp
4374 (define-key gnus-group-mode-map (kbd "v j d")
4375 (lambda ()
4376 (interactive)
4377 (gnus-group-jump-to-group "nndraft:drafts")))
4378 @end lisp
4379
4380 On keys reserved for users in Emacs and on keybindings in general
4381 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
4382
4383 @item ^
4384 @kindex ^ (Group)
4385 @findex gnus-group-enter-server-mode
4386 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4387 @xref{Server Buffer}.
4388
4389 @item a
4390 @kindex a (Group)
4391 @findex gnus-group-post-news
4392 Start composing a message (a news by default)
4393 (@code{gnus-group-post-news}). If given a prefix, post to the group
4394 under the point. If the prefix is 1, prompt for a group to post to.
4395 Contrary to what the name of this function suggests, the prepared
4396 article might be a mail instead of a news, if a mail group is specified
4397 with the prefix argument. @xref{Composing Messages}.
4398
4399 @item m
4400 @kindex m (Group)
4401 @findex gnus-group-mail
4402 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4403 use the posting style of the group under the point. If the prefix is 1,
4404 prompt for a group name to find the posting style.
4405 @xref{Composing Messages}.
4406
4407 @item i
4408 @kindex i (Group)
4409 @findex gnus-group-news
4410 Start composing a news (@code{gnus-group-news}). If given a prefix,
4411 post to the group under the point. If the prefix is 1, prompt
4412 for group to post to. @xref{Composing Messages}.
4413
4414 This function actually prepares a news even when using mail groups.
4415 This is useful for ``posting'' messages to mail groups without actually
4416 sending them over the network: they're just saved directly to the group
4417 in question. The corresponding back end must have a request-post method
4418 for this to work though.
4419
4420 @item G z
4421 @kindex G z (Group)
4422 @findex gnus-group-compact-group
4423
4424 Compact the group under point (@code{gnus-group-compact-group}).
4425 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
4426 gaps between article numbers, hence getting a correct total article
4427 count.
4428
4429 @end table
4430
4431 Variables for the group buffer:
4432
4433 @table @code
4434
4435 @item gnus-group-mode-hook
4436 @vindex gnus-group-mode-hook
4437 is called after the group buffer has been
4438 created.
4439
4440 @item gnus-group-prepare-hook
4441 @vindex gnus-group-prepare-hook
4442 is called after the group buffer is
4443 generated. It may be used to modify the buffer in some strange,
4444 unnatural way.
4445
4446 @item gnus-group-prepared-hook
4447 @vindex gnus-group-prepare-hook
4448 is called as the very last thing after the group buffer has been
4449 generated. It may be used to move point around, for instance.
4450
4451 @item gnus-permanently-visible-groups
4452 @vindex gnus-permanently-visible-groups
4453 Groups matching this regexp will always be listed in the group buffer,
4454 whether they are empty or not.
4455
4456 @end table
4457
4458 @node Scanning New Messages
4459 @subsection Scanning New Messages
4460 @cindex new messages
4461 @cindex scanning new news
4462
4463 @table @kbd
4464
4465 @item g
4466 @kindex g (Group)
4467 @findex gnus-group-get-new-news
4468 @c @icon{gnus-group-get-new-news}
4469 Check the server(s) for new articles. If the numerical prefix is used,
4470 this command will check only groups of level @var{arg} and lower
4471 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4472 command will force a total re-reading of the active file(s) from the
4473 back end(s).
4474
4475 @item M-g
4476 @kindex M-g (Group)
4477 @findex gnus-group-get-new-news-this-group
4478 @vindex gnus-goto-next-group-when-activating
4479 @c @icon{gnus-group-get-new-news-this-group}
4480 Check whether new articles have arrived in the current group
4481 (@code{gnus-group-get-new-news-this-group}).
4482 @code{gnus-goto-next-group-when-activating} says whether this command is
4483 to move point to the next group or not. It is @code{t} by default.
4484
4485 @findex gnus-activate-all-groups
4486 @cindex activating groups
4487 @item C-c M-g
4488 @kindex C-c M-g (Group)
4489 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4490
4491 @item R
4492 @kindex R (Group)
4493 @cindex restarting
4494 @findex gnus-group-restart
4495 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4496 file(s), closes the connection to all servers, clears up all run-time
4497 Gnus variables, and then starts Gnus all over again.
4498
4499 @end table
4500
4501 @vindex gnus-get-new-news-hook
4502 @code{gnus-get-new-news-hook} is run just before checking for new news.
4503
4504 @vindex gnus-after-getting-new-news-hook
4505 @code{gnus-after-getting-new-news-hook} is run after checking for new
4506 news.
4507
4508
4509 @node Group Information
4510 @subsection Group Information
4511 @cindex group information
4512 @cindex information on groups
4513
4514 @table @kbd
4515
4516
4517 @item H d
4518 @itemx C-c C-d
4519 @c @icon{gnus-group-describe-group}
4520 @kindex H d (Group)
4521 @kindex C-c C-d (Group)
4522 @cindex describing groups
4523 @cindex group description
4524 @findex gnus-group-describe-group
4525 Describe the current group (@code{gnus-group-describe-group}). If given
4526 a prefix, force Gnus to re-read the description from the server.
4527
4528 @item M-d
4529 @kindex M-d (Group)
4530 @findex gnus-group-describe-all-groups
4531 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4532 prefix, force Gnus to re-read the description file from the server.
4533
4534 @item H v
4535 @itemx V
4536 @kindex V (Group)
4537 @kindex H v (Group)
4538 @cindex version
4539 @findex gnus-version
4540 Display current Gnus version numbers (@code{gnus-version}).
4541
4542 @item ?
4543 @kindex ? (Group)
4544 @findex gnus-group-describe-briefly
4545 Give a very short help message (@code{gnus-group-describe-briefly}).
4546
4547 @item C-c C-i
4548 @kindex C-c C-i (Group)
4549 @cindex info
4550 @cindex manual
4551 @findex gnus-info-find-node
4552 Go to the Gnus info node (@code{gnus-info-find-node}).
4553 @end table
4554
4555
4556 @node Group Timestamp
4557 @subsection Group Timestamp
4558 @cindex timestamps
4559 @cindex group timestamps
4560
4561 It can be convenient to let Gnus keep track of when you last read a
4562 group. To set the ball rolling, you should add
4563 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4564
4565 @lisp
4566 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4567 @end lisp
4568
4569 After doing this, each time you enter a group, it'll be recorded.
4570
4571 This information can be displayed in various ways---the easiest is to
4572 use the @samp{%d} spec in the group line format:
4573
4574 @lisp
4575 (setq gnus-group-line-format
4576 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4577 @end lisp
4578
4579 This will result in lines looking like:
4580
4581 @example
4582 * 0: mail.ding 19961002T012943
4583 0: custom 19961002T012713
4584 @end example
4585
4586 As you can see, the date is displayed in compact ISO 8601 format. This
4587 may be a bit too much, so to just display the date, you could say
4588 something like:
4589
4590 @lisp
4591 (setq gnus-group-line-format
4592 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4593 @end lisp
4594
4595 If you would like greater control of the time format, you can use a
4596 user-defined format spec. Something like the following should do the
4597 trick:
4598
4599 @lisp
4600 (setq gnus-group-line-format
4601 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4602 (defun gnus-user-format-function-d (headers)
4603 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4604 (if time
4605 (format-time-string "%b %d %H:%M" time)
4606 "")))
4607 @end lisp
4608
4609 To see what variables are dynamically bound (like
4610 @code{gnus-tmp-group}), you have to look at the source code. The
4611 variable names aren't guaranteed to be stable over Gnus versions,
4612 either.
4613
4614
4615 @node File Commands
4616 @subsection File Commands
4617 @cindex file commands
4618
4619 @table @kbd
4620
4621 @item r
4622 @kindex r (Group)
4623 @findex gnus-group-read-init-file
4624 @vindex gnus-init-file
4625 @cindex reading init file
4626 Re-read the init file (@code{gnus-init-file}, which defaults to
4627 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4628
4629 @item s
4630 @kindex s (Group)
4631 @findex gnus-group-save-newsrc
4632 @cindex saving .newsrc
4633 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4634 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4635 file(s) whether Gnus thinks it is necessary or not.
4636
4637 @c @item Z
4638 @c @kindex Z (Group)
4639 @c @findex gnus-group-clear-dribble
4640 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4641
4642 @end table
4643
4644
4645 @node Sieve Commands
4646 @subsection Sieve Commands
4647 @cindex group sieve commands
4648
4649 Sieve is a server-side mail filtering language. In Gnus you can use
4650 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4651 sieve rules that should apply to each group. Gnus provides two
4652 commands to translate all these group parameters into a proper Sieve
4653 script that can be transferred to the server somehow.
4654
4655 @vindex gnus-sieve-file
4656 @vindex gnus-sieve-region-start
4657 @vindex gnus-sieve-region-end
4658 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4659 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4660 between two delimiters, @code{gnus-sieve-region-start} and
4661 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4662 outside these delimiters that will not be removed the next time you
4663 regenerate the Sieve script.
4664
4665 @vindex gnus-sieve-crosspost
4666 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4667 is generated. If it is non-@code{nil} (the default) articles is
4668 placed in all groups that have matching rules, otherwise the article
4669 is only placed in the group with the first matching rule. For
4670 example, the group parameter @samp{(sieve address "sender"
4671 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4672 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4673 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4674 except that the line containing the call to @code{stop} is removed.)
4675
4676 @example
4677 if address "sender" "owner-ding@@hpc.uh.edu" @{
4678 fileinto "INBOX.ding";
4679 stop;
4680 @}
4681 @end example
4682
4683 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4684
4685 @table @kbd
4686
4687 @item D g
4688 @kindex D g (Group)
4689 @findex gnus-sieve-generate
4690 @vindex gnus-sieve-file
4691 @cindex generating sieve script
4692 Regenerate a Sieve script from the @code{sieve} group parameters and
4693 put you into the @code{gnus-sieve-file} without saving it.
4694
4695 @item D u
4696 @kindex D u (Group)
4697 @findex gnus-sieve-update
4698 @vindex gnus-sieve-file
4699 @cindex updating sieve script
4700 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4701 @code{sieve} group parameters, save the file and upload it to the
4702 server using the @code{sieveshell} program.
4703
4704 @end table
4705
4706
4707 @node Summary Buffer
4708 @chapter Summary Buffer
4709 @cindex summary buffer
4710
4711 A line for each article is displayed in the summary buffer. You can
4712 move around, read articles, post articles and reply to articles.
4713
4714 The most common way to a summary buffer is to select a group from the
4715 group buffer (@pxref{Selecting a Group}).
4716
4717 You can have as many summary buffers open as you wish.
4718
4719 You can customize the Summary Mode tool bar, see @kbd{M-x
4720 customize-apropos RET gnus-summary-tool-bar}. This feature is only
4721 available in Emacs.
4722
4723 @kindex v (Summary)
4724 @cindex keys, reserved for users (Summary)
4725 The key @kbd{v} is reserved for users. You can bind it to some
4726 command or better use it as a prefix key. For example:
4727 @lisp
4728 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
4729 @end lisp
4730
4731 @menu
4732 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4733 * Summary Maneuvering:: Moving around the summary buffer.
4734 * Choosing Articles:: Reading articles.
4735 * Paging the Article:: Scrolling the current article.
4736 * Reply Followup and Post:: Posting articles.
4737 * Delayed Articles:: Send articles at a later time.
4738 * Marking Articles:: Marking articles as read, expirable, etc.
4739 * Limiting:: You can limit the summary buffer.
4740 * Threading:: How threads are made.
4741 * Sorting the Summary Buffer:: How articles and threads are sorted.
4742 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4743 * Article Caching:: You may store articles in a cache.
4744 * Persistent Articles:: Making articles expiry-resistant.
4745 * Sticky Articles:: Article buffers that are not reused.
4746 * Article Backlog:: Having already read articles hang around.
4747 * Saving Articles:: Ways of customizing article saving.
4748 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4749 * Article Treatment:: The article buffer can be mangled at will.
4750 * MIME Commands:: Doing MIMEy things with the articles.
4751 * Charsets:: Character set issues.
4752 * Article Commands:: Doing various things with the article buffer.
4753 * Summary Sorting:: Sorting the summary buffer in various ways.
4754 * Finding the Parent:: No child support? Get the parent.
4755 * Alternative Approaches:: Reading using non-default summaries.
4756 * Tree Display:: A more visual display of threads.
4757 * Mail Group Commands:: Some commands can only be used in mail groups.
4758 * Various Summary Stuff:: What didn't fit anywhere else.
4759 * Exiting the Summary Buffer:: Returning to the Group buffer,
4760 or reselecting the current group.
4761 * Crosspost Handling:: How crossposted articles are dealt with.
4762 * Duplicate Suppression:: An alternative when crosspost handling fails.
4763 * Security:: Decrypt and Verify.
4764 * Mailing List:: Mailing list minor mode.
4765 @end menu
4766
4767
4768 @node Summary Buffer Format
4769 @section Summary Buffer Format
4770 @cindex summary buffer format
4771
4772 @iftex
4773 @iflatex
4774 \gnusfigure{The Summary Buffer}{180}{
4775 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4776 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4777 }
4778 @end iflatex
4779 @end iftex
4780
4781 @menu
4782 * Summary Buffer Lines:: You can specify how summary lines should look.
4783 * To From Newsgroups:: How to not display your own name.
4784 * Summary Buffer Mode Line:: You can say how the mode line should look.
4785 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4786 @end menu
4787
4788 @findex mail-extract-address-components
4789 @findex gnus-extract-address-components
4790 @vindex gnus-extract-address-components
4791 Gnus will use the value of the @code{gnus-extract-address-components}
4792 variable as a function for getting the name and address parts of a
4793 @code{From} header. Two pre-defined functions exist:
4794 @code{gnus-extract-address-components}, which is the default, quite
4795 fast, and too simplistic solution; and
4796 @code{mail-extract-address-components}, which works very nicely, but is
4797 slower. The default function will return the wrong answer in 5% of the
4798 cases. If this is unacceptable to you, use the other function instead:
4799
4800 @lisp
4801 (setq gnus-extract-address-components
4802 'mail-extract-address-components)
4803 @end lisp
4804
4805 @vindex gnus-summary-same-subject
4806 @code{gnus-summary-same-subject} is a string indicating that the current
4807 article has the same subject as the previous. This string will be used
4808 with those specs that require it. The default is @code{""}.
4809
4810
4811 @node Summary Buffer Lines
4812 @subsection Summary Buffer Lines
4813
4814 @vindex gnus-summary-line-format
4815 You can change the format of the lines in the summary buffer by changing
4816 the @code{gnus-summary-line-format} variable. It works along the same
4817 lines as a normal @code{format} string, with some extensions
4818 (@pxref{Formatting Variables}).
4819
4820 There should always be a colon or a point position marker on the line;
4821 the cursor always moves to the point position marker or the colon after
4822 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4823 possible to change this. Just write a new function
4824 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4825 @xref{Positioning Point}.
4826
4827 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4828
4829 The following format specification characters and extended format
4830 specification(s) are understood:
4831
4832 @table @samp
4833 @item N
4834 Article number.
4835 @item S
4836 Subject string. List identifiers stripped,
4837 @code{gnus-list-identifiers}. @xref{Article Hiding}.
4838 @item s
4839 Subject if the article is the root of the thread or the previous article
4840 had a different subject, @code{gnus-summary-same-subject} otherwise.
4841 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4842 @item F
4843 Full @code{From} header.
4844 @item n
4845 The name (from the @code{From} header).
4846 @item f
4847 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4848 From Newsgroups}).
4849 @item a
4850 The name (from the @code{From} header). This differs from the @code{n}
4851 spec in that it uses the function designated by the
4852 @code{gnus-extract-address-components} variable, which is slower, but
4853 may be more thorough.
4854 @item A
4855 The address (from the @code{From} header). This works the same way as
4856 the @code{a} spec.
4857 @item L
4858 Number of lines in the article.
4859 @item c
4860 Number of characters in the article. This specifier is not supported
4861 in some methods (like nnfolder).
4862 @item k
4863 Pretty-printed version of the number of characters in the article;
4864 for example, @samp{1.2k} or @samp{0.4M}.
4865 @item I
4866 Indentation based on thread level (@pxref{Customizing Threading}).
4867 @item B
4868 A complex trn-style thread tree, showing response-connecting trace
4869 lines. A thread could be drawn like this:
4870
4871 @example
4872 >
4873 +->
4874 | +->
4875 | | \->
4876 | | \->
4877 | \->
4878 +->
4879 \->
4880 @end example
4881
4882 You can customize the appearance with the following options. Note
4883 that it is possible to make the thread display look really neat by
4884 replacing the default @acronym{ASCII} characters with graphic
4885 line-drawing glyphs.
4886 @table @code
4887 @item gnus-sum-thread-tree-root
4888 @vindex gnus-sum-thread-tree-root
4889 Used for the root of a thread. If @code{nil}, use subject
4890 instead. The default is @samp{> }.
4891
4892 @item gnus-sum-thread-tree-false-root
4893 @vindex gnus-sum-thread-tree-false-root
4894 Used for the false root of a thread (@pxref{Loose Threads}). If
4895 @code{nil}, use subject instead. The default is @samp{> }.
4896
4897 @item gnus-sum-thread-tree-single-indent
4898 @vindex gnus-sum-thread-tree-single-indent
4899 Used for a thread with just one message. If @code{nil}, use subject
4900 instead. The default is @samp{}.
4901
4902 @item gnus-sum-thread-tree-vertical
4903 @vindex gnus-sum-thread-tree-vertical
4904 Used for drawing a vertical line. The default is @samp{| }.
4905
4906 @item gnus-sum-thread-tree-indent
4907 @vindex gnus-sum-thread-tree-indent
4908 Used for indenting. The default is @samp{ }.
4909
4910 @item gnus-sum-thread-tree-leaf-with-other
4911 @vindex gnus-sum-thread-tree-leaf-with-other
4912 Used for a leaf with brothers. The default is @samp{+-> }.
4913
4914 @item gnus-sum-thread-tree-single-leaf
4915 @vindex gnus-sum-thread-tree-single-leaf
4916 Used for a leaf without brothers. The default is @samp{\-> }
4917
4918 @end table
4919
4920 @item T
4921 Nothing if the article is a root and lots of spaces if it isn't (it
4922 pushes everything after it off the screen).
4923 @item [
4924 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4925 for adopted articles (@pxref{Customizing Threading}).
4926 @item ]
4927 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4928 for adopted articles.
4929 @item >
4930 One space for each thread level.
4931 @item <
4932 Twenty minus thread level spaces.
4933 @item U
4934 Unread. @xref{Read Articles}.
4935
4936 @item R
4937 This misleadingly named specifier is the @dfn{secondary mark}. This
4938 mark will say whether the article has been replied to, has been cached,
4939 or has been saved. @xref{Other Marks}.
4940
4941 @item i
4942 Score as a number (@pxref{Scoring}).
4943 @item z
4944 @vindex gnus-summary-zcore-fuzz
4945 Zcore, @samp{+} if above the default level and @samp{-} if below the
4946 default level. If the difference between
4947 @code{gnus-summary-default-score} and the score is less than
4948 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4949 @item V
4950 Total thread score.
4951 @item x
4952 @code{Xref}.
4953 @item D
4954 @code{Date}.
4955 @item d
4956 The @code{Date} in @code{DD-MMM} format.
4957 @item o
4958 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4959 @item M
4960 @code{Message-ID}.
4961 @item r
4962 @code{References}.
4963 @item t
4964 Number of articles in the current sub-thread. Using this spec will slow
4965 down summary buffer generation somewhat.
4966 @item e
4967 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4968 article has any children.
4969 @item P
4970 The line number.
4971 @item O
4972 Download mark.
4973 @item *
4974 Desired cursor position (instead of after first colon).
4975 @item &user-date;
4976 Age sensitive date format. Various date format is defined in
4977 @code{gnus-user-date-format-alist}.
4978 @item u
4979 User defined specifier. The next character in the format string should
4980 be a letter. Gnus will call the function
4981 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4982 following @samp{%u}. The function will be passed the current header as
4983 argument. The function should return a string, which will be inserted
4984 into the summary just like information from any other summary specifier.
4985 @end table
4986
4987 Text between @samp{%(} and @samp{%)} will be highlighted with
4988 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4989 There can only be one such area.
4990
4991 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4992 have to be handled with care. For reasons of efficiency, Gnus will
4993 compute what column these characters will end up in, and ``hard-code''
4994 that. This means that it is invalid to have these specs after a
4995 variable-length spec. Well, you might not be arrested, but your summary
4996 buffer will look strange, which is bad enough.
4997
4998 The smart choice is to have these specs as far to the left as possible.
4999 (Isn't that the case with everything, though? But I digress.)
5000
5001 This restriction may disappear in later versions of Gnus.
5002
5003
5004 @node To From Newsgroups
5005 @subsection To From Newsgroups
5006 @cindex To
5007 @cindex Newsgroups
5008
5009 In some groups (particularly in archive groups), the @code{From} header
5010 isn't very interesting, since all the articles there are written by
5011 you. To display the information in the @code{To} or @code{Newsgroups}
5012 headers instead, you need to decide three things: What information to
5013 gather; where to display it; and when to display it.
5014
5015 @enumerate
5016 @item
5017 @vindex gnus-extra-headers
5018 The reading of extra header information is controlled by the
5019 @code{gnus-extra-headers}. This is a list of header symbols. For
5020 instance:
5021
5022 @lisp
5023 (setq gnus-extra-headers
5024 '(To Newsgroups X-Newsreader))
5025 @end lisp
5026
5027 This will result in Gnus trying to obtain these three headers, and
5028 storing it in header structures for later easy retrieval.
5029
5030 @item
5031 @findex gnus-extra-header
5032 The value of these extra headers can be accessed via the
5033 @code{gnus-extra-header} function. Here's a format line spec that will
5034 access the @code{X-Newsreader} header:
5035
5036 @example
5037 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5038 @end example
5039
5040 @item
5041 @vindex gnus-ignored-from-addresses
5042 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5043 summary line spec returns the @code{To}, @code{Newsreader} or
5044 @code{From} header. If this regexp matches the contents of the
5045 @code{From} header, the value of the @code{To} or @code{Newsreader}
5046 headers are used instead.
5047
5048 To distinguish regular articles from those where the @code{From} field
5049 has been swapped, a string is prefixed to the @code{To} or
5050 @code{Newsgroups} header in the summary line. By default the string is
5051 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5052 customize these strings with @code{gnus-summary-to-prefix} and
5053 @code{gnus-summary-newsgroup-prefix}.
5054
5055 @end enumerate
5056
5057 @vindex nnmail-extra-headers
5058 A related variable is @code{nnmail-extra-headers}, which controls when
5059 to include extra headers when generating overview (@acronym{NOV}) files.
5060 If you have old overview files, you should regenerate them after
5061 changing this variable, by entering the server buffer using @kbd{^},
5062 and then @kbd{g} on the appropriate mail server (e.g., nnml) to cause
5063 regeneration.
5064
5065 @vindex gnus-summary-line-format
5066 You also have to instruct Gnus to display the data by changing the
5067 @code{%n} spec to the @code{%f} spec in the
5068 @code{gnus-summary-line-format} variable.
5069
5070 In summary, you'd typically put something like the following in
5071 @file{~/.gnus.el}:
5072
5073 @lisp
5074 (setq gnus-extra-headers
5075 '(To Newsgroups))
5076 (setq nnmail-extra-headers gnus-extra-headers)
5077 (setq gnus-summary-line-format
5078 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5079 (setq gnus-ignored-from-addresses
5080 "Your Name Here")
5081 @end lisp
5082
5083 (The values listed above are the default values in Gnus. Alter them
5084 to fit your needs.)
5085
5086 A note for news server administrators, or for users who wish to try to
5087 convince their news server administrator to provide some additional
5088 support:
5089
5090 The above is mostly useful for mail groups, where you have control over
5091 the @acronym{NOV} files that are created. However, if you can persuade your
5092 nntp admin to add (in the usual implementation, notably INN):
5093
5094 @example
5095 Newsgroups:full
5096 @end example
5097
5098 to the end of her @file{overview.fmt} file, then you can use that just
5099 as you would the extra headers from the mail groups.
5100
5101
5102 @node Summary Buffer Mode Line
5103 @subsection Summary Buffer Mode Line
5104
5105 @vindex gnus-summary-mode-line-format
5106 You can also change the format of the summary mode bar (@pxref{Mode Line
5107 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
5108 like. The default is @samp{Gnus: %%b [%A] %Z}.
5109
5110 Here are the elements you can play with:
5111
5112 @table @samp
5113 @item G
5114 Group name.
5115 @item p
5116 Unprefixed group name.
5117 @item A
5118 Current article number.
5119 @item z
5120 Current article score.
5121 @item V
5122 Gnus version.
5123 @item U
5124 Number of unread articles in this group.
5125 @item e
5126 Number of unread articles in this group that aren't displayed in the
5127 summary buffer.
5128 @item Z
5129 A string with the number of unread and unselected articles represented
5130 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5131 articles, and just as @samp{<%U more>} if there are just unread articles
5132 and no unselected ones.
5133 @item g
5134 Shortish group name. For instance, @samp{rec.arts.anime} will be
5135 shortened to @samp{r.a.anime}.
5136 @item S
5137 Subject of the current article.
5138 @item u
5139 User-defined spec (@pxref{User-Defined Specs}).
5140 @item s
5141 Name of the current score file (@pxref{Scoring}).
5142 @item d
5143 Number of dormant articles (@pxref{Unread Articles}).
5144 @item t
5145 Number of ticked articles (@pxref{Unread Articles}).
5146 @item r
5147 Number of articles that have been marked as read in this session.
5148 @item E
5149 Number of articles expunged by the score files.
5150 @end table
5151
5152
5153 @node Summary Highlighting
5154 @subsection Summary Highlighting
5155
5156 @table @code
5157
5158 @item gnus-visual-mark-article-hook
5159 @vindex gnus-visual-mark-article-hook
5160 This hook is run after selecting an article. It is meant to be used for
5161 highlighting the article in some way. It is not run if
5162 @code{gnus-visual} is @code{nil}.
5163
5164 @item gnus-summary-update-hook
5165 @vindex gnus-summary-update-hook
5166 This hook is called when a summary line is changed. It is not run if
5167 @code{gnus-visual} is @code{nil}.
5168
5169 @item gnus-summary-selected-face
5170 @vindex gnus-summary-selected-face
5171 This is the face (or @dfn{font} as some people call it) used to
5172 highlight the current article in the summary buffer.
5173
5174 @item gnus-summary-highlight
5175 @vindex gnus-summary-highlight
5176 Summary lines are highlighted according to this variable, which is a
5177 list where the elements are of the format @code{(@var{form}
5178 . @var{face})}. If you would, for instance, like ticked articles to be
5179 italic and high-scored articles to be bold, you could set this variable
5180 to something like
5181 @lisp
5182 (((eq mark gnus-ticked-mark) . italic)
5183 ((> score default) . bold))
5184 @end lisp
5185 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5186 @var{face} will be applied to the line.
5187 @end table
5188
5189
5190 @node Summary Maneuvering
5191 @section Summary Maneuvering
5192 @cindex summary movement
5193
5194 All the straight movement commands understand the numeric prefix and
5195 behave pretty much as you'd expect.
5196
5197 None of these commands select articles.
5198
5199 @table @kbd
5200 @item G M-n
5201 @itemx M-n
5202 @kindex M-n (Summary)
5203 @kindex G M-n (Summary)
5204 @findex gnus-summary-next-unread-subject
5205 Go to the next summary line of an unread article
5206 (@code{gnus-summary-next-unread-subject}).
5207
5208 @item G M-p
5209 @itemx M-p
5210 @kindex M-p (Summary)
5211 @kindex G M-p (Summary)
5212 @findex gnus-summary-prev-unread-subject
5213 Go to the previous summary line of an unread article
5214 (@code{gnus-summary-prev-unread-subject}).
5215
5216 @item G g
5217 @kindex G g (Summary)
5218 @findex gnus-summary-goto-subject
5219 Ask for an article number and then go to the summary line of that article
5220 without displaying the article (@code{gnus-summary-goto-subject}).
5221 @end table
5222
5223 If Gnus asks you to press a key to confirm going to the next group, you
5224 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5225 buffer, searching for the next group to read without actually returning
5226 to the group buffer.
5227
5228 Variables related to summary movement:
5229
5230 @table @code
5231
5232 @vindex gnus-auto-select-next
5233 @item gnus-auto-select-next
5234 If you issue one of the movement commands (like @kbd{n}) and there are
5235 no more unread articles after the current one, Gnus will offer to go to
5236 the next group. If this variable is @code{t} and the next group is
5237 empty, Gnus will exit summary mode and return to the group buffer. If
5238 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5239 next group with unread articles. As a special case, if this variable
5240 is @code{quietly}, Gnus will select the next group without asking for
5241 confirmation. If this variable is @code{almost-quietly}, the same
5242 will happen only if you are located on the last article in the group.
5243 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5244 command will go to the next group without confirmation. Also
5245 @pxref{Group Levels}.
5246
5247 @item gnus-auto-select-same
5248 @vindex gnus-auto-select-same
5249 If non-@code{nil}, all the movement commands will try to go to the next
5250 article with the same subject as the current. (@dfn{Same} here might
5251 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5252 for details (@pxref{Customizing Threading}).) If there are no more
5253 articles with the same subject, go to the first unread article.
5254
5255 This variable is not particularly useful if you use a threaded display.
5256
5257 @item gnus-summary-check-current
5258 @vindex gnus-summary-check-current
5259 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5260 to the next (or previous) article if the current article is unread.
5261 Instead, they will choose the current article.
5262
5263 @item gnus-auto-center-summary
5264 @vindex gnus-auto-center-summary
5265 If non-@code{nil}, Gnus will keep the point in the summary buffer
5266 centered at all times. This makes things quite tidy, but if you have a
5267 slow network connection, or simply do not like this un-Emacsism, you can
5268 set this variable to @code{nil} to get the normal Emacs scrolling
5269 action. This will also inhibit horizontal re-centering of the summary
5270 buffer, which might make it more inconvenient to read extremely long
5271 threads.
5272
5273 This variable can also be a number. In that case, center the window at
5274 the given number of lines from the top.
5275
5276 @item gnus-summary-stop-at-end-of-message
5277 @vindex gnus-summary-stop-at-end-of-message
5278 If non-@code{nil}, don't go to the next article when hitting
5279 @kbd{SPC}, and you're at the end of the article.
5280
5281 @end table
5282
5283
5284 @node Choosing Articles
5285 @section Choosing Articles
5286 @cindex selecting articles
5287
5288 @menu
5289 * Choosing Commands:: Commands for choosing articles.
5290 * Choosing Variables:: Variables that influence these commands.
5291 @end menu
5292
5293
5294 @node Choosing Commands
5295 @subsection Choosing Commands
5296
5297 None of the following movement commands understand the numeric prefix,
5298 and they all select and display an article.
5299
5300 If you want to fetch new articles or redisplay the group, see
5301 @ref{Exiting the Summary Buffer}.
5302
5303 @table @kbd
5304 @item SPACE
5305 @kindex SPACE (Summary)
5306 @findex gnus-summary-next-page
5307 Select the current article, or, if that one's read already, the next
5308 unread article (@code{gnus-summary-next-page}).
5309
5310 If you have an article window open already and you press @kbd{SPACE}
5311 again, the article will be scrolled. This lets you conveniently
5312 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5313
5314 @item G n
5315 @itemx n
5316 @kindex n (Summary)
5317 @kindex G n (Summary)
5318 @findex gnus-summary-next-unread-article
5319 @c @icon{gnus-summary-next-unread}
5320 Go to next unread article (@code{gnus-summary-next-unread-article}).
5321
5322 @item G p
5323 @itemx p
5324 @kindex p (Summary)
5325 @findex gnus-summary-prev-unread-article
5326 @c @icon{gnus-summary-prev-unread}
5327 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5328
5329 @item G N
5330 @itemx N
5331 @kindex N (Summary)
5332 @kindex G N (Summary)
5333 @findex gnus-summary-next-article
5334 Go to the next article (@code{gnus-summary-next-article}).
5335
5336 @item G P
5337 @itemx P
5338 @kindex P (Summary)
5339 @kindex G P (Summary)
5340 @findex gnus-summary-prev-article
5341 Go to the previous article (@code{gnus-summary-prev-article}).
5342
5343 @item G C-n
5344 @kindex G C-n (Summary)
5345 @findex gnus-summary-next-same-subject
5346 Go to the next article with the same subject
5347 (@code{gnus-summary-next-same-subject}).
5348
5349 @item G C-p
5350 @kindex G C-p (Summary)
5351 @findex gnus-summary-prev-same-subject
5352 Go to the previous article with the same subject
5353 (@code{gnus-summary-prev-same-subject}).
5354
5355 @item G f
5356 @itemx .
5357 @kindex G f (Summary)
5358 @kindex . (Summary)
5359 @findex gnus-summary-first-unread-article
5360 Go to the first unread article
5361 (@code{gnus-summary-first-unread-article}).
5362
5363 @item G b
5364 @itemx ,
5365 @kindex G b (Summary)
5366 @kindex , (Summary)
5367 @findex gnus-summary-best-unread-article
5368 Go to the unread article with the highest score
5369 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5370 go to the first unread article that has a score over the default score.
5371
5372 @item G l
5373 @itemx l
5374 @kindex l (Summary)
5375 @kindex G l (Summary)
5376 @findex gnus-summary-goto-last-article
5377 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5378
5379 @item G o
5380 @kindex G o (Summary)
5381 @findex gnus-summary-pop-article
5382 @cindex history
5383 @cindex article history
5384 Pop an article off the summary history and go to this article
5385 (@code{gnus-summary-pop-article}). This command differs from the
5386 command above in that you can pop as many previous articles off the
5387 history as you like, while @kbd{l} toggles the two last read articles.
5388 For a somewhat related issue (if you use these commands a lot),
5389 @pxref{Article Backlog}.
5390
5391 @item G j
5392 @itemx j
5393 @kindex j (Summary)
5394 @kindex G j (Summary)
5395 @findex gnus-summary-goto-article
5396 Ask for an article number or @code{Message-ID}, and then go to that
5397 article (@code{gnus-summary-goto-article}).
5398
5399 @end table
5400
5401
5402 @node Choosing Variables
5403 @subsection Choosing Variables
5404
5405 Some variables relevant for moving and selecting articles:
5406
5407 @table @code
5408 @item gnus-auto-extend-newsgroup
5409 @vindex gnus-auto-extend-newsgroup
5410 All the movement commands will try to go to the previous (or next)
5411 article, even if that article isn't displayed in the Summary buffer if
5412 this variable is non-@code{nil}. Gnus will then fetch the article from
5413 the server and display it in the article buffer.
5414
5415 @item gnus-select-article-hook
5416 @vindex gnus-select-article-hook
5417 This hook is called whenever an article is selected. The default is
5418 @code{nil}. If you would like each article to be saved in the Agent as
5419 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5420 hook will do so.
5421
5422 @item gnus-mark-article-hook
5423 @vindex gnus-mark-article-hook
5424 @findex gnus-summary-mark-unread-as-read
5425 @findex gnus-summary-mark-read-and-unread-as-read
5426 @findex gnus-unread-mark
5427 This hook is called whenever an article is selected. It is intended to
5428 be used for marking articles as read. The default value is
5429 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5430 mark of almost any article you read to @code{gnus-read-mark}. The only
5431 articles not affected by this function are ticked, dormant, and
5432 expirable articles. If you'd instead like to just have unread articles
5433 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5434 instead. It will leave marks like @code{gnus-low-score-mark},
5435 @code{gnus-del-mark} (and so on) alone.
5436
5437 @end table
5438
5439
5440 @node Paging the Article
5441 @section Scrolling the Article
5442 @cindex article scrolling
5443
5444 @table @kbd
5445
5446 @item SPACE
5447 @kindex SPACE (Summary)
5448 @findex gnus-summary-next-page
5449 Pressing @kbd{SPACE} will scroll the current article forward one page,
5450 or, if you have come to the end of the current article, will choose the
5451 next article (@code{gnus-summary-next-page}).
5452
5453 @vindex gnus-article-boring-faces
5454 @vindex gnus-article-skip-boring
5455 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5456 the article consists only of citations and signature, then it will be
5457 skipped; the next article will be shown instead. You can customize
5458 what is considered uninteresting with
5459 @code{gnus-article-boring-faces}. You can manually view the article's
5460 pages, no matter how boring, using @kbd{C-M-v}.
5461
5462 @item DEL
5463 @kindex DEL (Summary)
5464 @findex gnus-summary-prev-page
5465 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5466
5467 @item RET
5468 @kindex RET (Summary)
5469 @findex gnus-summary-scroll-up
5470 Scroll the current article one line forward
5471 (@code{gnus-summary-scroll-up}).
5472
5473 @item M-RET
5474 @kindex M-RET (Summary)
5475 @findex gnus-summary-scroll-down
5476 Scroll the current article one line backward
5477 (@code{gnus-summary-scroll-down}).
5478
5479 @item A g
5480 @itemx g
5481 @kindex A g (Summary)
5482 @kindex g (Summary)
5483 @findex gnus-summary-show-article
5484 @vindex gnus-summary-show-article-charset-alist
5485 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5486 given a prefix, show a completely ``raw'' article, just the way it
5487 came from the server. If given a prefix twice (i.e., @kbd{C-u C-u
5488 g'}), fetch the current article, but don't run any of the article
5489 treatment functions.
5490
5491 @cindex charset, view article with different charset
5492 If given a numerical prefix, you can do semi-manual charset stuff.
5493 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5494 encoded in the @code{cn-gb-2312} charset. If you have
5495
5496 @lisp
5497 (setq gnus-summary-show-article-charset-alist
5498 '((1 . cn-gb-2312)
5499 (2 . big5)))
5500 @end lisp
5501
5502 then you can say @kbd{C-u 1 g} to get the same effect.
5503
5504 @item A <
5505 @itemx <
5506 @kindex < (Summary)
5507 @kindex A < (Summary)
5508 @findex gnus-summary-beginning-of-article
5509 Scroll to the beginning of the article
5510 (@code{gnus-summary-beginning-of-article}).
5511
5512 @item A >
5513 @itemx >
5514 @kindex > (Summary)
5515 @kindex A > (Summary)
5516 @findex gnus-summary-end-of-article
5517 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5518
5519 @item A s
5520 @itemx s
5521 @kindex A s (Summary)
5522 @kindex s (Summary)
5523 @findex gnus-summary-isearch-article
5524 Perform an isearch in the article buffer
5525 (@code{gnus-summary-isearch-article}).
5526
5527 @item h
5528 @kindex h (Summary)
5529 @findex gnus-summary-select-article-buffer
5530 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5531
5532 @end table
5533
5534
5535 @node Reply Followup and Post
5536 @section Reply, Followup and Post
5537
5538 @menu
5539 * Summary Mail Commands:: Sending mail.
5540 * Summary Post Commands:: Sending news.
5541 * Summary Message Commands:: Other Message-related commands.
5542 * Canceling and Superseding::
5543 @end menu
5544
5545
5546 @node Summary Mail Commands
5547 @subsection Summary Mail Commands
5548 @cindex mail
5549 @cindex composing mail
5550
5551 Commands for composing a mail message:
5552
5553 @table @kbd
5554
5555 @item S r
5556 @itemx r
5557 @kindex S r (Summary)
5558 @kindex r (Summary)
5559 @findex gnus-summary-reply
5560 @c @icon{gnus-summary-mail-reply}
5561 @c @icon{gnus-summary-reply}
5562 Mail a reply to the author of the current article
5563 (@code{gnus-summary-reply}).
5564
5565 @item S R
5566 @itemx R
5567 @kindex R (Summary)
5568 @kindex S R (Summary)
5569 @findex gnus-summary-reply-with-original
5570 @c @icon{gnus-summary-reply-with-original}
5571 Mail a reply to the author of the current article and include the
5572 original message (@code{gnus-summary-reply-with-original}). This
5573 command uses the process/prefix convention.
5574
5575 @item S w
5576 @kindex S w (Summary)
5577 @findex gnus-summary-wide-reply
5578 Mail a wide reply to the author of the current article
5579 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5580 goes out to all people listed in the @code{To}, @code{From} (or
5581 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5582 present, that's used instead.
5583
5584 @item S W
5585 @kindex S W (Summary)
5586 @findex gnus-summary-wide-reply-with-original
5587 Mail a wide reply to the current article and include the original
5588 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5589 the process/prefix convention, but only uses the headers from the
5590 first article to determine the recipients.
5591
5592 @item S L
5593 @kindex S L (Summary)
5594 @findex gnus-summary-reply-to-list-with-original
5595 When replying to a message from a mailing list, send a reply to that
5596 message to the mailing list, and include the original message
5597 (@code{gnus-summary-reply-to-list-with-original}).
5598
5599 @item S v
5600 @kindex S v (Summary)
5601 @findex gnus-summary-very-wide-reply
5602 Mail a very wide reply to the author of the current article
5603 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5604 that goes out to all people listed in the @code{To}, @code{From} (or
5605 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5606 articles. This command uses the process/prefix convention.
5607
5608 @item S V
5609 @kindex S V (Summary)
5610 @findex gnus-summary-very-wide-reply-with-original
5611 Mail a very wide reply to the author of the current article and include the
5612 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5613 command uses the process/prefix convention.
5614
5615 @item S B r
5616 @kindex S B r (Summary)
5617 @findex gnus-summary-reply-broken-reply-to
5618 Mail a reply to the author of the current article but ignore the
5619 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5620 If you need this because a mailing list incorrectly sets a
5621 @code{Reply-To} header pointing to the list, you probably want to set
5622 the @code{broken-reply-to} group parameter instead, so things will work
5623 correctly. @xref{Group Parameters}.
5624
5625 @item S B R
5626 @kindex S B R (Summary)
5627 @findex gnus-summary-reply-broken-reply-to-with-original
5628 Mail a reply to the author of the current article and include the
5629 original message but ignore the @code{Reply-To} field
5630 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5631
5632 @item S o m
5633 @itemx C-c C-f
5634 @kindex S o m (Summary)
5635 @kindex C-c C-f (Summary)
5636 @findex gnus-summary-mail-forward
5637 @c @icon{gnus-summary-mail-forward}
5638 Forward the current article to some other person
5639 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5640 is forwarded according to the value of (@code{message-forward-as-mime})
5641 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5642 message and forward directly inline; if the prefix is 2, forward message
5643 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5644 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5645 directly inline; otherwise, the message is forwarded as no prefix given
5646 but use the flipped value of (@code{message-forward-as-mime}). By
5647 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5648 section.
5649
5650 @item S m
5651 @itemx m
5652 @kindex m (Summary)
5653 @kindex S m (Summary)
5654 @findex gnus-summary-mail-other-window
5655 @c @icon{gnus-summary-mail-originate}
5656 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5657 the posting style of the current group. If given a prefix, disable that.
5658 If the prefix is 1, prompt for a group name to find the posting style.
5659
5660 @item S i
5661 @kindex S i (Summary)
5662 @findex gnus-summary-news-other-window
5663 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5664 post to the current group. If given a prefix, disable that. If the
5665 prefix is 1, prompt for a group to post to.
5666
5667 This function actually prepares a news even when using mail groups.
5668 This is useful for ``posting'' messages to mail groups without actually
5669 sending them over the network: they're just saved directly to the group
5670 in question. The corresponding back end must have a request-post method
5671 for this to work though.
5672
5673 @item S D b
5674 @kindex S D b (Summary)
5675 @findex gnus-summary-resend-bounced-mail
5676 @cindex bouncing mail
5677 If you have sent a mail, but the mail was bounced back to you for some
5678 reason (wrong address, transient failure), you can use this command to
5679 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5680 will be popped into a mail buffer where you can edit the headers before
5681 sending the mail off again. If you give a prefix to this command, and
5682 the bounced mail is a reply to some other mail, Gnus will try to fetch
5683 that mail and display it for easy perusal of its headers. This might
5684 very well fail, though.
5685
5686 @item S D r
5687 @kindex S D r (Summary)
5688 @findex gnus-summary-resend-message
5689 Not to be confused with the previous command,
5690 @code{gnus-summary-resend-message} will prompt you for an address to
5691 send the current message off to, and then send it to that place. The
5692 headers of the message won't be altered---but lots of headers that say
5693 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5694 means that you actually send a mail to someone that has a @code{To}
5695 header that (probably) points to yourself. This will confuse people.
5696 So, natcherly you'll only do that if you're really eVIl.
5697
5698 This command is mainly used if you have several accounts and want to
5699 ship a mail to a different account of yours. (If you're both
5700 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5701 to the @code{root} account, you may want to resend it to
5702 @code{postmaster}. Ordnung muss sein!
5703
5704 This command understands the process/prefix convention
5705 (@pxref{Process/Prefix}).
5706
5707 @item S D e
5708 @kindex S D e (Summary)
5709 @findex gnus-summary-resend-message-edit
5710
5711 Like the previous command, but will allow you to edit the message as
5712 if it were a new message before resending.
5713
5714 @item S O m
5715 @kindex S O m (Summary)
5716 @findex gnus-uu-digest-mail-forward
5717 Digest the current series (@pxref{Decoding Articles}) and forward the
5718 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5719 uses the process/prefix convention (@pxref{Process/Prefix}).
5720
5721 @item S M-c
5722 @kindex S M-c (Summary)
5723 @findex gnus-summary-mail-crosspost-complaint
5724 @cindex crossposting
5725 @cindex excessive crossposting
5726 Send a complaint about excessive crossposting to the author of the
5727 current article (@code{gnus-summary-mail-crosspost-complaint}).
5728
5729 @findex gnus-crosspost-complaint
5730 This command is provided as a way to fight back against the current
5731 crossposting pandemic that's sweeping Usenet. It will compose a reply
5732 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5733 command understands the process/prefix convention
5734 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5735
5736 @end table
5737
5738 Also @xref{Header Commands, ,Header Commands, message, The Message
5739 Manual}, for more information.
5740
5741
5742 @node Summary Post Commands
5743 @subsection Summary Post Commands
5744 @cindex post
5745 @cindex composing news
5746
5747 Commands for posting a news article:
5748
5749 @table @kbd
5750 @item S p
5751 @itemx a
5752 @kindex a (Summary)
5753 @kindex S p (Summary)
5754 @findex gnus-summary-post-news
5755 @c @icon{gnus-summary-post-news}
5756 Prepare for posting an article (@code{gnus-summary-post-news}). By
5757 default, post to the current group. If given a prefix, disable that.
5758 If the prefix is 1, prompt for another group instead.
5759
5760 @item S f
5761 @itemx f
5762 @kindex f (Summary)
5763 @kindex S f (Summary)
5764 @findex gnus-summary-followup
5765 @c @icon{gnus-summary-followup}
5766 Post a followup to the current article (@code{gnus-summary-followup}).
5767
5768 @item S F
5769 @itemx F
5770 @kindex S F (Summary)
5771 @kindex F (Summary)
5772 @c @icon{gnus-summary-followup-with-original}
5773 @findex gnus-summary-followup-with-original
5774 Post a followup to the current article and include the original message
5775 (@code{gnus-summary-followup-with-original}). This command uses the
5776 process/prefix convention.
5777
5778 @item S n
5779 @kindex S n (Summary)
5780 @findex gnus-summary-followup-to-mail
5781 Post a followup to the current article via news, even if you got the
5782 message through mail (@code{gnus-summary-followup-to-mail}).
5783
5784 @item S N
5785 @kindex S N (Summary)
5786 @findex gnus-summary-followup-to-mail-with-original
5787 Post a followup to the current article via news, even if you got the
5788 message through mail and include the original message
5789 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5790 the process/prefix convention.
5791
5792 @item S o p
5793 @kindex S o p (Summary)
5794 @findex gnus-summary-post-forward
5795 Forward the current article to a newsgroup
5796 (@code{gnus-summary-post-forward}).
5797 If no prefix is given, the message is forwarded according to the value
5798 of (@code{message-forward-as-mime}) and
5799 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5800 message and forward directly inline; if the prefix is 2, forward message
5801 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5802 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5803 directly inline; otherwise, the message is forwarded as no prefix given
5804 but use the flipped value of (@code{message-forward-as-mime}). By
5805 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5806
5807 @item S O p
5808 @kindex S O p (Summary)
5809 @findex gnus-uu-digest-post-forward
5810 @cindex digests
5811 @cindex making digests
5812 Digest the current series and forward the result to a newsgroup
5813 (@code{gnus-uu-digest-post-forward}). This command uses the
5814 process/prefix convention.
5815
5816 @item S u
5817 @kindex S u (Summary)
5818 @findex gnus-uu-post-news
5819 @c @icon{gnus-uu-post-news}
5820 Uuencode a file, split it into parts, and post it as a series
5821 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5822 @end table
5823
5824 Also @xref{Header Commands, ,Header Commands, message, The Message
5825 Manual}, for more information.
5826
5827
5828 @node Summary Message Commands
5829 @subsection Summary Message Commands
5830
5831 @table @kbd
5832 @item S y
5833 @kindex S y (Summary)
5834 @findex gnus-summary-yank-message
5835 Yank the current article into an already existing Message composition
5836 buffer (@code{gnus-summary-yank-message}). This command prompts for
5837 what message buffer you want to yank into, and understands the
5838 process/prefix convention (@pxref{Process/Prefix}).
5839
5840 @end table
5841
5842
5843 @node Canceling and Superseding
5844 @subsection Canceling Articles
5845 @cindex canceling articles
5846 @cindex superseding articles
5847
5848 Have you ever written something, and then decided that you really,
5849 really, really wish you hadn't posted that?
5850
5851 Well, you can't cancel mail, but you can cancel posts.
5852
5853 @findex gnus-summary-cancel-article
5854 @kindex C (Summary)
5855 @c @icon{gnus-summary-cancel-article}
5856 Find the article you wish to cancel (you can only cancel your own
5857 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5858 c} (@code{gnus-summary-cancel-article}). Your article will be
5859 canceled---machines all over the world will be deleting your article.
5860 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5861
5862 Be aware, however, that not all sites honor cancels, so your article may
5863 live on here and there, while most sites will delete the article in
5864 question.
5865
5866 Gnus will use the ``current'' select method when canceling. If you
5867 want to use the standard posting method, use the @samp{a} symbolic
5868 prefix (@pxref{Symbolic Prefixes}).
5869
5870 Gnus ensures that only you can cancel your own messages using a
5871 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5872 message, Message Manual}).
5873
5874 If you discover that you have made some mistakes and want to do some
5875 corrections, you can post a @dfn{superseding} article that will replace
5876 your original article.
5877
5878 @findex gnus-summary-supersede-article
5879 @kindex S (Summary)
5880 Go to the original article and press @kbd{S s}
5881 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5882 where you can edit the article all you want before sending it off the
5883 usual way.
5884
5885 The same goes for superseding as for canceling, only more so: Some
5886 sites do not honor superseding. On those sites, it will appear that you
5887 have posted almost the same article twice.
5888
5889 If you have just posted the article, and change your mind right away,
5890 there is a trick you can use to cancel/supersede the article without
5891 waiting for the article to appear on your site first. You simply return
5892 to the post buffer (which is called @file{*sent ...*}). There you will
5893 find the article you just posted, with all the headers intact. Change
5894 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5895 header by substituting one of those words for the word
5896 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5897 you would do normally. The previous article will be
5898 canceled/superseded.
5899
5900 Just remember, kids: There is no 'c' in 'supersede'.
5901
5902 @node Delayed Articles
5903 @section Delayed Articles
5904 @cindex delayed sending
5905 @cindex send delayed
5906
5907 Sometimes, you might wish to delay the sending of a message. For
5908 example, you might wish to arrange for a message to turn up just in time
5909 to remind your about the birthday of your Significant Other. For this,
5910 there is the @code{gnus-delay} package. Setup is simple:
5911
5912 @lisp
5913 (gnus-delay-initialize)
5914 @end lisp
5915
5916 @findex gnus-delay-article
5917 Normally, to send a message you use the @kbd{C-c C-c} command from
5918 Message mode. To delay a message, use @kbd{C-c C-j}
5919 (@code{gnus-delay-article}) instead. This will ask you for how long the
5920 message should be delayed. Possible answers are:
5921
5922 @itemize @bullet
5923 @item
5924 A time span. Consists of an integer and a letter. For example,
5925 @code{42d} means to delay for 42 days. Available letters are @code{m}
5926 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5927 (months) and @code{Y} (years).
5928
5929 @item
5930 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5931 delayed until that day, at a specific time (eight o'clock by default).
5932 See also @code{gnus-delay-default-hour}.
5933
5934 @item
5935 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5936 stuff. The deadline will be at that time today, except if that time has
5937 already passed, then it's at the given time tomorrow. So if it's ten
5938 o'clock in the morning and you specify @code{11:15}, then the deadline
5939 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5940 that means a time tomorrow.
5941 @end itemize
5942
5943 The action of the @code{gnus-delay-article} command is influenced by a
5944 couple of variables:
5945
5946 @table @code
5947 @item gnus-delay-default-hour
5948 @vindex gnus-delay-default-hour
5949 When you specify a specific date, the message will be due on that hour
5950 on the given date. Possible values are integers 0 through 23.
5951
5952 @item gnus-delay-default-delay
5953 @vindex gnus-delay-default-delay
5954 This is a string and gives the default delay. It can be of any of the
5955 formats described above.
5956
5957 @item gnus-delay-group
5958 @vindex gnus-delay-group
5959 Delayed articles will be kept in this group on the drafts server until
5960 they are due. You probably don't need to change this. The default
5961 value is @code{"delayed"}.
5962
5963 @item gnus-delay-header
5964 @vindex gnus-delay-header
5965 The deadline for each article will be stored in a header. This variable
5966 is a string and gives the header name. You probably don't need to
5967 change this. The default value is @code{"X-Gnus-Delayed"}.
5968 @end table
5969
5970 The way delaying works is like this: when you use the
5971 @code{gnus-delay-article} command, you give a certain delay. Gnus
5972 calculates the deadline of the message and stores it in the
5973 @code{X-Gnus-Delayed} header and puts the message in the
5974 @code{nndraft:delayed} group.
5975
5976 @findex gnus-delay-send-queue
5977 And whenever you get new news, Gnus looks through the group for articles
5978 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5979 function for this. By default, this function is added to the hook
5980 @code{gnus-get-new-news-hook}. But of course, you can change this.
5981 Maybe you want to use the demon to send drafts? Just tell the demon to
5982 execute the @code{gnus-delay-send-queue} function.
5983
5984 @table @code
5985 @item gnus-delay-initialize
5986 @findex gnus-delay-initialize
5987 By default, this function installs @code{gnus-delay-send-queue} in
5988 @code{gnus-get-new-news-hook}. But it accepts the optional second
5989 argument @code{no-check}. If it is non-@code{nil},
5990 @code{gnus-get-new-news-hook} is not changed. The optional first
5991 argument is ignored.
5992
5993 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5994 Presumably, you want to use the demon for sending due delayed articles.
5995 Just don't forget to set that up :-)
5996 @end table
5997
5998 When delaying an article with @kbd{C-c C-j}, Message mode will
5999 automatically add a @code{"Date"} header with the current time. In
6000 many cases you probably want the @code{"Date"} header to reflect the
6001 time the message is sent instead. To do this, you have to delete
6002 @code{Date} from @code{message-draft-headers}.
6003
6004
6005 @node Marking Articles
6006 @section Marking Articles
6007 @cindex article marking
6008 @cindex article ticking
6009 @cindex marks
6010
6011 There are several marks you can set on an article.
6012
6013 You have marks that decide the @dfn{readedness} (whoo, neato-keano
6014 neologism ohoy!) of the article. Alphabetic marks generally mean
6015 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
6016
6017 In addition, you also have marks that do not affect readedness.
6018
6019 @ifinfo
6020 There's a plethora of commands for manipulating these marks.
6021 @end ifinfo
6022
6023 @menu
6024 * Unread Articles:: Marks for unread articles.
6025 * Read Articles:: Marks for read articles.
6026 * Other Marks:: Marks that do not affect readedness.
6027 * Setting Marks:: How to set and remove marks.
6028 * Generic Marking Commands:: How to customize the marking.
6029 * Setting Process Marks:: How to mark articles for later processing.
6030 @end menu
6031
6032
6033 @node Unread Articles
6034 @subsection Unread Articles
6035
6036 The following marks mark articles as (kinda) unread, in one form or
6037 other.
6038
6039 @table @samp
6040 @item !
6041 @vindex gnus-ticked-mark
6042 Marked as ticked (@code{gnus-ticked-mark}).
6043
6044 @dfn{Ticked articles} are articles that will remain visible always. If
6045 you see an article that you find interesting, or you want to put off
6046 reading it, or replying to it, until sometime later, you'd typically
6047 tick it. However, articles can be expired (from news servers by the
6048 news server software, Gnus itself never expires ticked messages), so if
6049 you want to keep an article forever, you'll have to make it persistent
6050 (@pxref{Persistent Articles}).
6051
6052 @item ?
6053 @vindex gnus-dormant-mark
6054 Marked as dormant (@code{gnus-dormant-mark}).
6055
6056 @dfn{Dormant articles} will only appear in the summary buffer if there
6057 are followups to it. If you want to see them even if they don't have
6058 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6059 Otherwise (except for the visibility issue), they are just like ticked
6060 messages.
6061
6062 @item SPACE
6063 @vindex gnus-unread-mark
6064 Marked as unread (@code{gnus-unread-mark}).
6065
6066 @dfn{Unread articles} are articles that haven't been read at all yet.
6067 @end table
6068
6069
6070 @node Read Articles
6071 @subsection Read Articles
6072 @cindex expirable mark
6073
6074 All the following marks mark articles as read.
6075
6076 @table @samp
6077
6078 @item r
6079 @vindex gnus-del-mark
6080 These are articles that the user has marked as read with the @kbd{d}
6081 command manually, more or less (@code{gnus-del-mark}).
6082
6083 @item R
6084 @vindex gnus-read-mark
6085 Articles that have actually been read (@code{gnus-read-mark}).
6086
6087 @item O
6088 @vindex gnus-ancient-mark
6089 Articles that were marked as read in previous sessions and are now
6090 @dfn{old} (@code{gnus-ancient-mark}).
6091
6092 @item K
6093 @vindex gnus-killed-mark
6094 Marked as killed (@code{gnus-killed-mark}).
6095
6096 @item X
6097 @vindex gnus-kill-file-mark
6098 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6099
6100 @item Y
6101 @vindex gnus-low-score-mark
6102 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6103
6104 @item C
6105 @vindex gnus-catchup-mark
6106 Marked as read by a catchup (@code{gnus-catchup-mark}).
6107
6108 @item G
6109 @vindex gnus-canceled-mark
6110 Canceled article (@code{gnus-canceled-mark})
6111
6112 @item Q
6113 @vindex gnus-sparse-mark
6114 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
6115 Threading}.
6116
6117 @item M
6118 @vindex gnus-duplicate-mark
6119 Article marked as read by duplicate suppression
6120 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
6121
6122 @end table
6123
6124 All these marks just mean that the article is marked as read, really.
6125 They are interpreted differently when doing adaptive scoring, though.
6126
6127 One more special mark, though:
6128
6129 @table @samp
6130 @item E
6131 @vindex gnus-expirable-mark
6132 Marked as expirable (@code{gnus-expirable-mark}).
6133
6134 Marking articles as @dfn{expirable} (or have them marked as such
6135 automatically) doesn't make much sense in normal groups---a user doesn't
6136 control expiring of news articles, but in mail groups, for instance,
6137 articles marked as @dfn{expirable} can be deleted by Gnus at
6138 any time.
6139 @end table
6140
6141
6142 @node Other Marks
6143 @subsection Other Marks
6144 @cindex process mark
6145 @cindex bookmarks
6146
6147 There are some marks that have nothing to do with whether the article is
6148 read or not.
6149
6150 @itemize @bullet
6151
6152 @item
6153 You can set a bookmark in the current article. Say you are reading a
6154 long thesis on cats' urinary tracts, and have to go home for dinner
6155 before you've finished reading the thesis. You can then set a bookmark
6156 in the article, and Gnus will jump to this bookmark the next time it
6157 encounters the article. @xref{Setting Marks}.
6158
6159 @item
6160 @vindex gnus-replied-mark
6161 All articles that you have replied to or made a followup to (i.e., have
6162 answered) will be marked with an @samp{A} in the second column
6163 (@code{gnus-replied-mark}).
6164
6165 @item
6166 @vindex gnus-forwarded-mark
6167 All articles that you have forwarded will be marked with an @samp{F} in
6168 the second column (@code{gnus-forwarded-mark}).
6169
6170 @item
6171 @vindex gnus-cached-mark
6172 Articles stored in the article cache will be marked with an @samp{*} in
6173 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6174
6175 @item
6176 @vindex gnus-saved-mark
6177 Articles ``saved'' (in some manner or other; not necessarily
6178 religiously) are marked with an @samp{S} in the second column
6179 (@code{gnus-saved-mark}).
6180
6181 @item
6182 @vindex gnus-unseen-mark
6183 Articles that haven't been seen before in Gnus by the user are marked
6184 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6185
6186 @item
6187 @vindex gnus-downloaded-mark
6188 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6189 downloaded for unplugged (offline) viewing. If you are using the
6190 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6191 (The variable @code{gnus-downloaded-mark} controls which character to
6192 use.)
6193
6194 @item
6195 @vindex gnus-undownloaded-mark
6196 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6197 not have been downloaded. Such articles cannot be viewed while you
6198 are unplugged (offline). If you are using the @samp{%O} spec, these
6199 articles get the @samp{-} mark in that spec. (The variable
6200 @code{gnus-undownloaded-mark} controls which character to use.)
6201
6202 @item
6203 @vindex gnus-downloadable-mark
6204 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6205 automatically, but it is also possible to explicitly mark articles for
6206 download, even if they would not be downloaded automatically. Such
6207 explicitly-marked articles get the @samp{%} mark in the first column.
6208 (The variable @code{gnus-downloadable-mark} controls which character to
6209 use.)
6210
6211 @item
6212 @vindex gnus-not-empty-thread-mark
6213 @vindex gnus-empty-thread-mark
6214 If the @samp{%e} spec is used, the presence of threads or not will be
6215 marked with @code{gnus-not-empty-thread-mark} and
6216 @code{gnus-empty-thread-mark} in the third column, respectively.
6217
6218 @item
6219 @vindex gnus-process-mark
6220 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6221 variety of commands react to the presence of the process mark. For
6222 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6223 all articles that have been marked with the process mark. Articles
6224 marked with the process mark have a @samp{#} in the second column.
6225
6226 @end itemize
6227
6228 You might have noticed that most of these ``non-readedness'' marks
6229 appear in the second column by default. So if you have a cached, saved,
6230 replied article that you have process-marked, what will that look like?
6231
6232 Nothing much. The precedence rules go as follows: process -> cache ->
6233 replied -> saved. So if the article is in the cache and is replied,
6234 you'll only see the cache mark and not the replied mark.
6235
6236
6237 @node Setting Marks
6238 @subsection Setting Marks
6239 @cindex setting marks
6240
6241 All the marking commands understand the numeric prefix.
6242
6243 @table @kbd
6244 @item M c
6245 @itemx M-u
6246 @kindex M c (Summary)
6247 @kindex M-u (Summary)
6248 @findex gnus-summary-clear-mark-forward
6249 @cindex mark as unread
6250 Clear all readedness-marks from the current article
6251 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6252 article as unread.
6253
6254 @item M t
6255 @itemx !
6256 @kindex ! (Summary)
6257 @kindex M t (Summary)
6258 @findex gnus-summary-tick-article-forward
6259 Tick the current article (@code{gnus-summary-tick-article-forward}).
6260 @xref{Article Caching}.
6261
6262 @item M ?
6263 @itemx ?
6264 @kindex ? (Summary)
6265 @kindex M ? (Summary)
6266 @findex gnus-summary-mark-as-dormant
6267 Mark the current article as dormant
6268 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6269
6270 @item M d
6271 @itemx d
6272 @kindex M d (Summary)
6273 @kindex d (Summary)
6274 @findex gnus-summary-mark-as-read-forward
6275 Mark the current article as read
6276 (@code{gnus-summary-mark-as-read-forward}).
6277
6278 @item D
6279 @kindex D (Summary)
6280 @findex gnus-summary-mark-as-read-backward
6281 Mark the current article as read and move point to the previous line
6282 (@code{gnus-summary-mark-as-read-backward}).
6283
6284 @item M k
6285 @itemx k
6286 @kindex k (Summary)
6287 @kindex M k (Summary)
6288 @findex gnus-summary-kill-same-subject-and-select
6289 Mark all articles that have the same subject as the current one as read,
6290 and then select the next unread article
6291 (@code{gnus-summary-kill-same-subject-and-select}).
6292
6293 @item M K
6294 @itemx C-k
6295 @kindex M K (Summary)
6296 @kindex C-k (Summary)
6297 @findex gnus-summary-kill-same-subject
6298 Mark all articles that have the same subject as the current one as read
6299 (@code{gnus-summary-kill-same-subject}).
6300
6301 @item M C
6302 @kindex M C (Summary)
6303 @findex gnus-summary-catchup
6304 @c @icon{gnus-summary-catchup}
6305 Mark all unread articles as read (@code{gnus-summary-catchup}).
6306
6307 @item M C-c
6308 @kindex M C-c (Summary)
6309 @findex gnus-summary-catchup-all
6310 Mark all articles in the group as read---even the ticked and dormant
6311 articles (@code{gnus-summary-catchup-all}).
6312
6313 @item M H
6314 @kindex M H (Summary)
6315 @findex gnus-summary-catchup-to-here
6316 Catchup the current group to point (before the point)
6317 (@code{gnus-summary-catchup-to-here}).
6318
6319 @item M h
6320 @kindex M h (Summary)
6321 @findex gnus-summary-catchup-from-here
6322 Catchup the current group from point (after the point)
6323 (@code{gnus-summary-catchup-from-here}).
6324
6325 @item C-w
6326 @kindex C-w (Summary)
6327 @findex gnus-summary-mark-region-as-read
6328 Mark all articles between point and mark as read
6329 (@code{gnus-summary-mark-region-as-read}).
6330
6331 @item M V k
6332 @kindex M V k (Summary)
6333 @findex gnus-summary-kill-below
6334 Kill all articles with scores below the default score (or below the
6335 numeric prefix) (@code{gnus-summary-kill-below}).
6336
6337 @item M e
6338 @itemx E
6339 @kindex M e (Summary)
6340 @kindex E (Summary)
6341 @findex gnus-summary-mark-as-expirable
6342 Mark the current article as expirable
6343 (@code{gnus-summary-mark-as-expirable}).
6344
6345 @item M b
6346 @kindex M b (Summary)
6347 @findex gnus-summary-set-bookmark
6348 Set a bookmark in the current article
6349 (@code{gnus-summary-set-bookmark}).
6350
6351 @item M B
6352 @kindex M B (Summary)
6353 @findex gnus-summary-remove-bookmark
6354 Remove the bookmark from the current article
6355 (@code{gnus-summary-remove-bookmark}).
6356
6357 @item M V c
6358 @kindex M V c (Summary)
6359 @findex gnus-summary-clear-above
6360 Clear all marks from articles with scores over the default score (or
6361 over the numeric prefix) (@code{gnus-summary-clear-above}).
6362
6363 @item M V u
6364 @kindex M V u (Summary)
6365 @findex gnus-summary-tick-above
6366 Tick all articles with scores over the default score (or over the
6367 numeric prefix) (@code{gnus-summary-tick-above}).
6368
6369 @item M V m
6370 @kindex M V m (Summary)
6371 @findex gnus-summary-mark-above
6372 Prompt for a mark, and mark all articles with scores over the default
6373 score (or over the numeric prefix) with this mark
6374 (@code{gnus-summary-clear-above}).
6375 @end table
6376
6377 @vindex gnus-summary-goto-unread
6378 The @code{gnus-summary-goto-unread} variable controls what action should
6379 be taken after setting a mark. If non-@code{nil}, point will move to
6380 the next/previous unread article. If @code{nil}, point will just move
6381 one line up or down. As a special case, if this variable is
6382 @code{never}, all the marking commands as well as other commands (like
6383 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6384 The default is @code{t}.
6385
6386
6387 @node Generic Marking Commands
6388 @subsection Generic Marking Commands
6389
6390 Some people would like the command that ticks an article (@kbd{!}) to
6391 go to the next article. Others would like it to go to the next unread
6392 article. Yet others would like it to stay on the current article.
6393 And even though I haven't heard of anybody wanting it to go to the
6394 previous (unread) article, I'm sure there are people that want that as
6395 well.
6396
6397 Multiply these five behaviors with five different marking commands, and
6398 you get a potentially complex set of variable to control what each
6399 command should do.
6400
6401 To sidestep that mess, Gnus provides commands that do all these
6402 different things. They can be found on the @kbd{M M} map in the summary
6403 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6404 to list in this manual.
6405
6406 While you can use these commands directly, most users would prefer
6407 altering the summary mode keymap. For instance, if you would like the
6408 @kbd{!} command to go to the next article instead of the next unread
6409 article, you could say something like:
6410
6411 @lisp
6412 @group
6413 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6414 (defun my-alter-summary-map ()
6415 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6416 @end group
6417 @end lisp
6418
6419 @noindent
6420 or
6421
6422 @lisp
6423 (defun my-alter-summary-map ()
6424 (local-set-key "!" "MM!n"))
6425 @end lisp
6426
6427
6428 @node Setting Process Marks
6429 @subsection Setting Process Marks
6430 @cindex setting process marks
6431
6432 Process marks are displayed as @code{#} in the summary buffer, and are
6433 used for marking articles in such a way that other commands will
6434 process these articles. For instance, if you process mark four
6435 articles and then use the @kbd{*} command, Gnus will enter these four
6436 articles into the cache. For more information,
6437 @pxref{Process/Prefix}.
6438
6439 @table @kbd
6440
6441 @item M P p
6442 @itemx #
6443 @kindex # (Summary)
6444 @kindex M P p (Summary)
6445 @findex gnus-summary-mark-as-processable
6446 Mark the current article with the process mark
6447 (@code{gnus-summary-mark-as-processable}).
6448 @findex gnus-summary-unmark-as-processable
6449
6450 @item M P u
6451 @itemx M-#
6452 @kindex M P u (Summary)
6453 @kindex M-# (Summary)
6454 Remove the process mark, if any, from the current article
6455 (@code{gnus-summary-unmark-as-processable}).
6456
6457 @item M P U
6458 @kindex M P U (Summary)
6459 @findex gnus-summary-unmark-all-processable
6460 Remove the process mark from all articles
6461 (@code{gnus-summary-unmark-all-processable}).
6462
6463 @item M P i
6464 @kindex M P i (Summary)
6465 @findex gnus-uu-invert-processable
6466 Invert the list of process marked articles
6467 (@code{gnus-uu-invert-processable}).
6468
6469 @item M P R
6470 @kindex M P R (Summary)
6471 @findex gnus-uu-mark-by-regexp
6472 Mark articles that have a @code{Subject} header that matches a regular
6473 expression (@code{gnus-uu-mark-by-regexp}).
6474
6475 @item M P G
6476 @kindex M P G (Summary)
6477 @findex gnus-uu-unmark-by-regexp
6478 Unmark articles that have a @code{Subject} header that matches a regular
6479 expression (@code{gnus-uu-unmark-by-regexp}).
6480
6481 @item M P r
6482 @kindex M P r (Summary)
6483 @findex gnus-uu-mark-region
6484 Mark articles in region (@code{gnus-uu-mark-region}).
6485
6486 @item M P g
6487 @kindex M P g (Summary)
6488 @findex gnus-uu-unmark-region
6489 Unmark articles in region (@code{gnus-uu-unmark-region}).
6490
6491 @item M P t
6492 @kindex M P t (Summary)
6493 @findex gnus-uu-mark-thread
6494 Mark all articles in the current (sub)thread
6495 (@code{gnus-uu-mark-thread}).
6496
6497 @item M P T
6498 @kindex M P T (Summary)
6499 @findex gnus-uu-unmark-thread
6500 Unmark all articles in the current (sub)thread
6501 (@code{gnus-uu-unmark-thread}).
6502
6503 @item M P v
6504 @kindex M P v (Summary)
6505 @findex gnus-uu-mark-over
6506 Mark all articles that have a score above the prefix argument
6507 (@code{gnus-uu-mark-over}).
6508
6509 @item M P s
6510 @kindex M P s (Summary)
6511 @findex gnus-uu-mark-series
6512 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6513
6514 @item M P S
6515 @kindex M P S (Summary)
6516 @findex gnus-uu-mark-sparse
6517 Mark all series that have already had some articles marked
6518 (@code{gnus-uu-mark-sparse}).
6519
6520 @item M P a
6521 @kindex M P a (Summary)
6522 @findex gnus-uu-mark-all
6523 Mark all articles in series order (@code{gnus-uu-mark-all}).
6524
6525 @item M P b
6526 @kindex M P b (Summary)
6527 @findex gnus-uu-mark-buffer
6528 Mark all articles in the buffer in the order they appear
6529 (@code{gnus-uu-mark-buffer}).
6530
6531 @item M P k
6532 @kindex M P k (Summary)
6533 @findex gnus-summary-kill-process-mark
6534 Push the current process mark set onto the stack and unmark all articles
6535 (@code{gnus-summary-kill-process-mark}).
6536
6537 @item M P y
6538 @kindex M P y (Summary)
6539 @findex gnus-summary-yank-process-mark
6540 Pop the previous process mark set from the stack and restore it
6541 (@code{gnus-summary-yank-process-mark}).
6542
6543 @item M P w
6544 @kindex M P w (Summary)
6545 @findex gnus-summary-save-process-mark
6546 Push the current process mark set onto the stack
6547 (@code{gnus-summary-save-process-mark}).
6548
6549 @end table
6550
6551 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6552 set process marks based on article body contents.
6553
6554
6555 @node Limiting
6556 @section Limiting
6557 @cindex limiting
6558
6559 It can be convenient to limit the summary buffer to just show some
6560 subset of the articles currently in the group. The effect most limit
6561 commands have is to remove a few (or many) articles from the summary
6562 buffer.
6563
6564 Limiting commands work on subsets of the articles already fetched from
6565 the servers. These commands don't query the server for additional
6566 articles.
6567
6568 @table @kbd
6569
6570 @item / /
6571 @itemx / s
6572 @kindex / / (Summary)
6573 @findex gnus-summary-limit-to-subject
6574 Limit the summary buffer to articles that match some subject
6575 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6576 matching articles.
6577
6578 @item / a
6579 @kindex / a (Summary)
6580 @findex gnus-summary-limit-to-author
6581 Limit the summary buffer to articles that match some author
6582 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6583 matching articles.
6584
6585 @item / R
6586 @kindex / R (Summary)
6587 @findex gnus-summary-limit-to-recipient
6588 Limit the summary buffer to articles that match some recipient
6589 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6590 matching articles.
6591
6592 @item / A
6593 @kindex / A (Summary)
6594 @findex gnus-summary-limit-to-address
6595 Limit the summary buffer to articles in which contents of From, To or Cc
6596 header match a given address (@code{gnus-summary-limit-to-address}). If
6597 given a prefix, exclude matching articles.
6598
6599 @item / S
6600 @kindex / S (Summary)
6601 @findex gnus-summary-limit-to-singletons
6602 Limit the summary buffer to articles that aren't part of any displayed
6603 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
6604 limit to articles that are part of displayed threads.
6605
6606 @item / x
6607 @kindex / x (Summary)
6608 @findex gnus-summary-limit-to-extra
6609 Limit the summary buffer to articles that match one of the ``extra''
6610 headers (@pxref{To From Newsgroups})
6611 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6612 matching articles.
6613
6614 @item / u
6615 @itemx x
6616 @kindex / u (Summary)
6617 @kindex x (Summary)
6618 @findex gnus-summary-limit-to-unread
6619 Limit the summary buffer to articles not marked as read
6620 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6621 buffer to articles strictly unread. This means that ticked and
6622 dormant articles will also be excluded.
6623
6624 @item / m
6625 @kindex / m (Summary)
6626 @findex gnus-summary-limit-to-marks
6627 Ask for a mark and then limit to all articles that have been marked
6628 with that mark (@code{gnus-summary-limit-to-marks}).
6629
6630 @item / t
6631 @kindex / t (Summary)
6632 @findex gnus-summary-limit-to-age
6633 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6634 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6635 articles younger than that number of days.
6636
6637 @item / n
6638 @kindex / n (Summary)
6639 @findex gnus-summary-limit-to-articles
6640 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
6641 articles. If not given a prefix, use the process marked articles
6642 instead. (@code{gnus-summary-limit-to-articles}).
6643
6644 @item / w
6645 @kindex / w (Summary)
6646 @findex gnus-summary-pop-limit
6647 Pop the previous limit off the stack and restore it
6648 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6649 the stack.
6650
6651 @item / .
6652 @kindex / . (Summary)
6653 @findex gnus-summary-limit-to-unseen
6654 Limit the summary buffer to the unseen articles
6655 (@code{gnus-summary-limit-to-unseen}).
6656
6657 @item / v
6658 @kindex / v (Summary)
6659 @findex gnus-summary-limit-to-score
6660 Limit the summary buffer to articles that have a score at or above some
6661 score (@code{gnus-summary-limit-to-score}).
6662
6663 @item / p
6664 @kindex / p (Summary)
6665 @findex gnus-summary-limit-to-display-predicate
6666 Limit the summary buffer to articles that satisfy the @code{display}
6667 group parameter predicate
6668 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6669 Parameters}, for more on this predicate.
6670
6671 @item / r
6672 @kindex / r (Summary)
6673 @findex gnus-summary-limit-to-replied
6674 Limit the summary buffer to replied articles
6675 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6676 replied articles.
6677
6678 @item / E
6679 @itemx M S
6680 @kindex M S (Summary)
6681 @kindex / E (Summary)
6682 @findex gnus-summary-limit-include-expunged
6683 Include all expunged articles in the limit
6684 (@code{gnus-summary-limit-include-expunged}).
6685
6686 @item / D
6687 @kindex / D (Summary)
6688 @findex gnus-summary-limit-include-dormant
6689 Include all dormant articles in the limit
6690 (@code{gnus-summary-limit-include-dormant}).
6691
6692 @item / *
6693 @kindex / * (Summary)
6694 @findex gnus-summary-limit-include-cached
6695 Include all cached articles in the limit
6696 (@code{gnus-summary-limit-include-cached}).
6697
6698 @item / d
6699 @kindex / d (Summary)
6700 @findex gnus-summary-limit-exclude-dormant
6701 Exclude all dormant articles from the limit
6702 (@code{gnus-summary-limit-exclude-dormant}).
6703
6704 @item / M
6705 @kindex / M (Summary)
6706 @findex gnus-summary-limit-exclude-marks
6707 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6708
6709 @item / T
6710 @kindex / T (Summary)
6711 @findex gnus-summary-limit-include-thread
6712 Include all the articles in the current thread in the limit.
6713
6714 @item / c
6715 @kindex / c (Summary)
6716 @findex gnus-summary-limit-exclude-childless-dormant
6717 Exclude all dormant articles that have no children from the limit@*
6718 (@code{gnus-summary-limit-exclude-childless-dormant}).
6719
6720 @item / C
6721 @kindex / C (Summary)
6722 @findex gnus-summary-limit-mark-excluded-as-read
6723 Mark all excluded unread articles as read
6724 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6725 also mark excluded ticked and dormant articles as read.
6726
6727 @item / b
6728 @kindex / b (Summary)
6729 @findex gnus-summary-limit-to-bodies
6730 Limit the summary buffer to articles that have bodies that match a
6731 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
6732 prefix, reverse the limit. This command is quite slow since it
6733 requires selecting each article to find the matches.
6734
6735 @item / h
6736 @kindex / h (Summary)
6737 @findex gnus-summary-limit-to-headers
6738 Like the previous command, only limit to headers instead
6739 (@code{gnus-summary-limit-to-headers}).
6740
6741 @end table
6742
6743
6744 The following commands aren't limiting commands, but use the @kbd{/}
6745 prefix as well.
6746
6747 @table @kbd
6748 @item / N
6749 @kindex / N (Summary)
6750 @findex gnus-summary-insert-new-articles
6751 Insert all new articles in the summary buffer. It scans for new emails
6752 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6753
6754 @item / o
6755 @kindex / o (Summary)
6756 @findex gnus-summary-insert-old-articles
6757 Insert all old articles in the summary buffer. If given a numbered
6758 prefix, fetch this number of articles.
6759
6760 @end table
6761
6762
6763 @node Threading
6764 @section Threading
6765 @cindex threading
6766 @cindex article threading
6767
6768 Gnus threads articles by default. @dfn{To thread} is to put responses
6769 to articles directly after the articles they respond to---in a
6770 hierarchical fashion.
6771
6772 Threading is done by looking at the @code{References} headers of the
6773 articles. In a perfect world, this would be enough to build pretty
6774 trees, but unfortunately, the @code{References} header is often broken
6775 or simply missing. Weird news propagation exacerbates the problem,
6776 so one has to employ other heuristics to get pleasing results. A
6777 plethora of approaches exists, as detailed in horrible detail in
6778 @ref{Customizing Threading}.
6779
6780 First, a quick overview of the concepts:
6781
6782 @table @dfn
6783 @item root
6784 The top-most article in a thread; the first article in the thread.
6785
6786 @item thread
6787 A tree-like article structure.
6788
6789 @item sub-thread
6790 A small(er) section of this tree-like structure.
6791
6792 @item loose threads
6793 Threads often lose their roots due to article expiry, or due to the root
6794 already having been read in a previous session, and not displayed in the
6795 summary buffer. We then typically have many sub-threads that really
6796 belong to one thread, but are without connecting roots. These are
6797 called loose threads.
6798
6799 @item thread gathering
6800 An attempt to gather loose threads into bigger threads.
6801
6802 @item sparse threads
6803 A thread where the missing articles have been ``guessed'' at, and are
6804 displayed as empty lines in the summary buffer.
6805
6806 @end table
6807
6808
6809 @menu
6810 * Customizing Threading:: Variables you can change to affect the threading.
6811 * Thread Commands:: Thread based commands in the summary buffer.
6812 @end menu
6813
6814
6815 @node Customizing Threading
6816 @subsection Customizing Threading
6817 @cindex customizing threading
6818
6819 @menu
6820 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6821 * Filling In Threads:: Making the threads displayed look fuller.
6822 * More Threading:: Even more variables for fiddling with threads.
6823 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6824 @end menu
6825
6826
6827 @node Loose Threads
6828 @subsubsection Loose Threads
6829 @cindex <
6830 @cindex >
6831 @cindex loose threads
6832
6833 @table @code
6834 @item gnus-summary-make-false-root
6835 @vindex gnus-summary-make-false-root
6836 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6837 and create a dummy root at the top. (Wait a minute. Root at the top?
6838 Yup.) Loose subtrees occur when the real root has expired, or you've
6839 read or killed the root in a previous session.
6840
6841 When there is no real root of a thread, Gnus will have to fudge
6842 something. This variable says what fudging method Gnus should use.
6843 There are four possible values:
6844
6845 @iftex
6846 @iflatex
6847 \gnusfigure{The Summary Buffer}{390}{
6848 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6849 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6850 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6851 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6852 }
6853 @end iflatex
6854 @end iftex
6855
6856 @cindex adopting articles
6857
6858 @table @code
6859
6860 @item adopt
6861 Gnus will make the first of the orphaned articles the parent. This
6862 parent will adopt all the other articles. The adopted articles will be
6863 marked as such by pointy brackets (@samp{<>}) instead of the standard
6864 square brackets (@samp{[]}). This is the default method.
6865
6866 @item dummy
6867 @vindex gnus-summary-dummy-line-format
6868 @vindex gnus-summary-make-false-root-always
6869 Gnus will create a dummy summary line that will pretend to be the
6870 parent. This dummy line does not correspond to any real article, so
6871 selecting it will just select the first real article after the dummy
6872 article. @code{gnus-summary-dummy-line-format} is used to specify the
6873 format of the dummy roots. It accepts only one format spec: @samp{S},
6874 which is the subject of the article. @xref{Formatting Variables}.
6875 If you want all threads to have a dummy root, even the non-gathered
6876 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6877
6878 @item empty
6879 Gnus won't actually make any article the parent, but simply leave the
6880 subject field of all orphans except the first empty. (Actually, it will
6881 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6882 Buffer Format}).)
6883
6884 @item none
6885 Don't make any article parent at all. Just gather the threads and
6886 display them after one another.
6887
6888 @item nil
6889 Don't gather loose threads.
6890 @end table
6891
6892 @item gnus-summary-gather-subject-limit
6893 @vindex gnus-summary-gather-subject-limit
6894 Loose threads are gathered by comparing subjects of articles. If this
6895 variable is @code{nil}, Gnus requires an exact match between the
6896 subjects of the loose threads before gathering them into one big
6897 super-thread. This might be too strict a requirement, what with the
6898 presence of stupid newsreaders that chop off long subject lines. If
6899 you think so, set this variable to, say, 20 to require that only the
6900 first 20 characters of the subjects have to match. If you set this
6901 variable to a really low number, you'll find that Gnus will gather
6902 everything in sight into one thread, which isn't very helpful.
6903
6904 @cindex fuzzy article gathering
6905 If you set this variable to the special value @code{fuzzy}, Gnus will
6906 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6907 Matching}).
6908
6909 @item gnus-simplify-subject-fuzzy-regexp
6910 @vindex gnus-simplify-subject-fuzzy-regexp
6911 This can either be a regular expression or list of regular expressions
6912 that match strings that will be removed from subjects if fuzzy subject
6913 simplification is used.
6914
6915 @item gnus-simplify-ignored-prefixes
6916 @vindex gnus-simplify-ignored-prefixes
6917 If you set @code{gnus-summary-gather-subject-limit} to something as low
6918 as 10, you might consider setting this variable to something sensible:
6919
6920 @c Written by Michael Ernst <mernst@cs.rice.edu>
6921 @lisp
6922 (setq gnus-simplify-ignored-prefixes
6923 (concat
6924 "\\`\\[?\\("
6925 (mapconcat
6926 'identity
6927 '("looking"
6928 "wanted" "followup" "summary\\( of\\)?"
6929 "help" "query" "problem" "question"
6930 "answer" "reference" "announce"
6931 "How can I" "How to" "Comparison of"
6932 ;; ...
6933 )
6934 "\\|")
6935 "\\)\\s *\\("
6936 (mapconcat 'identity
6937 '("for" "for reference" "with" "about")
6938 "\\|")
6939 "\\)?\\]?:?[ \t]*"))
6940 @end lisp
6941
6942 All words that match this regexp will be removed before comparing two
6943 subjects.
6944
6945 @item gnus-simplify-subject-functions
6946 @vindex gnus-simplify-subject-functions
6947 If non-@code{nil}, this variable overrides
6948 @code{gnus-summary-gather-subject-limit}. This variable should be a
6949 list of functions to apply to the @code{Subject} string iteratively to
6950 arrive at the simplified version of the string.
6951
6952 Useful functions to put in this list include:
6953
6954 @table @code
6955 @item gnus-simplify-subject-re
6956 @findex gnus-simplify-subject-re
6957 Strip the leading @samp{Re:}.
6958
6959 @item gnus-simplify-subject-fuzzy
6960 @findex gnus-simplify-subject-fuzzy
6961 Simplify fuzzily.
6962
6963 @item gnus-simplify-whitespace
6964 @findex gnus-simplify-whitespace
6965 Remove excessive whitespace.
6966
6967 @item gnus-simplify-all-whitespace
6968 @findex gnus-simplify-all-whitespace
6969 Remove all whitespace.
6970 @end table
6971
6972 You may also write your own functions, of course.
6973
6974
6975 @item gnus-summary-gather-exclude-subject
6976 @vindex gnus-summary-gather-exclude-subject
6977 Since loose thread gathering is done on subjects only, that might lead
6978 to many false hits, especially with certain common subjects like
6979 @samp{} and @samp{(none)}. To make the situation slightly better,
6980 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6981 what subjects should be excluded from the gathering process.@*
6982 The default is @samp{^ *$\\|^(none)$}.
6983
6984 @item gnus-summary-thread-gathering-function
6985 @vindex gnus-summary-thread-gathering-function
6986 Gnus gathers threads by looking at @code{Subject} headers. This means
6987 that totally unrelated articles may end up in the same ``thread'', which
6988 is confusing. An alternate approach is to look at all the
6989 @code{Message-ID}s in all the @code{References} headers to find matches.
6990 This will ensure that no gathered threads ever include unrelated
6991 articles, but it also means that people who have posted with broken
6992 newsreaders won't be gathered properly. The choice is yours---plague or
6993 cholera:
6994
6995 @table @code
6996 @item gnus-gather-threads-by-subject
6997 @findex gnus-gather-threads-by-subject
6998 This function is the default gathering function and looks at
6999 @code{Subject}s exclusively.
7000
7001 @item gnus-gather-threads-by-references
7002 @findex gnus-gather-threads-by-references
7003 This function looks at @code{References} headers exclusively.
7004 @end table
7005
7006 If you want to test gathering by @code{References}, you could say
7007 something like:
7008
7009 @lisp
7010 (setq gnus-summary-thread-gathering-function
7011 'gnus-gather-threads-by-references)
7012 @end lisp
7013
7014 @end table
7015
7016
7017 @node Filling In Threads
7018 @subsubsection Filling In Threads
7019
7020 @table @code
7021 @item gnus-fetch-old-headers
7022 @vindex gnus-fetch-old-headers
7023 If non-@code{nil}, Gnus will attempt to build old threads by fetching
7024 more old headers---headers to articles marked as read. If you would
7025 like to display as few summary lines as possible, but still connect as
7026 many loose threads as possible, you should set this variable to
7027 @code{some} or a number. If you set it to a number, no more than that
7028 number of extra old headers will be fetched. In either case, fetching
7029 old headers only works if the back end you are using carries overview
7030 files---this would normally be @code{nntp}, @code{nnspool},
7031 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
7032 the thread has been expired by the server, there's not much Gnus can
7033 do about that.
7034
7035 This variable can also be set to @code{invisible}. This won't have any
7036 visible effects, but is useful if you use the @kbd{A T} command a lot
7037 (@pxref{Finding the Parent}).
7038
7039 The server has to support @acronym{NOV} for any of this to work.
7040
7041 @cindex Gmane, gnus-fetch-old-headers
7042 This feature can seriously impact performance it ignores all locally
7043 cached header entries. Setting it to @code{t} for groups for a server
7044 that doesn't expire articles (such as news.gmane.org), leads to very
7045 slow summary generation.
7046
7047 @item gnus-fetch-old-ephemeral-headers
7048 @vindex gnus-fetch-old-ephemeral-headers
7049 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7050 newsgroups.
7051
7052 @item gnus-build-sparse-threads
7053 @vindex gnus-build-sparse-threads
7054 Fetching old headers can be slow. A low-rent similar effect can be
7055 gotten by setting this variable to @code{some}. Gnus will then look at
7056 the complete @code{References} headers of all articles and try to string
7057 together articles that belong in the same thread. This will leave
7058 @dfn{gaps} in the threading display where Gnus guesses that an article
7059 is missing from the thread. (These gaps appear like normal summary
7060 lines. If you select a gap, Gnus will try to fetch the article in
7061 question.) If this variable is @code{t}, Gnus will display all these
7062 ``gaps'' without regard for whether they are useful for completing the
7063 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
7064 off sparse leaf nodes that don't lead anywhere. This variable is
7065 @code{nil} by default.
7066
7067 @item gnus-read-all-available-headers
7068 @vindex gnus-read-all-available-headers
7069 This is a rather obscure variable that few will find useful. It's
7070 intended for those non-news newsgroups where the back end has to fetch
7071 quite a lot to present the summary buffer, and where it's impossible to
7072 go back to parents of articles. This is mostly the case in the
7073 web-based groups.
7074
7075 If you don't use those, then it's safe to leave this as the default
7076 @code{nil}. If you want to use this variable, it should be a regexp
7077 that matches the group name, or @code{t} for all groups.
7078
7079 @end table
7080
7081
7082 @node More Threading
7083 @subsubsection More Threading
7084
7085 @table @code
7086 @item gnus-show-threads
7087 @vindex gnus-show-threads
7088 If this variable is @code{nil}, no threading will be done, and all of
7089 the rest of the variables here will have no effect. Turning threading
7090 off will speed group selection up a bit, but it is sure to make reading
7091 slower and more awkward.
7092
7093 @item gnus-thread-hide-subtree
7094 @vindex gnus-thread-hide-subtree
7095 If non-@code{nil}, all threads will be hidden when the summary buffer is
7096 generated.
7097
7098 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
7099 Available predicates are @code{gnus-article-unread-p} and
7100 @code{gnus-article-unseen-p}.
7101
7102 Here's an example:
7103
7104 @lisp
7105 (setq gnus-thread-hide-subtree
7106 '(or gnus-article-unread-p
7107 gnus-article-unseen-p))
7108 @end lisp
7109
7110 (It's a pretty nonsensical example, since all unseen articles are also
7111 unread, but you get my drift.)
7112
7113
7114 @item gnus-thread-expunge-below
7115 @vindex gnus-thread-expunge-below
7116 All threads that have a total score (as defined by
7117 @code{gnus-thread-score-function}) less than this number will be
7118 expunged. This variable is @code{nil} by default, which means that no
7119 threads are expunged.
7120
7121 @item gnus-thread-hide-killed
7122 @vindex gnus-thread-hide-killed
7123 if you kill a thread and this variable is non-@code{nil}, the subtree
7124 will be hidden.
7125
7126 @item gnus-thread-ignore-subject
7127 @vindex gnus-thread-ignore-subject
7128 Sometimes somebody changes the subject in the middle of a thread. If
7129 this variable is non-@code{nil}, which is the default, the subject
7130 change is ignored. If it is @code{nil}, a change in the subject will
7131 result in a new thread.
7132
7133 @item gnus-thread-indent-level
7134 @vindex gnus-thread-indent-level
7135 This is a number that says how much each sub-thread should be indented.
7136 The default is 4.
7137
7138 @item gnus-sort-gathered-threads-function
7139 @vindex gnus-sort-gathered-threads-function
7140 Sometimes, particularly with mailing lists, the order in which mails
7141 arrive locally is not necessarily the same as the order in which they
7142 arrived on the mailing list. Consequently, when sorting sub-threads
7143 using the default @code{gnus-thread-sort-by-number}, responses can end
7144 up appearing before the article to which they are responding to.
7145 Setting this variable to an alternate value
7146 (e.g., @code{gnus-thread-sort-by-date}), in a group's parameters or in an
7147 appropriate hook (e.g., @code{gnus-summary-generate-hook}) can produce a
7148 more logical sub-thread ordering in such instances.
7149
7150 @end table
7151
7152
7153 @node Low-Level Threading
7154 @subsubsection Low-Level Threading
7155
7156 @table @code
7157
7158 @item gnus-parse-headers-hook
7159 @vindex gnus-parse-headers-hook
7160 Hook run before parsing any headers.
7161
7162 @item gnus-alter-header-function
7163 @vindex gnus-alter-header-function
7164 If non-@code{nil}, this function will be called to allow alteration of
7165 article header structures. The function is called with one parameter,
7166 the article header vector, which it may alter in any way. For instance,
7167 if you have a mail-to-news gateway which alters the @code{Message-ID}s
7168 in systematic ways (by adding prefixes and such), you can use this
7169 variable to un-scramble the @code{Message-ID}s so that they are more
7170 meaningful. Here's one example:
7171
7172 @lisp
7173 (setq gnus-alter-header-function 'my-alter-message-id)
7174
7175 (defun my-alter-message-id (header)
7176 (let ((id (mail-header-id header)))
7177 (when (string-match
7178 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7179 (mail-header-set-id
7180 (concat (match-string 1 id) "@@" (match-string 2 id))
7181 header))))
7182 @end lisp
7183
7184 @end table
7185
7186
7187 @node Thread Commands
7188 @subsection Thread Commands
7189 @cindex thread commands
7190
7191 @table @kbd
7192
7193 @item T k
7194 @itemx C-M-k
7195 @kindex T k (Summary)
7196 @kindex C-M-k (Summary)
7197 @findex gnus-summary-kill-thread
7198 Mark all articles in the current (sub-)thread as read
7199 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
7200 remove all marks instead. If the prefix argument is negative, tick
7201 articles instead.
7202
7203 @item T l
7204 @itemx C-M-l
7205 @kindex T l (Summary)
7206 @kindex C-M-l (Summary)
7207 @findex gnus-summary-lower-thread
7208 Lower the score of the current (sub-)thread
7209 (@code{gnus-summary-lower-thread}).
7210
7211 @item T i
7212 @kindex T i (Summary)
7213 @findex gnus-summary-raise-thread
7214 Increase the score of the current (sub-)thread
7215 (@code{gnus-summary-raise-thread}).
7216
7217 @item T #
7218 @kindex T # (Summary)
7219 @findex gnus-uu-mark-thread
7220 Set the process mark on the current (sub-)thread
7221 (@code{gnus-uu-mark-thread}).
7222
7223 @item T M-#
7224 @kindex T M-# (Summary)
7225 @findex gnus-uu-unmark-thread
7226 Remove the process mark from the current (sub-)thread
7227 (@code{gnus-uu-unmark-thread}).
7228
7229 @item T T
7230 @kindex T T (Summary)
7231 @findex gnus-summary-toggle-threads
7232 Toggle threading (@code{gnus-summary-toggle-threads}).
7233
7234 @item T s
7235 @kindex T s (Summary)
7236 @findex gnus-summary-show-thread
7237 Expose the (sub-)thread hidden under the current article, if any@*
7238 (@code{gnus-summary-show-thread}).
7239
7240 @item T h
7241 @kindex T h (Summary)
7242 @findex gnus-summary-hide-thread
7243 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7244
7245 @item T S
7246 @kindex T S (Summary)
7247 @findex gnus-summary-show-all-threads
7248 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7249
7250 @item T H
7251 @kindex T H (Summary)
7252 @findex gnus-summary-hide-all-threads
7253 Hide all threads (@code{gnus-summary-hide-all-threads}).
7254
7255 @item T t
7256 @kindex T t (Summary)
7257 @findex gnus-summary-rethread-current
7258 Re-thread the current article's thread
7259 (@code{gnus-summary-rethread-current}). This works even when the
7260 summary buffer is otherwise unthreaded.
7261
7262 @item T ^
7263 @kindex T ^ (Summary)
7264 @findex gnus-summary-reparent-thread
7265 Make the current article the child of the marked (or previous) article
7266 (@code{gnus-summary-reparent-thread}).
7267
7268 @item T M-^
7269 @kindex T M-^ (Summary)
7270 @findex gnus-summary-reparent-children
7271 Make the current article the parent of the marked articles
7272 (@code{gnus-summary-reparent-children}).
7273
7274 @end table
7275
7276 The following commands are thread movement commands. They all
7277 understand the numeric prefix.
7278
7279 @table @kbd
7280
7281 @item T n
7282 @kindex T n (Summary)
7283 @itemx C-M-f
7284 @kindex C-M-n (Summary)
7285 @itemx M-down
7286 @kindex M-down (Summary)
7287 @findex gnus-summary-next-thread
7288 Go to the next thread (@code{gnus-summary-next-thread}).
7289
7290 @item T p
7291 @kindex T p (Summary)
7292 @itemx C-M-b
7293 @kindex C-M-p (Summary)
7294 @itemx M-up
7295 @kindex M-up (Summary)
7296 @findex gnus-summary-prev-thread
7297 Go to the previous thread (@code{gnus-summary-prev-thread}).
7298
7299 @item T d
7300 @kindex T d (Summary)
7301 @findex gnus-summary-down-thread
7302 Descend the thread (@code{gnus-summary-down-thread}).
7303
7304 @item T u
7305 @kindex T u (Summary)
7306 @findex gnus-summary-up-thread
7307 Ascend the thread (@code{gnus-summary-up-thread}).
7308
7309 @item T o
7310 @kindex T o (Summary)
7311 @findex gnus-summary-top-thread
7312 Go to the top of the thread (@code{gnus-summary-top-thread}).
7313 @end table
7314
7315 @vindex gnus-thread-operation-ignore-subject
7316 If you ignore subject while threading, you'll naturally end up with
7317 threads that have several different subjects in them. If you then issue
7318 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7319 wish to kill the entire thread, but just those parts of the thread that
7320 have the same subject as the current article. If you like this idea,
7321 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7322 is non-@code{nil} (which it is by default), subjects will be ignored
7323 when doing thread commands. If this variable is @code{nil}, articles in
7324 the same thread with different subjects will not be included in the
7325 operation in question. If this variable is @code{fuzzy}, only articles
7326 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7327 Matching}).
7328
7329
7330 @node Sorting the Summary Buffer
7331 @section Sorting the Summary Buffer
7332
7333 @findex gnus-thread-sort-by-total-score
7334 @findex gnus-thread-sort-by-date
7335 @findex gnus-thread-sort-by-score
7336 @findex gnus-thread-sort-by-subject
7337 @findex gnus-thread-sort-by-author
7338 @findex gnus-thread-sort-by-recipient
7339 @findex gnus-thread-sort-by-number
7340 @findex gnus-thread-sort-by-random
7341 @vindex gnus-thread-sort-functions
7342 @findex gnus-thread-sort-by-most-recent-number
7343 @findex gnus-thread-sort-by-most-recent-date
7344 If you are using a threaded summary display, you can sort the threads by
7345 setting @code{gnus-thread-sort-functions}, which can be either a single
7346 function, a list of functions, or a list containing functions and
7347 @code{(not some-function)} elements.
7348
7349 By default, sorting is done on article numbers. Ready-made sorting
7350 predicate functions include @code{gnus-thread-sort-by-number},
7351 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7352 @code{gnus-thread-sort-by-subject},
7353 @code{gnus-thread-sort-by-date},
7354 @code{gnus-thread-sort-by-score},
7355 @code{gnus-thread-sort-by-most-recent-number},
7356 @code{gnus-thread-sort-by-most-recent-date},
7357 @code{gnus-thread-sort-by-random} and
7358 @code{gnus-thread-sort-by-total-score}.
7359
7360 Each function takes two threads and returns non-@code{nil} if the first
7361 thread should be sorted before the other. Note that sorting really is
7362 normally done by looking only at the roots of each thread. Exceptions
7363 to this rule are @code{gnus-thread-sort-by-most-recent-number} and
7364 @code{gnus-thread-sort-by-most-recent-date}.
7365
7366 If you use more than one function, the primary sort key should be the
7367 last function in the list. You should probably always include
7368 @code{gnus-thread-sort-by-number} in the list of sorting
7369 functions---preferably first. This will ensure that threads that are
7370 equal with respect to the other sort criteria will be displayed in
7371 ascending article order.
7372
7373 If you would like to sort by reverse score, then by subject, and finally
7374 by number, you could do something like:
7375
7376 @lisp
7377 (setq gnus-thread-sort-functions
7378 '(gnus-thread-sort-by-number
7379 gnus-thread-sort-by-subject
7380 (not gnus-thread-sort-by-total-score)))
7381 @end lisp
7382
7383 The threads that have highest score will be displayed first in the
7384 summary buffer. When threads have the same score, they will be sorted
7385 alphabetically. The threads that have the same score and the same
7386 subject will be sorted by number, which is (normally) the sequence in
7387 which the articles arrived.
7388
7389 If you want to sort by score and then reverse arrival order, you could
7390 say something like:
7391
7392 @lisp
7393 (setq gnus-thread-sort-functions
7394 '((not gnus-thread-sort-by-number)
7395 gnus-thread-sort-by-score))
7396 @end lisp
7397
7398 By default, threads including their subthreads are sorted according to
7399 the value of @code{gnus-thread-sort-functions}. By customizing
7400 @code{gnus-subthread-sort-functions} you can define a custom sorting
7401 order for subthreads. This allows for example to sort threads from
7402 high score to low score in the summary buffer, but to have subthreads
7403 still sorted chronologically from old to new without taking their
7404 score into account.
7405
7406 @vindex gnus-thread-score-function
7407 The function in the @code{gnus-thread-score-function} variable (default
7408 @code{+}) is used for calculating the total score of a thread. Useful
7409 functions might be @code{max}, @code{min}, or squared means, or whatever
7410 tickles your fancy.
7411
7412 @findex gnus-article-sort-functions
7413 @findex gnus-article-sort-by-date
7414 @findex gnus-article-sort-by-most-recent-date
7415 @findex gnus-article-sort-by-score
7416 @findex gnus-article-sort-by-subject
7417 @findex gnus-article-sort-by-author
7418 @findex gnus-article-sort-by-random
7419 @findex gnus-article-sort-by-number
7420 @findex gnus-article-sort-by-most-recent-number
7421 If you are using an unthreaded display for some strange reason or
7422 other, you have to fiddle with the @code{gnus-article-sort-functions}
7423 variable. It is very similar to the
7424 @code{gnus-thread-sort-functions}, except that it uses slightly
7425 different functions for article comparison. Available sorting
7426 predicate functions are @code{gnus-article-sort-by-number},
7427 @code{gnus-article-sort-by-author},
7428 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7429 @code{gnus-article-sort-by-random}, and
7430 @code{gnus-article-sort-by-score}.
7431
7432 If you want to sort an unthreaded summary display by subject, you could
7433 say something like:
7434
7435 @lisp
7436 (setq gnus-article-sort-functions
7437 '(gnus-article-sort-by-number
7438 gnus-article-sort-by-subject))
7439 @end lisp
7440
7441 You can define group specific sorting via @code{gnus-parameters},
7442 @xref{Group Parameters}.
7443
7444
7445 @node Asynchronous Fetching
7446 @section Asynchronous Article Fetching
7447 @cindex asynchronous article fetching
7448 @cindex article pre-fetch
7449 @cindex pre-fetch
7450
7451 If you read your news from an @acronym{NNTP} server that's far away, the
7452 network latencies may make reading articles a chore. You have to wait
7453 for a while after pressing @kbd{n} to go to the next article before the
7454 article appears. Why can't Gnus just go ahead and fetch the article
7455 while you are reading the previous one? Why not, indeed.
7456
7457 First, some caveats. There are some pitfalls to using asynchronous
7458 article fetching, especially the way Gnus does it.
7459
7460 Let's say you are reading article 1, which is short, and article 2 is
7461 quite long, and you are not interested in reading that. Gnus does not
7462 know this, so it goes ahead and fetches article 2. You decide to read
7463 article 3, but since Gnus is in the process of fetching article 2, the
7464 connection is blocked.
7465
7466 To avoid these situations, Gnus will open two (count 'em two)
7467 connections to the server. Some people may think this isn't a very nice
7468 thing to do, but I don't see any real alternatives. Setting up that
7469 extra connection takes some time, so Gnus startup will be slower.
7470
7471 Gnus will fetch more articles than you will read. This will mean that
7472 the link between your machine and the @acronym{NNTP} server will become more
7473 loaded than if you didn't use article pre-fetch. The server itself will
7474 also become more loaded---both with the extra article requests, and the
7475 extra connection.
7476
7477 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7478 you really want to.
7479
7480 @vindex gnus-asynchronous
7481 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7482 happen automatically.
7483
7484 @vindex gnus-use-article-prefetch
7485 You can control how many articles are to be pre-fetched by setting
7486 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7487 that when you read an article in the group, the back end will pre-fetch
7488 the next 30 articles. If this variable is @code{t}, the back end will
7489 pre-fetch all the articles it can without bound. If it is
7490 @code{nil}, no pre-fetching will be done.
7491
7492 @vindex gnus-async-prefetch-article-p
7493 @findex gnus-async-unread-p
7494 There are probably some articles that you don't want to pre-fetch---read
7495 articles, for instance. The @code{gnus-async-prefetch-article-p}
7496 variable controls whether an article is to be pre-fetched. This
7497 function should return non-@code{nil} when the article in question is
7498 to be pre-fetched. The default is @code{gnus-async-unread-p}, which
7499 returns @code{nil} on read articles. The function is called with an
7500 article data structure as the only parameter.
7501
7502 If, for instance, you wish to pre-fetch only unread articles shorter
7503 than 100 lines, you could say something like:
7504
7505 @lisp
7506 (defun my-async-short-unread-p (data)
7507 "Return non-nil for short, unread articles."
7508 (and (gnus-data-unread-p data)
7509 (< (mail-header-lines (gnus-data-header data))
7510 100)))
7511
7512 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7513 @end lisp
7514
7515 These functions will be called many, many times, so they should
7516 preferably be short and sweet to avoid slowing down Gnus too much.
7517 It's probably a good idea to byte-compile things like this.
7518
7519 @vindex gnus-async-post-fetch-function
7520 @findex gnus-html-prefetch-images
7521 After an article has been prefetched, this
7522 @code{gnus-async-post-fetch-function} will be called. The buffer will
7523 be narrowed to the region of the article that was fetched. A useful
7524 value would be @code{gnus-html-prefetch-images}, which will prefetch
7525 and store images referenced in the article, so that you don't have to
7526 wait for them to be fetched when you read the article. This is useful
7527 for @acronym{HTML} messages that have external images.
7528
7529 @vindex gnus-prefetched-article-deletion-strategy
7530 Articles have to be removed from the asynch buffer sooner or later. The
7531 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7532 articles. This is a list that may contain the following elements:
7533
7534 @table @code
7535 @item read
7536 Remove articles when they are read.
7537
7538 @item exit
7539 Remove articles when exiting the group.
7540 @end table
7541
7542 The default value is @code{(read exit)}.
7543
7544 @c @vindex gnus-use-header-prefetch
7545 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7546 @c from the next group.
7547
7548
7549 @node Article Caching
7550 @section Article Caching
7551 @cindex article caching
7552 @cindex caching
7553
7554 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7555 consider turning article caching on. Each article will then be stored
7556 locally under your home directory. As you may surmise, this could
7557 potentially use @emph{huge} amounts of disk space, as well as eat up all
7558 your inodes so fast it will make your head swim. In vodka.
7559
7560 Used carefully, though, it could be just an easier way to save articles.
7561
7562 @vindex gnus-use-long-file-name
7563 @vindex gnus-cache-directory
7564 @vindex gnus-use-cache
7565 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7566 all articles ticked or marked as dormant will then be copied
7567 over to your local cache (@code{gnus-cache-directory}). Whether this
7568 cache is flat or hierarchical is controlled by the
7569 @code{gnus-use-long-file-name} variable, as usual.
7570
7571 When re-selecting a ticked or dormant article, it will be fetched from the
7572 cache instead of from the server. As articles in your cache will never
7573 expire, this might serve as a method of saving articles while still
7574 keeping them where they belong. Just mark all articles you want to save
7575 as dormant, and don't worry.
7576
7577 When an article is marked as read, is it removed from the cache.
7578
7579 @vindex gnus-cache-remove-articles
7580 @vindex gnus-cache-enter-articles
7581 The entering/removal of articles from the cache is controlled by the
7582 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7583 variables. Both are lists of symbols. The first is @code{(ticked
7584 dormant)} by default, meaning that ticked and dormant articles will be
7585 put in the cache. The latter is @code{(read)} by default, meaning that
7586 articles marked as read are removed from the cache. Possibly
7587 symbols in these two lists are @code{ticked}, @code{dormant},
7588 @code{unread} and @code{read}.
7589
7590 @findex gnus-jog-cache
7591 So where does the massive article-fetching and storing come into the
7592 picture? The @code{gnus-jog-cache} command will go through all
7593 subscribed newsgroups, request all unread articles, score them, and
7594 store them in the cache. You should only ever, ever ever ever, use this
7595 command if 1) your connection to the @acronym{NNTP} server is really, really,
7596 really slow and 2) you have a really, really, really huge disk.
7597 Seriously. One way to cut down on the number of articles downloaded is
7598 to score unwanted articles down and have them marked as read. They will
7599 not then be downloaded by this command.
7600
7601 @vindex gnus-uncacheable-groups
7602 @vindex gnus-cacheable-groups
7603 It is likely that you do not want caching on all groups. For instance,
7604 if your @code{nnml} mail is located under your home directory, it makes no
7605 sense to cache it somewhere else under your home directory. Unless you
7606 feel that it's neat to use twice as much space.
7607
7608 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7609 regexp of groups to cache, @samp{^nntp} for instance, or set the
7610 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7611 Both variables are @code{nil} by default. If a group matches both
7612 variables, the group is not cached.
7613
7614 @findex gnus-cache-generate-nov-databases
7615 @findex gnus-cache-generate-active
7616 @vindex gnus-cache-active-file
7617 The cache stores information on what articles it contains in its active
7618 file (@code{gnus-cache-active-file}). If this file (or any other parts
7619 of the cache) becomes all messed up for some reason or other, Gnus
7620 offers two functions that will try to set things right. @kbd{M-x
7621 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7622 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7623 file.
7624
7625 @findex gnus-cache-move-cache
7626 @code{gnus-cache-move-cache} will move your whole
7627 @code{gnus-cache-directory} to some other location. You get asked to
7628 where, isn't that cool?
7629
7630 @node Persistent Articles
7631 @section Persistent Articles
7632 @cindex persistent articles
7633
7634 Closely related to article caching, we have @dfn{persistent articles}.
7635 In fact, it's just a different way of looking at caching, and much more
7636 useful in my opinion.
7637
7638 Say you're reading a newsgroup, and you happen on to some valuable gem
7639 that you want to keep and treasure forever. You'd normally just save it
7640 (using one of the many saving commands) in some file. The problem with
7641 that is that it's just, well, yucky. Ideally you'd prefer just having
7642 the article remain in the group where you found it forever; untouched by
7643 the expiry going on at the news server.
7644
7645 This is what a @dfn{persistent article} is---an article that just won't
7646 be deleted. It's implemented using the normal cache functions, but
7647 you use two explicit commands for managing persistent articles:
7648
7649 @table @kbd
7650
7651 @item *
7652 @kindex * (Summary)
7653 @findex gnus-cache-enter-article
7654 Make the current article persistent (@code{gnus-cache-enter-article}).
7655
7656 @item M-*
7657 @kindex M-* (Summary)
7658 @findex gnus-cache-remove-article
7659 Remove the current article from the persistent articles
7660 (@code{gnus-cache-remove-article}). This will normally delete the
7661 article.
7662 @end table
7663
7664 Both these commands understand the process/prefix convention.
7665
7666 To avoid having all ticked articles (and stuff) entered into the cache,
7667 you should set @code{gnus-use-cache} to @code{passive} if you're just
7668 interested in persistent articles:
7669
7670 @lisp
7671 (setq gnus-use-cache 'passive)
7672 @end lisp
7673
7674 @node Sticky Articles
7675 @section Sticky Articles
7676 @cindex sticky articles
7677
7678 When you select an article the current article buffer will be reused
7679 according to the value of the variable
7680 @code{gnus-single-article-buffer}. If its value is non-@code{nil} (the
7681 default) all articles reuse the same article buffer. Else each group
7682 has its own article buffer.
7683
7684 This implies that it's not possible to have more than one article buffer
7685 in a group at a time. But sometimes you might want to display all the
7686 latest emails from your mother, your father, your aunt, your uncle and
7687 your 17 cousins to coordinate the next Christmas party.
7688
7689 That's where sticky articles come in handy. A sticky article buffer
7690 basically is a normal article buffer, but it won't be reused when you
7691 select another article. You can make an article sticky with:
7692
7693 @table @kbd
7694 @item A S
7695 @kindex A S (Summary)
7696 @findex gnus-sticky-article
7697 Make the current article sticky. If a prefix arg is given, ask for a
7698 name for this sticky article buffer.
7699 @end table
7700
7701 To close a sticky article buffer you can use these commands:
7702
7703 @table @kbd
7704 @item q
7705 @kindex q (Article)
7706 @findex bury-buffer
7707 Puts this sticky article buffer at the end of the list of all buffers.
7708
7709 @item k
7710 @kindex k (Article)
7711 @findex gnus-kill-sticky-article-buffer
7712 Kills this sticky article buffer.
7713 @end table
7714
7715 To kill all sticky article buffers you can use:
7716
7717 @defun gnus-kill-sticky-article-buffers ARG
7718 Kill all sticky article buffers.
7719 If a prefix ARG is given, ask for confirmation.
7720 @end defun
7721
7722 @node Article Backlog
7723 @section Article Backlog
7724 @cindex backlog
7725 @cindex article backlog
7726
7727 If you have a slow connection, but the idea of using caching seems
7728 unappealing to you (and it is, really), you can help the situation some
7729 by switching on the @dfn{backlog}. This is where Gnus will buffer
7730 already read articles so that it doesn't have to re-fetch articles
7731 you've already read. This only helps if you are in the habit of
7732 re-selecting articles you've recently read, of course. If you never do
7733 that, turning the backlog on will slow Gnus down a little bit, and
7734 increase memory usage some.
7735
7736 @vindex gnus-keep-backlog
7737 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7738 at most @var{n} old articles in a buffer for later re-fetching. If this
7739 variable is non-@code{nil} and is not a number, Gnus will store
7740 @emph{all} read articles, which means that your Emacs will grow without
7741 bound before exploding and taking your machine down with you. I put
7742 that in there just to keep y'all on your toes.
7743
7744 The default value is 20.
7745
7746
7747 @node Saving Articles
7748 @section Saving Articles
7749 @cindex saving articles
7750
7751 Gnus can save articles in a number of ways. Below is the documentation
7752 for saving articles in a fairly straight-forward fashion (i.e., little
7753 processing of the article is done before it is saved). For a different
7754 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7755 (@pxref{Decoding Articles}).
7756
7757 For the commands listed here, the target is a file. If you want to
7758 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7759 command (@pxref{Mail Group Commands}).
7760
7761 @vindex gnus-save-all-headers
7762 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7763 unwanted headers before saving the article.
7764
7765 @vindex gnus-saved-headers
7766 If the preceding variable is @code{nil}, all headers that match the
7767 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7768 deleted before saving.
7769
7770 @table @kbd
7771
7772 @item O o
7773 @itemx o
7774 @kindex O o (Summary)
7775 @kindex o (Summary)
7776 @findex gnus-summary-save-article
7777 @c @icon{gnus-summary-save-article}
7778 Save the current article using the default article saver
7779 (@code{gnus-summary-save-article}).
7780
7781 @item O m
7782 @kindex O m (Summary)
7783 @findex gnus-summary-save-article-mail
7784 Save the current article in a Unix mail box (mbox) file
7785 (@code{gnus-summary-save-article-mail}).
7786
7787 @item O r
7788 @kindex O r (Summary)
7789 @findex gnus-summary-save-article-rmail
7790 Save the current article in Rmail format
7791 (@code{gnus-summary-save-article-rmail}). This is mbox since Emacs 23,
7792 Babyl in older versions.
7793
7794 @item O f
7795 @kindex O f (Summary)
7796 @findex gnus-summary-save-article-file
7797 @c @icon{gnus-summary-save-article-file}
7798 Save the current article in plain file format
7799 (@code{gnus-summary-save-article-file}).
7800
7801 @item O F
7802 @kindex O F (Summary)
7803 @findex gnus-summary-write-article-file
7804 Write the current article in plain file format, overwriting any previous
7805 file contents (@code{gnus-summary-write-article-file}).
7806
7807 @item O b
7808 @kindex O b (Summary)
7809 @findex gnus-summary-save-article-body-file
7810 Save the current article body in plain file format
7811 (@code{gnus-summary-save-article-body-file}).
7812
7813 @item O h
7814 @kindex O h (Summary)
7815 @findex gnus-summary-save-article-folder
7816 Save the current article in mh folder format
7817 (@code{gnus-summary-save-article-folder}).
7818
7819 @item O v
7820 @kindex O v (Summary)
7821 @findex gnus-summary-save-article-vm
7822 Save the current article in a VM folder
7823 (@code{gnus-summary-save-article-vm}).
7824
7825 @item O p
7826 @itemx |
7827 @kindex O p (Summary)
7828 @kindex | (Summary)
7829 @findex gnus-summary-pipe-output
7830 @vindex gnus-summary-pipe-output-default-command
7831 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7832 the current article to a process (@code{gnus-summary-pipe-output}).
7833 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7834 complete headers in the piped output. The symbolic prefix @code{r} is
7835 special; it lets this command pipe a raw article including all headers.
7836 The @code{gnus-summary-pipe-output-default-command} variable can be set
7837 to a string containing the default command and options (default
7838 @code{nil}).
7839
7840 @item O P
7841 @kindex O P (Summary)
7842 @findex gnus-summary-muttprint
7843 @vindex gnus-summary-muttprint-program
7844 Save the current article into muttprint. That is, print it using the
7845 external program @uref{http://muttprint.sourceforge.net/,
7846 Muttprint}. The program name and options to use is controlled by the
7847 variable @code{gnus-summary-muttprint-program}.
7848 (@code{gnus-summary-muttprint}).
7849
7850 @end table
7851
7852 @vindex gnus-prompt-before-saving
7853 All these commands use the process/prefix convention
7854 (@pxref{Process/Prefix}). If you save bunches of articles using these
7855 functions, you might get tired of being prompted for files to save each
7856 and every article in. The prompting action is controlled by
7857 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7858 default, giving you that excessive prompting action you know and
7859 loathe. If you set this variable to @code{t} instead, you'll be prompted
7860 just once for each series of articles you save. If you like to really
7861 have Gnus do all your thinking for you, you can even set this variable
7862 to @code{nil}, which means that you will never be prompted for files to
7863 save articles in. Gnus will simply save all the articles in the default
7864 files.
7865
7866
7867 @vindex gnus-default-article-saver
7868 You can customize the @code{gnus-default-article-saver} variable to make
7869 Gnus do what you want it to. You can use any of the eight ready-made
7870 functions below, or you can create your own.
7871
7872 @table @code
7873
7874 @item gnus-summary-save-in-rmail
7875 @findex gnus-summary-save-in-rmail
7876 @vindex gnus-rmail-save-name
7877 @findex gnus-plain-save-name
7878 This is the default format, that used by the Rmail package. Since Emacs
7879 23, Rmail uses standard mbox format. Before this, it used the
7880 @dfn{Babyl} format. Accordingly, this command writes mbox format since
7881 Emacs 23, unless appending to an existing Babyl file. In older versions
7882 of Emacs, it always uses Babyl format. Uses the function in the
7883 @code{gnus-rmail-save-name} variable to get a file name to save the
7884 article in. The default is @code{gnus-plain-save-name}.
7885
7886 @item gnus-summary-save-in-mail
7887 @findex gnus-summary-save-in-mail
7888 @vindex gnus-mail-save-name
7889 Save in a Unix mail (mbox) file. Uses the function in the
7890 @code{gnus-mail-save-name} variable to get a file name to save the
7891 article in. The default is @code{gnus-plain-save-name}.
7892
7893 @item gnus-summary-save-in-file
7894 @findex gnus-summary-save-in-file
7895 @vindex gnus-file-save-name
7896 @findex gnus-numeric-save-name
7897 Append the article straight to an ordinary file. Uses the function in
7898 the @code{gnus-file-save-name} variable to get a file name to save the
7899 article in. The default is @code{gnus-numeric-save-name}.
7900
7901 @item gnus-summary-write-to-file
7902 @findex gnus-summary-write-to-file
7903 Write the article straight to an ordinary file. The file is
7904 overwritten if it exists. Uses the function in the
7905 @code{gnus-file-save-name} variable to get a file name to save the
7906 article in. The default is @code{gnus-numeric-save-name}.
7907
7908 @item gnus-summary-save-body-in-file
7909 @findex gnus-summary-save-body-in-file
7910 Append the article body to an ordinary file. Uses the function in the
7911 @code{gnus-file-save-name} variable to get a file name to save the
7912 article in. The default is @code{gnus-numeric-save-name}.
7913
7914 @item gnus-summary-write-body-to-file
7915 @findex gnus-summary-write-body-to-file
7916 Write the article body straight to an ordinary file. The file is
7917 overwritten if it exists. Uses the function in the
7918 @code{gnus-file-save-name} variable to get a file name to save the
7919 article in. The default is @code{gnus-numeric-save-name}.
7920
7921 @item gnus-summary-save-in-folder
7922 @findex gnus-summary-save-in-folder
7923 @findex gnus-folder-save-name
7924 @findex gnus-Folder-save-name
7925 @vindex gnus-folder-save-name
7926 @cindex rcvstore
7927 @cindex MH folders
7928 Save the article to an MH folder using @code{rcvstore} from the MH
7929 library. Uses the function in the @code{gnus-folder-save-name} variable
7930 to get a file name to save the article in. The default is
7931 @code{gnus-folder-save-name}, but you can also use
7932 @code{gnus-Folder-save-name}, which creates capitalized names.
7933
7934 @item gnus-summary-save-in-vm
7935 @findex gnus-summary-save-in-vm
7936 Save the article in a VM folder. You have to have the VM mail
7937 reader to use this setting.
7938
7939 @item gnus-summary-save-in-pipe
7940 @findex gnus-summary-save-in-pipe
7941 Pipe the article to a shell command. This function takes optional two
7942 arguments COMMAND and RAW@. Valid values for COMMAND include:
7943
7944 @itemize @bullet
7945 @item a string@*
7946 The executable command name and possibly arguments.
7947 @item @code{nil}@*
7948 You will be prompted for the command in the minibuffer.
7949 @item the symbol @code{default}@*
7950 It will be replaced with the command which the variable
7951 @code{gnus-summary-pipe-output-default-command} holds or the command
7952 last used for saving.
7953 @end itemize
7954
7955 Non-@code{nil} value for RAW overrides @code{:decode} and
7956 @code{:headers} properties (see below) and the raw article including all
7957 headers will be piped.
7958 @end table
7959
7960 The symbol of each function may have the following properties:
7961
7962 @table @code
7963 @item :decode
7964 The value non-@code{nil} means save decoded articles. This is
7965 meaningful only with @code{gnus-summary-save-in-file},
7966 @code{gnus-summary-save-body-in-file},
7967 @code{gnus-summary-write-to-file},
7968 @code{gnus-summary-write-body-to-file}, and
7969 @code{gnus-summary-save-in-pipe}.
7970
7971 @item :function
7972 The value specifies an alternative function which appends, not
7973 overwrites, articles to a file. This implies that when saving many
7974 articles at a time, @code{gnus-prompt-before-saving} is bound to
7975 @code{t} and all articles are saved in a single file. This is
7976 meaningful only with @code{gnus-summary-write-to-file} and
7977 @code{gnus-summary-write-body-to-file}.
7978
7979 @item :headers
7980 The value specifies the symbol of a variable of which the value
7981 specifies headers to be saved. If it is omitted,
7982 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
7983 headers should be saved.
7984 @end table
7985
7986 @vindex gnus-article-save-directory
7987 All of these functions, except for the last one, will save the article
7988 in the @code{gnus-article-save-directory}, which is initialized from the
7989 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7990 default.
7991
7992 As you can see above, the functions use different functions to find a
7993 suitable name of a file to save the article in. Below is a list of
7994 available functions that generate names:
7995
7996 @table @code
7997
7998 @item gnus-Numeric-save-name
7999 @findex gnus-Numeric-save-name
8000 File names like @file{~/News/Alt.andrea-dworkin/45}.
8001
8002 @item gnus-numeric-save-name
8003 @findex gnus-numeric-save-name
8004 File names like @file{~/News/alt.andrea-dworkin/45}.
8005
8006 @item gnus-Plain-save-name
8007 @findex gnus-Plain-save-name
8008 File names like @file{~/News/Alt.andrea-dworkin}.
8009
8010 @item gnus-plain-save-name
8011 @findex gnus-plain-save-name
8012 File names like @file{~/News/alt.andrea-dworkin}.
8013
8014 @item gnus-sender-save-name
8015 @findex gnus-sender-save-name
8016 File names like @file{~/News/larsi}.
8017 @end table
8018
8019 @vindex gnus-split-methods
8020 You can have Gnus suggest where to save articles by plonking a regexp into
8021 the @code{gnus-split-methods} alist. For instance, if you would like to
8022 save articles related to Gnus in the file @file{gnus-stuff}, and articles
8023 related to VM in @file{vm-stuff}, you could set this variable to something
8024 like:
8025
8026 @lisp
8027 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
8028 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
8029 (my-choosing-function "../other-dir/my-stuff")
8030 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
8031 @end lisp
8032
8033 We see that this is a list where each element is a list that has two
8034 elements---the @dfn{match} and the @dfn{file}. The match can either be
8035 a string (in which case it is used as a regexp to match on the article
8036 head); it can be a symbol (which will be called as a function with the
8037 group name as a parameter); or it can be a list (which will be
8038 @code{eval}ed). If any of these actions have a non-@code{nil} result,
8039 the @dfn{file} will be used as a default prompt. In addition, the
8040 result of the operation itself will be used if the function or form
8041 called returns a string or a list of strings.
8042
8043 You basically end up with a list of file names that might be used when
8044 saving the current article. (All ``matches'' will be used.) You will
8045 then be prompted for what you really want to use as a name, with file
8046 name completion over the results from applying this variable.
8047
8048 This variable is @code{((gnus-article-archive-name))} by default, which
8049 means that Gnus will look at the articles it saves for an
8050 @code{Archive-name} line and use that as a suggestion for the file
8051 name.
8052
8053 Here's an example function to clean up file names somewhat. If you have
8054 lots of mail groups called things like
8055 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
8056 these group names before creating the file name to save to. The
8057 following will do just that:
8058
8059 @lisp
8060 (defun my-save-name (group)
8061 (when (string-match "^nnml:mail." group)
8062 (substring group (match-end 0))))
8063
8064 (setq gnus-split-methods
8065 '((gnus-article-archive-name)
8066 (my-save-name)))
8067 @end lisp
8068
8069
8070 @vindex gnus-use-long-file-name
8071 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
8072 @code{nil}, all the preceding functions will replace all periods
8073 (@samp{.}) in the group names with slashes (@samp{/})---which means that
8074 the functions will generate hierarchies of directories instead of having
8075 all the files in the top level directory
8076 (@file{~/News/alt/andrea-dworkin} instead of
8077 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
8078 on most systems. However, for historical reasons, this is @code{nil} on
8079 Xenix and usg-unix-v machines by default.
8080
8081 This function also affects kill and score file names. If this variable
8082 is a list, and the list contains the element @code{not-score}, long file
8083 names will not be used for score files, if it contains the element
8084 @code{not-save}, long file names will not be used for saving, and if it
8085 contains the element @code{not-kill}, long file names will not be used
8086 for kill files.
8087
8088 If you'd like to save articles in a hierarchy that looks something like
8089 a spool, you could
8090
8091 @lisp
8092 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
8093 (setq gnus-default-article-saver
8094 'gnus-summary-save-in-file) ; @r{no encoding}
8095 @end lisp
8096
8097 Then just save with @kbd{o}. You'd then read this hierarchy with
8098 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
8099 the top level directory as the argument (@file{~/News/}). Then just walk
8100 around to the groups/directories with @code{nneething}.
8101
8102
8103 @node Decoding Articles
8104 @section Decoding Articles
8105 @cindex decoding articles
8106
8107 Sometime users post articles (or series of articles) that have been
8108 encoded in some way or other. Gnus can decode them for you.
8109
8110 @menu
8111 * Uuencoded Articles:: Uudecode articles.
8112 * Shell Archives:: Unshar articles.
8113 * PostScript Files:: Split PostScript.
8114 * Other Files:: Plain save and binhex.
8115 * Decoding Variables:: Variables for a happy decoding.
8116 * Viewing Files:: You want to look at the result of the decoding?
8117 @end menu
8118
8119 @cindex series
8120 @cindex article series
8121 All these functions use the process/prefix convention
8122 (@pxref{Process/Prefix}) for finding out what articles to work on, with
8123 the extension that a ``single article'' means ``a single series''. Gnus
8124 can find out by itself what articles belong to a series, decode all the
8125 articles and unpack/view/save the resulting file(s).
8126
8127 Gnus guesses what articles are in the series according to the following
8128 simplish rule: The subjects must be (nearly) identical, except for the
8129 last two numbers of the line. (Spaces are largely ignored, however.)
8130
8131 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
8132 will find all the articles that match the regexp @samp{^cat.gif
8133 ([0-9]+/[0-9]+).*$}.
8134
8135 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
8136 series}, will not be properly recognized by any of the automatic viewing
8137 commands, and you have to mark the articles manually with @kbd{#}.
8138
8139
8140 @node Uuencoded Articles
8141 @subsection Uuencoded Articles
8142 @cindex uudecode
8143 @cindex uuencoded articles
8144
8145 @table @kbd
8146
8147 @item X u
8148 @kindex X u (Summary)
8149 @findex gnus-uu-decode-uu
8150 @c @icon{gnus-uu-decode-uu}
8151 Uudecodes the current series (@code{gnus-uu-decode-uu}).
8152
8153 @item X U
8154 @kindex X U (Summary)
8155 @findex gnus-uu-decode-uu-and-save
8156 Uudecodes and saves the current series
8157 (@code{gnus-uu-decode-uu-and-save}).
8158
8159 @item X v u
8160 @kindex X v u (Summary)
8161 @findex gnus-uu-decode-uu-view
8162 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
8163
8164 @item X v U
8165 @kindex X v U (Summary)
8166 @findex gnus-uu-decode-uu-and-save-view
8167 Uudecodes, views and saves the current series
8168 (@code{gnus-uu-decode-uu-and-save-view}).
8169
8170 @end table
8171
8172 Remember that these all react to the presence of articles marked with
8173 the process mark. If, for instance, you'd like to decode and save an
8174 entire newsgroup, you'd typically do @kbd{M P a}
8175 (@code{gnus-uu-mark-all}) and then @kbd{X U}
8176 (@code{gnus-uu-decode-uu-and-save}).
8177
8178 All this is very much different from how @code{gnus-uu} worked with
8179 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
8180 the sun. This version of @code{gnus-uu} generally assumes that you mark
8181 articles in some way (@pxref{Setting Process Marks}) and then press
8182 @kbd{X u}.
8183
8184 @vindex gnus-uu-notify-files
8185 Note: When trying to decode articles that have names matching
8186 @code{gnus-uu-notify-files}, which is hard-coded to
8187 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
8188 automatically post an article on @samp{comp.unix.wizards} saying that
8189 you have just viewed the file in question. This feature can't be turned
8190 off.
8191
8192
8193 @node Shell Archives
8194 @subsection Shell Archives
8195 @cindex unshar
8196 @cindex shell archives
8197 @cindex shared articles
8198
8199 Shell archives (``shar files'') used to be a popular way to distribute
8200 sources, but it isn't used all that much today. In any case, we have
8201 some commands to deal with these:
8202
8203 @table @kbd
8204
8205 @item X s
8206 @kindex X s (Summary)
8207 @findex gnus-uu-decode-unshar
8208 Unshars the current series (@code{gnus-uu-decode-unshar}).
8209
8210 @item X S
8211 @kindex X S (Summary)
8212 @findex gnus-uu-decode-unshar-and-save
8213 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
8214
8215 @item X v s
8216 @kindex X v s (Summary)
8217 @findex gnus-uu-decode-unshar-view
8218 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
8219
8220 @item X v S
8221 @kindex X v S (Summary)
8222 @findex gnus-uu-decode-unshar-and-save-view
8223 Unshars, views and saves the current series
8224 (@code{gnus-uu-decode-unshar-and-save-view}).
8225 @end table
8226
8227
8228 @node PostScript Files
8229 @subsection PostScript Files
8230 @cindex PostScript
8231
8232 @table @kbd
8233
8234 @item X p
8235 @kindex X p (Summary)
8236 @findex gnus-uu-decode-postscript
8237 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
8238
8239 @item X P
8240 @kindex X P (Summary)
8241 @findex gnus-uu-decode-postscript-and-save
8242 Unpack and save the current PostScript series
8243 (@code{gnus-uu-decode-postscript-and-save}).
8244
8245 @item X v p
8246 @kindex X v p (Summary)
8247 @findex gnus-uu-decode-postscript-view
8248 View the current PostScript series
8249 (@code{gnus-uu-decode-postscript-view}).
8250
8251 @item X v P
8252 @kindex X v P (Summary)
8253 @findex gnus-uu-decode-postscript-and-save-view
8254 View and save the current PostScript series
8255 (@code{gnus-uu-decode-postscript-and-save-view}).
8256 @end table
8257
8258
8259 @node Other Files
8260 @subsection Other Files
8261
8262 @table @kbd
8263 @item X o
8264 @kindex X o (Summary)
8265 @findex gnus-uu-decode-save
8266 Save the current series
8267 (@code{gnus-uu-decode-save}).
8268
8269 @item X b
8270 @kindex X b (Summary)
8271 @findex gnus-uu-decode-binhex
8272 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
8273 doesn't really work yet.
8274
8275 @item X Y
8276 @kindex X Y (Summary)
8277 @findex gnus-uu-decode-yenc
8278 yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}).
8279 @end table
8280
8281
8282 @node Decoding Variables
8283 @subsection Decoding Variables
8284
8285 Adjective, not verb.
8286
8287 @menu
8288 * Rule Variables:: Variables that say how a file is to be viewed.
8289 * Other Decode Variables:: Other decode variables.
8290 * Uuencoding and Posting:: Variables for customizing uuencoding.
8291 @end menu
8292
8293
8294 @node Rule Variables
8295 @subsubsection Rule Variables
8296 @cindex rule variables
8297
8298 Gnus uses @dfn{rule variables} to decide how to view a file. All these
8299 variables are of the form
8300
8301 @lisp
8302 (list '(regexp1 command2)
8303 '(regexp2 command2)
8304 ...)
8305 @end lisp
8306
8307 @table @code
8308
8309 @item gnus-uu-user-view-rules
8310 @vindex gnus-uu-user-view-rules
8311 @cindex sox
8312 This variable is consulted first when viewing files. If you wish to use,
8313 for instance, @code{sox} to convert an @file{.au} sound file, you could
8314 say something like:
8315 @lisp
8316 (setq gnus-uu-user-view-rules
8317 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
8318 @end lisp
8319
8320 @item gnus-uu-user-view-rules-end
8321 @vindex gnus-uu-user-view-rules-end
8322 This variable is consulted if Gnus couldn't make any matches from the
8323 user and default view rules.
8324
8325 @item gnus-uu-user-archive-rules
8326 @vindex gnus-uu-user-archive-rules
8327 This variable can be used to say what commands should be used to unpack
8328 archives.
8329 @end table
8330
8331
8332 @node Other Decode Variables
8333 @subsubsection Other Decode Variables
8334
8335 @table @code
8336 @vindex gnus-uu-grabbed-file-functions
8337
8338 @item gnus-uu-grabbed-file-functions
8339 All functions in this list will be called right after each file has been
8340 successfully decoded---so that you can move or view files right away,
8341 and don't have to wait for all files to be decoded before you can do
8342 anything. Ready-made functions you can put in this list are:
8343
8344 @table @code
8345
8346 @item gnus-uu-grab-view
8347 @findex gnus-uu-grab-view
8348 View the file.
8349
8350 @item gnus-uu-grab-move
8351 @findex gnus-uu-grab-move
8352 Move the file (if you're using a saving function.)
8353 @end table
8354
8355 @item gnus-uu-be-dangerous
8356 @vindex gnus-uu-be-dangerous
8357 Specifies what to do if unusual situations arise during decoding. If
8358 @code{nil}, be as conservative as possible. If @code{t}, ignore things
8359 that didn't work, and overwrite existing files. Otherwise, ask each
8360 time.
8361
8362 @item gnus-uu-ignore-files-by-name
8363 @vindex gnus-uu-ignore-files-by-name
8364 Files with name matching this regular expression won't be viewed.
8365
8366 @item gnus-uu-ignore-files-by-type
8367 @vindex gnus-uu-ignore-files-by-type
8368 Files with a @acronym{MIME} type matching this variable won't be viewed.
8369 Note that Gnus tries to guess what type the file is based on the name.
8370 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
8371 kludgy.
8372
8373 @item gnus-uu-tmp-dir
8374 @vindex gnus-uu-tmp-dir
8375 Where @code{gnus-uu} does its work.
8376
8377 @item gnus-uu-do-not-unpack-archives
8378 @vindex gnus-uu-do-not-unpack-archives
8379 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
8380 looking for files to display.
8381
8382 @item gnus-uu-view-and-save
8383 @vindex gnus-uu-view-and-save
8384 Non-@code{nil} means that the user will always be asked to save a file
8385 after viewing it.
8386
8387 @item gnus-uu-ignore-default-view-rules
8388 @vindex gnus-uu-ignore-default-view-rules
8389 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
8390 rules.
8391
8392 @item gnus-uu-ignore-default-archive-rules
8393 @vindex gnus-uu-ignore-default-archive-rules
8394 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
8395 unpacking commands.
8396
8397 @item gnus-uu-kill-carriage-return
8398 @vindex gnus-uu-kill-carriage-return
8399 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
8400 from articles.
8401
8402 @item gnus-uu-unmark-articles-not-decoded
8403 @vindex gnus-uu-unmark-articles-not-decoded
8404 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
8405 decoded articles as unread.
8406
8407 @item gnus-uu-correct-stripped-uucode
8408 @vindex gnus-uu-correct-stripped-uucode
8409 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
8410 uuencoded files that have had trailing spaces deleted.
8411
8412 @item gnus-uu-pre-uudecode-hook
8413 @vindex gnus-uu-pre-uudecode-hook
8414 Hook run before sending a message to @code{uudecode}.
8415
8416 @item gnus-uu-view-with-metamail
8417 @vindex gnus-uu-view-with-metamail
8418 @cindex metamail
8419 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
8420 commands defined by the rule variables and just fudge a @acronym{MIME}
8421 content type based on the file name. The result will be fed to
8422 @code{metamail} for viewing.
8423
8424 @item gnus-uu-save-in-digest
8425 @vindex gnus-uu-save-in-digest
8426 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8427 decoding, will save in digests. If this variable is @code{nil},
8428 @code{gnus-uu} will just save everything in a file without any
8429 embellishments. The digesting almost conforms to RFC 1153---no easy way
8430 to specify any meaningful volume and issue numbers were found, so I
8431 simply dropped them.
8432
8433 @end table
8434
8435
8436 @node Uuencoding and Posting
8437 @subsubsection Uuencoding and Posting
8438
8439 @table @code
8440
8441 @item gnus-uu-post-include-before-composing
8442 @vindex gnus-uu-post-include-before-composing
8443 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8444 before you compose the article. If this variable is @code{t}, you can
8445 either include an encoded file with @kbd{C-c C-i} or have one included
8446 for you when you post the article.
8447
8448 @item gnus-uu-post-length
8449 @vindex gnus-uu-post-length
8450 Maximum length of an article. The encoded file will be split into how
8451 many articles it takes to post the entire file.
8452
8453 @item gnus-uu-post-threaded
8454 @vindex gnus-uu-post-threaded
8455 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8456 thread. This may not be smart, as no other decoder I have seen is able
8457 to follow threads when collecting uuencoded articles. (Well, I have
8458 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8459 think that counts@dots{}) Default is @code{nil}.
8460
8461 @item gnus-uu-post-separate-description
8462 @vindex gnus-uu-post-separate-description
8463 Non-@code{nil} means that the description will be posted in a separate
8464 article. The first article will typically be numbered (0/x). If this
8465 variable is @code{nil}, the description the user enters will be included
8466 at the beginning of the first article, which will be numbered (1/x).
8467 Default is @code{t}.
8468
8469 @end table
8470
8471
8472 @node Viewing Files
8473 @subsection Viewing Files
8474 @cindex viewing files
8475 @cindex pseudo-articles
8476
8477 After decoding, if the file is some sort of archive, Gnus will attempt
8478 to unpack the archive and see if any of the files in the archive can be
8479 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8480 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8481 uncompress and de-tar the main file, and then view the two pictures.
8482 This unpacking process is recursive, so if the archive contains archives
8483 of archives, it'll all be unpacked.
8484
8485 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8486 extracted file into the summary buffer. If you go to these
8487 ``articles'', you will be prompted for a command to run (usually Gnus
8488 will make a suggestion), and then the command will be run.
8489
8490 @vindex gnus-view-pseudo-asynchronously
8491 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8492 until the viewing is done before proceeding.
8493
8494 @vindex gnus-view-pseudos
8495 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8496 the pseudo-articles into the summary buffer, but view them
8497 immediately. If this variable is @code{not-confirm}, the user won't even
8498 be asked for a confirmation before viewing is done.
8499
8500 @vindex gnus-view-pseudos-separately
8501 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8502 pseudo-article will be created for each file to be viewed. If
8503 @code{nil}, all files that use the same viewing command will be given as
8504 a list of parameters to that command.
8505
8506 @vindex gnus-insert-pseudo-articles
8507 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8508 pseudo-articles when decoding. It is @code{t} by default.
8509
8510 So; there you are, reading your @emph{pseudo-articles} in your
8511 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8512 Why isn't anything real anymore? How did we get here?
8513
8514
8515 @node Article Treatment
8516 @section Article Treatment
8517
8518 Reading through this huge manual, you may have quite forgotten that the
8519 object of newsreaders is to actually, like, read what people have
8520 written. Reading articles. Unfortunately, people are quite bad at
8521 writing, so there are tons of functions and variables to make reading
8522 these articles easier.
8523
8524 @menu
8525 * Article Highlighting:: You want to make the article look like fruit salad.
8526 * Article Fontisizing:: Making emphasized text look nice.
8527 * Article Hiding:: You also want to make certain info go away.
8528 * Article Washing:: Lots of way-neat functions to make life better.
8529 * Article Header:: Doing various header transformations.
8530 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8531 * Article Button Levels:: Controlling appearance of buttons.
8532 * Article Date:: Grumble, UT!
8533 * Article Display:: Display various stuff:
8534 X-Face, Picons, Gravatars, Smileys.
8535 * Article Signature:: What is a signature?
8536 * Article Miscellanea:: Various other stuff.
8537 @end menu
8538
8539
8540 @node Article Highlighting
8541 @subsection Article Highlighting
8542 @cindex highlighting
8543
8544 Not only do you want your article buffer to look like fruit salad, but
8545 you want it to look like technicolor fruit salad.
8546
8547 @table @kbd
8548
8549 @item W H a
8550 @kindex W H a (Summary)
8551 @findex gnus-article-highlight
8552 @findex gnus-article-maybe-highlight
8553 Do much highlighting of the current article
8554 (@code{gnus-article-highlight}). This function highlights header, cited
8555 text, the signature, and adds buttons to the body and the head.
8556
8557 @item W H h
8558 @kindex W H h (Summary)
8559 @findex gnus-article-highlight-headers
8560 @vindex gnus-header-face-alist
8561 Highlight the headers (@code{gnus-article-highlight-headers}). The
8562 highlighting will be done according to the @code{gnus-header-face-alist}
8563 variable, which is a list where each element has the form
8564 @code{(@var{regexp} @var{name} @var{content})}.
8565 @var{regexp} is a regular expression for matching the
8566 header, @var{name} is the face used for highlighting the header name
8567 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8568 the header value. The first match made will be used. Note that
8569 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8570
8571 @item W H c
8572 @kindex W H c (Summary)
8573 @findex gnus-article-highlight-citation
8574 Highlight cited text (@code{gnus-article-highlight-citation}).
8575
8576 Some variables to customize the citation highlights:
8577
8578 @table @code
8579 @vindex gnus-cite-parse-max-size
8580
8581 @item gnus-cite-parse-max-size
8582 If the article size in bytes is bigger than this variable (which is
8583 25000 by default), no citation highlighting will be performed.
8584
8585 @item gnus-cite-max-prefix
8586 @vindex gnus-cite-max-prefix
8587 Maximum possible length for a citation prefix (default 20).
8588
8589 @item gnus-cite-face-list
8590 @vindex gnus-cite-face-list
8591 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8592 When there are citations from multiple articles in the same message,
8593 Gnus will try to give each citation from each article its own face.
8594 This should make it easier to see who wrote what.
8595
8596 @item gnus-supercite-regexp
8597 @vindex gnus-supercite-regexp
8598 Regexp matching normal Supercite attribution lines.
8599
8600 @item gnus-supercite-secondary-regexp
8601 @vindex gnus-supercite-secondary-regexp
8602 Regexp matching mangled Supercite attribution lines.
8603
8604 @item gnus-cite-minimum-match-count
8605 @vindex gnus-cite-minimum-match-count
8606 Minimum number of identical prefixes we have to see before we believe
8607 that it's a citation.
8608
8609 @item gnus-cite-attribution-prefix
8610 @vindex gnus-cite-attribution-prefix
8611 Regexp matching the beginning of an attribution line.
8612
8613 @item gnus-cite-attribution-suffix
8614 @vindex gnus-cite-attribution-suffix
8615 Regexp matching the end of an attribution line.
8616
8617 @item gnus-cite-attribution-face
8618 @vindex gnus-cite-attribution-face
8619 Face used for attribution lines. It is merged with the face for the
8620 cited text belonging to the attribution.
8621
8622 @item gnus-cite-ignore-quoted-from
8623 @vindex gnus-cite-ignore-quoted-from
8624 If non-@code{nil}, no citation highlighting will be performed on lines
8625 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8626 in order not to mix up with the envelope From line. The default value
8627 is @code{t}.
8628
8629 @end table
8630
8631
8632 @item W H s
8633 @kindex W H s (Summary)
8634 @vindex gnus-signature-separator
8635 @vindex gnus-signature-face
8636 @findex gnus-article-highlight-signature
8637 Highlight the signature (@code{gnus-article-highlight-signature}).
8638 Everything after @code{gnus-signature-separator} (@pxref{Article
8639 Signature}) in an article will be considered a signature and will be
8640 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8641 default.
8642
8643 @end table
8644
8645 @xref{Customizing Articles}, for how to highlight articles automatically.
8646
8647
8648 @node Article Fontisizing
8649 @subsection Article Fontisizing
8650 @cindex emphasis
8651 @cindex article emphasis
8652
8653 @findex gnus-article-emphasize
8654 @kindex W e (Summary)
8655 People commonly add emphasis to words in news articles by writing things
8656 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8657 this look nicer by running the article through the @kbd{W e}
8658 (@code{gnus-article-emphasize}) command.
8659
8660 @vindex gnus-emphasis-alist
8661 How the emphasis is computed is controlled by the
8662 @code{gnus-emphasis-alist} variable. This is an alist where the first
8663 element is a regular expression to be matched. The second is a number
8664 that says what regular expression grouping is used to find the entire
8665 emphasized word. The third is a number that says what regexp grouping
8666 should be displayed and highlighted. (The text between these two
8667 groupings will be hidden.) The fourth is the face used for
8668 highlighting.
8669
8670 @lisp
8671 (setq gnus-emphasis-alist
8672 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8673 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8674 @end lisp
8675
8676 @cindex slash
8677 @cindex asterisk
8678 @cindex underline
8679 @cindex /
8680 @cindex *
8681
8682 @vindex gnus-emphasis-underline
8683 @vindex gnus-emphasis-bold
8684 @vindex gnus-emphasis-italic
8685 @vindex gnus-emphasis-underline-bold
8686 @vindex gnus-emphasis-underline-italic
8687 @vindex gnus-emphasis-bold-italic
8688 @vindex gnus-emphasis-underline-bold-italic
8689 By default, there are seven rules, and they use the following faces:
8690 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8691 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8692 @code{gnus-emphasis-underline-italic},
8693 @code{gnus-emphasis-underline-bold}, and
8694 @code{gnus-emphasis-underline-bold-italic}.
8695
8696 If you want to change these faces, you can either use @kbd{M-x
8697 customize}, or you can use @code{copy-face}. For instance, if you want
8698 to make @code{gnus-emphasis-italic} use a red face instead, you could
8699 say something like:
8700
8701 @lisp
8702 (copy-face 'red 'gnus-emphasis-italic)
8703 @end lisp
8704
8705 @vindex gnus-group-highlight-words-alist
8706
8707 If you want to highlight arbitrary words, you can use the
8708 @code{gnus-group-highlight-words-alist} variable, which uses the same
8709 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8710 parameter (@pxref{Group Parameters}) can also be used.
8711
8712 @xref{Customizing Articles}, for how to fontize articles automatically.
8713
8714
8715 @node Article Hiding
8716 @subsection Article Hiding
8717 @cindex article hiding
8718
8719 Or rather, hiding certain things in each article. There usually is much
8720 too much cruft in most articles.
8721
8722 @table @kbd
8723
8724 @item W W a
8725 @kindex W W a (Summary)
8726 @findex gnus-article-hide
8727 Do quite a lot of hiding on the article buffer
8728 (@kbd{gnus-article-hide}). In particular, this function will hide
8729 headers, @acronym{PGP}, cited text and the signature.
8730
8731 @item W W h
8732 @kindex W W h (Summary)
8733 @findex gnus-article-hide-headers
8734 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8735 Headers}.
8736
8737 @item W W b
8738 @kindex W W b (Summary)
8739 @findex gnus-article-hide-boring-headers
8740 Hide headers that aren't particularly interesting
8741 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8742
8743 @item W W s
8744 @kindex W W s (Summary)
8745 @findex gnus-article-hide-signature
8746 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8747 Signature}.
8748
8749 @item W W l
8750 @kindex W W l (Summary)
8751 @findex gnus-article-hide-list-identifiers
8752 @vindex gnus-list-identifiers
8753 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8754 are strings some mailing list servers add to the beginning of all
8755 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8756 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8757 may not contain @code{\\(..\\)}.
8758
8759 @table @code
8760
8761 @item gnus-list-identifiers
8762 @vindex gnus-list-identifiers
8763 A regular expression that matches list identifiers to be removed from
8764 subject. This can also be a list of regular expressions.
8765
8766 @end table
8767
8768 @item W W P
8769 @kindex W W P (Summary)
8770 @findex gnus-article-hide-pem
8771 Hide @acronym{PEM} (privacy enhanced messages) cruft
8772 (@code{gnus-article-hide-pem}).
8773
8774 @item W W B
8775 @kindex W W B (Summary)
8776 @findex gnus-article-strip-banner
8777 @vindex gnus-article-banner-alist
8778 @vindex gnus-article-address-banner-alist
8779 @cindex banner
8780 @cindex OneList
8781 @cindex stripping advertisements
8782 @cindex advertisements
8783 Strip the banner specified by the @code{banner} group parameter
8784 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8785 annoying banners and/or signatures that some mailing lists and moderated
8786 groups adds to all the messages. The way to use this function is to add
8787 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8788 group you want banners stripped from. The parameter either be a string,
8789 which will be interpreted as a regular expression matching text to be
8790 removed, or the symbol @code{signature}, meaning that the (last)
8791 signature should be removed, or other symbol, meaning that the
8792 corresponding regular expression in @code{gnus-article-banner-alist} is
8793 used.
8794
8795 For instance:
8796
8797 @lisp
8798 (setq gnus-article-banner-alist
8799 ((googleGroups .
8800 "^\n*--~--~---------\\(.+\n\\)+")))
8801 @end lisp
8802
8803 Regardless of a group, you can hide things like advertisements only when
8804 the sender of an article has a certain mail address specified in
8805 @code{gnus-article-address-banner-alist}.
8806
8807 @table @code
8808
8809 @item gnus-article-address-banner-alist
8810 @vindex gnus-article-address-banner-alist
8811 Alist of mail addresses and banners. Each element has the form
8812 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8813 matching a mail address in the From header, @var{banner} is one of a
8814 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8815 a regexp and @code{nil}. If @var{address} matches author's mail
8816 address, it will remove things like advertisements. For example, if a
8817 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8818 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8819 sends, you can use the following element to remove them:
8820
8821 @lisp
8822 ("@@yoo-hoo\\.co\\.jp\\'" .
8823 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8824 @end lisp
8825
8826 @end table
8827
8828 @item W W c
8829 @kindex W W c (Summary)
8830 @findex gnus-article-hide-citation
8831 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8832 customizing the hiding:
8833
8834 @table @code
8835
8836 @item gnus-cited-opened-text-button-line-format
8837 @itemx gnus-cited-closed-text-button-line-format
8838 @vindex gnus-cited-closed-text-button-line-format
8839 @vindex gnus-cited-opened-text-button-line-format
8840 Gnus adds buttons to show where the cited text has been hidden, and to
8841 allow toggle hiding the text. The format of the variable is specified
8842 by these format-like variable (@pxref{Formatting Variables}). These
8843 specs are valid:
8844
8845 @table @samp
8846 @item b
8847 Starting point of the hidden text.
8848 @item e
8849 Ending point of the hidden text.
8850 @item l
8851 Number of characters in the hidden region.
8852 @item n
8853 Number of lines of hidden text.
8854 @end table
8855
8856 @item gnus-cited-lines-visible
8857 @vindex gnus-cited-lines-visible
8858 The number of lines at the beginning of the cited text to leave
8859 shown. This can also be a cons cell with the number of lines at the top
8860 and bottom of the text, respectively, to remain visible.
8861
8862 @end table
8863
8864 @item W W C-c
8865 @kindex W W C-c (Summary)
8866 @findex gnus-article-hide-citation-maybe
8867
8868 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8869 following two variables:
8870
8871 @table @code
8872 @item gnus-cite-hide-percentage
8873 @vindex gnus-cite-hide-percentage
8874 If the cited text is of a bigger percentage than this variable (default
8875 50), hide the cited text.
8876
8877 @item gnus-cite-hide-absolute
8878 @vindex gnus-cite-hide-absolute
8879 The cited text must have at least this length (default 10) before it
8880 is hidden.
8881 @end table
8882
8883 @item W W C
8884 @kindex W W C (Summary)
8885 @findex gnus-article-hide-citation-in-followups
8886 Hide cited text in articles that aren't roots
8887 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8888 useful as an interactive command, but might be a handy function to stick
8889 have happen automatically (@pxref{Customizing Articles}).
8890
8891 @end table
8892
8893 All these ``hiding'' commands are toggles, but if you give a negative
8894 prefix to these commands, they will show what they have previously
8895 hidden. If you give a positive prefix, they will always hide.
8896
8897 Also @pxref{Article Highlighting} for further variables for
8898 citation customization.
8899
8900 @xref{Customizing Articles}, for how to hide article elements
8901 automatically.
8902
8903
8904 @node Article Washing
8905 @subsection Article Washing
8906 @cindex washing
8907 @cindex article washing
8908
8909 We call this ``article washing'' for a really good reason. Namely, the
8910 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8911
8912 @dfn{Washing} is defined by us as ``changing something from something to
8913 something else'', but normally results in something looking better.
8914 Cleaner, perhaps.
8915
8916 @xref{Customizing Articles}, if you want to change how Gnus displays
8917 articles by default.
8918
8919 @table @kbd
8920
8921 @item C-u g
8922 This is not really washing, it's sort of the opposite of washing. If
8923 you type this, you see the article exactly as it exists on disk or on
8924 the server.
8925
8926 @item g
8927 Force redisplaying of the current article
8928 (@code{gnus-summary-show-article}). This is also not really washing.
8929 If you type this, you see the article without any previously applied
8930 interactive Washing functions but with all default treatments
8931 (@pxref{Customizing Articles}).
8932
8933 @item W l
8934 @kindex W l (Summary)
8935 @findex gnus-summary-stop-page-breaking
8936 Remove page breaks from the current article
8937 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8938 delimiters.
8939
8940 @item W r
8941 @kindex W r (Summary)
8942 @findex gnus-summary-caesar-message
8943 @c @icon{gnus-summary-caesar-message}
8944 Do a Caesar rotate (rot13) on the article buffer
8945 (@code{gnus-summary-caesar-message}).
8946 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8947 (Typically offensive jokes and such.)
8948
8949 It's commonly called ``rot13'' because each letter is rotated 13
8950 positions in the alphabet, e.g., @samp{B} (letter #2) -> @samp{O} (letter
8951 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8952 is rumored to have employed this form of, uh, somewhat weak encryption.
8953
8954 @item W m
8955 @kindex W m (Summary)
8956 @findex gnus-summary-morse-message
8957 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8958
8959 @item W i
8960 @kindex W i (Summary)
8961 @findex gnus-summary-idna-message
8962 Decode IDNA encoded domain names in the current articles. IDNA
8963 encoded domain names looks like @samp{xn--bar}. If a string remain
8964 unencoded after running invoking this, it is likely an invalid IDNA
8965 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8966 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8967 to work.
8968
8969 @item W t
8970 @item t
8971 @kindex W t (Summary)
8972 @kindex t (Summary)
8973 @findex gnus-summary-toggle-header
8974 Toggle whether to display all headers in the article buffer
8975 (@code{gnus-summary-toggle-header}).
8976
8977 @item W v
8978 @kindex W v (Summary)
8979 @findex gnus-summary-verbose-headers
8980 Toggle whether to display all headers in the article buffer permanently
8981 (@code{gnus-summary-verbose-headers}).
8982
8983 @item W o
8984 @kindex W o (Summary)
8985 @findex gnus-article-treat-overstrike
8986 Treat overstrike (@code{gnus-article-treat-overstrike}).
8987
8988 @item W d
8989 @kindex W d (Summary)
8990 @findex gnus-article-treat-dumbquotes
8991 @vindex gnus-article-dumbquotes-map
8992 @cindex Smartquotes
8993 @cindex M****s*** sm*rtq**t*s
8994 @cindex Latin 1
8995 Treat M****s*** sm*rtq**t*s according to
8996 @code{gnus-article-dumbquotes-map}
8997 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8998 whether a character is a sm*rtq**t* or not, so it should only be used
8999 interactively.
9000
9001 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
9002 an attempt to provide more quoting characters. If you see something
9003 like @code{\222} or @code{\264} where you're expecting some kind of
9004 apostrophe or quotation mark, then try this wash.
9005
9006 @item W U
9007 @kindex W U (Summary)
9008 @findex gnus-article-treat-non-ascii
9009 @cindex Unicode
9010 @cindex Non-@acronym{ASCII}
9011 Translate many non-@acronym{ASCII} characters into their
9012 @acronym{ASCII} equivalents (@code{gnus-article-treat-non-ascii}).
9013 This is mostly useful if you're on a terminal that has a limited font
9014 and doesn't show accented characters, ``advanced'' punctuation, and the
9015 like. For instance, @samp{»} is translated into @samp{>>}, and so on.
9016
9017 @item W Y f
9018 @kindex W Y f (Summary)
9019 @findex gnus-article-outlook-deuglify-article
9020 @cindex Outlook Express
9021 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
9022 unwrap lines, repair attribution and rearrange citation.
9023 (@code{gnus-article-outlook-deuglify-article}).
9024
9025 @item W Y u
9026 @kindex W Y u (Summary)
9027 @findex gnus-article-outlook-unwrap-lines
9028 @vindex gnus-outlook-deuglify-unwrap-min
9029 @vindex gnus-outlook-deuglify-unwrap-max
9030 Unwrap lines that appear to be wrapped citation lines. You can control
9031 what lines will be unwrapped by frobbing
9032 @code{gnus-outlook-deuglify-unwrap-min} and
9033 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
9034 maximum length of an unwrapped citation line.
9035 (@code{gnus-article-outlook-unwrap-lines}).
9036
9037 @item W Y a
9038 @kindex W Y a (Summary)
9039 @findex gnus-article-outlook-repair-attribution
9040 Repair a broken attribution line.@*
9041 (@code{gnus-article-outlook-repair-attribution}).
9042
9043 @item W Y c
9044 @kindex W Y c (Summary)
9045 @findex gnus-article-outlook-rearrange-citation
9046 Repair broken citations by rearranging the text.
9047 (@code{gnus-article-outlook-rearrange-citation}).
9048
9049 @item W w
9050 @kindex W w (Summary)
9051 @findex gnus-article-fill-cited-article
9052 Do word wrap (@code{gnus-article-fill-cited-article}).
9053
9054 You can give the command a numerical prefix to specify the width to use
9055 when filling.
9056
9057 @item W Q
9058 @kindex W Q (Summary)
9059 @findex gnus-article-fill-long-lines
9060 Fill long lines (@code{gnus-article-fill-long-lines}).
9061
9062 @item W C
9063 @kindex W C (Summary)
9064 @findex gnus-article-capitalize-sentences
9065 Capitalize the first word in each sentence
9066 (@code{gnus-article-capitalize-sentences}).
9067
9068 @item W c
9069 @kindex W c (Summary)
9070 @findex gnus-article-remove-cr
9071 Translate CRLF pairs (i.e., @samp{^M}s on the end of the lines) into LF
9072 (this takes care of DOS line endings), and then translate any remaining
9073 CRs into LF (this takes care of Mac line endings)
9074 (@code{gnus-article-remove-cr}).
9075
9076 @item W q
9077 @kindex W q (Summary)
9078 @findex gnus-article-de-quoted-unreadable
9079 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
9080 Quoted-Printable is one common @acronym{MIME} encoding employed when
9081 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
9082 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
9083 which doesn't look very readable to me. Note that this is usually
9084 done automatically by Gnus if the message in question has a
9085 @code{Content-Transfer-Encoding} header that says that this encoding
9086 has been done. If a prefix is given, a charset will be asked for.
9087
9088 @item W 6
9089 @kindex W 6 (Summary)
9090 @findex gnus-article-de-base64-unreadable
9091 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
9092 one common @acronym{MIME} encoding employed when sending
9093 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
9094 usually done automatically by Gnus if the message in question has a
9095 @code{Content-Transfer-Encoding} header that says that this encoding
9096 has been done. If a prefix is given, a charset will be asked for.
9097
9098 @item W Z
9099 @kindex W Z (Summary)
9100 @findex gnus-article-decode-HZ
9101 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
9102 common encoding employed when sending Chinese articles. It typically
9103 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
9104
9105 @item W A
9106 @kindex W A (Summary)
9107 @findex gnus-article-treat-ansi-sequences
9108 @cindex @acronym{ANSI} control sequences
9109 Translate @acronym{ANSI} SGR control sequences into overlays or
9110 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
9111 sequences are used in some Chinese hierarchies for highlighting.
9112
9113 @item W u
9114 @kindex W u (Summary)
9115 @findex gnus-article-unsplit-urls
9116 Remove newlines from within URLs. Some mailers insert newlines into
9117 outgoing email messages to keep lines short. This reformatting can
9118 split long URLs onto multiple lines. Repair those URLs by removing
9119 the newlines (@code{gnus-article-unsplit-urls}).
9120
9121 @item W h
9122 @kindex W h (Summary)
9123 @findex gnus-article-wash-html
9124 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
9125 usually done automatically by Gnus if the message in question has a
9126 @code{Content-Type} header that says that the message is @acronym{HTML}.
9127
9128 If a prefix is given, a charset will be asked for. If it is a number,
9129 the charset defined in @code{gnus-summary-show-article-charset-alist}
9130 (@pxref{Paging the Article}) will be used.
9131
9132 The default is to use the function specified by
9133 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9134 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9135 @acronym{HTML}. Pre-defined functions you can use include:
9136
9137 @table @code
9138 @item shr
9139 Use Gnus simple html renderer.
9140
9141 @item gnus-w3m
9142 Use Gnus rendered based on w3m.
9143
9144 @item w3
9145 Use Emacs/W3.
9146
9147 @item w3m
9148 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
9149
9150 @item w3m-standalone
9151 Use @uref{http://w3m.sourceforge.net/, w3m}.
9152
9153 @item links
9154 Use @uref{http://links.sf.net/, Links}.
9155
9156 @item lynx
9157 Use @uref{http://lynx.isc.org/, Lynx}.
9158
9159 @item html2text
9160 Use html2text---a simple @acronym{HTML} converter included with Gnus.
9161
9162 @end table
9163
9164 @item W b
9165 @kindex W b (Summary)
9166 @findex gnus-article-add-buttons
9167 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
9168 @xref{Article Buttons}.
9169
9170 @item W B
9171 @kindex W B (Summary)
9172 @findex gnus-article-add-buttons-to-head
9173 Add clickable buttons to the article headers
9174 (@code{gnus-article-add-buttons-to-head}).
9175
9176 @item W p
9177 @kindex W p (Summary)
9178 @findex gnus-article-verify-x-pgp-sig
9179 Verify a signed control message
9180 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
9181 @code{newgroup} and @code{checkgroups} are usually signed by the
9182 hierarchy maintainer. You need to add the @acronym{PGP} public key of
9183 the maintainer to your keyring to verify the
9184 message.@footnote{@acronym{PGP} keys for many hierarchies are
9185 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
9186
9187 @item W s
9188 @kindex W s (Summary)
9189 @findex gnus-summary-force-verify-and-decrypt
9190 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
9191 @acronym{S/MIME}) message
9192 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
9193
9194 @item W a
9195 @kindex W a (Summary)
9196 @findex gnus-article-strip-headers-in-body
9197 Strip headers like the @code{X-No-Archive} header from the beginning of
9198 article bodies (@code{gnus-article-strip-headers-in-body}).
9199
9200 @item W E l
9201 @kindex W E l (Summary)
9202 @findex gnus-article-strip-leading-blank-lines
9203 Remove all blank lines from the beginning of the article
9204 (@code{gnus-article-strip-leading-blank-lines}).
9205
9206 @item W E m
9207 @kindex W E m (Summary)
9208 @findex gnus-article-strip-multiple-blank-lines
9209 Replace all blank lines with empty lines and then all multiple empty
9210 lines with a single empty line.
9211 (@code{gnus-article-strip-multiple-blank-lines}).
9212
9213 @item W E t
9214 @kindex W E t (Summary)
9215 @findex gnus-article-remove-trailing-blank-lines
9216 Remove all blank lines at the end of the article
9217 (@code{gnus-article-remove-trailing-blank-lines}).
9218
9219 @item W E a
9220 @kindex W E a (Summary)
9221 @findex gnus-article-strip-blank-lines
9222 Do all the three commands above
9223 (@code{gnus-article-strip-blank-lines}).
9224
9225 @item W E A
9226 @kindex W E A (Summary)
9227 @findex gnus-article-strip-all-blank-lines
9228 Remove all blank lines
9229 (@code{gnus-article-strip-all-blank-lines}).
9230
9231 @item W E s
9232 @kindex W E s (Summary)
9233 @findex gnus-article-strip-leading-space
9234 Remove all white space from the beginning of all lines of the article
9235 body (@code{gnus-article-strip-leading-space}).
9236
9237 @item W E e
9238 @kindex W E e (Summary)
9239 @findex gnus-article-strip-trailing-space
9240 Remove all white space from the end of all lines of the article
9241 body (@code{gnus-article-strip-trailing-space}).
9242
9243 @end table
9244
9245 @xref{Customizing Articles}, for how to wash articles automatically.
9246
9247
9248 @node Article Header
9249 @subsection Article Header
9250
9251 These commands perform various transformations of article header.
9252
9253 @table @kbd
9254
9255 @item W G u
9256 @kindex W G u (Summary)
9257 @findex gnus-article-treat-unfold-headers
9258 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
9259
9260 @item W G n
9261 @kindex W G n (Summary)
9262 @findex gnus-article-treat-fold-newsgroups
9263 Fold the @code{Newsgroups} and @code{Followup-To} headers
9264 (@code{gnus-article-treat-fold-newsgroups}).
9265
9266 @item W G f
9267 @kindex W G f (Summary)
9268 @findex gnus-article-treat-fold-headers
9269 Fold all the message headers
9270 (@code{gnus-article-treat-fold-headers}).
9271
9272 @item W E w
9273 @kindex W E w (Summary)
9274 @findex gnus-article-remove-leading-whitespace
9275 Remove excessive whitespace from all headers
9276 (@code{gnus-article-remove-leading-whitespace}).
9277
9278 @end table
9279
9280
9281 @node Article Buttons
9282 @subsection Article Buttons
9283 @cindex buttons
9284
9285 People often include references to other stuff in articles, and it would
9286 be nice if Gnus could just fetch whatever it is that people talk about
9287 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
9288 button on these references.
9289
9290 @vindex gnus-button-man-handler
9291 Gnus adds @dfn{buttons} to certain standard references by default:
9292 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
9293 Emacs or Gnus related references. This is controlled by two variables,
9294 one that handles article bodies and one that handles article heads:
9295
9296 @table @code
9297
9298 @item gnus-button-alist
9299 @vindex gnus-button-alist
9300 This is an alist where each entry has this form:
9301
9302 @lisp
9303 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9304 @end lisp
9305
9306 @table @var
9307
9308 @item regexp
9309 All text that match this regular expression (case insensitive) will be
9310 considered an external reference. Here's a typical regexp that matches
9311 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
9312 variable containing a regexp, useful variables to use include
9313 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9314
9315 @item button-par
9316 Gnus has to know which parts of the matches is to be highlighted. This
9317 is a number that says what sub-expression of the regexp is to be
9318 highlighted. If you want it all highlighted, you use 0 here.
9319
9320 @item use-p
9321 This form will be @code{eval}ed, and if the result is non-@code{nil},
9322 this is considered a match. This is useful if you want extra sifting to
9323 avoid false matches. Often variables named
9324 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9325 Levels}, but any other form may be used too.
9326
9327 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
9328
9329 @item function
9330 This function will be called when you click on this button.
9331
9332 @item data-par
9333 As with @var{button-par}, this is a sub-expression number, but this one
9334 says which part of the match is to be sent as data to @var{function}.
9335
9336 @end table
9337
9338 So the full entry for buttonizing URLs is then
9339
9340 @lisp
9341 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
9342 @end lisp
9343
9344 @item gnus-header-button-alist
9345 @vindex gnus-header-button-alist
9346 This is just like the other alist, except that it is applied to the
9347 article head only, and that each entry has an additional element that is
9348 used to say what headers to apply the buttonize coding to:
9349
9350 @lisp
9351 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9352 @end lisp
9353
9354 @var{header} is a regular expression.
9355 @end table
9356
9357 @subsubsection Related variables and functions
9358
9359 @table @code
9360 @item gnus-button-@var{*}-level
9361 @xref{Article Button Levels}.
9362
9363 @c Stuff related to gnus-button-browse-level
9364
9365 @item gnus-button-url-regexp
9366 @vindex gnus-button-url-regexp
9367 A regular expression that matches embedded URLs. It is used in the
9368 default values of the variables above.
9369
9370 @c Stuff related to gnus-button-man-level
9371
9372 @item gnus-button-man-handler
9373 @vindex gnus-button-man-handler
9374 The function to use for displaying man pages. It must take at least one
9375 argument with a string naming the man page.
9376
9377 @c Stuff related to gnus-button-message-level
9378
9379 @item gnus-button-mid-or-mail-regexp
9380 @vindex gnus-button-mid-or-mail-regexp
9381 Regular expression that matches a message ID or a mail address.
9382
9383 @item gnus-button-prefer-mid-or-mail
9384 @vindex gnus-button-prefer-mid-or-mail
9385 This variable determines what to do when the button on a string as
9386 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
9387 message ID or a mail address. If it is one of the symbols @code{mid} or
9388 @code{mail}, Gnus will always assume that the string is a message ID or
9389 a mail address, respectively. If this variable is set to the symbol
9390 @code{ask}, always query the user what to do. If it is a function, this
9391 function will be called with the string as its only argument. The
9392 function must return @code{mid}, @code{mail}, @code{invalid} or
9393 @code{ask}. The default value is the function
9394 @code{gnus-button-mid-or-mail-heuristic}.
9395
9396 @item gnus-button-mid-or-mail-heuristic
9397 @findex gnus-button-mid-or-mail-heuristic
9398 Function that guesses whether its argument is a message ID or a mail
9399 address. Returns @code{mid} if it's a message IDs, @code{mail} if
9400 it's a mail address, @code{ask} if unsure and @code{invalid} if the
9401 string is invalid.
9402
9403 @item gnus-button-mid-or-mail-heuristic-alist
9404 @vindex gnus-button-mid-or-mail-heuristic-alist
9405 An alist of @code{(RATE . REGEXP)} pairs used by the function
9406 @code{gnus-button-mid-or-mail-heuristic}.
9407
9408 @c Misc stuff
9409
9410 @item gnus-article-button-face
9411 @vindex gnus-article-button-face
9412 Face used on buttons.
9413
9414 @item gnus-article-mouse-face
9415 @vindex gnus-article-mouse-face
9416 Face used when the mouse cursor is over a button.
9417
9418 @end table
9419
9420 @xref{Customizing Articles}, for how to buttonize articles automatically.
9421
9422
9423 @node Article Button Levels
9424 @subsection Article button levels
9425 @cindex button levels
9426 The higher the value of the variables @code{gnus-button-@var{*}-level},
9427 the more buttons will appear. If the level is zero, no corresponding
9428 buttons are displayed. With the default value (which is 5) you should
9429 already see quite a lot of buttons. With higher levels, you will see
9430 more buttons, but you may also get more false positives. To avoid them,
9431 you can set the variables @code{gnus-button-@var{*}-level} local to
9432 specific groups (@pxref{Group Parameters}). Here's an example for the
9433 variable @code{gnus-parameters}:
9434
9435 @lisp
9436 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9437 (setq gnus-parameters
9438 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9439 ("\\<unix\\>" (gnus-button-man-level 10))
9440 ("\\<tex\\>" (gnus-button-tex-level 10))))
9441 @end lisp
9442
9443 @table @code
9444
9445 @item gnus-button-browse-level
9446 @vindex gnus-button-browse-level
9447 Controls the display of references to message IDs, mail addresses and
9448 news URLs. Related variables and functions include
9449 @code{gnus-button-url-regexp}, @code{browse-url}, and
9450 @code{browse-url-browser-function}.
9451
9452 @item gnus-button-emacs-level
9453 @vindex gnus-button-emacs-level
9454 Controls the display of Emacs or Gnus references. Related functions are
9455 @code{gnus-button-handle-custom},
9456 @code{gnus-button-handle-describe-function},
9457 @code{gnus-button-handle-describe-variable},
9458 @code{gnus-button-handle-symbol},
9459 @code{gnus-button-handle-describe-key},
9460 @code{gnus-button-handle-apropos},
9461 @code{gnus-button-handle-apropos-command},
9462 @code{gnus-button-handle-apropos-variable},
9463 @code{gnus-button-handle-apropos-documentation}, and
9464 @code{gnus-button-handle-library}.
9465
9466 @item gnus-button-man-level
9467 @vindex gnus-button-man-level
9468 Controls the display of references to (Unix) man pages.
9469 See @code{gnus-button-man-handler}.
9470
9471 @item gnus-button-message-level
9472 @vindex gnus-button-message-level
9473 Controls the display of message IDs, mail addresses and news URLs.
9474 Related variables and functions include
9475 @code{gnus-button-mid-or-mail-regexp},
9476 @code{gnus-button-prefer-mid-or-mail},
9477 @code{gnus-button-mid-or-mail-heuristic}, and
9478 @code{gnus-button-mid-or-mail-heuristic-alist}.
9479
9480 @end table
9481
9482
9483 @node Article Date
9484 @subsection Article Date
9485
9486 The date is most likely generated in some obscure timezone you've never
9487 heard of, so it's quite nice to be able to find out what the time was
9488 when the article was sent.
9489
9490 @table @kbd
9491
9492 @item W T u
9493 @kindex W T u (Summary)
9494 @findex gnus-article-date-ut
9495 Display the date in UT (aka. GMT, aka ZULU)
9496 (@code{gnus-article-date-ut}).
9497
9498 @item W T i
9499 @kindex W T i (Summary)
9500 @findex gnus-article-date-iso8601
9501 @cindex ISO 8601
9502 Display the date in international format, aka. ISO 8601
9503 (@code{gnus-article-date-iso8601}).
9504
9505 @item W T l
9506 @kindex W T l (Summary)
9507 @findex gnus-article-date-local
9508 Display the date in the local timezone (@code{gnus-article-date-local}).
9509
9510 @item W T p
9511 @kindex W T p (Summary)
9512 @findex gnus-article-date-english
9513 Display the date in a format that's easily pronounceable in English
9514 (@code{gnus-article-date-english}).
9515
9516 @item W T s
9517 @kindex W T s (Summary)
9518 @vindex gnus-article-time-format
9519 @findex gnus-article-date-user
9520 @findex format-time-string
9521 Display the date using a user-defined format
9522 (@code{gnus-article-date-user}). The format is specified by the
9523 @code{gnus-article-time-format} variable, and is a string that's passed
9524 to @code{format-time-string}. See the documentation of that variable
9525 for a list of possible format specs.
9526
9527 @item W T e
9528 @kindex W T e (Summary)
9529 @findex gnus-article-date-lapsed
9530 @findex gnus-start-date-timer
9531 @findex gnus-stop-date-timer
9532 Say how much time has elapsed between the article was posted and now
9533 (@code{gnus-article-date-lapsed}). It looks something like:
9534
9535 @example
9536 Date: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9537 @end example
9538
9539 To make this line updated continually, set the
9540 @code{gnus-article-update-date-headers} variable to the frequency in
9541 seconds (the default is @code{nil}).
9542
9543 @item W T o
9544 @kindex W T o (Summary)
9545 @findex gnus-article-date-original
9546 Display the original date (@code{gnus-article-date-original}). This can
9547 be useful if you normally use some other conversion function and are
9548 worried that it might be doing something totally wrong. Say, claiming
9549 that the article was posted in 1854. Although something like that is
9550 @emph{totally} impossible. Don't you trust me? *titter*
9551
9552 @end table
9553
9554 @xref{Customizing Articles}, for how to display the date in your
9555 preferred format automatically.
9556
9557
9558 @node Article Display
9559 @subsection Article Display
9560 @cindex picons
9561 @cindex x-face
9562 @cindex smileys
9563 @cindex gravatars
9564
9565 These commands add various frivolous display gimmicks to the article
9566 buffer in Emacs versions that support them.
9567
9568 @code{X-Face} headers are small black-and-white images supplied by the
9569 message headers (@pxref{X-Face}).
9570
9571 @code{Face} headers are small colored images supplied by the message
9572 headers (@pxref{Face}).
9573
9574 Smileys are those little @samp{:-)} symbols that people like to litter
9575 their messages with (@pxref{Smileys}).
9576
9577 Picons, on the other hand, reside on your own system, and Gnus will
9578 try to match the headers to what you have (@pxref{Picons}).
9579
9580 Gravatars reside on-line and are fetched from
9581 @uref{http://www.gravatar.com/} (@pxref{Gravatars}).
9582
9583 All these functions are toggles---if the elements already exist,
9584 they'll be removed.
9585
9586 @table @kbd
9587 @item W D x
9588 @kindex W D x (Summary)
9589 @findex gnus-article-display-x-face
9590 Display an @code{X-Face} in the @code{From} header.
9591 (@code{gnus-article-display-x-face}).
9592
9593 @item W D d
9594 @kindex W D d (Summary)
9595 @findex gnus-article-display-face
9596 Display a @code{Face} in the @code{From} header.
9597 (@code{gnus-article-display-face}).
9598
9599 @item W D s
9600 @kindex W D s (Summary)
9601 @findex gnus-treat-smiley
9602 Display smileys (@code{gnus-treat-smiley}).
9603
9604 @item W D f
9605 @kindex W D f (Summary)
9606 @findex gnus-treat-from-picon
9607 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9608
9609 @item W D m
9610 @kindex W D m (Summary)
9611 @findex gnus-treat-mail-picon
9612 Piconify all mail headers (i.e., @code{Cc}, @code{To})
9613 (@code{gnus-treat-mail-picon}).
9614
9615 @item W D n
9616 @kindex W D n (Summary)
9617 @findex gnus-treat-newsgroups-picon
9618 Piconify all news headers (i.e., @code{Newsgroups} and
9619 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9620
9621 @item W D g
9622 @kindex W D g (Summary)
9623 @findex gnus-treat-from-gravatar
9624 Gravatarify the @code{From} header (@code{gnus-treat-from-gravatar}).
9625
9626 @item W D h
9627 @kindex W D h (Summary)
9628 @findex gnus-treat-mail-gravatar
9629 Gravatarify all mail headers (i.e., @code{Cc}, @code{To})
9630 (@code{gnus-treat-from-gravatar}).
9631
9632 @item W D D
9633 @kindex W D D (Summary)
9634 @findex gnus-article-remove-images
9635 Remove all images from the article buffer
9636 (@code{gnus-article-remove-images}).
9637
9638 @item W D W
9639 @kindex W D W (Summary)
9640 @findex gnus-html-show-images
9641 If you're reading an @acronym{HTML} article rendered with
9642 @code{gnus-article-html}, then you can insert any blocked images in
9643 the buffer with this command.
9644 (@code{gnus-html-show-images}).
9645
9646 @end table
9647
9648
9649
9650 @node Article Signature
9651 @subsection Article Signature
9652 @cindex signatures
9653 @cindex article signature
9654
9655 @vindex gnus-signature-separator
9656 Each article is divided into two parts---the head and the body. The
9657 body can be divided into a signature part and a text part. The variable
9658 that says what is to be considered a signature is
9659 @code{gnus-signature-separator}. This is normally the standard
9660 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9661 non-standard signature separators, so this variable can also be a list
9662 of regular expressions to be tested, one by one. (Searches are done
9663 from the end of the body towards the beginning.) One likely value is:
9664
9665 @lisp
9666 (setq gnus-signature-separator
9667 '("^-- $" ; @r{The standard}
9668 "^-- *$" ; @r{A common mangling}
9669 "^-------*$" ; @r{Many people just use a looong}
9670 ; @r{line of dashes. Shame!}
9671 "^ *--------*$" ; @r{Double-shame!}
9672 "^________*$" ; @r{Underscores are also popular}
9673 "^========*$")) ; @r{Pervert!}
9674 @end lisp
9675
9676 The more permissive you are, the more likely it is that you'll get false
9677 positives.
9678
9679 @vindex gnus-signature-limit
9680 @code{gnus-signature-limit} provides a limit to what is considered a
9681 signature when displaying articles.
9682
9683 @enumerate
9684 @item
9685 If it is an integer, no signature may be longer (in characters) than
9686 that integer.
9687 @item
9688 If it is a floating point number, no signature may be longer (in lines)
9689 than that number.
9690 @item
9691 If it is a function, the function will be called without any parameters,
9692 and if it returns @code{nil}, there is no signature in the buffer.
9693 @item
9694 If it is a string, it will be used as a regexp. If it matches, the text
9695 in question is not a signature.
9696 @end enumerate
9697
9698 This variable can also be a list where the elements may be of the types
9699 listed above. Here's an example:
9700
9701 @lisp
9702 (setq gnus-signature-limit
9703 '(200.0 "^---*Forwarded article"))
9704 @end lisp
9705
9706 This means that if there are more than 200 lines after the signature
9707 separator, or the text after the signature separator is matched by
9708 the regular expression @samp{^---*Forwarded article}, then it isn't a
9709 signature after all.
9710
9711
9712 @node Article Miscellanea
9713 @subsection Article Miscellanea
9714
9715 @table @kbd
9716 @item A t
9717 @kindex A t (Summary)
9718 @findex gnus-article-babel
9719 Translate the article from one language to another
9720 (@code{gnus-article-babel}).
9721
9722 @end table
9723
9724
9725 @node MIME Commands
9726 @section MIME Commands
9727 @cindex MIME decoding
9728 @cindex attachments
9729 @cindex viewing attachments
9730
9731 The following commands all understand the numerical prefix. For
9732 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9733
9734 @table @kbd
9735 @item b
9736 @itemx K v
9737 @kindex b (Summary)
9738 @kindex K v (Summary)
9739 View the @acronym{MIME} part.
9740
9741 @item K o
9742 @kindex K o (Summary)
9743 Save the @acronym{MIME} part.
9744
9745 @item K O
9746 @kindex K O (Summary)
9747 Prompt for a file name, then save the @acronym{MIME} part and strip it
9748 from the article. The stripped @acronym{MIME} object will be referred
9749 via the message/external-body @acronym{MIME} type.
9750
9751 @item K r
9752 @kindex K r (Summary)
9753 Replace the @acronym{MIME} part with an external body.
9754
9755 @item K d
9756 @kindex K d (Summary)
9757 Delete the @acronym{MIME} part and add some information about the
9758 removed part.
9759
9760 @item K c
9761 @kindex K c (Summary)
9762 Copy the @acronym{MIME} part.
9763
9764 @item K e
9765 @kindex K e (Summary)
9766 View the @acronym{MIME} part externally.
9767
9768 @item K i
9769 @kindex K i (Summary)
9770 View the @acronym{MIME} part internally.
9771
9772 @item K |
9773 @kindex K | (Summary)
9774 Pipe the @acronym{MIME} part to an external command.
9775 @end table
9776
9777 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9778 the same manner:
9779
9780 @table @kbd
9781 @item K H
9782 @kindex K H (Summary)
9783 @findex gnus-article-browse-html-article
9784 View @samp{text/html} parts of the current article with a WWW browser.
9785 Inline images embedded in a message using the @code{cid} scheme, as they
9786 are generally considered to be safe, will be processed properly. The
9787 message header is added to the beginning of every @acronym{HTML} part
9788 unless the prefix argument is given.
9789
9790 Warning: Spammers use links to images (using the @code{http} scheme) in
9791 @acronym{HTML} articles to verify whether you have read the message. As
9792 this command passes the @acronym{HTML} content to the browser without
9793 eliminating these ``web bugs'' you should only use it for mails from
9794 trusted senders.
9795
9796 If you always want to display @acronym{HTML} parts in the browser, set
9797 @code{mm-text-html-renderer} to @code{nil}.
9798
9799 This command creates temporary files to pass @acronym{HTML} contents
9800 including images if any to the browser, and deletes them when exiting
9801 the group (if you want).
9802
9803 @item K b
9804 @kindex K b (Summary)
9805 Make all the @acronym{MIME} parts have buttons in front of them. This is
9806 mostly useful if you wish to save (or perform other actions) on inlined
9807 parts.
9808
9809 @item K m
9810 @kindex K m (Summary)
9811 @findex gnus-summary-repair-multipart
9812 Some multipart messages are transmitted with missing or faulty headers.
9813 This command will attempt to ``repair'' these messages so that they can
9814 be viewed in a more pleasant manner
9815 (@code{gnus-summary-repair-multipart}).
9816
9817 @item X m
9818 @kindex X m (Summary)
9819 @findex gnus-summary-save-parts
9820 Save all parts matching a @acronym{MIME} type to a directory
9821 (@code{gnus-summary-save-parts}). Understands the process/prefix
9822 convention (@pxref{Process/Prefix}).
9823
9824 @item M-t
9825 @kindex M-t (Summary)
9826 @findex gnus-summary-toggle-display-buttonized
9827 Toggle the buttonized display of the article buffer
9828 (@code{gnus-summary-toggle-display-buttonized}).
9829
9830 @item W M w
9831 @kindex W M w (Summary)
9832 @findex gnus-article-decode-mime-words
9833 Decode RFC 2047-encoded words in the article headers
9834 (@code{gnus-article-decode-mime-words}).
9835
9836 @item W M c
9837 @kindex W M c (Summary)
9838 @findex gnus-article-decode-charset
9839 Decode encoded article bodies as well as charsets
9840 (@code{gnus-article-decode-charset}).
9841
9842 This command looks in the @code{Content-Type} header to determine the
9843 charset. If there is no such header in the article, you can give it a
9844 prefix, which will prompt for the charset to decode as. In regional
9845 groups where people post using some common encoding (but do not
9846 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9847 parameter to the required charset (@pxref{Group Parameters}).
9848
9849 @item W M v
9850 @kindex W M v (Summary)
9851 @findex gnus-mime-view-all-parts
9852 View all the @acronym{MIME} parts in the current article
9853 (@code{gnus-mime-view-all-parts}).
9854
9855 @end table
9856
9857 Relevant variables:
9858
9859 @table @code
9860 @item gnus-ignored-mime-types
9861 @vindex gnus-ignored-mime-types
9862 This is a list of regexps. @acronym{MIME} types that match a regexp from
9863 this list will be completely ignored by Gnus. The default value is
9864 @code{nil}.
9865
9866 To have all Vcards be ignored, you'd say something like this:
9867
9868 @lisp
9869 (setq gnus-ignored-mime-types
9870 '("text/x-vcard"))
9871 @end lisp
9872
9873 @item gnus-article-loose-mime
9874 @vindex gnus-article-loose-mime
9875 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9876 before interpreting the message as a @acronym{MIME} message. This helps
9877 when reading messages from certain broken mail user agents. The
9878 default is @code{t}.
9879
9880 @item gnus-article-emulate-mime
9881 @vindex gnus-article-emulate-mime
9882 @cindex uuencode
9883 @cindex yEnc
9884 There are other, non-@acronym{MIME} encoding methods used. The most common
9885 is @samp{uuencode}, but yEncode is also getting to be popular. If
9886 this variable is non-@code{nil}, Gnus will look in message bodies to
9887 see if it finds these encodings, and if so, it'll run them through the
9888 Gnus @acronym{MIME} machinery. The default is @code{t}. Only
9889 single-part yEnc encoded attachments can be decoded. There's no support
9890 for encoding in Gnus.
9891
9892 @item gnus-unbuttonized-mime-types
9893 @vindex gnus-unbuttonized-mime-types
9894 This is a list of regexps. @acronym{MIME} types that match a regexp from
9895 this list won't have @acronym{MIME} buttons inserted unless they aren't
9896 displayed or this variable is overridden by
9897 @code{gnus-buttonized-mime-types}. The default value is
9898 @code{(".*/.*")}. This variable is only used when
9899 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9900
9901 @item gnus-buttonized-mime-types
9902 @vindex gnus-buttonized-mime-types
9903 This is a list of regexps. @acronym{MIME} types that match a regexp from
9904 this list will have @acronym{MIME} buttons inserted unless they aren't
9905 displayed. This variable overrides
9906 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9907 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9908 is @code{nil}.
9909
9910 E.g., to see security buttons but no other buttons, you could set this
9911 variable to @code{("multipart/signed")} and leave
9912 @code{gnus-unbuttonized-mime-types} at the default value.
9913
9914 You could also add @code{"multipart/alternative"} to this list to
9915 display radio buttons that allow you to choose one of two media types
9916 those mails include. See also @code{mm-discouraged-alternatives}
9917 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9918 Emacs MIME Manual}).
9919
9920 @item gnus-inhibit-mime-unbuttonizing
9921 @vindex gnus-inhibit-mime-unbuttonizing
9922 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9923 default value is @code{nil}.
9924
9925 @item gnus-article-mime-part-function
9926 @vindex gnus-article-mime-part-function
9927 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9928 handle as the parameter. The function is meant to be used to allow
9929 users to gather information from the article (e.g., add Vcard info to
9930 the bbdb database) or to do actions based on parts (e.g., automatically
9931 save all jpegs into some directory).
9932
9933 Here's an example function the does the latter:
9934
9935 @lisp
9936 (defun my-save-all-jpeg-parts (handle)
9937 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9938 (with-temp-buffer
9939 (insert (mm-get-part handle))
9940 (write-region (point-min) (point-max)
9941 (read-file-name "Save jpeg to: ")))))
9942 (setq gnus-article-mime-part-function
9943 'my-save-all-jpeg-parts)
9944 @end lisp
9945
9946 @vindex gnus-mime-multipart-functions
9947 @item gnus-mime-multipart-functions
9948 Alist of @acronym{MIME} multipart types and functions to handle them.
9949
9950 @vindex gnus-mime-display-multipart-alternative-as-mixed
9951 @item gnus-mime-display-multipart-alternative-as-mixed
9952 Display "multipart/alternative" parts as "multipart/mixed".
9953
9954 @vindex gnus-mime-display-multipart-related-as-mixed
9955 @item gnus-mime-display-multipart-related-as-mixed
9956 Display "multipart/related" parts as "multipart/mixed".
9957
9958 If displaying @samp{text/html} is discouraged, see
9959 @code{mm-discouraged-alternatives}, images or other material inside a
9960 "multipart/related" part might be overlooked when this variable is
9961 @code{nil}. @ref{Display Customization, Display Customization, ,
9962 emacs-mime, Emacs-Mime Manual}.
9963
9964 @vindex gnus-mime-display-multipart-as-mixed
9965 @item gnus-mime-display-multipart-as-mixed
9966 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9967 overrides @code{nil} values of
9968 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9969 @code{gnus-mime-display-multipart-related-as-mixed}.
9970
9971 @vindex mm-file-name-rewrite-functions
9972 @item mm-file-name-rewrite-functions
9973 List of functions used for rewriting file names of @acronym{MIME} parts.
9974 Each function takes a file name as input and returns a file name.
9975
9976 Ready-made functions include@*
9977 @code{mm-file-name-delete-whitespace},
9978 @code{mm-file-name-trim-whitespace},
9979 @code{mm-file-name-collapse-whitespace}, and
9980 @code{mm-file-name-replace-whitespace}. The later uses the value of
9981 the variable @code{mm-file-name-replace-whitespace} to replace each
9982 whitespace character in a file name with that string; default value
9983 is @code{"_"} (a single underscore).
9984 @findex mm-file-name-delete-whitespace
9985 @findex mm-file-name-trim-whitespace
9986 @findex mm-file-name-collapse-whitespace
9987 @findex mm-file-name-replace-whitespace
9988 @vindex mm-file-name-replace-whitespace
9989
9990 The standard functions @code{capitalize}, @code{downcase},
9991 @code{upcase}, and @code{upcase-initials} may be useful, too.
9992
9993 Everybody knows that whitespace characters in file names are evil,
9994 except those who don't know. If you receive lots of attachments from
9995 such unenlightened users, you can make live easier by adding
9996
9997 @lisp
9998 (setq mm-file-name-rewrite-functions
9999 '(mm-file-name-trim-whitespace
10000 mm-file-name-collapse-whitespace
10001 mm-file-name-replace-whitespace))
10002 @end lisp
10003
10004 @noindent
10005 to your @file{~/.gnus.el} file.
10006
10007 @end table
10008
10009
10010 @node Charsets
10011 @section Charsets
10012 @cindex charsets
10013
10014 People use different charsets, and we have @acronym{MIME} to let us know what
10015 charsets they use. Or rather, we wish we had. Many people use
10016 newsreaders and mailers that do not understand or use @acronym{MIME}, and
10017 just send out messages without saying what character sets they use. To
10018 help a bit with this, some local news hierarchies have policies that say
10019 what character set is the default. For instance, the @samp{fj}
10020 hierarchy uses @code{iso-2022-jp}.
10021
10022 @vindex gnus-group-charset-alist
10023 This knowledge is encoded in the @code{gnus-group-charset-alist}
10024 variable, which is an alist of regexps (use the first item to match full
10025 group names) and default charsets to be used when reading these groups.
10026
10027 @vindex gnus-newsgroup-ignored-charsets
10028 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
10029 aren't. These blithely mark messages as being in @code{iso-8859-1}
10030 even if they really are in @code{koi-8}. To help here, the
10031 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
10032 charsets that are listed here will be ignored. The variable can be
10033 set on a group-by-group basis using the group parameters (@pxref{Group
10034 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
10035 which includes values some agents insist on having in there.
10036
10037 @vindex gnus-group-posting-charset-alist
10038 When posting, @code{gnus-group-posting-charset-alist} is used to
10039 determine which charsets should not be encoded using the @acronym{MIME}
10040 encodings. For instance, some hierarchies discourage using
10041 quoted-printable header encoding.
10042
10043 This variable is an alist of regexps and permitted unencoded charsets
10044 for posting. Each element of the alist has the form @code{(}@var{test
10045 header body-list}@code{)}, where:
10046
10047 @table @var
10048 @item test
10049 is either a regular expression matching the newsgroup header or a
10050 variable to query,
10051 @item header
10052 is the charset which may be left unencoded in the header (@code{nil}
10053 means encode all charsets),
10054 @item body-list
10055 is a list of charsets which may be encoded using 8bit content-transfer
10056 encoding in the body, or one of the special values @code{nil} (always
10057 encode using quoted-printable) or @code{t} (always use 8bit).
10058 @end table
10059
10060 @cindex Russian
10061 @cindex koi8-r
10062 @cindex koi8-u
10063 @cindex iso-8859-5
10064 @cindex coding system aliases
10065 @cindex preferred charset
10066
10067 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
10068 The Emacs MIME Manual}, for additional variables that control which
10069 MIME charsets are used when sending messages.
10070
10071 Other charset tricks that may be useful, although not Gnus-specific:
10072
10073 If there are several @acronym{MIME} charsets that encode the same Emacs
10074 charset, you can choose what charset to use by saying the following:
10075
10076 @lisp
10077 (put-charset-property 'cyrillic-iso8859-5
10078 'preferred-coding-system 'koi8-r)
10079 @end lisp
10080
10081 This means that Russian will be encoded using @code{koi8-r} instead of
10082 the default @code{iso-8859-5} @acronym{MIME} charset.
10083
10084 If you want to read messages in @code{koi8-u}, you can cheat and say
10085
10086 @lisp
10087 (define-coding-system-alias 'koi8-u 'koi8-r)
10088 @end lisp
10089
10090 This will almost do the right thing.
10091
10092 And finally, to read charsets like @code{windows-1251}, you can say
10093 something like
10094
10095 @lisp
10096 (codepage-setup 1251)
10097 (define-coding-system-alias 'windows-1251 'cp1251)
10098 @end lisp
10099
10100
10101 @node Article Commands
10102 @section Article Commands
10103
10104 @table @kbd
10105
10106 @item A P
10107 @cindex PostScript
10108 @cindex printing
10109 @kindex A P (Summary)
10110 @vindex gnus-ps-print-hook
10111 @findex gnus-summary-print-article
10112 Generate and print a PostScript image of the article buffer
10113 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
10114 be run just before printing the buffer. An alternative way to print
10115 article is to use Muttprint (@pxref{Saving Articles}).
10116
10117 @item A C
10118 @vindex gnus-fetch-partial-articles
10119 @findex gnus-summary-show-complete-article
10120 If @code{<backend>-fetch-partial-articles} is non-@code{nil}, Gnus will
10121 fetch partial articles, if the backend it fetches them from supports
10122 it. Currently only @code{nnimap} does. If you're looking at a
10123 partial article, and want to see the complete article instead, then
10124 the @kbd{A C} command (@code{gnus-summary-show-complete-article}) will
10125 do so.
10126
10127 @end table
10128
10129
10130 @node Summary Sorting
10131 @section Summary Sorting
10132 @cindex summary sorting
10133
10134 You can have the summary buffer sorted in various ways, even though I
10135 can't really see why you'd want that.
10136
10137 @table @kbd
10138
10139 @item C-c C-s C-n
10140 @kindex C-c C-s C-n (Summary)
10141 @findex gnus-summary-sort-by-number
10142 Sort by article number (@code{gnus-summary-sort-by-number}).
10143
10144 @item C-c C-s C-m C-n
10145 @kindex C-c C-s C-n (Summary)
10146 @findex gnus-summary-sort-by-most-recent-number
10147 Sort by most recent article number
10148 (@code{gnus-summary-sort-by-most-recent-number}).
10149
10150 @item C-c C-s C-a
10151 @kindex C-c C-s C-a (Summary)
10152 @findex gnus-summary-sort-by-author
10153 Sort by author (@code{gnus-summary-sort-by-author}).
10154
10155 @item C-c C-s C-t
10156 @kindex C-c C-s C-t (Summary)
10157 @findex gnus-summary-sort-by-recipient
10158 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
10159
10160 @item C-c C-s C-s
10161 @kindex C-c C-s C-s (Summary)
10162 @findex gnus-summary-sort-by-subject
10163 Sort by subject (@code{gnus-summary-sort-by-subject}).
10164
10165 @item C-c C-s C-d
10166 @kindex C-c C-s C-d (Summary)
10167 @findex gnus-summary-sort-by-date
10168 Sort by date (@code{gnus-summary-sort-by-date}).
10169
10170 @item C-c C-s C-m C-d
10171 @kindex C-c C-s C-m C-d (Summary)
10172 @findex gnus-summary-sort-by-most-recent-date
10173 Sort by most recent date (@code{gnus-summary-sort-by-most-recent-date}).
10174
10175 @item C-c C-s C-l
10176 @kindex C-c C-s C-l (Summary)
10177 @findex gnus-summary-sort-by-lines
10178 Sort by lines (@code{gnus-summary-sort-by-lines}).
10179
10180 @item C-c C-s C-c
10181 @kindex C-c C-s C-c (Summary)
10182 @findex gnus-summary-sort-by-chars
10183 Sort by article length (@code{gnus-summary-sort-by-chars}).
10184
10185 @item C-c C-s C-i
10186 @kindex C-c C-s C-i (Summary)
10187 @findex gnus-summary-sort-by-score
10188 Sort by score (@code{gnus-summary-sort-by-score}).
10189
10190 @item C-c C-s C-r
10191 @kindex C-c C-s C-r (Summary)
10192 @findex gnus-summary-sort-by-random
10193 Randomize (@code{gnus-summary-sort-by-random}).
10194
10195 @item C-c C-s C-o
10196 @kindex C-c C-s C-o (Summary)
10197 @findex gnus-summary-sort-by-original
10198 Sort using the default sorting method
10199 (@code{gnus-summary-sort-by-original}).
10200 @end table
10201
10202 These functions will work both when you use threading and when you don't
10203 use threading. In the latter case, all summary lines will be sorted,
10204 line by line. In the former case, sorting will be done on a
10205 root-by-root basis, which might not be what you were looking for. To
10206 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
10207 Commands}).
10208
10209 If a prefix argument if given, the sort order is reversed.
10210
10211
10212 @node Finding the Parent
10213 @section Finding the Parent
10214 @cindex parent articles
10215 @cindex referring articles
10216
10217 @table @kbd
10218 @item ^
10219 @kindex ^ (Summary)
10220 @findex gnus-summary-refer-parent-article
10221 If you'd like to read the parent of the current article, and it is not
10222 displayed in the summary buffer, you might still be able to. That is,
10223 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
10224 and the @code{References} in the current article are not mangled, you
10225 can just press @kbd{^} or @kbd{A r}
10226 (@code{gnus-summary-refer-parent-article}). If everything goes well,
10227 you'll get the parent. If the parent is already displayed in the
10228 summary buffer, point will just move to this article.
10229
10230 If given a positive numerical prefix, fetch that many articles back into
10231 the ancestry. If given a negative numerical prefix, fetch just that
10232 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
10233 grandparent and the great-grandparent of the current article. If you say
10234 @kbd{-3 ^}, Gnus will only fetch the great-grandparent of the current
10235 article.
10236
10237 @item A R (Summary)
10238 @findex gnus-summary-refer-references
10239 @kindex A R (Summary)
10240 Fetch all articles mentioned in the @code{References} header of the
10241 article (@code{gnus-summary-refer-references}).
10242
10243 @item A T (Summary)
10244 @findex gnus-summary-refer-thread
10245 @kindex A T (Summary)
10246 Display the full thread where the current article appears
10247 (@code{gnus-summary-refer-thread}). This command has to fetch all the
10248 headers in the current group to work, so it usually takes a while. If
10249 you do it often, you may consider setting @code{gnus-fetch-old-headers}
10250 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
10251 visible effects normally, but it'll make this command work a whole lot
10252 faster. Of course, it'll make group entry somewhat slow.
10253
10254 @vindex gnus-refer-thread-limit
10255 The @code{gnus-refer-thread-limit} variable says how many old (i.e.,
10256 articles before the first displayed in the current group) headers to
10257 fetch when doing this command. The default is 200. If @code{t}, all
10258 the available headers will be fetched. This variable can be overridden
10259 by giving the @kbd{A T} command a numerical prefix.
10260
10261 @item M-^ (Summary)
10262 @findex gnus-summary-refer-article
10263 @kindex M-^ (Summary)
10264 @cindex Message-ID
10265 @cindex fetching by Message-ID
10266 You can also ask Gnus for an arbitrary article, no matter what group it
10267 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
10268 for a @code{Message-ID}, which is one of those long, hard-to-read
10269 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
10270 You have to get it all exactly right. No fuzzy searches, I'm afraid.
10271
10272 Gnus looks for the @code{Message-ID} in the headers that have already
10273 been fetched, but also tries all the select methods specified by
10274 @code{gnus-refer-article-method} if it is not found.
10275 @end table
10276
10277 @vindex gnus-refer-article-method
10278 If the group you are reading is located on a back end that does not
10279 support fetching by @code{Message-ID} very well (like @code{nnspool}),
10280 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
10281 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
10282 updating the spool you are reading from, but that's not really
10283 necessary.
10284
10285 It can also be a list of select methods, as well as the special symbol
10286 @code{current}, which means to use the current select method. If it
10287 is a list, Gnus will try all the methods in the list until it finds a
10288 match.
10289
10290 Here's an example setting that will first try the current method, and
10291 then ask Google if that fails:
10292
10293 @lisp
10294 (setq gnus-refer-article-method
10295 '(current
10296 (nnweb "google" (nnweb-type google))))
10297 @end lisp
10298
10299 Most of the mail back ends support fetching by @code{Message-ID}, but
10300 do not do a particularly excellent job at it. That is, @code{nnmbox},
10301 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
10302 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
10303 only able to locate articles that have been posted to the current
10304 group. @code{nnmh} does not support this at all.
10305
10306 Fortunately, the special @code{nnregistry} back end is able to locate
10307 articles in any groups, regardless of their back end (@pxref{Registry
10308 Article Refer Method, fetching by @code{Message-ID} using the
10309 registry}).
10310
10311 @node Alternative Approaches
10312 @section Alternative Approaches
10313
10314 Different people like to read news using different methods. This being
10315 Gnus, we offer a small selection of minor modes for the summary buffers.
10316
10317 @menu
10318 * Pick and Read:: First mark articles and then read them.
10319 * Binary Groups:: Auto-decode all articles.
10320 @end menu
10321
10322
10323 @node Pick and Read
10324 @subsection Pick and Read
10325 @cindex pick and read
10326
10327 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
10328 a two-phased reading interface. The user first marks in a summary
10329 buffer the articles she wants to read. Then she starts reading the
10330 articles with just an article buffer displayed.
10331
10332 @findex gnus-pick-mode
10333 @kindex M-x gnus-pick-mode
10334 Gnus provides a summary buffer minor mode that allows
10335 this---@code{gnus-pick-mode}. This basically means that a few process
10336 mark commands become one-keystroke commands to allow easy marking, and
10337 it provides one additional command for switching to the summary buffer.
10338
10339 Here are the available keystrokes when using pick mode:
10340
10341 @table @kbd
10342 @item .
10343 @kindex . (Pick)
10344 @findex gnus-pick-article-or-thread
10345 Pick the article or thread on the current line
10346 (@code{gnus-pick-article-or-thread}). If the variable
10347 @code{gnus-thread-hide-subtree} is true, then this key selects the
10348 entire thread when used at the first article of the thread. Otherwise,
10349 it selects just the article. If given a numerical prefix, go to that
10350 thread or article and pick it. (The line number is normally displayed
10351 at the beginning of the summary pick lines.)
10352
10353 @item SPACE
10354 @kindex SPACE (Pick)
10355 @findex gnus-pick-next-page
10356 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
10357 at the end of the buffer, start reading the picked articles.
10358
10359 @item u
10360 @kindex u (Pick)
10361 @findex gnus-pick-unmark-article-or-thread.
10362 Unpick the thread or article
10363 (@code{gnus-pick-unmark-article-or-thread}). If the variable
10364 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
10365 thread if used at the first article of the thread. Otherwise it unpicks
10366 just the article. You can give this key a numerical prefix to unpick
10367 the thread or article at that line.
10368
10369 @item RET
10370 @kindex RET (Pick)
10371 @findex gnus-pick-start-reading
10372 @vindex gnus-pick-display-summary
10373 Start reading the picked articles (@code{gnus-pick-start-reading}). If
10374 given a prefix, mark all unpicked articles as read first. If
10375 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
10376 will still be visible when you are reading.
10377
10378 @end table
10379
10380 All the normal summary mode commands are still available in the
10381 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
10382 which is mapped to the same function
10383 @code{gnus-summary-tick-article-forward}.
10384
10385 If this sounds like a good idea to you, you could say:
10386
10387 @lisp
10388 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
10389 @end lisp
10390
10391 @vindex gnus-pick-mode-hook
10392 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
10393
10394 @vindex gnus-mark-unpicked-articles-as-read
10395 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
10396 all unpicked articles as read. The default is @code{nil}.
10397
10398 @vindex gnus-summary-pick-line-format
10399 The summary line format in pick mode is slightly different from the
10400 standard format. At the beginning of each line the line number is
10401 displayed. The pick mode line format is controlled by the
10402 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
10403 Variables}). It accepts the same format specs that
10404 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
10405
10406
10407 @node Binary Groups
10408 @subsection Binary Groups
10409 @cindex binary groups
10410
10411 @findex gnus-binary-mode
10412 @kindex M-x gnus-binary-mode
10413 If you spend much time in binary groups, you may grow tired of hitting
10414 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
10415 is a minor mode for summary buffers that makes all ordinary Gnus article
10416 selection functions uudecode series of articles and display the result
10417 instead of just displaying the articles the normal way.
10418
10419 @kindex g (Binary)
10420 @findex gnus-binary-show-article
10421 The only way, in fact, to see the actual articles is the @kbd{g}
10422 command, when you have turned on this mode
10423 (@code{gnus-binary-show-article}).
10424
10425 @vindex gnus-binary-mode-hook
10426 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
10427
10428
10429 @node Tree Display
10430 @section Tree Display
10431 @cindex trees
10432
10433 @vindex gnus-use-trees
10434 If you don't like the normal Gnus summary display, you might try setting
10435 @code{gnus-use-trees} to @code{t}. This will create (by default) an
10436 additional @dfn{tree buffer}. You can execute all summary mode commands
10437 in the tree buffer.
10438
10439 There are a few variables to customize the tree display, of course:
10440
10441 @table @code
10442 @item gnus-tree-mode-hook
10443 @vindex gnus-tree-mode-hook
10444 A hook called in all tree mode buffers.
10445
10446 @item gnus-tree-mode-line-format
10447 @vindex gnus-tree-mode-line-format
10448 A format string for the mode bar in the tree mode buffers (@pxref{Mode
10449 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
10450 of valid specs, @pxref{Summary Buffer Mode Line}.
10451
10452 @item gnus-selected-tree-face
10453 @vindex gnus-selected-tree-face
10454 Face used for highlighting the selected article in the tree buffer. The
10455 default is @code{modeline}.
10456
10457 @item gnus-tree-line-format
10458 @vindex gnus-tree-line-format
10459 A format string for the tree nodes. The name is a bit of a misnomer,
10460 though---it doesn't define a line, but just the node. The default value
10461 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
10462 the name of the poster. It is vital that all nodes are of the same
10463 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
10464
10465 Valid specs are:
10466
10467 @table @samp
10468 @item n
10469 The name of the poster.
10470 @item f
10471 The @code{From} header.
10472 @item N
10473 The number of the article.
10474 @item [
10475 The opening bracket.
10476 @item ]
10477 The closing bracket.
10478 @item s
10479 The subject.
10480 @end table
10481
10482 @xref{Formatting Variables}.
10483
10484 Variables related to the display are:
10485
10486 @table @code
10487 @item gnus-tree-brackets
10488 @vindex gnus-tree-brackets
10489 This is used for differentiating between ``real'' articles and
10490 ``sparse'' articles. The format is
10491 @example
10492 ((@var{real-open} . @var{real-close})
10493 (@var{sparse-open} . @var{sparse-close})
10494 (@var{dummy-open} . @var{dummy-close}))
10495 @end example
10496 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10497
10498 @item gnus-tree-parent-child-edges
10499 @vindex gnus-tree-parent-child-edges
10500 This is a list that contains the characters used for connecting parent
10501 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10502
10503 @end table
10504
10505 @item gnus-tree-minimize-window
10506 @vindex gnus-tree-minimize-window
10507 If this variable is non-@code{nil}, Gnus will try to keep the tree
10508 buffer as small as possible to allow more room for the other Gnus
10509 windows. If this variable is a number, the tree buffer will never be
10510 higher than that number. The default is @code{t}. Note that if you
10511 have several windows displayed side-by-side in a frame and the tree
10512 buffer is one of these, minimizing the tree window will also resize all
10513 other windows displayed next to it.
10514
10515 You may also wish to add the following hook to keep the window minimized
10516 at all times:
10517
10518 @lisp
10519 (add-hook 'gnus-configure-windows-hook
10520 'gnus-tree-perhaps-minimize)
10521 @end lisp
10522
10523 @item gnus-generate-tree-function
10524 @vindex gnus-generate-tree-function
10525 @findex gnus-generate-horizontal-tree
10526 @findex gnus-generate-vertical-tree
10527 The function that actually generates the thread tree. Two predefined
10528 functions are available: @code{gnus-generate-horizontal-tree} and
10529 @code{gnus-generate-vertical-tree} (which is the default).
10530
10531 @end table
10532
10533 Here's an example from a horizontal tree buffer:
10534
10535 @example
10536 @{***@}-(***)-[odd]-[Gun]
10537 | \[Jan]
10538 | \[odd]-[Eri]
10539 | \(***)-[Eri]
10540 | \[odd]-[Paa]
10541 \[Bjo]
10542 \[Gun]
10543 \[Gun]-[Jor]
10544 @end example
10545
10546 Here's the same thread displayed in a vertical tree buffer:
10547
10548 @example
10549 @group
10550 @{***@}
10551 |--------------------------\-----\-----\
10552 (***) [Bjo] [Gun] [Gun]
10553 |--\-----\-----\ |
10554 [odd] [Jan] [odd] (***) [Jor]
10555 | | |--\
10556 [Gun] [Eri] [Eri] [odd]
10557 |
10558 [Paa]
10559 @end group
10560 @end example
10561
10562 If you're using horizontal trees, it might be nice to display the trees
10563 side-by-side with the summary buffer. You could add something like the
10564 following to your @file{~/.gnus.el} file:
10565
10566 @lisp
10567 (setq gnus-use-trees t
10568 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10569 gnus-tree-minimize-window nil)
10570 (gnus-add-configuration
10571 '(article
10572 (vertical 1.0
10573 (horizontal 0.25
10574 (summary 0.75 point)
10575 (tree 1.0))
10576 (article 1.0))))
10577 @end lisp
10578
10579 @xref{Window Layout}.
10580
10581
10582 @node Mail Group Commands
10583 @section Mail Group Commands
10584 @cindex mail group commands
10585
10586 Some commands only make sense in mail groups. If these commands are
10587 invalid in the current group, they will raise a hell and let you know.
10588
10589 All these commands (except the expiry and edit commands) use the
10590 process/prefix convention (@pxref{Process/Prefix}).
10591
10592 @table @kbd
10593
10594 @item B e
10595 @kindex B e (Summary)
10596 @findex gnus-summary-expire-articles
10597 @cindex expiring mail
10598 Run all expirable articles in the current group through the expiry
10599 process (@code{gnus-summary-expire-articles}). That is, delete all
10600 expirable articles in the group that have been around for a while.
10601 (@pxref{Expiring Mail}).
10602
10603 @item B C-M-e
10604 @kindex B C-M-e (Summary)
10605 @findex gnus-summary-expire-articles-now
10606 @cindex expiring mail
10607 Delete all the expirable articles in the group
10608 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10609 articles eligible for expiry in the current group will
10610 disappear forever into that big @file{/dev/null} in the sky.
10611
10612 @item B DEL
10613 @kindex B DEL (Summary)
10614 @cindex deleting mail
10615 @findex gnus-summary-delete-article
10616 @c @icon{gnus-summary-mail-delete}
10617 Delete the mail article. This is ``delete'' as in ``delete it from your
10618 disk forever and ever, never to return again.'' Use with caution.
10619 (@code{gnus-summary-delete-article}).
10620
10621 @item B m
10622 @kindex B m (Summary)
10623 @cindex move mail
10624 @findex gnus-summary-move-article
10625 @vindex gnus-preserve-marks
10626 Move the article from one mail group to another
10627 (@code{gnus-summary-move-article}). Marks will be preserved if
10628 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10629
10630 @item B c
10631 @kindex B c (Summary)
10632 @cindex copy mail
10633 @findex gnus-summary-copy-article
10634 @c @icon{gnus-summary-mail-copy}
10635 Copy the article from one group (mail group or not) to a mail group
10636 (@code{gnus-summary-copy-article}). Marks will be preserved if
10637 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10638
10639 @item B B
10640 @kindex B B (Summary)
10641 @cindex crosspost mail
10642 @findex gnus-summary-crosspost-article
10643 Crosspost the current article to some other group
10644 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10645 the article in the other group, and the Xref headers of the article will
10646 be properly updated.
10647
10648 @item B i
10649 @kindex B i (Summary)
10650 @findex gnus-summary-import-article
10651 Import an arbitrary file into the current mail newsgroup
10652 (@code{gnus-summary-import-article}). You will be prompted for a file
10653 name, a @code{From} header and a @code{Subject} header.
10654
10655 @item B I
10656 @kindex B I (Summary)
10657 @findex gnus-summary-create-article
10658 Create an empty article in the current mail newsgroups
10659 (@code{gnus-summary-create-article}). You will be prompted for a
10660 @code{From} header and a @code{Subject} header.
10661
10662 @item B r
10663 @kindex B r (Summary)
10664 @findex gnus-summary-respool-article
10665 @vindex gnus-summary-respool-default-method
10666 Respool the mail article (@code{gnus-summary-respool-article}).
10667 @code{gnus-summary-respool-default-method} will be used as the default
10668 select method when respooling. This variable is @code{nil} by default,
10669 which means that the current group select method will be used instead.
10670 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10671 (which is the default).
10672
10673 @item B w
10674 @itemx e
10675 @kindex B w (Summary)
10676 @kindex e (Summary)
10677 @findex gnus-summary-edit-article
10678 @kindex C-c C-c (Article)
10679 @findex gnus-summary-edit-article-done
10680 Edit the current article (@code{gnus-summary-edit-article}). To finish
10681 editing and make the changes permanent, type @kbd{C-c C-c}
10682 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10683 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10684
10685 @item B q
10686 @kindex B q (Summary)
10687 @findex gnus-summary-respool-query
10688 If you want to re-spool an article, you might be curious as to what group
10689 the article will end up in before you do the re-spooling. This command
10690 will tell you (@code{gnus-summary-respool-query}).
10691
10692 @item B t
10693 @kindex B t (Summary)
10694 @findex gnus-summary-respool-trace
10695 Similarly, this command will display all fancy splitting patterns used
10696 when respooling, if any (@code{gnus-summary-respool-trace}).
10697
10698 @item B p
10699 @kindex B p (Summary)
10700 @findex gnus-summary-article-posted-p
10701 Some people have a tendency to send you ``courtesy'' copies when they
10702 follow up to articles you have posted. These usually have a
10703 @code{Newsgroups} header in them, but not always. This command
10704 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10705 article from your news server (or rather, from
10706 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10707 report back whether it found the article or not. Even if it says that
10708 it didn't find the article, it may have been posted anyway---mail
10709 propagation is much faster than news propagation, and the news copy may
10710 just not have arrived yet.
10711
10712 @item K E
10713 @kindex K E (Summary)
10714 @findex gnus-article-encrypt-body
10715 @vindex gnus-article-encrypt-protocol
10716 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10717 The body is encrypted with the encryption protocol specified by the
10718 variable @code{gnus-article-encrypt-protocol}.
10719
10720 @end table
10721
10722 @vindex gnus-move-split-methods
10723 @cindex moving articles
10724 If you move (or copy) articles regularly, you might wish to have Gnus
10725 suggest where to put the articles. @code{gnus-move-split-methods} is a
10726 variable that uses the same syntax as @code{gnus-split-methods}
10727 (@pxref{Saving Articles}). You may customize that variable to create
10728 suggestions you find reasonable. (Note that
10729 @code{gnus-move-split-methods} uses group names where
10730 @code{gnus-split-methods} uses file names.)
10731
10732 @lisp
10733 (setq gnus-move-split-methods
10734 '(("^From:.*Lars Magne" "nnml:junk")
10735 ("^Subject:.*gnus" "nnfolder:important")
10736 (".*" "nnml:misc")))
10737 @end lisp
10738
10739
10740 @node Various Summary Stuff
10741 @section Various Summary Stuff
10742
10743 @menu
10744 * Summary Group Information:: Information oriented commands.
10745 * Searching for Articles:: Multiple article commands.
10746 * Summary Generation Commands::
10747 * Really Various Summary Commands:: Those pesky non-conformant commands.
10748 @end menu
10749
10750 @table @code
10751 @vindex gnus-summary-display-while-building
10752 @item gnus-summary-display-while-building
10753 If non-@code{nil}, show and update the summary buffer as it's being
10754 built. If @code{t}, update the buffer after every line is inserted.
10755 If the value is an integer, @var{n}, update the display every @var{n}
10756 lines. The default is @code{nil}.
10757
10758 @vindex gnus-summary-display-arrow
10759 @item gnus-summary-display-arrow
10760 If non-@code{nil}, display an arrow in the fringe to indicate the
10761 current article.
10762
10763 @vindex gnus-summary-mode-hook
10764 @item gnus-summary-mode-hook
10765 This hook is called when creating a summary mode buffer.
10766
10767 @vindex gnus-summary-generate-hook
10768 @item gnus-summary-generate-hook
10769 This is called as the last thing before doing the threading and the
10770 generation of the summary buffer. It's quite convenient for customizing
10771 the threading variables based on what data the newsgroup has. This hook
10772 is called from the summary buffer after most summary buffer variables
10773 have been set.
10774
10775 @vindex gnus-summary-prepare-hook
10776 @item gnus-summary-prepare-hook
10777 It is called after the summary buffer has been generated. You might use
10778 it to, for instance, highlight lines or modify the look of the buffer in
10779 some other ungodly manner. I don't care.
10780
10781 @vindex gnus-summary-prepared-hook
10782 @item gnus-summary-prepared-hook
10783 A hook called as the very last thing after the summary buffer has been
10784 generated.
10785
10786 @vindex gnus-summary-ignore-duplicates
10787 @item gnus-summary-ignore-duplicates
10788 When Gnus discovers two articles that have the same @code{Message-ID},
10789 it has to do something drastic. No articles are allowed to have the
10790 same @code{Message-ID}, but this may happen when reading mail from some
10791 sources. Gnus allows you to customize what happens with this variable.
10792 If it is @code{nil} (which is the default), Gnus will rename the
10793 @code{Message-ID} (for display purposes only) and display the article as
10794 any other article. If this variable is @code{t}, it won't display the
10795 article---it'll be as if it never existed.
10796
10797 @vindex gnus-alter-articles-to-read-function
10798 @item gnus-alter-articles-to-read-function
10799 This function, which takes two parameters (the group name and the list
10800 of articles to be selected), is called to allow the user to alter the
10801 list of articles to be selected.
10802
10803 For instance, the following function adds the list of cached articles to
10804 the list in one particular group:
10805
10806 @lisp
10807 (defun my-add-cached-articles (group articles)
10808 (if (string= group "some.group")
10809 (append gnus-newsgroup-cached articles)
10810 articles))
10811 @end lisp
10812
10813 @vindex gnus-newsgroup-variables
10814 @item gnus-newsgroup-variables
10815 A list of newsgroup (summary buffer) local variables, or cons of
10816 variables and their default expressions to be evalled (when the default
10817 values are not @code{nil}), that should be made global while the summary
10818 buffer is active.
10819
10820 Note: The default expressions will be evaluated (using function
10821 @code{eval}) before assignment to the local variable rather than just
10822 assigned to it. If the default expression is the symbol @code{global},
10823 that symbol will not be evaluated but the global value of the local
10824 variable will be used instead.
10825
10826 These variables can be used to set variables in the group parameters
10827 while still allowing them to affect operations done in other
10828 buffers. For example:
10829
10830 @lisp
10831 (setq gnus-newsgroup-variables
10832 '(message-use-followup-to
10833 (gnus-visible-headers .
10834 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10835 @end lisp
10836
10837 Also @pxref{Group Parameters}.
10838
10839 @end table
10840
10841
10842 @node Summary Group Information
10843 @subsection Summary Group Information
10844
10845 @table @kbd
10846
10847 @item H d
10848 @kindex H d (Summary)
10849 @findex gnus-summary-describe-group
10850 Give a brief description of the current group
10851 (@code{gnus-summary-describe-group}). If given a prefix, force
10852 rereading the description from the server.
10853
10854 @item H h
10855 @kindex H h (Summary)
10856 @findex gnus-summary-describe-briefly
10857 Give an extremely brief description of the most important summary
10858 keystrokes (@code{gnus-summary-describe-briefly}).
10859
10860 @item H i
10861 @kindex H i (Summary)
10862 @findex gnus-info-find-node
10863 Go to the Gnus info node (@code{gnus-info-find-node}).
10864 @end table
10865
10866
10867 @node Searching for Articles
10868 @subsection Searching for Articles
10869
10870 @table @kbd
10871
10872 @item M-s
10873 @kindex M-s (Summary)
10874 @findex gnus-summary-search-article-forward
10875 Search through all subsequent (raw) articles for a regexp
10876 (@code{gnus-summary-search-article-forward}).
10877
10878 @item M-r
10879 @kindex M-r (Summary)
10880 @findex gnus-summary-search-article-backward
10881 Search through all previous (raw) articles for a regexp
10882 (@code{gnus-summary-search-article-backward}).
10883
10884 @item M-S
10885 @kindex M-S (Summary)
10886 @findex gnus-summary-repeat-search-article-forward
10887 Repeat the previous search forwards
10888 (@code{gnus-summary-repeat-search-article-forward}).
10889
10890 @item M-R
10891 @kindex M-R (Summary)
10892 @findex gnus-summary-repeat-search-article-backward
10893 Repeat the previous search backwards
10894 (@code{gnus-summary-repeat-search-article-backward}).
10895
10896 @item &
10897 @kindex & (Summary)
10898 @findex gnus-summary-execute-command
10899 This command will prompt you for a header, a regular expression to match
10900 on this field, and a command to be executed if the match is made
10901 (@code{gnus-summary-execute-command}). If the header is an empty
10902 string, the match is done on the entire article. If given a prefix,
10903 search backward instead.
10904
10905 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10906 all articles that have heads or bodies that match @samp{some.*string}.
10907
10908 @item M-&
10909 @kindex M-& (Summary)
10910 @findex gnus-summary-universal-argument
10911 Perform any operation on all articles that have been marked with
10912 the process mark (@code{gnus-summary-universal-argument}).
10913 @end table
10914
10915 @node Summary Generation Commands
10916 @subsection Summary Generation Commands
10917
10918 @table @kbd
10919
10920 @item Y g
10921 @kindex Y g (Summary)
10922 @findex gnus-summary-prepare
10923 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10924
10925 @item Y c
10926 @kindex Y c (Summary)
10927 @findex gnus-summary-insert-cached-articles
10928 Pull all cached articles (for the current group) into the summary buffer
10929 (@code{gnus-summary-insert-cached-articles}).
10930
10931 @item Y d
10932 @kindex Y d (Summary)
10933 @findex gnus-summary-insert-dormant-articles
10934 Pull all dormant articles (for the current group) into the summary buffer
10935 (@code{gnus-summary-insert-dormant-articles}).
10936
10937 @item Y t
10938 @kindex Y t (Summary)
10939 @findex gnus-summary-insert-ticked-articles
10940 Pull all ticked articles (for the current group) into the summary buffer
10941 (@code{gnus-summary-insert-ticked-articles}).
10942
10943 @end table
10944
10945
10946 @node Really Various Summary Commands
10947 @subsection Really Various Summary Commands
10948
10949 @table @kbd
10950
10951 @item A D
10952 @itemx C-d
10953 @kindex C-d (Summary)
10954 @kindex A D (Summary)
10955 @findex gnus-summary-enter-digest-group
10956 If the current article is a collection of other articles (for instance,
10957 a digest), you might use this command to enter a group based on the that
10958 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10959 guess what article type is currently displayed unless you give a prefix
10960 to this command, which forces a ``digest'' interpretation. Basically,
10961 whenever you see a message that is a collection of other messages of
10962 some format, you @kbd{C-d} and read these messages in a more convenient
10963 fashion.
10964
10965 @vindex gnus-auto-select-on-ephemeral-exit
10966 The variable @code{gnus-auto-select-on-ephemeral-exit} controls what
10967 article should be selected after exiting a digest group. Valid values
10968 include:
10969
10970 @table @code
10971 @item next
10972 Select the next article.
10973
10974 @item next-unread
10975 Select the next unread article.
10976
10977 @item next-noselect
10978 Move the cursor to the next article. This is the default.
10979
10980 @item next-unread-noselect
10981 Move the cursor to the next unread article.
10982 @end table
10983
10984 If it has any other value or there is no next (unread) article, the
10985 article selected before entering to the digest group will appear.
10986
10987 @item C-M-d
10988 @kindex C-M-d (Summary)
10989 @findex gnus-summary-read-document
10990 This command is very similar to the one above, but lets you gather
10991 several documents into one biiig group
10992 (@code{gnus-summary-read-document}). It does this by opening several
10993 @code{nndoc} groups for each document, and then opening an
10994 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10995 command understands the process/prefix convention
10996 (@pxref{Process/Prefix}).
10997
10998 @item C-t
10999 @kindex C-t (Summary)
11000 @findex gnus-summary-toggle-truncation
11001 Toggle truncation of summary lines
11002 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
11003 line centering function in the summary buffer, so it's not a good idea
11004 to have truncation switched off while reading articles.
11005
11006 @item =
11007 @kindex = (Summary)
11008 @findex gnus-summary-expand-window
11009 Expand the summary buffer window (@code{gnus-summary-expand-window}).
11010 If given a prefix, force an @code{article} window configuration.
11011
11012 @item C-M-e
11013 @kindex C-M-e (Summary)
11014 @findex gnus-summary-edit-parameters
11015 Edit the group parameters (@pxref{Group Parameters}) of the current
11016 group (@code{gnus-summary-edit-parameters}).
11017
11018 @item C-M-a
11019 @kindex C-M-a (Summary)
11020 @findex gnus-summary-customize-parameters
11021 Customize the group parameters (@pxref{Group Parameters}) of the current
11022 group (@code{gnus-summary-customize-parameters}).
11023
11024 @end table
11025
11026
11027 @node Exiting the Summary Buffer
11028 @section Exiting the Summary Buffer
11029 @cindex summary exit
11030 @cindex exiting groups
11031
11032 Exiting from the summary buffer will normally update all info on the
11033 group and return you to the group buffer.
11034
11035 @table @kbd
11036
11037 @item Z Z
11038 @itemx Z Q
11039 @itemx q
11040 @kindex Z Z (Summary)
11041 @kindex Z Q (Summary)
11042 @kindex q (Summary)
11043 @findex gnus-summary-exit
11044 @vindex gnus-summary-exit-hook
11045 @vindex gnus-summary-prepare-exit-hook
11046 @vindex gnus-group-no-more-groups-hook
11047 @c @icon{gnus-summary-exit}
11048 Exit the current group and update all information on the group
11049 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
11050 called before doing much of the exiting, which calls
11051 @code{gnus-summary-expire-articles} by default.
11052 @code{gnus-summary-exit-hook} is called after finishing the exit
11053 process. @code{gnus-group-no-more-groups-hook} is run when returning to
11054 group mode having no more (unread) groups.
11055
11056 @item Z E
11057 @itemx Q
11058 @kindex Z E (Summary)
11059 @kindex Q (Summary)
11060 @findex gnus-summary-exit-no-update
11061 Exit the current group without updating any information on the group
11062 (@code{gnus-summary-exit-no-update}).
11063
11064 @item Z c
11065 @itemx c
11066 @kindex Z c (Summary)
11067 @kindex c (Summary)
11068 @findex gnus-summary-catchup-and-exit
11069 @c @icon{gnus-summary-catchup-and-exit}
11070 Mark all unticked articles in the group as read and then exit
11071 (@code{gnus-summary-catchup-and-exit}).
11072
11073 @item Z C
11074 @kindex Z C (Summary)
11075 @findex gnus-summary-catchup-all-and-exit
11076 Mark all articles, even the ticked ones, as read and then exit
11077 (@code{gnus-summary-catchup-all-and-exit}).
11078
11079 @item Z n
11080 @kindex Z n (Summary)
11081 @findex gnus-summary-catchup-and-goto-next-group
11082 Mark all articles as read and go to the next group
11083 (@code{gnus-summary-catchup-and-goto-next-group}).
11084
11085 @item Z p
11086 @kindex Z p (Summary)
11087 @findex gnus-summary-catchup-and-goto-prev-group
11088 Mark all articles as read and go to the previous group
11089 (@code{gnus-summary-catchup-and-goto-prev-group}).
11090
11091 @item Z R
11092 @itemx C-x C-s
11093 @kindex Z R (Summary)
11094 @kindex C-x C-s (Summary)
11095 @findex gnus-summary-reselect-current-group
11096 Exit this group, and then enter it again
11097 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
11098 all articles, both read and unread.
11099
11100 @item Z G
11101 @itemx M-g
11102 @kindex Z G (Summary)
11103 @kindex M-g (Summary)
11104 @findex gnus-summary-rescan-group
11105 @c @icon{gnus-summary-mail-get}
11106 Exit the group, check for new articles in the group, and select the
11107 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
11108 articles, both read and unread.
11109
11110 @item Z N
11111 @kindex Z N (Summary)
11112 @findex gnus-summary-next-group
11113 Exit the group and go to the next group
11114 (@code{gnus-summary-next-group}).
11115
11116 @item Z P
11117 @kindex Z P (Summary)
11118 @findex gnus-summary-prev-group
11119 Exit the group and go to the previous group
11120 (@code{gnus-summary-prev-group}).
11121
11122 @item Z s
11123 @kindex Z s (Summary)
11124 @findex gnus-summary-save-newsrc
11125 Save the current number of read/marked articles in the dribble buffer
11126 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
11127 given a prefix, also save the @file{.newsrc} file(s). Using this
11128 command will make exit without updating (the @kbd{Q} command) worthless.
11129 @end table
11130
11131 @vindex gnus-exit-group-hook
11132 @code{gnus-exit-group-hook} is called when you exit the current group
11133 with an ``updating'' exit. For instance @kbd{Q}
11134 (@code{gnus-summary-exit-no-update}) does not call this hook.
11135
11136 @findex gnus-summary-wake-up-the-dead
11137 @findex gnus-dead-summary-mode
11138 @vindex gnus-kill-summary-on-exit
11139 If you're in the habit of exiting groups, and then changing your mind
11140 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
11141 If you do that, Gnus won't kill the summary buffer when you exit it.
11142 (Quelle surprise!) Instead it will change the name of the buffer to
11143 something like @file{*Dead Summary ... *} and install a minor mode
11144 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
11145 buffer, you'll find that all keys are mapped to a function called
11146 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
11147 summary buffer will result in a live, normal summary buffer.
11148
11149 There will never be more than one dead summary buffer at any one time.
11150
11151 @vindex gnus-use-cross-reference
11152 The data on the current group will be updated (which articles you have
11153 read, which articles you have replied to, etc.)@: when you exit the
11154 summary buffer. If the @code{gnus-use-cross-reference} variable is
11155 @code{t} (which is the default), articles that are cross-referenced to
11156 this group and are marked as read, will also be marked as read in the
11157 other subscribed groups they were cross-posted to. If this variable is
11158 neither @code{nil} nor @code{t}, the article will be marked as read in
11159 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
11160
11161
11162 @node Crosspost Handling
11163 @section Crosspost Handling
11164
11165 @cindex velveeta
11166 @cindex spamming
11167 Marking cross-posted articles as read ensures that you'll never have to
11168 read the same article more than once. Unless, of course, somebody has
11169 posted it to several groups separately. Posting the same article to
11170 several groups (not cross-posting) is called @dfn{spamming}, and you are
11171 by law required to send nasty-grams to anyone who perpetrates such a
11172 heinous crime.
11173
11174 Remember: Cross-posting is kinda ok, but posting the same article
11175 separately to several groups is not. Massive cross-posting (aka.
11176 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
11177 @code{gnus-summary-mail-crosspost-complaint} command to complain about
11178 excessive crossposting (@pxref{Summary Mail Commands}).
11179
11180 @cindex cross-posting
11181 @cindex Xref
11182 @cindex @acronym{NOV}
11183 One thing that may cause Gnus to not do the cross-posting thing
11184 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
11185 (which is very nice, because it speeds things up considerably) which
11186 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
11187 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
11188 even with @sc{xover} by registering the @code{Xref} lines of all
11189 articles you actually read, but if you kill the articles, or just mark
11190 them as read without reading them, Gnus will not get a chance to snoop
11191 the @code{Xref} lines out of these articles, and will be unable to use
11192 the cross reference mechanism.
11193
11194 @cindex LIST overview.fmt
11195 @cindex overview.fmt
11196 To check whether your @acronym{NNTP} server includes the @code{Xref} header
11197 in its overview files, try @samp{telnet your.nntp.server nntp},
11198 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
11199 overview.fmt}. This may not work, but if it does, and the last line you
11200 get does not read @samp{Xref:full}, then you should shout and whine at
11201 your news admin until she includes the @code{Xref} header in the
11202 overview files.
11203
11204 If you want Gnus to get the @code{Xref}s right all the time, you have to
11205 set @code{nntp-nov-is-evil} to @code{t}, which slows things down
11206 considerably. Also @pxref{Slow/Expensive Connection}.
11207
11208 C'est la vie.
11209
11210 For an alternative approach, @pxref{Duplicate Suppression}.
11211
11212
11213 @node Duplicate Suppression
11214 @section Duplicate Suppression
11215
11216 By default, Gnus tries to make sure that you don't have to read the same
11217 article more than once by utilizing the crossposting mechanism
11218 (@pxref{Crosspost Handling}). However, that simple and efficient
11219 approach may not work satisfactory for some users for various
11220 reasons.
11221
11222 @enumerate
11223 @item
11224 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
11225 is evil and not very common.
11226
11227 @item
11228 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
11229 @file{.overview} data bases. This is evil and all too common, alas.
11230
11231 @item
11232 You may be reading the same group (or several related groups) from
11233 different @acronym{NNTP} servers.
11234
11235 @item
11236 You may be getting mail that duplicates articles posted to groups.
11237 @end enumerate
11238
11239 I'm sure there are other situations where @code{Xref} handling fails as
11240 well, but these four are the most common situations.
11241
11242 If, and only if, @code{Xref} handling fails for you, then you may
11243 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
11244 will remember the @code{Message-ID}s of all articles you have read or
11245 otherwise marked as read, and then, as if by magic, mark them as read
11246 all subsequent times you see them---in @emph{all} groups. Using this
11247 mechanism is quite likely to be somewhat inefficient, but not overly
11248 so. It's certainly preferable to reading the same articles more than
11249 once.
11250
11251 Duplicate suppression is not a very subtle instrument. It's more like a
11252 sledge hammer than anything else. It works in a very simple
11253 fashion---if you have marked an article as read, it adds this Message-ID
11254 to a cache. The next time it sees this Message-ID, it will mark the
11255 article as read with the @samp{M} mark. It doesn't care what group it
11256 saw the article in.
11257
11258 @table @code
11259 @item gnus-suppress-duplicates
11260 @vindex gnus-suppress-duplicates
11261 If non-@code{nil}, suppress duplicates.
11262
11263 @item gnus-save-duplicate-list
11264 @vindex gnus-save-duplicate-list
11265 If non-@code{nil}, save the list of duplicates to a file. This will
11266 make startup and shutdown take longer, so the default is @code{nil}.
11267 However, this means that only duplicate articles read in a single Gnus
11268 session are suppressed.
11269
11270 @item gnus-duplicate-list-length
11271 @vindex gnus-duplicate-list-length
11272 This variable says how many @code{Message-ID}s to keep in the duplicate
11273 suppression list. The default is 10000.
11274
11275 @item gnus-duplicate-file
11276 @vindex gnus-duplicate-file
11277 The name of the file to store the duplicate suppression list in. The
11278 default is @file{~/News/suppression}.
11279 @end table
11280
11281 If you have a tendency to stop and start Gnus often, setting
11282 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
11283 you leave Gnus running for weeks on end, you may have it @code{nil}. On
11284 the other hand, saving the list makes startup and shutdown much slower,
11285 so that means that if you stop and start Gnus often, you should set
11286 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
11287 to you to figure out, I think.
11288
11289 @node Security
11290 @section Security
11291
11292 Gnus is able to verify signed messages or decrypt encrypted messages.
11293 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
11294 and @acronym{S/MIME}, however you need some external programs to get
11295 things to work:
11296
11297 @enumerate
11298 @item
11299 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
11300 install an OpenPGP implementation such as GnuPG@. The Lisp interface
11301 to GnuPG included with Emacs is called EasyPG (@pxref{Top, ,EasyPG,
11302 epa, EasyPG Assistant user's manual}), but PGG (@pxref{Top, ,PGG, pgg,
11303 PGG Manual}), and Mailcrypt are also supported.
11304
11305 @item
11306 To handle @acronym{S/MIME} message, you need to install OpenSSL@. OpenSSL 0.9.6
11307 or newer is recommended.
11308
11309 @end enumerate
11310
11311 The variables that control security functionality on reading/composing
11312 messages include:
11313
11314 @table @code
11315 @item mm-verify-option
11316 @vindex mm-verify-option
11317 Option of verifying signed parts. @code{never}, not verify;
11318 @code{always}, always verify; @code{known}, only verify known
11319 protocols. Otherwise, ask user.
11320
11321 @item mm-decrypt-option
11322 @vindex mm-decrypt-option
11323 Option of decrypting encrypted parts. @code{never}, no decryption;
11324 @code{always}, always decrypt; @code{known}, only decrypt known
11325 protocols. Otherwise, ask user.
11326
11327 @item mm-sign-option
11328 @vindex mm-sign-option
11329 Option of creating signed parts. @code{nil}, use default signing
11330 keys; @code{guided}, ask user to select signing keys from the menu.
11331
11332 @item mm-encrypt-option
11333 @vindex mm-encrypt-option
11334 Option of creating encrypted parts. @code{nil}, use the first
11335 public-key matching the @samp{From:} header as the recipient;
11336 @code{guided}, ask user to select recipient keys from the menu.
11337
11338 @item mml1991-use
11339 @vindex mml1991-use
11340 Symbol indicating elisp interface to OpenPGP implementation for
11341 @acronym{PGP} messages. The default is @code{epg}, but @code{pgg},
11342 and @code{mailcrypt} are also supported although
11343 deprecated. By default, Gnus uses the first available interface in
11344 this order.
11345
11346 @item mml2015-use
11347 @vindex mml2015-use
11348 Symbol indicating elisp interface to OpenPGP implementation for
11349 @acronym{PGP/MIME} messages. The default is @code{epg}, but
11350 @code{pgg}, and @code{mailcrypt} are also supported
11351 although deprecated. By default, Gnus uses the first available
11352 interface in this order.
11353
11354 @end table
11355
11356 By default the buttons that display security information are not
11357 shown, because they clutter reading the actual e-mail. You can type
11358 @kbd{K b} manually to display the information. Use the
11359 @code{gnus-buttonized-mime-types} and
11360 @code{gnus-unbuttonized-mime-types} variables to control this
11361 permanently. @ref{MIME Commands} for further details, and hints on
11362 how to customize these variables to always display security
11363 information.
11364
11365 @cindex snarfing keys
11366 @cindex importing PGP keys
11367 @cindex PGP key ring import
11368 Snarfing OpenPGP keys (i.e., importing keys from articles into your
11369 key ring) is not supported explicitly through a menu item or command,
11370 rather Gnus do detect and label keys as @samp{application/pgp-keys},
11371 allowing you to specify whatever action you think is appropriate
11372 through the usual @acronym{MIME} infrastructure. You can use a
11373 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
11374 Emacs MIME Manual}) such as the following to import keys using GNU
11375 Privacy Guard when you click on the @acronym{MIME} button
11376 (@pxref{Using MIME}).
11377
11378 @example
11379 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
11380 @end example
11381 @noindent
11382 This happens to also be the default action defined in
11383 @code{mailcap-mime-data}.
11384
11385 More information on how to set things for sending outgoing signed and
11386 encrypted messages up can be found in the message manual
11387 (@pxref{Security, ,Security, message, Message Manual}).
11388
11389 @node Mailing List
11390 @section Mailing List
11391 @cindex mailing list
11392 @cindex RFC 2396
11393
11394 @kindex A M (summary)
11395 @findex gnus-mailing-list-insinuate
11396 Gnus understands some mailing list fields of RFC 2369. To enable it,
11397 add a @code{to-list} group parameter (@pxref{Group Parameters}),
11398 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
11399 summary buffer.
11400
11401 That enables the following commands to the summary buffer:
11402
11403 @table @kbd
11404
11405 @item C-c C-n h
11406 @kindex C-c C-n h (Summary)
11407 @findex gnus-mailing-list-help
11408 Send a message to fetch mailing list help, if List-Help field exists.
11409
11410 @item C-c C-n s
11411 @kindex C-c C-n s (Summary)
11412 @findex gnus-mailing-list-subscribe
11413 Send a message to subscribe the mailing list, if List-Subscribe field exists.
11414
11415 @item C-c C-n u
11416 @kindex C-c C-n u (Summary)
11417 @findex gnus-mailing-list-unsubscribe
11418 Send a message to unsubscribe the mailing list, if List-Unsubscribe
11419 field exists.
11420
11421 @item C-c C-n p
11422 @kindex C-c C-n p (Summary)
11423 @findex gnus-mailing-list-post
11424 Post to the mailing list, if List-Post field exists.
11425
11426 @item C-c C-n o
11427 @kindex C-c C-n o (Summary)
11428 @findex gnus-mailing-list-owner
11429 Send a message to the mailing list owner, if List-Owner field exists.
11430
11431 @item C-c C-n a
11432 @kindex C-c C-n a (Summary)
11433 @findex gnus-mailing-list-archive
11434 Browse the mailing list archive, if List-Archive field exists.
11435
11436 @end table
11437
11438
11439 @node Article Buffer
11440 @chapter Article Buffer
11441 @cindex article buffer
11442
11443 The articles are displayed in the article buffer, of which there is only
11444 one. All the summary buffers share the same article buffer unless you
11445 tell Gnus otherwise.
11446
11447 @menu
11448 * Hiding Headers:: Deciding what headers should be displayed.
11449 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
11450 * HTML:: Reading @acronym{HTML} messages.
11451 * Customizing Articles:: Tailoring the look of the articles.
11452 * Article Keymap:: Keystrokes available in the article buffer.
11453 * Misc Article:: Other stuff.
11454 @end menu
11455
11456
11457 @node Hiding Headers
11458 @section Hiding Headers
11459 @cindex hiding headers
11460 @cindex deleting headers
11461
11462 The top section of each article is the @dfn{head}. (The rest is the
11463 @dfn{body}, but you may have guessed that already.)
11464
11465 @vindex gnus-show-all-headers
11466 There is a lot of useful information in the head: the name of the person
11467 who wrote the article, the date it was written and the subject of the
11468 article. That's well and nice, but there's also lots of information
11469 most people do not want to see---what systems the article has passed
11470 through before reaching you, the @code{Message-ID}, the
11471 @code{References}, etc. ad nauseam---and you'll probably want to get rid
11472 of some of those lines. If you want to keep all those lines in the
11473 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
11474
11475 Gnus provides you with two variables for sifting headers:
11476
11477 @table @code
11478
11479 @item gnus-visible-headers
11480 @vindex gnus-visible-headers
11481 If this variable is non-@code{nil}, it should be a regular expression
11482 that says what headers you wish to keep in the article buffer. All
11483 headers that do not match this variable will be hidden.
11484
11485 For instance, if you only want to see the name of the person who wrote
11486 the article and the subject, you'd say:
11487
11488 @lisp
11489 (setq gnus-visible-headers "^From:\\|^Subject:")
11490 @end lisp
11491
11492 This variable can also be a list of regexps to match headers to
11493 remain visible.
11494
11495 @item gnus-ignored-headers
11496 @vindex gnus-ignored-headers
11497 This variable is the reverse of @code{gnus-visible-headers}. If this
11498 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
11499 should be a regular expression that matches all lines that you want to
11500 hide. All lines that do not match this variable will remain visible.
11501
11502 For instance, if you just want to get rid of the @code{References} line
11503 and the @code{Xref} line, you might say:
11504
11505 @lisp
11506 (setq gnus-ignored-headers "^References:\\|^Xref:")
11507 @end lisp
11508
11509 This variable can also be a list of regexps to match headers to
11510 be removed.
11511
11512 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
11513 variable will have no effect.
11514
11515 @end table
11516
11517 @vindex gnus-sorted-header-list
11518 Gnus can also sort the headers for you. (It does this by default.) You
11519 can control the sorting by setting the @code{gnus-sorted-header-list}
11520 variable. It is a list of regular expressions that says in what order
11521 the headers are to be displayed.
11522
11523 For instance, if you want the name of the author of the article first,
11524 and then the subject, you might say something like:
11525
11526 @lisp
11527 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
11528 @end lisp
11529
11530 Any headers that are to remain visible, but are not listed in this
11531 variable, will be displayed in random order after all the headers listed in this variable.
11532
11533 @findex gnus-article-hide-boring-headers
11534 @vindex gnus-boring-article-headers
11535 You can hide further boring headers by setting
11536 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
11537 does depends on the @code{gnus-boring-article-headers} variable. It's a
11538 list, but this list doesn't actually contain header names. Instead it
11539 lists various @dfn{boring conditions} that Gnus can check and remove
11540 from sight.
11541
11542 These conditions are:
11543 @table @code
11544 @item empty
11545 Remove all empty headers.
11546 @item followup-to
11547 Remove the @code{Followup-To} header if it is identical to the
11548 @code{Newsgroups} header.
11549 @item reply-to
11550 Remove the @code{Reply-To} header if it lists the same addresses as
11551 the @code{From} header, or if the @code{broken-reply-to} group
11552 parameter is set.
11553 @item newsgroups
11554 Remove the @code{Newsgroups} header if it only contains the current group
11555 name.
11556 @item to-address
11557 Remove the @code{To} header if it only contains the address identical to
11558 the current group's @code{to-address} parameter.
11559 @item to-list
11560 Remove the @code{To} header if it only contains the address identical to
11561 the current group's @code{to-list} parameter.
11562 @item cc-list
11563 Remove the @code{Cc} header if it only contains the address identical to
11564 the current group's @code{to-list} parameter.
11565 @item date
11566 Remove the @code{Date} header if the article is less than three days
11567 old.
11568 @item long-to
11569 Remove the @code{To} and/or @code{Cc} header if it is very long.
11570 @item many-to
11571 Remove all @code{To} and/or @code{Cc} headers if there are more than one.
11572 @end table
11573
11574 To include these three elements, you could say something like:
11575
11576 @lisp
11577 (setq gnus-boring-article-headers
11578 '(empty followup-to reply-to))
11579 @end lisp
11580
11581 This is also the default value for this variable.
11582
11583
11584 @node Using MIME
11585 @section Using MIME
11586 @cindex @acronym{MIME}
11587
11588 Mime is a standard for waving your hands through the air, aimlessly,
11589 while people stand around yawning.
11590
11591 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11592 while all newsreaders die of fear.
11593
11594 @acronym{MIME} may specify what character set the article uses, the encoding
11595 of the characters, and it also makes it possible to embed pictures and
11596 other naughty stuff in innocent-looking articles.
11597
11598 @vindex gnus-display-mime-function
11599 @findex gnus-display-mime
11600 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
11601 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
11602 default, which creates a bundle of clickable buttons that can be used to
11603 display, save and manipulate the @acronym{MIME} objects.
11604
11605 The following commands are available when you have placed point over a
11606 @acronym{MIME} button:
11607
11608 @table @kbd
11609 @findex gnus-article-press-button
11610 @item RET (Article)
11611 @kindex RET (Article)
11612 @itemx BUTTON-2 (Article)
11613 Toggle displaying of the @acronym{MIME} object
11614 (@code{gnus-article-press-button}). If built-in viewers can not display
11615 the object, Gnus resorts to external viewers in the @file{mailcap}
11616 files. If a viewer has the @samp{copiousoutput} specification, the
11617 object is displayed inline.
11618
11619 @findex gnus-mime-view-part
11620 @item M-RET (Article)
11621 @kindex M-RET (Article)
11622 @itemx v (Article)
11623 Prompt for a method, and then view the @acronym{MIME} object using this
11624 method (@code{gnus-mime-view-part}).
11625
11626 @findex gnus-mime-view-part-as-type
11627 @item t (Article)
11628 @kindex t (Article)
11629 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
11630 (@code{gnus-mime-view-part-as-type}).
11631
11632 @findex gnus-mime-view-part-as-charset
11633 @item C (Article)
11634 @kindex C (Article)
11635 Prompt for a charset, and then view the @acronym{MIME} object using this
11636 charset (@code{gnus-mime-view-part-as-charset}).
11637
11638 @findex gnus-mime-save-part
11639 @item o (Article)
11640 @kindex o (Article)
11641 Prompt for a file name, and then save the @acronym{MIME} object
11642 (@code{gnus-mime-save-part}).
11643
11644 @findex gnus-mime-save-part-and-strip
11645 @item C-o (Article)
11646 @kindex C-o (Article)
11647 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11648 the article. Then proceed to article editing, where a reasonable
11649 suggestion is being made on how the altered article should look
11650 like. The stripped @acronym{MIME} object will be referred via the
11651 message/external-body @acronym{MIME} type.
11652 (@code{gnus-mime-save-part-and-strip}).
11653
11654 @findex gnus-mime-replace-part
11655 @item r (Article)
11656 @kindex r (Article)
11657 Prompt for a file name, replace the @acronym{MIME} object with an
11658 external body referring to the file via the message/external-body
11659 @acronym{MIME} type. (@code{gnus-mime-replace-part}).
11660
11661 @findex gnus-mime-delete-part
11662 @item d (Article)
11663 @kindex d (Article)
11664 Delete the @acronym{MIME} object from the article and replace it with some
11665 information about the removed @acronym{MIME} object
11666 (@code{gnus-mime-delete-part}).
11667
11668 @c FIXME: gnus-auto-select-part should be documented here
11669
11670 @findex gnus-mime-copy-part
11671 @item c (Article)
11672 @kindex c (Article)
11673 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11674 (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents
11675 without decoding. If given a numerical prefix, you can do semi-manual
11676 charset stuff (see @code{gnus-summary-show-article-charset-alist} in
11677 @ref{Paging the Article}). Compressed files like @file{.gz} and
11678 @file{.bz2} are automatically decompressed if
11679 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11680 Accessing Compressed Files, emacs, The Emacs Editor}).
11681
11682 @findex gnus-mime-print-part
11683 @item p (Article)
11684 @kindex p (Article)
11685 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11686 command respects the @samp{print=} specifications in the
11687 @file{.mailcap} file.
11688
11689 @findex gnus-mime-inline-part
11690 @item i (Article)
11691 @kindex i (Article)
11692 Insert the contents of the @acronym{MIME} object into the buffer
11693 (@code{gnus-mime-inline-part}) as @samp{text/plain}. If given a prefix, insert
11694 the raw contents without decoding. If given a numerical prefix, you can
11695 do semi-manual charset stuff (see
11696 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11697 Article}). Compressed files like @file{.gz} and @file{.bz2} are
11698 automatically decompressed depending on @code{jka-compr} regardless of
11699 @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing
11700 Compressed Files, emacs, The Emacs Editor}).
11701
11702 @findex gnus-mime-view-part-internally
11703 @item E (Article)
11704 @kindex E (Article)
11705 View the @acronym{MIME} object with an internal viewer. If no internal
11706 viewer is available, use an external viewer
11707 (@code{gnus-mime-view-part-internally}).
11708
11709 @findex gnus-mime-view-part-externally
11710 @item e (Article)
11711 @kindex e (Article)
11712 View the @acronym{MIME} object with an external viewer.
11713 (@code{gnus-mime-view-part-externally}).
11714
11715 @findex gnus-mime-pipe-part
11716 @item | (Article)
11717 @kindex | (Article)
11718 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11719
11720 @findex gnus-mime-action-on-part
11721 @item . (Article)
11722 @kindex . (Article)
11723 Interactively run an action on the @acronym{MIME} object
11724 (@code{gnus-mime-action-on-part}).
11725
11726 @end table
11727
11728 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11729 determines which parts to do this with is described in the Emacs
11730 @acronym{MIME} manual.
11731
11732 It might be best to just use the toggling functions from the article
11733 buffer to avoid getting nasty surprises. (For instance, you enter the
11734 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11735 decoded the sound file in the article and some horrible sing-a-long song
11736 comes screaming out your speakers, and you can't find the volume button,
11737 because there isn't one, and people are starting to look at you, and you
11738 try to stop the program, but you can't, and you can't find the program
11739 to control the volume, and everybody else in the room suddenly decides
11740 to look at you disdainfully, and you'll feel rather stupid.)
11741
11742 Any similarity to real events and people is purely coincidental. Ahem.
11743
11744 Also @pxref{MIME Commands}.
11745
11746
11747 @node HTML
11748 @section @acronym{HTML}
11749 @cindex @acronym{HTML}
11750
11751 Gnus can display @acronym{HTML} articles nicely formatted in the
11752 article buffer. There are many methods for doing that, but two of
11753 them are kind of default methods.
11754
11755 If your Emacs copy has been built with libxml2 support, then Gnus uses
11756 Emacs' built-in, plain elisp Simple HTML Renderer @code{shr}
11757 @footnote{@code{shr} displays colors as declared in the @acronym{HTML}
11758 article but tries to adjust them in order to be readable. If you
11759 prefer more contrast, @xref{FAQ 4-16}.} which is also used by Emacs'
11760 browser EWW (@pxref{EWW, ,EWW, emacs, The Emacs Manual}).
11761
11762 If your Emacs copy lacks libxml2 support but you have @code{w3m}
11763 installed on your system, Gnus uses that to render @acronym{HTML} mail
11764 and display the results in the article buffer (@code{gnus-w3m}).
11765
11766 For a complete overview, consult @xref{Display Customization, ,Display
11767 Customization, emacs-mime, The Emacs MIME Manual}. This section only
11768 describes the default method.
11769
11770 @table @code
11771 @item mm-text-html-renderer
11772 @vindex mm-text-html-renderer
11773 If set to @code{shr}, Gnus uses its own simple @acronym{HTML}
11774 renderer. If set to @code{gnus-w3m}, it uses @code{w3m}.
11775
11776 @item gnus-blocked-images
11777 @vindex gnus-blocked-images
11778 External images that have @acronym{URL}s that match this regexp won't
11779 be fetched and displayed. For instance, do block all @acronym{URL}s
11780 that have the string ``ads'' in them, do the following:
11781
11782 @lisp
11783 (setq gnus-blocked-images "ads")
11784 @end lisp
11785
11786 This can also be a function to be evaluated. If so, it will be
11787 called with the group name as the parameter. The default value is
11788 @code{gnus-block-private-groups}, which will return @samp{"."} for
11789 anything that isn't a newsgroup. This means that no external images
11790 will be fetched as a result of reading mail, so that nobody can use
11791 web bugs (and the like) to track whether you've read email.
11792
11793 Also @pxref{Misc Article} for @code{gnus-inhibit-images}.
11794
11795 @item gnus-html-cache-directory
11796 @vindex gnus-html-cache-directory
11797 Gnus will download and cache images according to how
11798 @code{gnus-blocked-images} is set. These images will be stored in
11799 this directory.
11800
11801 @item gnus-html-cache-size
11802 @vindex gnus-html-cache-size
11803 When @code{gnus-html-cache-size} bytes have been used in that
11804 directory, the oldest files will be deleted. The default is 500MB.
11805
11806 @item gnus-html-frame-width
11807 @vindex gnus-html-frame-width
11808 The width to use when rendering HTML@. The default is 70.
11809
11810 @item gnus-max-image-proportion
11811 @vindex gnus-max-image-proportion
11812 How big pictures displayed are in relation to the window they're in.
11813 A value of 0.7 (the default) means that they are allowed to take up
11814 70% of the width and height of the window. If they are larger than
11815 this, and Emacs supports it, then the images will be rescaled down to
11816 fit these criteria.
11817
11818 @end table
11819
11820 To use this, make sure that you have @code{w3m} and @code{curl}
11821 installed. If you have, then Gnus should display @acronym{HTML}
11822 automatically.
11823
11824
11825
11826 @node Customizing Articles
11827 @section Customizing Articles
11828 @cindex article customization
11829
11830 A slew of functions for customizing how the articles are to look like
11831 exist. You can call these functions interactively
11832 (@pxref{Article Washing}), or you can have them
11833 called automatically when you select the articles.
11834
11835 To have them called automatically, you should set the corresponding
11836 ``treatment'' variable. For instance, to have headers hidden, you'd set
11837 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11838 be set, but first we discuss the values these variables can have.
11839
11840 Note: Some values, while valid, make little sense. Check the list below
11841 for sensible values.
11842
11843 @enumerate
11844 @item
11845 @code{nil}: Don't do this treatment.
11846
11847 @item
11848 @code{t}: Do this treatment on all body parts.
11849
11850 @item
11851 @code{head}: Do the treatment on the headers.
11852
11853 @item
11854 @code{first}: Do this treatment on the first body part.
11855
11856 @item
11857 @code{last}: Do this treatment on the last body part.
11858
11859 @item
11860 An integer: Do this treatment on all body parts that have a length less
11861 than this number.
11862
11863 @item
11864 A list of strings: Do this treatment on all body parts that are in
11865 articles that are read in groups that have names that match one of the
11866 regexps in the list.
11867
11868 @item
11869 A list where the first element is not a string:
11870
11871 The list is evaluated recursively. The first element of the list is a
11872 predicate. The following predicates are recognized: @code{or},
11873 @code{and}, @code{not} and @code{typep}. Here's an example:
11874
11875 @lisp
11876 (or last
11877 (typep "text/x-vcard"))
11878 @end lisp
11879
11880 @item
11881 A function: the function is called with no arguments and should return
11882 @code{nil} or non-@code{nil}. The current article is available in the
11883 buffer named by @code{gnus-article-buffer}.
11884
11885 @end enumerate
11886
11887 You may have noticed that the word @dfn{part} is used here. This refers
11888 to the fact that some messages are @acronym{MIME} multipart articles that may
11889 be divided into several parts. Articles that are not multiparts are
11890 considered to contain just a single part.
11891
11892 @vindex gnus-article-treat-types
11893 Are the treatments applied to all sorts of multipart parts? Yes, if you
11894 want to, but by default, only @samp{text/plain} parts are given the
11895 treatment. This is controlled by the @code{gnus-article-treat-types}
11896 variable, which is a list of regular expressions that are matched to the
11897 type of the part. This variable is ignored if the value of the
11898 controlling variable is a predicate list, as described above.
11899
11900 @ifinfo
11901 @c Avoid sort of redundant entries in the same section for the printed
11902 @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or
11903 @c `i foo-bar'.
11904 @vindex gnus-treat-buttonize
11905 @vindex gnus-treat-buttonize-head
11906 @vindex gnus-treat-capitalize-sentences
11907 @vindex gnus-treat-overstrike
11908 @vindex gnus-treat-strip-cr
11909 @vindex gnus-treat-strip-headers-in-body
11910 @vindex gnus-treat-strip-leading-blank-lines
11911 @vindex gnus-treat-strip-multiple-blank-lines
11912 @vindex gnus-treat-strip-pem
11913 @vindex gnus-treat-strip-trailing-blank-lines
11914 @vindex gnus-treat-unsplit-urls
11915 @vindex gnus-treat-wash-html
11916 @vindex gnus-treat-date
11917 @vindex gnus-treat-from-picon
11918 @vindex gnus-treat-mail-picon
11919 @vindex gnus-treat-newsgroups-picon
11920 @vindex gnus-treat-from-gravatar
11921 @vindex gnus-treat-mail-gravatar
11922 @vindex gnus-treat-display-smileys
11923 @vindex gnus-treat-body-boundary
11924 @vindex gnus-treat-display-x-face
11925 @vindex gnus-treat-display-face
11926 @vindex gnus-treat-emphasize
11927 @vindex gnus-treat-fill-article
11928 @vindex gnus-treat-fill-long-lines
11929 @vindex gnus-treat-hide-boring-headers
11930 @vindex gnus-treat-hide-citation
11931 @vindex gnus-treat-hide-citation-maybe
11932 @vindex gnus-treat-hide-headers
11933 @vindex gnus-treat-hide-signature
11934 @vindex gnus-treat-strip-banner
11935 @vindex gnus-treat-strip-list-identifiers
11936 @vindex gnus-treat-highlight-citation
11937 @vindex gnus-treat-highlight-headers
11938 @vindex gnus-treat-highlight-signature
11939 @vindex gnus-treat-play-sounds
11940 @vindex gnus-treat-x-pgp-sig
11941 @vindex gnus-treat-unfold-headers
11942 @vindex gnus-treat-fold-headers
11943 @vindex gnus-treat-fold-newsgroups
11944 @vindex gnus-treat-leading-whitespace
11945 @end ifinfo
11946
11947 The following treatment options are available. The easiest way to
11948 customize this is to examine the @code{gnus-article-treat} customization
11949 group. Values in parenthesis are suggested sensible values. Others are
11950 possible but those listed are probably sufficient for most people.
11951
11952 @table @code
11953 @item gnus-treat-buttonize (t, integer)
11954 @item gnus-treat-buttonize-head (head)
11955
11956 @xref{Article Buttons}.
11957
11958 @item gnus-treat-capitalize-sentences (t, integer)
11959 @item gnus-treat-overstrike (t, integer)
11960 @item gnus-treat-strip-cr (t, integer)
11961 @item gnus-treat-strip-headers-in-body (t, integer)
11962 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11963 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11964 @item gnus-treat-strip-pem (t, last, integer)
11965 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11966 @item gnus-treat-unsplit-urls (t, integer)
11967 @item gnus-treat-wash-html (t, integer)
11968
11969 @xref{Article Washing}.
11970
11971 @item gnus-treat-date (head)
11972
11973 This will transform/add date headers according to the
11974 @code{gnus-article-date-headers} variable. This is a list of Date
11975 headers to display. The formats available are:
11976
11977 @table @code
11978 @item ut
11979 Universal time, aka GMT, aka ZULU.
11980
11981 @item local
11982 The user's local time zone.
11983
11984 @item english
11985 A semi-readable English sentence.
11986
11987 @item lapsed
11988 The time elapsed since the message was posted.
11989
11990 @item combined-lapsed
11991 Both the original date header and a (shortened) elapsed time.
11992
11993 @item original
11994 The original date header.
11995
11996 @item iso8601
11997 ISO8601 format, i.e., ``2010-11-23T22:05:21''.
11998
11999 @item user-defined
12000 A format done according to the @code{gnus-article-time-format}
12001 variable.
12002
12003 @end table
12004
12005 @xref{Article Date}.
12006
12007 @item gnus-treat-from-picon (head)
12008 @item gnus-treat-mail-picon (head)
12009 @item gnus-treat-newsgroups-picon (head)
12010
12011 @xref{Picons}.
12012
12013 @item gnus-treat-from-gravatar (head)
12014 @item gnus-treat-mail-gravatar (head)
12015
12016 @xref{Gravatars}.
12017
12018 @item gnus-treat-display-smileys (t, integer)
12019
12020 @item gnus-treat-body-boundary (head)
12021
12022 @vindex gnus-body-boundary-delimiter
12023 Adds a delimiter between header and body, the string used as delimiter
12024 is controlled by @code{gnus-body-boundary-delimiter}.
12025
12026 @xref{Smileys}.
12027
12028 @vindex gnus-treat-display-x-face
12029 @item gnus-treat-display-x-face (head)
12030
12031 @xref{X-Face}.
12032
12033 @vindex gnus-treat-display-face
12034 @item gnus-treat-display-face (head)
12035
12036 @xref{Face}.
12037
12038 @vindex gnus-treat-emphasize
12039 @item gnus-treat-emphasize (t, head, integer)
12040 @vindex gnus-treat-fill-article
12041 @item gnus-treat-fill-article (t, integer)
12042 @vindex gnus-treat-fill-long-lines
12043 @item gnus-treat-fill-long-lines (t, integer)
12044 @vindex gnus-treat-hide-boring-headers
12045 @item gnus-treat-hide-boring-headers (head)
12046 @vindex gnus-treat-hide-citation
12047 @item gnus-treat-hide-citation (t, integer)
12048 @vindex gnus-treat-hide-citation-maybe
12049 @item gnus-treat-hide-citation-maybe (t, integer)
12050 @vindex gnus-treat-hide-headers
12051 @item gnus-treat-hide-headers (head)
12052 @vindex gnus-treat-hide-signature
12053 @item gnus-treat-hide-signature (t, last)
12054 @vindex gnus-treat-strip-banner
12055 @item gnus-treat-strip-banner (t, last)
12056 @vindex gnus-treat-strip-list-identifiers
12057 @item gnus-treat-strip-list-identifiers (head)
12058
12059 @xref{Article Hiding}.
12060
12061 @vindex gnus-treat-highlight-citation
12062 @item gnus-treat-highlight-citation (t, integer)
12063 @vindex gnus-treat-highlight-headers
12064 @item gnus-treat-highlight-headers (head)
12065 @vindex gnus-treat-highlight-signature
12066 @item gnus-treat-highlight-signature (t, last, integer)
12067
12068 @xref{Article Highlighting}.
12069
12070 @vindex gnus-treat-play-sounds
12071 @item gnus-treat-play-sounds
12072 @item gnus-treat-ansi-sequences (t)
12073 @vindex gnus-treat-x-pgp-sig
12074 @item gnus-treat-x-pgp-sig (head)
12075
12076 @vindex gnus-treat-unfold-headers
12077 @item gnus-treat-unfold-headers (head)
12078 @vindex gnus-treat-fold-headers
12079 @item gnus-treat-fold-headers (head)
12080 @vindex gnus-treat-fold-newsgroups
12081 @item gnus-treat-fold-newsgroups (head)
12082 @vindex gnus-treat-leading-whitespace
12083 @item gnus-treat-leading-whitespace (head)
12084
12085 @xref{Article Header}.
12086
12087
12088 @end table
12089
12090 @vindex gnus-part-display-hook
12091 You can, of course, write your own functions to be called from
12092 @code{gnus-part-display-hook}. The functions are called narrowed to the
12093 part, and you can do anything you like, pretty much. There is no
12094 information that you have to keep in the buffer---you can change
12095 everything.
12096
12097
12098 @node Article Keymap
12099 @section Article Keymap
12100
12101 Most of the keystrokes in the summary buffer can also be used in the
12102 article buffer. They should behave as if you typed them in the summary
12103 buffer, which means that you don't actually have to have a summary
12104 buffer displayed while reading. You can do it all from the article
12105 buffer.
12106
12107 @kindex v (Article)
12108 @cindex keys, reserved for users (Article)
12109 The key @kbd{v} is reserved for users. You can bind it to some
12110 command or better use it as a prefix key.
12111
12112 A few additional keystrokes are available:
12113
12114 @table @kbd
12115
12116 @item SPACE
12117 @kindex SPACE (Article)
12118 @findex gnus-article-next-page
12119 Scroll forwards one page (@code{gnus-article-next-page}).
12120 This is exactly the same as @kbd{h SPACE h}.
12121
12122 @item DEL
12123 @kindex DEL (Article)
12124 @findex gnus-article-prev-page
12125 Scroll backwards one page (@code{gnus-article-prev-page}).
12126 This is exactly the same as @kbd{h DEL h}.
12127
12128 @item C-c ^
12129 @kindex C-c ^ (Article)
12130 @findex gnus-article-refer-article
12131 If point is in the neighborhood of a @code{Message-ID} and you press
12132 @kbd{C-c ^}, Gnus will try to get that article from the server
12133 (@code{gnus-article-refer-article}).
12134
12135 @item C-c C-m
12136 @kindex C-c C-m (Article)
12137 @findex gnus-article-mail
12138 Send a reply to the address near point (@code{gnus-article-mail}). If
12139 given a prefix, include the mail.
12140
12141 @item s
12142 @kindex s (Article)
12143 @findex gnus-article-show-summary
12144 Reconfigure the buffers so that the summary buffer becomes visible
12145 (@code{gnus-article-show-summary}).
12146
12147 @item ?
12148 @kindex ? (Article)
12149 @findex gnus-article-describe-briefly
12150 Give a very brief description of the available keystrokes
12151 (@code{gnus-article-describe-briefly}).
12152
12153 @item TAB
12154 @kindex TAB (Article)
12155 @findex gnus-article-next-button
12156 Go to the next button, if any (@code{gnus-article-next-button}). This
12157 only makes sense if you have buttonizing turned on.
12158
12159 @item M-TAB
12160 @kindex M-TAB (Article)
12161 @findex gnus-article-prev-button
12162 Go to the previous button, if any (@code{gnus-article-prev-button}).
12163
12164 @item R
12165 @kindex R (Article)
12166 @findex gnus-article-reply-with-original
12167 Send a reply to the current article and yank the current article
12168 (@code{gnus-article-reply-with-original}). If the region is active,
12169 only yank the text in the region.
12170
12171 @item S W
12172 @kindex S W (Article)
12173 @findex gnus-article-wide-reply-with-original
12174 Send a wide reply to the current article and yank the current article
12175 (@code{gnus-article-wide-reply-with-original}). If the region is
12176 active, only yank the text in the region.
12177
12178 @item F
12179 @kindex F (Article)
12180 @findex gnus-article-followup-with-original
12181 Send a followup to the current article and yank the current article
12182 (@code{gnus-article-followup-with-original}). If the region is active,
12183 only yank the text in the region.
12184
12185
12186 @end table
12187
12188
12189 @node Misc Article
12190 @section Misc Article
12191
12192 @table @code
12193
12194 @item gnus-single-article-buffer
12195 @vindex gnus-single-article-buffer
12196 @cindex article buffers, several
12197 If non-@code{nil}, use the same article buffer for all the groups.
12198 (This is the default.) If @code{nil}, each group will have its own
12199 article buffer.
12200
12201 @item gnus-widen-article-window
12202 @cindex gnus-widen-article-window
12203 If non-@code{nil}, selecting the article buffer with the @kbd{h}
12204 command will ``widen'' the article window to take the entire frame.
12205
12206 @vindex gnus-article-decode-hook
12207 @item gnus-article-decode-hook
12208 @cindex @acronym{MIME}
12209 Hook used to decode @acronym{MIME} articles. The default value is
12210 @code{(article-decode-charset article-decode-encoded-words)}
12211
12212 @vindex gnus-article-prepare-hook
12213 @item gnus-article-prepare-hook
12214 This hook is called right after the article has been inserted into the
12215 article buffer. It is mainly intended for functions that do something
12216 depending on the contents; it should probably not be used for changing
12217 the contents of the article buffer.
12218
12219 @item gnus-article-mode-hook
12220 @vindex gnus-article-mode-hook
12221 Hook called in article mode buffers.
12222
12223 @item gnus-article-mode-syntax-table
12224 @vindex gnus-article-mode-syntax-table
12225 Syntax table used in article buffers. It is initialized from
12226 @code{text-mode-syntax-table}.
12227
12228 @vindex gnus-article-over-scroll
12229 @item gnus-article-over-scroll
12230 If non-@code{nil}, allow scrolling the article buffer even when there
12231 no more new text to scroll in. The default is @code{nil}.
12232
12233 @vindex gnus-article-mode-line-format
12234 @item gnus-article-mode-line-format
12235 This variable is a format string along the same lines as
12236 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
12237 Line}). It accepts the same format specifications as that variable,
12238 with two extensions:
12239
12240 @table @samp
12241
12242 @item w
12243 The @dfn{wash status} of the article. This is a short string with one
12244 character for each possible article wash operation that may have been
12245 performed. The characters and their meaning:
12246
12247 @table @samp
12248
12249 @item c
12250 Displayed when cited text may be hidden in the article buffer.
12251
12252 @item h
12253 Displayed when headers are hidden in the article buffer.
12254
12255 @item p
12256 Displayed when article is digitally signed or encrypted, and Gnus has
12257 hidden the security headers. (N.B. does not tell anything about
12258 security status, i.e., good or bad signature.)
12259
12260 @item s
12261 Displayed when the signature has been hidden in the Article buffer.
12262
12263 @item o
12264 Displayed when Gnus has treated overstrike characters in the article buffer.
12265
12266 @item e
12267 Displayed when Gnus has treated emphasized strings in the article buffer.
12268
12269 @end table
12270
12271 @item m
12272 The number of @acronym{MIME} parts in the article.
12273
12274 @end table
12275
12276 @vindex gnus-break-pages
12277
12278 @item gnus-break-pages
12279 Controls whether @dfn{page breaking} is to take place. If this variable
12280 is non-@code{nil}, the articles will be divided into pages whenever a
12281 page delimiter appears in the article. If this variable is @code{nil},
12282 paging will not be done.
12283
12284 @item gnus-page-delimiter
12285 @vindex gnus-page-delimiter
12286 This is the delimiter mentioned above. By default, it is @samp{^L}
12287 (formfeed).
12288
12289 @cindex IDNA
12290 @cindex internationalized domain names
12291 @vindex gnus-use-idna
12292 @item gnus-use-idna
12293 This variable controls whether Gnus performs IDNA decoding of
12294 internationalized domain names inside @samp{From}, @samp{To} and
12295 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
12296 for how to compose such messages. This requires
12297 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
12298 variable is only enabled if you have installed it.
12299
12300 @vindex gnus-inhibit-images
12301 @item gnus-inhibit-images
12302 If this is non-@code{nil}, inhibit displaying of images inline in the
12303 article body. It is effective to images that are in articles as
12304 @acronym{MIME} parts, and images in @acronym{HTML} articles rendered
12305 when @code{mm-text-html-renderer} (@pxref{Display Customization,
12306 ,Display Customization, emacs-mime, The Emacs MIME Manual}) is
12307 @code{shr} or @code{gnus-w3m}.
12308
12309 @end table
12310
12311
12312 @node Composing Messages
12313 @chapter Composing Messages
12314 @cindex composing messages
12315 @cindex messages
12316 @cindex mail
12317 @cindex sending mail
12318 @cindex reply
12319 @cindex followup
12320 @cindex post
12321 @cindex using gpg
12322 @cindex using s/mime
12323 @cindex using smime
12324
12325 @kindex C-c C-c (Post)
12326 All commands for posting and mailing will put you in a message buffer
12327 where you can edit the article all you like, before you send the
12328 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
12329 Message Manual}. Where the message will be posted/mailed to depends
12330 on your setup (@pxref{Posting Server}).
12331
12332 @menu
12333 * Mail:: Mailing and replying.
12334 * Posting Server:: What server should you post and mail via?
12335 * POP before SMTP:: You cannot send a mail unless you read a mail.
12336 * Mail and Post:: Mailing and posting at the same time.
12337 * Archived Messages:: Where Gnus stores the messages you've sent.
12338 * Posting Styles:: An easier way to specify who you are.
12339 * Drafts:: Postponing messages and rejected messages.
12340 * Rejected Articles:: What happens if the server doesn't like your article?
12341 * Signing and encrypting:: How to compose secure messages.
12342 @end menu
12343
12344 Also @pxref{Canceling and Superseding} for information on how to
12345 remove articles you shouldn't have posted.
12346
12347
12348 @node Mail
12349 @section Mail
12350
12351 Variables for customizing outgoing mail:
12352
12353 @table @code
12354 @item gnus-uu-digest-headers
12355 @vindex gnus-uu-digest-headers
12356 List of regexps to match headers included in digested messages. The
12357 headers will be included in the sequence they are matched. If
12358 @code{nil} include all headers.
12359
12360 @item gnus-add-to-list
12361 @vindex gnus-add-to-list
12362 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
12363 that have none when you do a @kbd{a}.
12364
12365 @item gnus-confirm-mail-reply-to-news
12366 @vindex gnus-confirm-mail-reply-to-news
12367 If non-@code{nil}, Gnus will ask you for a confirmation when you are
12368 about to reply to news articles by mail. If it is @code{nil}, nothing
12369 interferes in what you want to do. This can also be a function
12370 receiving the group name as the only parameter which should return
12371 non-@code{nil} if a confirmation is needed, or a regular expression
12372 matching group names, where confirmation should be asked for.
12373
12374 If you find yourself never wanting to reply to mail, but occasionally
12375 press @kbd{R} anyway, this variable might be for you.
12376
12377 @item gnus-confirm-treat-mail-like-news
12378 @vindex gnus-confirm-treat-mail-like-news
12379 If non-@code{nil}, Gnus also requests confirmation according to
12380 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
12381 useful for treating mailing lists like newsgroups.
12382
12383 @end table
12384
12385
12386 @node Posting Server
12387 @section Posting Server
12388
12389 When you press those magical @kbd{C-c C-c} keys to ship off your latest
12390 (extremely intelligent, of course) article, where does it go?
12391
12392 Thank you for asking. I hate you.
12393
12394 It can be quite complicated.
12395
12396 @vindex gnus-post-method
12397 When posting news, Message usually invokes @code{message-send-news}
12398 (@pxref{News Variables, , News Variables, message, Message Manual}).
12399 Normally, Gnus will post using the same select method as you're
12400 reading from (which might be convenient if you're reading lots of
12401 groups from different private servers). However. If the server
12402 you're reading from doesn't allow posting, just reading, you probably
12403 want to use some other server to post your (extremely intelligent and
12404 fabulously interesting) articles. You can then set the
12405 @code{gnus-post-method} to some other method:
12406
12407 @lisp
12408 (setq gnus-post-method '(nnspool ""))
12409 @end lisp
12410
12411 Now, if you've done this, and then this server rejects your article, or
12412 this server is down, what do you do then? To override this variable you
12413 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
12414 the ``current'' server, to get back the default behavior, for posting.
12415
12416 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
12417 Gnus will prompt you for what method to use for posting.
12418
12419 You can also set @code{gnus-post-method} to a list of select methods.
12420 If that's the case, Gnus will always prompt you for what method to use
12421 for posting.
12422
12423 Finally, if you want to always post using the native select method,
12424 you can set this variable to @code{native}.
12425
12426 @vindex message-send-mail-function
12427 When sending mail, Message invokes the function specified by the
12428 variable @code{message-send-mail-function}. Gnus tries to set it to a
12429 value suitable for your system.
12430 @xref{Mail Variables, ,Mail Variables,message,Message manual}, for more
12431 information.
12432
12433
12434 @node POP before SMTP
12435 @section POP before SMTP
12436 @cindex pop before smtp
12437 @findex mail-source-touch-pop
12438
12439 Does your @acronym{ISP} use @acronym{POP}-before-@acronym{SMTP}
12440 authentication? This authentication method simply requires you to
12441 contact the @acronym{POP} server before sending email. To do that,
12442 put the following lines in your @file{~/.gnus.el} file:
12443
12444 @lisp
12445 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
12446 @end lisp
12447
12448 @noindent
12449 The @code{mail-source-touch-pop} function does @acronym{POP}
12450 authentication according to the value of @code{mail-sources} without
12451 fetching mails, just before sending a mail. @xref{Mail Sources}.
12452
12453 If you have two or more @acronym{POP} mail servers set in
12454 @code{mail-sources}, you may want to specify one of them to
12455 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
12456 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
12457 is your primary @acronym{POP} mail server (i.e., you are fetching mails
12458 mainly from that server), you can set it permanently as follows:
12459
12460 @lisp
12461 (setq mail-source-primary-source
12462 '(pop :server "pop3.mail.server"
12463 :password "secret"))
12464 @end lisp
12465
12466 @noindent
12467 Otherwise, bind it dynamically only when performing the
12468 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
12469
12470 @lisp
12471 (add-hook 'message-send-mail-hook
12472 (lambda ()
12473 (let ((mail-source-primary-source
12474 '(pop :server "pop3.mail.server"
12475 :password "secret")))
12476 (mail-source-touch-pop))))
12477 @end lisp
12478
12479
12480 @node Mail and Post
12481 @section Mail and Post
12482
12483 Here's a list of variables relevant to both mailing and
12484 posting:
12485
12486 @table @code
12487 @item gnus-mailing-list-groups
12488 @findex gnus-mailing-list-groups
12489 @cindex mailing lists
12490
12491 If your news server offers groups that are really mailing lists
12492 gatewayed to the @acronym{NNTP} server, you can read those groups without
12493 problems, but you can't post/followup to them without some difficulty.
12494 One solution is to add a @code{to-address} to the group parameters
12495 (@pxref{Group Parameters}). An easier thing to do is set the
12496 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
12497 really are mailing lists. Then, at least, followups to the mailing
12498 lists will work most of the time. Posting to these groups (@kbd{a}) is
12499 still a pain, though.
12500
12501 @item gnus-user-agent
12502 @vindex gnus-user-agent
12503 @cindex User-Agent
12504
12505 This variable controls which information should be exposed in the
12506 User-Agent header. It can be a list of symbols or a string. Valid
12507 symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs
12508 version). In addition to the Emacs version, you can add @code{codename}
12509 (show (S)XEmacs codename) or either @code{config} (show system
12510 configuration) or @code{type} (show system type). If you set it to a
12511 string, be sure to use a valid format, see RFC 2616.
12512
12513 @end table
12514
12515 You may want to do spell-checking on messages that you send out. Or, if
12516 you don't want to spell-check by hand, you could add automatic
12517 spell-checking via the @code{ispell} package:
12518
12519 @cindex ispell
12520 @findex ispell-message
12521 @lisp
12522 (add-hook 'message-send-hook 'ispell-message)
12523 @end lisp
12524
12525 If you want to change the @code{ispell} dictionary based on what group
12526 you're in, you could say something like the following:
12527
12528 @lisp
12529 (add-hook 'gnus-select-group-hook
12530 (lambda ()
12531 (cond
12532 ((string-match
12533 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
12534 (ispell-change-dictionary "deutsch"))
12535 (t
12536 (ispell-change-dictionary "english")))))
12537 @end lisp
12538
12539 Modify to suit your needs.
12540
12541 @vindex gnus-message-highlight-citation
12542 If @code{gnus-message-highlight-citation} is @code{t}, different levels of
12543 citations are highlighted like in Gnus article buffers also in message
12544 mode buffers.
12545
12546 @node Archived Messages
12547 @section Archived Messages
12548 @cindex archived messages
12549 @cindex sent messages
12550
12551 Gnus provides a few different methods for storing the mail and news you
12552 send. The default method is to use the @dfn{archive virtual server} to
12553 store the messages. If you want to disable this completely, the
12554 @code{gnus-message-archive-group} variable should be @code{nil}. The
12555 default is "sent.%Y-%m", which gives you one archive group per month.
12556
12557 For archiving interesting messages in a group you read, see the
12558 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
12559 Group Commands}).
12560
12561 @vindex gnus-message-archive-method
12562 @code{gnus-message-archive-method} says what virtual server Gnus is to
12563 use to store sent messages. The default is @code{"archive"}, and when
12564 actually being used it is expanded into:
12565
12566 @lisp
12567 (nnfolder "archive"
12568 (nnfolder-directory "~/Mail/archive")
12569 (nnfolder-active-file "~/Mail/archive/active")
12570 (nnfolder-get-new-mail nil)
12571 (nnfolder-inhibit-expiry t))
12572 @end lisp
12573
12574 @quotation
12575 @vindex gnus-update-message-archive-method
12576 Note: a server like this is saved in the @file{~/.newsrc.eld} file first
12577 so that it may be used as a real method of the server which is named
12578 @code{"archive"} (that is, for the case where
12579 @code{gnus-message-archive-method} is set to @code{"archive"}) ever
12580 since. If it once has been saved, it will never be updated by default
12581 even if you change the value of @code{gnus-message-archive-method}
12582 afterward. Therefore, the server @code{"archive"} doesn't necessarily
12583 mean the @code{nnfolder} server like this at all times. If you want the
12584 saved method to reflect always the value of
12585 @code{gnus-message-archive-method}, set the
12586 @code{gnus-update-message-archive-method} variable to a non-@code{nil}
12587 value. The default value of this variable is @code{nil}.
12588 @end quotation
12589
12590 You can, however, use any mail select method (@code{nnml},
12591 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
12592 for doing this sort of thing, though. If you don't like the default
12593 directory chosen, you could say something like:
12594
12595 @lisp
12596 (setq gnus-message-archive-method
12597 '(nnfolder "archive"
12598 (nnfolder-inhibit-expiry t)
12599 (nnfolder-active-file "~/News/sent-mail/active")
12600 (nnfolder-directory "~/News/sent-mail/")))
12601 @end lisp
12602
12603 @vindex gnus-message-archive-group
12604 @cindex Gcc
12605 Gnus will insert @code{Gcc} headers in all outgoing messages that point
12606 to one or more group(s) on that server. Which group to use is
12607 determined by the @code{gnus-message-archive-group} variable.
12608
12609 This variable can be used to do the following:
12610
12611 @table @asis
12612 @item a string
12613 Messages will be saved in that group.
12614
12615 Note that you can include a select method in the group name, then the
12616 message will not be stored in the select method given by
12617 @code{gnus-message-archive-method}, but in the select method specified
12618 by the group name, instead. Suppose @code{gnus-message-archive-method}
12619 has the default value shown above. Then setting
12620 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
12621 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
12622 value @code{"nnml:foo"}, then outgoing messages will be stored in
12623 @samp{nnml:foo}.
12624
12625 @item a list of strings
12626 Messages will be saved in all those groups.
12627
12628 @item an alist of regexps, functions and forms
12629 When a key ``matches'', the result is used.
12630
12631 @item @code{nil}
12632 No message archiving will take place.
12633 @end table
12634
12635 Let's illustrate:
12636
12637 Just saving to a single group called @samp{MisK}:
12638 @lisp
12639 (setq gnus-message-archive-group "MisK")
12640 @end lisp
12641
12642 Saving to two groups, @samp{MisK} and @samp{safe}:
12643 @lisp
12644 (setq gnus-message-archive-group '("MisK" "safe"))
12645 @end lisp
12646
12647 Save to different groups based on what group you are in:
12648 @lisp
12649 (setq gnus-message-archive-group
12650 '(("^alt" "sent-to-alt")
12651 ("mail" "sent-to-mail")
12652 (".*" "sent-to-misc")))
12653 @end lisp
12654
12655 More complex stuff:
12656 @lisp
12657 (setq gnus-message-archive-group
12658 '((if (message-news-p)
12659 "misc-news"
12660 "misc-mail")))
12661 @end lisp
12662
12663 How about storing all news messages in one file, but storing all mail
12664 messages in one file per month:
12665
12666 @lisp
12667 (setq gnus-message-archive-group
12668 '((if (message-news-p)
12669 "misc-news"
12670 (concat "mail." (format-time-string "%Y-%m")))))
12671 @end lisp
12672
12673 Now, when you send a message off, it will be stored in the appropriate
12674 group. (If you want to disable storing for just one particular message,
12675 you can just remove the @code{Gcc} header that has been inserted.) The
12676 archive group will appear in the group buffer the next time you start
12677 Gnus, or the next time you press @kbd{F} in the group buffer. You can
12678 enter it and read the articles in it just like you'd read any other
12679 group. If the group gets really big and annoying, you can simply rename
12680 if (using @kbd{G r} in the group buffer) to something
12681 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
12682 continue to be stored in the old (now empty) group.
12683
12684 @table @code
12685 @item gnus-gcc-mark-as-read
12686 @vindex gnus-gcc-mark-as-read
12687 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
12688
12689 @item gnus-gcc-externalize-attachments
12690 @vindex gnus-gcc-externalize-attachments
12691 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
12692 and matches the Gcc group name, attach files as external parts; if it is
12693 @code{all}, attach local files as external parts; if it is other
12694 non-@code{nil}, the behavior is the same as @code{all}, but it may be
12695 changed in the future.
12696
12697 @item gnus-gcc-self-resent-messages
12698 @vindex gnus-gcc-self-resent-messages
12699 Like the @code{gcc-self} group parameter, applied only for unmodified
12700 messages that @code{gnus-summary-resend-message} (@pxref{Summary Mail
12701 Commands}) resends. Non-@code{nil} value of this variable takes
12702 precedence over any existing @code{Gcc} header.
12703
12704 If this is @code{none}, no @code{Gcc} copy will be made. If this is
12705 @code{t}, messages resent will be @code{Gcc} copied to the current
12706 group. If this is a string, it specifies a group to which resent
12707 messages will be @code{Gcc} copied. If this is @code{nil}, @code{Gcc}
12708 will be done according to existing @code{Gcc} header(s), if any. If
12709 this is @code{no-gcc-self}, that is the default, resent messages will be
12710 @code{Gcc} copied to groups that existing @code{Gcc} header specifies,
12711 except for the current group.
12712
12713 @item gnus-gcc-pre-body-encode-hook
12714 @vindex gnus-gcc-pre-body-encode-hook
12715 @itemx gnus-gcc-post-body-encode-hook
12716 @vindex gnus-gcc-post-body-encode-hook
12717
12718 These hooks are run before/after encoding the message body of the Gcc
12719 copy of a sent message. The current buffer (when the hook is run)
12720 contains the message including the message header. Changes made to
12721 the message will only affect the Gcc copy, but not the original
12722 message. You can use these hooks to edit the copy (and influence
12723 subsequent transformations), e.g., remove MML secure tags
12724 (@pxref{Signing and encrypting}).
12725
12726 @end table
12727
12728
12729 @node Posting Styles
12730 @section Posting Styles
12731 @cindex posting styles
12732 @cindex styles
12733
12734 All them variables, they make my head swim.
12735
12736 So what if you want a different @code{Organization} and signature based
12737 on what groups you post to? And you post both from your home machine
12738 and your work machine, and you want different @code{From} lines, and so
12739 on?
12740
12741 @vindex gnus-posting-styles
12742 One way to do stuff like that is to write clever hooks that change the
12743 variables you need to have changed. That's a bit boring, so somebody
12744 came up with the bright idea of letting the user specify these things in
12745 a handy alist. Here's an example of a @code{gnus-posting-styles}
12746 variable:
12747
12748 @lisp
12749 ((".*"
12750 (signature "Peace and happiness")
12751 (organization "What me?"))
12752 ("^comp"
12753 (signature "Death to everybody"))
12754 ("comp.emacs.i-love-it"
12755 (organization "Emacs is it")))
12756 @end lisp
12757
12758 As you might surmise from this example, this alist consists of several
12759 @dfn{styles}. Each style will be applicable if the first element
12760 ``matches'', in some form or other. The entire alist will be iterated
12761 over, from the beginning towards the end, and each match will be
12762 applied, which means that attributes in later styles that match override
12763 the same attributes in earlier matching styles. So
12764 @samp{comp.programming.literate} will have the @samp{Death to everybody}
12765 signature and the @samp{What me?} @code{Organization} header.
12766
12767 The first element in each style is called the @code{match}. If it's a
12768 string, then Gnus will try to regexp match it against the group name.
12769 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
12770 will look in the original article for a header whose name is
12771 @var{match} and compare that @var{regexp}. @var{match} and
12772 @var{regexp} are strings. (The original article is the one you are
12773 replying or following up to. If you are not composing a reply or a
12774 followup, then there is nothing to match against.) If the
12775 @code{match} is a function symbol, that function will be called with
12776 no arguments. If it's a variable symbol, then the variable will be
12777 referenced. If it's a list, then that list will be @code{eval}ed. In
12778 any case, if this returns a non-@code{nil} value, then the style is
12779 said to @dfn{match}.
12780
12781 Each style may contain an arbitrary amount of @dfn{attributes}. Each
12782 attribute consists of a @code{(@var{name} @var{value})} pair. In
12783 addition, you can also use the @code{(@var{name} :file @var{value})}
12784 form or the @code{(@var{name} :value @var{value})} form. Where
12785 @code{:file} signifies @var{value} represents a file name and its
12786 contents should be used as the attribute value, @code{:value} signifies
12787 @var{value} does not represent a file name explicitly. The attribute
12788 name can be one of:
12789
12790 @itemize @bullet
12791 @item @code{signature}
12792 @item @code{signature-file}
12793 @item @code{x-face-file}
12794 @item @code{address}, overriding @code{user-mail-address}
12795 @item @code{name}, overriding @code{(user-full-name)}
12796 @item @code{body}
12797 @end itemize
12798
12799 Note that the @code{signature-file} attribute honors the variable
12800 @code{message-signature-directory}.
12801
12802 The attribute name can also be a string or a symbol. In that case,
12803 this will be used as a header name, and the value will be inserted in
12804 the headers of the article; if the value is @code{nil}, the header
12805 name will be removed. If the attribute name is @code{eval}, the form
12806 is evaluated, and the result is thrown away.
12807
12808 The attribute value can be a string, a function with zero arguments
12809 (the return value will be used), a variable (its value will be used)
12810 or a list (it will be @code{eval}ed and the return value will be
12811 used). The functions and sexps are called/@code{eval}ed in the
12812 message buffer that is being set up. The headers of the current
12813 article are available through the @code{message-reply-headers}
12814 variable, which is a vector of the following headers: number subject
12815 from date id references chars lines xref extra.
12816
12817 In the case of a string value, if the @code{match} is a regular
12818 expression, a @samp{gnus-match-substitute-replacement} is proceed on
12819 the value to replace the positional parameters @samp{\@var{n}} by the
12820 corresponding parenthetical matches (see @xref{Replacing Match,,
12821 Replacing the Text that Matched, elisp, The Emacs Lisp Reference Manual}.)
12822
12823 @vindex message-reply-headers
12824
12825 If you wish to check whether the message you are about to compose is
12826 meant to be a news article or a mail message, you can check the values
12827 of the @code{message-news-p} and @code{message-mail-p} functions.
12828
12829 @findex message-mail-p
12830 @findex message-news-p
12831
12832 So here's a new example:
12833
12834 @lisp
12835 (setq gnus-posting-styles
12836 '((".*"
12837 (signature-file "~/.signature")
12838 (name "User Name")
12839 (x-face-file "~/.xface")
12840 (x-url (getenv "WWW_HOME"))
12841 (organization "People's Front Against MWM"))
12842 ("^rec.humor"
12843 (signature my-funny-signature-randomizer))
12844 ((equal (system-name) "gnarly") ;; @r{A form}
12845 (signature my-quote-randomizer))
12846 (message-news-p ;; @r{A function symbol}
12847 (signature my-news-signature))
12848 (window-system ;; @r{A value symbol}
12849 ("X-Window-System" (format "%s" window-system)))
12850 ;; @r{If I'm replying to Larsi, set the Organization header.}
12851 ((header "from" "larsi.*org")
12852 (Organization "Somewhere, Inc."))
12853 ((posting-from-work-p) ;; @r{A user defined function}
12854 (signature-file "~/.work-signature")
12855 (address "user@@bar.foo")
12856 (body "You are fired.\n\nSincerely, your boss.")
12857 ("X-Message-SMTP-Method" "smtp smtp.example.org 587")
12858 (organization "Important Work, Inc"))
12859 ("nnml:.*"
12860 (From (with-current-buffer gnus-article-buffer
12861 (message-fetch-field "to"))))
12862 ("^nn.+:"
12863 (signature-file "~/.mail-signature"))))
12864 @end lisp
12865
12866 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12867 @code{From} address in all your outgoing replies, which might be handy
12868 if you fill many roles.
12869 You may also use @code{message-alternative-emails} instead.
12870 @xref{Message Headers, ,Message Headers, message, Message Manual}.
12871
12872 Of particular interest in the ``work-mail'' style is the
12873 @samp{X-Message-SMTP-Method} header. It specifies how to send the
12874 outgoing email. You may want to sent certain emails through certain
12875 @acronym{SMTP} servers due to company policies, for instance.
12876 @xref{Mail Variables, ,Message Variables, message, Message Manual}.
12877
12878
12879 @node Drafts
12880 @section Drafts
12881 @cindex drafts
12882
12883 If you are writing a message (mail or news) and suddenly remember that
12884 you have a steak in the oven (or some pesto in the food processor, you
12885 craaazy vegetarians), you'll probably wish there was a method to save
12886 the message you are writing so that you can continue editing it some
12887 other day, and send it when you feel its finished.
12888
12889 Well, don't worry about it. Whenever you start composing a message of
12890 some sort using the Gnus mail and post commands, the buffer you get will
12891 automatically associate to an article in a special @dfn{draft} group.
12892 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12893 article will be saved there. (Auto-save files also go to the draft
12894 group.)
12895
12896 @cindex nndraft
12897 @vindex nndraft-directory
12898 The draft group is a special group (which is implemented as an
12899 @code{nndraft} group, if you absolutely have to know) called
12900 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12901 @code{nndraft} is to store its files. What makes this group special is
12902 that you can't tick any articles in it or mark any articles as
12903 read---all articles in the group are permanently unread.
12904
12905 If the group doesn't exist, it will be created and you'll be subscribed
12906 to it. The only way to make it disappear from the Group buffer is to
12907 unsubscribe it. The special properties of the draft group comes from
12908 a group property (@pxref{Group Parameters}), and if lost the group
12909 behaves like any other group. This means the commands below will not
12910 be available. To restore the special properties of the group, the
12911 simplest way is to kill the group, using @kbd{C-k}, and restart
12912 Gnus. The group is automatically created again with the
12913 correct parameters. The content of the group is not lost.
12914
12915 @c @findex gnus-dissociate-buffer-from-draft
12916 @c @kindex C-c M-d (Mail)
12917 @c @kindex C-c M-d (Post)
12918 @c @findex gnus-associate-buffer-with-draft
12919 @c @kindex C-c C-d (Mail)
12920 @c @kindex C-c C-d (Post)
12921 @c If you're writing some super-secret message that you later want to
12922 @c encode with PGP before sending, you may wish to turn the auto-saving
12923 @c (and association with the draft group) off. You never know who might be
12924 @c interested in reading all your extremely valuable and terribly horrible
12925 @c and interesting secrets. The @kbd{C-c M-d}
12926 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12927 @c If you change your mind and want to turn the auto-saving back on again,
12928 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12929 @c
12930 @c @vindex gnus-use-draft
12931 @c To leave association with the draft group off by default, set
12932 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12933
12934 @findex gnus-draft-edit-message
12935 @kindex D e (Draft)
12936 When you want to continue editing the article, you simply enter the
12937 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12938 that. You will be placed in a buffer where you left off.
12939
12940 Rejected articles will also be put in this draft group (@pxref{Rejected
12941 Articles}).
12942
12943 @findex gnus-draft-send-all-messages
12944 @kindex D s (Draft)
12945 @findex gnus-draft-send-message
12946 @kindex D S (Draft)
12947 If you have lots of rejected messages you want to post (or mail) without
12948 doing further editing, you can use the @kbd{D s} command
12949 (@code{gnus-draft-send-message}). This command understands the
12950 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12951 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12952 in the buffer.
12953
12954 @findex gnus-draft-toggle-sending
12955 @kindex D t (Draft)
12956 If you have some messages that you wish not to send, you can use the
12957 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12958 as unsendable. This is a toggling command.
12959
12960 Finally, if you want to delete a draft, use the normal @kbd{B DEL}
12961 command (@pxref{Mail Group Commands}).
12962
12963
12964 @node Rejected Articles
12965 @section Rejected Articles
12966 @cindex rejected articles
12967
12968 Sometimes a news server will reject an article. Perhaps the server
12969 doesn't like your face. Perhaps it just feels miserable. Perhaps
12970 @emph{there be demons}. Perhaps you have included too much cited text.
12971 Perhaps the disk is full. Perhaps the server is down.
12972
12973 These situations are, of course, totally beyond the control of Gnus.
12974 (Gnus, of course, loves the way you look, always feels great, has angels
12975 fluttering around inside of it, doesn't care about how much cited text
12976 you include, never runs full and never goes down.) So Gnus saves these
12977 articles until some later time when the server feels better.
12978
12979 The rejected articles will automatically be put in a special draft group
12980 (@pxref{Drafts}). When the server comes back up again, you'd then
12981 typically enter that group and send all the articles off.
12982
12983 @node Signing and encrypting
12984 @section Signing and encrypting
12985 @cindex using gpg
12986 @cindex using s/mime
12987 @cindex using smime
12988
12989 Gnus can digitally sign and encrypt your messages, using vanilla
12990 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12991 decoding such messages, see the @code{mm-verify-option} and
12992 @code{mm-decrypt-option} options (@pxref{Security}).
12993
12994 @vindex gnus-message-replysign
12995 @vindex gnus-message-replyencrypt
12996 @vindex gnus-message-replysignencrypted
12997 Often, you would like to sign replies to people who send you signed
12998 messages. Even more often, you might want to encrypt messages which
12999 are in reply to encrypted messages. Gnus offers
13000 @code{gnus-message-replysign} to enable the former, and
13001 @code{gnus-message-replyencrypt} for the latter. In addition, setting
13002 @code{gnus-message-replysignencrypted} (on by default) will sign
13003 automatically encrypted messages.
13004
13005 Instructing @acronym{MML} to perform security operations on a
13006 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
13007 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
13008
13009 @table @kbd
13010
13011 @item C-c C-m s s
13012 @kindex C-c C-m s s (Message)
13013 @findex mml-secure-message-sign-smime
13014
13015 Digitally sign current message using @acronym{S/MIME}.
13016
13017 @item C-c C-m s o
13018 @kindex C-c C-m s o (Message)
13019 @findex mml-secure-message-sign-pgp
13020
13021 Digitally sign current message using @acronym{PGP}.
13022
13023 @item C-c C-m s p
13024 @kindex C-c C-m s p (Message)
13025 @findex mml-secure-message-sign-pgp
13026
13027 Digitally sign current message using @acronym{PGP/MIME}.
13028
13029 @item C-c C-m c s
13030 @kindex C-c C-m c s (Message)
13031 @findex mml-secure-message-encrypt-smime
13032
13033 Digitally encrypt current message using @acronym{S/MIME}.
13034
13035 @item C-c C-m c o
13036 @kindex C-c C-m c o (Message)
13037 @findex mml-secure-message-encrypt-pgp
13038
13039 Digitally encrypt current message using @acronym{PGP}.
13040
13041 @item C-c C-m c p
13042 @kindex C-c C-m c p (Message)
13043 @findex mml-secure-message-encrypt-pgpmime
13044
13045 Digitally encrypt current message using @acronym{PGP/MIME}.
13046
13047 @item C-c C-m C-n
13048 @kindex C-c C-m C-n (Message)
13049 @findex mml-unsecure-message
13050 Remove security related @acronym{MML} tags from message.
13051
13052 @end table
13053
13054 @xref{Security, ,Security, message, Message Manual}, for more information.
13055
13056 @node Select Methods
13057 @chapter Select Methods
13058 @cindex foreign groups
13059 @cindex select methods
13060
13061 A @dfn{foreign group} is a group not read by the usual (or
13062 default) means. It could be, for instance, a group from a different
13063 @acronym{NNTP} server, it could be a virtual group, or it could be your own
13064 personal mail group.
13065
13066 A foreign group (or any group, really) is specified by a @dfn{name} and
13067 a @dfn{select method}. To take the latter first, a select method is a
13068 list where the first element says what back end to use (e.g., @code{nntp},
13069 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
13070 name}. There may be additional elements in the select method, where the
13071 value may have special meaning for the back end in question.
13072
13073 One could say that a select method defines a @dfn{virtual server}---so
13074 we do just that (@pxref{Server Buffer}).
13075
13076 The @dfn{name} of the group is the name the back end will recognize the
13077 group as.
13078
13079 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
13080 @samp{some.where.edu} will have the name @samp{soc.motss} and select
13081 method @code{(nntp "some.where.edu")}. Gnus will call this group
13082 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
13083 back end just knows this group as @samp{soc.motss}.
13084
13085 The different methods all have their peculiarities, of course.
13086
13087 @menu
13088 * Server Buffer:: Making and editing virtual servers.
13089 * Getting News:: Reading USENET news with Gnus.
13090 * Using IMAP:: Reading mail from @acronym{IMAP}.
13091 * Getting Mail:: Reading your personal mail with Gnus.
13092 * Browsing the Web:: Getting messages from a plethora of Web sources.
13093 * Other Sources:: Reading directories, files.
13094 * Combined Groups:: Combining groups into one group.
13095 * Email Based Diary:: Using mails to manage diary events in Gnus.
13096 * Gnus Unplugged:: Reading news and mail offline.
13097 @end menu
13098
13099
13100 @node Server Buffer
13101 @section Server Buffer
13102
13103 Traditionally, a @dfn{server} is a machine or a piece of software that
13104 one connects to, and then requests information from. Gnus does not
13105 connect directly to any real servers, but does all transactions through
13106 one back end or other. But that's just putting one layer more between
13107 the actual media and Gnus, so we might just as well say that each
13108 back end represents a virtual server.
13109
13110 For instance, the @code{nntp} back end may be used to connect to several
13111 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
13112 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
13113 use, and what parameters to set by specifying a @dfn{select method}.
13114
13115 These select method specifications can sometimes become quite
13116 complicated---say, for instance, that you want to read from the
13117 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
13118 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
13119 Anyway, if you had to specify that for each group that used this
13120 server, that would be too much work, so Gnus offers a way of naming
13121 select methods, which is what you do in the server buffer.
13122
13123 To enter the server buffer, use the @kbd{^}
13124 (@code{gnus-group-enter-server-mode}) command in the group buffer.
13125
13126 @menu
13127 * Server Buffer Format:: You can customize the look of this buffer.
13128 * Server Commands:: Commands to manipulate servers.
13129 * Example Methods:: Examples server specifications.
13130 * Creating a Virtual Server:: An example session.
13131 * Server Variables:: Which variables to set.
13132 * Servers and Methods:: You can use server names as select methods.
13133 * Unavailable Servers:: Some servers you try to contact may be down.
13134 @end menu
13135
13136 @vindex gnus-server-mode-hook
13137 @code{gnus-server-mode-hook} is run when creating the server buffer.
13138
13139
13140 @node Server Buffer Format
13141 @subsection Server Buffer Format
13142 @cindex server buffer format
13143
13144 @vindex gnus-server-line-format
13145 You can change the look of the server buffer lines by changing the
13146 @code{gnus-server-line-format} variable. This is a @code{format}-like
13147 variable, with some simple extensions:
13148
13149 @table @samp
13150
13151 @item h
13152 How the news is fetched---the back end name.
13153
13154 @item n
13155 The name of this server.
13156
13157 @item w
13158 Where the news is to be fetched from---the address.
13159
13160 @item s
13161 The opened/closed/denied status of the server.
13162
13163 @item a
13164 Whether this server is agentized.
13165 @end table
13166
13167 @vindex gnus-server-mode-line-format
13168 The mode line can also be customized by using the
13169 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
13170 Formatting}). The following specs are understood:
13171
13172 @table @samp
13173 @item S
13174 Server name.
13175
13176 @item M
13177 Server method.
13178 @end table
13179
13180 Also @pxref{Formatting Variables}.
13181
13182
13183 @node Server Commands
13184 @subsection Server Commands
13185 @cindex server commands
13186
13187 @table @kbd
13188
13189 @item v
13190 @kindex v (Server)
13191 @cindex keys, reserved for users (Server)
13192 The key @kbd{v} is reserved for users. You can bind it to some
13193 command or better use it as a prefix key.
13194
13195 @item a
13196 @kindex a (Server)
13197 @findex gnus-server-add-server
13198 Add a new server (@code{gnus-server-add-server}).
13199
13200 @item e
13201 @kindex e (Server)
13202 @findex gnus-server-edit-server
13203 Edit a server (@code{gnus-server-edit-server}).
13204
13205 @item S
13206 @kindex S (Server)
13207 @findex gnus-server-show-server
13208 Show the definition of a server (@code{gnus-server-show-server}).
13209
13210 @item SPACE
13211 @kindex SPACE (Server)
13212 @findex gnus-server-read-server
13213 Browse the current server (@code{gnus-server-read-server}).
13214
13215 @item q
13216 @kindex q (Server)
13217 @findex gnus-server-exit
13218 Return to the group buffer (@code{gnus-server-exit}).
13219
13220 @item k
13221 @kindex k (Server)
13222 @findex gnus-server-kill-server
13223 Kill the current server (@code{gnus-server-kill-server}).
13224
13225 @item y
13226 @kindex y (Server)
13227 @findex gnus-server-yank-server
13228 Yank the previously killed server (@code{gnus-server-yank-server}).
13229
13230 @item c
13231 @kindex c (Server)
13232 @findex gnus-server-copy-server
13233 Copy the current server (@code{gnus-server-copy-server}).
13234
13235 @item l
13236 @kindex l (Server)
13237 @findex gnus-server-list-servers
13238 List all servers (@code{gnus-server-list-servers}).
13239
13240 @item s
13241 @kindex s (Server)
13242 @findex gnus-server-scan-server
13243 Request that the server scan its sources for new articles
13244 (@code{gnus-server-scan-server}). This is mainly sensible with mail
13245 servers.
13246
13247 @item g
13248 @kindex g (Server)
13249 @findex gnus-server-regenerate-server
13250 Request that the server regenerate all its data structures
13251 (@code{gnus-server-regenerate-server}). This can be useful if you have
13252 a mail back end that has gotten out of sync.
13253
13254 @item z
13255 @kindex z (Server)
13256 @findex gnus-server-compact-server
13257
13258 Compact all groups in the server under point
13259 (@code{gnus-server-compact-server}). Currently implemented only in
13260 nnml (@pxref{Mail Spool}). This removes gaps between article numbers,
13261 hence getting a correct total article count.
13262
13263 @end table
13264
13265 Some more commands for closing, disabling, and re-opening servers are
13266 listed in @ref{Unavailable Servers}.
13267
13268
13269 @node Example Methods
13270 @subsection Example Methods
13271
13272 Most select methods are pretty simple and self-explanatory:
13273
13274 @lisp
13275 (nntp "news.funet.fi")
13276 @end lisp
13277
13278 Reading directly from the spool is even simpler:
13279
13280 @lisp
13281 (nnspool "")
13282 @end lisp
13283
13284 As you can see, the first element in a select method is the name of the
13285 back end, and the second is the @dfn{address}, or @dfn{name}, if you
13286 will.
13287
13288 After these two elements, there may be an arbitrary number of
13289 @code{(@var{variable} @var{form})} pairs.
13290
13291 To go back to the first example---imagine that you want to read from
13292 port 15 on that machine. This is what the select method should
13293 look like then:
13294
13295 @lisp
13296 (nntp "news.funet.fi" (nntp-port-number 15))
13297 @end lisp
13298
13299 You should read the documentation to each back end to find out what
13300 variables are relevant, but here's an @code{nnmh} example:
13301
13302 @code{nnmh} is a mail back end that reads a spool-like structure. Say
13303 you have two structures that you wish to access: One is your private
13304 mail spool, and the other is a public one. Here's the possible spec for
13305 your private mail:
13306
13307 @lisp
13308 (nnmh "private" (nnmh-directory "~/private/mail/"))
13309 @end lisp
13310
13311 (This server is then called @samp{private}, but you may have guessed
13312 that.)
13313
13314 Here's the method for a public spool:
13315
13316 @lisp
13317 (nnmh "public"
13318 (nnmh-directory "/usr/information/spool/")
13319 (nnmh-get-new-mail nil))
13320 @end lisp
13321
13322 @cindex proxy
13323 @cindex firewall
13324
13325 If you are behind a firewall and only have access to the @acronym{NNTP}
13326 server from the firewall machine, you can instruct Gnus to @code{rlogin}
13327 on the firewall machine and connect with
13328 @uref{http://netcat.sourceforge.net/, netcat} from there to the
13329 @acronym{NNTP} server.
13330 Doing this can be rather fiddly, but your virtual server definition
13331 should probably look something like this:
13332
13333 @lisp
13334 (nntp "firewall"
13335 (nntp-open-connection-function nntp-open-via-rlogin-and-netcat)
13336 (nntp-via-address "the.firewall.machine")
13337 (nntp-address "the.real.nntp.host"))
13338 @end lisp
13339
13340 If you want to use the wonderful @code{ssh} program to provide a
13341 compressed connection over the modem line, you could add the following
13342 configuration to the example above:
13343
13344 @lisp
13345 (nntp-via-rlogin-command "ssh")
13346 @end lisp
13347
13348 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
13349 an indirect connection:
13350
13351 @lisp
13352 (setq gnus-select-method
13353 '(nntp "indirect"
13354 (nntp-address "news.server.example")
13355 (nntp-via-user-name "intermediate_user_name")
13356 (nntp-via-address "intermediate.host.example")
13357 (nntp-via-rlogin-command "ssh")
13358 (nntp-via-rlogin-command-switches ("-C"))
13359 (nntp-open-connection-function nntp-open-via-rlogin-and-netcat)))
13360 @end lisp
13361
13362 This means that you have to have set up @code{ssh-agent} correctly to
13363 provide automatic authorization, of course.
13364
13365 If you're behind a firewall, but have direct access to the outside world
13366 through a wrapper command like "runsocks", you could open a socksified
13367 netcat connection to the news server as follows:
13368
13369 @lisp
13370 (nntp "outside"
13371 (nntp-pre-command "runsocks")
13372 (nntp-open-connection-function nntp-open-netcat-stream)
13373 (nntp-address "the.news.server"))
13374 @end lisp
13375
13376
13377 @node Creating a Virtual Server
13378 @subsection Creating a Virtual Server
13379
13380 If you're saving lots of articles in the cache by using persistent
13381 articles, you may want to create a virtual server to read the cache.
13382
13383 First you need to add a new server. The @kbd{a} command does that. It
13384 would probably be best to use @code{nnml} to read the cache. You
13385 could also use @code{nnspool} or @code{nnmh}, though.
13386
13387 Type @kbd{a nnml RET cache RET}.
13388
13389 You should now have a brand new @code{nnml} virtual server called
13390 @samp{cache}. You now need to edit it to have the right definitions.
13391 Type @kbd{e} to edit the server. You'll be entered into a buffer that
13392 will contain the following:
13393
13394 @lisp
13395 (nnml "cache")
13396 @end lisp
13397
13398 Change that to:
13399
13400 @lisp
13401 (nnml "cache"
13402 (nnml-directory "~/News/cache/")
13403 (nnml-active-file "~/News/cache/active"))
13404 @end lisp
13405
13406 Type @kbd{C-c C-c} to return to the server buffer. If you now press
13407 @kbd{RET} over this virtual server, you should be entered into a browse
13408 buffer, and you should be able to enter any of the groups displayed.
13409
13410
13411 @node Server Variables
13412 @subsection Server Variables
13413 @cindex server variables
13414 @cindex server parameters
13415
13416 One sticky point when defining variables (both on back ends and in Emacs
13417 in general) is that some variables are typically initialized from other
13418 variables when the definition of the variables is being loaded. If you
13419 change the ``base'' variable after the variables have been loaded, you
13420 won't change the ``derived'' variables.
13421
13422 This typically affects directory and file variables. For instance,
13423 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
13424 directory variables are initialized from that variable, so
13425 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
13426 new virtual @code{nnml} server, it will @emph{not} suffice to set just
13427 @code{nnml-directory}---you have to explicitly set all the file
13428 variables to be what you want them to be. For a complete list of
13429 variables for each back end, see each back end's section later in this
13430 manual, but here's an example @code{nnml} definition:
13431
13432 @lisp
13433 (nnml "public"
13434 (nnml-directory "~/my-mail/")
13435 (nnml-active-file "~/my-mail/active")
13436 (nnml-newsgroups-file "~/my-mail/newsgroups"))
13437 @end lisp
13438
13439 Server variables are often called @dfn{server parameters}.
13440
13441 @node Servers and Methods
13442 @subsection Servers and Methods
13443
13444 Wherever you would normally use a select method
13445 (e.g., @code{gnus-secondary-select-method}, in the group select method,
13446 when browsing a foreign server) you can use a virtual server name
13447 instead. This could potentially save lots of typing. And it's nice all
13448 over.
13449
13450
13451 @node Unavailable Servers
13452 @subsection Unavailable Servers
13453
13454 If a server seems to be unreachable, Gnus will mark that server as
13455 @code{denied}. That means that any subsequent attempt to make contact
13456 with that server will just be ignored. ``It can't be opened,'' Gnus
13457 will tell you, without making the least effort to see whether that is
13458 actually the case or not.
13459
13460 That might seem quite naughty, but it does make sense most of the time.
13461 Let's say you have 10 groups subscribed to on server
13462 @samp{nephelococcygia.com}. This server is located somewhere quite far
13463 away from you and the machine is quite slow, so it takes 1 minute just
13464 to find out that it refuses connection to you today. If Gnus were to
13465 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
13466 attempt to do that. Once it has gotten a single ``connection refused'',
13467 it will regard that server as ``down''.
13468
13469 So, what happens if the machine was only feeling unwell temporarily?
13470 How do you test to see whether the machine has come up again?
13471
13472 You jump to the server buffer (@pxref{Server Buffer}) and poke it
13473 with the following commands:
13474
13475 @table @kbd
13476
13477 @item O
13478 @kindex O (Server)
13479 @findex gnus-server-open-server
13480 Try to establish connection to the server on the current line
13481 (@code{gnus-server-open-server}).
13482
13483 @item C
13484 @kindex C (Server)
13485 @findex gnus-server-close-server
13486 Close the connection (if any) to the server
13487 (@code{gnus-server-close-server}).
13488
13489 @item D
13490 @kindex D (Server)
13491 @findex gnus-server-deny-server
13492 Mark the current server as unreachable
13493 (@code{gnus-server-deny-server}).
13494
13495 @item M-o
13496 @kindex M-o (Server)
13497 @findex gnus-server-open-all-servers
13498 Open the connections to all servers in the buffer
13499 (@code{gnus-server-open-all-servers}).
13500
13501 @item M-c
13502 @kindex M-c (Server)
13503 @findex gnus-server-close-all-servers
13504 Close the connections to all servers in the buffer
13505 (@code{gnus-server-close-all-servers}).
13506
13507 @item R
13508 @kindex R (Server)
13509 @findex gnus-server-remove-denials
13510 Remove all marks to whether Gnus was denied connection from any servers
13511 (@code{gnus-server-remove-denials}).
13512
13513 @item c
13514 @kindex c (Server)
13515 @findex gnus-server-copy-server
13516 Copy a server and give it a new name
13517 (@code{gnus-server-copy-server}). This can be useful if you have a
13518 complex method definition, and want to use the same definition towards
13519 a different (physical) server.
13520
13521 @item L
13522 @kindex L (Server)
13523 @findex gnus-server-offline-server
13524 Set server status to offline (@code{gnus-server-offline-server}).
13525
13526 @end table
13527
13528
13529 @node Getting News
13530 @section Getting News
13531 @cindex reading news
13532 @cindex news back ends
13533
13534 A newsreader is normally used for reading news. Gnus currently provides
13535 only two methods of getting news---it can read from an @acronym{NNTP} server,
13536 or it can read from a local spool.
13537
13538 @menu
13539 * NNTP:: Reading news from an @acronym{NNTP} server.
13540 * News Spool:: Reading news from the local spool.
13541 @end menu
13542
13543
13544 @node NNTP
13545 @subsection NNTP
13546 @cindex nntp
13547
13548 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
13549 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
13550 server as the, uhm, address.
13551
13552 If the @acronym{NNTP} server is located at a non-standard port, setting the
13553 third element of the select method to this port number should allow you
13554 to connect to the right port. You'll have to edit the group info for
13555 that (@pxref{Foreign Groups}).
13556
13557 The name of the foreign group can be the same as a native group. In
13558 fact, you can subscribe to the same group from as many different servers
13559 you feel like. There will be no name collisions.
13560
13561 The following variables can be used to create a virtual @code{nntp}
13562 server:
13563
13564 @table @code
13565
13566 @item nntp-server-opened-hook
13567 @vindex nntp-server-opened-hook
13568 @cindex @sc{mode reader}
13569 @cindex authinfo
13570 @cindex authentication
13571 @cindex nntp authentication
13572 @findex nntp-send-authinfo
13573 @findex nntp-send-mode-reader
13574 is run after a connection has been made. It can be used to send
13575 commands to the @acronym{NNTP} server after it has been contacted. By
13576 default it sends the command @code{MODE READER} to the server with the
13577 @code{nntp-send-mode-reader} function. This function should always be
13578 present in this hook.
13579
13580 @item nntp-authinfo-function
13581 @vindex nntp-authinfo-function
13582 @findex nntp-send-authinfo
13583 @vindex nntp-authinfo-file
13584 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
13585 server. The default function is @code{nntp-send-authinfo}, which looks
13586 through your @file{~/.authinfo} (or whatever you've set the
13587 @code{nntp-authinfo-file} variable to) for applicable entries. If none
13588 are found, it will prompt you for a login name and a password. The
13589 format of the @file{~/.authinfo} file is (almost) the same as the
13590 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
13591 manual page, but here are the salient facts:
13592
13593 @enumerate
13594 @item
13595 The file contains one or more line, each of which define one server.
13596
13597 @item
13598 Each line may contain an arbitrary number of token/value pairs.
13599
13600 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
13601 @samp{default}. In addition Gnus introduces two new tokens, not present
13602 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
13603 @samp{force}. (This is the only way the @file{.authinfo} file format
13604 deviates from the @file{.netrc} file format.) @samp{port} is used to
13605 indicate what port on the server the credentials apply to and
13606 @samp{force} is explained below.
13607
13608 @end enumerate
13609
13610 Here's an example file:
13611
13612 @example
13613 machine news.uio.no login larsi password geheimnis
13614 machine nntp.ifi.uio.no login larsi force yes
13615 @end example
13616
13617 The token/value pairs may appear in any order; @samp{machine} doesn't
13618 have to be first, for instance.
13619
13620 In this example, both login name and password have been supplied for the
13621 former server, while the latter has only the login name listed, and the
13622 user will be prompted for the password. The latter also has the
13623 @samp{force} tag, which means that the authinfo will be sent to the
13624 @var{nntp} server upon connection; the default (i.e., when there is not
13625 @samp{force} tag) is to not send authinfo to the @var{nntp} server
13626 until the @var{nntp} server asks for it.
13627
13628 You can also add @samp{default} lines that will apply to all servers
13629 that don't have matching @samp{machine} lines.
13630
13631 @example
13632 default force yes
13633 @end example
13634
13635 This will force sending @samp{AUTHINFO} commands to all servers not
13636 previously mentioned.
13637
13638 Remember to not leave the @file{~/.authinfo} file world-readable.
13639
13640 @item nntp-server-action-alist
13641 @vindex nntp-server-action-alist
13642 This is a list of regexps to match on server types and actions to be
13643 taken when matches are made. For instance, if you want Gnus to beep
13644 every time you connect to innd, you could say something like:
13645
13646 @lisp
13647 (setq nntp-server-action-alist
13648 '(("innd" (ding))))
13649 @end lisp
13650
13651 You probably don't want to do that, though.
13652
13653 The default value is
13654
13655 @lisp
13656 '(("nntpd 1\\.5\\.11t"
13657 (remove-hook 'nntp-server-opened-hook
13658 'nntp-send-mode-reader)))
13659 @end lisp
13660
13661 This ensures that Gnus doesn't send the @code{MODE READER} command to
13662 nntpd 1.5.11t, since that command chokes that server, I've been told.
13663
13664 @item nntp-maximum-request
13665 @vindex nntp-maximum-request
13666 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
13667 will collect headers by sending a series of @code{head} commands. To
13668 speed things up, the back end sends lots of these commands without
13669 waiting for reply, and then reads all the replies. This is controlled
13670 by the @code{nntp-maximum-request} variable, and is 400 by default. If
13671 your network is buggy, you should set this to 1.
13672
13673 @item nntp-connection-timeout
13674 @vindex nntp-connection-timeout
13675 If you have lots of foreign @code{nntp} groups that you connect to
13676 regularly, you're sure to have problems with @acronym{NNTP} servers not
13677 responding properly, or being too loaded to reply within reasonable
13678 time. This is can lead to awkward problems, which can be helped
13679 somewhat by setting @code{nntp-connection-timeout}. This is an integer
13680 that says how many seconds the @code{nntp} back end should wait for a
13681 connection before giving up. If it is @code{nil}, which is the default,
13682 no timeouts are done.
13683
13684 @item nntp-nov-is-evil
13685 @vindex nntp-nov-is-evil
13686 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
13687 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
13688 can be used.
13689
13690 @item nntp-xover-commands
13691 @vindex nntp-xover-commands
13692 @cindex @acronym{NOV}
13693 @cindex XOVER
13694 List of strings used as commands to fetch @acronym{NOV} lines from a
13695 server. The default value of this variable is @code{("XOVER"
13696 "XOVERVIEW")}.
13697
13698 @item nntp-nov-gap
13699 @vindex nntp-nov-gap
13700 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
13701 the server. The server responds with one huge list of lines. However,
13702 if you have read articles 2--5000 in the group, and only want to read
13703 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
13704 lines that you will not need. This variable says how
13705 big a gap between two consecutive articles is allowed to be before the
13706 @code{XOVER} request is split into several request. Note that if your
13707 network is fast, setting this variable to a really small number means
13708 that fetching will probably be slower. If this variable is @code{nil},
13709 @code{nntp} will never split requests. The default is 5.
13710
13711 @item nntp-xref-number-is-evil
13712 @vindex nntp-xref-number-is-evil
13713 When Gnus refers to an article having the @code{Message-ID} that a user
13714 specifies or having the @code{Message-ID} of the parent article of the
13715 current one (@pxref{Finding the Parent}), Gnus sends a @code{HEAD}
13716 command to the @acronym{NNTP} server to know where it is, and the server
13717 returns the data containing the pairs of a group and an article number
13718 in the @code{Xref} header. Gnus normally uses the article number to
13719 refer to the article if the data shows that that article is in the
13720 current group, while it uses the @code{Message-ID} otherwise. However,
13721 some news servers, e.g., ones running Diablo, run multiple engines
13722 having the same articles but article numbers are not kept synchronized
13723 between them. In that case, the article number that appears in the
13724 @code{Xref} header varies by which engine is chosen, so you cannot refer
13725 to the parent article that is in the current group, for instance. If
13726 you connect to such a server, set this variable to a non-@code{nil}
13727 value, and Gnus never uses article numbers. For example:
13728
13729 @lisp
13730 (setq gnus-select-method
13731 '(nntp "newszilla"
13732 (nntp-address "newszilla.example.com")
13733 (nntp-xref-number-is-evil t)
13734 @dots{}))
13735 @end lisp
13736
13737 The default value of this server variable is @code{nil}.
13738
13739 @item nntp-prepare-server-hook
13740 @vindex nntp-prepare-server-hook
13741 A hook run before attempting to connect to an @acronym{NNTP} server.
13742
13743 @item nntp-record-commands
13744 @vindex nntp-record-commands
13745 If non-@code{nil}, @code{nntp} will log all commands it sends to the
13746 @acronym{NNTP} server (along with a timestamp) in the @file{*nntp-log*}
13747 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
13748 that doesn't seem to work.
13749
13750 @item nntp-open-connection-function
13751 @vindex nntp-open-connection-function
13752 It is possible to customize how the connection to the nntp server will
13753 be opened. If you specify an @code{nntp-open-connection-function}
13754 parameter, Gnus will use that function to establish the connection.
13755 Seven pre-made functions are supplied. These functions can be grouped
13756 in two categories: direct connection functions (four pre-made), and
13757 indirect ones (three pre-made).
13758
13759 @item nntp-never-echoes-commands
13760 @vindex nntp-never-echoes-commands
13761 Non-@code{nil} means the nntp server never echoes commands. It is
13762 reported that some nntps server doesn't echo commands. So, you may want
13763 to set this to non-@code{nil} in the method for such a server setting
13764 @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for
13765 example. The default value is @code{nil}. Note that the
13766 @code{nntp-open-connection-functions-never-echo-commands} variable
13767 overrides the @code{nil} value of this variable.
13768
13769 @item nntp-open-connection-functions-never-echo-commands
13770 @vindex nntp-open-connection-functions-never-echo-commands
13771 List of functions that never echo commands. Add or set a function which
13772 you set to @code{nntp-open-connection-function} to this list if it does
13773 not echo commands. Note that a non-@code{nil} value of the
13774 @code{nntp-never-echoes-commands} variable overrides this variable. The
13775 default value is @code{(nntp-open-network-stream)}.
13776
13777 @item nntp-prepare-post-hook
13778 @vindex nntp-prepare-post-hook
13779 A hook run just before posting an article. If there is no
13780 @code{Message-ID} header in the article and the news server provides the
13781 recommended ID, it will be added to the article before running this
13782 hook. It is useful to make @code{Cancel-Lock} headers even if you
13783 inhibit Gnus to add a @code{Message-ID} header, you could say:
13784
13785 @lisp
13786 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
13787 @end lisp
13788
13789 Note that not all servers support the recommended ID@. This works for
13790 INN versions 2.3.0 and later, for instance.
13791
13792 @item nntp-server-list-active-group
13793 If @code{nil}, then always use @samp{GROUP} instead of @samp{LIST
13794 ACTIVE}. This is usually slower, but on misconfigured servers that
13795 don't update their active files often, this can help.
13796
13797
13798 @end table
13799
13800 @menu
13801 * Direct Functions:: Connecting directly to the server.
13802 * Indirect Functions:: Connecting indirectly to the server.
13803 * Common Variables:: Understood by several connection functions.
13804 @end menu
13805
13806
13807 @node Direct Functions
13808 @subsubsection Direct Functions
13809 @cindex direct connection functions
13810
13811 These functions are called direct because they open a direct connection
13812 between your machine and the @acronym{NNTP} server. The behavior of these
13813 functions is also affected by commonly understood variables
13814 (@pxref{Common Variables}).
13815
13816 @table @code
13817 @findex nntp-open-network-stream
13818 @item nntp-open-network-stream
13819 This is the default, and simply connects to some port or other on the
13820 remote system. If both Emacs and the server supports it, the
13821 connection will be upgraded to an encrypted @acronym{STARTTLS}
13822 connection automatically.
13823
13824 @item network-only
13825 The same as the above, but don't do automatic @acronym{STARTTLS} upgrades.
13826
13827 @findex nntp-open-tls-stream
13828 @item nntp-open-tls-stream
13829 Opens a connection to a server over a @dfn{secure} channel. To use
13830 this you must have @uref{http://www.gnu.org/software/gnutls/, GnuTLS}
13831 installed. You then define a server as follows:
13832
13833 @lisp
13834 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
13835 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
13836 ;;
13837 (nntp "snews.bar.com"
13838 (nntp-open-connection-function nntp-open-tls-stream)
13839 (nntp-port-number 563)
13840 (nntp-address "snews.bar.com"))
13841 @end lisp
13842
13843 @findex nntp-open-ssl-stream
13844 @item nntp-open-ssl-stream
13845 Opens a connection to a server over a @dfn{secure} channel. To use
13846 this you must have @uref{http://www.openssl.org, OpenSSL}
13847 @ignore
13848 @c Defunct URL, ancient package, so don't mention it.
13849 or @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay}
13850 @end ignore
13851 installed. You then define a server as follows:
13852
13853 @lisp
13854 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
13855 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
13856 ;;
13857 (nntp "snews.bar.com"
13858 (nntp-open-connection-function nntp-open-ssl-stream)
13859 (nntp-port-number 563)
13860 (nntp-address "snews.bar.com"))
13861 @end lisp
13862
13863 @findex nntp-open-netcat-stream
13864 @item nntp-open-netcat-stream
13865 Opens a connection to an @acronym{NNTP} server using the @code{netcat}
13866 program. You might wonder why this function exists, since we have
13867 the default @code{nntp-open-network-stream} which would do the job. (One
13868 of) the reason(s) is that if you are behind a firewall but have direct
13869 connections to the outside world thanks to a command wrapper like
13870 @code{runsocks}, you can use it like this:
13871
13872 @lisp
13873 (nntp "socksified"
13874 (nntp-pre-command "runsocks")
13875 (nntp-open-connection-function nntp-open-netcat-stream)
13876 (nntp-address "the.news.server"))
13877 @end lisp
13878
13879 With the default method, you would need to wrap your whole Emacs
13880 session, which is not a good idea.
13881
13882 @findex nntp-open-telnet-stream
13883 @item nntp-open-telnet-stream
13884 Like @code{nntp-open-netcat-stream}, but uses @code{telnet} rather than
13885 @code{netcat}. @code{telnet} is a bit less robust because of things
13886 like line-end-conversion, but sometimes netcat is simply
13887 not available. The previous example would turn into:
13888
13889 @lisp
13890 (nntp "socksified"
13891 (nntp-pre-command "runsocks")
13892 (nntp-open-connection-function nntp-open-telnet-stream)
13893 (nntp-address "the.news.server")
13894 (nntp-end-of-line "\n"))
13895 @end lisp
13896 @end table
13897
13898
13899 @node Indirect Functions
13900 @subsubsection Indirect Functions
13901 @cindex indirect connection functions
13902
13903 These functions are called indirect because they connect to an
13904 intermediate host before actually connecting to the @acronym{NNTP} server.
13905 All of these functions and related variables are also said to belong to
13906 the ``via'' family of connection: they're all prefixed with ``via'' to make
13907 things cleaner. The behavior of these functions is also affected by
13908 commonly understood variables (@pxref{Common Variables}).
13909
13910 @table @code
13911 @item nntp-open-via-rlogin-and-netcat
13912 @findex nntp-open-via-rlogin-and-netcat
13913 Does an @samp{rlogin} on a remote system, and then uses @code{netcat} to connect
13914 to the real @acronym{NNTP} server from there. This is useful for instance if
13915 you need to connect to a firewall machine first.
13916
13917 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13918
13919 @table @code
13920 @item nntp-via-rlogin-command
13921 @vindex nntp-via-rlogin-command
13922 Command used to log in on the intermediate host. The default is
13923 @samp{rsh}, but @samp{ssh} is a popular alternative.
13924
13925 @item nntp-via-rlogin-command-switches
13926 @vindex nntp-via-rlogin-command-switches
13927 List of strings to be used as the switches to
13928 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13929 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13930 @samp{("-C")} in order to compress all data connections.
13931 @end table
13932
13933 @item nntp-open-via-rlogin-and-telnet
13934 @findex nntp-open-via-rlogin-and-telnet
13935 Does essentially the same, but uses @code{telnet} instead of @samp{netcat}
13936 to connect to the real @acronym{NNTP} server from the intermediate host.
13937 @code{telnet} is a bit less robust because of things like
13938 line-end-conversion, but sometimes @code{netcat} is simply not available.
13939
13940 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13941
13942 @table @code
13943 @item nntp-telnet-command
13944 @vindex nntp-telnet-command
13945 Command used to connect to the real @acronym{NNTP} server from the
13946 intermediate host. The default is @samp{telnet}.
13947
13948 @item nntp-telnet-switches
13949 @vindex nntp-telnet-switches
13950 List of strings to be used as the switches to the
13951 @code{nntp-telnet-command} command. The default is @code{("-8")}.
13952
13953 @item nntp-via-rlogin-command
13954 @vindex nntp-via-rlogin-command
13955 Command used to log in on the intermediate host. The default is
13956 @samp{rsh}, but @samp{ssh} is a popular alternative.
13957
13958 @item nntp-via-rlogin-command-switches
13959 @vindex nntp-via-rlogin-command-switches
13960 List of strings to be used as the switches to
13961 @code{nntp-via-rlogin-command}. If you use @samp{ssh}, you may need to set
13962 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13963 the telnet command requires a pseudo-tty allocation on an intermediate
13964 host. The default is @code{nil}.
13965 @end table
13966
13967 Note that you may want to change the value for @code{nntp-end-of-line}
13968 to @samp{\n} (@pxref{Common Variables}).
13969
13970 @item nntp-open-via-telnet-and-telnet
13971 @findex nntp-open-via-telnet-and-telnet
13972 Does essentially the same, but uses @samp{telnet} instead of
13973 @samp{rlogin} to connect to the intermediate host.
13974
13975 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13976
13977 @table @code
13978 @item nntp-via-telnet-command
13979 @vindex nntp-via-telnet-command
13980 Command used to @code{telnet} the intermediate host. The default is
13981 @samp{telnet}.
13982
13983 @item nntp-via-telnet-switches
13984 @vindex nntp-via-telnet-switches
13985 List of strings to be used as the switches to the
13986 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13987
13988 @item nntp-via-user-password
13989 @vindex nntp-via-user-password
13990 Password to use when logging in on the intermediate host.
13991
13992 @item nntp-via-envuser
13993 @vindex nntp-via-envuser
13994 If non-@code{nil}, the intermediate @code{telnet} session (client and
13995 server both) will support the @code{ENVIRON} option and not prompt for
13996 login name. This works for Solaris @code{telnet}, for instance.
13997
13998 @item nntp-via-shell-prompt
13999 @vindex nntp-via-shell-prompt
14000 Regexp matching the shell prompt on the intermediate host. The default
14001 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
14002
14003 @end table
14004
14005 Note that you may want to change the value for @code{nntp-end-of-line}
14006 to @samp{\n} (@pxref{Common Variables}).
14007 @end table
14008
14009
14010 Here are some additional variables that are understood by all the above
14011 functions:
14012
14013 @table @code
14014
14015 @item nntp-via-user-name
14016 @vindex nntp-via-user-name
14017 User name to use when connecting to the intermediate host.
14018
14019 @item nntp-via-address
14020 @vindex nntp-via-address
14021 Address of the intermediate host to connect to.
14022
14023 @end table
14024
14025
14026 @node Common Variables
14027 @subsubsection Common Variables
14028
14029 The following variables affect the behavior of all, or several of the
14030 pre-made connection functions. When not specified, all functions are
14031 affected (the values of the following variables will be used as the
14032 default if each virtual @code{nntp} server doesn't specify those server
14033 variables individually).
14034
14035 @table @code
14036
14037 @item nntp-pre-command
14038 @vindex nntp-pre-command
14039 A command wrapper to use when connecting through a non native
14040 connection function (all except @code{nntp-open-network-stream},
14041 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
14042 where you would put a @samp{SOCKS} wrapper for instance.
14043
14044 @item nntp-address
14045 @vindex nntp-address
14046 The address of the @acronym{NNTP} server.
14047
14048 @item nntp-port-number
14049 @vindex nntp-port-number
14050 Port number to connect to the @acronym{NNTP} server. The default is
14051 @samp{nntp}. If you use @acronym{NNTP} over
14052 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
14053 than named ports (i.e., use @samp{563} instead of @samp{snews} or
14054 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
14055 not work with named ports.
14056
14057 @item nntp-end-of-line
14058 @vindex nntp-end-of-line
14059 String to use as end-of-line marker when talking to the @acronym{NNTP}
14060 server. This is @samp{\r\n} by default, but should be @samp{\n} when
14061 using a non native telnet connection function.
14062
14063 @item nntp-netcat-command
14064 @vindex nntp-netcat-command
14065 Command to use when connecting to the @acronym{NNTP} server through
14066 @samp{netcat}. This is @emph{not} for an intermediate host. This is
14067 just for the real @acronym{NNTP} server. The default is
14068 @samp{nc}.
14069
14070 @item nntp-netcat-switches
14071 @vindex nntp-netcat-switches
14072 A list of switches to pass to @code{nntp-netcat-command}. The default
14073 is @samp{()}.
14074
14075 @end table
14076
14077 @node News Spool
14078 @subsection News Spool
14079 @cindex nnspool
14080 @cindex news spool
14081
14082 Subscribing to a foreign group from the local spool is extremely easy,
14083 and might be useful, for instance, to speed up reading groups that
14084 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
14085 instance.
14086
14087 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
14088 anything else) as the address.
14089
14090 If you have access to a local spool, you should probably use that as the
14091 native select method (@pxref{Finding the News}). It is normally faster
14092 than using an @code{nntp} select method, but might not be. It depends.
14093 You just have to try to find out what's best at your site.
14094
14095 @table @code
14096
14097 @item nnspool-inews-program
14098 @vindex nnspool-inews-program
14099 Program used to post an article.
14100
14101 @item nnspool-inews-switches
14102 @vindex nnspool-inews-switches
14103 Parameters given to the inews program when posting an article.
14104
14105 @item nnspool-spool-directory
14106 @vindex nnspool-spool-directory
14107 Where @code{nnspool} looks for the articles. This is normally
14108 @file{/usr/spool/news/}.
14109
14110 @item nnspool-nov-directory
14111 @vindex nnspool-nov-directory
14112 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
14113 @file{/usr/spool/news/over.view/}.
14114
14115 @item nnspool-lib-dir
14116 @vindex nnspool-lib-dir
14117 Where the news lib dir is (@file{/usr/lib/news/} by default).
14118
14119 @item nnspool-active-file
14120 @vindex nnspool-active-file
14121 The name of the active file.
14122
14123 @item nnspool-newsgroups-file
14124 @vindex nnspool-newsgroups-file
14125 The name of the group descriptions file.
14126
14127 @item nnspool-history-file
14128 @vindex nnspool-history-file
14129 The name of the news history file.
14130
14131 @item nnspool-active-times-file
14132 @vindex nnspool-active-times-file
14133 The name of the active date file.
14134
14135 @item nnspool-nov-is-evil
14136 @vindex nnspool-nov-is-evil
14137 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
14138 that it finds.
14139
14140 @item nnspool-sift-nov-with-sed
14141 @vindex nnspool-sift-nov-with-sed
14142 @cindex sed
14143 If non-@code{nil}, which is the default, use @code{sed} to get the
14144 relevant portion from the overview file. If @code{nil},
14145 @code{nnspool} will load the entire file into a buffer and process it
14146 there.
14147
14148 @end table
14149
14150
14151 @node Using IMAP
14152 @section Using IMAP
14153 @cindex imap
14154
14155 The most popular mail backend is probably @code{nnimap}, which
14156 provides access to @acronym{IMAP} servers. @acronym{IMAP} servers
14157 store mail remotely, so the client doesn't store anything locally.
14158 This means that it's a convenient choice when you're reading your mail
14159 from different locations, or with different user agents.
14160
14161 @menu
14162 * Connecting to an IMAP Server:: Getting started with @acronym{IMAP}.
14163 * Customizing the IMAP Connection:: Variables for @acronym{IMAP} connection.
14164 * Client-Side IMAP Splitting:: Put mail in the correct mail box.
14165 @end menu
14166
14167
14168 @node Connecting to an IMAP Server
14169 @subsection Connecting to an IMAP Server
14170
14171 Connecting to an @acronym{IMAP} can be very easy. Type @kbd{B} in the
14172 group buffer, or (if your primary interest is reading email), say
14173 something like:
14174
14175 @example
14176 (setq gnus-select-method
14177 '(nnimap "imap.gmail.com"))
14178 @end example
14179
14180 You'll be prompted for a user name and password. If you grow tired of
14181 that, then add the following to your @file{~/.authinfo} file:
14182
14183 @example
14184 machine imap.gmail.com login <username> password <password> port imap
14185 @end example
14186
14187 That should basically be it for most users.
14188
14189
14190 @node Customizing the IMAP Connection
14191 @subsection Customizing the IMAP Connection
14192
14193 Here's an example method that's more complex:
14194
14195 @example
14196 (nnimap "imap.gmail.com"
14197 (nnimap-inbox "INBOX")
14198 (nnimap-split-methods default)
14199 (nnimap-expunge t)
14200 (nnimap-stream ssl))
14201 @end example
14202
14203 @table @code
14204 @item nnimap-address
14205 The address of the server, like @samp{imap.gmail.com}.
14206
14207 @item nnimap-server-port
14208 If the server uses a non-standard port, that can be specified here. A
14209 typical port would be @code{"imap"} or @code{"imaps"}.
14210
14211 @item nnimap-stream
14212 How @code{nnimap} should connect to the server. Possible values are:
14213
14214 @table @code
14215 @item undecided
14216 This is the default, and this first tries the @code{ssl} setting, and
14217 then tries the @code{network} setting.
14218
14219 @item ssl
14220 This uses standard @acronym{TLS}/@acronym{SSL} connections.
14221
14222 @item network
14223 Non-encrypted and unsafe straight socket connection, but will upgrade
14224 to encrypted @acronym{STARTTLS} if both Emacs and the server
14225 supports it.
14226
14227 @item starttls
14228 Encrypted @acronym{STARTTLS} over the normal @acronym{IMAP} port.
14229
14230 @item shell
14231 If you need to tunnel via other systems to connect to the server, you
14232 can use this option, and customize @code{nnimap-shell-program} to be
14233 what you need.
14234
14235 @end table
14236
14237 @item nnimap-authenticator
14238 Some @acronym{IMAP} servers allow anonymous logins. In that case,
14239 this should be set to @code{anonymous}. If this variable isn't set,
14240 the normal login methods will be used. If you wish to specify a
14241 specific login method to be used, you can set this variable to either
14242 @code{login} (the traditional @acronym{IMAP} login method),
14243 @code{plain} or @code{cram-md5}.
14244
14245 @item nnimap-expunge
14246 If non-@code{nil}, expunge articles after deleting them. This is always done
14247 if the server supports UID EXPUNGE, but it's not done by default on
14248 servers that doesn't support that command.
14249
14250 @item nnimap-streaming
14251 Virtually all @acronym{IMAP} server support fast streaming of data.
14252 If you have problems connecting to the server, try setting this to
14253 @code{nil}.
14254
14255 @item nnimap-fetch-partial-articles
14256 If non-@code{nil}, fetch partial articles from the server. If set to
14257 a string, then it's interpreted as a regexp, and parts that have
14258 matching types will be fetched. For instance, @samp{"text/"} will
14259 fetch all textual parts, while leaving the rest on the server.
14260
14261 @item nnimap-record-commands
14262 If non-@code{nil}, record all @acronym{IMAP} commands in the
14263 @samp{"*imap log*"} buffer.
14264
14265 @end table
14266
14267
14268 @node Client-Side IMAP Splitting
14269 @subsection Client-Side IMAP Splitting
14270
14271 Many people prefer to do the sorting/splitting of mail into their mail
14272 boxes on the @acronym{IMAP} server. That way they don't have to
14273 download the mail they're not all that interested in.
14274
14275 If you do want to do client-side mail splitting, then the following
14276 variables are relevant:
14277
14278 @table @code
14279 @item nnimap-inbox
14280 This is the @acronym{IMAP} mail box that will be scanned for new
14281 mail. This can also be a list of mail box names.
14282
14283 @item nnimap-split-methods
14284 Uses the same syntax as @code{nnmail-split-methods} (@pxref{Splitting
14285 Mail}), except the symbol @code{default}, which means that it should
14286 use the value of the @code{nnmail-split-methods} variable.
14287
14288 @item nnimap-split-fancy
14289 Uses the same syntax as @code{nnmail-split-fancy}.
14290
14291 @item nnimap-unsplittable-articles
14292 List of flag symbols to ignore when doing splitting. That is,
14293 articles that have these flags won't be considered when splitting.
14294 The default is @samp{(%Deleted %Seen)}.
14295
14296 @end table
14297
14298 Here's a complete example @code{nnimap} backend with a client-side
14299 ``fancy'' splitting method:
14300
14301 @example
14302 (nnimap "imap.example.com"
14303 (nnimap-inbox "INBOX")
14304 (nnimap-split-methods
14305 (| ("MailScanner-SpamCheck" "spam" "spam.detected")
14306 (to "foo@@bar.com" "foo")
14307 "undecided")))
14308 @end example
14309
14310
14311 @node Getting Mail
14312 @section Getting Mail
14313 @cindex reading mail
14314 @cindex mail
14315
14316 Reading mail with a newsreader---isn't that just plain WeIrD@? But of
14317 course.
14318
14319 @menu
14320 * Mail in a Newsreader:: Important introductory notes.
14321 * Getting Started Reading Mail:: A simple cookbook example.
14322 * Splitting Mail:: How to create mail groups.
14323 * Mail Sources:: How to tell Gnus where to get mail from.
14324 * Mail Back End Variables:: Variables for customizing mail handling.
14325 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
14326 * Group Mail Splitting:: Use group customize to drive mail splitting.
14327 * Incorporating Old Mail:: What about the old mail you have?
14328 * Expiring Mail:: Getting rid of unwanted mail.
14329 * Washing Mail:: Removing cruft from the mail you get.
14330 * Duplicates:: Dealing with duplicated mail.
14331 * Not Reading Mail:: Using mail back ends for reading other files.
14332 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
14333 @end menu
14334
14335
14336 @node Mail in a Newsreader
14337 @subsection Mail in a Newsreader
14338
14339 If you are used to traditional mail readers, but have decided to switch
14340 to reading mail with Gnus, you may find yourself experiencing something
14341 of a culture shock.
14342
14343 Gnus does not behave like traditional mail readers. If you want to make
14344 it behave that way, you can, but it's an uphill battle.
14345
14346 Gnus, by default, handles all its groups using the same approach. This
14347 approach is very newsreaderly---you enter a group, see the new/unread
14348 messages, and when you read the messages, they get marked as read, and
14349 you don't see them any more. (Unless you explicitly ask for them.)
14350
14351 In particular, you do not do anything explicitly to delete messages.
14352
14353 Does this mean that all the messages that have been marked as read are
14354 deleted? How awful!
14355
14356 But, no, it means that old messages are @dfn{expired} according to some
14357 scheme or other. For news messages, the expire process is controlled by
14358 the news administrator; for mail, the expire process is controlled by
14359 you. The expire process for mail is covered in depth in @ref{Expiring
14360 Mail}.
14361
14362 What many Gnus users find, after using it a while for both news and
14363 mail, is that the transport mechanism has very little to do with how
14364 they want to treat a message.
14365
14366 Many people subscribe to several mailing lists. These are transported
14367 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
14368 answering, or even reading these messages very carefully. We may not
14369 need to save them because if we should need to read one again, they are
14370 archived somewhere else.
14371
14372 Some people have local news groups which have only a handful of readers.
14373 These are transported via @acronym{NNTP}, and are therefore news. But we may need
14374 to read and answer a large fraction of the messages very carefully in
14375 order to do our work. And there may not be an archive, so we may need
14376 to save the interesting messages the same way we would personal mail.
14377
14378 The important distinction turns out to be not the transport mechanism,
14379 but other factors such as how interested we are in the subject matter,
14380 or how easy it is to retrieve the message if we need to read it again.
14381
14382 Gnus provides many options for sorting mail into ``groups'' which behave
14383 like newsgroups, and for treating each group (whether mail or news)
14384 differently.
14385
14386 Some users never get comfortable using the Gnus (ahem) paradigm and wish
14387 that Gnus should grow up and be a male, er, mail reader. It is possible
14388 to whip Gnus into a more mailreaderly being, but, as said before, it's
14389 not easy. People who prefer proper mail readers should try @sc{vm}
14390 instead, which is an excellent, and proper, mail reader.
14391
14392 I don't mean to scare anybody off, but I want to make it clear that you
14393 may be required to learn a new way of thinking about messages. After
14394 you've been subjected to The Gnus Way, you will come to love it. I can
14395 guarantee it. (At least the guy who sold me the Emacs Subliminal
14396 Brain-Washing Functions that I've put into Gnus did guarantee it. You
14397 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
14398 You Do.)
14399
14400
14401 @node Getting Started Reading Mail
14402 @subsection Getting Started Reading Mail
14403
14404 It's quite easy to use Gnus to read your new mail. You just plonk the
14405 mail back end of your choice into @code{gnus-secondary-select-methods},
14406 and things will happen automatically.
14407
14408 For instance, if you want to use @code{nnml} (which is a ``one file per
14409 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
14410
14411 @lisp
14412 (setq gnus-secondary-select-methods '((nnml "")))
14413 @end lisp
14414
14415 Now, the next time you start Gnus, this back end will be queried for new
14416 articles, and it will move all the messages in your spool file to its
14417 directory, which is @file{~/Mail/} by default. The new group that will
14418 be created (@samp{mail.misc}) will be subscribed, and you can read it
14419 like any other group.
14420
14421 You will probably want to split the mail into several groups, though:
14422
14423 @lisp
14424 (setq nnmail-split-methods
14425 '(("junk" "^From:.*Lars Ingebrigtsen")
14426 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
14427 ("other" "")))
14428 @end lisp
14429
14430 This will result in three new @code{nnml} mail groups being created:
14431 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
14432 mail that doesn't fit into the first two groups will be placed in the
14433 last group.
14434
14435 This should be sufficient for reading mail with Gnus. You might want to
14436 give the other sections in this part of the manual a perusal, though.
14437 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
14438
14439
14440 @node Splitting Mail
14441 @subsection Splitting Mail
14442 @cindex splitting mail
14443 @cindex mail splitting
14444 @cindex mail filtering (splitting)
14445
14446 @vindex nnmail-split-methods
14447 The @code{nnmail-split-methods} variable says how the incoming mail is
14448 to be split into groups.
14449
14450 @lisp
14451 (setq nnmail-split-methods
14452 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
14453 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
14454 ("mail.other" "")))
14455 @end lisp
14456
14457 This variable is a list of lists, where the first element of each of
14458 these lists is the name of the mail group (they do not have to be called
14459 something beginning with @samp{mail}, by the way), and the second
14460 element is a regular expression used on the header of each mail to
14461 determine if it belongs in this mail group. The first string may
14462 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
14463 insert sub-expressions from the matched text. For instance:
14464
14465 @lisp
14466 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
14467 @end lisp
14468
14469 @noindent
14470 In that case, @code{nnmail-split-lowercase-expanded} controls whether
14471 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
14472
14473 The second element can also be a function. In that case, it will be
14474 called narrowed to the headers with the first element of the rule as the
14475 argument. It should return a non-@code{nil} value if it thinks that the
14476 mail belongs in that group.
14477
14478 @cindex @samp{bogus} group
14479 The last of these groups should always be a general one, and the regular
14480 expression should @emph{always} be @samp{""} so that it matches any mails
14481 that haven't been matched by any of the other regexps. (These rules are
14482 processed from the beginning of the alist toward the end. The first rule
14483 to make a match will ``win'', unless you have crossposting enabled. In
14484 that case, all matching rules will ``win''.) If no rule matched, the mail
14485 will end up in the @samp{bogus} group. When new groups are created by
14486 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
14487 see the new groups. This also applies to the @samp{bogus} group.
14488
14489 If you like to tinker with this yourself, you can set this variable to a
14490 function of your choice. This function will be called without any
14491 arguments in a buffer narrowed to the headers of an incoming mail
14492 message. The function should return a list of group names that it
14493 thinks should carry this mail message.
14494
14495 This variable can also be a fancy split method. For the syntax,
14496 see @ref{Fancy Mail Splitting}.
14497
14498 Note that the mail back ends are free to maul the poor, innocent,
14499 incoming headers all they want to. They all add @code{Lines} headers;
14500 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
14501 @code{From<SPACE>} line to something else.
14502
14503 @vindex nnmail-crosspost
14504 The mail back ends all support cross-posting. If several regexps match,
14505 the mail will be ``cross-posted'' to all those groups.
14506 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
14507 that no articles are crossposted to the general (@samp{""}) group.
14508
14509 @vindex nnmail-crosspost-link-function
14510 @cindex crosspost
14511 @cindex links
14512 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
14513 the crossposted articles. However, not all file systems support hard
14514 links. If that's the case for you, set
14515 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
14516 variable is @code{add-name-to-file} by default.)
14517
14518 @kindex M-x nnmail-split-history
14519 @findex nnmail-split-history
14520 If you wish to see where the previous mail split put the messages, you
14521 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
14522 where re-spooling messages would put the messages, you can use
14523 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
14524 Group Commands}).
14525
14526 @vindex nnmail-split-header-length-limit
14527 Header lines longer than the value of
14528 @code{nnmail-split-header-length-limit} are excluded from the split
14529 function.
14530
14531 @vindex nnmail-mail-splitting-decodes
14532 @vindex nnmail-mail-splitting-charset
14533 By default, splitting does not decode headers, so you can not match on
14534 non-@acronym{ASCII} strings. But it is useful if you want to match
14535 articles based on the raw header data. To enable it, set the
14536 @code{nnmail-mail-splitting-decodes} variable to a non-@code{nil} value.
14537 In addition, the value of the @code{nnmail-mail-splitting-charset}
14538 variable is used for decoding non-@acronym{MIME} encoded string when
14539 @code{nnmail-mail-splitting-decodes} is non-@code{nil}. The default
14540 value is @code{nil} which means not to decode non-@acronym{MIME} encoded
14541 string. A suitable value for you will be @code{undecided} or be the
14542 charset used normally in mails you are interested in.
14543
14544 @vindex nnmail-resplit-incoming
14545 By default, splitting is performed on all incoming messages. If you
14546 specify a @code{directory} entry for the variable @code{mail-sources}
14547 (@pxref{Mail Source Specifiers}), however, then splitting does
14548 @emph{not} happen by default. You can set the variable
14549 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
14550 splitting happen even in this case. (This variable has no effect on
14551 other kinds of entries.)
14552
14553 Gnus gives you all the opportunity you could possibly want for shooting
14554 yourself in the foot. Let's say you create a group that will contain
14555 all the mail you get from your boss. And then you accidentally
14556 unsubscribe from the group. Gnus will still put all the mail from your
14557 boss in the unsubscribed group, and so, when your boss mails you ``Have
14558 that report ready by Monday or you're fired!'', you'll never see it and,
14559 come Tuesday, you'll still believe that you're gainfully employed while
14560 you really should be out collecting empty bottles to save up for next
14561 month's rent money.
14562
14563
14564 @node Mail Sources
14565 @subsection Mail Sources
14566
14567 Mail can be gotten from many different sources---the mail spool, from
14568 a @acronym{POP} mail server, from a procmail directory, or from a
14569 maildir, for instance.
14570
14571 @menu
14572 * Mail Source Specifiers:: How to specify what a mail source is.
14573 * Mail Source Functions::
14574 * Mail Source Customization:: Some variables that influence things.
14575 * Fetching Mail:: Using the mail source specifiers.
14576 @end menu
14577
14578
14579 @node Mail Source Specifiers
14580 @subsubsection Mail Source Specifiers
14581 @cindex POP
14582 @cindex mail server
14583 @cindex procmail
14584 @cindex mail spool
14585 @cindex mail source
14586
14587 You tell Gnus how to fetch mail by setting @code{mail-sources}
14588 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
14589
14590 Here's an example:
14591
14592 @lisp
14593 (pop :server "pop3.mailserver.com" :user "myname")
14594 @end lisp
14595
14596 As can be observed, a mail source specifier is a list where the first
14597 element is a @dfn{mail source type}, followed by an arbitrary number of
14598 @dfn{keywords}. Keywords that are not explicitly specified are given
14599 default values.
14600
14601 The @code{mail-sources} is global for all mail groups. You can specify
14602 an additional mail source for a particular group by including the
14603 @code{group} mail specifier in @code{mail-sources}, and setting a
14604 @code{mail-source} group parameter (@pxref{Group Parameters}) specifying
14605 a single mail source. When this is used, @code{mail-sources} is
14606 typically just @code{(group)}; the @code{mail-source} parameter for a
14607 group might look like this:
14608
14609 @lisp
14610 (mail-source . (file :path "home/user/spools/foo.spool"))
14611 @end lisp
14612
14613 This means that the group's (and only this group's) messages will be
14614 fetched from the spool file @samp{/user/spools/foo.spool}.
14615
14616 The following mail source types are available:
14617
14618 @table @code
14619 @item file
14620 Get mail from a single file; typically from the mail spool.
14621
14622 Keywords:
14623
14624 @table @code
14625 @item :path
14626 The file name. Defaults to the value of the @env{MAIL}
14627 environment variable or the value of @code{rmail-spool-directory}
14628 (usually something like @file{/usr/mail/spool/user-name}).
14629
14630 @item :prescript
14631 @itemx :postscript
14632 Script run before/after fetching mail.
14633 @end table
14634
14635 An example file mail source:
14636
14637 @lisp
14638 (file :path "/usr/spool/mail/user-name")
14639 @end lisp
14640
14641 Or using the default file name:
14642
14643 @lisp
14644 (file)
14645 @end lisp
14646
14647 If the mail spool file is not located on the local machine, it's best
14648 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
14649 You can not use ange-ftp file names here---it has no way to lock the
14650 mail spool while moving the mail.
14651
14652 If it's impossible to set up a proper server, you can use ssh instead.
14653
14654 @lisp
14655 (setq mail-sources
14656 '((file :prescript "ssh host bin/getmail >%t")))
14657 @end lisp
14658
14659 The @samp{getmail} script would look something like the following:
14660
14661 @example
14662 #!/bin/sh
14663 # getmail - move mail from spool to stdout
14664 # flu@@iki.fi
14665
14666 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
14667 TMP=$HOME/Mail/tmp
14668 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
14669 @end example
14670
14671 Alter this script to fit the @samp{movemail} and temporary
14672 file you want to use.
14673
14674
14675 @item directory
14676 @vindex nnmail-scan-directory-mail-source-once
14677 Get mail from several files in a directory. This is typically used
14678 when you have procmail split the incoming mail into several files.
14679 That is, there is a one-to-one correspondence between files in that
14680 directory and groups, so that mail from the file @file{foo.bar.spool}
14681 will be put in the group @code{foo.bar}. (You can change the suffix
14682 to be used instead of @code{.spool}.) Setting
14683 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
14684 Gnus to scan the mail source only once. This is particularly useful
14685 if you want to scan mail groups at a specified level.
14686
14687 @vindex nnmail-resplit-incoming
14688 There is also the variable @code{nnmail-resplit-incoming}, if you set
14689 that to a non-@code{nil} value, then the normal splitting process is
14690 applied to all the files from the directory, @ref{Splitting Mail}.
14691
14692 Keywords:
14693
14694 @table @code
14695 @item :path
14696 The name of the directory where the files are. There is no default
14697 value.
14698
14699 @item :suffix
14700 Only files ending with this suffix are used. The default is
14701 @samp{.spool}.
14702
14703 @item :predicate
14704 Only files that have this predicate return non-@code{nil} are returned.
14705 The default is @code{identity}. This is used as an additional
14706 filter---only files that have the right suffix @emph{and} satisfy this
14707 predicate are considered.
14708
14709 @item :prescript
14710 @itemx :postscript
14711 Script run before/after fetching mail.
14712
14713 @end table
14714
14715 An example directory mail source:
14716
14717 @lisp
14718 (directory :path "/home/user-name/procmail-dir/"
14719 :suffix ".prcml")
14720 @end lisp
14721
14722 @item pop
14723 Get mail from a @acronym{POP} server.
14724
14725 Keywords:
14726
14727 @table @code
14728 @item :server
14729 The name of the @acronym{POP} server. The default is taken from the
14730 @env{MAILHOST} environment variable.
14731
14732 @item :port
14733 The port number of the @acronym{POP} server. This can be a number (e.g.,
14734 @samp{:port 1234}) or a string (e.g., @samp{:port "pop3"}). If it is a
14735 string, it should be a service name as listed in @file{/etc/services} on
14736 Unix systems. The default is @samp{"pop3"}. On some systems you might
14737 need to specify it as @samp{"pop-3"} instead.
14738
14739 @item :user
14740 The user name to give to the @acronym{POP} server. The default is the login
14741 name.
14742
14743 @item :password
14744 The password to give to the @acronym{POP} server. If not specified,
14745 the user is prompted.
14746
14747 @item :program
14748 The program to use to fetch mail from the @acronym{POP} server. This
14749 should be a @code{format}-like string. Here's an example:
14750
14751 @example
14752 fetchmail %u@@%s -P %p %t
14753 @end example
14754
14755 The valid format specifier characters are:
14756
14757 @table @samp
14758 @item t
14759 The name of the file the mail is to be moved to. This must always be
14760 included in this string.
14761
14762 @item s
14763 The name of the server.
14764
14765 @item P
14766 The port number of the server.
14767
14768 @item u
14769 The user name to use.
14770
14771 @item p
14772 The password to use.
14773 @end table
14774
14775 The values used for these specs are taken from the values you give the
14776 corresponding keywords.
14777
14778 @item :prescript
14779 A script to be run before fetching the mail. The syntax is the same as
14780 the @code{:program} keyword. This can also be a function to be run.
14781
14782 One popular way to use this is to set up an SSH tunnel to access the
14783 @acronym{POP} server. Here's an example:
14784
14785 @lisp
14786 (pop :server "127.0.0.1"
14787 :port 1234
14788 :user "foo"
14789 :password "secret"
14790 :prescript
14791 "nohup ssh -f -L 1234:pop.server:110 remote.host sleep 3600 &")
14792 @end lisp
14793
14794 @item :postscript
14795 A script to be run after fetching the mail. The syntax is the same as
14796 the @code{:program} keyword. This can also be a function to be run.
14797
14798 @item :function
14799 The function to use to fetch mail from the @acronym{POP} server. The
14800 function is called with one parameter---the name of the file where the
14801 mail should be moved to.
14802
14803 @item :authentication
14804 This can be either the symbol @code{password} or the symbol @code{apop}
14805 and says what authentication scheme to use. The default is
14806 @code{password}.
14807
14808 @item :leave
14809 Non-@code{nil} if the mail is to be left on the @acronym{POP} server
14810 after fetching. Only the built-in @code{pop3-movemail} program (the
14811 default) supports this keyword.
14812
14813 If this is a number, leave mails on the server for this many days since
14814 you first checked new mails. In that case, mails once fetched will
14815 never be fetched again by the @acronym{UIDL} control. If this is
14816 @code{nil} (the default), mails will be deleted on the server right
14817 after fetching. If this is neither @code{nil} nor a number, all mails
14818 will be left on the server, and you will end up getting the same mails
14819 again and again.
14820
14821 @vindex pop3-uidl-file
14822 The @code{pop3-uidl-file} variable specifies the file to which the
14823 @acronym{UIDL} data are locally stored. The default value is
14824 @file{~/.pop3-uidl}.
14825
14826 Note that @acronym{POP} servers maintain no state information between
14827 sessions, so what the client believes is there and what is actually
14828 there may not match up. If they do not, then you may get duplicate
14829 mails or the whole thing can fall apart and leave you with a corrupt
14830 mailbox.
14831
14832 @end table
14833
14834 @findex pop3-movemail
14835 @vindex pop3-leave-mail-on-server
14836 If the @code{:program} and @code{:function} keywords aren't specified,
14837 @code{pop3-movemail} will be used.
14838
14839 Here are some examples for getting mail from a @acronym{POP} server.
14840
14841 Fetch from the default @acronym{POP} server, using the default user
14842 name, and default fetcher:
14843
14844 @lisp
14845 (pop)
14846 @end lisp
14847
14848 Fetch from a named server with a named user and password:
14849
14850 @lisp
14851 (pop :server "my.pop.server"
14852 :user "user-name" :password "secret")
14853 @end lisp
14854
14855 Leave mails on the server for 14 days:
14856
14857 @lisp
14858 (pop :server "my.pop.server"
14859 :user "user-name" :password "secret"
14860 :leave 14)
14861 @end lisp
14862
14863 Use @samp{movemail} to move the mail:
14864
14865 @lisp
14866 (pop :program "movemail po:%u %t %p")
14867 @end lisp
14868
14869 @item maildir
14870 Get mail from a maildir. This is a type of mailbox that is supported by
14871 at least qmail and postfix, where each file in a special directory
14872 contains exactly one mail.
14873
14874 Keywords:
14875
14876 @table @code
14877 @item :path
14878 The name of the directory where the mails are stored. The default is
14879 taken from the @env{MAILDIR} environment variable or
14880 @file{~/Maildir/}.
14881 @item :subdirs
14882 The subdirectories of the Maildir. The default is
14883 @samp{("new" "cur")}.
14884
14885 @c If you sometimes look at your mail through a pop3 daemon before fetching
14886 @c them with Gnus, you may also have to fetch your mails from the
14887 @c @code{cur} directory inside the maildir, like in the first example
14888 @c below.
14889
14890 You can also get mails from remote hosts (because maildirs don't suffer
14891 from locking problems).
14892
14893 @end table
14894
14895 Two example maildir mail sources:
14896
14897 @lisp
14898 (maildir :path "/home/user-name/Maildir/"
14899 :subdirs ("cur" "new"))
14900 @end lisp
14901
14902 @lisp
14903 (maildir :path "/user@@remotehost.org:~/Maildir/"
14904 :subdirs ("new"))
14905 @end lisp
14906
14907 @item imap
14908 Get mail from a @acronym{IMAP} server. If you don't want to use
14909 @acronym{IMAP} as intended, as a network mail reading protocol (i.e.,
14910 with nnimap), for some reason or other, Gnus let you treat it similar
14911 to a @acronym{POP} server and fetches articles from a given
14912 @acronym{IMAP} mailbox. @xref{Using IMAP}, for more information.
14913
14914 Keywords:
14915
14916 @table @code
14917 @item :server
14918 The name of the @acronym{IMAP} server. The default is taken from the
14919 @env{MAILHOST} environment variable.
14920
14921 @item :port
14922 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
14923 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
14924
14925 @item :user
14926 The user name to give to the @acronym{IMAP} server. The default is the login
14927 name.
14928
14929 @item :password
14930 The password to give to the @acronym{IMAP} server. If not specified, the user is
14931 prompted.
14932
14933 @item :stream
14934 What stream to use for connecting to the server, this is one of the
14935 symbols in @code{imap-stream-alist}. Right now, this means
14936 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
14937 @samp{ssl}, @samp{shell} or the default @samp{network}.
14938
14939 @item :authentication
14940 Which authenticator to use for authenticating to the server, this is
14941 one of the symbols in @code{imap-authenticator-alist}. Right now,
14942 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
14943 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
14944
14945 @item :program
14946 When using the `shell' :stream, the contents of this variable is
14947 mapped into the @code{imap-shell-program} variable. This should be a
14948 @code{format}-like string (or list of strings). Here's an example:
14949
14950 @example
14951 ssh %s imapd
14952 @end example
14953
14954 Make sure nothing is interfering with the output of the program, e.g.,
14955 don't forget to redirect the error output to the void. The valid format
14956 specifier characters are:
14957
14958 @table @samp
14959 @item s
14960 The name of the server.
14961
14962 @item l
14963 User name from @code{imap-default-user}.
14964
14965 @item p
14966 The port number of the server.
14967 @end table
14968
14969 The values used for these specs are taken from the values you give the
14970 corresponding keywords.
14971
14972 @item :mailbox
14973 The name of the mailbox to get mail from. The default is @samp{INBOX}
14974 which normally is the mailbox which receives incoming mail.
14975
14976 @item :predicate
14977 The predicate used to find articles to fetch. The default, @samp{UNSEEN
14978 UNDELETED}, is probably the best choice for most people, but if you
14979 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
14980 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
14981 Then all articles in the mailbox is fetched, no matter what. For a
14982 complete list of predicates, see RFC 2060 section 6.4.4.
14983
14984 @item :fetchflag
14985 How to flag fetched articles on the server, the default @samp{\Deleted}
14986 will mark them as deleted, an alternative would be @samp{\Seen} which
14987 would simply mark them as read. These are the two most likely choices,
14988 but more flags are defined in RFC 2060 section 2.3.2.
14989
14990 @item :dontexpunge
14991 If non-@code{nil}, don't remove all articles marked as deleted in the
14992 mailbox after finishing the fetch.
14993
14994 @end table
14995
14996 An example @acronym{IMAP} mail source:
14997
14998 @lisp
14999 (imap :server "mail.mycorp.com"
15000 :stream kerberos4
15001 :fetchflag "\\Seen")
15002 @end lisp
15003
15004 @item group
15005 Get the actual mail source from the @code{mail-source} group parameter,
15006 @xref{Group Parameters}.
15007
15008 @end table
15009
15010 @table @dfn
15011 @item Common Keywords
15012 Common keywords can be used in any type of mail source.
15013
15014 Keywords:
15015
15016 @table @code
15017 @item :plugged
15018 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
15019 use directory source to get mail, you can specify it as in this
15020 example:
15021
15022 @lisp
15023 (setq mail-sources
15024 '((directory :path "/home/pavel/.Spool/"
15025 :suffix ""
15026 :plugged t)))
15027 @end lisp
15028
15029 Gnus will then fetch your mail even when you are unplugged. This is
15030 useful when you use local mail and news.
15031
15032 @end table
15033 @end table
15034
15035 @node Mail Source Functions
15036 @subsubsection Function Interface
15037
15038 Some of the above keywords specify a Lisp function to be executed.
15039 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
15040 the value of the keyword while the function is executing. For example,
15041 consider the following mail-source setting:
15042
15043 @lisp
15044 (setq mail-sources '((pop :user "jrl"
15045 :server "pophost" :function fetchfunc)))
15046 @end lisp
15047
15048 While the function @code{fetchfunc} is executing, the symbol @code{user}
15049 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
15050 @code{"pophost"}. The symbols @code{port}, @code{password},
15051 @code{program}, @code{prescript}, @code{postscript}, @code{function},
15052 and @code{authentication} are also bound (to their default values).
15053
15054 See above for a list of keywords for each type of mail source.
15055
15056
15057 @node Mail Source Customization
15058 @subsubsection Mail Source Customization
15059
15060 The following is a list of variables that influence how the mail is
15061 fetched. You would normally not need to set or change any of these
15062 variables.
15063
15064 @table @code
15065 @item mail-source-crash-box
15066 @vindex mail-source-crash-box
15067 File where mail will be stored while processing it. The default is@*
15068 @file{~/.emacs-mail-crash-box}.
15069
15070 @cindex Incoming*
15071 @item mail-source-delete-incoming
15072 @vindex mail-source-delete-incoming
15073 If non-@code{nil}, delete incoming files after handling them. If
15074 @code{t}, delete the files immediately, if @code{nil}, never delete any
15075 files. If a positive number, delete files older than number of days
15076 (the deletion will only happen when receiving new mail). You may also
15077 set @code{mail-source-delete-incoming} to @code{nil} and call
15078 @code{mail-source-delete-old-incoming} from a hook or interactively.
15079 @code{mail-source-delete-incoming} defaults to @code{10} in alpha Gnusae
15080 and @code{2} in released Gnusae. @xref{Gnus Development}.
15081
15082 @item mail-source-delete-old-incoming-confirm
15083 @vindex mail-source-delete-old-incoming-confirm
15084 If non-@code{nil}, ask for confirmation before deleting old incoming
15085 files. This variable only applies when
15086 @code{mail-source-delete-incoming} is a positive number.
15087
15088 @item mail-source-ignore-errors
15089 @vindex mail-source-ignore-errors
15090 If non-@code{nil}, ignore errors when reading mail from a mail source.
15091
15092 @item mail-source-directory
15093 @vindex mail-source-directory
15094 Directory where incoming mail source files (if any) will be stored. The
15095 default is @file{~/Mail/}. At present, the only thing this is used for
15096 is to say where the incoming files will be stored if the variable
15097 @code{mail-source-delete-incoming} is @code{nil} or a number.
15098
15099 @item mail-source-incoming-file-prefix
15100 @vindex mail-source-incoming-file-prefix
15101 Prefix for file name for storing incoming mail. The default is
15102 @file{Incoming}, in which case files will end up with names like
15103 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
15104 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
15105 number.
15106
15107 @item mail-source-default-file-modes
15108 @vindex mail-source-default-file-modes
15109 All new mail files will get this file mode. The default is @code{#o600}.
15110
15111 @item mail-source-movemail-program
15112 @vindex mail-source-movemail-program
15113 If non-@code{nil}, name of program for fetching new mail. If
15114 @code{nil}, @code{movemail} in @var{exec-directory}.
15115
15116 @end table
15117
15118
15119 @node Fetching Mail
15120 @subsubsection Fetching Mail
15121
15122 @vindex mail-sources
15123 The way to actually tell Gnus where to get new mail from is to set
15124 @code{mail-sources} to a list of mail source specifiers
15125 (@pxref{Mail Source Specifiers}).
15126
15127 If this variable is @code{nil}, the mail back ends will never attempt to
15128 fetch mail by themselves.
15129
15130 If you want to fetch mail both from your local spool as well as a
15131 @acronym{POP} mail server, you'd say something like:
15132
15133 @lisp
15134 (setq mail-sources
15135 '((file)
15136 (pop :server "pop3.mail.server"
15137 :password "secret")))
15138 @end lisp
15139
15140 Or, if you don't want to use any of the keyword defaults:
15141
15142 @lisp
15143 (setq mail-sources
15144 '((file :path "/var/spool/mail/user-name")
15145 (pop :server "pop3.mail.server"
15146 :user "user-name"
15147 :port "pop3"
15148 :password "secret")))
15149 @end lisp
15150
15151
15152 When you use a mail back end, Gnus will slurp all your mail from your
15153 inbox and plonk it down in your home directory. Gnus doesn't move any
15154 mail if you're not using a mail back end---you have to do a lot of magic
15155 invocations first. At the time when you have finished drawing the
15156 pentagram, lightened the candles, and sacrificed the goat, you really
15157 shouldn't be too surprised when Gnus moves your mail.
15158
15159
15160
15161 @node Mail Back End Variables
15162 @subsection Mail Back End Variables
15163
15164 These variables are (for the most part) pertinent to all the various
15165 mail back ends.
15166
15167 @table @code
15168 @vindex nnmail-read-incoming-hook
15169 @item nnmail-read-incoming-hook
15170 The mail back ends all call this hook after reading new mail. You can
15171 use this hook to notify any mail watch programs, if you want to.
15172
15173 @vindex nnmail-split-hook
15174 @item nnmail-split-hook
15175 @findex gnus-article-decode-encoded-words
15176 @cindex RFC 1522 decoding
15177 @cindex RFC 2047 decoding
15178 Hook run in the buffer where the mail headers of each message is kept
15179 just before the splitting based on these headers is done. The hook is
15180 free to modify the buffer contents in any way it sees fit---the buffer
15181 is discarded after the splitting has been done, and no changes performed
15182 in the buffer will show up in any files.
15183 @code{gnus-article-decode-encoded-words} is one likely function to add
15184 to this hook.
15185
15186 @vindex nnmail-pre-get-new-mail-hook
15187 @vindex nnmail-post-get-new-mail-hook
15188 @item nnmail-pre-get-new-mail-hook
15189 @itemx nnmail-post-get-new-mail-hook
15190 These are two useful hooks executed when treating new incoming
15191 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
15192 starting to handle the new mail) and
15193 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
15194 is done). Here's and example of using these two hooks to change the
15195 default file modes the new mail files get:
15196
15197 @lisp
15198 (add-hook 'nnmail-pre-get-new-mail-hook
15199 (lambda () (set-default-file-modes #o700)))
15200
15201 (add-hook 'nnmail-post-get-new-mail-hook
15202 (lambda () (set-default-file-modes #o775)))
15203 @end lisp
15204
15205 @item nnmail-use-long-file-names
15206 @vindex nnmail-use-long-file-names
15207 If non-@code{nil}, the mail back ends will use long file and directory
15208 names. Groups like @samp{mail.misc} will end up in directories
15209 (assuming use of @code{nnml} back end) or files (assuming use of
15210 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
15211 the same group will end up in @file{mail/misc}.
15212
15213 @item nnmail-delete-file-function
15214 @vindex nnmail-delete-file-function
15215 @findex delete-file
15216 Function called to delete files. It is @code{delete-file} by default.
15217
15218 @item nnmail-cache-accepted-message-ids
15219 @vindex nnmail-cache-accepted-message-ids
15220 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
15221 the back end (via @code{Gcc}, for instance) into the mail duplication
15222 discovery cache. The default is @code{nil}.
15223
15224 @item nnmail-cache-ignore-groups
15225 @vindex nnmail-cache-ignore-groups
15226 This can be a regular expression or a list of regular expressions.
15227 Group names that match any of the regular expressions will never be
15228 recorded in the @code{Message-ID} cache.
15229
15230 This can be useful, for example, when using Fancy Splitting
15231 (@pxref{Fancy Mail Splitting}) together with the function
15232 @code{nnmail-split-fancy-with-parent}.
15233
15234 @end table
15235
15236
15237 @node Fancy Mail Splitting
15238 @subsection Fancy Mail Splitting
15239 @cindex mail splitting
15240 @cindex fancy mail splitting
15241
15242 @vindex nnmail-split-fancy
15243 @findex nnmail-split-fancy
15244 If the rather simple, standard method for specifying how to split mail
15245 doesn't allow you to do what you want, you can set
15246 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
15247 play with the @code{nnmail-split-fancy} variable.
15248
15249 Let's look at an example value of this variable first:
15250
15251 @lisp
15252 ;; @r{Messages from the mailer daemon are not crossposted to any of}
15253 ;; @r{the ordinary groups. Warnings are put in a separate group}
15254 ;; @r{from real errors.}
15255 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
15256 "mail.misc"))
15257 ;; @r{Non-error messages are crossposted to all relevant}
15258 ;; @r{groups, but we don't crosspost between the group for the}
15259 ;; @r{(ding) list and the group for other (ding) related mail.}
15260 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
15261 ("subject" "ding" "ding.misc"))
15262 ;; @r{Other mailing lists@dots{}}
15263 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
15264 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
15265 ;; @r{Both lists below have the same suffix, so prevent}
15266 ;; @r{cross-posting to mkpkg.list of messages posted only to}
15267 ;; @r{the bugs- list, but allow cross-posting when the}
15268 ;; @r{message was really cross-posted.}
15269 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
15270 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
15271 ;; @r{People@dots{}}
15272 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
15273 ;; @r{Unmatched mail goes to the catch all group.}
15274 "misc.misc")
15275 @end lisp
15276
15277 This variable has the format of a @dfn{split}. A split is a
15278 (possibly) recursive structure where each split may contain other
15279 splits. Here are the possible split syntaxes:
15280
15281 @table @code
15282
15283 @item group
15284 If the split is a string, that will be taken as a group name. Normal
15285 regexp match expansion will be done. See below for examples.
15286
15287 @c Don't fold this line.
15288 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
15289 The split can be a list containing at least three elements. If the
15290 first element @var{field} (a regexp matching a header) contains
15291 @var{value} (also a regexp) then store the message as specified by
15292 @var{split}.
15293
15294 If @var{restrict} (yet another regexp) matches some string after
15295 @var{field} and before the end of the matched @var{value}, the
15296 @var{split} is ignored. If none of the @var{restrict} clauses match,
15297 @var{split} is processed.
15298
15299 The last element @var{invert-partial} is optional. If it is
15300 non-@code{nil}, the match-partial-words behavior controlled by the
15301 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
15302 be inverted. (New in Gnus 5.10.7)
15303
15304 @item (| @var{split} @dots{})
15305 If the split is a list, and the first element is @code{|} (vertical
15306 bar), then process each @var{split} until one of them matches. A
15307 @var{split} is said to match if it will cause the mail message to be
15308 stored in one or more groups.
15309
15310 @item (& @var{split} @dots{})
15311 If the split is a list, and the first element is @code{&}, then
15312 process all @var{split}s in the list.
15313
15314 @item junk
15315 If the split is the symbol @code{junk}, then don't save (i.e., delete)
15316 this message. Use with extreme caution.
15317
15318 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
15319 If the split is a list, and the first element is @samp{:}, then the
15320 second element will be called as a function with @var{args} given as
15321 arguments. The function should return a @var{split}.
15322
15323 @cindex body split
15324 For instance, the following function could be used to split based on the
15325 body of the messages:
15326
15327 @lisp
15328 (defun split-on-body ()
15329 (save-excursion
15330 (save-restriction
15331 (widen)
15332 (goto-char (point-min))
15333 (when (re-search-forward "Some.*string" nil t)
15334 "string.group"))))
15335 @end lisp
15336
15337 The buffer is narrowed to the header of the message in question when
15338 @var{function} is run. That's why @code{(widen)} needs to be called
15339 after @code{save-excursion} and @code{save-restriction} in the example
15340 above. Also note that with the nnimap backend, message bodies will
15341 not be downloaded by default. You need to set
15342 @code{nnimap-split-download-body} to @code{t} to do that
15343 (@pxref{Client-Side IMAP Splitting}).
15344
15345 @item (! @var{func} @var{split})
15346 If the split is a list, and the first element is @code{!}, then
15347 @var{split} will be processed, and @var{func} will be called as a
15348 function with the result of @var{split} as argument. @var{func}
15349 should return a split.
15350
15351 @item nil
15352 If the split is @code{nil}, it is ignored.
15353
15354 @end table
15355
15356 In these splits, @var{field} must match a complete field name.
15357
15358 Normally, @var{value} in these splits must match a complete @emph{word}
15359 according to the fundamental mode syntax table. In other words, all
15360 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
15361 which are word delimiters. Therefore, if you use the following split,
15362 for example,
15363
15364 @example
15365 (any "joe" "joemail")
15366 @end example
15367
15368 @noindent
15369 messages sent from @samp{joedavis@@foo.org} will normally not be filed
15370 in @samp{joemail}. If you want to alter this behavior, you can use any
15371 of the following three ways:
15372
15373 @enumerate
15374 @item
15375 @vindex nnmail-split-fancy-match-partial-words
15376 You can set the @code{nnmail-split-fancy-match-partial-words} variable
15377 to non-@code{nil} in order to ignore word boundaries and instead the
15378 match becomes more like a grep. This variable controls whether partial
15379 words are matched during fancy splitting. The default value is
15380 @code{nil}.
15381
15382 Note that it influences all @var{value}'s in your split rules.
15383
15384 @item
15385 @var{value} beginning with @code{.*} ignores word boundaries in front of
15386 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
15387 in the rear of a word will be ignored. For example, the @var{value}
15388 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
15389 @code{".*@@example\\.com"} does.
15390
15391 @item
15392 You can set the @var{invert-partial} flag in your split rules of the
15393 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
15394 section. If the flag is set, word boundaries on both sides of a word
15395 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
15396 @code{nil}. Contrarily, if the flag is set, word boundaries are not
15397 ignored even if @code{nnmail-split-fancy-match-partial-words} is
15398 non-@code{nil}. (New in Gnus 5.10.7)
15399 @end enumerate
15400
15401 @vindex nnmail-split-abbrev-alist
15402 @var{field} and @var{value} can also be Lisp symbols, in that case
15403 they are expanded as specified by the variable
15404 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
15405 where the @sc{car} of a cell contains the key, and the @sc{cdr}
15406 contains the associated value. Predefined entries in
15407 @code{nnmail-split-abbrev-alist} include:
15408
15409 @table @code
15410 @item from
15411 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
15412 @item to
15413 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
15414 @samp{Resent-To} and @samp{Resent-Cc} fields.
15415 @item any
15416 Is the union of the @code{from} and @code{to} entries.
15417 @end table
15418
15419 @vindex nnmail-split-fancy-syntax-table
15420 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
15421 when all this splitting is performed.
15422
15423 If you want to have Gnus create groups dynamically based on some
15424 information in the headers (i.e., do @code{replace-match}-like
15425 substitutions in the group names), you can say things like:
15426
15427 @example
15428 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
15429 @end example
15430
15431 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
15432 will be filed in @samp{mail.debian.foo}.
15433
15434 If the string contains the element @samp{\\&}, then the previously
15435 matched string will be substituted. Similarly, the elements @samp{\\1}
15436 up to @samp{\\9} will be substituted with the text matched by the
15437 groupings 1 through 9.
15438
15439 @vindex nnmail-split-lowercase-expanded
15440 Where @code{nnmail-split-lowercase-expanded} controls whether the
15441 lowercase of the matched string should be used for the substitution.
15442 Setting it as non-@code{nil} is useful to avoid the creation of multiple
15443 groups when users send to an address using different case
15444 (i.e., mailing-list@@domain vs Mailing-List@@Domain). The default value
15445 is @code{t}.
15446
15447 @findex nnmail-split-fancy-with-parent
15448 @code{nnmail-split-fancy-with-parent} is a function which allows you to
15449 split followups into the same groups their parents are in. Sometimes
15450 you can't make splitting rules for all your mail. For example, your
15451 boss might send you personal mail regarding different projects you are
15452 working on, and as you can't tell your boss to put a distinguishing
15453 string into the subject line, you have to resort to manually moving the
15454 messages into the right group. With this function, you only have to do
15455 it once per thread.
15456
15457 To use this feature, you have to set @code{nnmail-treat-duplicates}
15458 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
15459 value. And then you can include @code{nnmail-split-fancy-with-parent}
15460 using the colon feature, like so:
15461 @lisp
15462 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
15463 nnmail-cache-accepted-message-ids t
15464 nnmail-split-fancy
15465 '(| (: nnmail-split-fancy-with-parent)
15466 ;; @r{other splits go here}
15467 ))
15468 @end lisp
15469
15470 This feature works as follows: when @code{nnmail-treat-duplicates} is
15471 non-@code{nil}, Gnus records the message id of every message it sees
15472 in the file specified by the variable
15473 @code{nnmail-message-id-cache-file}, together with the group it is in
15474 (the group is omitted for non-mail messages). When mail splitting is
15475 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
15476 at the References (and In-Reply-To) header of each message to split
15477 and searches the file specified by @code{nnmail-message-id-cache-file}
15478 for the message ids. When it has found a parent, it returns the
15479 corresponding group name unless the group name matches the regexp
15480 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
15481 recommended that you set @code{nnmail-message-id-cache-length} to a
15482 somewhat higher number than the default so that the message ids are
15483 still in the cache. (A value of 5000 appears to create a file some
15484 300 kBytes in size.)
15485 @vindex nnmail-cache-accepted-message-ids
15486 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
15487 also records the message ids of moved articles, so that the followup
15488 messages goes into the new group.
15489
15490 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
15491 want certain groups to be recorded in the cache. For example, if all
15492 outgoing messages are written to an ``outgoing'' group, you could set
15493 @code{nnmail-cache-ignore-groups} to match that group name.
15494 Otherwise, answers to all your messages would end up in the
15495 ``outgoing'' group.
15496
15497
15498 @node Group Mail Splitting
15499 @subsection Group Mail Splitting
15500 @cindex mail splitting
15501 @cindex group mail splitting
15502
15503 @findex gnus-group-split
15504 If you subscribe to dozens of mailing lists but you don't want to
15505 maintain mail splitting rules manually, group mail splitting is for you.
15506 You just have to set @code{to-list} and/or @code{to-address} in group
15507 parameters or group customization and set @code{nnmail-split-methods} to
15508 @code{gnus-group-split}. This splitting function will scan all groups
15509 for those parameters and split mail accordingly, i.e., messages posted
15510 from or to the addresses specified in the parameters @code{to-list} or
15511 @code{to-address} of a mail group will be stored in that group.
15512
15513 Sometimes, mailing lists have multiple addresses, and you may want mail
15514 splitting to recognize them all: just set the @code{extra-aliases} group
15515 parameter to the list of additional addresses and it's done. If you'd
15516 rather use a regular expression, set @code{split-regexp}.
15517
15518 All these parameters in a group will be used to create an
15519 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
15520 the @var{value} is a single regular expression that matches
15521 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
15522 matches of @code{split-regexp}, and the @var{split} is the name of the
15523 group. @var{restrict}s are also supported: just set the
15524 @code{split-exclude} parameter to a list of regular expressions.
15525
15526 If you can't get the right split to be generated using all these
15527 parameters, or you just need something fancier, you can set the
15528 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
15529 this case, all other aforementioned parameters will be ignored by
15530 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
15531 @code{nil}, in which case the group will be ignored by
15532 @code{gnus-group-split}.
15533
15534 @vindex gnus-group-split-default-catch-all-group
15535 @code{gnus-group-split} will do cross-posting on all groups that match,
15536 by defining a single @code{&} fancy split containing one split for each
15537 group. If a message doesn't match any split, it will be stored in the
15538 group named in @code{gnus-group-split-default-catch-all-group}, unless
15539 some group has @code{split-spec} set to @code{catch-all}, in which case
15540 that group is used as the catch-all group. Even though this variable is
15541 often used just to name a group, it may also be set to an arbitrarily
15542 complex fancy split (after all, a group name is a fancy split), and this
15543 may be useful to split mail that doesn't go to any mailing list to
15544 personal mail folders. Note that this fancy split is added as the last
15545 element of a @code{|} split list that also contains a @code{&} split
15546 with the rules extracted from group parameters.
15547
15548 It's time for an example. Assume the following group parameters have
15549 been defined:
15550
15551 @example
15552 nnml:mail.bar:
15553 ((to-address . "bar@@femail.com")
15554 (split-regexp . ".*@@femail\\.com"))
15555 nnml:mail.foo:
15556 ((to-list . "foo@@nowhere.gov")
15557 (extra-aliases "foo@@localhost" "foo-redist@@home")
15558 (split-exclude "bugs-foo" "rambling-foo")
15559 (admin-address . "foo-request@@nowhere.gov"))
15560 nnml:mail.others:
15561 ((split-spec . catch-all))
15562 @end example
15563
15564 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
15565 behave as if @code{nnmail-split-fancy} had been selected and variable
15566 @code{nnmail-split-fancy} had been set as follows:
15567
15568 @lisp
15569 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
15570 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
15571 - "bugs-foo" - "rambling-foo" "mail.foo"))
15572 "mail.others")
15573 @end lisp
15574
15575 @findex gnus-group-split-fancy
15576 If you'd rather not use group splitting for all your mail groups, you
15577 may use it for only some of them, by using @code{nnmail-split-fancy}
15578 splits like this:
15579
15580 @lisp
15581 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
15582 @end lisp
15583
15584 @var{groups} may be a regular expression or a list of group names whose
15585 parameters will be scanned to generate the output split.
15586 @var{no-crosspost} can be used to disable cross-posting; in this case, a
15587 single @code{|} split will be output. @var{catch-all} is the fall back
15588 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
15589 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
15590 empty string in any selected group, no catch-all split will be issued.
15591 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
15592 this group will override the value of the @var{catch-all} argument.
15593
15594 @findex gnus-group-split-setup
15595 Unfortunately, scanning all groups and their parameters can be quite
15596 slow, especially considering that it has to be done for every message.
15597 But don't despair! The function @code{gnus-group-split-setup} can be
15598 used to enable @code{gnus-group-split} in a much more efficient way. It
15599 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
15600 @code{nnmail-split-fancy} to the split produced by
15601 @code{gnus-group-split-fancy}. Thus, the group parameters are only
15602 scanned once, no matter how many messages are split.
15603
15604 @findex gnus-group-split-update
15605 However, if you change group parameters, you'd have to update
15606 @code{nnmail-split-fancy} manually. You can do it by running
15607 @code{gnus-group-split-update}. If you'd rather have it updated
15608 automatically, just tell @code{gnus-group-split-setup} to do it for
15609 you. For example, add to your @file{~/.gnus.el}:
15610
15611 @lisp
15612 (gnus-group-split-setup @var{auto-update} @var{catch-all})
15613 @end lisp
15614
15615 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
15616 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
15617 have to worry about updating @code{nnmail-split-fancy} again. If you
15618 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
15619 @code{gnus-group-split-default-catch-all-group} will be set to its
15620 value.
15621
15622 @vindex gnus-group-split-updated-hook
15623 Because you may want to change @code{nnmail-split-fancy} after it is set
15624 by @code{gnus-group-split-update}, this function will run
15625 @code{gnus-group-split-updated-hook} just before finishing.
15626
15627 @node Incorporating Old Mail
15628 @subsection Incorporating Old Mail
15629 @cindex incorporating old mail
15630 @cindex import old mail
15631
15632 Most people have lots of old mail stored in various file formats. If
15633 you have set up Gnus to read mail using one of the spiffy Gnus mail
15634 back ends, you'll probably wish to have that old mail incorporated into
15635 your mail groups.
15636
15637 Doing so can be quite easy.
15638
15639 To take an example: You're reading mail using @code{nnml}
15640 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
15641 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
15642 file filled with important, but old, mail. You want to move it into
15643 your @code{nnml} groups.
15644
15645 Here's how:
15646
15647 @enumerate
15648 @item
15649 Go to the group buffer.
15650
15651 @item
15652 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
15653 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
15654
15655 @item
15656 Type @kbd{SPACE} to enter the newly created group.
15657
15658 @item
15659 Type @kbd{M P b} to process-mark all articles in this group's buffer
15660 (@pxref{Setting Process Marks}).
15661
15662 @item
15663 Type @kbd{B r} to respool all the process-marked articles, and answer
15664 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
15665 @end enumerate
15666
15667 All the mail messages in the mbox file will now also be spread out over
15668 all your @code{nnml} groups. Try entering them and check whether things
15669 have gone without a glitch. If things look ok, you may consider
15670 deleting the mbox file, but I wouldn't do that unless I was absolutely
15671 sure that all the mail has ended up where it should be.
15672
15673 Respooling is also a handy thing to do if you're switching from one mail
15674 back end to another. Just respool all the mail in the old mail groups
15675 using the new mail back end.
15676
15677
15678 @node Expiring Mail
15679 @subsection Expiring Mail
15680 @cindex article expiry
15681 @cindex expiring mail
15682
15683 Traditional mail readers have a tendency to remove mail articles when
15684 you mark them as read, in some way. Gnus takes a fundamentally
15685 different approach to mail reading.
15686
15687 Gnus basically considers mail just to be news that has been received in
15688 a rather peculiar manner. It does not think that it has the power to
15689 actually change the mail, or delete any mail messages. If you enter a
15690 mail group, and mark articles as ``read'', or kill them in some other
15691 fashion, the mail articles will still exist on the system. I repeat:
15692 Gnus will not delete your old, read mail. Unless you ask it to, of
15693 course.
15694
15695 To make Gnus get rid of your unwanted mail, you have to mark the
15696 articles as @dfn{expirable}. (With the default key bindings, this means
15697 that you have to type @kbd{E}.) This does not mean that the articles
15698 will disappear right away, however. In general, a mail article will be
15699 deleted from your system if, 1) it is marked as expirable, AND 2) it is
15700 more than one week old. If you do not mark an article as expirable, it
15701 will remain on your system until hell freezes over. This bears
15702 repeating one more time, with some spurious capitalizations: IF you do
15703 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
15704
15705 @vindex gnus-auto-expirable-marks
15706 You do not have to mark articles as expirable by hand. Gnus provides
15707 two features, called ``auto-expire'' and ``total-expire'', that can help you
15708 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
15709 for you when you select an article. And ``total-expire'' means that Gnus
15710 considers all articles as expirable that are read. So, in addition to
15711 the articles marked @samp{E}, also the articles marked @samp{r},
15712 @samp{R}, @samp{O}, @samp{K}, @samp{Y} (and so on) are considered
15713 expirable. @code{gnus-auto-expirable-marks} has the full list of
15714 these marks.
15715
15716 When should either auto-expire or total-expire be used? Most people
15717 who are subscribed to mailing lists split each list into its own group
15718 and then turn on auto-expire or total-expire for those groups.
15719 (@xref{Splitting Mail}, for more information on splitting each list
15720 into its own group.)
15721
15722 Which one is better, auto-expire or total-expire? It's not easy to
15723 answer. Generally speaking, auto-expire is probably faster. Another
15724 advantage of auto-expire is that you get more marks to work with: for
15725 the articles that are supposed to stick around, you can still choose
15726 between tick and dormant and read marks. But with total-expire, you
15727 only have dormant and ticked to choose from. The advantage of
15728 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
15729 Scoring}). Auto-expire works with normal scoring but not with adaptive
15730 scoring.
15731
15732 @vindex gnus-auto-expirable-newsgroups
15733 Groups that match the regular expression
15734 @code{gnus-auto-expirable-newsgroups} will have all articles that you
15735 read marked as expirable automatically. All articles marked as
15736 expirable have an @samp{E} in the first column in the summary buffer.
15737
15738 By default, if you have auto expiry switched on, Gnus will mark all the
15739 articles you read as expirable, no matter if they were read or unread
15740 before. To avoid having articles marked as read marked as expirable
15741 automatically, you can put something like the following in your
15742 @file{~/.gnus.el} file:
15743
15744 @vindex gnus-mark-article-hook
15745 @lisp
15746 (remove-hook 'gnus-mark-article-hook
15747 'gnus-summary-mark-read-and-unread-as-read)
15748 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
15749 @end lisp
15750
15751 Note that making a group auto-expirable doesn't mean that all read
15752 articles are expired---only the articles marked as expirable
15753 will be expired. Also note that using the @kbd{d} command won't make
15754 articles expirable---only semi-automatic marking of articles as read will
15755 mark the articles as expirable in auto-expirable groups.
15756
15757 Let's say you subscribe to a couple of mailing lists, and you want the
15758 articles you have read to disappear after a while:
15759
15760 @lisp
15761 (setq gnus-auto-expirable-newsgroups
15762 "mail.nonsense-list\\|mail.nice-list")
15763 @end lisp
15764
15765 Another way to have auto-expiry happen is to have the element
15766 @code{auto-expire} in the group parameters of the group.
15767
15768 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
15769 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
15770 don't really mix very well.
15771
15772 @vindex nnmail-expiry-wait
15773 The @code{nnmail-expiry-wait} variable supplies the default time an
15774 expirable article has to live. Gnus starts counting days from when the
15775 message @emph{arrived}, not from when it was sent. The default is seven
15776 days.
15777
15778 Gnus also supplies a function that lets you fine-tune how long articles
15779 are to live, based on what group they are in. Let's say you want to
15780 have one month expiry period in the @samp{mail.private} group, a one day
15781 expiry period in the @samp{mail.junk} group, and a six day expiry period
15782 everywhere else:
15783
15784 @vindex nnmail-expiry-wait-function
15785 @lisp
15786 (setq nnmail-expiry-wait-function
15787 (lambda (group)
15788 (cond ((string= group "mail.private")
15789 31)
15790 ((string= group "mail.junk")
15791 1)
15792 ((string= group "important")
15793 'never)
15794 (t
15795 6))))
15796 @end lisp
15797
15798 The group names this function is fed are ``unadorned'' group
15799 names---no @samp{nnml:} prefixes and the like.
15800
15801 The @code{nnmail-expiry-wait} variable and
15802 @code{nnmail-expiry-wait-function} function can either be a number (not
15803 necessarily an integer) or one of the symbols @code{immediate} or
15804 @code{never}.
15805
15806 You can also use the @code{expiry-wait} group parameter to selectively
15807 change the expiry period (@pxref{Group Parameters}).
15808
15809 @vindex nnmail-expiry-target
15810 The normal action taken when expiring articles is to delete them.
15811 However, in some circumstances it might make more sense to move them
15812 to other groups instead of deleting them. The variable
15813 @code{nnmail-expiry-target} (and the @code{expiry-target} group
15814 parameter) controls this. The variable supplies a default value for
15815 all groups, which can be overridden for specific groups by the group
15816 parameter. default value is @code{delete}, but this can also be a
15817 string (which should be the name of the group the message should be
15818 moved to), or a function (which will be called in a buffer narrowed to
15819 the message in question, and with the name of the group being moved
15820 from as its parameter) which should return a target---either a group
15821 name or @code{delete}.
15822
15823 Here's an example for specifying a group name:
15824 @lisp
15825 (setq nnmail-expiry-target "nnml:expired")
15826 @end lisp
15827
15828 @findex nnmail-fancy-expiry-target
15829 @vindex nnmail-fancy-expiry-targets
15830 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
15831 expire mail to groups according to the variable
15832 @code{nnmail-fancy-expiry-targets}. Here's an example:
15833
15834 @lisp
15835 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
15836 nnmail-fancy-expiry-targets
15837 '((to-from "boss" "nnfolder:Work")
15838 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
15839 ("from" ".*" "nnfolder:Archive-%Y")))
15840 @end lisp
15841
15842 With this setup, any mail that has @code{IMPORTANT} in its Subject
15843 header and was sent in the year @code{YYYY} and month @code{MMM}, will
15844 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
15845 From or To header contains the string @code{boss}, it will get expired
15846 to @code{nnfolder:Work}. All other mail will get expired to
15847 @code{nnfolder:Archive-YYYY}.
15848
15849 @vindex nnmail-keep-last-article
15850 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
15851 expire the final article in a mail newsgroup. This is to make life
15852 easier for procmail users.
15853
15854 @vindex gnus-total-expirable-newsgroups
15855 By the way: That line up there, about Gnus never expiring non-expirable
15856 articles, is a lie. If you put @code{total-expire} in the group
15857 parameters, articles will not be marked as expirable, but all read
15858 articles will be put through the expiry process. Use with extreme
15859 caution. Even more dangerous is the
15860 @code{gnus-total-expirable-newsgroups} variable. All groups that match
15861 this regexp will have all read articles put through the expiry process,
15862 which means that @emph{all} old mail articles in the groups in question
15863 will be deleted after a while. Use with extreme caution, and don't come
15864 crying to me when you discover that the regexp you used matched the
15865 wrong group and all your important mail has disappeared. Be a
15866 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
15867 with! So there!
15868
15869 Most people make most of their mail groups total-expirable, though.
15870
15871 @vindex gnus-inhibit-user-auto-expire
15872 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
15873 commands will not mark an article as expirable, even if the group has
15874 auto-expire turned on.
15875
15876 @vindex gnus-mark-copied-or-moved-articles-as-expirable
15877 The expirable marks of articles will be removed when copying or moving
15878 them to a group in which auto-expire is not turned on. This is for
15879 preventing articles from being expired unintentionally. On the other
15880 hand, to a group that has turned auto-expire on, the expirable marks of
15881 articles that are copied or moved will not be changed by default. I.e.,
15882 when copying or moving to such a group, articles that were expirable
15883 will be left expirable and ones that were not expirable will not be
15884 marked as expirable. So, even though in auto-expire groups, some
15885 articles will never get expired (unless you read them again). If you
15886 don't side with that behavior that unexpirable articles may be mixed
15887 into auto-expire groups, you can set
15888 @code{gnus-mark-copied-or-moved-articles-as-expirable} to a
15889 non-@code{nil} value. In that case, articles that have been read will
15890 be marked as expirable automatically when being copied or moved to a
15891 group that has auto-expire turned on. The default value is @code{nil}.
15892
15893
15894 @node Washing Mail
15895 @subsection Washing Mail
15896 @cindex mail washing
15897 @cindex list server brain damage
15898 @cindex incoming mail treatment
15899
15900 Mailers and list servers are notorious for doing all sorts of really,
15901 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
15902 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
15903 end of all lines passing through our server, so let's do that!!!!1!''
15904 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
15905 considered to be self-evident were not discussed. So. Here we are.
15906
15907 Case in point: The German version of Microsoft Exchange adds @samp{AW:
15908 } to the subjects of replies instead of @samp{Re: }. I could pretend to
15909 be shocked and dismayed by this, but I haven't got the energy. It is to
15910 laugh.
15911
15912 Gnus provides a plethora of functions for washing articles while
15913 displaying them, but it might be nicer to do the filtering before
15914 storing the mail to disk. For that purpose, we have three hooks and
15915 various functions that can be put in these hooks.
15916
15917 @table @code
15918 @item nnmail-prepare-incoming-hook
15919 @vindex nnmail-prepare-incoming-hook
15920 This hook is called before doing anything with the mail and is meant for
15921 grand, sweeping gestures. It is called in a buffer that contains all
15922 the new, incoming mail. Functions to be used include:
15923
15924 @table @code
15925 @item nnheader-ms-strip-cr
15926 @findex nnheader-ms-strip-cr
15927 Remove trailing carriage returns from each line. This is default on
15928 Emacs running on MS machines.
15929
15930 @end table
15931
15932 @item nnmail-prepare-incoming-header-hook
15933 @vindex nnmail-prepare-incoming-header-hook
15934 This hook is called narrowed to each header. It can be used when
15935 cleaning up the headers. Functions that can be used include:
15936
15937 @table @code
15938 @item nnmail-remove-leading-whitespace
15939 @findex nnmail-remove-leading-whitespace
15940 Clear leading white space that ``helpful'' listservs have added to the
15941 headers to make them look nice. Aaah.
15942
15943 (Note that this function works on both the header on the body of all
15944 messages, so it is a potentially dangerous function to use (if a body
15945 of a message contains something that looks like a header line). So
15946 rather than fix the bug, it is of course the right solution to make it
15947 into a feature by documenting it.)
15948
15949 @item nnmail-remove-list-identifiers
15950 @findex nnmail-remove-list-identifiers
15951 Some list servers add an identifier---for example, @samp{(idm)}---to the
15952 beginning of all @code{Subject} headers. I'm sure that's nice for
15953 people who use stone age mail readers. This function will remove
15954 strings that match the @code{nnmail-list-identifiers} regexp, which can
15955 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
15956 @code{\\(..\\)}.
15957
15958 For instance, if you want to remove the @samp{(idm)} and the
15959 @samp{nagnagnag} identifiers:
15960
15961 @lisp
15962 (setq nnmail-list-identifiers
15963 '("(idm)" "nagnagnag"))
15964 @end lisp
15965
15966 This can also be done non-destructively with
15967 @code{gnus-list-identifiers}, @xref{Article Hiding}.
15968
15969 @item nnmail-remove-tabs
15970 @findex nnmail-remove-tabs
15971 Translate all @samp{TAB} characters into @samp{SPACE} characters.
15972
15973 @item nnmail-ignore-broken-references
15974 @findex nnmail-ignore-broken-references
15975 @c @findex nnmail-fix-eudora-headers
15976 @cindex Eudora
15977 @cindex Pegasus
15978 Some mail user agents (e.g., Eudora and Pegasus) produce broken
15979 @code{References} headers, but correct @code{In-Reply-To} headers. This
15980 function will get rid of the @code{References} header if the headers
15981 contain a line matching the regular expression
15982 @code{nnmail-broken-references-mailers}.
15983
15984 @end table
15985
15986 @item nnmail-prepare-incoming-message-hook
15987 @vindex nnmail-prepare-incoming-message-hook
15988 This hook is called narrowed to each message. Functions to be used
15989 include:
15990
15991 @table @code
15992 @item article-de-quoted-unreadable
15993 @findex article-de-quoted-unreadable
15994 Decode Quoted Readable encoding.
15995
15996 @end table
15997 @end table
15998
15999
16000 @node Duplicates
16001 @subsection Duplicates
16002
16003 @vindex nnmail-treat-duplicates
16004 @vindex nnmail-message-id-cache-length
16005 @vindex nnmail-message-id-cache-file
16006 @cindex duplicate mails
16007 If you are a member of a couple of mailing lists, you will sometimes
16008 receive two copies of the same mail. This can be quite annoying, so
16009 @code{nnmail} checks for and treats any duplicates it might find. To do
16010 this, it keeps a cache of old @code{Message-ID}s:
16011 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
16012 default. The approximate maximum number of @code{Message-ID}s stored
16013 there is controlled by the @code{nnmail-message-id-cache-length}
16014 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
16015 stored.) If all this sounds scary to you, you can set
16016 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
16017 default), and @code{nnmail} won't delete duplicate mails. Instead it
16018 will insert a warning into the head of the mail saying that it thinks
16019 that this is a duplicate of a different message.
16020
16021 This variable can also be a function. If that's the case, the function
16022 will be called from a buffer narrowed to the message in question with
16023 the @code{Message-ID} as a parameter. The function must return either
16024 @code{nil}, @code{warn}, or @code{delete}.
16025
16026 You can turn this feature off completely by setting the variable to
16027 @code{nil}.
16028
16029 If you want all the duplicate mails to be put into a special
16030 @dfn{duplicates} group, you could do that using the normal mail split
16031 methods:
16032
16033 @lisp
16034 (setq nnmail-split-fancy
16035 '(| ;; @r{Messages duplicates go to a separate group.}
16036 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
16037 ;; @r{Message from daemons, postmaster, and the like to another.}
16038 (any mail "mail.misc")
16039 ;; @r{Other rules.}
16040 [...] ))
16041 @end lisp
16042 @noindent
16043 Or something like:
16044 @lisp
16045 (setq nnmail-split-methods
16046 '(("duplicates" "^Gnus-Warning:.*duplicate")
16047 ;; @r{Other rules.}
16048 [...]))
16049 @end lisp
16050
16051 Here's a neat feature: If you know that the recipient reads her mail
16052 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
16053 @code{delete}, you can send her as many insults as you like, just by
16054 using a @code{Message-ID} of a mail that you know that she's already
16055 received. Think of all the fun! She'll never see any of it! Whee!
16056
16057
16058 @node Not Reading Mail
16059 @subsection Not Reading Mail
16060
16061 If you start using any of the mail back ends, they have the annoying
16062 habit of assuming that you want to read mail with them. This might not
16063 be unreasonable, but it might not be what you want.
16064
16065 If you set @code{mail-sources} and @code{nnmail-spool-file} to
16066 @code{nil}, none of the back ends will ever attempt to read incoming
16067 mail, which should help.
16068
16069 @vindex nnbabyl-get-new-mail
16070 @vindex nnmbox-get-new-mail
16071 @vindex nnml-get-new-mail
16072 @vindex nnmh-get-new-mail
16073 @vindex nnfolder-get-new-mail
16074 This might be too much, if, for instance, you are reading mail quite
16075 happily with @code{nnml} and just want to peek at some old (pre-Emacs
16076 23) Rmail file you have stashed away with @code{nnbabyl}. All back ends have
16077 variables called back-end-@code{get-new-mail}. If you want to disable
16078 the @code{nnbabyl} mail reading, you edit the virtual server for the
16079 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
16080
16081 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
16082 narrowed to the article to be saved before saving it when reading
16083 incoming mail.
16084
16085
16086 @node Choosing a Mail Back End
16087 @subsection Choosing a Mail Back End
16088
16089 Gnus will read the mail spool when you activate a mail group. The mail
16090 file is first copied to your home directory. What happens after that
16091 depends on what format you want to store your mail in.
16092
16093 There are six different mail back ends in the standard Gnus, and more
16094 back ends are available separately. The mail back end most people use
16095 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
16096 Spool}).
16097
16098 @menu
16099 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
16100 * Babyl:: Babyl was used by older versions of Rmail.
16101 * Mail Spool:: Store your mail in a private spool?
16102 * MH Spool:: An mhspool-like back end.
16103 * Maildir:: Another one-file-per-message format.
16104 * nnmaildir Group Parameters::
16105 * Article Identification::
16106 * NOV Data::
16107 * Article Marks::
16108 * Mail Folders:: Having one file for each group.
16109 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
16110 @end menu
16111
16112
16113
16114 @node Unix Mail Box
16115 @subsubsection Unix Mail Box
16116 @cindex nnmbox
16117 @cindex unix mail box
16118
16119 @vindex nnmbox-active-file
16120 @vindex nnmbox-mbox-file
16121 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
16122 mail. @code{nnmbox} will add extra headers to each mail article to say
16123 which group it belongs in.
16124
16125 Virtual server settings:
16126
16127 @table @code
16128 @item nnmbox-mbox-file
16129 @vindex nnmbox-mbox-file
16130 The name of the mail box in the user's home directory. Default is
16131 @file{~/mbox}.
16132
16133 @item nnmbox-active-file
16134 @vindex nnmbox-active-file
16135 The name of the active file for the mail box. Default is
16136 @file{~/.mbox-active}.
16137
16138 @item nnmbox-get-new-mail
16139 @vindex nnmbox-get-new-mail
16140 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
16141 into groups. Default is @code{t}.
16142 @end table
16143
16144
16145 @node Babyl
16146 @subsubsection Babyl
16147 @cindex nnbabyl
16148
16149 @vindex nnbabyl-active-file
16150 @vindex nnbabyl-mbox-file
16151 The @dfn{nnbabyl} back end will use a Babyl mail box to store mail.
16152 @code{nnbabyl} will add extra headers to each mail article to say which
16153 group it belongs in.
16154
16155 Virtual server settings:
16156
16157 @table @code
16158 @item nnbabyl-mbox-file
16159 @vindex nnbabyl-mbox-file
16160 The name of the Babyl file. The default is @file{~/RMAIL}
16161
16162 @item nnbabyl-active-file
16163 @vindex nnbabyl-active-file
16164 The name of the active file for the Babyl file. The default is
16165 @file{~/.rmail-active}
16166
16167 @item nnbabyl-get-new-mail
16168 @vindex nnbabyl-get-new-mail
16169 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
16170 @code{t}
16171 @end table
16172
16173
16174 @node Mail Spool
16175 @subsubsection Mail Spool
16176 @cindex nnml
16177 @cindex mail @acronym{NOV} spool
16178
16179 The @dfn{nnml} spool mail format isn't compatible with any other known
16180 format. It should be used with some caution.
16181
16182 @vindex nnml-directory
16183 If you use this back end, Gnus will split all incoming mail into files,
16184 one file for each mail, and put the articles into the corresponding
16185 directories under the directory specified by the @code{nnml-directory}
16186 variable. The default value is @file{~/Mail/}.
16187
16188 You do not have to create any directories beforehand; Gnus will take
16189 care of all that.
16190
16191 If you have a strict limit as to how many files you are allowed to store
16192 in your account, you should not use this back end. As each mail gets its
16193 own file, you might very well occupy thousands of inodes within a few
16194 weeks. If this is no problem for you, and it isn't a problem for you
16195 having your friendly systems administrator walking around, madly,
16196 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
16197 know that this is probably the fastest format to use. You do not have
16198 to trudge through a big mbox file just to read your new mail.
16199
16200 @code{nnml} is probably the slowest back end when it comes to article
16201 splitting. It has to create lots of files, and it also generates
16202 @acronym{NOV} databases for the incoming mails. This makes it possibly the
16203 fastest back end when it comes to reading mail.
16204
16205 Virtual server settings:
16206
16207 @table @code
16208 @item nnml-directory
16209 @vindex nnml-directory
16210 All @code{nnml} directories will be placed under this directory. The
16211 default is the value of @code{message-directory} (whose default value
16212 is @file{~/Mail}).
16213
16214 @item nnml-active-file
16215 @vindex nnml-active-file
16216 The active file for the @code{nnml} server. The default is
16217 @file{~/Mail/active}.
16218
16219 @item nnml-newsgroups-file
16220 @vindex nnml-newsgroups-file
16221 The @code{nnml} group descriptions file. @xref{Newsgroups File
16222 Format}. The default is @file{~/Mail/newsgroups}.
16223
16224 @item nnml-get-new-mail
16225 @vindex nnml-get-new-mail
16226 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
16227 @code{t}.
16228
16229 @item nnml-nov-is-evil
16230 @vindex nnml-nov-is-evil
16231 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16232 default is @code{nil}.
16233
16234 @item nnml-nov-file-name
16235 @vindex nnml-nov-file-name
16236 The name of the @acronym{NOV} files. The default is @file{.overview}.
16237
16238 @item nnml-prepare-save-mail-hook
16239 @vindex nnml-prepare-save-mail-hook
16240 Hook run narrowed to an article before saving.
16241
16242 @item nnml-use-compressed-files
16243 @vindex nnml-use-compressed-files
16244 If non-@code{nil}, @code{nnml} will allow using compressed message
16245 files. This requires @code{auto-compression-mode} to be enabled
16246 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
16247 If the value of @code{nnml-use-compressed-files} is a string, it is used
16248 as the file extension specifying the compression program. You can set it
16249 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
16250 equivalent to @samp{.gz}.
16251
16252 @item nnml-compressed-files-size-threshold
16253 @vindex nnml-compressed-files-size-threshold
16254 Default size threshold for compressed message files. Message files with
16255 bodies larger than that many characters will be automatically compressed
16256 if @code{nnml-use-compressed-files} is non-@code{nil}.
16257
16258 @end table
16259
16260 @findex nnml-generate-nov-databases
16261 If your @code{nnml} groups and @acronym{NOV} files get totally out of
16262 whack, you can do a complete update by typing @kbd{M-x
16263 nnml-generate-nov-databases}. This command will trawl through the
16264 entire @code{nnml} hierarchy, looking at each and every article, so it
16265 might take a while to complete. A better interface to this
16266 functionality can be found in the server buffer (@pxref{Server
16267 Commands}).
16268
16269
16270 @node MH Spool
16271 @subsubsection MH Spool
16272 @cindex nnmh
16273 @cindex mh-e mail spool
16274
16275 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
16276 @acronym{NOV} databases and it doesn't keep an active file or marks
16277 file. This makes @code{nnmh} a @emph{much} slower back end than
16278 @code{nnml}, but it also makes it easier to write procmail scripts
16279 for.
16280
16281 Virtual server settings:
16282
16283 @table @code
16284 @item nnmh-directory
16285 @vindex nnmh-directory
16286 All @code{nnmh} directories will be located under this directory. The
16287 default is the value of @code{message-directory} (whose default is
16288 @file{~/Mail})
16289
16290 @item nnmh-get-new-mail
16291 @vindex nnmh-get-new-mail
16292 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
16293 @code{t}.
16294
16295 @item nnmh-be-safe
16296 @vindex nnmh-be-safe
16297 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
16298 sure that the articles in the folder are actually what Gnus thinks
16299 they are. It will check date stamps and stat everything in sight, so
16300 setting this to @code{t} will mean a serious slow-down. If you never
16301 use anything but Gnus to read the @code{nnmh} articles, you do not
16302 have to set this variable to @code{t}. The default is @code{nil}.
16303 @end table
16304
16305
16306 @node Maildir
16307 @subsubsection Maildir
16308 @cindex nnmaildir
16309 @cindex maildir
16310
16311 @code{nnmaildir} stores mail in the maildir format, with each maildir
16312 corresponding to a group in Gnus. This format is documented here:
16313 @uref{http://cr.yp.to/proto/maildir.html} and here:
16314 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
16315 also stores extra information in the @file{.nnmaildir/} directory
16316 within a maildir.
16317
16318 Maildir format was designed to allow concurrent deliveries and
16319 reading, without needing locks. With other back ends, you would have
16320 your mail delivered to a spool of some kind, and then you would
16321 configure Gnus to split mail from that spool into your groups. You
16322 can still do that with @code{nnmaildir}, but the more common
16323 configuration is to have your mail delivered directly to the maildirs
16324 that appear as group in Gnus.
16325
16326 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
16327 never corrupt its data in memory, and @code{SIGKILL} will never
16328 corrupt its data in the filesystem.
16329
16330 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
16331 maildir. So you can copy a whole maildir from one Gnus setup to
16332 another, and you will keep your marks.
16333
16334 Virtual server settings:
16335
16336 @table @code
16337 @item directory
16338 For each of your @code{nnmaildir} servers (it's very unlikely that
16339 you'd need more than one), you need to create a directory and populate
16340 it with maildirs or symlinks to maildirs (and nothing else; do not
16341 choose a directory already used for other purposes). Each maildir
16342 will be represented in Gnus as a newsgroup on that server; the
16343 filename of the symlink will be the name of the group. Any filenames
16344 in the directory starting with @samp{.} are ignored. The directory is
16345 scanned when you first start Gnus, and each time you type @kbd{g} in
16346 the group buffer; if any maildirs have been removed or added,
16347 @code{nnmaildir} notices at these times.
16348
16349 The value of the @code{directory} parameter should be a Lisp form
16350 which is processed by @code{eval} and @code{expand-file-name} to get
16351 the path of the directory for this server. The form is @code{eval}ed
16352 only when the server is opened; the resulting string is used until the
16353 server is closed. (If you don't know about forms and @code{eval},
16354 don't worry---a simple string will work.) This parameter is not
16355 optional; you must specify it. I don't recommend using
16356 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
16357 use that directory by default for various things, and may get confused
16358 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
16359 value.
16360
16361 @item target-prefix
16362 This should be a Lisp form which is processed by @code{eval} and
16363 @code{expand-file-name}. The form is @code{eval}ed only when the
16364 server is opened; the resulting string is used until the server is
16365 closed.
16366
16367 When you create a group on an @code{nnmaildir} server, the maildir is
16368 created with @code{target-prefix} prepended to its name, and a symlink
16369 pointing to that maildir is created, named with the plain group name.
16370 So if @code{directory} is @code{"~/.nnmaildir"} and
16371 @code{target-prefix} is @code{"../maildirs/"}, then when you create
16372 the group @code{foo}, @code{nnmaildir} will create
16373 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
16374 @file{~/.nnmaildir/foo} as a symlink pointing to
16375 @file{../maildirs/foo}.
16376
16377 You can set @code{target-prefix} to a string without any slashes to
16378 create both maildirs and symlinks in the same @code{directory}; in
16379 this case, any maildirs found in @code{directory} whose names start
16380 with @code{target-prefix} will not be listed as groups (but the
16381 symlinks pointing to them will be).
16382
16383 As a special case, if @code{target-prefix} is @code{""} (the default),
16384 then when you create a group, the maildir will be created in
16385 @code{directory} without a corresponding symlink. Beware that you
16386 cannot use @code{gnus-group-delete-group} on such groups without the
16387 @code{force} argument.
16388
16389 @item directory-files
16390 This should be a function with the same interface as
16391 @code{directory-files} (such as @code{directory-files} itself). It is
16392 used to scan the server's @code{directory} for maildirs. This
16393 parameter is optional; the default is
16394 @code{nnheader-directory-files-safe} if
16395 @code{nnheader-directory-files-is-safe} is @code{nil}, and
16396 @code{directory-files} otherwise.
16397 (@code{nnheader-directory-files-is-safe} is checked only once when the
16398 server is opened; if you want to check it each time the directory is
16399 scanned, you'll have to provide your own function that does that.)
16400
16401 @item get-new-mail
16402 If non-@code{nil}, then after scanning for new mail in the group
16403 maildirs themselves as usual, this server will also incorporate mail
16404 the conventional Gnus way, from @code{mail-sources} according to
16405 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
16406 value is @code{nil}.
16407
16408 Do @emph{not} use the same maildir both in @code{mail-sources} and as
16409 an @code{nnmaildir} group. The results might happen to be useful, but
16410 that would be by chance, not by design, and the results might be
16411 different in the future. If your split rules create new groups,
16412 remember to supply a @code{create-directory} server parameter.
16413 @end table
16414
16415 @node nnmaildir Group Parameters
16416 @subsubsection Group parameters
16417
16418 @code{nnmaildir} uses several group parameters. It's safe to ignore
16419 all this; the default behavior for @code{nnmaildir} is the same as the
16420 default behavior for other mail back ends: articles are deleted after
16421 one week, etc. Except for the expiry parameters, all this
16422 functionality is unique to @code{nnmaildir}, so you can ignore it if
16423 you're just trying to duplicate the behavior you already have with
16424 another back end.
16425
16426 If the value of any of these parameters is a vector, the first element
16427 is evaluated as a Lisp form and the result is used, rather than the
16428 original value. If the value is not a vector, the value itself is
16429 evaluated as a Lisp form. (This is why these parameters use names
16430 different from those of other, similar parameters supported by other
16431 back ends: they have different, though similar, meanings.) (For
16432 numbers, strings, @code{nil}, and @code{t}, you can ignore the
16433 @code{eval} business again; for other values, remember to use an extra
16434 quote and wrap the value in a vector when appropriate.)
16435
16436 @table @code
16437 @item expire-age
16438 An integer specifying the minimum age, in seconds, of an article
16439 before it will be expired, or the symbol @code{never} to specify that
16440 articles should never be expired. If this parameter is not set,
16441 @code{nnmaildir} falls back to the usual
16442 @code{nnmail-expiry-wait}(@code{-function}) variables (the
16443 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
16444 and makes @code{nnmail-expiry-wait-function} ineffective). If you
16445 wanted a value of 3 days, you could use something like @code{[(* 3 24
16446 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
16447 An article's age is measured starting from the article file's
16448 modification time. Normally, this is the same as the article's
16449 delivery time, but editing an article makes it younger. Moving an
16450 article (other than via expiry) may also make an article younger.
16451
16452 @item expire-group
16453 If this is set to a string such as a full Gnus group name, like
16454 @example
16455 "backend+server.address.string:group.name"
16456 @end example
16457 and if it is not the name of the same group that the parameter belongs
16458 to, then articles will be moved to the specified group during expiry
16459 before being deleted. @emph{If this is set to an @code{nnmaildir}
16460 group, the article will be just as old in the destination group as it
16461 was in the source group.} So be careful with @code{expire-age} in the
16462 destination group. If this is set to the name of the same group that
16463 the parameter belongs to, then the article is not expired at all. If
16464 you use the vector form, the first element is evaluated once for each
16465 article. So that form can refer to
16466 @code{nnmaildir-article-file-name}, etc., to decide where to put the
16467 article. @emph{Even if this parameter is not set, @code{nnmaildir}
16468 does not fall back to the @code{expiry-target} group parameter or the
16469 @code{nnmail-expiry-target} variable.}
16470
16471 @item read-only
16472 If this is set to @code{t}, @code{nnmaildir} will treat the articles
16473 in this maildir as read-only. This means: articles are not renamed
16474 from @file{new/} into @file{cur/}; articles are only found in
16475 @file{new/}, not @file{cur/}; articles are never deleted; articles
16476 cannot be edited. @file{new/} is expected to be a symlink to the
16477 @file{new/} directory of another maildir---e.g., a system-wide mailbox
16478 containing a mailing list of common interest. Everything in the
16479 maildir outside @file{new/} is @emph{not} treated as read-only, so for
16480 a shared mailbox, you do still need to set up your own maildir (or
16481 have write permission to the shared mailbox); your maildir just won't
16482 contain extra copies of the articles.
16483
16484 @item directory-files
16485 A function with the same interface as @code{directory-files}. It is
16486 used to scan the directories in the maildir corresponding to this
16487 group to find articles. The default is the function specified by the
16488 server's @code{directory-files} parameter.
16489
16490 @item distrust-Lines:
16491 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
16492 article, rather than use the @code{Lines:} header field. If
16493 @code{nil}, the header field will be used if present.
16494
16495 @item always-marks
16496 A list of mark symbols, such as @code{['(read expire)]}. Whenever
16497 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16498 say that all articles have these marks, regardless of whether the
16499 marks stored in the filesystem say so. This is a proof-of-concept
16500 feature that will probably be removed eventually; it ought to be done
16501 in Gnus proper, or abandoned if it's not worthwhile.
16502
16503 @item never-marks
16504 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
16505 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16506 say that no articles have these marks, regardless of whether the marks
16507 stored in the filesystem say so. @code{never-marks} overrides
16508 @code{always-marks}. This is a proof-of-concept feature that will
16509 probably be removed eventually; it ought to be done in Gnus proper, or
16510 abandoned if it's not worthwhile.
16511
16512 @item nov-cache-size
16513 An integer specifying the size of the @acronym{NOV} memory cache. To
16514 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
16515 for a limited number of articles in each group. (This is probably not
16516 worthwhile, and will probably be removed in the future.) This
16517 parameter's value is noticed only the first time a group is seen after
16518 the server is opened---i.e., when you first start Gnus, typically.
16519 The @acronym{NOV} cache is never resized until the server is closed
16520 and reopened. The default is an estimate of the number of articles
16521 that would be displayed in the summary buffer: a count of articles
16522 that are either marked with @code{tick} or not marked with
16523 @code{read}, plus a little extra.
16524 @end table
16525
16526 @node Article Identification
16527 @subsubsection Article identification
16528 Articles are stored in the @file{cur/} subdirectory of each maildir.
16529 Each article file is named like @code{uniq:info}, where @code{uniq}
16530 contains no colons. @code{nnmaildir} ignores, but preserves, the
16531 @code{:info} part. (Other maildir readers typically use this part of
16532 the filename to store marks.) The @code{uniq} part uniquely
16533 identifies the article, and is used in various places in the
16534 @file{.nnmaildir/} subdirectory of the maildir to store information
16535 about the corresponding article. The full pathname of an article is
16536 available in the variable @code{nnmaildir-article-file-name} after you
16537 request the article in the summary buffer.
16538
16539 @node NOV Data
16540 @subsubsection NOV data
16541 An article identified by @code{uniq} has its @acronym{NOV} data (used
16542 to generate lines in the summary buffer) stored in
16543 @code{.nnmaildir/nov/uniq}. There is no
16544 @code{nnmaildir-generate-nov-databases} function. (There isn't much
16545 need for it---an article's @acronym{NOV} data is updated automatically
16546 when the article or @code{nnmail-extra-headers} has changed.) You can
16547 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
16548 single article simply by deleting the corresponding @acronym{NOV}
16549 file, but @emph{beware}: this will also cause @code{nnmaildir} to
16550 assign a new article number for this article, which may cause trouble
16551 with @code{seen} marks, the Agent, and the cache.
16552
16553 @node Article Marks
16554 @subsubsection Article marks
16555 An article identified by @code{uniq} is considered to have the mark
16556 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
16557 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
16558 looks for such files and reports the set of marks it finds. When Gnus
16559 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
16560 creates and deletes the corresponding files as needed. (Actually,
16561 rather than create a new file for each mark, it just creates hard
16562 links to @file{.nnmaildir/markfile}, to save inodes.)
16563
16564 You can invent new marks by creating a new directory in
16565 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
16566 your server, untar it later, and keep your marks. You can add and
16567 remove marks yourself by creating and deleting mark files. If you do
16568 this while Gnus is running and your @code{nnmaildir} server is open,
16569 it's best to exit all summary buffers for @code{nnmaildir} groups and
16570 type @kbd{s} in the group buffer first, and to type @kbd{g} or
16571 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
16572 pick up the changes, and might undo them.
16573
16574
16575 @node Mail Folders
16576 @subsubsection Mail Folders
16577 @cindex nnfolder
16578 @cindex mbox folders
16579 @cindex mail folders
16580
16581 @code{nnfolder} is a back end for storing each mail group in a
16582 separate file. Each file is in the standard Un*x mbox format.
16583 @code{nnfolder} will add extra headers to keep track of article
16584 numbers and arrival dates.
16585
16586 Virtual server settings:
16587
16588 @table @code
16589 @item nnfolder-directory
16590 @vindex nnfolder-directory
16591 All the @code{nnfolder} mail boxes will be stored under this
16592 directory. The default is the value of @code{message-directory}
16593 (whose default is @file{~/Mail})
16594
16595 @item nnfolder-active-file
16596 @vindex nnfolder-active-file
16597 The name of the active file. The default is @file{~/Mail/active}.
16598
16599 @item nnfolder-newsgroups-file
16600 @vindex nnfolder-newsgroups-file
16601 The name of the group descriptions file. @xref{Newsgroups File
16602 Format}. The default is @file{~/Mail/newsgroups}
16603
16604 @item nnfolder-get-new-mail
16605 @vindex nnfolder-get-new-mail
16606 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
16607 default is @code{t}
16608
16609 @item nnfolder-save-buffer-hook
16610 @vindex nnfolder-save-buffer-hook
16611 @cindex backup files
16612 Hook run before saving the folders. Note that Emacs does the normal
16613 backup renaming of files even with the @code{nnfolder} buffers. If
16614 you wish to switch this off, you could say something like the
16615 following in your @file{.emacs} file:
16616
16617 @lisp
16618 (defun turn-off-backup ()
16619 (set (make-local-variable 'backup-inhibited) t))
16620
16621 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
16622 @end lisp
16623
16624 @item nnfolder-delete-mail-hook
16625 @vindex nnfolder-delete-mail-hook
16626 Hook run in a buffer narrowed to the message that is to be deleted.
16627 This function can be used to copy the message to somewhere else, or to
16628 extract some information from it before removing it.
16629
16630 @item nnfolder-nov-is-evil
16631 @vindex nnfolder-nov-is-evil
16632 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16633 default is @code{nil}.
16634
16635 @item nnfolder-nov-file-suffix
16636 @vindex nnfolder-nov-file-suffix
16637 The extension for @acronym{NOV} files. The default is @file{.nov}.
16638
16639 @item nnfolder-nov-directory
16640 @vindex nnfolder-nov-directory
16641 The directory where the @acronym{NOV} files should be stored. If
16642 @code{nil}, @code{nnfolder-directory} is used.
16643
16644 @end table
16645
16646
16647 @findex nnfolder-generate-active-file
16648 @kindex M-x nnfolder-generate-active-file
16649 If you have lots of @code{nnfolder}-like files you'd like to read with
16650 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
16651 command to make @code{nnfolder} aware of all likely files in
16652 @code{nnfolder-directory}. This only works if you use long file names,
16653 though.
16654
16655 @node Comparing Mail Back Ends
16656 @subsubsection Comparing Mail Back Ends
16657
16658 First, just for terminology, the @dfn{back end} is the common word for a
16659 low-level access method---a transport, if you will, by which something
16660 is acquired. The sense is that one's mail has to come from somewhere,
16661 and so selection of a suitable back end is required in order to get that
16662 mail within spitting distance of Gnus.
16663
16664 The same concept exists for Usenet itself: Though access to articles is
16665 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
16666 in the world got at Usenet by running a reader on the machine where the
16667 articles lay (the machine which today we call an @acronym{NNTP} server), and
16668 access was by the reader stepping into the articles' directory spool
16669 area directly. One can still select between either the @code{nntp} or
16670 @code{nnspool} back ends, to select between these methods, if one happens
16671 actually to live on the server (or can see its spool directly, anyway,
16672 via NFS).
16673
16674 The goal in selecting a mail back end is to pick one which
16675 simultaneously represents a suitable way of dealing with the original
16676 format plus leaving mail in a form that is convenient to use in the
16677 future. Here are some high and low points on each:
16678
16679 @table @code
16680 @item nnmbox
16681
16682 UNIX systems have historically had a single, very common, and well-defined
16683 format. All messages arrive in a single @dfn{spool file}, and
16684 they are delineated by a line whose regular expression matches
16685 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
16686 to make it clear in this instance that this is not the RFC-specified
16687 @samp{From:} header.) Because Emacs and therefore Gnus emanate
16688 historically from the Unix environment, it is simplest if one does not
16689 mess a great deal with the original mailbox format, so if one chooses
16690 this back end, Gnus' primary activity in getting mail from the real spool
16691 area to Gnus' preferred directory is simply to copy it, with no
16692 (appreciable) format change in the process. It is the ``dumbest'' way
16693 to move mail into availability in the Gnus environment. This makes it
16694 fast to move into place, but slow to parse, when Gnus has to look at
16695 what's where.
16696
16697 @item nnbabyl
16698
16699 Once upon a time, there was the DEC-10 and DEC-20, running operating
16700 systems called TOPS and related things, and the usual (only?) mail
16701 reading environment was a thing called Babyl. I don't know what format
16702 was used for mail landing on the system, but Babyl had its own internal
16703 format to which mail was converted, primarily involving creating a
16704 spool-file-like entity with a scheme for inserting Babyl-specific
16705 headers and status bits above the top of each message in the file.
16706 Rmail was Emacs's first mail reader, it was written by Richard Stallman,
16707 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
16708 to understand the mail files folks already had in existence. Gnus (and
16709 VM, for that matter) continue to support this format because it's
16710 perceived as having some good qualities in those mailer-specific
16711 headers/status bits stuff. Rmail itself still exists as well, of
16712 course, and is still maintained within Emacs. Since Emacs 23, it
16713 uses standard mbox format rather than Babyl.
16714
16715 Both of the above forms leave your mail in a single file on your
16716 file system, and they must parse that entire file each time you take a
16717 look at your mail.
16718
16719 @item nnml
16720
16721 @code{nnml} is the back end which smells the most as though you were
16722 actually operating with an @code{nnspool}-accessed Usenet system. (In
16723 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
16724 lo these years ago.) One's mail is taken from the original spool file,
16725 and is then cut up into individual message files, 1:1. It maintains a
16726 Usenet-style active file (analogous to what one finds in an INN- or
16727 CNews-based news system in (for instance) @file{/var/lib/news/active},
16728 or what is returned via the @samp{NNTP LIST} verb) and also creates
16729 @dfn{overview} files for efficient group entry, as has been defined for
16730 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
16731 due to the creation of lots of files, updates to the @code{nnml} active
16732 file, and additions to overview files on a per-message basis, but it is
16733 extremely fast on access because of what amounts to the indexing support
16734 provided by the active file and overviews.
16735
16736 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
16737 resource which defines available places in the file system to put new
16738 files. Sysadmins take a dim view of heavy inode occupation within
16739 tight, shared file systems. But if you live on a personal machine where
16740 the file system is your own and space is not at a premium, @code{nnml}
16741 wins big.
16742
16743 It is also problematic using this back end if you are living in a
16744 FAT16-based Windows world, since much space will be wasted on all these
16745 tiny files.
16746
16747 @item nnmh
16748
16749 The Rand MH mail-reading system has been around UNIX systems for a very
16750 long time; it operates by splitting one's spool file of messages into
16751 individual files, but with little or no indexing support---@code{nnmh}
16752 is considered to be semantically equivalent to ``@code{nnml} without
16753 active file or overviews''. This is arguably the worst choice, because
16754 one gets the slowness of individual file creation married to the
16755 slowness of access parsing when learning what's new in one's groups.
16756
16757 @item nnfolder
16758
16759 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
16760 method described above) on a per-group basis. That is, @code{nnmbox}
16761 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
16762 little bit of optimization to this so that each of one's mail groups has
16763 a Unix mail box file. It's faster than @code{nnmbox} because each group
16764 can be parsed separately, and still provides the simple Unix mail box
16765 format requiring minimal effort in moving the mail around. In addition,
16766 it maintains an ``active'' file making it much faster for Gnus to figure
16767 out how many messages there are in each separate group.
16768
16769 If you have groups that are expected to have a massive amount of
16770 messages, @code{nnfolder} is not the best choice, but if you receive
16771 only a moderate amount of mail, @code{nnfolder} is probably the most
16772 friendly mail back end all over.
16773
16774 @item nnmaildir
16775
16776 For configuring expiry and other things, @code{nnmaildir} uses
16777 incompatible group parameters, slightly different from those of other
16778 mail back ends.
16779
16780 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
16781 differences. Each message is stored in a separate file, but the
16782 filename is unrelated to the article number in Gnus. @code{nnmaildir}
16783 also stores the equivalent of @code{nnml}'s overview files in one file
16784 per article, so it uses about twice as many inodes as @code{nnml}.
16785 (Use @code{df -i} to see how plentiful your inode supply is.) If this
16786 slows you down or takes up very much space, a non-block-structured
16787 file system.
16788
16789 Since maildirs don't require locking for delivery, the maildirs you use
16790 as groups can also be the maildirs your mail is directly delivered to.
16791 This means you can skip Gnus' mail splitting if your mail is already
16792 organized into different mailboxes during delivery. A @code{directory}
16793 entry in @code{mail-sources} would have a similar effect, but would
16794 require one set of mailboxes for spooling deliveries (in mbox format,
16795 thus damaging message bodies), and another set to be used as groups (in
16796 whatever format you like). A maildir has a built-in spool, in the
16797 @code{new/} subdirectory. Beware that currently, mail moved from
16798 @code{new/} to @code{cur/} instead of via mail splitting will not
16799 undergo treatment such as duplicate checking.
16800
16801 @code{nnmaildir} stores article marks for a given group in the
16802 corresponding maildir, in a way designed so that it's easy to manipulate
16803 them from outside Gnus. You can tar up a maildir, unpack it somewhere
16804 else, and still have your marks.
16805
16806 @code{nnmaildir} uses a significant amount of memory to speed things up.
16807 (It keeps in memory some of the things that @code{nnml} stores in files
16808 and that @code{nnmh} repeatedly parses out of message files.) If this
16809 is a problem for you, you can set the @code{nov-cache-size} group
16810 parameter to something small (0 would probably not work, but 1 probably
16811 would) to make it use less memory. This caching will probably be
16812 removed in the future.
16813
16814 Startup is likely to be slower with @code{nnmaildir} than with other
16815 back ends. Everything else is likely to be faster, depending in part
16816 on your file system.
16817
16818 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
16819 to write an @code{nnmaildir}-derived back end.
16820
16821 @end table
16822
16823
16824 @node Browsing the Web
16825 @section Browsing the Web
16826 @cindex web
16827 @cindex browsing the web
16828 @cindex www
16829 @cindex http
16830
16831 Web-based discussion forums are getting more and more popular. On many
16832 subjects, the web-based forums have become the most important forums,
16833 eclipsing the importance of mailing lists and news groups. The reason
16834 is easy to understand---they are friendly to new users; you just point
16835 and click, and there's the discussion. With mailing lists, you have to
16836 go through a cumbersome subscription procedure, and most people don't
16837 even know what a news group is.
16838
16839 The problem with this scenario is that web browsers are not very good at
16840 being newsreaders. They do not keep track of what articles you've read;
16841 they do not allow you to score on subjects you're interested in; they do
16842 not allow off-line browsing; they require you to click around and drive
16843 you mad in the end.
16844
16845 So---if web browsers suck at reading discussion forums, why not use Gnus
16846 to do it instead?
16847
16848 Gnus has been getting a bit of a collection of back ends for providing
16849 interfaces to these sources.
16850
16851 @menu
16852 * Archiving Mail::
16853 * Web Searches:: Creating groups from articles that match a string.
16854 * RSS:: Reading RDF site summary.
16855 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
16856 @end menu
16857
16858 All the web sources require Emacs/W3 and the url library or those
16859 alternatives to work.
16860
16861 The main caveat with all these web sources is that they probably won't
16862 work for a very long time. Gleaning information from the @acronym{HTML} data
16863 is guesswork at best, and when the layout is altered, the Gnus back end
16864 will fail. If you have reasonably new versions of these back ends,
16865 though, you should be ok.
16866
16867 One thing all these Web methods have in common is that the Web sources
16868 are often down, unavailable or just plain too slow to be fun. In those
16869 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
16870 Unplugged}) handle downloading articles, and then you can read them at
16871 leisure from your local disk. No more World Wide Wait for you.
16872
16873 @node Archiving Mail
16874 @subsection Archiving Mail
16875 @cindex archiving mail
16876 @cindex backup of mail
16877
16878 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
16879 @code{nnmaildir}, now actually store the article marks with each group.
16880 For these servers, archiving and restoring a group while preserving
16881 marks is fairly simple.
16882
16883 (Preserving the group level and group parameters as well still
16884 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
16885 though.)
16886
16887 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
16888 server, take a recursive copy of the server directory. There is no need
16889 to shut down Gnus, so archiving may be invoked by @code{cron} or
16890 similar. You restore the data by restoring the directory tree, and
16891 adding a server definition pointing to that directory in Gnus. The
16892 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
16893 might interfere with overwriting data, so you may want to shut down Gnus
16894 before you restore the data.
16895
16896 @node Web Searches
16897 @subsection Web Searches
16898 @cindex nnweb
16899 @cindex Google
16900 @cindex dejanews
16901 @cindex gmane
16902 @cindex Usenet searches
16903 @cindex searching the Usenet
16904
16905 It's, like, too neat to search the Usenet for articles that match a
16906 string, but it, like, totally @emph{sucks}, like, totally, to use one of
16907 those, like, Web browsers, and you, like, have to, rilly, like, look at
16908 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
16909 searches without having to use a browser.
16910
16911 The @code{nnweb} back end allows an easy interface to the mighty search
16912 engine. You create an @code{nnweb} group, enter a search pattern, and
16913 then enter the group and read the articles like you would any normal
16914 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
16915 Groups}) will do this in an easy-to-use fashion.
16916
16917 @code{nnweb} groups don't really lend themselves to being solid
16918 groups---they have a very fleeting idea of article numbers. In fact,
16919 each time you enter an @code{nnweb} group (not even changing the search
16920 pattern), you are likely to get the articles ordered in a different
16921 manner. Not even using duplicate suppression (@pxref{Duplicate
16922 Suppression}) will help, since @code{nnweb} doesn't even know the
16923 @code{Message-ID} of the articles before reading them using some search
16924 engines (Google, for instance). The only possible way to keep track
16925 of which articles you've read is by scoring on the @code{Date}
16926 header---mark all articles posted before the last date you read the
16927 group as read.
16928
16929 If the search engine changes its output substantially, @code{nnweb}
16930 won't be able to parse it and will fail. One could hardly fault the Web
16931 providers if they were to do this---their @emph{raison d'@^etre} is to
16932 make money off of advertisements, not to provide services to the
16933 community. Since @code{nnweb} washes the ads off all the articles, one
16934 might think that the providers might be somewhat miffed. We'll see.
16935
16936 You must have the @code{url} and @code{W3} package or those alternatives
16937 (try @code{customize-group} on the @samp{mm-url} variable group)
16938 installed to be able to use @code{nnweb}.
16939
16940 Virtual server variables:
16941
16942 @table @code
16943 @item nnweb-type
16944 @vindex nnweb-type
16945 What search engine type is being used. The currently supported types
16946 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
16947 @code{dejanews} is an alias to @code{google}.
16948
16949 @item nnweb-search
16950 @vindex nnweb-search
16951 The search string to feed to the search engine.
16952
16953 @item nnweb-max-hits
16954 @vindex nnweb-max-hits
16955 Advisory maximum number of hits per search to display. The default is
16956 999.
16957
16958 @item nnweb-type-definition
16959 @vindex nnweb-type-definition
16960 Type-to-definition alist. This alist says what @code{nnweb} should do
16961 with the various search engine types. The following elements must be
16962 present:
16963
16964 @table @code
16965 @item article
16966 Function to decode the article and provide something that Gnus
16967 understands.
16968
16969 @item map
16970 Function to create an article number to message header and URL alist.
16971
16972 @item search
16973 Function to send the search string to the search engine.
16974
16975 @item address
16976 The address the aforementioned function should send the search string
16977 to.
16978
16979 @item id
16980 Format string URL to fetch an article by @code{Message-ID}.
16981 @end table
16982
16983 @end table
16984
16985
16986 @node RSS
16987 @subsection RSS
16988 @cindex nnrss
16989 @cindex RSS
16990
16991 Some web sites have an RDF Site Summary (@acronym{RSS}).
16992 @acronym{RSS} is a format for summarizing headlines from news related
16993 sites (such as BBC or CNN). But basically anything list-like can be
16994 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16995 changes to a wiki (e.g., @url{http://cliki.net/site/recent-changes}).
16996
16997 @acronym{RSS} has a quite regular and nice interface, and it's
16998 possible to get the information Gnus needs to keep groups updated.
16999
17000 Note: you had better use Emacs which supports the @code{utf-8} coding
17001 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
17002 text by default. It is also used by default for non-@acronym{ASCII}
17003 group names.
17004
17005 @kindex G R (Group)
17006 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
17007 prompted for the location, the title and the description of the feed.
17008 The title, which allows any characters, will be used for the group name
17009 and the name of the group data file. The description can be omitted.
17010
17011 An easy way to get started with @code{nnrss} is to say something like
17012 the following in the group buffer: @kbd{B nnrss RET RET y}, then
17013 subscribe to groups.
17014
17015 The @code{nnrss} back end saves the group data file in
17016 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
17017 names containing non-@acronym{ASCII} characters will be encoded by the
17018 coding system specified with the @code{nnmail-pathname-coding-system}
17019 variable or other. Also @xref{Non-ASCII Group Names}, for more
17020 information.
17021
17022 The @code{nnrss} back end generates @samp{multipart/alternative}
17023 @acronym{MIME} articles in which each contains a @samp{text/plain} part
17024 and a @samp{text/html} part.
17025
17026 @cindex OPML
17027 You can also use the following commands to import and export your
17028 subscriptions from a file in @acronym{OPML} format (Outline Processor
17029 Markup Language).
17030
17031 @defun nnrss-opml-import file
17032 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
17033 file.
17034 @end defun
17035
17036 @defun nnrss-opml-export
17037 Write your current @acronym{RSS} subscriptions to a buffer in
17038 @acronym{OPML} format.
17039 @end defun
17040
17041 The following @code{nnrss} variables can be altered:
17042
17043 @table @code
17044 @item nnrss-directory
17045 @vindex nnrss-directory
17046 The directory where @code{nnrss} stores its files. The default is
17047 @file{~/News/rss/}.
17048
17049 @item nnrss-file-coding-system
17050 @vindex nnrss-file-coding-system
17051 The coding system used when reading and writing the @code{nnrss} groups
17052 data files. The default is the value of
17053 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
17054 in Emacs or @code{escape-quoted} in XEmacs).
17055
17056 @item nnrss-ignore-article-fields
17057 @vindex nnrss-ignore-article-fields
17058 Some feeds update constantly article fields during their publications,
17059 e.g., to indicate the number of comments. However, if there is
17060 a difference between the local article and the distant one, the latter
17061 is considered to be new. To avoid this and discard some fields, set this
17062 variable to the list of fields to be ignored. The default is
17063 @code{'(slash:comments)}.
17064
17065 @item nnrss-use-local
17066 @vindex nnrss-use-local
17067 @findex nnrss-generate-download-script
17068 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
17069 the feeds from local files in @code{nnrss-directory}. You can use
17070 the command @code{nnrss-generate-download-script} to generate a
17071 download script using @command{wget}.
17072 @end table
17073
17074 The following code may be helpful, if you want to show the description in
17075 the summary buffer.
17076
17077 @lisp
17078 (add-to-list 'nnmail-extra-headers nnrss-description-field)
17079 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
17080
17081 (defun gnus-user-format-function-X (header)
17082 (let ((descr
17083 (assq nnrss-description-field (mail-header-extra header))))
17084 (if descr (concat "\n\t" (cdr descr)) "")))
17085 @end lisp
17086
17087 The following code may be useful to open an nnrss url directly from the
17088 summary buffer.
17089
17090 @lisp
17091 (require 'browse-url)
17092
17093 (defun browse-nnrss-url (arg)
17094 (interactive "p")
17095 (let ((url (assq nnrss-url-field
17096 (mail-header-extra
17097 (gnus-data-header
17098 (assq (gnus-summary-article-number)
17099 gnus-newsgroup-data))))))
17100 (if url
17101 (progn
17102 (browse-url (cdr url))
17103 (gnus-summary-mark-as-read-forward 1))
17104 (gnus-summary-scroll-up arg))))
17105
17106 (eval-after-load "gnus"
17107 #'(define-key gnus-summary-mode-map
17108 (kbd "<RET>") 'browse-nnrss-url))
17109 (add-to-list 'nnmail-extra-headers nnrss-url-field)
17110 @end lisp
17111
17112 Even if you have added @samp{text/html} to the
17113 @code{mm-discouraged-alternatives} variable (@pxref{Display
17114 Customization, ,Display Customization, emacs-mime, The Emacs MIME
17115 Manual}) since you don't want to see @acronym{HTML} parts, it might be
17116 more useful especially in @code{nnrss} groups to display
17117 @samp{text/html} parts. Here's an example of setting
17118 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
17119 Parameters}) in order to display @samp{text/html} parts only in
17120 @code{nnrss} groups:
17121
17122 @lisp
17123 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
17124 (eval-after-load "gnus-sum"
17125 '(add-to-list
17126 'gnus-newsgroup-variables
17127 '(mm-discouraged-alternatives
17128 . '("text/html" "image/.*"))))
17129
17130 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
17131 (add-to-list
17132 'gnus-parameters
17133 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
17134 @end lisp
17135
17136
17137 @node Customizing W3
17138 @subsection Customizing W3
17139 @cindex W3
17140 @cindex html
17141 @cindex url
17142 @cindex Netscape
17143
17144 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
17145 alternatives) to display web pages. Emacs/W3 is documented in its own
17146 manual, but there are some things that may be more relevant for Gnus
17147 users.
17148
17149 For instance, a common question is how to make Emacs/W3 follow links
17150 using the @code{browse-url} functions (which will call some external web
17151 browser like Netscape). Here's one way:
17152
17153 @lisp
17154 (eval-after-load "w3"
17155 '(progn
17156 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
17157 (defun w3-fetch (&optional url target)
17158 (interactive (list (w3-read-url-with-default)))
17159 (if (eq major-mode 'gnus-article-mode)
17160 (browse-url url)
17161 (w3-fetch-orig url target)))))
17162 @end lisp
17163
17164 Put that in your @file{.emacs} file, and hitting links in W3-rendered
17165 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
17166 follow the link.
17167
17168
17169 @node Other Sources
17170 @section Other Sources
17171
17172 Gnus can do more than just read news or mail. The methods described
17173 below allow Gnus to view directories and files as if they were
17174 newsgroups.
17175
17176 @menu
17177 * Directory Groups:: You can read a directory as if it was a newsgroup.
17178 * Anything Groups:: Dired? Who needs dired?
17179 * Document Groups:: Single files can be the basis of a group.
17180 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
17181 * The Empty Backend:: The backend that never has any news.
17182 @end menu
17183
17184
17185 @node Directory Groups
17186 @subsection Directory Groups
17187 @cindex nndir
17188 @cindex directory groups
17189
17190 If you have a directory that has lots of articles in separate files in
17191 it, you might treat it as a newsgroup. The files have to have numerical
17192 names, of course.
17193
17194 This might be an opportune moment to mention @code{ange-ftp} (and its
17195 successor @code{efs}), that most wonderful of all wonderful Emacs
17196 packages. When I wrote @code{nndir}, I didn't think much about it---a
17197 back end to read directories. Big deal.
17198
17199 @code{ange-ftp} changes that picture dramatically. For instance, if you
17200 enter the @code{ange-ftp} file name
17201 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17202 @code{ange-ftp} or @code{efs} will actually allow you to read this
17203 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17204
17205 @code{nndir} will use @acronym{NOV} files if they are present.
17206
17207 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17208 articles with this method. You can use @code{nnmh} or @code{nnml} for
17209 whatever you use @code{nndir} for, so you could switch to any of those
17210 methods if you feel the need to have a non-read-only @code{nndir}.
17211
17212
17213 @node Anything Groups
17214 @subsection Anything Groups
17215 @cindex nneething
17216
17217 From the @code{nndir} back end (which reads a single spool-like
17218 directory), it's just a hop and a skip to @code{nneething}, which
17219 pretends that any arbitrary directory is a newsgroup. Strange, but
17220 true.
17221
17222 When @code{nneething} is presented with a directory, it will scan this
17223 directory and assign article numbers to each file. When you enter such
17224 a group, @code{nneething} must create ``headers'' that Gnus can use.
17225 After all, Gnus is a newsreader, in case you're forgetting.
17226 @code{nneething} does this in a two-step process. First, it snoops each
17227 file in question. If the file looks like an article (i.e., the first
17228 few lines look like headers), it will use this as the head. If this is
17229 just some arbitrary file without a head (e.g., a C source file),
17230 @code{nneething} will cobble up a header out of thin air. It will use
17231 file ownership, name and date and do whatever it can with these
17232 elements.
17233
17234 All this should happen automatically for you, and you will be presented
17235 with something that looks very much like a newsgroup. Totally like a
17236 newsgroup, to be precise. If you select an article, it will be displayed
17237 in the article buffer, just as usual.
17238
17239 If you select a line that represents a directory, Gnus will pop you into
17240 a new summary buffer for this @code{nneething} group. And so on. You can
17241 traverse the entire disk this way, if you feel like, but remember that
17242 Gnus is not dired, really, and does not intend to be, either.
17243
17244 There are two overall modes to this action---ephemeral or solid. When
17245 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17246 will not store information on what files you have read, and what files
17247 are new, and so on. If you create a solid @code{nneething} group the
17248 normal way with @kbd{G m}, Gnus will store a mapping table between
17249 article numbers and file names, and you can treat this group like any
17250 other groups. When you activate a solid @code{nneething} group, you will
17251 be told how many unread articles it contains, etc., etc.
17252
17253 Some variables:
17254
17255 @table @code
17256 @item nneething-map-file-directory
17257 @vindex nneething-map-file-directory
17258 All the mapping files for solid @code{nneething} groups will be stored
17259 in this directory, which defaults to @file{~/.nneething/}.
17260
17261 @item nneething-exclude-files
17262 @vindex nneething-exclude-files
17263 All files that match this regexp will be ignored. Nice to use to exclude
17264 auto-save files and the like, which is what it does by default.
17265
17266 @item nneething-include-files
17267 @vindex nneething-include-files
17268 Regexp saying what files to include in the group. If this variable is
17269 non-@code{nil}, only files matching this regexp will be included.
17270
17271 @item nneething-map-file
17272 @vindex nneething-map-file
17273 Name of the map files.
17274 @end table
17275
17276
17277 @node Document Groups
17278 @subsection Document Groups
17279 @cindex nndoc
17280 @cindex documentation group
17281 @cindex help group
17282
17283 @code{nndoc} is a cute little thing that will let you read a single file
17284 as a newsgroup. Several files types are supported:
17285
17286 @table @code
17287 @cindex Babyl
17288 @item babyl
17289 The Babyl format.
17290
17291 @cindex mbox
17292 @cindex Unix mbox
17293 @item mbox
17294 The standard Unix mbox file.
17295
17296 @cindex MMDF mail box
17297 @item mmdf
17298 The MMDF mail box format.
17299
17300 @item news
17301 Several news articles appended into a file.
17302
17303 @cindex rnews batch files
17304 @item rnews
17305 The rnews batch transport format.
17306
17307 @item nsmail
17308 Netscape mail boxes.
17309
17310 @item mime-parts
17311 @acronym{MIME} multipart messages.
17312
17313 @item standard-digest
17314 The standard (RFC 1153) digest format.
17315
17316 @item mime-digest
17317 A @acronym{MIME} digest of messages.
17318
17319 @item lanl-gov-announce
17320 Announcement messages from LANL Gov Announce.
17321
17322 @cindex git commit messages
17323 @item git
17324 @code{git} commit messages.
17325
17326 @cindex forwarded messages
17327 @item rfc822-forward
17328 A message forwarded according to RFC822.
17329
17330 @item outlook
17331 The Outlook mail box.
17332
17333 @item oe-dbx
17334 The Outlook Express dbx mail box.
17335
17336 @item exim-bounce
17337 A bounce message from the Exim MTA.
17338
17339 @item forward
17340 A message forwarded according to informal rules.
17341
17342 @item rfc934
17343 An RFC934-forwarded message.
17344
17345 @item mailman
17346 A mailman digest.
17347
17348 @item clari-briefs
17349 A digest of Clarinet brief news items.
17350
17351 @item slack-digest
17352 Non-standard digest format---matches most things, but does it badly.
17353
17354 @item mail-in-mail
17355 The last resort.
17356 @end table
17357
17358 You can also use the special ``file type'' @code{guess}, which means
17359 that @code{nndoc} will try to guess what file type it is looking at.
17360 @code{digest} means that @code{nndoc} should guess what digest type the
17361 file is.
17362
17363 @code{nndoc} will not try to change the file or insert any extra headers into
17364 it---it will simply, like, let you use the file as the basis for a
17365 group. And that's it.
17366
17367 If you have some old archived articles that you want to insert into your
17368 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17369 that. Say you have an old @file{RMAIL} file with mail that you now want
17370 to split into your new @code{nnml} groups. You look at that file using
17371 @code{nndoc} (using the @kbd{G f} command in the group buffer
17372 (@pxref{Foreign Groups})), set the process mark on all the articles in
17373 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17374 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17375 file is now also stored in lots of @code{nnml} directories, and you can
17376 delete that pesky @file{RMAIL} file. If you have the guts!
17377
17378 Virtual server variables:
17379
17380 @table @code
17381 @item nndoc-article-type
17382 @vindex nndoc-article-type
17383 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17384 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17385 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17386 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17387 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17388
17389 @item nndoc-post-type
17390 @vindex nndoc-post-type
17391 This variable says whether Gnus is to consider the group a news group or
17392 a mail group. There are two valid values: @code{mail} (the default)
17393 and @code{news}.
17394 @end table
17395
17396 @menu
17397 * Document Server Internals:: How to add your own document types.
17398 @end menu
17399
17400
17401 @node Document Server Internals
17402 @subsubsection Document Server Internals
17403
17404 Adding new document types to be recognized by @code{nndoc} isn't
17405 difficult. You just have to whip up a definition of what the document
17406 looks like, write a predicate function to recognize that document type,
17407 and then hook into @code{nndoc}.
17408
17409 First, here's an example document type definition:
17410
17411 @example
17412 (mmdf
17413 (article-begin . "^\^A\^A\^A\^A\n")
17414 (body-end . "^\^A\^A\^A\^A\n"))
17415 @end example
17416
17417 The definition is simply a unique @dfn{name} followed by a series of
17418 regexp pseudo-variable settings. Below are the possible
17419 variables---don't be daunted by the number of variables; most document
17420 types can be defined with very few settings:
17421
17422 @table @code
17423 @item first-article
17424 If present, @code{nndoc} will skip past all text until it finds
17425 something that match this regexp. All text before this will be
17426 totally ignored.
17427
17428 @item article-begin
17429 This setting has to be present in all document type definitions. It
17430 says what the beginning of each article looks like. To do more
17431 complicated things that cannot be dealt with a simple regexp, you can
17432 use @code{article-begin-function} instead of this.
17433
17434 @item article-begin-function
17435 If present, this should be a function that moves point to the beginning
17436 of each article. This setting overrides @code{article-begin}.
17437
17438 @item head-begin
17439 If present, this should be a regexp that matches the head of the
17440 article. To do more complicated things that cannot be dealt with a
17441 simple regexp, you can use @code{head-begin-function} instead of this.
17442
17443 @item head-begin-function
17444 If present, this should be a function that moves point to the head of
17445 the article. This setting overrides @code{head-begin}.
17446
17447 @item head-end
17448 This should match the end of the head of the article. It defaults to
17449 @samp{^$}---the empty line.
17450
17451 @item body-begin
17452 This should match the beginning of the body of the article. It defaults
17453 to @samp{^\n}. To do more complicated things that cannot be dealt with
17454 a simple regexp, you can use @code{body-begin-function} instead of this.
17455
17456 @item body-begin-function
17457 If present, this function should move point to the beginning of the body
17458 of the article. This setting overrides @code{body-begin}.
17459
17460 @item body-end
17461 If present, this should match the end of the body of the article. To do
17462 more complicated things that cannot be dealt with a simple regexp, you
17463 can use @code{body-end-function} instead of this.
17464
17465 @item body-end-function
17466 If present, this function should move point to the end of the body of
17467 the article. This setting overrides @code{body-end}.
17468
17469 @item file-begin
17470 If present, this should match the beginning of the file. All text
17471 before this regexp will be totally ignored.
17472
17473 @item file-end
17474 If present, this should match the end of the file. All text after this
17475 regexp will be totally ignored.
17476
17477 @end table
17478
17479 So, using these variables @code{nndoc} is able to dissect a document
17480 file into a series of articles, each with a head and a body. However, a
17481 few more variables are needed since not all document types are all that
17482 news-like---variables needed to transform the head or the body into
17483 something that's palatable for Gnus:
17484
17485 @table @code
17486 @item prepare-body-function
17487 If present, this function will be called when requesting an article. It
17488 will be called with point at the start of the body, and is useful if the
17489 document has encoded some parts of its contents.
17490
17491 @item article-transform-function
17492 If present, this function is called when requesting an article. It's
17493 meant to be used for more wide-ranging transformation of both head and
17494 body of the article.
17495
17496 @item generate-head-function
17497 If present, this function is called to generate a head that Gnus can
17498 understand. It is called with the article number as a parameter, and is
17499 expected to generate a nice head for the article in question. It is
17500 called when requesting the headers of all articles.
17501
17502 @item generate-article-function
17503 If present, this function is called to generate an entire article that
17504 Gnus can understand. It is called with the article number as a
17505 parameter when requesting all articles.
17506
17507 @item dissection-function
17508 If present, this function is called to dissect a document by itself,
17509 overriding @code{first-article}, @code{article-begin},
17510 @code{article-begin-function}, @code{head-begin},
17511 @code{head-begin-function}, @code{head-end}, @code{body-begin},
17512 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
17513 @code{file-begin}, and @code{file-end}.
17514
17515 @end table
17516
17517 Let's look at the most complicated example I can come up with---standard
17518 digests:
17519
17520 @example
17521 (standard-digest
17522 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
17523 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
17524 (prepare-body-function . nndoc-unquote-dashes)
17525 (body-end-function . nndoc-digest-body-end)
17526 (head-end . "^ ?$")
17527 (body-begin . "^ ?\n")
17528 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
17529 (subtype digest guess))
17530 @end example
17531
17532 We see that all text before a 70-width line of dashes is ignored; all
17533 text after a line that starts with that @samp{^End of} is also ignored;
17534 each article begins with a 30-width line of dashes; the line separating
17535 the head from the body may contain a single space; and that the body is
17536 run through @code{nndoc-unquote-dashes} before being delivered.
17537
17538 To hook your own document definition into @code{nndoc}, use the
17539 @code{nndoc-add-type} function. It takes two parameters---the first
17540 is the definition itself and the second (optional) parameter says
17541 where in the document type definition alist to put this definition.
17542 The alist is traversed sequentially, and
17543 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
17544 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
17545 @code{mmdf} type, and so on. These type predicates should return
17546 @code{nil} if the document is not of the correct type; @code{t} if it
17547 is of the correct type; and a number if the document might be of the
17548 correct type. A high number means high probability; a low number
17549 means low probability with @samp{0} being the lowest valid number.
17550
17551
17552 @node Mail-To-News Gateways
17553 @subsection Mail-To-News Gateways
17554 @cindex mail-to-news gateways
17555 @cindex gateways
17556
17557 If your local @code{nntp} server doesn't allow posting, for some reason
17558 or other, you can post using one of the numerous mail-to-news gateways.
17559 The @code{nngateway} back end provides the interface.
17560
17561 Note that you can't read anything from this back end---it can only be
17562 used to post with.
17563
17564 Server variables:
17565
17566 @table @code
17567 @item nngateway-address
17568 @vindex nngateway-address
17569 This is the address of the mail-to-news gateway.
17570
17571 @item nngateway-header-transformation
17572 @vindex nngateway-header-transformation
17573 News headers often have to be transformed in some odd way or other
17574 for the mail-to-news gateway to accept it. This variable says what
17575 transformation should be called, and defaults to
17576 @code{nngateway-simple-header-transformation}. The function is called
17577 narrowed to the headers to be transformed and with one parameter---the
17578 gateway address.
17579
17580 This default function just inserts a new @code{To} header based on the
17581 @code{Newsgroups} header and the gateway address.
17582 For instance, an article with this @code{Newsgroups} header:
17583
17584 @example
17585 Newsgroups: alt.religion.emacs
17586 @end example
17587
17588 will get this @code{To} header inserted:
17589
17590 @example
17591 To: alt-religion-emacs@@GATEWAY
17592 @end example
17593
17594 The following pre-defined functions exist:
17595
17596 @findex nngateway-simple-header-transformation
17597 @table @code
17598
17599 @item nngateway-simple-header-transformation
17600 Creates a @code{To} header that looks like
17601 @var{newsgroup}@@@code{nngateway-address}.
17602
17603 @findex nngateway-mail2news-header-transformation
17604
17605 @item nngateway-mail2news-header-transformation
17606 Creates a @code{To} header that looks like
17607 @code{nngateway-address}.
17608 @end table
17609
17610 @end table
17611
17612 Here's an example:
17613
17614 @lisp
17615 (setq gnus-post-method
17616 '(nngateway
17617 "mail2news@@replay.com"
17618 (nngateway-header-transformation
17619 nngateway-mail2news-header-transformation)))
17620 @end lisp
17621
17622 So, to use this, simply say something like:
17623
17624 @lisp
17625 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
17626 @end lisp
17627
17628
17629 @node The Empty Backend
17630 @subsection The Empty Backend
17631 @cindex nnnil
17632
17633 @code{nnnil} is a backend that can be used as a placeholder if you
17634 have to specify a backend somewhere, but don't really want to. The
17635 classical example is if you don't want to have a primary select
17636 methods, but want to only use secondary ones:
17637
17638 @lisp
17639 (setq gnus-select-method '(nnnil ""))
17640 (setq gnus-secondary-select-methods
17641 '((nnimap "foo")
17642 (nnml "")))
17643 @end lisp
17644
17645
17646 @node Combined Groups
17647 @section Combined Groups
17648
17649 Gnus allows combining a mixture of all the other group types into bigger
17650 groups.
17651
17652 @menu
17653 * Virtual Groups:: Combining articles from many groups.
17654 @end menu
17655
17656
17657 @node Virtual Groups
17658 @subsection Virtual Groups
17659 @cindex nnvirtual
17660 @cindex virtual groups
17661 @cindex merging groups
17662
17663 An @dfn{nnvirtual group} is really nothing more than a collection of
17664 other groups.
17665
17666 For instance, if you are tired of reading many small groups, you can
17667 put them all in one big group, and then grow tired of reading one
17668 big, unwieldy group. The joys of computing!
17669
17670 You specify @code{nnvirtual} as the method. The address should be a
17671 regexp to match component groups.
17672
17673 All marks in the virtual group will stick to the articles in the
17674 component groups. So if you tick an article in a virtual group, the
17675 article will also be ticked in the component group from whence it
17676 came. (And vice versa---marks from the component groups will also be
17677 shown in the virtual group.). To create an empty virtual group, run
17678 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
17679 and edit the method regexp with @kbd{M-e}
17680 (@code{gnus-group-edit-group-method})
17681
17682 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
17683 newsgroups into one, big, happy newsgroup:
17684
17685 @lisp
17686 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
17687 @end lisp
17688
17689 The component groups can be native or foreign; everything should work
17690 smoothly, but if your computer explodes, it was probably my fault.
17691
17692 Collecting the same group from several servers might actually be a good
17693 idea if users have set the Distribution header to limit distribution.
17694 If you would like to read @samp{soc.motss} both from a server in Japan
17695 and a server in Norway, you could use the following as the group regexp:
17696
17697 @example
17698 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
17699 @end example
17700
17701 (Remember, though, that if you're creating the group with @kbd{G m}, you
17702 shouldn't double the backslashes, and you should leave off the quote
17703 characters at the beginning and the end of the string.)
17704
17705 This should work kinda smoothly---all articles from both groups should
17706 end up in this one, and there should be no duplicates. Threading (and
17707 the rest) will still work as usual, but there might be problems with the
17708 sequence of articles. Sorting on date might be an option here
17709 (@pxref{Selecting a Group}).
17710
17711 One limitation, however---all groups included in a virtual
17712 group have to be alive (i.e., subscribed or unsubscribed). Killed or
17713 zombie groups can't be component groups for @code{nnvirtual} groups.
17714
17715 @vindex nnvirtual-always-rescan
17716 If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which
17717 is the default), @code{nnvirtual} will always scan groups for unread
17718 articles when entering a virtual group. If this variable is @code{nil}
17719 and you read articles in a component group after the virtual group has
17720 been activated, the read articles from the component group will show up
17721 when you enter the virtual group. You'll also see this effect if you
17722 have two virtual groups that have a component group in common. If
17723 that's the case, you should set this variable to @code{t}. Or you can
17724 just tap @code{M-g} on the virtual group every time before you enter
17725 it---it'll have much the same effect.
17726
17727 @code{nnvirtual} can have both mail and news groups as component groups.
17728 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
17729 has to ask the back end of the component group the article comes from
17730 whether it is a news or mail back end. However, when you do a @kbd{^},
17731 there is typically no sure way for the component back end to know this,
17732 and in that case @code{nnvirtual} tells Gnus that the article came from a
17733 not-news back end. (Just to be on the safe side.)
17734
17735 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
17736 line from the article you respond to in these cases.
17737
17738 @code{nnvirtual} groups do not inherit anything but articles and marks
17739 from component groups---group parameters, for instance, are not
17740 inherited.
17741
17742
17743 @node Email Based Diary
17744 @section Email Based Diary
17745 @cindex diary
17746 @cindex email based diary
17747 @cindex calendar
17748
17749 This section describes a special mail back end called @code{nndiary},
17750 and its companion library @code{gnus-diary}. It is ``special'' in the
17751 sense that it is not meant to be one of the standard alternatives for
17752 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
17753 Instead, it is used to treat @emph{some} of your mails in a special way,
17754 namely, as event reminders.
17755
17756 Here is a typical scenario:
17757
17758 @itemize @bullet
17759 @item
17760 You've got a date with Andy Mc Dowell or Bruce Willis (select according
17761 to your sexual preference) in one month. You don't want to forget it.
17762 @item
17763 So you send a ``reminder'' message (actually, a diary one) to yourself.
17764 @item
17765 You forget all about it and keep on getting and reading new mail, as usual.
17766 @item
17767 From time to time, as you type `g' in the group buffer and as the date
17768 is getting closer, the message will pop up again to remind you of your
17769 appointment, just as if it were new and unread.
17770 @item
17771 Read your ``new'' messages, this one included, and start dreaming again
17772 of the night you're gonna have.
17773 @item
17774 Once the date is over (you actually fell asleep just after dinner), the
17775 message will be automatically deleted if it is marked as expirable.
17776 @end itemize
17777
17778 The Gnus Diary back end has the ability to handle regular appointments
17779 (that wouldn't ever be deleted) as well as punctual ones, operates as a
17780 real mail back end and is configurable in many ways. All of this is
17781 explained in the sections below.
17782
17783 @menu
17784 * The NNDiary Back End:: Basic setup and usage.
17785 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
17786 * Sending or Not Sending:: A final note on sending diary messages.
17787 @end menu
17788
17789
17790 @node The NNDiary Back End
17791 @subsection The NNDiary Back End
17792 @cindex nndiary
17793 @cindex the nndiary back end
17794
17795 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
17796 Spool}). Actually, it could appear as a mix of @code{nnml} and
17797 @code{nndraft}. If you know @code{nnml}, you're already familiar with
17798 the message storing scheme of @code{nndiary}: one file per message, one
17799 directory per group.
17800
17801 Before anything, there is one requirement to be able to run
17802 @code{nndiary} properly: you @emph{must} use the group timestamp feature
17803 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
17804 Timestamp} to see how it's done.
17805
17806 @menu
17807 * Diary Messages:: What makes a message valid for nndiary.
17808 * Running NNDiary:: NNDiary has two modes of operation.
17809 * Customizing NNDiary:: Bells and whistles.
17810 @end menu
17811
17812 @node Diary Messages
17813 @subsubsection Diary Messages
17814 @cindex nndiary messages
17815 @cindex nndiary mails
17816
17817 @code{nndiary} messages are just normal ones, except for the mandatory
17818 presence of 7 special headers. These headers are of the form
17819 @code{X-Diary-<something>}, @code{<something>} being one of
17820 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
17821 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
17822 @code{dow} means ``Day of Week''. These headers actually behave like
17823 crontab specifications and define the event date(s):
17824
17825 @itemize @bullet
17826 @item
17827 For all headers except the @code{Time-Zone} one, a header value is
17828 either a star (meaning all possible values), or a list of fields
17829 (separated by a comma).
17830 @item
17831 A field is either an integer, or a range.
17832 @item
17833 A range is two integers separated by a dash.
17834 @item
17835 Possible integer values are 0--59 for @code{Minute}, 0--23 for
17836 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
17837 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
17838 @item
17839 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
17840 mean ``all possible values'', but ``use only the other field''. Note
17841 that if both are star'ed, the use of either one gives the same result.
17842 @item
17843 The @code{Time-Zone} header is special in that it can only have one
17844 value (@code{GMT}, for instance). A star doesn't mean ``all possible
17845 values'' (because it makes no sense), but ``the current local time
17846 zone''. Most of the time, you'll be using a star here. However, for a
17847 list of available time zone values, see the variable
17848 @code{nndiary-headers}.
17849 @end itemize
17850
17851 As a concrete example, here are the diary headers to add to your message
17852 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
17853 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
17854 what to do then):
17855
17856 @example
17857 X-Diary-Minute: 0
17858 X-Diary-Hour: 12, 20-24
17859 X-Diary-Dom: 1
17860 X-Diary-Month: *
17861 X-Diary-Year: 1999-2010
17862 X-Diary-Dow: 1
17863 X-Diary-Time-Zone: *
17864 @end example
17865
17866 @node Running NNDiary
17867 @subsubsection Running NNDiary
17868 @cindex running nndiary
17869 @cindex nndiary operation modes
17870
17871 @code{nndiary} has two modes of operation: ``traditional'' (the default)
17872 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
17873 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
17874 from your primary mail back end to nndiary groups in order to handle them
17875 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
17876 mail and handles it independently from your primary mail back end.
17877
17878 One should note that Gnus is not inherently designed to allow several
17879 ``master'' mail back ends at the same time. However, this does make
17880 sense with @code{nndiary}: you really want to send and receive diary
17881 messages to your diary groups directly. So, @code{nndiary} supports
17882 being sort of a ``second primary mail back end'' (to my knowledge, it is
17883 the only back end offering this feature). However, there is a limitation
17884 (which I hope to fix some day): respooling doesn't work in autonomous
17885 mode.
17886
17887 In order to use @code{nndiary} in autonomous mode, you have several
17888 things to do:
17889
17890 @itemize @bullet
17891 @item
17892 Allow @code{nndiary} to retrieve new mail by itself. Put the following
17893 line in your @file{~/.gnus.el} file:
17894
17895 @lisp
17896 (setq nndiary-get-new-mail t)
17897 @end lisp
17898 @item
17899 You must arrange for diary messages (those containing @code{X-Diary-*}
17900 headers) to be split in a private folder @emph{before} Gnus treat them.
17901 Again, this is needed because Gnus cannot (yet ?) properly handle
17902 multiple primary mail back ends. Getting those messages from a separate
17903 source will compensate this misfeature to some extent.
17904
17905 As an example, here's my procmailrc entry to store diary files in
17906 @file{~/.nndiary} (the default @code{nndiary} mail source file):
17907
17908 @example
17909 :0 HD :
17910 * ^X-Diary
17911 .nndiary
17912 @end example
17913 @end itemize
17914
17915 Once this is done, you might want to customize the following two options
17916 that affect the diary mail retrieval and splitting processes:
17917
17918 @defvar nndiary-mail-sources
17919 This is the diary-specific replacement for the standard
17920 @code{mail-sources} variable. It obeys the same syntax, and defaults to
17921 @code{(file :path "~/.nndiary")}.
17922 @end defvar
17923
17924 @defvar nndiary-split-methods
17925 This is the diary-specific replacement for the standard
17926 @code{nnmail-split-methods} variable. It obeys the same syntax.
17927 @end defvar
17928
17929 Finally, you may add a permanent @code{nndiary} virtual server
17930 (something like @code{(nndiary "diary")} should do) to your
17931 @code{gnus-secondary-select-methods}.
17932
17933 Hopefully, almost everything (see the TODO section in
17934 @file{nndiary.el}) will work as expected when you restart Gnus: in
17935 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
17936 also get your new diary mails and split them according to your
17937 diary-specific rules, @kbd{F} will find your new diary groups etc.
17938
17939 @node Customizing NNDiary
17940 @subsubsection Customizing NNDiary
17941 @cindex customizing nndiary
17942 @cindex nndiary customization
17943
17944 Now that @code{nndiary} is up and running, it's time to customize it.
17945 The custom group is called @code{nndiary} (no, really ?!). You should
17946 browse it to figure out which options you'd like to tweak. The following
17947 two variables are probably the only ones you will want to change:
17948
17949 @defvar nndiary-reminders
17950 This is the list of times when you want to be reminded of your
17951 appointments (e.g., 3 weeks before, then 2 days before, then 1 hour
17952 before and that's it). Remember that ``being reminded'' means that the
17953 diary message will pop up as brand new and unread again when you get new
17954 mail.
17955 @end defvar
17956
17957 @defvar nndiary-week-starts-on-monday
17958 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
17959 default).
17960 @end defvar
17961
17962
17963 @node The Gnus Diary Library
17964 @subsection The Gnus Diary Library
17965 @cindex gnus-diary
17966 @cindex the gnus diary library
17967
17968 Using @code{nndiary} manually (I mean, writing the headers by hand and
17969 so on) would be rather boring. Fortunately, there is a library called
17970 @code{gnus-diary} written on top of @code{nndiary}, that does many
17971 useful things for you.
17972
17973 In order to use it, add the following line to your @file{~/.gnus.el} file:
17974
17975 @lisp
17976 (require 'gnus-diary)
17977 @end lisp
17978
17979 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
17980 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
17981 (sorry if you used them before).
17982
17983
17984 @menu
17985 * Diary Summary Line Format:: A nicer summary buffer line format.
17986 * Diary Articles Sorting:: A nicer way to sort messages.
17987 * Diary Headers Generation:: Not doing it manually.
17988 * Diary Group Parameters:: Not handling them manually.
17989 @end menu
17990
17991 @node Diary Summary Line Format
17992 @subsubsection Diary Summary Line Format
17993 @cindex diary summary buffer line
17994 @cindex diary summary line format
17995
17996 Displaying diary messages in standard summary line format (usually
17997 something like @samp{From Joe: Subject}) is pretty useless. Most of
17998 the time, you're the one who wrote the message, and you mostly want to
17999 see the event's date.
18000
18001 @code{gnus-diary} provides two supplemental user formats to be used in
18002 summary line formats. @code{D} corresponds to a formatted time string
18003 for the next occurrence of the event (e.g., ``Sat, Sep 22 01, 12:00''),
18004 while @code{d} corresponds to an approximate remaining time until the
18005 next occurrence of the event (e.g., ``in 6 months, 1 week'').
18006
18007 For example, here's how Joe's birthday is displayed in my
18008 @code{nndiary+diary:birthdays} summary buffer (note that the message is
18009 expirable, but will never be deleted, as it specifies a periodic event):
18010
18011 @example
18012 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
18013 @end example
18014
18015 In order to get something like the above, you would normally add the
18016 following line to your diary groups'parameters:
18017
18018 @lisp
18019 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
18020 @end lisp
18021
18022 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
18023 Parameters}). You can however customize the provided summary line format
18024 with the following user options:
18025
18026 @defvar gnus-diary-summary-line-format
18027 Defines the summary line format used for diary groups (@pxref{Summary
18028 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18029 diary groups'parameters.
18030 @end defvar
18031
18032 @defvar gnus-diary-time-format
18033 Defines the format to display dates in diary summary buffers. This is
18034 used by the @code{D} user format. See the docstring for details.
18035 @end defvar
18036
18037 @defvar gnus-diary-delay-format-function
18038 Defines the format function to use for displaying delays (remaining
18039 times) in diary summary buffers. This is used by the @code{d} user
18040 format. There are currently built-in functions for English and French;
18041 you can also define your own. See the docstring for details.
18042 @end defvar
18043
18044 @node Diary Articles Sorting
18045 @subsubsection Diary Articles Sorting
18046 @cindex diary articles sorting
18047 @cindex diary summary lines sorting
18048 @findex gnus-summary-sort-by-schedule
18049 @findex gnus-thread-sort-by-schedule
18050 @findex gnus-article-sort-by-schedule
18051
18052 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18053 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18054 @code{gnus-thread-sort-by-schedule} and
18055 @code{gnus-article-sort-by-schedule}. These functions let you organize
18056 your diary summary buffers from the closest event to the farthest one.
18057
18058 @code{gnus-diary} automatically installs
18059 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18060 buffer's ``sort'' menu, and the two others as the primary (hence
18061 default) sorting functions in the group parameters (@pxref{Diary Group
18062 Parameters}).
18063
18064 @node Diary Headers Generation
18065 @subsubsection Diary Headers Generation
18066 @cindex diary headers generation
18067 @findex gnus-diary-check-message
18068
18069 @code{gnus-diary} provides a function called
18070 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18071 headers. This function ensures that the current message contains all the
18072 required diary headers, and prompts you for values or corrections if
18073 needed.
18074
18075 This function is hooked into the @code{nndiary} back end, so that
18076 moving or copying an article to a diary group will trigger it
18077 automatically. It is also bound to @kbd{C-c C-f d} in
18078 @code{message-mode} and @code{article-edit-mode} in order to ease the
18079 process of converting a usual mail to a diary one.
18080
18081 This function takes a prefix argument which will force prompting of
18082 all diary headers, regardless of their presence or validity. That way,
18083 you can very easily reschedule an already valid diary message, for
18084 instance.
18085
18086 @node Diary Group Parameters
18087 @subsubsection Diary Group Parameters
18088 @cindex diary group parameters
18089
18090 When you create a new diary group, or visit one, @code{gnus-diary}
18091 automatically checks your group parameters and if needed, sets the
18092 summary line format to the diary-specific value, installs the
18093 diary-specific sorting functions, and also adds the different
18094 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18095 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18096 on a diary group to prepare a message, these headers will be inserted
18097 automatically (although not filled with proper values yet).
18098
18099 @node Sending or Not Sending
18100 @subsection Sending or Not Sending
18101
18102 Well, assuming you've read all of the above, here are two final notes on
18103 mail sending with @code{nndiary}:
18104
18105 @itemize @bullet
18106 @item
18107 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18108 messages for real. This means for instance that you can give
18109 appointments to anybody (provided they use Gnus and @code{nndiary}) by
18110 sending the diary message to them as well.
18111 @item
18112 However, since @code{nndiary} also has a @code{request-post} method, you
18113 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18114 message won't actually be sent; just stored locally in the group. This
18115 comes in very handy for private appointments.
18116 @end itemize
18117
18118 @node Gnus Unplugged
18119 @section Gnus Unplugged
18120 @cindex offline
18121 @cindex unplugged
18122 @cindex agent
18123 @cindex Gnus agent
18124 @cindex Gnus unplugged
18125
18126 In olden times (ca. February '88), people used to run their newsreaders
18127 on big machines with permanent connections to the net. News transport
18128 was dealt with by news servers, and all the newsreaders had to do was to
18129 read news. Believe it or not.
18130
18131 Nowadays most people read news and mail at home, and use some sort of
18132 modem to connect to the net. To avoid running up huge phone bills, it
18133 would be nice to have a way to slurp down all the news and mail, hang up
18134 the phone, read for several hours, and then upload any responses you
18135 have to make. And then you repeat the procedure.
18136
18137 Of course, you can use news servers for doing this as well. I've used
18138 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18139 for some years, but doing that's a bore. Moving the news server
18140 functionality up to the newsreader makes sense if you're the only person
18141 reading news on a machine.
18142
18143 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18144 fact, you don't have to configure anything as the agent is now enabled
18145 by default (@pxref{Agent Variables, gnus-agent}).
18146
18147 Of course, to use it as such, you have to learn a few new commands.
18148
18149 @menu
18150 * Agent Basics:: How it all is supposed to work.
18151 * Agent Categories:: How to tell the Gnus Agent what to download.
18152 * Agent Commands:: New commands for all the buffers.
18153 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18154 * Agent as Cache:: The Agent is a big cache too.
18155 * Agent Expiry:: How to make old articles go away.
18156 * Agent Regeneration:: How to recover from lost connections and other accidents.
18157 * Agent and flags:: How the Agent maintains flags.
18158 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18159 * Outgoing Messages:: What happens when you post/mail something?
18160 * Agent Variables:: Customizing is fun.
18161 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18162 * Batching Agents:: How to fetch news from a @code{cron} job.
18163 * Agent Caveats:: What you think it'll do and what it does.
18164 @end menu
18165
18166
18167 @node Agent Basics
18168 @subsection Agent Basics
18169
18170 First, let's get some terminology out of the way.
18171
18172 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18173 connection to the net (and notified the Agent that this is the case).
18174 When the connection to the net is up again (and Gnus knows this), the
18175 Agent is @dfn{plugged}.
18176
18177 The @dfn{local} machine is the one you're running on, and which isn't
18178 connected to the net continuously.
18179
18180 @dfn{Downloading} means fetching things from the net to your local
18181 machine. @dfn{Uploading} is doing the opposite.
18182
18183 You know that Gnus gives you all the opportunity you'd ever want for
18184 shooting yourself in the foot. Some people call it flexibility. Gnus
18185 is also customizable to a great extent, which means that the user has a
18186 say on how Gnus behaves. Other newsreaders might unconditionally shoot
18187 you in your foot, but with Gnus, you have a choice!
18188
18189 Gnus is never really in plugged or unplugged state. Rather, it applies
18190 that state to each server individually. This means that some servers
18191 can be plugged while others can be unplugged. Additionally, some
18192 servers can be ignored by the Agent altogether (which means that
18193 they're kinda like plugged always).
18194
18195 So when you unplug the Agent and then wonder why is Gnus opening a
18196 connection to the Net, the next step to do is to look whether all
18197 servers are agentized. If there is an unagentized server, you found
18198 the culprit.
18199
18200 Another thing is the @dfn{offline} state. Sometimes, servers aren't
18201 reachable. When Gnus notices this, it asks you whether you want the
18202 server to be switched to offline state. If you say yes, then the
18203 server will behave somewhat as if it was unplugged, except that Gnus
18204 will ask you whether you want to switch it back online again.
18205
18206 Let's take a typical Gnus session using the Agent.
18207
18208 @itemize @bullet
18209
18210 @item
18211 @findex gnus-unplugged
18212 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
18213 Agent in a disconnected state. You can read all the news that you have
18214 already fetched while in this mode.
18215
18216 @item
18217 You then decide to see whether any new news has arrived. You connect
18218 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
18219 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
18220 as usual. To check for new mail in unplugged mode (@pxref{Mail
18221 Source Specifiers}).
18222
18223 @item
18224 You can then read the new news immediately, or you can download the
18225 news onto your local machine. If you want to do the latter, you press
18226 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
18227 all the eligible articles in all the groups. (To let Gnus know which
18228 articles you want to download, @pxref{Agent Categories}).
18229
18230 @item
18231 After fetching the articles, you press @kbd{J j} to make Gnus become
18232 unplugged again, and you shut down the PPP thing (or whatever). And
18233 then you read the news offline.
18234
18235 @item
18236 And then you go to step 2.
18237 @end itemize
18238
18239 Here are some things you should do the first time (or so) that you use
18240 the Agent.
18241
18242 @itemize @bullet
18243
18244 @item
18245 Decide which servers should be covered by the Agent. If you have a mail
18246 back end, it would probably be nonsensical to have it covered by the
18247 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
18248 @kbd{J a} on the server (or servers) that you wish to have covered by the
18249 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
18250 added servers you do not wish to have covered by the Agent. By default,
18251 no servers are agentized.
18252
18253 @item
18254 Decide on download policy. It's fairly simple once you decide whether
18255 you are going to use agent categories, topic parameters, and/or group
18256 parameters to implement your policy. If you're new to gnus, it
18257 is probably best to start with a category, @xref{Agent Categories}.
18258
18259 Both topic parameters (@pxref{Topic Parameters}) and agent categories
18260 (@pxref{Agent Categories}) provide for setting a policy that applies
18261 to multiple groups. Which you use is entirely up to you. Topic
18262 parameters do override categories so, if you mix the two, you'll have
18263 to take that into account. If you have a few groups that deviate from
18264 your policy, you can use group parameters (@pxref{Group Parameters}) to
18265 configure them.
18266
18267 @item
18268 Uhm@dots{} that's it.
18269 @end itemize
18270
18271
18272 @node Agent Categories
18273 @subsection Agent Categories
18274
18275 One of the main reasons to integrate the news transport layer into the
18276 newsreader is to allow greater control over what articles to download.
18277 There's not much point in downloading huge amounts of articles, just to
18278 find out that you're not interested in reading any of them. It's better
18279 to be somewhat more conservative in choosing what to download, and then
18280 mark the articles for downloading manually if it should turn out that
18281 you're interested in the articles anyway.
18282
18283 One of the more effective methods for controlling what is to be
18284 downloaded is to create a @dfn{category} and then assign some (or all)
18285 groups to this category. Groups that do not belong in any other
18286 category belong to the @code{default} category. Gnus has its own
18287 buffer for creating and managing categories.
18288
18289 If you prefer, you can also use group parameters (@pxref{Group
18290 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
18291 alternative approach to controlling the agent. The only real
18292 difference is that categories are specific to the agent (so there is
18293 less to learn) while group and topic parameters include the kitchen
18294 sink.
18295
18296 Since you can set agent parameters in several different places we have
18297 a rule to decide which source to believe. This rule specifies that
18298 the parameter sources are checked in the following order: group
18299 parameters, topic parameters, agent category, and finally customizable
18300 variables. So you can mix all of these sources to produce a wide range
18301 of behavior, just don't blame me if you don't remember where you put
18302 your settings.
18303
18304 @menu
18305 * Category Syntax:: What a category looks like.
18306 * Category Buffer:: A buffer for maintaining categories.
18307 * Category Variables:: Customize'r'Us.
18308 @end menu
18309
18310
18311 @node Category Syntax
18312 @subsubsection Category Syntax
18313
18314 A category consists of a name, the list of groups belonging to the
18315 category, and a number of optional parameters that override the
18316 customizable variables. The complete list of agent parameters are
18317 listed below.
18318
18319 @cindex Agent Parameters
18320 @table @code
18321 @item agent-groups
18322 The list of groups that are in this category.
18323
18324 @item agent-predicate
18325 A predicate which (generally) gives a rough outline of which articles
18326 are eligible for downloading; and
18327
18328 @item agent-score
18329 a score rule which (generally) gives you a finer granularity when
18330 deciding what articles to download. (Note that this @dfn{download
18331 score} is not necessarily related to normal scores.)
18332
18333 @item agent-enable-expiration
18334 a boolean indicating whether the agent should expire old articles in
18335 this group. Most groups should be expired to conserve disk space. In
18336 fact, its probably safe to say that the gnus.* hierarchy contains the
18337 only groups that should not be expired.
18338
18339 @item agent-days-until-old
18340 an integer indicating the number of days that the agent should wait
18341 before deciding that a read article is safe to expire.
18342
18343 @item agent-low-score
18344 an integer that overrides the value of @code{gnus-agent-low-score}.
18345
18346 @item agent-high-score
18347 an integer that overrides the value of @code{gnus-agent-high-score}.
18348
18349 @item agent-short-article
18350 an integer that overrides the value of
18351 @code{gnus-agent-short-article}.
18352
18353 @item agent-long-article
18354 an integer that overrides the value of @code{gnus-agent-long-article}.
18355
18356 @item agent-enable-undownloaded-faces
18357 a symbol indicating whether the summary buffer should display
18358 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
18359 faces. Any symbol other than @code{nil} will enable the use of
18360 undownloaded faces.
18361 @end table
18362
18363 The name of a category can not be changed once the category has been
18364 created.
18365
18366 Each category maintains a list of groups that are exclusive members of
18367 that category. The exclusivity rule is automatically enforced, add a
18368 group to a new category and it is automatically removed from its old
18369 category.
18370
18371 A predicate in its simplest form can be a single predicate such as
18372 @code{true} or @code{false}. These two will download every available
18373 article or nothing respectively. In the case of these two special
18374 predicates an additional score rule is superfluous.
18375
18376 Predicates of @code{high} or @code{low} download articles in respect of
18377 their scores in relationship to @code{gnus-agent-high-score} and
18378 @code{gnus-agent-low-score} as described below.
18379
18380 To gain even finer control of what is to be regarded eligible for
18381 download a predicate can consist of a number of predicates with logical
18382 operators sprinkled in between.
18383
18384 Perhaps some examples are in order.
18385
18386 Here's a simple predicate. (It's the default predicate, in fact, used
18387 for all groups that don't belong to any other category.)
18388
18389 @lisp
18390 short
18391 @end lisp
18392
18393 Quite simple, eh? This predicate is true if and only if the article is
18394 short (for some value of ``short'').
18395
18396 Here's a more complex predicate:
18397
18398 @lisp
18399 (or high
18400 (and
18401 (not low)
18402 (not long)))
18403 @end lisp
18404
18405 This means that an article should be downloaded if it has a high score,
18406 or if the score is not low and the article is not long. You get the
18407 drift.
18408
18409 The available logical operators are @code{or}, @code{and} and
18410 @code{not}. (If you prefer, you can use the more ``C''-ish operators
18411 @samp{|}, @code{&} and @code{!} instead.)
18412
18413 The following predicates are pre-defined, but if none of these fit what
18414 you want to do, you can write your own.
18415
18416 When evaluating each of these predicates, the named constant will be
18417 bound to the value determined by calling
18418 @code{gnus-agent-find-parameter} on the appropriate parameter. For
18419 example, gnus-agent-short-article will be bound to
18420 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
18421 means that you can specify a predicate in your category then tune that
18422 predicate to individual groups.
18423
18424 @table @code
18425 @item short
18426 True if the article is shorter than @code{gnus-agent-short-article}
18427 lines; default 100.
18428
18429 @item long
18430 True if the article is longer than @code{gnus-agent-long-article}
18431 lines; default 200.
18432
18433 @item low
18434 True if the article has a download score less than
18435 @code{gnus-agent-low-score}; default 0.
18436
18437 @item high
18438 True if the article has a download score greater than
18439 @code{gnus-agent-high-score}; default 0.
18440
18441 @item spam
18442 True if the Gnus Agent guesses that the article is spam. The
18443 heuristics may change over time, but at present it just computes a
18444 checksum and sees whether articles match.
18445
18446 @item true
18447 Always true.
18448
18449 @item false
18450 Always false.
18451 @end table
18452
18453 If you want to create your own predicate function, here's what you have
18454 to know: The functions are called with no parameters, but the
18455 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
18456 useful values.
18457
18458 For example, you could decide that you don't want to download articles
18459 that were posted more than a certain number of days ago (e.g., posted
18460 more than @code{gnus-agent-expire-days} ago) you might write a function
18461 something along the lines of the following:
18462
18463 @lisp
18464 (defun my-article-old-p ()
18465 "Say whether an article is old."
18466 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
18467 (- (time-to-days (current-time)) gnus-agent-expire-days)))
18468 @end lisp
18469
18470 with the predicate then defined as:
18471
18472 @lisp
18473 (not my-article-old-p)
18474 @end lisp
18475
18476 or you could append your predicate to the predefined
18477 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
18478 wherever.
18479
18480 @lisp
18481 (require 'gnus-agent)
18482 (setq gnus-category-predicate-alist
18483 (append gnus-category-predicate-alist
18484 '((old . my-article-old-p))))
18485 @end lisp
18486
18487 and simply specify your predicate as:
18488
18489 @lisp
18490 (not old)
18491 @end lisp
18492
18493 If/when using something like the above, be aware that there are many
18494 misconfigured systems/mailers out there and so an article's date is not
18495 always a reliable indication of when it was posted. Hell, some people
18496 just don't give a damn.
18497
18498 The above predicates apply to @emph{all} the groups which belong to the
18499 category. However, if you wish to have a specific predicate for an
18500 individual group within a category, or you're just too lazy to set up a
18501 new category, you can enter a group's individual predicate in its group
18502 parameters like so:
18503
18504 @lisp
18505 (agent-predicate . short)
18506 @end lisp
18507
18508 This is the group/topic parameter equivalent of the agent category default.
18509 Note that when specifying a single word predicate like this, the
18510 @code{agent-predicate} specification must be in dotted pair notation.
18511
18512 The equivalent of the longer example from above would be:
18513
18514 @lisp
18515 (agent-predicate or high (and (not low) (not long)))
18516 @end lisp
18517
18518 The outer parenthesis required in the category specification are not
18519 entered here as, not being in dotted pair notation, the value of the
18520 predicate is assumed to be a list.
18521
18522
18523 Now, the syntax of the download score is the same as the syntax of
18524 normal score files, except that all elements that require actually
18525 seeing the article itself are verboten. This means that only the
18526 following headers can be scored on: @code{Subject}, @code{From},
18527 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
18528 @code{Lines}, and @code{Xref}.
18529
18530 As with predicates, the specification of the @code{download score rule}
18531 to use in respect of a group can be in either the category definition if
18532 it's to be applicable to all groups in therein, or a group's parameters
18533 if it's to be specific to that group.
18534
18535 In both of these places the @code{download score rule} can take one of
18536 three forms:
18537
18538 @enumerate
18539 @item
18540 Score rule
18541
18542 This has the same syntax as a normal Gnus score file except only a
18543 subset of scoring keywords are available as mentioned above.
18544
18545 example:
18546
18547 @itemize @bullet
18548 @item
18549 Category specification
18550
18551 @lisp
18552 (("from"
18553 ("Lars Ingebrigtsen" 1000000 nil s))
18554 ("lines"
18555 (500 -100 nil <)))
18556 @end lisp
18557
18558 @item
18559 Group/Topic Parameter specification
18560
18561 @lisp
18562 (agent-score ("from"
18563 ("Lars Ingebrigtsen" 1000000 nil s))
18564 ("lines"
18565 (500 -100 nil <)))
18566 @end lisp
18567
18568 Again, note the omission of the outermost parenthesis here.
18569 @end itemize
18570
18571 @item
18572 Agent score file
18573
18574 These score files must @emph{only} contain the permitted scoring
18575 keywords stated above.
18576
18577 example:
18578
18579 @itemize @bullet
18580 @item
18581 Category specification
18582
18583 @lisp
18584 ("~/News/agent.SCORE")
18585 @end lisp
18586
18587 or perhaps
18588
18589 @lisp
18590 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
18591 @end lisp
18592
18593 @item
18594 Group Parameter specification
18595
18596 @lisp
18597 (agent-score "~/News/agent.SCORE")
18598 @end lisp
18599
18600 Additional score files can be specified as above. Need I say anything
18601 about parenthesis?
18602 @end itemize
18603
18604 @item
18605 Use @code{normal} score files
18606
18607 If you don't want to maintain two sets of scoring rules for a group, and
18608 your desired @code{downloading} criteria for a group are the same as your
18609 @code{reading} criteria then you can tell the agent to refer to your
18610 @code{normal} score files when deciding what to download.
18611
18612 These directives in either the category definition or a group's
18613 parameters will cause the agent to read in all the applicable score
18614 files for a group, @emph{filtering out} those sections that do not
18615 relate to one of the permitted subset of scoring keywords.
18616
18617 @itemize @bullet
18618 @item
18619 Category Specification
18620
18621 @lisp
18622 file
18623 @end lisp
18624
18625 @item
18626 Group Parameter specification
18627
18628 @lisp
18629 (agent-score . file)
18630 @end lisp
18631 @end itemize
18632 @end enumerate
18633
18634 @node Category Buffer
18635 @subsubsection Category Buffer
18636
18637 You'd normally do all category maintenance from the category buffer.
18638 When you enter it for the first time (with the @kbd{J c} command from
18639 the group buffer), you'll only see the @code{default} category.
18640
18641 The following commands are available in this buffer:
18642
18643 @table @kbd
18644 @item q
18645 @kindex q (Category)
18646 @findex gnus-category-exit
18647 Return to the group buffer (@code{gnus-category-exit}).
18648
18649 @item e
18650 @kindex e (Category)
18651 @findex gnus-category-customize-category
18652 Use a customization buffer to set all of the selected category's
18653 parameters at one time (@code{gnus-category-customize-category}).
18654
18655 @item k
18656 @kindex k (Category)
18657 @findex gnus-category-kill
18658 Kill the current category (@code{gnus-category-kill}).
18659
18660 @item c
18661 @kindex c (Category)
18662 @findex gnus-category-copy
18663 Copy the current category (@code{gnus-category-copy}).
18664
18665 @item a
18666 @kindex a (Category)
18667 @findex gnus-category-add
18668 Add a new category (@code{gnus-category-add}).
18669
18670 @item p
18671 @kindex p (Category)
18672 @findex gnus-category-edit-predicate
18673 Edit the predicate of the current category
18674 (@code{gnus-category-edit-predicate}).
18675
18676 @item g
18677 @kindex g (Category)
18678 @findex gnus-category-edit-groups
18679 Edit the list of groups belonging to the current category
18680 (@code{gnus-category-edit-groups}).
18681
18682 @item s
18683 @kindex s (Category)
18684 @findex gnus-category-edit-score
18685 Edit the download score rule of the current category
18686 (@code{gnus-category-edit-score}).
18687
18688 @item l
18689 @kindex l (Category)
18690 @findex gnus-category-list
18691 List all the categories (@code{gnus-category-list}).
18692 @end table
18693
18694
18695 @node Category Variables
18696 @subsubsection Category Variables
18697
18698 @table @code
18699 @item gnus-category-mode-hook
18700 @vindex gnus-category-mode-hook
18701 Hook run in category buffers.
18702
18703 @item gnus-category-line-format
18704 @vindex gnus-category-line-format
18705 Format of the lines in the category buffer (@pxref{Formatting
18706 Variables}). Valid elements are:
18707
18708 @table @samp
18709 @item c
18710 The name of the category.
18711
18712 @item g
18713 The number of groups in the category.
18714 @end table
18715
18716 @item gnus-category-mode-line-format
18717 @vindex gnus-category-mode-line-format
18718 Format of the category mode line (@pxref{Mode Line Formatting}).
18719
18720 @item gnus-agent-short-article
18721 @vindex gnus-agent-short-article
18722 Articles that have fewer lines than this are short. Default 100.
18723
18724 @item gnus-agent-long-article
18725 @vindex gnus-agent-long-article
18726 Articles that have more lines than this are long. Default 200.
18727
18728 @item gnus-agent-low-score
18729 @vindex gnus-agent-low-score
18730 Articles that have a score lower than this have a low score. Default
18731 0.
18732
18733 @item gnus-agent-high-score
18734 @vindex gnus-agent-high-score
18735 Articles that have a score higher than this have a high score. Default
18736 0.
18737
18738 @item gnus-agent-expire-days
18739 @vindex gnus-agent-expire-days
18740 The number of days that a @samp{read} article must stay in the agent's
18741 local disk before becoming eligible for expiration (While the name is
18742 the same, this doesn't mean expiring the article on the server. It
18743 just means deleting the local copy of the article). What is also
18744 important to understand is that the counter starts with the time the
18745 article was written to the local disk and not the time the article was
18746 read.
18747 Default 7.
18748
18749 @item gnus-agent-enable-expiration
18750 @vindex gnus-agent-enable-expiration
18751 Determines whether articles in a group are, by default, expired or
18752 retained indefinitely. The default is @code{ENABLE} which means that
18753 you'll have to disable expiration when desired. On the other hand,
18754 you could set this to @code{DISABLE}. In that case, you would then
18755 have to enable expiration in selected groups.
18756
18757 @end table
18758
18759
18760 @node Agent Commands
18761 @subsection Agent Commands
18762 @findex gnus-agent-toggle-plugged
18763 @kindex J j (Agent)
18764
18765 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
18766 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
18767 toggles the plugged/unplugged state of the Gnus Agent.
18768
18769
18770 @menu
18771 * Group Agent Commands:: Configure groups and fetch their contents.
18772 * Summary Agent Commands:: Manually select then fetch specific articles.
18773 * Server Agent Commands:: Select the servers that are supported by the agent.
18774 @end menu
18775
18776
18777
18778
18779 @node Group Agent Commands
18780 @subsubsection Group Agent Commands
18781
18782 @table @kbd
18783 @item J u
18784 @kindex J u (Agent Group)
18785 @findex gnus-agent-fetch-groups
18786 Fetch all eligible articles in the current group
18787 (@code{gnus-agent-fetch-groups}).
18788
18789 @item J c
18790 @kindex J c (Agent Group)
18791 @findex gnus-enter-category-buffer
18792 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
18793
18794 @item J s
18795 @kindex J s (Agent Group)
18796 @findex gnus-agent-fetch-session
18797 Fetch all eligible articles in all groups
18798 (@code{gnus-agent-fetch-session}).
18799
18800 @item J S
18801 @kindex J S (Agent Group)
18802 @findex gnus-group-send-queue
18803 Send all sendable messages in the queue group
18804 (@code{gnus-group-send-queue}). @xref{Drafts}.
18805
18806 @item J a
18807 @kindex J a (Agent Group)
18808 @findex gnus-agent-add-group
18809 Add the current group to an Agent category
18810 (@code{gnus-agent-add-group}). This command understands the
18811 process/prefix convention (@pxref{Process/Prefix}).
18812
18813 @item J r
18814 @kindex J r (Agent Group)
18815 @findex gnus-agent-remove-group
18816 Remove the current group from its category, if any
18817 (@code{gnus-agent-remove-group}). This command understands the
18818 process/prefix convention (@pxref{Process/Prefix}).
18819
18820 @item J Y
18821 @kindex J Y (Agent Group)
18822 @findex gnus-agent-synchronize-flags
18823 Synchronize flags changed while unplugged with remote server, if any.
18824
18825
18826 @end table
18827
18828
18829 @node Summary Agent Commands
18830 @subsubsection Summary Agent Commands
18831
18832 @table @kbd
18833 @item J #
18834 @kindex J # (Agent Summary)
18835 @findex gnus-agent-mark-article
18836 Mark the article for downloading (@code{gnus-agent-mark-article}).
18837
18838 @item J M-#
18839 @kindex J M-# (Agent Summary)
18840 @findex gnus-agent-unmark-article
18841 Remove the downloading mark from the article
18842 (@code{gnus-agent-unmark-article}).
18843
18844 @cindex %
18845 @item @@
18846 @kindex @@ (Agent Summary)
18847 @findex gnus-agent-toggle-mark
18848 Toggle whether to download the article
18849 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
18850 default.
18851
18852 @item J c
18853 @kindex J c (Agent Summary)
18854 @findex gnus-agent-catchup
18855 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
18856
18857 @item J S
18858 @kindex J S (Agent Summary)
18859 @findex gnus-agent-fetch-group
18860 Download all eligible (@pxref{Agent Categories}) articles in this group.
18861 (@code{gnus-agent-fetch-group}).
18862
18863 @item J s
18864 @kindex J s (Agent Summary)
18865 @findex gnus-agent-summary-fetch-series
18866 Download all processable articles in this group.
18867 (@code{gnus-agent-summary-fetch-series}).
18868
18869 @item J u
18870 @kindex J u (Agent Summary)
18871 @findex gnus-agent-summary-fetch-group
18872 Download all downloadable articles in the current group
18873 (@code{gnus-agent-summary-fetch-group}).
18874
18875 @end table
18876
18877
18878 @node Server Agent Commands
18879 @subsubsection Server Agent Commands
18880
18881 @table @kbd
18882 @item J a
18883 @kindex J a (Agent Server)
18884 @findex gnus-agent-add-server
18885 Add the current server to the list of servers covered by the Gnus Agent
18886 (@code{gnus-agent-add-server}).
18887
18888 @item J r
18889 @kindex J r (Agent Server)
18890 @findex gnus-agent-remove-server
18891 Remove the current server from the list of servers covered by the Gnus
18892 Agent (@code{gnus-agent-remove-server}).
18893
18894 @end table
18895
18896
18897 @node Agent Visuals
18898 @subsection Agent Visuals
18899
18900 If you open a summary while unplugged and, Gnus knows from the group's
18901 active range that there are more articles than the headers currently
18902 stored in the Agent, you may see some articles whose subject looks
18903 something like @samp{[Undownloaded article #####]}. These are
18904 placeholders for the missing headers. Aside from setting a mark,
18905 there is not much that can be done with one of these placeholders.
18906 When Gnus finally gets a chance to fetch the group's headers, the
18907 placeholders will automatically be replaced by the actual headers.
18908 You can configure the summary buffer's maneuvering to skip over the
18909 placeholders if you care (See @code{gnus-auto-goto-ignores}).
18910
18911 While it may be obvious to all, the only headers and articles
18912 available while unplugged are those headers and articles that were
18913 fetched into the Agent while previously plugged. To put it another
18914 way, ``If you forget to fetch something while plugged, you might have a
18915 less than satisfying unplugged session''. For this reason, the Agent
18916 adds two visual effects to your summary buffer. These effects display
18917 the download status of each article so that you always know which
18918 articles will be available when unplugged.
18919
18920 The first visual effect is the @samp{%O} spec. If you customize
18921 @code{gnus-summary-line-format} to include this specifier, you will add
18922 a single character field that indicates an article's download status.
18923 Articles that have been fetched into either the Agent or the Cache,
18924 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
18925 other articles will display @code{gnus-undownloaded-mark} (defaults to
18926 @samp{-}). If you open a group that has not been agentized, a space
18927 (@samp{ }) will be displayed.
18928
18929 The second visual effect are the undownloaded faces. The faces, there
18930 are three indicating the article's score (low, normal, high), seem to
18931 result in a love/hate response from many Gnus users. The problem is
18932 that the face selection is controlled by a list of condition tests and
18933 face names (See @code{gnus-summary-highlight}). Each condition is
18934 tested in the order in which it appears in the list so early
18935 conditions have precedence over later conditions. All of this means
18936 that, if you tick an undownloaded article, the article will continue
18937 to be displayed in the undownloaded face rather than the ticked face.
18938
18939 If you use the Agent as a cache (to avoid downloading the same article
18940 each time you visit it or to minimize your connection time), the
18941 undownloaded face will probably seem like a good idea. The reason
18942 being that you do all of our work (marking, reading, deleting) with
18943 downloaded articles so the normal faces always appear. For those
18944 users using the agent to improve online performance by caching the NOV
18945 database (most users since 5.10.2), the undownloaded faces may appear
18946 to be an absolutely horrible idea. The issue being that, since none
18947 of their articles have been fetched into the Agent, all of the
18948 normal faces will be obscured by the undownloaded faces.
18949
18950 If you would like to use the undownloaded faces, you must enable the
18951 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
18952 group parameter to @code{t}. This parameter, like all other agent
18953 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
18954 a Group Topic (@pxref{Topic Parameters}), or an individual group
18955 (@pxref{Group Parameters}).
18956
18957 The one problem common to all users using the agent is how quickly it
18958 can consume disk space. If you using the agent on many groups, it is
18959 even more difficult to effectively recover disk space. One solution
18960 is the @samp{%F} format available in @code{gnus-group-line-format}.
18961 This format will display the actual disk space used by articles
18962 fetched into both the agent and cache. By knowing which groups use
18963 the most space, users know where to focus their efforts when ``agent
18964 expiring'' articles.
18965
18966 @node Agent as Cache
18967 @subsection Agent as Cache
18968
18969 When Gnus is plugged, it is not efficient to download headers or
18970 articles from the server again, if they are already stored in the
18971 Agent. So, Gnus normally only downloads headers once, and stores them
18972 in the Agent. These headers are later used when generating the summary
18973 buffer, regardless of whether you are plugged or unplugged. Articles
18974 are not cached in the Agent by default though (that would potentially
18975 consume lots of disk space), but if you have already downloaded an
18976 article into the Agent, Gnus will not download the article from the
18977 server again but use the locally stored copy instead.
18978
18979 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
18980 @pxref{Agent Variables}) to always download headers and articles while
18981 plugged. Gnus will almost certainly be slower, but it will be kept
18982 synchronized with the server. That last point probably won't make any
18983 sense if you are using a nntp or nnimap back end.
18984
18985 @node Agent Expiry
18986 @subsection Agent Expiry
18987
18988 @vindex gnus-agent-expire-days
18989 @findex gnus-agent-expire
18990 @kindex M-x gnus-agent-expire
18991 @kindex M-x gnus-agent-expire-group
18992 @findex gnus-agent-expire-group
18993 @cindex agent expiry
18994 @cindex Gnus agent expiry
18995 @cindex expiry, in Gnus agent
18996
18997 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
18998 least it doesn't handle it like other back ends. Instead, there are
18999 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
19000 commands that will expire all read articles that are older than
19001 @code{gnus-agent-expire-days} days. They can be run whenever you feel
19002 that you're running out of space. Neither are particularly fast or
19003 efficient, and it's not a particularly good idea to interrupt them (with
19004 @kbd{C-g} or anything else) once you've started one of them.
19005
19006 Note that other functions might run @code{gnus-agent-expire} for you
19007 to keep the agent synchronized with the group.
19008
19009 The agent parameter @code{agent-enable-expiration} may be used to
19010 prevent expiration in selected groups.
19011
19012 @vindex gnus-agent-expire-all
19013 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
19014 expiration commands will expire all articles---unread, read, ticked
19015 and dormant. If @code{nil} (which is the default), only read articles
19016 are eligible for expiry, and unread, ticked and dormant articles will
19017 be kept indefinitely.
19018
19019 If you find that some articles eligible for expiry are never expired,
19020 perhaps some Gnus Agent files are corrupted. There's are special
19021 commands, @code{gnus-agent-regenerate} and
19022 @code{gnus-agent-regenerate-group}, to fix possible problems.
19023
19024 @node Agent Regeneration
19025 @subsection Agent Regeneration
19026
19027 @cindex agent regeneration
19028 @cindex Gnus agent regeneration
19029 @cindex regeneration
19030
19031 The local data structures used by @code{nnagent} may become corrupted
19032 due to certain exceptional conditions. When this happens,
19033 @code{nnagent} functionality may degrade or even fail. The solution
19034 to this problem is to repair the local data structures by removing all
19035 internal inconsistencies.
19036
19037 For example, if your connection to your server is lost while
19038 downloaded articles into the agent, the local data structures will not
19039 know about articles successfully downloaded prior to the connection
19040 failure. Running @code{gnus-agent-regenerate} or
19041 @code{gnus-agent-regenerate-group} will update the data structures
19042 such that you don't need to download these articles a second time.
19043
19044 @findex gnus-agent-regenerate
19045 @kindex M-x gnus-agent-regenerate
19046 The command @code{gnus-agent-regenerate} will perform
19047 @code{gnus-agent-regenerate-group} on every agentized group. While
19048 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19049 recommended that you first close all summary buffers.
19050
19051 @findex gnus-agent-regenerate-group
19052 @kindex M-x gnus-agent-regenerate-group
19053 The command @code{gnus-agent-regenerate-group} uses the local copies
19054 of individual articles to repair the local @acronym{NOV}(header) database. It
19055 then updates the internal data structures that document which articles
19056 are stored locally. An optional argument will mark articles in the
19057 agent as unread.
19058
19059 @node Agent and flags
19060 @subsection Agent and flags
19061
19062 The Agent works with any Gnus back end including those, such as
19063 nnimap, that store flags (read, ticked, etc.)@: on the server. Sadly,
19064 the Agent does not actually know which backends keep their flags in
19065 the backend server rather than in @file{.newsrc}. This means that the
19066 Agent, while unplugged or disconnected, will always record all changes
19067 to the flags in its own files.
19068
19069 When you plug back in, Gnus will then check to see if you have any
19070 changed any flags and ask if you wish to synchronize these with the
19071 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19072
19073 @vindex gnus-agent-synchronize-flags
19074 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19075 never automatically synchronize flags. If it is @code{ask}, which is
19076 the default, the Agent will check if you made any changes and if so
19077 ask if you wish to synchronize these when you re-connect. If it has
19078 any other value, all flags will be synchronized automatically.
19079
19080 If you do not wish to synchronize flags automatically when you
19081 re-connect, you can do it manually with the
19082 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19083 in the group buffer.
19084
19085 Technical note: the synchronization algorithm does not work by ``pushing''
19086 all local flags to the server, but rather by incrementally updated the
19087 server view of flags by changing only those flags that were changed by
19088 the user. Thus, if you set one flag on an article, quit the group then
19089 re-select the group and remove the flag; the flag will be set and
19090 removed from the server when you ``synchronize''. The queued flag
19091 operations can be found in the per-server @code{flags} file in the Agent
19092 directory. It's emptied when you synchronize flags.
19093
19094 @node Agent and IMAP
19095 @subsection Agent and IMAP
19096
19097 The Agent works with any Gnus back end, including nnimap. However,
19098 since there are some conceptual differences between @acronym{NNTP} and
19099 @acronym{IMAP}, this section (should) provide you with some information to
19100 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19101
19102 Some things are currently not implemented in the Agent that you'd might
19103 expect from a disconnected @acronym{IMAP} client, including:
19104
19105 @itemize @bullet
19106
19107 @item
19108 Copying/moving articles into nnimap groups when unplugged.
19109
19110 @item
19111 Creating/deleting nnimap groups when unplugged.
19112
19113 @end itemize
19114
19115 @node Outgoing Messages
19116 @subsection Outgoing Messages
19117
19118 By default, when Gnus is unplugged, all outgoing messages (both mail
19119 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19120 You can view them there after posting, and edit them at will.
19121
19122 You can control the circumstances under which outgoing mail is queued
19123 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19124 news is always queued when Gnus is unplugged, and never otherwise.
19125
19126 You can send the messages either from the draft group with the special
19127 commands available there, or you can use the @kbd{J S} command in the
19128 group buffer to send all the sendable messages in the draft group.
19129 Posting news will only work when Gnus is plugged, but you can send
19130 mail at any time.
19131
19132 If sending mail while unplugged does not work for you and you worry
19133 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19134 ask you to confirm your action (see
19135 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19136
19137 @node Agent Variables
19138 @subsection Agent Variables
19139
19140 @table @code
19141 @item gnus-agent
19142 @vindex gnus-agent
19143 Is the agent enabled? The default is @code{t}. When first enabled,
19144 the agent will use @code{gnus-agent-auto-agentize-methods} to
19145 automatically mark some back ends as agentized. You may change which
19146 back ends are agentized using the agent commands in the server buffer.
19147
19148 To enter the server buffer, use the @kbd{^}
19149 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19150
19151
19152 @item gnus-agent-directory
19153 @vindex gnus-agent-directory
19154 Where the Gnus Agent will store its files. The default is
19155 @file{~/News/agent/}.
19156
19157 @item gnus-agent-handle-level
19158 @vindex gnus-agent-handle-level
19159 Groups on levels (@pxref{Group Levels}) higher than this variable will
19160 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19161 which means that only subscribed group will be considered by the Agent
19162 by default.
19163
19164 @item gnus-agent-plugged-hook
19165 @vindex gnus-agent-plugged-hook
19166 Hook run when connecting to the network.
19167
19168 @item gnus-agent-unplugged-hook
19169 @vindex gnus-agent-unplugged-hook
19170 Hook run when disconnecting from the network.
19171
19172 @item gnus-agent-fetched-hook
19173 @vindex gnus-agent-fetched-hook
19174 Hook run when finished fetching articles.
19175
19176 @item gnus-agent-cache
19177 @vindex gnus-agent-cache
19178 Variable to control whether use the locally stored @acronym{NOV} and
19179 articles when plugged, e.g., essentially using the Agent as a cache.
19180 The default is non-@code{nil}, which means to use the Agent as a cache.
19181
19182 @item gnus-agent-go-online
19183 @vindex gnus-agent-go-online
19184 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
19185 automatically switch offline servers into online status. If it is
19186 @code{ask}, the default, the Agent will ask if you wish to switch
19187 offline servers into online status when you re-connect. If it has any
19188 other value, all offline servers will be automatically switched into
19189 online status.
19190
19191 @item gnus-agent-mark-unread-after-downloaded
19192 @vindex gnus-agent-mark-unread-after-downloaded
19193 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
19194 mark articles as unread after downloading. This is usually a safe
19195 thing to do as the newly downloaded article has obviously not been
19196 read. The default is @code{t}.
19197
19198 @item gnus-agent-synchronize-flags
19199 @vindex gnus-agent-synchronize-flags
19200 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19201 never automatically synchronize flags. If it is @code{ask}, which is
19202 the default, the Agent will check if you made any changes and if so
19203 ask if you wish to synchronize these when you re-connect. If it has
19204 any other value, all flags will be synchronized automatically.
19205
19206 @item gnus-agent-consider-all-articles
19207 @vindex gnus-agent-consider-all-articles
19208 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
19209 agent will let the agent predicate decide whether articles need to be
19210 downloaded or not, for all articles. When @code{nil}, the default,
19211 the agent will only let the predicate decide whether unread articles
19212 are downloaded or not. If you enable this, you may also want to look
19213 into the agent expiry settings (@pxref{Category Variables}), so that
19214 the agent doesn't download articles which the agent will later expire,
19215 over and over again.
19216
19217 @item gnus-agent-max-fetch-size
19218 @vindex gnus-agent-max-fetch-size
19219 The agent fetches articles into a temporary buffer prior to parsing
19220 them into individual files. To avoid exceeding the max. buffer size,
19221 the agent alternates between fetching and parsing until all articles
19222 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
19223 limit to control how often the cycling occurs. A large value improves
19224 performance. A small value minimizes the time lost should the
19225 connection be lost while fetching (You may need to run
19226 @code{gnus-agent-regenerate-group} to update the group's state.
19227 However, all articles parsed prior to losing the connection will be
19228 available while unplugged). The default is 10M so it is unusual to
19229 see any cycling.
19230
19231 @item gnus-server-unopen-status
19232 @vindex gnus-server-unopen-status
19233 Perhaps not an Agent variable, but closely related to the Agent, this
19234 variable says what will happen if Gnus cannot open a server. If the
19235 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
19236 whether to deny the server or whether to unplug the agent. If the
19237 Agent is disabled, Gnus always simply deny the server. Other choices
19238 for this variable include @code{denied} and @code{offline} the latter
19239 is only valid if the Agent is used.
19240
19241 @item gnus-auto-goto-ignores
19242 @vindex gnus-auto-goto-ignores
19243 Another variable that isn't an Agent variable, yet so closely related
19244 that most will look for it here, this variable tells the summary
19245 buffer how to maneuver around undownloaded (only headers stored in the
19246 agent) and unfetched (neither article nor headers stored) articles.
19247
19248 The valid values are @code{nil} (maneuver to any article),
19249 @code{undownloaded} (maneuvering while unplugged ignores articles that
19250 have not been fetched), @code{always-undownloaded} (maneuvering always
19251 ignores articles that have not been fetched), @code{unfetched}
19252 (maneuvering ignores articles whose headers have not been fetched).
19253
19254 @item gnus-agent-queue-mail
19255 @vindex gnus-agent-queue-mail
19256 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
19257 queue mail rather than sending it straight away. When @code{t}, Gnus
19258 will queue mail when unplugged only. When @code{nil}, never queue
19259 mail. The default is @code{t}.
19260
19261 @item gnus-agent-prompt-send-queue
19262 @vindex gnus-agent-prompt-send-queue
19263 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
19264 prompt you to confirm that you really wish to proceed if you hit
19265 @kbd{J S} while unplugged. The default is @code{nil}.
19266
19267 @item gnus-agent-auto-agentize-methods
19268 @vindex gnus-agent-auto-agentize-methods
19269 If you have never used the Agent before (or more technically, if
19270 @file{~/News/agent/lib/servers} does not exist), Gnus will
19271 automatically agentize a few servers for you. This variable control
19272 which back ends should be auto-agentized. It is typically only useful
19273 to agentize remote back ends. The auto-agentizing has the same effect
19274 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
19275 If the file exist, you must manage the servers manually by adding or
19276 removing them, this variable is only applicable the first time you
19277 start Gnus. The default is @samp{nil}.
19278
19279 @end table
19280
19281
19282 @node Example Setup
19283 @subsection Example Setup
19284
19285 If you don't want to read this manual, and you have a fairly standard
19286 setup, you may be able to use something like the following as your
19287 @file{~/.gnus.el} file to get started.
19288
19289 @lisp
19290 ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
19291 ;; @r{from your ISP's server.}
19292 (setq gnus-select-method '(nntp "news.your-isp.com"))
19293
19294 ;; @r{Define how Gnus is to read your mail. We read mail from}
19295 ;; @r{your ISP's @acronym{POP} server.}
19296 (setq mail-sources '((pop :server "pop.your-isp.com")))
19297
19298 ;; @r{Say how Gnus is to store the mail. We use nnml groups.}
19299 (setq gnus-secondary-select-methods '((nnml "")))
19300
19301 ;; @r{Make Gnus into an offline newsreader.}
19302 ;; (gnus-agentize) ; @r{The obsolete setting.}
19303 ;; (setq gnus-agent t) ; @r{Now the default.}
19304 @end lisp
19305
19306 That should be it, basically. Put that in your @file{~/.gnus.el} file,
19307 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
19308 gnus}.
19309
19310 If this is the first time you've run Gnus, you will be subscribed
19311 automatically to a few default newsgroups. You'll probably want to
19312 subscribe to more groups, and to do that, you have to query the
19313 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
19314 command. This usually takes quite a while, but you only have to do it
19315 once.
19316
19317 After reading and parsing a while, you'll be presented with a list of
19318 groups. Subscribe to the ones you want to read with the @kbd{u}
19319 command. @kbd{l} to make all the killed groups disappear after you've
19320 subscribe to all the groups you want to read. (@kbd{A k} will bring
19321 back all the killed groups.)
19322
19323 You can now read the groups at once, or you can download the articles
19324 with the @kbd{J s} command. And then read the rest of this manual to
19325 find out which of the other gazillion things you want to customize.
19326
19327
19328 @node Batching Agents
19329 @subsection Batching Agents
19330 @findex gnus-agent-batch
19331
19332 Having the Gnus Agent fetch articles (and post whatever messages you've
19333 written) is quite easy once you've gotten things set up properly. The
19334 following shell script will do everything that is necessary:
19335
19336 You can run a complete batch command from the command line with the
19337 following incantation:
19338
19339 @example
19340 #!/bin/sh
19341 emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1
19342 @end example
19343
19344
19345 @node Agent Caveats
19346 @subsection Agent Caveats
19347
19348 The Gnus Agent doesn't seem to work like most other offline
19349 newsreaders. Here are some common questions that some imaginary people
19350 may ask:
19351
19352 @table @dfn
19353 @item If I read an article while plugged, do they get entered into the Agent?
19354
19355 @strong{No}. If you want this behavior, add
19356 @code{gnus-agent-fetch-selected-article} to
19357 @code{gnus-select-article-hook}.
19358
19359 @item If I read an article while plugged, and the article already exists in
19360 the Agent, will it get downloaded once more?
19361
19362 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
19363
19364 @end table
19365
19366 In short, when Gnus is unplugged, it only looks into the locally stored
19367 articles; when it's plugged, it talks to your ISP and may also use the
19368 locally stored articles.
19369
19370
19371 @node Scoring
19372 @chapter Scoring
19373 @cindex scoring
19374
19375 Other people use @dfn{kill files}, but we here at Gnus Towers like
19376 scoring better than killing, so we'd rather switch than fight. They do
19377 something completely different as well, so sit up straight and pay
19378 attention!
19379
19380 @vindex gnus-summary-mark-below
19381 All articles have a default score (@code{gnus-summary-default-score}),
19382 which is 0 by default. This score may be raised or lowered either
19383 interactively or by score files. Articles that have a score lower than
19384 @code{gnus-summary-mark-below} are marked as read.
19385
19386 Gnus will read any @dfn{score files} that apply to the current group
19387 before generating the summary buffer.
19388
19389 There are several commands in the summary buffer that insert score
19390 entries based on the current article. You can, for instance, ask Gnus to
19391 lower or increase the score of all articles with a certain subject.
19392
19393 There are two sorts of scoring entries: Permanent and temporary.
19394 Temporary score entries are self-expiring entries. Any entries that are
19395 temporary and have not been used for, say, a week, will be removed
19396 silently to help keep the sizes of the score files down.
19397
19398 @menu
19399 * Summary Score Commands:: Adding score entries for the current group.
19400 * Group Score Commands:: General score commands.
19401 * Score Variables:: Customize your scoring. (My, what terminology).
19402 * Score File Format:: What a score file may contain.
19403 * Score File Editing:: You can edit score files by hand as well.
19404 * Adaptive Scoring:: Big Sister Gnus knows what you read.
19405 * Home Score File:: How to say where new score entries are to go.
19406 * Followups To Yourself:: Having Gnus notice when people answer you.
19407 * Scoring On Other Headers:: Scoring on non-standard headers.
19408 * Scoring Tips:: How to score effectively.
19409 * Reverse Scoring:: That problem child of old is not problem.
19410 * Global Score Files:: Earth-spanning, ear-splitting score files.
19411 * Kill Files:: They are still here, but they can be ignored.
19412 * Converting Kill Files:: Translating kill files to score files.
19413 * Advanced Scoring:: Using logical expressions to build score rules.
19414 * Score Decays:: It can be useful to let scores wither away.
19415 @end menu
19416
19417
19418 @node Summary Score Commands
19419 @section Summary Score Commands
19420 @cindex score commands
19421
19422 The score commands that alter score entries do not actually modify real
19423 score files. That would be too inefficient. Gnus maintains a cache of
19424 previously loaded score files, one of which is considered the
19425 @dfn{current score file alist}. The score commands simply insert
19426 entries into this list, and upon group exit, this list is saved.
19427
19428 The current score file is by default the group's local score file, even
19429 if no such score file actually exists. To insert score commands into
19430 some other score file (e.g., @file{all.SCORE}), you must first make this
19431 score file the current one.
19432
19433 General score commands that don't actually change the score file:
19434
19435 @table @kbd
19436
19437 @item V s
19438 @kindex V s (Summary)
19439 @findex gnus-summary-set-score
19440 Set the score of the current article (@code{gnus-summary-set-score}).
19441
19442 @item V S
19443 @kindex V S (Summary)
19444 @findex gnus-summary-current-score
19445 Display the score of the current article
19446 (@code{gnus-summary-current-score}).
19447
19448 @item V t
19449 @kindex V t (Summary)
19450 @findex gnus-score-find-trace
19451 Display all score rules that have been used on the current article
19452 (@code{gnus-score-find-trace}). In the @file{*Score Trace*} buffer, you
19453 may type @kbd{e} to edit score file corresponding to the score rule on
19454 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
19455 score file and edit it.
19456
19457 @item V w
19458 @kindex V w (Summary)
19459 @findex gnus-score-find-favourite-words
19460 List words used in scoring (@code{gnus-score-find-favourite-words}).
19461
19462 @item V R
19463 @kindex V R (Summary)
19464 @findex gnus-summary-rescore
19465 Run the current summary through the scoring process
19466 (@code{gnus-summary-rescore}). This might be useful if you're playing
19467 around with your score files behind Gnus' back and want to see the
19468 effect you're having.
19469
19470 @item V c
19471 @kindex V c (Summary)
19472 @findex gnus-score-change-score-file
19473 Make a different score file the current
19474 (@code{gnus-score-change-score-file}).
19475
19476 @item V e
19477 @kindex V e (Summary)
19478 @findex gnus-score-edit-current-scores
19479 Edit the current score file (@code{gnus-score-edit-current-scores}).
19480 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
19481 File Editing}).
19482
19483 @item V f
19484 @kindex V f (Summary)
19485 @findex gnus-score-edit-file
19486 Edit a score file and make this score file the current one
19487 (@code{gnus-score-edit-file}).
19488
19489 @item V F
19490 @kindex V F (Summary)
19491 @findex gnus-score-flush-cache
19492 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
19493 after editing score files.
19494
19495 @item V C
19496 @kindex V C (Summary)
19497 @findex gnus-score-customize
19498 Customize a score file in a visually pleasing manner
19499 (@code{gnus-score-customize}).
19500
19501 @end table
19502
19503 The rest of these commands modify the local score file.
19504
19505 @table @kbd
19506
19507 @item V m
19508 @kindex V m (Summary)
19509 @findex gnus-score-set-mark-below
19510 Prompt for a score, and mark all articles with a score below this as
19511 read (@code{gnus-score-set-mark-below}).
19512
19513 @item V x
19514 @kindex V x (Summary)
19515 @findex gnus-score-set-expunge-below
19516 Prompt for a score, and add a score rule to the current score file to
19517 expunge all articles below this score
19518 (@code{gnus-score-set-expunge-below}).
19519 @end table
19520
19521 The keystrokes for actually making score entries follow a very regular
19522 pattern, so there's no need to list all the commands. (Hundreds of
19523 them.)
19524
19525 @findex gnus-summary-increase-score
19526 @findex gnus-summary-lower-score
19527
19528 @enumerate
19529 @item
19530 The first key is either @kbd{I} (upper case i) for increasing the score
19531 or @kbd{L} for lowering the score.
19532 @item
19533 The second key says what header you want to score on. The following
19534 keys are available:
19535 @table @kbd
19536
19537 @item a
19538 Score on the author name.
19539
19540 @item s
19541 Score on the subject line.
19542
19543 @item x
19544 Score on the @code{Xref} line---i.e., the cross-posting line.
19545
19546 @item r
19547 Score on the @code{References} line.
19548
19549 @item d
19550 Score on the date.
19551
19552 @item l
19553 Score on the number of lines.
19554
19555 @item i
19556 Score on the @code{Message-ID} header.
19557
19558 @item e
19559 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
19560 if your @acronym{NNTP} server tracks additional header data in overviews.
19561
19562 @item f
19563 Score on followups---this matches the author name, and adds scores to
19564 the followups to this author. (Using this key leads to the creation of
19565 @file{ADAPT} files.)
19566
19567 @item b
19568 Score on the body.
19569
19570 @item h
19571 Score on the head.
19572
19573 @item t
19574 Score on thread. (Using this key leads to the creation of @file{ADAPT}
19575 files.)
19576
19577 @end table
19578
19579 @item
19580 The third key is the match type. Which match types are valid depends on
19581 what headers you are scoring on.
19582
19583 @table @code
19584
19585 @item strings
19586
19587 @table @kbd
19588
19589 @item e
19590 Exact matching.
19591
19592 @item s
19593 Substring matching.
19594
19595 @item f
19596 Fuzzy matching (@pxref{Fuzzy Matching}).
19597
19598 @item r
19599 Regexp matching
19600 @end table
19601
19602 @item date
19603 @table @kbd
19604
19605 @item b
19606 Before date.
19607
19608 @item a
19609 After date.
19610
19611 @item n
19612 This date.
19613 @end table
19614
19615 @item number
19616 @table @kbd
19617
19618 @item <
19619 Less than number.
19620
19621 @item =
19622 Equal to number.
19623
19624 @item >
19625 Greater than number.
19626 @end table
19627 @end table
19628
19629 @item
19630 The fourth and usually final key says whether this is a temporary (i.e.,
19631 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
19632 or whether it is to be done immediately, without adding to the score
19633 file.
19634 @table @kbd
19635
19636 @item t
19637 Temporary score entry.
19638
19639 @item p
19640 Permanent score entry.
19641
19642 @item i
19643 Immediately scoring.
19644 @end table
19645
19646 @item
19647 If you are scoring on `e' (extra) headers, you will then be prompted for
19648 the header name on which you wish to score. This must be a header named
19649 in gnus-extra-headers, and @samp{TAB} completion is available.
19650
19651 @end enumerate
19652
19653 So, let's say you want to increase the score on the current author with
19654 exact matching permanently: @kbd{I a e p}. If you want to lower the
19655 score based on the subject line, using substring matching, and make a
19656 temporary score entry: @kbd{L s s t}. Pretty easy.
19657
19658 To make things a bit more complicated, there are shortcuts. If you use
19659 a capital letter on either the second or third keys, Gnus will use
19660 defaults for the remaining one or two keystrokes. The defaults are
19661 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
19662 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
19663
19664 These functions take both the numerical prefix and the symbolic prefix
19665 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
19666 (or increase) the score of the article. A symbolic prefix of @code{a}
19667 says to use the @file{all.SCORE} file for the command instead of the
19668 current score file.
19669
19670 @vindex gnus-score-mimic-keymap
19671 The @code{gnus-score-mimic-keymap} says whether these commands will
19672 pretend they are keymaps or not.
19673
19674
19675 @node Group Score Commands
19676 @section Group Score Commands
19677 @cindex group score commands
19678
19679 There aren't many of these as yet, I'm afraid.
19680
19681 @table @kbd
19682
19683 @item W e
19684 @kindex W e (Group)
19685 @findex gnus-score-edit-all-score
19686 Edit the apply-to-all-groups all.SCORE file. You will be popped into
19687 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
19688
19689 @item W f
19690 @kindex W f (Group)
19691 @findex gnus-score-flush-cache
19692 Gnus maintains a cache of score alists to avoid having to reload them
19693 all the time. This command will flush the cache
19694 (@code{gnus-score-flush-cache}).
19695
19696 @end table
19697
19698 You can do scoring from the command line by saying something like:
19699
19700 @findex gnus-batch-score
19701 @cindex batch scoring
19702 @example
19703 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
19704 @end example
19705
19706
19707 @node Score Variables
19708 @section Score Variables
19709 @cindex score variables
19710
19711 @table @code
19712
19713 @item gnus-use-scoring
19714 @vindex gnus-use-scoring
19715 If @code{nil}, Gnus will not check for score files, and will not, in
19716 general, do any score-related work. This is @code{t} by default.
19717
19718 @item gnus-kill-killed
19719 @vindex gnus-kill-killed
19720 If this variable is @code{nil}, Gnus will never apply score files to
19721 articles that have already been through the kill process. While this
19722 may save you lots of time, it also means that if you apply a kill file
19723 to a group, and then change the kill file and want to run it over you
19724 group again to kill more articles, it won't work. You have to set this
19725 variable to @code{t} to do that. (It is @code{t} by default.)
19726
19727 @item gnus-kill-files-directory
19728 @vindex gnus-kill-files-directory
19729 All kill and score files will be stored in this directory, which is
19730 initialized from the @env{SAVEDIR} environment variable by default.
19731 This is @file{~/News/} by default.
19732
19733 @item gnus-score-file-suffix
19734 @vindex gnus-score-file-suffix
19735 Suffix to add to the group name to arrive at the score file name
19736 (@file{SCORE} by default.)
19737
19738 @item gnus-score-uncacheable-files
19739 @vindex gnus-score-uncacheable-files
19740 @cindex score cache
19741 All score files are normally cached to avoid excessive re-loading of
19742 score files. However, this might make your Emacs grow big and
19743 bloated, so this regexp can be used to weed out score files unlikely
19744 to be needed again. It would be a bad idea to deny caching of
19745 @file{all.SCORE}, while it might be a good idea to not cache
19746 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
19747 variable is @samp{ADAPT$} by default, so no adaptive score files will
19748 be cached.
19749
19750 @item gnus-save-score
19751 @vindex gnus-save-score
19752 If you have really complicated score files, and do lots of batch
19753 scoring, then you might set this variable to @code{t}. This will make
19754 Gnus save the scores into the @file{.newsrc.eld} file.
19755
19756 If you do not set this to @code{t}, then manual scores (like those set
19757 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
19758 across group visits.
19759
19760 @item gnus-score-interactive-default-score
19761 @vindex gnus-score-interactive-default-score
19762 Score used by all the interactive raise/lower commands to raise/lower
19763 score with. Default is 1000, which may seem excessive, but this is to
19764 ensure that the adaptive scoring scheme gets enough room to play with.
19765 We don't want the small changes from the adaptive scoring to overwrite
19766 manually entered data.
19767
19768 @item gnus-summary-default-score
19769 @vindex gnus-summary-default-score
19770 Default score of an article, which is 0 by default.
19771
19772 @item gnus-summary-expunge-below
19773 @vindex gnus-summary-expunge-below
19774 Don't display the summary lines of articles that have scores lower than
19775 this variable. This is @code{nil} by default, which means that no
19776 articles will be hidden. This variable is local to the summary buffers,
19777 and has to be set from @code{gnus-summary-mode-hook}.
19778
19779 @item gnus-score-over-mark
19780 @vindex gnus-score-over-mark
19781 Mark (in the third column) used for articles with a score over the
19782 default. Default is @samp{+}.
19783
19784 @item gnus-score-below-mark
19785 @vindex gnus-score-below-mark
19786 Mark (in the third column) used for articles with a score below the
19787 default. Default is @samp{-}.
19788
19789 @item gnus-score-find-score-files-function
19790 @vindex gnus-score-find-score-files-function
19791 Function used to find score files for the current group. This function
19792 is called with the name of the group as the argument.
19793
19794 Predefined functions available are:
19795 @table @code
19796
19797 @item gnus-score-find-single
19798 @findex gnus-score-find-single
19799 Only apply the group's own score file.
19800
19801 @item gnus-score-find-bnews
19802 @findex gnus-score-find-bnews
19803 Apply all score files that match, using bnews syntax. This is the
19804 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
19805 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
19806 @file{gnu.all.SCORE} would all apply. In short, the instances of
19807 @samp{all} in the score file names are translated into @samp{.*}, and
19808 then a regexp match is done.
19809
19810 This means that if you have some score entries that you want to apply to
19811 all groups, then you put those entries in the @file{all.SCORE} file.
19812
19813 The score files are applied in a semi-random order, although Gnus will
19814 try to apply the more general score files before the more specific score
19815 files. It does this by looking at the number of elements in the score
19816 file names---discarding the @samp{all} elements.
19817
19818 @item gnus-score-find-hierarchical
19819 @findex gnus-score-find-hierarchical
19820 Apply all score files from all the parent groups. This means that you
19821 can't have score files like @file{all.SCORE}, but you can have
19822 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
19823 server.
19824
19825 @end table
19826 This variable can also be a list of functions. In that case, all
19827 these functions will be called with the group name as argument, and
19828 all the returned lists of score files will be applied. These
19829 functions can also return lists of lists of score alists directly. In
19830 that case, the functions that return these non-file score alists
19831 should probably be placed before the ``real'' score file functions, to
19832 ensure that the last score file returned is the local score file.
19833 Phu.
19834
19835 For example, to do hierarchical scoring but use a non-server-specific
19836 overall score file, you could use the value
19837 @example
19838 (list (lambda (group) ("all.SCORE"))
19839 'gnus-score-find-hierarchical)
19840 @end example
19841
19842 @item gnus-score-expiry-days
19843 @vindex gnus-score-expiry-days
19844 This variable says how many days should pass before an unused score file
19845 entry is expired. If this variable is @code{nil}, no score file entries
19846 are expired. It's 7 by default.
19847
19848 @item gnus-update-score-entry-dates
19849 @vindex gnus-update-score-entry-dates
19850 If this variable is non-@code{nil}, temporary score entries that have
19851 been triggered (matched) will have their dates updated. (This is how Gnus
19852 controls expiry---all non-matched-entries will become too old while
19853 matched entries will stay fresh and young.) However, if you set this
19854 variable to @code{nil}, even matched entries will grow old and will
19855 have to face that oh-so grim reaper.
19856
19857 @item gnus-score-after-write-file-function
19858 @vindex gnus-score-after-write-file-function
19859 Function called with the name of the score file just written.
19860
19861 @item gnus-score-thread-simplify
19862 @vindex gnus-score-thread-simplify
19863 If this variable is non-@code{nil}, article subjects will be
19864 simplified for subject scoring purposes in the same manner as with
19865 threading---according to the current value of
19866 @code{gnus-simplify-subject-functions}. If the scoring entry uses
19867 @code{substring} or @code{exact} matching, the match will also be
19868 simplified in this manner.
19869
19870 @end table
19871
19872
19873 @node Score File Format
19874 @section Score File Format
19875 @cindex score file format
19876
19877 A score file is an @code{emacs-lisp} file that normally contains just a
19878 single form. Casual users are not expected to edit these files;
19879 everything can be changed from the summary buffer.
19880
19881 Anyway, if you'd like to dig into it yourself, here's an example:
19882
19883 @lisp
19884 (("from"
19885 ("Lars Ingebrigtsen" -10000)
19886 ("Per Abrahamsen")
19887 ("larsi\\|lmi" -50000 nil R))
19888 ("subject"
19889 ("Ding is Badd" nil 728373))
19890 ("xref"
19891 ("alt.politics" -1000 728372 s))
19892 ("lines"
19893 (2 -100 nil <))
19894 (mark 0)
19895 (expunge -1000)
19896 (mark-and-expunge -10)
19897 (read-only nil)
19898 (orphan -10)
19899 (adapt t)
19900 (files "/hom/larsi/News/gnu.SCORE")
19901 (exclude-files "all.SCORE")
19902 (local (gnus-newsgroup-auto-expire t)
19903 (gnus-summary-make-false-root empty))
19904 (eval (ding)))
19905 @end lisp
19906
19907 This example demonstrates most score file elements. @xref{Advanced
19908 Scoring}, for a different approach.
19909
19910 Even though this looks much like Lisp code, nothing here is actually
19911 @code{eval}ed. The Lisp reader is used to read this form, though, so it
19912 has to be valid syntactically, if not semantically.
19913
19914 Six keys are supported by this alist:
19915
19916 @table @code
19917
19918 @item STRING
19919 If the key is a string, it is the name of the header to perform the
19920 match on. Scoring can only be performed on these eight headers:
19921 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
19922 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
19923 these headers, there are three strings to tell Gnus to fetch the entire
19924 article and do the match on larger parts of the article: @code{Body}
19925 will perform the match on the body of the article, @code{Head} will
19926 perform the match on the head of the article, and @code{All} will
19927 perform the match on the entire article. Note that using any of these
19928 last three keys will slow down group entry @emph{considerably}. The
19929 final ``header'' you can score on is @code{Followup}. These score
19930 entries will result in new score entries being added for all follow-ups
19931 to articles that matches these score entries.
19932
19933 Following this key is an arbitrary number of score entries, where each
19934 score entry has one to four elements.
19935 @enumerate
19936
19937 @item
19938 The first element is the @dfn{match element}. On most headers this will
19939 be a string, but on the Lines and Chars headers, this must be an
19940 integer.
19941
19942 @item
19943 If the second element is present, it should be a number---the @dfn{score
19944 element}. This number should be an integer in the neginf to posinf
19945 interval. This number is added to the score of the article if the match
19946 is successful. If this element is not present, the
19947 @code{gnus-score-interactive-default-score} number will be used
19948 instead. This is 1000 by default.
19949
19950 @item
19951 If the third element is present, it should be a number---the @dfn{date
19952 element}. This date says when the last time this score entry matched,
19953 which provides a mechanism for expiring the score entries. It this
19954 element is not present, the score entry is permanent. The date is
19955 represented by the number of days since December 31, 1 BCE.
19956
19957 @item
19958 If the fourth element is present, it should be a symbol---the @dfn{type
19959 element}. This element specifies what function should be used to see
19960 whether this score entry matches the article. What match types that can
19961 be used depends on what header you wish to perform the match on.
19962 @table @dfn
19963
19964 @item From, Subject, References, Xref, Message-ID
19965 For most header types, there are the @code{r} and @code{R} (regexp), as
19966 well as @code{s} and @code{S} (substring) types, and @code{e} and
19967 @code{E} (exact match), and @code{w} (word match) types. If this
19968 element is not present, Gnus will assume that substring matching should
19969 be used. @code{R}, @code{S}, and @code{E} differ from the others in
19970 that the matches will be done in a case-sensitive manner. All these
19971 one-letter types are really just abbreviations for the @code{regexp},
19972 @code{string}, @code{exact}, and @code{word} types, which you can use
19973 instead, if you feel like.
19974
19975 @item Extra
19976 Just as for the standard string overview headers, if you are using
19977 gnus-extra-headers, you can score on these headers' values. In this
19978 case, there is a 5th element in the score entry, being the name of the
19979 header to be scored. The following entry is useful in your
19980 @file{all.SCORE} file in case of spam attacks from a single origin
19981 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
19982 overviews:
19983
19984 @lisp
19985 ("111.222.333.444" -1000 nil s
19986 "NNTP-Posting-Host")
19987 @end lisp
19988
19989 @item Lines, Chars
19990 These two headers use different match types: @code{<}, @code{>},
19991 @code{=}, @code{>=} and @code{<=}.
19992
19993 These predicates are true if
19994
19995 @example
19996 (PREDICATE HEADER MATCH)
19997 @end example
19998
19999 evaluates to non-@code{nil}. For instance, the advanced match
20000 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
20001 following form:
20002
20003 @lisp
20004 (< header-value 4)
20005 @end lisp
20006
20007 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
20008 the match, we get the score added if the article has less than 4 lines.
20009 (It's easy to get confused and think it's the other way around. But
20010 it's not. I think.)
20011
20012 When matching on @code{Lines}, be careful because some back ends (like
20013 @code{nndir}) do not generate @code{Lines} header, so every article ends
20014 up being marked as having 0 lines. This can lead to strange results if
20015 you happen to lower score of the articles with few lines.
20016
20017 @item Date
20018 For the Date header we have three kinda silly match types:
20019 @code{before}, @code{at} and @code{after}. I can't really imagine this
20020 ever being useful, but, like, it would feel kinda silly not to provide
20021 this function. Just in case. You never know. Better safe than sorry.
20022 Once burnt, twice shy. Don't judge a book by its cover. Never not have
20023 sex on a first date. (I have been told that at least one person, and I
20024 quote, ``found this function indispensable'', however.)
20025
20026 @cindex ISO8601
20027 @cindex date
20028 A more useful match type is @code{regexp}. With it, you can match the
20029 date string using a regular expression. The date is normalized to
20030 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20031 you want to match all articles that have been posted on April 1st in
20032 every year, you could use @samp{....0401.........} as a match string,
20033 for instance. (Note that the date is kept in its original time zone, so
20034 this will match articles that were posted when it was April 1st where
20035 the article was posted from. Time zones are such wholesome fun for the
20036 whole family, eh?)
20037
20038 @item Head, Body, All
20039 These three match keys use the same match types as the @code{From} (etc.)@:
20040 header uses.
20041
20042 @item Followup
20043 This match key is somewhat special, in that it will match the
20044 @code{From} header, and affect the score of not only the matching
20045 articles, but also all followups to the matching articles. This allows
20046 you to increase the score of followups to your own articles, or
20047 decrease the score of followups to the articles of some known
20048 trouble-maker. Uses the same match types as the @code{From} header
20049 uses. (Using this match key will lead to creation of @file{ADAPT}
20050 files.)
20051
20052 @item Thread
20053 This match key works along the same lines as the @code{Followup} match
20054 key. If you say that you want to score on a (sub-)thread started by an
20055 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20056 match. This will add a new @samp{thread} match for each article that
20057 has @var{x} in its @code{References} header. (These new @samp{thread}
20058 matches will use the @code{Message-ID}s of these matching articles.)
20059 This will ensure that you can raise/lower the score of an entire thread,
20060 even though some articles in the thread may not have complete
20061 @code{References} headers. Note that using this may lead to
20062 nondeterministic scores of the articles in the thread. (Using this match
20063 key will lead to creation of @file{ADAPT} files.)
20064 @end table
20065 @end enumerate
20066
20067 @cindex score file atoms
20068 @item mark
20069 The value of this entry should be a number. Any articles with a score
20070 lower than this number will be marked as read.
20071
20072 @item expunge
20073 The value of this entry should be a number. Any articles with a score
20074 lower than this number will be removed from the summary buffer.
20075
20076 @item mark-and-expunge
20077 The value of this entry should be a number. Any articles with a score
20078 lower than this number will be marked as read and removed from the
20079 summary buffer.
20080
20081 @item thread-mark-and-expunge
20082 The value of this entry should be a number. All articles that belong to
20083 a thread that has a total score below this number will be marked as read
20084 and removed from the summary buffer. @code{gnus-thread-score-function}
20085 says how to compute the total score for a thread.
20086
20087 @item files
20088 The value of this entry should be any number of file names. These files
20089 are assumed to be score files as well, and will be loaded the same way
20090 this one was.
20091
20092 @item exclude-files
20093 The clue of this entry should be any number of files. These files will
20094 not be loaded, even though they would normally be so, for some reason or
20095 other.
20096
20097 @item eval
20098 The value of this entry will be @code{eval}ed. This element will be
20099 ignored when handling global score files.
20100
20101 @item read-only
20102 Read-only score files will not be updated or saved. Global score files
20103 should feature this atom (@pxref{Global Score Files}). (Note:
20104 @dfn{Global} here really means @dfn{global}; not your personal
20105 apply-to-all-groups score files.)
20106
20107 @item orphan
20108 The value of this entry should be a number. Articles that do not have
20109 parents will get this number added to their scores. Imagine you follow
20110 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20111 will only follow a few of the threads, also want to see any new threads.
20112
20113 You can do this with the following two score file entries:
20114
20115 @example
20116 (orphan -500)
20117 (mark-and-expunge -100)
20118 @end example
20119
20120 When you enter the group the first time, you will only see the new
20121 threads. You then raise the score of the threads that you find
20122 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{c y}) the
20123 rest. Next time you enter the group, you will see new articles in the
20124 interesting threads, plus any new threads.
20125
20126 I.e., the orphan score atom is for high-volume groups where a few
20127 interesting threads which can't be found automatically by ordinary
20128 scoring rules exist.
20129
20130 @item adapt
20131 This entry controls the adaptive scoring. If it is @code{t}, the
20132 default adaptive scoring rules will be used. If it is @code{ignore}, no
20133 adaptive scoring will be performed on this group. If it is a list, this
20134 list will be used as the adaptive scoring rules. If it isn't present,
20135 or is something other than @code{t} or @code{ignore}, the default
20136 adaptive scoring rules will be used. If you want to use adaptive
20137 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20138 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20139 not want adaptive scoring. If you only want adaptive scoring in a few
20140 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20141 insert @code{(adapt t)} in the score files of the groups where you want
20142 it.
20143
20144 @item adapt-file
20145 All adaptive score entries will go to the file named by this entry. It
20146 will also be applied when entering the group. This atom might be handy
20147 if you want to adapt on several groups at once, using the same adaptive
20148 file for a number of groups.
20149
20150 @item local
20151 @cindex local variables
20152 The value of this entry should be a list of @code{(@var{var}
20153 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20154 current summary buffer, and set to the value specified. This is a
20155 convenient, if somewhat strange, way of setting variables in some
20156 groups if you don't like hooks much. Note that the @var{value} won't
20157 be evaluated.
20158 @end table
20159
20160
20161 @node Score File Editing
20162 @section Score File Editing
20163
20164 You normally enter all scoring commands from the summary buffer, but you
20165 might feel the urge to edit them by hand as well, so we've supplied you
20166 with a mode for that.
20167
20168 It's simply a slightly customized @code{emacs-lisp} mode, with these
20169 additional commands:
20170
20171 @table @kbd
20172
20173 @item C-c C-c
20174 @kindex C-c C-c (Score)
20175 @findex gnus-score-edit-exit
20176 Save the changes you have made and return to the summary buffer
20177 (@code{gnus-score-edit-exit}).
20178
20179 @item C-c C-d
20180 @kindex C-c C-d (Score)
20181 @findex gnus-score-edit-insert-date
20182 Insert the current date in numerical format
20183 (@code{gnus-score-edit-insert-date}). This is really the day number, if
20184 you were wondering.
20185
20186 @item C-c C-p
20187 @kindex C-c C-p (Score)
20188 @findex gnus-score-pretty-print
20189 The adaptive score files are saved in an unformatted fashion. If you
20190 intend to read one of these files, you want to @dfn{pretty print} it
20191 first. This command (@code{gnus-score-pretty-print}) does that for
20192 you.
20193
20194 @end table
20195
20196 Type @kbd{M-x gnus-score-mode} to use this mode.
20197
20198 @vindex gnus-score-mode-hook
20199 @code{gnus-score-menu-hook} is run in score mode buffers.
20200
20201 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
20202 @kbd{V t} to begin editing score files.
20203
20204
20205 @node Adaptive Scoring
20206 @section Adaptive Scoring
20207 @cindex adaptive scoring
20208
20209 If all this scoring is getting you down, Gnus has a way of making it all
20210 happen automatically---as if by magic. Or rather, as if by artificial
20211 stupidity, to be precise.
20212
20213 @vindex gnus-use-adaptive-scoring
20214 When you read an article, or mark an article as read, or kill an
20215 article, you leave marks behind. On exit from the group, Gnus can sniff
20216 these marks and add score elements depending on what marks it finds.
20217 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
20218 @code{t} or @code{(line)}. If you want score adaptively on separate
20219 words appearing in the subjects, you should set this variable to
20220 @code{(word)}. If you want to use both adaptive methods, set this
20221 variable to @code{(word line)}.
20222
20223 @vindex gnus-default-adaptive-score-alist
20224 To give you complete control over the scoring process, you can customize
20225 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
20226 might look something like this:
20227
20228 @lisp
20229 (setq gnus-default-adaptive-score-alist
20230 '((gnus-unread-mark)
20231 (gnus-ticked-mark (from 4))
20232 (gnus-dormant-mark (from 5))
20233 (gnus-del-mark (from -4) (subject -1))
20234 (gnus-read-mark (from 4) (subject 2))
20235 (gnus-expirable-mark (from -1) (subject -1))
20236 (gnus-killed-mark (from -1) (subject -3))
20237 (gnus-kill-file-mark)
20238 (gnus-ancient-mark)
20239 (gnus-low-score-mark)
20240 (gnus-catchup-mark (from -1) (subject -1))))
20241 @end lisp
20242
20243 As you see, each element in this alist has a mark as a key (either a
20244 variable name or a ``real'' mark---a character). Following this key is
20245 a arbitrary number of header/score pairs. If there are no header/score
20246 pairs following the key, no adaptive scoring will be done on articles
20247 that have that key as the article mark. For instance, articles with
20248 @code{gnus-unread-mark} in the example above will not get adaptive score
20249 entries.
20250
20251 Each article can have only one mark, so just a single of these rules
20252 will be applied to each article.
20253
20254 To take @code{gnus-del-mark} as an example---this alist says that all
20255 articles that have that mark (i.e., are marked with @samp{e}) will have a
20256 score entry added to lower based on the @code{From} header by -4, and
20257 lowered by @code{Subject} by -1. Change this to fit your prejudices.
20258
20259 If you have marked 10 articles with the same subject with
20260 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
20261 That means that that subject will get a score of ten times -1, which
20262 should be, unless I'm much mistaken, -10.
20263
20264 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
20265 the read articles will be marked with the @samp{E} mark. This'll
20266 probably make adaptive scoring slightly impossible, so auto-expiring and
20267 adaptive scoring doesn't really mix very well.
20268
20269 The headers you can score on are @code{from}, @code{subject},
20270 @code{message-id}, @code{references}, @code{xref}, @code{lines},
20271 @code{chars} and @code{date}. In addition, you can score on
20272 @code{followup}, which will create an adaptive score entry that matches
20273 on the @code{References} header using the @code{Message-ID} of the
20274 current article, thereby matching the following thread.
20275
20276 If you use this scheme, you should set the score file atom @code{mark}
20277 to something small---like -300, perhaps, to avoid having small random
20278 changes result in articles getting marked as read.
20279
20280 After using adaptive scoring for a week or so, Gnus should start to
20281 become properly trained and enhance the authors you like best, and kill
20282 the authors you like least, without you having to say so explicitly.
20283
20284 You can control what groups the adaptive scoring is to be performed on
20285 by using the score files (@pxref{Score File Format}). This will also
20286 let you use different rules in different groups.
20287
20288 @vindex gnus-adaptive-file-suffix
20289 The adaptive score entries will be put into a file where the name is the
20290 group name with @code{gnus-adaptive-file-suffix} appended. The default
20291 is @file{ADAPT}.
20292
20293 @vindex gnus-adaptive-pretty-print
20294 Adaptive score files can get huge and are not meant to be edited by
20295 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
20296 default) those files will not be written in a human readable way.
20297
20298 @vindex gnus-score-exact-adapt-limit
20299 When doing adaptive scoring, substring or fuzzy matching would probably
20300 give you the best results in most cases. However, if the header one
20301 matches is short, the possibility for false positives is great, so if
20302 the length of the match is less than
20303 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
20304 this variable is @code{nil}, exact matching will always be used to avoid
20305 this problem.
20306
20307 @vindex gnus-default-adaptive-word-score-alist
20308 As mentioned above, you can adapt either on individual words or entire
20309 headers. If you adapt on words, the
20310 @code{gnus-default-adaptive-word-score-alist} variable says what score
20311 each instance of a word should add given a mark.
20312
20313 @lisp
20314 (setq gnus-default-adaptive-word-score-alist
20315 `((,gnus-read-mark . 30)
20316 (,gnus-catchup-mark . -10)
20317 (,gnus-killed-mark . -20)
20318 (,gnus-del-mark . -15)))
20319 @end lisp
20320
20321 This is the default value. If you have adaption on words enabled, every
20322 word that appears in subjects of articles marked with
20323 @code{gnus-read-mark} will result in a score rule that increase the
20324 score with 30 points.
20325
20326 @vindex gnus-default-ignored-adaptive-words
20327 @vindex gnus-ignored-adaptive-words
20328 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
20329 will be ignored. If you wish to add more words to be ignored, use the
20330 @code{gnus-ignored-adaptive-words} list instead.
20331
20332 @vindex gnus-adaptive-word-length-limit
20333 Some may feel that short words shouldn't count when doing adaptive
20334 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
20335 an integer. Words shorter than this number will be ignored. This
20336 variable defaults to @code{nil}.
20337
20338 @vindex gnus-adaptive-word-syntax-table
20339 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
20340 syntax table in effect. It is similar to the standard syntax table, but
20341 it considers numbers to be non-word-constituent characters.
20342
20343 @vindex gnus-adaptive-word-minimum
20344 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
20345 word scoring process will never bring down the score of an article to
20346 below this number. The default is @code{nil}.
20347
20348 @vindex gnus-adaptive-word-no-group-words
20349 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
20350 won't adaptively word score any of the words in the group name. Useful
20351 for groups like @samp{comp.editors.emacs}, where most of the subject
20352 lines contain the word @samp{emacs}.
20353
20354 After using this scheme for a while, it might be nice to write a
20355 @code{gnus-psychoanalyze-user} command to go through the rules and see
20356 what words you like and what words you don't like. Or perhaps not.
20357
20358 Note that the adaptive word scoring thing is highly experimental and is
20359 likely to change in the future. Initial impressions seem to indicate
20360 that it's totally useless as it stands. Some more work (involving more
20361 rigorous statistical methods) will have to be done to make this useful.
20362
20363
20364 @node Home Score File
20365 @section Home Score File
20366
20367 The score file where new score file entries will go is called the
20368 @dfn{home score file}. This is normally (and by default) the score file
20369 for the group itself. For instance, the home score file for
20370 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
20371
20372 However, this may not be what you want. It is often convenient to share
20373 a common home score file among many groups---all @samp{emacs} groups
20374 could perhaps use the same home score file.
20375
20376 @vindex gnus-home-score-file
20377 The variable that controls this is @code{gnus-home-score-file}. It can
20378 be:
20379
20380 @enumerate
20381 @item
20382 A string. Then this file will be used as the home score file for all
20383 groups.
20384
20385 @item
20386 A function. The result of this function will be used as the home score
20387 file. The function will be called with the name of the group as the
20388 parameter.
20389
20390 @item
20391 A list. The elements in this list can be:
20392
20393 @enumerate
20394 @item
20395 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
20396 group name, the @var{file-name} will be used as the home score file.
20397
20398 @item
20399 A function. If the function returns non-@code{nil}, the result will
20400 be used as the home score file. The function will be called with the
20401 name of the group as the parameter.
20402
20403 @item
20404 A string. Use the string as the home score file.
20405 @end enumerate
20406
20407 The list will be traversed from the beginning towards the end looking
20408 for matches.
20409
20410 @end enumerate
20411
20412 So, if you want to use just a single score file, you could say:
20413
20414 @lisp
20415 (setq gnus-home-score-file
20416 "my-total-score-file.SCORE")
20417 @end lisp
20418
20419 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
20420 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
20421
20422 @findex gnus-hierarchial-home-score-file
20423 @lisp
20424 (setq gnus-home-score-file
20425 'gnus-hierarchial-home-score-file)
20426 @end lisp
20427
20428 This is a ready-made function provided for your convenience.
20429 Other functions include
20430
20431 @table @code
20432 @item gnus-current-home-score-file
20433 @findex gnus-current-home-score-file
20434 Return the ``current'' regular score file. This will make scoring
20435 commands add entry to the ``innermost'' matching score file.
20436
20437 @end table
20438
20439 If you want to have one score file for the @samp{emacs} groups and
20440 another for the @samp{comp} groups, while letting all other groups use
20441 their own home score files:
20442
20443 @lisp
20444 (setq gnus-home-score-file
20445 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
20446 '(("\\.emacs" "emacs.SCORE")
20447 ;; @r{All the comp groups in one score file}
20448 ("^comp" "comp.SCORE")))
20449 @end lisp
20450
20451 @vindex gnus-home-adapt-file
20452 @code{gnus-home-adapt-file} works exactly the same way as
20453 @code{gnus-home-score-file}, but says what the home adaptive score file
20454 is instead. All new adaptive file entries will go into the file
20455 specified by this variable, and the same syntax is allowed.
20456
20457 In addition to using @code{gnus-home-score-file} and
20458 @code{gnus-home-adapt-file}, you can also use group parameters
20459 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
20460 Parameters}) to achieve much the same. Group and topic parameters take
20461 precedence over this variable.
20462
20463
20464 @node Followups To Yourself
20465 @section Followups To Yourself
20466
20467 Gnus offers two commands for picking out the @code{Message-ID} header in
20468 the current buffer. Gnus will then add a score rule that scores using
20469 this @code{Message-ID} on the @code{References} header of other
20470 articles. This will, in effect, increase the score of all articles that
20471 respond to the article in the current buffer. Quite useful if you want
20472 to easily note when people answer what you've said.
20473
20474 @table @code
20475
20476 @item gnus-score-followup-article
20477 @findex gnus-score-followup-article
20478 This will add a score to articles that directly follow up your own
20479 article.
20480
20481 @item gnus-score-followup-thread
20482 @findex gnus-score-followup-thread
20483 This will add a score to all articles that appear in a thread ``below''
20484 your own article.
20485 @end table
20486
20487 @vindex message-sent-hook
20488 These two functions are both primarily meant to be used in hooks like
20489 @code{message-sent-hook}, like this:
20490 @lisp
20491 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
20492 @end lisp
20493
20494
20495 If you look closely at your own @code{Message-ID}, you'll notice that
20496 the first two or three characters are always the same. Here's two of
20497 mine:
20498
20499 @example
20500 <x6u3u47icf.fsf@@eyesore.no>
20501 <x6sp9o7ibw.fsf@@eyesore.no>
20502 @end example
20503
20504 So ``my'' ident on this machine is @samp{x6}. This can be
20505 exploited---the following rule will raise the score on all followups to
20506 myself:
20507
20508 @lisp
20509 ("references"
20510 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
20511 1000 nil r))
20512 @end lisp
20513
20514 Whether it's the first two or first three characters that are ``yours''
20515 is system-dependent.
20516
20517
20518 @node Scoring On Other Headers
20519 @section Scoring On Other Headers
20520 @cindex scoring on other headers
20521
20522 Gnus is quite fast when scoring the ``traditional''
20523 headers---@samp{From}, @samp{Subject} and so on. However, scoring
20524 other headers requires writing a @code{head} scoring rule, which means
20525 that Gnus has to request every single article from the back end to find
20526 matches. This takes a long time in big groups.
20527
20528 @vindex gnus-inhibit-slow-scoring
20529 You can inhibit this slow scoring on headers or body by setting the
20530 variable @code{gnus-inhibit-slow-scoring}. If
20531 @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if
20532 the group matches the regexp. If it is @code{t}, slow scoring on it is
20533 inhibited for all groups.
20534
20535 Now, there's not much you can do about the slowness for news groups, but for
20536 mail groups, you have greater control. In @ref{To From Newsgroups},
20537 it's explained in greater detail what this mechanism does, but here's
20538 a cookbook example for @code{nnml} on how to allow scoring on the
20539 @samp{To} and @samp{Cc} headers.
20540
20541 Put the following in your @file{~/.gnus.el} file.
20542
20543 @lisp
20544 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
20545 nnmail-extra-headers gnus-extra-headers)
20546 @end lisp
20547
20548 Restart Gnus and rebuild your @code{nnml} overview files with the
20549 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
20550 time if you have much mail.
20551
20552 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
20553 so: @kbd{I e s p To RET <your name> RET}.
20554
20555 See? Simple.
20556
20557
20558 @node Scoring Tips
20559 @section Scoring Tips
20560 @cindex scoring tips
20561
20562 @table @dfn
20563
20564 @item Crossposts
20565 @cindex crossposts
20566 @cindex scoring crossposts
20567 If you want to lower the score of crossposts, the line to match on is
20568 the @code{Xref} header.
20569 @lisp
20570 ("xref" (" talk.politics.misc:" -1000))
20571 @end lisp
20572
20573 @item Multiple crossposts
20574 If you want to lower the score of articles that have been crossposted to
20575 more than, say, 3 groups:
20576 @lisp
20577 ("xref"
20578 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
20579 -1000 nil r))
20580 @end lisp
20581
20582 @item Matching on the body
20583 This is generally not a very good idea---it takes a very long time.
20584 Gnus actually has to fetch each individual article from the server. But
20585 you might want to anyway, I guess. Even though there are three match
20586 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
20587 and stick with it in each score file. If you use any two, each article
20588 will be fetched @emph{twice}. If you want to match a bit on the
20589 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
20590 the matches.
20591
20592 @item Marking as read
20593 You will probably want to mark articles that have scores below a certain
20594 number as read. This is most easily achieved by putting the following
20595 in your @file{all.SCORE} file:
20596 @lisp
20597 ((mark -100))
20598 @end lisp
20599 You may also consider doing something similar with @code{expunge}.
20600
20601 @item Negated character classes
20602 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
20603 That will match newlines, which might lead to, well, The Unknown. Say
20604 @code{[^abcd\n]*} instead.
20605 @end table
20606
20607
20608 @node Reverse Scoring
20609 @section Reverse Scoring
20610 @cindex reverse scoring
20611
20612 If you want to keep just articles that have @samp{Sex with Emacs} in the
20613 subject header, and expunge all other articles, you could put something
20614 like this in your score file:
20615
20616 @lisp
20617 (("subject"
20618 ("Sex with Emacs" 2))
20619 (mark 1)
20620 (expunge 1))
20621 @end lisp
20622
20623 So, you raise all articles that match @samp{Sex with Emacs} and mark the
20624 rest as read, and expunge them to boot.
20625
20626
20627 @node Global Score Files
20628 @section Global Score Files
20629 @cindex global score files
20630
20631 Sure, other newsreaders have ``global kill files''. These are usually
20632 nothing more than a single kill file that applies to all groups, stored
20633 in the user's home directory. Bah! Puny, weak newsreaders!
20634
20635 What I'm talking about here are Global Score Files. Score files from
20636 all over the world, from users everywhere, uniting all nations in one
20637 big, happy score file union! Ange-score! New and untested!
20638
20639 @vindex gnus-global-score-files
20640 All you have to do to use other people's score files is to set the
20641 @code{gnus-global-score-files} variable. One entry for each score file,
20642 or each score file directory. Gnus will decide by itself what score
20643 files are applicable to which group.
20644
20645 To use the score file
20646 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
20647 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
20648 say this:
20649
20650 @lisp
20651 (setq gnus-global-score-files
20652 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
20653 "/ftp@@ftp.some-where:/pub/score/"))
20654 @end lisp
20655
20656 @findex gnus-score-search-global-directories
20657 @noindent
20658 Simple, eh? Directory names must end with a @samp{/}. These
20659 directories are typically scanned only once during each Gnus session.
20660 If you feel the need to manually re-scan the remote directories, you can
20661 use the @code{gnus-score-search-global-directories} command.
20662
20663 Note that, at present, using this option will slow down group entry
20664 somewhat. (That is---a lot.)
20665
20666 If you want to start maintaining score files for other people to use,
20667 just put your score file up for anonymous ftp and announce it to the
20668 world. Become a retro-moderator! Participate in the retro-moderator
20669 wars sure to ensue, where retro-moderators battle it out for the
20670 sympathy of the people, luring them to use their score files on false
20671 premises! Yay! The net is saved!
20672
20673 Here are some tips for the would-be retro-moderator, off the top of my
20674 head:
20675
20676 @itemize @bullet
20677
20678 @item
20679 Articles heavily crossposted are probably junk.
20680 @item
20681 To lower a single inappropriate article, lower by @code{Message-ID}.
20682 @item
20683 Particularly brilliant authors can be raised on a permanent basis.
20684 @item
20685 Authors that repeatedly post off-charter for the group can safely be
20686 lowered out of existence.
20687 @item
20688 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
20689 articles completely.
20690
20691 @item
20692 Use expiring score entries to keep the size of the file down. You
20693 should probably have a long expiry period, though, as some sites keep
20694 old articles for a long time.
20695 @end itemize
20696
20697 @dots{} I wonder whether other newsreaders will support global score files
20698 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
20699 Wave, xrn and 1stReader are bound to implement scoring. Should we start
20700 holding our breath yet?
20701
20702
20703 @node Kill Files
20704 @section Kill Files
20705 @cindex kill files
20706
20707 Gnus still supports those pesky old kill files. In fact, the kill file
20708 entries can now be expiring, which is something I wrote before Daniel
20709 Quinlan thought of doing score files, so I've left the code in there.
20710
20711 In short, kill processing is a lot slower (and I do mean @emph{a lot})
20712 than score processing, so it might be a good idea to rewrite your kill
20713 files into score files.
20714
20715 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
20716 forms into this file, which means that you can use kill files as some
20717 sort of primitive hook function to be run on group entry, even though
20718 that isn't a very good idea.
20719
20720 Normal kill files look like this:
20721
20722 @lisp
20723 (gnus-kill "From" "Lars Ingebrigtsen")
20724 (gnus-kill "Subject" "ding")
20725 (gnus-expunge "X")
20726 @end lisp
20727
20728 This will mark every article written by me as read, and remove the
20729 marked articles from the summary buffer. Very useful, you'll agree.
20730
20731 Other programs use a totally different kill file syntax. If Gnus
20732 encounters what looks like a @code{rn} kill file, it will take a stab at
20733 interpreting it.
20734
20735 Two summary functions for editing a @sc{gnus} kill file:
20736
20737 @table @kbd
20738
20739 @item M-k
20740 @kindex M-k (Summary)
20741 @findex gnus-summary-edit-local-kill
20742 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
20743
20744 @item M-K
20745 @kindex M-K (Summary)
20746 @findex gnus-summary-edit-global-kill
20747 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
20748 @end table
20749
20750 Two group mode functions for editing the kill files:
20751
20752 @table @kbd
20753
20754 @item M-k
20755 @kindex M-k (Group)
20756 @findex gnus-group-edit-local-kill
20757 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
20758
20759 @item M-K
20760 @kindex M-K (Group)
20761 @findex gnus-group-edit-global-kill
20762 Edit the general kill file (@code{gnus-group-edit-global-kill}).
20763 @end table
20764
20765 Kill file variables:
20766
20767 @table @code
20768 @item gnus-kill-file-name
20769 @vindex gnus-kill-file-name
20770 A kill file for the group @samp{soc.motss} is normally called
20771 @file{soc.motss.KILL}. The suffix appended to the group name to get
20772 this file name is detailed by the @code{gnus-kill-file-name} variable.
20773 The ``global'' kill file (not in the score file sense of ``global'', of
20774 course) is just called @file{KILL}.
20775
20776 @vindex gnus-kill-save-kill-file
20777 @item gnus-kill-save-kill-file
20778 If this variable is non-@code{nil}, Gnus will save the
20779 kill file after processing, which is necessary if you use expiring
20780 kills.
20781
20782 @item gnus-apply-kill-hook
20783 @vindex gnus-apply-kill-hook
20784 @findex gnus-apply-kill-file-unless-scored
20785 @findex gnus-apply-kill-file
20786 A hook called to apply kill files to a group. It is
20787 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
20788 kill file if you have a score file for the same group, you can set this
20789 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
20790 kill files to be processed, you should set this variable to @code{nil}.
20791
20792 @item gnus-kill-file-mode-hook
20793 @vindex gnus-kill-file-mode-hook
20794 A hook called in kill-file mode buffers.
20795
20796 @end table
20797
20798
20799 @node Converting Kill Files
20800 @section Converting Kill Files
20801 @cindex kill files
20802 @cindex converting kill files
20803
20804 If you have loads of old kill files, you may want to convert them into
20805 score files. If they are ``regular'', you can use
20806 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
20807 by hand.
20808
20809 The kill to score conversion package isn't included in Emacs by default.
20810 You can fetch it from the contrib directory of the Gnus distribution or
20811 from
20812 @uref{http://heim.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
20813
20814 If your old kill files are very complex---if they contain more
20815 non-@code{gnus-kill} forms than not, you'll have to convert them by
20816 hand. Or just let them be as they are. Gnus will still use them as
20817 before.
20818
20819
20820 @node Advanced Scoring
20821 @section Advanced Scoring
20822
20823 Scoring on Subjects and From headers is nice enough, but what if you're
20824 really interested in what a person has to say only when she's talking
20825 about a particular subject? Or what if you really don't want to
20826 read what person A has to say when she's following up to person B, but
20827 want to read what she says when she's following up to person C?
20828
20829 By using advanced scoring rules you may create arbitrarily complex
20830 scoring patterns.
20831
20832 @menu
20833 * Advanced Scoring Syntax:: A definition.
20834 * Advanced Scoring Examples:: What they look like.
20835 * Advanced Scoring Tips:: Getting the most out of it.
20836 @end menu
20837
20838
20839 @node Advanced Scoring Syntax
20840 @subsection Advanced Scoring Syntax
20841
20842 Ordinary scoring rules have a string as the first element in the rule.
20843 Advanced scoring rules have a list as the first element. The second
20844 element is the score to be applied if the first element evaluated to a
20845 non-@code{nil} value.
20846
20847 These lists may consist of three logical operators, one redirection
20848 operator, and various match operators.
20849
20850 Logical operators:
20851
20852 @table @code
20853 @item &
20854 @itemx and
20855 This logical operator will evaluate each of its arguments until it finds
20856 one that evaluates to @code{false}, and then it'll stop. If all arguments
20857 evaluate to @code{true} values, then this operator will return
20858 @code{true}.
20859
20860 @item |
20861 @itemx or
20862 This logical operator will evaluate each of its arguments until it finds
20863 one that evaluates to @code{true}. If no arguments are @code{true},
20864 then this operator will return @code{false}.
20865
20866 @item !
20867 @itemx not
20868 @itemx ¬
20869 This logical operator only takes a single argument. It returns the
20870 logical negation of the value of its argument.
20871
20872 @end table
20873
20874 There is an @dfn{indirection operator} that will make its arguments
20875 apply to the ancestors of the current article being scored. For
20876 instance, @code{1-} will make score rules apply to the parent of the
20877 current article. @code{2-} will make score rules apply to the
20878 grandparent of the current article. Alternatively, you can write
20879 @code{^^}, where the number of @code{^}s (carets) says how far back into
20880 the ancestry you want to go.
20881
20882 Finally, we have the match operators. These are the ones that do the
20883 real work. Match operators are header name strings followed by a match
20884 and a match type. A typical match operator looks like @samp{("from"
20885 "Lars Ingebrigtsen" s)}. The header names are the same as when using
20886 simple scoring, and the match types are also the same.
20887
20888
20889 @node Advanced Scoring Examples
20890 @subsection Advanced Scoring Examples
20891
20892 Please note that the following examples are score file rules. To
20893 make a complete score file from them, surround them with another pair
20894 of parentheses.
20895
20896 Let's say you want to increase the score of articles written by Lars
20897 when he's talking about Gnus:
20898
20899 @example
20900 @group
20901 ((&
20902 ("from" "Lars Ingebrigtsen")
20903 ("subject" "Gnus"))
20904 1000)
20905 @end group
20906 @end example
20907
20908 Quite simple, huh?
20909
20910 When he writes long articles, he sometimes has something nice to say:
20911
20912 @example
20913 ((&
20914 ("from" "Lars Ingebrigtsen")
20915 (|
20916 ("subject" "Gnus")
20917 ("lines" 100 >)))
20918 1000)
20919 @end example
20920
20921 However, when he responds to things written by Reig Eigil Logge, you
20922 really don't want to read what he's written:
20923
20924 @example
20925 ((&
20926 ("from" "Lars Ingebrigtsen")
20927 (1- ("from" "Reig Eigil Logge")))
20928 -100000)
20929 @end example
20930
20931 Everybody that follows up Redmondo when he writes about disappearing
20932 socks should have their scores raised, but only when they talk about
20933 white socks. However, when Lars talks about socks, it's usually not
20934 very interesting:
20935
20936 @example
20937 ((&
20938 (1-
20939 (&
20940 ("from" "redmondo@@.*no" r)
20941 ("body" "disappearing.*socks" t)))
20942 (! ("from" "Lars Ingebrigtsen"))
20943 ("body" "white.*socks"))
20944 1000)
20945 @end example
20946
20947 Suppose you're reading a high volume group and you're only interested
20948 in replies. The plan is to score down all articles that don't have
20949 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
20950 parents of articles that have subjects that begin with reply marks.
20951
20952 @example
20953 ((! ("subject" "re:\\|fwd?:" r))
20954 -200)
20955 ((1- ("subject" "re:\\|fwd?:" r))
20956 200)
20957 @end example
20958
20959 The possibilities are endless.
20960
20961 @node Advanced Scoring Tips
20962 @subsection Advanced Scoring Tips
20963
20964 The @code{&} and @code{|} logical operators do short-circuit logic.
20965 That is, they stop processing their arguments when it's clear what the
20966 result of the operation will be. For instance, if one of the arguments
20967 of an @code{&} evaluates to @code{false}, there's no point in evaluating
20968 the rest of the arguments. This means that you should put slow matches
20969 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
20970 @samp{subject}) first.
20971
20972 The indirection arguments (@code{1-} and so on) will make their
20973 arguments work on previous generations of the thread. If you say
20974 something like:
20975
20976 @example
20977 ...
20978 (1-
20979 (1-
20980 ("from" "lars")))
20981 ...
20982 @end example
20983
20984 Then that means ``score on the from header of the grandparent of the
20985 current article''. An indirection is quite fast, but it's better to say:
20986
20987 @example
20988 (1-
20989 (&
20990 ("from" "Lars")
20991 ("subject" "Gnus")))
20992 @end example
20993
20994 than it is to say:
20995
20996 @example
20997 (&
20998 (1- ("from" "Lars"))
20999 (1- ("subject" "Gnus")))
21000 @end example
21001
21002
21003 @node Score Decays
21004 @section Score Decays
21005 @cindex score decays
21006 @cindex decays
21007
21008 You may find that your scores have a tendency to grow without
21009 bounds, especially if you're using adaptive scoring. If scores get too
21010 big, they lose all meaning---they simply max out and it's difficult to
21011 use them in any sensible way.
21012
21013 @vindex gnus-decay-scores
21014 @findex gnus-decay-score
21015 @vindex gnus-decay-score-function
21016 Gnus provides a mechanism for decaying scores to help with this problem.
21017 When score files are loaded and @code{gnus-decay-scores} is
21018 non-@code{nil}, Gnus will run the score files through the decaying
21019 mechanism thereby lowering the scores of all non-permanent score rules.
21020 If @code{gnus-decay-scores} is a regexp, only score files matching this
21021 regexp are treated. E.g., you may set it to @samp{\\.ADAPT\\'} if only
21022 @emph{adaptive} score files should be decayed. The decay itself if
21023 performed by the @code{gnus-decay-score-function} function, which is
21024 @code{gnus-decay-score} by default. Here's the definition of that
21025 function:
21026
21027 @lisp
21028 (defun gnus-decay-score (score)
21029 "Decay SCORE according to `gnus-score-decay-constant'
21030 and `gnus-score-decay-scale'."
21031 (let ((n (- score
21032 (* (if (< score 0) -1 1)
21033 (min (abs score)
21034 (max gnus-score-decay-constant
21035 (* (abs score)
21036 gnus-score-decay-scale)))))))
21037 (if (and (featurep 'xemacs)
21038 ;; XEmacs's floor can handle only the floating point
21039 ;; number below the half of the maximum integer.
21040 (> (abs n) (lsh -1 -2)))
21041 (string-to-number
21042 (car (split-string (number-to-string n) "\\.")))
21043 (floor n))))
21044 @end lisp
21045
21046 @vindex gnus-score-decay-scale
21047 @vindex gnus-score-decay-constant
21048 @code{gnus-score-decay-constant} is 3 by default and
21049 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21050
21051 @enumerate
21052 @item
21053 Scores between -3 and 3 will be set to 0 when this function is called.
21054
21055 @item
21056 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21057
21058 @item
21059 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21060 score.
21061 @end enumerate
21062
21063 If you don't like this decay function, write your own. It is called
21064 with the score to be decayed as its only parameter, and it should return
21065 the new score, which should be an integer.
21066
21067 Gnus will try to decay scores once a day. If you haven't run Gnus for
21068 four days, Gnus will decay the scores four times, for instance.
21069
21070 @node Searching
21071 @chapter Searching
21072 @cindex searching
21073
21074 FIXME: Add a brief overview of Gnus search capabilities. A brief
21075 comparison of nnir, nnmairix, contrib/gnus-namazu would be nice
21076 as well.
21077
21078 This chapter describes tools for searching groups and servers for
21079 articles matching a query and then retrieving those articles. Gnus
21080 provides a simpler mechanism for searching through articles in a summary buffer
21081 to find those matching a pattern. @xref{Searching for Articles}.
21082
21083 @menu
21084 * nnir:: Searching with various engines.
21085 * nnmairix:: Searching with Mairix.
21086 @end menu
21087
21088 @node nnir
21089 @section nnir
21090 @cindex nnir
21091
21092 This section describes how to use @code{nnir} to search for articles
21093 within gnus.
21094
21095 @menu
21096 * What is nnir?:: What does @code{nnir} do?
21097 * Basic Usage:: How to perform simple searches.
21098 * Setting up nnir:: How to set up @code{nnir}.
21099 @end menu
21100
21101 @node What is nnir?
21102 @subsection What is nnir?
21103
21104 @code{nnir} is a Gnus interface to a number of tools for searching
21105 through mail and news repositories. Different backends (like
21106 @code{nnimap} and @code{nntp}) work with different tools (called
21107 @dfn{engines} in @code{nnir} lingo), but all use the same basic search
21108 interface.
21109
21110 The @code{nnimap} and @code{gmane} search engines should work with no
21111 configuration. Other engines require a local index that needs to be
21112 created and maintained outside of Gnus.
21113
21114
21115 @node Basic Usage
21116 @subsection Basic Usage
21117
21118 In the group buffer typing @kbd{G G} will search the group on the
21119 current line by calling @code{gnus-group-make-nnir-group}. This prompts
21120 for a query string, creates an ephemeral @code{nnir} group containing
21121 the articles that match this query, and takes you to a summary buffer
21122 showing these articles. Articles may then be read, moved and deleted
21123 using the usual commands.
21124
21125 The @code{nnir} group made in this way is an @code{ephemeral} group,
21126 and some changes are not permanent: aside from reading, moving, and
21127 deleting, you can't act on the original article. But there is an
21128 alternative: you can @emph{warp} (i.e., jump) to the original group
21129 for the article on the current line with @kbd{A W}, aka
21130 @code{gnus-warp-to-article}. Even better, the function
21131 @code{gnus-summary-refer-thread}, bound by default in summary buffers
21132 to @kbd{A T}, will first warp to the original group before it works
21133 its magic and includes all the articles in the thread. From here you
21134 can read, move and delete articles, but also copy them, alter article
21135 marks, whatever. Go nuts.
21136
21137 You say you want to search more than just the group on the current line?
21138 No problem: just process-mark the groups you want to search. You want
21139 even more? Calling for an nnir search with the cursor on a topic heading
21140 will search all the groups under that heading.
21141
21142 Still not enough? OK, in the server buffer
21143 @code{gnus-group-make-nnir-group} (now bound to @kbd{G}) will search all
21144 groups from the server on the current line. Too much? Want to ignore
21145 certain groups when searching, like spam groups? Just customize
21146 @code{nnir-ignored-newsgroups}.
21147
21148 One more thing: individual search engines may have special search
21149 features. You can access these special features by giving a prefix-arg
21150 to @code{gnus-group-make-nnir-group}. If you are searching multiple
21151 groups with different search engines you will be prompted for the
21152 special search features for each engine separately.
21153
21154
21155 @node Setting up nnir
21156 @subsection Setting up nnir
21157
21158 To set up nnir you may need to do some prep work. Firstly, you may need
21159 to configure the search engines you plan to use. Some of them, like
21160 @code{imap} and @code{gmane}, need no special configuration. Others,
21161 like @code{namazu} and @code{swish}, require configuration as described
21162 below. Secondly, you need to associate a search engine with a server or
21163 a backend.
21164
21165 If you just want to use the @code{imap} engine to search @code{nnimap}
21166 servers, and the @code{gmane} engine to search @code{gmane} then you
21167 don't have to do anything. But you might want to read the details of the
21168 query language anyway.
21169
21170 @menu
21171 * Associating Engines:: How to associate engines.
21172 * The imap Engine:: Imap configuration and usage.
21173 * The gmane Engine:: Gmane configuration and usage.
21174 * The swish++ Engine:: Swish++ configuration and usage.
21175 * The swish-e Engine:: Swish-e configuration and usage.
21176 * The namazu Engine:: Namazu configuration and usage.
21177 * The notmuch Engine:: Notmuch configuration and usage.
21178 * The hyrex Engine:: Hyrex configuration and usage.
21179 * Customizations:: User customizable settings.
21180 @end menu
21181
21182 @node Associating Engines
21183 @subsubsection Associating Engines
21184
21185
21186 When searching a group, @code{nnir} needs to know which search engine to
21187 use. You can configure a given server to use a particular engine by
21188 setting the server variable @code{nnir-search-engine} to the engine
21189 name. For example to use the @code{namazu} engine to search the server
21190 named @code{home} you can use
21191
21192 @lisp
21193 (setq gnus-secondary-select-methods
21194 '((nnml "home"
21195 (nnimap-address "localhost")
21196 (nnir-search-engine namazu))))
21197 @end lisp
21198
21199 Alternatively you might want to use a particular engine for all servers
21200 with a given backend. For example, you might want to use the @code{imap}
21201 engine for all servers using the @code{nnimap} backend. In this case you
21202 can customize the variable @code{nnir-method-default-engines}. This is
21203 an alist of pairs of the form @code{(backend . engine)}. By default this
21204 variable is set to use the @code{imap} engine for all servers using the
21205 @code{nnimap} backend, and the @code{gmane} backend for @code{nntp}
21206 servers. (Don't worry, the @code{gmane} search engine won't actually try
21207 to search non-gmane @code{nntp} servers.) But if you wanted to use
21208 @code{namazu} for all your servers with an @code{nnimap} backend you
21209 could change this to
21210
21211 @lisp
21212 '((nnimap . namazu)
21213 (nntp . gmane))
21214 @end lisp
21215
21216 @node The imap Engine
21217 @subsubsection The imap Engine
21218
21219 The @code{imap} engine requires no configuration.
21220
21221 Queries using the @code{imap} engine follow a simple query language.
21222 The search is always case-insensitive and supports the following
21223 features (inspired by the Google search input language):
21224
21225 @table @samp
21226
21227 @item Boolean query operators
21228 AND, OR, and NOT are supported, and parentheses can be used to control
21229 operator precedence, e.g., (emacs OR xemacs) AND linux. Note that
21230 operators must be written with all capital letters to be
21231 recognized. Also preceding a term with a @minus{} sign is equivalent
21232 to NOT term.
21233
21234 @item Automatic AND queries
21235 If you specify multiple words then they will be treated as an AND
21236 expression intended to match all components.
21237
21238 @item Phrase searches
21239 If you wrap your query in double-quotes then it will be treated as a
21240 literal string.
21241
21242 @end table
21243
21244 By default the whole message will be searched. The query can be limited
21245 to a specific part of a message by using a prefix-arg. After inputting
21246 the query this will prompt (with completion) for a message part.
21247 Choices include ``Whole message'', ``Subject'', ``From'', and
21248 ``To''. Any unrecognized input is interpreted as a header name. For
21249 example, typing @kbd{Message-ID} in response to this prompt will limit
21250 the query to the Message-ID header.
21251
21252 Finally selecting ``Imap'' will interpret the query as a raw
21253 @acronym{IMAP} search query. The format of such queries can be found in
21254 RFC3501.
21255
21256 If you don't like the default of searching whole messages you can
21257 customize @code{nnir-imap-default-search-key}. For example to use
21258 @acronym{IMAP} queries by default
21259
21260 @lisp
21261 (setq nnir-imap-default-search-key "Imap")
21262 @end lisp
21263
21264 @node The gmane Engine
21265 @subsubsection The gmane Engine
21266
21267 The @code{gmane} engine requires no configuration.
21268
21269 Gmane queries follow a simple query language:
21270
21271 @table @samp
21272 @item Boolean query operators
21273 AND, OR, NOT (or AND NOT), and XOR are supported, and brackets can be
21274 used to control operator precedence, e.g., (emacs OR xemacs) AND linux.
21275 Note that operators must be written with all capital letters to be
21276 recognized.
21277
21278 @item Required and excluded terms
21279 + and @minus{} can be used to require or exclude terms, e.g., football
21280 @minus{}american
21281
21282 @item Unicode handling
21283 The search engine converts all text to utf-8, so searching should work
21284 in any language.
21285
21286 @item Stopwords
21287 Common English words (like 'the' and 'a') are ignored by default. You
21288 can override this by prefixing such words with a + (e.g., +the) or
21289 enclosing the word in quotes (e.g., "the").
21290
21291 @end table
21292
21293 The query can be limited to articles by a specific author using a
21294 prefix-arg. After inputting the query this will prompt for an author
21295 name (or part of a name) to match.
21296
21297 @node The swish++ Engine
21298 @subsubsection The swish++ Engine
21299
21300 FIXME: Say something more here.
21301
21302 Documentation for swish++ may be found at the swish++ sourceforge page:
21303 @uref{http://swishplusplus.sourceforge.net}
21304
21305 @table @code
21306
21307 @item nnir-swish++-program
21308 The name of the swish++ executable. Defaults to @code{search}
21309
21310 @item nnir-swish++-additional-switches
21311 A list of strings to be given as additional arguments to
21312 swish++. @code{nil} by default.
21313
21314 @item nnir-swish++-remove-prefix
21315 The prefix to remove from each file name returned by swish++ in order
21316 to get a group name. By default this is @code{$HOME/Mail}.
21317
21318 @end table
21319
21320 @node The swish-e Engine
21321 @subsubsection The swish-e Engine
21322
21323 FIXME: Say something more here.
21324
21325 Documentation for swish-e may be found at the swish-e homepage
21326 @uref{http://swish-e.org}
21327
21328 @table @code
21329
21330 @item nnir-swish-e-program
21331 The name of the swish-e search program. Defaults to @code{swish-e}.
21332
21333 @item nnir-swish-e-additional-switches
21334 A list of strings to be given as additional arguments to
21335 swish-e. @code{nil} by default.
21336
21337 @item nnir-swish-e-remove-prefix
21338 The prefix to remove from each file name returned by swish-e in order
21339 to get a group name. By default this is @code{$HOME/Mail}.
21340
21341 @end table
21342
21343 @node The namazu Engine
21344 @subsubsection The namazu Engine
21345
21346 Using the namazu engine requires creating and maintaining index files.
21347 One directory should contain all the index files, and nnir must be told
21348 where to find them by setting the @code{nnir-namazu-index-directory}
21349 variable.
21350
21351 To work correctly the @code{nnir-namazu-remove-prefix} variable must
21352 also be correct. This is the prefix to remove from each file name
21353 returned by Namazu in order to get a proper group name (albeit with `/'
21354 instead of `.').
21355
21356 For example, suppose that Namazu returns file names such as
21357 @samp{/home/john/Mail/mail/misc/42}. For this example, use the
21358 following setting: @code{(setq nnir-namazu-remove-prefix
21359 "/home/john/Mail/")} Note the trailing slash. Removing this prefix from
21360 the directory gives @samp{mail/misc/42}. @code{nnir} knows to remove
21361 the @samp{/42} and to replace @samp{/} with @samp{.} to arrive at the
21362 correct group name @samp{mail.misc}.
21363
21364 Extra switches may be passed to the namazu search command by setting the
21365 variable @code{nnir-namazu-additional-switches}. It is particularly
21366 important not to pass any any switches to namazu that will change the
21367 output format. Good switches to use include `--sort', `--ascending',
21368 `--early' and `--late'. Refer to the Namazu documentation for further
21369 information on valid switches.
21370
21371 Mail must first be indexed with the `mknmz' program. Read the documentation
21372 for namazu to create a configuration file. Here is an example:
21373
21374 @cartouche
21375 @example
21376 package conf; # Don't remove this line!
21377
21378 # Paths which will not be indexed. Don't use `^' or `$' anchors.
21379 $EXCLUDE_PATH = "spam|sent";
21380
21381 # Header fields which should be searchable. case-insensitive
21382 $REMAIN_HEADER = "from|date|message-id|subject";
21383
21384 # Searchable fields. case-insensitive
21385 $SEARCH_FIELD = "from|date|message-id|subject";
21386
21387 # The max length of a word.
21388 $WORD_LENG_MAX = 128;
21389
21390 # The max length of a field.
21391 $MAX_FIELD_LENGTH = 256;
21392 @end example
21393 @end cartouche
21394
21395 For this example, mail is stored in the directories @samp{~/Mail/mail/},
21396 @samp{~/Mail/lists/} and @samp{~/Mail/archive/}, so to index them go to
21397 the index directory set in @code{nnir-namazu-index-directory} and issue
21398 the following command:
21399
21400 @example
21401 mknmz --mailnews ~/Mail/archive/ ~/Mail/mail/ ~/Mail/lists/
21402 @end example
21403
21404 For maximum searching efficiency you might want to have a cron job run
21405 this command periodically, say every four hours.
21406
21407
21408 @node The notmuch Engine
21409 @subsubsection The notmuch Engine
21410
21411 @table @code
21412 @item nnir-notmuch-program
21413 The name of the notmuch search executable. Defaults to
21414 @samp{notmuch}.
21415
21416 @item nnir-notmuch-additional-switches
21417 A list of strings, to be given as additional arguments to notmuch.
21418
21419 @item nnir-notmuch-remove-prefix
21420 The prefix to remove from each file name returned by notmuch in order
21421 to get a group name (albeit with @samp{/} instead of @samp{.}). This
21422 is a regular expression.
21423
21424 @end table
21425
21426
21427 @node The hyrex Engine
21428 @subsubsection The hyrex Engine
21429 This engine is obsolete.
21430
21431 @node Customizations
21432 @subsubsection Customizations
21433
21434 @table @code
21435
21436 @item nnir-method-default-engines
21437 Alist of pairs of server backends and search engines. The default
21438 associations are
21439 @example
21440 (nnimap . imap)
21441 (nntp . gmane)
21442 @end example
21443
21444 @item nnir-ignored-newsgroups
21445 A regexp to match newsgroups in the active file that should be skipped
21446 when searching all groups on a server.
21447
21448 @item nnir-summary-line-format
21449 The format specification to be used for lines in an nnir summary buffer.
21450 All the items from `gnus-summary-line-format' are available, along with
21451 three items unique to nnir summary buffers:
21452
21453 @example
21454 %Z Search retrieval score value (integer)
21455 %G Article original full group name (string)
21456 %g Article original short group name (string)
21457 @end example
21458
21459 If @code{nil} (the default) this will use @code{gnus-summary-line-format}.
21460
21461 @item nnir-retrieve-headers-override-function
21462 If non-@code{nil}, a function that retrieves article headers rather than using
21463 the gnus built-in function. This function takes an article list and
21464 group as arguments and populates the `nntp-server-buffer' with the
21465 retrieved headers. It should then return either 'nov or 'headers
21466 indicating the retrieved header format. Failure to retrieve headers
21467 should return @code{nil}.
21468
21469 If this variable is @code{nil}, or if the provided function returns
21470 @code{nil} for a search result, @code{gnus-retrieve-headers} will be
21471 called instead."
21472
21473
21474 @end table
21475
21476
21477 @node nnmairix
21478 @section nnmairix
21479
21480 @cindex mairix
21481 @cindex nnmairix
21482 This paragraph describes how to set up mairix and the back end
21483 @code{nnmairix} for indexing and searching your mail from within
21484 Gnus. Additionally, you can create permanent ``smart'' groups which are
21485 bound to mairix searches and are automatically updated.
21486
21487 @menu
21488 * About mairix:: About the mairix mail search engine
21489 * nnmairix requirements:: What you will need for using nnmairix
21490 * What nnmairix does:: What does nnmairix actually do?
21491 * Setting up mairix:: Set up your mairix installation
21492 * Configuring nnmairix:: Set up the nnmairix back end
21493 * nnmairix keyboard shortcuts:: List of available keyboard shortcuts
21494 * Propagating marks:: How to propagate marks from nnmairix groups
21495 * nnmairix tips and tricks:: Some tips, tricks and examples
21496 * nnmairix caveats:: Some more stuff you might want to know
21497 @end menu
21498
21499 @c FIXME: The markup in this section might need improvement.
21500 @c E.g., adding @samp, @var, @file, @command, etc.
21501 @c Cf. (info "(texinfo)Indicating")
21502
21503 @node About mairix
21504 @subsection About mairix
21505
21506 Mairix is a tool for indexing and searching words in locally stored
21507 mail. It was written by Richard Curnow and is licensed under the
21508 GPL@. Mairix comes with most popular GNU/Linux distributions, but it also
21509 runs under Windows (with cygwin), Mac OS X and Solaris. The homepage can
21510 be found at
21511 @uref{http://www.rpcurnow.force9.co.uk/mairix/index.html}
21512
21513 Though mairix might not be as flexible as other search tools like
21514 swish++ or namazu, which you can use via the @code{nnir} back end, it
21515 has the prime advantage of being incredibly fast. On current systems, it
21516 can easily search through headers and message bodies of thousands and
21517 thousands of mails in well under a second. Building the database
21518 necessary for searching might take a minute or two, but only has to be
21519 done once fully. Afterwards, the updates are done incrementally and
21520 therefore are really fast, too. Additionally, mairix is very easy to set
21521 up.
21522
21523 For maximum speed though, mairix should be used with mails stored in
21524 @code{Maildir} or @code{MH} format (this includes the @code{nnml} back
21525 end), although it also works with mbox. Mairix presents the search
21526 results by populating a @emph{virtual} maildir/MH folder with symlinks
21527 which point to the ``real'' message files (if mbox is used, copies are
21528 made). Since mairix already presents search results in such a virtual
21529 mail folder, it is very well suited for using it as an external program
21530 for creating @emph{smart} mail folders, which represent certain mail
21531 searches.
21532
21533 @node nnmairix requirements
21534 @subsection nnmairix requirements
21535
21536 Mairix searches local mail---that means, mairix absolutely must have
21537 direct access to your mail folders. If your mail resides on another
21538 server (e.g., an @acronym{IMAP} server) and you happen to have shell
21539 access, @code{nnmairix} supports running mairix remotely, e.g., via ssh.
21540
21541 Additionally, @code{nnmairix} only supports the following Gnus back
21542 ends: @code{nnml}, @code{nnmaildir}, and @code{nnimap}. You must use
21543 one of these back ends for using @code{nnmairix}. Other back ends, like
21544 @code{nnmbox}, @code{nnfolder} or @code{nnmh}, won't work.
21545
21546 If you absolutely must use mbox and still want to use @code{nnmairix},
21547 you can set up a local @acronym{IMAP} server, which you then access via
21548 @code{nnimap}. This is a rather massive setup for accessing some mbox
21549 files, so just change to MH or Maildir already... However, if you're
21550 really, really passionate about using mbox, you might want to look into
21551 the package @file{mairix.el}, which comes with Emacs 23.
21552
21553 @node What nnmairix does
21554 @subsection What nnmairix does
21555
21556 The back end @code{nnmairix} enables you to call mairix from within Gnus,
21557 either to query mairix with a search term or to update the
21558 database. While visiting a message in the summary buffer, you can use
21559 several pre-defined shortcuts for calling mairix, e.g., to quickly
21560 search for all mails from the sender of the current message or to
21561 display the whole thread associated with the message, even if the
21562 mails are in different folders.
21563
21564 Additionally, you can create permanent @code{nnmairix} groups which are bound
21565 to certain mairix searches. This way, you can easily create a group
21566 containing mails from a certain sender, with a certain subject line or
21567 even for one specific thread based on the Message-ID@. If you check for
21568 new mail in these folders (e.g., by pressing @kbd{g} or @kbd{M-g}), they
21569 automatically update themselves by calling mairix.
21570
21571 You might ask why you need @code{nnmairix} at all, since mairix already
21572 creates the group, populates it with links to the mails so that you can
21573 then access it with Gnus, right? Well, this @emph{might} work, but often
21574 does not---at least not without problems. Most probably you will get
21575 strange article counts, and sometimes you might see mails which Gnus
21576 claims have already been canceled and are inaccessible. This is due to
21577 the fact that Gnus isn't really amused when things are happening behind
21578 its back. Another problem can be the mail back end itself, e.g., if you
21579 use mairix with an @acronym{IMAP} server (I had Dovecot complaining
21580 about corrupt index files when mairix changed the contents of the search
21581 group). Using @code{nnmairix} should circumvent these problems.
21582
21583 @code{nnmairix} is not really a mail back end---it's actually more like
21584 a wrapper, sitting between a ``real'' mail back end where mairix stores
21585 the searches and the Gnus front end. You can choose between three
21586 different mail back ends for the mairix folders: @code{nnml},
21587 @code{nnmaildir} or @code{nnimap}. @code{nnmairix} will call the mairix
21588 binary so that the search results are stored in folders named
21589 @code{zz_mairix-<NAME>-<NUMBER>} on this mail back end, but it will
21590 present these folders in the Gnus front end only with @code{<NAME>}.
21591 You can use an existing mail back end where you already store your mail,
21592 but if you're uncomfortable with @code{nnmairix} creating new mail
21593 groups alongside your other mail, you can also create, e.g., a new
21594 @code{nnmaildir} or @code{nnml} server exclusively for mairix, but then
21595 make sure those servers do not accidentally receive your new mail
21596 (@pxref{nnmairix caveats}). A special case exists if you want to use
21597 mairix remotely on an IMAP server with @code{nnimap}---here the mairix
21598 folders and your other mail must be on the same @code{nnimap} back end.
21599
21600 @node Setting up mairix
21601 @subsection Setting up mairix
21602
21603 First: create a backup of your mail folders (@pxref{nnmairix caveats}).
21604
21605 Setting up mairix is easy: simply create a @file{.mairixrc} file with
21606 (at least) the following entries:
21607
21608 @example
21609 # Your Maildir/MH base folder
21610 base=~/Maildir
21611 @end example
21612
21613 This is the base folder for your mails. All the following directories
21614 are relative to this base folder. If you want to use @code{nnmairix}
21615 with @code{nnimap}, this base directory has to point to the mail
21616 directory where the @acronym{IMAP} server stores the mail folders!
21617
21618 @example
21619 maildir= ... your maildir folders which should be indexed ...
21620 mh= ... your nnml/mh folders which should be indexed ...
21621 mbox = ... your mbox files which should be indexed ...
21622 @end example
21623
21624 This specifies all your mail folders and mbox files (relative to the
21625 base directory!) you want to index with mairix. Note that the
21626 @code{nnml} back end saves mails in MH format, so you have to put those
21627 directories in the @code{mh} line. See the example at the end of this
21628 section and mairixrc's man-page for further details.
21629
21630 @example
21631 omit=zz_mairix-*
21632 @end example
21633
21634 @vindex nnmairix-group-prefix
21635 This should make sure that you don't accidentally index the mairix
21636 search results. You can change the prefix of these folders with the
21637 variable @code{nnmairix-group-prefix}.
21638
21639 @example
21640 mformat= ... 'maildir' or 'mh' ...
21641 database= ... location of database file ...
21642 @end example
21643
21644 The @code{format} setting specifies the output format for the mairix
21645 search folder. Set this to @code{mh} if you want to access search results
21646 with @code{nnml}. Otherwise choose @code{maildir}.
21647
21648 To summarize, here is my shortened @file{.mairixrc} file as an example:
21649
21650 @example
21651 base=~/Maildir
21652 maildir=.personal:.work:.logcheck:.sent
21653 mh=../Mail/nnml/*...
21654 mbox=../mboxmail/mailarchive_year*
21655 mformat=maildir
21656 omit=zz_mairix-*
21657 database=~/.mairixdatabase
21658 @end example
21659
21660 In this case, the base directory is @file{~/Maildir}, where all my Maildir
21661 folders are stored. As you can see, the folders are separated by
21662 colons. If you wonder why every folder begins with a dot: this is
21663 because I use Dovecot as @acronym{IMAP} server, which again uses
21664 @code{Maildir++} folders. For testing nnmairix, I also have some
21665 @code{nnml} mail, which is saved in @file{~/Mail/nnml}. Since this has
21666 to be specified relative to the @code{base} directory, the @code{../Mail}
21667 notation is needed. Note that the line ends in @code{*...}, which means
21668 to recursively scan all files under this directory. Without the three
21669 dots, the wildcard @code{*} will not work recursively. I also have some
21670 old mbox files with archived mail lying around in @file{~/mboxmail}.
21671 The other lines should be obvious.
21672
21673 See the man page for @code{mairixrc} for details and further options,
21674 especially regarding wildcard usage, which may be a little different
21675 than you are used to.
21676
21677 Now simply call @code{mairix} to create the index for the first time.
21678 Note that this may take a few minutes, but every following index will do
21679 the updates incrementally and hence is very fast.
21680
21681 @node Configuring nnmairix
21682 @subsection Configuring nnmairix
21683
21684 In group mode, type @kbd{G b c}
21685 (@code{nnmairix-create-server-and-default-group}). This will ask you for all
21686 necessary information and create a @code{nnmairix} server as a foreign
21687 server. You will have to specify the following:
21688
21689 @itemize @bullet
21690
21691 @item
21692 The @strong{name} of the @code{nnmairix} server---choose whatever you
21693 want.
21694
21695 @item
21696 The name of the @strong{back end server} where mairix should store its
21697 searches. This must be a full server name, like @code{nnml:mymail}.
21698 Just hit @kbd{TAB} to see the available servers. Currently, servers
21699 which are accessed through @code{nnmaildir}, @code{nnimap} and
21700 @code{nnml} are supported. As explained above, for locally stored
21701 mails, this can be an existing server where you store your mails.
21702 However, you can also create, e.g., a new @code{nnmaildir} or @code{nnml}
21703 server exclusively for @code{nnmairix} in your secondary select methods
21704 (@pxref{Finding the News}). If you use a secondary @code{nnml} server
21705 just for mairix, make sure that you explicitly set the server variable
21706 @code{nnml-get-new-mail} to @code{nil}, or you might lose mail
21707 (@pxref{nnmairix caveats}). If you want to use mairix remotely on an
21708 @acronym{IMAP} server, you have to choose the corresponding
21709 @code{nnimap} server here.
21710
21711 @item
21712 @vindex nnmairix-mairix-search-options
21713 The @strong{command} to call the mairix binary. This will usually just
21714 be @code{mairix}, but you can also choose something like @code{ssh
21715 SERVER mairix} if you want to call mairix remotely, e.g., on your
21716 @acronym{IMAP} server. If you want to add some default options to
21717 mairix, you could do this here, but better use the variable
21718 @code{nnmairix-mairix-search-options} instead.
21719
21720 @item
21721 The name of the @strong{default search group}. This will be the group
21722 where all temporary mairix searches are stored, i.e., all searches which
21723 are not bound to permanent @code{nnmairix} groups. Choose whatever you
21724 like.
21725
21726 @item
21727 If the mail back end is @code{nnimap} or @code{nnmaildir}, you will be
21728 asked if you work with @strong{Maildir++}, i.e., with hidden maildir
21729 folders (=beginning with a dot). For example, you have to answer
21730 @samp{yes} here if you work with the Dovecot @acronym{IMAP}
21731 server. Otherwise, you should answer @samp{no} here.
21732
21733 @end itemize
21734
21735 @node nnmairix keyboard shortcuts
21736 @subsection nnmairix keyboard shortcuts
21737
21738 In group mode:
21739
21740 @table @kbd
21741
21742 @item G b c
21743 @kindex G b c (Group)
21744 @findex nnmairix-create-server-and-default-group
21745 Creates @code{nnmairix} server and default search group for this server
21746 (@code{nnmairix-create-server-and-default-group}). You should have done
21747 this by now (@pxref{Configuring nnmairix}).
21748
21749 @item G b s
21750 @kindex G b s (Group)
21751 @findex nnmairix-search
21752 Prompts for query which is then sent to the mairix binary. Search
21753 results are put into the default search group which is automatically
21754 displayed (@code{nnmairix-search}).
21755
21756 @item G b m
21757 @kindex G b m (Group)
21758 @findex nnmairix-widget-search
21759 Allows you to create a mairix search or a permanent group more
21760 comfortably using graphical widgets, similar to a customization
21761 group. Just try it to see how it works (@code{nnmairix-widget-search}).
21762
21763 @item G b i
21764 @kindex G b i (Group)
21765 @findex nnmairix-search-interactive
21766 Another command for creating a mairix query more comfortably, but uses
21767 only the minibuffer (@code{nnmairix-search-interactive}).
21768
21769 @item G b g
21770 @kindex G b g (Group)
21771 @findex nnmairix-create-search-group
21772 Creates a permanent group which is associated with a search query
21773 (@code{nnmairix-create-search-group}). The @code{nnmairix} back end
21774 automatically calls mairix when you update this group with @kbd{g} or
21775 @kbd{M-g}.
21776
21777 @item G b q
21778 @kindex G b q (Group)
21779 @findex nnmairix-group-change-query-this-group
21780 Changes the search query for the @code{nnmairix} group under cursor
21781 (@code{nnmairix-group-change-query-this-group}).
21782
21783 @item G b t
21784 @kindex G b t (Group)
21785 @findex nnmairix-group-toggle-threads-this-group
21786 Toggles the 'threads' parameter for the @code{nnmairix} group under cursor,
21787 i.e., if you want see the whole threads of the found messages
21788 (@code{nnmairix-group-toggle-threads-this-group}).
21789
21790 @item G b u
21791 @kindex G b u (Group)
21792 @findex nnmairix-update-database
21793 @vindex nnmairix-mairix-update-options
21794 Calls mairix binary for updating the database
21795 (@code{nnmairix-update-database}). The default parameters are @code{-F}
21796 and @code{-Q} for making this as fast as possible (see variable
21797 @code{nnmairix-mairix-update-options} for defining these default
21798 options).
21799
21800 @item G b r
21801 @kindex G b r (Group)
21802 @findex nnmairix-group-toggle-readmarks-this-group
21803 Keep articles in this @code{nnmairix} group always read or unread, or leave the
21804 marks unchanged (@code{nnmairix-group-toggle-readmarks-this-group}).
21805
21806 @item G b d
21807 @kindex G b d (Group)
21808 @findex nnmairix-group-delete-recreate-this-group
21809 Recreate @code{nnmairix} group on the ``real'' mail back end
21810 (@code{nnmairix-group-delete-recreate-this-group}). You can do this if
21811 you always get wrong article counts with a @code{nnmairix} group.
21812
21813 @item G b a
21814 @kindex G b a (Group)
21815 @findex nnmairix-group-toggle-allowfast-this-group
21816 Toggles the @code{allow-fast} parameters for group under cursor
21817 (@code{nnmairix-group-toggle-allowfast-this-group}). The default
21818 behavior of @code{nnmairix} is to do a mairix search every time you
21819 update or enter the group. With the @code{allow-fast} parameter set,
21820 mairix will only be called when you explicitly update the group, but not
21821 upon entering. This makes entering the group faster, but it may also
21822 lead to dangling symlinks if something changed between updating and
21823 entering the group which is not yet in the mairix database.
21824
21825 @item G b p
21826 @kindex G b p (Group)
21827 @findex nnmairix-group-toggle-propmarks-this-group
21828 Toggle marks propagation for this group
21829 (@code{nnmairix-group-toggle-propmarks-this-group}). (@pxref{Propagating
21830 marks}).
21831
21832 @item G b o
21833 @kindex G b o (Group)
21834 @findex nnmairix-propagate-marks
21835 Manually propagate marks (@code{nnmairix-propagate-marks}); needed only when
21836 @code{nnmairix-propagate-marks-upon-close} is set to @code{nil}.
21837
21838 @end table
21839
21840 In summary mode:
21841
21842 @table @kbd
21843
21844 @item $ m
21845 @kindex $ m (Summary)
21846 @findex nnmairix-widget-search-from-this-article
21847 Allows you to create a mairix query or group based on the current
21848 message using graphical widgets (same as @code{nnmairix-widget-search})
21849 (@code{nnmairix-widget-search-from-this-article}).
21850
21851 @item $ g
21852 @kindex $ g (Summary)
21853 @findex nnmairix-create-search-group-from-message
21854 Interactively creates a new search group with query based on the current
21855 message, but uses the minibuffer instead of graphical widgets
21856 (@code{nnmairix-create-search-group-from-message}).
21857
21858 @item $ t
21859 @kindex $ t (Summary)
21860 @findex nnmairix-search-thread-this-article
21861 Searches thread for the current article
21862 (@code{nnmairix-search-thread-this-article}). This is effectively a
21863 shortcut for calling @code{nnmairix-search} with @samp{m:msgid} of the
21864 current article and enabled threads.
21865
21866 @item $ f
21867 @kindex $ f (Summary)
21868 @findex nnmairix-search-from-this-article
21869 Searches all messages from sender of the current article
21870 (@code{nnmairix-search-from-this-article}). This is a shortcut for
21871 calling @code{nnmairix-search} with @samp{f:From}.
21872
21873 @item $ o
21874 @kindex $ o (Summary)
21875 @findex nnmairix-goto-original-article
21876 (Only in @code{nnmairix} groups!) Tries determine the group this article
21877 originally came from and displays the article in this group, so that,
21878 e.g., replying to this article the correct posting styles/group
21879 parameters are applied (@code{nnmairix-goto-original-article}). This
21880 function will use the registry if available, but can also parse the
21881 article file name as a fallback method.
21882
21883 @item $ u
21884 @kindex $ u (Summary)
21885 @findex nnmairix-remove-tick-mark-original-article
21886 Remove possibly existing tick mark from original article
21887 (@code{nnmairix-remove-tick-mark-original-article}). (@pxref{nnmairix
21888 tips and tricks}).
21889
21890 @end table
21891
21892 @node Propagating marks
21893 @subsection Propagating marks
21894
21895 First of: you really need a patched mairix binary for using the marks
21896 propagation feature efficiently. Otherwise, you would have to update
21897 the mairix database all the time. You can get the patch at
21898
21899 @uref{http://www.randomsample.de/mairix-maildir-patch.tar}
21900
21901 You need the mairix v0.21 source code for this patch; everything else
21902 is explained in the accompanied readme file. If you don't want to use
21903 marks propagation, you don't have to apply these patches, but they also
21904 fix some annoyances regarding changing maildir flags, so it might still
21905 be useful to you.
21906
21907 With the patched mairix binary, you can use @code{nnmairix} as an
21908 alternative to mail splitting (@pxref{Fancy Mail Splitting}). For
21909 example, instead of splitting all mails from @samp{david@@foobar.com}
21910 into a group, you can simply create a search group with the query
21911 @samp{f:david@@foobar.com}. This is actually what ``smart folders'' are
21912 all about: simply put everything in one mail folder and dynamically
21913 create searches instead of splitting. This is more flexible, since you
21914 can dynamically change your folders any time you want to. This also
21915 implies that you will usually read your mails in the @code{nnmairix}
21916 groups instead of your ``real'' mail groups.
21917
21918 There is one problem, though: say you got a new mail from
21919 @samp{david@@foobar.com}; it will now show up in two groups, the
21920 ``real'' group (your INBOX, for example) and in the @code{nnmairix}
21921 search group (provided you have updated the mairix database). Now you
21922 enter the @code{nnmairix} group and read the mail. The mail will be
21923 marked as read, but only in the @code{nnmairix} group---in the ``real''
21924 mail group it will be still shown as unread.
21925
21926 You could now catch up the mail group (@pxref{Group Data}), but this is
21927 tedious and error prone, since you may overlook mails you don't have
21928 created @code{nnmairix} groups for. Of course, you could first use
21929 @code{nnmairix-goto-original-article} (@pxref{nnmairix keyboard
21930 shortcuts}) and then read the mail in the original group, but that's
21931 even more cumbersome.
21932
21933 Clearly, the easiest way would be if marks could somehow be
21934 automatically set for the original article. This is exactly what
21935 @emph{marks propagation} is about.
21936
21937 Marks propagation is inactive by default. You can activate it for a
21938 certain @code{nnmairix} group with
21939 @code{nnmairix-group-toggle-propmarks-this-group} (bound to @kbd{G b
21940 p}). This function will warn you if you try to use it with your default
21941 search group; the reason is that the default search group is used for
21942 temporary searches, and it's easy to accidentally propagate marks from
21943 this group. However, you can ignore this warning if you really want to.
21944
21945 With marks propagation enabled, all the marks you set in a @code{nnmairix}
21946 group should now be propagated to the original article. For example,
21947 you can now tick an article (by default with @kbd{!}) and this mark should
21948 magically be set for the original article, too.
21949
21950 A few more remarks which you may or may not want to know:
21951
21952 @vindex nnmairix-propagate-marks-upon-close
21953 Marks will not be set immediately, but only upon closing a group. This
21954 not only makes marks propagation faster, it also avoids problems with
21955 dangling symlinks when dealing with maildir files (since changing flags
21956 will change the file name). You can also control when to propagate marks
21957 via @code{nnmairix-propagate-marks-upon-close} (see the doc-string for
21958 details).
21959
21960 Obviously, @code{nnmairix} will have to look up the original group for every
21961 article you want to set marks for. If available, @code{nnmairix} will first
21962 use the registry for determining the original group. The registry is very
21963 fast, hence you should really, really enable the registry when using
21964 marks propagation. If you don't have to worry about RAM and disc space,
21965 set @code{gnus-registry-max-entries} to a large enough value; to be on
21966 the safe side, choose roughly the amount of mails you index with mairix.
21967
21968 @vindex nnmairix-only-use-registry
21969 If you don't want to use the registry or the registry hasn't seen the
21970 original article yet, @code{nnmairix} will use an additional mairix
21971 search for determining the file name of the article. This, of course, is
21972 way slower than the registry---if you set hundreds or even thousands of
21973 marks this way, it might take some time. You can avoid this situation by
21974 setting @code{nnmairix-only-use-registry} to @code{t}.
21975
21976 Maybe you also want to propagate marks the other way round, i.e., if you
21977 tick an article in a "real" mail group, you'd like to have the same
21978 article in a @code{nnmairix} group ticked, too. For several good
21979 reasons, this can only be done efficiently if you use maildir. To
21980 immediately contradict myself, let me mention that it WON'T work with
21981 @code{nnmaildir}, since @code{nnmaildir} stores the marks externally and
21982 not in the file name. Therefore, propagating marks to @code{nnmairix}
21983 groups will usually only work if you use an IMAP server which uses
21984 maildir as its file format.
21985
21986 @vindex nnmairix-propagate-marks-to-nnmairix-groups
21987 If you work with this setup, just set
21988 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t} and see what
21989 happens. If you don't like what you see, just set it to @code{nil} again.
21990 One problem might be that you get a wrong number of unread articles; this
21991 usually happens when you delete or expire articles in the original
21992 groups. When this happens, you can recreate the @code{nnmairix} group on
21993 the back end using @kbd{G b d}.
21994
21995 @node nnmairix tips and tricks
21996 @subsection nnmairix tips and tricks
21997
21998 @itemize
21999 @item
22000 Checking Mail
22001
22002 @findex nnmairix-update-groups
22003 I put all my important mail groups at group level 1. The mairix groups
22004 have group level 5, so they do not get checked at start up (@pxref{Group
22005 Levels}).
22006
22007 I use the following to check for mails:
22008
22009 @lisp
22010 (defun my-check-mail-mairix-update (level)
22011 (interactive "P")
22012 ;; if no prefix given, set level=1
22013 (gnus-group-get-new-news (or level 1))
22014 (nnmairix-update-groups "mairixsearch" t t)
22015 (gnus-group-list-groups))
22016
22017 (define-key gnus-group-mode-map "g" 'my-check-mail-mairix-update)
22018 @end lisp
22019
22020 Instead of @samp{"mairixsearch"} use the name of your @code{nnmairix}
22021 server. See the doc string for @code{nnmairix-update-groups} for
22022 details.
22023
22024 @item
22025 Example: search group for ticked articles
22026
22027 For example, you can create a group for all ticked articles, where the
22028 articles always stay unread:
22029
22030 Hit @kbd{G b g}, enter group name (e.g., @samp{important}), use
22031 @samp{F:f} as query and do not include threads.
22032
22033 Now activate marks propagation for this group by using @kbd{G b p}. Then
22034 activate the always-unread feature by using @kbd{G b r} twice.
22035
22036 So far so good---but how do you remove the tick marks in the @code{nnmairix}
22037 group? There are two options: You may simply use
22038 @code{nnmairix-remove-tick-mark-original-article} (bound to @kbd{$ u}) to remove
22039 tick marks from the original article. The other possibility is to set
22040 @code{nnmairix-propagate-marks-to-nnmairix-groups} to @code{t}, but see the above
22041 comments about this option. If it works for you, the tick marks should
22042 also exist in the @code{nnmairix} group and you can remove them as usual,
22043 e.g., by marking an article as read.
22044
22045 When you have removed a tick mark from the original article, this
22046 article should vanish from the @code{nnmairix} group after you have updated the
22047 mairix database and updated the group. Fortunately, there is a function
22048 for doing exactly that: @code{nnmairix-update-groups}. See the previous code
22049 snippet and the doc string for details.
22050
22051 @item
22052 Dealing with auto-subscription of mail groups
22053
22054 As described before, all @code{nnmairix} groups are in fact stored on
22055 the mail back end in the form @samp{zz_mairix-<NAME>-<NUMBER>}. You can
22056 see them when you enter the back end server in the server buffer. You
22057 should not subscribe these groups! Unfortunately, these groups will
22058 usually get @emph{auto-subscribed} when you use @code{nnmaildir} or
22059 @code{nnml}, i.e., you will suddenly see groups of the form
22060 @samp{zz_mairix*} pop up in your group buffer. If this happens to you,
22061 simply kill these groups with C-k. For avoiding this, turn off
22062 auto-subscription completely by setting the variable
22063 @code{gnus-auto-subscribed-groups} to @code{nil} (@pxref{Filtering New
22064 Groups}), or if you like to keep this feature use the following kludge
22065 for turning it off for all groups beginning with @samp{zz_}:
22066
22067 @lisp
22068 (setq gnus-auto-subscribed-groups
22069 "^\\(nnml\\|nnfolder\\|nnmbox\\|nnmh\\|nnbabyl\\|nnmaildir\\).*:\\([^z]\\|z$\\|\\z[^z]\\|zz$\\|zz[^_]\\|zz_$\\).*")
22070 @end lisp
22071
22072 @end itemize
22073
22074 @node nnmairix caveats
22075 @subsection nnmairix caveats
22076
22077 @itemize
22078 @item
22079 You can create a secondary @code{nnml} server just for nnmairix, but then
22080 you have to explicitly set the corresponding server variable
22081 @code{nnml-get-new-mail} to @code{nil}. Otherwise, new mail might get
22082 put into this secondary server (and would never show up again). Here's
22083 an example server definition:
22084
22085 @lisp
22086 (nnml "mairix" (nnml-directory "mairix") (nnml-get-new-mail nil))
22087 @end lisp
22088
22089 (The @code{nnmaildir} back end also has a server variable
22090 @code{get-new-mail}, but its default value is @code{nil}, so you don't
22091 have to explicitly set it if you use a @code{nnmaildir} server just for
22092 mairix.)
22093
22094 @item
22095 If you use the Gnus registry: don't use the registry with
22096 @code{nnmairix} groups (put them in
22097 @code{gnus-registry-unfollowed-groups}; this is the default). Be
22098 @emph{extra careful} if you use
22099 @code{gnus-registry-split-fancy-with-parent}; mails which are split
22100 into @code{nnmairix} groups are usually gone for good as soon as you
22101 check the group for new mail (yes, it has happened to me...).
22102
22103 @item
22104 Therefore: @emph{Never ever} put ``real'' mails into @code{nnmairix}
22105 groups (you shouldn't be able to, anyway).
22106
22107 @item
22108 If you use the Gnus agent (@pxref{Gnus Unplugged}): don't agentize
22109 @code{nnmairix} groups (though I have no idea what happens if you do).
22110
22111 @item
22112 mairix does only support us-ascii characters.
22113
22114 @item
22115 @code{nnmairix} uses a rather brute force method to force Gnus to
22116 completely reread the group on the mail back end after mairix was
22117 called---it simply deletes and re-creates the group on the mail
22118 back end. So far, this has worked for me without any problems, and I
22119 don't see how @code{nnmairix} could delete other mail groups than its
22120 own, but anyway: you really should have a backup of your mail
22121 folders.
22122
22123 @item
22124 All necessary information is stored in the group parameters
22125 (@pxref{Group Parameters}). This has the advantage that no active file
22126 is needed, but also implies that when you kill a @code{nnmairix} group,
22127 it is gone for good.
22128
22129 @item
22130 @findex nnmairix-purge-old-groups
22131 If you create and kill a lot of @code{nnmairix} groups, the
22132 ``zz_mairix-*'' groups will accumulate on the mail back end server. To
22133 delete old groups which are no longer needed, call
22134 @code{nnmairix-purge-old-groups}. Note that this assumes that you don't
22135 save any ``real'' mail in folders of the form
22136 @code{zz_mairix-<NAME>-<NUMBER>}. You can change the prefix of
22137 @code{nnmairix} groups by changing the variable
22138 @code{nnmairix-group-prefix}.
22139
22140 @item
22141 The following only applies if you @emph{don't} use the mentioned patch
22142 for mairix (@pxref{Propagating marks}):
22143
22144 A problem can occur when using @code{nnmairix} with maildir folders and
22145 comes with the fact that maildir stores mail flags like @samp{Seen} or
22146 @samp{Replied} by appending chars @samp{S} and @samp{R} to the message
22147 file name, respectively. This implies that currently you would have to
22148 update the mairix database not only when new mail arrives, but also when
22149 mail flags are changing. The same applies to new mails which are indexed
22150 while they are still in the @samp{new} folder but then get moved to
22151 @samp{cur} when Gnus has seen the mail. If you don't update the database
22152 after this has happened, a mairix query can lead to symlinks pointing to
22153 non-existing files. In Gnus, these messages will usually appear with
22154 ``(none)'' entries in the header and can't be accessed. If this happens
22155 to you, using @kbd{G b u} and updating the group will usually fix this.
22156
22157 @end itemize
22158
22159 @iftex
22160 @iflatex
22161 @chapter Message
22162 @include message.texi
22163 @chapter Emacs MIME
22164 @include emacs-mime.texi
22165 @chapter Sieve
22166 @include sieve.texi
22167 @chapter EasyPG
22168 @include epa.texi
22169 @chapter SASL
22170 @include sasl.texi
22171 @end iflatex
22172 @end iftex
22173
22174 @node Various
22175 @chapter Various
22176
22177 @menu
22178 * Process/Prefix:: A convention used by many treatment commands.
22179 * Interactive:: Making Gnus ask you many questions.
22180 * Symbolic Prefixes:: How to supply some Gnus functions with options.
22181 * Formatting Variables:: You can specify what buffers should look like.
22182 * Window Layout:: Configuring the Gnus buffer windows.
22183 * Faces and Fonts:: How to change how faces look.
22184 * Mode Lines:: Displaying information in the mode lines.
22185 * Highlighting and Menus:: Making buffers look all nice and cozy.
22186 * Daemons:: Gnus can do things behind your back.
22187 * Undo:: Some actions can be undone.
22188 * Predicate Specifiers:: Specifying predicates.
22189 * Moderation:: What to do if you're a moderator.
22190 * Fetching a Group:: Starting Gnus just to read a group.
22191 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
22192 * Fuzzy Matching:: What's the big fuzz?
22193 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
22194 * Spam Package:: A package for filtering and processing spam.
22195 * The Gnus Registry:: A package for tracking messages by Message-ID.
22196 * Other modes:: Interaction with other modes.
22197 * Various Various:: Things that are really various.
22198 @end menu
22199
22200
22201 @node Process/Prefix
22202 @section Process/Prefix
22203 @cindex process/prefix convention
22204
22205 Many functions, among them functions for moving, decoding and saving
22206 articles, use what is known as the @dfn{Process/Prefix convention}.
22207
22208 This is a method for figuring out what articles the user wants the
22209 command to be performed on.
22210
22211 It goes like this:
22212
22213 If the numeric prefix is N, perform the operation on the next N
22214 articles, starting with the current one. If the numeric prefix is
22215 negative, perform the operation on the previous N articles, starting
22216 with the current one.
22217
22218 @vindex transient-mark-mode
22219 If @code{transient-mark-mode} in non-@code{nil} and the region is
22220 active, all articles in the region will be worked upon.
22221
22222 If there is no numeric prefix, but some articles are marked with the
22223 process mark, perform the operation on the articles marked with
22224 the process mark.
22225
22226 If there is neither a numeric prefix nor any articles marked with the
22227 process mark, just perform the operation on the current article.
22228
22229 Quite simple, really, but it needs to be made clear so that surprises
22230 are avoided.
22231
22232 Commands that react to the process mark will push the current list of
22233 process marked articles onto a stack and will then clear all process
22234 marked articles. You can restore the previous configuration with the
22235 @kbd{M P y} command (@pxref{Setting Process Marks}).
22236
22237 @vindex gnus-summary-goto-unread
22238 One thing that seems to shock & horrify lots of people is that, for
22239 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
22240 Since each @kbd{d} (which marks the current article as read) by default
22241 goes to the next unread article after marking, this means that @kbd{3 d}
22242 will mark the next three unread articles as read, no matter what the
22243 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
22244 @code{nil} for a more straightforward action.
22245
22246 Many commands do not use the process/prefix convention. All commands
22247 that do explicitly say so in this manual. To apply the process/prefix
22248 convention to commands that do not use it, you can use the @kbd{M-&}
22249 command. For instance, to mark all the articles in the group as
22250 expirable, you could say @kbd{M P b M-& E}.
22251
22252
22253 @node Interactive
22254 @section Interactive
22255 @cindex interaction
22256
22257 @table @code
22258
22259 @item gnus-novice-user
22260 @vindex gnus-novice-user
22261 If this variable is non-@code{nil}, you are either a newcomer to the
22262 World of Usenet, or you are very cautious, which is a nice thing to be,
22263 really. You will be given questions of the type ``Are you sure you want
22264 to do this?'' before doing anything dangerous. This is @code{t} by
22265 default.
22266
22267 @item gnus-expert-user
22268 @vindex gnus-expert-user
22269 If this variable is non-@code{nil}, you will seldom be asked any
22270 questions by Gnus. It will simply assume you know what you're doing,
22271 no matter how strange. For example, quitting Gnus, exiting a group
22272 without an update, catching up with a group, deleting expired
22273 articles, and replying by mail to a news message will not require
22274 confirmation.
22275
22276 @item gnus-interactive-catchup
22277 @vindex gnus-interactive-catchup
22278 Require confirmation before catching up a group if non-@code{nil}. It
22279 is @code{t} by default.
22280
22281 @item gnus-interactive-exit
22282 @vindex gnus-interactive-exit
22283 If non-@code{nil}, require a confirmation when exiting Gnus. If
22284 @code{quiet}, update any active summary buffers automatically without
22285 querying. The default value is @code{t}.
22286 @end table
22287
22288
22289 @node Symbolic Prefixes
22290 @section Symbolic Prefixes
22291 @cindex symbolic prefixes
22292
22293 Quite a lot of Emacs commands react to the (numeric) prefix. For
22294 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
22295 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
22296 rule of 900 to the current article.
22297
22298 This is all nice and well, but what if you want to give a command some
22299 additional information? Well, what most commands do is interpret the
22300 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
22301 doesn't want a backup file to be created when saving the current buffer,
22302 for instance. But what if you want to save without making a backup
22303 file, and you want Emacs to flash lights and play a nice tune at the
22304 same time? You can't, and you're probably perfectly happy that way.
22305
22306 @kindex M-i (Summary)
22307 @findex gnus-symbolic-argument
22308 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
22309 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
22310 character typed in is the value. You can stack as many @kbd{M-i}
22311 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
22312 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
22313 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
22314 @code{b}''. You get the drift.
22315
22316 Typing in symbolic prefixes to commands that don't accept them doesn't
22317 hurt, but it doesn't do any good either. Currently not many Gnus
22318 functions make use of the symbolic prefix.
22319
22320 If you're interested in how Gnus implements this, @pxref{Extended
22321 Interactive}.
22322
22323
22324 @node Formatting Variables
22325 @section Formatting Variables
22326 @cindex formatting variables
22327
22328 Throughout this manual you've probably noticed lots of variables called
22329 things like @code{gnus-group-line-format} and
22330 @code{gnus-summary-mode-line-format}. These control how Gnus is to
22331 output lines in the various buffers. There's quite a lot of them.
22332 Fortunately, they all use the same syntax, so there's not that much to
22333 be annoyed by.
22334
22335 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
22336 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
22337 lots of percentages everywhere.
22338
22339 @menu
22340 * Formatting Basics:: A formatting variable is basically a format string.
22341 * Mode Line Formatting:: Some rules about mode line formatting variables.
22342 * Advanced Formatting:: Modifying output in various ways.
22343 * User-Defined Specs:: Having Gnus call your own functions.
22344 * Formatting Fonts:: Making the formatting look colorful and nice.
22345 * Positioning Point:: Moving point to a position after an operation.
22346 * Tabulation:: Tabulating your output.
22347 * Wide Characters:: Dealing with wide characters.
22348 @end menu
22349
22350 Currently Gnus uses the following formatting variables:
22351 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
22352 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
22353 @code{gnus-group-mode-line-format},
22354 @code{gnus-summary-mode-line-format},
22355 @code{gnus-article-mode-line-format},
22356 @code{gnus-server-mode-line-format}, and
22357 @code{gnus-summary-pick-line-format}.
22358
22359 All these format variables can also be arbitrary elisp forms. In that
22360 case, they will be @code{eval}ed to insert the required lines.
22361
22362 @kindex M-x gnus-update-format
22363 @findex gnus-update-format
22364 Gnus includes a command to help you while creating your own format
22365 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
22366 update the spec in question and pop you to a buffer where you can
22367 examine the resulting Lisp code to be run to generate the line.
22368
22369
22370
22371 @node Formatting Basics
22372 @subsection Formatting Basics
22373
22374 Each @samp{%} element will be replaced by some string or other when the
22375 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
22376 spec, and pad with spaces to get a 5-character field''.
22377
22378 As with normal C and Emacs Lisp formatting strings, the numerical
22379 modifier between the @samp{%} and the formatting type character will
22380 @dfn{pad} the output so that it is always at least that long.
22381 @samp{%5y} will make the field always (at least) five characters wide by
22382 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
22383 the right instead.
22384
22385 You may also wish to limit the length of the field to protect against
22386 particularly wide values. For that you can say @samp{%4,6y}, which
22387 means that the field will never be more than 6 characters wide and never
22388 less than 4 characters wide.
22389
22390 Also Gnus supports some extended format specifications, such as
22391 @samp{%&user-date;}.
22392
22393
22394 @node Mode Line Formatting
22395 @subsection Mode Line Formatting
22396
22397 Mode line formatting variables (e.g.,
22398 @code{gnus-summary-mode-line-format}) follow the same rules as other,
22399 buffer line oriented formatting variables (@pxref{Formatting Basics})
22400 with the following two differences:
22401
22402 @enumerate
22403
22404 @item
22405 There must be no newline (@samp{\n}) at the end.
22406
22407 @item
22408 The special @samp{%%b} spec can be used to display the buffer name.
22409 Well, it's no spec at all, really---@samp{%%} is just a way to quote
22410 @samp{%} to allow it to pass through the formatting machinery unmangled,
22411 so that Emacs receives @samp{%b}, which is something the Emacs mode line
22412 display interprets to mean ``show the buffer name''. For a full list of
22413 mode line specs Emacs understands, see the documentation of the
22414 @code{mode-line-format} variable.
22415
22416 @end enumerate
22417
22418
22419 @node Advanced Formatting
22420 @subsection Advanced Formatting
22421
22422 It is frequently useful to post-process the fields in some way.
22423 Padding, limiting, cutting off parts and suppressing certain values can
22424 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
22425 look like @samp{%~(cut 3)~(ignore "0")y}.
22426
22427 These are the valid modifiers:
22428
22429 @table @code
22430 @item pad
22431 @itemx pad-left
22432 Pad the field to the left with spaces until it reaches the required
22433 length.
22434
22435 @item pad-right
22436 Pad the field to the right with spaces until it reaches the required
22437 length.
22438
22439 @item max
22440 @itemx max-left
22441 Cut off characters from the left until it reaches the specified length.
22442
22443 @item max-right
22444 Cut off characters from the right until it reaches the specified
22445 length.
22446
22447 @item cut
22448 @itemx cut-left
22449 Cut off the specified number of characters from the left.
22450
22451 @item cut-right
22452 Cut off the specified number of characters from the right.
22453
22454 @item ignore
22455 Return an empty string if the field is equal to the specified value.
22456
22457 @item form
22458 Use the specified form as the field value when the @samp{@@} spec is
22459 used.
22460
22461 Here's an example:
22462
22463 @lisp
22464 "~(form (current-time-string))@@"
22465 @end lisp
22466
22467 @end table
22468
22469 Let's take an example. The @samp{%o} spec in the summary mode lines
22470 will return a date in compact ISO8601 format---@samp{19960809T230410}.
22471 This is quite a mouthful, so we want to shave off the century number and
22472 the time, leaving us with a six-character date. That would be
22473 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
22474 maxing, and we need the padding to ensure that the date is never less
22475 than 6 characters to make it look nice in columns.)
22476
22477 Ignoring is done first; then cutting; then maxing; and then as the very
22478 last operation, padding.
22479
22480
22481 @node User-Defined Specs
22482 @subsection User-Defined Specs
22483
22484 All the specs allow for inserting user defined specifiers---@samp{u}.
22485 The next character in the format string should be a letter. Gnus
22486 will call the function @code{gnus-user-format-function-}@samp{X}, where
22487 @samp{X} is the letter following @samp{%u}. The function will be passed
22488 a single parameter---what the parameter means depends on what buffer
22489 it's being called from. The function should return a string, which will
22490 be inserted into the buffer just like information from any other
22491 specifier. This function may also be called with dummy values, so it
22492 should protect against that.
22493
22494 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
22495 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
22496
22497 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
22498 much the same without defining new functions. Here's an example:
22499 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
22500 given here will be evaluated to yield the current line number, and then
22501 inserted.
22502
22503
22504 @node Formatting Fonts
22505 @subsection Formatting Fonts
22506
22507 @cindex %(, %)
22508 @vindex gnus-mouse-face
22509 There are specs for highlighting, and these are shared by all the format
22510 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
22511 the special @code{mouse-face} property set, which means that it will be
22512 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
22513 over it.
22514
22515 @cindex %@{, %@}
22516 @vindex gnus-face-0
22517 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
22518 normal faces set using @code{gnus-face-0}, which is @code{bold} by
22519 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
22520 and so on. Create as many faces as you wish. The same goes for the
22521 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
22522 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
22523
22524 @cindex %<<, %>>, guillemets
22525 @c @cindex %<<, %>>, %«, %», guillemets
22526 @vindex gnus-balloon-face-0
22527 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
22528 special @code{balloon-help} property set to
22529 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
22530 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
22531 variables should be either strings or symbols naming functions that
22532 return a string. When the mouse passes over text with this property
22533 set, a balloon window will appear and display the string. Please
22534 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
22535 (in Emacs) or the doc string of @code{balloon-help-mode} (in
22536 XEmacs) for more information on this. (For technical reasons, the
22537 guillemets have been approximated as @samp{<<} and @samp{>>} in this
22538 paragraph.)
22539
22540 Here's an alternative recipe for the group buffer:
22541
22542 @lisp
22543 ;; @r{Create three face types.}
22544 (setq gnus-face-1 'bold)
22545 (setq gnus-face-3 'italic)
22546
22547 ;; @r{We want the article count to be in}
22548 ;; @r{a bold and green face. So we create}
22549 ;; @r{a new face called @code{my-green-bold}.}
22550 (copy-face 'bold 'my-green-bold)
22551 ;; @r{Set the color.}
22552 (set-face-foreground 'my-green-bold "ForestGreen")
22553 (setq gnus-face-2 'my-green-bold)
22554
22555 ;; @r{Set the new & fancy format.}
22556 (setq gnus-group-line-format
22557 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
22558 @end lisp
22559
22560 I'm sure you'll be able to use this scheme to create totally unreadable
22561 and extremely vulgar displays. Have fun!
22562
22563 Note that the @samp{%(} specs (and friends) do not make any sense on the
22564 mode-line variables.
22565
22566 @node Positioning Point
22567 @subsection Positioning Point
22568
22569 Gnus usually moves point to a pre-defined place on each line in most
22570 buffers. By default, point move to the first colon character on the
22571 line. You can customize this behavior in three different ways.
22572
22573 You can move the colon character to somewhere else on the line.
22574
22575 @findex gnus-goto-colon
22576 You can redefine the function that moves the point to the colon. The
22577 function is called @code{gnus-goto-colon}.
22578
22579 But perhaps the most convenient way to deal with this, if you don't want
22580 to have a colon in your line, is to use the @samp{%*} specifier. If you
22581 put a @samp{%*} somewhere in your format line definition, Gnus will
22582 place point there.
22583
22584
22585 @node Tabulation
22586 @subsection Tabulation
22587
22588 You can usually line up your displays by padding and cutting your
22589 strings. However, when combining various strings of different size, it
22590 can often be more convenient to just output the strings, and then worry
22591 about lining up the following text afterwards.
22592
22593 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
22594 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
22595
22596 @samp{%50=} will insert space characters to pad the line up to column
22597 50. If the text is already past column 50, nothing will be inserted.
22598 This is the soft tabulator.
22599
22600 @samp{%-50=} will insert space characters to pad the line up to column
22601 50. If the text is already past column 50, the excess text past column
22602 50 will be removed. This is the hard tabulator.
22603
22604
22605 @node Wide Characters
22606 @subsection Wide Characters
22607
22608 Fixed width fonts in most countries have characters of the same width.
22609 Some countries, however, use Latin characters mixed with wider
22610 characters---most notable East Asian countries.
22611
22612 The problem is that when formatting, Gnus assumes that if a string is 10
22613 characters wide, it'll be 10 Latin characters wide on the screen. In
22614 these countries, that's not true.
22615
22616 @vindex gnus-use-correct-string-widths
22617 To help fix this, you can set @code{gnus-use-correct-string-widths} to
22618 @code{t}. This makes buffer generation slower, but the results will be
22619 prettier. The default value under XEmacs is @code{t} but @code{nil}
22620 for Emacs.
22621
22622
22623 @node Window Layout
22624 @section Window Layout
22625 @cindex window layout
22626
22627 No, there's nothing here about X, so be quiet.
22628
22629 @vindex gnus-use-full-window
22630 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
22631 other windows and occupy the entire Emacs screen by itself. It is
22632 @code{t} by default.
22633
22634 Setting this variable to @code{nil} kinda works, but there are
22635 glitches. Use at your own peril.
22636
22637 @vindex gnus-buffer-configuration
22638 @code{gnus-buffer-configuration} describes how much space each Gnus
22639 buffer should be given. Here's an excerpt of this variable:
22640
22641 @lisp
22642 ((group (vertical 1.0 (group 1.0 point)))
22643 (article (vertical 1.0 (summary 0.25 point)
22644 (article 1.0))))
22645 @end lisp
22646
22647 This is an alist. The @dfn{key} is a symbol that names some action or
22648 other. For instance, when displaying the group buffer, the window
22649 configuration function will use @code{group} as the key. A full list of
22650 possible names is listed below.
22651
22652 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
22653 should occupy. To take the @code{article} split as an example:
22654
22655 @lisp
22656 (article (vertical 1.0 (summary 0.25 point)
22657 (article 1.0)))
22658 @end lisp
22659
22660 This @dfn{split} says that the summary buffer should occupy 25% of upper
22661 half of the screen, and that it is placed over the article buffer. As
22662 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
22663 reaching for that calculator there). However, the special number
22664 @code{1.0} is used to signal that this buffer should soak up all the
22665 rest of the space available after the rest of the buffers have taken
22666 whatever they need. There should be only one buffer with the @code{1.0}
22667 size spec per split.
22668
22669 Point will be put in the buffer that has the optional third element
22670 @code{point}. In a @code{frame} split, the last subsplit having a leaf
22671 split where the tag @code{frame-focus} is a member (i.e., is the third or
22672 fourth element in the list, depending on whether the @code{point} tag is
22673 present) gets focus.
22674
22675 Here's a more complicated example:
22676
22677 @lisp
22678 (article (vertical 1.0 (group 4)
22679 (summary 0.25 point)
22680 (article 1.0)))
22681 @end lisp
22682
22683 If the size spec is an integer instead of a floating point number,
22684 then that number will be used to say how many lines a buffer should
22685 occupy, not a percentage.
22686
22687 If the @dfn{split} looks like something that can be @code{eval}ed (to be
22688 precise---if the @code{car} of the split is a function or a subr), this
22689 split will be @code{eval}ed. If the result is non-@code{nil}, it will
22690 be used as a split.
22691
22692 Not complicated enough for you? Well, try this on for size:
22693
22694 @lisp
22695 (article (horizontal 1.0
22696 (vertical 0.5
22697 (group 1.0))
22698 (vertical 1.0
22699 (summary 0.25 point)
22700 (article 1.0))))
22701 @end lisp
22702
22703 Whoops. Two buffers with the mystery 100% tag. And what's that
22704 @code{horizontal} thingie?
22705
22706 If the first element in one of the split is @code{horizontal}, Gnus will
22707 split the window horizontally, giving you two windows side-by-side.
22708 Inside each of these strips you may carry on all you like in the normal
22709 fashion. The number following @code{horizontal} says what percentage of
22710 the screen is to be given to this strip.
22711
22712 For each split, there @emph{must} be one element that has the 100% tag.
22713 The splitting is never accurate, and this buffer will eat any leftover
22714 lines from the splits.
22715
22716 To be slightly more formal, here's a definition of what a valid split
22717 may look like:
22718
22719 @example
22720 @group
22721 split = frame | horizontal | vertical | buffer | form
22722 frame = "(frame " size *split ")"
22723 horizontal = "(horizontal " size *split ")"
22724 vertical = "(vertical " size *split ")"
22725 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
22726 size = number | frame-params
22727 buf-name = group | article | summary ...
22728 @end group
22729 @end example
22730
22731 The limitations are that the @code{frame} split can only appear as the
22732 top-level split. @var{form} should be an Emacs Lisp form that should
22733 return a valid split. We see that each split is fully recursive, and
22734 may contain any number of @code{vertical} and @code{horizontal} splits.
22735
22736 @vindex gnus-window-min-width
22737 @vindex gnus-window-min-height
22738 @cindex window height
22739 @cindex window width
22740 Finding the right sizes can be a bit complicated. No window may be less
22741 than @code{gnus-window-min-height} (default 1) characters high, and all
22742 windows must be at least @code{gnus-window-min-width} (default 1)
22743 characters wide. Gnus will try to enforce this before applying the
22744 splits. If you want to use the normal Emacs window width/height limit,
22745 you can just set these two variables to @code{nil}.
22746
22747 If you're not familiar with Emacs terminology, @code{horizontal} and
22748 @code{vertical} splits may work the opposite way of what you'd expect.
22749 Windows inside a @code{horizontal} split are shown side-by-side, and
22750 windows within a @code{vertical} split are shown above each other.
22751
22752 @findex gnus-configure-frame
22753 If you want to experiment with window placement, a good tip is to call
22754 @code{gnus-configure-frame} directly with a split. This is the function
22755 that does all the real work when splitting buffers. Below is a pretty
22756 nonsensical configuration with 5 windows; two for the group buffer and
22757 three for the article buffer. (I said it was nonsensical.) If you
22758 @code{eval} the statement below, you can get an idea of how that would
22759 look straight away, without going through the normal Gnus channels.
22760 Play with it until you're satisfied, and then use
22761 @code{gnus-add-configuration} to add your new creation to the buffer
22762 configuration list.
22763
22764 @lisp
22765 (gnus-configure-frame
22766 '(horizontal 1.0
22767 (vertical 10
22768 (group 1.0)
22769 (article 0.3 point))
22770 (vertical 1.0
22771 (article 1.0)
22772 (horizontal 4
22773 (group 1.0)
22774 (article 10)))))
22775 @end lisp
22776
22777 You might want to have several frames as well. No prob---just use the
22778 @code{frame} split:
22779
22780 @lisp
22781 (gnus-configure-frame
22782 '(frame 1.0
22783 (vertical 1.0
22784 (summary 0.25 point frame-focus)
22785 (article 1.0))
22786 (vertical ((height . 5) (width . 15)
22787 (user-position . t)
22788 (left . -1) (top . 1))
22789 (picon 1.0))))
22790
22791 @end lisp
22792
22793 This split will result in the familiar summary/article window
22794 configuration in the first (or ``main'') frame, while a small additional
22795 frame will be created where picons will be shown. As you can see,
22796 instead of the normal @code{1.0} top-level spec, each additional split
22797 should have a frame parameter alist as the size spec.
22798 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
22799 Reference Manual}. Under XEmacs, a frame property list will be
22800 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
22801 is such a plist.
22802 The list of all possible keys for @code{gnus-buffer-configuration} can
22803 be found in its default value.
22804
22805 Note that the @code{message} key is used for both
22806 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
22807 it is desirable to distinguish between the two, something like this
22808 might be used:
22809
22810 @lisp
22811 (message (horizontal 1.0
22812 (vertical 1.0 (message 1.0 point))
22813 (vertical 0.24
22814 (if (buffer-live-p gnus-summary-buffer)
22815 '(summary 0.5))
22816 (group 1.0))))
22817 @end lisp
22818
22819 One common desire for a multiple frame split is to have a separate frame
22820 for composing mail and news while leaving the original frame intact. To
22821 accomplish that, something like the following can be done:
22822
22823 @lisp
22824 (message
22825 (frame 1.0
22826 (if (not (buffer-live-p gnus-summary-buffer))
22827 (car (cdr (assoc 'group gnus-buffer-configuration)))
22828 (car (cdr (assoc 'summary gnus-buffer-configuration))))
22829 (vertical ((user-position . t) (top . 1) (left . 1)
22830 (name . "Message"))
22831 (message 1.0 point))))
22832 @end lisp
22833
22834 @findex gnus-add-configuration
22835 Since the @code{gnus-buffer-configuration} variable is so long and
22836 complicated, there's a function you can use to ease changing the config
22837 of a single setting: @code{gnus-add-configuration}. If, for instance,
22838 you want to change the @code{article} setting, you could say:
22839
22840 @lisp
22841 (gnus-add-configuration
22842 '(article (vertical 1.0
22843 (group 4)
22844 (summary .25 point)
22845 (article 1.0))))
22846 @end lisp
22847
22848 You'd typically stick these @code{gnus-add-configuration} calls in your
22849 @file{~/.gnus.el} file or in some startup hook---they should be run after
22850 Gnus has been loaded.
22851
22852 @vindex gnus-always-force-window-configuration
22853 If all windows mentioned in the configuration are already visible, Gnus
22854 won't change the window configuration. If you always want to force the
22855 ``right'' window configuration, you can set
22856 @code{gnus-always-force-window-configuration} to non-@code{nil}.
22857
22858 If you're using tree displays (@pxref{Tree Display}), and the tree
22859 window is displayed vertically next to another window, you may also want
22860 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
22861 windows resized.
22862
22863 @subsection Window Configuration Names
22864
22865 Here's a list of most of the currently known window configurations,
22866 and when they're used:
22867
22868 @table @code
22869 @item group
22870 The group buffer.
22871
22872 @item summary
22873 Entering a group and showing only the summary.
22874
22875 @item article
22876 Selecting an article.
22877
22878 @item server
22879 The server buffer.
22880
22881 @item browse
22882 Browsing groups from the server buffer.
22883
22884 @item message
22885 Composing a (new) message.
22886
22887 @item only-article
22888 Showing only the article buffer.
22889
22890 @item edit-article
22891 Editing an article.
22892
22893 @item edit-form
22894 Editing group parameters and the like.
22895
22896 @item edit-score
22897 Editing a server definition.
22898
22899 @item post
22900 Composing a news message.
22901
22902 @item reply
22903 Replying or following up an article without yanking the text.
22904
22905 @item forward
22906 Forwarding a message.
22907
22908 @item reply-yank
22909 Replying or following up an article with yanking the text.
22910
22911 @item mail-bound
22912 Bouncing a message.
22913
22914 @item pipe
22915 Sending an article to an external process.
22916
22917 @item bug
22918 Sending a bug report.
22919
22920 @item score-trace
22921 Displaying the score trace.
22922
22923 @item score-words
22924 Displaying the score words.
22925
22926 @item split-trace
22927 Displaying the split trace.
22928
22929 @item compose-bounce
22930 Composing a bounce message.
22931
22932 @item mml-preview
22933 Previewing a @acronym{MIME} part.
22934
22935 @end table
22936
22937
22938 @subsection Example Window Configurations
22939
22940 @itemize @bullet
22941 @item
22942 Narrow left hand side occupied by group buffer. Right hand side split
22943 between summary buffer (top one-sixth) and article buffer (bottom).
22944
22945 @ifinfo
22946 @example
22947 +---+---------+
22948 | G | Summary |
22949 | r +---------+
22950 | o | |
22951 | u | Article |
22952 | p | |
22953 +---+---------+
22954 @end example
22955 @end ifinfo
22956
22957 @lisp
22958 (gnus-add-configuration
22959 '(article
22960 (horizontal 1.0
22961 (vertical 25 (group 1.0))
22962 (vertical 1.0
22963 (summary 0.16 point)
22964 (article 1.0)))))
22965
22966 (gnus-add-configuration
22967 '(summary
22968 (horizontal 1.0
22969 (vertical 25 (group 1.0))
22970 (vertical 1.0 (summary 1.0 point)))))
22971 @end lisp
22972
22973 @end itemize
22974
22975
22976 @node Faces and Fonts
22977 @section Faces and Fonts
22978 @cindex faces
22979 @cindex fonts
22980 @cindex colors
22981
22982 Fiddling with fonts and faces used to be very difficult, but these days
22983 it is very simple. You simply say @kbd{M-x customize-face}, pick out
22984 the face you want to alter, and alter it via the standard Customize
22985 interface.
22986
22987
22988 @node Mode Lines
22989 @section Mode Lines
22990 @cindex mode lines
22991
22992 @vindex gnus-updated-mode-lines
22993 @code{gnus-updated-mode-lines} says what buffers should keep their mode
22994 lines updated. It is a list of symbols. Supported symbols include
22995 @code{group}, @code{article}, @code{summary}, @code{server},
22996 @code{browse}, and @code{tree}. If the corresponding symbol is present,
22997 Gnus will keep that mode line updated with information that may be
22998 pertinent. If this variable is @code{nil}, screen refresh may be
22999 quicker.
23000
23001 @cindex display-time
23002
23003 @vindex gnus-mode-non-string-length
23004 By default, Gnus displays information on the current article in the mode
23005 lines of the summary and article buffers. The information Gnus wishes
23006 to display (e.g., the subject of the article) is often longer than the
23007 mode lines, and therefore have to be cut off at some point. The
23008 @code{gnus-mode-non-string-length} variable says how long the other
23009 elements on the line is (i.e., the non-info part). If you put
23010 additional elements on the mode line (e.g., a clock), you should modify
23011 this variable:
23012
23013 @c Hook written by Francesco Potortì <pot@cnuce.cnr.it>
23014 @lisp
23015 (add-hook 'display-time-hook
23016 (lambda () (setq gnus-mode-non-string-length
23017 (+ 21
23018 (if line-number-mode 5 0)
23019 (if column-number-mode 4 0)
23020 (length display-time-string)))))
23021 @end lisp
23022
23023 If this variable is @code{nil} (which is the default), the mode line
23024 strings won't be chopped off, and they won't be padded either. Note
23025 that the default is unlikely to be desirable, as even the percentage
23026 complete in the buffer may be crowded off the mode line; the user should
23027 configure this variable appropriately for her configuration.
23028
23029
23030 @node Highlighting and Menus
23031 @section Highlighting and Menus
23032 @cindex visual
23033 @cindex highlighting
23034 @cindex menus
23035
23036 @vindex gnus-visual
23037 The @code{gnus-visual} variable controls most of the Gnus-prettifying
23038 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
23039 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
23040 file.
23041
23042 This variable can be a list of visual properties that are enabled. The
23043 following elements are valid, and are all included by default:
23044
23045 @table @code
23046 @item group-highlight
23047 Do highlights in the group buffer.
23048 @item summary-highlight
23049 Do highlights in the summary buffer.
23050 @item article-highlight
23051 Do highlights in the article buffer.
23052 @item highlight
23053 Turn on highlighting in all buffers.
23054 @item group-menu
23055 Create menus in the group buffer.
23056 @item summary-menu
23057 Create menus in the summary buffers.
23058 @item article-menu
23059 Create menus in the article buffer.
23060 @item browse-menu
23061 Create menus in the browse buffer.
23062 @item server-menu
23063 Create menus in the server buffer.
23064 @item score-menu
23065 Create menus in the score buffers.
23066 @item menu
23067 Create menus in all buffers.
23068 @end table
23069
23070 So if you only want highlighting in the article buffer and menus in all
23071 buffers, you could say something like:
23072
23073 @lisp
23074 (setq gnus-visual '(article-highlight menu))
23075 @end lisp
23076
23077 If you want highlighting only and no menus whatsoever, you'd say:
23078
23079 @lisp
23080 (setq gnus-visual '(highlight))
23081 @end lisp
23082
23083 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
23084 in all Gnus buffers.
23085
23086 Other general variables that influence the look of all buffers include:
23087
23088 @table @code
23089 @item gnus-mouse-face
23090 @vindex gnus-mouse-face
23091 This is the face (i.e., font) used for mouse highlighting in Gnus. No
23092 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
23093
23094 @end table
23095
23096 There are hooks associated with the creation of all the different menus:
23097
23098 @table @code
23099
23100 @item gnus-article-menu-hook
23101 @vindex gnus-article-menu-hook
23102 Hook called after creating the article mode menu.
23103
23104 @item gnus-group-menu-hook
23105 @vindex gnus-group-menu-hook
23106 Hook called after creating the group mode menu.
23107
23108 @item gnus-summary-menu-hook
23109 @vindex gnus-summary-menu-hook
23110 Hook called after creating the summary mode menu.
23111
23112 @item gnus-server-menu-hook
23113 @vindex gnus-server-menu-hook
23114 Hook called after creating the server mode menu.
23115
23116 @item gnus-browse-menu-hook
23117 @vindex gnus-browse-menu-hook
23118 Hook called after creating the browse mode menu.
23119
23120 @item gnus-score-menu-hook
23121 @vindex gnus-score-menu-hook
23122 Hook called after creating the score mode menu.
23123
23124 @end table
23125
23126
23127 @node Daemons
23128 @section Daemons
23129 @cindex demons
23130 @cindex daemons
23131
23132 Gnus, being larger than any program ever written (allegedly), does lots
23133 of strange stuff that you may wish to have done while you're not
23134 present. For instance, you may want it to check for new mail once in a
23135 while. Or you may want it to close down all connections to all servers
23136 when you leave Emacs idle. And stuff like that.
23137
23138 Gnus will let you do stuff like that by defining various
23139 @dfn{handlers}. Each handler consists of three elements: A
23140 @var{function}, a @var{time}, and an @var{idle} parameter.
23141
23142 Here's an example of a handler that closes connections when Emacs has
23143 been idle for thirty minutes:
23144
23145 @lisp
23146 (gnus-demon-close-connections nil 30)
23147 @end lisp
23148
23149 Here's a handler that scans for @acronym{PGP} headers every hour when
23150 Emacs is idle:
23151
23152 @lisp
23153 (gnus-demon-scan-pgp 60 t)
23154 @end lisp
23155
23156 This @var{time} parameter and that @var{idle} parameter work together
23157 in a strange, but wonderful fashion. Basically, if @var{idle} is
23158 @code{nil}, then the function will be called every @var{time} minutes.
23159
23160 If @var{idle} is @code{t}, then the function will be called after
23161 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
23162 the function will never be called. But once Emacs goes idle, the
23163 function will be called every @var{time} minutes.
23164
23165 If @var{idle} is a number and @var{time} is a number, the function will
23166 be called every @var{time} minutes only when Emacs has been idle for
23167 @var{idle} minutes.
23168
23169 If @var{idle} is a number and @var{time} is @code{nil}, the function
23170 will be called once every time Emacs has been idle for @var{idle}
23171 minutes.
23172
23173 And if @var{time} is a string, it should look like @samp{07:31}, and
23174 the function will then be called once every day somewhere near that
23175 time. Modified by the @var{idle} parameter, of course.
23176
23177 @vindex gnus-demon-timestep
23178 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
23179 seconds. This is 60 by default. If you change that variable,
23180 all the timings in the handlers will be affected.)
23181
23182 So, if you want to add a handler, you could put something like this in
23183 your @file{~/.gnus.el} file:
23184
23185 @findex gnus-demon-add-handler
23186 @lisp
23187 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
23188 @end lisp
23189
23190 @findex gnus-demon-add-scanmail
23191 @findex gnus-demon-add-rescan
23192 @findex gnus-demon-add-scan-timestamps
23193 @findex gnus-demon-add-disconnection
23194 Some ready-made functions to do this have been created:
23195 @code{gnus-demon-add-disconnection},
23196 @code{gnus-demon-add-nntp-close-connection},
23197 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
23198 @code{gnus-demon-add-scanmail}. Just put those functions in your
23199 @file{~/.gnus.el} if you want those abilities.
23200
23201 @findex gnus-demon-init
23202 @findex gnus-demon-cancel
23203 @vindex gnus-demon-handlers
23204 If you add handlers to @code{gnus-demon-handlers} directly, you should
23205 run @code{gnus-demon-init} to make the changes take hold. To cancel all
23206 daemons, you can use the @code{gnus-demon-cancel} function.
23207
23208 Note that adding daemons can be pretty naughty if you over do it. Adding
23209 functions that scan all news and mail from all servers every two seconds
23210 is a sure-fire way of getting booted off any respectable system. So
23211 behave.
23212
23213
23214 @node Undo
23215 @section Undo
23216 @cindex undo
23217
23218 It is very useful to be able to undo actions one has done. In normal
23219 Emacs buffers, it's easy enough---you just push the @code{undo} button.
23220 In Gnus buffers, however, it isn't that simple.
23221
23222 The things Gnus displays in its buffer is of no value whatsoever to
23223 Gnus---it's all just data designed to look nice to the user.
23224 Killing a group in the group buffer with @kbd{C-k} makes the line
23225 disappear, but that's just a side-effect of the real action---the
23226 removal of the group in question from the internal Gnus structures.
23227 Undoing something like that can't be done by the normal Emacs
23228 @code{undo} function.
23229
23230 Gnus tries to remedy this somewhat by keeping track of what the user
23231 does and coming up with actions that would reverse the actions the user
23232 takes. When the user then presses the @code{undo} key, Gnus will run
23233 the code to reverse the previous action, or the previous actions.
23234 However, not all actions are easily reversible, so Gnus currently offers
23235 a few key functions to be undoable. These include killing groups,
23236 yanking groups, and changing the list of read articles of groups.
23237 That's it, really. More functions may be added in the future, but each
23238 added function means an increase in data to be stored, so Gnus will
23239 never be totally undoable.
23240
23241 @findex gnus-undo-mode
23242 @vindex gnus-use-undo
23243 @findex gnus-undo
23244 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
23245 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
23246 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
23247 command, which should feel kinda like the normal Emacs @code{undo}
23248 command.
23249
23250
23251 @node Predicate Specifiers
23252 @section Predicate Specifiers
23253 @cindex predicate specifiers
23254
23255 Some Gnus variables are @dfn{predicate specifiers}. This is a special
23256 form that allows flexible specification of predicates without having
23257 to type all that much.
23258
23259 These specifiers are lists consisting of functions, symbols and lists.
23260
23261 Here's an example:
23262
23263 @lisp
23264 (or gnus-article-unseen-p
23265 gnus-article-unread-p)
23266 @end lisp
23267
23268 The available symbols are @code{or}, @code{and} and @code{not}. The
23269 functions all take one parameter.
23270
23271 @findex gnus-make-predicate
23272 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
23273 to create a function that can be called. This input parameter to this
23274 function will be passed along to all the functions in the predicate
23275 specifier.
23276
23277
23278 @node Moderation
23279 @section Moderation
23280 @cindex moderation
23281
23282 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
23283 It is not included in the standard Gnus package. Write a mail to
23284 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
23285 get a copy.
23286
23287 The moderation package is implemented as a minor mode for summary
23288 buffers. Put
23289
23290 @lisp
23291 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
23292 @end lisp
23293
23294 in your @file{~/.gnus.el} file.
23295
23296 If you are the moderator of @samp{rec.zoofle}, this is how it's
23297 supposed to work:
23298
23299 @enumerate
23300 @item
23301 You split your incoming mail by matching on
23302 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
23303 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
23304
23305 @item
23306 You enter that group once in a while and post articles using the @kbd{e}
23307 (edit-and-post) or @kbd{s} (just send unedited) commands.
23308
23309 @item
23310 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
23311 articles that weren't approved by you, you can cancel them with the
23312 @kbd{c} command.
23313 @end enumerate
23314
23315 To use moderation mode in these two groups, say:
23316
23317 @lisp
23318 (setq gnus-moderated-list
23319 "^nnml:rec.zoofle$\\|^rec.zoofle$")
23320 @end lisp
23321
23322
23323 @node Fetching a Group
23324 @section Fetching a Group
23325 @cindex fetching a group
23326
23327 @findex gnus-fetch-group
23328 It is sometimes convenient to be able to just say ``I want to read this
23329 group and I don't care whether Gnus has been started or not''. This is
23330 perhaps more useful for people who write code than for users, but the
23331 command @code{gnus-fetch-group} provides this functionality in any case.
23332 It takes the group name as a parameter.
23333
23334
23335 @node Image Enhancements
23336 @section Image Enhancements
23337
23338 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
23339 support images, Emacs 22 does.} and up, are able to display pictures and
23340 stuff, so Gnus has taken advantage of that.
23341
23342 @menu
23343 * X-Face:: Display a funky, teensy black-and-white image.
23344 * Face:: Display a funkier, teensier colored image.
23345 * Smileys:: Show all those happy faces the way they were meant to be shown.
23346 * Picons:: How to display pictures of what you're reading.
23347 * Gravatars:: Display the avatar of people you read.
23348 * XVarious:: Other XEmacsy Gnusey variables.
23349 @end menu
23350
23351
23352 @node X-Face
23353 @subsection X-Face
23354 @cindex x-face
23355
23356 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
23357 depth) image that's supposed to represent the author of the message.
23358 It seems to be supported by an ever-growing number of mail and news
23359 readers.
23360
23361 @cindex x-face
23362 @findex gnus-article-display-x-face
23363 @vindex gnus-article-x-face-command
23364 @vindex gnus-article-x-face-too-ugly
23365 @iftex
23366 @iflatex
23367 \include{xface}
23368 @end iflatex
23369 @end iftex
23370 @c @anchor{X-Face}
23371
23372 Viewing an @code{X-Face} header either requires an Emacs that has
23373 @samp{compface} support (which most XEmacs versions have), or that you
23374 have suitable conversion or display programs installed. If your Emacs
23375 has image support the default action is to display the face before the
23376 @code{From} header. If there's no native @code{X-Face} support, Gnus
23377 will try to convert the @code{X-Face} header using external programs
23378 from the @code{pbmplus} package and friends, see below. For XEmacs it's
23379 faster if XEmacs has been compiled with @code{X-Face} support. The
23380 default action under Emacs without image support is to fork off the
23381 @code{display} program.
23382
23383 On a GNU/Linux system, the @code{display} program is included in the
23384 ImageMagick package. For external conversion programs look for packages
23385 with names like @code{netpbm}, @code{libgr-progs} and @code{compface}.
23386 On Windows, you may use the packages @code{netpbm} and @code{compface}
23387 from @url{http://gnuwin32.sourceforge.net}. You need to add the
23388 @code{bin} directory to your @code{PATH} environment variable.
23389 @c In fact only the following DLLs and binaries seem to be required:
23390 @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe
23391
23392 The variable @code{gnus-article-x-face-command} controls which programs
23393 are used to display the @code{X-Face} header. If this variable is a
23394 string, this string will be executed in a sub-shell. If it is a
23395 function, this function will be called with the face as the argument.
23396 If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the
23397 @code{From} header, the face will not be shown.
23398
23399 (Note: @code{x-face} is used in the variable/function names, not
23400 @code{xface}).
23401
23402 @noindent
23403 Face and variable:
23404
23405 @table @code
23406 @item gnus-x-face
23407 @vindex gnus-x-face
23408 Face to show X-Face. The colors from this face are used as the
23409 foreground and background colors of the displayed X-Faces. The
23410 default colors are black and white.
23411
23412 @item gnus-face-properties-alist
23413 @vindex gnus-face-properties-alist
23414 Alist of image types and properties applied to Face (@pxref{Face}) and
23415 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
23416 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
23417 XEmacs. Here are examples:
23418
23419 @lisp
23420 ;; Specify the altitude of Face and X-Face images in the From header.
23421 (setq gnus-face-properties-alist
23422 '((pbm . (:face gnus-x-face :ascent 80))
23423 (png . (:ascent 80))))
23424
23425 ;; Show Face and X-Face images as pressed buttons.
23426 (setq gnus-face-properties-alist
23427 '((pbm . (:face gnus-x-face :relief -2))
23428 (png . (:relief -2))))
23429 @end lisp
23430
23431 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
23432 Reference Manual} for the valid properties for various image types.
23433 Currently, @code{pbm} is used for X-Face images and @code{png} is used
23434 for Face images in Emacs. Only the @code{:face} property is effective
23435 on the @code{xface} image type in XEmacs if it is built with the
23436 @samp{libcompface} library.
23437 @end table
23438
23439 If you use posting styles, you can use an @code{x-face-file} entry in
23440 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
23441 provides a few convenience functions and variables to allow easier
23442 insertion of X-Face headers in outgoing messages. You also need the
23443 above mentioned ImageMagick, netpbm or other image conversion packages
23444 (depending the values of the variables below) for these functions.
23445
23446 @findex gnus-random-x-face
23447 @vindex gnus-convert-pbm-to-x-face-command
23448 @vindex gnus-x-face-directory
23449 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
23450 @code{gnus-x-face-directory} and picks one at random, and then
23451 converts it to the X-Face format by using the
23452 @code{gnus-convert-pbm-to-x-face-command} shell command. The
23453 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
23454 header data as a string.
23455
23456 @findex gnus-insert-random-x-face-header
23457 @code{gnus-insert-random-x-face-header} calls
23458 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
23459 randomly generated data.
23460
23461 @findex gnus-x-face-from-file
23462 @vindex gnus-convert-image-to-x-face-command
23463 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
23464 converts the file to X-Face format by using the
23465 @code{gnus-convert-image-to-x-face-command} shell command.
23466
23467 Here's how you would typically use the first function. Put something
23468 like the following in your @file{~/.gnus.el} file:
23469
23470 @lisp
23471 (setq message-required-news-headers
23472 (nconc message-required-news-headers
23473 (list '(X-Face . gnus-random-x-face))))
23474 @end lisp
23475
23476 Using the last function would be something like this:
23477
23478 @lisp
23479 (setq message-required-news-headers
23480 (nconc message-required-news-headers
23481 (list '(X-Face . (lambda ()
23482 (gnus-x-face-from-file
23483 "~/My-face.gif"))))))
23484 @end lisp
23485
23486
23487 @node Face
23488 @subsection Face
23489 @cindex face
23490
23491 @c #### FIXME: faces and x-faces' implementations should really be harmonized.
23492
23493 @code{Face} headers are essentially a funkier version of @code{X-Face}
23494 ones. They describe a 48x48 pixel colored image that's supposed to
23495 represent the author of the message.
23496
23497 @cindex face
23498 @findex gnus-article-display-face
23499 The contents of a @code{Face} header must be a base64 encoded PNG image.
23500 See @uref{http://quimby.gnus.org/circus/face/} for the precise
23501 specifications.
23502
23503 The @code{gnus-face-properties-alist} variable affects the appearance of
23504 displayed Face images. @xref{X-Face}.
23505
23506 Viewing a @code{Face} header requires an Emacs that is able to display
23507 PNG images.
23508 @c Maybe add this:
23509 @c (if (featurep 'xemacs)
23510 @c (featurep 'png)
23511 @c (image-type-available-p 'png))
23512
23513 Gnus provides a few convenience functions and variables to allow
23514 easier insertion of Face headers in outgoing messages.
23515
23516 @findex gnus-convert-png-to-face
23517 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
23518 726 bytes long, and converts it to a face.
23519
23520 @findex gnus-face-from-file
23521 @vindex gnus-convert-image-to-face-command
23522 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
23523 converts the file to Face format by using the
23524 @code{gnus-convert-image-to-face-command} shell command.
23525
23526 Here's how you would typically use this function. Put something like the
23527 following in your @file{~/.gnus.el} file:
23528
23529 @lisp
23530 (setq message-required-news-headers
23531 (nconc message-required-news-headers
23532 (list '(Face . (lambda ()
23533 (gnus-face-from-file "~/face.jpg"))))))
23534 @end lisp
23535
23536
23537 @node Smileys
23538 @subsection Smileys
23539 @cindex smileys
23540
23541 @iftex
23542 @iflatex
23543 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
23544 \input{smiley}
23545 @end iflatex
23546 @end iftex
23547
23548 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
23549 currently the only package that uses Smiley, it is documented here.
23550
23551 In short---to use Smiley in Gnus, put the following in your
23552 @file{~/.gnus.el} file:
23553
23554 @lisp
23555 (setq gnus-treat-display-smileys t)
23556 @end lisp
23557
23558 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
23559 the like---to pictures and displays those instead of the text smiley
23560 faces. The conversion is controlled by a list of regexps that matches
23561 text and maps that to file names.
23562
23563 @vindex smiley-regexp-alist
23564 The alist used is specified by the @code{smiley-regexp-alist}
23565 variable. The first item in each element is the regexp to be matched;
23566 the second element is the regexp match group that is to be replaced by
23567 the picture; and the third element is the name of the file to be
23568 displayed.
23569
23570 The following variables customize the appearance of the smileys:
23571
23572 @table @code
23573
23574 @item smiley-style
23575 @vindex smiley-style
23576 Specifies the smiley style. Predefined smiley styles include
23577 @code{low-color} (small 13x14 pixel, three-color images), @code{medium}
23578 (more colorful images, 16x16 pixel), and @code{grayscale} (grayscale
23579 images, 14x14 pixel). The default depends on the height of the default
23580 face.
23581
23582 @item smiley-data-directory
23583 @vindex smiley-data-directory
23584 Where Smiley will look for smiley faces files. You shouldn't set this
23585 variable anymore. Customize @code{smiley-style} instead.
23586
23587 @item gnus-smiley-file-types
23588 @vindex gnus-smiley-file-types
23589 List of suffixes on smiley file names to try.
23590
23591 @end table
23592
23593
23594 @node Picons
23595 @subsection Picons
23596
23597 @iftex
23598 @iflatex
23599 \include{picons}
23600 @end iflatex
23601 @end iftex
23602
23603 So@dots{} You want to slow down your news reader even more! This is a
23604 good way to do so. It's also a great way to impress people staring
23605 over your shoulder as you read news.
23606
23607 What are Picons? To quote directly from the Picons Web site:
23608
23609 @iftex
23610 @iflatex
23611 \margindex{}
23612 @end iflatex
23613 @end iftex
23614
23615 @quotation
23616 @dfn{Picons} is short for ``personal icons''. They're small,
23617 constrained images used to represent users and domains on the net,
23618 organized into databases so that the appropriate image for a given
23619 e-mail address can be found. Besides users and domains, there are picon
23620 databases for Usenet newsgroups and weather forecasts. The picons are
23621 in either monochrome @code{XBM} format or color @code{XPM} and
23622 @code{GIF} formats.
23623 @end quotation
23624
23625 @vindex gnus-picon-databases
23626 For instructions on obtaining and installing the picons databases,
23627 point your Web browser at
23628 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
23629
23630 If you are using Debian GNU/Linux, saying @samp{apt-get install
23631 picons.*} will install the picons where Gnus can find them.
23632
23633 To enable displaying picons, simply make sure that
23634 @code{gnus-picon-databases} points to the directory containing the
23635 Picons databases.
23636
23637 @vindex gnus-picon-style
23638 The variable @code{gnus-picon-style} controls how picons are displayed.
23639 If @code{inline}, the textual representation is replaced. If
23640 @code{right}, picons are added right to the textual representation.
23641
23642 @vindex gnus-picon-properties
23643 The value of the variable @code{gnus-picon-properties} is a list of
23644 properties applied to picons.
23645
23646 The following variables offer control over where things are located.
23647
23648 @table @code
23649
23650 @item gnus-picon-databases
23651 @vindex gnus-picon-databases
23652 The location of the picons database. This is a list of directories
23653 containing the @file{news}, @file{domains}, @file{users} (and so on)
23654 subdirectories. Defaults to @code{("/usr/lib/picon"
23655 "/usr/local/faces")}.
23656
23657 @item gnus-picon-news-directories
23658 @vindex gnus-picon-news-directories
23659 List of subdirectories to search in @code{gnus-picon-databases} for
23660 newsgroups faces. @code{("news")} is the default.
23661
23662 @item gnus-picon-user-directories
23663 @vindex gnus-picon-user-directories
23664 List of subdirectories to search in @code{gnus-picon-databases} for user
23665 faces. @code{("users" "usenix" "local" "misc")} is the default.
23666
23667 @item gnus-picon-domain-directories
23668 @vindex gnus-picon-domain-directories
23669 List of subdirectories to search in @code{gnus-picon-databases} for
23670 domain name faces. Defaults to @code{("domains")}. Some people may
23671 want to add @samp{"unknown"} to this list.
23672
23673 @item gnus-picon-file-types
23674 @vindex gnus-picon-file-types
23675 Ordered list of suffixes on picon file names to try. Defaults to
23676 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
23677
23678 @item gnus-picon-inhibit-top-level-domains
23679 @vindex gnus-picon-inhibit-top-level-domains
23680 If non-@code{nil} (which is the default), don't display picons for
23681 things like @samp{.net} and @samp{.de}, which aren't usually very
23682 interesting.
23683
23684 @end table
23685
23686 @node Gravatars
23687 @subsection Gravatars
23688
23689 @iftex
23690 @iflatex
23691 \include{gravatars}
23692 @end iflatex
23693 @end iftex
23694
23695 A gravatar is an image registered to an e-mail address.
23696
23697 You can submit yours on-line at @uref{http://www.gravatar.com}.
23698
23699 The following variables offer control over how things are displayed.
23700
23701 @table @code
23702
23703 @item gnus-gravatar-size
23704 @vindex gnus-gravatar-size
23705 The size in pixels of gravatars. Gravatars are always square, so one
23706 number for the size is enough.
23707
23708 @item gnus-gravatar-properties
23709 @vindex gnus-gravatar-properties
23710 List of image properties applied to Gravatar images.
23711
23712 @item gnus-gravatar-too-ugly
23713 @vindex gnus-gravatar-too-ugly
23714 Regexp that matches mail addresses or names of people of which avatars
23715 should not be displayed, or @code{nil}. It default to the value of
23716 @code{gnus-article-x-face-too-ugly} (@pxref{X-Face}).
23717
23718 @end table
23719
23720 If you want to see them in the From field, set:
23721 @lisp
23722 (setq gnus-treat-from-gravatar 'head)
23723 @end lisp
23724
23725 If you want to see them in the Cc and To fields, set:
23726
23727 @lisp
23728 (setq gnus-treat-mail-gravatar 'head)
23729 @end lisp
23730
23731
23732 @node XVarious
23733 @subsection Various XEmacs Variables
23734
23735 @table @code
23736 @item gnus-xmas-glyph-directory
23737 @vindex gnus-xmas-glyph-directory
23738 This is where Gnus will look for pictures. Gnus will normally
23739 auto-detect this directory, but you may set it manually if you have an
23740 unusual directory structure.
23741
23742 @item gnus-xmas-modeline-glyph
23743 @vindex gnus-xmas-modeline-glyph
23744 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
23745 default.
23746
23747 @end table
23748
23749 @subsubsection Toolbar
23750
23751 @table @code
23752
23753 @item gnus-use-toolbar
23754 @vindex gnus-use-toolbar
23755 This variable specifies the position to display the toolbar. If
23756 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
23757 be one of the symbols @code{default}, @code{top}, @code{bottom},
23758 @code{right}, and @code{left}. @code{default} means to use the default
23759 toolbar, the rest mean to display the toolbar on the place which those
23760 names show. The default is @code{default}.
23761
23762 @item gnus-toolbar-thickness
23763 @vindex gnus-toolbar-thickness
23764 Cons of the height and the width specifying the thickness of a toolbar.
23765 The height is used for the toolbar displayed on the top or the bottom,
23766 the width is used for the toolbar displayed on the right or the left.
23767 The default is that of the default toolbar.
23768
23769 @item gnus-group-toolbar
23770 @vindex gnus-group-toolbar
23771 The toolbar in the group buffer.
23772
23773 @item gnus-summary-toolbar
23774 @vindex gnus-summary-toolbar
23775 The toolbar in the summary buffer.
23776
23777 @item gnus-summary-mail-toolbar
23778 @vindex gnus-summary-mail-toolbar
23779 The toolbar in the summary buffer of mail groups.
23780
23781 @end table
23782
23783 @iftex
23784 @iflatex
23785 \margindex{}
23786 @end iflatex
23787 @end iftex
23788
23789
23790 @node Fuzzy Matching
23791 @section Fuzzy Matching
23792 @cindex fuzzy matching
23793
23794 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
23795 things like scoring, thread gathering and thread comparison.
23796
23797 As opposed to regular expression matching, fuzzy matching is very fuzzy.
23798 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
23799 means, and the implementation has changed over time.
23800
23801 Basically, it tries to remove all noise from lines before comparing.
23802 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
23803 out of the strings before comparing the results. This often leads to
23804 adequate results---even when faced with strings generated by text
23805 manglers masquerading as newsreaders.
23806
23807
23808 @node Thwarting Email Spam
23809 @section Thwarting Email Spam
23810 @cindex email spam
23811 @cindex spam
23812 @cindex UCE
23813 @cindex unsolicited commercial email
23814
23815 In these last days of the Usenet, commercial vultures are hanging about
23816 and grepping through news like crazy to find email addresses they can
23817 foist off their scams and products to. As a reaction to this, many
23818 people have started putting nonsense addresses into their @code{From}
23819 lines. I think this is counterproductive---it makes it difficult for
23820 people to send you legitimate mail in response to things you write, as
23821 well as making it difficult to see who wrote what. This rewriting may
23822 perhaps be a bigger menace than the unsolicited commercial email itself
23823 in the end.
23824
23825 The biggest problem I have with email spam is that it comes in under
23826 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
23827 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
23828 mail group, only to find two pyramid schemes, seven advertisements
23829 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
23830 and one mail asking me to repent and find some god.
23831
23832 This is annoying. Here's what you can do about it.
23833
23834 @menu
23835 * The problem of spam:: Some background, and some solutions
23836 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
23837 * SpamAssassin:: How to use external anti-spam tools.
23838 * Hashcash:: Reduce spam by burning CPU time.
23839 @end menu
23840
23841 @node The problem of spam
23842 @subsection The problem of spam
23843 @cindex email spam
23844 @cindex spam filtering approaches
23845 @cindex filtering approaches, spam
23846 @cindex UCE
23847 @cindex unsolicited commercial email
23848
23849 First, some background on spam.
23850
23851 If you have access to e-mail, you are familiar with spam (technically
23852 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
23853 exists because e-mail delivery is very cheap compared to paper mail,
23854 so only a very small percentage of people need to respond to an UCE to
23855 make it worthwhile to the advertiser. Ironically, one of the most
23856 common spams is the one offering a database of e-mail addresses for
23857 further spamming. Senders of spam are usually called @emph{spammers},
23858 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
23859 @emph{morons} are in common use as well.
23860
23861 Spam comes from a wide variety of sources. It is simply impossible to
23862 dispose of all spam without discarding useful messages. A good
23863 example is the TMDA system, which requires senders
23864 unknown to you to confirm themselves as legitimate senders before
23865 their e-mail can reach you. Without getting into the technical side
23866 of TMDA, a downside is clearly that e-mail from legitimate sources may
23867 be discarded if those sources can't or won't confirm themselves
23868 through the TMDA system. Another problem with TMDA is that it
23869 requires its users to have a basic understanding of e-mail delivery
23870 and processing.
23871
23872 The simplest approach to filtering spam is filtering, at the mail
23873 server or when you sort through incoming mail. If you get 200 spam
23874 messages per day from @samp{random-address@@vmadmin.com}, you block
23875 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23876 discard all messages with @samp{VIAGRA} in the message. If you get
23877 lots of spam from Bulgaria, for example, you try to filter all mail
23878 from Bulgarian IPs.
23879
23880 This, unfortunately, is a great way to discard legitimate e-mail. The
23881 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23882 etc.)@: or even a continent (Asia, Africa, Europe, etc.)@: from contacting
23883 you should be obvious, so don't do it if you have the choice.
23884
23885 In another instance, the very informative and useful RISKS digest has
23886 been blocked by overzealous mail filters because it @strong{contained}
23887 words that were common in spam messages. Nevertheless, in isolated
23888 cases, with great care, direct filtering of mail can be useful.
23889
23890 Another approach to filtering e-mail is the distributed spam
23891 processing, for instance DCC implements such a system. In essence,
23892 @var{N} systems around the world agree that a machine @var{X} in
23893 Ghana, Estonia, or California is sending out spam e-mail, and these
23894 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23895 database. The criteria for spam detection vary---it may be the number
23896 of messages sent, the content of the messages, and so on. When a user
23897 of the distributed processing system wants to find out if a message is
23898 spam, he consults one of those @var{N} systems.
23899
23900 Distributed spam processing works very well against spammers that send
23901 a large number of messages at once, but it requires the user to set up
23902 fairly complicated checks. There are commercial and free distributed
23903 spam processing systems. Distributed spam processing has its risks as
23904 well. For instance legitimate e-mail senders have been accused of
23905 sending spam, and their web sites and mailing lists have been shut
23906 down for some time because of the incident.
23907
23908 The statistical approach to spam filtering is also popular. It is
23909 based on a statistical analysis of previous spam messages. Usually
23910 the analysis is a simple word frequency count, with perhaps pairs of
23911 words or 3-word combinations thrown into the mix. Statistical
23912 analysis of spam works very well in most of the cases, but it can
23913 classify legitimate e-mail as spam in some cases. It takes time to
23914 run the analysis, the full message must be analyzed, and the user has
23915 to store the database of spam analysis. Statistical analysis on the
23916 server is gaining popularity. This has the advantage of letting the
23917 user Just Read Mail, but has the disadvantage that it's harder to tell
23918 the server that it has misclassified mail.
23919
23920 Fighting spam is not easy, no matter what anyone says. There is no
23921 magic switch that will distinguish Viagra ads from Mom's e-mails.
23922 Even people are having a hard time telling spam apart from non-spam,
23923 because spammers are actively looking to fool us into thinking they
23924 are Mom, essentially. Spamming is irritating, irresponsible, and
23925 idiotic behavior from a bunch of people who think the world owes them
23926 a favor. We hope the following sections will help you in fighting the
23927 spam plague.
23928
23929 @node Anti-Spam Basics
23930 @subsection Anti-Spam Basics
23931 @cindex email spam
23932 @cindex spam
23933 @cindex UCE
23934 @cindex unsolicited commercial email
23935
23936 One way of dealing with spam is having Gnus split out all spam into a
23937 @samp{spam} mail group (@pxref{Splitting Mail}).
23938
23939 First, pick one (1) valid mail address that you can be reached at, and
23940 put it in your @code{From} header of all your news articles. (I've
23941 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23942 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23943 sysadmin whether your sendmail installation accepts keywords in the local
23944 part of the mail address.)
23945
23946 @lisp
23947 (setq message-default-news-headers
23948 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23949 @end lisp
23950
23951 Then put the following split rule in @code{nnmail-split-fancy}
23952 (@pxref{Fancy Mail Splitting}):
23953
23954 @lisp
23955 (...
23956 (to "larsi@@trym.ifi.uio.no"
23957 (| ("subject" "re:.*" "misc")
23958 ("references" ".*@@.*" "misc")
23959 "spam"))
23960 ...)
23961 @end lisp
23962
23963 This says that all mail to this address is suspect, but if it has a
23964 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23965 header, it's probably ok. All the rest goes to the @samp{spam} group.
23966 (This idea probably comes from Tim Pierce.)
23967
23968 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23969 and do not include your email address explicitly in the @code{To}
23970 header. Why they do this is unknown---perhaps it's to thwart this
23971 thwarting scheme? In any case, this is trivial to deal with---you just
23972 put anything not addressed to you in the @samp{spam} group by ending
23973 your fancy split rule in this way:
23974
23975 @lisp
23976 (
23977 ...
23978 (to "larsi" "misc")
23979 "spam")
23980 @end lisp
23981
23982 In my experience, this will sort virtually everything into the right
23983 group. You still have to check the @samp{spam} group from time to time to
23984 check for legitimate mail, though. If you feel like being a good net
23985 citizen, you can even send off complaints to the proper authorities on
23986 each unsolicited commercial email---at your leisure.
23987
23988 This works for me. It allows people an easy way to contact me (they can
23989 just press @kbd{r} in the usual way), and I'm not bothered at all with
23990 spam. It's a win-win situation. Forging @code{From} headers to point
23991 to non-existent domains is yucky, in my opinion.
23992
23993 Be careful with this approach. Spammers are wise to it.
23994
23995
23996 @node SpamAssassin
23997 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23998 @cindex SpamAssassin
23999 @cindex Vipul's Razor
24000 @cindex DCC
24001
24002 The days where the hints in the previous section were sufficient in
24003 avoiding spam are coming to an end. There are many tools out there
24004 that claim to reduce the amount of spam you get. This section could
24005 easily become outdated fast, as new products replace old, but
24006 fortunately most of these tools seem to have similar interfaces. Even
24007 though this section will use SpamAssassin as an example, it should be
24008 easy to adapt it to most other tools.
24009
24010 Note that this section does not involve the @code{spam.el} package,
24011 which is discussed in the next section. If you don't care for all
24012 the features of @code{spam.el}, you can make do with these simple
24013 recipes.
24014
24015 If the tool you are using is not installed on the mail server, you
24016 need to invoke it yourself. Ideas on how to use the
24017 @code{:postscript} mail source parameter (@pxref{Mail Source
24018 Specifiers}) follow.
24019
24020 @lisp
24021 (setq mail-sources
24022 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
24023 (pop :user "jrl"
24024 :server "pophost"
24025 :postscript
24026 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
24027 @end lisp
24028
24029 Once you manage to process your incoming spool somehow, thus making
24030 the mail contain, e.g., a header indicating it is spam, you are ready to
24031 filter it out. Using normal split methods (@pxref{Splitting Mail}):
24032
24033 @lisp
24034 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
24035 ...))
24036 @end lisp
24037
24038 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
24039
24040 @lisp
24041 (setq nnmail-split-methods 'nnmail-split-fancy
24042 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
24043 ...))
24044 @end lisp
24045
24046 Some people might not like the idea of piping the mail through various
24047 programs using a @code{:prescript} (if some program is buggy, you
24048 might lose all mail). If you are one of them, another solution is to
24049 call the external tools during splitting. Example fancy split method:
24050
24051 @lisp
24052 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
24053 ...))
24054 (defun kevin-spamassassin ()
24055 (save-excursion
24056 (save-restriction
24057 (widen)
24058 (if (eq 1 (call-process-region (point-min) (point-max)
24059 "spamc" nil nil nil "-c"))
24060 "spam"))))
24061 @end lisp
24062
24063 Note that with the nnimap back end, message bodies will not be
24064 downloaded by default. You need to set
24065 @code{nnimap-split-download-body} to @code{t} to do that
24066 (@pxref{Client-Side IMAP Splitting}).
24067
24068 That is about it. As some spam is likely to get through anyway, you
24069 might want to have a nifty function to call when you happen to read
24070 spam. And here is the nifty function:
24071
24072 @lisp
24073 (defun my-gnus-raze-spam ()
24074 "Submit SPAM to Vipul's Razor, then mark it as expirable."
24075 (interactive)
24076 (gnus-summary-save-in-pipe "razor-report -f -d" t)
24077 (gnus-summary-mark-as-expirable 1))
24078 @end lisp
24079
24080 @node Hashcash
24081 @subsection Hashcash
24082 @cindex hashcash
24083
24084 A novel technique to fight spam is to require senders to do something
24085 costly and demonstrably unique for each message they send. This has
24086 the obvious drawback that you cannot rely on everyone in the world
24087 using this technique, since it is not part of the Internet standards,
24088 but it may be useful in smaller communities.
24089
24090 While the tools in the previous section work well in practice, they
24091 work only because the tools are constantly maintained and updated as
24092 new form of spam appears. This means that a small percentage of spam
24093 will always get through. It also means that somewhere, someone needs
24094 to read lots of spam to update these tools. Hashcash avoids that, but
24095 instead prefers that everyone you contact through e-mail supports the
24096 scheme. You can view the two approaches as pragmatic vs dogmatic.
24097 The approaches have their own advantages and disadvantages, but as
24098 often in the real world, a combination of them is stronger than either
24099 one of them separately.
24100
24101 @cindex X-Hashcash
24102 The ``something costly'' is to burn CPU time, more specifically to
24103 compute a hash collision up to a certain number of bits. The
24104 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
24105 For more details, and for the external application @code{hashcash} you
24106 need to install to use this feature, see
24107 @uref{http://www.hashcash.org/}. Even more information can be found
24108 at @uref{http://www.camram.org/}.
24109
24110 If you wish to generate hashcash for each message you send, you can
24111 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
24112 Headers,message, The Message Manual}), as in:
24113
24114 @lisp
24115 (setq message-generate-hashcash t)
24116 @end lisp
24117
24118 You will need to set up some additional variables as well:
24119
24120 @table @code
24121
24122 @item hashcash-default-payment
24123 @vindex hashcash-default-payment
24124 This variable indicates the default number of bits the hash collision
24125 should consist of. By default this is 20. Suggested useful values
24126 include 17 to 29.
24127
24128 @item hashcash-payment-alist
24129 @vindex hashcash-payment-alist
24130 Some receivers may require you to spend burn more CPU time than the
24131 default. This variable contains a list of @samp{(@var{addr}
24132 @var{amount})} cells, where @var{addr} is the receiver (email address
24133 or newsgroup) and @var{amount} is the number of bits in the collision
24134 that is needed. It can also contain @samp{(@var{addr} @var{string}
24135 @var{amount})} cells, where the @var{string} is the string to use
24136 (normally the email address or newsgroup name is used).
24137
24138 @item hashcash-path
24139 @vindex hashcash-path
24140 Where the @code{hashcash} binary is installed. This variable should
24141 be automatically set by @code{executable-find}, but if it's @code{nil}
24142 (usually because the @code{hashcash} binary is not in your path)
24143 you'll get a warning when you check hashcash payments and an error
24144 when you generate hashcash payments.
24145
24146 @end table
24147
24148 Gnus can verify hashcash cookies, although this can also be done by
24149 hand customized mail filtering scripts. To verify a hashcash cookie
24150 in a message, use the @code{mail-check-payment} function in the
24151 @code{hashcash.el} library. You can also use the @code{spam.el}
24152 package with the @code{spam-use-hashcash} back end to validate hashcash
24153 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
24154 Hashcash Payments}).
24155
24156 @node Spam Package
24157 @section Spam Package
24158 @cindex spam filtering
24159 @cindex spam
24160
24161 The Spam package provides Gnus with a centralized mechanism for
24162 detecting and filtering spam. It filters new mail, and processes
24163 messages according to whether they are spam or ham. (@dfn{Ham} is the
24164 name used throughout this manual to indicate non-spam messages.)
24165
24166 @menu
24167 * Spam Package Introduction::
24168 * Filtering Incoming Mail::
24169 * Detecting Spam in Groups::
24170 * Spam and Ham Processors::
24171 * Spam Package Configuration Examples::
24172 * Spam Back Ends::
24173 * Extending the Spam package::
24174 * Spam Statistics Package::
24175 @end menu
24176
24177 @node Spam Package Introduction
24178 @subsection Spam Package Introduction
24179 @cindex spam filtering
24180 @cindex spam filtering sequence of events
24181 @cindex spam
24182
24183 You must read this section to understand how the Spam package works.
24184 Do not skip, speed-read, or glance through this section.
24185
24186 Make sure you read the section on the @code{spam.el} sequence of
24187 events. See @xref{Extending the Spam package}.
24188
24189 @cindex spam-initialize
24190 @vindex spam-use-stat
24191 To use the Spam package, you @strong{must} first run the function
24192 @code{spam-initialize}:
24193
24194 @example
24195 (spam-initialize)
24196 @end example
24197
24198 This autoloads @code{spam.el} and installs the various hooks necessary
24199 to let the Spam package do its job. In order to make use of the Spam
24200 package, you have to set up certain group parameters and variables,
24201 which we will describe below. All of the variables controlling the
24202 Spam package can be found in the @samp{spam} customization group.
24203
24204 There are two ``contact points'' between the Spam package and the rest
24205 of Gnus: checking new mail for spam, and leaving a group.
24206
24207 Checking new mail for spam is done in one of two ways: while splitting
24208 incoming mail, or when you enter a group.
24209
24210 The first way, checking for spam while splitting incoming mail, is
24211 suited to mail back ends such as @code{nnml} or @code{nnimap}, where
24212 new mail appears in a single spool file. The Spam package processes
24213 incoming mail, and sends mail considered to be spam to a designated
24214 ``spam'' group. @xref{Filtering Incoming Mail}.
24215
24216 The second way is suited to back ends such as @code{nntp}, which have
24217 no incoming mail spool, or back ends where the server is in charge of
24218 splitting incoming mail. In this case, when you enter a Gnus group,
24219 the unseen or unread messages in that group are checked for spam.
24220 Detected spam messages are marked as spam. @xref{Detecting Spam in
24221 Groups}.
24222
24223 @cindex spam back ends
24224 In either case, you have to tell the Spam package what method to use
24225 to detect spam messages. There are several methods, or @dfn{spam back
24226 ends} (not to be confused with Gnus back ends!) to choose from: spam
24227 ``blacklists'' and ``whitelists'', dictionary-based filters, and so
24228 forth. @xref{Spam Back Ends}.
24229
24230 In the Gnus summary buffer, messages that have been identified as spam
24231 always appear with a @samp{$} symbol.
24232
24233 The Spam package divides Gnus groups into three categories: ham
24234 groups, spam groups, and unclassified groups. You should mark each of
24235 the groups you subscribe to as either a ham group or a spam group,
24236 using the @code{spam-contents} group parameter (@pxref{Group
24237 Parameters}). Spam groups have a special property: when you enter a
24238 spam group, all unseen articles are marked as spam. Thus, mail split
24239 into a spam group is automatically marked as spam.
24240
24241 Identifying spam messages is only half of the Spam package's job. The
24242 second half comes into play whenever you exit a group buffer. At this
24243 point, the Spam package does several things:
24244
24245 First, it calls @dfn{spam and ham processors} to process the articles
24246 according to whether they are spam or ham. There is a pair of spam
24247 and ham processors associated with each spam back end, and what the
24248 processors do depends on the back end. At present, the main role of
24249 spam and ham processors is for dictionary-based spam filters: they add
24250 the contents of the messages in the group to the filter's dictionary,
24251 to improve its ability to detect future spam. The @code{spam-process}
24252 group parameter specifies what spam processors to use. @xref{Spam and
24253 Ham Processors}.
24254
24255 If the spam filter failed to mark a spam message, you can mark it
24256 yourself, so that the message is processed as spam when you exit the
24257 group:
24258
24259 @table @kbd
24260 @item $
24261 @itemx M-d
24262 @itemx M s x
24263 @itemx S x
24264 @kindex $ (Summary)
24265 @kindex M-d (Summary)
24266 @kindex S x (Summary)
24267 @kindex M s x (Summary)
24268 @findex gnus-summary-mark-as-spam
24269 @findex gnus-summary-mark-as-spam
24270 Mark current article as spam, showing it with the @samp{$} mark
24271 (@code{gnus-summary-mark-as-spam}).
24272 @end table
24273
24274 @noindent
24275 Similarly, you can unmark an article if it has been erroneously marked
24276 as spam. @xref{Setting Marks}.
24277
24278 Normally, a ham message found in a non-ham group is not processed as
24279 ham---the rationale is that it should be moved into a ham group for
24280 further processing (see below). However, you can force these articles
24281 to be processed as ham by setting
24282 @code{spam-process-ham-in-spam-groups} and
24283 @code{spam-process-ham-in-nonham-groups}.
24284
24285 @vindex gnus-ham-process-destinations
24286 @vindex gnus-spam-process-destinations
24287 The second thing that the Spam package does when you exit a group is
24288 to move ham articles out of spam groups, and spam articles out of ham
24289 groups. Ham in a spam group is moved to the group specified by the
24290 variable @code{gnus-ham-process-destinations}, or the group parameter
24291 @code{ham-process-destination}. Spam in a ham group is moved to the
24292 group specified by the variable @code{gnus-spam-process-destinations},
24293 or the group parameter @code{spam-process-destination}. If these
24294 variables are not set, the articles are left in their current group.
24295 If an article cannot be moved (e.g., with a read-only backend such
24296 as @acronym{NNTP}), it is copied.
24297
24298 If an article is moved to another group, it is processed again when
24299 you visit the new group. Normally, this is not a problem, but if you
24300 want each article to be processed only once, load the
24301 @code{gnus-registry.el} package and set the variable
24302 @code{spam-log-to-registry} to @code{t}. @xref{Spam Package
24303 Configuration Examples}.
24304
24305 Normally, spam groups ignore @code{gnus-spam-process-destinations}.
24306 However, if you set @code{spam-move-spam-nonspam-groups-only} to
24307 @code{nil}, spam will also be moved out of spam groups, depending on
24308 the @code{spam-process-destination} parameter.
24309
24310 The final thing the Spam package does is to mark spam articles as
24311 expired, which is usually the right thing to do.
24312
24313 If all this seems confusing, don't worry. Soon it will be as natural
24314 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
24315 50 years in the future yet. Just trust us, it's not so bad.
24316
24317 @node Filtering Incoming Mail
24318 @subsection Filtering Incoming Mail
24319 @cindex spam filtering
24320 @cindex spam filtering incoming mail
24321 @cindex spam
24322
24323 To use the Spam package to filter incoming mail, you must first set up
24324 fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package
24325 defines a special splitting function that you can add to your fancy
24326 split variable (either @code{nnmail-split-fancy} or
24327 @code{nnimap-split-fancy}, depending on your mail back end):
24328
24329 @example
24330 (: spam-split)
24331 @end example
24332
24333 @vindex spam-split-group
24334 @noindent
24335 The @code{spam-split} function scans incoming mail according to your
24336 chosen spam back end(s), and sends messages identified as spam to a
24337 spam group. By default, the spam group is a group named @samp{spam},
24338 but you can change this by customizing @code{spam-split-group}. Make
24339 sure the contents of @code{spam-split-group} are an unqualified group
24340 name. For instance, in an @code{nnimap} server @samp{your-server},
24341 the value @samp{spam} means @samp{nnimap+your-server:spam}. The value
24342 @samp{nnimap+server:spam} is therefore wrong---it gives the group
24343 @samp{nnimap+your-server:nnimap+server:spam}.
24344
24345 @code{spam-split} does not modify the contents of messages in any way.
24346
24347 @vindex nnimap-split-download-body
24348 Note for IMAP users: if you use the @code{spam-check-bogofilter},
24349 @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends,
24350 you should also set the variable @code{nnimap-split-download-body} to
24351 @code{t}. These spam back ends are most useful when they can ``scan''
24352 the full message body. By default, the nnimap back end only retrieves
24353 the message headers; @code{nnimap-split-download-body} tells it to
24354 retrieve the message bodies as well. We don't set this by default
24355 because it will slow @acronym{IMAP} down, and that is not an
24356 appropriate decision to make on behalf of the user. @xref{Client-Side
24357 IMAP Splitting}.
24358
24359 You have to specify one or more spam back ends for @code{spam-split}
24360 to use, by setting the @code{spam-use-*} variables. @xref{Spam Back
24361 Ends}. Normally, @code{spam-split} simply uses all the spam back ends
24362 you enabled in this way. However, you can tell @code{spam-split} to
24363 use only some of them. Why this is useful? Suppose you are using the
24364 @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back
24365 ends, and the following split rule:
24366
24367 @example
24368 nnimap-split-fancy '(|
24369 (any "ding" "ding")
24370 (: spam-split)
24371 ;; @r{default mailbox}
24372 "mail")
24373 @end example
24374
24375 @noindent
24376 The problem is that you want all ding messages to make it to the ding
24377 folder. But that will let obvious spam (for example, spam detected by
24378 SpamAssassin, and @code{spam-use-regex-headers}) through, when it's
24379 sent to the ding list. On the other hand, some messages to the ding
24380 list are from a mail server in the blackhole list, so the invocation
24381 of @code{spam-split} can't be before the ding rule.
24382
24383 The solution is to let SpamAssassin headers supersede ding rules, and
24384 perform the other @code{spam-split} rules (including a second
24385 invocation of the regex-headers check) after the ding rule. This is
24386 done by passing a parameter to @code{spam-split}:
24387
24388 @example
24389 nnimap-split-fancy
24390 '(|
24391 ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
24392 (: spam-split "regex-spam" 'spam-use-regex-headers)
24393 (any "ding" "ding")
24394 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
24395 (: spam-split)
24396 ;; @r{default mailbox}
24397 "mail")
24398 @end example
24399
24400 @noindent
24401 This lets you invoke specific @code{spam-split} checks depending on
24402 your particular needs, and target the results of those checks to a
24403 particular spam group. You don't have to throw all mail into all the
24404 spam tests. Another reason why this is nice is that messages to
24405 mailing lists you have rules for don't have to have resource-intensive
24406 blackhole checks performed on them. You could also specify different
24407 spam checks for your nnmail split vs. your nnimap split. Go crazy.
24408
24409 You should set the @code{spam-use-*} variables for whatever spam back
24410 ends you intend to use. The reason is that when loading
24411 @file{spam.el}, some conditional loading is done depending on what
24412 @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}.
24413
24414 @c @emph{TODO: spam.el needs to provide a uniform way of training all the
24415 @c statistical databases. Some have that functionality built-in, others
24416 @c don't.}
24417
24418 @node Detecting Spam in Groups
24419 @subsection Detecting Spam in Groups
24420
24421 To detect spam when visiting a group, set the group's
24422 @code{spam-autodetect} and @code{spam-autodetect-methods} group
24423 parameters. These are accessible with @kbd{G c} or @kbd{G p}, as
24424 usual (@pxref{Group Parameters}).
24425
24426 You should set the @code{spam-use-*} variables for whatever spam back
24427 ends you intend to use. The reason is that when loading
24428 @file{spam.el}, some conditional loading is done depending on what
24429 @code{spam-use-xyz} variables you have set.
24430
24431 By default, only unseen articles are processed for spam. You can
24432 force Gnus to recheck all messages in the group by setting the
24433 variable @code{spam-autodetect-recheck-messages} to @code{t}.
24434
24435 If you use the @code{spam-autodetect} method of checking for spam, you
24436 can specify different spam detection methods for different groups.
24437 For instance, the @samp{ding} group may have @code{spam-use-BBDB} as
24438 the autodetection method, while the @samp{suspect} group may have the
24439 @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods
24440 enabled. Unlike with @code{spam-split}, you don't have any control
24441 over the @emph{sequence} of checks, but this is probably unimportant.
24442
24443 @node Spam and Ham Processors
24444 @subsection Spam and Ham Processors
24445 @cindex spam filtering
24446 @cindex spam filtering variables
24447 @cindex spam variables
24448 @cindex spam
24449
24450 @vindex gnus-spam-process-newsgroups
24451 Spam and ham processors specify special actions to take when you exit
24452 a group buffer. Spam processors act on spam messages, and ham
24453 processors on ham messages. At present, the main role of these
24454 processors is to update the dictionaries of dictionary-based spam back
24455 ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics
24456 package (@pxref{Spam Statistics Filtering}).
24457
24458 The spam and ham processors that apply to each group are determined by
24459 the group's@code{spam-process} group parameter. If this group
24460 parameter is not defined, they are determined by the variable
24461 @code{gnus-spam-process-newsgroups}.
24462
24463 @vindex gnus-spam-newsgroup-contents
24464 Gnus learns from the spam you get. You have to collect your spam in
24465 one or more spam groups, and set or customize the variable
24466 @code{spam-junk-mailgroups} as appropriate. You can also declare
24467 groups to contain spam by setting their group parameter
24468 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
24469 by customizing the corresponding variable
24470 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
24471 parameter and the @code{gnus-spam-newsgroup-contents} variable can
24472 also be used to declare groups as @emph{ham} groups if you set their
24473 classification to @code{gnus-group-spam-classification-ham}. If
24474 groups are not classified by means of @code{spam-junk-mailgroups},
24475 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
24476 considered @emph{unclassified}. All groups are unclassified by
24477 default.
24478
24479 @vindex gnus-spam-mark
24480 @cindex $
24481 In spam groups, all messages are considered to be spam by default:
24482 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
24483 group. If you have seen a message, had it marked as spam, then
24484 unmarked it, it won't be marked as spam when you enter the group
24485 thereafter. You can disable that behavior, so all unread messages
24486 will get the @samp{$} mark, if you set the
24487 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
24488 should remove the @samp{$} mark when you are in the group summary
24489 buffer for every message that is not spam after all. To remove the
24490 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
24491 @kbd{d} for declaring it read the non-spam way. When you leave a
24492 group, all spam-marked (@samp{$}) articles are sent to a spam
24493 processor which will study them as spam samples.
24494
24495 Messages may also be deleted in various other ways, and unless
24496 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
24497 and @samp{r} for default read or explicit delete, marks @samp{X} and
24498 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
24499 low scores, are all considered to be associated with articles which
24500 are not spam. This assumption might be false, in particular if you
24501 use kill files or score files as means for detecting genuine spam, you
24502 should then adjust the @code{ham-marks} group parameter.
24503
24504 @defvar ham-marks
24505 You can customize this group or topic parameter to be the list of
24506 marks you want to consider ham. By default, the list contains the
24507 deleted, read, killed, kill-filed, and low-score marks (the idea is
24508 that these articles have been read, but are not spam). It can be
24509 useful to also include the tick mark in the ham marks. It is not
24510 recommended to make the unread mark a ham mark, because it normally
24511 indicates a lack of classification. But you can do it, and we'll be
24512 happy for you.
24513 @end defvar
24514
24515 @defvar spam-marks
24516 You can customize this group or topic parameter to be the list of
24517 marks you want to consider spam. By default, the list contains only
24518 the spam mark. It is not recommended to change that, but you can if
24519 you really want to.
24520 @end defvar
24521
24522 When you leave @emph{any} group, regardless of its
24523 @code{spam-contents} classification, all spam-marked articles are sent
24524 to a spam processor, which will study these as spam samples. If you
24525 explicit kill a lot, you might sometimes end up with articles marked
24526 @samp{K} which you never saw, and which might accidentally contain
24527 spam. Best is to make sure that real spam is marked with @samp{$},
24528 and nothing else.
24529
24530 @vindex gnus-ham-process-destinations
24531 When you leave a @emph{spam} group, all spam-marked articles are
24532 marked as expired after processing with the spam processor. This is
24533 not done for @emph{unclassified} or @emph{ham} groups. Also, any
24534 @strong{ham} articles in a spam group will be moved to a location
24535 determined by either the @code{ham-process-destination} group
24536 parameter or a match in the @code{gnus-ham-process-destinations}
24537 variable, which is a list of regular expressions matched with group
24538 names (it's easiest to customize this variable with @kbd{M-x
24539 customize-variable @key{RET} gnus-ham-process-destinations}). Each
24540 group name list is a standard Lisp list, if you prefer to customize
24541 the variable manually. If the @code{ham-process-destination}
24542 parameter is not set, ham articles are left in place. If the
24543 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
24544 set, the ham articles are marked as unread before being moved.
24545
24546 If ham can not be moved---because of a read-only back end such as
24547 @acronym{NNTP}, for example, it will be copied.
24548
24549 Note that you can use multiples destinations per group or regular
24550 expression! This enables you to send your ham to a regular mail
24551 group and to a @emph{ham training} group.
24552
24553 When you leave a @emph{ham} group, all ham-marked articles are sent to
24554 a ham processor, which will study these as non-spam samples.
24555
24556 @vindex spam-process-ham-in-spam-groups
24557 By default the variable @code{spam-process-ham-in-spam-groups} is
24558 @code{nil}. Set it to @code{t} if you want ham found in spam groups
24559 to be processed. Normally this is not done, you are expected instead
24560 to send your ham to a ham group and process it there.
24561
24562 @vindex spam-process-ham-in-nonham-groups
24563 By default the variable @code{spam-process-ham-in-nonham-groups} is
24564 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
24565 or unclassified) groups to be processed. Normally this is not done,
24566 you are expected instead to send your ham to a ham group and process
24567 it there.
24568
24569 @vindex gnus-spam-process-destinations
24570 When you leave a @emph{ham} or @emph{unclassified} group, all
24571 @strong{spam} articles are moved to a location determined by either
24572 the @code{spam-process-destination} group parameter or a match in the
24573 @code{gnus-spam-process-destinations} variable, which is a list of
24574 regular expressions matched with group names (it's easiest to
24575 customize this variable with @kbd{M-x customize-variable @key{RET}
24576 gnus-spam-process-destinations}). Each group name list is a standard
24577 Lisp list, if you prefer to customize the variable manually. If the
24578 @code{spam-process-destination} parameter is not set, the spam
24579 articles are only expired. The group name is fully qualified, meaning
24580 that if you see @samp{nntp:servername} before the group name in the
24581 group buffer then you need it here as well.
24582
24583 If spam can not be moved---because of a read-only back end such as
24584 @acronym{NNTP}, for example, it will be copied.
24585
24586 Note that you can use multiples destinations per group or regular
24587 expression! This enables you to send your spam to multiple @emph{spam
24588 training} groups.
24589
24590 @vindex spam-log-to-registry
24591 The problem with processing ham and spam is that Gnus doesn't track
24592 this processing by default. Enable the @code{spam-log-to-registry}
24593 variable so @code{spam.el} will use @code{gnus-registry.el} to track
24594 what articles have been processed, and avoid processing articles
24595 multiple times. Keep in mind that if you limit the number of registry
24596 entries, this won't work as well as it does without a limit.
24597
24598 @vindex spam-mark-only-unseen-as-spam
24599 Set this variable if you want only unseen articles in spam groups to
24600 be marked as spam. By default, it is set. If you set it to
24601 @code{nil}, unread articles will also be marked as spam.
24602
24603 @vindex spam-mark-ham-unread-before-move-from-spam-group
24604 Set this variable if you want ham to be unmarked before it is moved
24605 out of the spam group. This is very useful when you use something
24606 like the tick mark @samp{!} to mark ham---the article will be placed
24607 in your @code{ham-process-destination}, unmarked as if it came fresh
24608 from the mail server.
24609
24610 @vindex spam-autodetect-recheck-messages
24611 When autodetecting spam, this variable tells @code{spam.el} whether
24612 only unseen articles or all unread articles should be checked for
24613 spam. It is recommended that you leave it off.
24614
24615 @node Spam Package Configuration Examples
24616 @subsection Spam Package Configuration Examples
24617 @cindex spam filtering
24618 @cindex spam filtering configuration examples
24619 @cindex spam configuration examples
24620 @cindex spam
24621
24622 @subsubheading Ted's setup
24623
24624 From Ted Zlatanov <tzz@@lifelogs.com>.
24625 @example
24626 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
24627 ;; @r{see @file{gnus-registry.el} for more information}
24628 (gnus-registry-initialize)
24629 (spam-initialize)
24630
24631 (setq
24632 spam-log-to-registry t ; @r{for spam autodetection}
24633 spam-use-BBDB t
24634 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
24635 ;; @r{all groups with @samp{spam} in the name contain spam}
24636 gnus-spam-newsgroup-contents
24637 '(("spam" gnus-group-spam-classification-spam))
24638 ;; @r{see documentation for these}
24639 spam-move-spam-nonspam-groups-only nil
24640 spam-mark-only-unseen-as-spam t
24641 spam-mark-ham-unread-before-move-from-spam-group t
24642 ;; @r{understand what this does before you copy it to your own setup!}
24643 ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual}
24644 nnimap-split-fancy '(|
24645 ;; @r{trace references to parents and put in their group}
24646 (: gnus-registry-split-fancy-with-parent)
24647 ;; @r{this will catch server-side SpamAssassin tags}
24648 (: spam-split 'spam-use-regex-headers)
24649 (any "ding" "ding")
24650 ;; @r{note that spam by default will go to @samp{spam}}
24651 (: spam-split)
24652 ;; @r{default mailbox}
24653 "mail"))
24654
24655 ;; @r{my parameters, set with @kbd{G p}}
24656
24657 ;; @r{all nnml groups, and all nnimap groups except}
24658 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
24659 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
24660 ;; @r{because it must have been detected manually}
24661
24662 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24663
24664 ;; @r{all @acronym{NNTP} groups}
24665 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
24666 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
24667 ;; @r{send all spam to the training group}
24668 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24669
24670 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
24671 ((spam-autodetect . t))
24672
24673 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
24674
24675 ;; @r{this is a spam group}
24676 ((spam-contents gnus-group-spam-classification-spam)
24677
24678 ;; @r{any spam (which happens when I enter for all unseen messages,}
24679 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
24680 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
24681
24682 (spam-process-destination "nnimap+mail.lifelogs.com:train")
24683
24684 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
24685 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
24686
24687 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
24688 "nnimap+mail.lifelogs.com:trainham")
24689 ;; @r{in this group, only @samp{!} marks are ham}
24690 (ham-marks
24691 (gnus-ticked-mark))
24692 ;; @r{remembers senders in the blacklist on the way out---this is}
24693 ;; @r{definitely not needed, it just makes me feel better}
24694 (spam-process (gnus-group-spam-exit-processor-blacklist)))
24695
24696 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
24697 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
24698 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
24699
24700 @end example
24701
24702 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
24703 From Reiner Steib <reiner.steib@@gmx.de>.
24704
24705 My provider has set up bogofilter (in combination with @acronym{DCC}) on
24706 the mail server (@acronym{IMAP}). Recognized spam goes to
24707 @samp{spam.detected}, the rest goes through the normal filter rules,
24708 i.e., to @samp{some.folder} or to @samp{INBOX}. Training on false
24709 positives or negatives is done by copying or moving the article to
24710 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
24711 the server feeds those to bogofilter with the suitable ham or spam
24712 options and deletes them from the @samp{training.ham} and
24713 @samp{training.spam} folders.
24714
24715 With the following entries in @code{gnus-parameters}, @code{spam.el}
24716 does most of the job for me:
24717
24718 @lisp
24719 ("nnimap:spam\\.detected"
24720 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
24721 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
24722 (spam-contents gnus-group-spam-classification-spam))
24723 ("nnimap:\\(INBOX\\|other-folders\\)"
24724 (spam-process-destination . "nnimap:training.spam")
24725 (spam-contents gnus-group-spam-classification-ham))
24726 @end lisp
24727
24728 @itemize
24729
24730 @item @b{The Spam folder:}
24731
24732 In the folder @samp{spam.detected}, I have to check for false positives
24733 (i.e., legitimate mails, that were wrongly judged as spam by
24734 bogofilter or DCC).
24735
24736 Because of the @code{gnus-group-spam-classification-spam} entry, all
24737 messages are marked as spam (with @code{$}). When I find a false
24738 positive, I mark the message with some other ham mark
24739 (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit,
24740 those messages are copied to both groups, @samp{INBOX} (where I want
24741 to have the article) and @samp{training.ham} (for training bogofilter)
24742 and deleted from the @samp{spam.detected} folder.
24743
24744 The @code{gnus-article-sort-by-chars} entry simplifies detection of
24745 false positives for me. I receive lots of worms (sweN, @dots{}), that all
24746 have a similar size. Grouping them by size (i.e., chars) makes finding
24747 other false positives easier. (Of course worms aren't @i{spam}
24748 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
24749 an excellent tool for filtering those unwanted mails for me.)
24750
24751 @item @b{Ham folders:}
24752
24753 In my ham folders, I just hit @kbd{S x}
24754 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
24755 mail (false negative). On group exit, those messages are moved to
24756 @samp{training.spam}.
24757 @end itemize
24758
24759 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
24760
24761 From Reiner Steib <reiner.steib@@gmx.de>.
24762
24763 With following entry in @code{gnus-parameters}, @kbd{S x}
24764 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
24765 groups as spam and reports the to Gmane at group exit:
24766
24767 @lisp
24768 ("^gmane\\."
24769 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
24770 @end lisp
24771
24772 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
24773 because I don't read the groups directly from news.gmane.org, but
24774 through my local news server (leafnode). I.e., the article numbers are
24775 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
24776 the @code{X-Report-Spam} header to find the correct number.
24777
24778 @node Spam Back Ends
24779 @subsection Spam Back Ends
24780 @cindex spam back ends
24781
24782 The spam package offers a variety of back ends for detecting spam.
24783 Each back end defines a set of methods for detecting spam
24784 (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}),
24785 and a pair of spam and ham processors (@pxref{Spam and Ham
24786 Processors}).
24787
24788 @menu
24789 * Blacklists and Whitelists::
24790 * BBDB Whitelists::
24791 * Gmane Spam Reporting::
24792 * Anti-spam Hashcash Payments::
24793 * Blackholes::
24794 * Regular Expressions Header Matching::
24795 * Bogofilter::
24796 * SpamAssassin back end::
24797 * ifile spam filtering::
24798 * Spam Statistics Filtering::
24799 * SpamOracle::
24800 @end menu
24801
24802 @node Blacklists and Whitelists
24803 @subsubsection Blacklists and Whitelists
24804 @cindex spam filtering
24805 @cindex whitelists, spam filtering
24806 @cindex blacklists, spam filtering
24807 @cindex spam
24808
24809 @defvar spam-use-blacklist
24810
24811 Set this variable to @code{t} if you want to use blacklists when
24812 splitting incoming mail. Messages whose senders are in the blacklist
24813 will be sent to the @code{spam-split-group}. This is an explicit
24814 filter, meaning that it acts only on mail senders @emph{declared} to
24815 be spammers.
24816
24817 @end defvar
24818
24819 @defvar spam-use-whitelist
24820
24821 Set this variable to @code{t} if you want to use whitelists when
24822 splitting incoming mail. Messages whose senders are not in the
24823 whitelist will be sent to the next spam-split rule. This is an
24824 explicit filter, meaning that unless someone is in the whitelist, their
24825 messages are not assumed to be spam or ham.
24826
24827 @end defvar
24828
24829 @defvar spam-use-whitelist-exclusive
24830
24831 Set this variable to @code{t} if you want to use whitelists as an
24832 implicit filter, meaning that every message will be considered spam
24833 unless the sender is in the whitelist. Use with care.
24834
24835 @end defvar
24836
24837 @defvar gnus-group-spam-exit-processor-blacklist
24838
24839 Add this symbol to a group's @code{spam-process} parameter by
24840 customizing the group parameters or the
24841 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24842 added to a group's @code{spam-process} parameter, the senders of
24843 spam-marked articles will be added to the blacklist.
24844
24845 @emph{WARNING}
24846
24847 Instead of the obsolete
24848 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24849 that you use @code{(spam spam-use-blacklist)}. Everything will work
24850 the same way, we promise.
24851
24852 @end defvar
24853
24854 @defvar gnus-group-ham-exit-processor-whitelist
24855
24856 Add this symbol to a group's @code{spam-process} parameter by
24857 customizing the group parameters or the
24858 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24859 added to a group's @code{spam-process} parameter, the senders of
24860 ham-marked articles in @emph{ham} groups will be added to the
24861 whitelist.
24862
24863 @emph{WARNING}
24864
24865 Instead of the obsolete
24866 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24867 that you use @code{(ham spam-use-whitelist)}. Everything will work
24868 the same way, we promise.
24869
24870 @end defvar
24871
24872 Blacklists are lists of regular expressions matching addresses you
24873 consider to be spam senders. For instance, to block mail from any
24874 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24875 blacklist. You start out with an empty blacklist. Blacklist entries
24876 use the Emacs regular expression syntax.
24877
24878 Conversely, whitelists tell Gnus what addresses are considered
24879 legitimate. All messages from whitelisted addresses are considered
24880 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24881 Emacs regular expression syntax.
24882
24883 The blacklist and whitelist file locations can be customized with the
24884 @code{spam-directory} variable (@file{~/News/spam} by default), or
24885 the @code{spam-whitelist} and @code{spam-blacklist} variables
24886 directly. The whitelist and blacklist files will by default be in the
24887 @code{spam-directory} directory, named @file{whitelist} and
24888 @file{blacklist} respectively.
24889
24890 @node BBDB Whitelists
24891 @subsubsection BBDB Whitelists
24892 @cindex spam filtering
24893 @cindex BBDB whitelists, spam filtering
24894 @cindex BBDB, spam filtering
24895 @cindex spam
24896
24897 @defvar spam-use-BBDB
24898
24899 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24900 Whitelists}), but uses the BBDB as the source of whitelisted
24901 addresses, without regular expressions. You must have the BBDB loaded
24902 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24903 not in the BBDB will be sent to the next spam-split rule. This is an
24904 explicit filter, meaning that unless someone is in the BBDB, their
24905 messages are not assumed to be spam or ham.
24906
24907 @end defvar
24908
24909 @defvar spam-use-BBDB-exclusive
24910
24911 Set this variable to @code{t} if you want to use the BBDB as an
24912 implicit filter, meaning that every message will be considered spam
24913 unless the sender is in the BBDB@. Use with care. Only sender
24914 addresses in the BBDB will be allowed through; all others will be
24915 classified as spammers.
24916
24917 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24918 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24919 @emph{not} a separate back end. If you set
24920 @code{spam-use-BBDB-exclusive} to @code{t}, @emph{all} your BBDB splitting
24921 will be exclusive.
24922
24923 @end defvar
24924
24925 @defvar gnus-group-ham-exit-processor-BBDB
24926
24927 Add this symbol to a group's @code{spam-process} parameter by
24928 customizing the group parameters or the
24929 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24930 added to a group's @code{spam-process} parameter, the senders of
24931 ham-marked articles in @emph{ham} groups will be added to the
24932 BBDB.
24933
24934 @emph{WARNING}
24935
24936 Instead of the obsolete
24937 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24938 that you use @code{(ham spam-use-BBDB)}. Everything will work
24939 the same way, we promise.
24940
24941 @end defvar
24942
24943 @node Gmane Spam Reporting
24944 @subsubsection Gmane Spam Reporting
24945 @cindex spam reporting
24946 @cindex Gmane, spam reporting
24947 @cindex Gmane, spam reporting
24948 @cindex spam
24949
24950 @defvar gnus-group-spam-exit-processor-report-gmane
24951
24952 Add this symbol to a group's @code{spam-process} parameter by
24953 customizing the group parameters or the
24954 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24955 added to a group's @code{spam-process} parameter, the spam-marked
24956 articles groups will be reported to the Gmane administrators via a
24957 HTTP request.
24958
24959 Gmane can be found at @uref{http://gmane.org}.
24960
24961 @emph{WARNING}
24962
24963 Instead of the obsolete
24964 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24965 that you use @code{(spam spam-use-gmane)}. Everything will work the
24966 same way, we promise.
24967
24968 @end defvar
24969
24970 @defvar spam-report-gmane-use-article-number
24971
24972 This variable is @code{t} by default. Set it to @code{nil} if you are
24973 running your own news server, for instance, and the local article
24974 numbers don't correspond to the Gmane article numbers. When
24975 @code{spam-report-gmane-use-article-number} is @code{nil},
24976 @code{spam-report.el} will fetch the number from the article headers.
24977
24978 @end defvar
24979
24980 @defvar spam-report-user-mail-address
24981
24982 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24983 the Gmane administrators to contact you in case of misreports. The
24984 default is @code{user-mail-address}.
24985
24986 @end defvar
24987
24988 @node Anti-spam Hashcash Payments
24989 @subsubsection Anti-spam Hashcash Payments
24990 @cindex spam filtering
24991 @cindex hashcash, spam filtering
24992 @cindex spam
24993
24994 @defvar spam-use-hashcash
24995
24996 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24997 Whitelists}), but uses hashcash tokens for whitelisting messages
24998 instead of the sender address. Messages without a hashcash payment
24999 token will be sent to the next spam-split rule. This is an explicit
25000 filter, meaning that unless a hashcash token is found, the messages
25001 are not assumed to be spam or ham.
25002
25003 @end defvar
25004
25005 @node Blackholes
25006 @subsubsection Blackholes
25007 @cindex spam filtering
25008 @cindex blackholes, spam filtering
25009 @cindex spam
25010
25011 @defvar spam-use-blackholes
25012
25013 This option is disabled by default. You can let Gnus consult the
25014 blackhole-type distributed spam processing systems (DCC, for instance)
25015 when you set this option. The variable @code{spam-blackhole-servers}
25016 holds the list of blackhole servers Gnus will consult. The current
25017 list is fairly comprehensive, but make sure to let us know if it
25018 contains outdated servers.
25019
25020 The blackhole check uses the @code{dig.el} package, but you can tell
25021 @code{spam.el} to use @code{dns.el} instead for better performance if
25022 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
25023 this time to set @code{spam-use-dig} to @code{nil} despite the
25024 possible performance improvements, because some users may be unable to
25025 use it, but you can try it and see if it works for you.
25026
25027 @end defvar
25028
25029 @defvar spam-blackhole-servers
25030
25031 The list of servers to consult for blackhole checks.
25032
25033 @end defvar
25034
25035 @defvar spam-blackhole-good-server-regex
25036
25037 A regular expression for IPs that should not be checked against the
25038 blackhole server list. When set to @code{nil}, it has no effect.
25039
25040 @end defvar
25041
25042 @defvar spam-use-dig
25043
25044 Use the @code{dig.el} package instead of the @code{dns.el} package.
25045 The default setting of @code{t} is recommended.
25046
25047 @end defvar
25048
25049 Blackhole checks are done only on incoming mail. There is no spam or
25050 ham processor for blackholes.
25051
25052 @node Regular Expressions Header Matching
25053 @subsubsection Regular Expressions Header Matching
25054 @cindex spam filtering
25055 @cindex regular expressions header matching, spam filtering
25056 @cindex spam
25057
25058 @defvar spam-use-regex-headers
25059
25060 This option is disabled by default. You can let Gnus check the
25061 message headers against lists of regular expressions when you set this
25062 option. The variables @code{spam-regex-headers-spam} and
25063 @code{spam-regex-headers-ham} hold the list of regular expressions.
25064 Gnus will check against the message headers to determine if the
25065 message is spam or ham, respectively.
25066
25067 @end defvar
25068
25069 @defvar spam-regex-headers-spam
25070
25071 The list of regular expressions that, when matched in the headers of
25072 the message, positively identify it as spam.
25073
25074 @end defvar
25075
25076 @defvar spam-regex-headers-ham
25077
25078 The list of regular expressions that, when matched in the headers of
25079 the message, positively identify it as ham.
25080
25081 @end defvar
25082
25083 Regular expression header checks are done only on incoming mail.
25084 There is no specific spam or ham processor for regular expressions.
25085
25086 @node Bogofilter
25087 @subsubsection Bogofilter
25088 @cindex spam filtering
25089 @cindex bogofilter, spam filtering
25090 @cindex spam
25091
25092 @defvar spam-use-bogofilter
25093
25094 Set this variable if you want @code{spam-split} to use Eric Raymond's
25095 speedy Bogofilter.
25096
25097 With a minimum of care for associating the @samp{$} mark for spam
25098 articles only, Bogofilter training all gets fairly automatic. You
25099 should do this until you get a few hundreds of articles in each
25100 category, spam or not. The command @kbd{S t} in summary mode, either
25101 for debugging or for curiosity, shows the @emph{spamicity} score of
25102 the current article (between 0.0 and 1.0).
25103
25104 Bogofilter determines if a message is spam based on a specific
25105 threshold. That threshold can be customized, consult the Bogofilter
25106 documentation.
25107
25108 If the @code{bogofilter} executable is not in your path, Bogofilter
25109 processing will be turned off.
25110
25111 You should not enable this if you use @code{spam-use-bogofilter-headers}.
25112
25113 @end defvar
25114
25115 @table @kbd
25116 @item M s t
25117 @itemx S t
25118 @kindex M s t
25119 @kindex S t
25120 @findex spam-bogofilter-score
25121 Get the Bogofilter spamicity score (@code{spam-bogofilter-score}).
25122 @end table
25123
25124 @defvar spam-use-bogofilter-headers
25125
25126 Set this variable if you want @code{spam-split} to use Eric Raymond's
25127 speedy Bogofilter, looking only at the message headers. It works
25128 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
25129 must be in the message already. Normally you would do this with a
25130 procmail recipe or something similar; consult the Bogofilter
25131 installation documents for details.
25132
25133 You should not enable this if you use @code{spam-use-bogofilter}.
25134
25135 @end defvar
25136
25137 @defvar gnus-group-spam-exit-processor-bogofilter
25138 Add this symbol to a group's @code{spam-process} parameter by
25139 customizing the group parameters or the
25140 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25141 added to a group's @code{spam-process} parameter, spam-marked articles
25142 will be added to the Bogofilter spam database.
25143
25144 @emph{WARNING}
25145
25146 Instead of the obsolete
25147 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
25148 that you use @code{(spam spam-use-bogofilter)}. Everything will work
25149 the same way, we promise.
25150 @end defvar
25151
25152 @defvar gnus-group-ham-exit-processor-bogofilter
25153 Add this symbol to a group's @code{spam-process} parameter by
25154 customizing the group parameters or the
25155 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25156 added to a group's @code{spam-process} parameter, the ham-marked
25157 articles in @emph{ham} groups will be added to the Bogofilter database
25158 of non-spam messages.
25159
25160 @emph{WARNING}
25161
25162 Instead of the obsolete
25163 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
25164 that you use @code{(ham spam-use-bogofilter)}. Everything will work
25165 the same way, we promise.
25166 @end defvar
25167
25168 @defvar spam-bogofilter-database-directory
25169
25170 This is the directory where Bogofilter will store its databases. It
25171 is not specified by default, so Bogofilter will use its own default
25172 database directory.
25173
25174 @end defvar
25175
25176 The Bogofilter mail classifier is similar to @command{ifile} in intent and
25177 purpose. A ham and a spam processor are provided, plus the
25178 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
25179 variables to indicate to spam-split that Bogofilter should either be
25180 used, or has already been used on the article. The 0.9.2.1 version of
25181 Bogofilter was used to test this functionality.
25182
25183 @node SpamAssassin back end
25184 @subsubsection SpamAssassin back end
25185 @cindex spam filtering
25186 @cindex spamassassin, spam filtering
25187 @cindex spam
25188
25189 @defvar spam-use-spamassassin
25190
25191 Set this variable if you want @code{spam-split} to use SpamAssassin.
25192
25193 SpamAssassin assigns a score to each article based on a set of rules
25194 and tests, including a Bayesian filter. The Bayesian filter can be
25195 trained by associating the @samp{$} mark for spam articles. The
25196 spam score can be viewed by using the command @kbd{S t} in summary
25197 mode.
25198
25199 If you set this variable, each article will be processed by
25200 SpamAssassin when @code{spam-split} is called. If your mail is
25201 preprocessed by SpamAssassin, and you want to just use the
25202 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
25203 instead.
25204
25205 You should not enable this if you use
25206 @code{spam-use-spamassassin-headers}.
25207
25208 @end defvar
25209
25210 @defvar spam-use-spamassassin-headers
25211
25212 Set this variable if your mail is preprocessed by SpamAssassin and
25213 want @code{spam-split} to split based on the SpamAssassin headers.
25214
25215 You should not enable this if you use @code{spam-use-spamassassin}.
25216
25217 @end defvar
25218
25219 @defvar spam-spamassassin-program
25220
25221 This variable points to the SpamAssassin executable. If you have
25222 @code{spamd} running, you can set this variable to the @code{spamc}
25223 executable for faster processing. See the SpamAssassin documentation
25224 for more information on @code{spamd}/@code{spamc}.
25225
25226 @end defvar
25227
25228 SpamAssassin is a powerful and flexible spam filter that uses a wide
25229 variety of tests to identify spam. A ham and a spam processors are
25230 provided, plus the @code{spam-use-spamassassin} and
25231 @code{spam-use-spamassassin-headers} variables to indicate to
25232 spam-split that SpamAssassin should be either used, or has already
25233 been used on the article. The 2.63 version of SpamAssassin was used
25234 to test this functionality.
25235
25236 @node ifile spam filtering
25237 @subsubsection ifile spam filtering
25238 @cindex spam filtering
25239 @cindex ifile, spam filtering
25240 @cindex spam
25241
25242 @defvar spam-use-ifile
25243
25244 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
25245 statistical analyzer similar to Bogofilter.
25246
25247 @end defvar
25248
25249 @defvar spam-ifile-all-categories
25250
25251 Enable this variable if you want @code{spam-use-ifile} to give you all
25252 the ifile categories, not just spam/non-spam. If you use this, make
25253 sure you train ifile as described in its documentation.
25254
25255 @end defvar
25256
25257 @defvar spam-ifile-spam-category
25258
25259 This is the category of spam messages as far as ifile is concerned.
25260 The actual string used is irrelevant, but you probably want to leave
25261 the default value of @samp{spam}.
25262 @end defvar
25263
25264 @defvar spam-ifile-database
25265
25266 This is the filename for the ifile database. It is not specified by
25267 default, so ifile will use its own default database name.
25268
25269 @end defvar
25270
25271 The ifile mail classifier is similar to Bogofilter in intent and
25272 purpose. A ham and a spam processor are provided, plus the
25273 @code{spam-use-ifile} variable to indicate to spam-split that ifile
25274 should be used. The 1.2.1 version of ifile was used to test this
25275 functionality.
25276
25277 @node Spam Statistics Filtering
25278 @subsubsection Spam Statistics Filtering
25279 @cindex spam filtering
25280 @cindex spam-stat, spam filtering
25281 @cindex spam-stat
25282 @cindex spam
25283
25284 This back end uses the Spam Statistics Emacs Lisp package to perform
25285 statistics-based filtering (@pxref{Spam Statistics Package}). Before
25286 using this, you may want to perform some additional steps to
25287 initialize your Spam Statistics dictionary. @xref{Creating a
25288 spam-stat dictionary}.
25289
25290 @defvar spam-use-stat
25291
25292 @end defvar
25293
25294 @defvar gnus-group-spam-exit-processor-stat
25295 Add this symbol to a group's @code{spam-process} parameter by
25296 customizing the group parameters or the
25297 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25298 added to a group's @code{spam-process} parameter, the spam-marked
25299 articles will be added to the spam-stat database of spam messages.
25300
25301 @emph{WARNING}
25302
25303 Instead of the obsolete
25304 @code{gnus-group-spam-exit-processor-stat}, it is recommended
25305 that you use @code{(spam spam-use-stat)}. Everything will work
25306 the same way, we promise.
25307 @end defvar
25308
25309 @defvar gnus-group-ham-exit-processor-stat
25310 Add this symbol to a group's @code{spam-process} parameter by
25311 customizing the group parameters or the
25312 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25313 added to a group's @code{spam-process} parameter, the ham-marked
25314 articles in @emph{ham} groups will be added to the spam-stat database
25315 of non-spam messages.
25316
25317 @emph{WARNING}
25318
25319 Instead of the obsolete
25320 @code{gnus-group-ham-exit-processor-stat}, it is recommended
25321 that you use @code{(ham spam-use-stat)}. Everything will work
25322 the same way, we promise.
25323 @end defvar
25324
25325 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
25326 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
25327 which unlike ifile or Bogofilter does not require external programs.
25328 A spam and a ham processor, and the @code{spam-use-stat} variable for
25329 @code{spam-split} are provided.
25330
25331 @node SpamOracle
25332 @subsubsection Using SpamOracle with Gnus
25333 @cindex spam filtering
25334 @cindex SpamOracle
25335 @cindex spam
25336
25337 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
25338 statistical mail filtering tool written by Xavier Leroy and needs to be
25339 installed separately.
25340
25341 There are several ways to use SpamOracle with Gnus. In all cases, your
25342 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
25343 then enter an @samp{X-Spam} header indicating whether it regards the
25344 mail as a spam mail or not.
25345
25346 One possibility is to run SpamOracle as a @code{:prescript} from the
25347 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
25348 the advantage that the user can see the @emph{X-Spam} headers.
25349
25350 The easiest method is to make @file{spam.el} (@pxref{Spam Package})
25351 call SpamOracle.
25352
25353 @vindex spam-use-spamoracle
25354 To enable SpamOracle usage by @code{spam.el}, set the variable
25355 @code{spam-use-spamoracle} to @code{t} and configure the
25356 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam
25357 Package}. In this example the @samp{INBOX} of an nnimap server is
25358 filtered using SpamOracle. Mails recognized as spam mails will be
25359 moved to @code{spam-split-group}, @samp{Junk} in this case. Ham
25360 messages stay in @samp{INBOX}:
25361
25362 @example
25363 (setq spam-use-spamoracle t
25364 spam-split-group "Junk"
25365 ;; @r{for nnimap you'll probably want to set nnimap-split-methods, see the manual}
25366 nnimap-split-inbox '("INBOX")
25367 nnimap-split-fancy '(| (: spam-split) "INBOX"))
25368 @end example
25369
25370 @defvar spam-use-spamoracle
25371 Set to @code{t} if you want Gnus to enable spam filtering using
25372 SpamOracle.
25373 @end defvar
25374
25375 @defvar spam-spamoracle-binary
25376 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
25377 user's PATH@. Using the variable @code{spam-spamoracle-binary}, this
25378 can be customized.
25379 @end defvar
25380
25381 @defvar spam-spamoracle-database
25382 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
25383 store its analysis. This is controlled by the variable
25384 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
25385 the default SpamOracle database will be used. In case you want your
25386 database to live somewhere special, set
25387 @code{spam-spamoracle-database} to this path.
25388 @end defvar
25389
25390 SpamOracle employs a statistical algorithm to determine whether a
25391 message is spam or ham. In order to get good results, meaning few
25392 false hits or misses, SpamOracle needs training. SpamOracle learns
25393 the characteristics of your spam mails. Using the @emph{add} mode
25394 (training mode) one has to feed good (ham) and spam mails to
25395 SpamOracle. This can be done by pressing @kbd{|} in the Summary
25396 buffer and pipe the mail to a SpamOracle process or using
25397 @file{spam.el}'s spam- and ham-processors, which is much more
25398 convenient. For a detailed description of spam- and ham-processors,
25399 @xref{Spam Package}.
25400
25401 @defvar gnus-group-spam-exit-processor-spamoracle
25402 Add this symbol to a group's @code{spam-process} parameter by
25403 customizing the group parameter or the
25404 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25405 to a group's @code{spam-process} parameter, spam-marked articles will be
25406 sent to SpamOracle as spam samples.
25407
25408 @emph{WARNING}
25409
25410 Instead of the obsolete
25411 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
25412 that you use @code{(spam spam-use-spamoracle)}. Everything will work
25413 the same way, we promise.
25414 @end defvar
25415
25416 @defvar gnus-group-ham-exit-processor-spamoracle
25417 Add this symbol to a group's @code{spam-process} parameter by
25418 customizing the group parameter or the
25419 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25420 to a group's @code{spam-process} parameter, the ham-marked articles in
25421 @emph{ham} groups will be sent to the SpamOracle as samples of ham
25422 messages.
25423
25424 @emph{WARNING}
25425
25426 Instead of the obsolete
25427 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
25428 that you use @code{(ham spam-use-spamoracle)}. Everything will work
25429 the same way, we promise.
25430 @end defvar
25431
25432 @emph{Example:} These are the Group Parameters of a group that has been
25433 classified as a ham group, meaning that it should only contain ham
25434 messages.
25435 @example
25436 ((spam-contents gnus-group-spam-classification-ham)
25437 (spam-process ((ham spam-use-spamoracle)
25438 (spam spam-use-spamoracle))))
25439 @end example
25440 For this group the @code{spam-use-spamoracle} is installed for both
25441 ham and spam processing. If the group contains spam message
25442 (e.g., because SpamOracle has not had enough sample messages yet) and
25443 the user marks some messages as spam messages, these messages will be
25444 processed by SpamOracle. The processor sends the messages to
25445 SpamOracle as new samples for spam.
25446
25447 @node Extending the Spam package
25448 @subsection Extending the Spam package
25449 @cindex spam filtering
25450 @cindex spam elisp package, extending
25451 @cindex extending the spam elisp package
25452
25453 Say you want to add a new back end called blackbox. For filtering
25454 incoming mail, provide the following:
25455
25456 @enumerate
25457
25458 @item
25459 Code
25460
25461 @lisp
25462 (defvar spam-use-blackbox nil
25463 "True if blackbox should be used.")
25464 @end lisp
25465
25466 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
25467
25468 Write @code{spam-blackbox-register-routine} and
25469 @code{spam-blackbox-unregister-routine} using the bogofilter
25470 register/unregister routines as a start, or other register/unregister
25471 routines more appropriate to Blackbox, if Blackbox can
25472 register/unregister spam and ham.
25473
25474 @item
25475 Functionality
25476
25477 The @code{spam-check-blackbox} function should return @samp{nil} or
25478 @code{spam-split-group}, observing the other conventions. See the
25479 existing @code{spam-check-*} functions for examples of what you can
25480 do, and stick to the template unless you fully understand the reasons
25481 why you aren't.
25482
25483 @end enumerate
25484
25485 For processing spam and ham messages, provide the following:
25486
25487 @enumerate
25488
25489 @item
25490 Code
25491
25492 Note you don't have to provide a spam or a ham processor. Only
25493 provide them if Blackbox supports spam or ham processing.
25494
25495 Also, ham and spam processors are being phased out as single
25496 variables. Instead the form @code{(spam spam-use-blackbox)} or
25497 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
25498 processor variables are still around but they won't be for long.
25499
25500 @lisp
25501 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
25502 "The Blackbox summary exit spam processor.
25503 Only applicable to spam groups.")
25504
25505 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
25506 "The whitelist summary exit ham processor.
25507 Only applicable to non-spam (unclassified and ham) groups.")
25508
25509 @end lisp
25510
25511 @item
25512 Gnus parameters
25513
25514 Add
25515 @lisp
25516 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
25517 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
25518 @end lisp
25519 to the @code{spam-process} group parameter in @code{gnus.el}. Make
25520 sure you do it twice, once for the parameter and once for the
25521 variable customization.
25522
25523 Add
25524 @lisp
25525 (variable-item spam-use-blackbox)
25526 @end lisp
25527 to the @code{spam-autodetect-methods} group parameter in
25528 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
25529
25530 Finally, use the appropriate @code{spam-install-*-backend} function in
25531 @code{spam.el}. Here are the available functions.
25532
25533
25534 @enumerate
25535
25536 @item
25537 @code{spam-install-backend-alias}
25538
25539 This function will simply install an alias for a back end that does
25540 everything like the original back end. It is currently only used to
25541 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
25542
25543 @item
25544 @code{spam-install-nocheck-backend}
25545
25546 This function installs a back end that has no check function, but can
25547 register/unregister ham or spam. The @code{spam-use-gmane} back end is
25548 such a back end.
25549
25550 @item
25551 @code{spam-install-checkonly-backend}
25552
25553 This function will install a back end that can only check incoming mail
25554 for spam contents. It can't register or unregister messages.
25555 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
25556 back ends.
25557
25558 @item
25559 @code{spam-install-statistical-checkonly-backend}
25560
25561 This function installs a statistical back end (one which requires the
25562 full body of a message to check it) that can only check incoming mail
25563 for contents. @code{spam-use-regex-body} is such a filter.
25564
25565 @item
25566 @code{spam-install-statistical-backend}
25567
25568 This function install a statistical back end with incoming checks and
25569 registration/unregistration routines. @code{spam-use-bogofilter} is
25570 set up this way.
25571
25572 @item
25573 @code{spam-install-backend}
25574
25575 This is the most normal back end installation, where a back end that can
25576 check and register/unregister messages is set up without statistical
25577 abilities. The @code{spam-use-BBDB} is such a back end.
25578
25579 @item
25580 @code{spam-install-mover-backend}
25581
25582 Mover back ends are internal to @code{spam.el} and specifically move
25583 articles around when the summary is exited. You will very probably
25584 never install such a back end.
25585 @end enumerate
25586
25587 @end enumerate
25588
25589 @node Spam Statistics Package
25590 @subsection Spam Statistics Package
25591 @cindex Paul Graham
25592 @cindex Graham, Paul
25593 @cindex naive Bayesian spam filtering
25594 @cindex Bayesian spam filtering, naive
25595 @cindex spam filtering, naive Bayesian
25596
25597 Paul Graham has written an excellent essay about spam filtering using
25598 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
25599 Spam}. In it he describes the inherent deficiency of rule-based
25600 filtering as used by SpamAssassin, for example: Somebody has to write
25601 the rules, and everybody else has to install these rules. You are
25602 always late. It would be much better, he argues, to filter mail based
25603 on whether it somehow resembles spam or non-spam. One way to measure
25604 this is word distribution. He then goes on to describe a solution
25605 that checks whether a new mail resembles any of your other spam mails
25606 or not.
25607
25608 The basic idea is this: Create a two collections of your mail, one
25609 with spam, one with non-spam. Count how often each word appears in
25610 either collection, weight this by the total number of mails in the
25611 collections, and store this information in a dictionary. For every
25612 word in a new mail, determine its probability to belong to a spam or a
25613 non-spam mail. Use the 15 most conspicuous words, compute the total
25614 probability of the mail being spam. If this probability is higher
25615 than a certain threshold, the mail is considered to be spam.
25616
25617 The Spam Statistics package adds support to Gnus for this kind of
25618 filtering. It can be used as one of the back ends of the Spam package
25619 (@pxref{Spam Package}), or by itself.
25620
25621 Before using the Spam Statistics package, you need to set it up.
25622 First, you need two collections of your mail, one with spam, one with
25623 non-spam. Then you need to create a dictionary using these two
25624 collections, and save it. And last but not least, you need to use
25625 this dictionary in your fancy mail splitting rules.
25626
25627 @menu
25628 * Creating a spam-stat dictionary::
25629 * Splitting mail using spam-stat::
25630 * Low-level interface to the spam-stat dictionary::
25631 @end menu
25632
25633 @node Creating a spam-stat dictionary
25634 @subsubsection Creating a spam-stat dictionary
25635
25636 Before you can begin to filter spam based on statistics, you must
25637 create these statistics based on two mail collections, one with spam,
25638 one with non-spam. These statistics are then stored in a dictionary
25639 for later use. In order for these statistics to be meaningful, you
25640 need several hundred emails in both collections.
25641
25642 Gnus currently supports only the nnml back end for automated dictionary
25643 creation. The nnml back end stores all mails in a directory, one file
25644 per mail. Use the following:
25645
25646 @defun spam-stat-process-spam-directory
25647 Create spam statistics for every file in this directory. Every file
25648 is treated as one spam mail.
25649 @end defun
25650
25651 @defun spam-stat-process-non-spam-directory
25652 Create non-spam statistics for every file in this directory. Every
25653 file is treated as one non-spam mail.
25654 @end defun
25655
25656 Usually you would call @code{spam-stat-process-spam-directory} on a
25657 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
25658 the group @samp{nnml:mail.spam}), and you would call
25659 @code{spam-stat-process-non-spam-directory} on a directory such as
25660 @file{~/Mail/mail/misc} (this usually corresponds to the group
25661 @samp{nnml:mail.misc}).
25662
25663 When you are using @acronym{IMAP}, you won't have the mails available
25664 locally, so that will not work. One solution is to use the Gnus Agent
25665 to cache the articles. Then you can use directories such as
25666 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
25667 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
25668
25669 @defvar spam-stat
25670 This variable holds the hash-table with all the statistics---the
25671 dictionary we have been talking about. For every word in either
25672 collection, this hash-table stores a vector describing how often the
25673 word appeared in spam and often it appeared in non-spam mails.
25674 @end defvar
25675
25676 If you want to regenerate the statistics from scratch, you need to
25677 reset the dictionary.
25678
25679 @defun spam-stat-reset
25680 Reset the @code{spam-stat} hash-table, deleting all the statistics.
25681 @end defun
25682
25683 When you are done, you must save the dictionary. The dictionary may
25684 be rather large. If you will not update the dictionary incrementally
25685 (instead, you will recreate it once a month, for example), then you
25686 can reduce the size of the dictionary by deleting all words that did
25687 not appear often enough or that do not clearly belong to only spam or
25688 only non-spam mails.
25689
25690 @defun spam-stat-reduce-size
25691 Reduce the size of the dictionary. Use this only if you do not want
25692 to update the dictionary incrementally.
25693 @end defun
25694
25695 @defun spam-stat-save
25696 Save the dictionary.
25697 @end defun
25698
25699 @defvar spam-stat-file
25700 The filename used to store the dictionary. This defaults to
25701 @file{~/.spam-stat.el}.
25702 @end defvar
25703
25704 @node Splitting mail using spam-stat
25705 @subsubsection Splitting mail using spam-stat
25706
25707 This section describes how to use the Spam statistics
25708 @emph{independently} of the @xref{Spam Package}.
25709
25710 First, add the following to your @file{~/.gnus.el} file:
25711
25712 @lisp
25713 (require 'spam-stat)
25714 (spam-stat-load)
25715 @end lisp
25716
25717 This will load the necessary Gnus code, and the dictionary you
25718 created.
25719
25720 Next, you need to adapt your fancy splitting rules: You need to
25721 determine how to use @code{spam-stat}. The following examples are for
25722 the nnml back end. Using the nnimap back end works just as well. Just
25723 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
25724
25725 In the simplest case, you only have two groups, @samp{mail.misc} and
25726 @samp{mail.spam}. The following expression says that mail is either
25727 spam or it should go into @samp{mail.misc}. If it is spam, then
25728 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
25729
25730 @lisp
25731 (setq nnmail-split-fancy
25732 `(| (: spam-stat-split-fancy)
25733 "mail.misc"))
25734 @end lisp
25735
25736 @defvar spam-stat-split-fancy-spam-group
25737 The group to use for spam. Default is @samp{mail.spam}.
25738 @end defvar
25739
25740 If you also filter mail with specific subjects into other groups, use
25741 the following expression. Only mails not matching the regular
25742 expression are considered potential spam.
25743
25744 @lisp
25745 (setq nnmail-split-fancy
25746 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
25747 (: spam-stat-split-fancy)
25748 "mail.misc"))
25749 @end lisp
25750
25751 If you want to filter for spam first, then you must be careful when
25752 creating the dictionary. Note that @code{spam-stat-split-fancy} must
25753 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
25754 non-spam, therefore both should be in your collection of non-spam
25755 mails, when creating the dictionary!
25756
25757 @lisp
25758 (setq nnmail-split-fancy
25759 `(| (: spam-stat-split-fancy)
25760 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25761 "mail.misc"))
25762 @end lisp
25763
25764 You can combine this with traditional filtering. Here, we move all
25765 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
25766 @code{spam-stat-split-fancy} will never see them, the mails in
25767 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
25768 nor in your collection of non-spam mails, when creating the
25769 dictionary!
25770
25771 @lisp
25772 (setq nnmail-split-fancy
25773 `(| ("Content-Type" "text/html" "mail.spam.filtered")
25774 (: spam-stat-split-fancy)
25775 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25776 "mail.misc"))
25777 @end lisp
25778
25779
25780 @node Low-level interface to the spam-stat dictionary
25781 @subsubsection Low-level interface to the spam-stat dictionary
25782
25783 The main interface to using @code{spam-stat}, are the following functions:
25784
25785 @defun spam-stat-buffer-is-spam
25786 Called in a buffer, that buffer is considered to be a new spam mail.
25787 Use this for new mail that has not been processed before.
25788 @end defun
25789
25790 @defun spam-stat-buffer-is-no-spam
25791 Called in a buffer, that buffer is considered to be a new non-spam
25792 mail. Use this for new mail that has not been processed before.
25793 @end defun
25794
25795 @defun spam-stat-buffer-change-to-spam
25796 Called in a buffer, that buffer is no longer considered to be normal
25797 mail but spam. Use this to change the status of a mail that has
25798 already been processed as non-spam.
25799 @end defun
25800
25801 @defun spam-stat-buffer-change-to-non-spam
25802 Called in a buffer, that buffer is no longer considered to be spam but
25803 normal mail. Use this to change the status of a mail that has already
25804 been processed as spam.
25805 @end defun
25806
25807 @defun spam-stat-save
25808 Save the hash table to the file. The filename used is stored in the
25809 variable @code{spam-stat-file}.
25810 @end defun
25811
25812 @defun spam-stat-load
25813 Load the hash table from a file. The filename used is stored in the
25814 variable @code{spam-stat-file}.
25815 @end defun
25816
25817 @defun spam-stat-score-word
25818 Return the spam score for a word.
25819 @end defun
25820
25821 @defun spam-stat-score-buffer
25822 Return the spam score for a buffer.
25823 @end defun
25824
25825 @defun spam-stat-split-fancy
25826 Use this function for fancy mail splitting. Add the rule @samp{(:
25827 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
25828 @end defun
25829
25830 Make sure you load the dictionary before using it. This requires the
25831 following in your @file{~/.gnus.el} file:
25832
25833 @lisp
25834 (require 'spam-stat)
25835 (spam-stat-load)
25836 @end lisp
25837
25838 Typical test will involve calls to the following functions:
25839
25840 @smallexample
25841 Reset: (setq spam-stat (make-hash-table :test 'equal))
25842 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25843 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25844 Save table: (spam-stat-save)
25845 File size: (nth 7 (file-attributes spam-stat-file))
25846 Number of words: (hash-table-count spam-stat)
25847 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25848 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25849 Reduce table size: (spam-stat-reduce-size)
25850 Save table: (spam-stat-save)
25851 File size: (nth 7 (file-attributes spam-stat-file))
25852 Number of words: (hash-table-count spam-stat)
25853 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25854 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25855 @end smallexample
25856
25857 Here is how you would create your dictionary:
25858
25859 @smallexample
25860 Reset: (setq spam-stat (make-hash-table :test 'equal))
25861 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25862 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25863 Repeat for any other non-spam group you need...
25864 Reduce table size: (spam-stat-reduce-size)
25865 Save table: (spam-stat-save)
25866 @end smallexample
25867
25868 @node The Gnus Registry
25869 @section The Gnus Registry
25870 @cindex registry
25871 @cindex split
25872 @cindex track
25873
25874 The Gnus registry is a package that tracks messages by their
25875 Message-ID across all backends. This allows Gnus users to do several
25876 cool things, be the envy of the locals, get free haircuts, and be
25877 experts on world issues. Well, maybe not all of those, but the
25878 features are pretty cool.
25879
25880 Although they will be explained in detail shortly, here's a quick list
25881 of said features in case your attention span is... never mind.
25882
25883 @enumerate
25884 @item
25885 Split messages to their parent
25886
25887 This keeps discussions in the same group. You can use the subject and
25888 the sender in addition to the Message-ID@. Several strategies are
25889 available.
25890
25891 @item
25892 Refer to messages by ID
25893
25894 Commands like @code{gnus-summary-refer-parent-article} can take
25895 advantage of the registry to jump to the referred article, regardless
25896 of the group the message is in.
25897
25898 @item
25899 Store custom flags and keywords
25900
25901 The registry can store custom flags and keywords for a message. For
25902 instance, you can mark a message ``To-Do'' this way and the flag will
25903 persist whether the message is in the nnimap, nnml, nnmaildir,
25904 etc. backends.
25905
25906 @item
25907 Store arbitrary data
25908
25909 Through a simple ELisp API, the registry can remember any data for a
25910 message. A built-in inverse map, when activated, allows quick lookups
25911 of all messages matching a particular set of criteria.
25912 @end enumerate
25913
25914 @menu
25915 * Gnus Registry Setup::
25916 * Registry Article Refer Method::
25917 * Fancy splitting to parent::
25918 * Store custom flags and keywords::
25919 * Store arbitrary data::
25920 @end menu
25921
25922 @node Gnus Registry Setup
25923 @subsection Gnus Registry Setup
25924
25925 Fortunately, setting up the Gnus registry is pretty easy:
25926
25927 @lisp
25928 (setq gnus-registry-max-entries 2500)
25929
25930 (gnus-registry-initialize)
25931 @end lisp
25932
25933 This adds registry saves to Gnus newsrc saves (which happen on exit
25934 and when you press @kbd{s} from the @file{*Group*} buffer. It also
25935 adds registry calls to article actions in Gnus (copy, move, etc.)@: so
25936 it's not easy to undo the initialization. See
25937 @code{gnus-registry-initialize} for the gory details.
25938
25939 Here are other settings used by the author of the registry (understand
25940 what they do before you copy them blindly).
25941
25942 @lisp
25943 (setq
25944 gnus-registry-split-strategy 'majority
25945 gnus-registry-ignored-groups '(("nntp" t)
25946 ("nnrss" t)
25947 ("spam" t)
25948 ("train" t))
25949 gnus-registry-max-entries 500000
25950 ;; this is the default
25951 gnus-registry-track-extra '(sender subject))
25952 @end lisp
25953
25954 They say: keep a lot of messages around, track messages by sender and
25955 subject (not just parent Message-ID), and when the registry splits
25956 incoming mail, use a majority rule to decide where messages should go
25957 if there's more than one possibility. In addition, the registry
25958 should ignore messages in groups that match ``nntp'', ``nnrss'',
25959 ``spam'', or ``train.''
25960
25961 You are doubtless impressed by all this, but you ask: ``I am a Gnus
25962 user, I customize to live. Give me more.'' Here you go, these are
25963 the general settings.
25964
25965 @defvar gnus-registry-unfollowed-groups
25966 The groups that will not be followed by
25967 @code{gnus-registry-split-fancy-with-parent}. They will still be
25968 remembered by the registry. This is a list of regular expressions.
25969 By default any group name that ends with ``delayed'', ``drafts'',
25970 ``queue'', or ``INBOX'', belongs to the nnmairix backend, or contains
25971 the word ``archive'' is not followed.
25972 @end defvar
25973
25974 @defvar gnus-registry-max-entries
25975 The number (an integer or @code{nil} for unlimited) of entries the
25976 registry will keep.
25977 @end defvar
25978
25979 @defvar gnus-registry-max-pruned-entries
25980 The maximum number (an integer or @code{nil} for unlimited) of entries
25981 the registry will keep after pruning.
25982 @end defvar
25983
25984 @defvar gnus-registry-cache-file
25985 The file where the registry will be stored between Gnus sessions. By
25986 default the file name is @code{.gnus.registry.eioio} in the same
25987 directory as your @code{.newsrc.eld}.
25988 @end defvar
25989
25990 @node Registry Article Refer Method
25991 @subsection Fetching by @code{Message-ID} Using the Registry
25992
25993 The registry knows how to map each @code{Message-ID} to the group it's
25994 in. This can be leveraged to enhance the ``article refer method'',
25995 the thing that tells Gnus how to look up an article given its
25996 Message-ID (@pxref{Finding the Parent}).
25997
25998 @vindex nnregistry
25999 @vindex gnus-refer-article-method
26000
26001 The @code{nnregistry} refer method does exactly that. It has the
26002 advantage that an article may be found regardless of the group it's
26003 in---provided its @code{Message-ID} is known to the registry. It can
26004 be enabled by augmenting the start-up file with something along these
26005 lines:
26006
26007 @example
26008 ;; Keep enough entries to have a good hit rate when referring to an
26009 ;; article using the registry. Use long group names so that Gnus
26010 ;; knows where the article is.
26011 (setq gnus-registry-max-entries 2500)
26012
26013 (gnus-registry-initialize)
26014
26015 (setq gnus-refer-article-method
26016 '(current
26017 (nnregistry)
26018 (nnweb "gmane" (nnweb-type gmane))))
26019 @end example
26020
26021 The example above instructs Gnus to first look up the article in the
26022 current group, or, alternatively, using the registry, and finally, if
26023 all else fails, using Gmane.
26024
26025 @node Fancy splitting to parent
26026 @subsection Fancy splitting to parent
26027
26028 Simply put, this lets you put followup e-mail where it belongs.
26029
26030 Every message has a Message-ID, which is unique, and the registry
26031 remembers it. When the message is moved or copied, the registry will
26032 notice this and offer the new group as a choice to the splitting
26033 strategy.
26034
26035 When a followup is made, usually it mentions the original message's
26036 Message-ID in the headers. The registry knows this and uses that
26037 mention to find the group where the original message lives. You only
26038 have to put a rule like this:
26039
26040 @lisp
26041 (setq nnimap-my-split-fancy '(|
26042
26043 ;; split to parent: you need this
26044 (: gnus-registry-split-fancy-with-parent)
26045
26046 ;; other rules, as an example
26047 (: spam-split)
26048 ;; default mailbox
26049 "mail")
26050 @end lisp
26051
26052 in your fancy split setup. In addition, you may want to customize the
26053 following variables.
26054
26055 @defvar gnus-registry-track-extra
26056 This is a list of symbols, so it's best to change it from the
26057 Customize interface. By default it's @code{(subject sender recipient)},
26058 which may work for you. It can be annoying if your mail flow is large
26059 and people don't stick to the same groups.
26060
26061 When you decide to stop tracking any of those extra data, you can use
26062 the command @code{gnus-registry-remove-extra-data} to purge it from
26063 the existing registry entries.
26064 @end defvar
26065
26066 @defvar gnus-registry-split-strategy
26067 This is a symbol, so it's best to change it from the Customize
26068 interface. By default it's @code{nil}, but you may want to set it to
26069 @code{majority} or @code{first} to split by sender or subject based on
26070 the majority of matches or on the first found. I find @code{majority}
26071 works best.
26072 @end defvar
26073
26074 @node Store custom flags and keywords
26075 @subsection Store custom flags and keywords
26076
26077 The registry lets you set custom flags and keywords per message. You
26078 can use the Gnus->Registry Marks menu or the @kbd{M M x} keyboard
26079 shortcuts, where @code{x} is the first letter of the mark's name.
26080
26081 @defvar gnus-registry-marks
26082 The custom marks that the registry can use. You can modify the
26083 default list, if you like. If you do, you'll have to exit Emacs
26084 before they take effect (you can also unload the registry and reload
26085 it or evaluate the specific macros you'll need, but you probably don't
26086 want to bother). Use the Customize interface to modify the list.
26087
26088 By default this list has the @code{Important}, @code{Work},
26089 @code{Personal}, @code{To-Do}, and @code{Later} marks. They all have
26090 keyboard shortcuts like @kbd{M M i} for Important, using the first
26091 letter.
26092 @end defvar
26093
26094 @defun gnus-registry-mark-article
26095 Call this function to mark an article with a custom registry mark. It
26096 will offer the available marks for completion.
26097 @end defun
26098
26099 You can use @code{defalias} to install a summary line formatting
26100 function that will show the registry marks. There are two flavors of
26101 this function, either showing the marks as single characters, using
26102 their @code{:char} property, or showing the marks as full strings.
26103
26104 @lisp
26105 ;; show the marks as single characters (see the :char property in
26106 ;; `gnus-registry-marks'):
26107 ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-chars)
26108
26109 ;; show the marks by name (see `gnus-registry-marks'):
26110 ;; (defalias 'gnus-user-format-function-M 'gnus-registry-article-marks-to-names)
26111 @end lisp
26112
26113
26114 @node Store arbitrary data
26115 @subsection Store arbitrary data
26116
26117 The registry has a simple API that uses a Message-ID as the key to
26118 store arbitrary data (as long as it can be converted to a list for
26119 storage).
26120
26121 @defun gnus-registry-set-id-key (id key value)
26122 Store @code{value} under @code{key} for message @code{id}.
26123 @end defun
26124
26125 @defun gnus-registry-get-id-key (id key)
26126 Get the data under @code{key} for message @code{id}.
26127 @end defun
26128
26129 @defvar gnus-registry-extra-entries-precious
26130 If any extra entries are precious, their presence will make the
26131 registry keep the whole entry forever, even if there are no groups for
26132 the Message-ID and if the size limit of the registry is reached. By
26133 default this is just @code{(marks)} so the custom registry marks are
26134 precious.
26135 @end defvar
26136
26137 @node Other modes
26138 @section Interaction with other modes
26139
26140 @subsection Dired
26141 @cindex dired
26142
26143 @code{gnus-dired-minor-mode} provides some useful functions for dired
26144 buffers. It is enabled with
26145 @lisp
26146 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
26147 @end lisp
26148
26149 @table @kbd
26150 @item C-c C-m C-a
26151 @findex gnus-dired-attach
26152 @cindex attachments, selection via dired
26153 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
26154 You will be prompted for a message buffer.
26155
26156 @item C-c C-m C-l
26157 @findex gnus-dired-find-file-mailcap
26158 Visit a file according to the appropriate mailcap entry
26159 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
26160 buffer.
26161
26162 @item C-c C-m C-p
26163 @findex gnus-dired-print
26164 Print file according to the mailcap entry (@code{gnus-dired-print}). If
26165 there is no print command, print in a PostScript image.
26166 @end table
26167
26168 @node Various Various
26169 @section Various Various
26170 @cindex mode lines
26171 @cindex highlights
26172
26173 @table @code
26174
26175 @item gnus-home-directory
26176 @vindex gnus-home-directory
26177 All Gnus file and directory variables will be initialized from this
26178 variable, which defaults to @file{~/}.
26179
26180 @item gnus-directory
26181 @vindex gnus-directory
26182 Most Gnus storage file and directory variables will be initialized from
26183 this variable, which defaults to the @env{SAVEDIR} environment
26184 variable, or @file{~/News/} if that variable isn't set.
26185
26186 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
26187 This means that other directory variables that are initialized from this
26188 variable won't be set properly if you set this variable in
26189 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
26190
26191 @item gnus-default-directory
26192 @vindex gnus-default-directory
26193 Not related to the above variable at all---this variable says what the
26194 default directory of all Gnus buffers should be. If you issue commands
26195 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
26196 default directory. If this variable is @code{nil} (which is the
26197 default), the default directory will be the default directory of the
26198 buffer you were in when you started Gnus.
26199
26200 @item gnus-verbose
26201 @vindex gnus-verbose
26202 This variable is an integer between zero and ten. The higher the value,
26203 the more messages will be displayed. If this variable is zero, Gnus
26204 will never flash any messages, if it is seven (which is the default),
26205 most important messages will be shown, and if it is ten, Gnus won't ever
26206 shut up, but will flash so many messages it will make your head swim.
26207
26208 @item gnus-verbose-backends
26209 @vindex gnus-verbose-backends
26210 This variable works the same way as @code{gnus-verbose}, but it applies
26211 to the Gnus back ends instead of Gnus proper.
26212
26213 @item gnus-add-timestamp-to-message
26214 @vindex gnus-add-timestamp-to-message
26215 This variable controls whether to add timestamps to messages that are
26216 controlled by @code{gnus-verbose} and @code{gnus-verbose-backends} and
26217 are issued. The default value is @code{nil} which means never to add
26218 timestamp. If it is @code{log}, add timestamps to only the messages
26219 that go into the @file{*Messages*} buffer (in XEmacs, it is the
26220 @w{@file{ *Message-Log*}} buffer). If it is neither @code{nil} nor
26221 @code{log}, add timestamps not only to log messages but also to the ones
26222 displayed in the echo area.
26223
26224 @item nnheader-max-head-length
26225 @vindex nnheader-max-head-length
26226 When the back ends read straight heads of articles, they all try to read
26227 as little as possible. This variable (default 8192) specifies
26228 the absolute max length the back ends will try to read before giving up
26229 on finding a separator line between the head and the body. If this
26230 variable is @code{nil}, there is no upper read bound. If it is
26231 @code{t}, the back ends won't try to read the articles piece by piece,
26232 but read the entire articles. This makes sense with some versions of
26233 @code{ange-ftp} or @code{efs}.
26234
26235 @item nnheader-head-chop-length
26236 @vindex nnheader-head-chop-length
26237 This variable (default 2048) says how big a piece of each article to
26238 read when doing the operation described above.
26239
26240 @item nnheader-file-name-translation-alist
26241 @vindex nnheader-file-name-translation-alist
26242 @cindex file names
26243 @cindex invalid characters in file names
26244 @cindex characters in file names
26245 This is an alist that says how to translate characters in file names.
26246 For instance, if @samp{:} is invalid as a file character in file names
26247 on your system (you OS/2 user you), you could say something like:
26248
26249 @lisp
26250 @group
26251 (setq nnheader-file-name-translation-alist
26252 '((?: . ?_)))
26253 @end group
26254 @end lisp
26255
26256 In fact, this is the default value for this variable on OS/2 and MS
26257 Windows (phooey) systems.
26258
26259 @item gnus-hidden-properties
26260 @vindex gnus-hidden-properties
26261 This is a list of properties to use to hide ``invisible'' text. It is
26262 @code{(invisible t intangible t)} by default on most systems, which
26263 makes invisible text invisible and intangible.
26264
26265 @item gnus-parse-headers-hook
26266 @vindex gnus-parse-headers-hook
26267 A hook called before parsing headers. It can be used, for instance, to
26268 gather statistics on the headers fetched, or perhaps you'd like to prune
26269 some headers. I don't see why you'd want that, though.
26270
26271 @item gnus-shell-command-separator
26272 @vindex gnus-shell-command-separator
26273 String used to separate two shell commands. The default is @samp{;}.
26274
26275 @item gnus-invalid-group-regexp
26276 @vindex gnus-invalid-group-regexp
26277
26278 Regexp to match ``invalid'' group names when querying user for a group
26279 name. The default value catches some @strong{really} invalid group
26280 names who could possibly mess up Gnus internally (like allowing
26281 @samp{:} in a group name, which is normally used to delimit method and
26282 group).
26283
26284 @acronym{IMAP} users might want to allow @samp{/} in group names though.
26285
26286 @item gnus-safe-html-newsgroups
26287 @vindex gnus-safe-html-newsgroups
26288 Groups in which links in html articles are considered all safe. The
26289 value may be a regexp matching those groups, a list of group names, or
26290 @code{nil}. This overrides @code{mm-w3m-safe-url-regexp}. The default
26291 value is @code{"\\`nnrss[+:]"}. This is effective only when emacs-w3m
26292 renders html articles, i.e., in the case @code{mm-text-html-renderer} is
26293 set to @code{w3m}. @xref{Display Customization, ,Display Customization,
26294 emacs-mime, The Emacs MIME Manual}.
26295
26296 @end table
26297
26298 @node The End
26299 @chapter The End
26300
26301 Well, that's the manual---you can get on with your life now. Keep in
26302 touch. Say hello to your cats from me.
26303
26304 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
26305
26306 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
26307
26308 @quotation
26309 @strong{Te Deum}
26310
26311 @sp 1
26312 Not because of victories @*
26313 I sing,@*
26314 having none,@*
26315 but for the common sunshine,@*
26316 the breeze,@*
26317 the largess of the spring.
26318
26319 @sp 1
26320 Not for victory@*
26321 but for the day's work done@*
26322 as well as I was able;@*
26323 not for a seat upon the dais@*
26324 but at the common table.@*
26325 @end quotation
26326
26327
26328 @node Appendices
26329 @chapter Appendices
26330
26331 @menu
26332 * XEmacs:: Requirements for installing under XEmacs.
26333 * History:: How Gnus got where it is today.
26334 * On Writing Manuals:: Why this is not a beginner's guide.
26335 * Terminology:: We use really difficult, like, words here.
26336 * Customization:: Tailoring Gnus to your needs.
26337 * Troubleshooting:: What you might try if things do not work.
26338 * Gnus Reference Guide:: Rilly, rilly technical stuff.
26339 * Emacs for Heathens:: A short introduction to Emacsian terms.
26340 * Frequently Asked Questions:: The Gnus FAQ
26341 @end menu
26342
26343
26344 @node XEmacs
26345 @section XEmacs
26346 @cindex XEmacs
26347 @cindex installing under XEmacs
26348
26349 XEmacs is distributed as a collection of packages. You should install
26350 whatever packages the Gnus XEmacs package requires. The current
26351 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
26352 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
26353 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
26354 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
26355
26356
26357 @node History
26358 @section History
26359
26360 @cindex history
26361 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
26362 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
26363
26364 If you want to investigate the person responsible for this outrage,
26365 you can point your (feh!) web browser to
26366 @uref{http://quimby.gnus.org/}. This is also the primary
26367 distribution point for the new and spiffy versions of Gnus, and is
26368 known as The Site That Destroys Newsrcs And Drives People Mad.
26369
26370 During the first extended alpha period of development, the new Gnus was
26371 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
26372 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
26373 (Besides, the ``Gnus'' in this abbreviation should probably be
26374 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
26375 appropriate name, don't you think?)
26376
26377 In any case, after spending all that energy on coming up with a new and
26378 spunky name, we decided that the name was @emph{too} spunky, so we
26379 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
26380 ``@sc{gnus}''. New vs. old.
26381
26382 @menu
26383 * Gnus Versions:: What Gnus versions have been released.
26384 * Why?:: What's the point of Gnus?
26385 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
26386 * Conformity:: Gnus tries to conform to all standards.
26387 * Emacsen:: Gnus can be run on a few modern Emacsen.
26388 * Gnus Development:: How Gnus is developed.
26389 * Contributors:: Oodles of people.
26390 * New Features:: Pointers to some of the new stuff in Gnus.
26391 @end menu
26392
26393
26394 @node Gnus Versions
26395 @subsection Gnus Versions
26396 @cindex ding Gnus
26397 @cindex September Gnus
26398 @cindex Red Gnus
26399 @cindex Quassia Gnus
26400 @cindex Pterodactyl Gnus
26401 @cindex Oort Gnus
26402 @cindex No Gnus
26403 @cindex Ma Gnus
26404 @cindex Gnus versions
26405
26406 The first ``proper'' release of Gnus 5 was done in November 1995 when it
26407 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
26408 plus 15 Gnus 5.0 releases).
26409
26410 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
26411 releases)) was released under the name ``Gnus 5.2'' (40 releases).
26412
26413 On July 28th 1996 work on Red Gnus was begun, and it was released on
26414 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
26415
26416 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
26417 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
26418
26419 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
26420 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
26421 1999.
26422
26423 On the 26th of October 2000, Oort Gnus was begun and was released as
26424 Gnus 5.10 on May 1st 2003 (24 releases).
26425
26426 On the January 4th 2004, No Gnus was begun.
26427
26428 On April 19, 2010 Gnus development was moved to Git. See
26429 http://git.gnus.org for details (http://www.gnus.org will be updated
26430 with the information when possible).
26431
26432 On the January 31th 2012, Ma Gnus was begun.
26433
26434 If you happen upon a version of Gnus that has a prefixed name---``(ding)
26435 Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
26436 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'', ``Ma Gnus''---don't
26437 panic. Don't let it know that you're frightened. Back away. Slowly.
26438 Whatever you do, don't run. Walk away, calmly, until you're out of
26439 its reach. Find a proper released version of Gnus and snuggle up to
26440 that instead.
26441
26442
26443 @node Why?
26444 @subsection Why?
26445
26446 What's the point of Gnus?
26447
26448 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
26449 newsreader, that lets you do anything you can think of. That was my
26450 original motivation, but while working on Gnus, it has become clear to
26451 me that this generation of newsreaders really belong in the stone age.
26452 Newsreaders haven't developed much since the infancy of the net. If the
26453 volume continues to rise with the current rate of increase, all current
26454 newsreaders will be pretty much useless. How do you deal with
26455 newsgroups that have thousands of new articles each day? How do you
26456 keep track of millions of people who post?
26457
26458 Gnus offers no real solutions to these questions, but I would very much
26459 like to see Gnus being used as a testing ground for new methods of
26460 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
26461 to separate the newsreader from the back ends, Gnus now offers a simple
26462 interface for anybody who wants to write new back ends for fetching mail
26463 and news from different sources. I have added hooks for customizations
26464 everywhere I could imagine it being useful. By doing so, I'm inviting
26465 every one of you to explore and invent.
26466
26467 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
26468 @kbd{C-u 100 M-x all-hail-xemacs}.
26469
26470
26471 @node Compatibility
26472 @subsection Compatibility
26473
26474 @cindex compatibility
26475 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
26476 bindings have been kept. More key bindings have been added, of course,
26477 but only in one or two obscure cases have old bindings been changed.
26478
26479 Our motto is:
26480 @quotation
26481 @cartouche
26482 @center In a cloud bones of steel.
26483 @end cartouche
26484 @end quotation
26485
26486 All commands have kept their names. Some internal functions have changed
26487 their names.
26488
26489 The @code{gnus-uu} package has changed drastically. @xref{Decoding
26490 Articles}.
26491
26492 One major compatibility question is the presence of several summary
26493 buffers. All variables relevant while reading a group are
26494 buffer-local to the summary buffer they belong in. Although many
26495 important variables have their values copied into their global
26496 counterparts whenever a command is executed in the summary buffer, this
26497 change might lead to incorrect values being used unless you are careful.
26498
26499 All code that relies on knowledge of @sc{gnus} internals will probably
26500 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
26501 changing it in any way, as a matter of fact) is strictly verboten. Gnus
26502 maintains a hash table that points to the entries in this alist (which
26503 speeds up many functions), and changing the alist directly will lead to
26504 peculiar results.
26505
26506 @cindex hilit19
26507 @cindex highlighting
26508 Old hilit19 code does not work at all. In fact, you should probably
26509 remove all hilit code from all Gnus hooks
26510 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
26511 Gnus provides various integrated functions for highlighting. These are
26512 faster and more accurate. To make life easier for everybody, Gnus will
26513 by default remove all hilit calls from all hilit hooks. Uncleanliness!
26514 Away!
26515
26516 Packages like @code{expire-kill} will no longer work. As a matter of
26517 fact, you should probably remove all old @sc{gnus} packages (and other
26518 code) when you start using Gnus. More likely than not, Gnus already
26519 does what you have written code to make @sc{gnus} do. (Snicker.)
26520
26521 Even though old methods of doing things are still supported, only the
26522 new methods are documented in this manual. If you detect a new method of
26523 doing something while reading this manual, that does not mean you have
26524 to stop doing it the old way.
26525
26526 Gnus understands all @sc{gnus} startup files.
26527
26528 @kindex M-x gnus-bug
26529 @findex gnus-bug
26530 @cindex reporting bugs
26531 @cindex bugs
26532 Overall, a casual user who hasn't written much code that depends on
26533 @sc{gnus} internals should suffer no problems. If problems occur,
26534 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
26535
26536 @vindex gnus-bug-create-help-buffer
26537 If you are in the habit of sending bug reports @emph{very} often, you
26538 may find the helpful help buffer annoying after a while. If so, set
26539 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
26540 up at you.
26541
26542
26543 @node Conformity
26544 @subsection Conformity
26545
26546 No rebels without a clue here, ma'am. We conform to all standards known
26547 to (wo)man. Except for those standards and/or conventions we disagree
26548 with, of course.
26549
26550 @table @strong
26551
26552 @item RFC (2)822
26553 @cindex RFC 822
26554 @cindex RFC 2822
26555 There are no known breaches of this standard.
26556
26557 @item RFC 1036
26558 @cindex RFC 1036
26559 There are no known breaches of this standard, either.
26560
26561 @item Son-of-RFC 1036
26562 @cindex Son-of-RFC 1036
26563 We do have some breaches to this one.
26564
26565 @table @emph
26566
26567 @item X-Newsreader
26568 @itemx User-Agent
26569 These are considered to be ``vanity headers'', while I consider them
26570 to be consumer information. After seeing so many badly formatted
26571 articles coming from @code{tin} and @code{Netscape} I know not to use
26572 either of those for posting articles. I would not have known that if
26573 it wasn't for the @code{X-Newsreader} header.
26574 @end table
26575
26576 @item USEFOR
26577 @cindex USEFOR
26578 USEFOR is an IETF working group writing a successor to RFC 1036, based
26579 on Son-of-RFC 1036. They have produced a number of drafts proposing
26580 various changes to the format of news articles. The Gnus towers will
26581 look into implementing the changes when the draft is accepted as an RFC.
26582
26583 @item MIME---RFC 2045--2049 etc
26584 @cindex @acronym{MIME}
26585 All the various @acronym{MIME} RFCs are supported.
26586
26587 @item Disposition Notifications---RFC 2298
26588 Message Mode is able to request notifications from the receiver.
26589
26590 @item PGP---RFC 1991 and RFC 2440
26591 @cindex RFC 1991
26592 @cindex RFC 2440
26593 RFC 1991 is the original @acronym{PGP} message specification,
26594 published as an informational RFC@. RFC 2440 was the follow-up, now
26595 called Open PGP, and put on the Standards Track. Both document a
26596 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
26597 encoding (signing and encryption) and decoding (verification and
26598 decryption).
26599
26600 @item PGP/MIME---RFC 2015/3156
26601 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
26602 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
26603 Gnus supports both encoding and decoding.
26604
26605 @item S/MIME---RFC 2633
26606 RFC 2633 describes the @acronym{S/MIME} format.
26607
26608 @item IMAP---RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
26609 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
26610 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
26611 authentication for @acronym{IMAP}. RFC 2086 describes access control
26612 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
26613 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
26614 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
26615 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
26616
26617 @end table
26618
26619 If you ever notice Gnus acting non-compliant with regards to the texts
26620 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
26621 know.
26622
26623
26624 @node Emacsen
26625 @subsection Emacsen
26626 @cindex Emacsen
26627 @cindex XEmacs
26628 @cindex Mule
26629 @cindex Emacs
26630
26631 This version of Gnus should work on:
26632
26633 @itemize @bullet
26634
26635 @item
26636 Emacs 23.1 and up.
26637
26638 @item
26639 XEmacs 21.4 and up.
26640
26641 @end itemize
26642
26643 This Gnus version will absolutely not work on any Emacsen older than
26644 that. Not reliably, at least. Older versions of Gnus may work on older
26645 Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs
26646 20.7 and XEmacs 21.1.
26647
26648 @c No-merge comment: The paragraph added in v5-10 here must not be
26649 @c synced here!
26650
26651 @node Gnus Development
26652 @subsection Gnus Development
26653
26654 Gnus is developed in a two-phased cycle. The first phase involves much
26655 discussion on the development mailing list @samp{ding@@gnus.org}, where people
26656 propose changes and new features, post patches and new back ends. This
26657 phase is called the @dfn{alpha} phase, since the Gnusae released in this
26658 phase are @dfn{alpha releases}, or (perhaps more commonly in other
26659 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
26660 unstable and should not be used by casual users. Gnus alpha releases
26661 have names like ``Oort Gnus'' and ``No Gnus''. @xref{Gnus Versions}.
26662
26663 After futzing around for 10--100 alpha releases, Gnus is declared
26664 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
26665 and is called things like ``Gnus 5.10.1'' instead. Normal people are
26666 supposed to be able to use these, and these are mostly discussed on the
26667 @samp{gnu.emacs.gnus} newsgroup. This newgroup is mirrored to the
26668 mailing list @samp{info-gnus-english@@gnu.org} which is carried on Gmane
26669 as @samp{gmane.emacs.gnus.user}. These releases are finally integrated
26670 in Emacs.
26671
26672 @cindex Incoming*
26673 @vindex mail-source-delete-incoming
26674 Some variable defaults differ between alpha Gnusae and released Gnusae,
26675 in particular, @code{mail-source-delete-incoming}. This is to prevent
26676 lossage of mail if an alpha release hiccups while handling the mail.
26677 @xref{Mail Source Customization}.
26678
26679 The division of discussion between the ding mailing list and the Gnus
26680 newsgroup is not purely based on publicity concerns. It's true that
26681 having people write about the horrible things that an alpha Gnus release
26682 can do (sometimes) in a public forum may scare people off, but more
26683 importantly, talking about new experimental features that have been
26684 introduced may confuse casual users. New features are frequently
26685 introduced, fiddled with, and judged to be found wanting, and then
26686 either discarded or totally rewritten. People reading the mailing list
26687 usually keep up with these rapid changes, while people on the newsgroup
26688 can't be assumed to do so.
26689
26690 So if you have problems with or questions about the alpha versions,
26691 direct those to the ding mailing list @samp{ding@@gnus.org}. This list
26692 is also available on Gmane as @samp{gmane.emacs.gnus.general}.
26693
26694 @cindex Incoming*
26695 @vindex mail-source-delete-incoming
26696 Some variable defaults differ between alpha Gnusae and released Gnusae,
26697 in particular, @code{mail-source-delete-incoming}. This is to prevent
26698 lossage of mail if an alpha release hiccups while handling the mail.
26699 @xref{Mail Source Customization}.
26700
26701 @node Contributors
26702 @subsection Contributors
26703 @cindex contributors
26704
26705 The new Gnus version couldn't have been done without the help of all the
26706 people on the (ding) mailing list. Every day for over a year I have
26707 gotten billions of nice bug reports from them, filling me with joy,
26708 every single one of them. Smooches. The people on the list have been
26709 tried beyond endurance, what with my ``oh, that's a neat idea <type
26710 type>, yup, I'll release it right away <ship off> no wait, that doesn't
26711 work at all <type type>, yup, I'll ship that one off right away <ship
26712 off> no, wait, that absolutely does not work'' policy for releases.
26713 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
26714 ``worser''? ``much worser''? ``worsest''?)
26715
26716 I would like to take this opportunity to thank the Academy for@dots{} oops,
26717 wrong show.
26718
26719 @itemize @bullet
26720
26721 @item
26722 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
26723
26724 @item
26725 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el,
26726 nnwarchive and many, many other things connected with @acronym{MIME} and
26727 other types of en/decoding, as well as general bug fixing, new
26728 functionality and stuff.
26729
26730 @item
26731 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
26732 well as numerous other things).
26733
26734 @item
26735 Luis Fernandes---design and graphics.
26736
26737 @item
26738 Joe Reiss---creator of the smiley faces.
26739
26740 @item
26741 Justin Sheehy---the @acronym{FAQ} maintainer.
26742
26743 @item
26744 Erik Naggum---help, ideas, support, code and stuff.
26745
26746 @item
26747 Wes Hardaker---@file{gnus-picon.el} and the manual section on
26748 @dfn{picons} (@pxref{Picons}).
26749
26750 @item
26751 Kim-Minh Kaplan---further work on the picon code.
26752
26753 @item
26754 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
26755
26756 @item
26757 Sudish Joseph---innumerable bug fixes.
26758
26759 @item
26760 Ilja Weis---@file{gnus-topic.el}.
26761
26762 @item
26763 Steven L. Baur---lots and lots and lots of bug detection and fixes.
26764
26765 @item
26766 Vladimir Alexiev---the refcard and reference booklets.
26767
26768 @item
26769 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
26770 distribution by Felix Lee and JWZ.
26771
26772 @item
26773 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
26774
26775 @item
26776 Peter Mutsaers---orphan article scoring code.
26777
26778 @item
26779 Ken Raeburn---POP mail support.
26780
26781 @item
26782 Hallvard B Furuseth---various bits and pieces, especially dealing with
26783 .newsrc files.
26784
26785 @item
26786 Brian Edmonds---@file{gnus-bbdb.el}.
26787
26788 @item
26789 David Moore---rewrite of @file{nnvirtual.el} and many other things.
26790
26791 @item
26792 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
26793
26794 @item
26795 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
26796 well as autoconf support.
26797
26798 @end itemize
26799
26800 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
26801 Borges, and Jost Krieger proof-reading parts of the manual.
26802
26803 The following people have contributed many patches and suggestions:
26804
26805 Christopher Davis,
26806 Andrew Eskilsson,
26807 Kai Grossjohann,
26808 Kevin Greiner,
26809 Jesper Harder,
26810 Paul Jarc,
26811 Simon Josefsson,
26812 David K@aa{}gedal,
26813 Richard Pieri,
26814 Fabrice Popineau,
26815 Daniel Quinlan,
26816 Michael Shields,
26817 Reiner Steib,
26818 Jason L. Tibbitts, III,
26819 Jack Vinson,
26820 Katsumi Yamaoka, @c Yamaoka
26821 and
26822 Teodor Zlatanov.
26823
26824 Also thanks to the following for patches and stuff:
26825
26826 Jari Aalto,
26827 Adrian Aichner,
26828 Vladimir Alexiev,
26829 Russ Allbery,
26830 Peter Arius,
26831 Matt Armstrong,
26832 Marc Auslander,
26833 Miles Bader,
26834 Alexei V. Barantsev,
26835 Frank Bennett,
26836 Robert Bihlmeyer,
26837 Chris Bone,
26838 Mark Borges,
26839 Mark Boyns,
26840 Lance A. Brown,
26841 Rob Browning,
26842 Kees de Bruin,
26843 Martin Buchholz,
26844 Joe Buehler,
26845 Kevin Buhr,
26846 Alastair Burt,
26847 Joao Cachopo,
26848 Zlatko Calusic,
26849 Massimo Campostrini,
26850 Castor,
26851 David Charlap,
26852 Dan Christensen,
26853 Kevin Christian,
26854 Jae-you Chung, @c ?
26855 James H. Cloos, Jr.,
26856 Laura Conrad,
26857 Michael R. Cook,
26858 Glenn Coombs,
26859 Andrew J. Cosgriff,
26860 Neil Crellin,
26861 Frank D. Cringle,
26862 Geoffrey T. Dairiki,
26863 Andre Deparade,
26864 Ulrik Dickow,
26865 Dave Disser,
26866 Rui-Tao Dong, @c ?
26867 Joev Dubach,
26868 Michael Welsh Duggan,
26869 Dave Edmondson,
26870 Paul Eggert,
26871 Mark W. Eichin,
26872 Karl Eichwalder,
26873 Enami Tsugutomo, @c Enami
26874 Michael Ernst,
26875 Luc Van Eycken,
26876 Sam Falkner,
26877 Nelson Jose dos Santos Ferreira,
26878 Sigbjorn Finne,
26879 Sven Fischer,
26880 Paul Fisher,
26881 Decklin Foster,
26882 Gary D. Foster,
26883 Paul Franklin,
26884 Guy Geens,
26885 Arne Georg Gleditsch,
26886 David S. Goldberg,
26887 Michelangelo Grigni,
26888 Dale Hagglund,
26889 D. Hall,
26890 Magnus Hammerin,
26891 Kenichi Handa, @c Handa
26892 Raja R. Harinath,
26893 Yoshiki Hayashi, @c Hayashi
26894 P. E. Jareth Hein,
26895 Hisashige Kenji, @c Hisashige
26896 Scott Hofmann,
26897 Tassilo Horn,
26898 Marc Horowitz,
26899 Gunnar Horrigmo,
26900 Richard Hoskins,
26901 Brad Howes,
26902 Miguel de Icaza,
26903 Fran@,{c}ois Felix Ingrand,
26904 Tatsuya Ichikawa, @c Ichikawa
26905 Ishikawa Ichiro, @c Ishikawa
26906 Lee Iverson,
26907 Iwamuro Motonori, @c Iwamuro
26908 Rajappa Iyer,
26909 Andreas Jaeger,
26910 Adam P. Jenkins,
26911 Randell Jesup,
26912 Fred Johansen,
26913 Gareth Jones,
26914 Greg Klanderman,
26915 Karl Kleinpaste,
26916 Michael Klingbeil,
26917 Peter Skov Knudsen,
26918 Shuhei Kobayashi, @c Kobayashi
26919 Petr Konecny,
26920 Koseki Yoshinori, @c Koseki
26921 Thor Kristoffersen,
26922 Jens Lautenbacher,
26923 Martin Larose,
26924 Seokchan Lee, @c Lee
26925 Joerg Lenneis,
26926 Carsten Leonhardt,
26927 James LewisMoss,
26928 Christian Limpach,
26929 Markus Linnala,
26930 Dave Love,
26931 Mike McEwan,
26932 Tonny Madsen,
26933 Shlomo Mahlab,
26934 Nat Makarevitch,
26935 Istvan Marko,
26936 David Martin,
26937 Jason R. Mastaler,
26938 Gordon Matzigkeit,
26939 Timo Metzemakers,
26940 Richard Mlynarik,
26941 Lantz Moore,
26942 Morioka Tomohiko, @c Morioka
26943 Erik Toubro Nielsen,
26944 Hrvoje Niksic,
26945 Andy Norman,
26946 Fred Oberhauser,
26947 C. R. Oldham,
26948 Alexandre Oliva,
26949 Ken Olstad,
26950 Masaharu Onishi, @c Onishi
26951 Hideki Ono, @c Ono
26952 Ettore Perazzoli,
26953 William Perry,
26954 Stephen Peters,
26955 Jens-Ulrik Holger Petersen,
26956 Ulrich Pfeifer,
26957 Matt Pharr,
26958 Andy Piper,
26959 John McClary Prevost,
26960 Bill Pringlemeir,
26961 Mike Pullen,
26962 Jim Radford,
26963 Colin Rafferty,
26964 Lasse Rasinen,
26965 Lars Balker Rasmussen,
26966 Joe Reiss,
26967 Renaud Rioboo,
26968 Roland B. Roberts,
26969 Bart Robinson,
26970 Christian von Roques,
26971 Markus Rost,
26972 Jason Rumney,
26973 Wolfgang Rupprecht,
26974 Jay Sachs,
26975 Dewey M. Sasser,
26976 Conrad Sauerwald,
26977 Loren Schall,
26978 Dan Schmidt,
26979 Ralph Schleicher,
26980 Philippe Schnoebelen,
26981 Andreas Schwab,
26982 Randal L. Schwartz,
26983 Danny Siu,
26984 Matt Simmons,
26985 Paul D. Smith,
26986 Jeff Sparkes,
26987 Toby Speight,
26988 Michael Sperber,
26989 Darren Stalder,
26990 Richard Stallman,
26991 Greg Stark,
26992 Sam Steingold,
26993 Paul Stevenson,
26994 Jonas Steverud,
26995 Paul Stodghill,
26996 Kiyokazu Suto, @c Suto
26997 Kurt Swanson,
26998 Samuel Tardieu,
26999 Teddy,
27000 Chuck Thompson,
27001 Tozawa Akihiko, @c Tozawa
27002 Philippe Troin,
27003 James Troup,
27004 Trung Tran-Duc,
27005 Jack Twilley,
27006 Aaron M. Ucko,
27007 Aki Vehtari,
27008 Didier Verna,
27009 Vladimir Volovich,
27010 Jan Vroonhof,
27011 Stefan Waldherr,
27012 Pete Ware,
27013 Barry A. Warsaw,
27014 Christoph Wedler,
27015 Joe Wells,
27016 Lee Willis,
27017 and
27018 Lloyd Zusman.
27019
27020
27021 For a full overview of what each person has done, the ChangeLogs
27022 included in the Gnus alpha distributions should give ample reading
27023 (550kB and counting).
27024
27025 Apologies to everybody that I've forgotten, of which there are many, I'm
27026 sure.
27027
27028 Gee, that's quite a list of people. I guess that must mean that there
27029 actually are people who are using Gnus. Who'd'a thunk it!
27030
27031
27032 @node New Features
27033 @subsection New Features
27034 @cindex new features
27035
27036 @menu
27037 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
27038 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
27039 * Red Gnus:: Third time best---Gnus 5.4/5.5.
27040 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
27041 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
27042 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
27043 * No Gnus:: Very punny. Gnus 5.12/5.13.
27044 * Ma Gnus:: Celebrating 25 years of Gnus.
27045 @end menu
27046
27047 These lists are, of course, just @emph{short} overviews of the
27048 @emph{most} important new features. No, really. There are tons more.
27049 Yes, we have feeping creaturism in full effect.
27050
27051 @node ding Gnus
27052 @subsubsection (ding) Gnus
27053
27054 New features in Gnus 5.0/5.1:
27055
27056 @itemize @bullet
27057
27058 @item
27059 The look of all buffers can be changed by setting format-like variables
27060 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
27061
27062 @item
27063 Local spool and several @acronym{NNTP} servers can be used at once
27064 (@pxref{Select Methods}).
27065
27066 @item
27067 You can combine groups into virtual groups (@pxref{Virtual Groups}).
27068
27069 @item
27070 You can read a number of different mail formats (@pxref{Getting Mail}).
27071 All the mail back ends implement a convenient mail expiry scheme
27072 (@pxref{Expiring Mail}).
27073
27074 @item
27075 Gnus can use various strategies for gathering threads that have lost
27076 their roots (thereby gathering loose sub-threads into one thread) or it
27077 can go back and retrieve enough headers to build a complete thread
27078 (@pxref{Customizing Threading}).
27079
27080 @item
27081 Killed groups can be displayed in the group buffer, and you can read
27082 them as well (@pxref{Listing Groups}).
27083
27084 @item
27085 Gnus can do partial group updates---you do not have to retrieve the
27086 entire active file just to check for new articles in a few groups
27087 (@pxref{The Active File}).
27088
27089 @item
27090 Gnus implements a sliding scale of subscribedness to groups
27091 (@pxref{Group Levels}).
27092
27093 @item
27094 You can score articles according to any number of criteria
27095 (@pxref{Scoring}). You can even get Gnus to find out how to score
27096 articles for you (@pxref{Adaptive Scoring}).
27097
27098 @item
27099 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
27100 manner, so it should be difficult to lose much data on what you have
27101 read if your machine should go down (@pxref{Auto Save}).
27102
27103 @item
27104 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
27105 cluttering up the @file{.emacs} file.
27106
27107 @item
27108 You can set the process mark on both groups and articles and perform
27109 operations on all the marked items (@pxref{Process/Prefix}).
27110
27111 @item
27112 You can list subsets of groups according to, well, anything
27113 (@pxref{Listing Groups}).
27114
27115 @item
27116 You can browse foreign servers and subscribe to groups from those
27117 servers (@pxref{Browse Foreign Server}).
27118
27119 @item
27120 Gnus can fetch articles, asynchronously, on a second connection to the
27121 server (@pxref{Asynchronous Fetching}).
27122
27123 @item
27124 You can cache articles locally (@pxref{Article Caching}).
27125
27126 @item
27127 The uudecode functions have been expanded and generalized
27128 (@pxref{Decoding Articles}).
27129
27130 @item
27131 You can still post uuencoded articles, which was a little-known feature
27132 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
27133
27134 @item
27135 Fetching parents (and other articles) now actually works without
27136 glitches (@pxref{Finding the Parent}).
27137
27138 @item
27139 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
27140
27141 @item
27142 Digests (and other files) can be used as the basis for groups
27143 (@pxref{Document Groups}).
27144
27145 @item
27146 Articles can be highlighted and customized (@pxref{Customizing
27147 Articles}).
27148
27149 @item
27150 URLs and other external references can be buttonized (@pxref{Article
27151 Buttons}).
27152
27153 @item
27154 You can do lots of strange stuff with the Gnus window & frame
27155 configuration (@pxref{Window Layout}).
27156
27157 @end itemize
27158
27159
27160 @node September Gnus
27161 @subsubsection September Gnus
27162
27163 @iftex
27164 @iflatex
27165 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
27166 @end iflatex
27167 @end iftex
27168
27169 New features in Gnus 5.2/5.3:
27170
27171 @itemize @bullet
27172
27173 @item
27174 A new message composition mode is used. All old customization variables
27175 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
27176 now obsolete.
27177
27178 @item
27179 Gnus is now able to generate @dfn{sparse} threads---threads where
27180 missing articles are represented by empty nodes (@pxref{Customizing
27181 Threading}).
27182
27183 @lisp
27184 (setq gnus-build-sparse-threads 'some)
27185 @end lisp
27186
27187 @item
27188 Outgoing articles are stored on a special archive server
27189 (@pxref{Archived Messages}).
27190
27191 @item
27192 Partial thread regeneration now happens when articles are
27193 referred.
27194
27195 @item
27196 Gnus can make use of GroupLens predictions.
27197
27198 @item
27199 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
27200
27201 @item
27202 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
27203
27204 @lisp
27205 (setq gnus-use-trees t)
27206 @end lisp
27207
27208 @item
27209 An @code{nn}-like pick-and-read minor mode is available for the summary
27210 buffers (@pxref{Pick and Read}).
27211
27212 @lisp
27213 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
27214 @end lisp
27215
27216 @item
27217 In binary groups you can use a special binary minor mode (@pxref{Binary
27218 Groups}).
27219
27220 @item
27221 Groups can be grouped in a folding topic hierarchy (@pxref{Group
27222 Topics}).
27223
27224 @lisp
27225 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
27226 @end lisp
27227
27228 @item
27229 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
27230
27231 @item
27232 Groups can now have a score, and bubbling based on entry frequency
27233 is possible (@pxref{Group Score}).
27234
27235 @lisp
27236 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
27237 @end lisp
27238
27239 @item
27240 Groups can be process-marked, and commands can be performed on
27241 groups of groups (@pxref{Marking Groups}).
27242
27243 @item
27244 Caching is possible in virtual groups.
27245
27246 @item
27247 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
27248 news batches, ClariNet briefs collections, and just about everything
27249 else (@pxref{Document Groups}).
27250
27251 @item
27252 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets.
27253
27254 @item
27255 The Gnus cache is much faster.
27256
27257 @item
27258 Groups can be sorted according to many criteria (@pxref{Sorting
27259 Groups}).
27260
27261 @item
27262 New group parameters have been introduced to set list-addresses and
27263 expiry times (@pxref{Group Parameters}).
27264
27265 @item
27266 All formatting specs allow specifying faces to be used
27267 (@pxref{Formatting Fonts}).
27268
27269 @item
27270 There are several more commands for setting/removing/acting on process
27271 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
27272
27273 @item
27274 The summary buffer can be limited to show parts of the available
27275 articles based on a wide range of criteria. These commands have been
27276 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
27277
27278 @item
27279 Articles can be made persistent with the @kbd{*} command
27280 (@pxref{Persistent Articles}).
27281
27282 @item
27283 All functions for hiding article elements are now toggles.
27284
27285 @item
27286 Article headers can be buttonized (@pxref{Article Washing}).
27287
27288 @item
27289 All mail back ends support fetching articles by @code{Message-ID}.
27290
27291 @item
27292 Duplicate mail can now be treated properly (@pxref{Duplicates}).
27293
27294 @item
27295 All summary mode commands are available directly from the article
27296 buffer (@pxref{Article Keymap}).
27297
27298 @item
27299 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
27300 Layout}).
27301
27302 @item
27303 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
27304 @iftex
27305 @iflatex
27306 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
27307 @end iflatex
27308 @end iftex
27309
27310 @item
27311 Groups can be made permanently visible (@pxref{Listing Groups}).
27312
27313 @lisp
27314 (setq gnus-permanently-visible-groups "^nnml:")
27315 @end lisp
27316
27317 @item
27318 Many new hooks have been introduced to make customizing easier.
27319
27320 @item
27321 Gnus respects the @code{Mail-Copies-To} header.
27322
27323 @item
27324 Threads can be gathered by looking at the @code{References} header
27325 (@pxref{Customizing Threading}).
27326
27327 @lisp
27328 (setq gnus-summary-thread-gathering-function
27329 'gnus-gather-threads-by-references)
27330 @end lisp
27331
27332 @item
27333 Read articles can be stored in a special backlog buffer to avoid
27334 refetching (@pxref{Article Backlog}).
27335
27336 @lisp
27337 (setq gnus-keep-backlog 50)
27338 @end lisp
27339
27340 @item
27341 A clean copy of the current article is always stored in a separate
27342 buffer to allow easier treatment.
27343
27344 @item
27345 Gnus can suggest where to save articles (@pxref{Saving Articles}).
27346
27347 @item
27348 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
27349 Articles}).
27350
27351 @lisp
27352 (setq gnus-prompt-before-saving t)
27353 @end lisp
27354
27355 @item
27356 @code{gnus-uu} can view decoded files asynchronously while fetching
27357 articles (@pxref{Other Decode Variables}).
27358
27359 @lisp
27360 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
27361 @end lisp
27362
27363 @item
27364 Filling in the article buffer now works properly on cited text
27365 (@pxref{Article Washing}).
27366
27367 @item
27368 Hiding cited text adds buttons to toggle hiding, and how much
27369 cited text to hide is now customizable (@pxref{Article Hiding}).
27370
27371 @lisp
27372 (setq gnus-cited-lines-visible 2)
27373 @end lisp
27374
27375 @item
27376 Boring headers can be hidden (@pxref{Article Hiding}).
27377
27378 @item
27379 Default scoring values can now be set from the menu bar.
27380
27381 @item
27382 Further syntax checking of outgoing articles have been added.
27383
27384 @end itemize
27385
27386
27387 @node Red Gnus
27388 @subsubsection Red Gnus
27389
27390 New features in Gnus 5.4/5.5:
27391
27392 @iftex
27393 @iflatex
27394 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
27395 @end iflatex
27396 @end iftex
27397
27398 @itemize @bullet
27399
27400 @item
27401 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
27402
27403 @item
27404 Article prefetching functionality has been moved up into
27405 Gnus (@pxref{Asynchronous Fetching}).
27406
27407 @item
27408 Scoring can now be performed with logical operators like @code{and},
27409 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
27410 Scoring}).
27411
27412 @item
27413 Article washing status can be displayed in the
27414 article mode line (@pxref{Misc Article}).
27415
27416 @item
27417 @file{gnus.el} has been split into many smaller files.
27418
27419 @item
27420 Suppression of duplicate articles based on Message-ID can be done
27421 (@pxref{Duplicate Suppression}).
27422
27423 @lisp
27424 (setq gnus-suppress-duplicates t)
27425 @end lisp
27426
27427 @item
27428 New variables for specifying what score and adapt files are to be
27429 considered home score and adapt files (@pxref{Home Score File}) have
27430 been added.
27431
27432 @item
27433 @code{nndoc} was rewritten to be easily extensible (@pxref{Document
27434 Server Internals}).
27435
27436 @item
27437 Groups can inherit group parameters from parent topics (@pxref{Topic
27438 Parameters}).
27439
27440 @item
27441 Article editing has been revamped and is now actually usable.
27442
27443 @item
27444 Signatures can be recognized in more intelligent fashions
27445 (@pxref{Article Signature}).
27446
27447 @item
27448 Summary pick mode has been made to look more @code{nn}-like. Line
27449 numbers are displayed and the @kbd{.} command can be used to pick
27450 articles (@code{Pick and Read}).
27451
27452 @item
27453 Commands for moving the @file{.newsrc.eld} from one server to
27454 another have been added (@pxref{Changing Servers}).
27455
27456 @item
27457 There's a way now to specify that ``uninteresting'' fields be suppressed
27458 when generating lines in buffers (@pxref{Advanced Formatting}).
27459
27460 @item
27461 Several commands in the group buffer can be undone with @kbd{C-M-_}
27462 (@pxref{Undo}).
27463
27464 @item
27465 Scoring can be done on words using the new score type @code{w}
27466 (@pxref{Score File Format}).
27467
27468 @item
27469 Adaptive scoring can be done on a Subject word-by-word basis
27470 (@pxref{Adaptive Scoring}).
27471
27472 @lisp
27473 (setq gnus-use-adaptive-scoring '(word))
27474 @end lisp
27475
27476 @item
27477 Scores can be decayed (@pxref{Score Decays}).
27478
27479 @lisp
27480 (setq gnus-decay-scores t)
27481 @end lisp
27482
27483 @item
27484 Scoring can be performed using a regexp on the Date header. The Date is
27485 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
27486
27487 @item
27488 A new command has been added to remove all data on articles from
27489 the native server (@pxref{Changing Servers}).
27490
27491 @item
27492 A new command for reading collections of documents
27493 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
27494 (@pxref{Really Various Summary Commands}).
27495
27496 @item
27497 Process mark sets can be pushed and popped (@pxref{Setting Process
27498 Marks}).
27499
27500 @item
27501 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
27502 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
27503
27504 @item
27505 A new back end for reading searches from Web search engines
27506 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
27507 (@pxref{Web Searches}).
27508
27509 @item
27510 Groups inside topics can now be sorted using the standard sorting
27511 functions, and each topic can be sorted independently (@pxref{Topic
27512 Sorting}).
27513
27514 @item
27515 Subsets of the groups can be sorted independently (@code{Sorting
27516 Groups}).
27517
27518 @item
27519 Cached articles can be pulled into the groups (@pxref{Summary Generation
27520 Commands}).
27521 @iftex
27522 @iflatex
27523 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
27524 @end iflatex
27525 @end iftex
27526
27527 @item
27528 Score files are now applied in a more reliable order (@pxref{Score
27529 Variables}).
27530
27531 @item
27532 Reports on where mail messages end up can be generated (@pxref{Splitting
27533 Mail}).
27534
27535 @item
27536 More hooks and functions have been added to remove junk from incoming
27537 mail before saving the mail (@pxref{Washing Mail}).
27538
27539 @item
27540 Emphasized text can be properly fontisized:
27541
27542 @end itemize
27543
27544
27545 @node Quassia Gnus
27546 @subsubsection Quassia Gnus
27547
27548 New features in Gnus 5.6:
27549
27550 @itemize @bullet
27551
27552 @item
27553 New functionality for using Gnus as an offline newsreader has been
27554 added. A plethora of new commands and modes have been added.
27555 @xref{Gnus Unplugged}, for the full story.
27556
27557 @item
27558 The @code{nndraft} back end has returned, but works differently than
27559 before. All Message buffers are now also articles in the @code{nndraft}
27560 group, which is created automatically.
27561
27562 @item
27563 @code{gnus-alter-header-function} can now be used to alter header
27564 values.
27565
27566 @item
27567 @code{gnus-summary-goto-article} now accept Message-IDs.
27568
27569 @item
27570 A new Message command for deleting text in the body of a message
27571 outside the region: @kbd{C-c C-v}.
27572
27573 @item
27574 You can now post to component group in @code{nnvirtual} groups with
27575 @kbd{C-u C-c C-c}.
27576
27577 @item
27578 @code{nntp-rlogin-program}---new variable to ease customization.
27579
27580 @item
27581 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
27582 re-highlighting of the article buffer.
27583
27584 @item
27585 New element in @code{gnus-boring-article-headers}---@code{long-to}.
27586
27587 @item
27588 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
27589 details.
27590
27591 @item
27592 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
27593 @kbd{a} to add the score rule to the @file{all.SCORE} file.
27594
27595 @item
27596 @code{gnus-simplify-subject-functions} variable to allow greater
27597 control over simplification.
27598
27599 @item
27600 @kbd{A T}---new command for fetching the current thread.
27601
27602 @item
27603 @kbd{/ T}---new command for including the current thread in the
27604 limit.
27605
27606 @item
27607 @kbd{M-RET} is a new Message command for breaking cited text.
27608
27609 @item
27610 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
27611
27612 @item
27613 The @code{custom-face-lookup} function has been removed.
27614 If you used this function in your initialization files, you must
27615 rewrite them to use @code{face-spec-set} instead.
27616
27617 @item
27618 Canceling now uses the current select method. Symbolic prefix
27619 @kbd{a} forces normal posting method.
27620
27621 @item
27622 New command to translate M******** sm*rtq**t*s into proper
27623 text---@kbd{W d}.
27624
27625 @item
27626 For easier debugging of @code{nntp}, you can set
27627 @code{nntp-record-commands} to a non-@code{nil} value.
27628
27629 @item
27630 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
27631 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
27632
27633 @item
27634 A command for editing group parameters from the summary buffer
27635 has been added.
27636
27637 @item
27638 A history of where mails have been split is available.
27639
27640 @item
27641 A new article date command has been added---@code{article-date-iso8601}.
27642
27643 @item
27644 Subjects can be simplified when threading by setting
27645 @code{gnus-score-thread-simplify}.
27646
27647 @item
27648 A new function for citing in Message has been
27649 added---@code{message-cite-original-without-signature}.
27650
27651 @item
27652 @code{article-strip-all-blank-lines}---new article command.
27653
27654 @item
27655 A new Message command to kill to the end of the article has
27656 been added.
27657
27658 @item
27659 A minimum adaptive score can be specified by using the
27660 @code{gnus-adaptive-word-minimum} variable.
27661
27662 @item
27663 The ``lapsed date'' article header can be kept continually
27664 updated by the @code{gnus-start-date-timer} command.
27665
27666 @item
27667 Web listserv archives can be read with the @code{nnlistserv} back end.
27668
27669 @item
27670 Old dejanews archives can now be read by @code{nnweb}.
27671
27672 @end itemize
27673
27674 @node Pterodactyl Gnus
27675 @subsubsection Pterodactyl Gnus
27676
27677 New features in Gnus 5.8:
27678
27679 @itemize @bullet
27680
27681 @item
27682 The mail-fetching functions have changed. See the manual for the
27683 many details. In particular, all procmail fetching variables are gone.
27684
27685 If you used procmail like in
27686
27687 @lisp
27688 (setq nnmail-use-procmail t)
27689 (setq nnmail-spool-file 'procmail)
27690 (setq nnmail-procmail-directory "~/mail/incoming/")
27691 (setq nnmail-procmail-suffix "\\.in")
27692 @end lisp
27693
27694 this now has changed to
27695
27696 @lisp
27697 (setq mail-sources
27698 '((directory :path "~/mail/incoming/"
27699 :suffix ".in")))
27700 @end lisp
27701
27702 @xref{Mail Source Specifiers}.
27703
27704 @item
27705 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
27706 Gnus, and adds a slew of new commands. See the manual for details.
27707
27708 @item
27709 Gnus has also been multilingualized. This also affects too
27710 many parts of Gnus to summarize here, and adds many new variables.
27711
27712 @item
27713 @code{gnus-auto-select-first} can now be a function to be
27714 called to position point.
27715
27716 @item
27717 The user can now decide which extra headers should be included in
27718 summary buffers and @acronym{NOV} files.
27719
27720 @item
27721 @code{gnus-article-display-hook} has been removed. Instead, a number
27722 of variables starting with @code{gnus-treat-} have been added.
27723
27724 @item
27725 The Gnus posting styles have been redone again and now works in a
27726 subtly different manner.
27727
27728 @item
27729 New web-based back ends have been added: @code{nnslashdot},
27730 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
27731 again, to keep up with ever-changing layouts.
27732
27733 @item
27734 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
27735
27736 @end itemize
27737
27738 @node Oort Gnus
27739 @subsubsection Oort Gnus
27740 @cindex Oort Gnus
27741
27742 New features in Gnus 5.10:
27743
27744 @itemize @bullet
27745
27746 @item Installation changes
27747 @c ***********************
27748
27749 @itemize @bullet
27750 @item
27751 Upgrading from previous (stable) version if you have used Oort.
27752
27753 If you have tried Oort (the unstable Gnus branch leading to this
27754 release) but went back to a stable version, be careful when upgrading to
27755 this version. In particular, you will probably want to remove all
27756 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
27757 read from your @file{.newsrc.eld} instead of from the
27758 @file{.marks}/@file{.mrk} file where this release store flags. See a
27759 later entry for more information about marks. Note that downgrading
27760 isn't save in general.
27761
27762 @item
27763 Lisp files are now installed in @file{.../site-lisp/gnus/} by default.
27764 It defaulted to @file{.../site-lisp/} formerly. In addition to this,
27765 the new installer issues a warning if other Gnus installations which
27766 will shadow the latest one are detected. You can then remove those
27767 shadows manually or remove them using @code{make
27768 remove-installed-shadows}.
27769
27770 @item
27771 New @file{make.bat} for compiling and installing Gnus under MS Windows
27772
27773 Use @file{make.bat} if you want to install Gnus under MS Windows, the
27774 first argument to the batch-program should be the directory where
27775 @file{xemacs.exe} respectively @file{emacs.exe} is located, if you want
27776 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
27777 the second parameter.
27778
27779 @file{make.bat} has been rewritten from scratch, it now features
27780 automatic recognition of XEmacs and Emacs, generates
27781 @file{gnus-load.el}, checks if errors occur while compilation and
27782 generation of info files and reports them at the end of the build
27783 process. It now uses @code{makeinfo} if it is available and falls
27784 back to @file{infohack.el} otherwise. @file{make.bat} should now
27785 install all files which are necessary to run Gnus and be generally a
27786 complete replacement for the @code{configure; make; make install}
27787 cycle used under Unix systems.
27788
27789 The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak}
27790 superfluous, so they have been removed.
27791
27792 @item
27793 @file{~/News/overview/} not used.
27794
27795 As a result of the following change, the @file{~/News/overview/}
27796 directory is not used any more. You can safely delete the entire
27797 hierarchy.
27798
27799 @c FIXME: `gnus-load' is mentioned in README, which is not included in
27800 @c the repository. We should find a better place for this item.
27801 @item
27802 @code{(require 'gnus-load)}
27803
27804 If you use a stand-alone Gnus distribution, you'd better add
27805 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
27806 lisp directory into load-path.
27807
27808 File @file{gnus-load.el} contains autoload commands, functions and variables,
27809 some of which may not be included in distributions of Emacsen.
27810
27811 @end itemize
27812
27813 @item New packages and libraries within Gnus
27814 @c *****************************************
27815
27816 @itemize @bullet
27817
27818 @item
27819 The revised Gnus @acronym{FAQ} is included in the manual,
27820 @xref{Frequently Asked Questions}.
27821
27822 @item
27823 @acronym{TLS} wrapper shipped with Gnus
27824
27825 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
27826 @acronym{NNTP} via @file{tls.el} and GnuTLS.
27827
27828 @item
27829 Improved anti-spam features.
27830
27831 Gnus is now able to take out spam from your mail and news streams
27832 using a wide variety of programs and filter rules. Among the supported
27833 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
27834 for easy use of external packages such as SpamAssassin and Hashcash
27835 are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}.
27836 @c FIXME: @xref{Spam Package}?. Should this be under Misc?
27837
27838 @item
27839 Gnus supports server-side mail filtering using Sieve.
27840
27841 Sieve rules can be added as Group Parameters for groups, and the
27842 complete Sieve script is generated using @kbd{D g} from the Group
27843 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27844 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27845 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27846
27847 @end itemize
27848
27849 @item Changes in group mode
27850 @c ************************
27851
27852 @itemize @bullet
27853
27854 @item
27855 @code{gnus-group-read-ephemeral-group} can be called interactively,
27856 using @kbd{G M}.
27857
27858 @item
27859 Retrieval of charters and control messages
27860
27861 There are new commands for fetching newsgroup charters (@kbd{H c}) and
27862 control messages (@kbd{H C}).
27863
27864 @item
27865 The new variable @code{gnus-parameters} can be used to set group parameters.
27866
27867 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
27868 the parameters in @file{~/.newsrc.eld}, but via this variable you can
27869 enjoy the powers of customize, and simplified backups since you set the
27870 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
27871 variable maps regular expressions matching group names to group
27872 parameters, a'la:
27873 @lisp
27874 (setq gnus-parameters
27875 '(("mail\\..*"
27876 (gnus-show-threads nil)
27877 (gnus-use-scoring nil))
27878 ("^nnimap:\\(foo.bar\\)$"
27879 (to-group . "\\1"))))
27880 @end lisp
27881
27882 @item
27883 Unread count correct in nnimap groups.
27884
27885 The estimated number of unread articles in the group buffer should now
27886 be correct for nnimap groups. This is achieved by calling
27887 @code{nnimap-fixup-unread-after-getting-new-news} from the
27888 @code{gnus-setup-news-hook} (called on startup) and
27889 @code{gnus-after-getting-new-news-hook} (called after getting new
27890 mail). If you have modified those variables from the default, you may
27891 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
27892 you were happy with the estimate and want to save some (minimal) time
27893 when getting new mail, remove the function.
27894
27895 @item
27896 Group names are treated as UTF-8 by default.
27897
27898 This is supposedly what USEFOR wanted to migrate to. See
27899 @code{gnus-group-name-charset-group-alist} and
27900 @code{gnus-group-name-charset-method-alist} for customization.
27901
27902 @item
27903 @code{gnus-group-charset-alist} and
27904 @code{gnus-group-ignored-charsets-alist}.
27905
27906 The regexps in these variables are compared with full group names
27907 instead of real group names in 5.8. Users who customize these
27908 variables should change those regexps accordingly. For example:
27909 @lisp
27910 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27911 @end lisp
27912
27913 @item
27914 Old intermediate incoming mail files (@file{Incoming*}) are deleted
27915 after a couple of days, not immediately. @xref{Mail Source
27916 Customization}. (New in Gnus 5.10.10 / Emacs 22.2)
27917
27918 @end itemize
27919
27920 @item Changes in summary and article mode
27921 @c **************************************
27922
27923 @itemize @bullet
27924
27925 @item
27926 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
27927 (@code{gnus-article-reply-with-original}) only yank the text in the
27928 region if the region is active.
27929
27930 @item
27931 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
27932 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
27933
27934 @item
27935 Article Buttons
27936
27937 More buttons for URLs, mail addresses, Message-IDs, Info links, man
27938 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
27939 variables @code{gnus-button-@var{*}-level} can be used to control the
27940 appearance of all article buttons. @xref{Article Button Levels}.
27941
27942 @item
27943 Single-part yenc encoded attachments can be decoded.
27944
27945 @item
27946 Picons
27947
27948 The picons code has been reimplemented to work in GNU Emacs---some of
27949 the previous options have been removed or renamed.
27950
27951 Picons are small ``personal icons'' representing users, domain and
27952 newsgroups, which can be displayed in the Article buffer.
27953 @xref{Picons}.
27954
27955 @item
27956 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
27957 boundary line is drawn at the end of the headers.
27958
27959 @item
27960 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
27961
27962 @item
27963 The Summary Buffer uses an arrow in the fringe to indicate the current
27964 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
27965
27966 @item
27967 Warn about email replies to news
27968
27969 Do you often find yourself replying to news by email by mistake? Then
27970 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
27971 you.
27972
27973 @item
27974 If the new option @code{gnus-summary-display-while-building} is
27975 non-@code{nil}, the summary buffer is shown and updated as it's being
27976 built.
27977
27978 @item
27979 Gnus supports RFC 2369 mailing list headers, and adds a number of
27980 related commands in mailing list groups. @xref{Mailing List}.
27981
27982 @item
27983 The Date header can be displayed in a format that can be read aloud
27984 in English. @xref{Article Date}.
27985
27986 @item
27987 diffs are automatically highlighted in groups matching
27988 @code{mm-uu-diff-groups-regexp}
27989
27990 @item
27991 Better handling of Microsoft citation styles
27992
27993 Gnus now tries to recognize the mangled header block that some Microsoft
27994 mailers use to indicate that the rest of the message is a citation, even
27995 though it is not quoted in any way. The variable
27996 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
27997 citations.
27998
27999 The new command @kbd{W Y f}
28000 (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken
28001 Outlook (Express) articles.
28002
28003 @item
28004 @code{gnus-article-skip-boring}
28005
28006 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
28007 not scroll down to show you a page that contains only boring text,
28008 which by default means cited text and signature. You can customize
28009 what is skippable using @code{gnus-article-boring-faces}.
28010
28011 This feature is especially useful if you read many articles that
28012 consist of a little new content at the top with a long, untrimmed
28013 message cited below.
28014
28015 @item
28016 Smileys (@samp{:-)}, @samp{;-)} etc.)@: are now displayed graphically in
28017 Emacs too.
28018
28019 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
28020 disable it.
28021
28022 @item
28023 Face headers handling. @xref{Face}.
28024
28025 @item
28026 In the summary buffer, the new command @kbd{/ N} inserts new messages
28027 and @kbd{/ o} inserts old messages.
28028
28029 @item
28030 Gnus decodes morse encoded messages if you press @kbd{W m}.
28031
28032 @item
28033 @code{gnus-summary-line-format}
28034
28035 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
28036 %s\n}. Moreover @code{gnus-extra-headers},
28037 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
28038 changed their default so that the users name will be replaced by the
28039 recipient's name or the group name posting to for @acronym{NNTP}
28040 groups.
28041
28042 @item
28043 Deleting of attachments.
28044
28045 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
28046 on @acronym{MIME} buttons) saves a part and replaces the part with an
28047 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
28048 @acronym{MIME} buttons) removes a part. It works only on back ends
28049 that support editing.
28050
28051 @item
28052 @code{gnus-default-charset}
28053
28054 The default value is determined from the
28055 @code{current-language-environment} variable, instead of
28056 @code{iso-8859-1}. Also the @samp{.*} item in
28057 @code{gnus-group-charset-alist} is removed.
28058
28059 @item
28060 Printing capabilities are enhanced.
28061
28062 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
28063 Article buffers. Also, each individual @acronym{MIME} part can be
28064 printed using @kbd{p} on the @acronym{MIME} button.
28065
28066 @item
28067 Extended format specs.
28068
28069 Format spec @samp{%&user-date;} is added into
28070 @code{gnus-summary-line-format-alist}. Also, user defined extended
28071 format specs are supported. The extended format specs look like
28072 @samp{%u&foo;}, which invokes function
28073 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
28074 escape character, old user defined format @samp{%u&} is no longer supported.
28075
28076 @item
28077 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
28078 @c FIXME: Was this a user-visible change?
28079
28080 It was aliased to @kbd{Y c}
28081 (@code{gnus-summary-insert-cached-articles}). The new function filters
28082 out other articles.
28083
28084 @item
28085 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
28086
28087 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
28088 s}, @kbd{/ a}, and @kbd{/ x}
28089 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
28090 result will be to display all articles that do not match the expression.
28091
28092 @item
28093 Gnus inlines external parts (message/external).
28094
28095 @end itemize
28096
28097 @item Changes in Message mode and related Gnus features
28098 @c ****************************************************
28099
28100 @itemize @bullet
28101
28102 @item
28103 Delayed articles
28104
28105 You can delay the sending of a message with @kbd{C-c C-j} in the Message
28106 buffer. The messages are delivered at specified time. This is useful
28107 for sending yourself reminders. @xref{Delayed Articles}.
28108
28109 @item
28110 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
28111 the nnml back end allows compressed message files.
28112
28113 @item
28114 The new option @code{gnus-gcc-mark-as-read} automatically marks
28115 Gcc articles as read.
28116
28117 @item
28118 Externalizing of attachments
28119
28120 If @code{gnus-gcc-externalize-attachments} or
28121 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
28122 local files as external parts.
28123
28124 @item
28125 The envelope sender address can be customized when using Sendmail.
28126 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
28127
28128 @item
28129 Gnus no longer generate the Sender: header automatically.
28130
28131 Earlier it was generated when the user configurable email address was
28132 different from the Gnus guessed default user address. As the guessing
28133 algorithm is rarely correct these days, and (more controversially) the
28134 only use of the Sender: header was to check if you are entitled to
28135 cancel/supersede news (which is now solved by Cancel Locks instead,
28136 see another entry), generation of the header has been disabled by
28137 default. See the variables @code{message-required-headers},
28138 @code{message-required-news-headers}, and
28139 @code{message-required-mail-headers}.
28140
28141 @item
28142 Features from third party @file{message-utils.el} added to @file{message.el}.
28143
28144 Message now asks if you wish to remove @samp{(was: <old subject>)} from
28145 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
28146 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
28147 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
28148 appropriate headers and a note in the body for cross-postings and
28149 followups (see the variables @code{message-cross-post-@var{*}}).
28150
28151 @item
28152 References and X-Draft-From headers are no longer generated when you
28153 start composing messages and @code{message-generate-headers-first} is
28154 @code{nil}.
28155
28156 @item
28157 Easy inclusion of X-Faces headers. @xref{X-Face}.
28158
28159 @item
28160 Group Carbon Copy (GCC) quoting
28161
28162 To support groups that contains SPC and other weird characters, groups
28163 are quoted before they are placed in the Gcc: header. This means
28164 variables such as @code{gnus-message-archive-group} should no longer
28165 contain quote characters to make groups containing SPC work. Also, if
28166 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
28167 into two groups) you must change it to return the list
28168 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
28169 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
28170 was incorrect earlier, it just didn't generate any problems since it
28171 was inserted directly.
28172
28173 @item
28174 @code{message-insinuate-rmail}
28175
28176 @c FIXME should that not be 'message-user-agent?
28177 Adding @code{(message-insinuate-rmail)} and @code{(setq
28178 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
28179 compose, reply and forward messages in message-mode, where you can
28180 enjoy the power of @acronym{MML}.
28181
28182 @item
28183 @code{message-minibuffer-local-map}
28184
28185 The line below enables BBDB in resending a message:
28186 @lisp
28187 (define-key message-minibuffer-local-map [(tab)]
28188 'bbdb-complete-name)
28189 @end lisp
28190
28191 @item
28192 @code{gnus-posting-styles}
28193
28194 Add a new format of match like
28195 @lisp
28196 ((header "to" "larsi.*org")
28197 (Organization "Somewhere, Inc."))
28198 @end lisp
28199 The old format like the lines below is obsolete, but still accepted.
28200 @lisp
28201 (header "to" "larsi.*org"
28202 (Organization "Somewhere, Inc."))
28203 @end lisp
28204
28205 @item
28206 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
28207
28208 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
28209 added into these two variables. If you customized those, perhaps you
28210 need add those two headers too.
28211
28212 @item
28213 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
28214 composing messages, it is enabled by @code{use-hard-newlines}.
28215 Decoding format=flowed was present but not documented in earlier
28216 versions.
28217
28218 @item
28219 The option @code{mm-fill-flowed} can be used to disable treatment of
28220 ``format=flowed'' messages. Also, flowed text is disabled when sending
28221 inline PGP signed messages. @xref{Flowed text, , Flowed text,
28222 emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7)
28223 @c This entry is also present in the node "No Gnus".
28224
28225 @item
28226 Gnus supports the generation of RFC 2298 Disposition Notification requests.
28227
28228 This is invoked with the @kbd{C-c M-n} key binding from message mode.
28229
28230 @item
28231 Message supports the Importance: (RFC 2156) header.
28232
28233 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
28234 the valid values.
28235
28236 @item
28237 Gnus supports Cancel Locks in News.
28238
28239 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
28240 used to determine if you wrote an article or not (for canceling and
28241 superseding). Gnus generates a random password string the first time
28242 you post a message, and saves it in your @file{~/.emacs} using the Custom
28243 system. While the variable is called @code{canlock-password}, it is not
28244 security sensitive data. Publishing your canlock string on the web
28245 will not allow anyone to be able to anything she could not already do.
28246 The behavior can be changed by customizing @code{message-insert-canlock}.
28247
28248 @item
28249 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
28250 2015/3156) and @acronym{S/MIME} (RFC 2630--2633).
28251
28252 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
28253 additional Lisp libraries. This add several menu items to the
28254 Attachments menu, and @kbd{C-c RET} key bindings, when composing
28255 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
28256
28257 @item
28258 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
28259 C-m}.
28260
28261 This change was made to avoid conflict with the standard binding of
28262 @code{back-to-indentation}, which is also useful in message mode.
28263
28264 @item
28265 The default for @code{message-forward-show-mml} changed to the symbol
28266 @code{best}.
28267
28268 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
28269 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
28270 used when forwarding signed or encrypted messages, as the conversion
28271 invalidate the digital signature.
28272
28273 @item
28274 If @code{auto-compression-mode} is enabled, attachments are automatically
28275 decompressed when activated.
28276 @c FIXME: Does this affect article or message mode?
28277
28278 @item
28279 Support for non-@acronym{ASCII} domain names
28280
28281 Message supports non-@acronym{ASCII} domain names in From:, To: and
28282 Cc: and will query you whether to perform encoding when you try to
28283 send a message. The variable @code{message-use-idna} controls this.
28284 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
28285 and Cc: when you view a message. The variable @code{gnus-use-idna}
28286 controls this.
28287
28288 @item You can now drag and drop attachments to the Message buffer.
28289 See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}.
28290 @xref{MIME, ,MIME, message, Message Manual}.
28291 @c New in 5.10.9 / 5.11 (Emacs 22.1)
28292
28293 @item @code{auto-fill-mode} is enabled by default in Message mode.
28294 See @code{message-fill-column}. @xref{Various Message Variables, ,
28295 Message Headers, message, Message Manual}.
28296 @c New in Gnus 5.10.12 / 5.11 (Emacs 22.3)
28297
28298 @end itemize
28299
28300 @item Changes in back ends
28301 @c ***********************
28302
28303 @itemize @bullet
28304 @item
28305 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
28306
28307 @item
28308 The nndoc back end now supports mailman digests and exim bounces.
28309
28310 @item
28311 Gnus supports Maildir groups.
28312
28313 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
28314
28315 @item
28316 The nnml and nnfolder back ends store marks for each groups.
28317
28318 This makes it possible to take backup of nnml/nnfolder servers/groups
28319 separately of @file{~/.newsrc.eld}, while preserving marks. It also
28320 makes it possible to share articles and marks between users (without
28321 sharing the @file{~/.newsrc.eld} file) within, e.g., a department. It
28322 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
28323 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
28324 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
28325 another machine, Gnus will automatically use the @file{.marks} or
28326 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
28327 The new server variables @code{nnml-marks-is-evil} and
28328 @code{nnfolder-marks-is-evil} can be used to disable this feature.
28329
28330 @end itemize
28331
28332 @item Appearance
28333 @c *************
28334
28335 @itemize @bullet
28336
28337 @item
28338 The menu bar item (in Group and Summary buffer) named ``Misc'' has
28339 been renamed to ``Gnus''.
28340
28341 @item
28342 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
28343 renamed to ``Attachments''. Note that this menu also contains security
28344 related stuff, like signing and encryption (@pxref{Security, Security,,
28345 message, Message Manual}).
28346
28347 @item
28348 The tool bars have been updated to use GNOME icons in Group, Summary and
28349 Message mode. You can also customize the tool bars: @kbd{M-x
28350 customize-apropos RET -tool-bar$} should get you started. This is a new
28351 feature in Gnus 5.10.10. (Only for Emacs, not in XEmacs.)
28352
28353 @item The tool bar icons are now (de)activated correctly
28354 in the group buffer, see the variable @code{gnus-group-update-tool-bar}.
28355 Its default value depends on your Emacs version. This is a new feature
28356 in Gnus 5.10.9.
28357 @end itemize
28358
28359
28360 @item Miscellaneous changes
28361 @c ************************
28362
28363 @itemize @bullet
28364
28365 @item
28366 @code{gnus-agent}
28367
28368 The Gnus Agent has seen a major updated and is now enabled by default,
28369 and all nntp and nnimap servers from @code{gnus-select-method} and
28370 @code{gnus-secondary-select-method} are agentized by default. Earlier
28371 only the server in @code{gnus-select-method} was agentized by the
28372 default, and the agent was disabled by default. When the agent is
28373 enabled, headers are now also retrieved from the Agent cache instead
28374 of the back ends when possible. Earlier this only happened in the
28375 unplugged state. You can enroll or remove servers with @kbd{J a} and
28376 @kbd{J r} in the server buffer. Gnus will not download articles into
28377 the Agent cache, unless you instruct it to do so, though, by using
28378 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
28379 behavior of having the Agent disabled with @code{(setq gnus-agent
28380 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
28381 is not needed any more.
28382
28383 @item
28384 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
28385
28386 If one reads an article while plugged, and the article already exists
28387 in the Agent, it won't get downloaded once more. @code{(setq
28388 gnus-agent-cache nil)} reverts to the old behavior.
28389
28390 @item
28391 Dired integration
28392
28393 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
28394 bindings in dired buffers to send a file as an attachment, open a file
28395 using the appropriate mailcap entry, and print a file using the mailcap
28396 entry.
28397
28398 @item
28399 The format spec @code{%C} for positioning point has changed to @code{%*}.
28400
28401 @item
28402 @code{gnus-slave-unplugged}
28403
28404 A new command which starts Gnus offline in slave mode.
28405
28406 @end itemize
28407
28408 @end itemize
28409
28410 @node No Gnus
28411 @subsubsection No Gnus
28412 @cindex No Gnus
28413
28414 New features in No Gnus:
28415 @c FIXME: Gnus 5.12?
28416
28417 @include gnus-news.texi
28418
28419 @node Ma Gnus
28420 @subsubsection Ma Gnus
28421 @cindex Ma Gnus
28422
28423 I'm sure there will be lots of text here. It's really spelled 真
28424 Gnus.
28425
28426 New features in Ma Gnus:
28427
28428 @itemize @bullet
28429
28430 @item Changes in Message mode and related Gnus features
28431 @c ****************************************************
28432
28433 @itemize @bullet
28434
28435 @item
28436 The new hooks @code{gnus-gcc-pre-body-encode-hook} and
28437 @code{gnus-gcc-post-body-encode-hook} are run before/after encoding
28438 the message body of the Gcc copy of a sent message. See
28439 @xref{Archived Messages}.
28440
28441 @end itemize
28442
28443 @end itemize
28444
28445 @iftex
28446
28447 @page
28448 @node The Manual
28449 @section The Manual
28450 @cindex colophon
28451 @cindex manual
28452
28453 This manual was generated from a TeXinfo file and then run through
28454 either @code{texi2dvi}
28455 @iflatex
28456 or my own home-brewed TeXinfo to \LaTeX\ transformer,
28457 and then run through @code{latex} and @code{dvips}
28458 @end iflatex
28459 to get what you hold in your hands now.
28460
28461 The following conventions have been used:
28462
28463 @enumerate
28464
28465 @item
28466 This is a @samp{string}
28467
28468 @item
28469 This is a @kbd{keystroke}
28470
28471 @item
28472 This is a @file{file}
28473
28474 @item
28475 This is a @code{symbol}
28476
28477 @end enumerate
28478
28479 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
28480 mean:
28481
28482 @lisp
28483 (setq flargnoze "yes")
28484 @end lisp
28485
28486 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
28487
28488 @lisp
28489 (setq flumphel 'yes)
28490 @end lisp
28491
28492 @samp{yes} and @code{yes} are two @emph{very} different things---don't
28493 ever get them confused.
28494
28495 @iflatex
28496 @c @head
28497 Of course, everything in this manual is of vital interest, so you should
28498 read it all. Several times. However, if you feel like skimming the
28499 manual, look for that gnu head you should see in the margin over
28500 there---it means that what's being discussed is of more importance than
28501 the rest of the stuff. (On the other hand, if everything is infinitely
28502 important, how can anything be more important than that? Just one more
28503 of the mysteries of this world, I guess.)
28504 @end iflatex
28505
28506 @end iftex
28507
28508
28509 @node On Writing Manuals
28510 @section On Writing Manuals
28511
28512 I guess most manuals are written after-the-fact; documenting a program
28513 that's already there. This is not how this manual is written. When
28514 implementing something, I write the manual entry for that something
28515 straight away. I then see that it's difficult to explain the
28516 functionality, so I write how it's supposed to be, and then I change the
28517 implementation. Writing the documentation and writing the code go hand
28518 in hand.
28519
28520 This, of course, means that this manual has no, or little, flow. It
28521 documents absolutely everything in Gnus, but often not where you're
28522 looking for it. It is a reference manual, and not a guide to how to get
28523 started with Gnus.
28524
28525 That would be a totally different book, that should be written using the
28526 reference manual as source material. It would look quite different.
28527
28528
28529 @page
28530 @node Terminology
28531 @section Terminology
28532
28533 @cindex terminology
28534 @table @dfn
28535
28536 @item news
28537 @cindex news
28538 This is what you are supposed to use this thing for---reading news.
28539 News is generally fetched from a nearby @acronym{NNTP} server, and is
28540 generally publicly available to everybody. If you post news, the entire
28541 world is likely to read just what you have written, and they'll all
28542 snigger mischievously. Behind your back.
28543
28544 @item mail
28545 @cindex mail
28546 Everything that's delivered to you personally is mail. Some news/mail
28547 readers (like Gnus) blur the distinction between mail and news, but
28548 there is a difference. Mail is private. News is public. Mailing is
28549 not posting, and replying is not following up.
28550
28551 @item reply
28552 @cindex reply
28553 Send a mail to the person who has written what you are reading.
28554
28555 @item follow up
28556 @cindex follow up
28557 Post an article to the current newsgroup responding to the article you
28558 are reading.
28559
28560 @item back end
28561 @cindex back end
28562 Gnus considers mail and news to be mostly the same, really. The only
28563 difference is how to access the actual articles. News articles are
28564 commonly fetched via the protocol @acronym{NNTP}, whereas mail
28565 messages could be read from a file on the local disk. The internal
28566 architecture of Gnus thus comprises a ``front end'' and a number of
28567 ``back ends''. Internally, when you enter a group (by hitting
28568 @key{RET}, say), you thereby invoke a function in the front end in
28569 Gnus. The front end then ``talks'' to a back end and says things like
28570 ``Give me the list of articles in the foo group'' or ``Show me article
28571 number 4711''.
28572
28573 So a back end mainly defines either a protocol (the @code{nntp} back
28574 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
28575 accesses mail via @acronym{IMAP}) or a file format and directory
28576 layout (the @code{nnspool} back end accesses news via the common
28577 ``spool directory'' format, the @code{nnml} back end access mail via a
28578 file format and directory layout that's quite similar).
28579
28580 Gnus does not handle the underlying media, so to speak---this is all
28581 done by the back ends. A back end is a collection of functions to
28582 access the articles.
28583
28584 However, sometimes the term ``back end'' is also used where ``server''
28585 would have been more appropriate. And then there is the term ``select
28586 method'' which can mean either. The Gnus terminology can be quite
28587 confusing.
28588
28589 @item native
28590 @cindex native
28591 Gnus will always use one method (and back end) as the @dfn{native}, or
28592 default, way of getting news. Groups from the native select method
28593 have names like @samp{gnu.emacs.gnus}.
28594
28595 @item foreign
28596 @cindex foreign
28597 You can also have any number of foreign groups active at the same
28598 time. These are groups that use non-native non-secondary back ends
28599 for getting news. Foreign groups have names like
28600 @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}.
28601
28602 @item secondary
28603 @cindex secondary
28604 Secondary back ends are somewhere half-way between being native and
28605 being foreign, but they mostly act like they are native, but they, too
28606 have names like @samp{nntp+news.gmane.org:gmane.emacs.gnus.devel}.
28607
28608 @item article
28609 @cindex article
28610 A message that has been posted as news.
28611
28612 @item mail message
28613 @cindex mail message
28614 A message that has been mailed.
28615
28616 @item message
28617 @cindex message
28618 A mail message or news article
28619
28620 @item head
28621 @cindex head
28622 The top part of a message, where administrative information (etc.)@: is
28623 put.
28624
28625 @item body
28626 @cindex body
28627 The rest of an article. Everything not in the head is in the
28628 body.
28629
28630 @item header
28631 @cindex header
28632 A line from the head of an article.
28633
28634 @item headers
28635 @cindex headers
28636 A collection of such lines, or a collection of heads. Or even a
28637 collection of @acronym{NOV} lines.
28638
28639 @item @acronym{NOV}
28640 @cindex @acronym{NOV}
28641 @acronym{NOV} stands for News OverView, which is a type of news server
28642 header which provide datas containing the condensed header information
28643 of articles. They are produced by the server itself; in the @code{nntp}
28644 back end Gnus uses the ones that the @acronym{NNTP} server makes, but
28645 Gnus makes them by itself for some backends (in particular, @code{nnml}).
28646
28647 When Gnus enters a group, it asks the back end for the headers of all
28648 unread articles in the group. Most servers support the News OverView
28649 format, which is more compact and much faster to read and parse than the
28650 normal @sc{head} format.
28651
28652 The @acronym{NOV} data consist of one or more text lines (@pxref{Text
28653 Lines, ,Motion by Text Lines, elisp, The Emacs Lisp Reference Manual})
28654 where each line has the header information of one article. The header
28655 information is a tab-separated series of the header's contents including
28656 an article number, a subject, an author, a date, a message-id,
28657 references, etc.
28658
28659 Those data enable Gnus to generate summary lines quickly. However, if
28660 the server does not support @acronym{NOV} or you disable it purposely or
28661 for some reason, Gnus will try to generate the header information by
28662 parsing each article's headers one by one. It will take time.
28663 Therefore, it is not usually a good idea to set nn*-nov-is-evil
28664 (@pxref{Slow/Expensive Connection}) to a non-@code{nil} value unless you
28665 know that the server makes wrong @acronym{NOV} data.
28666
28667 @item level
28668 @cindex levels
28669 Each group is subscribed at some @dfn{level} or other (1--9). The ones
28670 that have a lower level are ``more'' subscribed than the groups with a
28671 higher level. In fact, groups on levels 1--5 are considered
28672 @dfn{subscribed}; 6--7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
28673 are @dfn{killed}. Commands for listing groups and scanning for new
28674 articles will all use the numeric prefix as @dfn{working level}.
28675
28676 @item killed groups
28677 @cindex killed groups
28678 No information on killed groups is stored or updated, which makes killed
28679 groups much easier to handle than subscribed groups.
28680
28681 @item zombie groups
28682 @cindex zombie groups
28683 Just like killed groups, only slightly less dead.
28684
28685 @item active file
28686 @cindex active file
28687 The news server has to keep track of what articles it carries, and what
28688 groups exist. All this information in stored in the active file, which
28689 is rather large, as you might surmise.
28690
28691 @item bogus groups
28692 @cindex bogus groups
28693 A group that exists in the @file{.newsrc} file, but isn't known to the
28694 server (i.e., it isn't in the active file), is a @emph{bogus group}.
28695 This means that the group probably doesn't exist (any more).
28696
28697 @item activating
28698 @cindex activating groups
28699 The act of asking the server for info on a group and computing the
28700 number of unread articles is called @dfn{activating the group}.
28701 Un-activated groups are listed with @samp{*} in the group buffer.
28702
28703 @item spool
28704 @cindex spool
28705 News servers store their articles locally in one fashion or other.
28706 One old-fashioned storage method is to have just one file per
28707 article. That's called a ``traditional spool''.
28708
28709 @item server
28710 @cindex server
28711 A machine one can connect to and get news (or mail) from.
28712
28713 @item select method
28714 @cindex select method
28715 A structure that specifies the back end, the server and the virtual
28716 server settings.
28717
28718 @item virtual server
28719 @cindex virtual server
28720 A named select method. Since a select method defines all there is to
28721 know about connecting to a (physical) server, taking the thing as a
28722 whole is a virtual server.
28723
28724 @item washing
28725 @cindex washing
28726 Taking a buffer and running it through a filter of some sort. The
28727 result will (more often than not) be cleaner and more pleasing than the
28728 original.
28729
28730 @item ephemeral groups
28731 @cindex ephemeral groups
28732 @cindex temporary groups
28733 Most groups store data on what articles you have read. @dfn{Ephemeral}
28734 groups are groups that will have no data stored---when you exit the
28735 group, it'll disappear into the aether.
28736
28737 @item solid groups
28738 @cindex solid groups
28739 This is the opposite of ephemeral groups. All groups listed in the
28740 group buffer are solid groups.
28741
28742 @item sparse articles
28743 @cindex sparse articles
28744 These are article placeholders shown in the summary buffer when
28745 @code{gnus-build-sparse-threads} has been switched on.
28746
28747 @item threading
28748 @cindex threading
28749 To put responses to articles directly after the articles they respond
28750 to---in a hierarchical fashion.
28751
28752 @item root
28753 @cindex root
28754 @cindex thread root
28755 The first article in a thread is the root. It is the ancestor of all
28756 articles in the thread.
28757
28758 @item parent
28759 @cindex parent
28760 An article that has responses.
28761
28762 @item child
28763 @cindex child
28764 An article that responds to a different article---its parent.
28765
28766 @item digest
28767 @cindex digest
28768 A collection of messages in one file. The most common digest format is
28769 specified by RFC 1153.
28770
28771 @item splitting
28772 @cindex splitting, terminology
28773 @cindex mail sorting
28774 @cindex mail filtering (splitting)
28775 The action of sorting your emails according to certain rules. Sometimes
28776 incorrectly called mail filtering.
28777
28778 @end table
28779
28780
28781 @page
28782 @node Customization
28783 @section Customization
28784 @cindex general customization
28785
28786 All variables are properly documented elsewhere in this manual. This
28787 section is designed to give general pointers on how to customize Gnus
28788 for some quite common situations.
28789
28790 @menu
28791 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
28792 * Slow Terminal Connection:: You run a remote Emacs.
28793 * Little Disk Space:: You feel that having large setup files is icky.
28794 * Slow Machine:: You feel like buying a faster machine.
28795 @end menu
28796
28797
28798 @node Slow/Expensive Connection
28799 @subsection Slow/Expensive Connection
28800
28801 If you run Emacs on a machine locally, and get your news from a machine
28802 over some very thin strings, you want to cut down on the amount of data
28803 Gnus has to get from the server.
28804
28805 @table @code
28806
28807 @item gnus-read-active-file
28808 Set this to @code{nil}, which will inhibit Gnus from requesting the
28809 entire active file from the server. This file is often very large. You
28810 also have to set @code{gnus-check-new-newsgroups} and
28811 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
28812 doesn't suddenly decide to fetch the active file anyway.
28813
28814 @item gnus-nov-is-evil
28815 @vindex gnus-nov-is-evil
28816 Usually this one must @emph{always} be @code{nil} (which is the
28817 default). If, for example, you wish to not use @acronym{NOV}
28818 (@pxref{Terminology}) with the @code{nntp} back end (@pxref{Crosspost
28819 Handling}), set @code{nntp-nov-is-evil} to a non-@code{nil} value
28820 instead of setting this. But you normally do not need to set
28821 @code{nntp-nov-is-evil} since Gnus by itself will detect whether the
28822 @acronym{NNTP} server supports @acronym{NOV}. Anyway, grabbing article
28823 headers from the @acronym{NNTP} server will not be very fast if you tell
28824 Gnus not to use @acronym{NOV}.
28825
28826 As the variables for the other back ends, there are
28827 @code{nndiary-nov-is-evil}, @code{nndir-nov-is-evil},
28828 @code{nnfolder-nov-is-evil}, @code{nnimap-nov-is-evil},
28829 @code{nnml-nov-is-evil}, and @code{nnspool-nov-is-evil}. Note that a
28830 non-@code{nil} value for @code{gnus-nov-is-evil} overrides all those
28831 variables.
28832 @end table
28833
28834
28835 @node Slow Terminal Connection
28836 @subsection Slow Terminal Connection
28837
28838 Let's say you use your home computer for dialing up the system that runs
28839 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
28840 possible) the amount of data sent over the wires.
28841
28842 @table @code
28843
28844 @item gnus-auto-center-summary
28845 Set this to @code{nil} to inhibit Gnus from re-centering the summary
28846 buffer all the time. If it is @code{vertical}, do only vertical
28847 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
28848 horizontal and vertical recentering.
28849
28850 @item gnus-visible-headers
28851 Cut down on the headers included in the articles to the
28852 minimum. You can, in fact, make do without them altogether---most of the
28853 useful data is in the summary buffer, anyway. Set this variable to
28854 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
28855
28856 Use the following to enable all the available hiding features:
28857 @lisp
28858 (setq gnus-treat-hide-headers 'head
28859 gnus-treat-hide-signature t
28860 gnus-treat-hide-citation t)
28861 @end lisp
28862
28863 @item gnus-use-full-window
28864 By setting this to @code{nil}, you can make all the windows smaller.
28865 While this doesn't really cut down much generally, it means that you
28866 have to see smaller portions of articles before deciding that you didn't
28867 want to read them anyway.
28868
28869 @item gnus-thread-hide-subtree
28870 If this is non-@code{nil}, all threads in the summary buffer will be
28871 hidden initially.
28872
28873
28874 @item gnus-updated-mode-lines
28875 If this is @code{nil}, Gnus will not put information in the buffer mode
28876 lines, which might save some time.
28877 @end table
28878
28879
28880 @node Little Disk Space
28881 @subsection Little Disk Space
28882 @cindex disk space
28883
28884 The startup files can get rather large, so you may want to cut their
28885 sizes a bit if you are running out of space.
28886
28887 @table @code
28888
28889 @item gnus-save-newsrc-file
28890 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
28891 only save @file{.newsrc.eld}. This means that you will not be able to
28892 use any other newsreaders than Gnus. This variable is @code{t} by
28893 default.
28894
28895 @item gnus-read-newsrc-file
28896 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
28897 only read @file{.newsrc.eld}. This means that you will not be able to
28898 use any other newsreaders than Gnus. This variable is @code{t} by
28899 default.
28900
28901 @item gnus-save-killed-list
28902 If this is @code{nil}, Gnus will not save the list of dead groups. You
28903 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
28904 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
28905 variable to @code{nil}. This variable is @code{t} by default.
28906
28907 @end table
28908
28909
28910 @node Slow Machine
28911 @subsection Slow Machine
28912 @cindex slow machine
28913
28914 If you have a slow machine, or are just really impatient, there are a
28915 few things you can do to make Gnus run faster.
28916
28917 Set @code{gnus-check-new-newsgroups} and
28918 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
28919
28920 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
28921 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
28922 summary buffer faster. Also @pxref{Slow/Expensive Connection}.
28923
28924
28925 @page
28926 @node Troubleshooting
28927 @section Troubleshooting
28928 @cindex troubleshooting
28929
28930 Gnus works @emph{so} well straight out of the box---I can't imagine any
28931 problems, really.
28932
28933 Ahem.
28934
28935 @enumerate
28936
28937 @item
28938 Make sure your computer is switched on.
28939
28940 @item
28941 Make sure that you really load the current Gnus version. If you have
28942 been running @sc{gnus}, you need to exit Emacs and start it up again before
28943 Gnus will work.
28944
28945 @item
28946 Try doing an @kbd{M-x gnus-version}. If you get something that looks
28947 like @c
28948 @samp{Gnus v5.13} @c Adjust ../Makefile.in if you change this line!
28949 @c
28950 you have the right files loaded. Otherwise you have some old @file{.el}
28951 files lying around. Delete these.
28952
28953 @item
28954 Read the help group (@kbd{G h} in the group buffer) for a
28955 @acronym{FAQ} and a how-to.
28956
28957 @item
28958 @vindex max-lisp-eval-depth
28959 Gnus works on many recursive structures, and in some extreme (and very
28960 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
28961 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
28962 something like that.
28963 @end enumerate
28964
28965 If all else fails, report the problem as a bug.
28966
28967 @cindex bugs
28968 @cindex reporting bugs
28969
28970 @kindex M-x gnus-bug
28971 @findex gnus-bug
28972 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
28973 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
28974 me the backtrace. I will fix bugs, but I can only fix them if you send
28975 me a precise description as to how to reproduce the bug.
28976
28977 You really can never be too detailed in a bug report. Always use the
28978 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
28979 a 10Kb mail each time you use it, and even if you have sent me your
28980 environment 500 times before. I don't care. I want the full info each
28981 time.
28982
28983 It is also important to remember that I have no memory whatsoever. If
28984 you send a bug report, and I send you a reply, and then you just send
28985 back ``No, it's not! Moron!'', I will have no idea what you are
28986 insulting me about. Always over-explain everything. It's much easier
28987 for all of us---if I don't have all the information I need, I will just
28988 mail you and ask for more info, and everything takes more time.
28989
28990 If the problem you're seeing is very visual, and you can't quite explain
28991 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
28992 it somewhere it can be reached, and include the URL of the picture in
28993 the bug report.
28994
28995 @cindex patches
28996 If you would like to contribute a patch to fix bugs or make
28997 improvements, please produce the patch using @samp{diff -u}.
28998
28999 @cindex edebug
29000 If you want to debug your problem further before reporting, possibly
29001 in order to solve the problem yourself and send a patch, you can use
29002 edebug. Debugging Lisp code is documented in the Elisp manual
29003 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
29004 Lisp Reference Manual}). To get you started with edebug, consider if
29005 you discover some weird behavior when pressing @kbd{c}, the first
29006 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
29007 the documentation buffer that leads you to the function definition,
29008 then press @kbd{M-x edebug-defun RET} with point inside that function,
29009 return to Gnus and press @kbd{c} to invoke the code. You will be
29010 placed in the lisp buffer and can single step using @kbd{SPC} and
29011 evaluate expressions using @kbd{M-:} or inspect variables using
29012 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
29013 @kbd{c} or @kbd{g}.
29014
29015 @cindex elp
29016 @cindex profile
29017 @cindex slow
29018 Sometimes, a problem do not directly generate an elisp error but
29019 manifests itself by causing Gnus to be very slow. In these cases, you
29020 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
29021 slow, and then try to analyze the backtrace (repeating the procedure
29022 helps isolating the real problem areas).
29023
29024 A fancier approach is to use the elisp profiler, ELP@. The profiler is
29025 (or should be) fully documented elsewhere, but to get you started
29026 there are a few steps that need to be followed. First, instrument the
29027 part of Gnus you are interested in for profiling, e.g., @kbd{M-x
29028 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
29029 RET message}. Then perform the operation that is slow and press
29030 @kbd{M-x elp-results}. You will then see which operations that takes
29031 time, and can debug them further. If the entire operation takes much
29032 longer than the time spent in the slowest function in the profiler
29033 output, you probably profiled the wrong part of Gnus. To reset
29034 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
29035 elp-restore-all} is supposed to remove profiling, but given the
29036 complexities and dynamic code generation in Gnus, it might not always
29037 work perfectly.
29038
29039 @cindex gnu.emacs.gnus
29040 @cindex ding mailing list
29041 If you just need help, you are better off asking on
29042 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
29043 @email{ding@@gnus.org, the ding mailing list}. Write to
29044 @email{ding-request@@gnus.org} to subscribe.
29045
29046
29047 @page
29048 @node Gnus Reference Guide
29049 @section Gnus Reference Guide
29050
29051 It is my hope that other people will figure out smart stuff that Gnus
29052 can do, and that other people will write those smart things as well. To
29053 facilitate that I thought it would be a good idea to describe the inner
29054 workings of Gnus. And some of the not-so-inner workings, while I'm at
29055 it.
29056
29057 You can never expect the internals of a program not to change, but I
29058 will be defining (in some details) the interface between Gnus and its
29059 back ends (this is written in stone), the format of the score files
29060 (ditto), data structures (some are less likely to change than others)
29061 and general methods of operation.
29062
29063 @menu
29064 * Gnus Utility Functions:: Common functions and variable to use.
29065 * Back End Interface:: How Gnus communicates with the servers.
29066 * Score File Syntax:: A BNF definition of the score file standard.
29067 * Headers:: How Gnus stores headers internally.
29068 * Ranges:: A handy format for storing mucho numbers.
29069 * Group Info:: The group info format.
29070 * Extended Interactive:: Symbolic prefixes and stuff.
29071 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
29072 * Various File Formats:: Formats of files that Gnus use.
29073 @end menu
29074
29075
29076 @node Gnus Utility Functions
29077 @subsection Gnus Utility Functions
29078 @cindex Gnus utility functions
29079 @cindex utility functions
29080 @cindex functions
29081 @cindex internal variables
29082
29083 When writing small functions to be run from hooks (and stuff), it's
29084 vital to have access to the Gnus internal functions and variables.
29085 Below is a list of the most common ones.
29086
29087 @table @code
29088
29089 @item gnus-newsgroup-name
29090 @vindex gnus-newsgroup-name
29091 This variable holds the name of the current newsgroup.
29092
29093 @item gnus-find-method-for-group
29094 @findex gnus-find-method-for-group
29095 A function that returns the select method for @var{group}.
29096
29097 @item gnus-group-real-name
29098 @findex gnus-group-real-name
29099 Takes a full (prefixed) Gnus group name, and returns the unprefixed
29100 name.
29101
29102 @item gnus-group-prefixed-name
29103 @findex gnus-group-prefixed-name
29104 Takes an unprefixed group name and a select method, and returns the full
29105 (prefixed) Gnus group name.
29106
29107 @item gnus-get-info
29108 @findex gnus-get-info
29109 Returns the group info list for @var{group} (@pxref{Group Info}).
29110
29111 @item gnus-group-unread
29112 @findex gnus-group-unread
29113 The number of unread articles in @var{group}, or @code{t} if that is
29114 unknown.
29115
29116 @item gnus-active
29117 @findex gnus-active
29118 The active entry (i.e., a cons cell containing the lowest and highest
29119 article numbers) for @var{group}.
29120
29121 @item gnus-set-active
29122 @findex gnus-set-active
29123 Set the active entry for @var{group}.
29124
29125 @item gnus-add-current-to-buffer-list
29126 @findex gnus-add-current-to-buffer-list
29127 Adds the current buffer to the list of buffers to be killed on Gnus
29128 exit.
29129
29130 @item gnus-continuum-version
29131 @findex gnus-continuum-version
29132 Takes a Gnus version string as a parameter and returns a floating point
29133 number. Earlier versions will always get a lower number than later
29134 versions.
29135
29136 @item gnus-group-read-only-p
29137 @findex gnus-group-read-only-p
29138 Says whether @var{group} is read-only or not.
29139
29140 @item gnus-news-group-p
29141 @findex gnus-news-group-p
29142 Says whether @var{group} came from a news back end.
29143
29144 @item gnus-ephemeral-group-p
29145 @findex gnus-ephemeral-group-p
29146 Says whether @var{group} is ephemeral or not.
29147
29148 @item gnus-server-to-method
29149 @findex gnus-server-to-method
29150 Returns the select method corresponding to @var{server}.
29151
29152 @item gnus-server-equal
29153 @findex gnus-server-equal
29154 Says whether two virtual servers are essentially equal. For instance,
29155 two virtual servers may have server parameters in different order, but
29156 this function will consider them equal.
29157
29158 @item gnus-group-native-p
29159 @findex gnus-group-native-p
29160 Says whether @var{group} is native or not.
29161
29162 @item gnus-group-secondary-p
29163 @findex gnus-group-secondary-p
29164 Says whether @var{group} is secondary or not.
29165
29166 @item gnus-group-foreign-p
29167 @findex gnus-group-foreign-p
29168 Says whether @var{group} is foreign or not.
29169
29170 @item gnus-group-find-parameter
29171 @findex gnus-group-find-parameter
29172 Returns the parameter list of @var{group} (@pxref{Group Parameters}).
29173 If given a second parameter, returns the value of that parameter for
29174 @var{group}.
29175
29176 @item gnus-group-set-parameter
29177 @findex gnus-group-set-parameter
29178 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
29179
29180 @item gnus-narrow-to-body
29181 @findex gnus-narrow-to-body
29182 Narrows the current buffer to the body of the article.
29183
29184 @item gnus-check-backend-function
29185 @findex gnus-check-backend-function
29186 Takes two parameters, @var{function} and @var{group}. If the back end
29187 @var{group} comes from supports @var{function}, return non-@code{nil}.
29188
29189 @lisp
29190 (gnus-check-backend-function "request-scan" "nnml:misc")
29191 @result{} t
29192 @end lisp
29193
29194 @item gnus-read-method
29195 @findex gnus-read-method
29196 Prompts the user for a select method.
29197
29198 @end table
29199
29200
29201 @node Back End Interface
29202 @subsection Back End Interface
29203
29204 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
29205 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
29206 server is a @dfn{back end} and some @dfn{back end variables}. As examples
29207 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
29208 examples of the latter we have @code{nntp-port-number} and
29209 @code{nnmbox-directory}.
29210
29211 When Gnus asks for information from a back end---say @code{nntp}---on
29212 something, it will normally include a virtual server name in the
29213 function parameters. (If not, the back end should use the ``current''
29214 virtual server.) For instance, @code{nntp-request-list} takes a virtual
29215 server as its only (optional) parameter. If this virtual server hasn't
29216 been opened, the function should fail.
29217
29218 Note that a virtual server name has no relation to some physical server
29219 name. Take this example:
29220
29221 @lisp
29222 (nntp "odd-one"
29223 (nntp-address "ifi.uio.no")
29224 (nntp-port-number 4324))
29225 @end lisp
29226
29227 Here the virtual server name is @samp{odd-one} while the name of
29228 the physical server is @samp{ifi.uio.no}.
29229
29230 The back ends should be able to switch between several virtual servers.
29231 The standard back ends implement this by keeping an alist of virtual
29232 server environments that they pull down/push up when needed.
29233
29234 There are two groups of interface functions: @dfn{required functions},
29235 which must be present, and @dfn{optional functions}, which Gnus will
29236 always check for presence before attempting to call 'em.
29237
29238 All these functions are expected to return data in the buffer
29239 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
29240 unfortunately named, but we'll have to live with it. When I talk about
29241 @dfn{resulting data}, I always refer to the data in that buffer. When I
29242 talk about @dfn{return value}, I talk about the function value returned by
29243 the function call. Functions that fail should return @code{nil} as the
29244 return value.
29245
29246 Some back ends could be said to be @dfn{server-forming} back ends, and
29247 some might be said not to be. The latter are back ends that generally
29248 only operate on one group at a time, and have no concept of ``server'';
29249 they have a group, and they deliver info on that group and nothing
29250 more.
29251
29252 Gnus identifies each message by way of group name and article number. A
29253 few remarks about these article numbers might be useful. First of all,
29254 the numbers are positive integers. Secondly, it is normally not
29255 possible for later articles to ``re-use'' older article numbers without
29256 confusing Gnus. That is, if a group has ever contained a message
29257 numbered 42, then no other message may get that number, or Gnus will get
29258 mightily confused.@footnote{See the function
29259 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
29260 Third, article numbers must be assigned in order of arrival in the
29261 group; this is not necessarily the same as the date of the message.
29262
29263 The previous paragraph already mentions all the ``hard'' restrictions that
29264 article numbers must fulfill. But it seems that it might be useful to
29265 assign @emph{consecutive} article numbers, for Gnus gets quite confused
29266 if there are holes in the article numbering sequence. However, due to
29267 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
29268 also useful for the article numbers to start at 1 to avoid running out
29269 of numbers as long as possible.
29270
29271 Note that by convention, back ends are named @code{nnsomething}, but
29272 Gnus also comes with some @code{nnnotbackends}, such as
29273 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
29274
29275 In the examples and definitions I will refer to the imaginary back end
29276 @code{nnchoke}.
29277
29278 @cindex @code{nnchoke}
29279
29280 @menu
29281 * Required Back End Functions:: Functions that must be implemented.
29282 * Optional Back End Functions:: Functions that need not be implemented.
29283 * Error Messaging:: How to get messages and report errors.
29284 * Writing New Back Ends:: Extending old back ends.
29285 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
29286 * Mail-like Back Ends:: Some tips on mail back ends.
29287 @end menu
29288
29289
29290 @node Required Back End Functions
29291 @subsubsection Required Back End Functions
29292
29293 @table @code
29294
29295 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
29296
29297 @var{articles} is either a range of article numbers or a list of
29298 @code{Message-ID}s. Current back ends do not fully support either---only
29299 sequences (lists) of article numbers, and most back ends do not support
29300 retrieval of @code{Message-ID}s. But they should try for both.
29301
29302 The result data should either be HEADs or @acronym{NOV} lines, and the result
29303 value should either be @code{headers} or @code{nov} to reflect this.
29304 This might later be expanded to @code{various}, which will be a mixture
29305 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
29306
29307 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
29308 headers'', in some meaning of the word. This is generally done by
29309 fetching (at most) @var{fetch-old} extra headers less than the smallest
29310 article number in @code{articles}, and filling the gaps as well. The
29311 presence of this parameter can be ignored if the back end finds it
29312 cumbersome to follow the request. If this is non-@code{nil} and not a
29313 number, do maximum fetches.
29314
29315 Here's an example HEAD:
29316
29317 @example
29318 221 1056 Article retrieved.
29319 Path: ifi.uio.no!sturles
29320 From: sturles@@ifi.uio.no (Sturle Sunde)
29321 Newsgroups: ifi.discussion
29322 Subject: Re: Something very droll
29323 Date: 27 Oct 1994 14:02:57 +0100
29324 Organization: Dept. of Informatics, University of Oslo, Norway
29325 Lines: 26
29326 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
29327 References: <38jdmq$4qu@@visbur.ifi.uio.no>
29328 NNTP-Posting-Host: holmenkollen.ifi.uio.no
29329 .
29330 @end example
29331
29332 So a @code{headers} return value would imply that there's a number of
29333 these in the data buffer.
29334
29335 Here's a BNF definition of such a buffer:
29336
29337 @example
29338 headers = *head
29339 head = error / valid-head
29340 error-message = [ "4" / "5" ] 2number " " <error message> eol
29341 valid-head = valid-message *header "." eol
29342 valid-message = "221 " <number> " Article retrieved." eol
29343 header = <text> eol
29344 @end example
29345
29346 @cindex BNF
29347 (The version of BNF used here is the one used in RFC822.)
29348
29349 If the return value is @code{nov}, the data buffer should contain
29350 @dfn{network overview database} lines. These are basically fields
29351 separated by tabs.
29352
29353 @example
29354 nov-buffer = *nov-line
29355 nov-line = field 7*8[ <TAB> field ] eol
29356 field = <text except TAB>
29357 @end example
29358
29359 For a closer look at what should be in those fields,
29360 @pxref{Headers}.
29361
29362
29363 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
29364
29365 @var{server} is here the virtual server name. @var{definitions} is a
29366 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
29367
29368 If the server can't be opened, no error should be signaled. The back end
29369 may then choose to refuse further attempts at connecting to this
29370 server. In fact, it should do so.
29371
29372 If the server is opened already, this function should return a
29373 non-@code{nil} value. There should be no data returned.
29374
29375
29376 @item (nnchoke-close-server &optional SERVER)
29377
29378 Close connection to @var{server} and free all resources connected
29379 to it. Return @code{nil} if the server couldn't be closed for some
29380 reason.
29381
29382 There should be no data returned.
29383
29384
29385 @item (nnchoke-request-close)
29386
29387 Close connection to all servers and free all resources that the back end
29388 have reserved. All buffers that have been created by that back end
29389 should be killed. (Not the @code{nntp-server-buffer}, though.) This
29390 function is generally only called when Gnus is shutting down.
29391
29392 There should be no data returned.
29393
29394
29395 @item (nnchoke-server-opened &optional SERVER)
29396
29397 If @var{server} is the current virtual server, and the connection to the
29398 physical server is alive, then this function should return a
29399 non-@code{nil} value. This function should under no circumstances
29400 attempt to reconnect to a server we have lost connection to.
29401
29402 There should be no data returned.
29403
29404
29405 @item (nnchoke-status-message &optional SERVER)
29406
29407 This function should return the last error message from @var{server}.
29408
29409 There should be no data returned.
29410
29411
29412 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
29413
29414 The result data from this function should be the article specified by
29415 @var{article}. This might either be a @code{Message-ID} or a number.
29416 It is optional whether to implement retrieval by @code{Message-ID}, but
29417 it would be nice if that were possible.
29418
29419 If @var{to-buffer} is non-@code{nil}, the result data should be returned
29420 in this buffer instead of the normal data buffer. This is to make it
29421 possible to avoid copying large amounts of data from one buffer to
29422 another, while Gnus mainly requests articles to be inserted directly
29423 into its article buffer.
29424
29425 If it is at all possible, this function should return a cons cell where
29426 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
29427 the article number. This will enable Gnus to find out what the real
29428 group and article numbers are when fetching articles by
29429 @code{Message-ID}. If this isn't possible, @code{t} should be returned
29430 on successful article retrieval.
29431
29432
29433 @item (nnchoke-request-group GROUP &optional SERVER FAST INFO)
29434
29435 Get data on @var{group}. This function also has the side effect of
29436 making @var{group} the current group.
29437
29438 If @var{fast}, don't bother to return useful data, just make @var{group}
29439 the current group.
29440
29441 If @var{info}, it allows the backend to update the group info
29442 structure.
29443
29444 Here's an example of some result data and a definition of the same:
29445
29446 @example
29447 211 56 1000 1059 ifi.discussion
29448 @end example
29449
29450 The first number is the status, which should be 211. Next is the
29451 total number of articles in the group, the lowest article number, the
29452 highest article number, and finally the group name. Note that the total
29453 number of articles may be less than one might think while just
29454 considering the highest and lowest article numbers, but some articles
29455 may have been canceled. Gnus just discards the total-number, so
29456 whether one should take the bother to generate it properly (if that is a
29457 problem) is left as an exercise to the reader. If the group contains no
29458 articles, the lowest article number should be reported as 1 and the
29459 highest as 0.
29460
29461 @example
29462 group-status = [ error / info ] eol
29463 error = [ "4" / "5" ] 2<number> " " <Error message>
29464 info = "211 " 3* [ <number> " " ] <string>
29465 @end example
29466
29467
29468 @item (nnchoke-close-group GROUP &optional SERVER)
29469
29470 Close @var{group} and free any resources connected to it. This will be
29471 a no-op on most back ends.
29472
29473 There should be no data returned.
29474
29475
29476 @item (nnchoke-request-list &optional SERVER)
29477
29478 Return a list of all groups available on @var{server}. And that means
29479 @emph{all}.
29480
29481 Here's an example from a server that only carries two groups:
29482
29483 @example
29484 ifi.test 0000002200 0000002000 y
29485 ifi.discussion 3324 3300 n
29486 @end example
29487
29488 On each line we have a group name, then the highest article number in
29489 that group, the lowest article number, and finally a flag. If the group
29490 contains no articles, the lowest article number should be reported as 1
29491 and the highest as 0.
29492
29493 @example
29494 active-file = *active-line
29495 active-line = name " " <number> " " <number> " " flags eol
29496 name = <string>
29497 flags = "n" / "y" / "m" / "x" / "j" / "=" name
29498 @end example
29499
29500 The flag says whether the group is read-only (@samp{n}), is moderated
29501 (@samp{m}), is dead (@samp{x}), is aliased to some other group
29502 (@samp{=other-group}) or none of the above (@samp{y}).
29503
29504
29505 @item (nnchoke-request-post &optional SERVER)
29506
29507 This function should post the current buffer. It might return whether
29508 the posting was successful or not, but that's not required. If, for
29509 instance, the posting is done asynchronously, it has generally not been
29510 completed by the time this function concludes. In that case, this
29511 function should set up some kind of sentinel to beep the user loud and
29512 clear if the posting could not be completed.
29513
29514 There should be no result data from this function.
29515
29516 @end table
29517
29518
29519 @node Optional Back End Functions
29520 @subsubsection Optional Back End Functions
29521
29522 @table @code
29523
29524 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
29525
29526 @var{groups} is a list of groups, and this function should request data
29527 on all those groups. How it does it is of no concern to Gnus, but it
29528 should attempt to do this in a speedy fashion.
29529
29530 The return value of this function can be either @code{active} or
29531 @code{group}, which says what the format of the result data is. The
29532 former is in the same format as the data from
29533 @code{nnchoke-request-list}, while the latter is a buffer full of lines
29534 in the same format as @code{nnchoke-request-group} gives.
29535
29536 @example
29537 group-buffer = *active-line / *group-status
29538 @end example
29539
29540
29541 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
29542
29543 A Gnus group info (@pxref{Group Info}) is handed to the back end for
29544 alterations. This comes in handy if the back end really carries all
29545 the information (as is the case with virtual and imap groups). This
29546 function should destructively alter the info to suit its needs, and
29547 should return a non-@code{nil} value (exceptionally,
29548 @code{nntp-request-update-info} always returns @code{nil} not to waste
29549 the network resources).
29550
29551 There should be no result data from this function.
29552
29553
29554 @item (nnchoke-request-type GROUP &optional ARTICLE)
29555
29556 When the user issues commands for ``sending news'' (@kbd{F} in the
29557 summary buffer, for instance), Gnus has to know whether the article the
29558 user is following up on is news or mail. This function should return
29559 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
29560 is mail and @code{unknown} if the type can't be decided. (The
29561 @var{article} parameter is necessary in @code{nnvirtual} groups which
29562 might very well combine mail groups and news groups.) Both @var{group}
29563 and @var{article} may be @code{nil}.
29564
29565 There should be no result data from this function.
29566
29567
29568 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
29569
29570 Set/remove/add marks on articles. Normally Gnus handles the article
29571 marks (such as read, ticked, expired etc.)@: internally, and store them in
29572 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
29573 all information about the articles on the server, so Gnus need to
29574 propagate the mark information to the server.
29575
29576 @var{action} is a list of mark setting requests, having this format:
29577
29578 @example
29579 (RANGE ACTION MARK)
29580 @end example
29581
29582 @var{range} is a range of articles you wish to update marks on.
29583 @var{action} is @code{add} or @code{del}, used to add marks or remove
29584 marks (preserving all marks not mentioned). @var{mark} is a list of
29585 marks; where each mark is a symbol. Currently used marks are
29586 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
29587 @code{dormant}, @code{save}, @code{download}, @code{unsend}, and
29588 @code{forward}, but your back end should, if possible, not limit
29589 itself to these.
29590
29591 Given contradictory actions, the last action in the list should be the
29592 effective one. That is, if your action contains a request to add the
29593 @code{tick} mark on article 1 and, later in the list, a request to
29594 remove the mark on the same article, the mark should in fact be removed.
29595
29596 An example action list:
29597
29598 @example
29599 (((5 12 30) 'del '(tick))
29600 ((10 . 90) 'add '(read expire))
29601 ((92 94) 'del '(read)))
29602 @end example
29603
29604 The function should return a range of articles it wasn't able to set the
29605 mark on (currently not used for anything).
29606
29607 There should be no result data from this function.
29608
29609 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
29610
29611 If the user tries to set a mark that the back end doesn't like, this
29612 function may change the mark. Gnus will use whatever this function
29613 returns as the mark for @var{article} instead of the original
29614 @var{mark}. If the back end doesn't care, it must return the original
29615 @var{mark}, and not @code{nil} or any other type of garbage.
29616
29617 The only use for this I can see is what @code{nnvirtual} does with
29618 it---if a component group is auto-expirable, marking an article as read
29619 in the virtual group should result in the article being marked as
29620 expirable.
29621
29622 There should be no result data from this function.
29623
29624
29625 @item (nnchoke-request-scan &optional GROUP SERVER)
29626
29627 This function may be called at any time (by Gnus or anything else) to
29628 request that the back end check for incoming articles, in one way or
29629 another. A mail back end will typically read the spool file or query
29630 the @acronym{POP} server when this function is invoked. The
29631 @var{group} doesn't have to be heeded---if the back end decides that
29632 it is too much work just scanning for a single group, it may do a
29633 total scan of all groups. It would be nice, however, to keep things
29634 local if that's practical.
29635
29636 There should be no result data from this function.
29637
29638
29639 @item (nnchoke-request-group-description GROUP &optional SERVER)
29640
29641 The result data from this function should be a description of
29642 @var{group}.
29643
29644 @example
29645 description-line = name <TAB> description eol
29646 name = <string>
29647 description = <text>
29648 @end example
29649
29650 @item (nnchoke-request-list-newsgroups &optional SERVER)
29651
29652 The result data from this function should be the description of all
29653 groups available on the server.
29654
29655 @example
29656 description-buffer = *description-line
29657 @end example
29658
29659
29660 @item (nnchoke-request-newgroups DATE &optional SERVER)
29661
29662 The result data from this function should be all groups that were
29663 created after @samp{date}, which is in normal human-readable date format
29664 (i.e., the date format used in mail and news headers, and returned by
29665 the function @code{message-make-date} by default). The data should be
29666 in the active buffer format.
29667
29668 It is okay for this function to return ``too many'' groups; some back ends
29669 might find it cheaper to return the full list of groups, rather than
29670 just the new groups. But don't do this for back ends with many groups.
29671 Normally, if the user creates the groups herself, there won't be too
29672 many groups, so @code{nnml} and the like are probably safe. But for
29673 back ends like @code{nntp}, where the groups have been created by the
29674 server, it is quite likely that there can be many groups.
29675
29676
29677 @item (nnchoke-request-create-group GROUP &optional SERVER)
29678
29679 This function should create an empty group with name @var{group}.
29680
29681 There should be no return data.
29682
29683
29684 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
29685
29686 This function should run the expiry process on all articles in the
29687 @var{articles} range (which is currently a simple list of article
29688 numbers.) It is left up to the back end to decide how old articles
29689 should be before they are removed by this function. If @var{force} is
29690 non-@code{nil}, all @var{articles} should be deleted, no matter how new
29691 they are.
29692
29693 This function should return a list of articles that it did not/was not
29694 able to delete.
29695
29696 There should be no result data returned.
29697
29698
29699 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
29700
29701 This function should move @var{article} (which is a number) from
29702 @var{group} by calling @var{accept-form}.
29703
29704 This function should ready the article in question for moving by
29705 removing any header lines it has added to the article, and generally
29706 should ``tidy up'' the article. Then it should @code{eval}
29707 @var{accept-form} in the buffer where the ``tidy'' article is. This
29708 will do the actual copying. If this @code{eval} returns a
29709 non-@code{nil} value, the article should be removed.
29710
29711 If @var{last} is @code{nil}, that means that there is a high likelihood
29712 that there will be more requests issued shortly, so that allows some
29713 optimizations.
29714
29715 The function should return a cons where the @code{car} is the group name and
29716 the @code{cdr} is the article number that the article was entered as.
29717
29718 There should be no data returned.
29719
29720
29721 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
29722
29723 This function takes the current buffer and inserts it into @var{group}.
29724 If @var{last} in @code{nil}, that means that there will be more calls to
29725 this function in short order.
29726
29727 The function should return a cons where the @code{car} is the group name and
29728 the @code{cdr} is the article number that the article was entered as.
29729
29730 The group should exist before the back end is asked to accept the
29731 article for that group.
29732
29733 There should be no data returned.
29734
29735
29736 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
29737
29738 This function should remove @var{article} (which is a number) from
29739 @var{group} and insert @var{buffer} there instead.
29740
29741 There should be no data returned.
29742
29743
29744 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
29745
29746 This function should delete @var{group}. If @var{force}, it should
29747 really delete all the articles in the group, and then delete the group
29748 itself. (If there is such a thing as ``the group itself''.)
29749
29750 There should be no data returned.
29751
29752
29753 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
29754
29755 This function should rename @var{group} into @var{new-name}. All
29756 articles in @var{group} should move to @var{new-name}.
29757
29758 There should be no data returned.
29759
29760 @end table
29761
29762
29763 @node Error Messaging
29764 @subsubsection Error Messaging
29765
29766 @findex nnheader-report
29767 @findex nnheader-get-report
29768 The back ends should use the function @code{nnheader-report} to report
29769 error conditions---they should not raise errors when they aren't able to
29770 perform a request. The first argument to this function is the back end
29771 symbol, and the rest are interpreted as arguments to @code{format} if
29772 there are multiple of them, or just a string if there is one of them.
29773 This function must always returns @code{nil}.
29774
29775 @lisp
29776 (nnheader-report 'nnchoke "You did something totally bogus")
29777
29778 (nnheader-report 'nnchoke "Could not request group %s" group)
29779 @end lisp
29780
29781 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
29782 @code{nil} back from a server, and this function returns the most
29783 recently reported message for the back end in question. This function
29784 takes one argument---the server symbol.
29785
29786 Internally, these functions access @var{back-end}@code{-status-string},
29787 so the @code{nnchoke} back end will have its error message stored in
29788 @code{nnchoke-status-string}.
29789
29790
29791 @node Writing New Back Ends
29792 @subsubsection Writing New Back Ends
29793
29794 Many back ends are quite similar. @code{nnml} is just like
29795 @code{nnspool}, but it allows you to edit the articles on the server.
29796 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
29797 and it doesn't maintain overview databases. @code{nndir} is just like
29798 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
29799 editing articles.
29800
29801 It would make sense if it were possible to ``inherit'' functions from
29802 back ends when writing new back ends. And, indeed, you can do that if you
29803 want to. (You don't have to if you don't want to, of course.)
29804
29805 All the back ends declare their public variables and functions by using a
29806 package called @code{nnoo}.
29807
29808 To inherit functions from other back ends (and allow other back ends to
29809 inherit functions from the current back end), you should use the
29810 following macros:
29811
29812 @table @code
29813
29814 @item nnoo-declare
29815 This macro declares the first parameter to be a child of the subsequent
29816 parameters. For instance:
29817
29818 @lisp
29819 (nnoo-declare nndir
29820 nnml nnmh)
29821 @end lisp
29822
29823 @code{nndir} has declared here that it intends to inherit functions from
29824 both @code{nnml} and @code{nnmh}.
29825
29826 @item defvoo
29827 This macro is equivalent to @code{defvar}, but registers the variable as
29828 a public server variable. Most state-oriented variables should be
29829 declared with @code{defvoo} instead of @code{defvar}.
29830
29831 In addition to the normal @code{defvar} parameters, it takes a list of
29832 variables in the parent back ends to map the variable to when executing
29833 a function in those back ends.
29834
29835 @lisp
29836 (defvoo nndir-directory nil
29837 "Where nndir will look for groups."
29838 nnml-current-directory nnmh-current-directory)
29839 @end lisp
29840
29841 This means that @code{nnml-current-directory} will be set to
29842 @code{nndir-directory} when an @code{nnml} function is called on behalf
29843 of @code{nndir}. (The same with @code{nnmh}.)
29844
29845 @item nnoo-define-basics
29846 This macro defines some common functions that almost all back ends should
29847 have.
29848
29849 @lisp
29850 (nnoo-define-basics nndir)
29851 @end lisp
29852
29853 @item deffoo
29854 This macro is just like @code{defun} and takes the same parameters. In
29855 addition to doing the normal @code{defun} things, it registers the
29856 function as being public so that other back ends can inherit it.
29857
29858 @item nnoo-map-functions
29859 This macro allows mapping of functions from the current back end to
29860 functions from the parent back ends.
29861
29862 @lisp
29863 (nnoo-map-functions nndir
29864 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29865 (nnmh-request-article 0 nndir-current-group 0 0))
29866 @end lisp
29867
29868 This means that when @code{nndir-retrieve-headers} is called, the first,
29869 third, and fourth parameters will be passed on to
29870 @code{nnml-retrieve-headers}, while the second parameter is set to the
29871 value of @code{nndir-current-group}.
29872
29873 @item nnoo-import
29874 This macro allows importing functions from back ends. It should be the
29875 last thing in the source file, since it will only define functions that
29876 haven't already been defined.
29877
29878 @lisp
29879 (nnoo-import nndir
29880 (nnmh
29881 nnmh-request-list
29882 nnmh-request-newgroups)
29883 (nnml))
29884 @end lisp
29885
29886 This means that calls to @code{nndir-request-list} should just be passed
29887 on to @code{nnmh-request-list}, while all public functions from
29888 @code{nnml} that haven't been defined in @code{nndir} yet should be
29889 defined now.
29890
29891 @end table
29892
29893 Below is a slightly shortened version of the @code{nndir} back end.
29894
29895 @lisp
29896 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
29897 ;; @r{Copyright (C) 1995,1996 Free Software Foundation, Inc.}
29898
29899 ;;; @r{Code:}
29900
29901 (require 'nnheader)
29902 (require 'nnmh)
29903 (require 'nnml)
29904 (require 'nnoo)
29905 (eval-when-compile (require 'cl))
29906
29907 (nnoo-declare nndir
29908 nnml nnmh)
29909
29910 (defvoo nndir-directory nil
29911 "Where nndir will look for groups."
29912 nnml-current-directory nnmh-current-directory)
29913
29914 (defvoo nndir-nov-is-evil nil
29915 "*Non-nil means that nndir will never retrieve NOV headers."
29916 nnml-nov-is-evil)
29917
29918 (defvoo nndir-current-group ""
29919 nil
29920 nnml-current-group nnmh-current-group)
29921 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
29922 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
29923
29924 (defvoo nndir-status-string "" nil nnmh-status-string)
29925 (defconst nndir-version "nndir 1.0")
29926
29927 ;;; @r{Interface functions.}
29928
29929 (nnoo-define-basics nndir)
29930
29931 (deffoo nndir-open-server (server &optional defs)
29932 (setq nndir-directory
29933 (or (cadr (assq 'nndir-directory defs))
29934 server))
29935 (unless (assq 'nndir-directory defs)
29936 (push `(nndir-directory ,server) defs))
29937 (push `(nndir-current-group
29938 ,(file-name-nondirectory
29939 (directory-file-name nndir-directory)))
29940 defs)
29941 (push `(nndir-top-directory
29942 ,(file-name-directory (directory-file-name nndir-directory)))
29943 defs)
29944 (nnoo-change-server 'nndir server defs))
29945
29946 (nnoo-map-functions nndir
29947 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29948 (nnmh-request-article 0 nndir-current-group 0 0)
29949 (nnmh-request-group nndir-current-group 0 0)
29950 (nnmh-close-group nndir-current-group 0))
29951
29952 (nnoo-import nndir
29953 (nnmh
29954 nnmh-status-message
29955 nnmh-request-list
29956 nnmh-request-newgroups))
29957
29958 (provide 'nndir)
29959 @end lisp
29960
29961
29962 @node Hooking New Back Ends Into Gnus
29963 @subsubsection Hooking New Back Ends Into Gnus
29964
29965 @vindex gnus-valid-select-methods
29966 @findex gnus-declare-backend
29967 Having Gnus start using your new back end is rather easy---you just
29968 declare it with the @code{gnus-declare-backend} functions. This will
29969 enter the back end into the @code{gnus-valid-select-methods} variable.
29970
29971 @code{gnus-declare-backend} takes two parameters---the back end name and
29972 an arbitrary number of @dfn{abilities}.
29973
29974 Here's an example:
29975
29976 @lisp
29977 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
29978 @end lisp
29979
29980 The above line would then go in the @file{nnchoke.el} file.
29981
29982 The abilities can be:
29983
29984 @table @code
29985 @item mail
29986 This is a mailish back end---followups should (probably) go via mail.
29987 @item post
29988 This is a newsish back end---followups should (probably) go via news.
29989 @item post-mail
29990 This back end supports both mail and news.
29991 @item none
29992 This is neither a post nor mail back end---it's something completely
29993 different.
29994 @item respool
29995 It supports respooling---or rather, it is able to modify its source
29996 articles and groups.
29997 @item address
29998 The name of the server should be in the virtual server name. This is
29999 true for almost all back ends.
30000 @item prompt-address
30001 The user should be prompted for an address when doing commands like
30002 @kbd{B} in the group buffer. This is true for back ends like
30003 @code{nntp}, but not @code{nnmbox}, for instance.
30004 @end table
30005
30006
30007 @node Mail-like Back Ends
30008 @subsubsection Mail-like Back Ends
30009
30010 One of the things that separate the mail back ends from the rest of the
30011 back ends is the heavy dependence by most of the mail back ends on
30012 common functions in @file{nnmail.el}. For instance, here's the
30013 definition of @code{nnml-request-scan}:
30014
30015 @lisp
30016 (deffoo nnml-request-scan (&optional group server)
30017 (setq nnml-article-file-alist nil)
30018 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
30019 @end lisp
30020
30021 It simply calls @code{nnmail-get-new-mail} with a few parameters,
30022 and @code{nnmail} takes care of all the moving and splitting of the
30023 mail.
30024
30025 This function takes four parameters.
30026
30027 @table @var
30028 @item method
30029 This should be a symbol to designate which back end is responsible for
30030 the call.
30031
30032 @item exit-function
30033 This function should be called after the splitting has been performed.
30034
30035 @item temp-directory
30036 Where the temporary files should be stored.
30037
30038 @item group
30039 This optional argument should be a group name if the splitting is to be
30040 performed for one group only.
30041 @end table
30042
30043 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
30044 save each article. @var{back-end}@code{-active-number} will be called to
30045 find the article number assigned to this article.
30046
30047 The function also uses the following variables:
30048 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
30049 this back end); and @var{back-end}@code{-group-alist} and
30050 @var{back-end}@code{-active-file} to generate the new active file.
30051 @var{back-end}@code{-group-alist} should be a group-active alist, like
30052 this:
30053
30054 @example
30055 (("a-group" (1 . 10))
30056 ("some-group" (34 . 39)))
30057 @end example
30058
30059
30060 @node Score File Syntax
30061 @subsection Score File Syntax
30062
30063 Score files are meant to be easily parsable, but yet extremely
30064 malleable. It was decided that something that had the same read syntax
30065 as an Emacs Lisp list would fit that spec.
30066
30067 Here's a typical score file:
30068
30069 @lisp
30070 (("summary"
30071 ("Windows 95" -10000 nil s)
30072 ("Gnus"))
30073 ("from"
30074 ("Lars" -1000))
30075 (mark -100))
30076 @end lisp
30077
30078 BNF definition of a score file:
30079
30080 @example
30081 score-file = "" / "(" *element ")"
30082 element = rule / atom
30083 rule = string-rule / number-rule / date-rule
30084 string-rule = "(" quote string-header quote space *string-match ")"
30085 number-rule = "(" quote number-header quote space *number-match ")"
30086 date-rule = "(" quote date-header quote space *date-match ")"
30087 quote = <ascii 34>
30088 string-header = "subject" / "from" / "references" / "message-id" /
30089 "xref" / "body" / "head" / "all" / "followup"
30090 number-header = "lines" / "chars"
30091 date-header = "date"
30092 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
30093 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
30094 score = "nil" / <integer>
30095 date = "nil" / <natural number>
30096 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
30097 "r" / "regex" / "R" / "Regex" /
30098 "e" / "exact" / "E" / "Exact" /
30099 "f" / "fuzzy" / "F" / "Fuzzy"
30100 number-match = "(" <integer> [ "" / [ space score [ "" /
30101 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
30102 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
30103 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
30104 space date [ "" / [ space date-match-t ] ] ] ] ")"
30105 date-match-t = "nil" / "at" / "before" / "after"
30106 atom = "(" [ required-atom / optional-atom ] ")"
30107 required-atom = mark / expunge / mark-and-expunge / files /
30108 exclude-files / read-only / touched
30109 optional-atom = adapt / local / eval
30110 mark = "mark" space nil-or-number
30111 nil-or-number = "nil" / <integer>
30112 expunge = "expunge" space nil-or-number
30113 mark-and-expunge = "mark-and-expunge" space nil-or-number
30114 files = "files" *[ space <string> ]
30115 exclude-files = "exclude-files" *[ space <string> ]
30116 read-only = "read-only" [ space "nil" / space "t" ]
30117 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
30118 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
30119 local = "local" *[ space "(" <string> space <form> ")" ]
30120 eval = "eval" space <form>
30121 space = *[ " " / <TAB> / <NEWLINE> ]
30122 @end example
30123
30124 Any unrecognized elements in a score file should be ignored, but not
30125 discarded.
30126
30127 As you can see, white space is needed, but the type and amount of white
30128 space is irrelevant. This means that formatting of the score file is
30129 left up to the programmer---if it's simpler to just spew it all out on
30130 one looong line, then that's ok.
30131
30132 The meaning of the various atoms are explained elsewhere in this
30133 manual (@pxref{Score File Format}).
30134
30135
30136 @node Headers
30137 @subsection Headers
30138
30139 Internally Gnus uses a format for storing article headers that
30140 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
30141 almost suspect that the author looked at the @acronym{NOV} specification and
30142 just shamelessly @emph{stole} the entire thing, and one would be right.
30143
30144 @dfn{Header} is a severely overloaded term. ``Header'' is used in
30145 RFC 1036 to talk about lines in the head of an article (e.g.,
30146 @code{From}). It is used by many people as a synonym for
30147 ``head''---``the header and the body''. (That should be avoided, in my
30148 opinion.) And Gnus uses a format internally that it calls ``header'',
30149 which is what I'm talking about here. This is a 9-element vector,
30150 basically, with each header (ouch) having one slot.
30151
30152 These slots are, in order: @code{number}, @code{subject}, @code{from},
30153 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
30154 @code{xref}, and @code{extra}. There are macros for accessing and
30155 setting these slots---they all have predictable names beginning with
30156 @code{mail-header-} and @code{mail-header-set-}, respectively.
30157
30158 All these slots contain strings, except the @code{extra} slot, which
30159 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
30160
30161
30162 @node Ranges
30163 @subsection Ranges
30164
30165 @sc{gnus} introduced a concept that I found so useful that I've started
30166 using it a lot and have elaborated on it greatly.
30167
30168 The question is simple: If you have a large amount of objects that are
30169 identified by numbers (say, articles, to take a @emph{wild} example)
30170 that you want to qualify as being ``included'', a normal sequence isn't
30171 very useful. (A 200,000 length sequence is a bit long-winded.)
30172
30173 The solution is as simple as the question: You just collapse the
30174 sequence.
30175
30176 @example
30177 (1 2 3 4 5 6 10 11 12)
30178 @end example
30179
30180 is transformed into
30181
30182 @example
30183 ((1 . 6) (10 . 12))
30184 @end example
30185
30186 To avoid having those nasty @samp{(13 . 13)} elements to denote a
30187 lonesome object, a @samp{13} is a valid element:
30188
30189 @example
30190 ((1 . 6) 7 (10 . 12))
30191 @end example
30192
30193 This means that comparing two ranges to find out whether they are equal
30194 is slightly tricky:
30195
30196 @example
30197 ((1 . 5) 7 8 (10 . 12))
30198 @end example
30199
30200 and
30201
30202 @example
30203 ((1 . 5) (7 . 8) (10 . 12))
30204 @end example
30205
30206 are equal. In fact, any non-descending list is a range:
30207
30208 @example
30209 (1 2 3 4 5)
30210 @end example
30211
30212 is a perfectly valid range, although a pretty long-winded one. This is
30213 also valid:
30214
30215 @example
30216 (1 . 5)
30217 @end example
30218
30219 and is equal to the previous range.
30220
30221 Here's a BNF definition of ranges. Of course, one must remember the
30222 semantic requirement that the numbers are non-descending. (Any number
30223 of repetition of the same number is allowed, but apt to disappear in
30224 range handling.)
30225
30226 @example
30227 range = simple-range / normal-range
30228 simple-range = "(" number " . " number ")"
30229 normal-range = "(" start-contents ")"
30230 contents = "" / simple-range *[ " " contents ] /
30231 number *[ " " contents ]
30232 @end example
30233
30234 Gnus currently uses ranges to keep track of read articles and article
30235 marks. I plan on implementing a number of range operators in C if The
30236 Powers That Be are willing to let me. (I haven't asked yet, because I
30237 need to do some more thinking on what operators I need to make life
30238 totally range-based without ever having to convert back to normal
30239 sequences.)
30240
30241
30242 @node Group Info
30243 @subsection Group Info
30244
30245 Gnus stores all permanent info on groups in a @dfn{group info} list.
30246 This list is from three to six elements (or more) long and exhaustively
30247 describes the group.
30248
30249 Here are two example group infos; one is a very simple group while the
30250 second is a more complex one:
30251
30252 @example
30253 ("no.group" 5 ((1 . 54324)))
30254
30255 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
30256 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
30257 (nnml "")
30258 ((auto-expire . t) (to-address . "ding@@gnus.org")))
30259 @end example
30260
30261 The first element is the @dfn{group name}---as Gnus knows the group,
30262 anyway. The second element is the @dfn{subscription level}, which
30263 normally is a small integer. (It can also be the @dfn{rank}, which is a
30264 cons cell where the @code{car} is the level and the @code{cdr} is the
30265 score.) The third element is a list of ranges of read articles. The
30266 fourth element is a list of lists of article marks of various kinds.
30267 The fifth element is the select method (or virtual server, if you like).
30268 The sixth element is a list of @dfn{group parameters}, which is what
30269 this section is about.
30270
30271 Any of the last three elements may be missing if they are not required.
30272 In fact, the vast majority of groups will normally only have the first
30273 three elements, which saves quite a lot of cons cells.
30274
30275 Here's a BNF definition of the group info format:
30276
30277 @example
30278 info = "(" group space ralevel space read
30279 [ "" / [ space marks-list [ "" / [ space method [ "" /
30280 space parameters ] ] ] ] ] ")"
30281 group = quote <string> quote
30282 ralevel = rank / level
30283 level = <integer in the range of 1 to inf>
30284 rank = "(" level "." score ")"
30285 score = <integer in the range of 1 to inf>
30286 read = range
30287 marks-lists = nil / "(" *marks ")"
30288 marks = "(" <string> range ")"
30289 method = "(" <string> *elisp-forms ")"
30290 parameters = "(" *elisp-forms ")"
30291 @end example
30292
30293 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
30294 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
30295 in pseudo-BNF.
30296
30297 If you have a Gnus info and want to access the elements, Gnus offers a
30298 series of macros for getting/setting these elements.
30299
30300 @table @code
30301 @item gnus-info-group
30302 @itemx gnus-info-set-group
30303 @findex gnus-info-group
30304 @findex gnus-info-set-group
30305 Get/set the group name.
30306
30307 @item gnus-info-rank
30308 @itemx gnus-info-set-rank
30309 @findex gnus-info-rank
30310 @findex gnus-info-set-rank
30311 Get/set the group rank (@pxref{Group Score}).
30312
30313 @item gnus-info-level
30314 @itemx gnus-info-set-level
30315 @findex gnus-info-level
30316 @findex gnus-info-set-level
30317 Get/set the group level.
30318
30319 @item gnus-info-score
30320 @itemx gnus-info-set-score
30321 @findex gnus-info-score
30322 @findex gnus-info-set-score
30323 Get/set the group score (@pxref{Group Score}).
30324
30325 @item gnus-info-read
30326 @itemx gnus-info-set-read
30327 @findex gnus-info-read
30328 @findex gnus-info-set-read
30329 Get/set the ranges of read articles.
30330
30331 @item gnus-info-marks
30332 @itemx gnus-info-set-marks
30333 @findex gnus-info-marks
30334 @findex gnus-info-set-marks
30335 Get/set the lists of ranges of marked articles.
30336
30337 @item gnus-info-method
30338 @itemx gnus-info-set-method
30339 @findex gnus-info-method
30340 @findex gnus-info-set-method
30341 Get/set the group select method.
30342
30343 @item gnus-info-params
30344 @itemx gnus-info-set-params
30345 @findex gnus-info-params
30346 @findex gnus-info-set-params
30347 Get/set the group parameters.
30348 @end table
30349
30350 All the getter functions take one parameter---the info list. The setter
30351 functions take two parameters---the info list and the new value.
30352
30353 The last three elements in the group info aren't mandatory, so it may be
30354 necessary to extend the group info before setting the element. If this
30355 is necessary, you can just pass on a non-@code{nil} third parameter to
30356 the three final setter functions to have this happen automatically.
30357
30358
30359 @node Extended Interactive
30360 @subsection Extended Interactive
30361 @cindex interactive
30362 @findex gnus-interactive
30363
30364 Gnus extends the standard Emacs @code{interactive} specification
30365 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
30366 Prefixes}). Here's an example of how this is used:
30367
30368 @lisp
30369 (defun gnus-summary-increase-score (&optional score symp)
30370 (interactive (gnus-interactive "P\ny"))
30371 ...
30372 )
30373 @end lisp
30374
30375 The best thing to do would have been to implement
30376 @code{gnus-interactive} as a macro which would have returned an
30377 @code{interactive} form, but this isn't possible since Emacs checks
30378 whether a function is interactive or not by simply doing an @code{assq}
30379 on the lambda form. So, instead we have @code{gnus-interactive}
30380 function that takes a string and returns values that are usable to
30381 @code{interactive}.
30382
30383 This function accepts (almost) all normal @code{interactive} specs, but
30384 adds a few more.
30385
30386 @table @samp
30387 @item y
30388 @vindex gnus-current-prefix-symbol
30389 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
30390 variable.
30391
30392 @item Y
30393 @vindex gnus-current-prefix-symbols
30394 A list of the current symbolic prefixes---the
30395 @code{gnus-current-prefix-symbol} variable.
30396
30397 @item A
30398 The current article number---the @code{gnus-summary-article-number}
30399 function.
30400
30401 @item H
30402 The current article header---the @code{gnus-summary-article-header}
30403 function.
30404
30405 @item g
30406 The current group name---the @code{gnus-group-group-name}
30407 function.
30408
30409 @end table
30410
30411
30412 @node Emacs/XEmacs Code
30413 @subsection Emacs/XEmacs Code
30414 @cindex XEmacs
30415 @cindex Emacsen
30416
30417 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
30418 platforms must be the primary one. I chose Emacs. Not because I don't
30419 like XEmacs or Mule, but because it comes first alphabetically.
30420
30421 This means that Gnus will byte-compile under Emacs with nary a warning,
30422 while XEmacs will pump out gigabytes of warnings while byte-compiling.
30423 As I use byte-compilation warnings to help me root out trivial errors in
30424 Gnus, that's very useful.
30425
30426 I've also consistently used Emacs function interfaces, but have used
30427 Gnusey aliases for the functions. To take an example: Emacs defines a
30428 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
30429 function. I then define a function called @code{gnus-run-at-time} that
30430 takes the same parameters as the Emacs @code{run-at-time}. When running
30431 Gnus under Emacs, the former function is just an alias for the latter.
30432 However, when running under XEmacs, the former is an alias for the
30433 following function:
30434
30435 @lisp
30436 (defun gnus-xmas-run-at-time (time repeat function &rest args)
30437 (start-itimer
30438 "gnus-run-at-time"
30439 `(lambda ()
30440 (,function ,@@args))
30441 time repeat))
30442 @end lisp
30443
30444 This sort of thing has been done for bunches of functions. Gnus does
30445 not redefine any native Emacs functions while running under XEmacs---it
30446 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
30447 all over.
30448
30449 In the cases where the XEmacs function interface was obviously cleaner,
30450 I used it instead. For example @code{gnus-region-active-p} is an alias
30451 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
30452
30453 Of course, I could have chosen XEmacs as my native platform and done
30454 mapping functions the other way around. But I didn't. The performance
30455 hit these indirections impose on Gnus under XEmacs should be slight.
30456
30457
30458 @node Various File Formats
30459 @subsection Various File Formats
30460
30461 @menu
30462 * Active File Format:: Information on articles and groups available.
30463 * Newsgroups File Format:: Group descriptions.
30464 @end menu
30465
30466
30467 @node Active File Format
30468 @subsubsection Active File Format
30469
30470 The active file lists all groups available on the server in
30471 question. It also lists the highest and lowest current article numbers
30472 in each group.
30473
30474 Here's an excerpt from a typical active file:
30475
30476 @example
30477 soc.motss 296030 293865 y
30478 alt.binaries.pictures.fractals 3922 3913 n
30479 comp.sources.unix 1605 1593 m
30480 comp.binaries.ibm.pc 5097 5089 y
30481 no.general 1000 900 y
30482 @end example
30483
30484 Here's a pseudo-BNF definition of this file:
30485
30486 @example
30487 active = *group-line
30488 group-line = group spc high-number spc low-number spc flag <NEWLINE>
30489 group = <non-white-space string>
30490 spc = " "
30491 high-number = <non-negative integer>
30492 low-number = <positive integer>
30493 flag = "y" / "n" / "m" / "j" / "x" / "=" group
30494 @end example
30495
30496 For a full description of this file, see the manual pages for
30497 @samp{innd}, in particular @samp{active(5)}.
30498
30499
30500 @node Newsgroups File Format
30501 @subsubsection Newsgroups File Format
30502
30503 The newsgroups file lists groups along with their descriptions. Not all
30504 groups on the server have to be listed, and not all groups in the file
30505 have to exist on the server. The file is meant purely as information to
30506 the user.
30507
30508 The format is quite simple; a group name, a tab, and the description.
30509 Here's the definition:
30510
30511 @example
30512 newsgroups = *line
30513 line = group tab description <NEWLINE>
30514 group = <non-white-space string>
30515 tab = <TAB>
30516 description = <string>
30517 @end example
30518
30519
30520 @page
30521 @node Emacs for Heathens
30522 @section Emacs for Heathens
30523
30524 Believe it or not, but some people who use Gnus haven't really used
30525 Emacs much before they embarked on their journey on the Gnus Love Boat.
30526 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
30527 region'', and ``set @code{gnus-flargblossen} to an alist where the key
30528 is a regexp that is used for matching on the group name'' are magical
30529 phrases with little or no meaning, then this appendix is for you. If
30530 you are already familiar with Emacs, just ignore this and go fondle your
30531 cat instead.
30532
30533 @menu
30534 * Keystrokes:: Entering text and executing commands.
30535 * Emacs Lisp:: The built-in Emacs programming language.
30536 @end menu
30537
30538
30539 @node Keystrokes
30540 @subsection Keystrokes
30541
30542 @itemize @bullet
30543 @item
30544 Q: What is an experienced Emacs user?
30545
30546 @item
30547 A: A person who wishes that the terminal had pedals.
30548 @end itemize
30549
30550 Yes, when you use Emacs, you are apt to use the control key, the shift
30551 key and the meta key a lot. This is very annoying to some people
30552 (notably @code{vi}le users), and the rest of us just love the hell out
30553 of it. Just give up and submit. Emacs really does stand for
30554 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
30555 may have heard from other disreputable sources (like the Emacs author).
30556
30557 The shift keys are normally located near your pinky fingers, and are
30558 normally used to get capital letters and stuff. You probably use it all
30559 the time. The control key is normally marked ``CTRL'' or something like
30560 that. The meta key is, funnily enough, never marked as such on any
30561 keyboard. The one I'm currently at has a key that's marked ``Alt'',
30562 which is the meta key on this keyboard. It's usually located somewhere
30563 to the left hand side of the keyboard, usually on the bottom row.
30564
30565 Now, us Emacs people don't say ``press the meta-control-m key'',
30566 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
30567 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
30568 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
30569 down the control key, and hold it down while you press @kbd{k}''.
30570 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
30571 the control key and then press @kbd{k}''. Simple, ay?
30572
30573 This is somewhat complicated by the fact that not all keyboards have a
30574 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
30575 means ``press escape, release escape, press @kbd{k}''. That's much more
30576 work than if you have a meta key, so if that's the case, I respectfully
30577 suggest you get a real keyboard with a meta key. You can't live without
30578 it.
30579
30580
30581
30582 @node Emacs Lisp
30583 @subsection Emacs Lisp
30584
30585 Emacs is the King of Editors because it's really a Lisp interpreter.
30586 Each and every key you tap runs some Emacs Lisp code snippet, and since
30587 Emacs Lisp is an interpreted language, that means that you can configure
30588 any key to run any arbitrary code. You just, like, do it.
30589
30590 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
30591 functions. (These are byte-compiled for speed, but it's still
30592 interpreted.) If you decide that you don't like the way Gnus does
30593 certain things, it's trivial to have it do something a different way.
30594 (Well, at least if you know how to write Lisp code.) However, that's
30595 beyond the scope of this manual, so we are simply going to talk about
30596 some common constructs that you normally use in your @file{~/.gnus.el}
30597 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
30598 in order to set things of Gnus up, it is much better to use the
30599 @file{~/.gnus.el} file, @xref{Startup Files}.)
30600
30601 If you want to set the variable @code{gnus-florgbnize} to four (4), you
30602 write the following:
30603
30604 @lisp
30605 (setq gnus-florgbnize 4)
30606 @end lisp
30607
30608 This function (really ``special form'') @code{setq} is the one that can
30609 set a variable to some value. This is really all you need to know. Now
30610 you can go and fill your @file{~/.gnus.el} file with lots of these to
30611 change how Gnus works.
30612
30613 If you have put that thing in your @file{~/.gnus.el} file, it will be
30614 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
30615 start Gnus. If you want to change the variable right away, simply say
30616 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
30617 previous ``form'', which is a simple @code{setq} statement here.
30618
30619 Go ahead---just try it, if you're located at your Emacs. After you
30620 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
30621 is the return value of the form you @code{eval}ed.
30622
30623 Some pitfalls:
30624
30625 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
30626 that means:
30627
30628 @lisp
30629 (setq gnus-read-active-file 'some)
30630 @end lisp
30631
30632 On the other hand, if the manual says ``set @code{gnus-nntp-server-file} to
30633 @samp{/etc/nntpserver}'', that means:
30634
30635 @lisp
30636 (setq gnus-nntp-server-file "/etc/nntpserver")
30637 @end lisp
30638
30639 So be careful not to mix up strings (the latter) with symbols (the
30640 former). The manual is unambiguous, but it can be confusing.
30641
30642 @page
30643 @include gnus-faq.texi
30644
30645 @node GNU Free Documentation License
30646 @chapter GNU Free Documentation License
30647 @include doclicense.texi
30648
30649 @node Index
30650 @chapter Index
30651 @printindex cp
30652
30653 @node Key Index
30654 @chapter Key Index
30655 @printindex ky
30656
30657 @bye
30658
30659 @iftex
30660 @iflatex
30661 \end{document}
30662 @end iflatex
30663 @end iftex
30664
30665 @c Local Variables:
30666 @c mode: texinfo
30667 @c coding: utf-8
30668 @c End: