59ee56a38983aa2fa96d608b468fcc1cfcde0d1d
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-  -*- coding: iso-latin-1 -*-
2
3 @setfilename gnus
4 @settitle T-gnus 6.15 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @dircategory Emacs
9 @direntry
10 * Gnus: (gnus).         The newsreader Gnus.
11 @end direntry
12 @iftex
13 @finalout
14 @end iftex
15 @setchapternewpage odd
16
17 @iftex
18 @iflatex
19 \documentclass[twoside,a4paper,openright,11pt]{book}
20 \usepackage[latin1]{inputenc}
21 \usepackage{pagestyle}
22 \usepackage{epsfig}
23 \usepackage{pixidx}
24 \input{gnusconfig.tex}
25
26 \ifx\pdfoutput\undefined
27 \else
28 \usepackage[pdftex,bookmarks]{hyperref}
29 \pdfcompresslevel=9
30 \fi
31
32 \makeindex
33 \begin{document}
34
35 \newcommand{\gnusversionname}{Oort Gnus v.}
36 \newcommand{\gnuschaptername}{}
37 \newcommand{\gnussectionname}{}
38
39 \newcommand{\gnusbackslash}{/}
40
41 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
42 \ifx\pdfoutput\undefined
43 \newcommand{\gnusuref}[1]{\gnustt{#1}}
44 \else
45 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
46 \fi
47 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
48 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
49
50 \newcommand{\gnuskindex}[1]{\index{#1}}
51 \newcommand{\gnusindex}[1]{\index{#1}}
52
53 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
54 \newcommand{\gnuscode}[1]{\gnustt{#1}}
55 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
56 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
57 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
58 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
59 \newcommand{\gnusdfn}[1]{\textit{#1}}
60 \newcommand{\gnusi}[1]{\textit{#1}}
61 \newcommand{\gnusstrong}[1]{\textbf{#1}}
62 \newcommand{\gnusemph}[1]{\textit{#1}}
63 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
64 \newcommand{\gnussc}[1]{\textsc{#1}}
65 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
66 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
67 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
68 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
69
70 \newcommand{\gnusbullet}{{${\bullet}$}}
71 \newcommand{\gnusdollar}{\$}
72 \newcommand{\gnusampersand}{\&}
73 \newcommand{\gnuspercent}{\%}
74 \newcommand{\gnushash}{\#}
75 \newcommand{\gnushat}{\symbol{"5E}}
76 \newcommand{\gnusunderline}{\symbol{"5F}}
77 \newcommand{\gnusnot}{$\neg$}
78 \newcommand{\gnustilde}{\symbol{"7E}}
79 \newcommand{\gnusless}{{$<$}}
80 \newcommand{\gnusgreater}{{$>$}}
81 \newcommand{\gnusbraceleft}{{$>$}}
82 \newcommand{\gnusbraceright}{{$>$}}
83
84 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
85 \newcommand{\gnusinteresting}{
86 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
87 }
88
89 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
90
91 \newcommand{\gnuspagechapter}[1]{
92 {\mbox{}}
93 }
94
95 \newdimen{\gnusdimen}
96 \gnusdimen 0pt
97
98 \newcommand{\gnuschapter}[2]{
99 \gnuscleardoublepage
100 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
101 \chapter{#2}
102 \renewcommand{\gnussectionname}{}
103 \renewcommand{\gnuschaptername}{#2}
104 \thispagestyle{empty}
105 \hspace*{-2cm}
106 \begin{picture}(500,500)(0,0)
107 \put(480,350){\makebox(0,0)[tr]{#1}}
108 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
109 \end{picture}
110 \clearpage
111 }
112
113 \newcommand{\gnusfigure}[3]{
114 \begin{figure}
115 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
116 #3
117 \end{picture}
118 \caption{#1}
119 \end{figure}
120 }
121
122 \newcommand{\gnusicon}[1]{
123 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
124 }
125
126 \newcommand{\gnuspicon}[1]{
127 \margindex{\epsfig{figure=#1,width=2cm}}
128 }
129
130 \newcommand{\gnusxface}[2]{
131 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
132 }
133
134 \newcommand{\gnussmiley}[2]{
135 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
136 }
137
138 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
139
140 \newcommand{\gnussection}[1]{
141 \renewcommand{\gnussectionname}{#1}
142 \section{#1}
143 }
144
145 \newenvironment{codelist}%
146 {\begin{list}{}{
147 }
148 }{\end{list}}
149
150 \newenvironment{kbdlist}%
151 {\begin{list}{}{
152 \labelwidth=0cm
153 }
154 }{\end{list}}
155
156 \newenvironment{dfnlist}%
157 {\begin{list}{}{
158 }
159 }{\end{list}}
160
161 \newenvironment{stronglist}%
162 {\begin{list}{}{
163 }
164 }{\end{list}}
165
166 \newenvironment{samplist}%
167 {\begin{list}{}{
168 }
169 }{\end{list}}
170
171 \newenvironment{varlist}%
172 {\begin{list}{}{
173 }
174 }{\end{list}}
175
176 \newenvironment{emphlist}%
177 {\begin{list}{}{
178 }
179 }{\end{list}}
180
181 \newlength\gnusheadtextwidth
182 \setlength{\gnusheadtextwidth}{\headtextwidth}
183 \addtolength{\gnusheadtextwidth}{1cm}
184
185 \newpagestyle{gnuspreamble}%
186 {
187 {
188 \ifodd\count0
189 {
190 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
191 }
192 \else
193 {
194 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
195 }
196 }
197 \fi
198 }
199 }
200 {
201 \ifodd\count0
202 \mbox{} \hfill
203 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
204 \else
205 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
206 \hfill \mbox{}
207 \fi
208 }
209
210 \newpagestyle{gnusindex}%
211 {
212 {
213 \ifodd\count0
214 {
215 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
216 }
217 \else
218 {
219 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
220 }
221 \fi
222 }
223 }
224 {
225 \ifodd\count0
226 \mbox{} \hfill
227 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
228 \else
229 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
230 \hfill \mbox{}
231 \fi
232 }
233
234 \newpagestyle{gnus}%
235 {
236 {
237 \ifodd\count0
238 {
239 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
240 }
241 \else
242 {
243 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
244 }
245 \fi
246 }
247 }
248 {
249 \ifodd\count0
250 \mbox{} \hfill
251 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
252 \else
253 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
254 \hfill \mbox{}
255 \fi
256 }
257
258 \pagenumbering{roman}
259 \pagestyle{gnuspreamble}
260
261 @end iflatex
262 @end iftex
263
264 @iftex
265 @iflatex
266 \begin{titlepage}
267 {
268
269 %\addtolength{\oddsidemargin}{-5cm}
270 %\addtolength{\evensidemargin}{-5cm}
271 \parindent=0cm
272 \addtolength{\textheight}{2cm}
273
274 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
275 \rule{15cm}{1mm}\\
276 \vfill
277 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
278 \vfill
279 \rule{15cm}{1mm}\\
280 \gnusauthor{by Lars Magne Ingebrigtsen}
281 \newpage
282 }
283
284 \mbox{}
285 \vfill
286
287 \thispagestyle{empty}
288
289 Copyright \copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001
290 Free Software Foundation, Inc.
291
292
293 Permission is granted to copy, distribute and/or modify this document
294 under the terms of the GNU Free Documentation License, Version 1.1 or
295 any later version published by the Free Software Foundation; with no
296 Invariant Sections, with the Front-Cover texts being ``A GNU
297 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
298 license is included in the section entitled ``GNU Free Documentation
299 License'' in the Emacs manual.
300
301 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
302 this GNU Manual, like GNU software.  Copies published by the Free
303 Software Foundation raise funds for GNU development.''
304
305 This document is part of a collection distributed under the GNU Free
306 Documentation License.  If you want to distribute this document
307 separately from the collection, you can do so by adding a copy of the
308 license to the document, as described in section 6 of the license.
309 \newpage
310 \end{titlepage}
311 @end iflatex
312 @end iftex
313
314 @ifnottex
315
316 This file documents gnus, the GNU Emacs newsreader.
317
318 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001 
319         Free Software Foundation, Inc.
320
321 Permission is granted to copy, distribute and/or modify this document
322 under the terms of the GNU Free Documentation License, Version 1.1 or
323 any later version published by the Free Software Foundation; with the
324 Invariant Sections being none, with the Front-Cover texts being ``A GNU
325 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
326 license is included in the section entitled ``GNU Free Documentation
327 License'' in the Emacs manual.
328
329 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
330 this GNU Manual, like GNU software.  Copies published by the Free
331 Software Foundation raise funds for GNU development.''
332
333 This document is part of a collection distributed under the GNU Free
334 Documentation License.  If you want to distribute this document
335 separately from the collection, you can do so by adding a copy of the
336 license to the document, as described in section 6 of the license.
337 @end ifnottex
338
339 @tex
340
341 @titlepage
342 @title T-gnus 6.15 Manual
343
344 @author by Lars Magne Ingebrigtsen
345 @page
346
347 @vskip 0pt plus 1filll
348 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001
349         Free Software Foundation, Inc.
350
351 Permission is granted to copy, distribute and/or modify this document
352 under the terms of the GNU Free Documentation License, Version 1.1 or
353 any later version published by the Free Software Foundation; with no
354 Invariant Sections, with the Front-Cover texts being ``A GNU
355 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
356 license is included in the section entitled ``GNU Free Documentation
357 License'' in the Emacs manual.
358
359 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
360 this GNU Manual, like GNU software.  Copies published by the Free
361 Software Foundation raise funds for GNU development.''
362
363 This document is part of a collection distributed under the GNU Free
364 Documentation License.  If you want to distribute this document
365 separately from the collection, you can do so by adding a copy of the
366 license to the document, as described in section 6 of the license.
367
368 @end titlepage
369 @page
370
371 @end tex
372
373
374 @node Top
375 @top The gnus Newsreader
376
377 @ifinfo
378
379 You can read news (and mail) from within Emacs by using gnus.  The news
380 can be gotten by any nefarious means you can think of---@sc{nntp}, local
381 spool or your mbox file.  All at the same time, if you want to push your
382 luck.
383
384 T-gnus provides MIME features based on SEMI API.  So T-gnus supports
385 your right to read strange messages including big images or other
386 various kinds of formats.  T-gnus also supports
387 internationalization/localization and multiscript features based on MULE
388 API.  So T-gnus does not discriminate various language communities.
389 Oh, if you are a Klingon, please wait Unicode Next Generation.
390
391 This manual corresponds to T-gnus 6.15.
392
393 @end ifinfo
394
395 @iftex
396
397 @iflatex
398 \tableofcontents
399 \gnuscleardoublepage
400 @end iflatex
401
402 Gnus is the advanced, self-documenting, customizable, extensible
403 unreal-time newsreader for GNU Emacs.
404
405 Oops.  That sounds oddly familiar, so let's start over again to avoid
406 being accused of plagiarism:
407
408 Gnus is a message-reading laboratory.  It will let you look at just
409 about anything as if it were a newsgroup.  You can read mail with it,
410 you can browse directories with it, you can @code{ftp} with it---you
411 can even read news with it!
412
413 Gnus tries to empower people who read news the same way Emacs empowers
414 people who edit text.  Gnus sets no limits to what the user should be
415 allowed to do.  Users are encouraged to extend gnus to make it behave
416 like they want it to behave.  A program should not control people;
417 people should be empowered to do what they want by using (or abusing)
418 the program.
419
420 @end iftex
421
422 @menu
423 * Starting Up::                 Finding news can be a pain.
424 * Group Buffer::                Selecting, subscribing and killing groups.
425 * Summary Buffer::              Reading, saving and posting articles.
426 * Article Buffer::              Displaying and handling articles.
427 * Composing Messages::          Information on sending mail and news.
428 * Select Methods::              Gnus reads all messages from various select methods.
429 * Scoring::                     Assigning values to articles.
430 * Various::                     General purpose settings.
431 * The End::                     Farewell and goodbye.
432 * Appendices::                  Terminology, Emacs intro, FAQ, History, Internals.
433 * Index::                       Variable, function and concept index.
434 * Key Index::                   Key Index.
435
436 @detailmenu
437  --- The Detailed Node Listing ---
438
439 Starting Gnus
440
441 * Finding the News::            Choosing a method for getting news.
442 * The First Time::              What does Gnus do the first time you start it?
443 * The Server is Down::          How can I read my mail then?
444 * Slave Gnusae::                You can have more than one Gnus active at a time.
445 * Fetching a Group::            Starting Gnus just to read a group.
446 * New Groups::                  What is Gnus supposed to do with new groups?
447 * Changing Servers::            You may want to move from one server to another.
448 * Startup Files::               Those pesky startup files---@file{.newsrc}.
449 * Auto Save::                   Recovering from a crash.
450 * The Active File::             Reading the active file over a slow line Takes Time.
451 * Startup Variables::           Other variables you might change.
452
453 New Groups
454
455 * Checking New Groups::         Determining what groups are new.
456 * Subscription Methods::        What Gnus should do with new groups.
457 * Filtering New Groups::        Making Gnus ignore certain new groups.
458
459 Group Buffer
460
461 * Group Buffer Format::         Information listed and how you can change it.
462 * Group Maneuvering::           Commands for moving in the group buffer.
463 * Selecting a Group::           Actually reading news.
464 * Subscription Commands::       Unsubscribing, killing, subscribing.
465 * Group Data::                  Changing the info for a group.
466 * Group Levels::                Levels? What are those, then?
467 * Group Score::                 A mechanism for finding out what groups you like.
468 * Marking Groups::              You can mark groups for later processing.
469 * Foreign Groups::              Creating and editing groups.
470 * Group Parameters::            Each group may have different parameters set.
471 * Listing Groups::              Gnus can list various subsets of the groups.
472 * Sorting Groups::              Re-arrange the group order.
473 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
474 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
475 * Exiting Gnus::                Stop reading news and get some work done.
476 * Group Topics::                A folding group mode divided into topics.
477 * Misc Group Stuff::            Other stuff that you can to do.
478
479 Group Buffer Format
480
481 * Group Line Specification::    Deciding how the group buffer is to look.
482 * Group Modeline Specification::  The group buffer modeline.
483 * Group Highlighting::          Having nice colors in the group buffer.
484
485 Group Topics
486
487 * Topic Variables::             How to customize the topics the Lisp Way.
488 * Topic Commands::              Interactive E-Z commands.
489 * Topic Sorting::               Sorting each topic individually.
490 * Topic Topology::              A map of the world.
491 * Topic Parameters::            Parameters that apply to all groups in a topic.
492
493 Misc Group Stuff
494
495 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
496 * Group Information::           Information and help on groups and Gnus.
497 * Group Timestamp::             Making Gnus keep track of when you last read a group.
498 * File Commands::               Reading and writing the Gnus files.
499 * Sieve Commands::              Managing Sieve scripts.
500
501 Summary Buffer
502
503 * Summary Buffer Format::       Deciding how the summary buffer is to look.
504 * Summary Maneuvering::         Moving around the summary buffer.
505 * Choosing Articles::           Reading articles.
506 * Paging the Article::          Scrolling the current article.
507 * Reply Followup and Post::     Posting articles.
508 * Delayed Articles::            
509 * Marking Articles::            Marking articles as read, expirable, etc.
510 * Limiting::                    You can limit the summary buffer.
511 * Threading::                   How threads are made.
512 * Sorting the Summary Buffer::  How articles and threads are sorted.
513 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
514 * Article Caching::             You may store articles in a cache.
515 * Persistent Articles::         Making articles expiry-resistant.
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::               
561 * Generic Marking Commands::    
562 * Setting Process Marks::       
563
564 Marking Articles
565
566 * Setting Marks::             How to set and remove marks.
567 * Generic Marking Commands::  How to customize the marking.
568 * Setting Process Marks::     How to mark articles for later processing.
569
570 Threading
571
572 * Customizing Threading::       Variables you can change to affect the threading.
573 * Thread Commands::             Thread based commands in the summary buffer.
574
575 Customizing Threading
576
577 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
578 * Filling In Threads::          Making the threads displayed look fuller.
579 * More Threading::              Even more variables for fiddling with threads.
580 * Low-Level Threading::         You thought it was over... but you were wrong!
581
582 Decoding Articles
583
584 * Uuencoded Articles::          Uudecode articles.
585 * Shell Archives::              Unshar articles.
586 * PostScript Files::            Split PostScript.
587 * Other Files::                 Plain save and binhex.
588 * Decoding Variables::          Variables for a happy decoding.
589 * Viewing Files::               You want to look at the result of the decoding?
590
591 Decoding Variables
592
593 * Rule Variables::              Variables that say how a file is to be viewed.
594 * Other Decode Variables::      Other decode variables.
595 * Uuencoding and Posting::      Variables for customizing uuencoding.
596
597 Article Treatment
598
599 * Article Highlighting::        You want to make the article look like fruit salad.
600 * Article Fontisizing::         Making emphasized text look nice.
601 * Article Hiding::              You also want to make certain info go away.
602 * Article Washing::             Lots of way-neat functions to make life better.
603 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
604 * Article Date::                Grumble, UT!
605 * Article Signature::           What is a signature?
606 * Article Miscellania::         Various other stuff.
607
608 Alternative Approaches
609
610 * Pick and Read::               First mark articles and then read them.
611 * Binary Groups::               Auto-decode all articles.
612
613 Various Summary Stuff
614
615 * Summary Group Information::   Information oriented commands.
616 * Searching for Articles::      Multiple article commands.
617 * Summary Generation Commands::  
618 * Really Various Summary Commands::  Those pesky non-conformant commands.
619
620 Article Buffer
621
622 * Hiding Headers::              Deciding what headers should be displayed.
623 * Using MIME::                  Pushing articles through @sc{mime} before reading them.
624 * Customizing Articles::        Tailoring the look of the articles.
625 * Article Keymap::              Keystrokes available in the article buffer.
626 * Misc Article::                Other stuff.
627
628 Composing Messages
629
630 * Mail::                        Mailing and replying.
631 * Posting Server::              What server should you post via?
632 * Mail and Post::               Mailing and posting at the same time.
633 * Archived Messages::           Where Gnus stores the messages you've sent.
634 * Posting Styles::              An easier way to specify who you are.
635 * Drafts::                      Postponing messages and rejected messages.
636 * Rejected Articles::           What happens if the server doesn't like your article?
637 * Using GPG::                   How to use GPG and MML to sign and encrypt messages
638
639 Select Methods
640
641 * Server Buffer::               Making and editing virtual servers.
642 * Getting News::                Reading USENET news with Gnus.
643 * Getting Mail::                Reading your personal mail with Gnus.
644 * Browsing the Web::            Getting messages from a plethora of Web sources.
645 * IMAP::                        Using Gnus as a @sc{imap} client.
646 * Other Sources::               Reading directories, files, SOUP packets.
647 * Combined Groups::             Combining groups into one group.
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 @sc{nntp} server.
663 * News Spool::                  Reading news from the local spool.
664
665 @sc{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 gruft 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 * Archiving Mail::              How to backup your mail.
687
688 Mail Sources
689
690 * Mail Source Specifiers::      How to specify what a mail source is.
691 * Mail Source Customization::   Some variables that influence things.
692 * Fetching Mail::               Using the mail source specifiers.
693
694 Choosing a Mail Back End
695
696 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
697 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
698 * Mail Spool::                  Store your mail in a private spool?
699 * MH Spool::                    An mhspool-like back end.
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 * Web Searches::                Creating groups from articles that match a string.
706 * Slashdot::                    Reading the Slashdot comments.
707 * Ultimate::                    The Ultimate Bulletin Board systems.
708 * Web Archive::                 Reading mailing list archived on web.
709 * RSS::                         Reading RDF site summary.
710 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
711
712 @sc{imap}
713
714 * Splitting in IMAP::           Splitting mail with nnimap.
715 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
716 * Expunging mailboxes::         Equivalent of a "compress mailbox" button.
717
718 Other Sources
719
720 * Directory Groups::            You can read a directory as if it was a newsgroup.
721 * Anything Groups::             Dired?  Who needs dired?
722 * Document Groups::             Single files can be the basis of a group.
723 * SOUP::                        Reading @sc{soup} packets ``offline''.
724 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
725
726 Document Groups
727
728 * Document Server Internals::   How to add your own document types.
729
730 SOUP
731
732 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
733 * SOUP Groups::                 A back end for reading @sc{soup} packets.
734 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
735
736 Combined Groups
737
738 * Virtual Groups::              Combining articles from many groups.
739 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
740
741 Gnus Unplugged
742
743 * Agent Basics::                How it all is supposed to work.
744 * Agent Categories::            How to tell the Gnus Agent what to download.
745 * Agent Commands::              New commands for all the buffers.
746 * Agent Expiry::                How to make old articles go away.
747 * Agent and IMAP::              How to use the Agent with IMAP.
748 * Outgoing Messages::           What happens when you post/mail something?
749 * Agent Variables::             Customizing is fun.
750 * Example Setup::               An example @file{.gnus.el} file for offline people.
751 * Batching Agents::             How to fetch news from a @code{cron} job.
752 * Agent Caveats::               What you think it'll do and what it does.
753
754 Agent Categories
755
756 * Category Syntax::             What a category looks like.
757 * Category Buffer::             A buffer for maintaining categories.
758 * Category Variables::          Customize'r'Us.
759
760 Agent Commands
761
762 * Group Agent Commands::        
763 * Summary Agent Commands::      
764 * Server Agent Commands::       
765
766 Scoring
767
768 * Summary Score Commands::      Adding score entries for the current group.
769 * Group Score Commands::        General score commands.
770 * Score Variables::             Customize your scoring.  (My, what terminology).
771 * Score File Format::           What a score file may contain.
772 * Score File Editing::          You can edit score files by hand as well.
773 * Adaptive Scoring::            Big Sister Gnus knows what you read.
774 * Home Score File::             How to say where new score entries are to go.
775 * Followups To Yourself::       Having Gnus notice when people answer you.
776 * Scoring On Other Headers::    Scoring on non-standard headers.
777 * Scoring Tips::                How to score effectively.
778 * Reverse Scoring::             That problem child of old is not problem.
779 * Global Score Files::          Earth-spanning, ear-splitting score files.
780 * Kill Files::                  They are still here, but they can be ignored.
781 * Converting Kill Files::       Translating kill files to score files.
782 * GroupLens::                   Getting predictions on what you like to read.
783 * Advanced Scoring::            Using logical expressions to build score rules.
784 * Score Decays::                It can be useful to let scores wither away.
785
786 GroupLens
787
788 * Using GroupLens::             How to make Gnus use GroupLens.
789 * Rating Articles::             Letting GroupLens know how you rate articles.
790 * Displaying Predictions::      Displaying predictions given by GroupLens.
791 * GroupLens Variables::         Customizing GroupLens.
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 Various
800
801 * Process/Prefix::              A convention used by many treatment commands.
802 * Interactive::                 Making Gnus ask you many questions.
803 * Symbolic Prefixes::           How to supply some Gnus functions with options.
804 * Formatting Variables::        You can specify what buffers should look like.
805 * Window Layout::               Configuring the Gnus buffer windows.
806 * Faces and Fonts::             How to change how faces look.
807 * Compilation::                 How to speed Gnus up.
808 * Mode Lines::                  Displaying information in the mode lines.
809 * Highlighting and Menus::      Making buffers look all nice and cozy.
810 * Buttons::                     Get tendinitis in ten easy steps!
811 * Daemons::                     Gnus can do things behind your back.
812 * NoCeM::                       How to avoid spam and other fatty foods.
813 * Undo::                        Some actions can be undone.
814 * Moderation::                  What to do if you're a moderator.
815 * XEmacs Enhancements::         There are more pictures and stuff under XEmacs.
816 * Fuzzy Matching::              What's the big fuzz?
817 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
818 * Various Various::             Things that are really various.
819
820 Formatting Variables
821
822 * Formatting Basics::           A formatting variable is basically a format string.
823 * Mode Line Formatting::        Some rules about mode line formatting variables.
824 * Advanced Formatting::         Modifying output in various ways.
825 * User-Defined Specs::          Having Gnus call your own functions.
826 * Formatting Fonts::            Making the formatting look colorful and nice.
827 * Positioning Point::           Moving point to a position after an operation.
828 * Tabulation::                  Tabulating your output.
829 * Wide Characters::             Dealing with wide characters.
830
831 XEmacs Enhancements
832
833 * Picons::                      How to display pictures of what your reading.
834 * Smileys::                     Show all those happy faces the way they were meant to be shown.
835 * Toolbar::                     Click'n'drool.
836 * XVarious::                    Other XEmacsy Gnusey variables.
837
838 Picons
839
840 * Picon Basics::                What are picons and How do I get them.
841 * Picon Requirements::          Don't go further if you aren't using XEmacs.
842 * Easy Picons::                 Displaying Picons---the easy way.
843 * Hard Picons::                 The way you should do it.  You'll learn something.
844 * Picon Useless Configuration::  Other variables you can trash/tweak/munge/play with.
845
846 Appendices
847
848 * History::                     How Gnus got where it is today.
849 * On Writing Manuals::          Why this is not a beginner's guide.
850 * Terminology::                 We use really difficult, like, words here.
851 * Customization::               Tailoring Gnus to your needs.
852 * Troubleshooting::             What you might try if things do not work.
853 * Gnus Reference Guide::        Rilly, rilly technical stuff.
854 * Emacs for Heathens::          A short introduction to Emacsian terms.
855
856 History
857
858 * Gnus Versions::               What Gnus versions have been released.
859 * Other Gnus Versions::         Other Gnus versions that also have been released.
860 * Why?::                        What's the point of Gnus?
861 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
862 * Conformity::                  Gnus tries to conform to all standards.
863 * Emacsen::                     Gnus can be run on a few modern Emacsen.
864 * Gnus Development::            How Gnus is developed.
865 * Contributors::                Oodles of people.
866 * New Features::                Pointers to some of the new stuff in Gnus.
867
868 New Features
869
870 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
871 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
872 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
873 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
874 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
875
876 Customization
877
878 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
879 * Slow Terminal Connection::    You run a remote Emacs.
880 * Little Disk Space::           You feel that having large setup files is icky.
881 * Slow Machine::                You feel like buying a faster machine.
882
883 Gnus Reference Guide
884
885 * Gnus Utility Functions::      Common functions and variable to use.
886 * Back End Interface::          How Gnus communicates with the servers.
887 * Score File Syntax::           A BNF definition of the score file standard.
888 * Headers::                     How Gnus stores headers internally.
889 * Ranges::                      A handy format for storing mucho numbers.
890 * Group Info::                  The group info format.
891 * Extended Interactive::        Symbolic prefixes and stuff.
892 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
893 * Various File Formats::        Formats of files that Gnus use.
894
895 Back End Interface
896
897 * Required Back End Functions:: Functions that must be implemented.
898 * Optional Back End Functions:: Functions that need not be implemented.
899 * Error Messaging::             How to get messages and report errors.
900 * Writing New Back Ends::       Extending old back ends.
901 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
902 * Mail-like Back Ends::         Some tips on mail back ends.
903
904 Various File Formats
905
906 * Active File Format::          Information on articles and groups available.
907 * Newsgroups File Format::      Group descriptions.
908
909 Emacs for Heathens
910
911 * Keystrokes::                  Entering text and executing commands.
912 * Emacs Lisp::                  The built-in Emacs programming language.
913
914 @end detailmenu
915 @end menu
916
917 @node Starting Up
918 @chapter Starting gnus
919 @cindex starting up
920
921 @kindex M-x gnus
922 @findex gnus
923 If your system administrator has set things up properly, starting gnus
924 and reading news is extremely easy---you just type @kbd{M-x gnus} in
925 your Emacs.
926
927 @findex gnus-other-frame
928 @kindex M-x gnus-other-frame
929 If you want to start gnus in a different frame, you can use the command
930 @kbd{M-x gnus-other-frame} instead.
931
932 If things do not go smoothly at startup, you have to twiddle some
933 variables in your @file{~/.gnus} file.  This file is similar to
934 @file{~/.emacs}, but is read when gnus starts.
935
936 If you puzzle at any terms used in this manual, please refer to the
937 terminology section (@pxref{Terminology}).
938
939 @menu
940 * Finding the News::            Choosing a method for getting news.
941 * The First Time::              What does Gnus do the first time you start it?
942 * The Server is Down::          How can I read my mail then?
943 * Slave Gnusae::                You can have more than one Gnus active at a time.
944 * Fetching a Group::            Starting Gnus just to read a group.
945 * New Groups::                  What is Gnus supposed to do with new groups?
946 * Changing Servers::            You may want to move from one server to another.
947 * Startup Files::               Those pesky startup files---@file{.newsrc}.
948 * Auto Save::                   Recovering from a crash.
949 * The Active File::             Reading the active file over a slow line Takes Time.
950 * Startup Variables::           Other variables you might change.
951 @end menu
952
953
954 @node Finding the News
955 @section Finding the News
956 @cindex finding news
957
958 @vindex gnus-select-method
959 @c @head
960 The @code{gnus-select-method} variable says where gnus should look for
961 news.  This variable should be a list where the first element says
962 @dfn{how} and the second element says @dfn{where}.  This method is your
963 native method.  All groups not fetched with this method are
964 foreign groups.
965
966 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
967 you want to get your daily dosage of news from, you'd say:
968
969 @lisp
970 (setq gnus-select-method '(nntp "news.somewhere.edu"))
971 @end lisp
972
973 If you want to read directly from the local spool, say:
974
975 @lisp
976 (setq gnus-select-method '(nnspool ""))
977 @end lisp
978
979 If you can use a local spool, you probably should, as it will almost
980 certainly be much faster.  But do not use the local spool if your
981 server is running Leafnode; in this case, use @code{(nntp "localhost")}.
982
983 @vindex gnus-nntpserver-file
984 @cindex NNTPSERVER
985 @cindex @sc{nntp} server
986 If this variable is not set, gnus will take a look at the
987 @code{NNTPSERVER} environment variable.  If that variable isn't set,
988 gnus will see whether @code{gnus-nntpserver-file}
989 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
990 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
991
992 @vindex gnus-nntp-server
993 If @code{gnus-nntp-server} is set, this variable will override
994 @code{gnus-select-method}.  You should therefore set
995 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
996
997 @vindex gnus-secondary-servers
998 @vindex gnus-nntp-server
999 You can also make gnus prompt you interactively for the name of an
1000 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
1001 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
1002 in the @code{gnus-secondary-servers} list (if any).  You can also just
1003 type in the name of any server you feel like visiting.  (Note that this
1004 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1005 gnus} later in the same Emacs session, Gnus will contact the same
1006 server.)
1007
1008 @findex gnus-group-browse-foreign-server
1009 @kindex B (Group)
1010 However, if you use one @sc{nntp} server regularly and are just
1011 interested in a couple of groups from a different server, you would be
1012 better served by using the @kbd{B} command in the group buffer.  It will
1013 let you have a look at what groups are available, and you can subscribe
1014 to any of the groups you want to.  This also makes @file{.newsrc}
1015 maintenance much tidier.  @xref{Foreign Groups}.
1016
1017 @vindex gnus-secondary-select-methods
1018 @c @head
1019 A slightly different approach to foreign groups is to set the
1020 @code{gnus-secondary-select-methods} variable.  The select methods
1021 listed in this variable are in many ways just as native as the
1022 @code{gnus-select-method} server.  They will also be queried for active
1023 files during startup (if that's required), and new newsgroups that
1024 appear on these servers will be subscribed (or not) just as native
1025 groups are.
1026
1027 For instance, if you use the @code{nnmbox} back end to read your mail,
1028 you would typically set this variable to
1029
1030 @lisp
1031 (setq gnus-secondary-select-methods '((nnmbox "")))
1032 @end lisp
1033
1034
1035 @node The First Time
1036 @section The First Time
1037 @cindex first time usage
1038
1039 If no startup files exist, gnus will try to determine what groups should
1040 be subscribed by default.
1041
1042 @vindex gnus-default-subscribed-newsgroups
1043 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1044 will subscribe you to just those groups in that list, leaving the rest
1045 killed.  Your system administrator should have set this variable to
1046 something useful.
1047
1048 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1049 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
1050 here as @dfn{whatever Lars thinks you should read}.)
1051
1052 You'll also be subscribed to the gnus documentation group, which should
1053 help you with most common problems.
1054
1055 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1056 use the normal functions for handling new groups, and not do anything
1057 special.
1058
1059
1060 @node The Server is Down
1061 @section The Server is Down
1062 @cindex server errors
1063
1064 If the default server is down, gnus will understandably have some
1065 problems starting.  However, if you have some mail groups in addition to
1066 the news groups, you may want to start gnus anyway.
1067
1068 Gnus, being the trusting sort of program, will ask whether to proceed
1069 without a native select method if that server can't be contacted.  This
1070 will happen whether the server doesn't actually exist (i.e., you have
1071 given the wrong address) or the server has just momentarily taken ill
1072 for some reason or other.  If you decide to continue and have no foreign
1073 groups, you'll find it difficult to actually do anything in the group
1074 buffer.  But, hey, that's your problem.  Blllrph!
1075
1076 @findex gnus-no-server
1077 @kindex M-x gnus-no-server
1078 @c @head
1079 If you know that the server is definitely down, or you just want to read
1080 your mail without bothering with the server at all, you can use the
1081 @code{gnus-no-server} command to start gnus.  That might come in handy
1082 if you're in a hurry as well.  This command will not attempt to contact
1083 your primary server---instead, it will just activate all groups on level
1084 1 and 2.  (You should preferably keep no native groups on those two
1085 levels.) Also @pxref{Group Levels}.
1086
1087
1088 @node Slave Gnusae
1089 @section Slave Gnusae
1090 @cindex slave
1091
1092 You might want to run more than one Emacs with more than one gnus at the
1093 same time.  If you are using different @file{.newsrc} files (e.g., if you
1094 are using the two different gnusae to read from two different servers),
1095 that is no problem whatsoever.  You just do it.
1096
1097 The problem appears when you want to run two Gnusae that use the same
1098 @code{.newsrc} file.
1099
1100 To work around that problem some, we here at the Think-Tank at the gnus
1101 Towers have come up with a new concept: @dfn{Masters} and
1102 @dfn{slaves}.  (We have applied for a patent on this concept, and have
1103 taken out a copyright on those words.  If you wish to use those words in
1104 conjunction with each other, you have to send $1 per usage instance to
1105 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
1106 Applications}) will be much more expensive, of course.)
1107
1108 Anyway, you start one gnus up the normal way with @kbd{M-x gnus} (or
1109 however you do it).  Each subsequent slave gnusae should be started with
1110 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
1111 files, but instead save @dfn{slave files} that contain information only
1112 on what groups have been read in the slave session.  When a master gnus
1113 starts, it will read (and delete) these slave files, incorporating all
1114 information from them.  (The slave files will be read in the sequence
1115 they were created, so the latest changes will have precedence.)
1116
1117 Information from the slave files has, of course, precedence over the
1118 information in the normal (i.e., master) @code{.newsrc} file.
1119
1120
1121 @node Fetching a Group
1122 @section Fetching a Group
1123 @cindex fetching a group
1124
1125 @findex gnus-fetch-group
1126 It is sometimes convenient to be able to just say ``I want to read this
1127 group and I don't care whether gnus has been started or not''.  This is
1128 perhaps more useful for people who write code than for users, but the
1129 command @code{gnus-fetch-group} provides this functionality in any case.
1130 It takes the group name as a parameter.
1131
1132
1133 @node New Groups
1134 @section New Groups
1135 @cindex new groups
1136 @cindex subscription
1137
1138 @vindex gnus-check-new-newsgroups
1139 If you are satisfied that you really never want to see any new groups,
1140 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
1141 also save you some time at startup.  Even if this variable is
1142 @code{nil}, you can always subscribe to the new groups just by pressing
1143 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
1144 is @code{ask-server} by default.  If you set this variable to
1145 @code{always}, then Gnus will query the back ends for new groups even
1146 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1147
1148 @menu
1149 * Checking New Groups::         Determining what groups are new.
1150 * Subscription Methods::        What Gnus should do with new groups.
1151 * Filtering New Groups::        Making Gnus ignore certain new groups.
1152 @end menu
1153
1154
1155 @node Checking New Groups
1156 @subsection Checking New Groups
1157
1158 Gnus normally determines whether a group is new or not by comparing the
1159 list of groups from the active file(s) with the lists of subscribed and
1160 dead groups.  This isn't a particularly fast method.  If
1161 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1162 server for new groups since the last time.  This is both faster and
1163 cheaper.  This also means that you can get rid of the list of killed
1164 groups altogether, so you may set @code{gnus-save-killed-list} to
1165 @code{nil}, which will save time both at startup, at exit, and all over.
1166 Saves disk space, too.  Why isn't this the default, then?
1167 Unfortunately, not all servers support this command.
1168
1169 I bet I know what you're thinking now: How do I find out whether my
1170 server supports @code{ask-server}?  No?  Good, because I don't have a
1171 fail-safe answer.  I would suggest just setting this variable to
1172 @code{ask-server} and see whether any new groups appear within the next
1173 few days.  If any do, then it works.  If none do, then it doesn't
1174 work.  I could write a function to make gnus guess whether the server
1175 supports @code{ask-server}, but it would just be a guess.  So I won't.
1176 You could @code{telnet} to the server and say @code{HELP} and see
1177 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
1178 it does, then it might work.  (But there are servers that lists
1179 @samp{NEWGROUPS} without supporting the function properly.)
1180
1181 This variable can also be a list of select methods.  If so, gnus will
1182 issue an @code{ask-server} command to each of the select methods, and
1183 subscribe them (or not) using the normal methods.  This might be handy
1184 if you are monitoring a few servers for new groups.  A side effect is
1185 that startup will take much longer, so you can meditate while waiting.
1186 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1187
1188
1189 @node Subscription Methods
1190 @subsection Subscription Methods
1191
1192 @vindex gnus-subscribe-newsgroup-method
1193 What gnus does when it encounters a new group is determined by the
1194 @code{gnus-subscribe-newsgroup-method} variable.
1195
1196 This variable should contain a function.  This function will be called
1197 with the name of the new group as the only parameter.
1198
1199 Some handy pre-fab functions are:
1200
1201 @table @code
1202
1203 @item gnus-subscribe-zombies
1204 @vindex gnus-subscribe-zombies
1205 Make all new groups zombies.  This is the default.  You can browse the
1206 zombies later (with @kbd{A z}) and either kill them all off properly
1207 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1208
1209 @item gnus-subscribe-randomly
1210 @vindex gnus-subscribe-randomly
1211 Subscribe all new groups in arbitrary order.  This really means that all
1212 new groups will be added at ``the top'' of the group buffer.
1213
1214 @item gnus-subscribe-alphabetically
1215 @vindex gnus-subscribe-alphabetically
1216 Subscribe all new groups in alphabetical order.
1217
1218 @item gnus-subscribe-hierarchically
1219 @vindex gnus-subscribe-hierarchically
1220 Subscribe all new groups hierarchically.  The difference between this
1221 function and @code{gnus-subscribe-alphabetically} is slight.
1222 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1223 alphabetical fashion, while this function will enter groups into its
1224 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
1225 @samp{comp} hierarchy, this function will not mess that configuration
1226 up.  Or something like that.
1227
1228 @item gnus-subscribe-interactively
1229 @vindex gnus-subscribe-interactively
1230 Subscribe new groups interactively.  This means that gnus will ask
1231 you about @strong{all} new groups.  The groups you choose to subscribe
1232 to will be subscribed hierarchically.
1233
1234 @item gnus-subscribe-killed
1235 @vindex gnus-subscribe-killed
1236 Kill all new groups.
1237
1238 @item gnus-subscribe-topics
1239 @vindex gnus-subscribe-topics
1240 Put the groups into the topic that has a matching @code{subscribe} topic
1241 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
1242 topic parameter that looks like
1243
1244 @example
1245 "nnslashdot"
1246 @end example
1247
1248 will mean that all groups that match that regex will be subscribed under
1249 that topic.
1250
1251 If no topics match the groups, the groups will be subscribed in the
1252 top-level topic.
1253
1254 @end table
1255
1256 @vindex gnus-subscribe-hierarchical-interactive
1257 A closely related variable is
1258 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
1259 mouthful.)  If this variable is non-@code{nil}, gnus will ask you in a
1260 hierarchical fashion whether to subscribe to new groups or not.  Gnus
1261 will ask you for each sub-hierarchy whether you want to descend the
1262 hierarchy or not.
1263
1264 One common mistake is to set the variable a few paragraphs above
1265 (@code{gnus-subscribe-newsgroup-method}) to
1266 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
1267 will not work.  This is ga-ga.  So don't do it.
1268
1269
1270 @node Filtering New Groups
1271 @subsection Filtering New Groups
1272
1273 A nice and portable way to control which new newsgroups should be
1274 subscribed (or ignored) is to put an @dfn{options} line at the start of
1275 the @file{.newsrc} file.  Here's an example:
1276
1277 @example
1278 options -n !alt.all !rec.all sci.all
1279 @end example
1280
1281 @vindex gnus-subscribe-options-newsgroup-method
1282 This line obviously belongs to a serious-minded intellectual scientific
1283 person (or she may just be plain old boring), because it says that all
1284 groups that have names beginning with @samp{alt} and @samp{rec} should
1285 be ignored, and all groups with names beginning with @samp{sci} should
1286 be subscribed.  Gnus will not use the normal subscription method for
1287 subscribing these groups.
1288 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
1289 variable defaults to @code{gnus-subscribe-alphabetically}.
1290
1291 @vindex gnus-options-not-subscribe
1292 @vindex gnus-options-subscribe
1293 If you don't want to mess with your @file{.newsrc} file, you can just
1294 set the two variables @code{gnus-options-subscribe} and
1295 @code{gnus-options-not-subscribe}.  These two variables do exactly the
1296 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
1297 and if the new group matches the former, it will be unconditionally
1298 subscribed, and if it matches the latter, it will be ignored.
1299
1300 @vindex gnus-auto-subscribed-groups
1301 Yet another variable that meddles here is
1302 @code{gnus-auto-subscribed-groups}.  It works exactly like
1303 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1304 thought it would be nice to have two of these.  This variable is more
1305 meant for setting some ground rules, while the other variable is used
1306 more for user fiddling.  By default this variable makes all new groups
1307 that come from mail back ends (@code{nnml}, @code{nnbabyl},
1308 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
1309 don't like that, just set this variable to @code{nil}.
1310
1311 New groups that match this regexp are subscribed using
1312 @code{gnus-subscribe-options-newsgroup-method}.
1313
1314
1315 @node Changing Servers
1316 @section Changing Servers
1317 @cindex changing servers
1318
1319 Sometimes it is necessary to move from one @sc{nntp} server to another.
1320 This happens very rarely, but perhaps you change jobs, or one server is
1321 very flaky and you want to use another.
1322
1323 Changing the server is pretty easy, right?  You just change
1324 @code{gnus-select-method} to point to the new server?
1325
1326 @emph{Wrong!}
1327
1328 Article numbers are not (in any way) kept synchronized between different
1329 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1330 you have read is by keeping track of article numbers.  So when you
1331 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1332 worthless.
1333
1334 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1335 file from one server to another.  They all have one thing in
1336 common---they take a looong time to run.  You don't want to use these
1337 functions more than absolutely necessary.
1338
1339 @kindex M-x gnus-change-server
1340 @findex gnus-change-server
1341 If you have access to both servers, Gnus can request the headers for all
1342 the articles you have read and compare @code{Message-ID}s and map the
1343 article numbers of the read articles and article marks.  The @kbd{M-x
1344 gnus-change-server} command will do this for all your native groups.  It
1345 will prompt for the method you want to move to.
1346
1347 @kindex M-x gnus-group-move-group-to-server
1348 @findex gnus-group-move-group-to-server
1349 You can also move individual groups with the @kbd{M-x
1350 gnus-group-move-group-to-server} command.  This is useful if you want to
1351 move a (foreign) group from one server to another.
1352
1353 @kindex M-x gnus-group-clear-data-on-native-groups
1354 @findex gnus-group-clear-data-on-native-groups
1355 If you don't have access to both the old and new server, all your marks
1356 and read ranges have become worthless.  You can use the @kbd{M-x
1357 gnus-group-clear-data-on-native-groups} command to clear out all data
1358 that you have on your native groups.  Use with caution.
1359
1360 After changing servers, you @strong{must} move the cache hierarchy away,
1361 since the cached articles will have wrong article numbers, which will
1362 affect which articles Gnus thinks are read.
1363
1364
1365 @node Startup Files
1366 @section Startup Files
1367 @cindex startup files
1368 @cindex .newsrc
1369 @cindex .newsrc.el
1370 @cindex .newsrc.eld
1371
1372 Now, you all know about the @file{.newsrc} file.  All subscription
1373 information is traditionally stored in this file.
1374
1375 Things got a bit more complicated with @sc{gnus}.  In addition to
1376 keeping the @file{.newsrc} file updated, it also used a file called
1377 @file{.newsrc.el} for storing all the information that didn't fit into
1378 the @file{.newsrc} file.  (Actually, it also duplicated everything in
1379 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
1380 files was the most recently saved, which enabled people to swap between
1381 @sc{gnus} and other newsreaders.
1382
1383 That was kinda silly, so Gnus went one better: In addition to the
1384 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1385 @file{.newsrc.eld}.  It will read whichever of these files that are most
1386 recent, but it will never write a @file{.newsrc.el} file.  You should
1387 never delete the @file{.newsrc.eld} file---it contains much information
1388 not stored in the @file{.newsrc} file.
1389
1390 @vindex gnus-save-newsrc-file
1391 @vindex gnus-read-newsrc-file
1392 You can turn off writing the @file{.newsrc} file by setting
1393 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1394 the file and save some space, as well as exiting from gnus faster.
1395 However, this will make it impossible to use other newsreaders than
1396 gnus.  But hey, who would want to, right?  Similarly, setting
1397 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1398 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1399 convenient if you have a tendency to use Netscape once in a while.
1400
1401 @vindex gnus-save-killed-list
1402 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1403 will not save the list of killed groups to the startup file.  This will
1404 save both time (when starting and quitting) and space (on disk).  It
1405 will also mean that Gnus has no record of what groups are new or old,
1406 so the automatic new groups subscription methods become meaningless.
1407 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1408 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1409 Groups}).  This variable can also be a regular expression.  If that's
1410 the case, remove all groups that do not match this regexp before
1411 saving.  This can be useful in certain obscure situations that involve
1412 several servers where not all servers support @code{ask-server}.
1413
1414 @vindex gnus-startup-file
1415 The @code{gnus-startup-file} variable says where the startup files are.
1416 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1417 file being whatever that one is, with a @samp{.eld} appended.
1418
1419 @vindex gnus-save-newsrc-hook
1420 @vindex gnus-save-quick-newsrc-hook
1421 @vindex gnus-save-standard-newsrc-hook
1422 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1423 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1424 saving the @file{.newsrc.eld} file, and
1425 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1426 @file{.newsrc} file.  The latter two are commonly used to turn version
1427 control on or off.  Version control is on by default when saving the
1428 startup files.  If you want to turn backup creation off, say something like:
1429
1430 @lisp
1431 (defun turn-off-backup ()
1432   (set (make-local-variable 'backup-inhibited) t))
1433
1434 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1435 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1436 @end lisp
1437
1438 @vindex gnus-init-file
1439 When gnus starts, it will read the @code{gnus-site-init-file}
1440 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1441 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
1442 and can be used to avoid cluttering your @file{~/.emacs} and
1443 @file{site-init} files with gnus stuff.  Gnus will also check for files
1444 with the same names as these, but with @file{.elc} and @file{.el}
1445 suffixes.  In other words, if you have set @code{gnus-init-file} to
1446 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1447 and finally @file{~/.gnus} (in this order).
1448
1449
1450
1451 @node Auto Save
1452 @section Auto Save
1453 @cindex dribble file
1454 @cindex auto-save
1455
1456 Whenever you do something that changes the gnus data (reading articles,
1457 catching up, killing/subscribing groups), the change is added to a
1458 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
1459 Emacs way.  If your Emacs should crash before you have saved the
1460 @file{.newsrc} files, all changes you have made can be recovered from
1461 this file.
1462
1463 If gnus detects this file at startup, it will ask the user whether to
1464 read it.  The auto save file is deleted whenever the real startup file is
1465 saved.
1466
1467 @vindex gnus-use-dribble-file
1468 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1469 maintain a dribble buffer.  The default is @code{t}.
1470
1471 @vindex gnus-dribble-directory
1472 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
1473 this variable is @code{nil}, which it is by default, gnus will dribble
1474 into the directory where the @file{.newsrc} file is located.  (This is
1475 normally the user's home directory.)  The dribble file will get the same
1476 file permissions as the @code{.newsrc} file.
1477
1478 @vindex gnus-always-read-dribble-file
1479 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1480 read the dribble file on startup without querying the user.
1481
1482
1483 @node The Active File
1484 @section The Active File
1485 @cindex active file
1486 @cindex ignored groups
1487
1488 When gnus starts, or indeed whenever it tries to determine whether new
1489 articles have arrived, it reads the active file.  This is a very large
1490 file that lists all the active groups and articles on the server.
1491
1492 @vindex gnus-ignored-newsgroups
1493 Before examining the active file, gnus deletes all lines that match the
1494 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
1495 any groups with bogus names, but you can use this variable to make gnus
1496 ignore hierarchies you aren't ever interested in.  However, this is not
1497 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
1498 Groups} for an overview of other variables that can be used instead.
1499
1500 @c This variable is
1501 @c @code{nil} by default, and will slow down active file handling somewhat
1502 @c if you set it to anything else.
1503
1504 @vindex gnus-read-active-file
1505 @c @head
1506 The active file can be rather Huge, so if you have a slow network, you
1507 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1508 reading the active file.  This variable is @code{some} by default.
1509
1510 Gnus will try to make do by getting information just on the groups that
1511 you actually subscribe to.
1512
1513 Note that if you subscribe to lots and lots of groups, setting this
1514 variable to @code{nil} will probably make gnus slower, not faster.  At
1515 present, having this variable @code{nil} will slow gnus down
1516 considerably, unless you read news over a 2400 baud modem.
1517
1518 This variable can also have the value @code{some}.  Gnus will then
1519 attempt to read active info only on the subscribed groups.  On some
1520 servers this is quite fast (on sparkling, brand new INN servers that
1521 support the @code{LIST ACTIVE group} command), on others this isn't fast
1522 at all.  In any case, @code{some} should be faster than @code{nil}, and
1523 is certainly faster than @code{t} over slow lines.
1524
1525 Some news servers (old versions of Leafnode and old versions of INN, for
1526 instance) do not support the @code{LIST ACTIVE group}.  For these
1527 servers, @code{nil} is probably the most efficient value for this
1528 variable.
1529
1530 If this variable is @code{nil}, gnus will ask for group info in total
1531 lock-step, which isn't very fast.  If it is @code{some} and you use an
1532 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1533 read all the replies in one swoop.  This will normally result in better
1534 performance, but if the server does not support the aforementioned
1535 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1536
1537 If you think that starting up Gnus takes too long, try all the three
1538 different values for this variable and see what works best for you.
1539
1540 In any case, if you use @code{some} or @code{nil}, you should definitely
1541 kill all groups that you aren't interested in to speed things up.
1542
1543 Note that this variable also affects active file retrieval from
1544 secondary select methods.
1545
1546
1547 @node Startup Variables
1548 @section Startup Variables
1549
1550 @table @code
1551
1552 @item gnus-load-hook
1553 @vindex gnus-load-hook
1554 A hook run while gnus is being loaded.  Note that this hook will
1555 normally be run just once in each Emacs session, no matter how many
1556 times you start gnus.
1557
1558 @item gnus-before-startup-hook
1559 @vindex gnus-before-startup-hook
1560 A hook run after starting up gnus successfully.
1561
1562 @item gnus-startup-hook
1563 @vindex gnus-startup-hook
1564 A hook run as the very last thing after starting up gnus
1565
1566 @item gnus-started-hook
1567 @vindex gnus-started-hook
1568 A hook that is run as the very last thing after starting up gnus
1569 successfully.
1570
1571 @item gnus-setup-news-hook
1572 @vindex gnus-setup-news-hook
1573 A hook that is run after reading the @file{.newsrc} file(s), but before
1574 generating the group buffer.
1575
1576 @item gnus-check-bogus-newsgroups
1577 @vindex gnus-check-bogus-newsgroups
1578 If non-@code{nil}, gnus will check for and delete all bogus groups at
1579 startup.  A @dfn{bogus group} is a group that you have in your
1580 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1581 bogus groups can take quite a while, so to save time and resources it's
1582 best to leave this option off, and do the checking for bogus groups once
1583 in a while from the group buffer instead (@pxref{Group Maintenance}).
1584
1585 @item gnus-inhibit-startup-message
1586 @vindex gnus-inhibit-startup-message
1587 If non-@code{nil}, the startup message won't be displayed.  That way,
1588 your boss might not notice as easily that you are reading news instead
1589 of doing your job.  Note that this variable is used before
1590 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1591
1592 @item gnus-no-groups-message
1593 @vindex gnus-no-groups-message
1594 Message displayed by gnus when no groups are available.
1595
1596 @item gnus-play-startup-jingle
1597 @vindex gnus-play-startup-jingle
1598 If non-@code{nil}, play the gnus jingle at startup.
1599
1600 @item gnus-startup-jingle
1601 @vindex gnus-startup-jingle
1602 Jingle to be played if the above variable is non-@code{nil}.  The
1603 default is @samp{Tuxedomoon.Jingle4.au}.
1604
1605 @end table
1606
1607
1608 @node Group Buffer
1609 @chapter Group Buffer
1610 @cindex group buffer
1611
1612 @c Alex Schroeder suggests to rearrange this as follows:
1613 @c
1614 @c <kensanata> ok, just save it for reference.  I'll go to bed in a minute.
1615 @c   1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1616 @c   4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1617 @c   7. Group Score, 8. Group Buffer Format
1618 @c <kensanata> Group Levels should have more information on levels 5 to 9.  I
1619 @c   suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1620 @c <kensanata> First, "Gnus considers groups... (default 9)."
1621 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1622 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1623 @c <kensanata> Then expand the next paragraph or add some more to it.
1624 @c    This short one sentence explains levels 1 and 2, therefore I understand
1625 @c    that I should keep important news at 3 and boring news at 4.
1626 @c    Say so!  Then go on to explain why I should bother with levels 6 to 9.
1627 @c    Maybe keep those that you don't want to read temporarily at 6,
1628 @c    those that you never want to read at 8, those that offend your
1629 @c    human rights at 9...
1630
1631
1632 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1633 is the first buffer shown when gnus starts, and will never be killed as
1634 long as gnus is active.
1635
1636 @iftex
1637 @iflatex
1638 \gnusfigure{The Group Buffer}{320}{
1639 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1640 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1641 \put(120,38){\vector(1,2){10}}
1642 \put(40,60){\makebox(0,0)[r]{Mode line}}
1643 \put(40,58){\vector(1,0){30}}
1644 \put(200,28){\makebox(0,0)[t]{Native select method}}
1645 \put(200,26){\vector(-1,2){15}}
1646 }
1647 @end iflatex
1648 @end iftex
1649
1650 @menu
1651 * Group Buffer Format::         Information listed and how you can change it.
1652 * Group Maneuvering::           Commands for moving in the group buffer.
1653 * Selecting a Group::           Actually reading news.
1654 * Subscription Commands::       Unsubscribing, killing, subscribing.
1655 * Group Data::                  Changing the info for a group.
1656 * Group Levels::                Levels? What are those, then?
1657 * Group Score::                 A mechanism for finding out what groups you like.
1658 * Marking Groups::              You can mark groups for later processing.
1659 * Foreign Groups::              Creating and editing groups.
1660 * Group Parameters::            Each group may have different parameters set.
1661 * Listing Groups::              Gnus can list various subsets of the groups.
1662 * Sorting Groups::              Re-arrange the group order.
1663 * Group Maintenance::           Maintaining a tidy @file{.newsrc} file.
1664 * Browse Foreign Server::       You can browse a server.  See what it has to offer.
1665 * Exiting Gnus::                Stop reading news and get some work done.
1666 * Group Topics::                A folding group mode divided into topics.
1667 * Misc Group Stuff::            Other stuff that you can to do.
1668 @end menu
1669
1670
1671 @node Group Buffer Format
1672 @section Group Buffer Format
1673
1674 @menu
1675 * Group Line Specification::    Deciding how the group buffer is to look.
1676 * Group Modeline Specification::  The group buffer modeline.
1677 * Group Highlighting::          Having nice colors in the group buffer.
1678 @end menu
1679
1680
1681 @node Group Line Specification
1682 @subsection Group Line Specification
1683 @cindex group buffer format
1684
1685 The default format of the group buffer is nice and dull, but you can
1686 make it as exciting and ugly as you feel like.
1687
1688 Here's a couple of example group lines:
1689
1690 @example
1691      25: news.announce.newusers
1692  *    0: alt.fan.andrea-dworkin
1693 @end example
1694
1695 Quite simple, huh?
1696
1697 You can see that there are 25 unread articles in
1698 @samp{news.announce.newusers}.  There are no unread articles, but some
1699 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1700 asterisk at the beginning of the line?).
1701
1702 @vindex gnus-group-line-format
1703 You can change that format to whatever you want by fiddling with the
1704 @code{gnus-group-line-format} variable.  This variable works along the
1705 lines of a @code{format} specification, which is pretty much the same as
1706 a @code{printf} specifications, for those of you who use (feh!) C.
1707 @xref{Formatting Variables}.
1708
1709 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1710
1711 There should always be a colon on the line; the cursor always moves to
1712 the colon after performing an operation.  @xref{Positioning
1713 Point}. Nothing else is required---not even the group name.  All
1714 displayed text is just window dressing, and is never examined by Gnus.
1715 Gnus stores all real information it needs using text properties.
1716
1717 (Note that if you make a really strange, wonderful, spreadsheet-like
1718 layout, everybody will believe you are hard at work with the accounting
1719 instead of wasting time reading news.)
1720
1721 Here's a list of all available format characters:
1722
1723 @table @samp
1724
1725 @item M
1726 An asterisk if the group only has marked articles.
1727
1728 @item S
1729 Whether the group is subscribed.
1730
1731 @item L
1732 Level of subscribedness.
1733
1734 @item N
1735 Number of unread articles.
1736
1737 @item I
1738 Number of dormant articles.
1739
1740 @item T
1741 Number of ticked articles.
1742
1743 @item R
1744 Number of read articles.
1745
1746 @item t
1747 Estimated total number of articles.  (This is really @var{max-number}
1748 minus @var{min-number} plus 1.)
1749
1750 Gnus uses this estimation because the NNTP protocol provides efficient
1751 access to @var{max-number} and @var{min-number} but getting the true
1752 unread message count is not possible efficiently.  For hysterical
1753 raisins, even the mail back ends, where the true number of unread
1754 messages might be available efficiently, use the same limited
1755 interface.  To remove this restriction from Gnus means that the
1756 back end interface has to be changed, which is not an easy job.  If you
1757 want to work on this, please contact the Gnus mailing list.
1758
1759 @item y
1760 Number of unread, unticked, non-dormant articles.
1761
1762 @item i
1763 Number of ticked and dormant articles.
1764
1765 @item g
1766 Full group name.
1767
1768 @item G
1769 Group name.
1770
1771 @item D
1772 Newsgroup description.
1773
1774 @item o
1775 @samp{m} if moderated.
1776
1777 @item O
1778 @samp{(m)} if moderated.
1779
1780 @item s
1781 Select method.
1782
1783 @item n
1784 Select from where.
1785
1786 @item z
1787 A string that looks like @samp{<%s:%n>} if a foreign select method is
1788 used.
1789
1790 @item P
1791 Indentation based on the level of the topic (@pxref{Group Topics}).
1792
1793 @item c
1794 @vindex gnus-group-uncollapsed-levels
1795 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1796 variable says how many levels to leave at the end of the group name.
1797 The default is 1---this will mean that group names like
1798 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1799
1800 @item m
1801 @vindex gnus-new-mail-mark
1802 @cindex %
1803 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1804 the group lately.
1805
1806 @item p
1807 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1808
1809 @item d
1810 A string that says when you last read the group (@pxref{Group
1811 Timestamp}).
1812
1813 @item u
1814 User defined specifier.  The next character in the format string should
1815 be a letter.  Gnus will call the function
1816 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1817 following @samp{%u}.  The function will be passed a single dummy
1818 parameter as argument.  The function should return a string, which will
1819 be inserted into the buffer just like information from any other
1820 specifier.
1821 @end table
1822
1823 @cindex *
1824 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1825 if no info is available---for instance, if it is a non-activated foreign
1826 group, or a bogus native group.
1827
1828
1829 @node Group Modeline Specification
1830 @subsection Group Modeline Specification
1831 @cindex group modeline
1832
1833 @vindex gnus-group-mode-line-format
1834 The mode line can be changed by setting
1835 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1836 doesn't understand that many format specifiers:
1837
1838 @table @samp
1839 @item S
1840 The native news server.
1841 @item M
1842 The native select method.
1843 @end table
1844
1845
1846 @node Group Highlighting
1847 @subsection Group Highlighting
1848 @cindex highlighting
1849 @cindex group highlighting
1850
1851 @vindex gnus-group-highlight
1852 Highlighting in the group buffer is controlled by the
1853 @code{gnus-group-highlight} variable.  This is an alist with elements
1854 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1855 something non-@code{nil}, the @var{face} will be used on the line.
1856
1857 Here's an example value for this variable that might look nice if the
1858 background is dark:
1859
1860 @lisp
1861 (cond (window-system
1862        (setq custom-background-mode 'light)
1863        (defface my-group-face-1
1864          '((t (:foreground "Red" :bold t))) "First group face")
1865        (defface my-group-face-2
1866          '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1867        (defface my-group-face-3
1868          '((t (:foreground "Green4" :bold t))) "Third group face")
1869        (defface my-group-face-4
1870          '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1871        (defface my-group-face-5
1872          '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1873
1874 (setq gnus-group-highlight
1875       '(((> unread 200) . my-group-face-1)
1876         ((and (< level 3) (zerop unread)) . my-group-face-2)
1877         ((< level 3) . my-group-face-3)
1878         ((zerop unread) . my-group-face-4)
1879         (t . my-group-face-5)))
1880 @end lisp
1881
1882 Also @pxref{Faces and Fonts}.
1883
1884 Variables that are dynamically bound when the forms are evaluated
1885 include:
1886
1887 @table @code
1888 @item group
1889 The group name.
1890 @item unread
1891 The number of unread articles in the group.
1892 @item method
1893 The select method.
1894 @item mailp
1895 Whether the group is a mail group.
1896 @item level
1897 The level of the group.
1898 @item score
1899 The score of the group.
1900 @item ticked
1901 The number of ticked articles in the group.
1902 @item total
1903 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1904 MIN-NUMBER plus one.
1905 @item topic
1906 When using the topic minor mode, this variable is bound to the current
1907 topic being inserted.
1908 @end table
1909
1910 When the forms are @code{eval}ed, point is at the beginning of the line
1911 of the group in question, so you can use many of the normal gnus
1912 functions for snarfing info on the group.
1913
1914 @vindex gnus-group-update-hook
1915 @findex gnus-group-highlight-line
1916 @code{gnus-group-update-hook} is called when a group line is changed.
1917 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1918 calls @code{gnus-group-highlight-line} by default.
1919
1920
1921 @node Group Maneuvering
1922 @section Group Maneuvering
1923 @cindex group movement
1924
1925 All movement commands understand the numeric prefix and will behave as
1926 expected, hopefully.
1927
1928 @table @kbd
1929
1930 @item n
1931 @kindex n (Group)
1932 @findex gnus-group-next-unread-group
1933 Go to the next group that has unread articles
1934 (@code{gnus-group-next-unread-group}).
1935
1936 @item p
1937 @itemx DEL
1938 @kindex DEL (Group)
1939 @kindex p (Group)
1940 @findex gnus-group-prev-unread-group
1941 Go to the previous group that has unread articles
1942 (@code{gnus-group-prev-unread-group}).
1943
1944 @item N
1945 @kindex N (Group)
1946 @findex gnus-group-next-group
1947 Go to the next group (@code{gnus-group-next-group}).
1948
1949 @item P
1950 @kindex P (Group)
1951 @findex gnus-group-prev-group
1952 Go to the previous group (@code{gnus-group-prev-group}).
1953
1954 @item M-n
1955 @kindex M-n (Group)
1956 @findex gnus-group-next-unread-group-same-level
1957 Go to the next unread group on the same (or lower) level
1958 (@code{gnus-group-next-unread-group-same-level}).
1959
1960 @item M-p
1961 @kindex M-p (Group)
1962 @findex gnus-group-prev-unread-group-same-level
1963 Go to the previous unread group on the same (or lower) level
1964 (@code{gnus-group-prev-unread-group-same-level}).
1965 @end table
1966
1967 Three commands for jumping to groups:
1968
1969 @table @kbd
1970
1971 @item j
1972 @kindex j (Group)
1973 @findex gnus-group-jump-to-group
1974 Jump to a group (and make it visible if it isn't already)
1975 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1976 like living groups.
1977
1978 @item ,
1979 @kindex , (Group)
1980 @findex gnus-group-best-unread-group
1981 Jump to the unread group with the lowest level
1982 (@code{gnus-group-best-unread-group}).
1983
1984 @item .
1985 @kindex . (Group)
1986 @findex gnus-group-first-unread-group
1987 Jump to the first group with unread articles
1988 (@code{gnus-group-first-unread-group}).
1989 @end table
1990
1991 @vindex gnus-group-goto-unread
1992 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1993 commands will move to the next group, not the next unread group.  Even
1994 the commands that say they move to the next unread group.  The default
1995 is @code{t}.
1996
1997
1998 @node Selecting a Group
1999 @section Selecting a Group
2000 @cindex group selection
2001
2002 @table @kbd
2003
2004 @item SPACE
2005 @kindex SPACE (Group)
2006 @findex gnus-group-read-group
2007 Select the current group, switch to the summary buffer and display the
2008 first unread article (@code{gnus-group-read-group}).  If there are no
2009 unread articles in the group, or if you give a non-numerical prefix to
2010 this command, gnus will offer to fetch all the old articles in this
2011 group from the server.  If you give a numerical prefix @var{N}, @var{N}
2012 determines the number of articles gnus will fetch.  If @var{N} is
2013 positive, gnus fetches the @var{N} newest articles, if @var{N} is
2014 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
2015
2016 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2017 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2018 - 4 2 SPC} fetches the 42 oldest ones.
2019
2020 When you are in the group (in the Summary buffer), you can type
2021 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2022 ones.
2023
2024 @item RET
2025 @kindex RET (Group)
2026 @findex gnus-group-select-group
2027 Select the current group and switch to the summary buffer
2028 (@code{gnus-group-select-group}).  Takes the same arguments as
2029 @code{gnus-group-read-group}---the only difference is that this command
2030 does not display the first unread article automatically upon group
2031 entry.
2032
2033 @item M-RET
2034 @kindex M-RET (Group)
2035 @findex gnus-group-quick-select-group
2036 This does the same as the command above, but tries to do it with the
2037 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
2038 scoring/killing will be performed, there will be no highlights and no
2039 expunging.  This might be useful if you're in a real hurry and have to
2040 enter some humongous group.  If you give a 0 prefix to this command
2041 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
2042 which is useful if you want to toggle threading before generating the
2043 summary buffer (@pxref{Summary Generation Commands}).
2044
2045 @item M-SPACE
2046 @kindex M-SPACE (Group)
2047 @findex gnus-group-visible-select-group
2048 This is yet one more command that does the same as the @kbd{RET}
2049 command, but this one does it without expunging and hiding dormants
2050 (@code{gnus-group-visible-select-group}).
2051
2052 @item C-M-RET
2053 @kindex C-M-RET (Group)
2054 @findex gnus-group-select-group-ephemerally
2055 Finally, this command selects the current group ephemerally without
2056 doing any processing of its contents
2057 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
2058 turned off.  Everything you do in the group after selecting it in this
2059 manner will have no permanent effects.
2060
2061 @end table
2062
2063 @vindex gnus-large-newsgroup
2064 The @code{gnus-large-newsgroup} variable says what gnus should consider
2065 to be a big group.  This is 200 by default.  If the group has more
2066 (unread and/or ticked) articles than this, gnus will query the user
2067 before entering the group.  The user can then specify how many articles
2068 should be fetched from the server.  If the user specifies a negative
2069 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
2070 is positive, the @code{n} articles that have arrived most recently will
2071 be fetched.
2072
2073 @vindex gnus-select-group-hook
2074 @vindex gnus-auto-select-first
2075 @code{gnus-auto-select-first} control whether any articles are selected
2076 automatically when entering a group with the @kbd{SPACE} command.
2077
2078 @table @code
2079
2080 @item nil
2081 Don't select any articles when entering the group.  Just display the
2082 full summary buffer.
2083
2084 @item t
2085 Select the first unread article when entering the group.
2086
2087 @item best
2088 Select the highest scored article in the group when entering the
2089 group.
2090
2091 @end table
2092
2093 This variable can also be a function.  In that case, that function will
2094 be called to place point on a subject line, and/or select some article.
2095 Useful functions include:
2096
2097 @table @code
2098 @item gnus-summary-first-unread-subject
2099 Place point on the subject line of the first unread article, but
2100 don't select the article.
2101
2102 @item gnus-summary-first-unread-article
2103 Select the first unread article.
2104
2105 @item gnus-summary-best-unread-article
2106 Select the highest-scored unread article.
2107 @end table
2108
2109
2110 If you want to prevent automatic selection in some group (say, in a
2111 binary group with Huge articles) you can set this variable to @code{nil}
2112 in @code{gnus-select-group-hook}, which is called when a group is
2113 selected.
2114
2115
2116 @node Subscription Commands
2117 @section Subscription Commands
2118 @cindex subscription
2119
2120 @table @kbd
2121
2122 @item S t
2123 @itemx u
2124 @kindex S t (Group)
2125 @kindex u (Group)
2126 @findex gnus-group-unsubscribe-current-group
2127 @c @icon{gnus-group-unsubscribe}
2128 Toggle subscription to the current group
2129 (@code{gnus-group-unsubscribe-current-group}).
2130
2131 @item S s
2132 @itemx U
2133 @kindex S s (Group)
2134 @kindex U (Group)
2135 @findex gnus-group-unsubscribe-group
2136 Prompt for a group to subscribe, and then subscribe it.  If it was
2137 subscribed already, unsubscribe it instead
2138 (@code{gnus-group-unsubscribe-group}).
2139
2140 @item S k
2141 @itemx C-k
2142 @kindex S k (Group)
2143 @kindex C-k (Group)
2144 @findex gnus-group-kill-group
2145 @c @icon{gnus-group-kill-group}
2146 Kill the current group (@code{gnus-group-kill-group}).
2147
2148 @item S y
2149 @itemx C-y
2150 @kindex S y (Group)
2151 @kindex C-y (Group)
2152 @findex gnus-group-yank-group
2153 Yank the last killed group (@code{gnus-group-yank-group}).
2154
2155 @item C-x C-t
2156 @kindex C-x C-t (Group)
2157 @findex gnus-group-transpose-groups
2158 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
2159 really a subscription command, but you can use it instead of a
2160 kill-and-yank sequence sometimes.
2161
2162 @item S w
2163 @itemx C-w
2164 @kindex S w (Group)
2165 @kindex C-w (Group)
2166 @findex gnus-group-kill-region
2167 Kill all groups in the region (@code{gnus-group-kill-region}).
2168
2169 @item S z
2170 @kindex S z (Group)
2171 @findex gnus-group-kill-all-zombies
2172 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2173
2174 @item S C-k
2175 @kindex S C-k (Group)
2176 @findex gnus-group-kill-level
2177 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2178 These groups can't be yanked back after killing, so this command should
2179 be used with some caution.  The only time where this command comes in
2180 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2181 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
2182 kill off all unsubscribed groups that do not have message numbers in the
2183 @file{.newsrc} file.
2184
2185 @end table
2186
2187 Also @pxref{Group Levels}.
2188
2189
2190 @node Group Data
2191 @section Group Data
2192
2193 @table @kbd
2194
2195 @item c
2196 @kindex c (Group)
2197 @findex gnus-group-catchup-current
2198 @vindex gnus-group-catchup-group-hook
2199 @c @icon{gnus-group-catchup-current}
2200 Mark all unticked articles in this group as read
2201 (@code{gnus-group-catchup-current}).
2202 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2203 the group buffer.
2204
2205 @item C
2206 @kindex C (Group)
2207 @findex gnus-group-catchup-current-all
2208 Mark all articles in this group, even the ticked ones, as read
2209 (@code{gnus-group-catchup-current-all}).
2210
2211 @item M-c
2212 @kindex M-c (Group)
2213 @findex gnus-group-clear-data
2214 Clear the data from the current group---nix out marks and the list of
2215 read articles (@code{gnus-group-clear-data}).
2216
2217 @item M-x gnus-group-clear-data-on-native-groups
2218 @kindex M-x gnus-group-clear-data-on-native-groups
2219 @findex gnus-group-clear-data-on-native-groups
2220 If you have switched from one @sc{nntp} server to another, all your marks
2221 and read ranges have become worthless.  You can use this command to
2222 clear out all data that you have on your native groups.  Use with
2223 caution.
2224
2225 @end table
2226
2227
2228 @node Group Levels
2229 @section Group Levels
2230 @cindex group level
2231 @cindex level
2232
2233 All groups have a level of @dfn{subscribedness}.  For instance, if a
2234 group is on level 2, it is more subscribed than a group on level 5.  You
2235 can ask gnus to just list groups on a given level or lower
2236 (@pxref{Listing Groups}), or to just check for new articles in groups on
2237 a given level or lower (@pxref{Scanning New Messages}).
2238
2239 Remember:  The higher the level of the group, the less important it is.
2240
2241 @table @kbd
2242
2243 @item S l
2244 @kindex S l (Group)
2245 @findex gnus-group-set-current-level
2246 Set the level of the current group.  If a numeric prefix is given, the
2247 next @var{n} groups will have their levels set.  The user will be
2248 prompted for a level.
2249 @end table
2250
2251 @vindex gnus-level-killed
2252 @vindex gnus-level-zombie
2253 @vindex gnus-level-unsubscribed
2254 @vindex gnus-level-subscribed
2255 Gnus considers groups from levels 1 to
2256 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2257 @code{gnus-level-subscribed} (exclusive) and
2258 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2259 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2260 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2261 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
2262 same, but zombie and killed groups have no information on what articles
2263 you have read, etc, stored.  This distinction between dead and living
2264 groups isn't done because it is nice or clever, it is done purely for
2265 reasons of efficiency.
2266
2267 It is recommended that you keep all your mail groups (if any) on quite
2268 low levels (e.g. 1 or 2).
2269
2270 Maybe the following description of the default behavior of Gnus helps to
2271 understand what these levels are all about.  By default, Gnus shows you
2272 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2273 empty subscribed groups and unsubscribed groups, too.  Type @kbd{l} to
2274 go back to showing nonempty subscribed groups again.  Thus, unsubscribed
2275 groups are hidden, in a way.
2276
2277 Zombie and killed groups are similar to unsubscribed groups in that they
2278 are hidden by default.  But they are different from subscribed and
2279 unsubscribed groups in that Gnus doesn't ask the news server for
2280 information (number of messages, number of unread messages) on zombie
2281 and killed groups.  Normally, you use @kbd{C-k} to kill the groups you
2282 aren't interested in.  If most groups are killed, Gnus is faster.
2283
2284 Why does Gnus distinguish between zombie and killed groups?  Well, when
2285 a new group arrives on the server, Gnus by default makes it a zombie
2286 group.  This means that you are normally not bothered with new groups,
2287 but you can type @kbd{A z} to get a list of all new groups.  Subscribe
2288 the ones you like and kill the ones you don't want.  (@kbd{A k} shows a
2289 list of killed groups.)
2290
2291 If you want to play with the level variables, you should show some care.
2292 Set them once, and don't touch them ever again.  Better yet, don't touch
2293 them at all unless you know exactly what you're doing.
2294
2295 @vindex gnus-level-default-unsubscribed
2296 @vindex gnus-level-default-subscribed
2297 Two closely related variables are @code{gnus-level-default-subscribed}
2298 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2299 which are the levels that new groups will be put on if they are
2300 (un)subscribed.  These two variables should, of course, be inside the
2301 relevant valid ranges.
2302
2303 @vindex gnus-keep-same-level
2304 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2305 will only move to groups of the same level (or lower).  In
2306 particular, going from the last article in one group to the next group
2307 will go to the next group of the same level (or lower).  This might be
2308 handy if you want to read the most important groups before you read the
2309 rest.
2310
2311 If this variable is @code{best}, Gnus will make the next newsgroup the
2312 one with the best level.
2313
2314 @vindex gnus-group-default-list-level
2315 All groups with a level less than or equal to
2316 @code{gnus-group-default-list-level} will be listed in the group buffer
2317 by default.
2318
2319 @vindex gnus-group-list-inactive-groups
2320 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2321 groups will be listed along with the unread groups.  This variable is
2322 @code{t} by default.  If it is @code{nil}, inactive groups won't be
2323 listed.
2324
2325 @vindex gnus-group-use-permanent-levels
2326 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2327 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2328 use this level as the ``work'' level.
2329
2330 @vindex gnus-activate-level
2331 Gnus will normally just activate (i. e., query the server about) groups
2332 on level @code{gnus-activate-level} or less.  If you don't want to
2333 activate unsubscribed groups, for instance, you might set this variable
2334 to 5.  The default is 6.
2335
2336
2337 @node Group Score
2338 @section Group Score
2339 @cindex group score
2340 @cindex group rank
2341 @cindex rank
2342
2343 You would normally keep important groups on high levels, but that scheme
2344 is somewhat restrictive.  Don't you wish you could have Gnus sort the
2345 group buffer according to how often you read groups, perhaps?  Within
2346 reason?
2347
2348 This is what @dfn{group score} is for.  You can have Gnus assign a score
2349 to each group through the mechanism described below.  You can then sort
2350 the group buffer based on this score.  Alternatively, you can sort on
2351 score and then level.  (Taken together, the level and the score is
2352 called the @dfn{rank} of the group.  A group that is on level 4 and has
2353 a score of 1 has a higher rank than a group on level 5 that has a score
2354 of 300.  (The level is the most significant part and the score is the
2355 least significant part.))
2356
2357 @findex gnus-summary-bubble-group
2358 If you want groups you read often to get higher scores than groups you
2359 read seldom you can add the @code{gnus-summary-bubble-group} function to
2360 the @code{gnus-summary-exit-hook} hook.  This will result (after
2361 sorting) in a bubbling sort of action.  If you want to see that in
2362 action after each summary exit, you can add
2363 @code{gnus-group-sort-groups-by-rank} or
2364 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2365 slow things down somewhat.
2366
2367
2368 @node Marking Groups
2369 @section Marking Groups
2370 @cindex marking groups
2371
2372 If you want to perform some command on several groups, and they appear
2373 subsequently in the group buffer, you would normally just give a
2374 numerical prefix to the command.  Most group commands will then do your
2375 bidding on those groups.
2376
2377 However, if the groups are not in sequential order, you can still
2378 perform a command on several groups.  You simply mark the groups first
2379 with the process mark and then execute the command.
2380
2381 @table @kbd
2382
2383 @item #
2384 @kindex # (Group)
2385 @itemx M m
2386 @kindex M m (Group)
2387 @findex gnus-group-mark-group
2388 Set the mark on the current group (@code{gnus-group-mark-group}).
2389
2390 @item M-#
2391 @kindex M-# (Group)
2392 @itemx M u
2393 @kindex M u (Group)
2394 @findex gnus-group-unmark-group
2395 Remove the mark from the current group
2396 (@code{gnus-group-unmark-group}).
2397
2398 @item M U
2399 @kindex M U (Group)
2400 @findex gnus-group-unmark-all-groups
2401 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2402
2403 @item M w
2404 @kindex M w (Group)
2405 @findex gnus-group-mark-region
2406 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2407
2408 @item M b
2409 @kindex M b (Group)
2410 @findex gnus-group-mark-buffer
2411 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2412
2413 @item M r
2414 @kindex M r (Group)
2415 @findex gnus-group-mark-regexp
2416 Mark all groups that match some regular expression
2417 (@code{gnus-group-mark-regexp}).
2418 @end table
2419
2420 Also @pxref{Process/Prefix}.
2421
2422 @findex gnus-group-universal-argument
2423 If you want to execute some command on all groups that have been marked
2424 with the process mark, you can use the @kbd{M-&}
2425 (@code{gnus-group-universal-argument}) command.  It will prompt you for
2426 the command to be executed.
2427
2428
2429 @node Foreign Groups
2430 @section Foreign Groups
2431 @cindex foreign groups
2432
2433 Below are some group mode commands for making and editing general foreign
2434 groups, as well as commands to ease the creation of a few
2435 special-purpose groups.  All these commands insert the newly created
2436 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2437 consulted.
2438
2439 @table @kbd
2440
2441 @item G m
2442 @kindex G m (Group)
2443 @findex gnus-group-make-group
2444 @cindex making groups
2445 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
2446 for a name, a method and possibly an @dfn{address}.  For an easier way
2447 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2448
2449 @item G r
2450 @kindex G r (Group)
2451 @findex gnus-group-rename-group
2452 @cindex renaming groups
2453 Rename the current group to something else
2454 (@code{gnus-group-rename-group}).  This is valid only on some
2455 groups---mail groups mostly.  This command might very well be quite slow
2456 on some back ends.
2457
2458 @item G c
2459 @kindex G c (Group)
2460 @cindex customizing
2461 @findex gnus-group-customize
2462 Customize the group parameters (@code{gnus-group-customize}).
2463
2464 @item G e
2465 @kindex G e (Group)
2466 @findex gnus-group-edit-group-method
2467 @cindex renaming groups
2468 Enter a buffer where you can edit the select method of the current
2469 group (@code{gnus-group-edit-group-method}).
2470
2471 @item G p
2472 @kindex G p (Group)
2473 @findex gnus-group-edit-group-parameters
2474 Enter a buffer where you can edit the group parameters
2475 (@code{gnus-group-edit-group-parameters}).
2476
2477 @item G E
2478 @kindex G E (Group)
2479 @findex gnus-group-edit-group
2480 Enter a buffer where you can edit the group info
2481 (@code{gnus-group-edit-group}).
2482
2483 @item G d
2484 @kindex G d (Group)
2485 @findex gnus-group-make-directory-group
2486 @cindex nndir
2487 Make a directory group (@pxref{Directory Groups}).  You will be prompted
2488 for a directory name (@code{gnus-group-make-directory-group}).
2489
2490 @item G h
2491 @kindex G h (Group)
2492 @cindex help group
2493 @findex gnus-group-make-help-group
2494 Make the gnus help group (@code{gnus-group-make-help-group}).
2495
2496 @item G a
2497 @kindex G a (Group)
2498 @cindex (ding) archive
2499 @cindex archive group
2500 @findex gnus-group-make-archive-group
2501 @vindex gnus-group-archive-directory
2502 @vindex gnus-group-recent-archive-directory
2503 Make a gnus archive group (@code{gnus-group-make-archive-group}).  By
2504 default a group pointing to the most recent articles will be created
2505 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2506 group will be created from @code{gnus-group-archive-directory}.
2507
2508 @item G k
2509 @kindex G k (Group)
2510 @findex gnus-group-make-kiboze-group
2511 @cindex nnkiboze
2512 Make a kiboze group.  You will be prompted for a name, for a regexp to
2513 match groups to be ``included'' in the kiboze group, and a series of
2514 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2515 @xref{Kibozed Groups}.
2516
2517 @item G D
2518 @kindex G D (Group)
2519 @findex gnus-group-enter-directory
2520 @cindex nneething
2521 Read an arbitrary directory as if it were a newsgroup with the
2522 @code{nneething} back end (@code{gnus-group-enter-directory}).
2523 @xref{Anything Groups}.
2524
2525 @item G f
2526 @kindex G f (Group)
2527 @findex gnus-group-make-doc-group
2528 @cindex ClariNet Briefs
2529 @cindex nndoc
2530 Make a group based on some file or other
2531 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
2532 command, you will be prompted for a file name and a file type.
2533 Currently supported types are @code{mbox}, @code{babyl},
2534 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2535 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2536 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2537 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}.  If
2538 you run this command without a prefix, Gnus will guess at the file
2539 type.  @xref{Document Groups}.
2540
2541 @item G u
2542 @kindex G u (Group)
2543 @vindex gnus-useful-groups
2544 @findex gnus-group-make-useful-group
2545 Create one of the groups mentioned in @code{gnus-useful-groups}
2546 (@code{gnus-group-make-useful-group}).
2547
2548 @item G w
2549 @kindex G w (Group)
2550 @findex gnus-group-make-web-group
2551 @cindex DejaNews
2552 @cindex Alta Vista
2553 @cindex InReference
2554 @cindex nnweb
2555 Make an ephemeral group based on a web search
2556 (@code{gnus-group-make-web-group}).  If you give a prefix to this
2557 command, make a solid group instead.  You will be prompted for the
2558 search engine type and the search string.  Valid search engine types
2559 include @code{dejanews}, @code{altavista} and @code{reference}.
2560 @xref{Web Searches}.
2561
2562 If you use the @code{dejanews} search engine, you can limit the search
2563 to a particular group by using a match string like
2564 @samp{~g alt.sysadmin.recovery shaving}.
2565
2566 @item G DEL
2567 @kindex G DEL (Group)
2568 @findex gnus-group-delete-group
2569 This function will delete the current group
2570 (@code{gnus-group-delete-group}).  If given a prefix, this function will
2571 actually delete all the articles in the group, and forcibly remove the
2572 group itself from the face of the Earth.  Use a prefix only if you are
2573 absolutely sure of what you are doing.  This command can't be used on
2574 read-only groups (like @code{nntp} group), though.
2575
2576 @item G V
2577 @kindex G V (Group)
2578 @findex gnus-group-make-empty-virtual
2579 Make a new, fresh, empty @code{nnvirtual} group
2580 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
2581
2582 @item G v
2583 @kindex G v (Group)
2584 @findex gnus-group-add-to-virtual
2585 Add the current group to an @code{nnvirtual} group
2586 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2587 @end table
2588
2589 @xref{Select Methods}, for more information on the various select
2590 methods.
2591
2592 @vindex gnus-activate-foreign-newsgroups
2593 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2594 gnus will check all foreign groups with this level or lower at startup.
2595 This might take quite a while, especially if you subscribe to lots of
2596 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
2597 @code{gnus-activate-level} also affects activation of foreign
2598 newsgroups.
2599
2600
2601 @node Group Parameters
2602 @section Group Parameters
2603 @cindex group parameters
2604
2605 The group parameters store information local to a particular group.
2606 Here's an example group parameter list:
2607
2608 @example
2609 ((to-address . "ding@@gnus.org")
2610  (auto-expire . t))
2611 @end example
2612
2613 We see that each element consists of a "dotted pair"---the thing before
2614 the dot is the key, while the thing after the dot is the value.  All the
2615 parameters have this form @emph{except} local variable specs, which are
2616 not dotted pairs, but proper lists.
2617
2618 Some parameters have correspondant customizable variables, each of which
2619 is an alist of regexps and values.
2620
2621 The following group parameters can be used:
2622
2623 @table @code
2624 @item to-address
2625 @cindex to-address
2626 Address used by when doing followups and new posts.
2627
2628 @example
2629 (to-address . "some@@where.com")
2630 @end example
2631
2632 This is primarily useful in mail groups that represent closed mailing
2633 lists---mailing lists where it's expected that everybody that writes to
2634 the mailing list is subscribed to it.  Since using this parameter
2635 ensures that the mail only goes to the mailing list itself, it means
2636 that members won't receive two copies of your followups.
2637
2638 Using @code{to-address} will actually work whether the group is foreign
2639 or not.  Let's say there's a group on the server that is called
2640 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2641 the articles from a mail-to-news gateway.  Posting directly to this
2642 group is therefore impossible---you have to send mail to the mailing
2643 list address instead.
2644
2645 See also @code{gnus-parameter-to-address-alist}.
2646
2647 @item to-list
2648 @cindex to-list
2649 Address used when doing @kbd{a} in that group.
2650
2651 @example
2652 (to-list . "some@@where.com")
2653 @end example
2654
2655 It is totally ignored
2656 when doing a followup---except that if it is present in a news group,
2657 you'll get mail group semantics when doing @kbd{f}.
2658
2659 If you do an @kbd{a} command in a mail group and you have neither a
2660 @code{to-list} group parameter nor a @code{to-address} group parameter,
2661 then a @code{to-list} group parameter will be added automatically upon
2662 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2663 @vindex gnus-add-to-list
2664
2665 If you do an @kbd{a} command in a mail group and you don't have a
2666 @code{to-list} group parameter, one will be added automatically upon
2667 sending the message.
2668
2669 @findex gnus-mailing-list-mode
2670 @cindex Mail List Groups
2671 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2672 entering summary buffer.
2673
2674 See also @code{gnus-parameter-to-list-alist}.
2675
2676 @item visible
2677 @cindex visible
2678 If the group parameter list has the element @code{(visible . t)},
2679 that group will always be visible in the Group buffer, regardless
2680 of whether it has any unread articles.
2681
2682 @item broken-reply-to
2683 @cindex broken-reply-to
2684 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2685 headers in this group are to be ignored.  This can be useful if you're
2686 reading a mailing list group where the listserv has inserted
2687 @code{Reply-To} headers that point back to the listserv itself.  This is
2688 broken behavior.  So there!
2689
2690 @item to-group
2691 @cindex to-group
2692 Elements like @code{(to-group . "some.group.name")} means that all
2693 posts in that group will be sent to @code{some.group.name}.
2694
2695 @item newsgroup
2696 @cindex newsgroup
2697 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2698 will treat all responses as if they were responses to news articles.
2699 This can be useful if you have a mail group that's really a mirror of a
2700 news group.
2701
2702 @item gcc-self
2703 @cindex gcc-self
2704 If @code{(gcc-self . t)} is present in the group parameter list, newly
2705 composed messages will be @code{Gcc}'d to the current group.  If
2706 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2707 generated, if @code{(gcc-self . "string")} is present, this string will
2708 be inserted literally as a @code{gcc} header.  This parameter takes
2709 precedence over any default @code{Gcc} rules as described later
2710 (@pxref{Archived Messages}).
2711
2712 @item auto-expire
2713 @cindex auto-expire
2714 If the group parameter has an element that looks like @code{(auto-expire
2715 . t)}, all articles read will be marked as expirable.  For an
2716 alternative approach, @pxref{Expiring Mail}.
2717
2718 See also @code{gnus-auto-expirable-newsgroups}.
2719
2720 @item total-expire
2721 @cindex total-expire
2722 If the group parameter has an element that looks like
2723 @code{(total-expire . t)}, all read articles will be put through the
2724 expiry process, even if they are not marked as expirable.  Use with
2725 caution.  Unread, ticked and dormant articles are not eligible for
2726 expiry.
2727
2728 See also @code{gnus-total-expirable-newsgroups}.
2729
2730 @item expiry-wait
2731 @cindex expiry-wait
2732 @vindex nnmail-expiry-wait-function
2733 If the group parameter has an element that looks like @code{(expiry-wait
2734 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2735 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2736 The value can either be a number of days (not necessarily an integer) or
2737 the symbols @code{never} or @code{immediate}.
2738
2739 @item score-file
2740 @cindex score file group parameter
2741 Elements that look like @code{(score-file . "file")} will make
2742 @file{file} into the current score file for the group in question.  All
2743 interactive score entries will be put into this file.
2744
2745 @item adapt-file
2746 @cindex adapt file group parameter
2747 Elements that look like @code{(adapt-file . "file")} will make
2748 @file{file} into the current adaptive file for the group in question.
2749 All adaptive score entries will be put into this file.
2750
2751 @item admin-address
2752 @cindex admin-address
2753 When unsubscribing from a mailing list you should never send the
2754 unsubscription notice to the mailing list itself.  Instead, you'd send
2755 messages to the administrative address.  This parameter allows you to
2756 put the admin address somewhere convenient.
2757
2758 @item display
2759 @cindex display
2760 Elements that look like @code{(display . MODE)} say which articles to
2761 display on entering the group.  Valid values are:
2762
2763 @table @code
2764 @item all
2765 Display all articles, both read and unread.
2766
2767 @item an integer
2768 Display the last INTEGER articles in the group.  This is the same as
2769 entering the group with C-u INTEGER.
2770
2771 @item default
2772 Display the default visible articles, which normally includes unread and
2773 ticked articles.
2774
2775 @item an array
2776 Display articles that satisfy a predicate.
2777
2778 Here are some examples:
2779
2780 @table @code
2781 @item [read]
2782 Display only read articles.
2783
2784 @item [not expire]
2785 Display everything except expirable articles.
2786
2787 @item [and (not reply) (not expire)]
2788 Display everything except expirable and articles you've already
2789 responded to.
2790 @end table
2791
2792 The available operators are @code{not}, @code{and} and @code{or}.
2793 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2794 @code{read}, @code{dormant}, @code{expire}, @code{reply},
2795 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2796 @code{cache}, @code{forward}, @code{seen} and @code{recent}.
2797
2798 @end table
2799
2800 The @code{display} parameter works by limiting the summary buffer to
2801 the subset specified.  You can pop the limit by using the @kbd{/ w}
2802 command (@pxref{Limiting}).
2803
2804 @item comment
2805 @cindex comment
2806 Elements that look like @code{(comment . "This is a comment")}
2807 are arbitrary comments on the group.  They are currently ignored by
2808 gnus, but provide a place for you to store information on particular
2809 groups.
2810
2811 @item charset
2812 @cindex charset
2813 Elements that look like @code{(charset . iso-8859-1)} will make
2814 @code{iso-8859-1} the default charset; that is, the charset that will be
2815 used for all articles that do not specify a charset.
2816
2817 See also @code{gnus-group-charset-alist}.
2818
2819 @item ignored-charsets
2820 @cindex ignored-charset
2821 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
2822 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
2823 default charset will be used for decoding articles.
2824
2825 See also @code{gnus-group-ignored-charsets-alist}.
2826
2827 @item posting-style
2828 @cindex posting-style
2829 You can store additional posting style information for this group only
2830 here (@pxref{Posting Styles}).  The format is that of an entry in the
2831 @code{gnus-posting-styles} alist, except that there's no regexp matching
2832 the group name (of course).  Style elements in this group parameter will
2833 take precedence over the ones found in @code{gnus-posting-styles}.
2834
2835 For instance, if you want a funky name and signature in this group only,
2836 instead of hacking @code{gnus-posting-styles}, you could put something
2837 like this in the group parameters:
2838
2839 @example
2840 (posting-style
2841   (name "Funky Name")
2842   (signature "Funky Signature"))
2843 @end example
2844
2845 @item post-method
2846 @cindex post-method
2847 If it is set, the value is used as the method for posting message
2848 instead of @code{gnus-post-method}.
2849
2850 @item banner
2851 @cindex banner
2852 An item like @code{(banner . "regex")} causes any part of an article
2853 that matches the regular expression "regex" to be stripped. Instead of
2854 "regex", you can also use the symbol @code{signature} which strips the
2855 last signature or any of the elements of the alist
2856 @code{gnus-article-banner-alist}.
2857
2858 @item sieve
2859 @cindex sieve
2860 This parameter contains a Sieve test that should match incoming mail
2861 that should be placed in this group.  From this group parameter, a
2862 Sieve @samp{IF} control structure is generated, having the test as the
2863 condition and @samp{fileinto "group.name";} as the body.
2864
2865 For example, if the INBOX.list.sieve group has the @code{(sieve
2866 address "sender" "sieve-admin@@extundo.com")} group parameter, when
2867 translating the group parameter into a Sieve script (@pxref{Sieve
2868 Commands}) the following Sieve code is generated:
2869
2870 @example
2871   if address \"sender\" \"sieve-admin@@extundo.com\" @{
2872           fileinto \"INBOX.list.sieve\";
2873   @}
2874 @end example
2875
2876 The Sieve language is described in RFC 3028.  @xref{Top, , Top, sieve,
2877 Emacs Sieve}.
2878
2879 @item (@var{variable} @var{form})
2880 You can use the group parameters to set variables local to the group you
2881 are entering.  If you want to turn threading off in @samp{news.answers},
2882 you could put @code{(gnus-show-threads nil)} in the group parameters of
2883 that group.  @code{gnus-show-threads} will be made into a local variable
2884 in the summary buffer you enter, and the form @code{nil} will be
2885 @code{eval}ed there.
2886
2887 This can also be used as a group-specific hook function, if you'd like.
2888 If you want to hear a beep when you enter a group, you could put
2889 something like @code{(dummy-variable (ding))} in the parameters of that
2890 group.  @code{dummy-variable} will be set to the result of the
2891 @code{(ding)} form, but who cares?
2892
2893 @end table
2894
2895 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2896 group.  (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2897 presents you with a Customize-like interface.  The latter helps avoid
2898 silly Lisp errors.)  You might also be interested in reading about topic
2899 parameters (@pxref{Topic Parameters}).
2900
2901 Group parameters can be set via the @code{gnus-parameters} variable too.
2902 But some variables, such as @code{visible}, have no effect.  For
2903 example:
2904
2905 @example
2906 (setq gnus-parameters
2907       '(("mail\\..*"
2908          (gnus-show-threads nil)
2909          (gnus-use-scoring nil)
2910          (gnus-summary-line-format
2911           "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
2912          (gcc-self . t)
2913          (display . all))
2914
2915         ("^nnimap:\\(foo.bar\\)$"
2916          (to-group . "\\1"))
2917
2918         ("mail\\.me"
2919          (gnus-use-scoring  t))
2920
2921         ("list\\..*"
2922          (total-expire . t)
2923          (broken-reply-to . t))))
2924 @end example
2925
2926 String value of parameters will be subjected to regexp substitution, as
2927 the @code{to-group} example shows.
2928
2929
2930 @node Listing Groups
2931 @section Listing Groups
2932 @cindex group listing
2933
2934 These commands all list various slices of the groups available.
2935
2936 @table @kbd
2937
2938 @item l
2939 @itemx A s
2940 @kindex A s (Group)
2941 @kindex l (Group)
2942 @findex gnus-group-list-groups
2943 List all groups that have unread articles
2944 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2945 command will list only groups of level ARG and lower.  By default, it
2946 only lists groups of level five (i. e.,
2947 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2948 groups).
2949
2950 @item L
2951 @itemx A u
2952 @kindex A u (Group)
2953 @kindex L (Group)
2954 @findex gnus-group-list-all-groups
2955 List all groups, whether they have unread articles or not
2956 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2957 this command will list only groups of level ARG and lower.  By default,
2958 it lists groups of level seven or lower (i.e., just subscribed and
2959 unsubscribed groups).
2960
2961 @item A l
2962 @kindex A l (Group)
2963 @findex gnus-group-list-level
2964 List all unread groups on a specific level
2965 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2966 with no unread articles.
2967
2968 @item A k
2969 @kindex A k (Group)
2970 @findex gnus-group-list-killed
2971 List all killed groups (@code{gnus-group-list-killed}).  If given a
2972 prefix argument, really list all groups that are available, but aren't
2973 currently (un)subscribed.  This could entail reading the active file
2974 from the server.
2975
2976 @item A z
2977 @kindex A z (Group)
2978 @findex gnus-group-list-zombies
2979 List all zombie groups (@code{gnus-group-list-zombies}).
2980
2981 @item A m
2982 @kindex A m (Group)
2983 @findex gnus-group-list-matching
2984 List all unread, subscribed groups with names that match a regexp
2985 (@code{gnus-group-list-matching}).
2986
2987 @item A M
2988 @kindex A M (Group)
2989 @findex gnus-group-list-all-matching
2990 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2991
2992 @item A A
2993 @kindex A A (Group)
2994 @findex gnus-group-list-active
2995 List absolutely all groups in the active file(s) of the
2996 server(s) you are connected to (@code{gnus-group-list-active}).  This
2997 might very well take quite a while.  It might actually be a better idea
2998 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2999 thing to match on.  Also note that this command may list groups that
3000 don't exist (yet)---these will be listed as if they were killed groups.
3001 Take the output with some grains of salt.
3002
3003 @item A a
3004 @kindex A a (Group)
3005 @findex gnus-group-apropos
3006 List all groups that have names that match a regexp
3007 (@code{gnus-group-apropos}).
3008
3009 @item A d
3010 @kindex A d (Group)
3011 @findex gnus-group-description-apropos
3012 List all groups that have names or descriptions that match a regexp
3013 (@code{gnus-group-description-apropos}).
3014
3015 @item A c
3016 @kindex A c (Group)
3017 @findex gnus-group-list-cached
3018 List all groups with cached articles (@code{gnus-group-list-cached}).
3019
3020 @item A ?
3021 @kindex A ? (Group)
3022 @findex gnus-group-list-dormant
3023 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3024
3025 @item A /
3026 @kindex A / (Group)
3027 @findex gnus-group-list-limit
3028 List groups limited within the current selection
3029 (@code{gnus-group-list-limit}).
3030
3031 @item A f
3032 @kindex A f (Group)
3033 @findex gnus-group-list-flush
3034 Flush groups from the current selection (@code{gnus-group-list-flush}).
3035
3036 @item A p
3037 @kindex A p (Group)
3038 @findex gnus-group-list-plus
3039 List groups plus the current selection (@code{gnus-group-list-plus}).
3040
3041 @end table
3042
3043 @vindex gnus-permanently-visible-groups
3044 @cindex visible group parameter
3045 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3046 always be shown, whether they have unread articles or not.  You can also
3047 add the @code{visible} element to the group parameters in question to
3048 get the same effect.
3049
3050 @vindex gnus-list-groups-with-ticked-articles
3051 Groups that have just ticked articles in it are normally listed in the
3052 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
3053 @code{nil}, these groups will be treated just like totally empty
3054 groups.  It is @code{t} by default.
3055
3056
3057 @node Sorting Groups
3058 @section Sorting Groups
3059 @cindex sorting groups
3060
3061 @kindex C-c C-s (Group)
3062 @findex gnus-group-sort-groups
3063 @vindex gnus-group-sort-function
3064 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3065 group buffer according to the function(s) given by the
3066 @code{gnus-group-sort-function} variable.  Available sorting functions
3067 include:
3068
3069 @table @code
3070
3071 @item gnus-group-sort-by-alphabet
3072 @findex gnus-group-sort-by-alphabet
3073 Sort the group names alphabetically.  This is the default.
3074
3075 @item gnus-group-sort-by-real-name
3076 @findex gnus-group-sort-by-real-name
3077 Sort the group alphabetically on the real (unprefixed) group names.
3078
3079 @item gnus-group-sort-by-level
3080 @findex gnus-group-sort-by-level
3081 Sort by group level.
3082
3083 @item gnus-group-sort-by-score
3084 @findex gnus-group-sort-by-score
3085 Sort by group score.  @xref{Group Score}.
3086
3087 @item gnus-group-sort-by-rank
3088 @findex gnus-group-sort-by-rank
3089 Sort by group score and then the group level.  The level and the score
3090 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
3091
3092 @item gnus-group-sort-by-unread
3093 @findex gnus-group-sort-by-unread
3094 Sort by number of unread articles.
3095
3096 @item gnus-group-sort-by-method
3097 @findex gnus-group-sort-by-method
3098 Sort alphabetically on the select method.
3099
3100 @item gnus-group-sort-by-server
3101 @findex gnus-group-sort-by-server
3102 Sort alphabetically on the Gnus server name.
3103
3104
3105 @end table
3106
3107 @code{gnus-group-sort-function} can also be a list of sorting
3108 functions.  In that case, the most significant sort key function must be
3109 the last one.
3110
3111
3112 There are also a number of commands for sorting directly according to
3113 some sorting criteria:
3114
3115 @table @kbd
3116 @item G S a
3117 @kindex G S a (Group)
3118 @findex gnus-group-sort-groups-by-alphabet
3119 Sort the group buffer alphabetically by group name
3120 (@code{gnus-group-sort-groups-by-alphabet}).
3121
3122 @item G S u
3123 @kindex G S u (Group)
3124 @findex gnus-group-sort-groups-by-unread
3125 Sort the group buffer by the number of unread articles
3126 (@code{gnus-group-sort-groups-by-unread}).
3127
3128 @item G S l
3129 @kindex G S l (Group)
3130 @findex gnus-group-sort-groups-by-level
3131 Sort the group buffer by group level
3132 (@code{gnus-group-sort-groups-by-level}).
3133
3134 @item G S v
3135 @kindex G S v (Group)
3136 @findex gnus-group-sort-groups-by-score
3137 Sort the group buffer by group score
3138 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
3139
3140 @item G S r
3141 @kindex G S r (Group)
3142 @findex gnus-group-sort-groups-by-rank
3143 Sort the group buffer by group rank
3144 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
3145
3146 @item G S m
3147 @kindex G S m (Group)
3148 @findex gnus-group-sort-groups-by-method
3149 Sort the group buffer alphabetically by back end name
3150 (@code{gnus-group-sort-groups-by-method}).
3151
3152 @end table
3153
3154 All the commands below obey the process/prefix convention
3155 (@pxref{Process/Prefix}).
3156
3157 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3158 commands will sort in reverse order.
3159
3160 You can also sort a subset of the groups:
3161
3162 @table @kbd
3163 @item G P a
3164 @kindex G P a (Group)
3165 @findex gnus-group-sort-selected-groups-by-alphabet
3166 Sort the groups alphabetically by group name
3167 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3168
3169 @item G P u
3170 @kindex G P u (Group)
3171 @findex gnus-group-sort-selected-groups-by-unread
3172 Sort the groups by the number of unread articles
3173 (@code{gnus-group-sort-selected-groups-by-unread}).
3174
3175 @item G P l
3176 @kindex G P l (Group)
3177 @findex gnus-group-sort-selected-groups-by-level
3178 Sort the groups by group level
3179 (@code{gnus-group-sort-selected-groups-by-level}).
3180
3181 @item G P v
3182 @kindex G P v (Group)
3183 @findex gnus-group-sort-selected-groups-by-score
3184 Sort the groups by group score
3185 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
3186
3187 @item G P r
3188 @kindex G P r (Group)
3189 @findex gnus-group-sort-selected-groups-by-rank
3190 Sort the groups by group rank
3191 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
3192
3193 @item G P m
3194 @kindex G P m (Group)
3195 @findex gnus-group-sort-selected-groups-by-method
3196 Sort the groups alphabetically by back end name
3197 (@code{gnus-group-sort-selected-groups-by-method}).
3198
3199 @end table
3200
3201 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3202 move groups around.
3203
3204
3205 @node Group Maintenance
3206 @section Group Maintenance
3207 @cindex bogus groups
3208
3209 @table @kbd
3210 @item b
3211 @kindex b (Group)
3212 @findex gnus-group-check-bogus-groups
3213 Find bogus groups and delete them
3214 (@code{gnus-group-check-bogus-groups}).
3215
3216 @item F
3217 @kindex F (Group)
3218 @findex gnus-group-find-new-groups
3219 Find new groups and process them (@code{gnus-group-find-new-groups}).
3220 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3221 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
3222 to query the server for new groups, and subscribe the new groups as
3223 zombies.
3224
3225 @item C-c C-x
3226 @kindex C-c C-x (Group)
3227 @findex gnus-group-expire-articles
3228 Run all expirable articles in the current group through the expiry
3229 process (if any) (@code{gnus-group-expire-articles}).  That is, delete
3230 all expirable articles in the group that have been around for a while.
3231 (@pxref{Expiring Mail}).
3232
3233 @item C-c C-M-x
3234 @kindex C-c C-M-x (Group)
3235 @findex gnus-group-expire-all-groups
3236 Run all expirable articles in all groups through the expiry process
3237 (@code{gnus-group-expire-all-groups}).
3238
3239 @end table
3240
3241
3242 @node Browse Foreign Server
3243 @section Browse Foreign Server
3244 @cindex foreign servers
3245 @cindex browsing servers
3246
3247 @table @kbd
3248 @item B
3249 @kindex B (Group)
3250 @findex gnus-group-browse-foreign-server
3251 You will be queried for a select method and a server name.  Gnus will
3252 then attempt to contact this server and let you browse the groups there
3253 (@code{gnus-group-browse-foreign-server}).
3254 @end table
3255
3256 @findex gnus-browse-mode
3257 A new buffer with a list of available groups will appear.  This buffer
3258 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
3259 a lot) like a normal group buffer.
3260
3261 Here's a list of keystrokes available in the browse mode:
3262
3263 @table @kbd
3264 @item n
3265 @kindex n (Browse)
3266 @findex gnus-group-next-group
3267 Go to the next group (@code{gnus-group-next-group}).
3268
3269 @item p
3270 @kindex p (Browse)
3271 @findex gnus-group-prev-group
3272 Go to the previous group (@code{gnus-group-prev-group}).
3273
3274 @item SPACE
3275 @kindex SPACE (Browse)
3276 @findex gnus-browse-read-group
3277 Enter the current group and display the first article
3278 (@code{gnus-browse-read-group}).
3279
3280 @item RET
3281 @kindex RET (Browse)
3282 @findex gnus-browse-select-group
3283 Enter the current group (@code{gnus-browse-select-group}).
3284
3285 @item u
3286 @kindex u (Browse)
3287 @findex gnus-browse-unsubscribe-current-group
3288 Unsubscribe to the current group, or, as will be the case here,
3289 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3290
3291 @item l
3292 @itemx q
3293 @kindex q (Browse)
3294 @kindex l (Browse)
3295 @findex gnus-browse-exit
3296 Exit browse mode (@code{gnus-browse-exit}).
3297
3298 @item ?
3299 @kindex ? (Browse)
3300 @findex gnus-browse-describe-briefly
3301 Describe browse mode briefly (well, there's not much to describe, is
3302 there) (@code{gnus-browse-describe-briefly}).
3303 @end table
3304
3305
3306 @node Exiting Gnus
3307 @section Exiting gnus
3308 @cindex exiting gnus
3309
3310 Yes, gnus is ex(c)iting.
3311
3312 @table @kbd
3313 @item z
3314 @kindex z (Group)
3315 @findex gnus-group-suspend
3316 Suspend gnus (@code{gnus-group-suspend}).  This doesn't really exit gnus,
3317 but it kills all buffers except the Group buffer.  I'm not sure why this
3318 is a gain, but then who am I to judge?
3319
3320 @item q
3321 @kindex q (Group)
3322 @findex gnus-group-exit
3323 @c @icon{gnus-group-exit}
3324 Quit gnus (@code{gnus-group-exit}).
3325
3326 @item Q
3327 @kindex Q (Group)
3328 @findex gnus-group-quit
3329 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3330 The dribble file will be saved, though (@pxref{Auto Save}).
3331 @end table
3332
3333 @vindex gnus-exit-gnus-hook
3334 @vindex gnus-suspend-gnus-hook
3335 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3336 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3337 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3338 exiting gnus.
3339
3340 @findex gnus-unload
3341 @cindex unloading
3342 If you wish to completely unload gnus and all its adherents, you can use
3343 the @code{gnus-unload} command.  This command is also very handy when
3344 trying to customize meta-variables.
3345
3346 Note:
3347
3348 @quotation
3349 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3350 numbly heavy and herself fall into a hazy trance as the boy sitting
3351 behind her drew repeated lines with his pencil across the back of her
3352 plastic chair.
3353 @end quotation
3354
3355
3356 @node Group Topics
3357 @section Group Topics
3358 @cindex topics
3359
3360 If you read lots and lots of groups, it might be convenient to group
3361 them hierarchically according to topics.  You put your Emacs groups over
3362 here, your sex groups over there, and the rest (what, two groups or so?)
3363 you put in some misc section that you never bother with anyway.  You can
3364 even group the Emacs sex groups as a sub-topic to either the Emacs
3365 groups or the sex groups---or both!  Go wild!
3366
3367 @iftex
3368 @iflatex
3369 \gnusfigure{Group Topics}{400}{
3370 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3371 }
3372 @end iflatex
3373 @end iftex
3374
3375 Here's an example:
3376
3377 @example
3378 Gnus
3379   Emacs -- I wuw it!
3380      3: comp.emacs
3381      2: alt.religion.emacs
3382     Naughty Emacs
3383      452: alt.sex.emacs
3384        0: comp.talk.emacs.recovery
3385   Misc
3386      8: comp.binaries.fractals
3387     13: comp.sources.unix
3388 @end example
3389
3390 @findex gnus-topic-mode
3391 @kindex t (Group)
3392 To get this @emph{fab} functionality you simply turn on (ooh!) the
3393 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
3394 is a toggling command.)
3395
3396 Go ahead, just try it.  I'll still be here when you get back.  La de
3397 dum...  Nice tune, that...  la la la...  What, you're back?  Yes, and
3398 now press @kbd{l}.  There.  All your groups are now listed under
3399 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
3400 bothered?
3401
3402 If you want this permanently enabled, you should add that minor mode to
3403 the hook for the group mode.  Put the following line in your
3404 @file{~/.gnus} file:
3405
3406 @lisp
3407 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3408 @end lisp
3409
3410 @menu
3411 * Topic Commands::              Interactive E-Z commands.
3412 * Topic Variables::             How to customize the topics the Lisp Way.
3413 * Topic Sorting::               Sorting each topic individually.
3414 * Topic Topology::              A map of the world.
3415 * Topic Parameters::            Parameters that apply to all groups in a topic.
3416 @end menu
3417
3418
3419 @node Topic Commands
3420 @subsection Topic Commands
3421 @cindex topic commands
3422
3423 When the topic minor mode is turned on, a new @kbd{T} submap will be
3424 available.  In addition, a few of the standard keys change their
3425 definitions slightly.
3426
3427 In general, the following kinds of operations are possible on topics.
3428 First of all, you want to create topics.  Secondly, you want to put
3429 groups in topics and to move them around until you have an order you
3430 like.  The third kind of operation is to show/hide parts of the whole
3431 shebang.  You might want to hide a topic including its subtopics and
3432 groups, to get a better overview of the other groups.
3433
3434 Here is a list of the basic keys that you might need to set up topics
3435 the way you like.
3436
3437 @table @kbd
3438
3439 @item T n
3440 @kindex T n (Topic)
3441 @findex gnus-topic-create-topic
3442 Prompt for a new topic name and create it
3443 (@code{gnus-topic-create-topic}).
3444
3445 @item T TAB
3446 @itemx TAB
3447 @kindex T TAB (Topic)
3448 @kindex TAB (Topic)
3449 @findex gnus-topic-indent
3450 ``Indent'' the current topic so that it becomes a sub-topic of the
3451 previous topic (@code{gnus-topic-indent}).  If given a prefix,
3452 ``un-indent'' the topic instead.
3453
3454 @item M-TAB
3455 @kindex M-TAB (Topic)
3456 @findex gnus-topic-unindent
3457 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3458 parent of its current parent (@code{gnus-topic-unindent}).
3459
3460 @end table
3461
3462 The following two keys can be used to move groups and topics around.
3463 They work like the well-known cut and paste.  @kbd{C-k} is like cut and
3464 @kbd{C-y} is like paste.  Of course, this being Emacs, we use the terms
3465 kill and yank rather than cut and paste.
3466
3467 @table @kbd
3468
3469 @item C-k
3470 @kindex C-k (Topic)
3471 @findex gnus-topic-kill-group
3472 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
3473 topic will be removed along with the topic.
3474
3475 @item C-y
3476 @kindex C-y (Topic)
3477 @findex gnus-topic-yank-group
3478 Yank the previously killed group or topic
3479 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
3480 before all groups.
3481
3482 So, to move a topic to the beginning of the list of topics, just hit
3483 @kbd{C-k} on it.  This is like the `cut' part of cut and paste.  Then,
3484 move the cursor to the beginning of the buffer (just below the `Gnus'
3485 topic) and hit @kbd{C-y}.  This is like the `paste' part of cut and
3486 paste.  Like I said -- E-Z.
3487
3488 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics.  So
3489 you can move topics around as well as groups.
3490
3491 @end table
3492
3493 After setting up the topics the way you like them, you might wish to
3494 hide a topic, or to show it again.  That's why we have the following
3495 key.
3496
3497 @table @kbd
3498
3499 @item RET
3500 @kindex RET (Topic)
3501 @findex gnus-topic-select-group
3502 @itemx SPACE
3503 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3504 When you perform this command on a group, you'll enter the group, as
3505 usual.  When done on a topic line, the topic will be folded (if it was
3506 visible) or unfolded (if it was folded already).  So it's basically a
3507 toggling command on topics.  In addition, if you give a numerical
3508 prefix, group on that level (and lower) will be displayed.
3509
3510 @end table
3511
3512 Now for a list of other commands, in no particular order.
3513
3514 @table @kbd
3515
3516 @item T m
3517 @kindex T m (Topic)
3518 @findex gnus-topic-move-group
3519 Move the current group to some other topic
3520 (@code{gnus-topic-move-group}).  This command uses the process/prefix
3521 convention (@pxref{Process/Prefix}).
3522
3523 @item T j
3524 @kindex T j (Topic)
3525 @findex gnus-topic-jump-to-topic
3526 Go to a topic (@code{gnus-topic-jump-to-topic}).
3527
3528 @item T c
3529 @kindex T c (Topic)
3530 @findex gnus-topic-copy-group
3531 Copy the current group to some other topic
3532 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
3533 convention (@pxref{Process/Prefix}).
3534
3535 @item T h
3536 @kindex T h (Topic)
3537 @findex gnus-topic-hide-topic
3538 Hide the current topic (@code{gnus-topic-hide-topic}).  If given
3539 a prefix, hide the topic permanently.
3540
3541 @item T s
3542 @kindex T s (Topic)
3543 @findex gnus-topic-show-topic
3544 Show the current topic (@code{gnus-topic-show-topic}).  If given
3545 a prefix, show the topic permanently.
3546
3547 @item T D
3548 @kindex T D (Topic)
3549 @findex gnus-topic-remove-group
3550 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3551 This command is mainly useful if you have the same group in several
3552 topics and wish to remove it from one of the topics.  You may also
3553 remove a group from all topics, but in that case, Gnus will add it to
3554 the root topic the next time you start Gnus.  In fact, all new groups
3555 (which, naturally, don't belong to any topic) will show up in the root
3556 topic.
3557
3558 This command uses the process/prefix convention
3559 (@pxref{Process/Prefix}).
3560
3561 @item T M
3562 @kindex T M (Topic)
3563 @findex gnus-topic-move-matching
3564 Move all groups that match some regular expression to a topic
3565 (@code{gnus-topic-move-matching}).
3566
3567 @item T C
3568 @kindex T C (Topic)
3569 @findex gnus-topic-copy-matching
3570 Copy all groups that match some regular expression to a topic
3571 (@code{gnus-topic-copy-matching}).
3572
3573 @item T H
3574 @kindex T H (Topic)
3575 @findex gnus-topic-toggle-display-empty-topics
3576 Toggle hiding empty topics
3577 (@code{gnus-topic-toggle-display-empty-topics}).
3578
3579 @item T #
3580 @kindex T # (Topic)
3581 @findex gnus-topic-mark-topic
3582 Mark all groups in the current topic with the process mark
3583 (@code{gnus-topic-mark-topic}).
3584
3585 @item T M-#
3586 @kindex T M-# (Topic)
3587 @findex gnus-topic-unmark-topic
3588 Remove the process mark from all groups in the current topic
3589 (@code{gnus-topic-unmark-topic}).
3590
3591 @item C-c C-x
3592 @kindex C-c C-x (Topic)
3593 @findex gnus-topic-expire-articles
3594 Run all expirable articles in the current group or topic through the
3595 expiry process (if any)
3596 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3597
3598 @item T r
3599 @kindex T r (Topic)
3600 @findex gnus-topic-rename
3601 Rename a topic (@code{gnus-topic-rename}).
3602
3603 @item T DEL
3604 @kindex T DEL (Topic)
3605 @findex gnus-topic-delete
3606 Delete an empty topic (@code{gnus-topic-delete}).
3607
3608 @item A T
3609 @kindex A T (Topic)
3610 @findex gnus-topic-list-active
3611 List all groups that gnus knows about in a topics-ified way
3612 (@code{gnus-topic-list-active}).
3613
3614 @item G p
3615 @kindex G p (Topic)
3616 @findex gnus-topic-edit-parameters
3617 @cindex group parameters
3618 @cindex topic parameters
3619 @cindex parameters
3620 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3621 @xref{Topic Parameters}.
3622
3623 @end table
3624
3625
3626 @node Topic Variables
3627 @subsection Topic Variables
3628 @cindex topic variables
3629
3630 The previous section told you how to tell Gnus which topics to display.
3631 This section explains how to tell Gnus what to display about each topic.
3632
3633 @vindex gnus-topic-line-format
3634 The topic lines themselves are created according to the
3635 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3636 Valid elements are:
3637
3638 @table @samp
3639 @item i
3640 Indentation.
3641 @item n
3642 Topic name.
3643 @item v
3644 Visibility.
3645 @item l
3646 Level.
3647 @item g
3648 Number of groups in the topic.
3649 @item a
3650 Number of unread articles in the topic.
3651 @item A
3652 Number of unread articles in the topic and all its subtopics.
3653 @end table
3654
3655 @vindex gnus-topic-indent-level
3656 Each sub-topic (and the groups in the sub-topics) will be indented with
3657 @code{gnus-topic-indent-level} times the topic level number of spaces.
3658 The default is 2.
3659
3660 @vindex gnus-topic-mode-hook
3661 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3662
3663 @vindex gnus-topic-display-empty-topics
3664 The @code{gnus-topic-display-empty-topics} says whether to display even
3665 topics that have no unread articles in them.  The default is @code{t}.
3666
3667
3668 @node Topic Sorting
3669 @subsection Topic Sorting
3670 @cindex topic sorting
3671
3672 You can sort the groups in each topic individually with the following
3673 commands:
3674
3675
3676 @table @kbd
3677 @item T S a
3678 @kindex T S a (Topic)
3679 @findex gnus-topic-sort-groups-by-alphabet
3680 Sort the current topic alphabetically by group name
3681 (@code{gnus-topic-sort-groups-by-alphabet}).
3682
3683 @item T S u
3684 @kindex T S u (Topic)
3685 @findex gnus-topic-sort-groups-by-unread
3686 Sort the current topic by the number of unread articles
3687 (@code{gnus-topic-sort-groups-by-unread}).
3688
3689 @item T S l
3690 @kindex T S l (Topic)
3691 @findex gnus-topic-sort-groups-by-level
3692 Sort the current topic by group level
3693 (@code{gnus-topic-sort-groups-by-level}).
3694
3695 @item T S v
3696 @kindex T S v (Topic)
3697 @findex gnus-topic-sort-groups-by-score
3698 Sort the current topic by group score
3699 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
3700
3701 @item T S r
3702 @kindex T S r (Topic)
3703 @findex gnus-topic-sort-groups-by-rank
3704 Sort the current topic by group rank
3705 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
3706
3707 @item T S m
3708 @kindex T S m (Topic)
3709 @findex gnus-topic-sort-groups-by-method
3710 Sort the current topic alphabetically by back end name
3711 (@code{gnus-topic-sort-groups-by-method}).
3712
3713 @item T S e
3714 @kindex T S e (Topic)
3715 @findex gnus-topic-sort-groups-by-server
3716 Sort the current topic alphabetically by server name
3717 (@code{gnus-topic-sort-groups-by-server}).
3718
3719 @end table
3720
3721 @xref{Sorting Groups}, for more information about group sorting.
3722
3723
3724 @node Topic Topology
3725 @subsection Topic Topology
3726 @cindex topic topology
3727 @cindex topology
3728
3729 So, let's have a look at an example group buffer:
3730
3731 @example
3732 Gnus
3733   Emacs -- I wuw it!
3734      3: comp.emacs
3735      2: alt.religion.emacs
3736     Naughty Emacs
3737      452: alt.sex.emacs
3738        0: comp.talk.emacs.recovery
3739   Misc
3740      8: comp.binaries.fractals
3741     13: comp.sources.unix
3742 @end example
3743
3744 So, here we have one top-level topic (@samp{Gnus}), two topics under
3745 that, and one sub-topic under one of the sub-topics.  (There is always
3746 just one (1) top-level topic).  This topology can be expressed as
3747 follows:
3748
3749 @lisp
3750 (("Gnus" visible)
3751  (("Emacs -- I wuw it!" visible)
3752   (("Naughty Emacs" visible)))
3753  (("Misc" visible)))
3754 @end lisp
3755
3756 @vindex gnus-topic-topology
3757 This is in fact how the variable @code{gnus-topic-topology} would look
3758 for the display above.  That variable is saved in the @file{.newsrc.eld}
3759 file, and shouldn't be messed with manually---unless you really want
3760 to.  Since this variable is read from the @file{.newsrc.eld} file,
3761 setting it in any other startup files will have no effect.
3762
3763 This topology shows what topics are sub-topics of what topics (right),
3764 and which topics are visible.  Two settings are currently
3765 allowed---@code{visible} and @code{invisible}.
3766
3767
3768 @node Topic Parameters
3769 @subsection Topic Parameters
3770 @cindex topic parameters
3771
3772 All groups in a topic will inherit group parameters from the parent (and
3773 ancestor) topic parameters.  All valid group parameters are valid topic
3774 parameters (@pxref{Group Parameters}).
3775
3776 In addition, the following parameters are only valid as topic
3777 parameters:
3778
3779 @table @code
3780 @item subscribe
3781 When subscribing new groups by topic (@pxref{Subscription Methods}), the
3782 @code{subscribe} topic parameter says what groups go in what topic.  Its
3783 value should be a regexp to match the groups that should go in that
3784 topic.
3785
3786 @end table
3787
3788 Group parameters (of course) override topic parameters, and topic
3789 parameters in sub-topics override topic parameters in super-topics.  You
3790 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
3791 verb, although you may feel free to disagree with me here.)
3792
3793 @example
3794 Gnus
3795   Emacs
3796      3: comp.emacs
3797      2: alt.religion.emacs
3798    452: alt.sex.emacs
3799     Relief
3800      452: alt.sex.emacs
3801        0: comp.talk.emacs.recovery
3802   Misc
3803      8: comp.binaries.fractals
3804     13: comp.sources.unix
3805    452: alt.sex.emacs
3806 @end example
3807
3808 The @samp{Emacs} topic has the topic parameter @code{(score-file
3809 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3810 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3811 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
3812 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3813 . "religion.SCORE")}.
3814
3815 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3816 will get the @file{relief.SCORE} home score file.  If you enter the same
3817 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3818 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
3819 get the @file{religion.SCORE} home score file.
3820
3821 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
3822 there are some problems, especially with the @code{total-expiry}
3823 parameter.  Say you have a mail group in two topics; one with
3824 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
3825 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
3826 of these topics you mean to expire articles from, so anything may
3827 happen.  In fact, I hereby declare that it is @dfn{undefined} what
3828 happens.  You just have to be careful if you do stuff like that.
3829
3830
3831 @node Misc Group Stuff
3832 @section Misc Group Stuff
3833
3834 @menu
3835 * Scanning New Messages::       Asking Gnus to see whether new messages have arrived.
3836 * Group Information::           Information and help on groups and Gnus.
3837 * Group Timestamp::             Making Gnus keep track of when you last read a group.
3838 * File Commands::               Reading and writing the Gnus files.
3839 * Sieve Commands::              Managing Sieve scripts.
3840 @end menu
3841
3842 @table @kbd
3843
3844 @item ^
3845 @kindex ^ (Group)
3846 @findex gnus-group-enter-server-mode
3847 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3848 @xref{Server Buffer}.
3849
3850 @item a
3851 @kindex a (Group)
3852 @findex gnus-group-post-news
3853 Post an article to a group (@code{gnus-group-post-news}).  If given a
3854 prefix, the current group name will be used as the default.
3855 @xref{Composing Messages}.
3856
3857 @item m
3858 @kindex m (Group)
3859 @findex gnus-group-mail
3860 Mail a message somewhere (@code{gnus-group-mail}).  @xref{Composing Messages}.
3861
3862 @end table
3863
3864 Variables for the group buffer:
3865
3866 @table @code
3867
3868 @item gnus-group-mode-hook
3869 @vindex gnus-group-mode-hook
3870 is called after the group buffer has been
3871 created.
3872
3873 @item gnus-group-prepare-hook
3874 @vindex gnus-group-prepare-hook
3875 is called after the group buffer is
3876 generated.  It may be used to modify the buffer in some strange,
3877 unnatural way.
3878
3879 @item gnus-group-prepared-hook
3880 @vindex gnus-group-prepare-hook
3881 is called as the very last thing after the group buffer has been
3882 generated.  It may be used to move point around, for instance.
3883
3884 @item gnus-permanently-visible-groups
3885 @vindex gnus-permanently-visible-groups
3886 Groups matching this regexp will always be listed in the group buffer,
3887 whether they are empty or not.
3888
3889 @item gnus-group-name-charset-method-alist
3890 @vindex gnus-group-name-charset-method-alist
3891 An alist of method and the charset for group names. It is used to show
3892 non-ASCII group names.
3893
3894 For example:
3895 @lisp
3896 (setq gnus-group-name-charset-method-alist
3897     '(((nntp "news.com.cn") . cn-gb-2312)))
3898 @end lisp
3899
3900 @item gnus-group-name-charset-group-alist
3901 @cindex UTF-8 group names
3902 @vindex gnus-group-name-charset-group-alist
3903 An alist of regexp of group name and the charset for group names.  It
3904 is used to show non-ASCII group names.  @code{((".*" utf-8))} is the
3905 default value if UTF-8 is supported, otherwise the default is nil.
3906
3907 For example:
3908 @lisp
3909 (setq gnus-group-name-charset-group-alist
3910     '(("\\.com\\.cn:" . cn-gb-2312)))
3911 @end lisp
3912
3913 @end table
3914
3915 @node Scanning New Messages
3916 @subsection Scanning New Messages
3917 @cindex new messages
3918 @cindex scanning new news
3919
3920 @table @kbd
3921
3922 @item g
3923 @kindex g (Group)
3924 @findex gnus-group-get-new-news
3925 @c @icon{gnus-group-get-new-news}
3926 Check the server(s) for new articles.  If the numerical prefix is used,
3927 this command will check only groups of level @var{arg} and lower
3928 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3929 command will force a total re-reading of the active file(s) from the
3930 back end(s).
3931
3932 @item M-g
3933 @kindex M-g (Group)
3934 @findex gnus-group-get-new-news-this-group
3935 @vindex gnus-goto-next-group-when-activating
3936 @c @icon{gnus-group-get-new-news-this-group}
3937 Check whether new articles have arrived in the current group
3938 (@code{gnus-group-get-new-news-this-group}).
3939 @code{gnus-goto-next-group-when-activating} says whether this command is
3940 to move point to the next group or not.  It is @code{t} by default.
3941
3942 @findex gnus-activate-all-groups
3943 @cindex activating groups
3944 @item C-c M-g
3945 @kindex C-c M-g (Group)
3946 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3947
3948 @item R
3949 @kindex R (Group)
3950 @cindex restarting
3951 @findex gnus-group-restart
3952 Restart gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3953 file(s), closes the connection to all servers, clears up all run-time
3954 gnus variables, and then starts gnus all over again.
3955
3956 @end table
3957
3958 @vindex gnus-get-new-news-hook
3959 @code{gnus-get-new-news-hook} is run just before checking for new news.
3960
3961 @vindex gnus-after-getting-new-news-hook
3962 @code{gnus-after-getting-new-news-hook} is run after checking for new
3963 news.
3964
3965
3966 @node Group Information
3967 @subsection Group Information
3968 @cindex group information
3969 @cindex information on groups
3970
3971 @table @kbd
3972
3973
3974 @item H f
3975 @kindex H f (Group)
3976 @findex gnus-group-fetch-faq
3977 @vindex gnus-group-faq-directory
3978 @cindex FAQ
3979 @cindex ange-ftp
3980 Try to fetch the FAQ for the current group
3981 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3982 @code{gnus-group-faq-directory}, which is usually a directory on a
3983 remote machine.  This variable can also be a list of directories.  In
3984 that case, giving a prefix to this command will allow you to choose
3985 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3986 for fetching the file.
3987
3988 If fetching from the first site is unsuccessful, gnus will attempt to go
3989 through @code{gnus-group-faq-directory} and try to open them one by one.
3990
3991 @item H d
3992 @itemx C-c C-d
3993 @c @icon{gnus-group-describe-group}
3994 @kindex H d (Group)
3995 @kindex C-c C-d (Group)
3996 @cindex describing groups
3997 @cindex group description
3998 @findex gnus-group-describe-group
3999 Describe the current group (@code{gnus-group-describe-group}).  If given
4000 a prefix, force Gnus to re-read the description from the server.
4001
4002 @item M-d
4003 @kindex M-d (Group)
4004 @findex gnus-group-describe-all-groups
4005 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
4006 prefix, force gnus to re-read the description file from the server.
4007
4008 @item H v
4009 @itemx V
4010 @kindex V (Group)
4011 @kindex H v (Group)
4012 @cindex version
4013 @findex gnus-version
4014 Display current gnus version numbers (@code{gnus-version}).
4015
4016 @item ?
4017 @kindex ? (Group)
4018 @findex gnus-group-describe-briefly
4019 Give a very short help message (@code{gnus-group-describe-briefly}).
4020
4021 @item C-c C-i
4022 @kindex C-c C-i (Group)
4023 @cindex info
4024 @cindex manual
4025 @findex gnus-info-find-node
4026 Go to the gnus info node (@code{gnus-info-find-node}).
4027 @end table
4028
4029
4030 @node Group Timestamp
4031 @subsection Group Timestamp
4032 @cindex timestamps
4033 @cindex group timestamps
4034
4035 It can be convenient to let gnus keep track of when you last read a
4036 group.  To set the ball rolling, you should add
4037 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4038
4039 @lisp
4040 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4041 @end lisp
4042
4043 After doing this, each time you enter a group, it'll be recorded.
4044
4045 This information can be displayed in various ways---the easiest is to
4046 use the @samp{%d} spec in the group line format:
4047
4048 @lisp
4049 (setq gnus-group-line-format
4050       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4051 @end lisp
4052
4053 This will result in lines looking like:
4054
4055 @example
4056 *        0: mail.ding                                19961002T012943
4057          0: custom                                   19961002T012713
4058 @end example
4059
4060 As you can see, the date is displayed in compact ISO 8601 format.  This
4061 may be a bit too much, so to just display the date, you could say
4062 something like:
4063
4064 @lisp
4065 (setq gnus-group-line-format
4066       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4067 @end lisp
4068
4069
4070 @node File Commands
4071 @subsection File Commands
4072 @cindex file commands
4073
4074 @table @kbd
4075
4076 @item r
4077 @kindex r (Group)
4078 @findex gnus-group-read-init-file
4079 @vindex gnus-init-file
4080 @cindex reading init file
4081 Re-read the init file (@code{gnus-init-file}, which defaults to
4082 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
4083
4084 @item s
4085 @kindex s (Group)
4086 @findex gnus-group-save-newsrc
4087 @cindex saving .newsrc
4088 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4089 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
4090 file(s) whether Gnus thinks it is necessary or not.
4091
4092 @c @item Z
4093 @c @kindex Z (Group)
4094 @c @findex gnus-group-clear-dribble
4095 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4096
4097 @end table
4098
4099
4100 @node Sieve Commands
4101 @subsection Sieve Commands
4102 @cindex group sieve commands
4103
4104 Sieve is a server-side mail filtering language.  In Gnus you can use
4105 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4106 sieve rules that should apply to each group.  Gnus provides two
4107 commands to translate all these group parameters into a proper Sieve
4108 script that can be transfered to the server somehow.
4109
4110 @vindex gnus-sieve-file
4111 @vindex gnus-sieve-region-start
4112 @vindex gnus-sieve-region-end
4113 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4114 default @file{~/.sieve}).  The Sieve code that Gnus generate is placed
4115 between two delimiters, @code{gnus-sieve-region-start} and
4116 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4117 outside these delimiters that will not be removed the next time you
4118 regenerate the Sieve script.
4119
4120 @vindex gnus-sieve-crosspost
4121 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4122 is generated.  If it is non-nil (the default) articles is placed in
4123 all groups that have matching rules, otherwise the article is only
4124 placed in the group with the first matching rule.  For example, the
4125 group parameter @samp{(sieve address "sender"
4126 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4127 code if @code{gnus-sieve-crosspost} is nil. (When
4128 @code{gnus-sieve-crosspost} is non-nil, it looks the same except that
4129 the line containing the call to @code{stop} is removed.)
4130
4131 @example
4132 if address "sender" "owner-ding@@hpc.uh.edu" @{
4133         fileinto "INBOX.ding";
4134         stop;
4135 @}
4136 @end example
4137
4138 @xref{Top, ,Top, sieve, Emacs Sieve}.
4139
4140 @table @kbd
4141
4142 @item D g
4143 @kindex D g (Group)
4144 @findex gnus-sieve-generate
4145 @vindex gnus-sieve-file
4146 @cindex generating sieve script
4147 Regenerate a Sieve script from the @code{sieve} group parameters and
4148 put you into the @code{gnus-sieve-file} without saving it.
4149
4150 @item D u
4151 @kindex D u (Group)
4152 @findex gnus-sieve-update
4153 @vindex gnus-sieve-file
4154 @cindex updating sieve script
4155 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4156 @code{sieve} group parameters, save the file and upload it to the
4157 server using the @code{sieveshell} program.
4158
4159 @end table
4160
4161
4162 @node Summary Buffer
4163 @chapter Summary Buffer
4164 @cindex summary buffer
4165
4166 A line for each article is displayed in the summary buffer.  You can
4167 move around, read articles, post articles and reply to articles.
4168
4169 The most common way to a summary buffer is to select a group from the
4170 group buffer (@pxref{Selecting a Group}).
4171
4172 You can have as many summary buffers open as you wish.
4173
4174 @menu
4175 * Summary Buffer Format::       Deciding how the summary buffer is to look.
4176 * Summary Maneuvering::         Moving around the summary buffer.
4177 * Choosing Articles::           Reading articles.
4178 * Paging the Article::          Scrolling the current article.
4179 * Reply Followup and Post::     Posting articles.
4180 * Delayed Articles::            
4181 * Marking Articles::            Marking articles as read, expirable, etc.
4182 * Limiting::                    You can limit the summary buffer.
4183 * Threading::                   How threads are made.
4184 * Sorting the Summary Buffer::  How articles and threads are sorted.
4185 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
4186 * Article Caching::             You may store articles in a cache.
4187 * Persistent Articles::         Making articles expiry-resistant.
4188 * Article Backlog::             Having already read articles hang around.
4189 * Saving Articles::             Ways of customizing article saving.
4190 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
4191 * Article Treatment::           The article buffer can be mangled at will.
4192 * MIME Commands::               Doing MIMEy things with the articles.
4193 * Charsets::                    Character set issues.
4194 * Article Commands::            Doing various things with the article buffer.
4195 * Summary Sorting::             Sorting the summary buffer in various ways.
4196 * Finding the Parent::          No child support? Get the parent.
4197 * Alternative Approaches::      Reading using non-default summaries.
4198 * Tree Display::                A more visual display of threads.
4199 * Mail Group Commands::         Some commands can only be used in mail groups.
4200 * Various Summary Stuff::       What didn't fit anywhere else.
4201 * Exiting the Summary Buffer::  Returning to the Group buffer,
4202                                 or reselecting the current group.
4203 * Crosspost Handling::          How crossposted articles are dealt with.
4204 * Duplicate Suppression::       An alternative when crosspost handling fails.
4205 * Security::                    Decrypt and Verify.
4206 * Mailing List::                Mailing list minor mode.
4207 @end menu
4208
4209
4210 @node Summary Buffer Format
4211 @section Summary Buffer Format
4212 @cindex summary buffer format
4213
4214 @iftex
4215 @iflatex
4216 \gnusfigure{The Summary Buffer}{180}{
4217 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4218 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4219 }
4220 @end iflatex
4221 @end iftex
4222
4223 @menu
4224 * Summary Buffer Lines::        You can specify how summary lines should look.
4225 * To From Newsgroups::          How to not display your own name.
4226 * Summary Buffer Mode Line::    You can say how the mode line should look.
4227 * Summary Highlighting::        Making the summary buffer all pretty and nice.
4228 @end menu
4229
4230 @findex mail-extract-address-components
4231 @findex gnus-extract-address-components
4232 @vindex gnus-extract-address-components
4233 Gnus will use the value of the @code{gnus-extract-address-components}
4234 variable as a function for getting the name and address parts of a
4235 @code{From} header.  Three pre-defined functions exist:
4236 @code{gnus-extract-address-components}, which is the default, quite
4237 fast, and too simplistic solution;
4238 @code{mail-extract-address-components}, which works nicely, but is
4239 slower; and @code{std11-extract-address-components}, which works very
4240 nicely, but is slower.  The default function will return the wrong
4241 answer in 5% of the cases.  If this is unacceptable to you, use the
4242 other function instead:
4243
4244 @lisp
4245 (setq gnus-extract-address-components
4246       'mail-extract-address-components)
4247 @end lisp
4248
4249 @vindex gnus-summary-same-subject
4250 @code{gnus-summary-same-subject} is a string indicating that the current
4251 article has the same subject as the previous.  This string will be used
4252 with those specs that require it.  The default is @code{""}.
4253
4254
4255 @node Summary Buffer Lines
4256 @subsection Summary Buffer Lines
4257
4258 @vindex gnus-summary-line-format
4259 You can change the format of the lines in the summary buffer by changing
4260 the @code{gnus-summary-line-format} variable.  It works along the same
4261 lines as a normal @code{format} string, with some extensions
4262 (@pxref{Formatting Variables}).
4263
4264 There should always be a colon or a point position marker on the line;
4265 the cursor always moves to the point position marker or the colon after
4266 performing an operation.  (Of course, Gnus wouldn't be Gnus if it wasn't
4267 possible to change this.  Just write a new function
4268 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4269 @xref{Positioning Point}.
4270
4271 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23n%]%) %s\n}.
4272
4273 The following format specification characters and extended format
4274 specification(s) are understood:
4275
4276 @table @samp
4277 @item N
4278 Article number.
4279 @item S
4280 Subject string.  List identifiers stripped,
4281 @code{gnus-list-identifies}.  @xref{Article Hiding}.
4282 @item s
4283 Subject if the article is the root of the thread or the previous article
4284 had a different subject, @code{gnus-summary-same-subject} otherwise.
4285 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4286 @item F
4287 Full @code{From} header.
4288 @item n
4289 The name (from the @code{From} header).
4290 @item f
4291 The name, code @code{To} header or the @code{Newsgroups} header
4292 (@pxref{To From Newsgroups}).
4293 @item a
4294 The name (from the @code{From} header).  This differs from the @code{n}
4295 spec in that it uses the function designated by the
4296 @code{gnus-extract-address-components} variable, which is slower, but
4297 may be more thorough.
4298 @item A
4299 The address (from the @code{From} header).  This works the same way as
4300 the @code{a} spec.
4301 @item L
4302 Number of lines in the article.
4303 @item c
4304 Number of characters in the article. This specifier is not supported
4305 in some methods (like nnfolder).
4306 @item I
4307 Indentation based on thread level (@pxref{Customizing Threading}).
4308 @item B
4309 A complex trn-style thread tree, showing response-connecting trace
4310 lines.
4311 @item T
4312 Nothing if the article is a root and lots of spaces if it isn't (it
4313 pushes everything after it off the screen).
4314 @item [
4315 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4316 for adopted articles (@pxref{Customizing Threading}).
4317 @item ]
4318 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4319 for adopted articles.
4320 @item >
4321 One space for each thread level.
4322 @item <
4323 Twenty minus thread level spaces.
4324 @item U
4325 Unread.
4326
4327 @item R
4328 This misleadingly named specifier is the @dfn{secondary mark}.  This
4329 mark will say whether the article has been replied to, has been cached,
4330 or has been saved.
4331
4332 @item i
4333 Score as a number (@pxref{Scoring}).
4334 @item z
4335 @vindex gnus-summary-zcore-fuzz
4336 Zcore, @samp{+} if above the default level and @samp{-} if below the
4337 default level.  If the difference between
4338 @code{gnus-summary-default-score} and the score is less than
4339 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4340 @item V
4341 Total thread score.
4342 @item x
4343 @code{Xref}.
4344 @item D
4345 @code{Date}.
4346 @item d
4347 The @code{Date} in @code{DD-MMM} format.
4348 @item o
4349 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4350 @item M
4351 @code{Message-ID}.
4352 @item r
4353 @code{References}.
4354 @item t
4355 Number of articles in the current sub-thread.  Using this spec will slow
4356 down summary buffer generation somewhat.
4357 @item e
4358 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4359 article has any children.
4360 @item P
4361 The line number.
4362 @item O
4363 Download mark.
4364 @item &user-date;
4365 Age sensitive date format.  Various date format is defined in
4366 @code{gnus-user-date-format-alist}.
4367 @item u
4368 User defined specifier.  The next character in the format string should
4369 be a letter.  Gnus will call the function
4370 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4371 following @samp{%u}.  The function will be passed the current header as
4372 argument.  The function should return a string, which will be inserted
4373 into the summary just like information from any other summary specifier.
4374 @end table
4375
4376 Text between @samp{%(} and @samp{%)} will be highlighted with
4377 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4378 There can only be one such area.
4379
4380 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4381 have to be handled with care.  For reasons of efficiency, gnus will
4382 compute what column these characters will end up in, and ``hard-code''
4383 that.  This means that it is invalid to have these specs after a
4384 variable-length spec.  Well, you might not be arrested, but your summary
4385 buffer will look strange, which is bad enough.
4386
4387 The smart choice is to have these specs as far to the left as possible.
4388 (Isn't that the case with everything, though?  But I digress.)
4389
4390 This restriction may disappear in later versions of gnus.
4391
4392
4393 @node To From Newsgroups
4394 @subsection To From Newsgroups
4395 @cindex To
4396 @cindex Newsgroups
4397
4398 In some groups (particularly in archive groups), the @code{From} header
4399 isn't very interesting, since all the articles there are written by
4400 you.  To display the information in the @code{To} or @code{Newsgroups}
4401 headers instead, you need to decide three things: What information to
4402 gather; where to display it; and when to display it.
4403
4404 @enumerate
4405 @item
4406 @vindex gnus-extra-headers
4407 The reading of extra header information is controlled by the
4408 @code{gnus-extra-headers}.  This is a list of header symbols.  For
4409 instance:
4410
4411 @lisp
4412 (setq gnus-extra-headers
4413       '(To Newsgroups X-Newsreader))
4414 @end lisp
4415
4416 This will result in Gnus trying to obtain these three headers, and
4417 storing it in header structures for later easy retrieval.
4418
4419 @item
4420 @findex gnus-extra-header
4421 The value of these extra headers can be accessed via the
4422 @code{gnus-extra-header} function.  Here's a format line spec that will
4423 access the @code{X-Newsreader} header:
4424
4425 @example
4426 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4427 @end example
4428
4429 @item
4430 @vindex gnus-ignored-from-addresses
4431 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4432 summary line spec returns the @code{To}, @code{Newsreader} or
4433 @code{From} header.  If this regexp matches the contents of the
4434 @code{From} header, the value of the @code{To} or @code{Newsreader}
4435 headers are used instead.
4436
4437 @end enumerate
4438
4439 @vindex nnmail-extra-headers
4440 A related variable is @code{nnmail-extra-headers}, which controls when
4441 to include extra headers when generating overview (@sc{nov}) files.  If
4442 you have old overview files, you should regenerate them after changing
4443 this variable.
4444
4445 @vindex gnus-summary-line-format
4446 You also have to instruct Gnus to display the data by changing the
4447 @code{%n} spec to the @code{%f} spec in the
4448 @code{gnus-summary-line-format} variable.
4449
4450 In summary, you'd typically put something like the following in
4451 @file{~/.gnus}:
4452
4453 @lisp
4454 (setq gnus-extra-headers
4455       '(To Newsgroups))
4456 (setq nnmail-extra-headers gnus-extra-headers)
4457 (setq gnus-summary-line-format
4458       "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
4459 (setq gnus-ignored-from-addresses
4460       "Your Name Here")
4461 @end lisp
4462
4463 Now, this is mostly useful for mail groups, where you have control over
4464 the @sc{nov} files that are created.  However, if you can persuade your
4465 nntp admin to add:
4466
4467 @example
4468 Newsgroups:full
4469 @end example
4470
4471 to the end of her @file{overview.fmt} file, then you can use that just
4472 as you would the extra headers from the mail groups.
4473
4474
4475 @node Summary Buffer Mode Line
4476 @subsection Summary Buffer Mode Line
4477
4478 @vindex gnus-summary-mode-line-format
4479 You can also change the format of the summary mode bar (@pxref{Mode Line
4480 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
4481 like.  The default is @samp{Gnus: %%b [%A] %Z}.
4482
4483 Here are the elements you can play with:
4484
4485 @table @samp
4486 @item G
4487 Group name.
4488 @item p
4489 Unprefixed group name.
4490 @item A
4491 Current article number.
4492 @item z
4493 Current article score.
4494 @item V
4495 Gnus version.
4496 @item U
4497 Number of unread articles in this group.
4498 @item e
4499 Number of unread articles in this group that aren't displayed in the
4500 summary buffer.
4501 @item Z
4502 A string with the number of unread and unselected articles represented
4503 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4504 articles, and just as @samp{<%U more>} if there are just unread articles
4505 and no unselected ones.
4506 @item g
4507 Shortish group name.  For instance, @samp{rec.arts.anime} will be
4508 shortened to @samp{r.a.anime}.
4509 @item S
4510 Subject of the current article.
4511 @item u
4512 User-defined spec (@pxref{User-Defined Specs}).
4513 @item s
4514 Name of the current score file (@pxref{Scoring}).
4515 @item d
4516 Number of dormant articles (@pxref{Unread Articles}).
4517 @item t
4518 Number of ticked articles (@pxref{Unread Articles}).
4519 @item r
4520 Number of articles that have been marked as read in this session.
4521 @item E
4522 Number of articles expunged by the score files.
4523 @end table
4524
4525
4526 @node Summary Highlighting
4527 @subsection Summary Highlighting
4528
4529 @table @code
4530
4531 @item gnus-visual-mark-article-hook
4532 @vindex gnus-visual-mark-article-hook
4533 This hook is run after selecting an article.  It is meant to be used for
4534 highlighting the article in some way.  It is not run if
4535 @code{gnus-visual} is @code{nil}.
4536
4537 @item gnus-summary-update-hook
4538 @vindex gnus-summary-update-hook
4539 This hook is called when a summary line is changed.  It is not run if
4540 @code{gnus-visual} is @code{nil}.
4541
4542 @item gnus-summary-selected-face
4543 @vindex gnus-summary-selected-face
4544 This is the face (or @dfn{font} as some people call it) used to
4545 highlight the current article in the summary buffer.
4546
4547 @item gnus-summary-highlight
4548 @vindex gnus-summary-highlight
4549 Summary lines are highlighted according to this variable, which is a
4550 list where the elements are of the format @code{(@var{form}
4551 . @var{face})}.  If you would, for instance, like ticked articles to be
4552 italic and high-scored articles to be bold, you could set this variable
4553 to something like
4554 @lisp
4555 (((eq mark gnus-ticked-mark) . italic)
4556  ((> score default) . bold))
4557 @end lisp
4558 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4559 @var{face} will be applied to the line.
4560 @end table
4561
4562
4563 @node Summary Maneuvering
4564 @section Summary Maneuvering
4565 @cindex summary movement
4566
4567 All the straight movement commands understand the numeric prefix and
4568 behave pretty much as you'd expect.
4569
4570 None of these commands select articles.
4571
4572 @table @kbd
4573 @item G M-n
4574 @itemx M-n
4575 @kindex M-n (Summary)
4576 @kindex G M-n (Summary)
4577 @findex gnus-summary-next-unread-subject
4578 Go to the next summary line of an unread article
4579 (@code{gnus-summary-next-unread-subject}).
4580
4581 @item G M-p
4582 @itemx M-p
4583 @kindex M-p (Summary)
4584 @kindex G M-p (Summary)
4585 @findex gnus-summary-prev-unread-subject
4586 Go to the previous summary line of an unread article
4587 (@code{gnus-summary-prev-unread-subject}).
4588
4589 @item G g
4590 @kindex G g (Summary)
4591 @findex gnus-summary-goto-subject
4592 Ask for an article number and then go to the summary line of that article
4593 without displaying the article (@code{gnus-summary-goto-subject}).
4594 @end table
4595
4596 If gnus asks you to press a key to confirm going to the next group, you
4597 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4598 buffer, searching for the next group to read without actually returning
4599 to the group buffer.
4600
4601 Variables related to summary movement:
4602
4603 @table @code
4604
4605 @vindex gnus-auto-select-next
4606 @item gnus-auto-select-next
4607 If you issue one of the movement commands (like @kbd{n}) and there are
4608 no more unread articles after the current one, gnus will offer to go to
4609 the next group.  If this variable is @code{t} and the next group is
4610 empty, gnus will exit summary mode and return to the group buffer.  If
4611 this variable is neither @code{t} nor @code{nil}, gnus will select the
4612 next group, no matter whether it has any unread articles or not.  As a
4613 special case, if this variable is @code{quietly}, gnus will select the
4614 next group without asking for confirmation.  If this variable is
4615 @code{almost-quietly}, the same will happen only if you are located on
4616 the last article in the group.  Finally, if this variable is
4617 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4618 without confirmation.  Also @pxref{Group Levels}.
4619
4620 @item gnus-auto-select-same
4621 @vindex gnus-auto-select-same
4622 If non-@code{nil}, all the movement commands will try to go to the next
4623 article with the same subject as the current.  (@dfn{Same} here might
4624 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
4625 for details (@pxref{Customizing Threading}).)  If there are no more
4626 articles with the same subject, go to the first unread article.
4627
4628 This variable is not particularly useful if you use a threaded display.
4629
4630 @item gnus-summary-check-current
4631 @vindex gnus-summary-check-current
4632 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4633 to the next (or previous) article if the current article is unread.
4634 Instead, they will choose the current article.
4635
4636 @item gnus-auto-center-summary
4637 @vindex gnus-auto-center-summary
4638 If non-@code{nil}, gnus will keep the point in the summary buffer
4639 centered at all times.  This makes things quite tidy, but if you have a
4640 slow network connection, or simply do not like this un-Emacsism, you can
4641 set this variable to @code{nil} to get the normal Emacs scrolling
4642 action.  This will also inhibit horizontal re-centering of the summary
4643 buffer, which might make it more inconvenient to read extremely long
4644 threads.
4645
4646 This variable can also be a number.  In that case, center the window at
4647 the given number of lines from the top.
4648
4649 @end table
4650
4651
4652 @node Choosing Articles
4653 @section Choosing Articles
4654 @cindex selecting articles
4655
4656 @menu
4657 * Choosing Commands::           Commands for choosing articles.
4658 * Choosing Variables::          Variables that influence these commands.
4659 @end menu
4660
4661
4662 @node Choosing Commands
4663 @subsection Choosing Commands
4664
4665 None of the following movement commands understand the numeric prefix,
4666 and they all select and display an article.
4667
4668 If you want to fetch new articles or redisplay the group, see
4669 @ref{Exiting the Summary Buffer}.
4670
4671 @table @kbd
4672 @item SPACE
4673 @kindex SPACE (Summary)
4674 @findex gnus-summary-next-page
4675 Select the current article, or, if that one's read already, the next
4676 unread article (@code{gnus-summary-next-page}).
4677
4678 @item G n
4679 @itemx n
4680 @kindex n (Summary)
4681 @kindex G n (Summary)
4682 @findex gnus-summary-next-unread-article
4683 @c @icon{gnus-summary-next-unread}
4684 Go to next unread article (@code{gnus-summary-next-unread-article}).
4685
4686 @item G p
4687 @itemx p
4688 @kindex p (Summary)
4689 @findex gnus-summary-prev-unread-article
4690 @c @icon{gnus-summary-prev-unread}
4691 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4692
4693 @item G N
4694 @itemx N
4695 @kindex N (Summary)
4696 @kindex G N (Summary)
4697 @findex gnus-summary-next-article
4698 Go to the next article (@code{gnus-summary-next-article}).
4699
4700 @item G P
4701 @itemx P
4702 @kindex P (Summary)
4703 @kindex G P (Summary)
4704 @findex gnus-summary-prev-article
4705 Go to the previous article (@code{gnus-summary-prev-article}).
4706
4707 @item G C-n
4708 @kindex G C-n (Summary)
4709 @findex gnus-summary-next-same-subject
4710 Go to the next article with the same subject
4711 (@code{gnus-summary-next-same-subject}).
4712
4713 @item G C-p
4714 @kindex G C-p (Summary)
4715 @findex gnus-summary-prev-same-subject
4716 Go to the previous article with the same subject
4717 (@code{gnus-summary-prev-same-subject}).
4718
4719 @item G f
4720 @itemx .
4721 @kindex G f  (Summary)
4722 @kindex .  (Summary)
4723 @findex gnus-summary-first-unread-article
4724 Go to the first unread article
4725 (@code{gnus-summary-first-unread-article}).
4726
4727 @item G b
4728 @itemx ,
4729 @kindex G b (Summary)
4730 @kindex , (Summary)
4731 @findex gnus-summary-best-unread-article
4732 Go to the article with the highest score
4733 (@code{gnus-summary-best-unread-article}).
4734
4735 @item G l
4736 @itemx l
4737 @kindex l (Summary)
4738 @kindex G l (Summary)
4739 @findex gnus-summary-goto-last-article
4740 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4741
4742 @item G o
4743 @kindex G o (Summary)
4744 @findex gnus-summary-pop-article
4745 @cindex history
4746 @cindex article history
4747 Pop an article off the summary history and go to this article
4748 (@code{gnus-summary-pop-article}).  This command differs from the
4749 command above in that you can pop as many previous articles off the
4750 history as you like, while @kbd{l} toggles the two last read articles.
4751 For a somewhat related issue (if you use these commands a lot),
4752 @pxref{Article Backlog}.
4753
4754 @item G j
4755 @itemx j
4756 @kindex j (Summary)
4757 @kindex G j (Summary)
4758 @findex gnus-summary-goto-article
4759 Ask for an article number or @code{Message-ID}, and then go to that
4760 article (@code{gnus-summary-goto-article}).
4761
4762 @end table
4763
4764
4765 @node Choosing Variables
4766 @subsection Choosing Variables
4767
4768 Some variables relevant for moving and selecting articles:
4769
4770 @table @code
4771 @item gnus-auto-extend-newsgroup
4772 @vindex gnus-auto-extend-newsgroup
4773 All the movement commands will try to go to the previous (or next)
4774 article, even if that article isn't displayed in the Summary buffer if
4775 this variable is non-@code{nil}.  Gnus will then fetch the article from
4776 the server and display it in the article buffer.
4777
4778 @item gnus-select-article-hook
4779 @vindex gnus-select-article-hook
4780 This hook is called whenever an article is selected.  By default it
4781 exposes any threads hidden under the selected article.
4782
4783 @item gnus-mark-article-hook
4784 @vindex gnus-mark-article-hook
4785 @findex gnus-summary-mark-unread-as-read
4786 @findex gnus-summary-mark-read-and-unread-as-read
4787 @findex gnus-unread-mark
4788 This hook is called whenever an article is selected.  It is intended to
4789 be used for marking articles as read.  The default value is
4790 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4791 mark of almost any article you read to @code{gnus-unread-mark}.  The
4792 only articles not affected by this function are ticked, dormant, and
4793 expirable articles.  If you'd instead like to just have unread articles
4794 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4795 instead.  It will leave marks like @code{gnus-low-score-mark},
4796 @code{gnus-del-mark} (and so on) alone.
4797
4798 @end table
4799
4800
4801 @node Paging the Article
4802 @section Scrolling the Article
4803 @cindex article scrolling
4804
4805 @table @kbd
4806
4807 @item SPACE
4808 @kindex SPACE (Summary)
4809 @findex gnus-summary-next-page
4810 Pressing @kbd{SPACE} will scroll the current article forward one page,
4811 or, if you have come to the end of the current article, will choose the
4812 next article (@code{gnus-summary-next-page}).
4813
4814 @item DEL
4815 @kindex DEL (Summary)
4816 @findex gnus-summary-prev-page
4817 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4818
4819 @item RET
4820 @kindex RET (Summary)
4821 @findex gnus-summary-scroll-up
4822 Scroll the current article one line forward
4823 (@code{gnus-summary-scroll-up}).
4824
4825 @item M-RET
4826 @kindex M-RET (Summary)
4827 @findex gnus-summary-scroll-down
4828 Scroll the current article one line backward
4829 (@code{gnus-summary-scroll-down}).
4830
4831 @item A g
4832 @itemx g
4833 @kindex A g (Summary)
4834 @kindex g (Summary)
4835 @findex gnus-summary-show-article
4836 @vindex gnus-summary-show-article-charset-alist
4837 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
4838 given a prefix, fetch the current article, but don't run any of the
4839 article treatment functions.  This will give you a ``raw'' article, just
4840 the way it came from the server.
4841
4842 If given a numerical prefix, you can do semi-manual charset stuff.
4843 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4844 encoded in the @code{cn-gb-2312} charset.  If you have
4845
4846 @lisp
4847 (setq gnus-summary-show-article-charset-alist
4848       '((1 . cn-gb-2312)
4849         (2 . big5)))
4850 @end lisp
4851
4852 then you can say @kbd{C-u 1 g} to get the same effect.
4853
4854 @item A <
4855 @itemx <
4856 @kindex < (Summary)
4857 @kindex A < (Summary)
4858 @findex gnus-summary-beginning-of-article
4859 Scroll to the beginning of the article
4860 (@code{gnus-summary-beginning-of-article}).
4861
4862 @item A >
4863 @itemx >
4864 @kindex > (Summary)
4865 @kindex A > (Summary)
4866 @findex gnus-summary-end-of-article
4867 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4868
4869 @item A s
4870 @itemx s
4871 @kindex A s (Summary)
4872 @kindex s (Summary)
4873 @findex gnus-summary-isearch-article
4874 Perform an isearch in the article buffer
4875 (@code{gnus-summary-isearch-article}).
4876
4877 @item h
4878 @kindex h (Summary)
4879 @findex gnus-summary-select-article-buffer
4880 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4881
4882 @end table
4883
4884
4885 @node Reply Followup and Post
4886 @section Reply, Followup and Post
4887
4888 @menu
4889 * Summary Mail Commands::       Sending mail.
4890 * Summary Post Commands::       Sending news.
4891 * Summary Message Commands::    Other Message-related commands.
4892 * Canceling and Superseding::   
4893 @end menu
4894
4895
4896 @node Summary Mail Commands
4897 @subsection Summary Mail Commands
4898 @cindex mail
4899 @cindex composing mail
4900
4901 Commands for composing a mail message:
4902
4903 @table @kbd
4904
4905 @item S r
4906 @itemx r
4907 @kindex S r (Summary)
4908 @kindex r (Summary)
4909 @findex gnus-summary-reply
4910 @c @icon{gnus-summary-mail-reply}
4911 @c @icon{gnus-summary-reply}
4912 Mail a reply to the author of the current article
4913 (@code{gnus-summary-reply}).
4914
4915 @item S R
4916 @itemx R
4917 @kindex R (Summary)
4918 @kindex S R (Summary)
4919 @findex gnus-summary-reply-with-original
4920 @c @icon{gnus-summary-reply-with-original}
4921 Mail a reply to the author of the current article and include the
4922 original message (@code{gnus-summary-reply-with-original}).  This
4923 command uses the process/prefix convention.
4924
4925 @item S w
4926 @kindex S w (Summary)
4927 @findex gnus-summary-wide-reply
4928 Mail a wide reply to the author of the current article
4929 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
4930 goes out to all people listed in the @code{To}, @code{From} (or
4931 @code{Reply-to}) and @code{Cc} headers.
4932
4933 @item S W
4934 @kindex S W (Summary)
4935 @findex gnus-summary-wide-reply-with-original
4936 Mail a wide reply to the current article and include the original
4937 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
4938 the process/prefix convention.
4939
4940 @item S v
4941 @kindex S v (Summary)
4942 @findex gnus-summary-very-wide-reply
4943 Mail a very wide reply to the author of the current article
4944 (@code{gnus-summary-wide-reply}).  A @dfn{very wide reply} is a reply
4945 that goes out to all people listed in the @code{To}, @code{From} (or
4946 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
4947 articles.  This command uses the process/prefix convention.
4948
4949 @item S o m
4950 @itemx C-c C-f
4951 @kindex S o m (Summary)
4952 @kindex C-c C-f (Summary)
4953 @findex gnus-summary-mail-forward
4954 @c @icon{gnus-summary-mail-forward}
4955 Forward the current article to some other person
4956 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
4957 headers of the forwarded article.
4958
4959 @item S m
4960 @itemx m
4961 @kindex m (Summary)
4962 @kindex S m (Summary)
4963 @findex gnus-summary-mail-other-window
4964 @c @icon{gnus-summary-mail-originate}
4965 Send a mail to some other person
4966 (@code{gnus-summary-mail-other-window}).
4967
4968 @item S D b
4969 @kindex S D b (Summary)
4970 @findex gnus-summary-resend-bounced-mail
4971 @cindex bouncing mail
4972 If you have sent a mail, but the mail was bounced back to you for some
4973 reason (wrong address, transient failure), you can use this command to
4974 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
4975 will be popped into a mail buffer where you can edit the headers before
4976 sending the mail off again.  If you give a prefix to this command, and
4977 the bounced mail is a reply to some other mail, gnus will try to fetch
4978 that mail and display it for easy perusal of its headers.  This might
4979 very well fail, though.
4980
4981 @item S D r
4982 @kindex S D r (Summary)
4983 @findex gnus-summary-resend-message
4984 Not to be confused with the previous command,
4985 @code{gnus-summary-resend-message} will prompt you for an address to
4986 send the current message off to, and then send it to that place.  The
4987 headers of the message won't be altered---but lots of headers that say
4988 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
4989 means that you actually send a mail to someone that has a @code{To}
4990 header that (probably) points to yourself.  This will confuse people.
4991 So, natcherly you'll only do that if you're really eVIl.
4992
4993 This command is mainly used if you have several accounts and want to
4994 ship a mail to a different account of yours.  (If you're both
4995 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4996 to the @code{root} account, you may want to resend it to
4997 @code{postmaster}.  Ordnung muß sein!
4998
4999 This command understands the process/prefix convention
5000 (@pxref{Process/Prefix}).
5001
5002 @item S O m
5003 @kindex S O m (Summary)
5004 @findex gnus-summary-digest-mail-forward
5005 Digest the current series (@pxref{Decoding Articles}) and forward the
5006 result using mail (@code{gnus-summary-digest-mail-forward}).  This
5007 command uses the process/prefix convention (@pxref{Process/Prefix}).
5008
5009 @item S M-c
5010 @kindex S M-c (Summary)
5011 @findex gnus-summary-mail-crosspost-complaint
5012 @cindex crossposting
5013 @cindex excessive crossposting
5014 Send a complaint about excessive crossposting to the author of the
5015 current article (@code{gnus-summary-mail-crosspost-complaint}).
5016
5017 @findex gnus-crosspost-complaint
5018 This command is provided as a way to fight back against the current
5019 crossposting pandemic that's sweeping Usenet.  It will compose a reply
5020 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
5021 command understands the process/prefix convention
5022 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5023
5024 @end table
5025
5026 Also @xref{Header Commands, ,Header Commands, message, The Message
5027 Manual}, for more information.
5028
5029
5030 @node Summary Post Commands
5031 @subsection Summary Post Commands
5032 @cindex post
5033 @cindex composing news
5034
5035 Commands for posting a news article:
5036
5037 @table @kbd
5038 @item S p
5039 @itemx a
5040 @kindex a (Summary)
5041 @kindex S p (Summary)
5042 @findex gnus-summary-post-news
5043 @c @icon{gnus-summary-post-news}
5044 Post an article to the current group
5045 (@code{gnus-summary-post-news}).
5046
5047 @item S f
5048 @itemx f
5049 @kindex f (Summary)
5050 @kindex S f (Summary)
5051 @findex gnus-summary-followup
5052 @c @icon{gnus-summary-followup}
5053 Post a followup to the current article (@code{gnus-summary-followup}).
5054
5055 @item S F
5056 @itemx F
5057 @kindex S F (Summary)
5058 @kindex F (Summary)
5059 @c @icon{gnus-summary-followup-with-original}
5060 @findex gnus-summary-followup-with-original
5061 Post a followup to the current article and include the original message
5062 (@code{gnus-summary-followup-with-original}).   This command uses the
5063 process/prefix convention.
5064
5065 @item S n
5066 @kindex S n (Summary)
5067 @findex gnus-summary-followup-to-mail
5068 Post a followup to the current article via news, even if you got the
5069 message through mail (@code{gnus-summary-followup-to-mail}).
5070
5071 @item S N
5072 @kindex S N (Summary)
5073 @findex gnus-summary-followup-to-mail-with-original
5074 Post a followup to the current article via news, even if you got the
5075 message through mail and include the original message
5076 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
5077 the process/prefix convention.
5078
5079 @item S o p
5080 @kindex S o p (Summary)
5081 @findex gnus-summary-post-forward
5082 Forward the current article to a newsgroup
5083 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
5084 headers of the forwarded article.
5085
5086 @item S O p
5087 @kindex S O p (Summary)
5088 @findex gnus-summary-digest-post-forward
5089 @cindex digests
5090 @cindex making digests
5091 Digest the current series and forward the result to a newsgroup
5092 (@code{gnus-summary-digest-post-forward}).  This command uses the
5093 process/prefix convention.
5094
5095 @item S u
5096 @kindex S u (Summary)
5097 @findex gnus-uu-post-news
5098 @c @icon{gnus-uu-post-news}
5099 Uuencode a file, split it into parts, and post it as a series
5100 (@code{gnus-uu-post-news}).  (@pxref{Uuencoding and Posting}).
5101 @end table
5102
5103 Also @xref{Header Commands, ,Header Commands, message, The Message
5104 Manual}, for more information.
5105
5106
5107 @node Summary Message Commands
5108 @subsection Summary Message Commands
5109
5110 @table @kbd
5111 @item S y
5112 @kindex S y (Summary)
5113 @findex gnus-summary-yank-message
5114 Yank the current article into an already existing Message composition
5115 buffer (@code{gnus-summary-yank-message}).  This command prompts for
5116 what message buffer you want to yank into, and understands the
5117 process/prefix convention (@pxref{Process/Prefix}).
5118
5119 @end table
5120
5121
5122 @node Canceling and Superseding
5123 @subsection Canceling Articles
5124 @cindex canceling articles
5125 @cindex superseding articles
5126
5127 Have you ever written something, and then decided that you really,
5128 really, really wish you hadn't posted that?
5129
5130 Well, you can't cancel mail, but you can cancel posts.
5131
5132 @findex gnus-summary-cancel-article
5133 @kindex C (Summary)
5134 @c @icon{gnus-summary-cancel-article}
5135 Find the article you wish to cancel (you can only cancel your own
5136 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
5137 c} (@code{gnus-summary-cancel-article}).  Your article will be
5138 canceled---machines all over the world will be deleting your article.
5139 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5140
5141 Be aware, however, that not all sites honor cancels, so your article may
5142 live on here and there, while most sites will delete the article in
5143 question.
5144
5145 Gnus will use the ``current'' select method when canceling.  If you
5146 want to use the standard posting method, use the @samp{a} symbolic
5147 prefix (@pxref{Symbolic Prefixes}).
5148
5149 If you discover that you have made some mistakes and want to do some
5150 corrections, you can post a @dfn{superseding} article that will replace
5151 your original article.
5152
5153 @findex gnus-summary-supersede-article
5154 @kindex S (Summary)
5155 Go to the original article and press @kbd{S s}
5156 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
5157 where you can edit the article all you want before sending it off the
5158 usual way.
5159
5160 The same goes for superseding as for canceling, only more so: Some
5161 sites do not honor superseding.  On those sites, it will appear that you
5162 have posted almost the same article twice.
5163
5164 If you have just posted the article, and change your mind right away,
5165 there is a trick you can use to cancel/supersede the article without
5166 waiting for the article to appear on your site first.  You simply return
5167 to the post buffer (which is called @code{*sent ...*}).  There you will
5168 find the article you just posted, with all the headers intact.  Change
5169 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5170 header by substituting one of those words for the word
5171 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
5172 you would do normally.  The previous article will be
5173 canceled/superseded.
5174
5175 Just remember, kids: There is no 'c' in 'supersede'.
5176
5177 @node Delayed Articles
5178 @section Delayed Articles
5179 @cindex delayed sending
5180 @cindex send delayed
5181
5182 Sometimes, you might wish to delay the sending of a message.  For
5183 example, you might wish to arrange for a message to turn up just in time
5184 to remind your about the birthday of your Significant Other.  For this,
5185 there is the @code{gnus-delay} package.  Setup is simple:
5186
5187 @lisp
5188 (gnus-delay-initialize)
5189 @end lisp
5190
5191 @findex gnus-delay-article
5192 Normally, to send a message you use the @kbd{C-c C-c} command from
5193 Message mode.  To delay a message, use @kbd{C-c C-j}
5194 (@code{gnus-delay-article}) instead.  This will ask you for how long the
5195 message should be delayed.  Possible answers are:
5196
5197 @itemize @bullet
5198 @item
5199 A time span.  Consists of an integer and a letter.  For example,
5200 @code{42d} means to delay for 42 days.  Available letters are @code{m}
5201 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5202 (months) and @code{Y} (years).
5203
5204 @item
5205 A specific date.  Looks like @code{YYYYY-MM-DD}.  The message will be
5206 delayed until that day, at a specific time (eight o'clock by default).
5207 See also @code{gnus-delay-default-hour}.
5208
5209 @item
5210 A specific time of day.  Given in @code{hh:mm} format, 24h, no am/pm
5211 stuff.  The deadline will be at that time today, except if that time has
5212 already passed, then it's at the given time tomorrow.  So if it's ten
5213 o'clock in the morning and you specify @code{11:15}, then the deadline
5214 is one hour and fifteen minutes hence.  But if you specify @code{9:20},
5215 that means a time tomorrow.
5216 @end itemize
5217
5218 The action of the @code{gnus-delay-article} command is influenced by a
5219 couple of variables:
5220
5221 @table @code
5222 @item gnus-delay-default-hour
5223 @vindex gnus-delay-default-hour
5224 When you specify a specific date, the message will be due on that hour
5225 on the given date.  Possible values are integers 0 through 23.
5226
5227 @item gnus-delay-default-delay
5228 @vindex gnus-delay-default-delay
5229 This is a string and gives the default delay.  It can be of any of the
5230 formats described above.
5231
5232 @item gnus-delay-group
5233 @vindex gnus-delay-group
5234 Delayed articles will be kept in this group on the drafts server until
5235 they are due.  You probably don't need to change this.  The default
5236 value is @code{"delayed"}.
5237
5238 @item gnus-delay-header
5239 @vindex gnus-delay-header
5240 The deadline for each article will be stored in a header.  This variable
5241 is a string and gives the header name.  You probably don't need to
5242 change this.  The default value is @code{"X-Gnus-Delayed"}.
5243 @end table
5244
5245 The way delaying works is like this: when you use the
5246 @code{gnus-delay-article} command, you give a certain delay.  Gnus
5247 calculates the deadline of the message and stores it in the
5248 @code{X-Gnus-Delayed} header and puts the message in the
5249 @code{nndraft:delayed} group.
5250
5251 And whenever you get new news, Gnus looks through the group for articles
5252 which are due and sends them.  It uses the @code{gnus-delay-send-drafts}
5253 function for this.  By default, this function is added to the hook
5254 @code{gnus-get-new-news-hook}.  But of course, you can change this.
5255 Maybe you want to use the demon to send drafts?  Just tell the demon to
5256 execute the @code{gnus-delay-send-drafts} function.
5257
5258 @table @code
5259 @item gnus-delay-initialize
5260 @findex gnus-delay-initialize
5261 By default, this function installs the @kbd{C-c C-j} key binding in
5262 Message mode and @code{gnus-delay-send-drafts} in
5263 @code{gnus-get-new-news-hook}.  But it accepts two optional arguments,
5264 @code{no-keymap} and @code{no-check}.  If @code{no-keymap} is non-nil,
5265 the @kbd{C-c C-j} binding is not intalled.  If @code{no-check} is
5266 non-nil, @code{gnus-get-new-news-hook} is not changed.
5267
5268 For example, @code{(gnus-delay-initialize nil t)} means to change the
5269 keymap but not to change @code{gnus-get-new-news-hook}.  Presumably, you
5270 want to use the demon for sending due delayed articles.  Just don't
5271 forget to set that up :-)
5272 @end table
5273
5274
5275 @node Marking Articles
5276 @section Marking Articles
5277 @cindex article marking
5278 @cindex article ticking
5279 @cindex marks
5280
5281 There are several marks you can set on an article.
5282
5283 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5284 neologism ohoy!) of the article.  Alphabetic marks generally mean
5285 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5286
5287 In addition, you also have marks that do not affect readedness.
5288
5289 @menu
5290 * Unread Articles::             Marks for unread articles.
5291 * Read Articles::               Marks for read articles.
5292 * Other Marks::                 Marks that do not affect readedness.
5293 @end menu
5294
5295 @ifinfo
5296 There's a plethora of commands for manipulating these marks:
5297 @end ifinfo
5298
5299 @menu
5300 * Setting Marks::             How to set and remove marks.
5301 * Generic Marking Commands::  How to customize the marking.
5302 * Setting Process Marks::     How to mark articles for later processing.
5303 @end menu
5304
5305
5306 @node Unread Articles
5307 @subsection Unread Articles
5308
5309 The following marks mark articles as (kinda) unread, in one form or
5310 other.
5311
5312 @table @samp
5313 @item !
5314 @vindex gnus-ticked-mark
5315 Marked as ticked (@code{gnus-ticked-mark}).
5316
5317 @dfn{Ticked articles} are articles that will remain visible always.  If
5318 you see an article that you find interesting, or you want to put off
5319 reading it, or replying to it, until sometime later, you'd typically
5320 tick it.  However, articles can be expired (from news servers by the
5321 news server software, Gnus itself never expires ticked messages), so if
5322 you want to keep an article forever, you'll have to make it persistent
5323 (@pxref{Persistent Articles}).
5324
5325 @item ?
5326 @vindex gnus-dormant-mark
5327 Marked as dormant (@code{gnus-dormant-mark}).
5328
5329 @dfn{Dormant articles} will only appear in the summary buffer if there
5330 are followups to it.  If you want to see them even if they don't have
5331 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
5332 Otherwise (except for the visibility issue), they are just like ticked
5333 messages.
5334
5335 @item SPACE
5336 @vindex gnus-unread-mark
5337 Marked as unread (@code{gnus-unread-mark}).
5338
5339 @dfn{Unread articles} are articles that haven't been read at all yet.
5340 @end table
5341
5342
5343 @node Read Articles
5344 @subsection Read Articles
5345 @cindex expirable mark
5346
5347 All the following marks mark articles as read.
5348
5349 @table @samp
5350
5351 @item r
5352 @vindex gnus-del-mark
5353 These are articles that the user has marked as read with the @kbd{d}
5354 command manually, more or less (@code{gnus-del-mark}).
5355
5356 @item R
5357 @vindex gnus-read-mark
5358 Articles that have actually been read (@code{gnus-read-mark}).
5359
5360 @item O
5361 @vindex gnus-ancient-mark
5362 Articles that were marked as read in previous sessions and are now
5363 @dfn{old} (@code{gnus-ancient-mark}).
5364
5365 @item K
5366 @vindex gnus-killed-mark
5367 Marked as killed (@code{gnus-killed-mark}).
5368
5369 @item X
5370 @vindex gnus-kill-file-mark
5371 Marked as killed by kill files (@code{gnus-kill-file-mark}).
5372
5373 @item Y
5374 @vindex gnus-low-score-mark
5375 Marked as read by having too low a score (@code{gnus-low-score-mark}).
5376
5377 @item C
5378 @vindex gnus-catchup-mark
5379 Marked as read by a catchup (@code{gnus-catchup-mark}).
5380
5381 @item G
5382 @vindex gnus-canceled-mark
5383 Canceled article (@code{gnus-canceled-mark})
5384
5385 @item F
5386 @vindex gnus-souped-mark
5387 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
5388
5389 @item Q
5390 @vindex gnus-sparse-mark
5391 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
5392 Threading}.
5393
5394 @item M
5395 @vindex gnus-duplicate-mark
5396 Article marked as read by duplicate suppression
5397 (@code{gnus-duplicate-mark}).  @xref{Duplicate Suppression}.
5398
5399 @end table
5400
5401 All these marks just mean that the article is marked as read, really.
5402 They are interpreted differently when doing adaptive scoring, though.
5403
5404 One more special mark, though:
5405
5406 @table @samp
5407 @item E
5408 @vindex gnus-expirable-mark
5409 Marked as expirable (@code{gnus-expirable-mark}).
5410
5411 Marking articles as @dfn{expirable} (or have them marked as such
5412 automatically) doesn't make much sense in normal groups---a user doesn't
5413 control expiring of news articles, but in mail groups, for instance,
5414 articles marked as @dfn{expirable} can be deleted by gnus at
5415 any time.
5416 @end table
5417
5418
5419 @node Other Marks
5420 @subsection Other Marks
5421 @cindex process mark
5422 @cindex bookmarks
5423
5424 There are some marks that have nothing to do with whether the article is
5425 read or not.
5426
5427 @itemize @bullet
5428
5429 @item
5430 You can set a bookmark in the current article.  Say you are reading a
5431 long thesis on cats' urinary tracts, and have to go home for dinner
5432 before you've finished reading the thesis.  You can then set a bookmark
5433 in the article, and gnus will jump to this bookmark the next time it
5434 encounters the article.  @xref{Setting Marks}.
5435
5436 @item
5437 @vindex gnus-replied-mark
5438 All articles that you have replied to or made a followup to (i.e., have
5439 answered) will be marked with an @samp{A} in the second column
5440 (@code{gnus-replied-mark}).
5441
5442 @vindex gnus-forwarded-mark
5443 All articles that you have forwarded will be marked with an @samp{F} in
5444 the second column (@code{gnus-forwarded-mark}).
5445
5446 @vindex gnus-recent-mark
5447 Articles that are ``recently'' arrived in the group will be marked
5448 with an @samp{N} in the second column (@code{gnus-recent-mark}).  Most
5449 back end doesn't support the mark, in which case it's not shown.
5450
5451 @item
5452 @vindex gnus-cached-mark
5453 Articles stored in the article cache will be marked with an @samp{*} in
5454 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
5455
5456 @item
5457 @vindex gnus-saved-mark
5458 Articles ``saved'' (in some manner or other; not necessarily
5459 religiously) are marked with an @samp{S} in the second column
5460 (@code{gnus-saved-mark}).
5461
5462 @item
5463 @vindex gnus-recent-mark
5464 Articles that according to the back end haven't been seen by the user
5465 before are marked with a @samp{N} in the second column
5466 (@code{gnus-recent-mark}).  Note that not all back ends support this
5467 mark, in which case it simply never appear.
5468
5469 @item
5470 @vindex gnus-unseen-mark
5471 Articles that haven't been seen by the user before are marked with a
5472 @samp{.} in the second column (@code{gnus-unseen-mark}). 
5473
5474 @item
5475 @vindex gnus-not-empty-thread-mark
5476 @vindex gnus-empty-thread-mark
5477 If the @samp{%e} spec is used, the presence of threads or not will be
5478 marked with @code{gnus-not-empty-thread-mark} and
5479 @code{gnus-empty-thread-mark} in the third column, respectively.
5480
5481 @item
5482 @vindex gnus-process-mark
5483 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
5484 variety of commands react to the presence of the process mark.  For
5485 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
5486 all articles that have been marked with the process mark.  Articles
5487 marked with the process mark have a @samp{#} in the second column.
5488
5489 @end itemize
5490
5491 You might have noticed that most of these ``non-readedness'' marks
5492 appear in the second column by default.  So if you have a cached, saved,
5493 replied article that you have process-marked, what will that look like?
5494
5495 Nothing much.  The precedence rules go as follows: process -> cache ->
5496 replied -> saved.  So if the article is in the cache and is replied,
5497 you'll only see the cache mark and not the replied mark.
5498
5499
5500 @node Setting Marks
5501 @subsection Setting Marks
5502 @cindex setting marks
5503
5504 All the marking commands understand the numeric prefix.
5505
5506 @table @kbd
5507 @item M c
5508 @itemx M-u
5509 @kindex M c (Summary)
5510 @kindex M-u (Summary)
5511 @findex gnus-summary-clear-mark-forward
5512 @cindex mark as unread
5513 Clear all readedness-marks from the current article
5514 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
5515 article as unread.
5516
5517 @item M t
5518 @itemx !
5519 @kindex ! (Summary)
5520 @kindex M t (Summary)
5521 @findex gnus-summary-tick-article-forward
5522 Tick the current article (@code{gnus-summary-tick-article-forward}).
5523 @xref{Article Caching}.
5524
5525 @item M ?
5526 @itemx ?
5527 @kindex ? (Summary)
5528 @kindex M ? (Summary)
5529 @findex gnus-summary-mark-as-dormant
5530 Mark the current article as dormant
5531 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
5532
5533 @item M d
5534 @itemx d
5535 @kindex M d (Summary)
5536 @kindex d (Summary)
5537 @findex gnus-summary-mark-as-read-forward
5538 Mark the current article as read
5539 (@code{gnus-summary-mark-as-read-forward}).
5540
5541 @item D
5542 @kindex D (Summary)
5543 @findex gnus-summary-mark-as-read-backward
5544 Mark the current article as read and move point to the previous line
5545 (@code{gnus-summary-mark-as-read-backward}).
5546
5547 @item M k
5548 @itemx k
5549 @kindex k (Summary)
5550 @kindex M k (Summary)
5551 @findex gnus-summary-kill-same-subject-and-select
5552 Mark all articles that have the same subject as the current one as read,
5553 and then select the next unread article
5554 (@code{gnus-summary-kill-same-subject-and-select}).
5555
5556 @item M K
5557 @itemx C-k
5558 @kindex M K (Summary)
5559 @kindex C-k (Summary)
5560 @findex gnus-summary-kill-same-subject
5561 Mark all articles that have the same subject as the current one as read
5562 (@code{gnus-summary-kill-same-subject}).
5563
5564 @item M C
5565 @kindex M C (Summary)
5566 @findex gnus-summary-catchup
5567 @c @icon{gnus-summary-catchup}
5568 Mark all unread articles as read (@code{gnus-summary-catchup}).
5569
5570 @item M C-c
5571 @kindex M C-c (Summary)
5572 @findex gnus-summary-catchup-all
5573 Mark all articles in the group as read---even the ticked and dormant
5574 articles (@code{gnus-summary-catchup-all}).
5575
5576 @item M H
5577 @kindex M H (Summary)
5578 @findex gnus-summary-catchup-to-here
5579 Catchup the current group to point (before the point)
5580 (@code{gnus-summary-catchup-to-here}).
5581
5582 @item M h
5583 @kindex M h (Summary)
5584 @findex gnus-summary-catchup-from-here
5585 Catchup the current group from point (after the point)
5586 (@code{gnus-summary-catchup-from-here}).
5587
5588 @item C-w
5589 @kindex C-w (Summary)
5590 @findex gnus-summary-mark-region-as-read
5591 Mark all articles between point and mark as read
5592 (@code{gnus-summary-mark-region-as-read}).
5593
5594 @item M V k
5595 @kindex M V k (Summary)
5596 @findex gnus-summary-kill-below
5597 Kill all articles with scores below the default score (or below the
5598 numeric prefix) (@code{gnus-summary-kill-below}).
5599
5600 @item M e
5601 @itemx E
5602 @kindex M e (Summary)
5603 @kindex E (Summary)
5604 @findex gnus-summary-mark-as-expirable
5605 Mark the current article as expirable
5606 (@code{gnus-summary-mark-as-expirable}).
5607
5608 @item M b
5609 @kindex M b (Summary)
5610 @findex gnus-summary-set-bookmark
5611 Set a bookmark in the current article
5612 (@code{gnus-summary-set-bookmark}).
5613
5614 @item M B
5615 @kindex M B (Summary)
5616 @findex gnus-summary-remove-bookmark
5617 Remove the bookmark from the current article
5618 (@code{gnus-summary-remove-bookmark}).
5619
5620 @item M V c
5621 @kindex M V c (Summary)
5622 @findex gnus-summary-clear-above
5623 Clear all marks from articles with scores over the default score (or
5624 over the numeric prefix) (@code{gnus-summary-clear-above}).
5625
5626 @item M V u
5627 @kindex M V u (Summary)
5628 @findex gnus-summary-tick-above
5629 Tick all articles with scores over the default score (or over the
5630 numeric prefix) (@code{gnus-summary-tick-above}).
5631
5632 @item M V m
5633 @kindex M V m (Summary)
5634 @findex gnus-summary-mark-above
5635 Prompt for a mark, and mark all articles with scores over the default
5636 score (or over the numeric prefix) with this mark
5637 (@code{gnus-summary-clear-above}).
5638 @end table
5639
5640 @vindex gnus-summary-goto-unread
5641 The @code{gnus-summary-goto-unread} variable controls what action should
5642 be taken after setting a mark.  If non-@code{nil}, point will move to
5643 the next/previous unread article.  If @code{nil}, point will just move
5644 one line up or down.  As a special case, if this variable is
5645 @code{never}, all the marking commands as well as other commands (like
5646 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5647 The default is @code{t}.
5648
5649
5650 @node Generic Marking Commands
5651 @subsection Generic Marking Commands
5652
5653 Some people would like the command that ticks an article (@kbd{!}) go to
5654 the next article.  Others would like it to go to the next unread
5655 article.  Yet others would like it to stay on the current article.  And
5656 even though I haven't heard of anybody wanting it to go to the
5657 previous (unread) article, I'm sure there are people that want that as
5658 well.
5659
5660 Multiply these five behaviors with five different marking commands, and
5661 you get a potentially complex set of variable to control what each
5662 command should do.
5663
5664 To sidestep that mess, Gnus provides commands that do all these
5665 different things.  They can be found on the @kbd{M M} map in the summary
5666 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
5667 to list in this manual.
5668
5669 While you can use these commands directly, most users would prefer
5670 altering the summary mode keymap.  For instance, if you would like the
5671 @kbd{!} command to go to the next article instead of the next unread
5672 article, you could say something like:
5673
5674 @lisp
5675 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5676 (defun my-alter-summary-map ()
5677   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5678 @end lisp
5679
5680 or
5681
5682 @lisp
5683 (defun my-alter-summary-map ()
5684   (local-set-key "!" "MM!n"))
5685 @end lisp
5686
5687
5688 @node Setting Process Marks
5689 @subsection Setting Process Marks
5690 @cindex setting process marks
5691
5692 @table @kbd
5693
5694 @item M P p
5695 @itemx #
5696 @kindex # (Summary)
5697 @kindex M P p (Summary)
5698 @findex gnus-summary-mark-as-processable
5699 Mark the current article with the process mark
5700 (@code{gnus-summary-mark-as-processable}).
5701 @findex gnus-summary-unmark-as-processable
5702
5703 @item M P u
5704 @itemx M-#
5705 @kindex M P u (Summary)
5706 @kindex M-# (Summary)
5707 Remove the process mark, if any, from the current article
5708 (@code{gnus-summary-unmark-as-processable}).
5709
5710 @item M P U
5711 @kindex M P U (Summary)
5712 @findex gnus-summary-unmark-all-processable
5713 Remove the process mark from all articles
5714 (@code{gnus-summary-unmark-all-processable}).
5715
5716 @item M P i
5717 @kindex M P i (Summary)
5718 @findex gnus-uu-invert-processable
5719 Invert the list of process marked articles
5720 (@code{gnus-uu-invert-processable}).
5721
5722 @item M P R
5723 @kindex M P R (Summary)
5724 @findex gnus-uu-mark-by-regexp
5725 Mark articles that have a @code{Subject} header that matches a regular
5726 expression (@code{gnus-uu-mark-by-regexp}).
5727
5728 @item M P G
5729 @kindex M P G (Summary)
5730 @findex gnus-uu-unmark-by-regexp
5731 Unmark articles that have a @code{Subject} header that matches a regular
5732 expression (@code{gnus-uu-unmark-by-regexp}).
5733
5734 @item M P r
5735 @kindex M P r (Summary)
5736 @findex gnus-uu-mark-region
5737 Mark articles in region (@code{gnus-uu-mark-region}).
5738
5739 @item M P t
5740 @kindex M P t (Summary)
5741 @findex gnus-uu-mark-thread
5742 Mark all articles in the current (sub)thread
5743 (@code{gnus-uu-mark-thread}).
5744
5745 @item M P T
5746 @kindex M P T (Summary)
5747 @findex gnus-uu-unmark-thread
5748 Unmark all articles in the current (sub)thread
5749 (@code{gnus-uu-unmark-thread}).
5750
5751 @item M P v
5752 @kindex M P v (Summary)
5753 @findex gnus-uu-mark-over
5754 Mark all articles that have a score above the prefix argument
5755 (@code{gnus-uu-mark-over}).
5756
5757 @item M P s
5758 @kindex M P s (Summary)
5759 @findex gnus-uu-mark-series
5760 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5761
5762 @item M P S
5763 @kindex M P S (Summary)
5764 @findex gnus-uu-mark-sparse
5765 Mark all series that have already had some articles marked
5766 (@code{gnus-uu-mark-sparse}).
5767
5768 @item M P a
5769 @kindex M P a (Summary)
5770 @findex gnus-uu-mark-all
5771 Mark all articles in series order (@code{gnus-uu-mark-series}).
5772
5773 @item M P b
5774 @kindex M P b (Summary)
5775 @findex gnus-uu-mark-buffer
5776 Mark all articles in the buffer in the order they appear
5777 (@code{gnus-uu-mark-buffer}).
5778
5779 @item M P k
5780 @kindex M P k (Summary)
5781 @findex gnus-summary-kill-process-mark
5782 Push the current process mark set onto the stack and unmark all articles
5783 (@code{gnus-summary-kill-process-mark}).
5784
5785 @item M P y
5786 @kindex M P y (Summary)
5787 @findex gnus-summary-yank-process-mark
5788 Pop the previous process mark set from the stack and restore it
5789 (@code{gnus-summary-yank-process-mark}).
5790
5791 @item M P w
5792 @kindex M P w (Summary)
5793 @findex gnus-summary-save-process-mark
5794 Push the current process mark set onto the stack
5795 (@code{gnus-summary-save-process-mark}).
5796
5797 @end table
5798
5799 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5800 set process marks based on article body contents.
5801
5802
5803 @node Limiting
5804 @section Limiting
5805 @cindex limiting
5806
5807 It can be convenient to limit the summary buffer to just show some
5808 subset of the articles currently in the group.  The effect most limit
5809 commands have is to remove a few (or many) articles from the summary
5810 buffer.
5811
5812 All limiting commands work on subsets of the articles already fetched
5813 from the servers.  None of these commands query the server for
5814 additional articles.
5815
5816 @table @kbd
5817
5818 @item / /
5819 @itemx / s
5820 @kindex / / (Summary)
5821 @findex gnus-summary-limit-to-subject
5822 Limit the summary buffer to articles that match some subject
5823 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
5824 matching articles.
5825
5826 @item / a
5827 @kindex / a (Summary)
5828 @findex gnus-summary-limit-to-author
5829 Limit the summary buffer to articles that match some author
5830 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
5831 matching articles.
5832
5833 @item / x
5834 @kindex / x (Summary)
5835 @findex gnus-summary-limit-to-extra
5836 Limit the summary buffer to articles that match one of the ``extra''
5837 headers (@pxref{To From Newsgroups})
5838 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
5839 matching articles.
5840
5841 @item / u
5842 @itemx x
5843 @kindex / u (Summary)
5844 @kindex x (Summary)
5845 @findex gnus-summary-limit-to-unread
5846 Limit the summary buffer to articles not marked as read
5847 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
5848 buffer to articles strictly unread.  This means that ticked and
5849 dormant articles will also be excluded.
5850
5851 @item / m
5852 @kindex / m (Summary)
5853 @findex gnus-summary-limit-to-marks
5854 Ask for a mark and then limit to all articles that have been marked
5855 with that mark (@code{gnus-summary-limit-to-marks}).
5856
5857 @item / t
5858 @kindex / t (Summary)
5859 @findex gnus-summary-limit-to-age
5860 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5861 (@code{gnus-summary-limit-to-age}).  If given a prefix, limit to
5862 articles younger than that number of days.
5863
5864 @item / n
5865 @kindex / n (Summary)
5866 @findex gnus-summary-limit-to-articles
5867 Limit the summary buffer to the current article
5868 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
5869 convention (@pxref{Process/Prefix}).
5870
5871 @item / w
5872 @kindex / w (Summary)
5873 @findex gnus-summary-pop-limit
5874 Pop the previous limit off the stack and restore it
5875 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
5876 the stack.
5877
5878 @item / v
5879 @kindex / v (Summary)
5880 @findex gnus-summary-limit-to-score
5881 Limit the summary buffer to articles that have a score at or above some
5882 score (@code{gnus-summary-limit-to-score}).
5883
5884 @item / p
5885 @kindex / p (Summary)
5886 @findex gnus-summary-limit-to-display-parameter
5887 Limit the summary buffer to articles that satisfy the @code{display}
5888 group parameter predicate
5889 (@code{gnus-summary-limit-to-display-parameter}).  See @pxref{Group
5890 Parameters} for more on this predicate.
5891
5892 @item / E
5893 @itemx M S
5894 @kindex M S (Summary)
5895 @kindex / E (Summary)
5896 @findex gnus-summary-limit-include-expunged
5897 Include all expunged articles in the limit
5898 (@code{gnus-summary-limit-include-expunged}).
5899
5900 @item / D
5901 @kindex / D (Summary)
5902 @findex gnus-summary-limit-include-dormant
5903 Include all dormant articles in the limit
5904 (@code{gnus-summary-limit-include-dormant}).
5905
5906 @item / *
5907 @kindex / * (Summary)
5908 @findex gnus-summary-limit-include-cached
5909 Include all cached articles in the limit
5910 (@code{gnus-summary-limit-include-cached}).
5911
5912 @item / d
5913 @kindex / d (Summary)
5914 @findex gnus-summary-limit-exclude-dormant
5915 Exclude all dormant articles from the limit
5916 (@code{gnus-summary-limit-exclude-dormant}).
5917
5918 @item / M
5919 @kindex / M (Summary)
5920 @findex gnus-summary-limit-exclude-marks
5921 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5922
5923 @item / T
5924 @kindex / T (Summary)
5925 @findex gnus-summary-limit-include-thread
5926 Include all the articles in the current thread in the limit.
5927
5928 @item / c
5929 @kindex / c (Summary)
5930 @findex gnus-summary-limit-exclude-childless-dormant
5931 Exclude all dormant articles that have no children from the limit
5932 (@code{gnus-summary-limit-exclude-childless-dormant}).
5933
5934 @item / C
5935 @kindex / C (Summary)
5936 @findex gnus-summary-limit-mark-excluded-as-read
5937 Mark all excluded unread articles as read
5938 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
5939 also mark excluded ticked and dormant articles as read.
5940
5941 @item / N
5942 @kindex / N (Summary)
5943 @findex gnus-summary-insert-new-articles
5944 Insert all new articles in the summary buffer. It scans for new emails
5945 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
5946
5947 @item / o
5948 @kindex / o (Summary)
5949 @findex gnus-summary-insert-old-articles
5950 Insert all old articles in the summary buffer. If given a numbered
5951 prefix, fetch this number of articles.  
5952
5953 @end table
5954
5955
5956 @node Threading
5957 @section Threading
5958 @cindex threading
5959 @cindex article threading
5960
5961 Gnus threads articles by default.  @dfn{To thread} is to put responses
5962 to articles directly after the articles they respond to---in a
5963 hierarchical fashion.
5964
5965 Threading is done by looking at the @code{References} headers of the
5966 articles.  In a perfect world, this would be enough to build pretty
5967 trees, but unfortunately, the @code{References} header is often broken
5968 or simply missing.  Weird news propagation exacerbates the problem,
5969 so one has to employ other heuristics to get pleasing results.  A
5970 plethora of approaches exists, as detailed in horrible detail in
5971 @pxref{Customizing Threading}.
5972
5973 First, a quick overview of the concepts:
5974
5975 @table @dfn
5976 @item root
5977 The top-most article in a thread; the first article in the thread.
5978
5979 @item thread
5980 A tree-like article structure.
5981
5982 @item sub-thread
5983 A small(er) section of this tree-like structure.
5984
5985 @item loose threads
5986 Threads often lose their roots due to article expiry, or due to the root
5987 already having been read in a previous session, and not displayed in the
5988 summary buffer.  We then typically have many sub-threads that really
5989 belong to one thread, but are without connecting roots.  These are
5990 called loose threads.
5991
5992 @item thread gathering
5993 An attempt to gather loose threads into bigger threads.
5994
5995 @item sparse threads
5996 A thread where the missing articles have been ``guessed'' at, and are
5997 displayed as empty lines in the summary buffer.
5998
5999 @end table
6000
6001
6002 @menu
6003 * Customizing Threading::       Variables you can change to affect the threading.
6004 * Thread Commands::             Thread based commands in the summary buffer.
6005 @end menu
6006
6007
6008 @node Customizing Threading
6009 @subsection Customizing Threading
6010 @cindex customizing threading
6011
6012 @menu
6013 * Loose Threads::               How Gnus gathers loose threads into bigger threads.
6014 * Filling In Threads::          Making the threads displayed look fuller.
6015 * More Threading::              Even more variables for fiddling with threads.
6016 * Low-Level Threading::         You thought it was over... but you were wrong!
6017 @end menu
6018
6019
6020 @node Loose Threads
6021 @subsubsection Loose Threads
6022 @cindex <
6023 @cindex >
6024 @cindex loose threads
6025
6026 @table @code
6027 @item gnus-summary-make-false-root
6028 @vindex gnus-summary-make-false-root
6029 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
6030 and create a dummy root at the top.  (Wait a minute.  Root at the top?
6031 Yup.)  Loose subtrees occur when the real root has expired, or you've
6032 read or killed the root in a previous session.
6033
6034 When there is no real root of a thread, gnus will have to fudge
6035 something.  This variable says what fudging method gnus should use.
6036 There are four possible values:
6037
6038 @iftex
6039 @iflatex
6040 \gnusfigure{The Summary Buffer}{390}{
6041 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6042 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6043 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6044 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6045 }
6046 @end iflatex
6047 @end iftex
6048
6049 @cindex adopting articles
6050
6051 @table @code
6052
6053 @item adopt
6054 Gnus will make the first of the orphaned articles the parent.  This
6055 parent will adopt all the other articles.  The adopted articles will be
6056 marked as such by pointy brackets (@samp{<>}) instead of the standard
6057 square brackets (@samp{[]}).  This is the default method.
6058
6059 @item dummy
6060 @vindex gnus-summary-dummy-line-format
6061 Gnus will create a dummy summary line that will pretend to be the
6062 parent.  This dummy line does not correspond to any real article, so
6063 selecting it will just select the first real article after the dummy
6064 article.  @code{gnus-summary-dummy-line-format} is used to specify the
6065 format of the dummy roots.  It accepts only one format spec:  @samp{S},
6066 which is the subject of the article.  @xref{Formatting Variables}.
6067
6068 @item empty
6069 Gnus won't actually make any article the parent, but simply leave the
6070 subject field of all orphans except the first empty.  (Actually, it will
6071 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6072 Buffer Format}).)
6073
6074 @item none
6075 Don't make any article parent at all.  Just gather the threads and
6076 display them after one another.
6077
6078 @item nil
6079 Don't gather loose threads.
6080 @end table
6081
6082 @item gnus-summary-gather-subject-limit
6083 @vindex gnus-summary-gather-subject-limit
6084 Loose threads are gathered by comparing subjects of articles.  If this
6085 variable is @code{nil}, gnus requires an exact match between the
6086 subjects of the loose threads before gathering them into one big
6087 super-thread.  This might be too strict a requirement, what with the
6088 presence of stupid newsreaders that chop off long subject lines.  If
6089 you think so, set this variable to, say, 20 to require that only the
6090 first 20 characters of the subjects have to match.  If you set this
6091 variable to a really low number, you'll find that gnus will gather
6092 everything in sight into one thread, which isn't very helpful.
6093
6094 @cindex fuzzy article gathering
6095 If you set this variable to the special value @code{fuzzy}, gnus will
6096 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6097 Matching}).
6098
6099 @item gnus-simplify-subject-fuzzy-regexp
6100 @vindex gnus-simplify-subject-fuzzy-regexp
6101 This can either be a regular expression or list of regular expressions
6102 that match strings that will be removed from subjects if fuzzy subject
6103 simplification is used.
6104
6105 @item gnus-simplify-ignored-prefixes
6106 @vindex gnus-simplify-ignored-prefixes
6107 If you set @code{gnus-summary-gather-subject-limit} to something as low
6108 as 10, you might consider setting this variable to something sensible:
6109
6110 @c Written by Michael Ernst <mernst@cs.rice.edu>
6111 @lisp
6112 (setq gnus-simplify-ignored-prefixes
6113       (concat
6114        "\\`\\[?\\("
6115        (mapconcat
6116         'identity
6117         '("looking"
6118           "wanted" "followup" "summary\\( of\\)?"
6119           "help" "query" "problem" "question"
6120           "answer" "reference" "announce"
6121           "How can I" "How to" "Comparison of"
6122           ;; ...
6123           )
6124         "\\|")
6125        "\\)\\s *\\("
6126        (mapconcat 'identity
6127                   '("for" "for reference" "with" "about")
6128                   "\\|")
6129        "\\)?\\]?:?[ \t]*"))
6130 @end lisp
6131
6132 All words that match this regexp will be removed before comparing two
6133 subjects.
6134
6135 @item gnus-simplify-subject-functions
6136 @vindex gnus-simplify-subject-functions
6137 If non-@code{nil}, this variable overrides
6138 @code{gnus-summary-gather-subject-limit}.  This variable should be a
6139 list of functions to apply to the @code{Subject} string iteratively to
6140 arrive at the simplified version of the string.
6141
6142 Useful functions to put in this list include:
6143
6144 @table @code
6145 @item gnus-simplify-subject-re
6146 @findex gnus-simplify-subject-re
6147 Strip the leading @samp{Re:}.
6148
6149 @item gnus-simplify-subject-fuzzy
6150 @findex gnus-simplify-subject-fuzzy
6151 Simplify fuzzily.
6152
6153 @item gnus-simplify-whitespace
6154 @findex gnus-simplify-whitespace
6155 Remove excessive whitespace.
6156 @end table
6157
6158 You may also write your own functions, of course.
6159
6160
6161 @item gnus-summary-gather-exclude-subject
6162 @vindex gnus-summary-gather-exclude-subject
6163 Since loose thread gathering is done on subjects only, that might lead
6164 to many false hits, especially with certain common subjects like
6165 @samp{} and @samp{(none)}.  To make the situation slightly better,
6166 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6167 what subjects should be excluded from the gathering process.@*
6168 The default is @samp{^ *$\\|^(none)$}.
6169
6170 @item gnus-summary-thread-gathering-function
6171 @vindex gnus-summary-thread-gathering-function
6172 Gnus gathers threads by looking at @code{Subject} headers.  This means
6173 that totally unrelated articles may end up in the same ``thread'', which
6174 is confusing.  An alternate approach is to look at all the
6175 @code{Message-ID}s in all the @code{References} headers to find matches.
6176 This will ensure that no gathered threads ever include unrelated
6177 articles, but it also means that people who have posted with broken
6178 newsreaders won't be gathered properly.  The choice is yours---plague or
6179 cholera:
6180
6181 @table @code
6182 @item gnus-gather-threads-by-subject
6183 @findex gnus-gather-threads-by-subject
6184 This function is the default gathering function and looks at
6185 @code{Subject}s exclusively.
6186
6187 @item gnus-gather-threads-by-references
6188 @findex gnus-gather-threads-by-references
6189 This function looks at @code{References} headers exclusively.
6190 @end table
6191
6192 If you want to test gathering by @code{References}, you could say
6193 something like:
6194
6195 @lisp
6196 (setq gnus-summary-thread-gathering-function
6197       'gnus-gather-threads-by-references)
6198 @end lisp
6199
6200 @end table
6201
6202
6203 @node Filling In Threads
6204 @subsubsection Filling In Threads
6205
6206 @table @code
6207 @item gnus-fetch-old-headers
6208 @vindex gnus-fetch-old-headers
6209 If non-@code{nil}, gnus will attempt to build old threads by fetching
6210 more old headers---headers to articles marked as read.  If you
6211 would like to display as few summary lines as possible, but still
6212 connect as many loose threads as possible, you should set this variable
6213 to @code{some} or a number.  If you set it to a number, no more than
6214 that number of extra old headers will be fetched.  In either case,
6215 fetching old headers only works if the back end you are using carries
6216 overview files---this would normally be @code{nntp}, @code{nnspool} and
6217 @code{nnml}.  Also remember that if the root of the thread has been
6218 expired by the server, there's not much gnus can do about that.
6219
6220 This variable can also be set to @code{invisible}.  This won't have any
6221 visible effects, but is useful if you use the @kbd{A T} command a lot
6222 (@pxref{Finding the Parent}).
6223
6224 @item gnus-build-sparse-threads
6225 @vindex gnus-build-sparse-threads
6226 Fetching old headers can be slow.  A low-rent similar effect can be
6227 gotten by setting this variable to @code{some}.  Gnus will then look at
6228 the complete @code{References} headers of all articles and try to string
6229 together articles that belong in the same thread.  This will leave
6230 @dfn{gaps} in the threading display where gnus guesses that an article
6231 is missing from the thread.  (These gaps appear like normal summary
6232 lines.  If you select a gap, gnus will try to fetch the article in
6233 question.)  If this variable is @code{t}, gnus will display all these
6234 ``gaps'' without regard for whether they are useful for completing the
6235 thread or not.  Finally, if this variable is @code{more}, gnus won't cut
6236 off sparse leaf nodes that don't lead anywhere.  This variable is
6237 @code{nil} by default.
6238
6239 @item gnus-read-all-available-headers
6240 @vindex gnus-read-all-available-headers
6241 This is a rather obscure variable that few will find useful.  It's
6242 intended for those non-news newsgroups where the back end has to fetch
6243 quite a lot to present the summary buffer, and where it's impossible to
6244 go back to parents of articles.  This is mostly the case in the
6245 web-based groups, like the @code{nnultimate} groups.
6246
6247 If you don't use those, then it's safe to leave this as the default
6248 @code{nil}.  If you want to use this variable, it should be a regexp
6249 that matches the group name, or @code{t} for all groups.
6250
6251 @end table
6252
6253
6254 @node More Threading
6255 @subsubsection More Threading
6256
6257 @table @code
6258 @item gnus-show-threads
6259 @vindex gnus-show-threads
6260 If this variable is @code{nil}, no threading will be done, and all of
6261 the rest of the variables here will have no effect.  Turning threading
6262 off will speed group selection up a bit, but it is sure to make reading
6263 slower and more awkward.
6264
6265 @item gnus-thread-hide-subtree
6266 @vindex gnus-thread-hide-subtree
6267 If non-@code{nil}, all threads will be hidden when the summary buffer is
6268 generated.
6269
6270 @item gnus-thread-expunge-below
6271 @vindex gnus-thread-expunge-below
6272 All threads that have a total score (as defined by
6273 @code{gnus-thread-score-function}) less than this number will be
6274 expunged.  This variable is @code{nil} by default, which means that no
6275 threads are expunged.
6276
6277 @item gnus-thread-hide-killed
6278 @vindex gnus-thread-hide-killed
6279 if you kill a thread and this variable is non-@code{nil}, the subtree
6280 will be hidden.
6281
6282 @item gnus-thread-ignore-subject
6283 @vindex gnus-thread-ignore-subject
6284 Sometimes somebody changes the subject in the middle of a thread.  If
6285 this variable is non-@code{nil}, which is the default, the subject
6286 change is ignored.  If it is @code{nil}, a change in the subject will
6287 result in a new thread.
6288
6289 @item gnus-thread-indent-level
6290 @vindex gnus-thread-indent-level
6291 This is a number that says how much each sub-thread should be indented.
6292 The default is 4.
6293
6294 @item gnus-sort-gathered-threads-function
6295 @vindex gnus-sort-gathered-threads-function
6296 Sometimes, particularly with mailing lists, the order in which mails
6297 arrive locally is not necessarily the same as the order in which they
6298 arrived on the mailing list.  Consequently, when sorting sub-threads
6299 using the default @code{gnus-thread-sort-by-number}, responses can end
6300 up appearing before the article to which they are responding to.
6301 Setting this variable to an alternate value
6302 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
6303 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
6304 more logical sub-thread ordering in such instances.
6305
6306 @end table
6307
6308
6309 @node Low-Level Threading
6310 @subsubsection Low-Level Threading
6311
6312 @table @code
6313
6314 @item gnus-parse-headers-hook
6315 @vindex gnus-parse-headers-hook
6316 Hook run before parsing any headers.  The default value is
6317 @code{(gnus-set-summary-default-charset)}, which sets up local value of
6318 @code{default-mime-charset} in summary buffer based on variable
6319 @code{gnus-newsgroup-default-charset-alist}.
6320
6321 @item gnus-alter-header-function
6322 @vindex gnus-alter-header-function
6323 If non-@code{nil}, this function will be called to allow alteration of
6324 article header structures.  The function is called with one parameter,
6325 the article header vector, which it may alter in any way.  For instance,
6326 if you have a mail-to-news gateway which alters the @code{Message-ID}s
6327 in systematic ways (by adding prefixes and such), you can use this
6328 variable to un-scramble the @code{Message-ID}s so that they are more
6329 meaningful.  Here's one example:
6330
6331 @lisp
6332 (setq gnus-alter-header-function 'my-alter-message-id)
6333
6334 (defun my-alter-message-id (header)
6335   (let ((id (mail-header-id header)))
6336     (when (string-match
6337            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
6338       (mail-header-set-id
6339        (concat (match-string 1 id) "@@" (match-string 2 id))
6340        header))))
6341 @end lisp
6342
6343 @end table
6344
6345
6346 @node Thread Commands
6347 @subsection Thread Commands
6348 @cindex thread commands
6349
6350 @table @kbd
6351
6352 @item T k
6353 @itemx C-M-k
6354 @kindex T k (Summary)
6355 @kindex C-M-k (Summary)
6356 @findex gnus-summary-kill-thread
6357 Mark all articles in the current (sub-)thread as read
6358 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
6359 remove all marks instead.  If the prefix argument is negative, tick
6360 articles instead.
6361
6362 @item T l
6363 @itemx C-M-l
6364 @kindex T l (Summary)
6365 @kindex C-M-l (Summary)
6366 @findex gnus-summary-lower-thread
6367 Lower the score of the current (sub-)thread
6368 (@code{gnus-summary-lower-thread}).
6369
6370 @item T i
6371 @kindex T i (Summary)
6372 @findex gnus-summary-raise-thread
6373 Increase the score of the current (sub-)thread
6374 (@code{gnus-summary-raise-thread}).
6375
6376 @item T #
6377 @kindex T # (Summary)
6378 @findex gnus-uu-mark-thread
6379 Set the process mark on the current (sub-)thread
6380 (@code{gnus-uu-mark-thread}).
6381
6382 @item T M-#
6383 @kindex T M-# (Summary)
6384 @findex gnus-uu-unmark-thread
6385 Remove the process mark from the current (sub-)thread
6386 (@code{gnus-uu-unmark-thread}).
6387
6388 @item T T
6389 @kindex T T (Summary)
6390 @findex gnus-summary-toggle-threads
6391 Toggle threading (@code{gnus-summary-toggle-threads}).
6392
6393 @item T s
6394 @kindex T s (Summary)
6395 @findex gnus-summary-show-thread
6396 Expose the (sub-)thread hidden under the current article, if any
6397 (@code{gnus-summary-show-thread}).
6398
6399 @item T h
6400 @kindex T h (Summary)
6401 @findex gnus-summary-hide-thread
6402 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
6403
6404 @item T S
6405 @kindex T S (Summary)
6406 @findex gnus-summary-show-all-threads
6407 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
6408
6409 @item T H
6410 @kindex T H (Summary)
6411 @findex gnus-summary-hide-all-threads
6412 Hide all threads (@code{gnus-summary-hide-all-threads}).
6413
6414 @item T t
6415 @kindex T t (Summary)
6416 @findex gnus-summary-rethread-current
6417 Re-thread the current article's thread
6418 (@code{gnus-summary-rethread-current}).  This works even when the
6419 summary buffer is otherwise unthreaded.
6420
6421 @item T ^
6422 @kindex T ^ (Summary)
6423 @findex gnus-summary-reparent-thread
6424 Make the current article the child of the marked (or previous) article
6425 (@code{gnus-summary-reparent-thread}).
6426
6427 @end table
6428
6429 The following commands are thread movement commands.  They all
6430 understand the numeric prefix.
6431
6432 @table @kbd
6433
6434 @item T n
6435 @kindex T n (Summary)
6436 @itemx C-M-n
6437 @kindex C-M-n (Summary)
6438 @itemx M-down
6439 @kindex M-down (Summary)
6440 @findex gnus-summary-next-thread
6441 Go to the next thread (@code{gnus-summary-next-thread}).
6442
6443 @item T p
6444 @kindex T p (Summary)
6445 @itemx C-M-p
6446 @kindex C-M-p (Summary)
6447 @itemx M-up
6448 @kindex M-up (Summary)
6449 @findex gnus-summary-prev-thread
6450 Go to the previous thread (@code{gnus-summary-prev-thread}).
6451
6452 @item T d
6453 @kindex T d (Summary)
6454 @findex gnus-summary-down-thread
6455 Descend the thread (@code{gnus-summary-down-thread}).
6456
6457 @item T u
6458 @kindex T u (Summary)
6459 @findex gnus-summary-up-thread
6460 Ascend the thread (@code{gnus-summary-up-thread}).
6461
6462 @item T o
6463 @kindex T o (Summary)
6464 @findex gnus-summary-top-thread
6465 Go to the top of the thread (@code{gnus-summary-top-thread}).
6466 @end table
6467
6468 @vindex gnus-thread-operation-ignore-subject
6469 If you ignore subject while threading, you'll naturally end up with
6470 threads that have several different subjects in them.  If you then issue
6471 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
6472 wish to kill the entire thread, but just those parts of the thread that
6473 have the same subject as the current article.  If you like this idea,
6474 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
6475 is non-@code{nil} (which it is by default), subjects will be ignored
6476 when doing thread commands.  If this variable is @code{nil}, articles in
6477 the same thread with different subjects will not be included in the
6478 operation in question.  If this variable is @code{fuzzy}, only articles
6479 that have subjects fuzzily equal will be included (@pxref{Fuzzy
6480 Matching}).
6481
6482
6483 @node Sorting the Summary Buffer
6484 @section Sorting the Summary Buffer
6485
6486 @findex gnus-thread-sort-by-total-score
6487 @findex gnus-thread-sort-by-date
6488 @findex gnus-thread-sort-by-score
6489 @findex gnus-thread-sort-by-subject
6490 @findex gnus-thread-sort-by-author
6491 @findex gnus-thread-sort-by-number
6492 @vindex gnus-thread-sort-functions
6493 If you are using a threaded summary display, you can sort the threads by
6494 setting @code{gnus-thread-sort-functions}, which can be either a single
6495 function, a list of functions, or a list containing functions and
6496 @code{(not some-function)} elements.
6497
6498 By default, sorting is done on article numbers.  Ready-made sorting
6499 predicate functions include @code{gnus-thread-sort-by-number},
6500 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
6501 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
6502 @code{gnus-thread-sort-by-total-score}.
6503
6504 Each function takes two threads and returns non-@code{nil} if the first
6505 thread should be sorted before the other.  Note that sorting really is
6506 normally done by looking only at the roots of each thread.
6507
6508 If you use more than one function, the primary sort key should be the
6509 last function in the list.  You should probably always include
6510 @code{gnus-thread-sort-by-number} in the list of sorting
6511 functions---preferably first.  This will ensure that threads that are
6512 equal with respect to the other sort criteria will be displayed in
6513 ascending article order.
6514
6515 If you would like to sort by reverse score, then by subject, and finally
6516 by number, you could do something like:
6517
6518 @lisp
6519 (setq gnus-thread-sort-functions
6520       '(gnus-thread-sort-by-number
6521         gnus-thread-sort-by-subject
6522         (not gnus-thread-sort-by-total-score)))
6523 @end lisp
6524
6525 The threads that have highest score will be displayed first in the
6526 summary buffer.  When threads have the same score, they will be sorted
6527 alphabetically.  The threads that have the same score and the same
6528 subject will be sorted by number, which is (normally) the sequence in
6529 which the articles arrived.
6530
6531 If you want to sort by score and then reverse arrival order, you could
6532 say something like:
6533
6534 @lisp
6535 (setq gnus-thread-sort-functions
6536       '((lambda (t1 t2)
6537           (not (gnus-thread-sort-by-number t1 t2)))
6538         gnus-thread-sort-by-score))
6539 @end lisp
6540
6541 @vindex gnus-thread-score-function
6542 The function in the @code{gnus-thread-score-function} variable (default
6543 @code{+}) is used for calculating the total score of a thread.  Useful
6544 functions might be @code{max}, @code{min}, or squared means, or whatever
6545 tickles your fancy.
6546
6547 @findex gnus-article-sort-functions
6548 @findex gnus-article-sort-by-date
6549 @findex gnus-article-sort-by-score
6550 @findex gnus-article-sort-by-subject
6551 @findex gnus-article-sort-by-author
6552 @findex gnus-article-sort-by-number
6553 If you are using an unthreaded display for some strange reason or other,
6554 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6555 It is very similar to the @code{gnus-thread-sort-functions}, except that
6556 it uses slightly different functions for article comparison.  Available
6557 sorting predicate functions are @code{gnus-article-sort-by-number},
6558 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6559 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6560
6561 If you want to sort an unthreaded summary display by subject, you could
6562 say something like:
6563
6564 @lisp
6565 (setq gnus-article-sort-functions
6566       '(gnus-article-sort-by-number
6567         gnus-article-sort-by-subject))
6568 @end lisp
6569
6570
6571
6572 @node Asynchronous Fetching
6573 @section Asynchronous Article Fetching
6574 @cindex asynchronous article fetching
6575 @cindex article pre-fetch
6576 @cindex pre-fetch
6577
6578 If you read your news from an @sc{nntp} server that's far away, the
6579 network latencies may make reading articles a chore.  You have to wait
6580 for a while after pressing @kbd{n} to go to the next article before the
6581 article appears.  Why can't gnus just go ahead and fetch the article
6582 while you are reading the previous one?  Why not, indeed.
6583
6584 First, some caveats.  There are some pitfalls to using asynchronous
6585 article fetching, especially the way gnus does it.
6586
6587 Let's say you are reading article 1, which is short, and article 2 is
6588 quite long, and you are not interested in reading that.  Gnus does not
6589 know this, so it goes ahead and fetches article 2.  You decide to read
6590 article 3, but since gnus is in the process of fetching article 2, the
6591 connection is blocked.
6592
6593 To avoid these situations, gnus will open two (count 'em two)
6594 connections to the server.  Some people may think this isn't a very nice
6595 thing to do, but I don't see any real alternatives.  Setting up that
6596 extra connection takes some time, so gnus startup will be slower.
6597
6598 Gnus will fetch more articles than you will read.  This will mean that
6599 the link between your machine and the @sc{nntp} server will become more
6600 loaded than if you didn't use article pre-fetch.  The server itself will
6601 also become more loaded---both with the extra article requests, and the
6602 extra connection.
6603
6604 Ok, so now you know that you shouldn't really use this thing...  unless
6605 you really want to.
6606
6607 @vindex gnus-asynchronous
6608 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
6609 happen automatically.
6610
6611 @vindex gnus-use-article-prefetch
6612 You can control how many articles are to be pre-fetched by setting
6613 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
6614 that when you read an article in the group, the back end will pre-fetch
6615 the next 30 articles.  If this variable is @code{t}, the back end will
6616 pre-fetch all the articles it can without bound.  If it is
6617 @code{nil}, no pre-fetching will be done.
6618
6619 @vindex gnus-async-prefetch-article-p
6620 @findex gnus-async-read-p
6621 There are probably some articles that you don't want to pre-fetch---read
6622 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
6623 return non-@code{nil} when the article in question is to be
6624 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
6625 @code{nil} on read articles.  The function is called with an article
6626 data structure as the only parameter.
6627
6628 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6629
6630 @lisp
6631 (defun my-async-short-unread-p (data)
6632   "Return non-nil for short, unread articles."
6633   (and (gnus-data-unread-p data)
6634        (< (mail-header-lines (gnus-data-header data))
6635           100)))
6636
6637 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6638 @end lisp
6639
6640 These functions will be called many, many times, so they should
6641 preferably be short and sweet to avoid slowing down gnus too much.
6642 It's probably a good idea to byte-compile things like this.
6643
6644 @vindex gnus-prefetched-article-deletion-strategy
6645 Articles have to be removed from the asynch buffer sooner or later.  The
6646 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6647 articles.  This is a list that may contain the following elements:
6648
6649 @table @code
6650 @item read
6651 Remove articles when they are read.
6652
6653 @item exit
6654 Remove articles when exiting the group.
6655 @end table
6656
6657 The default value is @code{(read exit)}.
6658
6659 @c @vindex gnus-use-header-prefetch
6660 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6661 @c from the next group.
6662
6663
6664 @node Article Caching
6665 @section Article Caching
6666 @cindex article caching
6667 @cindex caching
6668
6669 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6670 consider turning article caching on.  Each article will then be stored
6671 locally under your home directory.  As you may surmise, this could
6672 potentially use @emph{huge} amounts of disk space, as well as eat up all
6673 your inodes so fast it will make your head swim.  In vodka.
6674
6675 Used carefully, though, it could be just an easier way to save articles.
6676
6677 @vindex gnus-use-long-file-name
6678 @vindex gnus-cache-directory
6679 @vindex gnus-use-cache
6680 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
6681 all articles ticked or marked as dormant will then be copied
6682 over to your local cache (@code{gnus-cache-directory}).  Whether this
6683 cache is flat or hierarchical is controlled by the
6684 @code{gnus-use-long-file-name} variable, as usual.
6685
6686 When re-selecting a ticked or dormant article, it will be fetched from the
6687 cache instead of from the server.  As articles in your cache will never
6688 expire, this might serve as a method of saving articles while still
6689 keeping them where they belong.  Just mark all articles you want to save
6690 as dormant, and don't worry.
6691
6692 When an article is marked as read, is it removed from the cache.
6693
6694 @vindex gnus-cache-remove-articles
6695 @vindex gnus-cache-enter-articles
6696 The entering/removal of articles from the cache is controlled by the
6697 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6698 variables.  Both are lists of symbols.  The first is @code{(ticked
6699 dormant)} by default, meaning that ticked and dormant articles will be
6700 put in the cache.  The latter is @code{(read)} by default, meaning that
6701 articles marked as read are removed from the cache.  Possibly
6702 symbols in these two lists are @code{ticked}, @code{dormant},
6703 @code{unread} and @code{read}.
6704
6705 @findex gnus-jog-cache
6706 So where does the massive article-fetching and storing come into the
6707 picture?  The @code{gnus-jog-cache} command will go through all
6708 subscribed newsgroups, request all unread articles, score them, and
6709 store them in the cache.  You should only ever, ever ever ever, use this
6710 command if 1) your connection to the @sc{nntp} server is really, really,
6711 really slow and 2) you have a really, really, really huge disk.
6712 Seriously.  One way to cut down on the number of articles downloaded is
6713 to score unwanted articles down and have them marked as read.  They will
6714 not then be downloaded by this command.
6715
6716 @vindex gnus-uncacheable-groups
6717 @vindex gnus-cacheable-groups
6718 It is likely that you do not want caching on all groups.  For instance,
6719 if your @code{nnml} mail is located under your home directory, it makes no
6720 sense to cache it somewhere else under your home directory.  Unless you
6721 feel that it's neat to use twice as much space.
6722
6723 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6724 regexp of groups to cache, @samp{^nntp} for instance, or set the
6725 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6726 Both variables are @code{nil} by default.  If a group matches both
6727 variables, the group is not cached.
6728
6729 @findex gnus-cache-generate-nov-databases
6730 @findex gnus-cache-generate-active
6731 @vindex gnus-cache-active-file
6732 The cache stores information on what articles it contains in its active
6733 file (@code{gnus-cache-active-file}).  If this file (or any other parts
6734 of the cache) becomes all messed up for some reason or other, gnus
6735 offers two functions that will try to set things right.  @kbd{M-x
6736 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6737 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6738 file.
6739
6740
6741 @node Persistent Articles
6742 @section Persistent Articles
6743 @cindex persistent articles
6744
6745 Closely related to article caching, we have @dfn{persistent articles}.
6746 In fact, it's just a different way of looking at caching, and much more
6747 useful in my opinion.
6748
6749 Say you're reading a newsgroup, and you happen on to some valuable gem
6750 that you want to keep and treasure forever.  You'd normally just save it
6751 (using one of the many saving commands) in some file.  The problem with
6752 that is that it's just, well, yucky.  Ideally you'd prefer just having
6753 the article remain in the group where you found it forever; untouched by
6754 the expiry going on at the news server.
6755
6756 This is what a @dfn{persistent article} is---an article that just won't
6757 be deleted.  It's implemented using the normal cache functions, but
6758 you use two explicit commands for managing persistent articles:
6759
6760 @table @kbd
6761
6762 @item *
6763 @kindex * (Summary)
6764 @findex gnus-cache-enter-article
6765 Make the current article persistent (@code{gnus-cache-enter-article}).
6766
6767 @item M-*
6768 @kindex M-* (Summary)
6769 @findex gnus-cache-remove-article
6770 Remove the current article from the persistent articles
6771 (@code{gnus-cache-remove-article}).  This will normally delete the
6772 article.
6773 @end table
6774
6775 Both these commands understand the process/prefix convention.
6776
6777 To avoid having all ticked articles (and stuff) entered into the cache,
6778 you should set @code{gnus-use-cache} to @code{passive} if you're just
6779 interested in persistent articles:
6780
6781 @lisp
6782 (setq gnus-use-cache 'passive)
6783 @end lisp
6784
6785
6786 @node Article Backlog
6787 @section Article Backlog
6788 @cindex backlog
6789 @cindex article backlog
6790
6791 If you have a slow connection, but the idea of using caching seems
6792 unappealing to you (and it is, really), you can help the situation some
6793 by switching on the @dfn{backlog}.  This is where gnus will buffer
6794 already read articles so that it doesn't have to re-fetch articles
6795 you've already read.  This only helps if you are in the habit of
6796 re-selecting articles you've recently read, of course.  If you never do
6797 that, turning the backlog on will slow gnus down a little bit, and
6798 increase memory usage some.
6799
6800 @vindex gnus-keep-backlog
6801 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
6802 at most @var{n} old articles in a buffer for later re-fetching.  If this
6803 variable is non-@code{nil} and is not a number, gnus will store
6804 @emph{all} read articles, which means that your Emacs will grow without
6805 bound before exploding and taking your machine down with you.  I put
6806 that in there just to keep y'all on your toes.
6807
6808 This variable is @code{nil} by default.
6809
6810
6811 @node Saving Articles
6812 @section Saving Articles
6813 @cindex saving articles
6814
6815 Gnus can save articles in a number of ways.  Below is the documentation
6816 for saving articles in a fairly straight-forward fashion (i.e., little
6817 processing of the article is done before it is saved).  For a different
6818 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6819 (@pxref{Decoding Articles}).
6820
6821 @vindex gnus-save-all-headers
6822 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
6823 unwanted headers before saving the article.
6824
6825 @vindex gnus-saved-headers
6826 If the preceding variable is @code{nil}, all headers that match the
6827 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6828 deleted before saving.
6829
6830 @table @kbd
6831
6832 @item O o
6833 @itemx o
6834 @kindex O o (Summary)
6835 @kindex o (Summary)
6836 @findex gnus-summary-save-article
6837 @c @icon{gnus-summary-save-article}
6838 Save the current article using the default article saver
6839 (@code{gnus-summary-save-article}).
6840
6841 @item O m
6842 @kindex O m (Summary)
6843 @findex gnus-summary-save-article-mail
6844 Save the current article in mail format
6845 (@code{gnus-summary-save-article-mail}).
6846
6847 @item O r
6848 @kindex O r (Summary)
6849 @findex gnus-summary-save-article-rmail
6850 Save the current article in rmail format
6851 (@code{gnus-summary-save-article-rmail}).
6852
6853 @item O f
6854 @kindex O f (Summary)
6855 @findex gnus-summary-save-article-file
6856 @c @icon{gnus-summary-save-article-file}
6857 Save the current article in plain file format
6858 (@code{gnus-summary-save-article-file}).
6859
6860 @item O F
6861 @kindex O F (Summary)
6862 @findex gnus-summary-write-article-file
6863 Write the current article in plain file format, overwriting any previous
6864 file contents (@code{gnus-summary-write-article-file}).
6865
6866 @item O b
6867 @kindex O b (Summary)
6868 @findex gnus-summary-save-article-body-file
6869 Save the current article body in plain file format
6870 (@code{gnus-summary-save-article-body-file}).
6871
6872 @item O h
6873 @kindex O h (Summary)
6874 @findex gnus-summary-save-article-folder
6875 Save the current article in mh folder format
6876 (@code{gnus-summary-save-article-folder}).
6877
6878 @item O v
6879 @kindex O v (Summary)
6880 @findex gnus-summary-save-article-vm
6881 Save the current article in a VM folder
6882 (@code{gnus-summary-save-article-vm}).
6883
6884 @item O p
6885 @itemx |
6886 @kindex O p (Summary)
6887 @kindex | (Summary)
6888 @findex gnus-summary-pipe-output
6889 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
6890 the current article to a process (@code{gnus-summary-pipe-output}).
6891 @end table
6892
6893 @vindex gnus-prompt-before-saving
6894 All these commands use the process/prefix convention
6895 (@pxref{Process/Prefix}).  If you save bunches of articles using these
6896 functions, you might get tired of being prompted for files to save each
6897 and every article in.  The prompting action is controlled by
6898 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6899 default, giving you that excessive prompting action you know and
6900 loathe.  If you set this variable to @code{t} instead, you'll be prompted
6901 just once for each series of articles you save.  If you like to really
6902 have Gnus do all your thinking for you, you can even set this variable
6903 to @code{nil}, which means that you will never be prompted for files to
6904 save articles in.  Gnus will simply save all the articles in the default
6905 files.
6906
6907
6908 @vindex gnus-default-article-saver
6909 You can customize the @code{gnus-default-article-saver} variable to make
6910 gnus do what you want it to.  You can use any of the six ready-made
6911 functions below, or you can create your own.
6912
6913 @table @code
6914
6915 @item gnus-summary-save-in-rmail
6916 @findex gnus-summary-save-in-rmail
6917 @vindex gnus-rmail-save-name
6918 @findex gnus-plain-save-name
6919 This is the default format, @dfn{babyl}.  Uses the function in the
6920 @code{gnus-rmail-save-name} variable to get a file name to save the
6921 article in.  The default is @code{gnus-plain-save-name}.
6922
6923 @item gnus-summary-save-in-mail
6924 @findex gnus-summary-save-in-mail
6925 @vindex gnus-mail-save-name
6926 Save in a Unix mail (mbox) file.  Uses the function in the
6927 @code{gnus-mail-save-name} variable to get a file name to save the
6928 article in.  The default is @code{gnus-plain-save-name}.
6929
6930 @item gnus-summary-save-in-file
6931 @findex gnus-summary-save-in-file
6932 @vindex gnus-file-save-name
6933 @findex gnus-numeric-save-name
6934 Append the article straight to an ordinary file.  Uses the function in
6935 the @code{gnus-file-save-name} variable to get a file name to save the
6936 article in.  The default is @code{gnus-numeric-save-name}.
6937
6938 @item gnus-summary-write-to-file
6939 @findex gnus-summary-write-to-file
6940 Write the article straight to an ordinary file.  The file is
6941 overwritten if it exists.  Uses the function in the
6942 @code{gnus-file-save-name} variable to get a file name to save the
6943 article in.  The default is @code{gnus-numeric-save-name}.
6944
6945 @item gnus-summary-save-body-in-file
6946 @findex gnus-summary-save-body-in-file
6947 Append the article body to an ordinary file.  Uses the function in the
6948 @code{gnus-file-save-name} variable to get a file name to save the
6949 article in.  The default is @code{gnus-numeric-save-name}.
6950
6951 @item gnus-summary-save-in-folder
6952 @findex gnus-summary-save-in-folder
6953 @findex gnus-folder-save-name
6954 @findex gnus-Folder-save-name
6955 @vindex gnus-folder-save-name
6956 @cindex rcvstore
6957 @cindex MH folders
6958 Save the article to an MH folder using @code{rcvstore} from the MH
6959 library.  Uses the function in the @code{gnus-folder-save-name} variable
6960 to get a file name to save the article in.  The default is
6961 @code{gnus-folder-save-name}, but you can also use
6962 @code{gnus-Folder-save-name}, which creates capitalized names.
6963
6964 @item gnus-summary-save-in-vm
6965 @findex gnus-summary-save-in-vm
6966 Save the article in a VM folder.  You have to have the VM mail
6967 reader to use this setting.
6968 @end table
6969
6970 @vindex gnus-article-save-directory
6971 All of these functions, except for the last one, will save the article
6972 in the @code{gnus-article-save-directory}, which is initialized from the
6973 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
6974 default.
6975
6976 As you can see above, the functions use different functions to find a
6977 suitable name of a file to save the article in.  Below is a list of
6978 available functions that generate names:
6979
6980 @table @code
6981
6982 @item gnus-Numeric-save-name
6983 @findex gnus-Numeric-save-name
6984 File names like @file{~/News/Alt.andrea-dworkin/45}.
6985
6986 @item gnus-numeric-save-name
6987 @findex gnus-numeric-save-name
6988 File names like @file{~/News/alt.andrea-dworkin/45}.
6989
6990 @item gnus-Plain-save-name
6991 @findex gnus-Plain-save-name
6992 File names like @file{~/News/Alt.andrea-dworkin}.
6993
6994 @item gnus-plain-save-name
6995 @findex gnus-plain-save-name
6996 File names like @file{~/News/alt.andrea-dworkin}.
6997
6998 @item gnus-sender-save-name
6999 @findex gnus-sender-save-name
7000 File names like @file{~/News/larsi}.
7001 @end table
7002
7003 @vindex gnus-split-methods
7004 You can have gnus suggest where to save articles by plonking a regexp into
7005 the @code{gnus-split-methods} alist.  For instance, if you would like to
7006 save articles related to gnus in the file @file{gnus-stuff}, and articles
7007 related to VM in @code{vm-stuff}, you could set this variable to something
7008 like:
7009
7010 @lisp
7011 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7012  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7013  (my-choosing-function "../other-dir/my-stuff")
7014  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7015 @end lisp
7016
7017 We see that this is a list where each element is a list that has two
7018 elements---the @dfn{match} and the @dfn{file}.  The match can either be
7019 a string (in which case it is used as a regexp to match on the article
7020 head); it can be a symbol (which will be called as a function with the
7021 group name as a parameter); or it can be a list (which will be
7022 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
7023 the @dfn{file} will be used as a default prompt.  In addition, the
7024 result of the operation itself will be used if the function or form
7025 called returns a string or a list of strings.
7026
7027 You basically end up with a list of file names that might be used when
7028 saving the current article.  (All ``matches'' will be used.)  You will
7029 then be prompted for what you really want to use as a name, with file
7030 name completion over the results from applying this variable.
7031
7032 This variable is @code{((gnus-article-archive-name))} by default, which
7033 means that gnus will look at the articles it saves for an
7034 @code{Archive-name} line and use that as a suggestion for the file
7035 name.
7036
7037 Here's an example function to clean up file names somewhat.  If you have
7038 lots of mail groups called things like
7039 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7040 these group names before creating the file name to save to.  The
7041 following will do just that:
7042
7043 @lisp
7044 (defun my-save-name (group)
7045   (when (string-match "^nnml:mail." group)
7046     (substring group (match-end 0))))
7047
7048 (setq gnus-split-methods
7049       '((gnus-article-archive-name)
7050         (my-save-name)))
7051 @end lisp
7052
7053
7054 @vindex gnus-use-long-file-name
7055 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
7056 @code{nil}, all the preceding functions will replace all periods
7057 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7058 the functions will generate hierarchies of directories instead of having
7059 all the files in the top level directory
7060 (@file{~/News/alt/andrea-dworkin} instead of
7061 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
7062 on most systems.  However, for historical reasons, this is @code{nil} on
7063 Xenix and usg-unix-v machines by default.
7064
7065 This function also affects kill and score file names.  If this variable
7066 is a list, and the list contains the element @code{not-score}, long file
7067 names will not be used for score files, if it contains the element
7068 @code{not-save}, long file names will not be used for saving, and if it
7069 contains the element @code{not-kill}, long file names will not be used
7070 for kill files.
7071
7072 If you'd like to save articles in a hierarchy that looks something like
7073 a spool, you could
7074
7075 @lisp
7076 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
7077 (setq gnus-default-article-saver
7078       'gnus-summary-save-in-file) ; no encoding
7079 @end lisp
7080
7081 Then just save with @kbd{o}.  You'd then read this hierarchy with
7082 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
7083 the top level directory as the argument (@file{~/News/}).  Then just walk
7084 around to the groups/directories with @code{nneething}.
7085
7086
7087 @node Decoding Articles
7088 @section Decoding Articles
7089 @cindex decoding articles
7090
7091 Sometime users post articles (or series of articles) that have been
7092 encoded in some way or other.  Gnus can decode them for you.
7093
7094 @menu
7095 * Uuencoded Articles::          Uudecode articles.
7096 * Shell Archives::              Unshar articles.
7097 * PostScript Files::            Split PostScript.
7098 * Other Files::                 Plain save and binhex.
7099 * Decoding Variables::          Variables for a happy decoding.
7100 * Viewing Files::               You want to look at the result of the decoding?
7101 @end menu
7102
7103 @cindex series
7104 @cindex article series
7105 All these functions use the process/prefix convention
7106 (@pxref{Process/Prefix}) for finding out what articles to work on, with
7107 the extension that a ``single article'' means ``a single series''.  Gnus
7108 can find out by itself what articles belong to a series, decode all the
7109 articles and unpack/view/save the resulting file(s).
7110
7111 Gnus guesses what articles are in the series according to the following
7112 simplish rule: The subjects must be (nearly) identical, except for the
7113 last two numbers of the line.  (Spaces are largely ignored, however.)
7114
7115 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
7116 will find all the articles that match the regexp @samp{^cat.gif
7117 ([0-9]+/[0-9]+).*$}.
7118
7119 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
7120 series}, will not be properly recognized by any of the automatic viewing
7121 commands, and you have to mark the articles manually with @kbd{#}.
7122
7123
7124 @node Uuencoded Articles
7125 @subsection Uuencoded Articles
7126 @cindex uudecode
7127 @cindex uuencoded articles
7128
7129 @table @kbd
7130
7131 @item X u
7132 @kindex X u (Summary)
7133 @findex gnus-uu-decode-uu
7134 @c @icon{gnus-uu-decode-uu}
7135 Uudecodes the current series (@code{gnus-uu-decode-uu}).
7136
7137 @item X U
7138 @kindex X U (Summary)
7139 @findex gnus-uu-decode-uu-and-save
7140 Uudecodes and saves the current series
7141 (@code{gnus-uu-decode-uu-and-save}).
7142
7143 @item X v u
7144 @kindex X v u (Summary)
7145 @findex gnus-uu-decode-uu-view
7146 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
7147
7148 @item X v U
7149 @kindex X v U (Summary)
7150 @findex gnus-uu-decode-uu-and-save-view
7151 Uudecodes, views and saves the current series
7152 (@code{gnus-uu-decode-uu-and-save-view}).
7153
7154 @end table
7155
7156 Remember that these all react to the presence of articles marked with
7157 the process mark.  If, for instance, you'd like to decode and save an
7158 entire newsgroup, you'd typically do @kbd{M P a}
7159 (@code{gnus-uu-mark-all}) and then @kbd{X U}
7160 (@code{gnus-uu-decode-uu-and-save}).
7161
7162 All this is very much different from how @code{gnus-uu} worked with
7163 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
7164 the sun.  This version of @code{gnus-uu} generally assumes that you mark
7165 articles in some way (@pxref{Setting Process Marks}) and then press
7166 @kbd{X u}.
7167
7168 @vindex gnus-uu-notify-files
7169 Note: When trying to decode articles that have names matching
7170 @code{gnus-uu-notify-files}, which is hard-coded to
7171 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
7172 automatically post an article on @samp{comp.unix.wizards} saying that
7173 you have just viewed the file in question.  This feature can't be turned
7174 off.
7175
7176
7177 @node Shell Archives
7178 @subsection Shell Archives
7179 @cindex unshar
7180 @cindex shell archives
7181 @cindex shared articles
7182
7183 Shell archives (``shar files'') used to be a popular way to distribute
7184 sources, but it isn't used all that much today.  In any case, we have
7185 some commands to deal with these:
7186
7187 @table @kbd
7188
7189 @item X s
7190 @kindex X s (Summary)
7191 @findex gnus-uu-decode-unshar
7192 Unshars the current series (@code{gnus-uu-decode-unshar}).
7193
7194 @item X S
7195 @kindex X S (Summary)
7196 @findex gnus-uu-decode-unshar-and-save
7197 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
7198
7199 @item X v s
7200 @kindex X v s (Summary)
7201 @findex gnus-uu-decode-unshar-view
7202 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
7203
7204 @item X v S
7205 @kindex X v S (Summary)
7206 @findex gnus-uu-decode-unshar-and-save-view
7207 Unshars, views and saves the current series
7208 (@code{gnus-uu-decode-unshar-and-save-view}).
7209 @end table
7210
7211
7212 @node PostScript Files
7213 @subsection PostScript Files
7214 @cindex PostScript
7215
7216 @table @kbd
7217
7218 @item X p
7219 @kindex X p (Summary)
7220 @findex gnus-uu-decode-postscript
7221 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
7222
7223 @item X P
7224 @kindex X P (Summary)
7225 @findex gnus-uu-decode-postscript-and-save
7226 Unpack and save the current PostScript series
7227 (@code{gnus-uu-decode-postscript-and-save}).
7228
7229 @item X v p
7230 @kindex X v p (Summary)
7231 @findex gnus-uu-decode-postscript-view
7232 View the current PostScript series
7233 (@code{gnus-uu-decode-postscript-view}).
7234
7235 @item X v P
7236 @kindex X v P (Summary)
7237 @findex gnus-uu-decode-postscript-and-save-view
7238 View and save the current PostScript series
7239 (@code{gnus-uu-decode-postscript-and-save-view}).
7240 @end table
7241
7242
7243 @node Other Files
7244 @subsection Other Files
7245
7246 @table @kbd
7247 @item X o
7248 @kindex X o (Summary)
7249 @findex gnus-uu-decode-save
7250 Save the current series
7251 (@code{gnus-uu-decode-save}).
7252
7253 @item X b
7254 @kindex X b (Summary)
7255 @findex gnus-uu-decode-binhex
7256 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
7257 doesn't really work yet.
7258 @end table
7259
7260
7261 @node Decoding Variables
7262 @subsection Decoding Variables
7263
7264 Adjective, not verb.
7265
7266 @menu
7267 * Rule Variables::              Variables that say how a file is to be viewed.
7268 * Other Decode Variables::      Other decode variables.
7269 * Uuencoding and Posting::      Variables for customizing uuencoding.
7270 @end menu
7271
7272
7273 @node Rule Variables
7274 @subsubsection Rule Variables
7275 @cindex rule variables
7276
7277 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
7278 variables are of the form
7279
7280 @lisp
7281       (list '(regexp1 command2)
7282             '(regexp2 command2)
7283             ...)
7284 @end lisp
7285
7286 @table @code
7287
7288 @item gnus-uu-user-view-rules
7289 @vindex gnus-uu-user-view-rules
7290 @cindex sox
7291 This variable is consulted first when viewing files.  If you wish to use,
7292 for instance, @code{sox} to convert an @samp{.au} sound file, you could
7293 say something like:
7294 @lisp
7295 (setq gnus-uu-user-view-rules
7296       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
7297 @end lisp
7298
7299 @item gnus-uu-user-view-rules-end
7300 @vindex gnus-uu-user-view-rules-end
7301 This variable is consulted if gnus couldn't make any matches from the
7302 user and default view rules.
7303
7304 @item gnus-uu-user-archive-rules
7305 @vindex gnus-uu-user-archive-rules
7306 This variable can be used to say what commands should be used to unpack
7307 archives.
7308 @end table
7309
7310
7311 @node Other Decode Variables
7312 @subsubsection Other Decode Variables
7313
7314 @table @code
7315 @vindex gnus-uu-grabbed-file-functions
7316
7317 @item gnus-uu-grabbed-file-functions
7318 All functions in this list will be called right after each file has been
7319 successfully decoded---so that you can move or view files right away,
7320 and don't have to wait for all files to be decoded before you can do
7321 anything.  Ready-made functions you can put in this list are:
7322
7323 @table @code
7324
7325 @item gnus-uu-grab-view
7326 @findex gnus-uu-grab-view
7327 View the file.
7328
7329 @item gnus-uu-grab-move
7330 @findex gnus-uu-grab-move
7331 Move the file (if you're using a saving function.)
7332 @end table
7333
7334 @item gnus-uu-be-dangerous
7335 @vindex gnus-uu-be-dangerous
7336 Specifies what to do if unusual situations arise during decoding.  If
7337 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
7338 that didn't work, and overwrite existing files.  Otherwise, ask each
7339 time.
7340
7341 @item gnus-uu-ignore-files-by-name
7342 @vindex gnus-uu-ignore-files-by-name
7343 Files with name matching this regular expression won't be viewed.
7344
7345 @item gnus-uu-ignore-files-by-type
7346 @vindex gnus-uu-ignore-files-by-type
7347 Files with a @sc{mime} type matching this variable won't be viewed.
7348 Note that Gnus tries to guess what type the file is based on the name.
7349 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
7350 kludgey.
7351
7352 @item gnus-uu-tmp-dir
7353 @vindex gnus-uu-tmp-dir
7354 Where @code{gnus-uu} does its work.
7355
7356 @item gnus-uu-do-not-unpack-archives
7357 @vindex gnus-uu-do-not-unpack-archives
7358 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
7359 looking for files to display.
7360
7361 @item gnus-uu-view-and-save
7362 @vindex gnus-uu-view-and-save
7363 Non-@code{nil} means that the user will always be asked to save a file
7364 after viewing it.
7365
7366 @item gnus-uu-ignore-default-view-rules
7367 @vindex gnus-uu-ignore-default-view-rules
7368 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
7369 rules.
7370
7371 @item gnus-uu-ignore-default-archive-rules
7372 @vindex gnus-uu-ignore-default-archive-rules
7373 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
7374 unpacking commands.
7375
7376 @item gnus-uu-kill-carriage-return
7377 @vindex gnus-uu-kill-carriage-return
7378 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
7379 from articles.
7380
7381 @item gnus-uu-unmark-articles-not-decoded
7382 @vindex gnus-uu-unmark-articles-not-decoded
7383 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
7384 decoded articles as unread.
7385
7386 @item gnus-uu-correct-stripped-uucode
7387 @vindex gnus-uu-correct-stripped-uucode
7388 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
7389 uuencoded files that have had trailing spaces deleted.
7390
7391 @item gnus-uu-pre-uudecode-hook
7392 @vindex gnus-uu-pre-uudecode-hook
7393 Hook run before sending a message to @code{uudecode}.
7394
7395 @item gnus-uu-view-with-metamail
7396 @vindex gnus-uu-view-with-metamail
7397 @cindex metamail
7398 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
7399 commands defined by the rule variables and just fudge a @sc{mime}
7400 content type based on the file name.  The result will be fed to
7401 @code{metamail} for viewing.
7402
7403 @item gnus-uu-save-in-digest
7404 @vindex gnus-uu-save-in-digest
7405 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
7406 decoding, will save in digests.  If this variable is @code{nil},
7407 @code{gnus-uu} will just save everything in a file without any
7408 embellishments.  The digesting almost conforms to RFC 1153---no easy way
7409 to specify any meaningful volume and issue numbers were found, so I
7410 simply dropped them.
7411
7412 @end table
7413
7414
7415 @node Uuencoding and Posting
7416 @subsubsection Uuencoding and Posting
7417
7418 @table @code
7419
7420 @item gnus-uu-post-include-before-composing
7421 @vindex gnus-uu-post-include-before-composing
7422 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
7423 before you compose the article.  If this variable is @code{t}, you can
7424 either include an encoded file with @kbd{C-c C-i} or have one included
7425 for you when you post the article.
7426
7427 @item gnus-uu-post-length
7428 @vindex gnus-uu-post-length
7429 Maximum length of an article.  The encoded file will be split into how
7430 many articles it takes to post the entire file.
7431
7432 @item gnus-uu-post-threaded
7433 @vindex gnus-uu-post-threaded
7434 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
7435 thread.  This may not be smart, as no other decoder I have seen is able
7436 to follow threads when collecting uuencoded articles.  (Well, I have
7437 seen one package that does that---@code{gnus-uu}, but somehow, I don't
7438 think that counts...) Default is @code{nil}.
7439
7440 @item gnus-uu-post-separate-description
7441 @vindex gnus-uu-post-separate-description
7442 Non-@code{nil} means that the description will be posted in a separate
7443 article.  The first article will typically be numbered (0/x).  If this
7444 variable is @code{nil}, the description the user enters will be included
7445 at the beginning of the first article, which will be numbered (1/x).
7446 Default is @code{t}.
7447
7448 @end table
7449
7450
7451 @node Viewing Files
7452 @subsection Viewing Files
7453 @cindex viewing files
7454 @cindex pseudo-articles
7455
7456 After decoding, if the file is some sort of archive, gnus will attempt
7457 to unpack the archive and see if any of the files in the archive can be
7458 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
7459 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
7460 uncompress and de-tar the main file, and then view the two pictures.
7461 This unpacking process is recursive, so if the archive contains archives
7462 of archives, it'll all be unpacked.
7463
7464 Finally, gnus will normally insert a @dfn{pseudo-article} for each
7465 extracted file into the summary buffer.  If you go to these
7466 ``articles'', you will be prompted for a command to run (usually Gnus
7467 will make a suggestion), and then the command will be run.
7468
7469 @vindex gnus-view-pseudo-asynchronously
7470 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
7471 until the viewing is done before proceeding.
7472
7473 @vindex gnus-view-pseudos
7474 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
7475 the pseudo-articles into the summary buffer, but view them
7476 immediately.  If this variable is @code{not-confirm}, the user won't even
7477 be asked for a confirmation before viewing is done.
7478
7479 @vindex gnus-view-pseudos-separately
7480 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
7481 pseudo-article will be created for each file to be viewed.  If
7482 @code{nil}, all files that use the same viewing command will be given as
7483 a list of parameters to that command.
7484
7485 @vindex gnus-insert-pseudo-articles
7486 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
7487 pseudo-articles when decoding.  It is @code{t} by default.
7488
7489 So; there you are, reading your @emph{pseudo-articles} in your
7490 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
7491 Why isn't anything real anymore? How did we get here?
7492
7493
7494 @node Article Treatment
7495 @section Article Treatment
7496
7497 Reading through this huge manual, you may have quite forgotten that the
7498 object of newsreaders is to actually, like, read what people have
7499 written.  Reading articles.  Unfortunately, people are quite bad at
7500 writing, so there are tons of functions and variables to make reading
7501 these articles easier.
7502
7503 @menu
7504 * Article Highlighting::        You want to make the article look like fruit salad.
7505 * Article Fontisizing::         Making emphasized text look nice.
7506 * Article Hiding::              You also want to make certain info go away.
7507 * Article Washing::             Lots of way-neat functions to make life better.
7508 * Article Buttons::             Click on URLs, Message-IDs, addresses and the like.
7509 * Article Date::                Grumble, UT!
7510 * Article Signature::           What is a signature?
7511 * Article Miscellania::         Various other stuff.
7512 @end menu
7513
7514
7515 @node Article Highlighting
7516 @subsection Article Highlighting
7517 @cindex highlighting
7518
7519 Not only do you want your article buffer to look like fruit salad, but
7520 you want it to look like technicolor fruit salad.
7521
7522 @table @kbd
7523
7524 @item W H a
7525 @kindex W H a (Summary)
7526 @findex gnus-article-highlight
7527 @findex gnus-article-maybe-highlight
7528 Do much highlighting of the current article
7529 (@code{gnus-article-highlight}).  This function highlights header, cited
7530 text, the signature, and adds buttons to the body and the head.
7531
7532 @item W H h
7533 @kindex W H h (Summary)
7534 @findex gnus-article-highlight-headers
7535 @vindex gnus-header-face-alist
7536 Highlight the headers (@code{gnus-article-highlight-headers}).  The
7537 highlighting will be done according to the @code{gnus-header-face-alist}
7538 variable, which is a list where each element has the form
7539 @code{(@var{regexp} @var{name} @var{content})}.
7540 @var{regexp} is a regular expression for matching the
7541 header, @var{name} is the face used for highlighting the header name
7542 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
7543 the header value.  The first match made will be used.  Note that
7544 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
7545
7546 @item W H c
7547 @kindex W H c (Summary)
7548 @findex gnus-article-highlight-citation
7549 Highlight cited text (@code{gnus-article-highlight-citation}).
7550
7551 Some variables to customize the citation highlights:
7552
7553 @table @code
7554 @vindex gnus-cite-parse-max-size
7555
7556 @item gnus-cite-parse-max-size
7557 If the article size if bigger than this variable (which is 25000 by
7558 default), no citation highlighting will be performed.
7559
7560 @item gnus-cite-max-prefix
7561 @vindex gnus-cite-max-prefix
7562 Maximum possible length for a citation prefix (default 20).
7563
7564 @item gnus-cite-face-list
7565 @vindex gnus-cite-face-list
7566 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7567 When there are citations from multiple articles in the same message,
7568 gnus will try to give each citation from each article its own face.
7569 This should make it easier to see who wrote what.
7570
7571 @item gnus-supercite-regexp
7572 @vindex gnus-supercite-regexp
7573 Regexp matching normal Supercite attribution lines.
7574
7575 @item gnus-supercite-secondary-regexp
7576 @vindex gnus-supercite-secondary-regexp
7577 Regexp matching mangled Supercite attribution lines.
7578
7579 @item gnus-cite-minimum-match-count
7580 @vindex gnus-cite-minimum-match-count
7581 Minimum number of identical prefixes we have to see before we believe
7582 that it's a citation.
7583
7584 @item gnus-cite-attribution-prefix
7585 @vindex gnus-cite-attribution-prefix
7586 Regexp matching the beginning of an attribution line.
7587
7588 @item gnus-cite-attribution-suffix
7589 @vindex gnus-cite-attribution-suffix
7590 Regexp matching the end of an attribution line.
7591
7592 @item gnus-cite-attribution-face
7593 @vindex gnus-cite-attribution-face
7594 Face used for attribution lines.  It is merged with the face for the
7595 cited text belonging to the attribution.
7596
7597 @end table
7598
7599
7600 @item W H s
7601 @kindex W H s (Summary)
7602 @vindex gnus-signature-separator
7603 @vindex gnus-signature-face
7604 @findex gnus-article-highlight-signature
7605 Highlight the signature (@code{gnus-article-highlight-signature}).
7606 Everything after @code{gnus-signature-separator} (@pxref{Article
7607 Signature}) in an article will be considered a signature and will be
7608 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7609 default.
7610
7611 @end table
7612
7613 @xref{Customizing Articles}, for how to highlight articles automatically.
7614
7615
7616 @node Article Fontisizing
7617 @subsection Article Fontisizing
7618 @cindex emphasis
7619 @cindex article emphasis
7620
7621 @findex gnus-article-emphasize
7622 @kindex W e (Summary)
7623 People commonly add emphasis to words in news articles by writing things
7624 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
7625 this look nicer by running the article through the @kbd{W e}
7626 (@code{gnus-article-emphasize}) command.
7627
7628 @vindex gnus-emphasis-alist
7629 How the emphasis is computed is controlled by the
7630 @code{gnus-emphasis-alist} variable.  This is an alist where the first
7631 element is a regular expression to be matched.  The second is a number
7632 that says what regular expression grouping is used to find the entire
7633 emphasized word.  The third is a number that says what regexp grouping
7634 should be displayed and highlighted.  (The text between these two
7635 groupings will be hidden.)  The fourth is the face used for
7636 highlighting.
7637
7638 @lisp
7639 (setq gnus-emphasis-alist
7640       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7641         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7642 @end lisp
7643
7644 @cindex slash
7645 @cindex asterisk
7646 @cindex underline
7647 @cindex /
7648 @cindex *
7649
7650 @vindex gnus-emphasis-underline
7651 @vindex gnus-emphasis-bold
7652 @vindex gnus-emphasis-italic
7653 @vindex gnus-emphasis-underline-bold
7654 @vindex gnus-emphasis-underline-italic
7655 @vindex gnus-emphasis-bold-italic
7656 @vindex gnus-emphasis-underline-bold-italic
7657 By default, there are seven rules, and they use the following faces:
7658 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7659 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7660 @code{gnus-emphasis-underline-italic},
7661 @code{gnus-emphasis-underline-bold}, and
7662 @code{gnus-emphasis-underline-bold-italic}.
7663
7664 If you want to change these faces, you can either use @kbd{M-x
7665 customize}, or you can use @code{copy-face}.  For instance, if you want
7666 to make @code{gnus-emphasis-italic} use a red face instead, you could
7667 say something like:
7668
7669 @lisp
7670 (copy-face 'red 'gnus-emphasis-italic)
7671 @end lisp
7672
7673 @vindex gnus-group-highlight-words-alist
7674
7675 If you want to highlight arbitrary words, you can use the
7676 @code{gnus-group-highlight-words-alist} variable, which uses the same
7677 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
7678 parameter (@pxref{Group Parameters}) can also be used.
7679
7680 @xref{Customizing Articles}, for how to fontize articles automatically.
7681
7682
7683 @node Article Hiding
7684 @subsection Article Hiding
7685 @cindex article hiding
7686
7687 Or rather, hiding certain things in each article.  There usually is much
7688 too much cruft in most articles.
7689
7690 @table @kbd
7691
7692 @item W W a
7693 @kindex W W a (Summary)
7694 @findex gnus-article-hide
7695 Do quite a lot of hiding on the article buffer
7696 (@kbd{gnus-article-hide}).  In particular, this function will hide
7697 headers, PGP, cited text and the signature.
7698
7699 @item W W h
7700 @kindex W W h (Summary)
7701 @findex gnus-article-toggle-headers
7702 Toggle hiding of headers (@code{gnus-article-toggle-headers}).  @xref{Hiding
7703 Headers}.
7704
7705 @item W W b
7706 @kindex W W b (Summary)
7707 @findex gnus-article-hide-boring-headers
7708 Hide headers that aren't particularly interesting
7709 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
7710
7711 @item W W s
7712 @kindex W W s (Summary)
7713 @findex gnus-article-hide-signature
7714 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
7715 Signature}.
7716
7717 @item W W l
7718 @kindex W W l (Summary)
7719 @findex gnus-article-hide-list-identifiers
7720 @vindex gnus-list-identifiers
7721 Strip list identifiers specified in @code{gnus-list-identifiers}.  These
7722 are strings some mailing list servers add to the beginning of all
7723 @code{Subject} headers---for example, @samp{[zebra 4711]}.  Any leading
7724 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7725 may not contain @code{\\(..\\)}.
7726
7727 @table @code
7728
7729 @item gnus-list-identifiers
7730 @vindex gnus-list-identifiers
7731 A regular expression that matches list identifiers to be removed from
7732 subject.  This can also be a list of regular expressions.
7733
7734 @end table
7735
7736 @item W W p
7737 @kindex W W p (Summary)
7738 @findex gnus-article-hide-pgp
7739 @vindex gnus-article-hide-pgp-hook
7740 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
7741 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7742 signature has been hidden.  For example, to automatically verify
7743 articles that have signatures in them do:
7744 @lisp
7745 ;;; Hide pgp cruft if any.
7746
7747 (setq gnus-treat-strip-pgp t)
7748
7749 ;;; After hiding pgp, verify the message;
7750 ;;; only happens if pgp signature is found.
7751
7752 (add-hook 'gnus-article-hide-pgp-hook
7753           (lambda ()
7754             (save-excursion
7755               (set-buffer gnus-original-article-buffer)
7756               (mc-verify))))
7757 @end lisp
7758
7759 @item W W P
7760 @kindex W W P (Summary)
7761 @findex gnus-article-hide-pem
7762 Hide @sc{pem} (privacy enhanced messages) cruft
7763 (@code{gnus-article-hide-pem}).
7764
7765 @item W W B
7766 @kindex W W B (Summary)
7767 @findex gnus-article-strip-banner
7768 @cindex banner
7769 @cindex OneList
7770 @cindex stripping advertisements
7771 @cindex advertisements
7772 Strip the banner specified by the @code{banner} group parameter
7773 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
7774 annoying banners and/or signatures that some mailing lists and moderated
7775 groups adds to all the messages.  The way to use this function is to add
7776 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7777 group you want banners stripped from.  The parameter either be a string,
7778 which will be interpreted as a regular expression matching text to be
7779 removed, or the symbol @code{signature}, meaning that the (last)
7780 signature should be removed, or other symbol, meaning that the
7781 corresponding regular expression in @code{gnus-article-banner-alist} is
7782 used.
7783
7784 @item W W c
7785 @kindex W W c (Summary)
7786 @findex gnus-article-hide-citation
7787 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
7788 customizing the hiding:
7789
7790 @table @code
7791
7792 @item gnus-cited-opened-text-button-line-format
7793 @itemx gnus-cited-closed-text-button-line-format
7794 @vindex gnus-cited-closed-text-button-line-format
7795 @vindex gnus-cited-opened-text-button-line-format
7796 Gnus adds buttons to show where the cited text has been hidden, and to
7797 allow toggle hiding the text.  The format of the variable is specified
7798 by these format-like variable (@pxref{Formatting Variables}).  These
7799 specs are valid:
7800
7801 @table @samp
7802 @item b
7803 Starting point of the hidden text.
7804 @item e
7805 Ending point of the hidden text.
7806 @item l
7807 Number of characters in the hidden region.
7808 @item n
7809 Number of lines of hidden text.
7810 @end table
7811
7812 @item gnus-cited-lines-visible
7813 @vindex gnus-cited-lines-visible
7814 The number of lines at the beginning of the cited text to leave
7815 shown. This can also be a cons cell with the number of lines at the top
7816 and bottom of the text, respectively, to remain visible.
7817
7818 @end table
7819
7820 @item W W C-c
7821 @kindex W W C-c (Summary)
7822 @findex gnus-article-hide-citation-maybe
7823
7824 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7825 following two variables:
7826
7827 @table @code
7828 @item gnus-cite-hide-percentage
7829 @vindex gnus-cite-hide-percentage
7830 If the cited text is of a bigger percentage than this variable (default
7831 50), hide the cited text.
7832
7833 @item gnus-cite-hide-absolute
7834 @vindex gnus-cite-hide-absolute
7835 The cited text must have at least this length (default 10) before it
7836 is hidden.
7837 @end table
7838
7839 @item W W C
7840 @kindex W W C (Summary)
7841 @findex gnus-article-hide-citation-in-followups
7842 Hide cited text in articles that aren't roots
7843 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
7844 useful as an interactive command, but might be a handy function to stick
7845 have happen automatically (@pxref{Customizing Articles}).
7846
7847 @end table
7848
7849 All these ``hiding'' commands are toggles, but if you give a negative
7850 prefix to these commands, they will show what they have previously
7851 hidden.  If you give a positive prefix, they will always hide.
7852
7853 Also @pxref{Article Highlighting} for further variables for
7854 citation customization.
7855
7856 @xref{Customizing Articles}, for how to hide article elements
7857 automatically.
7858
7859
7860 @node Article Washing
7861 @subsection Article Washing
7862 @cindex washing
7863 @cindex article washing
7864
7865 We call this ``article washing'' for a really good reason.  Namely, the
7866 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7867
7868 @dfn{Washing} is defined by us as ``changing something from something to
7869 something else'', but normally results in something looking better.
7870 Cleaner, perhaps.
7871
7872 @xref{Customizing Articles}, if you want to change how Gnus displays
7873 articles by default.
7874
7875 @table @kbd
7876
7877 @item C-u g
7878 This is not really washing, it's sort of the opposite of washing.  If
7879 you type this, you see the article exactly as it exists on disk or on
7880 the server.
7881
7882 @item W l
7883 @kindex W l (Summary)
7884 @findex gnus-summary-stop-page-breaking
7885 Remove page breaks from the current article
7886 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
7887 delimiters.
7888
7889 @item W r
7890 @kindex W r (Summary)
7891 @findex gnus-summary-caesar-message
7892 @c @icon{gnus-summary-caesar-message}
7893 Do a Caesar rotate (rot13) on the article buffer
7894 (@code{gnus-summary-caesar-message}).
7895 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7896 (Typically offensive jokes and such.)
7897
7898 It's commonly called ``rot13'' because each letter is rotated 13
7899 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7900 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
7901 is rumored to have employed this form of, uh, somewhat weak encryption.
7902
7903 @item W t
7904 @item t
7905 @kindex W t (Summary)
7906 @kindex t (Summary)
7907 @findex gnus-article-toggle-headers
7908 Toggle whether to display all headers in the article buffer
7909 (@code{gnus-article-toggle-headers}).
7910
7911 @item W v
7912 @kindex W v (Summary)
7913 @findex gnus-summary-verbose-header
7914 Toggle whether to display all headers in the article buffer permanently
7915 (@code{gnus-summary-verbose-header}).
7916
7917 @item W m
7918 @kindex W m (Summary)
7919 @findex gnus-summary-toggle-mime
7920 Toggle whether to run the article through @sc{mime} before displaying
7921 (@code{gnus-summary-toggle-mime}).
7922
7923 @item W o
7924 @kindex W o (Summary)
7925 @findex gnus-article-treat-overstrike
7926 Treat overstrike (@code{gnus-article-treat-overstrike}).
7927
7928 @item W d
7929 @kindex W d (Summary)
7930 @findex gnus-article-treat-dumbquotes
7931 @vindex gnus-article-dumbquotes-map
7932 @cindex Smartquotes
7933 @cindex M****s*** sm*rtq**t*s
7934 @cindex Latin 1
7935 Treat M****s*** sm*rtq**t*s according to
7936 @code{gnus-article-dumbquotes-map}
7937 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
7938 whether a character is a sm*rtq**t* or not, so it should only be used
7939 interactively.
7940
7941 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
7942 an attempt to provide more quoting characters.  If you see something
7943 like @code{\222} or @code{\264} where you're expecting some kind of
7944 apostrophe or quotation mark, then try this wash.
7945
7946 @item W w
7947 @kindex W w (Summary)
7948 @findex gnus-article-fill-cited-article
7949 Do word wrap (@code{gnus-article-fill-cited-article}).
7950
7951 You can give the command a numerical prefix to specify the width to use
7952 when filling.
7953
7954 @item W Q
7955 @kindex W Q (Summary)
7956 @findex gnus-article-fill-long-lines
7957 Fill long lines (@code{gnus-article-fill-long-lines}).
7958
7959 @item W C
7960 @kindex W C (Summary)
7961 @findex gnus-article-capitalize-sentences
7962 Capitalize the first word in each sentence
7963 (@code{gnus-article-capitalize-sentences}).
7964
7965 @item W c
7966 @kindex W c (Summary)
7967 @findex gnus-article-remove-cr
7968 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7969 (this takes care of DOS line endings), and then translate any remaining
7970 CRs into LF (this takes care of Mac line endings)
7971 (@code{gnus-article-remove-cr}).
7972
7973 @item W 6
7974 @kindex W 6 (Summary)
7975 @findex gnus-article-de-base64-unreadable
7976 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7977 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7978 (i. e., 8-bit) articles.  Note that the this is usually done
7979 automatically by Gnus if the message in question has a
7980 @code{Content-Transfer-Encoding} header that says that this encoding has
7981 been done.
7982 If a prefix is given, a charset will be asked for.
7983
7984 @item W Z
7985 @kindex W Z (Summary)
7986 @findex gnus-article-decode-HZ
7987 Treat HZ or HZP (@code{gnus-article-decode-HZ}).  HZ (or HZP) is one
7988 common encoding employed when sending Chinese articles.  It typically
7989 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7990
7991 @item W h
7992 @kindex W h (Summary)
7993 @findex gnus-article-wash-html
7994 Treat HTML (@code{gnus-article-wash-html}).
7995 Note that the this is usually done automatically by Gnus if the message
7996 in question has a @code{Content-Type} header that says that this type
7997 has been done.
7998 If a prefix is given, a charset will be asked for.
7999
8000 @item W f
8001 @kindex W f (Summary)
8002 @cindex x-face
8003 @findex gnus-article-display-x-face
8004 @findex gnus-article-x-face-command
8005 @vindex gnus-article-x-face-command
8006 @vindex gnus-article-x-face-too-ugly
8007 @iftex
8008 @iflatex
8009 \include{xface}
8010 @end iflatex
8011 @end iftex
8012 @c @anchor{X-Face}
8013 Look for and display any X-Face headers
8014 (@code{gnus-article-display-x-face}).  The command executed by this
8015 function is given by the @code{gnus-article-x-face-command} variable.
8016 If this variable is a string, this string will be executed in a
8017 sub-shell.  If it is a function, this function will be called with the
8018 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
8019 is a regexp) matches the @code{From} header, the face will not be shown.
8020 The default action under Emacs is to fork off the @code{display}
8021 program@footnote{@code{display} is from the ImageMagick package.  For
8022 the @code{uncompface} and @code{icontopbm} programs look for a package
8023 like `compface' or `faces-xface' on a GNU/Linux system.}  to view the
8024 face.  Under XEmacs or Emacs 21+ with suitable image support, the
8025 default action is to display the face before the @code{From} header.
8026 (It's nicer if XEmacs has been compiled with X-Face support---that will
8027 make display somewhat faster.  If there's no native X-Face support, Gnus
8028 will try to convert the @code{X-Face} header using external programs
8029 from the @code{pbmplus} package and friends.@footnote{On a GNU/Linux
8030 system look for packages with names like @code{netpbm} or
8031 @code{libgr-progs}.})  If you want to have this function in the display
8032 hook, it should probably come last.  
8033 (NOTE: @code{x-face} is used in the variable/function names, not @code{xface}).
8034
8035 @item W b
8036 @kindex W b (Summary)
8037 @findex gnus-article-add-buttons
8038 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
8039 @xref{Article Buttons}.
8040
8041 @item W B
8042 @kindex W B (Summary)
8043 @findex gnus-article-add-buttons-to-head
8044 Add clickable buttons to the article headers
8045 (@code{gnus-article-add-buttons-to-head}).
8046
8047 @item W p
8048 @kindex W p (Summary)
8049 @findex gnus-article-verify-x-pgp-sig
8050 Verify a signed control message (@code{gnus-article-verify-x-pgp-sig}).
8051 Control messages such as @code{newgroup} and @code{checkgroups} are
8052 usually signed by the hierarchy maintainer.  You need to add the PGP
8053 public key of the maintainer to your keyring to verify the
8054 message.@footnote{PGP keys for many hierarchies are available at
8055 @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
8056
8057 @item W s
8058 @kindex W s (Summary)
8059 @findex gnus-summary-force-verify-and-decrypt
8060 Verify a signed (PGP, PGP/MIME or S/MIME) message
8061 (@code{gnus-summary-force-verify-and-decrypt}).
8062
8063 @item W W H
8064 @kindex W W H (Summary)
8065 @findex gnus-article-strip-headers-from-body
8066 Strip headers like the @code{X-No-Archive} header from the beginning of
8067 article bodies (@code{gnus-article-strip-headers-from-body}).
8068
8069 @item W E l
8070 @kindex W E l (Summary)
8071 @findex gnus-article-strip-leading-blank-lines
8072 Remove all blank lines from the beginning of the article
8073 (@code{gnus-article-strip-leading-blank-lines}).
8074
8075 @item W E m
8076 @kindex W E m (Summary)
8077 @findex gnus-article-strip-multiple-blank-lines
8078 Replace all blank lines with empty lines and then all multiple empty
8079 lines with a single empty line.
8080 (@code{gnus-article-strip-multiple-blank-lines}).
8081
8082 @item W E t
8083 @kindex W E t (Summary)
8084 @findex gnus-article-remove-trailing-blank-lines
8085 Remove all blank lines at the end of the article
8086 (@code{gnus-article-remove-trailing-blank-lines}).
8087
8088 @item W E a
8089 @kindex W E a (Summary)
8090 @findex gnus-article-strip-blank-lines
8091 Do all the three commands above
8092 (@code{gnus-article-strip-blank-lines}).
8093
8094 @item W E A
8095 @kindex W E A (Summary)
8096 @findex gnus-article-strip-all-blank-lines
8097 Remove all blank lines
8098 (@code{gnus-article-strip-all-blank-lines}).
8099
8100 @item W E s
8101 @kindex W E s (Summary)
8102 @findex gnus-article-strip-leading-space
8103 Remove all white space from the beginning of all lines of the article
8104 body (@code{gnus-article-strip-leading-space}).
8105
8106 @item W E e
8107 @kindex W E e (Summary)
8108 @findex gnus-article-strip-trailing-space
8109 Remove all white space from the end of all lines of the article
8110 body (@code{gnus-article-strip-trailing-space}).
8111
8112 @end table
8113
8114 @xref{Customizing Articles}, for how to wash articles automatically.
8115
8116
8117 @node Article Buttons
8118 @subsection Article Buttons
8119 @cindex buttons
8120
8121 People often include references to other stuff in articles, and it would
8122 be nice if Gnus could just fetch whatever it is that people talk about
8123 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
8124 button on these references.
8125
8126 Gnus adds @dfn{buttons} to certain standard references by default:
8127 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
8128 two variables, one that handles article bodies and one that handles
8129 article heads:
8130
8131 @table @code
8132
8133 @item gnus-button-alist
8134 @vindex gnus-button-alist
8135 This is an alist where each entry has this form:
8136
8137 @lisp
8138 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8139 @end lisp
8140
8141 @table @var
8142
8143 @item regexp
8144 All text that match this regular expression will be considered an
8145 external reference.  Here's a typical regexp that matches embedded URLs:
8146 @samp{<URL:\\([^\n\r>]*\\)>}.
8147
8148 @item button-par
8149 Gnus has to know which parts of the matches is to be highlighted.  This
8150 is a number that says what sub-expression of the regexp is to be
8151 highlighted.  If you want it all highlighted, you use 0 here.
8152
8153 @item use-p
8154 This form will be @code{eval}ed, and if the result is non-@code{nil},
8155 this is considered a match.  This is useful if you want extra sifting to
8156 avoid false matches.
8157
8158 @item function
8159 This function will be called when you click on this button.
8160
8161 @item data-par
8162 As with @var{button-par}, this is a sub-expression number, but this one
8163 says which part of the match is to be sent as data to @var{function}.
8164
8165 @end table
8166
8167 So the full entry for buttonizing URLs is then
8168
8169 @lisp
8170 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
8171 @end lisp
8172
8173 @item gnus-header-button-alist
8174 @vindex gnus-header-button-alist
8175 This is just like the other alist, except that it is applied to the
8176 article head only, and that each entry has an additional element that is
8177 used to say what headers to apply the buttonize coding to:
8178
8179 @lisp
8180 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
8181 @end lisp
8182
8183 @var{header} is a regular expression.
8184
8185 @item gnus-button-url-regexp
8186 @vindex gnus-button-url-regexp
8187 A regular expression that matches embedded URLs.  It is used in the
8188 default values of the variables above.
8189
8190 @item gnus-article-button-face
8191 @vindex gnus-article-button-face
8192 Face used on buttons.
8193
8194 @item gnus-article-mouse-face
8195 @vindex gnus-article-mouse-face
8196 Face used when the mouse cursor is over a button.
8197
8198 @end table
8199
8200 @xref{Customizing Articles}, for how to buttonize articles automatically.
8201
8202
8203 @node Article Date
8204 @subsection Article Date
8205
8206 The date is most likely generated in some obscure timezone you've never
8207 heard of, so it's quite nice to be able to find out what the time was
8208 when the article was sent.
8209
8210 @table @kbd
8211
8212 @item W T u
8213 @kindex W T u (Summary)
8214 @findex gnus-article-date-ut
8215 Display the date in UT (aka. GMT, aka ZULU)
8216 (@code{gnus-article-date-ut}).
8217
8218 @item W T i
8219 @kindex W T i (Summary)
8220 @findex gnus-article-date-iso8601
8221 @cindex ISO 8601
8222 Display the date in international format, aka. ISO 8601
8223 (@code{gnus-article-date-iso8601}).
8224
8225 @item W T l
8226 @kindex W T l (Summary)
8227 @findex gnus-article-date-local
8228 Display the date in the local timezone (@code{gnus-article-date-local}).
8229
8230 @item W T p
8231 @kindex W T p (Summary)
8232 @findex gnus-article-date-english
8233 Display the date in a format that's easily pronounceable in English
8234 (@code{gnus-article-date-english}).
8235
8236 @item W T s
8237 @kindex W T s (Summary)
8238 @vindex gnus-article-time-format
8239 @findex gnus-article-date-user
8240 @findex format-time-string
8241 Display the date using a user-defined format
8242 (@code{gnus-article-date-user}).  The format is specified by the
8243 @code{gnus-article-time-format} variable, and is a string that's passed
8244 to @code{format-time-string}.  See the documentation of that variable
8245 for a list of possible format specs.
8246
8247 @item W T e
8248 @kindex W T e (Summary)
8249 @findex gnus-article-date-lapsed
8250 @findex gnus-start-date-timer
8251 @findex gnus-stop-date-timer
8252 Say how much time has elapsed between the article was posted and now
8253 (@code{gnus-article-date-lapsed}).  It looks something like:
8254
8255 @example
8256 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
8257 @end example
8258
8259 The value of @code{gnus-article-date-lapsed-new-header} determines
8260 whether this header will just be added below the old Date one, or will
8261 replace it.
8262
8263 An advantage of using Gnus to read mail is that it converts simple bugs
8264 into wonderful absurdities.
8265
8266 If you want to have this line updated continually, you can put
8267
8268 @lisp
8269 (gnus-start-date-timer)
8270 @end lisp
8271
8272 in your @file{.gnus.el} file, or you can run it off of some hook.  If
8273 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
8274 command.
8275
8276 @item W T o
8277 @kindex W T o (Summary)
8278 @findex gnus-article-date-original
8279 Display the original date (@code{gnus-article-date-original}).  This can
8280 be useful if you normally use some other conversion function and are
8281 worried that it might be doing something totally wrong.  Say, claiming
8282 that the article was posted in 1854.  Although something like that is
8283 @emph{totally} impossible.  Don't you trust me? *titter*
8284
8285 @end table
8286
8287 @xref{Customizing Articles}, for how to display the date in your
8288 preferred format automatically.
8289
8290
8291 @node Article Signature
8292 @subsection Article Signature
8293 @cindex signatures
8294 @cindex article signature
8295
8296 @vindex gnus-signature-separator
8297 Each article is divided into two parts---the head and the body.  The
8298 body can be divided into a signature part and a text part.  The variable
8299 that says what is to be considered a signature is
8300 @code{gnus-signature-separator}.  This is normally the standard
8301 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
8302 non-standard signature separators, so this variable can also be a list
8303 of regular expressions to be tested, one by one.  (Searches are done
8304 from the end of the body towards the beginning.)  One likely value is:
8305
8306 @lisp
8307 (setq gnus-signature-separator
8308       '("^-- $"         ; The standard
8309         "^-- *$"        ; A common mangling
8310         "^-------*$"    ; Many people just use a looong
8311                         ; line of dashes.  Shame!
8312         "^ *--------*$" ; Double-shame!
8313         "^________*$"   ; Underscores are also popular
8314         "^========*$")) ; Pervert!
8315 @end lisp
8316
8317 The more permissive you are, the more likely it is that you'll get false
8318 positives.
8319
8320 @vindex gnus-signature-limit
8321 @code{gnus-signature-limit} provides a limit to what is considered a
8322 signature when displaying articles.
8323
8324 @enumerate
8325 @item
8326 If it is an integer, no signature may be longer (in characters) than
8327 that integer.
8328 @item
8329 If it is a floating point number, no signature may be longer (in lines)
8330 than that number.
8331 @item
8332 If it is a function, the function will be called without any parameters,
8333 and if it returns @code{nil}, there is no signature in the buffer.
8334 @item
8335 If it is a string, it will be used as a regexp.  If it matches, the text
8336 in question is not a signature.
8337 @end enumerate
8338
8339 This variable can also be a list where the elements may be of the types
8340 listed above.  Here's an example:
8341
8342 @lisp
8343 (setq gnus-signature-limit
8344       '(200.0 "^---*Forwarded article"))
8345 @end lisp
8346
8347 This means that if there are more than 200 lines after the signature
8348 separator, or the text after the signature separator is matched by
8349 the regular expression @samp{^---*Forwarded article}, then it isn't a
8350 signature after all.
8351
8352
8353 @node Article Miscellania
8354 @subsection Article Miscellania
8355
8356 @table @kbd
8357 @item A t
8358 @kindex A t (Summary)
8359 @findex gnus-article-babel
8360 Translate the article from one language to another
8361 (@code{gnus-article-babel}).
8362
8363 @end table
8364
8365
8366 @node MIME Commands
8367 @section @sc{mime} Commands
8368 @cindex MIME decoding
8369 @cindex attachments
8370 @cindex viewing attachments
8371
8372 The following commands all understand the numerical prefix.  For
8373 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
8374
8375 @table @kbd
8376 @item b
8377 @itemx K v
8378 @kindex b (Summary)
8379 @kindex K v (Summary)
8380 View the @sc{mime} part.
8381
8382 @item K o
8383 @kindex K o (Summary)
8384 Save the @sc{mime} part.
8385
8386 @item K c
8387 @kindex K c (Summary)
8388 Copy the @sc{mime} part.
8389
8390 @item K e
8391 @kindex K e (Summary)
8392 View the @sc{mime} part externally.
8393
8394 @item K i
8395 @kindex K i (Summary)
8396 View the @sc{mime} part internally.
8397
8398 @item K |
8399 @kindex K | (Summary)
8400 Pipe the @sc{mime} part to an external command.
8401 @end table
8402
8403 The rest of these @sc{mime} commands do not use the numerical prefix in
8404 the same manner:
8405
8406 @table @kbd
8407 @item K b
8408 @kindex K b (Summary)
8409 Make all the @sc{mime} parts have buttons in front of them.  This is
8410 mostly useful if you wish to save (or perform other actions) on inlined
8411 parts.
8412
8413 @item K m
8414 @kindex K m (Summary)
8415 @findex gnus-summary-repair-multipart
8416 Some multipart messages are transmitted with missing or faulty headers.
8417 This command will attempt to ``repair'' these messages so that they can
8418 be viewed in a more pleasant manner
8419 (@code{gnus-summary-repair-multipart}).
8420
8421 @item X m
8422 @kindex X m (Summary)
8423 @findex gnus-summary-save-parts
8424 Save all parts matching a @sc{mime} type to a directory
8425 (@code{gnus-summary-save-parts}).  Understands the process/prefix
8426 convention (@pxref{Process/Prefix}).
8427
8428 @item M-t
8429 @kindex M-t (Summary)
8430 @findex gnus-summary-display-buttonized
8431 Toggle the buttonized display of the article buffer
8432 (@code{gnus-summary-toggle-display-buttonized}).
8433
8434 @item W M w
8435 @kindex W M w (Summary)
8436 Decode RFC 2047-encoded words in the article headers
8437 (@code{gnus-article-decode-mime-words}).
8438
8439 @item W M c
8440 @kindex W M c (Summary)
8441 Decode encoded article bodies as well as charsets
8442 (@code{gnus-article-decode-charset}).
8443
8444 This command looks in the @code{Content-Type} header to determine the
8445 charset.  If there is no such header in the article, you can give it a
8446 prefix, which will prompt for the charset to decode as.  In regional
8447 groups where people post using some common encoding (but do not include
8448 MIME headers), you can set the @code{charset} group/topic parameter to
8449 the required charset (@pxref{Group Parameters}).
8450
8451 @item W M v
8452 @kindex W M v (Summary)
8453 View all the @sc{mime} parts in the current article
8454 (@code{gnus-mime-view-all-parts}).
8455
8456 @end table
8457
8458 Relevant variables:
8459
8460 @table @code
8461 @item gnus-ignored-mime-types
8462 @vindex gnus-ignored-mime-types
8463 This is a list of regexps.  @sc{mime} types that match a regexp from
8464 this list will be completely ignored by Gnus.  The default value is
8465 @code{nil}.
8466
8467 To have all Vcards be ignored, you'd say something like this:
8468
8469 @lisp
8470 (setq gnus-ignored-mime-types
8471       '("text/x-vcard"))
8472 @end lisp
8473
8474 @item gnus-unbuttonized-mime-types
8475 @vindex gnus-unbuttonized-mime-types
8476 This is a list of regexps.  @sc{mime} types that match a regexp from
8477 this list won't have @sc{mime} buttons inserted unless they aren't
8478 displayed or this variable is overriden by
8479 @code{gnus-buttonized-mime-types}.  The default value is
8480 @code{(".*/.*")}.
8481
8482 @item gnus-buttonized-mime-types
8483 @vindex gnus-buttonized-mime-types
8484 This is a list of regexps.  @sc{mime} types that match a regexp from
8485 this list will have @sc{mime} buttons inserted unless they aren't
8486 displayed.  This variable overrides
8487 @code{gnus-unbuttonized-mime-types}.  The default value is @code{nil}.
8488
8489 To see e.g. security buttons but no other buttons, you could set this
8490 variable to @code{("multipart/signed")} and leave
8491 @code{gnus-unbuttonized-mime-types} to the default value.
8492
8493 @item gnus-article-mime-part-function
8494 @vindex gnus-article-mime-part-function
8495 For each @sc{mime} part, this function will be called with the @sc{mime}
8496 handle as the parameter.  The function is meant to be used to allow
8497 users to gather information from the article (e. g., add Vcard info to
8498 the bbdb database) or to do actions based on parts (e. g., automatically
8499 save all jpegs into some directory).
8500
8501 Here's an example function the does the latter:
8502
8503 @lisp
8504 (defun my-save-all-jpeg-parts (handle)
8505   (when (equal (car (mm-handle-type handle)) "image/jpeg")
8506     (with-temp-buffer
8507       (insert (mm-get-part handle))
8508       (write-region (point-min) (point-max)
8509                     (read-file-name "Save jpeg to: ")))))
8510 (setq gnus-article-mime-part-function
8511       'my-save-all-jpeg-parts)
8512 @end lisp
8513
8514 @vindex gnus-mime-multipart-functions
8515 @item gnus-mime-multipart-functions
8516 Alist of @sc{mime} multipart types and functions to handle them.
8517
8518 @vindex mm-file-name-rewrite-functions
8519 @item mm-file-name-rewrite-functions
8520 List of functions used for rewriting file names of @sc{mime} parts.
8521 Each function takes a file name as input and returns a file name.
8522
8523 Ready-made functions include@*
8524 @code{mm-file-name-delete-whitespace},
8525 @code{mm-file-name-trim-whitespace},
8526 @code{mm-file-name-collapse-whitespace}, and
8527 @code{mm-file-name-replace-whitespace}.  The later uses the value of
8528 the variable @code{mm-file-name-replace-whitespace} to replace each
8529 whitespace character in a file name with that string; default value
8530 is @code{"_"} (a single underscore).
8531 @findex mm-file-name-delete-whitespace
8532 @findex mm-file-name-trim-whitespace
8533 @findex mm-file-name-collapse-whitespace
8534 @findex mm-file-name-replace-whitespace
8535 @vindex mm-file-name-replace-whitespace
8536
8537 The standard functions @code{capitalize}, @code{downcase},
8538 @code{upcase}, and @code{upcase-initials} may be useful, too.
8539
8540 Everybody knows that whitespace characters in file names are evil,
8541 except those who don't know.  If you receive lots of attachments from
8542 such unenlightened users, you can make live easier by adding
8543
8544 @lisp
8545 (setq mm-file-name-rewrite-functions
8546       '(mm-file-name-trim-whitespace
8547         mm-file-name-collapse-whitespace
8548         mm-file-name-replace-whitespace))
8549 @end lisp
8550
8551 @noindent
8552 to your @file{.gnus} file.
8553
8554 @end table
8555
8556
8557 @node Charsets
8558 @section Charsets
8559 @cindex charsets
8560
8561 People use different charsets, and we have @sc{mime} to let us know what
8562 charsets they use.  Or rather, we wish we had.  Many people use
8563 newsreaders and mailers that do not understand or use @sc{mime}, and
8564 just send out messages without saying what character sets they use.  To
8565 help a bit with this, some local news hierarchies have policies that say
8566 what character set is the default.  For instance, the @samp{fj}
8567 hierarchy uses @code{iso-2022-jp-2}.
8568
8569 @vindex gnus-group-charset-alist
8570 This knowledge is encoded in the @code{gnus-group-charset-alist}
8571 variable, which is an alist of regexps (use the first item to match full
8572 group names) and default charsets to be used when reading these groups.
8573
8574 In addition, some people do use soi-disant @sc{mime}-aware agents that
8575 aren't.  These blithely mark messages as being in @code{iso-8859-1}
8576 even if they really are in @code{koi-8}.  To help here, the
8577 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
8578 charsets that are listed here will be ignored.  The variable can be
8579 set on a group-by-group basis using the group parameters (@pxref{Group
8580 Parameters}).  The default value is @code{(unknown-8bit x-unknown)},
8581 which includes values some agents insist on having in there.
8582
8583 @vindex gnus-group-posting-charset-alist
8584 When posting, @code{gnus-group-posting-charset-alist} is used to
8585 determine which charsets should not be encoded using the @sc{mime}
8586 encodings.  For instance, some hierarchies discourage using
8587 quoted-printable header encoding.
8588
8589 This variable is an alist of regexps and permitted unencoded charsets
8590 for posting.  Each element of the alist has the form @code{(}@var{test
8591 header body-list}@code{)}, where:
8592
8593 @table @var
8594 @item test
8595 is either a regular expression matching the newsgroup header or a
8596 variable to query,
8597 @item header
8598 is the charset which may be left unencoded in the header (@code{nil}
8599 means encode all charsets),
8600 @item body-list
8601 is a list of charsets which may be encoded using 8bit content-transfer
8602 encoding in the body, or one of the special values @code{nil} (always
8603 encode using quoted-printable) or @code{t} (always use 8bit).
8604 @end table
8605
8606 @cindex Russian
8607 @cindex koi8-r
8608 @cindex koi8-u
8609 @cindex iso-8859-5
8610 @cindex coding system aliases
8611 @cindex preferred charset
8612
8613 Other charset tricks that may be useful, although not Gnus-specific:
8614
8615 If there are several @sc{mime} charsets that encode the same Emacs
8616 charset, you can choose what charset to use by saying the following:
8617
8618 @lisp
8619 (put-charset-property 'cyrillic-iso8859-5
8620                       'preferred-coding-system 'koi8-r)
8621 @end lisp
8622
8623 This means that Russian will be encoded using @code{koi8-r} instead of
8624 the default @code{iso-8859-5} @sc{mime} charset.
8625
8626 If you want to read messages in @code{koi8-u}, you can cheat and say
8627
8628 @lisp
8629 (define-coding-system-alias 'koi8-u 'koi8-r)
8630 @end lisp
8631
8632 This will almost do the right thing.
8633
8634 And finally, to read charsets like @code{windows-1251}, you can say
8635 something like
8636
8637 @lisp
8638 (codepage-setup 1251)
8639 (define-coding-system-alias 'windows-1251 'cp1251)
8640 @end lisp
8641
8642
8643 @node Article Commands
8644 @section Article Commands
8645
8646 @table @kbd
8647
8648 @item A P
8649 @cindex PostScript
8650 @cindex printing
8651 @kindex A P (Summary)
8652 @vindex gnus-ps-print-hook
8653 @findex gnus-summary-print-article
8654 Generate and print a PostScript image of the article buffer
8655 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
8656 run just before printing the buffer.
8657
8658 @end table
8659
8660
8661 @node Summary Sorting
8662 @section Summary Sorting
8663 @cindex summary sorting
8664
8665 You can have the summary buffer sorted in various ways, even though I
8666 can't really see why you'd want that.
8667
8668 @table @kbd
8669
8670 @item C-c C-s C-n
8671 @kindex C-c C-s C-n (Summary)
8672 @findex gnus-summary-sort-by-number
8673 Sort by article number (@code{gnus-summary-sort-by-number}).
8674
8675 @item C-c C-s C-a
8676 @kindex C-c C-s C-a (Summary)
8677 @findex gnus-summary-sort-by-author
8678 Sort by author (@code{gnus-summary-sort-by-author}).
8679
8680 @item C-c C-s C-s
8681 @kindex C-c C-s C-s (Summary)
8682 @findex gnus-summary-sort-by-subject
8683 Sort by subject (@code{gnus-summary-sort-by-subject}).
8684
8685 @item C-c C-s C-d
8686 @kindex C-c C-s C-d (Summary)
8687 @findex gnus-summary-sort-by-date
8688 Sort by date (@code{gnus-summary-sort-by-date}).
8689
8690 @item C-c C-s C-l
8691 @kindex C-c C-s C-l (Summary)
8692 @findex gnus-summary-sort-by-lines
8693 Sort by lines (@code{gnus-summary-sort-by-lines}).
8694
8695 @item C-c C-s C-c
8696 @kindex C-c C-s C-c (Summary)
8697 @findex gnus-summary-sort-by-chars
8698 Sort by article length (@code{gnus-summary-sort-by-chars}).
8699
8700 @item C-c C-s C-i
8701 @kindex C-c C-s C-i (Summary)
8702 @findex gnus-summary-sort-by-score
8703 Sort by score (@code{gnus-summary-sort-by-score}).
8704
8705 @item C-c C-s C-o
8706 @kindex C-c C-s C-o (Summary)
8707 @findex gnus-summary-sort-by-original
8708 Sort using the default sorting method
8709 (@code{gnus-summary-sort-by-original}).
8710 @end table
8711
8712 These functions will work both when you use threading and when you don't
8713 use threading.  In the latter case, all summary lines will be sorted,
8714 line by line.  In the former case, sorting will be done on a
8715 root-by-root basis, which might not be what you were looking for.  To
8716 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8717 Commands}).
8718
8719
8720 @node Finding the Parent
8721 @section Finding the Parent
8722 @cindex parent articles
8723 @cindex referring articles
8724
8725 @table @kbd
8726 @item ^
8727 @kindex ^ (Summary)
8728 @findex gnus-summary-refer-parent-article
8729 If you'd like to read the parent of the current article, and it is not
8730 displayed in the summary buffer, you might still be able to.  That is,
8731 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8732 and the @code{References} in the current article are not mangled, you
8733 can just press @kbd{^} or @kbd{A r}
8734 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
8735 you'll get the parent.  If the parent is already displayed in the
8736 summary buffer, point will just move to this article.
8737
8738 If given a positive numerical prefix, fetch that many articles back into
8739 the ancestry.  If given a negative numerical prefix, fetch just that
8740 ancestor.  So if you say @kbd{3 ^}, gnus will fetch the parent, the
8741 grandparent and the grandgrandparent of the current article.  If you say
8742 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
8743 article.
8744
8745 @item A R (Summary)
8746 @findex gnus-summary-refer-references
8747 @kindex A R (Summary)
8748 Fetch all articles mentioned in the @code{References} header of the
8749 article (@code{gnus-summary-refer-references}).
8750
8751 @item A T (Summary)
8752 @findex gnus-summary-refer-thread
8753 @kindex A T (Summary)
8754 Display the full thread where the current article appears
8755 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
8756 headers in the current group to work, so it usually takes a while.  If
8757 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8758 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
8759 visible effects normally, but it'll make this command work a whole lot
8760 faster.  Of course, it'll make group entry somewhat slow.
8761
8762 @vindex gnus-refer-thread-limit
8763 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8764 articles before the first displayed in the current group) headers to
8765 fetch when doing this command.  The default is 200.  If @code{t}, all
8766 the available headers will be fetched.  This variable can be overridden
8767 by giving the @kbd{A T} command a numerical prefix.
8768
8769 @item M-^ (Summary)
8770 @findex gnus-summary-refer-article
8771 @kindex M-^ (Summary)
8772 @cindex Message-ID
8773 @cindex fetching by Message-ID
8774 You can also ask the @sc{nntp} server for an arbitrary article, no
8775 matter what group it belongs to.  @kbd{M-^}
8776 (@code{gnus-summary-refer-article}) will ask you for a
8777 @code{Message-ID}, which is one of those long, hard-to-read thingies
8778 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
8779 have to get it all exactly right.  No fuzzy searches, I'm afraid.
8780 @end table
8781
8782 The current select method will be used when fetching by
8783 @code{Message-ID} from non-news select method, but you can override this
8784 by giving this command a prefix.
8785
8786 @vindex gnus-refer-article-method
8787 If the group you are reading is located on a back end that does not
8788 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8789 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
8790 would, perhaps, be best if the @sc{nntp} server you consult is the one
8791 updating the spool you are reading from, but that's not really
8792 necessary.
8793
8794 It can also be a list of select methods, as well as the special symbol
8795 @code{current}, which means to use the current select method.  If it
8796 is a list, Gnus will try all the methods in the list until it finds a
8797 match.
8798
8799 Here's an example setting that will first try the current method, and
8800 then ask Deja if that fails:
8801
8802 @lisp
8803 (setq gnus-refer-article-method
8804       '(current
8805         (nnweb "refer" (nnweb-type dejanews))))
8806 @end lisp
8807
8808 Most of the mail back ends support fetching by @code{Message-ID}, but
8809 do not do a particularly excellent job at it.  That is, @code{nnmbox}
8810 and @code{nnbabyl} are able to locate articles from any groups, while
8811 @code{nnml}, @code{nnfolder} and @code{nnimap}1 are only able to locate
8812 articles that have been posted to the current group.  (Anything else
8813 would be too time consuming.)  @code{nnmh} does not support this at
8814 all.
8815
8816
8817 @node Alternative Approaches
8818 @section Alternative Approaches
8819
8820 Different people like to read news using different methods.  This being
8821 gnus, we offer a small selection of minor modes for the summary buffers.
8822
8823 @menu
8824 * Pick and Read::               First mark articles and then read them.
8825 * Binary Groups::               Auto-decode all articles.
8826 @end menu
8827
8828
8829 @node Pick and Read
8830 @subsection Pick and Read
8831 @cindex pick and read
8832
8833 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8834 a two-phased reading interface.  The user first marks in a summary
8835 buffer the articles she wants to read.  Then she starts reading the
8836 articles with just an article buffer displayed.
8837
8838 @findex gnus-pick-mode
8839 @kindex M-x gnus-pick-mode
8840 Gnus provides a summary buffer minor mode that allows
8841 this---@code{gnus-pick-mode}.  This basically means that a few process
8842 mark commands become one-keystroke commands to allow easy marking, and
8843 it provides one additional command for switching to the summary buffer.
8844
8845 Here are the available keystrokes when using pick mode:
8846
8847 @table @kbd
8848 @item .
8849 @kindex . (Pick)
8850 @findex gnus-pick-article-or-thread
8851 Pick the article or thread on the current line
8852 (@code{gnus-pick-article-or-thread}).  If the variable
8853 @code{gnus-thread-hide-subtree} is true, then this key selects the
8854 entire thread when used at the first article of the thread.  Otherwise,
8855 it selects just the article.  If given a numerical prefix, go to that
8856 thread or article and pick it.  (The line number is normally displayed
8857 at the beginning of the summary pick lines.)
8858
8859 @item SPACE
8860 @kindex SPACE (Pick)
8861 @findex gnus-pick-next-page
8862 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
8863 at the end of the buffer, start reading the picked articles.
8864
8865 @item u
8866 @kindex u (Pick)
8867 @findex gnus-pick-unmark-article-or-thread.
8868 Unpick the thread or article
8869 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
8870 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8871 thread if used at the first article of the thread.  Otherwise it unpicks
8872 just the article.  You can give this key a numerical prefix to unpick
8873 the thread or article at that line.
8874
8875 @item RET
8876 @kindex RET (Pick)
8877 @findex gnus-pick-start-reading
8878 @vindex gnus-pick-display-summary
8879 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
8880 given a prefix, mark all unpicked articles as read first.  If
8881 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8882 will still be visible when you are reading.
8883
8884 @end table
8885
8886 All the normal summary mode commands are still available in the
8887 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
8888 which is mapped to the same function
8889 @code{gnus-summary-tick-article-forward}.
8890
8891 If this sounds like a good idea to you, you could say:
8892
8893 @lisp
8894 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8895 @end lisp
8896
8897 @vindex gnus-pick-mode-hook
8898 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8899
8900 @vindex gnus-mark-unpicked-articles-as-read
8901 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8902 all unpicked articles as read.  The default is @code{nil}.
8903
8904 @vindex gnus-summary-pick-line-format
8905 The summary line format in pick mode is slightly different from the
8906 standard format.  At the beginning of each line the line number is
8907 displayed.  The pick mode line format is controlled by the
8908 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8909 Variables}).  It accepts the same format specs that
8910 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8911
8912
8913 @node Binary Groups
8914 @subsection Binary Groups
8915 @cindex binary groups
8916
8917 @findex gnus-binary-mode
8918 @kindex M-x gnus-binary-mode
8919 If you spend much time in binary groups, you may grow tired of hitting
8920 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
8921 is a minor mode for summary buffers that makes all ordinary Gnus article
8922 selection functions uudecode series of articles and display the result
8923 instead of just displaying the articles the normal way.
8924
8925 @kindex g (Binary)
8926 @findex gnus-binary-show-article
8927 The only way, in fact, to see the actual articles is the @kbd{g}
8928 command, when you have turned on this mode
8929 (@code{gnus-binary-show-article}).
8930
8931 @vindex gnus-binary-mode-hook
8932 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8933
8934
8935 @node Tree Display
8936 @section Tree Display
8937 @cindex trees
8938
8939 @vindex gnus-use-trees
8940 If you don't like the normal gnus summary display, you might try setting
8941 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
8942 additional @dfn{tree buffer}.  You can execute all summary mode commands
8943 in the tree buffer.
8944
8945 There are a few variables to customize the tree display, of course:
8946
8947 @table @code
8948 @item gnus-tree-mode-hook
8949 @vindex gnus-tree-mode-hook
8950 A hook called in all tree mode buffers.
8951
8952 @item gnus-tree-mode-line-format
8953 @vindex gnus-tree-mode-line-format
8954 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8955 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
8956 of valid specs, @pxref{Summary Buffer Mode Line}.
8957
8958 @item gnus-selected-tree-face
8959 @vindex gnus-selected-tree-face
8960 Face used for highlighting the selected article in the tree buffer.  The
8961 default is @code{modeline}.
8962
8963 @item gnus-tree-line-format
8964 @vindex gnus-tree-line-format
8965 A format string for the tree nodes.  The name is a bit of a misnomer,
8966 though---it doesn't define a line, but just the node.  The default value
8967 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8968 the name of the poster.  It is vital that all nodes are of the same
8969 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8970
8971 Valid specs are:
8972
8973 @table @samp
8974 @item n
8975 The name of the poster.
8976 @item f
8977 The @code{From} header.
8978 @item N
8979 The number of the article.
8980 @item [
8981 The opening bracket.
8982 @item ]
8983 The closing bracket.
8984 @item s
8985 The subject.
8986 @end table
8987
8988 @xref{Formatting Variables}.
8989
8990 Variables related to the display are:
8991
8992 @table @code
8993 @item gnus-tree-brackets
8994 @vindex gnus-tree-brackets
8995 This is used for differentiating between ``real'' articles and
8996 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
8997 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8998 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8999
9000 @item gnus-tree-parent-child-edges
9001 @vindex gnus-tree-parent-child-edges
9002 This is a list that contains the characters used for connecting parent
9003 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
9004
9005 @end table
9006
9007 @item gnus-tree-minimize-window
9008 @vindex gnus-tree-minimize-window
9009 If this variable is non-@code{nil}, gnus will try to keep the tree
9010 buffer as small as possible to allow more room for the other gnus
9011 windows.  If this variable is a number, the tree buffer will never be
9012 higher than that number.  The default is @code{t}.  Note that if you
9013 have several windows displayed side-by-side in a frame and the tree
9014 buffer is one of these, minimizing the tree window will also resize all
9015 other windows displayed next to it.
9016
9017 @item gnus-generate-tree-function
9018 @vindex gnus-generate-tree-function
9019 @findex gnus-generate-horizontal-tree
9020 @findex gnus-generate-vertical-tree
9021 The function that actually generates the thread tree.  Two predefined
9022 functions are available: @code{gnus-generate-horizontal-tree} and
9023 @code{gnus-generate-vertical-tree} (which is the default).
9024
9025 @end table
9026
9027 Here's an example from a horizontal tree buffer:
9028
9029 @example
9030 @{***@}-(***)-[odd]-[Gun]
9031      |      \[Jan]
9032      |      \[odd]-[Eri]
9033      |      \(***)-[Eri]
9034      |            \[odd]-[Paa]
9035      \[Bjo]
9036      \[Gun]
9037      \[Gun]-[Jor]
9038 @end example
9039
9040 Here's the same thread displayed in a vertical tree buffer:
9041
9042 @example
9043 @{***@}
9044   |--------------------------\-----\-----\
9045 (***)                         [Bjo] [Gun] [Gun]
9046   |--\-----\-----\                          |
9047 [odd] [Jan] [odd] (***)                   [Jor]
9048   |           |     |--\
9049 [Gun]       [Eri] [Eri] [odd]
9050                           |
9051                         [Paa]
9052 @end example
9053
9054 If you're using horizontal trees, it might be nice to display the trees
9055 side-by-side with the summary buffer.  You could add something like the
9056 following to your @file{.gnus.el} file:
9057
9058 @lisp
9059 (setq gnus-use-trees t
9060       gnus-generate-tree-function 'gnus-generate-horizontal-tree
9061       gnus-tree-minimize-window nil)
9062 (gnus-add-configuration
9063  '(article
9064    (vertical 1.0
9065              (horizontal 0.25
9066                          (summary 0.75 point)
9067                          (tree 1.0))
9068              (article 1.0))))
9069 @end lisp
9070
9071 @xref{Window Layout}.
9072
9073
9074 @node Mail Group Commands
9075 @section Mail Group Commands
9076 @cindex mail group commands
9077
9078 Some commands only make sense in mail groups.  If these commands are
9079 invalid in the current group, they will raise a hell and let you know.
9080
9081 All these commands (except the expiry and edit commands) use the
9082 process/prefix convention (@pxref{Process/Prefix}).
9083
9084 @table @kbd
9085
9086 @item B e
9087 @kindex B e (Summary)
9088 @findex gnus-summary-expire-articles
9089 Run all expirable articles in the current group through the expiry
9090 process (@code{gnus-summary-expire-articles}).  That is, delete all
9091 expirable articles in the group that have been around for a while.
9092 (@pxref{Expiring Mail}).
9093
9094 @item B C-M-e
9095 @kindex B C-M-e (Summary)
9096 @findex gnus-summary-expire-articles-now
9097 Delete all the expirable articles in the group
9098 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
9099 articles eligible for expiry in the current group will
9100 disappear forever into that big @file{/dev/null} in the sky.
9101
9102 @item B DEL
9103 @kindex B DEL (Summary)
9104 @findex gnus-summary-delete-article
9105 @c @icon{gnus-summary-mail-delete}
9106 Delete the mail article.  This is ``delete'' as in ``delete it from your
9107 disk forever and ever, never to return again.'' Use with caution.
9108 (@code{gnus-summary-delete-article}).
9109
9110 @item B m
9111 @kindex B m (Summary)
9112 @cindex move mail
9113 @findex gnus-summary-move-article
9114 @vindex gnus-preserve-marks
9115 Move the article from one mail group to another
9116 (@code{gnus-summary-move-article}).  Marks will be preserved if
9117 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
9118
9119 @item B c
9120 @kindex B c (Summary)
9121 @cindex copy mail
9122 @findex gnus-summary-copy-article
9123 @c @icon{gnus-summary-mail-copy}
9124 Copy the article from one group (mail group or not) to a mail group
9125 (@code{gnus-summary-copy-article}).  Marks will be preserved if
9126 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
9127
9128 @item B B
9129 @kindex B B (Summary)
9130 @cindex crosspost mail
9131 @findex gnus-summary-crosspost-article
9132 Crosspost the current article to some other group
9133 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
9134 the article in the other group, and the Xref headers of the article will
9135 be properly updated.
9136
9137 @item B i
9138 @kindex B i (Summary)
9139 @findex gnus-summary-import-article
9140 Import an arbitrary file into the current mail newsgroup
9141 (@code{gnus-summary-import-article}).  You will be prompted for a file
9142 name, a @code{From} header and a @code{Subject} header.
9143
9144 @item B r
9145 @kindex B r (Summary)
9146 @findex gnus-summary-respool-article
9147 Respool the mail article (@code{gnus-summary-respool-article}).
9148 @code{gnus-summary-respool-default-method} will be used as the default
9149 select method when respooling.  This variable is @code{nil} by default,
9150 which means that the current group select method will be used instead.
9151 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
9152 (which is the default).
9153
9154 @item B w
9155 @itemx e
9156 @kindex B w (Summary)
9157 @kindex e (Summary)
9158 @findex gnus-summary-edit-article
9159 @kindex C-c C-c (Article)
9160 Edit the current article (@code{gnus-summary-edit-article}).  To finish
9161 editing and make the changes permanent, type @kbd{C-c C-c}
9162 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
9163 @kbd{C-c C-c} command, gnus won't re-highlight the article.
9164
9165 @item B q
9166 @kindex B q (Summary)
9167 @findex gnus-summary-respool-query
9168 If you want to re-spool an article, you might be curious as to what group
9169 the article will end up in before you do the re-spooling.  This command
9170 will tell you (@code{gnus-summary-respool-query}).
9171
9172 @item B t
9173 @kindex B t (Summary)
9174 @findex gnus-summary-respool-trace
9175 Similarly, this command will display all fancy splitting patterns used
9176 when repooling, if any (@code{gnus-summary-respool-trace}).
9177
9178 @item B p
9179 @kindex B p (Summary)
9180 @findex gnus-summary-article-posted-p
9181 Some people have a tendency to send you "courtesy" copies when they
9182 follow up to articles you have posted.  These usually have a
9183 @code{Newsgroups} header in them, but not always.  This command
9184 (@code{gnus-summary-article-posted-p}) will try to fetch the current
9185 article from your news server (or rather, from
9186 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
9187 report back whether it found the article or not.  Even if it says that
9188 it didn't find the article, it may have been posted anyway---mail
9189 propagation is much faster than news propagation, and the news copy may
9190 just not have arrived yet.
9191
9192 @end table
9193
9194 @vindex gnus-move-split-methods
9195 @cindex moving articles
9196 If you move (or copy) articles regularly, you might wish to have gnus
9197 suggest where to put the articles.  @code{gnus-move-split-methods} is a
9198 variable that uses the same syntax as @code{gnus-split-methods}
9199 (@pxref{Saving Articles}).  You may customize that variable to create
9200 suggestions you find reasonable.  (Note that
9201 @code{gnus-move-split-methods} uses group names where
9202 @code{gnus-split-methods} uses file names.)
9203
9204 @lisp
9205 (setq gnus-move-split-methods
9206       '(("^From:.*Lars Magne" "nnml:junk")
9207         ("^Subject:.*gnus" "nnfolder:important")
9208         (".*" "nnml:misc")))
9209 @end lisp
9210
9211
9212 @node Various Summary Stuff
9213 @section Various Summary Stuff
9214
9215 @menu
9216 * Summary Group Information::   Information oriented commands.
9217 * Searching for Articles::      Multiple article commands.
9218 * Summary Generation Commands::  
9219 * Really Various Summary Commands::  Those pesky non-conformant commands.
9220 @end menu
9221
9222 @table @code
9223 @vindex gnus-summary-mode-hook
9224 @item gnus-summary-mode-hook
9225 This hook is called when creating a summary mode buffer.
9226
9227 @vindex gnus-summary-generate-hook
9228 @item gnus-summary-generate-hook
9229 This is called as the last thing before doing the threading and the
9230 generation of the summary buffer.  It's quite convenient for customizing
9231 the threading variables based on what data the newsgroup has.  This hook
9232 is called from the summary buffer after most summary buffer variables
9233 have been set.
9234
9235 @vindex gnus-summary-prepare-hook
9236 @item gnus-summary-prepare-hook
9237 It is called after the summary buffer has been generated.  You might use
9238 it to, for instance, highlight lines or modify the look of the buffer in
9239 some other ungodly manner.  I don't care.
9240
9241 @vindex gnus-summary-prepared-hook
9242 @item gnus-summary-prepared-hook
9243 A hook called as the very last thing after the summary buffer has been
9244 generated.
9245
9246 @vindex gnus-summary-ignore-duplicates
9247 @item gnus-summary-ignore-duplicates
9248 When gnus discovers two articles that have the same @code{Message-ID},
9249 it has to do something drastic.  No articles are allowed to have the
9250 same @code{Message-ID}, but this may happen when reading mail from some
9251 sources.  Gnus allows you to customize what happens with this variable.
9252 If it is @code{nil} (which is the default), gnus will rename the
9253 @code{Message-ID} (for display purposes only) and display the article as
9254 any other article.  If this variable is @code{t}, it won't display the
9255 article---it'll be as if it never existed.
9256
9257 @vindex gnus-alter-articles-to-read-function
9258 @item gnus-alter-articles-to-read-function
9259 This function, which takes two parameters (the group name and the list
9260 of articles to be selected), is called to allow the user to alter the
9261 list of articles to be selected.
9262
9263 For instance, the following function adds the list of cached articles to
9264 the list in one particular group:
9265
9266 @lisp
9267 (defun my-add-cached-articles (group articles)
9268   (if (string= group "some.group")
9269       (append gnus-newsgroup-cached articles)
9270     articles))
9271 @end lisp
9272
9273 @vindex gnus-newsgroup-variables
9274 @item gnus-newsgroup-variables
9275 A list of newsgroup (summary buffer) local variables, or cons of
9276 variables and their default values (when the default values are not
9277 nil), that should be made global while the summary buffer is active.
9278 These variables can be used to set variables in the group parameters
9279 while still allowing them to affect operations done in other
9280 buffers. For example:
9281
9282 @lisp
9283 (setq gnus-newsgroup-variables 
9284      '(message-use-followup-to
9285        (gnus-visible-headers . 
9286          "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
9287 @end lisp
9288
9289 @end table
9290
9291
9292 @node Summary Group Information
9293 @subsection Summary Group Information
9294
9295 @table @kbd
9296
9297 @item H f
9298 @kindex H f (Summary)
9299 @findex gnus-summary-fetch-faq
9300 @vindex gnus-group-faq-directory
9301 Try to fetch the FAQ (list of frequently asked questions) for the
9302 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
9303 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
9304 on a remote machine.  This variable can also be a list of directories.
9305 In that case, giving a prefix to this command will allow you to choose
9306 between the various sites.  @code{ange-ftp} or @code{efs} will probably
9307 be used for fetching the file.
9308
9309 @item H d
9310 @kindex H d (Summary)
9311 @findex gnus-summary-describe-group
9312 Give a brief description of the current group
9313 (@code{gnus-summary-describe-group}).  If given a prefix, force
9314 rereading the description from the server.
9315
9316 @item H h
9317 @kindex H h (Summary)
9318 @findex gnus-summary-describe-briefly
9319 Give an extremely brief description of the most important summary
9320 keystrokes (@code{gnus-summary-describe-briefly}).
9321
9322 @item H i
9323 @kindex H i (Summary)
9324 @findex gnus-info-find-node
9325 Go to the gnus info node (@code{gnus-info-find-node}).
9326 @end table
9327
9328
9329 @node Searching for Articles
9330 @subsection Searching for Articles
9331
9332 @table @kbd
9333
9334 @item M-s
9335 @kindex M-s (Summary)
9336 @findex gnus-summary-search-article-forward
9337 Search through all subsequent (raw) articles for a regexp
9338 (@code{gnus-summary-search-article-forward}).
9339
9340 @item M-r
9341 @kindex M-r (Summary)
9342 @findex gnus-summary-search-article-backward
9343 Search through all previous (raw) articles for a regexp
9344 (@code{gnus-summary-search-article-backward}).
9345
9346 @item &
9347 @kindex & (Summary)
9348 @findex gnus-summary-execute-command
9349 This command will prompt you for a header, a regular expression to match
9350 on this field, and a command to be executed if the match is made
9351 (@code{gnus-summary-execute-command}).  If the header is an empty
9352 string, the match is done on the entire article.  If given a prefix,
9353 search backward instead.
9354
9355 For instance, @kbd{& RET some.*string #} will put the process mark on
9356 all articles that have heads or bodies that match @samp{some.*string}.
9357
9358 @item M-&
9359 @kindex M-& (Summary)
9360 @findex gnus-summary-universal-argument
9361 Perform any operation on all articles that have been marked with
9362 the process mark (@code{gnus-summary-universal-argument}).
9363 @end table
9364
9365 @node Summary Generation Commands
9366 @subsection Summary Generation Commands
9367
9368 @table @kbd
9369
9370 @item Y g
9371 @kindex Y g (Summary)
9372 @findex gnus-summary-prepare
9373 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
9374
9375 @item Y c
9376 @kindex Y c (Summary)
9377 @findex gnus-summary-insert-cached-articles
9378 Pull all cached articles (for the current group) into the summary buffer
9379 (@code{gnus-summary-insert-cached-articles}).
9380
9381 @end table
9382
9383
9384 @node Really Various Summary Commands
9385 @subsection Really Various Summary Commands
9386
9387 @table @kbd
9388
9389 @item A D
9390 @itemx C-d
9391 @kindex C-d (Summary)
9392 @kindex A D (Summary)
9393 @findex gnus-summary-enter-digest-group
9394 If the current article is a collection of other articles (for instance,
9395 a digest), you might use this command to enter a group based on the that
9396 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
9397 guess what article type is currently displayed unless you give a prefix
9398 to this command, which forces a ``digest'' interpretation.  Basically,
9399 whenever you see a message that is a collection of other messages of
9400 some format, you @kbd{C-d} and read these messages in a more convenient
9401 fashion.
9402
9403 @item C-M-d
9404 @kindex C-M-d (Summary)
9405 @findex gnus-summary-read-document
9406 This command is very similar to the one above, but lets you gather
9407 several documents into one biiig group
9408 (@code{gnus-summary-read-document}).  It does this by opening several
9409 @code{nndoc} groups for each document, and then opening an
9410 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
9411 command understands the process/prefix convention
9412 (@pxref{Process/Prefix}).
9413
9414 @item C-t
9415 @kindex C-t (Summary)
9416 @findex gnus-summary-toggle-truncation
9417 Toggle truncation of summary lines
9418 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
9419 line centering function in the summary buffer, so it's not a good idea
9420 to have truncation switched off while reading articles.
9421
9422 @item =
9423 @kindex = (Summary)
9424 @findex gnus-summary-expand-window
9425 Expand the summary buffer window (@code{gnus-summary-expand-window}).
9426 If given a prefix, force an @code{article} window configuration.
9427
9428 @item C-M-e
9429 @kindex C-M-e (Summary)
9430 @findex gnus-summary-edit-parameters
9431 Edit the group parameters (@pxref{Group Parameters}) of the current
9432 group (@code{gnus-summary-edit-parameters}).
9433
9434 @item C-M-a
9435 @kindex C-M-a (Summary)
9436 @findex gnus-summary-customize-parameters
9437 Customize the group parameters (@pxref{Group Parameters}) of the current
9438 group (@code{gnus-summary-customize-parameters}).
9439
9440 @end table
9441
9442
9443 @node Exiting the Summary Buffer
9444 @section Exiting the Summary Buffer
9445 @cindex summary exit
9446 @cindex exiting groups
9447
9448 Exiting from the summary buffer will normally update all info on the
9449 group and return you to the group buffer.
9450
9451 @table @kbd
9452
9453 @item Z Z
9454 @itemx q
9455 @kindex Z Z (Summary)
9456 @kindex q (Summary)
9457 @findex gnus-summary-exit
9458 @vindex gnus-summary-exit-hook
9459 @vindex gnus-summary-prepare-exit-hook
9460 @c @icon{gnus-summary-exit}
9461 Exit the current group and update all information on the group
9462 (@code{gnus-summary-exit}).  @code{gnus-summary-prepare-exit-hook} is
9463 called before doing much of the exiting, which calls
9464 @code{gnus-summary-expire-articles} by default.
9465 @code{gnus-summary-exit-hook} is called after finishing the exit
9466 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
9467 group mode having no more (unread) groups.
9468
9469 @item Z E
9470 @itemx Q
9471 @kindex Z E (Summary)
9472 @kindex Q (Summary)
9473 @findex gnus-summary-exit-no-update
9474 Exit the current group without updating any information on the group
9475 (@code{gnus-summary-exit-no-update}).
9476
9477 @item Z c
9478 @itemx c
9479 @kindex Z c (Summary)
9480 @kindex c (Summary)
9481 @findex gnus-summary-catchup-and-exit
9482 @c @icon{gnus-summary-catchup-and-exit}
9483 Mark all unticked articles in the group as read and then exit
9484 (@code{gnus-summary-catchup-and-exit}).
9485
9486 @item Z C
9487 @kindex Z C (Summary)
9488 @findex gnus-summary-catchup-all-and-exit
9489 Mark all articles, even the ticked ones, as read and then exit
9490 (@code{gnus-summary-catchup-all-and-exit}).
9491
9492 @item Z n
9493 @kindex Z n (Summary)
9494 @findex gnus-summary-catchup-and-goto-next-group
9495 Mark all articles as read and go to the next group
9496 (@code{gnus-summary-catchup-and-goto-next-group}).
9497
9498 @item Z R
9499 @kindex Z R (Summary)
9500 @findex gnus-summary-reselect-current-group
9501 Exit this group, and then enter it again
9502 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
9503 all articles, both read and unread.
9504
9505 @item Z G
9506 @itemx M-g
9507 @kindex Z G (Summary)
9508 @kindex M-g (Summary)
9509 @findex gnus-summary-rescan-group
9510 @c @icon{gnus-summary-mail-get}
9511 Exit the group, check for new articles in the group, and select the
9512 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
9513 articles, both read and unread.
9514
9515 @item Z N
9516 @kindex Z N (Summary)
9517 @findex gnus-summary-next-group
9518 Exit the group and go to the next group
9519 (@code{gnus-summary-next-group}).
9520
9521 @item Z P
9522 @kindex Z P (Summary)
9523 @findex gnus-summary-prev-group
9524 Exit the group and go to the previous group
9525 (@code{gnus-summary-prev-group}).
9526
9527 @item Z s
9528 @kindex Z s (Summary)
9529 @findex gnus-summary-save-newsrc
9530 Save the current number of read/marked articles in the dribble buffer
9531 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
9532 given a prefix, also save the @file{.newsrc} file(s).  Using this
9533 command will make exit without updating (the @kbd{Q} command) worthless.
9534 @end table
9535
9536 @vindex gnus-exit-group-hook
9537 @code{gnus-exit-group-hook} is called when you exit the current group
9538 with an ``updating'' exit.  For instance @kbd{Q}
9539 (@code{gnus-summary-exit-no-update}) does not call this hook.
9540
9541 @findex gnus-summary-wake-up-the-dead
9542 @findex gnus-dead-summary-mode
9543 @vindex gnus-kill-summary-on-exit
9544 If you're in the habit of exiting groups, and then changing your mind
9545 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
9546 If you do that, gnus won't kill the summary buffer when you exit it.
9547 (Quelle surprise!)  Instead it will change the name of the buffer to
9548 something like @samp{*Dead Summary ... *} and install a minor mode
9549 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
9550 buffer, you'll find that all keys are mapped to a function called
9551 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
9552 summary buffer will result in a live, normal summary buffer.
9553
9554 There will never be more than one dead summary buffer at any one time.
9555
9556 @vindex gnus-use-cross-reference
9557 The data on the current group will be updated (which articles you have
9558 read, which articles you have replied to, etc.) when you exit the
9559 summary buffer.  If the @code{gnus-use-cross-reference} variable is
9560 @code{t} (which is the default), articles that are cross-referenced to
9561 this group and are marked as read, will also be marked as read in the
9562 other subscribed groups they were cross-posted to.  If this variable is
9563 neither @code{nil} nor @code{t}, the article will be marked as read in
9564 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
9565
9566
9567 @node Crosspost Handling
9568 @section Crosspost Handling
9569
9570 @cindex velveeta
9571 @cindex spamming
9572 Marking cross-posted articles as read ensures that you'll never have to
9573 read the same article more than once.  Unless, of course, somebody has
9574 posted it to several groups separately.  Posting the same article to
9575 several groups (not cross-posting) is called @dfn{spamming}, and you are
9576 by law required to send nasty-grams to anyone who perpetrates such a
9577 heinous crime.  You may want to try NoCeM handling to filter out spam
9578 (@pxref{NoCeM}).
9579
9580 Remember: Cross-posting is kinda ok, but posting the same article
9581 separately to several groups is not.  Massive cross-posting (aka.
9582 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
9583 @code{gnus-summary-mail-crosspost-complaint} command to complain about
9584 excessive crossposting (@pxref{Summary Mail Commands}).
9585
9586 @cindex cross-posting
9587 @cindex Xref
9588 @cindex @sc{nov}
9589 One thing that may cause Gnus to not do the cross-posting thing
9590 correctly is if you use an @sc{nntp} server that supports @sc{xover}
9591 (which is very nice, because it speeds things up considerably) which
9592 does not include the @code{Xref} header in its @sc{nov} lines.  This is
9593 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
9594 even with @sc{xover} by registering the @code{Xref} lines of all
9595 articles you actually read, but if you kill the articles, or just mark
9596 them as read without reading them, Gnus will not get a chance to snoop
9597 the @code{Xref} lines out of these articles, and will be unable to use
9598 the cross reference mechanism.
9599
9600 @cindex LIST overview.fmt
9601 @cindex overview.fmt
9602 To check whether your @sc{nntp} server includes the @code{Xref} header
9603 in its overview files, try @samp{telnet your.nntp.server nntp},
9604 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
9605 overview.fmt}.  This may not work, but if it does, and the last line you
9606 get does not read @samp{Xref:full}, then you should shout and whine at
9607 your news admin until she includes the @code{Xref} header in the
9608 overview files.
9609
9610 @vindex gnus-nov-is-evil
9611 If you want Gnus to get the @code{Xref}s right all the time, you have to
9612 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
9613 considerably.
9614
9615 C'est la vie.
9616
9617 For an alternative approach, @pxref{Duplicate Suppression}.
9618
9619
9620 @node Duplicate Suppression
9621 @section Duplicate Suppression
9622
9623 By default, gnus tries to make sure that you don't have to read the same
9624 article more than once by utilizing the crossposting mechanism
9625 (@pxref{Crosspost Handling}).  However, that simple and efficient
9626 approach may not work satisfactory for some users for various
9627 reasons.
9628
9629 @enumerate
9630 @item
9631 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
9632 is evil and not very common.
9633
9634 @item
9635 The @sc{nntp} server may fail to include the @code{Xref} header in the
9636 @file{.overview} data bases.  This is evil and all too common, alas.
9637
9638 @item
9639 You may be reading the same group (or several related groups) from
9640 different @sc{nntp} servers.
9641
9642 @item
9643 You may be getting mail that duplicates articles posted to groups.
9644 @end enumerate
9645
9646 I'm sure there are other situations where @code{Xref} handling fails as
9647 well, but these four are the most common situations.
9648
9649 If, and only if, @code{Xref} handling fails for you, then you may
9650 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
9651 will remember the @code{Message-ID}s of all articles you have read or
9652 otherwise marked as read, and then, as if by magic, mark them as read
9653 all subsequent times you see them---in @emph{all} groups.  Using this
9654 mechanism is quite likely to be somewhat inefficient, but not overly
9655 so.  It's certainly preferable to reading the same articles more than
9656 once.
9657
9658 Duplicate suppression is not a very subtle instrument.  It's more like a
9659 sledge hammer than anything else.  It works in a very simple
9660 fashion---if you have marked an article as read, it adds this Message-ID
9661 to a cache.  The next time it sees this Message-ID, it will mark the
9662 article as read with the @samp{M} mark.  It doesn't care what group it
9663 saw the article in.
9664
9665 @table @code
9666 @item gnus-suppress-duplicates
9667 @vindex gnus-suppress-duplicates
9668 If non-@code{nil}, suppress duplicates.
9669
9670 @item gnus-save-duplicate-list
9671 @vindex gnus-save-duplicate-list
9672 If non-@code{nil}, save the list of duplicates to a file.  This will
9673 make startup and shutdown take longer, so the default is @code{nil}.
9674 However, this means that only duplicate articles read in a single gnus
9675 session are suppressed.
9676
9677 @item gnus-duplicate-list-length
9678 @vindex gnus-duplicate-list-length
9679 This variable says how many @code{Message-ID}s to keep in the duplicate
9680 suppression list.  The default is 10000.
9681
9682 @item gnus-duplicate-file
9683 @vindex gnus-duplicate-file
9684 The name of the file to store the duplicate suppression list in.  The
9685 default is @file{~/News/suppression}.
9686 @end table
9687
9688 If you have a tendency to stop and start gnus often, setting
9689 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
9690 you leave gnus running for weeks on end, you may have it @code{nil}.  On
9691 the other hand, saving the list makes startup and shutdown much slower,
9692 so that means that if you stop and start gnus often, you should set
9693 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
9694 to you to figure out, I think.
9695
9696 @node Security
9697 @section Security
9698
9699 Gnus is able to verify signed messages or decrypt encrypted messages.
9700 The formats that are supported are PGP (plain text, RFC 1991 format),
9701 PGP/MIME (RFC 2015/3156) and S/MIME, however you need some external
9702 programs to get things to work:
9703
9704 @enumerate
9705 @item
9706 To verify or decrypt PGP messages, you have to install mailcrypt or
9707 gpg.el as well as a OpenPGP implementation (such as GnuPG). @xref{Using GPG}.
9708
9709 @item
9710 To verify or decrypt S/MIME message, you need to install OpenSSL.
9711 OpenSSL 0.9.6 or newer is recommended.
9712
9713 @end enumerate
9714
9715 More information on how to set things up can be found in the message
9716 manual. @xref{Security, ,Security, message, The Message Manual}.
9717
9718 @table @code
9719 @item mm-verify-option
9720 @vindex mm-verify-option
9721 Option of verifying signed parts.  @code{never}, not verify;
9722 @code{always}, always verify; @code{known}, only verify known
9723 protocols. Otherwise, ask user.
9724
9725 @item mm-decrypt-option
9726 @vindex mm-decrypt-option
9727 Option of decrypting encrypted parts.  @code{never}, no decryption;
9728 @code{always}, always decrypt @code{known}, only decrypt known
9729 protocols. Otherwise, ask user.
9730
9731 @end table
9732
9733 @node Mailing List
9734 @section Mailing List
9735
9736 Gnus understands some mailing list fields of RFC 2369.  To enable it,
9737 either add a `to-list' group parameter (@pxref{Group Parameters}),
9738 possibly using @kbd{A M} in the summary buffer, or say:
9739
9740 @lisp
9741 (add-hook 'gnus-summary-mode-hook 'turn-on-gnus-mailing-list-mode)
9742 @end lisp
9743
9744 That enables the following commands to the summary buffer:
9745
9746 @table @kbd
9747
9748 @item C-c C-n h
9749 @kindex C-c C-n h (Summary)
9750 @findex gnus-mailing-list-help
9751 Send a message to fetch mailing list help, if List-Help field exists.
9752
9753 @item C-c C-n s
9754 @kindex C-c C-n s (Summary)
9755 @findex gnus-mailing-list-subscribe
9756 Send a message to subscribe the mailing list, if List-Subscribe field exists.
9757
9758 @item C-c C-n u
9759 @kindex C-c C-n u (Summary)
9760 @findex gnus-mailing-list-unsubscribe
9761 Send a message to unsubscribe the mailing list, if List-Unsubscribe
9762 field exists.
9763
9764 @item C-c C-n p
9765 @kindex C-c C-n p (Summary)
9766 @findex gnus-mailing-list-post
9767 Post to the mailing list, if List-Post field exists.
9768
9769 @item C-c C-n o
9770 @kindex C-c C-n o (Summary)
9771 @findex gnus-mailing-list-owner
9772 Send a message to the mailing list owner, if List-Owner field exists.
9773
9774 @item C-c C-n a
9775 @kindex C-c C-n a (Summary)
9776 @findex gnus-mailing-list-owner
9777 Browse the mailing list archive, if List-Archive field exists.
9778
9779 @end table
9780
9781 @node Article Buffer
9782 @chapter Article Buffer
9783 @cindex article buffer
9784
9785 The articles are displayed in the article buffer, of which there is only
9786 one.  All the summary buffers share the same article buffer unless you
9787 tell gnus otherwise.
9788
9789 @menu
9790 * Hiding Headers::              Deciding what headers should be displayed.
9791 * Using MIME::                  Pushing articles through @sc{mime} before reading them.
9792 * Customizing Articles::        Tailoring the look of the articles.
9793 * Article Keymap::              Keystrokes available in the article buffer.
9794 * Misc Article::                Other stuff.
9795 @end menu
9796
9797
9798 @node Hiding Headers
9799 @section Hiding Headers
9800 @cindex hiding headers
9801 @cindex deleting headers
9802
9803 The top section of each article is the @dfn{head}.  (The rest is the
9804 @dfn{body}, but you may have guessed that already.)
9805
9806 @vindex gnus-show-all-headers
9807 There is a lot of useful information in the head: the name of the person
9808 who wrote the article, the date it was written and the subject of the
9809 article.  That's well and nice, but there's also lots of information
9810 most people do not want to see---what systems the article has passed
9811 through before reaching you, the @code{Message-ID}, the
9812 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9813 of some of those lines.  If you want to keep all those lines in the
9814 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9815
9816 Gnus provides you with two variables for sifting headers:
9817
9818 @table @code
9819
9820 @item gnus-visible-headers
9821 @vindex gnus-visible-headers
9822 If this variable is non-@code{nil}, it should be a regular expression
9823 that says what headers you wish to keep in the article buffer.  All
9824 headers that do not match this variable will be hidden.
9825
9826 For instance, if you only want to see the name of the person who wrote
9827 the article and the subject, you'd say:
9828
9829 @lisp
9830 (setq gnus-visible-headers "^From:\\|^Subject:")
9831 @end lisp
9832
9833 This variable can also be a list of regexps to match headers to
9834 remain visible.
9835
9836 @item gnus-ignored-headers
9837 @vindex gnus-ignored-headers
9838 This variable is the reverse of @code{gnus-visible-headers}.  If this
9839 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9840 should be a regular expression that matches all lines that you want to
9841 hide.  All lines that do not match this variable will remain visible.
9842
9843 For instance, if you just want to get rid of the @code{References} field
9844 and the @code{Xref} field, you might say:
9845
9846 @lisp
9847 (setq gnus-ignored-headers "^References:\\|^Xref:")
9848 @end lisp
9849
9850 This variable can also be a list of regexps to match headers to
9851 be removed.
9852
9853 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9854 variable will have no effect.
9855
9856 @end table
9857
9858 @vindex gnus-sorted-header-list
9859 Gnus can also sort the headers for you.  (It does this by default.)  You
9860 can control the sorting by setting the @code{gnus-sorted-header-list}
9861 variable.  It is a list of regular expressions that says in what order
9862 the headers are to be displayed.
9863
9864 For instance, if you want the name of the author of the article first,
9865 and then the subject, you might say something like:
9866
9867 @lisp
9868 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9869 @end lisp
9870
9871 Any headers that are to remain visible, but are not listed in this
9872 variable, will be displayed in random order after all the headers listed in this variable.
9873
9874 @findex gnus-article-hide-boring-headers
9875 @vindex gnus-boring-article-headers
9876 You can hide further boring headers by setting
9877 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
9878 does depends on the @code{gnus-boring-article-headers} variable.  It's a
9879 list, but this list doesn't actually contain header names.  Instead is
9880 lists various @dfn{boring conditions} that Gnus can check and remove
9881 from sight.
9882
9883 These conditions are:
9884 @table @code
9885 @item empty
9886 Remove all empty headers.
9887 @item followup-to
9888 Remove the @code{Followup-To} header if it is identical to the
9889 @code{Newsgroups} header.
9890 @item reply-to
9891 Remove the @code{Reply-To} header if it lists the same address as the
9892 @code{From} header.
9893 @item newsgroups
9894 Remove the @code{Newsgroups} header if it only contains the current group
9895 name.
9896 @item to-address
9897 Remove the @code{To} header if it only contains the address identical to
9898 the current groups's @code{to-address} parameter.
9899 @item date
9900 Remove the @code{Date} header if the article is less than three days
9901 old.
9902 @item long-to
9903 Remove the @code{To} header if it is very long.
9904 @item many-to
9905 Remove all @code{To} headers if there are more than one.
9906 @end table
9907
9908 To include these three elements, you could say something like;
9909
9910 @lisp
9911 (setq gnus-boring-article-headers
9912       '(empty followup-to reply-to))
9913 @end lisp
9914
9915 This is also the default value for this variable.
9916
9917
9918 @node Using MIME
9919 @section Using MIME
9920 @cindex @sc{mime}
9921
9922 Mime is a standard for waving your hands through the air, aimlessly,
9923 while people stand around yawning.
9924
9925 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9926 while all newsreaders die of fear.
9927
9928 @sc{mime} may specify what character set the article uses, the encoding
9929 of the characters, and it also makes it possible to embed pictures and
9930 other naughty stuff in innocent-looking articles.
9931
9932 @vindex gnus-show-mime
9933 @vindex gnus-article-display-method-for-mime
9934 @vindex gnus-strict-mime
9935 @findex gnus-article-display-mime-message
9936 Gnus handles @sc{mime} by pushing the articles through
9937 @code{gnus-article-display-method-for-mime}, which is
9938 @code{gnus-article-display-mime-message} by default.  This function
9939 calls the SEMI MIME-View program to actually do the work.  For more
9940 information on SEMI MIME-View, see its manual page (however it is not
9941 existed yet, sorry).
9942
9943 Set @code{gnus-show-mime} to @code{t} if you want to use
9944 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
9945 non-@code{nil}, the @sc{mime} method will only be used if there are
9946 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
9947 set, then you'll see some unfortunate display glitches in the article
9948 buffer.  These can't be avoided.
9949
9950 In GNUS or Gnus, it might be best to just use the toggling functions
9951 from the summary buffer to avoid getting nasty surprises. (For instance,
9952 you enter the group @samp{alt.sing-a-long} and, before you know it,
9953 @sc{mime} has decoded the sound file in the article and some horrible
9954 sing-a-long song comes screaming out your speakers, and you can't find
9955 the volume button, because there isn't one, and people are starting to
9956 look at you, and you try to stop the program, but you can't, and you
9957 can't find the program to control the volume, and everybody else in the
9958 room suddenly decides to look at you disdainfully, and you'll feel
9959 rather stupid.)
9960
9961 Any similarity to real events and people is purely coincidental.  Ahem.
9962
9963 To avoid such kind of situation, gnus stops to use
9964 @code{metamail-buffer}.  So now, you can set @code{gnus-show-mime} to
9965 non-@code{nil} every-time, then you can push button in the article
9966 buffer when there are nobody else.
9967
9968 Also see @pxref{MIME Commands}.
9969
9970
9971 @node Customizing Articles
9972 @section Customizing Articles
9973 @cindex article customization
9974
9975 A slew of functions for customizing how the articles are to look like
9976 exist.  You can call these functions interactively, or you can have them
9977 called automatically when you select the articles.
9978
9979 To have them called automatically, you should set the corresponding
9980 ``treatment'' variable.  For instance, to have headers hidden, you'd set
9981 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
9982 be set, but first we discuss the values these variables can have.
9983
9984 Note: Some values, while valid, make little sense.  Check the list below
9985 for sensible values.
9986
9987 @enumerate
9988 @item
9989 @code{nil}: Don't do this treatment.
9990
9991 @item
9992 @code{t}: Do this treatment on all body parts.
9993
9994 @item
9995 @code{head}: Do the treatment on the headers.
9996
9997 @item
9998 @code{last}: Do this treatment on the last part.
9999
10000 @item
10001 An integer: Do this treatment on all body parts that have a length less
10002 than this number.
10003
10004 @item
10005 A list of strings: Do this treatment on all body parts that are in
10006 articles that are read in groups that have names that match one of the
10007 regexps in the list.
10008
10009 @item
10010 A list where the first element is not a string:
10011
10012 The list is evaluated recursively.  The first element of the list is a
10013 predicate.  The following predicates are recognized: @code{or},
10014 @code{and}, @code{not} and @code{typep}.  Here's an example:
10015
10016 @lisp
10017 (or last
10018     (typep "text/x-vcard"))
10019 @end lisp
10020
10021 @item
10022 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
10023 non-nil.
10024
10025 @end enumerate
10026
10027 You may have noticed that the word @dfn{part} is used here.  This refers
10028 to the fact that some messages are @sc{mime} multipart articles that may
10029 be divided into several parts.  Articles that are not multiparts are
10030 considered to contain just a single part.
10031
10032 @vindex gnus-article-treat-types
10033 Are the treatments applied to all sorts of multipart parts?  Yes, if you
10034 want to, but by default, only @samp{text/plain} parts are given the
10035 treatment.  This is controlled by the @code{gnus-article-treat-types}
10036 variable, which is a list of regular expressions that are matched to the
10037 type of the part.  This variable is ignored if the value of the
10038 controlling variable is a predicate list, as described above.
10039
10040 The following treatment options are available.  The easiest way to
10041 customize this is to examine the @code{gnus-article-treat} customization
10042 group.  Values in parenthesis are suggested sensible values.  Others are
10043 possible but those listed are probably sufficient for most people.
10044
10045 @table @code
10046 @item gnus-treat-buttonize (t, integer)
10047 @item gnus-treat-buttonize-head (head)
10048 @item gnus-treat-capitalize-sentences (t, integer)
10049 @item gnus-treat-date-english (head)
10050 @item gnus-treat-date-iso8601 (head)
10051 @item gnus-treat-date-lapsed (head)
10052 @item gnus-treat-date-local (head)
10053 @item gnus-treat-date-original (head)
10054 @item gnus-treat-date-user-defined (head)
10055 @item gnus-treat-date-ut (head)
10056 @item gnus-treat-display-picons (head)
10057 @item gnus-treat-display-smileys (t, integer)
10058 @item gnus-treat-display-xface (head)
10059 @item gnus-treat-emphasize (t, head, integer)
10060 @item gnus-treat-fill-article (t, integer)
10061 @item gnus-treat-fill-long-lines (t, integer)
10062 @item gnus-treat-hide-boring-headers (head)
10063 @item gnus-treat-hide-citation (t, integer)
10064 @item gnus-treat-hide-citation-maybe (t, integer)
10065 @item gnus-treat-hide-headers (head)
10066 @item gnus-treat-hide-signature (t, last)
10067 @item gnus-treat-highlight-citation (t, integer)
10068 @item gnus-treat-highlight-headers (head)
10069 @item gnus-treat-highlight-signature (t, last, integer)
10070 @item gnus-treat-overstrike (t, integer)
10071 @item gnus-treat-play-sounds
10072 @item gnus-treat-strip-cr (t, integer)
10073 @item gnus-treat-strip-headers-in-body (t, integer)
10074 @item gnus-treat-strip-leading-blank-lines (t, integer)
10075 @item gnus-treat-strip-multiple-blank-lines (t, integer)
10076 @item gnus-treat-strip-pem (t, last, integer)
10077 @item gnus-treat-strip-pgp (t, last, integer)
10078 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
10079 @item gnus-treat-translate
10080 @item gnus-treat-x-pgp-sig (head)
10081 @item gnus-treat-decode-article-as-default-mime-charset
10082 @end table
10083
10084 @vindex gnus-part-display-hook
10085 You can, of course, write your own functions to be called from
10086 @code{gnus-part-display-hook}.  The functions are called narrowed to the
10087 part, and you can do anything you like, pretty much.  There is no
10088 information that you have to keep in the buffer---you can change
10089 everything.
10090
10091
10092 @node Article Keymap
10093 @section Article Keymap
10094
10095 Most of the keystrokes in the summary buffer can also be used in the
10096 article buffer.  They should behave as if you typed them in the summary
10097 buffer, which means that you don't actually have to have a summary
10098 buffer displayed while reading.  You can do it all from the article
10099 buffer.
10100
10101 A few additional keystrokes are available:
10102
10103 @table @kbd
10104
10105 @item SPACE
10106 @kindex SPACE (Article)
10107 @findex gnus-article-next-page
10108 Scroll forwards one page (@code{gnus-article-next-page}).
10109
10110 @item DEL
10111 @kindex DEL (Article)
10112 @findex gnus-article-prev-page
10113 Scroll backwards one page (@code{gnus-article-prev-page}).
10114
10115 @item C-c ^
10116 @kindex C-c ^ (Article)
10117 @findex gnus-article-refer-article
10118 If point is in the neighborhood of a @code{Message-ID} and you press
10119 @kbd{C-c ^}, Gnus will try to get that article from the server
10120 (@code{gnus-article-refer-article}).
10121
10122 @item C-c C-m
10123 @kindex C-c C-m (Article)
10124 @findex gnus-article-mail
10125 Send a reply to the address near point (@code{gnus-article-mail}).  If
10126 given a prefix, include the mail.
10127
10128 @item s
10129 @kindex s (Article)
10130 @findex gnus-article-show-summary
10131 Reconfigure the buffers so that the summary buffer becomes visible
10132 (@code{gnus-article-show-summary}).
10133
10134 @item ?
10135 @kindex ? (Article)
10136 @findex gnus-article-describe-briefly
10137 Give a very brief description of the available keystrokes
10138 (@code{gnus-article-describe-briefly}).
10139
10140 @item TAB
10141 @kindex TAB (Article)
10142 @findex gnus-article-next-button
10143 Go to the next button, if any (@code{gnus-article-next-button}).  This
10144 only makes sense if you have buttonizing turned on.
10145
10146 @item M-TAB
10147 @kindex M-TAB (Article)
10148 @findex gnus-article-prev-button
10149 Go to the previous button, if any (@code{gnus-article-prev-button}).
10150
10151 @end table
10152
10153
10154 @node Misc Article
10155 @section Misc Article
10156
10157 @table @code
10158
10159 @item gnus-single-article-buffer
10160 @vindex gnus-single-article-buffer
10161 If non-@code{nil}, use the same article buffer for all the groups.
10162 (This is the default.)  If @code{nil}, each group will have its own
10163 article buffer.
10164
10165 @vindex gnus-article-decode-hook
10166 @item gnus-article-decode-hook
10167 @cindex MIME
10168 Hook used to decode @sc{mime} articles.  The default value is
10169 @code{(article-decode-charset article-decode-encoded-words)}
10170
10171 @vindex gnus-article-prepare-hook
10172 @item gnus-article-prepare-hook
10173 This hook is called right after the article has been inserted into the
10174 article buffer.  It is mainly intended for functions that do something
10175 depending on the contents; it should probably not be used for changing
10176 the contents of the article buffer.
10177
10178 @item gnus-article-mode-hook
10179 @vindex gnus-article-mode-hook
10180 Hook called in article mode buffers.
10181
10182 @item gnus-article-mode-syntax-table
10183 @vindex gnus-article-mode-syntax-table
10184 Syntax table used in article buffers.  It is initialized from
10185 @code{text-mode-syntax-table}.
10186
10187 @vindex gnus-article-mode-line-format
10188 @item gnus-article-mode-line-format
10189 This variable is a format string along the same lines as
10190 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
10191 accepts the same format specifications as that variable, with two
10192 extensions:
10193
10194 @table @samp
10195
10196 @item w
10197 The @dfn{wash status} of the article.  This is a short string with one
10198 character for each possible article wash operation that may have been
10199 performed.  The characters and their meaning:
10200
10201 @table @samp
10202
10203 @item c
10204 Displayed when cited text may be hidden in the article buffer.
10205
10206 @item h
10207 Displayed when headers are hidden in the article buffer.
10208
10209 @item p 
10210 Displayed when article is digitally signed or encrypted, and Gnus has
10211 hidden the security headers.  (N.B. does not tell anything about
10212 security status, i.e. good or bad signature.)
10213
10214 @item s
10215 Displayed when the signature has been hidden in the Article buffer.
10216
10217 @item o
10218 Displayed when Gnus has treated overstrike characters in the article buffer.
10219
10220 @item e
10221 Displayed when Gnus has treated emphasised strings in the article buffer.
10222
10223 @end table
10224
10225 @item m
10226 The number of @sc{mime} parts in the article.
10227
10228 @end table
10229
10230 @vindex gnus-break-pages
10231
10232 @item gnus-break-pages
10233 Controls whether @dfn{page breaking} is to take place.  If this variable
10234 is non-@code{nil}, the articles will be divided into pages whenever a
10235 page delimiter appears in the article.  If this variable is @code{nil},
10236 paging will not be done.
10237
10238 @item gnus-page-delimiter
10239 @vindex gnus-page-delimiter
10240 This is the delimiter mentioned above.  By default, it is @samp{^L}
10241 (formfeed).
10242 @end table
10243
10244
10245 @node Composing Messages
10246 @chapter Composing Messages
10247 @cindex composing messages
10248 @cindex messages
10249 @cindex mail
10250 @cindex sending mail
10251 @cindex reply
10252 @cindex followup
10253 @cindex post
10254 @cindex using gpg
10255
10256 @kindex C-c C-c (Post)
10257 All commands for posting and mailing will put you in a message buffer
10258 where you can edit the article all you like, before you send the
10259 article by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The
10260 Message Manual}.  Where the message will be posted/mailed to depends
10261 on your setup (@pxref{Posting Server}).
10262
10263 @menu
10264 * Mail::                        Mailing and replying.
10265 * Posting Server::              What server should you post via?
10266 * Mail and Post::               Mailing and posting at the same time.
10267 * Archived Messages::           Where Gnus stores the messages you've sent.
10268 * Posting Styles::              An easier way to specify who you are.
10269 * Drafts::                      Postponing messages and rejected messages.
10270 * Rejected Articles::           What happens if the server doesn't like your article?
10271 * Using GPG::                   How to use GPG and MML to sign and encrypt messages
10272 @end menu
10273
10274 Also see @pxref{Canceling and Superseding} for information on how to
10275 remove articles you shouldn't have posted.
10276
10277
10278 @node Mail
10279 @section Mail
10280
10281 Variables for customizing outgoing mail:
10282
10283 @table @code
10284 @item gnus-uu-digest-headers
10285 @vindex gnus-uu-digest-headers
10286 List of regexps to match headers included in digested messages.  The
10287 headers will be included in the sequence they are matched.
10288
10289 @item gnus-add-to-list
10290 @vindex gnus-add-to-list
10291 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
10292 that have none when you do a @kbd{a}.
10293
10294 @end table
10295
10296
10297 @node Posting Server
10298 @section Posting Server
10299
10300 When you press those magical @kbd{C-c C-c} keys to ship off your latest
10301 (extremely intelligent, of course) article, where does it go?
10302
10303 Thank you for asking.  I hate you.
10304
10305 @vindex gnus-post-method
10306
10307 It can be quite complicated.  Normally, Gnus will post using the same
10308 select method as you're reading from (which might be convenient if
10309 you're reading lots of groups from different private servers).
10310 However.  If the server you're reading from doesn't allow posting,
10311 just reading, you probably want to use some other server to post your
10312 (extremely intelligent and fabulously interesting) articles.  You can
10313 then set the @code{gnus-post-method} to some other method:
10314
10315 @lisp
10316 (setq gnus-post-method '(nnspool ""))
10317 @end lisp
10318
10319 Now, if you've done this, and then this server rejects your article, or
10320 this server is down, what do you do then?  To override this variable you
10321 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
10322 the ``current'' server, to get back the default behavior, for posting.
10323
10324 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
10325 gnus will prompt you for what method to use for posting.
10326
10327 You can also set @code{gnus-post-method} to a list of select methods.
10328 If that's the case, gnus will always prompt you for what method to use
10329 for posting.
10330
10331 Finally, if you want to always post using the native select method,
10332 you can set this variable to @code{native}.
10333
10334
10335 @node Mail and Post
10336 @section Mail and Post
10337
10338 Here's a list of variables relevant to both mailing and
10339 posting:
10340
10341 @table @code
10342 @item gnus-mailing-list-groups
10343 @findex gnus-mailing-list-groups
10344 @cindex mailing lists
10345
10346 If your news server offers groups that are really mailing lists
10347 gatewayed to the @sc{nntp} server, you can read those groups without
10348 problems, but you can't post/followup to them without some difficulty.
10349 One solution is to add a @code{to-address} to the group parameters
10350 (@pxref{Group Parameters}).  An easier thing to do is set the
10351 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
10352 really are mailing lists.  Then, at least, followups to the mailing
10353 lists will work most of the time.  Posting to these groups (@kbd{a}) is
10354 still a pain, though.
10355
10356 @end table
10357
10358 You may want to do spell-checking on messages that you send out.  Or, if
10359 you don't want to spell-check by hand, you could add automatic
10360 spell-checking via the @code{ispell} package:
10361
10362 @cindex ispell
10363 @findex ispell-message
10364 @lisp
10365 (add-hook 'message-send-hook 'ispell-message)
10366 @end lisp
10367
10368 If you want to change the @code{ispell} dictionary based on what group
10369 you're in, you could say something like the following:
10370
10371 @lisp
10372 (add-hook 'gnus-select-group-hook
10373           (lambda ()
10374             (cond
10375              ((string-match
10376                "^de\\." (gnus-group-real-name gnus-newsgroup-name))
10377               (ispell-change-dictionary "deutsch"))
10378              (t
10379               (ispell-change-dictionary "english")))))
10380 @end lisp
10381
10382 Modify to suit your needs.
10383
10384
10385 @node Archived Messages
10386 @section Archived Messages
10387 @cindex archived messages
10388 @cindex sent messages
10389
10390 Gnus provides a few different methods for storing the mail and news you
10391 send.  The default method is to use the @dfn{archive virtual server} to
10392 store the messages.  If you want to disable this completely, the
10393 @code{gnus-message-archive-group} variable should be @code{nil}, which
10394 is the default.
10395
10396 @vindex gnus-message-archive-method
10397 @code{gnus-message-archive-method} says what virtual server gnus is to
10398 use to store sent messages.  The default is:
10399
10400 @lisp
10401 (nnfolder "archive"
10402           (nnfolder-directory   "~/Mail/archive")
10403           (nnfolder-active-file "~/Mail/archive/active")
10404           (nnfolder-get-new-mail nil)
10405           (nnfolder-inhibit-expiry t))
10406 @end lisp
10407
10408 You can, however, use any mail select method (@code{nnml},
10409 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likable select method
10410 for doing this sort of thing, though.  If you don't like the default
10411 directory chosen, you could say something like:
10412
10413 @lisp
10414 (setq gnus-message-archive-method
10415       '(nnfolder "archive"
10416                  (nnfolder-inhibit-expiry t)
10417                  (nnfolder-active-file "~/News/sent-mail/active")
10418                  (nnfolder-directory "~/News/sent-mail/")))
10419 @end lisp
10420
10421 @vindex gnus-message-archive-group
10422 @cindex Gcc
10423 Gnus will insert @code{Gcc} headers in all outgoing messages that point
10424 to one or more group(s) on that server.  Which group to use is
10425 determined by the @code{gnus-message-archive-group} variable.
10426
10427 This variable can be used to do the following:
10428
10429 @itemize @bullet
10430 @item
10431 a string
10432 Messages will be saved in that group.
10433
10434 Note that you can include a select method in the group name, then the
10435 message will not be stored in the select method given by
10436 @code{gnus-message-archive-method}, but in the select method specified
10437 by the group name, instead.  Suppose @code{gnus-message-archive-method}
10438 has the default value shown above.  Then setting
10439 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
10440 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
10441 value @code{"nnml:foo"}, then outgoing messages will be stored in
10442 @samp{nnml:foo}.
10443 @item
10444 a list of strings
10445 Messages will be saved in all those groups.
10446 @item
10447 an alist of regexps, functions and forms
10448 When a key ``matches'', the result is used.
10449 @item
10450 @code{nil}
10451 No message archiving will take place.  This is the default.
10452 @end itemize
10453
10454 Let's illustrate:
10455
10456 Just saving to a single group called @samp{MisK}:
10457 @lisp
10458 (setq gnus-message-archive-group "MisK")
10459 @end lisp
10460
10461 Saving to two groups, @samp{MisK} and @samp{safe}:
10462 @lisp
10463 (setq gnus-message-archive-group '("MisK" "safe"))
10464 @end lisp
10465
10466 Save to different groups based on what group you are in:
10467 @lisp
10468 (setq gnus-message-archive-group
10469       '(("^alt" "sent-to-alt")
10470         ("mail" "sent-to-mail")
10471         (".*" "sent-to-misc")))
10472 @end lisp
10473
10474 More complex stuff:
10475 @lisp
10476 (setq gnus-message-archive-group
10477       '((if (message-news-p)
10478             "misc-news"
10479           "misc-mail")))
10480 @end lisp
10481
10482 How about storing all news messages in one file, but storing all mail
10483 messages in one file per month:
10484
10485 @lisp
10486 (setq gnus-message-archive-group
10487       '((if (message-news-p)
10488             "misc-news"
10489           (concat "mail." (format-time-string "%Y-%m")))))
10490 @end lisp
10491
10492 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
10493 @c use a different value for @code{gnus-message-archive-group} there.)
10494
10495 Now, when you send a message off, it will be stored in the appropriate
10496 group.  (If you want to disable storing for just one particular message,
10497 you can just remove the @code{Gcc} header that has been inserted.)  The
10498 archive group will appear in the group buffer the next time you start
10499 gnus, or the next time you press @kbd{F} in the group buffer.  You can
10500 enter it and read the articles in it just like you'd read any other
10501 group.  If the group gets really big and annoying, you can simply rename
10502 if (using @kbd{G r} in the group buffer) to something
10503 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
10504 continue to be stored in the old (now empty) group.
10505
10506 That's the default method of archiving sent messages.  Gnus offers a
10507 different way for the people who don't like the default method.  In that
10508 case you should set @code{gnus-message-archive-group} to @code{nil};
10509 this will disable archiving.
10510
10511 @table @code
10512 @item gnus-outgoing-message-group
10513 @vindex gnus-outgoing-message-group
10514 All outgoing messages will be put in this group.  If you want to store
10515 all your outgoing mail and articles in the group @samp{nnml:archive},
10516 you set this variable to that value.  This variable can also be a list of
10517 group names.
10518
10519 If you want to have greater control over what group to put each
10520 message in, you can set this variable to a function that checks the
10521 current newsgroup name and then returns a suitable group name (or list
10522 of names).
10523
10524 This variable can be used instead of @code{gnus-message-archive-group},
10525 but the latter is the preferred method.
10526
10527 @item gnus-inews-mark-gcc-as-read
10528 @vindex gnus-inews-mark-gcc-as-read
10529 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
10530
10531 @end table
10532
10533
10534 @node Posting Styles
10535 @section Posting Styles
10536 @cindex posting styles
10537 @cindex styles
10538
10539 All them variables, they make my head swim.
10540
10541 So what if you want a different @code{Organization} and signature based
10542 on what groups you post to?  And you post both from your home machine
10543 and your work machine, and you want different @code{From} lines, and so
10544 on?
10545
10546 @vindex gnus-posting-styles
10547 One way to do stuff like that is to write clever hooks that change the
10548 variables you need to have changed.  That's a bit boring, so somebody
10549 came up with the bright idea of letting the user specify these things in
10550 a handy alist.  Here's an example of a @code{gnus-posting-styles}
10551 variable:
10552
10553 @lisp
10554 ((".*"
10555   (signature "Peace and happiness")
10556   (organization "What me?"))
10557  ("^comp"
10558   (signature "Death to everybody"))
10559  ("comp.emacs.i-love-it"
10560   (organization "Emacs is it")))
10561 @end lisp
10562
10563 As you might surmise from this example, this alist consists of several
10564 @dfn{styles}.  Each style will be applicable if the first element
10565 ``matches'', in some form or other.  The entire alist will be iterated
10566 over, from the beginning towards the end, and each match will be
10567 applied, which means that attributes in later styles that match override
10568 the same attributes in earlier matching styles.  So
10569 @samp{comp.programming.literate} will have the @samp{Death to everybody}
10570 signature and the @samp{What me?} @code{Organization} header.
10571
10572 The first element in each style is called the @code{match}.  If it's a
10573 string, then Gnus will try to regexp match it against the group name.
10574 If it is the symbol @code{header}, then Gnus will look for header (the
10575 next element in the match) in the original article , and compare that to
10576 the last regexp in the match.  If it's a function symbol, that function
10577 will be called with no arguments.  If it's a variable symbol, then the
10578 variable will be referenced.  If it's a list, then that list will be
10579 @code{eval}ed.  In any case, if this returns a non-@code{nil} value,
10580 then the style is said to @dfn{match}.
10581
10582 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
10583 attribute consists of a @code{(@var{name} @var{value})} pair.  The
10584 attribute name can be one of @code{signature}, @code{signature-file},
10585 @code{organization}, @code{address}, @code{name} or @code{body}.  The
10586 attribute name can also be a string.  In that case, this will be used as
10587 a header name, and the value will be inserted in the headers of the
10588 article; if the value is @code{nil}, the header name will be removed.
10589 If the attribute name is @code{eval}, the form is evaluated, and the
10590 result is thrown away.
10591
10592 The attribute value can be a string (used verbatim), a function with
10593 zero arguments (the return value will be used), a variable (its value
10594 will be used) or a list (it will be @code{eval}ed and the return value
10595 will be used).  The functions and sexps are called/@code{eval}ed in the
10596 message buffer that is being set up.  The headers of the current article
10597 are available through the @code{message-reply-headers} variable.
10598
10599 If you wish to check whether the message you are about to compose is
10600 meant to be a news article or a mail message, you can check the values
10601 of the @code{message-news-p} and @code{message-mail-p} functions.
10602
10603 @findex message-mail-p
10604 @findex message-news-p
10605
10606 So here's a new example:
10607
10608 @lisp
10609 (setq gnus-posting-styles
10610       '((".*"
10611          (signature-file "~/.signature")
10612          (name "User Name")
10613          ("X-Home-Page" (getenv "WWW_HOME"))
10614          (organization "People's Front Against MWM"))
10615         ("^rec.humor"
10616          (signature my-funny-signature-randomizer))
10617         ((equal (system-name) "gnarly")
10618          (signature my-quote-randomizer))
10619         ((message-news-p)
10620          (signature my-news-signature))
10621         (header "to" "larsi.*org"
10622                 (Organization "Somewhere, Inc."))
10623         ((posting-from-work-p)
10624          (signature-file "~/.work-signature")
10625          (address "user@@bar.foo")
10626          (body "You are fired.\n\nSincerely, your boss.")
10627          (organization "Important Work, Inc"))
10628         ("nnml:.*"
10629          (From (save-excursion
10630                  (set-buffer gnus-article-buffer)
10631                  (message-fetch-field "to"))))
10632         ("^nn.+:"
10633          (signature-file "~/.mail-signature"))))
10634 @end lisp
10635
10636 The @samp{nnml:.*} rule means that you use the @code{To} address as the
10637 @code{From} address in all your outgoing replies, which might be handy
10638 if you fill many roles.
10639
10640
10641 @node Drafts
10642 @section Drafts
10643 @cindex drafts
10644
10645 If you are writing a message (mail or news) and suddenly remember that
10646 you have a steak in the oven (or some pesto in the food processor, you
10647 craaazy vegetarians), you'll probably wish there was a method to save
10648 the message you are writing so that you can continue editing it some
10649 other day, and send it when you feel its finished.
10650
10651 Well, don't worry about it.  Whenever you start composing a message of
10652 some sort using the gnus mail and post commands, the buffer you get will
10653 automatically associate to an article in a special @dfn{draft} group.
10654 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
10655 article will be saved there.  (Auto-save files also go to the draft
10656 group.)
10657
10658 @cindex nndraft
10659 @vindex nndraft-directory
10660 The draft group is a special group (which is implemented as an
10661 @code{nndraft} group, if you absolutely have to know) called
10662 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
10663 @code{nndraft} is to store its files.  What makes this group special is
10664 that you can't tick any articles in it or mark any articles as
10665 read---all articles in the group are permanently unread.
10666
10667 If the group doesn't exist, it will be created and you'll be subscribed
10668 to it.  The only way to make it disappear from the Group buffer is to
10669 unsubscribe it.
10670
10671 @c @findex gnus-dissociate-buffer-from-draft
10672 @c @kindex C-c M-d (Mail)
10673 @c @kindex C-c M-d (Post)
10674 @c @findex gnus-associate-buffer-with-draft
10675 @c @kindex C-c C-d (Mail)
10676 @c @kindex C-c C-d (Post)
10677 @c If you're writing some super-secret message that you later want to
10678 @c encode with PGP before sending, you may wish to turn the auto-saving
10679 @c (and association with the draft group) off.  You never know who might be
10680 @c interested in reading all your extremely valuable and terribly horrible
10681 @c and interesting secrets.  The @kbd{C-c M-d}
10682 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
10683 @c If you change your mind and want to turn the auto-saving back on again,
10684 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
10685 @c
10686 @c @vindex gnus-use-draft
10687 @c To leave association with the draft group off by default, set
10688 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
10689
10690 @findex gnus-draft-edit-message
10691 @kindex D e (Draft)
10692 When you want to continue editing the article, you simply enter the
10693 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
10694 that.  You will be placed in a buffer where you left off.
10695
10696 Rejected articles will also be put in this draft group (@pxref{Rejected
10697 Articles}).
10698
10699 @findex gnus-draft-send-all-messages
10700 @findex gnus-draft-send-message
10701 If you have lots of rejected messages you want to post (or mail) without
10702 doing further editing, you can use the @kbd{D s} command
10703 (@code{gnus-draft-send-message}).  This command understands the
10704 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
10705 command (@code{gnus-draft-send-all-messages}) will ship off all messages
10706 in the buffer.
10707
10708 If you have some messages that you wish not to send, you can use the
10709 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
10710 as unsendable.  This is a toggling command.
10711
10712
10713 @node Rejected Articles
10714 @section Rejected Articles
10715 @cindex rejected articles
10716
10717 Sometimes a news server will reject an article.  Perhaps the server
10718 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
10719 @emph{there be demons}.  Perhaps you have included too much cited text.
10720 Perhaps the disk is full.  Perhaps the server is down.
10721
10722 These situations are, of course, totally beyond the control of gnus.
10723 (Gnus, of course, loves the way you look, always feels great, has angels
10724 fluttering around inside of it, doesn't care about how much cited text
10725 you include, never runs full and never goes down.)  So gnus saves these
10726 articles until some later time when the server feels better.
10727
10728 The rejected articles will automatically be put in a special draft group
10729 (@pxref{Drafts}).  When the server comes back up again, you'd then
10730 typically enter that group and send all the articles off.
10731
10732 @node Using GPG
10733 @section Using GPG
10734 @cindex using gpg
10735
10736 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el}. See
10737 @code{mm-verify-option} and @code{mm-decrypt-option} to enable Gnus to
10738 verify or decrypt messages accordingly.
10739
10740 To use this correctly with GPG, you'll need the following lisp code in your
10741 @file{~/.emacs} or @file{~/.gnus}:
10742
10743 @lisp
10744 (require 'gpg)
10745 (setq mml2015-use 'gpg)
10746 (setq mml1991-use 'gpg)
10747 (setq gpg-temp-directory (expand-file-name "~/.gnupg/tmp"))
10748 @end lisp
10749
10750 The @code{gpg-temp-directory} need to point to a directory with permissions set
10751 to 700, for your own safety.
10752
10753 If you want to benefit of PGP2.6 compatibility, you might create a script named
10754 @file{gpg-2comp} with these instructions:
10755
10756 @example
10757 #!/bin/sh
10758 exec gpg --rfc1991 "$@@"
10759 @end example
10760
10761 If you don't want to use such compatibility, you can add the following line to
10762 your @file{~/.emacs} or @file{~/.gnus}:
10763
10764 @lisp
10765 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10766 @end lisp
10767
10768 To sign or encrypt your message you may choose to use the MML Security
10769 menu or @kbd{C-c C-m s p} to sign your message using PGP/MIME,
10770 @kbd{C-c C-m s s} to sign your message using S/MIME.  There's also
10771 @kbd{C-c C-m c p} to encrypt your message with PGP/MIME and @kbd{C-c
10772 C-m c s} to encrypt using S/MIME. @xref{Security, ,Security, message,
10773 The Message Manual}.
10774
10775 Gnus will ask for your passphrase and then it will send your message, if
10776 you've typed it correctly.
10777
10778 @node Select Methods
10779 @chapter Select Methods
10780 @cindex foreign groups
10781 @cindex select methods
10782
10783 A @dfn{foreign group} is a group not read by the usual (or
10784 default) means.  It could be, for instance, a group from a different
10785 @sc{nntp} server, it could be a virtual group, or it could be your own
10786 personal mail group.
10787
10788 A foreign group (or any group, really) is specified by a @dfn{name} and
10789 a @dfn{select method}.  To take the latter first, a select method is a
10790 list where the first element says what back end to use (e.g. @code{nntp},
10791 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10792 name}.  There may be additional elements in the select method, where the
10793 value may have special meaning for the back end in question.
10794
10795 One could say that a select method defines a @dfn{virtual server}---so
10796 we do just that (@pxref{Server Buffer}).
10797
10798 The @dfn{name} of the group is the name the back end will recognize the
10799 group as.
10800
10801 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10802 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10803 method @code{(nntp "some.where.edu")}.  Gnus will call this group
10804 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10805 back end just knows this group as @samp{soc.motss}.
10806
10807 The different methods all have their peculiarities, of course.
10808
10809 @menu
10810 * Server Buffer::               Making and editing virtual servers.
10811 * Getting News::                Reading USENET news with Gnus.
10812 * Getting Mail::                Reading your personal mail with Gnus.
10813 * Browsing the Web::            Getting messages from a plethora of Web sources.
10814 * IMAP::                        Using Gnus as a @sc{imap} client.
10815 * Other Sources::               Reading directories, files, SOUP packets.
10816 * Combined Groups::             Combining groups into one group.
10817 * Gnus Unplugged::              Reading news and mail offline.
10818 @end menu
10819
10820
10821 @node Server Buffer
10822 @section Server Buffer
10823
10824 Traditionally, a @dfn{server} is a machine or a piece of software that
10825 one connects to, and then requests information from.  Gnus does not
10826 connect directly to any real servers, but does all transactions through
10827 one back end or other.  But that's just putting one layer more between
10828 the actual media and Gnus, so we might just as well say that each
10829 back end represents a virtual server.
10830
10831 For instance, the @code{nntp} back end may be used to connect to several
10832 different actual @sc{nntp} servers, or, perhaps, to many different ports
10833 on the same actual @sc{nntp} server.  You tell Gnus which back end to
10834 use, and what parameters to set by specifying a @dfn{select method}.
10835
10836 These select method specifications can sometimes become quite
10837 complicated---say, for instance, that you want to read from the
10838 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10839 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
10840 Anyway, if you had to specify that for each group that used this
10841 server, that would be too much work, so Gnus offers a way of naming
10842 select methods, which is what you do in the server buffer.
10843
10844 To enter the server buffer, use the @kbd{^}
10845 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10846
10847 @menu
10848 * Server Buffer Format::        You can customize the look of this buffer.
10849 * Server Commands::             Commands to manipulate servers.
10850 * Example Methods::             Examples server specifications.
10851 * Creating a Virtual Server::   An example session.
10852 * Server Variables::            Which variables to set.
10853 * Servers and Methods::         You can use server names as select methods.
10854 * Unavailable Servers::         Some servers you try to contact may be down.
10855 @end menu
10856
10857 @vindex gnus-server-mode-hook
10858 @code{gnus-server-mode-hook} is run when creating the server buffer.
10859
10860
10861 @node Server Buffer Format
10862 @subsection Server Buffer Format
10863 @cindex server buffer format
10864
10865 @vindex gnus-server-line-format
10866 You can change the look of the server buffer lines by changing the
10867 @code{gnus-server-line-format} variable.  This is a @code{format}-like
10868 variable, with some simple extensions:
10869
10870 @table @samp
10871
10872 @item h
10873 How the news is fetched---the back end name.
10874
10875 @item n
10876 The name of this server.
10877
10878 @item w
10879 Where the news is to be fetched from---the address.
10880
10881 @item s
10882 The opened/closed/denied status of the server.
10883 @end table
10884
10885 @vindex gnus-server-mode-line-format
10886 The mode line can also be customized by using the
10887 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10888 Formatting}).  The following specs are understood:
10889
10890 @table @samp
10891 @item S
10892 Server name.
10893
10894 @item M
10895 Server method.
10896 @end table
10897
10898 Also @pxref{Formatting Variables}.
10899
10900
10901 @node Server Commands
10902 @subsection Server Commands
10903 @cindex server commands
10904
10905 @table @kbd
10906
10907 @item a
10908 @kindex a (Server)
10909 @findex gnus-server-add-server
10910 Add a new server (@code{gnus-server-add-server}).
10911
10912 @item e
10913 @kindex e (Server)
10914 @findex gnus-server-edit-server
10915 Edit a server (@code{gnus-server-edit-server}).
10916
10917 @item SPACE
10918 @kindex SPACE (Server)
10919 @findex gnus-server-read-server
10920 Browse the current server (@code{gnus-server-read-server}).
10921
10922 @item q
10923 @kindex q (Server)
10924 @findex gnus-server-exit
10925 Return to the group buffer (@code{gnus-server-exit}).
10926
10927 @item k
10928 @kindex k (Server)
10929 @findex gnus-server-kill-server
10930 Kill the current server (@code{gnus-server-kill-server}).
10931
10932 @item y
10933 @kindex y (Server)
10934 @findex gnus-server-yank-server
10935 Yank the previously killed server (@code{gnus-server-yank-server}).
10936
10937 @item c
10938 @kindex c (Server)
10939 @findex gnus-server-copy-server
10940 Copy the current server (@code{gnus-server-copy-server}).
10941
10942 @item l
10943 @kindex l (Server)
10944 @findex gnus-server-list-servers
10945 List all servers (@code{gnus-server-list-servers}).
10946
10947 @item s
10948 @kindex s (Server)
10949 @findex gnus-server-scan-server
10950 Request that the server scan its sources for new articles
10951 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
10952 servers.
10953
10954 @item g
10955 @kindex g (Server)
10956 @findex gnus-server-regenerate-server
10957 Request that the server regenerate all its data structures
10958 (@code{gnus-server-regenerate-server}).  This can be useful if you have
10959 a mail back end that has gotten out of sync.
10960
10961 @end table
10962
10963
10964 @node Example Methods
10965 @subsection Example Methods
10966
10967 Most select methods are pretty simple and self-explanatory:
10968
10969 @lisp
10970 (nntp "news.funet.fi")
10971 @end lisp
10972
10973 Reading directly from the spool is even simpler:
10974
10975 @lisp
10976 (nnspool "")
10977 @end lisp
10978
10979 As you can see, the first element in a select method is the name of the
10980 back end, and the second is the @dfn{address}, or @dfn{name}, if you
10981 will.
10982
10983 After these two elements, there may be an arbitrary number of
10984 @code{(@var{variable} @var{form})} pairs.
10985
10986 To go back to the first example---imagine that you want to read from
10987 port 15 on that machine.  This is what the select method should
10988 look like then:
10989
10990 @lisp
10991 (nntp "news.funet.fi" (nntp-port-number 15))
10992 @end lisp
10993
10994 You should read the documentation to each back end to find out what
10995 variables are relevant, but here's an @code{nnmh} example:
10996
10997 @code{nnmh} is a mail back end that reads a spool-like structure.  Say
10998 you have two structures that you wish to access: One is your private
10999 mail spool, and the other is a public one.  Here's the possible spec for
11000 your private mail:
11001
11002 @lisp
11003 (nnmh "private" (nnmh-directory "~/private/mail/"))
11004 @end lisp
11005
11006 (This server is then called @samp{private}, but you may have guessed
11007 that.)
11008
11009 Here's the method for a public spool:
11010
11011 @lisp
11012 (nnmh "public"
11013       (nnmh-directory "/usr/information/spool/")
11014       (nnmh-get-new-mail nil))
11015 @end lisp
11016
11017 @cindex proxy
11018 @cindex firewall
11019
11020 If you are behind a firewall and only have access to the @sc{nntp}
11021 server from the firewall machine, you can instruct Gnus to @code{rlogin}
11022 on the firewall machine and telnet from there to the @sc{nntp} server.
11023 Doing this can be rather fiddly, but your virtual server definition
11024 should probably look something like this:
11025
11026 @lisp
11027 (nntp "firewall"
11028       (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
11029       (nntp-via-address "the.firewall.machine")
11030       (nntp-address "the.real.nntp.host")
11031       (nntp-end-of-line "\n"))
11032 @end lisp
11033
11034 If you want to use the wonderful @code{ssh} program to provide a
11035 compressed connection over the modem line, you could add the following
11036 configuration to the example above:
11037
11038 @lisp
11039       (nntp-via-rlogin-command "ssh")
11040 @end lisp
11041
11042 If you're behind a firewall, but have direct access to the outside world
11043 through a wrapper command like "runsocks", you could open a socksified
11044 telnet connection to the news server as follows:
11045
11046 @lisp
11047 (nntp "outside"
11048       (nntp-pre-command "runsocks")
11049       (nntp-open-connection-function nntp-open-via-telnet)
11050       (nntp-address "the.news.server")
11051       (nntp-end-of-line "\n"))
11052 @end lisp
11053
11054 This means that you have to have set up @code{ssh-agent} correctly to
11055 provide automatic authorization, of course.  And to get a compressed
11056 connection, you have to have the @samp{Compression} option in the
11057 @code{ssh} @file{config} file.
11058
11059
11060 @node Creating a Virtual Server
11061 @subsection Creating a Virtual Server
11062
11063 If you're saving lots of articles in the cache by using persistent
11064 articles, you may want to create a virtual server to read the cache.
11065
11066 First you need to add a new server.  The @kbd{a} command does that.  It
11067 would probably be best to use @code{nnspool} to read the cache.  You
11068 could also use @code{nnml} or @code{nnmh}, though.
11069
11070 Type @kbd{a nnspool RET cache RET}.
11071
11072 You should now have a brand new @code{nnspool} virtual server called
11073 @samp{cache}.  You now need to edit it to have the right definitions.
11074 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
11075 will contain the following:
11076
11077 @lisp
11078 (nnspool "cache")
11079 @end lisp
11080
11081 Change that to:
11082
11083 @lisp
11084 (nnspool "cache"
11085          (nnspool-spool-directory "~/News/cache/")
11086          (nnspool-nov-directory "~/News/cache/")
11087          (nnspool-active-file "~/News/cache/active"))
11088 @end lisp
11089
11090 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
11091 @kbd{RET} over this virtual server, you should be entered into a browse
11092 buffer, and you should be able to enter any of the groups displayed.
11093
11094
11095 @node Server Variables
11096 @subsection Server Variables
11097
11098 One sticky point when defining variables (both on back ends and in Emacs
11099 in general) is that some variables are typically initialized from other
11100 variables when the definition of the variables is being loaded.  If you
11101 change the "base" variable after the variables have been loaded, you
11102 won't change the "derived" variables.
11103
11104 This typically affects directory and file variables.  For instance,
11105 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
11106 directory variables are initialized from that variable, so
11107 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
11108 new virtual @code{nnml} server, it will @emph{not} suffice to set just
11109 @code{nnml-directory}---you have to explicitly set all the file
11110 variables to be what you want them to be.  For a complete list of
11111 variables for each back end, see each back end's section later in this
11112 manual, but here's an example @code{nnml} definition:
11113
11114 @lisp
11115 (nnml "public"
11116       (nnml-directory "~/my-mail/")
11117       (nnml-active-file "~/my-mail/active")
11118       (nnml-newsgroups-file "~/my-mail/newsgroups"))
11119 @end lisp
11120
11121
11122 @node Servers and Methods
11123 @subsection Servers and Methods
11124
11125 Wherever you would normally use a select method
11126 (e.g. @code{gnus-secondary-select-method}, in the group select method,
11127 when browsing a foreign server) you can use a virtual server name
11128 instead.  This could potentially save lots of typing.  And it's nice all
11129 over.
11130
11131
11132 @node Unavailable Servers
11133 @subsection Unavailable Servers
11134
11135 If a server seems to be unreachable, Gnus will mark that server as
11136 @code{denied}.  That means that any subsequent attempt to make contact
11137 with that server will just be ignored.  ``It can't be opened,'' Gnus
11138 will tell you, without making the least effort to see whether that is
11139 actually the case or not.
11140
11141 That might seem quite naughty, but it does make sense most of the time.
11142 Let's say you have 10 groups subscribed to on server
11143 @samp{nephelococcygia.com}.  This server is located somewhere quite far
11144 away from you and the machine is quite slow, so it takes 1 minute just
11145 to find out that it refuses connection to you today.  If Gnus were to
11146 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
11147 attempt to do that.  Once it has gotten a single ``connection refused'',
11148 it will regard that server as ``down''.
11149
11150 So, what happens if the machine was only feeling unwell temporarily?
11151 How do you test to see whether the machine has come up again?
11152
11153 You jump to the server buffer (@pxref{Server Buffer}) and poke it
11154 with the following commands:
11155
11156 @table @kbd
11157
11158 @item O
11159 @kindex O (Server)
11160 @findex gnus-server-open-server
11161 Try to establish connection to the server on the current line
11162 (@code{gnus-server-open-server}).
11163
11164 @item C
11165 @kindex C (Server)
11166 @findex gnus-server-close-server
11167 Close the connection (if any) to the server
11168 (@code{gnus-server-close-server}).
11169
11170 @item D
11171 @kindex D (Server)
11172 @findex gnus-server-deny-server
11173 Mark the current server as unreachable
11174 (@code{gnus-server-deny-server}).
11175
11176 @item M-o
11177 @kindex M-o (Server)
11178 @findex gnus-server-open-all-servers
11179 Open the connections to all servers in the buffer
11180 (@code{gnus-server-open-all-servers}).
11181
11182 @item M-c
11183 @kindex M-c (Server)
11184 @findex gnus-server-close-all-servers
11185 Close the connections to all servers in the buffer
11186 (@code{gnus-server-close-all-servers}).
11187
11188 @item R
11189 @kindex R (Server)
11190 @findex gnus-server-remove-denials
11191 Remove all marks to whether Gnus was denied connection from any servers
11192 (@code{gnus-server-remove-denials}).
11193
11194 @end table
11195
11196
11197 @node Getting News
11198 @section Getting News
11199 @cindex reading news
11200 @cindex news back ends
11201
11202 A newsreader is normally used for reading news.  Gnus currently provides
11203 only two methods of getting news---it can read from an @sc{nntp} server,
11204 or it can read from a local spool.
11205
11206 @menu
11207 * NNTP::                        Reading news from an @sc{nntp} server.
11208 * News Spool::                  Reading news from the local spool.
11209 @end menu
11210
11211
11212 @node NNTP
11213 @subsection @sc{nntp}
11214 @cindex nntp
11215
11216 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
11217 You just specify @code{nntp} as method and the address of the @sc{nntp}
11218 server as the, uhm, address.
11219
11220 If the @sc{nntp} server is located at a non-standard port, setting the
11221 third element of the select method to this port number should allow you
11222 to connect to the right port.  You'll have to edit the group info for
11223 that (@pxref{Foreign Groups}).
11224
11225 The name of the foreign group can be the same as a native group.  In
11226 fact, you can subscribe to the same group from as many different servers
11227 you feel like.  There will be no name collisions.
11228
11229 The following variables can be used to create a virtual @code{nntp}
11230 server:
11231
11232 @table @code
11233
11234 @item nntp-server-opened-hook
11235 @vindex nntp-server-opened-hook
11236 @cindex @sc{mode reader}
11237 @cindex authinfo
11238 @cindex authentification
11239 @cindex nntp authentification
11240 @findex nntp-send-authinfo
11241 @findex nntp-send-mode-reader
11242 is run after a connection has been made.  It can be used to send
11243 commands to the @sc{nntp} server after it has been contacted.  By
11244 default it sends the command @code{MODE READER} to the server with the
11245 @code{nntp-send-mode-reader} function.  This function should always be
11246 present in this hook.
11247
11248 @item nntp-authinfo-function
11249 @vindex nntp-authinfo-function
11250 @findex nntp-send-authinfo
11251 @vindex nntp-authinfo-file
11252 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
11253 server.  The default function is @code{nntp-send-authinfo}, which looks
11254 through your @file{~/.authinfo} (or whatever you've set the
11255 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
11256 are found, it will prompt you for a login name and a password.  The
11257 format of the @file{~/.authinfo} file is (almost) the same as the
11258 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
11259 manual page, but here are the salient facts:
11260
11261 @enumerate
11262 @item
11263 The file contains one or more line, each of which define one server.
11264
11265 @item
11266 Each line may contain an arbitrary number of token/value pairs.
11267
11268 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
11269 @samp{default}.  In addition Gnus introduces two new tokens, not present
11270 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
11271 @samp{force}.  (This is the only way the @file{.authinfo} file format
11272 deviates from the @file{.netrc} file format.)  @samp{port} is used to
11273 indicate what port on the server the credentials apply to and
11274 @samp{force} is explained below.
11275
11276 @end enumerate
11277
11278 Here's an example file:
11279
11280 @example
11281 machine news.uio.no login larsi password geheimnis
11282 machine nntp.ifi.uio.no login larsi force yes
11283 @end example
11284
11285 The token/value pairs may appear in any order; @samp{machine} doesn't
11286 have to be first, for instance.
11287
11288 In this example, both login name and password have been supplied for the
11289 former server, while the latter has only the login name listed, and the
11290 user will be prompted for the password.  The latter also has the
11291 @samp{force} tag, which means that the authinfo will be sent to the
11292 @var{nntp} server upon connection; the default (i.e., when there is not
11293 @samp{force} tag) is to not send authinfo to the @var{nntp} server
11294 until the @var{nntp} server asks for it.
11295
11296 You can also add @samp{default} lines that will apply to all servers
11297 that don't have matching @samp{machine} lines.
11298
11299 @example
11300 default force yes
11301 @end example
11302
11303 This will force sending @samp{AUTHINFO} commands to all servers not
11304 previously mentioned.
11305
11306 Remember to not leave the @file{~/.authinfo} file world-readable.
11307
11308 @item nntp-server-action-alist
11309 @vindex nntp-server-action-alist
11310 This is a list of regexps to match on server types and actions to be
11311 taken when matches are made.  For instance, if you want Gnus to beep
11312 every time you connect to innd, you could say something like:
11313
11314 @lisp
11315 (setq nntp-server-action-alist
11316       '(("innd" (ding))))
11317 @end lisp
11318
11319 You probably don't want to do that, though.
11320
11321 The default value is
11322
11323 @lisp
11324 '(("nntpd 1\\.5\\.11t"
11325    (remove-hook 'nntp-server-opened-hook
11326                 'nntp-send-mode-reader)))
11327 @end lisp
11328
11329 This ensures that Gnus doesn't send the @code{MODE READER} command to
11330 nntpd 1.5.11t, since that command chokes that server, I've been told.
11331
11332 @item nntp-maximum-request
11333 @vindex nntp-maximum-request
11334 If the @sc{nntp} server doesn't support @sc{nov} headers, this back end
11335 will collect headers by sending a series of @code{head} commands.  To
11336 speed things up, the back end sends lots of these commands without
11337 waiting for reply, and then reads all the replies.  This is controlled
11338 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
11339 your network is buggy, you should set this to 1.
11340
11341 @item nntp-connection-timeout
11342 @vindex nntp-connection-timeout
11343 If you have lots of foreign @code{nntp} groups that you connect to
11344 regularly, you're sure to have problems with @sc{nntp} servers not
11345 responding properly, or being too loaded to reply within reasonable
11346 time.  This is can lead to awkward problems, which can be helped
11347 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
11348 that says how many seconds the @code{nntp} back end should wait for a
11349 connection before giving up.  If it is @code{nil}, which is the default,
11350 no timeouts are done.
11351
11352 @c @item nntp-command-timeout
11353 @c @vindex nntp-command-timeout
11354 @c @cindex PPP connections
11355 @c @cindex dynamic IP addresses
11356 @c If you're running Gnus on a machine that has a dynamically assigned
11357 @c address, Gnus may become confused.  If the address of your machine
11358 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
11359 @c waiting forever for replies from the server.  To help with this
11360 @c unfortunate problem, you can set this command to a number.  Gnus will
11361 @c then, if it sits waiting for a reply from the server longer than that
11362 @c number of seconds, shut down the connection, start a new one, and resend
11363 @c the command.  This should hopefully be transparent to the user.  A
11364 @c likely number is 30 seconds.
11365 @c
11366 @c @item nntp-retry-on-break
11367 @c @vindex nntp-retry-on-break
11368 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
11369 @c hangs.  This will have much the same effect as the command timeout
11370 @c described above.
11371
11372 @item nntp-server-hook
11373 @vindex nntp-server-hook
11374 This hook is run as the last step when connecting to an @sc{nntp}
11375 server.
11376
11377 @item nntp-buggy-select
11378 @vindex nntp-buggy-select
11379 Set this to non-@code{nil} if your select routine is buggy.
11380
11381 @item nntp-nov-is-evil
11382 @vindex nntp-nov-is-evil
11383 If the @sc{nntp} server does not support @sc{nov}, you could set this
11384 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
11385 can be used.
11386
11387 @item nntp-xover-commands
11388 @vindex nntp-xover-commands
11389 @cindex nov
11390 @cindex XOVER
11391 List of strings used as commands to fetch @sc{nov} lines from a
11392 server.  The default value of this variable is @code{("XOVER"
11393 "XOVERVIEW")}.
11394
11395 @item nntp-nov-gap
11396 @vindex nntp-nov-gap
11397 @code{nntp} normally sends just one big request for @sc{nov} lines to
11398 the server.  The server responds with one huge list of lines.  However,
11399 if you have read articles 2-5000 in the group, and only want to read
11400 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
11401 lines that you will not need.  This variable says how
11402 big a gap between two consecutive articles is allowed to be before the
11403 @code{XOVER} request is split into several request.  Note that if your
11404 network is fast, setting this variable to a really small number means
11405 that fetching will probably be slower.  If this variable is @code{nil},
11406 @code{nntp} will never split requests.  The default is 5.
11407
11408 @item nntp-prepare-server-hook
11409 @vindex nntp-prepare-server-hook
11410 A hook run before attempting to connect to an @sc{nntp} server.
11411
11412 @item nntp-warn-about-losing-connection
11413 @vindex nntp-warn-about-losing-connection
11414 If this variable is non-@code{nil}, some noise will be made when a
11415 server closes connection.
11416
11417 @item nntp-record-commands
11418 @vindex nntp-record-commands
11419 If non-@code{nil}, @code{nntp} will log all commands it sends to the
11420 @sc{nntp} server (along with a timestamp) in the @samp{*nntp-log*}
11421 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
11422 that doesn't seem to work.
11423
11424 @item nntp-open-connection-function
11425 @vindex nntp-open-connection-function
11426 It is possible to customize how the connection to the nntp server will
11427 be opened.  If you specify an @code{nntp-open-connection-function}
11428 parameter, Gnus will use that function to establish the connection.
11429 Five pre-made functions are supplied.  These functions can be grouped in
11430 two categories: direct connection functions (three pre-made), and
11431 indirect ones (two pre-made).
11432
11433 @item nntp-prepare-post-hook
11434 @vindex nntp-prepare-post-hook
11435 A hook run just before posting an article.  If there is no
11436 @code{Message-ID} header in the article and the news server provides the
11437 recommended ID, it will be added to the article before running this
11438 hook.  It is useful to make @code{Cancel-Lock} headers even if you
11439 inhibit Gnus to add a @code{Message-ID} header, you could say:
11440
11441 @lisp
11442 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
11443 @end lisp
11444
11445 @item nntp-list-options
11446 @vindex nntp-list-options
11447 List of newsgroup name used for a option of the LIST command to restrict
11448 the listing output to only the specified newsgroups.  Each newsgroup name
11449 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
11450 etc.  Fortunately, if the server can accept such a option, it will
11451 probably make gnus run faster.  You may use it as a server variable as
11452 follows:
11453
11454 @lisp
11455 (setq gnus-select-method
11456       '(nntp "news.somewhere.edu"
11457              (nntp-list-options ("fj.*" "japan.*"))))
11458 @end lisp
11459
11460 @item nntp-options-subscribe
11461 @vindex nntp-options-subscribe
11462 Regexp matching the newsgroup names which will be subscribed
11463 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
11464 It may be effective as well as @code{nntp-list-options} even though the
11465 server could not accept a shell-style wildcard as a option of the LIST
11466 command.  You may use it as a server variable as follows:
11467
11468 @lisp
11469 (setq gnus-select-method
11470       '(nntp "news.somewhere.edu"
11471              (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
11472 @end lisp
11473
11474 @item nntp-options-not-subscribe
11475 @vindex nntp-options-not-subscribe
11476 Regexp matching the newsgroup names which will not be subscribed
11477 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
11478 It may be effective as well as @code{nntp-list-options} even though the
11479 server could not accept a shell-style wildcard as a option of the LIST
11480 command.  You may use it as a server variable as follows:
11481
11482 @lisp
11483 (setq gnus-select-method
11484       '(nntp "news.somewhere.edu"
11485              (nntp-options-not-subscribe "\\.binaries\\.")))
11486 @end lisp
11487 @end table
11488
11489 @menu
11490 * Direct Functions::            Connecting directly to the server.
11491 * Indirect Functions::          Connecting indirectly to the server.
11492 * Common Variables::            Understood by several connection functions.
11493 @end menu
11494
11495
11496 @node Direct Functions
11497 @subsubsection Direct Functions
11498 @cindex direct connection functions
11499
11500 These functions are called direct because they open a direct connection
11501 between your machine and the @sc{nntp} server.  The behavior of these
11502 functions is also affected by commonly understood variables
11503 (@pxref{Common Variables}).
11504
11505 @table @code
11506 @findex nntp-open-network-stream
11507 @item nntp-open-network-stream
11508 This is the default, and simply connects to some port or other on the
11509 remote system.
11510
11511 @findex nntp-open-ssl-stream
11512 @item nntp-open-ssl-stream
11513 Opens a connection to a server over a @dfn{secure} channel.  To use
11514 this you must have OpenSSL (@uref{http://www.openssl.org}) or SSLeay
11515 installed (@uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also
11516 need @file{ssl.el} (from the W3 distribution, for instance).  You then
11517 define a server as follows:
11518
11519 @lisp
11520 ;; Type `C-c C-c' after you've finished editing.
11521 ;;
11522 ;; "snews" is port 563 and is predefined in our /etc/services
11523 ;;
11524 (nntp "snews.bar.com"
11525       (nntp-open-connection-function nntp-open-ssl-stream)
11526       (nntp-port-number "snews")
11527       (nntp-address "snews.bar.com"))
11528 @end lisp
11529
11530 @findex nntp-open-telnet-stream
11531 @item nntp-open-telnet-stream
11532 Opens a connection to an @sc{nntp} server by simply @samp{telnet}'ing
11533 it.  You might wonder why this function exists, since we have the
11534 default @code{nntp-open-network-stream} which would do the job.  (One
11535 of) the reason(s) is that if you are behind a firewall but have direct
11536 connections to the outside world thanks to a command wrapper like
11537 @code{runsocks}, you can use it like this:
11538
11539 @lisp
11540 (nntp "socksified"
11541       (nntp-pre-command "runsocks")
11542       (nntp-open-connection-function nntp-open-telnet-stream)
11543       (nntp-address "the.news.server"))
11544 @end lisp
11545
11546 With the default method, you would need to wrap your whole Emacs
11547 session, which is not a good idea.
11548 @end table
11549
11550
11551 @node Indirect Functions
11552 @subsubsection Indirect Functions
11553 @cindex indirect connection functions
11554
11555 These functions are called indirect because they connect to an
11556 intermediate host before actually connecting to the @sc{nntp} server.
11557 All of these functions and related variables are also said to belong to
11558 the "via" family of connection: they're all prefixed with "via" to make
11559 things cleaner.  The behavior of these functions is also affected by
11560 commonly understood variables (@pxref{Common Variables}).
11561
11562 @table @code
11563 @item nntp-open-via-rlogin-and-telnet
11564 @findex nntp-open-via-rlogin-and-telnet
11565 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
11566 to the real @sc{nntp} server from there.  This is useful for instance if
11567 you need to connect to a firewall machine first.
11568
11569 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
11570
11571 @table @code
11572 @item nntp-via-rlogin-command
11573 @vindex nntp-via-rlogin-command
11574 Command used to log in on the intermediate host.  The default is
11575 @samp{rsh}, but @samp{ssh} is a popular alternative.
11576 @end table
11577
11578 @item nntp-open-via-telnet-and-telnet
11579 @findex nntp-open-via-telnet-and-telnet
11580 Does essentially the same, but uses @samp{telnet} instead of
11581 @samp{rlogin} to connect to the intermediate host.
11582
11583 @code{nntp-open-via-telnet-and-telnet}-specific variables:
11584
11585 @table @code
11586 @item nntp-via-telnet-command
11587 @vindex nntp-via-telnet-command
11588 Command used to @code{telnet} the intermediate host.  The default is
11589 @samp{telnet}.
11590
11591 @item nntp-via-telnet-switches
11592 @vindex nntp-via-telnet-switches
11593 List of strings to be used as the switches to the
11594 @code{nntp-via-telnet-command} command.  The default is @samp{("-8")}.
11595
11596 @item nntp-via-user-password
11597 @vindex nntp-via-user-password
11598 Password to use when logging in on the intermediate host.
11599
11600 @item nntp-via-envuser
11601 @vindex nntp-via-envuser
11602 If non-@code{nil}, the intermediate @code{telnet} session (client and
11603 server both) will support the @code{ENVIRON} option and not prompt for
11604 login name. This works for Solaris @code{telnet}, for instance.
11605
11606 @item nntp-via-shell-prompt
11607 @vindex nntp-via-shell-prompt
11608 Regexp matching the shell prompt on the intermediate host.  The default
11609 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
11610
11611 @end table
11612
11613 @end table
11614
11615
11616 Here are some additional variables that are understood by all the above
11617 functions:
11618
11619 @table @code
11620
11621 @item nntp-via-user-name
11622 @vindex nntp-via-user-name
11623 User name to use when connecting to the intermediate host.
11624
11625 @item nntp-via-address
11626 @vindex nntp-via-address
11627 Address of the intermediate host to connect to.
11628
11629 @end table
11630
11631
11632 @node Common Variables
11633 @subsubsection Common Variables
11634
11635 The following variables affect the behavior of all, or several of the
11636 pre-made connection functions. When not specified, all functions are
11637 affected.
11638
11639 @table @code
11640
11641 @item nntp-pre-command
11642 @vindex nntp-pre-command
11643 A command wrapper to use when connecting through a non native connection
11644 function (all except @code{nntp-open-network-stream} and
11645 @code{nntp-open-ssl-stream}.  This is where you would put a @samp{SOCKS}
11646 wrapper for instance.
11647
11648 @item nntp-address
11649 @vindex nntp-address
11650 The address of the @sc{nntp} server.
11651
11652 @item nntp-port-number
11653 @vindex nntp-port-number
11654 Port number to connect to the @sc{nntp} server.  The default is @samp{nntp}.
11655
11656 @item nntp-end-of-line
11657 @vindex nntp-end-of-line
11658 String to use as end-of-line marker when talking to the @sc{nntp}
11659 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
11660 using a non native connection function.
11661
11662 @item nntp-telnet-command
11663 @vindex nntp-telnet-command
11664 Command to use when connecting to the @sc{nntp} server through
11665 @samp{telnet}.  This is NOT for an intermediate host.  This is just for
11666 the real @sc{nntp} server.  The default is @samp{telnet}.
11667
11668 @item nntp-telnet-switches
11669 @vindex nntp-telnet-switches
11670 A list of switches to pass to @code{nntp-telnet-command}.  The default
11671 is @samp{("-8")}.
11672
11673 @end table
11674
11675
11676 @node News Spool
11677 @subsection News Spool
11678 @cindex nnspool
11679 @cindex news spool
11680
11681 Subscribing to a foreign group from the local spool is extremely easy,
11682 and might be useful, for instance, to speed up reading groups that
11683 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
11684 instance.
11685
11686 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
11687 anything else) as the address.
11688
11689 If you have access to a local spool, you should probably use that as the
11690 native select method (@pxref{Finding the News}).  It is normally faster
11691 than using an @code{nntp} select method, but might not be.  It depends.
11692 You just have to try to find out what's best at your site.
11693
11694 @table @code
11695
11696 @item nnspool-inews-program
11697 @vindex nnspool-inews-program
11698 Program used to post an article.
11699
11700 @item nnspool-inews-switches
11701 @vindex nnspool-inews-switches
11702 Parameters given to the inews program when posting an article.
11703
11704 @item nnspool-spool-directory
11705 @vindex nnspool-spool-directory
11706 Where @code{nnspool} looks for the articles.  This is normally
11707 @file{/usr/spool/news/}.
11708
11709 @item nnspool-nov-directory
11710 @vindex nnspool-nov-directory
11711 Where @code{nnspool} will look for @sc{nov} files.  This is normally
11712 @file{/usr/spool/news/over.view/}.
11713
11714 @item nnspool-lib-dir
11715 @vindex nnspool-lib-dir
11716 Where the news lib dir is (@file{/usr/lib/news/} by default).
11717
11718 @item nnspool-active-file
11719 @vindex nnspool-active-file
11720 The path to the active file.
11721
11722 @item nnspool-newsgroups-file
11723 @vindex nnspool-newsgroups-file
11724 The path to the group descriptions file.
11725
11726 @item nnspool-history-file
11727 @vindex nnspool-history-file
11728 The path to the news history file.
11729
11730 @item nnspool-active-times-file
11731 @vindex nnspool-active-times-file
11732 The path to the active date file.
11733
11734 @item nnspool-nov-is-evil
11735 @vindex nnspool-nov-is-evil
11736 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
11737 that it finds.
11738
11739 @item nnspool-sift-nov-with-sed
11740 @vindex nnspool-sift-nov-with-sed
11741 @cindex sed
11742 If non-@code{nil}, which is the default, use @code{sed} to get the
11743 relevant portion from the overview file.  If nil, @code{nnspool} will
11744 load the entire file into a buffer and process it there.
11745
11746 @end table
11747
11748
11749 @node Getting Mail
11750 @section Getting Mail
11751 @cindex reading mail
11752 @cindex mail
11753
11754 Reading mail with a newsreader---isn't that just plain WeIrD? But of
11755 course.
11756
11757 @menu
11758 * Mail in a Newsreader::        Important introductory notes.
11759 * Getting Started Reading Mail::  A simple cookbook example.
11760 * Splitting Mail::              How to create mail groups.
11761 * Mail Sources::                How to tell Gnus where to get mail from.
11762 * Mail Back End Variables::     Variables for customizing mail handling.
11763 * Fancy Mail Splitting::        Gnus can do hairy splitting of incoming mail.
11764 * Group Mail Splitting::        Use group customize to drive mail splitting.
11765 * Incorporating Old Mail::      What about the old mail you have?
11766 * Expiring Mail::               Getting rid of unwanted mail.
11767 * Washing Mail::                Removing gruft from the mail you get.
11768 * Duplicates::                  Dealing with duplicated mail.
11769 * Not Reading Mail::            Using mail back ends for reading other files.
11770 * Choosing a Mail Back End::    Gnus can read a variety of mail formats.
11771 * Archiving Mail::              How to backup your mail.
11772 @end menu
11773
11774
11775 @node Mail in a Newsreader
11776 @subsection Mail in a Newsreader
11777
11778 If you are used to traditional mail readers, but have decided to switch
11779 to reading mail with Gnus, you may find yourself experiencing something
11780 of a culture shock.
11781
11782 Gnus does not behave like traditional mail readers.  If you want to make
11783 it behave that way, you can, but it's an uphill battle.
11784
11785 Gnus, by default, handles all its groups using the same approach.  This
11786 approach is very newsreaderly---you enter a group, see the new/unread
11787 messages, and when you read the messages, they get marked as read, and
11788 you don't see them any more.  (Unless you explicitly ask for them.)
11789
11790 In particular, you do not do anything explicitly to delete messages.
11791
11792 Does this mean that all the messages that have been marked as read are
11793 deleted?  How awful!
11794
11795 But, no, it means that old messages are @dfn{expired} according to some
11796 scheme or other.  For news messages, the expire process is controlled by
11797 the news administrator; for mail, the expire process is controlled by
11798 you.  The expire process for mail is covered in depth in @pxref{Expiring
11799 Mail}.
11800
11801 What many Gnus users find, after using it a while for both news and
11802 mail, is that the transport mechanism has very little to do with how
11803 they want to treat a message.
11804
11805 Many people subscribe to several mailing lists.  These are transported
11806 via SMTP, and are therefore mail.  But we might go for weeks without
11807 answering, or even reading these messages very carefully.  We may not
11808 need to save them because if we should need to read one again, they are
11809 archived somewhere else.
11810
11811 Some people have local news groups which have only a handful of readers.
11812 These are transported via @sc{nntp}, and are therefore news.  But we may need
11813 to read and answer a large fraction of the messages very carefully in
11814 order to do our work.  And there may not be an archive, so we may need
11815 to save the interesting messages the same way we would personal mail.
11816
11817 The important distinction turns out to be not the transport mechanism,
11818 but other factors such as how interested we are in the subject matter,
11819 or how easy it is to retrieve the message if we need to read it again.
11820
11821 Gnus provides many options for sorting mail into ``groups'' which behave
11822 like newsgroups, and for treating each group (whether mail or news)
11823 differently.
11824
11825 Some users never get comfortable using the Gnus (ahem) paradigm and wish
11826 that Gnus should grow up and be a male, er, mail reader.  It is possible
11827 to whip Gnus into a more mailreaderly being, but, as said before, it's
11828 not easy.  People who prefer proper mail readers should try @sc{vm}
11829 instead, which is an excellent, and proper, mail reader.
11830
11831 I don't mean to scare anybody off, but I want to make it clear that you
11832 may be required to learn a new way of thinking about messages.  After
11833 you've been subjected to The Gnus Way, you will come to love it.  I can
11834 guarantee it.  (At least the guy who sold me the Emacs Subliminal
11835 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
11836 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
11837 You Do.)
11838
11839
11840 @node Getting Started Reading Mail
11841 @subsection Getting Started Reading Mail
11842
11843 It's quite easy to use Gnus to read your new mail.  You just plonk the
11844 mail back end of your choice into @code{gnus-secondary-select-methods},
11845 and things will happen automatically.
11846
11847 For instance, if you want to use @code{nnml} (which is a "one file per
11848 mail" back end), you could put the following in your @file{.gnus} file:
11849
11850 @lisp
11851 (setq gnus-secondary-select-methods '((nnml "")))
11852 @end lisp
11853
11854 Now, the next time you start Gnus, this back end will be queried for new
11855 articles, and it will move all the messages in your spool file to its
11856 directory, which is @code{~/Mail/} by default.  The new group that will
11857 be created (@samp{mail.misc}) will be subscribed, and you can read it
11858 like any other group.
11859
11860 You will probably want to split the mail into several groups, though:
11861
11862 @lisp
11863 (setq nnmail-split-methods
11864       '(("junk" "^From:.*Lars Ingebrigtsen")
11865         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11866         ("other" "")))
11867 @end lisp
11868
11869 This will result in three new @code{nnml} mail groups being created:
11870 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
11871 mail that doesn't fit into the first two groups will be placed in the
11872 last group.
11873
11874 This should be sufficient for reading mail with Gnus.  You might want to
11875 give the other sections in this part of the manual a perusal, though.
11876 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
11877
11878
11879 @node Splitting Mail
11880 @subsection Splitting Mail
11881 @cindex splitting mail
11882 @cindex mail splitting
11883
11884 @vindex nnmail-split-methods
11885 The @code{nnmail-split-methods} variable says how the incoming mail is
11886 to be split into groups.
11887
11888 @lisp
11889 (setq nnmail-split-methods
11890   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11891     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11892     ("mail.other" "")))
11893 @end lisp
11894
11895 This variable is a list of lists, where the first element of each of
11896 these lists is the name of the mail group (they do not have to be called
11897 something beginning with @samp{mail}, by the way), and the second
11898 element is a regular expression used on the header of each mail to
11899 determine if it belongs in this mail group.  The first string may
11900 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11901 insert sub-expressions from the matched text.  For instance:
11902
11903 @lisp
11904 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11905 @end lisp
11906
11907 The second element can also be a function.  In that case, it will be
11908 called narrowed to the headers with the first element of the rule as the
11909 argument.  It should return a non-@code{nil} value if it thinks that the
11910 mail belongs in that group.
11911
11912 The last of these groups should always be a general one, and the regular
11913 expression should @emph{always} be @samp{} so that it matches any mails
11914 that haven't been matched by any of the other regexps.  (These rules are
11915 processed from the beginning of the alist toward the end.  The first
11916 rule to make a match will "win", unless you have crossposting enabled.
11917 In that case, all matching rules will "win".)
11918
11919 If you like to tinker with this yourself, you can set this variable to a
11920 function of your choice.  This function will be called without any
11921 arguments in a buffer narrowed to the headers of an incoming mail
11922 message.  The function should return a list of group names that it
11923 thinks should carry this mail message.
11924
11925 Note that the mail back ends are free to maul the poor, innocent,
11926 incoming headers all they want to.  They all add @code{Lines} headers;
11927 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11928 @code{From<SPACE>} line to something else.
11929
11930 @vindex nnmail-crosspost
11931 The mail back ends all support cross-posting.  If several regexps match,
11932 the mail will be ``cross-posted'' to all those groups.
11933 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
11934 that no articles are crossposted to the general (@samp{}) group.
11935
11936 @vindex nnmail-crosspost-link-function
11937 @cindex crosspost
11938 @cindex links
11939 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11940 the crossposted articles.  However, not all file systems support hard
11941 links.  If that's the case for you, set
11942 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
11943 variable is @code{add-name-to-file} by default.)
11944
11945 @kindex M-x nnmail-split-history
11946 @kindex nnmail-split-history
11947 If you wish to see where the previous mail split put the messages, you
11948 can use the @kbd{M-x nnmail-split-history} command.  If you wish to see
11949 where re-spooling messages would put the messages, you can use
11950 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11951 Group Commands}).
11952
11953 Gnus gives you all the opportunity you could possibly want for shooting
11954 yourself in the foot.  Let's say you create a group that will contain
11955 all the mail you get from your boss.  And then you accidentally
11956 unsubscribe from the group.  Gnus will still put all the mail from your
11957 boss in the unsubscribed group, and so, when your boss mails you ``Have
11958 that report ready by Monday or you're fired!'', you'll never see it and,
11959 come Tuesday, you'll still believe that you're gainfully employed while
11960 you really should be out collecting empty bottles to save up for next
11961 month's rent money.
11962
11963
11964 @node Mail Sources
11965 @subsection Mail Sources
11966
11967 Mail can be gotten from many different sources---the mail spool, from a
11968 POP mail server, from a procmail directory, or from a maildir, for
11969 instance.
11970
11971 @menu
11972 * Mail Source Specifiers::      How to specify what a mail source is.
11973 * Mail Source Customization::   Some variables that influence things.
11974 * Fetching Mail::               Using the mail source specifiers.
11975 @end menu
11976
11977
11978 @node Mail Source Specifiers
11979 @subsubsection Mail Source Specifiers
11980 @cindex POP
11981 @cindex mail server
11982 @cindex procmail
11983 @cindex mail spool
11984 @cindex mail source
11985
11986 You tell Gnus how to fetch mail by setting @code{mail-sources}
11987 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11988
11989 Here's an example:
11990
11991 @lisp
11992 (pop :server "pop3.mailserver.com" :user "myname")
11993 @end lisp
11994
11995 As can be observed, a mail source specifier is a list where the first
11996 element is a @dfn{mail source type}, followed by an arbitrary number of
11997 @dfn{keywords}.  Keywords that are not explicitly specified are given
11998 default values.
11999
12000 The following mail source types are available:
12001
12002 @table @code
12003 @item file
12004 Get mail from a single file; typically from the mail spool.
12005
12006 Keywords:
12007
12008 @table @code
12009 @item :path
12010 The path of the file.  Defaults to the value of the @code{MAIL}
12011 environment variable or @file{/usr/mail/spool/user-name}.
12012 @end table
12013
12014 An example file mail source:
12015
12016 @lisp
12017 (file :path "/usr/spool/mail/user-name")
12018 @end lisp
12019
12020 Or using the default path:
12021
12022 @lisp
12023 (file)
12024 @end lisp
12025
12026 If the mail spool file is not located on the local machine, it's best to
12027 use POP or @sc{imap} or the like to fetch the mail.  You can not use ange-ftp
12028 file names here---it has no way to lock the mail spool while moving the
12029 mail.
12030
12031 If it's impossible to set up a proper server, you can use ssh instead.
12032
12033 @lisp
12034 (setq mail-sources
12035       '((file :prescript "ssh host bin/getmail >%t")))
12036 @end lisp
12037
12038 The @samp{getmail} script would look something like the following:
12039
12040 @example
12041 #!/bin/sh
12042 #  getmail - move mail from spool to stdout
12043 #  flu@@iki.fi
12044
12045 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
12046 TMP=$HOME/Mail/tmp
12047 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
12048 @end example
12049
12050 Alter this script to fit find the @samp{movemail} you want to use.
12051
12052
12053 @item directory
12054 Get mail from several files in a directory.  This is typically used
12055 when you have procmail split the incoming mail into several files.
12056 That is, mail from the file @file{foo.bar.spool} will be put in the
12057 group @code{foo.bar}.  (You can change the suffix to be used instead
12058 of @code{.spool}.)  Setting
12059 @code{nnmail-scan-directory-mail-source-once} to non-nil forces Gnus
12060 to scan the mail source only once. This is particularly useful if you
12061 want to scan mail groups at a specified level.
12062
12063 Keywords:
12064
12065 @table @code
12066 @item :path
12067 The path of the directory where the files are.  There is no default
12068 value.
12069
12070 @item :suffix
12071 Only files ending with this suffix are used.  The default is
12072 @samp{.spool}.
12073
12074 @item :predicate
12075 Only files that have this predicate return non-@code{nil} are returned.
12076 The default is @code{identity}.  This is used as an additional
12077 filter---only files that have the right suffix @emph{and} satisfy this
12078 predicate are considered.
12079
12080 @item :prescript
12081 @itemx :postscript
12082 Script run before/after fetching mail.
12083
12084 @end table
12085
12086 An example directory mail source:
12087
12088 @lisp
12089 (directory :path "/home/user-name/procmail-dir/"
12090            :suffix ".prcml")
12091 @end lisp
12092
12093 @item pop
12094 Get mail from a POP server.
12095
12096 Keywords:
12097
12098 @table @code
12099 @item :server
12100 The name of the POP server.  The default is taken from the
12101 @code{MAILHOST} environment variable.
12102
12103 @item :port
12104 The port number of the POP server.  This can be a number (eg,
12105 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}).  If it is a
12106 string, it should be a service name as listed in @file{/etc/services} on
12107 Unix systems.  The default is @samp{"pop3"}.  On some systems you might
12108 need to specify it as @samp{"pop-3"} instead.
12109
12110 @item :user
12111 The user name to give to the POP server.  The default is the login
12112 name.
12113
12114 @item :password
12115 The password to give to the POP server.  If not specified, the user is
12116 prompted.
12117
12118 @item :program
12119 The program to use to fetch mail from the POP server.  This should be
12120 a @code{format}-like string.  Here's an example:
12121
12122 @example
12123 fetchmail %u@@%s -P %p %t
12124 @end example
12125
12126 The valid format specifier characters are:
12127
12128 @table @samp
12129 @item t
12130 The name of the file the mail is to be moved to.  This must always be
12131 included in this string.
12132
12133 @item s
12134 The name of the server.
12135
12136 @item P
12137 The port number of the server.
12138
12139 @item u
12140 The user name to use.
12141
12142 @item p
12143 The password to use.
12144 @end table
12145
12146 The values used for these specs are taken from the values you give the
12147 corresponding keywords.
12148
12149 @item :prescript
12150 A script to be run before fetching the mail.  The syntax is the same as
12151 the @code{:program} keyword.  This can also be a function to be run.
12152
12153 @item :postscript
12154 A script to be run after fetching the mail.  The syntax is the same as
12155 the @code{:program} keyword.  This can also be a function to be run.
12156
12157 @item :function
12158 The function to use to fetch mail from the POP server.  The function is
12159 called with one parameter---the name of the file where the mail should
12160 be moved to.
12161
12162 @item :authentication
12163 This can be either the symbol @code{password} or the symbol @code{apop}
12164 and says what authentication scheme to use.  The default is
12165 @code{password}.
12166
12167 @end table
12168
12169 If the @code{:program} and @code{:function} keywords aren't specified,
12170 @code{pop3-movemail} will be used.
12171
12172 Here are some examples.  Fetch from the default POP server, using the
12173 default user name, and default fetcher:
12174
12175 @lisp
12176 (pop)
12177 @end lisp
12178
12179 Fetch from a named server with a named user and password:
12180
12181 @lisp
12182 (pop :server "my.pop.server"
12183      :user "user-name" :password "secret")
12184 @end lisp
12185
12186 Use @samp{movemail} to move the mail:
12187
12188 @lisp
12189 (pop :program "movemail po:%u %t %p")
12190 @end lisp
12191
12192 @item maildir
12193 Get mail from a maildir.  This is a type of mailbox that is supported by
12194 at least qmail and postfix, where each file in a special directory
12195 contains exactly one mail.
12196
12197 Keywords:
12198
12199 @table @code
12200 @item :path
12201 The path of the directory where the mails are stored.  The default is
12202 taken from the @code{MAILDIR} environment variable or
12203 @samp{~/Maildir/}.
12204 @item :subdirs
12205 The subdirectories of the Maildir.  The default is
12206 @samp{("new" "cur")}.
12207
12208 @c If you sometimes look at your mail through a pop3 daemon before fetching
12209 @c them with Gnus, you may also have to fetch your mails from the
12210 @c @code{cur} directory inside the maildir, like in the first example
12211 @c below.
12212
12213 You can also get mails from remote hosts (because maildirs don't suffer
12214 from locking problems).
12215
12216 @end table
12217
12218 Two example maildir mail sources:
12219
12220 @lisp
12221 (maildir :path "/home/user-name/Maildir/"
12222          :subdirs ("cur" "new"))
12223 @end lisp
12224
12225 @lisp
12226 (maildir :path "/user@@remotehost.org:~/Maildir/"
12227          :subdirs ("new"))
12228 @end lisp
12229
12230 @item imap
12231 Get mail from a @sc{imap} server.  If you don't want to use @sc{imap}
12232 as intended, as a network mail reading protocol (ie with nnimap), for
12233 some reason or other, Gnus let you treat it similar to a POP server
12234 and fetches articles from a given @sc{imap} mailbox.  @xref{IMAP}, for
12235 more information.
12236
12237 Note that for the Kerberos, GSSAPI, SSL/TLS and STARTTLS support you
12238 may need external programs and libraries, @xref{IMAP}.
12239
12240 Keywords:
12241
12242 @table @code
12243 @item :server
12244 The name of the @sc{imap} server.  The default is taken from the
12245 @code{MAILHOST} environment variable.
12246
12247 @item :port
12248 The port number of the @sc{imap} server.  The default is @samp{143}, or
12249 @samp{993} for SSL/TLS connections.
12250
12251 @item :user
12252 The user name to give to the @sc{imap} server.  The default is the login
12253 name.
12254
12255 @item :password
12256 The password to give to the @sc{imap} server.  If not specified, the user is
12257 prompted.
12258
12259 @item :stream
12260 What stream to use for connecting to the server, this is one of the
12261 symbols in @code{imap-stream-alist}.  Right now, this means
12262 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{ssl},
12263 @samp{shell} or the default @samp{network}.
12264
12265 @item :authentication
12266 Which authenticator to use for authenticating to the server, this is
12267 one of the symbols in @code{imap-authenticator-alist}.  Right now,
12268 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
12269 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
12270
12271 @item :program
12272 When using the `shell' :stream, the contents of this variable is
12273 mapped into the `imap-shell-program' variable.  This should be a
12274 @code{format}-like string (or list of strings).  Here's an example:
12275
12276 @example
12277 ssh %s imapd
12278 @end example
12279
12280 The valid format specifier characters are:
12281
12282 @table @samp
12283 @item s
12284 The name of the server.
12285
12286 @item l
12287 User name from `imap-default-user'.
12288
12289 @item p
12290 The port number of the server.
12291 @end table
12292
12293 The values used for these specs are taken from the values you give the
12294 corresponding keywords.
12295
12296 @item :mailbox
12297 The name of the mailbox to get mail from.  The default is @samp{INBOX}
12298 which normally is the mailbox which receive incoming mail.
12299
12300 @item :predicate
12301 The predicate used to find articles to fetch.  The default, @samp{UNSEEN
12302 UNDELETED}, is probably the best choice for most people, but if you
12303 sometimes peek in your mailbox with a @sc{imap} client and mark some
12304 articles as read (or; SEEN) you might want to set this to @samp{nil}.
12305 Then all articles in the mailbox is fetched, no matter what.  For a
12306 complete list of predicates, see RFC 2060 Â§6.4.4.
12307
12308 @item :fetchflag
12309 How to flag fetched articles on the server, the default @samp{\Deleted}
12310 will mark them as deleted, an alternative would be @samp{\Seen} which
12311 would simply mark them as read.  These are the two most likely choices,
12312 but more flags are defined in RFC 2060 Â§2.3.2.
12313
12314 @item :dontexpunge
12315 If non-nil, don't remove all articles marked as deleted in the mailbox
12316 after finishing the fetch.
12317
12318 @end table
12319
12320 An example @sc{imap} mail source:
12321
12322 @lisp
12323 (imap :server "mail.mycorp.com"
12324       :stream kerberos4
12325       :fetchflag "\\Seen")
12326 @end lisp
12327
12328 @item webmail
12329 Get mail from a webmail server, such as www.hotmail.com,
12330 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
12331
12332 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
12333 is suggested.
12334
12335 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
12336 required for url "4.0pre.46".
12337
12338 WARNING: Mails may lost.  NO WARRANTY.
12339
12340 Keywords:
12341
12342 @table @code
12343 @item :subtype
12344 The type of the webmail server.  The default is @code{hotmail}.  The
12345 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
12346
12347 @item :user
12348 The user name to give to the webmail server.  The default is the login
12349 name.
12350
12351 @item :password
12352 The password to give to the webmail server.  If not specified, the user is
12353 prompted.
12354
12355 @item :dontexpunge
12356 If non-nil, only fetch unread articles and don't move them to trash
12357 folder after finishing the fetch.
12358
12359 @end table
12360
12361 An example webmail source:
12362
12363 @lisp
12364 (webmail :subtype 'hotmail
12365          :user "user-name"
12366          :password "secret")
12367 @end lisp
12368 @end table
12369
12370 @table @dfn
12371 @item Common Keywords
12372 Common keywords can be used in any type of mail source.
12373
12374 Keywords:
12375
12376 @table @code
12377 @item :plugged
12378 If non-nil, fetch the mail even when Gnus is unplugged.  If you use
12379 directory source to get mail, you can specify it as in this example:
12380
12381 @lisp
12382 (setq mail-sources
12383       '((directory :path "/home/pavel/.Spool/"
12384                    :suffix ""
12385                    :plugged t)))
12386 @end lisp
12387
12388 Gnus will then fetch your mail even when you are unplugged.  This is
12389 useful when you use local mail and news.
12390
12391 @end table
12392 @end table
12393
12394 @subsubsection Function Interface
12395
12396 Some of the above keywords specify a Lisp function to be executed.
12397 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
12398 the value of the keyword while the function is executing.  For example,
12399 consider the following mail-source setting:
12400
12401 @lisp
12402 (setq mail-sources '((pop :user "jrl"
12403                           :server "pophost" :function fetchfunc)))
12404 @end lisp
12405
12406 While the function @code{fetchfunc} is executing, the symbol @code{user}
12407 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
12408 @code{"pophost"}.  The symbols @code{port}, @code{password},
12409 @code{program}, @code{prescript}, @code{postscript}, @code{function},
12410 and @code{authentication} are also bound (to their default values).
12411
12412 See above for a list of keywords for each type of mail source.
12413
12414
12415 @node Mail Source Customization
12416 @subsubsection Mail Source Customization
12417
12418 The following is a list of variables that influence how the mail is
12419 fetched.  You would normally not need to set or change any of these
12420 variables.
12421
12422 @table @code
12423 @item mail-source-crash-box
12424 @vindex mail-source-crash-box
12425 File where mail will be stored while processing it.  The default is
12426 @file{~/.emacs-mail-crash-box}.
12427
12428 @item mail-source-delete-incoming
12429 @vindex mail-source-delete-incoming
12430 If non-@code{nil}, delete incoming files after handling them.
12431
12432 @item mail-source-directory
12433 @vindex mail-source-directory
12434 Directory where files (if any) will be stored.  The default is
12435 @file{~/Mail/}.  At present, the only thing this is used for is to say
12436 where the incoming files will be stored if the previous variable is
12437 @code{nil}.
12438
12439 @item mail-source-incoming-file-prefix
12440 @vindex mail-source-incoming-file-prefix
12441 Prefix for file name for storing incoming mail.  The default is
12442 @file{Incoming}, in which case files will end up with names like
12443 @file{Incoming30630D_} or @file{Incoming298602ZD}.  This is really only
12444 relevant if @code{mail-source-delete-incoming} is @code{nil}.
12445
12446 @item mail-source-default-file-modes
12447 @vindex mail-source-default-file-modes
12448 All new mail files will get this file mode.  The default is 384.
12449
12450 @item mail-source-movemail-program
12451 @vindex mail-source-movemail-program
12452 If non-nil, name of program for fetching new mail.  If nil,
12453 @code{movemail} in @var{exec-directory}.
12454
12455 @end table
12456
12457
12458 @node Fetching Mail
12459 @subsubsection Fetching Mail
12460
12461 @vindex mail-sources
12462 @vindex nnmail-spool-file
12463 The way to actually tell Gnus where to get new mail from is to set
12464 @code{mail-sources} to a list of mail source specifiers
12465 (@pxref{Mail Source Specifiers}).
12466
12467 If this variable (and the obsolescent @code{nnmail-spool-file}) is
12468 @code{nil}, the mail back ends will never attempt to fetch mail by
12469 themselves.
12470
12471 If you want to fetch mail both from your local spool as well as a POP
12472 mail server, you'd say something like:
12473
12474 @lisp
12475 (setq mail-sources
12476       '((file)
12477         (pop :server "pop3.mail.server"
12478              :password "secret")))
12479 @end lisp
12480
12481 Or, if you don't want to use any of the keyword defaults:
12482
12483 @lisp
12484 (setq mail-sources
12485       '((file :path "/var/spool/mail/user-name")
12486         (pop :server "pop3.mail.server"
12487              :user "user-name"
12488              :port "pop3"
12489              :password "secret")))
12490 @end lisp
12491
12492
12493 When you use a mail back end, Gnus will slurp all your mail from your
12494 inbox and plonk it down in your home directory.  Gnus doesn't move any
12495 mail if you're not using a mail back end---you have to do a lot of magic
12496 invocations first.  At the time when you have finished drawing the
12497 pentagram, lightened the candles, and sacrificed the goat, you really
12498 shouldn't be too surprised when Gnus moves your mail.
12499
12500
12501
12502 @node Mail Back End Variables
12503 @subsection Mail Back End Variables
12504
12505 These variables are (for the most part) pertinent to all the various
12506 mail back ends.
12507
12508 @table @code
12509 @vindex nnmail-read-incoming-hook
12510 @item nnmail-read-incoming-hook
12511 The mail back ends all call this hook after reading new mail.  You can
12512 use this hook to notify any mail watch programs, if you want to.
12513
12514 @vindex nnmail-split-hook
12515 @item nnmail-split-hook
12516 @findex article-decode-encoded-words
12517 @findex RFC 1522 decoding
12518 @findex RFC 2047 decoding
12519 Hook run in the buffer where the mail headers of each message is kept
12520 just before the splitting based on these headers is done.  The hook is
12521 free to modify the buffer contents in any way it sees fit---the buffer
12522 is discarded after the splitting has been done, and no changes performed
12523 in the buffer will show up in any files.
12524 @code{gnus-article-decode-encoded-words} is one likely function to add
12525 to this hook.
12526
12527 @vindex nnmail-pre-get-new-mail-hook
12528 @vindex nnmail-post-get-new-mail-hook
12529 @item nnmail-pre-get-new-mail-hook
12530 @itemx nnmail-post-get-new-mail-hook
12531 These are two useful hooks executed when treating new incoming
12532 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
12533 starting to handle the new mail) and
12534 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
12535 is done).  Here's and example of using these two hooks to change the
12536 default file modes the new mail files get:
12537
12538 @lisp
12539 (add-hook 'nnmail-pre-get-new-mail-hook
12540           (lambda () (set-default-file-modes 511)))
12541
12542 (add-hook 'nnmail-post-get-new-mail-hook
12543           (lambda () (set-default-file-modes 551)))
12544 @end lisp
12545
12546 @item nnmail-use-long-file-names
12547 @vindex nnmail-use-long-file-names
12548 If non-@code{nil}, the mail back ends will use long file and directory
12549 names.  Groups like @samp{mail.misc} will end up in directories
12550 (assuming use of @code{nnml} back end) or files (assuming use of
12551 @code{nnfolder} back end) like @file{mail.misc}.  If it is @code{nil},
12552 the same group will end up in @file{mail/misc}.
12553
12554 @item nnmail-delete-file-function
12555 @vindex nnmail-delete-file-function
12556 @findex delete-file
12557 Function called to delete files.  It is @code{delete-file} by default.
12558
12559 @item nnmail-cache-accepted-message-ids
12560 @vindex nnmail-cache-accepted-message-ids
12561 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
12562 the back end (via @code{Gcc}, for instance) into the mail duplication
12563 discovery cache.  The default is @code{nil}.
12564
12565 @end table
12566
12567
12568 @node Fancy Mail Splitting
12569 @subsection Fancy Mail Splitting
12570 @cindex mail splitting
12571 @cindex fancy mail splitting
12572
12573 @vindex nnmail-split-fancy
12574 @findex nnmail-split-fancy
12575 If the rather simple, standard method for specifying how to split mail
12576 doesn't allow you to do what you want, you can set
12577 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
12578 play with the @code{nnmail-split-fancy} variable.
12579
12580 Let's look at an example value of this variable first:
12581
12582 @lisp
12583 ;; Messages from the mailer daemon are not crossposted to any of
12584 ;; the ordinary groups.  Warnings are put in a separate group
12585 ;; from real errors.
12586 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
12587                    "mail.misc"))
12588    ;; Non-error messages are crossposted to all relevant
12589    ;; groups, but we don't crosspost between the group for the
12590    ;; (ding) list and the group for other (ding) related mail.
12591    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
12592          ("subject" "ding" "ding.misc"))
12593       ;; Other mailing lists...
12594       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
12595       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
12596       ;; Both lists below have the same suffix, so prevent
12597       ;; cross-posting to mkpkg.list of messages posted only to
12598       ;; the bugs- list, but allow cross-posting when the
12599       ;; message was really cross-posted.
12600       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
12601       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
12602       ;; People...
12603       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
12604    ;; Unmatched mail goes to the catch all group.
12605    "misc.misc")
12606 @end lisp
12607
12608 This variable has the format of a @dfn{split}.  A split is a (possibly)
12609 recursive structure where each split may contain other splits.  Here are
12610 the five possible split syntaxes:
12611
12612 @enumerate
12613
12614 @item
12615 @samp{group}: If the split is a string, that will be taken as a group
12616 name.  Normal regexp match expansion will be done.  See below for
12617 examples.
12618
12619 @item
12620 @code{(@var{field} @var{value} @code{[-} @var{restrict}
12621 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
12622 first element of which is a string, then store the message as
12623 specified by @var{split}, if header @var{field} (a regexp) contains
12624 @var{value} (also a regexp).  If @var{restrict} (yet another regexp)
12625 matches some string after @var{field} and before the end of the
12626 matched @var{value}, the @var{split} is ignored.  If none of the
12627 @var{restrict} clauses match, @var{split} is processed.
12628
12629 @item
12630 @code{(| @var{split}@dots{})}: If the split is a list, and the first
12631 element is @code{|} (vertical bar), then process each @var{split} until
12632 one of them matches.  A @var{split} is said to match if it will cause
12633 the mail message to be stored in one or more groups.
12634
12635 @item
12636 @code{(& @var{split}@dots{})}: If the split is a list, and the first
12637 element is @code{&}, then process all @var{split}s in the list.
12638
12639 @item
12640 @code{junk}: If the split is the symbol @code{junk}, then don't save
12641 (i.e., delete) this message.  Use with extreme caution.
12642
12643 @item
12644 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is
12645 a list, and the first element is @code{:}, then the second element will
12646 be called as a function with @var{args} given as arguments.  The
12647 function should return a @var{split}.
12648
12649 @cindex body split
12650 For instance, the following function could be used to split based on the
12651 body of the messages:
12652
12653 @lisp
12654 (defun split-on-body ()
12655   (save-excursion
12656     (set-buffer " *nnmail incoming*")
12657     (goto-char (point-min))
12658     (when (re-search-forward "Some.*string" nil t)
12659       "string.group")))
12660 @end lisp
12661
12662 The @samp{" *nnmail incoming*"} is narrowed to the message in question
12663 when the @code{:} function is run.
12664
12665 @item
12666 @code{(! @var{func} @var{split})}: If the split is a list, and the first
12667 element is @code{!}, then SPLIT will be processed, and FUNC will be
12668 called as a function with the result of SPLIT as argument.  FUNC should
12669 return a split.
12670
12671 @item
12672 @code{nil}: If the split is @code{nil}, it is ignored.
12673
12674 @end enumerate
12675
12676 In these splits, @var{field} must match a complete field name.
12677 @var{value} must match a complete word according to the fundamental mode
12678 syntax table.  You can use @code{.*} in the regexps to match partial
12679 field names or words.  In other words, all @var{value}'s are wrapped in
12680 @samp{\<} and @samp{\>} pairs.
12681
12682 @vindex nnmail-split-abbrev-alist
12683 @var{field} and @var{value} can also be lisp symbols, in that case they
12684 are expanded as specified by the variable
12685 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
12686 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
12687 value.
12688
12689 @vindex nnmail-split-fancy-syntax-table
12690 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
12691 when all this splitting is performed.
12692
12693 If you want to have Gnus create groups dynamically based on some
12694 information in the headers (i.e., do @code{replace-match}-like
12695 substitutions in the group names), you can say things like:
12696
12697 @example
12698 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
12699 @end example
12700
12701 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
12702 will be filed in @samp{mail.debian.foo}.
12703
12704 If the string contains the element @samp{\&}, then the previously
12705 matched string will be substituted.  Similarly, the elements @samp{\\1}
12706 up to @samp{\\9} will be substituted with the text matched by the
12707 groupings 1 through 9.
12708
12709 @findex nnmail-split-fancy-with-parent
12710 @code{nnmail-split-fancy-with-parent} is a function which allows you to
12711 split followups into the same groups their parents are in.  Sometimes
12712 you can't make splitting rules for all your mail.  For example, your
12713 boss might send you personal mail regarding different projects you are
12714 working on, and as you can't tell your boss to put a distinguishing
12715 string into the subject line, you have to resort to manually moving the
12716 messages into the right group.  With this function, you only have to do
12717 it once per thread.
12718
12719 To use this feature, you have to set @code{nnmail-treat-duplicates} and
12720 @code{nnmail-cache-accepted-message-ids} to a non-nil value.  And then
12721 you can include @code{nnmail-split-fancy-with-parent} using the colon
12722 feature, like so:
12723 @lisp
12724 (setq nnmail-split-fancy
12725       '(| (: nnmail-split-fancy-with-parent)
12726           ;; other splits go here
12727         ))
12728 @end lisp
12729
12730 This feature works as follows: when @code{nnmail-treat-duplicates} is
12731 non-nil, Gnus records the message id of every message it sees in the
12732 file specified by the variable @code{nnmail-message-id-cache-file},
12733 together with the group it is in (the group is omitted for non-mail
12734 messages).  When mail splitting is invoked, the function
12735 @code{nnmail-split-fancy-with-parent} then looks at the References (and
12736 In-Reply-To) header of each message to split and searches the file
12737 specified by @code{nnmail-message-id-cache-file} for the message ids.
12738 When it has found a parent, it returns the corresponding group name
12739 unless the group name matches the regexp
12740 @code{nnmail-split-fancy-with-parent-ignore-groups}.  It is recommended
12741 that you set @code{nnmail-message-id-cache-length} to a somewhat higher
12742 number than the default so that the message ids are still in the cache.
12743 (A value of 5000 appears to create a file some 300 kBytes in size.)
12744 @vindex nnmail-cache-accepted-message-ids
12745 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
12746 also records the message ids of moved articles, so that the followup
12747 messages goes into the new group.
12748
12749
12750 @node Group Mail Splitting
12751 @subsection Group Mail Splitting
12752 @cindex mail splitting
12753 @cindex group mail splitting
12754
12755 @findex gnus-group-split
12756 If you subscribe to dozens of mailing lists but you don't want to
12757 maintain mail splitting rules manually, group mail splitting is for you.
12758 You just have to set @var{to-list} and/or @var{to-address} in group
12759 parameters or group customization and set @code{nnmail-split-methods} to
12760 @code{gnus-group-split}.  This splitting function will scan all groups
12761 for those parameters and split mail accordingly, i.e., messages posted
12762 from or to the addresses specified in the parameters @var{to-list} or
12763 @var{to-address} of a mail group will be stored in that group.
12764
12765 Sometimes, mailing lists have multiple addresses, and you may want mail
12766 splitting to recognize them all: just set the @var{extra-aliases} group
12767 parameter to the list of additional addresses and it's done.  If you'd
12768 rather use a regular expression, set @var{split-regexp}.
12769
12770 All these parameters in a group will be used to create an
12771 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
12772 the @var{value} is a single regular expression that matches
12773 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
12774 matches of @var{split-regexp}, and the @var{split} is the name of the
12775 group.  @var{restrict}s are also supported: just set the
12776 @var{split-exclude} parameter to a list of regular expressions.
12777
12778 If you can't get the right split to be generated using all these
12779 parameters, or you just need something fancier, you can set the
12780 parameter @var{split-spec} to an @code{nnmail-split-fancy} split.  In
12781 this case, all other aforementioned parameters will be ignored by
12782 @code{gnus-group-split}.  In particular, @var{split-spec} may be set to
12783 @code{nil}, in which case the group will be ignored by
12784 @code{gnus-group-split}.
12785
12786 @vindex gnus-group-split-default-catch-all-group
12787 @code{gnus-group-split} will do cross-posting on all groups that match,
12788 by defining a single @code{&} fancy split containing one split for each
12789 group.  If a message doesn't match any split, it will be stored in the
12790 group named in @code{gnus-group-split-default-catch-all-group}, unless
12791 some group has @var{split-spec} set to @code{catch-all}, in which case
12792 that group is used as the catch-all group.  Even though this variable is
12793 often used just to name a group, it may also be set to an arbitrarily
12794 complex fancy split (after all, a group name is a fancy split), and this
12795 may be useful to split mail that doesn't go to any mailing list to
12796 personal mail folders.  Note that this fancy split is added as the last
12797 element of a @code{|} split list that also contains a @code{&} split
12798 with the rules extracted from group parameters.
12799
12800 It's time for an example.  Assume the following group parameters have
12801 been defined:
12802
12803 @example
12804 nnml:mail.bar:
12805 ((to-address . "bar@@femail.com")
12806  (split-regexp . ".*@@femail\\.com"))
12807 nnml:mail.foo:
12808 ((to-list . "foo@@nowhere.gov")
12809  (extra-aliases "foo@@localhost" "foo-redist@@home")
12810  (split-exclude "bugs-foo" "rambling-foo")
12811  (admin-address . "foo-request@@nowhere.gov"))
12812 nnml:mail.others:
12813 ((split-spec . catch-all))
12814 @end example
12815
12816 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
12817 behave as if @code{nnmail-split-fancy} had been selected and variable
12818 @code{nnmail-split-fancy} had been set as follows:
12819
12820 @lisp
12821 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
12822       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
12823            - "bugs-foo" - "rambling-foo" "mail.foo"))
12824    "mail.others")
12825 @end lisp
12826
12827 @findex gnus-group-split-fancy
12828 If you'd rather not use group splitting for all your mail groups, you
12829 may use it for only some of them, by using @code{nnmail-split-fancy}
12830 splits like this:
12831
12832 @lisp
12833 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
12834 @end lisp
12835
12836 @var{groups} may be a regular expression or a list of group names whose
12837 parameters will be scanned to generate the output split.
12838 @var{no-crosspost} can be used to disable cross-posting; in this case, a
12839 single @code{|} split will be output.  @var{catch-all} is the fallback
12840 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
12841 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
12842 empty string in any selected group, no catch-all split will be issued.
12843 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
12844 this group will override the value of the @var{catch-all} argument.
12845
12846 @findex gnus-group-split-setup
12847 Unfortunately, scanning all groups and their parameters can be quite
12848 slow, especially considering that it has to be done for every message.
12849 But don't despair!  The function @code{gnus-group-split-setup} can be
12850 used to enable @code{gnus-group-split} in a much more efficient way.  It
12851 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
12852 @code{nnmail-split-fancy} to the split produced by
12853 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
12854 scanned once, no matter how many messages are split.
12855
12856 @findex gnus-group-split-update
12857 However, if you change group parameters, you'd have to update
12858 @code{nnmail-split-fancy} manually.  You can do it by running
12859 @code{gnus-group-split-update}.  If you'd rather have it updated
12860 automatically, just tell @code{gnus-group-split-setup} to do it for
12861 you.  For example, add to your @file{.gnus}:
12862
12863 @lisp
12864 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
12865 @end lisp
12866
12867 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
12868 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
12869 have to worry about updating @code{nnmail-split-fancy} again.  If you
12870 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
12871 @code{gnus-group-split-default-catch-all-group} will be set to its
12872 value.
12873
12874 @vindex gnus-group-split-updated-hook
12875 Because you may want to change @code{nnmail-split-fancy} after it is set
12876 by @code{gnus-group-split-update}, this function will run
12877 @code{gnus-group-split-updated-hook} just before finishing.
12878
12879 @node Incorporating Old Mail
12880 @subsection Incorporating Old Mail
12881 @cindex incorporating old mail
12882 @cindex import old mail
12883
12884 Most people have lots of old mail stored in various file formats.  If
12885 you have set up Gnus to read mail using one of the spiffy Gnus mail
12886 back ends, you'll probably wish to have that old mail incorporated into
12887 your mail groups.
12888
12889 Doing so can be quite easy.
12890
12891 To take an example: You're reading mail using @code{nnml}
12892 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12893 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
12894 file filled with important, but old, mail.  You want to move it into
12895 your @code{nnml} groups.
12896
12897 Here's how:
12898
12899 @enumerate
12900 @item
12901 Go to the group buffer.
12902
12903 @item
12904 Type `G f' and give the path to the mbox file when prompted to create an
12905 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12906
12907 @item
12908 Type `SPACE' to enter the newly created group.
12909
12910 @item
12911 Type `M P b' to process-mark all articles in this group's buffer
12912 (@pxref{Setting Process Marks}).
12913
12914 @item
12915 Type `B r' to respool all the process-marked articles, and answer
12916 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12917 @end enumerate
12918
12919 All the mail messages in the mbox file will now also be spread out over
12920 all your @code{nnml} groups.  Try entering them and check whether things
12921 have gone without a glitch.  If things look ok, you may consider
12922 deleting the mbox file, but I wouldn't do that unless I was absolutely
12923 sure that all the mail has ended up where it should be.
12924
12925 Respooling is also a handy thing to do if you're switching from one mail
12926 back end to another.  Just respool all the mail in the old mail groups
12927 using the new mail back end.
12928
12929
12930 @node Expiring Mail
12931 @subsection Expiring Mail
12932 @cindex article expiry
12933
12934 Traditional mail readers have a tendency to remove mail articles when
12935 you mark them as read, in some way.  Gnus takes a fundamentally
12936 different approach to mail reading.
12937
12938 Gnus basically considers mail just to be news that has been received in
12939 a rather peculiar manner.  It does not think that it has the power to
12940 actually change the mail, or delete any mail messages.  If you enter a
12941 mail group, and mark articles as ``read'', or kill them in some other
12942 fashion, the mail articles will still exist on the system.  I repeat:
12943 Gnus will not delete your old, read mail.  Unless you ask it to, of
12944 course.
12945
12946 To make Gnus get rid of your unwanted mail, you have to mark the
12947 articles as @dfn{expirable}.  This does not mean that the articles will
12948 disappear right away, however.  In general, a mail article will be
12949 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12950 more than one week old.  If you do not mark an article as expirable, it
12951 will remain on your system until hell freezes over.  This bears
12952 repeating one more time, with some spurious capitalizations: IF you do
12953 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12954
12955 @vindex gnus-auto-expirable-newsgroups
12956 You do not have to mark articles as expirable by hand.  Groups that
12957 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12958 have all articles that you read marked as expirable automatically.  All
12959 articles marked as expirable have an @samp{E} in the first
12960 column in the summary buffer.
12961
12962 By default, if you have auto expiry switched on, Gnus will mark all the
12963 articles you read as expirable, no matter if they were read or unread
12964 before.  To avoid having articles marked as read marked as expirable
12965 automatically, you can put something like the following in your
12966 @file{.gnus} file:
12967
12968 @vindex gnus-mark-article-hook
12969 @lisp
12970 (remove-hook 'gnus-mark-article-hook
12971              'gnus-summary-mark-read-and-unread-as-read)
12972 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12973 @end lisp
12974
12975 Note that making a group auto-expirable doesn't mean that all read
12976 articles are expired---only the articles marked as expirable
12977 will be expired.  Also note that using the @kbd{d} command won't make
12978 articles expirable---only semi-automatic marking of articles as read will
12979 mark the articles as expirable in auto-expirable groups.
12980
12981 Let's say you subscribe to a couple of mailing lists, and you want the
12982 articles you have read to disappear after a while:
12983
12984 @lisp
12985 (setq gnus-auto-expirable-newsgroups
12986       "mail.nonsense-list\\|mail.nice-list")
12987 @end lisp
12988
12989 Another way to have auto-expiry happen is to have the element
12990 @code{auto-expire} in the group parameters of the group.
12991
12992 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12993 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
12994 don't really mix very well.
12995
12996 @vindex nnmail-expiry-wait
12997 The @code{nnmail-expiry-wait} variable supplies the default time an
12998 expirable article has to live.  Gnus starts counting days from when the
12999 message @emph{arrived}, not from when it was sent.  The default is seven
13000 days.
13001
13002 Gnus also supplies a function that lets you fine-tune how long articles
13003 are to live, based on what group they are in.  Let's say you want to
13004 have one month expiry period in the @samp{mail.private} group, a one day
13005 expiry period in the @samp{mail.junk} group, and a six day expiry period
13006 everywhere else:
13007
13008 @vindex nnmail-expiry-wait-function
13009 @lisp
13010 (setq nnmail-expiry-wait-function
13011       (lambda (group)
13012        (cond ((string= group "mail.private")
13013                31)
13014              ((string= group "mail.junk")
13015                1)
13016              ((string= group "important")
13017                'never)
13018              (t
13019                6))))
13020 @end lisp
13021
13022 The group names this function is fed are ``unadorned'' group
13023 names---no @samp{nnml:} prefixes and the like.
13024
13025 The @code{nnmail-expiry-wait} variable and
13026 @code{nnmail-expiry-wait-function} function can either be a number (not
13027 necessarily an integer) or one of the symbols @code{immediate} or
13028 @code{never}.
13029
13030 You can also use the @code{expiry-wait} group parameter to selectively
13031 change the expiry period (@pxref{Group Parameters}).
13032
13033 @vindex nnmail-expiry-target
13034 The normal action taken when expiring articles is to delete them.
13035 However, in some circumstances it might make more sense to move them to
13036 other groups instead of deleting them.  The variable @code{nnmail-expiry-target}
13037 (and the @code{expiry-target} group parameter) controls this.  The
13038 variable supplies a default value for all groups, which can be
13039 overridden for specific groups by the group parameter.
13040 default value is @code{delete}, but this can also be a string (which
13041 should be the name of the group the message should be moved to), or a
13042 function (which will be called in a buffer narrowed to the message in
13043 question, and with the name of the group being moved from as its
13044 parameter) which should return a target -- either a group name or
13045 @code{delete}.
13046
13047 Here's an example for specifying a group name:
13048 @lisp
13049 (setq nnmail-expiry-target "nnml:expired")
13050 @end lisp
13051
13052 @findex nnmail-fancy-expiry-target
13053 @vindex nnmail-fancy-expiry-targets
13054 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
13055 expire mail to groups according to the variable
13056 @code{nnmail-fancy-expiry-targets}.  Here's an example:
13057
13058 @lisp
13059  (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
13060        nnmail-fancy-expiry-targets
13061        '((to-from "boss" "nnfolder:Work")
13062          ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
13063          ("from" ".*" "nnfolder:Archive-%Y")))
13064 @end lisp
13065
13066 With this setup, any mail that has @code{IMPORTANT} in its Subject
13067 header and was sent in the year @code{YYYY} and month @code{MMM}, will
13068 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
13069 From or To header contains the string @code{boss}, it will get expired
13070 to @code{nnfolder:Work}. All other mail will get expired to
13071 @code{nnfolder:Archive-YYYY}.
13072
13073 @vindex nnmail-keep-last-article
13074 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
13075 expire the final article in a mail newsgroup.  This is to make life
13076 easier for procmail users.
13077
13078 @vindex gnus-total-expirable-newsgroups
13079 By the way: That line up there, about Gnus never expiring non-expirable
13080 articles, is a lie.  If you put @code{total-expire} in the group
13081 parameters, articles will not be marked as expirable, but all read
13082 articles will be put through the expiry process.  Use with extreme
13083 caution.  Even more dangerous is the
13084 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
13085 this regexp will have all read articles put through the expiry process,
13086 which means that @emph{all} old mail articles in the groups in question
13087 will be deleted after a while.  Use with extreme caution, and don't come
13088 crying to me when you discover that the regexp you used matched the
13089 wrong group and all your important mail has disappeared.  Be a
13090 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
13091 with!  So there!
13092
13093 Most people make most of their mail groups total-expirable, though.
13094
13095 @vindex gnus-inhibit-user-auto-expire
13096 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
13097 commands will not mark an article as expirable, even if the group has
13098 auto-expire turned on.
13099
13100
13101 @node Washing Mail
13102 @subsection Washing Mail
13103 @cindex mail washing
13104 @cindex list server brain damage
13105 @cindex incoming mail treatment
13106
13107 Mailers and list servers are notorious for doing all sorts of really,
13108 really stupid things with mail.  ``Hey, RFC 822 doesn't explicitly
13109 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
13110 end of all lines passing through our server, so let's do that!!!!1!''
13111 Yes, but RFC 822 wasn't designed to be read by morons.  Things that were
13112 considered to be self-evident were not discussed.  So.  Here we are.
13113
13114 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
13115 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
13116 be shocked and dismayed by this, but I haven't got the energy.  It is to
13117 laugh.
13118
13119 Gnus provides a plethora of functions for washing articles while
13120 displaying them, but it might be nicer to do the filtering before
13121 storing the mail to disc.  For that purpose, we have three hooks and
13122 various functions that can be put in these hooks.
13123
13124 @table @code
13125 @item nnmail-prepare-incoming-hook
13126 @vindex nnmail-prepare-incoming-hook
13127 This hook is called before doing anything with the mail and is meant for
13128 grand, sweeping gestures.  It is called in a buffer that contains all
13129 the new, incoming mail.  Functions to be used include:
13130
13131 @table @code
13132 @item nnheader-ms-strip-cr
13133 @findex nnheader-ms-strip-cr
13134 Remove trailing carriage returns from each line.  This is default on
13135 Emacs running on MS machines.
13136
13137 @end table
13138
13139 @item nnmail-prepare-incoming-header-hook
13140 @vindex nnmail-prepare-incoming-header-hook
13141 This hook is called narrowed to each header.  It can be used when
13142 cleaning up the headers.  Functions that can be used include:
13143
13144 @table @code
13145 @item nnmail-remove-leading-whitespace
13146 @findex nnmail-remove-leading-whitespace
13147 Clear leading white space that ``helpful'' listservs have added to the
13148 headers to make them look nice.  Aaah.
13149
13150 @item nnmail-remove-list-identifiers
13151 @findex nnmail-remove-list-identifiers
13152 Some list servers add an identifier---for example, @samp{(idm)}---to the
13153 beginning of all @code{Subject} headers.  I'm sure that's nice for
13154 people who use stone age mail readers.  This function will remove
13155 strings that match the @code{nnmail-list-identifiers} regexp, which can
13156 also be a list of regexp.  @code{nnmail-list-identifiers} may not contain
13157 @code{\\(..\\)}.
13158
13159 For instance, if you want to remove the @samp{(idm)} and the
13160 @samp{nagnagnag} identifiers:
13161
13162 @lisp
13163 (setq nnmail-list-identifiers
13164       '("(idm)" "nagnagnag"))
13165 @end lisp
13166
13167 This can also be done non-destructively with
13168 @code{gnus-list-identifiers}, @xref{Article Hiding}.
13169
13170 @item nnmail-remove-tabs
13171 @findex nnmail-remove-tabs
13172 Translate all @samp{TAB} characters into @samp{SPACE} characters.
13173
13174 @item nnmail-fix-eudora-headers
13175 @findex nnmail-fix-eudora-headers
13176 @cindex Eudora
13177 Eudora produces broken @code{References} headers, but OK
13178 @code{In-Reply-To} headers.  This function will get rid of the
13179 @code{References} headers.
13180
13181 @end table
13182
13183 @item nnmail-prepare-incoming-message-hook
13184 @vindex nnmail-prepare-incoming-message-hook
13185 This hook is called narrowed to each message.  Functions to be used
13186 include:
13187
13188 @table @code
13189 @item article-de-quoted-unreadable
13190 @findex article-de-quoted-unreadable
13191 Decode Quoted Readable encoding.
13192
13193 @end table
13194 @end table
13195
13196
13197 @node Duplicates
13198 @subsection Duplicates
13199
13200 @vindex nnmail-treat-duplicates
13201 @vindex nnmail-message-id-cache-length
13202 @vindex nnmail-message-id-cache-file
13203 @cindex duplicate mails
13204 If you are a member of a couple of mailing lists, you will sometimes
13205 receive two copies of the same mail.  This can be quite annoying, so
13206 @code{nnmail} checks for and treats any duplicates it might find.  To do
13207 this, it keeps a cache of old @code{Message-ID}s---
13208 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
13209 default.  The approximate maximum number of @code{Message-ID}s stored
13210 there is controlled by the @code{nnmail-message-id-cache-length}
13211 variable, which is 1000 by default.  (So 1000 @code{Message-ID}s will be
13212 stored.) If all this sounds scary to you, you can set
13213 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
13214 default), and @code{nnmail} won't delete duplicate mails.  Instead it
13215 will insert a warning into the head of the mail saying that it thinks
13216 that this is a duplicate of a different message.
13217
13218 This variable can also be a function.  If that's the case, the function
13219 will be called from a buffer narrowed to the message in question with
13220 the @code{Message-ID} as a parameter.  The function must return either
13221 @code{nil}, @code{warn}, or @code{delete}.
13222
13223 You can turn this feature off completely by setting the variable to
13224 @code{nil}.
13225
13226 If you want all the duplicate mails to be put into a special
13227 @dfn{duplicates} group, you could do that using the normal mail split
13228 methods:
13229
13230 @lisp
13231 (setq nnmail-split-fancy
13232       '(| ;; Messages duplicates go to a separate group.
13233           ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
13234           ;; Message from daemons, postmaster, and the like to another.
13235           (any mail "mail.misc")
13236           ;; Other rules.
13237           [ ... ] ))
13238 @end lisp
13239
13240 Or something like:
13241 @lisp
13242 (setq nnmail-split-methods
13243       '(("duplicates" "^Gnus-Warning:.*duplicate")
13244         ;; Other rules.
13245         [...]))
13246 @end lisp
13247
13248 Here's a neat feature: If you know that the recipient reads her mail
13249 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
13250 @code{delete}, you can send her as many insults as you like, just by
13251 using a @code{Message-ID} of a mail that you know that she's already
13252 received.  Think of all the fun!  She'll never see any of it!  Whee!
13253
13254
13255 @node Not Reading Mail
13256 @subsection Not Reading Mail
13257
13258 If you start using any of the mail back ends, they have the annoying
13259 habit of assuming that you want to read mail with them.  This might not
13260 be unreasonable, but it might not be what you want.
13261
13262 If you set @code{mail-sources} and @code{nnmail-spool-file} to
13263 @code{nil}, none of the back ends will ever attempt to read incoming
13264 mail, which should help.
13265
13266 @vindex nnbabyl-get-new-mail
13267 @vindex nnmbox-get-new-mail
13268 @vindex nnml-get-new-mail
13269 @vindex nnmh-get-new-mail
13270 @vindex nnfolder-get-new-mail
13271 This might be too much, if, for instance, you are reading mail quite
13272 happily with @code{nnml} and just want to peek at some old @sc{rmail}
13273 file you have stashed away with @code{nnbabyl}.  All back ends have
13274 variables called back-end-@code{get-new-mail}.  If you want to disable
13275 the @code{nnbabyl} mail reading, you edit the virtual server for the
13276 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
13277
13278 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
13279 narrowed to the article to be saved before saving it when reading
13280 incoming mail.
13281
13282
13283 @node Choosing a Mail Back End
13284 @subsection Choosing a Mail Back End
13285
13286 Gnus will read the mail spool when you activate a mail group.  The mail
13287 file is first copied to your home directory.  What happens after that
13288 depends on what format you want to store your mail in.
13289
13290 There are five different mail back ends in the standard Gnus, and more
13291 back ends are available separately.  The mail back end most people use
13292 (because it is the fastest and most flexible) is @code{nnml}
13293 (@pxref{Mail Spool}).
13294
13295 @menu
13296 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
13297 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
13298 * Mail Spool::                  Store your mail in a private spool?
13299 * MH Spool::                    An mhspool-like back end.
13300 * Mail Folders::                Having one file for each group.
13301 * Comparing Mail Back Ends::    An in-depth looks at pros and cons.
13302 @end menu
13303
13304
13305 @node Unix Mail Box
13306 @subsubsection Unix Mail Box
13307 @cindex nnmbox
13308 @cindex unix mail box
13309
13310 @vindex nnmbox-active-file
13311 @vindex nnmbox-mbox-file
13312 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
13313 mail.  @code{nnmbox} will add extra headers to each mail article to say
13314 which group it belongs in.
13315
13316 Virtual server settings:
13317
13318 @table @code
13319 @item nnmbox-mbox-file
13320 @vindex nnmbox-mbox-file
13321 The name of the mail box in the user's home directory.  Default is
13322 @file{~/mbox}.
13323
13324 @item nnmbox-active-file
13325 @vindex nnmbox-active-file
13326 The name of the active file for the mail box.  Default is
13327 @file{~/.mbox-active}.
13328
13329 @item nnmbox-get-new-mail
13330 @vindex nnmbox-get-new-mail
13331 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
13332 into groups.  Default is @code{t}.
13333 @end table
13334
13335
13336 @node Rmail Babyl
13337 @subsubsection Rmail Babyl
13338 @cindex nnbabyl
13339 @cindex rmail mbox
13340
13341 @vindex nnbabyl-active-file
13342 @vindex nnbabyl-mbox-file
13343 The @dfn{nnbabyl} back end will use a babyl mail box (aka. @dfn{rmail
13344 mbox}) to store mail.  @code{nnbabyl} will add extra headers to each
13345 mail article to say which group it belongs in.
13346
13347 Virtual server settings:
13348
13349 @table @code
13350 @item nnbabyl-mbox-file
13351 @vindex nnbabyl-mbox-file
13352 The name of the rmail mbox file.  The default is @file{~/RMAIL}
13353
13354 @item nnbabyl-active-file
13355 @vindex nnbabyl-active-file
13356 The name of the active file for the rmail box.  The default is
13357 @file{~/.rmail-active}
13358
13359 @item nnbabyl-get-new-mail
13360 @vindex nnbabyl-get-new-mail
13361 If non-@code{nil}, @code{nnbabyl} will read incoming mail.  Default is
13362 @code{t}
13363 @end table
13364
13365
13366 @node Mail Spool
13367 @subsubsection Mail Spool
13368 @cindex nnml
13369 @cindex mail @sc{nov} spool
13370
13371 The @dfn{nnml} spool mail format isn't compatible with any other known
13372 format.  It should be used with some caution.
13373
13374 @vindex nnml-directory
13375 If you use this back end, Gnus will split all incoming mail into files,
13376 one file for each mail, and put the articles into the corresponding
13377 directories under the directory specified by the @code{nnml-directory}
13378 variable.  The default value is @file{~/Mail/}.
13379
13380 You do not have to create any directories beforehand; Gnus will take
13381 care of all that.
13382
13383 If you have a strict limit as to how many files you are allowed to store
13384 in your account, you should not use this back end.  As each mail gets its
13385 own file, you might very well occupy thousands of inodes within a few
13386 weeks.  If this is no problem for you, and it isn't a problem for you
13387 having your friendly systems administrator walking around, madly,
13388 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
13389 know that this is probably the fastest format to use.  You do not have
13390 to trudge through a big mbox file just to read your new mail.
13391
13392 @code{nnml} is probably the slowest back end when it comes to article
13393 splitting.  It has to create lots of files, and it also generates
13394 @sc{nov} databases for the incoming mails.  This makes it the fastest
13395 back end when it comes to reading mail.
13396
13397 @cindex self contained nnml servers
13398 When the marks file is used (which it is by default), @code{nnml}
13399 servers have the property that you may backup them using @code{tar} or
13400 similar, and later be able to restore them into Gnus (by adding the
13401 proper @code{nnml} server) and have all your marks be preserved.  Marks
13402 for a group is usually stored in the @code{.marks} file (but see
13403 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
13404 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
13405 to restore the group (after restoring the backup into the nnml
13406 directory).
13407
13408 Virtual server settings:
13409
13410 @table @code
13411 @item nnml-directory
13412 @vindex nnml-directory
13413 All @code{nnml} directories will be placed under this directory.
13414 The default is the value of `message-directory' (whose default value is
13415 @file{~/Mail}).
13416
13417 @item nnml-active-file
13418 @vindex nnml-active-file
13419 The active file for the @code{nnml} server.  The default is
13420 @file{~/Mail/active"}.
13421
13422 @item nnml-newsgroups-file
13423 @vindex nnml-newsgroups-file
13424 The @code{nnml} group descriptions file.  @xref{Newsgroups File
13425 Format}.  The default is @file{~/Mail/newsgroups"}.
13426
13427 @item nnml-get-new-mail
13428 @vindex nnml-get-new-mail
13429 If non-@code{nil}, @code{nnml} will read incoming mail.  The default is
13430 @code{t}.
13431
13432 @item nnml-nov-is-evil
13433 @vindex nnml-nov-is-evil
13434 If non-@code{nil}, this back end will ignore any @sc{nov} files.  The
13435 default is @code{nil}.
13436
13437 @item nnml-nov-file-name
13438 @vindex nnml-nov-file-name
13439 The name of the @sc{nov} files.  The default is @file{.overview}.
13440
13441 @item nnml-prepare-save-mail-hook
13442 @vindex nnml-prepare-save-mail-hook
13443 Hook run narrowed to an article before saving.
13444
13445 @item nnml-marks-is-evil
13446 @vindex nnml-marks-is-evil
13447 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
13448 default is @code{nil}.
13449
13450 @item nnml-marks-file-name
13451 @vindex nnml-marks-file-name
13452 The name of the @sc{marks} files.  The default is @file{.marks}.
13453
13454 @end table
13455
13456 @findex nnml-generate-nov-databases
13457 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
13458 you can do a complete update by typing @kbd{M-x
13459 nnml-generate-nov-databases}.  This command will trawl through the
13460 entire @code{nnml} hierarchy, looking at each and every article, so it
13461 might take a while to complete.  A better interface to this
13462 functionality can be found in the server buffer (@pxref{Server
13463 Commands}).
13464
13465
13466 @node MH Spool
13467 @subsubsection MH Spool
13468 @cindex nnmh
13469 @cindex mh-e mail spool
13470
13471 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
13472 @sc{nov} databases and it doesn't keep an active file or marks file.
13473 This makes @code{nnmh} a @emph{much} slower back end than @code{nnml},
13474 but it also makes it easier to write procmail scripts for.
13475
13476 Virtual server settings:
13477
13478 @table @code
13479 @item nnmh-directory
13480 @vindex nnmh-directory
13481 All @code{nnmh} directories will be located under this directory.  The
13482 default is the value of @code{message-directory} (whose default is
13483 @file{~/Mail})
13484
13485 @item nnmh-get-new-mail
13486 @vindex nnmh-get-new-mail
13487 If non-@code{nil}, @code{nnmh} will read incoming mail.  The default is
13488 @code{t}.
13489
13490 @item nnmh-be-safe
13491 @vindex nnmh-be-safe
13492 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
13493 sure that the articles in the folder are actually what Gnus thinks they
13494 are.  It will check date stamps and stat everything in sight, so
13495 setting this to @code{t} will mean a serious slow-down.  If you never
13496 use anything but Gnus to read the @code{nnmh} articles, you do not have
13497 to set this variable to @code{t}.  The default is @code{nil}.
13498 @end table
13499
13500
13501 @node Mail Folders
13502 @subsubsection Mail Folders
13503 @cindex nnfolder
13504 @cindex mbox folders
13505 @cindex mail folders
13506
13507 @code{nnfolder} is a back end for storing each mail group in a separate
13508 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
13509 will add extra headers to keep track of article numbers and arrival
13510 dates.
13511
13512 @cindex self contained nnfolder servers
13513 When the marks file is used (which it is by default), @code{nnfolder}
13514 servers have the property that you may backup them using @code{tar} or
13515 similar, and later be able to restore them into Gnus (by adding the
13516 proper @code{nnfolder} server) and have all your marks be preserved.
13517 Marks for a group is usually stored in a file named as the mbox file
13518 with @code{.mrk} concatenated to it (but see
13519 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder} directory.
13520 Individual @code{nnfolder} groups are also possible to backup, use
13521 @kbd{G m} to restore the group (after restoring the backup into the
13522 @code{nnfolder} directory).
13523
13524 Virtual server settings:
13525
13526 @table @code
13527 @item nnfolder-directory
13528 @vindex nnfolder-directory
13529 All the @code{nnfolder} mail boxes will be stored under this directory.
13530 The default is the value of @code{message-directory} (whose default is
13531 @file{~/Mail})
13532
13533 @item nnfolder-active-file
13534 @vindex nnfolder-active-file
13535 The name of the active file.  The default is @file{~/Mail/active}.
13536
13537 @item nnfolder-newsgroups-file
13538 @vindex nnfolder-newsgroups-file
13539 The name of the group descriptions file.  @xref{Newsgroups File
13540 Format}.  The default is @file{~/Mail/newsgroups"}
13541
13542 @item nnfolder-get-new-mail
13543 @vindex nnfolder-get-new-mail
13544 If non-@code{nil}, @code{nnfolder} will read incoming mail.  The default
13545 is @code{t}
13546
13547 @item nnfolder-save-buffer-hook
13548 @vindex nnfolder-save-buffer-hook
13549 @cindex backup files
13550 Hook run before saving the folders.  Note that Emacs does the normal
13551 backup renaming of files even with the @code{nnfolder} buffers.  If you
13552 wish to switch this off, you could say something like the following in
13553 your @file{.emacs} file:
13554
13555 @lisp
13556 (defun turn-off-backup ()
13557   (set (make-local-variable 'backup-inhibited) t))
13558
13559 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
13560 @end lisp
13561
13562 @item nnfolder-delete-mail-hook
13563 @vindex nnfolder-delete-mail-hook
13564 Hook run in a buffer narrowed to the message that is to be deleted.
13565 This function can be used to copy the message to somewhere else, or to
13566 extract some information from it before removing it.
13567
13568 @item nnfolder-nov-is-evil
13569 @vindex nnfolder-nov-is-evil
13570 If non-@code{nil}, this back end will ignore any @sc{nov} files.  The
13571 default is @code{nil}.
13572
13573 @item nnfolder-nov-file-suffix
13574 @vindex nnfolder-nov-file-suffix
13575 The extension for @sc{nov} files.  The default is @file{.nov}.
13576
13577 @item nnfolder-nov-directory
13578 @vindex nnfolder-nov-directory
13579 The directory where the @sc{nov} files should be stored.  If nil,
13580 @code{nnfolder-directory} is used.
13581
13582 @item nnfolder-marks-is-evil
13583 @vindex nnfolder-marks-is-evil
13584 If non-@code{nil}, this back end will ignore any @sc{marks} files.  The
13585 default is @code{nil}.
13586
13587 @item nnfolder-marks-file-suffix
13588 @vindex nnfolder-marks-file-suffix
13589 The extension for @sc{marks} files.  The default is @file{.mrk}.
13590
13591 @item nnfolder-marks-directory
13592 @vindex nnfolder-marks-directory
13593 The directory where the @sc{marks} files should be stored.  If nil,
13594 @code{nnfolder-directory} is used.
13595
13596 @end table
13597
13598
13599 @findex nnfolder-generate-active-file
13600 @kindex M-x nnfolder-generate-active-file
13601 If you have lots of @code{nnfolder}-like files you'd like to read with
13602 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
13603 command to make @code{nnfolder} aware of all likely files in
13604 @code{nnfolder-directory}.  This only works if you use long file names,
13605 though.
13606
13607 @node Comparing Mail Back Ends
13608 @subsubsection Comparing Mail Back Ends
13609
13610 First, just for terminology, the @dfn{back end} is the common word for a
13611 low-level access method---a transport, if you will, by which something
13612 is acquired.  The sense is that one's mail has to come from somewhere,
13613 and so selection of a suitable back end is required in order to get that
13614 mail within spitting distance of Gnus.
13615
13616 The same concept exists for Usenet itself: Though access to articles is
13617 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
13618 in the world got at Usenet by running a reader on the machine where the
13619 articles lay (the machine which today we call an @sc{nntp} server), and
13620 access was by the reader stepping into the articles' directory spool
13621 area directly.  One can still select between either the @code{nntp} or
13622 @code{nnspool} back ends, to select between these methods, if one happens
13623 actually to live on the server (or can see its spool directly, anyway,
13624 via NFS).
13625
13626 The goal in selecting a mail back end is to pick one which
13627 simultaneously represents a suitable way of dealing with the original
13628 format plus leaving mail in a form that is convenient to use in the
13629 future.  Here are some high and low points on each:
13630
13631 @table @code
13632 @item nnmbox
13633
13634 UNIX systems have historically had a single, very common, and well-
13635 defined format.  All messages arrive in a single @dfn{spool file}, and
13636 they are delineated by a line whose regular expression matches
13637 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
13638 to make it clear in this instance that this is not the RFC-specified
13639 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
13640 historically from the Unix environment, it is simplest if one does not
13641 mess a great deal with the original mailbox format, so if one chooses
13642 this back end, Gnus' primary activity in getting mail from the real spool
13643 area to Gnus' preferred directory is simply to copy it, with no
13644 (appreciable) format change in the process.  It is the ``dumbest'' way
13645 to move mail into availability in the Gnus environment.  This makes it
13646 fast to move into place, but slow to parse, when Gnus has to look at
13647 what's where.
13648
13649 @item nnbabyl
13650
13651 Once upon a time, there was the DEC-10 and DEC-20, running operating
13652 systems called TOPS and related things, and the usual (only?) mail
13653 reading environment was a thing called Babyl.  I don't know what format
13654 was used for mail landing on the system, but Babyl had its own internal
13655 format to which mail was converted, primarily involving creating a
13656 spool-file-like entity with a scheme for inserting Babyl-specific
13657 headers and status bits above the top of each message in the file.
13658 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
13659 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
13660 to understand the mail files folks already had in existence.  Gnus (and
13661 VM, for that matter) continue to support this format because it's
13662 perceived as having some good qualities in those mailer-specific
13663 headers/status bits stuff.  RMAIL itself still exists as well, of
13664 course, and is still maintained by Stallman.
13665
13666 Both of the above forms leave your mail in a single file on your
13667 filesystem, and they must parse that entire file each time you take a
13668 look at your mail.
13669
13670 @item nnml
13671
13672 @code{nnml} is the back end which smells the most as though you were
13673 actually operating with an @code{nnspool}-accessed Usenet system.  (In
13674 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
13675 lo these years ago.)  One's mail is taken from the original spool file,
13676 and is then cut up into individual message files, 1:1.  It maintains a
13677 Usenet-style active file (analogous to what one finds in an INN- or
13678 CNews-based news system in (for instance) @file{/var/lib/news/active},
13679 or what is returned via the @samp{NNTP LIST} verb) and also creates
13680 @dfn{overview} files for efficient group entry, as has been defined for
13681 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
13682 due to the creation of lots of files, updates to the @code{nnml} active
13683 file, and additions to overview files on a per-message basis, but it is
13684 extremely fast on access because of what amounts to the indexing support
13685 provided by the active file and overviews.
13686
13687 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
13688 resource which defines available places in the filesystem to put new
13689 files.  Sysadmins take a dim view of heavy inode occupation within
13690 tight, shared filesystems.  But if you live on a personal machine where
13691 the filesystem is your own and space is not at a premium, @code{nnml}
13692 wins big.
13693
13694 It is also problematic using this back end if you are living in a
13695 FAT16-based Windows world, since much space will be wasted on all these
13696 tiny files.
13697
13698 @item nnmh
13699
13700 The Rand MH mail-reading system has been around UNIX systems for a very
13701 long time; it operates by splitting one's spool file of messages into
13702 individual files, but with little or no indexing support -- @code{nnmh}
13703 is considered to be semantically equivalent to ``@code{nnml} without
13704 active file or overviews''.  This is arguably the worst choice, because
13705 one gets the slowness of individual file creation married to the
13706 slowness of access parsing when learning what's new in one's groups.
13707
13708 @item nnfolder
13709
13710 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
13711 method described above) on a per-group basis.  That is, @code{nnmbox}
13712 itself puts *all* one's mail in one file; @code{nnfolder} provides a
13713 little bit of optimization to this so that each of one's mail groups has
13714 a Unix mail box file.  It's faster than @code{nnmbox} because each group
13715 can be parsed separately, and still provides the simple Unix mail box
13716 format requiring minimal effort in moving the mail around.  In addition,
13717 it maintains an ``active'' file making it much faster for Gnus to figure
13718 out how many messages there are in each separate group.
13719
13720 If you have groups that are expected to have a massive amount of
13721 messages, @code{nnfolder} is not the best choice, but if you receive
13722 only a moderate amount of mail, @code{nnfolder} is probably the most
13723 friendly mail back end all over.
13724
13725 @end table
13726
13727
13728 @node Browsing the Web
13729 @section Browsing the Web
13730 @cindex web
13731 @cindex browsing the web
13732 @cindex www
13733 @cindex http
13734
13735 Web-based discussion forums are getting more and more popular.  On many
13736 subjects, the web-based forums have become the most important forums,
13737 eclipsing the importance of mailing lists and news groups.  The reason
13738 is easy to understand---they are friendly to new users; you just point
13739 and click, and there's the discussion.  With mailing lists, you have to
13740 go through a cumbersome subscription procedure, and most people don't
13741 even know what a news group is.
13742
13743 The problem with this scenario is that web browsers are not very good at
13744 being newsreaders.  They do not keep track of what articles you've read;
13745 they do not allow you to score on subjects you're interested in; they do
13746 not allow off-line browsing; they require you to click around and drive
13747 you mad in the end.
13748
13749 So---if web browsers suck at reading discussion forums, why not use Gnus
13750 to do it instead?
13751
13752 Gnus has been getting a bit of a collection of back ends for providing
13753 interfaces to these sources.
13754
13755 @menu
13756 * Web Searches::                Creating groups from articles that match a string.
13757 * Slashdot::                    Reading the Slashdot comments.
13758 * Ultimate::                    The Ultimate Bulletin Board systems.
13759 * Web Archive::                 Reading mailing list archived on web.
13760 * RSS::                         Reading RDF site summary.
13761 * Customizing w3::              Doing stuff to Emacs/w3 from Gnus.
13762 @end menu
13763
13764 All the web sources require Emacs/w3 and the url library to work.
13765
13766 The main caveat with all these web sources is that they probably won't
13767 work for a very long time.  Gleaning information from the @sc{html} data
13768 is guesswork at best, and when the layout is altered, the Gnus back end
13769 will fail.  If you have reasonably new versions of these back ends,
13770 though, you should be ok.
13771
13772 One thing all these Web methods have in common is that the Web sources
13773 are often down, unavailable or just plain too slow to be fun.  In those
13774 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
13775 Unplugged}) handle downloading articles, and then you can read them at
13776 leisure from your local disk.  No more World Wide Wait for you.
13777
13778 @node Archiving Mail
13779 @subsection Archiving Mail
13780 @cindex archiving mail
13781 @cindex backup of mail
13782
13783 Some of the back ends, notably nnml and nnfolder, now actually store
13784 the article marks with each group.  For these servers, archiving and
13785 restoring a group while preserving marks is fairly simple.
13786
13787 (Preserving the group level and group parameters as well still
13788 requires ritual dancing and sacrifices to the @code{.newsrc.eld} deity
13789 though.)
13790
13791 To archive an entire @code{nnml} or @code{nnfolder} server, take a
13792 recursive copy of the server directory.  There is no need to shut down
13793 Gnus, so archiving may be invoked by @code{cron} or similar.  You
13794 restore the data by restoring the directory tree, and adding a server
13795 definition pointing to that directory in Gnus. The @ref{Article
13796 Backlog}, @ref{Asynchronous Fetching} and other things might interfer
13797 with overwriting data, so you may want to shut down Gnus before you
13798 restore the data.
13799
13800 It is also possible to archive individual @code{nnml} or
13801 @code{nnfolder} groups, while preserving marks.  For @code{nnml}, you
13802 copy all files in the group's directory.  For @code{nnfolder} you need
13803 to copy both the base folder file itself (@code{FOO}, say), and the
13804 marks file (@code{FOO.mrk} in this example).  Restoring the group is
13805 done with @kbd{G m} from the Group buffer.  The last step makes Gnus
13806 notice the new directory.
13807
13808 @node Web Searches
13809 @subsection Web Searches
13810 @cindex nnweb
13811 @cindex DejaNews
13812 @cindex Alta Vista
13813 @cindex InReference
13814 @cindex Usenet searches
13815 @cindex searching the Usenet
13816
13817 It's, like, too neat to search the Usenet for articles that match a
13818 string, but it, like, totally @emph{sucks}, like, totally, to use one of
13819 those, like, Web browsers, and you, like, have to, rilly, like, look at
13820 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
13821 searches without having to use a browser.
13822
13823 The @code{nnweb} back end allows an easy interface to the mighty search
13824 engine.  You create an @code{nnweb} group, enter a search pattern, and
13825 then enter the group and read the articles like you would any normal
13826 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
13827 Groups}) will do this in an easy-to-use fashion.
13828
13829 @code{nnweb} groups don't really lend themselves to being solid
13830 groups---they have a very fleeting idea of article numbers.  In fact,
13831 each time you enter an @code{nnweb} group (not even changing the search
13832 pattern), you are likely to get the articles ordered in a different
13833 manner.  Not even using duplicate suppression (@pxref{Duplicate
13834 Suppression}) will help, since @code{nnweb} doesn't even know the
13835 @code{Message-ID} of the articles before reading them using some search
13836 engines (DejaNews, for instance).  The only possible way to keep track
13837 of which articles you've read is by scoring on the @code{Date}
13838 header---mark all articles posted before the last date you read the
13839 group as read.
13840
13841 If the search engine changes its output substantially, @code{nnweb}
13842 won't be able to parse it and will fail.  One could hardly fault the Web
13843 providers if they were to do this---their @emph{raison d'être} is to
13844 make money off of advertisements, not to provide services to the
13845 community.  Since @code{nnweb} washes the ads off all the articles, one
13846 might think that the providers might be somewhat miffed.  We'll see.
13847
13848 You must have the @code{url} and @code{w3} package installed to be able
13849 to use @code{nnweb}.
13850
13851 Virtual server variables:
13852
13853 @table @code
13854 @item nnweb-type
13855 @vindex nnweb-type
13856 What search engine type is being used.  The currently supported types
13857 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
13858 @code{reference}.
13859
13860 @item nnweb-search
13861 @vindex nnweb-search
13862 The search string to feed to the search engine.
13863
13864 @item nnweb-max-hits
13865 @vindex nnweb-max-hits
13866 Advisory maximum number of hits per search to display.  The default is
13867 100.
13868
13869 @item nnweb-type-definition
13870 @vindex nnweb-type-definition
13871 Type-to-definition alist.  This alist says what @code{nnweb} should do
13872 with the various search engine types.  The following elements must be
13873 present:
13874
13875 @table @code
13876 @item article
13877 Function to decode the article and provide something that Gnus
13878 understands.
13879
13880 @item map
13881 Function to create an article number to message header and URL alist.
13882
13883 @item search
13884 Function to send the search string to the search engine.
13885
13886 @item address
13887 The address the aforementioned function should send the search string
13888 to.
13889
13890 @item id
13891 Format string URL to fetch an article by @code{Message-ID}.
13892 @end table
13893
13894 @end table
13895
13896
13897 @node Slashdot
13898 @subsection Slashdot
13899 @cindex Slashdot
13900 @cindex nnslashdot
13901
13902 Slashdot (@uref{http://slashdot.org/}) is a popular news site, with
13903 lively discussion following the news articles.  @code{nnslashdot} will
13904 let you read this forum in a convenient manner.
13905
13906 The easiest way to read this source is to put something like the
13907 following in your @file{.gnus.el} file:
13908
13909 @lisp
13910 (setq gnus-secondary-select-methods
13911       '((nnslashdot "")))
13912 @end lisp
13913
13914 This will make Gnus query the @code{nnslashdot} back end for new comments
13915 and groups.  The @kbd{F} command will subscribe each new news article as
13916 a new Gnus group, and you can read the comments by entering these
13917 groups.  (Note that the default subscription method is to subscribe new
13918 groups as zombies.  Other methods are available (@pxref{Subscription
13919 Methods}).
13920
13921 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
13922 command is the most handy tool (@pxref{Foreign Groups}).
13923
13924 When following up to @code{nnslashdot} comments (or posting new
13925 comments), some light @sc{html}izations will be performed.  In
13926 particular, text quoted with @samp{> } will be quoted with
13927 @code{blockquote} instead, and signatures will have @code{br} added to
13928 the end of each line.  Other than that, you can just write @sc{html}
13929 directly into the message buffer.  Note that Slashdot filters out some
13930 @sc{html} forms.
13931
13932 The following variables can be altered to change its behavior:
13933
13934 @table @code
13935 @item nnslashdot-threaded
13936 Whether @code{nnslashdot} should display threaded groups or not.  The
13937 default is @code{t}.  To be able to display threads, @code{nnslashdot}
13938 has to retrieve absolutely all comments in a group upon entry.  If a
13939 threaded display is not required, @code{nnslashdot} will only retrieve
13940 the comments that are actually wanted by the user.  Threading is nicer,
13941 but much, much slower than untreaded.
13942
13943 @item nnslashdot-login-name
13944 @vindex nnslashdot-login-name
13945 The login name to use when posting.
13946
13947 @item nnslashdot-password
13948 @vindex nnslashdot-password
13949 The password to use when posting.
13950
13951 @item nnslashdot-directory
13952 @vindex nnslashdot-directory
13953 Where @code{nnslashdot} will store its files.  The default is
13954 @samp{~/News/slashdot/}.
13955
13956 @item nnslashdot-active-url
13957 @vindex nnslashdot-active-url
13958 The @sc{url} format string that will be used to fetch the information on
13959 news articles and comments.  The default is
13960 @samp{http://slashdot.org/search.pl?section=&min=%d}.
13961
13962 @item nnslashdot-comments-url
13963 @vindex nnslashdot-comments-url
13964 The @sc{url} format string that will be used to fetch comments.  The
13965 default is
13966 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
13967
13968 @item nnslashdot-article-url
13969 @vindex nnslashdot-article-url
13970 The @sc{url} format string that will be used to fetch the news article.  The
13971 default is
13972 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
13973
13974 @item nnslashdot-threshold
13975 @vindex nnslashdot-threshold
13976 The score threshold.  The default is -1.
13977
13978 @item nnslashdot-group-number
13979 @vindex nnslashdot-group-number
13980 The number of old groups, in addition to the ten latest, to keep
13981 updated.  The default is 0.
13982
13983 @end table
13984
13985
13986
13987 @node Ultimate
13988 @subsection Ultimate
13989 @cindex nnultimate
13990 @cindex Ultimate Bulletin Board
13991
13992 The Ultimate Bulletin Board (@uref{http://www.ultimatebb.com/}) is
13993 probably the most popular Web bulletin board system used.  It has a
13994 quite regular and nice interface, and it's possible to get the
13995 information Gnus needs to keep groups updated.
13996
13997 The easiest way to get started with @code{nnultimate} is to say
13998 something like the following in the group buffer:  @kbd{B nnultimate RET
13999 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @sc{url}
14000 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
14001 you're interested in; there's quite a list of them on the Ultimate web
14002 site.)  Then subscribe to the groups you're interested in from the
14003 server buffer, and read them from the group buffer.
14004
14005 The following @code{nnultimate} variables can be altered:
14006
14007 @table @code
14008 @item nnultimate-directory
14009 @vindex nnultimate-directory
14010 The directory where @code{nnultimate} stores its files.  The default is
14011 @samp{~/News/ultimate/}.
14012 @end table
14013
14014
14015 @node Web Archive
14016 @subsection Web Archive
14017 @cindex nnwarchive
14018 @cindex Web Archive
14019
14020 Some mailing lists only have archives on Web servers, such as
14021 @uref{http://www.egroups.com/} and
14022 @uref{http://www.mail-archive.com/}.  It has a quite regular and nice
14023 interface, and it's possible to get the information Gnus needs to keep
14024 groups updated.
14025
14026 The easiest way to get started with @code{nnwarchive} is to say
14027 something like the following in the group buffer: @kbd{M-x
14028 gnus-group-make-warchive-group RET an_egroup RET egroups RET
14029 www.egroups.com RET your@@email.address RET}.  (Substitute the
14030 @sc{an_egroup} with the mailing list you subscribed, the
14031 @sc{your@@email.address} with your email address.), or to browse the
14032 back end by @kbd{B nnwarchive RET mail-archive RET}.
14033
14034 The following @code{nnwarchive} variables can be altered:
14035
14036 @table @code
14037 @item nnwarchive-directory
14038 @vindex nnwarchive-directory
14039 The directory where @code{nnwarchive} stores its files.  The default is
14040 @samp{~/News/warchive/}.
14041
14042 @item nnwarchive-login
14043 @vindex nnwarchive-login
14044 The account name on the web server.
14045
14046 @item nnwarchive-passwd
14047 @vindex nnwarchive-passwd
14048 The password for your account on the web server.
14049 @end table
14050
14051 @node RSS
14052 @subsection RSS
14053 @cindex nnrss
14054 @cindex RSS
14055
14056 Some sites have RDF site summary (RSS)
14057 @uref{http://purl.org/rss/1.0/spec}.  It has a quite regular and nice
14058 interface, and it's possible to get the information Gnus needs to keep
14059 groups updated.
14060
14061 The easiest way to get started with @code{nnrss} is to say something
14062 like the following in the group buffer: @kbd{B nnrss RET RET}, then
14063 subscribe groups.
14064
14065 The following @code{nnrss} variables can be altered:
14066
14067 @table @code
14068 @item nnrss-directory
14069 @vindex nnrss-directory
14070 The directory where @code{nnrss} stores its files.  The default is
14071 @samp{~/News/rss/}.
14072
14073 @end table
14074
14075 The following code may be helpful, if you want to show the description in
14076 the summary buffer.
14077
14078 @lisp
14079 (add-to-list 'nnmail-extra-headers nnrss-description-field)
14080 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
14081
14082 (defun gnus-user-format-function-X (header)
14083   (let ((descr
14084          (assq nnrss-description-field (mail-header-extra header))))
14085     (if descr (concat "\n\t" (cdr descr)) "")))
14086 @end lisp
14087
14088 The following code may be useful to open an nnrss url directly from the
14089 summary buffer.
14090 @lisp
14091 (require 'browse-url)
14092
14093 (defun browse-nnrss-url( arg )
14094   (interactive "p")
14095   (let ((url (assq nnrss-url-field
14096                    (mail-header-extra
14097                     (gnus-data-header
14098                      (assq (gnus-summary-article-number)
14099                            gnus-newsgroup-data))))))
14100     (if url
14101         (browse-url (cdr url))
14102       (gnus-summary-scroll-up arg))))
14103
14104 (eval-after-load "gnus"
14105   #'(define-key gnus-summary-mode-map
14106       (kbd "<RET>") 'browse-nnrss-url))
14107 (add-to-list 'nnmail-extra-headers nnrss-url-field)
14108 @end lisp
14109
14110 @node Customizing w3
14111 @subsection Customizing w3
14112 @cindex w3
14113 @cindex html
14114 @cindex url
14115 @cindex Netscape
14116
14117 Gnus uses the url library to fetch web pages and Emacs/w3 to display web
14118 pages.  Emacs/w3 is documented in its own manual, but there are some
14119 things that may be more relevant for Gnus users.
14120
14121 For instance, a common question is how to make Emacs/w3 follow links
14122 using the @code{browse-url} functions (which will call some external web
14123 browser like Netscape).  Here's one way:
14124
14125 @lisp
14126 (eval-after-load "w3"
14127   '(progn
14128     (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
14129     (defun w3-fetch (&optional url target)
14130       (interactive (list (w3-read-url-with-default)))
14131       (if (eq major-mode 'gnus-article-mode)
14132           (browse-url url)
14133         (w3-fetch-orig url target)))))
14134 @end lisp
14135
14136 Put that in your @file{.emacs} file, and hitting links in w3-rendered
14137 @sc{html} in the Gnus article buffers will use @code{browse-url} to
14138 follow the link.
14139
14140 @node IMAP
14141 @section @sc{imap}
14142 @cindex nnimap
14143 @cindex @sc{imap}
14144
14145 @sc{imap} is a network protocol for reading mail (or news, or ...),
14146 think of it as a modernized @sc{nntp}.  Connecting to a @sc{imap}
14147 server is much similar to connecting to a news server, you just
14148 specify the network address of the server.
14149
14150 @sc{imap} has two properties.  First, @sc{imap} can do everything that
14151 POP can, it can hence be viewed as POP++.  Secondly, @sc{imap} is a
14152 mail storage protocol, similar to @sc{nntp} being a news storage
14153 protocol.  (@sc{imap} offers more features than @sc{nntp} because news
14154 is more or less read-only whereas mail is read-write.)
14155
14156 If you want to use @sc{imap} as POP++, use an imap entry in
14157 mail-sources.  With this, Gnus will fetch mails from the @sc{imap}
14158 server and store them on the local disk.  This is not the usage
14159 described in this section.  @xref{Mail Sources}.
14160
14161 If you want to use @sc{imap} as a mail storage protocol, use an nnimap
14162 entry in gnus-secondary-select-methods.  With this, Gnus will
14163 manipulate mails stored on the @sc{imap} server.  This is the kind of
14164 usage explained in this section.
14165
14166 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
14167 might look something like this:
14168
14169 @lisp
14170 (setq gnus-secondary-select-methods
14171       '((nnimap "simpleserver") ; no special configuration
14172         ; perhaps a ssh port forwarded server:
14173         (nnimap "dolk"
14174                 (nnimap-address "localhost")
14175                 (nnimap-server-port 1430))
14176         ; a UW server running on localhost
14177         (nnimap "barbar"
14178                 (nnimap-server-port 143)
14179                 (nnimap-address "localhost")
14180                 (nnimap-list-pattern ("INBOX" "mail/*")))
14181         ; anonymous public cyrus server:
14182         (nnimap "cyrus.andrew.cmu.edu"
14183                 (nnimap-authenticator anonymous)
14184                 (nnimap-list-pattern "archive.*")
14185                 (nnimap-stream network))
14186         ; a ssl server on a non-standard port:
14187         (nnimap "vic20"
14188                 (nnimap-address "vic20.somewhere.com")
14189                 (nnimap-server-port 9930)
14190                 (nnimap-stream ssl))))
14191 @end lisp
14192
14193 (Note that for SSL/TLS to work, you need the external library
14194 @samp{ssl.el}, see below.)
14195
14196 The following variables can be used to create a virtual @code{nnimap}
14197 server:
14198
14199 @table @code
14200
14201 @item nnimap-address
14202 @vindex nnimap-address
14203
14204 The address of the remote @sc{imap} server.  Defaults to the virtual
14205 server name if not specified.
14206
14207 @item nnimap-server-port
14208 @vindex nnimap-server-port
14209 Port on server to contact.  Defaults to port 143, or 993 for SSL.
14210
14211 Note that this should be an integer, example server specification:
14212
14213 @lisp
14214 (nnimap "mail.server.com"
14215         (nnimap-server-port 4711))
14216 @end lisp
14217
14218 @item nnimap-list-pattern
14219 @vindex nnimap-list-pattern
14220 String or list of strings of mailboxes to limit available groups to.
14221 This is used when the server has very many mailboxes and you're only
14222 interested in a few -- some servers export your home directory via
14223 @sc{imap}, you'll probably want to limit the mailboxes to those in
14224 @file{~/Mail/*} then.
14225
14226 The string can also be a cons of REFERENCE and the string as above, what
14227 REFERENCE is used for is server specific, but on the University of
14228 Washington server it's a directory that will be concatenated with the
14229 mailbox.
14230
14231 Example server specification:
14232
14233 @lisp
14234 (nnimap "mail.server.com"
14235         (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
14236                                ("~friend/Mail/" . "list/*"))))
14237 @end lisp
14238
14239 @item nnimap-stream
14240 @vindex nnimap-stream
14241 The type of stream used to connect to your server.  By default, nnimap
14242 will detect and automatically use all of the below, with the exception
14243 of SSL/TLS. (IMAP over SSL/TLS is being replaced by STARTTLS, which
14244 can be automatically detected, but it's not widely deployed yet.)
14245
14246 Example server specification:
14247
14248 @lisp
14249 (nnimap "mail.server.com"
14250         (nnimap-stream ssl))
14251 @end lisp
14252
14253 Please note that the value of @code{nnimap-stream} is a symbol!
14254
14255 @itemize @bullet
14256 @item
14257 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Requires the
14258 @samp{imtest} program.
14259 @item
14260 @dfn{kerberos4:} Connect with kerberos 4. Requires the @samp{imtest} program.
14261 @item
14262 @dfn{starttls:} Connect via the STARTTLS extension (similar to
14263 SSL). Requires the external library @samp{starttls.el} and program
14264 @samp{starttls}.
14265 @item
14266 @dfn{ssl:} Connect through SSL. Requires OpenSSL (the program
14267 @samp{openssl}) or SSLeay (@samp{s_client}) as well as the external
14268 library @samp{ssl.el}.
14269 @item
14270 @dfn{shell:} Use a shell command to start @sc{imap} connection.
14271 @item
14272 @dfn{network:} Plain, TCP/IP network connection.
14273 @end itemize
14274
14275 @vindex imap-kerberos4-program
14276 The @samp{imtest} program is shipped with Cyrus IMAPD.  If you're
14277 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
14278 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
14279 to make @code{imap.el} use a pty instead of a pipe when communicating
14280 with @samp{imtest}.  You will then suffer from a line length
14281 restrictions on IMAP commands, which might make Gnus seem to hang
14282 indefinitely if you have many articles in a mailbox.  The variable
14283 @code{imap-kerberos4-program} contain parameters to pass to the imtest
14284 program.
14285
14286 @vindex imap-ssl-program
14287 For SSL connections, the OpenSSL program is available from
14288 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
14289 and nnimap support it too - altough the most recent versions of
14290 SSLeay, 0.9.x, are known to have serious bugs making it
14291 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
14292 work. The variable @code{imap-ssl-program} contain parameters to pass
14293 to OpenSSL/SSLeay.  You also need @samp{ssl.el} (from the W3
14294 distribution, for instance).
14295
14296 @vindex imap-shell-program
14297 @vindex imap-shell-host
14298 For @sc{imap} connections using the @code{shell} stream, the variable
14299 @code{imap-shell-program} specify what program to call.
14300
14301 @item nnimap-authenticator
14302 @vindex nnimap-authenticator
14303
14304 The authenticator used to connect to the server.  By default, nnimap
14305 will use the most secure authenticator your server is capable of.
14306
14307 Example server specification:
14308
14309 @lisp
14310 (nnimap "mail.server.com"
14311         (nnimap-authenticator anonymous))
14312 @end lisp
14313
14314 Please note that the value of @code{nnimap-authenticator} is a symbol!
14315
14316 @itemize @bullet
14317 @item
14318 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
14319 external program @code{imtest}.
14320 @item
14321 @dfn{kerberos4:} Kerberos authentication. Require external program
14322 @code{imtest}.
14323 @item
14324 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
14325 external library @code{digest-md5.el}.
14326 @item
14327 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
14328 @item
14329 @dfn{login:} Plain-text username/password via LOGIN.
14330 @item
14331 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
14332 @end itemize
14333
14334 @item nnimap-expunge-on-close
14335 @cindex Expunging
14336 @vindex nnimap-expunge-on-close
14337 Unlike Parmenides the @sc{imap} designers has decided that things that
14338 doesn't exist actually does exist.  More specifically, @sc{imap} has
14339 this concept of marking articles @code{Deleted} which doesn't actually
14340 delete them, and this (marking them @code{Deleted}, that is) is what
14341 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
14342 similar).
14343
14344 Since the articles aren't really removed when we mark them with the
14345 @code{Deleted} flag we'll need a way to actually delete them.  Feel like
14346 running in circles yet?
14347
14348 Traditionally, nnimap has removed all articles marked as @code{Deleted}
14349 when closing a mailbox but this is now configurable by this server
14350 variable.
14351
14352 The possible options are:
14353
14354 @table @code
14355
14356 @item always
14357 The default behavior, delete all articles marked as "Deleted" when
14358 closing a mailbox.
14359 @item never
14360 Never actually delete articles.  Currently there is no way of showing
14361 the articles marked for deletion in nnimap, but other @sc{imap} clients
14362 may allow you to do this.  If you ever want to run the EXPUNGE command
14363 manually, @xref{Expunging mailboxes}.
14364 @item ask
14365 When closing mailboxes, nnimap will ask if you wish to expunge deleted
14366 articles or not.
14367
14368 @end table
14369
14370 @item nnimap-importantize-dormant
14371 @vindex nnimap-importantize-dormant
14372
14373 If non-nil, marks dormant articles as ticked (as well), for other IMAP
14374 clients. Within Gnus, dormant articles will naturally still (only) be
14375 marked as ticked.  This is to make dormant articles stand out, just
14376 like ticked articles, in other IMAP clients. (In other words, Gnus has
14377 two ``Tick'' marks and IMAP has only one.)
14378
14379 Probably the only reason for frobing this would be if you're trying
14380 enable per-user persistant dormant flags, using something like:
14381
14382 @lisp
14383 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
14384         (format "gnus-dormant-%s" (user-login-name)))
14385 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
14386         (format "KEYWORD gnus-dormant-%s" (user-login-name)))
14387 @end lisp
14388
14389 In this case, you would not want the per-user dormant flag showing up
14390 as ticked for other users.
14391
14392 @item nnimap-expunge-search-string
14393 @cindex Expunging
14394 @vindex nnimap-expunge-search-string
14395
14396 This variable contain the IMAP search command sent to server when
14397 searching for articles eligible for expiring.  The default is
14398 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
14399 UID set and the second @code{%s} is replaced by a date.
14400
14401 Probably the only useful value to change this to is
14402 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
14403 messages instead of the internal article date. See section 6.4.4 of
14404 RFC 2060 for more information on valid strings.
14405
14406 @item nnimap-authinfo-file
14407 @vindex nnimap-authinfo-file
14408
14409 A file containing credentials used to log in on servers.  The format is
14410 (almost) the same as the @code{ftp} @file{~/.netrc} file.  See the
14411 variable @code{nntp-authinfo-file} for exact syntax; also see
14412 @ref{NNTP}.
14413
14414 @end table
14415
14416 @menu
14417 * Splitting in IMAP::           Splitting mail with nnimap.
14418 * Editing IMAP ACLs::           Limiting/enabling other users access to a mailbox.
14419 * Expunging mailboxes::         Equivalent of a "compress mailbox" button.
14420 @end menu
14421
14422
14423
14424 @node Splitting in IMAP
14425 @subsection Splitting in @sc{imap}
14426 @cindex splitting imap mail
14427
14428 Splitting is something Gnus users has loved and used for years, and now
14429 the rest of the world is catching up.  Yeah, dream on, not many
14430 @sc{imap} server has server side splitting and those that have splitting
14431 seem to use some non-standard protocol.  This means that @sc{imap}
14432 support for Gnus has to do it's own splitting.
14433
14434 And it does.
14435
14436 Here are the variables of interest:
14437
14438 @table @code
14439
14440 @item nnimap-split-crosspost
14441 @cindex splitting, crosspost
14442 @cindex crosspost
14443 @vindex nnimap-split-crosspost
14444
14445 If non-nil, do crossposting if several split methods match the mail.  If
14446 nil, the first match in @code{nnimap-split-rule} found will be used.
14447
14448 Nnmail equivalent: @code{nnmail-crosspost}.
14449
14450 @item nnimap-split-inbox
14451 @cindex splitting, inbox
14452 @cindex inbox
14453 @vindex nnimap-split-inbox
14454
14455 A string or a list of strings that gives the name(s) of @sc{imap}
14456 mailboxes to split from.  Defaults to nil, which means that splitting is
14457 disabled!
14458
14459 @lisp
14460 (setq nnimap-split-inbox
14461       '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14462 @end lisp
14463
14464 No nnmail equivalent.
14465
14466 @item nnimap-split-rule
14467 @cindex Splitting, rules
14468 @vindex nnimap-split-rule
14469
14470 New mail found in @code{nnimap-split-inbox} will be split according to
14471 this variable.
14472
14473 This variable contains a list of lists, where the first element in the
14474 sublist gives the name of the @sc{imap} mailbox to move articles
14475 matching the regexp in the second element in the sublist.  Got that?
14476 Neither did I, we need examples.
14477
14478 @lisp
14479 (setq nnimap-split-rule
14480       '(("INBOX.nnimap"
14481          "^Sender: owner-nnimap@@vic20.globalcom.se")
14482         ("INBOX.junk"    "^Subject:.*MAKE MONEY")
14483         ("INBOX.private" "")))
14484 @end lisp
14485
14486 This will put all articles from the nnimap mailing list into mailbox
14487 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14488 into INBOX.junk and everything else in INBOX.private.
14489
14490 The first string may contain `\\1' forms, like the ones used by
14491 replace-match to insert sub-expressions from the matched text.  For
14492 instance:
14493
14494 @lisp
14495 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
14496 @end lisp
14497
14498 The second element can also be a function.  In that case, it will be
14499 called with the first element of the rule as the argument, in a buffer
14500 containing the headers of the article.  It should return a non-nil value
14501 if it thinks that the mail belongs in that group.
14502
14503 Nnmail users might recollect that the last regexp had to be empty to
14504 match all articles (like in the example above).  This is not required in
14505 nnimap.  Articles not matching any of the regexps will not be moved out
14506 of your inbox.  (This might affect performance if you keep lots of
14507 unread articles in your inbox, since the splitting code would go over
14508 them every time you fetch new mail.)
14509
14510 These rules are processed from the beginning of the alist toward the
14511 end.  The first rule to make a match will "win", unless you have
14512 crossposting enabled.  In that case, all matching rules will "win".
14513
14514 This variable can also have a function as its value, the function will
14515 be called with the headers narrowed and should return a group where it
14516 thinks the article should be split to.  See @code{nnimap-split-fancy}.
14517
14518 The splitting code tries to create mailboxes if it needs to.
14519
14520 To allow for different split rules on different virtual servers, and
14521 even different split rules in different inboxes on the same server,
14522 the syntax of this variable have been extended along the lines of:
14523
14524 @lisp
14525 (setq nnimap-split-rule
14526       '(("my1server"    (".*"    (("ding"    "ding@@gnus.org")
14527                                   ("junk"    "From:.*Simon")))
14528         ("my2server"    ("INBOX" nnimap-split-fancy))
14529         ("my[34]server" (".*"    (("private" "To:.*Simon")
14530                                   ("junk"    my-junk-func)))))
14531 @end lisp
14532
14533 The virtual server name is in fact a regexp, so that the same rules
14534 may apply to several servers.  In the example, the servers
14535 @code{my3server} and @code{my4server} both use the same rules.
14536 Similarly, the inbox string is also a regexp.  The actual splitting
14537 rules are as before, either a function, or a list with group/regexp or
14538 group/function elements.
14539
14540 Nnmail equivalent: @code{nnmail-split-methods}.
14541
14542 @item nnimap-split-predicate
14543 @cindex splitting
14544 @vindex nnimap-split-predicate
14545
14546 Mail matching this predicate in @code{nnimap-split-inbox} will be
14547 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
14548
14549 This might be useful if you use another @sc{imap} client to read mail in
14550 your inbox but would like Gnus to split all articles in the inbox
14551 regardless of readedness. Then you might change this to
14552 @samp{UNDELETED}.
14553
14554 @item nnimap-split-fancy
14555 @cindex splitting, fancy
14556 @findex nnimap-split-fancy
14557 @vindex nnimap-split-fancy
14558
14559 It's possible to set @code{nnimap-split-rule} to
14560 @code{nnmail-split-fancy} if you want to use fancy
14561 splitting. @xref{Fancy Mail Splitting}.
14562
14563 However, to be able to have different fancy split rules for nnmail and
14564 nnimap back ends you can set @code{nnimap-split-rule} to
14565 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14566 rule in @code{nnimap-split-fancy}.
14567
14568 Example:
14569
14570 @lisp
14571 (setq nnimap-split-rule 'nnimap-split-fancy
14572       nnimap-split-fancy ...)
14573 @end lisp
14574
14575 Nnmail equivalent: @code{nnmail-split-fancy}.
14576
14577 @end table
14578
14579 @node Editing IMAP ACLs
14580 @subsection Editing @sc{imap} ACLs
14581 @cindex editing imap acls
14582 @cindex Access Control Lists
14583 @cindex Editing @sc{imap} ACLs
14584 @kindex G l
14585 @findex gnus-group-nnimap-edit-acl
14586
14587 ACL stands for Access Control List.  ACLs are used in @sc{imap} for
14588 limiting (or enabling) other users access to your mail boxes.  Not all
14589 @sc{imap} servers support this, this function will give an error if it
14590 doesn't.
14591
14592 To edit a ACL for a mailbox, type @kbd{G l}
14593 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14594 editing window with detailed instructions.
14595
14596 Some possible uses:
14597
14598 @itemize @bullet
14599 @item
14600 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14601 on your mailing list mailboxes enables other users on the same server to
14602 follow the list without subscribing to it.
14603 @item
14604 At least with the Cyrus server, you are required to give the user
14605 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14606 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14607 INBOX.mailbox).
14608 @end itemize
14609
14610 @node Expunging mailboxes
14611 @subsection Expunging mailboxes
14612 @cindex expunging
14613
14614 @cindex Expunge
14615 @cindex Manual expunging
14616 @kindex G x
14617 @findex gnus-group-nnimap-expunge
14618
14619 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
14620 you may want the option of expunging all deleted articles in a mailbox
14621 manually.  This is exactly what @kbd{G x} does.
14622
14623 Currently there is no way of showing deleted articles, you can just
14624 delete them.
14625
14626
14627
14628 @node Other Sources
14629 @section Other Sources
14630
14631 Gnus can do more than just read news or mail.  The methods described
14632 below allow Gnus to view directories and files as if they were
14633 newsgroups.
14634
14635 @menu
14636 * Directory Groups::            You can read a directory as if it was a newsgroup.
14637 * Anything Groups::             Dired?  Who needs dired?
14638 * Document Groups::             Single files can be the basis of a group.
14639 * SOUP::                        Reading @sc{soup} packets ``offline''.
14640 * Mail-To-News Gateways::       Posting articles via mail-to-news gateways.
14641 @end menu
14642
14643
14644 @node Directory Groups
14645 @subsection Directory Groups
14646 @cindex nndir
14647 @cindex directory groups
14648
14649 If you have a directory that has lots of articles in separate files in
14650 it, you might treat it as a newsgroup.  The files have to have numerical
14651 names, of course.
14652
14653 This might be an opportune moment to mention @code{ange-ftp} (and its
14654 successor @code{efs}), that most wonderful of all wonderful Emacs
14655 packages.  When I wrote @code{nndir}, I didn't think much about it---a
14656 back end to read directories.  Big deal.
14657
14658 @code{ange-ftp} changes that picture dramatically.  For instance, if you
14659 enter the @code{ange-ftp} file name
14660 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
14661 @code{ange-ftp} or @code{efs} will actually allow you to read this
14662 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
14663
14664 @code{nndir} will use @sc{nov} files if they are present.
14665
14666 @code{nndir} is a ``read-only'' back end---you can't delete or expire
14667 articles with this method.  You can use @code{nnmh} or @code{nnml} for
14668 whatever you use @code{nndir} for, so you could switch to any of those
14669 methods if you feel the need to have a non-read-only @code{nndir}.
14670
14671
14672 @node Anything Groups
14673 @subsection Anything Groups
14674 @cindex nneething
14675
14676 From the @code{nndir} back end (which reads a single spool-like
14677 directory), it's just a hop and a skip to @code{nneething}, which
14678 pretends that any arbitrary directory is a newsgroup.  Strange, but
14679 true.
14680
14681 When @code{nneething} is presented with a directory, it will scan this
14682 directory and assign article numbers to each file.  When you enter such
14683 a group, @code{nneething} must create ``headers'' that Gnus can use.
14684 After all, Gnus is a newsreader, in case you're forgetting.
14685 @code{nneething} does this in a two-step process.  First, it snoops each
14686 file in question.  If the file looks like an article (i.e., the first
14687 few lines look like headers), it will use this as the head.  If this is
14688 just some arbitrary file without a head (e.g. a C source file),
14689 @code{nneething} will cobble up a header out of thin air.  It will use
14690 file ownership, name and date and do whatever it can with these
14691 elements.
14692
14693 All this should happen automatically for you, and you will be presented
14694 with something that looks very much like a newsgroup.  Totally like a
14695 newsgroup, to be precise.  If you select an article, it will be displayed
14696 in the article buffer, just as usual.
14697
14698 If you select a line that represents a directory, Gnus will pop you into
14699 a new summary buffer for this @code{nneething} group.  And so on.  You can
14700 traverse the entire disk this way, if you feel like, but remember that
14701 Gnus is not dired, really, and does not intend to be, either.
14702
14703 There are two overall modes to this action---ephemeral or solid.  When
14704 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
14705 will not store information on what files you have read, and what files
14706 are new, and so on.  If you create a solid @code{nneething} group the
14707 normal way with @kbd{G m}, Gnus will store a mapping table between
14708 article numbers and file names, and you can treat this group like any
14709 other groups.  When you activate a solid @code{nneething} group, you will
14710 be told how many unread articles it contains, etc., etc.
14711
14712 Some variables:
14713
14714 @table @code
14715 @item nneething-map-file-directory
14716 @vindex nneething-map-file-directory
14717 All the mapping files for solid @code{nneething} groups will be stored
14718 in this directory, which defaults to @file{~/.nneething/}.
14719
14720 @item nneething-exclude-files
14721 @vindex nneething-exclude-files
14722 All files that match this regexp will be ignored.  Nice to use to exclude
14723 auto-save files and the like, which is what it does by default.
14724
14725 @item nneething-include-files
14726 @vindex nneething-include-files
14727 Regexp saying what files to include in the group.  If this variable is
14728 non-@code{nil}, only files matching this regexp will be included.
14729
14730 @item nneething-map-file
14731 @vindex nneething-map-file
14732 Name of the map files.
14733 @end table
14734
14735
14736 @node Document Groups
14737 @subsection Document Groups
14738 @cindex nndoc
14739 @cindex documentation group
14740 @cindex help group
14741
14742 @code{nndoc} is a cute little thing that will let you read a single file
14743 as a newsgroup.  Several files types are supported:
14744
14745 @table @code
14746 @cindex babyl
14747 @cindex rmail mbox
14748
14749 @item babyl
14750 The babyl (rmail) mail box.
14751 @cindex mbox
14752 @cindex Unix mbox
14753
14754 @item mbox
14755 The standard Unix mbox file.
14756
14757 @cindex MMDF mail box
14758 @item mmdf
14759 The MMDF mail box format.
14760
14761 @item news
14762 Several news articles appended into a file.
14763
14764 @item rnews
14765 @cindex rnews batch files
14766 The rnews batch transport format.
14767 @cindex forwarded messages
14768
14769 @item forward
14770 Forwarded articles.
14771
14772 @item nsmail
14773 Netscape mail boxes.
14774
14775 @item mime-parts
14776 MIME multipart messages.
14777
14778 @item standard-digest
14779 The standard (RFC 1153) digest format.
14780
14781 @item slack-digest
14782 Non-standard digest format---matches most things, but does it badly.
14783 @end table
14784
14785 You can also use the special ``file type'' @code{guess}, which means
14786 that @code{nndoc} will try to guess what file type it is looking at.
14787 @code{digest} means that @code{nndoc} should guess what digest type the
14788 file is.
14789
14790 @code{nndoc} will not try to change the file or insert any extra headers into
14791 it---it will simply, like, let you use the file as the basis for a
14792 group.  And that's it.
14793
14794 If you have some old archived articles that you want to insert into your
14795 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
14796 that.  Say you have an old @file{RMAIL} file with mail that you now want
14797 to split into your new @code{nnml} groups.  You look at that file using
14798 @code{nndoc} (using the @kbd{G f} command in the group buffer
14799 (@pxref{Foreign Groups})), set the process mark on all the articles in
14800 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
14801 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
14802 file is now also stored in lots of @code{nnml} directories, and you can
14803 delete that pesky @file{RMAIL} file.  If you have the guts!
14804
14805 Virtual server variables:
14806
14807 @table @code
14808 @item nndoc-article-type
14809 @vindex nndoc-article-type
14810 This should be one of @code{mbox}, @code{babyl}, @code{digest},
14811 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
14812 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
14813 @code{slack-digest}, @code{clari-briefs}, @code{nsmail},
14814 @code{outlook}, @code{oe-dbx}, and @code{mailman} or @code{guess}.
14815
14816 @item nndoc-post-type
14817 @vindex nndoc-post-type
14818 This variable says whether Gnus is to consider the group a news group or
14819 a mail group.  There are two valid values:  @code{mail} (the default)
14820 and @code{news}.
14821 @end table
14822
14823 @menu
14824 * Document Server Internals::   How to add your own document types.
14825 @end menu
14826
14827
14828 @node Document Server Internals
14829 @subsubsection Document Server Internals
14830
14831 Adding new document types to be recognized by @code{nndoc} isn't
14832 difficult.  You just have to whip up a definition of what the document
14833 looks like, write a predicate function to recognize that document type,
14834 and then hook into @code{nndoc}.
14835
14836 First, here's an example document type definition:
14837
14838 @example
14839 (mmdf
14840  (article-begin .  "^\^A\^A\^A\^A\n")
14841  (body-end .  "^\^A\^A\^A\^A\n"))
14842 @end example
14843
14844 The definition is simply a unique @dfn{name} followed by a series of
14845 regexp pseudo-variable settings.  Below are the possible
14846 variables---don't be daunted by the number of variables; most document
14847 types can be defined with very few settings:
14848
14849 @table @code
14850 @item first-article
14851 If present, @code{nndoc} will skip past all text until it finds
14852 something that match this regexp.  All text before this will be
14853 totally ignored.
14854
14855 @item article-begin
14856 This setting has to be present in all document type definitions.  It
14857 says what the beginning of each article looks like.
14858
14859 @item head-begin-function
14860 If present, this should be a function that moves point to the head of
14861 the article.
14862
14863 @item nndoc-head-begin
14864 If present, this should be a regexp that matches the head of the
14865 article.
14866
14867 @item nndoc-head-end
14868 This should match the end of the head of the article.  It defaults to
14869 @samp{^$}---the empty line.
14870
14871 @item body-begin-function
14872 If present, this function should move point to the beginning of the body
14873 of the article.
14874
14875 @item body-begin
14876 This should match the beginning of the body of the article.  It defaults
14877 to @samp{^\n}.
14878
14879 @item body-end-function
14880 If present, this function should move point to the end of the body of
14881 the article.
14882
14883 @item body-end
14884 If present, this should match the end of the body of the article.
14885
14886 @item file-end
14887 If present, this should match the end of the file.  All text after this
14888 regexp will be totally ignored.
14889
14890 @end table
14891
14892 So, using these variables @code{nndoc} is able to dissect a document
14893 file into a series of articles, each with a head and a body.  However, a
14894 few more variables are needed since not all document types are all that
14895 news-like---variables needed to transform the head or the body into
14896 something that's palatable for Gnus:
14897
14898 @table @code
14899 @item prepare-body-function
14900 If present, this function will be called when requesting an article.  It
14901 will be called with point at the start of the body, and is useful if the
14902 document has encoded some parts of its contents.
14903
14904 @item article-transform-function
14905 If present, this function is called when requesting an article.  It's
14906 meant to be used for more wide-ranging transformation of both head and
14907 body of the article.
14908
14909 @item generate-head-function
14910 If present, this function is called to generate a head that Gnus can
14911 understand.  It is called with the article number as a parameter, and is
14912 expected to generate a nice head for the article in question.  It is
14913 called when requesting the headers of all articles.
14914
14915 @end table
14916
14917 Let's look at the most complicated example I can come up with---standard
14918 digests:
14919
14920 @example
14921 (standard-digest
14922  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
14923  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
14924  (prepare-body-function . nndoc-unquote-dashes)
14925  (body-end-function . nndoc-digest-body-end)
14926  (head-end . "^ ?$")
14927  (body-begin . "^ ?\n")
14928  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
14929  (subtype digest guess))
14930 @end example
14931
14932 We see that all text before a 70-width line of dashes is ignored; all
14933 text after a line that starts with that @samp{^End of} is also ignored;
14934 each article begins with a 30-width line of dashes; the line separating
14935 the head from the body may contain a single space; and that the body is
14936 run through @code{nndoc-unquote-dashes} before being delivered.
14937
14938 To hook your own document definition into @code{nndoc}, use the
14939 @code{nndoc-add-type} function.  It takes two parameters---the first is
14940 the definition itself and the second (optional) parameter says where in
14941 the document type definition alist to put this definition.  The alist is
14942 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}.  So @code{nndoc-mmdf-type-p} is called to see whether a document
14943 is of @code{mmdf} type, and so on.  These type predicates should return
14944 @code{nil} if the document is not of the correct type; @code{t} if it is
14945 of the correct type; and a number if the document might be of the
14946 correct type.  A high number means high probability; a low number means
14947 low probability with @samp{0} being the lowest valid number.
14948
14949
14950 @node SOUP
14951 @subsection SOUP
14952 @cindex SOUP
14953 @cindex offline
14954
14955 In the PC world people often talk about ``offline'' newsreaders.  These
14956 are thingies that are combined reader/news transport monstrosities.
14957 With built-in modem programs.  Yecchh!
14958
14959 Of course, us Unix Weenie types of human beans use things like
14960 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
14961 transport things like Ghod intended.  And then we just use normal
14962 newsreaders.
14963
14964 However, it can sometimes be convenient to do something that's a bit
14965 easier on the brain if you have a very slow modem, and you're not really
14966 that interested in doing things properly.
14967
14968 A file format called @sc{soup} has been developed for transporting news
14969 and mail from servers to home machines and back again.  It can be a bit
14970 fiddly.
14971
14972 First some terminology:
14973
14974 @table @dfn
14975
14976 @item server
14977 This is the machine that is connected to the outside world and where you
14978 get news and/or mail from.
14979
14980 @item home machine
14981 This is the machine that you want to do the actual reading and responding
14982 on.  It is typically not connected to the rest of the world in any way.
14983
14984 @item packet
14985 Something that contains messages and/or commands.  There are two kinds
14986 of packets:
14987
14988 @table @dfn
14989 @item message packets
14990 These are packets made at the server, and typically contain lots of
14991 messages for you to read.  These are called @file{SoupoutX.tgz} by
14992 default, where @var{x} is a number.
14993
14994 @item response packets
14995 These are packets made at the home machine, and typically contains
14996 replies that you've written.  These are called @file{SoupinX.tgz} by
14997 default, where @var{x} is a number.
14998
14999 @end table
15000
15001 @end table
15002
15003
15004 @enumerate
15005
15006 @item
15007 You log in on the server and create a @sc{soup} packet.  You can either
15008 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
15009 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
15010 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
15011
15012 @item
15013 You transfer the packet home.  Rail, boat, car or modem will do fine.
15014
15015 @item
15016 You put the packet in your home directory.
15017
15018 @item
15019 You fire up Gnus on your home machine using the @code{nnsoup} back end as
15020 the native or secondary server.
15021
15022 @item
15023 You read articles and mail and answer and followup to the things you
15024 want (@pxref{SOUP Replies}).
15025
15026 @item
15027 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
15028 packet.
15029
15030 @item
15031 You transfer this packet to the server.
15032
15033 @item
15034 You use Gnus to mail this packet out with the @kbd{G s s} command.
15035
15036 @item
15037 You then repeat until you die.
15038
15039 @end enumerate
15040
15041 So you basically have a bipartite system---you use @code{nnsoup} for
15042 reading and Gnus for packing/sending these @sc{soup} packets.
15043
15044 @menu
15045 * SOUP Commands::               Commands for creating and sending @sc{soup} packets
15046 * SOUP Groups::                 A back end for reading @sc{soup} packets.
15047 * SOUP Replies::                How to enable @code{nnsoup} to take over mail and news.
15048 @end menu
15049
15050
15051 @node SOUP Commands
15052 @subsubsection SOUP Commands
15053
15054 These are commands for creating and manipulating @sc{soup} packets.
15055
15056 @table @kbd
15057 @item G s b
15058 @kindex G s b (Group)
15059 @findex gnus-group-brew-soup
15060 Pack all unread articles in the current group
15061 (@code{gnus-group-brew-soup}).  This command understands the
15062 process/prefix convention.
15063
15064 @item G s w
15065 @kindex G s w (Group)
15066 @findex gnus-soup-save-areas
15067 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
15068
15069 @item G s s
15070 @kindex G s s (Group)
15071 @findex gnus-soup-send-replies
15072 Send all replies from the replies packet
15073 (@code{gnus-soup-send-replies}).
15074
15075 @item G s p
15076 @kindex G s p (Group)
15077 @findex gnus-soup-pack-packet
15078 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
15079
15080 @item G s r
15081 @kindex G s r (Group)
15082 @findex nnsoup-pack-replies
15083 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
15084
15085 @item O s
15086 @kindex O s (Summary)
15087 @findex gnus-soup-add-article
15088 This summary-mode command adds the current article to a @sc{soup} packet
15089 (@code{gnus-soup-add-article}).  It understands the process/prefix
15090 convention (@pxref{Process/Prefix}).
15091
15092 @end table
15093
15094
15095 There are a few variables to customize where Gnus will put all these
15096 thingies:
15097
15098 @table @code
15099
15100 @item gnus-soup-directory
15101 @vindex gnus-soup-directory
15102 Directory where Gnus will save intermediate files while composing
15103 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
15104
15105 @item gnus-soup-replies-directory
15106 @vindex gnus-soup-replies-directory
15107 This is what Gnus will use as a temporary directory while sending our
15108 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
15109
15110 @item gnus-soup-prefix-file
15111 @vindex gnus-soup-prefix-file
15112 Name of the file where Gnus stores the last used prefix.  The default is
15113 @samp{gnus-prefix}.
15114
15115 @item gnus-soup-packer
15116 @vindex gnus-soup-packer
15117 A format string command for packing a @sc{soup} packet.  The default is
15118 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
15119
15120 @item gnus-soup-unpacker
15121 @vindex gnus-soup-unpacker
15122 Format string command for unpacking a @sc{soup} packet.  The default is
15123 @samp{gunzip -c %s | tar xvf -}.
15124
15125 @item gnus-soup-packet-directory
15126 @vindex gnus-soup-packet-directory
15127 Where Gnus will look for reply packets.  The default is @file{~/}.
15128
15129 @item gnus-soup-packet-regexp
15130 @vindex gnus-soup-packet-regexp
15131 Regular expression matching @sc{soup} reply packets in
15132 @code{gnus-soup-packet-directory}.
15133
15134 @end table
15135
15136
15137 @node SOUP Groups
15138 @subsubsection @sc{soup} Groups
15139 @cindex nnsoup
15140
15141 @code{nnsoup} is the back end for reading @sc{soup} packets.  It will
15142 read incoming packets, unpack them, and put them in a directory where
15143 you can read them at leisure.
15144
15145 These are the variables you can use to customize its behavior:
15146
15147 @table @code
15148
15149 @item nnsoup-tmp-directory
15150 @vindex nnsoup-tmp-directory
15151 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
15152 directory.  (@file{/tmp/} by default.)
15153
15154 @item nnsoup-directory
15155 @vindex nnsoup-directory
15156 @code{nnsoup} then moves each message and index file to this directory.
15157 The default is @file{~/SOUP/}.
15158
15159 @item nnsoup-replies-directory
15160 @vindex nnsoup-replies-directory
15161 All replies will be stored in this directory before being packed into a
15162 reply packet.  The default is @file{~/SOUP/replies/"}.
15163
15164 @item nnsoup-replies-format-type
15165 @vindex nnsoup-replies-format-type
15166 The @sc{soup} format of the replies packets.  The default is @samp{?n}
15167 (rnews), and I don't think you should touch that variable.  I probably
15168 shouldn't even have documented it.  Drats!  Too late!
15169
15170 @item nnsoup-replies-index-type
15171 @vindex nnsoup-replies-index-type
15172 The index type of the replies packet.  The default is @samp{?n}, which
15173 means ``none''.  Don't fiddle with this one either!
15174
15175 @item nnsoup-active-file
15176 @vindex nnsoup-active-file
15177 Where @code{nnsoup} stores lots of information.  This is not an ``active
15178 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
15179 this file or mess it up in any way, you're dead.  The default is
15180 @file{~/SOUP/active}.
15181
15182 @item nnsoup-packer
15183 @vindex nnsoup-packer
15184 Format string command for packing a reply @sc{soup} packet.  The default
15185 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
15186
15187 @item nnsoup-unpacker
15188 @vindex nnsoup-unpacker
15189 Format string command for unpacking incoming @sc{soup} packets.  The
15190 default is @samp{gunzip -c %s | tar xvf -}.
15191
15192 @item nnsoup-packet-directory
15193 @vindex nnsoup-packet-directory
15194 Where @code{nnsoup} will look for incoming packets.  The default is
15195 @file{~/}.
15196
15197 @item nnsoup-packet-regexp
15198 @vindex nnsoup-packet-regexp
15199 Regular expression matching incoming @sc{soup} packets.  The default is
15200 @samp{Soupout}.
15201
15202 @item nnsoup-always-save
15203 @vindex nnsoup-always-save
15204 If non-@code{nil}, save the replies buffer after each posted message.
15205
15206 @end table
15207
15208
15209 @node SOUP Replies
15210 @subsubsection SOUP Replies
15211
15212 Just using @code{nnsoup} won't mean that your postings and mailings end
15213 up in @sc{soup} reply packets automagically.  You have to work a bit
15214 more for that to happen.
15215
15216 @findex nnsoup-set-variables
15217 The @code{nnsoup-set-variables} command will set the appropriate
15218 variables to ensure that all your followups and replies end up in the
15219 @sc{soup} system.
15220
15221 In specific, this is what it does:
15222
15223 @lisp
15224 (setq message-send-news-function 'nnsoup-request-post)
15225 (setq message-send-mail-function 'nnsoup-request-mail)
15226 @end lisp
15227
15228 And that's it, really.  If you only want news to go into the @sc{soup}
15229 system you just use the first line.  If you only want mail to be
15230 @sc{soup}ed you use the second.
15231
15232
15233 @node Mail-To-News Gateways
15234 @subsection Mail-To-News Gateways
15235 @cindex mail-to-news gateways
15236 @cindex gateways
15237
15238 If your local @code{nntp} server doesn't allow posting, for some reason
15239 or other, you can post using one of the numerous mail-to-news gateways.
15240 The @code{nngateway} back end provides the interface.
15241
15242 Note that you can't read anything from this back end---it can only be
15243 used to post with.
15244
15245 Server variables:
15246
15247 @table @code
15248 @item nngateway-address
15249 @vindex nngateway-address
15250 This is the address of the mail-to-news gateway.
15251
15252 @item nngateway-header-transformation
15253 @vindex nngateway-header-transformation
15254 News headers often have to be transformed in some odd way or other
15255 for the mail-to-news gateway to accept it.  This variable says what
15256 transformation should be called, and defaults to
15257 @code{nngateway-simple-header-transformation}.  The function is called
15258 narrowed to the headers to be transformed and with one parameter---the
15259 gateway address.
15260
15261 This default function just inserts a new @code{To} header based on the
15262 @code{Newsgroups} header and the gateway address.
15263 For instance, an article with this @code{Newsgroups} header:
15264
15265 @example
15266 Newsgroups: alt.religion.emacs
15267 @end example
15268
15269 will get this @code{From} header inserted:
15270
15271 @example
15272 To: alt-religion-emacs@@GATEWAY
15273 @end example
15274
15275 The following pre-defined functions exist:
15276
15277 @findex nngateway-simple-header-transformation
15278 @table @code
15279
15280 @item nngateway-simple-header-transformation
15281 Creates a @code{To} header that looks like
15282 @var{newsgroup}@@@code{nngateway-address}.
15283
15284 @findex nngateway-mail2news-header-transformation
15285
15286 @item nngateway-mail2news-header-transformation
15287 Creates a @code{To} header that looks like
15288 @code{nngateway-address}.
15289
15290 Here's an example:
15291
15292 @lisp
15293 (setq gnus-post-method
15294       '(nngateway
15295         "mail2news@@replay.com"
15296         (nngateway-header-transformation
15297          nngateway-mail2news-header-transformation)))
15298 @end lisp
15299
15300 @end table
15301
15302
15303 @end table
15304
15305 So, to use this, simply say something like:
15306
15307 @lisp
15308 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
15309 @end lisp
15310
15311
15312
15313 @node Combined Groups
15314 @section Combined Groups
15315
15316 Gnus allows combining a mixture of all the other group types into bigger
15317 groups.
15318
15319 @menu
15320 * Virtual Groups::              Combining articles from many groups.
15321 * Kibozed Groups::              Looking through parts of the newsfeed for articles.
15322 @end menu
15323
15324
15325 @node Virtual Groups
15326 @subsection Virtual Groups
15327 @cindex nnvirtual
15328 @cindex virtual groups
15329 @cindex merging groups
15330
15331 An @dfn{nnvirtual group} is really nothing more than a collection of
15332 other groups.
15333
15334 For instance, if you are tired of reading many small groups, you can
15335 put them all in one big group, and then grow tired of reading one
15336 big, unwieldy group.  The joys of computing!
15337
15338 You specify @code{nnvirtual} as the method.  The address should be a
15339 regexp to match component groups.
15340
15341 All marks in the virtual group will stick to the articles in the
15342 component groups.  So if you tick an article in a virtual group, the
15343 article will also be ticked in the component group from whence it came.
15344 (And vice versa---marks from the component groups will also be shown in
15345 the virtual group.)
15346
15347 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
15348 newsgroups into one, big, happy newsgroup:
15349
15350 @lisp
15351 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
15352 @end lisp
15353
15354 The component groups can be native or foreign; everything should work
15355 smoothly, but if your computer explodes, it was probably my fault.
15356
15357 Collecting the same group from several servers might actually be a good
15358 idea if users have set the Distribution header to limit distribution.
15359 If you would like to read @samp{soc.motss} both from a server in Japan
15360 and a server in Norway, you could use the following as the group regexp:
15361
15362 @example
15363 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
15364 @end example
15365
15366 (Remember, though, that if you're creating the group with @kbd{G m}, you
15367 shouldn't double the backslashes, and you should leave off the quote
15368 characters at the beginning and the end of the string.)
15369
15370 This should work kinda smoothly---all articles from both groups should
15371 end up in this one, and there should be no duplicates.  Threading (and
15372 the rest) will still work as usual, but there might be problems with the
15373 sequence of articles.  Sorting on date might be an option here
15374 (@pxref{Selecting a Group}).
15375
15376 One limitation, however---all groups included in a virtual
15377 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
15378 zombie groups can't be component groups for @code{nnvirtual} groups.
15379
15380 @vindex nnvirtual-always-rescan
15381 If the @code{nnvirtual-always-rescan} is non-@code{nil},
15382 @code{nnvirtual} will always scan groups for unread articles when
15383 entering a virtual group.  If this variable is @code{nil} (which is the
15384 default) and you read articles in a component group after the virtual
15385 group has been activated, the read articles from the component group
15386 will show up when you enter the virtual group.  You'll also see this
15387 effect if you have two virtual groups that have a component group in
15388 common.  If that's the case, you should set this variable to @code{t}.
15389 Or you can just tap @code{M-g} on the virtual group every time before
15390 you enter it---it'll have much the same effect.
15391
15392 @code{nnvirtual} can have both mail and news groups as component groups.
15393 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
15394 has to ask the back end of the component group the article comes from
15395 whether it is a news or mail back end.  However, when you do a @kbd{^},
15396 there is typically no sure way for the component back end to know this,
15397 and in that case @code{nnvirtual} tells Gnus that the article came from a
15398 not-news back end.  (Just to be on the safe side.)
15399
15400 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
15401 line from the article you respond to in these cases.
15402
15403
15404
15405 @node Kibozed Groups
15406 @subsection Kibozed Groups
15407 @cindex nnkiboze
15408 @cindex kibozing
15409
15410 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
15411 the news feed''.  @code{nnkiboze} is a back end that will do this for
15412 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
15413 with useless requests!  Oh happiness!
15414
15415 @kindex G k (Group)
15416 To create a kibozed group, use the @kbd{G k} command in the group
15417 buffer.
15418
15419 The address field of the @code{nnkiboze} method is, as with
15420 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
15421 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
15422 and @code{nnvirtual} end.
15423
15424 In addition to this regexp detailing component groups, an @code{nnkiboze} group
15425 must have a score file to say what articles are to be included in
15426 the group (@pxref{Scoring}).
15427
15428 @kindex M-x nnkiboze-generate-groups
15429 @findex nnkiboze-generate-groups
15430 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
15431 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
15432 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
15433 all the articles in all the component groups and run them through the
15434 scoring process to determine if there are any articles in the groups
15435 that are to be part of the @code{nnkiboze} groups.
15436
15437 Please limit the number of component groups by using restrictive
15438 regexps.  Otherwise your sysadmin may become annoyed with you, and the
15439 @sc{nntp} site may throw you off and never let you back in again.
15440 Stranger things have happened.
15441
15442 @code{nnkiboze} component groups do not have to be alive---they can be dead,
15443 and they can be foreign.  No restrictions.
15444
15445 @vindex nnkiboze-directory
15446 The generation of an @code{nnkiboze} group means writing two files in
15447 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
15448 contains the @sc{nov} header lines for all the articles in the group,
15449 and the other is an additional @file{.newsrc} file to store information
15450 on what groups have been searched through to find component articles.
15451
15452 Articles marked as read in the @code{nnkiboze} group will have
15453 their @sc{nov} lines removed from the @sc{nov} file.
15454
15455
15456 @node Gnus Unplugged
15457 @section Gnus Unplugged
15458 @cindex offline
15459 @cindex unplugged
15460 @cindex Agent
15461 @cindex Gnus Agent
15462 @cindex Gnus Unplugged
15463
15464 In olden times (ca. February '88), people used to run their newsreaders
15465 on big machines with permanent connections to the net.  News transport
15466 was dealt with by news servers, and all the newsreaders had to do was to
15467 read news.  Believe it or not.
15468
15469 Nowadays most people read news and mail at home, and use some sort of
15470 modem to connect to the net.  To avoid running up huge phone bills, it
15471 would be nice to have a way to slurp down all the news and mail, hang up
15472 the phone, read for several hours, and then upload any responses you
15473 have to make.  And then you repeat the procedure.
15474
15475 Of course, you can use news servers for doing this as well.  I've used
15476 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
15477 for some years, but doing that's a bore.  Moving the news server
15478 functionality up to the newsreader makes sense if you're the only person
15479 reading news on a machine.
15480
15481 Using Gnus as an ``offline'' newsreader is quite simple.
15482
15483 @itemize @bullet
15484 @item
15485 First, set up Gnus as you would do if you were running it on a machine
15486 that has full connection to the net.  Go ahead.  I'll still be waiting
15487 here.
15488
15489 @item
15490 Then, put the following magical incantation at the end of your
15491 @file{.gnus.el} file:
15492
15493 @lisp
15494 (gnus-agentize)
15495 @end lisp
15496 @end itemize
15497
15498 That's it.  Gnus is now an ``offline'' newsreader.
15499
15500 Of course, to use it as such, you have to learn a few new commands.
15501
15502 @menu
15503 * Agent Basics::                How it all is supposed to work.
15504 * Agent Categories::            How to tell the Gnus Agent what to download.
15505 * Agent Commands::              New commands for all the buffers.
15506 * Agent Expiry::                How to make old articles go away.
15507 * Agent and IMAP::              How to use the Agent with IMAP.
15508 * Outgoing Messages::           What happens when you post/mail something?
15509 * Agent Variables::             Customizing is fun.
15510 * Example Setup::               An example @file{.gnus.el} file for offline people.
15511 * Batching Agents::             How to fetch news from a @code{cron} job.
15512 * Agent Caveats::               What you think it'll do and what it does.
15513 @end menu
15514
15515
15516 @node Agent Basics
15517 @subsection Agent Basics
15518
15519 First, let's get some terminology out of the way.
15520
15521 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
15522 connection to the net (and notified the Agent that this is the case).
15523 When the connection to the net is up again (and Gnus knows this), the
15524 Agent is @dfn{plugged}.
15525
15526 The @dfn{local} machine is the one you're running on, and which isn't
15527 connected to the net continuously.
15528
15529 @dfn{Downloading} means fetching things from the net to your local
15530 machine.  @dfn{Uploading} is doing the opposite.
15531
15532 Let's take a typical Gnus session using the Agent.
15533
15534 @itemize @bullet
15535
15536 @item
15537 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
15538 Agent in a disconnected state.  You can read all the news that you have
15539 already fetched while in this mode.
15540
15541 @item
15542 You then decide to see whether any new news has arrived.  You connect
15543 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
15544 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
15545 as usual.  To check for new mail in unplugged mode, see (@pxref{Mail
15546 Source Specifiers}).
15547
15548 @item
15549 You can then read the new news immediately, or you can download the news
15550 onto your local machine.  If you want to do the latter, you press @kbd{g}
15551 to check if there are any new news and then @kbd{J
15552 s} to fetch all the eligible articles in all the groups.  (To let Gnus
15553 know which articles you want to download, @pxref{Agent Categories}.)
15554
15555 @item
15556 After fetching the articles, you press @kbd{J j} to make Gnus become
15557 unplugged again, and you shut down the PPP thing (or whatever).  And
15558 then you read the news offline.
15559
15560 @item
15561 And then you go to step 2.
15562 @end itemize
15563
15564 Here are some things you should do the first time (or so) that you use
15565 the Agent.
15566
15567 @itemize @bullet
15568
15569 @item
15570 Decide which servers should be covered by the Agent.  If you have a mail
15571 back end, it would probably be nonsensical to have it covered by the
15572 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
15573 @kbd{J a} the server (or servers) that you wish to have covered by the
15574 Agent (@pxref{Server Agent Commands}).  This will typically be only the
15575 primary select method, which is listed on the bottom in the buffer.
15576
15577 @item
15578 Decide on download policy.  @xref{Agent Categories}.
15579
15580 @item
15581 Uhm... that's it.
15582 @end itemize
15583
15584
15585 @node Agent Categories
15586 @subsection Agent Categories
15587
15588 One of the main reasons to integrate the news transport layer into the
15589 newsreader is to allow greater control over what articles to download.
15590 There's not much point in downloading huge amounts of articles, just to
15591 find out that you're not interested in reading any of them.  It's better
15592 to be somewhat more conservative in choosing what to download, and then
15593 mark the articles for downloading manually if it should turn out that
15594 you're interested in the articles anyway.
15595
15596 The main way to control what is to be downloaded is to create a
15597 @dfn{category} and then assign some (or all) groups to this category.
15598 Groups that do not belong in any other category belong to the
15599 @code{default} category.  Gnus has its own buffer for creating and
15600 managing categories.
15601
15602 @menu
15603 * Category Syntax::             What a category looks like.
15604 * Category Buffer::             A buffer for maintaining categories.
15605 * Category Variables::          Customize'r'Us.
15606 @end menu
15607
15608
15609 @node Category Syntax
15610 @subsubsection Category Syntax
15611
15612 A category consists of two things.
15613
15614 @enumerate
15615 @item
15616 A predicate which (generally) gives a rough outline of which articles
15617 are eligible for downloading; and
15618
15619 @item
15620 a score rule which (generally) gives you a finer granularity when
15621 deciding what articles to download.  (Note that this @dfn{download
15622 score} is not necessarily related to normal scores.)
15623 @end enumerate
15624
15625 A predicate in its simplest form can be a single predicate such as
15626 @code{true} or @code{false}.  These two will download every available
15627 article or nothing respectively.  In the case of these two special
15628 predicates an additional score rule is superfluous.
15629
15630 Predicates of @code{high} or @code{low} download articles in respect of
15631 their scores in relationship to @code{gnus-agent-high-score} and
15632 @code{gnus-agent-low-score} as described below.
15633
15634 To gain even finer control of what is to be regarded eligible for
15635 download a predicate can consist of a number of predicates with logical
15636 operators sprinkled in between.
15637
15638 Perhaps some examples are in order.
15639
15640 Here's a simple predicate.  (It's the default predicate, in fact, used
15641 for all groups that don't belong to any other category.)
15642
15643 @lisp
15644 short
15645 @end lisp
15646
15647 Quite simple, eh?  This predicate is true if and only if the article is
15648 short (for some value of ``short'').
15649
15650 Here's a more complex predicate:
15651
15652 @lisp
15653 (or high
15654     (and
15655      (not low)
15656      (not long)))
15657 @end lisp
15658
15659 This means that an article should be downloaded if it has a high score,
15660 or if the score is not low and the article is not long.  You get the
15661 drift.
15662
15663 The available logical operators are @code{or}, @code{and} and
15664 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
15665 @samp{|}, @code{&} and @code{!} instead.)
15666
15667 The following predicates are pre-defined, but if none of these fit what
15668 you want to do, you can write your own.
15669
15670 @table @code
15671 @item short
15672 True iff the article is shorter than @code{gnus-agent-short-article}
15673 lines; default 100.
15674
15675 @item long
15676 True iff the article is longer than @code{gnus-agent-long-article}
15677 lines; default 200.
15678
15679 @item low
15680 True iff the article has a download score less than
15681 @code{gnus-agent-low-score}; default 0.
15682
15683 @item high
15684 True iff the article has a download score greater than
15685 @code{gnus-agent-high-score}; default 0.
15686
15687 @item spam
15688 True iff the Gnus Agent guesses that the article is spam.  The
15689 heuristics may change over time, but at present it just computes a
15690 checksum and sees whether articles match.
15691
15692 @item true
15693 Always true.
15694
15695 @item false
15696 Always false.
15697 @end table
15698
15699 If you want to create your own predicate function, here's what you have
15700 to know:  The functions are called with no parameters, but the
15701 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
15702 useful values.
15703
15704 For example, you could decide that you don't want to download articles
15705 that were posted more than a certain number of days ago (e.g. posted
15706 more than @code{gnus-agent-expire-days} ago) you might write a function
15707 something along the lines of the following:
15708
15709 @lisp
15710 (defun my-article-old-p ()
15711   "Say whether an article is old."
15712   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
15713      (- (time-to-days (current-time)) gnus-agent-expire-days)))
15714 @end lisp
15715
15716 with the predicate then defined as:
15717
15718 @lisp
15719 (not my-article-old-p)
15720 @end lisp
15721
15722 or you could append your predicate to the predefined
15723 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
15724 wherever.  (Note: this would have to be at a point *after*
15725 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
15726
15727 @lisp
15728 (setq  gnus-category-predicate-alist
15729   (append gnus-category-predicate-alist
15730          '((old . my-article-old-p))))
15731 @end lisp
15732
15733 and simply specify your predicate as:
15734
15735 @lisp
15736 (not old)
15737 @end lisp
15738
15739 If/when using something like the above, be aware that there are many
15740 misconfigured systems/mailers out there and so an article's date is not
15741 always a reliable indication of when it was posted.  Hell, some people
15742 just don't give a damn.
15743
15744 The above predicates apply to *all* the groups which belong to the
15745 category.  However, if you wish to have a specific predicate for an
15746 individual group within a category, or you're just too lazy to set up a
15747 new category, you can enter a group's individual predicate in it's group
15748 parameters like so:
15749
15750 @lisp
15751 (agent-predicate . short)
15752 @end lisp
15753
15754 This is the group parameter equivalent of the agent category default.
15755 Note that when specifying a single word predicate like this, the
15756 @code{agent-predicate} specification must be in dotted pair notation.
15757
15758 The equivalent of the longer example from above would be:
15759
15760 @lisp
15761 (agent-predicate or high (and (not low) (not long)))
15762 @end lisp
15763
15764 The outer parenthesis required in the category specification are not
15765 entered here as, not being in dotted pair notation, the value of the
15766 predicate is assumed to be a list.
15767
15768
15769 Now, the syntax of the download score is the same as the syntax of
15770 normal score files, except that all elements that require actually
15771 seeing the article itself are verboten.  This means that only the
15772 following headers can be scored on: @code{Subject}, @code{From},
15773 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
15774 @code{Lines}, and @code{Xref}.
15775
15776 As with predicates, the specification of the @code{download score rule}
15777 to use in respect of a group can be in either the category definition if
15778 it's to be applicable to all groups in therein, or a group's parameters
15779 if it's to be specific to that group.
15780
15781 In both of these places the @code{download score rule} can take one of
15782 three forms:
15783
15784 @enumerate
15785 @item
15786 Score rule
15787
15788 This has the same syntax as a normal gnus score file except only a
15789 subset of scoring keywords are available as mentioned above.
15790
15791 example:
15792
15793 @itemize @bullet
15794 @item
15795 Category specification
15796
15797 @lisp
15798 (("from"
15799        ("Lars Ingebrigtsen" 1000000 nil s))
15800 ("lines"
15801        (500 -100 nil <)))
15802 @end lisp
15803
15804 @item
15805 Group Parameter specification
15806
15807 @lisp
15808 (agent-score ("from"
15809                    ("Lars Ingebrigtsen" 1000000 nil s))
15810              ("lines"
15811                    (500 -100 nil <)))
15812 @end lisp
15813
15814 Again, note the omission of the outermost parenthesis here.
15815 @end itemize
15816
15817 @item
15818 Agent score file
15819
15820 These score files must *only* contain the permitted scoring keywords
15821 stated above.
15822
15823 example:
15824
15825 @itemize @bullet
15826 @item
15827 Category specification
15828
15829 @lisp
15830 ("~/News/agent.SCORE")
15831 @end lisp
15832
15833 or perhaps
15834
15835 @lisp
15836 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
15837 @end lisp
15838
15839 @item
15840 Group Parameter specification
15841
15842 @lisp
15843 (agent-score "~/News/agent.SCORE")
15844 @end lisp
15845
15846 Additional score files can be specified as above.  Need I say anything
15847 about parenthesis?
15848 @end itemize
15849
15850 @item
15851 Use @code{normal} score files
15852
15853 If you don't want to maintain two sets of scoring rules for a group, and
15854 your desired @code{downloading} criteria for a group are the same as your
15855 @code{reading} criteria then you can tell the agent to refer to your
15856 @code{normal} score files when deciding what to download.
15857
15858 These directives in either the category definition or a group's
15859 parameters will cause the agent to read in all the applicable score
15860 files for a group, *filtering out* those sections that do not
15861 relate to one of the permitted subset of scoring keywords.
15862
15863 @itemize @bullet
15864 @item
15865 Category Specification
15866
15867 @lisp
15868 file
15869 @end lisp
15870
15871 @item
15872 Group Parameter specification
15873
15874 @lisp
15875 (agent-score . file)
15876 @end lisp
15877 @end itemize
15878 @end enumerate
15879
15880 @node Category Buffer
15881 @subsubsection Category Buffer
15882
15883 You'd normally do all category maintenance from the category buffer.
15884 When you enter it for the first time (with the @kbd{J c} command from
15885 the group buffer), you'll only see the @code{default} category.
15886
15887 The following commands are available in this buffer:
15888
15889 @table @kbd
15890 @item q
15891 @kindex q (Category)
15892 @findex gnus-category-exit
15893 Return to the group buffer (@code{gnus-category-exit}).
15894
15895 @item k
15896 @kindex k (Category)
15897 @findex gnus-category-kill
15898 Kill the current category (@code{gnus-category-kill}).
15899
15900 @item c
15901 @kindex c (Category)
15902 @findex gnus-category-copy
15903 Copy the current category (@code{gnus-category-copy}).
15904
15905 @item a
15906 @kindex a (Category)
15907 @findex gnus-category-add
15908 Add a new category (@code{gnus-category-add}).
15909
15910 @item p
15911 @kindex p (Category)
15912 @findex gnus-category-edit-predicate
15913 Edit the predicate of the current category
15914 (@code{gnus-category-edit-predicate}).
15915
15916 @item g
15917 @kindex g (Category)
15918 @findex gnus-category-edit-groups
15919 Edit the list of groups belonging to the current category
15920 (@code{gnus-category-edit-groups}).
15921
15922 @item s
15923 @kindex s (Category)
15924 @findex gnus-category-edit-score
15925 Edit the download score rule of the current category
15926 (@code{gnus-category-edit-score}).
15927
15928 @item l
15929 @kindex l (Category)
15930 @findex gnus-category-list
15931 List all the categories (@code{gnus-category-list}).
15932 @end table
15933
15934
15935 @node Category Variables
15936 @subsubsection Category Variables
15937
15938 @table @code
15939 @item gnus-category-mode-hook
15940 @vindex gnus-category-mode-hook
15941 Hook run in category buffers.
15942
15943 @item gnus-category-line-format
15944 @vindex gnus-category-line-format
15945 Format of the lines in the category buffer (@pxref{Formatting
15946 Variables}).  Valid elements are:
15947
15948 @table @samp
15949 @item c
15950 The name of the category.
15951
15952 @item g
15953 The number of groups in the category.
15954 @end table
15955
15956 @item gnus-category-mode-line-format
15957 @vindex gnus-category-mode-line-format
15958 Format of the category mode line (@pxref{Mode Line Formatting}).
15959
15960 @item gnus-agent-short-article
15961 @vindex gnus-agent-short-article
15962 Articles that have fewer lines than this are short.  Default 100.
15963
15964 @item gnus-agent-long-article
15965 @vindex gnus-agent-long-article
15966 Articles that have more lines than this are long.  Default 200.
15967
15968 @item gnus-agent-low-score
15969 @vindex gnus-agent-low-score
15970 Articles that have a score lower than this have a low score.  Default
15971 0.
15972
15973 @item gnus-agent-high-score
15974 @vindex gnus-agent-high-score
15975 Articles that have a score higher than this have a high score.  Default
15976 0.
15977
15978 @end table
15979
15980
15981 @node Agent Commands
15982 @subsection Agent Commands
15983
15984 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
15985 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
15986 toggles the plugged/unplugged state of the Gnus Agent.
15987
15988
15989 @menu
15990 * Group Agent Commands::        
15991 * Summary Agent Commands::      
15992 * Server Agent Commands::       
15993 @end menu
15994
15995 You can run a complete batch fetch from the command line with the
15996 following incantation:
15997
15998 @cindex gnus-agent-batch-fetch
15999 @example
16000 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
16001 @end example
16002
16003
16004
16005 @node Group Agent Commands
16006 @subsubsection Group Agent Commands
16007
16008 @table @kbd
16009 @item J u
16010 @kindex J u (Agent Group)
16011 @findex gnus-agent-fetch-groups
16012 Fetch all eligible articles in the current group
16013 (@code{gnus-agent-fetch-groups}).
16014
16015 @item J c
16016 @kindex J c (Agent Group)
16017 @findex gnus-enter-category-buffer
16018 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
16019
16020 @item J s
16021 @kindex J s (Agent Group)
16022 @findex gnus-agent-fetch-session
16023 Fetch all eligible articles in all groups
16024 (@code{gnus-agent-fetch-session}).
16025
16026 @item J S
16027 @kindex J S (Agent Group)
16028 @findex gnus-group-send-drafts
16029 Send all sendable messages in the draft group
16030 (@code{gnus-group-send-drafts}).  @xref{Drafts}.
16031
16032 @item J a
16033 @kindex J a (Agent Group)
16034 @findex gnus-agent-add-group
16035 Add the current group to an Agent category
16036 (@code{gnus-agent-add-group}).  This command understands the
16037 process/prefix convention (@pxref{Process/Prefix}).
16038
16039 @item J r
16040 @kindex J r (Agent Group)
16041 @findex gnus-agent-remove-group
16042 Remove the current group from its category, if any
16043 (@code{gnus-agent-remove-group}).  This command understands the
16044 process/prefix convention (@pxref{Process/Prefix}).
16045
16046 @item J Y
16047 @kindex J Y (Agent Group)
16048 @findex gnus-agent-synchronize-flags
16049 Synchronize flags changed while unplugged with remote server, if any.
16050
16051
16052 @end table
16053
16054
16055 @node Summary Agent Commands
16056 @subsubsection Summary Agent Commands
16057
16058 @table @kbd
16059 @item J #
16060 @kindex J # (Agent Summary)
16061 @findex gnus-agent-mark-article
16062 Mark the article for downloading (@code{gnus-agent-mark-article}).
16063
16064 @item J M-#
16065 @kindex J M-# (Agent Summary)
16066 @findex gnus-agent-unmark-article
16067 Remove the downloading mark from the article
16068 (@code{gnus-agent-unmark-article}).
16069
16070 @item @@
16071 @kindex @@ (Agent Summary)
16072 @findex gnus-agent-toggle-mark
16073 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
16074
16075 @item J c
16076 @kindex J c (Agent Summary)
16077 @findex gnus-agent-catchup
16078 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
16079
16080 @item J u
16081 @kindex J u (Agent Summary)
16082 @findex gnus-agent-summary-fetch-group
16083 Download all downloadable articles in the current group
16084 (@code{gnus-agent-summary-fetch-group}). 
16085
16086 @end table
16087
16088
16089 @node Server Agent Commands
16090 @subsubsection Server Agent Commands
16091
16092 @table @kbd
16093 @item J a
16094 @kindex J a (Agent Server)
16095 @findex gnus-agent-add-server
16096 Add the current server to the list of servers covered by the Gnus Agent
16097 (@code{gnus-agent-add-server}).
16098
16099 @item J r
16100 @kindex J r (Agent Server)
16101 @findex gnus-agent-remove-server
16102 Remove the current server from the list of servers covered by the Gnus
16103 Agent (@code{gnus-agent-remove-server}).
16104
16105 @end table
16106
16107
16108 @node Agent Expiry
16109 @subsection Agent Expiry
16110
16111 @vindex gnus-agent-expire-days
16112 @findex gnus-agent-expire
16113 @kindex M-x gnus-agent-expire
16114 @cindex Agent expiry
16115 @cindex Gnus Agent expiry
16116 @cindex expiry
16117
16118 @code{nnagent} doesn't handle expiry.  Instead, there's a special
16119 @code{gnus-agent-expire} command that will expire all read articles that
16120 are older than @code{gnus-agent-expire-days} days.  It can be run
16121 whenever you feel that you're running out of space.  It's not
16122 particularly fast or efficient, and it's not a particularly good idea to
16123 interrupt it (with @kbd{C-g} or anything else) once you've started it.
16124
16125 @vindex gnus-agent-expire-all
16126 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
16127 expire all articles---unread, read, ticked and dormant.  If @code{nil}
16128 (which is the default), only read articles are eligible for expiry, and
16129 unread, ticked and dormant articles will be kept indefinitely.
16130
16131
16132 @node Agent and IMAP
16133 @subsection Agent and IMAP
16134
16135 The Agent work with any Gnus back end, including nnimap.  However,
16136 since there are some conceptual differences between @sc{nntp} and
16137 @sc{imap}, this section (should) provide you with some information to
16138 make Gnus Agent work smoother as a @sc{imap} Disconnected Mode client.
16139
16140 The first thing to keep in mind is that all flags (read, ticked, etc)
16141 are kept on the @sc{imap} server, rather than in @code{.newsrc} as is the
16142 case for nntp.  Thus Gnus need to remember flag changes when
16143 disconnected, and synchronize these flags when you plug back in.
16144
16145 Gnus keep track of flag changes when reading nnimap groups under the
16146 Agent by default.  When you plug back in, by default Gnus will check if
16147 you have any changed any flags and ask if you wish to synchronize these
16148 with the server.  This behavior is customizable with
16149 @code{gnus-agent-synchronize-flags}.
16150
16151 @vindex gnus-agent-synchronize-flags
16152 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
16153 never automatically synchronize flags.  If it is @code{ask}, the
16154 default, the Agent will check if you made any changes and if so ask if
16155 you wish to synchronize these when you re-connect.  If it has any other
16156 value, all flags will be synchronized automatically.
16157
16158 If you do not wish to automatically synchronize flags when you
16159 re-connect, this can be done manually with the
16160 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
16161 in the group buffer by default.
16162
16163 Some things are currently not implemented in the Agent that you'd might
16164 expect from a disconnected @sc{imap} client, including:
16165
16166 @itemize @bullet
16167
16168 @item
16169 Copying/moving articles into nnimap groups when unplugged.
16170
16171 @item
16172 Creating/deleting nnimap groups when unplugged.
16173
16174 @end itemize
16175
16176 Technical note: the synchronization algorithm does not work by "pushing"
16177 all local flags to the server, but rather incrementally update the
16178 server view of flags by changing only those flags that were changed by
16179 the user.  Thus, if you set one flag on a article, quit the group and
16180 re-select the group and remove the flag; the flag will be set and
16181 removed from the server when you "synchronize".  The queued flag
16182 operations can be found in the per-server @code{flags} file in the Agent
16183 directory.  It's emptied when you synchronize flags.
16184
16185
16186 @node Outgoing Messages
16187 @subsection Outgoing Messages
16188
16189 When Gnus is unplugged, all outgoing messages (both mail and news) are
16190 stored in the draft groups (@pxref{Drafts}).  You can view them there
16191 after posting, and edit them at will.
16192
16193 When Gnus is plugged again, you can send the messages either from the
16194 draft group with the special commands available there, or you can use
16195 the @kbd{J S} command in the group buffer to send all the sendable
16196 messages in the draft group.
16197
16198
16199
16200 @node Agent Variables
16201 @subsection Agent Variables
16202
16203 @table @code
16204 @item gnus-agent-directory
16205 @vindex gnus-agent-directory
16206 Where the Gnus Agent will store its files.  The default is
16207 @file{~/News/agent/}.
16208
16209 @item gnus-agent-handle-level
16210 @vindex gnus-agent-handle-level
16211 Groups on levels (@pxref{Group Levels}) higher than this variable will
16212 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
16213 which means that only subscribed group will be considered by the Agent
16214 by default.
16215
16216 @item gnus-agent-plugged-hook
16217 @vindex gnus-agent-plugged-hook
16218 Hook run when connecting to the network.
16219
16220 @item gnus-agent-unplugged-hook
16221 @vindex gnus-agent-unplugged-hook
16222 Hook run when disconnecting from the network.
16223
16224 @end table
16225
16226
16227 @node Example Setup
16228 @subsection Example Setup
16229
16230 If you don't want to read this manual, and you have a fairly standard
16231 setup, you may be able to use something like the following as your
16232 @file{.gnus.el} file to get started.
16233
16234 @lisp
16235 ;;; Define how Gnus is to fetch news.  We do this over @sc{nntp}
16236 ;;; from your ISP's server.
16237 (setq gnus-select-method '(nntp "news.your-isp.com"))
16238
16239 ;;; Define how Gnus is to read your mail.  We read mail from
16240 ;;; your ISP's POP server.
16241 (setq mail-sources '((pop :server "pop.your-isp.com")))
16242
16243 ;;; Say how Gnus is to store the mail.  We use nnml groups.
16244 (setq gnus-secondary-select-methods '((nnml "")))
16245
16246 ;;; Make Gnus into an offline newsreader.
16247 (gnus-agentize)
16248 @end lisp
16249
16250 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
16251 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
16252 gnus}.
16253
16254 If this is the first time you've run Gnus, you will be subscribed
16255 automatically to a few default newsgroups.  You'll probably want to
16256 subscribe to more groups, and to do that, you have to query the
16257 @sc{nntp} server for a complete list of groups with the @kbd{A A}
16258 command.  This usually takes quite a while, but you only have to do it
16259 once.
16260
16261 After reading and parsing a while, you'll be presented with a list of
16262 groups.  Subscribe to the ones you want to read with the @kbd{u}
16263 command.  @kbd{l} to make all the killed groups disappear after you've
16264 subscribe to all the groups you want to read.  (@kbd{A k} will bring
16265 back all the killed groups.)
16266
16267 You can now read the groups at once, or you can download the articles
16268 with the @kbd{J s} command.  And then read the rest of this manual to
16269 find out which of the other gazillion things you want to customize.
16270
16271
16272 @node Batching Agents
16273 @subsection Batching Agents
16274
16275 Having the Gnus Agent fetch articles (and post whatever messages you've
16276 written) is quite easy once you've gotten things set up properly.  The
16277 following shell script will do everything that is necessary:
16278
16279 @example
16280 #!/bin/sh
16281 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
16282 @end example
16283
16284
16285 @node Agent Caveats
16286 @subsection Agent Caveats
16287
16288 The Gnus Agent doesn't seem to work like most other offline
16289 newsreaders.  Here are some common questions that some imaginary people
16290 may ask:
16291
16292 @table @dfn
16293 @item If I read an article while plugged, do they get entered into the
16294 Agent?
16295
16296 @strong{No.}
16297
16298 @item If I read an article while plugged, and the article already exists
16299 in the Agent, will it get downloaded once more?
16300
16301 @strong{Yes.}
16302
16303 @end table
16304
16305 In short, when Gnus is unplugged, it only looks into the locally stored
16306 articles; when it's plugged, it only talks to your ISP.
16307
16308
16309 @node Scoring
16310 @chapter Scoring
16311 @cindex scoring
16312
16313 Other people use @dfn{kill files}, but we here at Gnus Towers like
16314 scoring better than killing, so we'd rather switch than fight.  They do
16315 something completely different as well, so sit up straight and pay
16316 attention!
16317
16318 @vindex gnus-summary-mark-below
16319 All articles have a default score (@code{gnus-summary-default-score}),
16320 which is 0 by default.  This score may be raised or lowered either
16321 interactively or by score files.  Articles that have a score lower than
16322 @code{gnus-summary-mark-below} are marked as read.
16323
16324 Gnus will read any @dfn{score files} that apply to the current group
16325 before generating the summary buffer.
16326
16327 There are several commands in the summary buffer that insert score
16328 entries based on the current article.  You can, for instance, ask Gnus to
16329 lower or increase the score of all articles with a certain subject.
16330
16331 There are two sorts of scoring entries: Permanent and temporary.
16332 Temporary score entries are self-expiring entries.  Any entries that are
16333 temporary and have not been used for, say, a week, will be removed
16334 silently to help keep the sizes of the score files down.
16335
16336 @menu
16337 * Summary Score Commands::      Adding score entries for the current group.
16338 * Group Score Commands::        General score commands.
16339 * Score Variables::             Customize your scoring.  (My, what terminology).
16340 * Score File Format::           What a score file may contain.
16341 * Score File Editing::          You can edit score files by hand as well.
16342 * Adaptive Scoring::            Big Sister Gnus knows what you read.
16343 * Home Score File::             How to say where new score entries are to go.
16344 * Followups To Yourself::       Having Gnus notice when people answer you.
16345 * Scoring On Other Headers::    Scoring on non-standard headers.
16346 * Scoring Tips::                How to score effectively.
16347 * Reverse Scoring::             That problem child of old is not problem.
16348 * Global Score Files::          Earth-spanning, ear-splitting score files.
16349 * Kill Files::                  They are still here, but they can be ignored.
16350 * Converting Kill Files::       Translating kill files to score files.
16351 * GroupLens::                   Getting predictions on what you like to read.
16352 * Advanced Scoring::            Using logical expressions to build score rules.
16353 * Score Decays::                It can be useful to let scores wither away.
16354 @end menu
16355
16356
16357 @node Summary Score Commands
16358 @section Summary Score Commands
16359 @cindex score commands
16360
16361 The score commands that alter score entries do not actually modify real
16362 score files.  That would be too inefficient.  Gnus maintains a cache of
16363 previously loaded score files, one of which is considered the
16364 @dfn{current score file alist}.  The score commands simply insert
16365 entries into this list, and upon group exit, this list is saved.
16366
16367 The current score file is by default the group's local score file, even
16368 if no such score file actually exists.  To insert score commands into
16369 some other score file (e.g. @file{all.SCORE}), you must first make this
16370 score file the current one.
16371
16372 General score commands that don't actually change the score file:
16373
16374 @table @kbd
16375
16376 @item V s
16377 @kindex V s (Summary)
16378 @findex gnus-summary-set-score
16379 Set the score of the current article (@code{gnus-summary-set-score}).
16380
16381 @item V S
16382 @kindex V S (Summary)
16383 @findex gnus-summary-current-score
16384 Display the score of the current article
16385 (@code{gnus-summary-current-score}).
16386
16387 @item V t
16388 @kindex V t (Summary)
16389 @findex gnus-score-find-trace
16390 Display all score rules that have been used on the current article
16391 (@code{gnus-score-find-trace}).
16392
16393 @item V R
16394 @kindex V R (Summary)
16395 @findex gnus-summary-rescore
16396 Run the current summary through the scoring process
16397 (@code{gnus-summary-rescore}).  This might be useful if you're playing
16398 around with your score files behind Gnus' back and want to see the
16399 effect you're having.
16400
16401 @item V c
16402 @kindex V c (Summary)
16403 @findex gnus-score-change-score-file
16404 Make a different score file the current
16405 (@code{gnus-score-change-score-file}).
16406
16407 @item V e
16408 @kindex V e (Summary)
16409 @findex gnus-score-edit-current-scores
16410 Edit the current score file (@code{gnus-score-edit-current-scores}).
16411 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
16412 File Editing}).
16413
16414 @item V f
16415 @kindex V f (Summary)
16416 @findex gnus-score-edit-file
16417 Edit a score file and make this score file the current one
16418 (@code{gnus-score-edit-file}).
16419
16420 @item V F
16421 @kindex V F (Summary)
16422 @findex gnus-score-flush-cache
16423 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
16424 after editing score files.
16425
16426 @item V C
16427 @kindex V C (Summary)
16428 @findex gnus-score-customize
16429 Customize a score file in a visually pleasing manner
16430 (@code{gnus-score-customize}).
16431
16432 @end table
16433
16434 The rest of these commands modify the local score file.
16435
16436 @table @kbd
16437
16438 @item V m
16439 @kindex V m (Summary)
16440 @findex gnus-score-set-mark-below
16441 Prompt for a score, and mark all articles with a score below this as
16442 read (@code{gnus-score-set-mark-below}).
16443
16444 @item V x
16445 @kindex V x (Summary)
16446 @findex gnus-score-set-expunge-below
16447 Prompt for a score, and add a score rule to the current score file to
16448 expunge all articles below this score
16449 (@code{gnus-score-set-expunge-below}).
16450 @end table
16451
16452 The keystrokes for actually making score entries follow a very regular
16453 pattern, so there's no need to list all the commands.  (Hundreds of
16454 them.)
16455
16456 @findex gnus-summary-increase-score
16457 @findex gnus-summary-lower-score
16458
16459 @enumerate
16460 @item
16461 The first key is either @kbd{I} (upper case i) for increasing the score
16462 or @kbd{L} for lowering the score.
16463 @item
16464 The second key says what header you want to score on.  The following
16465 keys are available:
16466 @table @kbd
16467
16468 @item a
16469 Score on the author name.
16470
16471 @item s
16472 Score on the subject line.
16473
16474 @item x
16475 Score on the @code{Xref} line---i.e., the cross-posting line.
16476
16477 @item r
16478 Score on the @code{References} line.
16479
16480 @item d
16481 Score on the date.
16482
16483 @item l
16484 Score on the number of lines.
16485
16486 @item i
16487 Score on the @code{Message-ID} header.
16488
16489 @item f
16490 Score on followups---this matches the author name, and adds scores to
16491 the followups to this author.  (Using this key leads to the creation of
16492 @file{ADAPT} files.)
16493
16494 @item b
16495 Score on the body.
16496
16497 @item h
16498 Score on the head.
16499
16500 @item t
16501 Score on thread.  (Using this key leads to the creation of @file{ADAPT}
16502 files.)
16503
16504 @end table
16505
16506 @item
16507 The third key is the match type.  Which match types are valid depends on
16508 what headers you are scoring on.
16509
16510 @table @code
16511
16512 @item strings
16513
16514 @table @kbd
16515
16516 @item e
16517 Exact matching.
16518
16519 @item s
16520 Substring matching.
16521
16522 @item f
16523 Fuzzy matching (@pxref{Fuzzy Matching}).
16524
16525 @item r
16526 Regexp matching
16527 @end table
16528
16529 @item date
16530 @table @kbd
16531
16532 @item b
16533 Before date.
16534
16535 @item a
16536 After date.
16537
16538 @item n
16539 This date.
16540 @end table
16541
16542 @item number
16543 @table @kbd
16544
16545 @item <
16546 Less than number.
16547
16548 @item =
16549 Equal to number.
16550
16551 @item >
16552 Greater than number.
16553 @end table
16554 @end table
16555
16556 @item
16557 The fourth and final key says whether this is a temporary (i.e., expiring)
16558 score entry, or a permanent (i.e., non-expiring) score entry, or whether
16559 it is to be done immediately, without adding to the score file.
16560 @table @kbd
16561
16562 @item t
16563 Temporary score entry.
16564
16565 @item p
16566 Permanent score entry.
16567
16568 @item i
16569 Immediately scoring.
16570 @end table
16571
16572 @end enumerate
16573
16574 So, let's say you want to increase the score on the current author with
16575 exact matching permanently: @kbd{I a e p}.  If you want to lower the
16576 score based on the subject line, using substring matching, and make a
16577 temporary score entry: @kbd{L s s t}.  Pretty easy.
16578
16579 To make things a bit more complicated, there are shortcuts.  If you use
16580 a capital letter on either the second or third keys, Gnus will use
16581 defaults for the remaining one or two keystrokes.  The defaults are
16582 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
16583 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
16584
16585 These functions take both the numerical prefix and the symbolic prefix
16586 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
16587 (or increase) the score of the article.  A symbolic prefix of @code{a}
16588 says to use the @file{all.SCORE} file for the command instead of the
16589 current score file.
16590
16591 @vindex gnus-score-mimic-keymap
16592 The @code{gnus-score-mimic-keymap} says whether these commands will
16593 pretend they are keymaps or not.
16594
16595
16596 @node Group Score Commands
16597 @section Group Score Commands
16598 @cindex group score commands
16599
16600 There aren't many of these as yet, I'm afraid.
16601
16602 @table @kbd
16603
16604 @item W f
16605 @kindex W f (Group)
16606 @findex gnus-score-flush-cache
16607 Gnus maintains a cache of score alists to avoid having to reload them
16608 all the time.  This command will flush the cache
16609 (@code{gnus-score-flush-cache}).
16610
16611 @end table
16612
16613 You can do scoring from the command line by saying something like:
16614
16615 @findex gnus-batch-score
16616 @cindex batch scoring
16617 @example
16618 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
16619 @end example
16620
16621
16622 @node Score Variables
16623 @section Score Variables
16624 @cindex score variables
16625
16626 @table @code
16627
16628 @item gnus-use-scoring
16629 @vindex gnus-use-scoring
16630 If @code{nil}, Gnus will not check for score files, and will not, in
16631 general, do any score-related work.  This is @code{t} by default.
16632
16633 @item gnus-kill-killed
16634 @vindex gnus-kill-killed
16635 If this variable is @code{nil}, Gnus will never apply score files to
16636 articles that have already been through the kill process.  While this
16637 may save you lots of time, it also means that if you apply a kill file
16638 to a group, and then change the kill file and want to run it over you
16639 group again to kill more articles, it won't work.  You have to set this
16640 variable to @code{t} to do that.  (It is @code{t} by default.)
16641
16642 @item gnus-kill-files-directory
16643 @vindex gnus-kill-files-directory
16644 All kill and score files will be stored in this directory, which is
16645 initialized from the @code{SAVEDIR} environment variable by default.
16646 This is @file{~/News/} by default.
16647
16648 @item gnus-score-file-suffix
16649 @vindex gnus-score-file-suffix
16650 Suffix to add to the group name to arrive at the score file name
16651 (@samp{SCORE} by default.)
16652
16653 @item gnus-score-uncacheable-files
16654 @vindex gnus-score-uncacheable-files
16655 @cindex score cache
16656 All score files are normally cached to avoid excessive re-loading of
16657 score files.  However, if this might make your Emacs grow big and
16658 bloated, so this regexp can be used to weed out score files unlikely to be needed again.  It would be a bad idea to deny caching of
16659 @file{all.SCORE}, while it might be a good idea to not cache
16660 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
16661 variable is @samp{ADAPT$} by default, so no adaptive score files will
16662 be cached.
16663
16664 @item gnus-save-score
16665 @vindex gnus-save-score
16666 If you have really complicated score files, and do lots of batch
16667 scoring, then you might set this variable to @code{t}.  This will make
16668 Gnus save the scores into the @file{.newsrc.eld} file.
16669
16670 If you do not set this to @code{t}, then manual scores (like those set
16671 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
16672 across group visits.
16673
16674 @item gnus-score-interactive-default-score
16675 @vindex gnus-score-interactive-default-score
16676 Score used by all the interactive raise/lower commands to raise/lower
16677 score with.  Default is 1000, which may seem excessive, but this is to
16678 ensure that the adaptive scoring scheme gets enough room to play with.
16679 We don't want the small changes from the adaptive scoring to overwrite
16680 manually entered data.
16681
16682 @item gnus-summary-default-score
16683 @vindex gnus-summary-default-score
16684 Default score of an article, which is 0 by default.
16685
16686 @item gnus-summary-expunge-below
16687 @vindex gnus-summary-expunge-below
16688 Don't display the summary lines of articles that have scores lower than
16689 this variable.  This is @code{nil} by default, which means that no
16690 articles will be hidden.  This variable is local to the summary buffers,
16691 and has to be set from @code{gnus-summary-mode-hook}.
16692
16693 @item gnus-score-over-mark
16694 @vindex gnus-score-over-mark
16695 Mark (in the third column) used for articles with a score over the
16696 default.  Default is @samp{+}.
16697
16698 @item gnus-score-below-mark
16699 @vindex gnus-score-below-mark
16700 Mark (in the third column) used for articles with a score below the
16701 default.  Default is @samp{-}.
16702
16703 @item gnus-score-find-score-files-function
16704 @vindex gnus-score-find-score-files-function
16705 Function used to find score files for the current group.  This function
16706 is called with the name of the group as the argument.
16707
16708 Predefined functions available are:
16709 @table @code
16710
16711 @item gnus-score-find-single
16712 @findex gnus-score-find-single
16713 Only apply the group's own score file.
16714
16715 @item gnus-score-find-bnews
16716 @findex gnus-score-find-bnews
16717 Apply all score files that match, using bnews syntax.  This is the
16718 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
16719 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
16720 @file{gnu.all.SCORE} would all apply.  In short, the instances of
16721 @samp{all} in the score file names are translated into @samp{.*}, and
16722 then a regexp match is done.
16723
16724 This means that if you have some score entries that you want to apply to
16725 all groups, then you put those entries in the @file{all.SCORE} file.
16726
16727 The score files are applied in a semi-random order, although Gnus will
16728 try to apply the more general score files before the more specific score
16729 files.  It does this by looking at the number of elements in the score
16730 file names---discarding the @samp{all} elements.
16731
16732 @item gnus-score-find-hierarchical
16733 @findex gnus-score-find-hierarchical
16734 Apply all score files from all the parent groups.  This means that you
16735 can't have score files like @file{all.SCORE}, but you can have
16736 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
16737 server.
16738
16739 @end table
16740 This variable can also be a list of functions.  In that case, all
16741 these functions will be called with the group name as argument, and
16742 all the returned lists of score files will be applied.  These
16743 functions can also return lists of lists of score alists directly.  In
16744 that case, the functions that return these non-file score alists
16745 should probably be placed before the ``real'' score file functions, to
16746 ensure that the last score file returned is the local score file.
16747 Phu.
16748
16749 For example, to do hierarchical scoring but use a non-server-specific
16750 overall score file, you could use the value
16751 @example
16752 (list (lambda (group) ("all.SCORE"))
16753       'gnus-score-find-hierarchical)
16754 @end example
16755
16756 @item gnus-score-expiry-days
16757 @vindex gnus-score-expiry-days
16758 This variable says how many days should pass before an unused score file
16759 entry is expired.  If this variable is @code{nil}, no score file entries
16760 are expired.  It's 7 by default.
16761
16762 @item gnus-update-score-entry-dates
16763 @vindex gnus-update-score-entry-dates
16764 If this variable is non-@code{nil}, matching score entries will have
16765 their dates updated.  (This is how Gnus controls expiry---all
16766 non-matching entries will become too old while matching entries will
16767 stay fresh and young.)  However, if you set this variable to @code{nil},
16768 even matching entries will grow old and will have to face that oh-so
16769 grim reaper.
16770
16771 @item gnus-score-after-write-file-function
16772 @vindex gnus-score-after-write-file-function
16773 Function called with the name of the score file just written.
16774
16775 @item gnus-score-thread-simplify
16776 @vindex gnus-score-thread-simplify
16777 If this variable is non-@code{nil}, article subjects will be simplified
16778 for subject scoring purposes in the same manner as with
16779 threading---according to the current value of
16780 gnus-simplify-subject-functions.  If the scoring entry uses
16781 @code{substring} or @code{exact} matching, the match will also be
16782 simplified in this manner.
16783
16784 @end table
16785
16786
16787 @node Score File Format
16788 @section Score File Format
16789 @cindex score file format
16790
16791 A score file is an @code{emacs-lisp} file that normally contains just a
16792 single form.  Casual users are not expected to edit these files;
16793 everything can be changed from the summary buffer.
16794
16795 Anyway, if you'd like to dig into it yourself, here's an example:
16796
16797 @lisp
16798 (("from"
16799   ("Lars Ingebrigtsen" -10000)
16800   ("Per Abrahamsen")
16801   ("larsi\\|lmi" -50000 nil R))
16802  ("subject"
16803   ("Ding is Badd" nil 728373))
16804  ("xref"
16805   ("alt.politics" -1000 728372 s))
16806  ("lines"
16807   (2 -100 nil <))
16808  (mark 0)
16809  (expunge -1000)
16810  (mark-and-expunge -10)
16811  (read-only nil)
16812  (orphan -10)
16813  (adapt t)
16814  (files "/hom/larsi/News/gnu.SCORE")
16815  (exclude-files "all.SCORE")
16816  (local (gnus-newsgroup-auto-expire t)
16817         (gnus-summary-make-false-root empty))
16818  (eval (ding)))
16819 @end lisp
16820
16821 This example demonstrates most score file elements.  For a different
16822 approach, see @pxref{Advanced Scoring}.
16823
16824 Even though this looks much like lisp code, nothing here is actually
16825 @code{eval}ed.  The lisp reader is used to read this form, though, so it
16826 has to be valid syntactically, if not semantically.
16827
16828 Six keys are supported by this alist:
16829
16830 @table @code
16831
16832 @item STRING
16833 If the key is a string, it is the name of the header to perform the
16834 match on.  Scoring can only be performed on these eight headers:
16835 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
16836 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
16837 these headers, there are three strings to tell Gnus to fetch the entire
16838 article and do the match on larger parts of the article: @code{Body}
16839 will perform the match on the body of the article, @code{Head} will
16840 perform the match on the head of the article, and @code{All} will
16841 perform the match on the entire article.  Note that using any of these
16842 last three keys will slow down group entry @emph{considerably}.  The
16843 final ``header'' you can score on is @code{Followup}.  These score
16844 entries will result in new score entries being added for all follow-ups
16845 to articles that matches these score entries.
16846
16847 Following this key is a arbitrary number of score entries, where each
16848 score entry has one to four elements.
16849 @enumerate
16850
16851 @item
16852 The first element is the @dfn{match element}.  On most headers this will
16853 be a string, but on the Lines and Chars headers, this must be an
16854 integer.
16855
16856 @item
16857 If the second element is present, it should be a number---the @dfn{score
16858 element}.  This number should be an integer in the neginf to posinf
16859 interval.  This number is added to the score of the article if the match
16860 is successful.  If this element is not present, the
16861 @code{gnus-score-interactive-default-score} number will be used
16862 instead.  This is 1000 by default.
16863
16864 @item
16865 If the third element is present, it should be a number---the @dfn{date
16866 element}.  This date says when the last time this score entry matched,
16867 which provides a mechanism for expiring the score entries.  It this
16868 element is not present, the score entry is permanent.  The date is
16869 represented by the number of days since December 31, 1 BCE.
16870
16871 @item
16872 If the fourth element is present, it should be a symbol---the @dfn{type
16873 element}.  This element specifies what function should be used to see
16874 whether this score entry matches the article.  What match types that can
16875 be used depends on what header you wish to perform the match on.
16876 @table @dfn
16877
16878 @item From, Subject, References, Xref, Message-ID
16879 For most header types, there are the @code{r} and @code{R} (regexp), as
16880 well as @code{s} and @code{S} (substring) types, and @code{e} and
16881 @code{E} (exact match), and @code{w} (word match) types.  If this
16882 element is not present, Gnus will assume that substring matching should
16883 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
16884 that the matches will be done in a case-sensitive manner.  All these
16885 one-letter types are really just abbreviations for the @code{regexp},
16886 @code{string}, @code{exact}, and @code{word} types, which you can use
16887 instead, if you feel like.
16888
16889 @item Lines, Chars
16890 These two headers use different match types: @code{<}, @code{>},
16891 @code{=}, @code{>=} and @code{<=}.
16892
16893 These predicates are true if
16894
16895 @example
16896 (PREDICATE HEADER MATCH)
16897 @end example
16898
16899 evaluates to non-@code{nil}.  For instance, the advanced match
16900 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
16901 following form:
16902
16903 @lisp
16904 (< header-value 4)
16905 @end lisp
16906
16907 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
16908 the match, we get the score added if the article has less than 4 lines.
16909 (It's easy to get confused and think it's the other way around.  But
16910 it's not.  I think.)
16911
16912 When matching on @code{Lines}, be careful because some back ends (like
16913 @code{nndir}) do not generate @code{Lines} header, so every article ends
16914 up being marked as having 0 lines.  This can lead to strange results if
16915 you happen to lower score of the articles with few lines.
16916
16917 @item Date
16918 For the Date header we have three kinda silly match types:
16919 @code{before}, @code{at} and @code{after}.  I can't really imagine this
16920 ever being useful, but, like, it would feel kinda silly not to provide
16921 this function.  Just in case.  You never know.  Better safe than sorry.
16922 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
16923 sex on a first date.  (I have been told that at least one person, and I
16924 quote, ``found this function indispensable'', however.)
16925
16926 @cindex ISO8601
16927 @cindex date
16928 A more useful match type is @code{regexp}.  With it, you can match the
16929 date string using a regular expression.  The date is normalized to
16930 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
16931 you want to match all articles that have been posted on April 1st in
16932 every year, you could use @samp{....0401.........} as a match string,
16933 for instance.  (Note that the date is kept in its original time zone, so
16934 this will match articles that were posted when it was April 1st where
16935 the article was posted from.  Time zones are such wholesome fun for the
16936 whole family, eh?)
16937
16938 @item Head, Body, All
16939 These three match keys use the same match types as the @code{From} (etc)
16940 header uses.
16941
16942 @item Followup
16943 This match key is somewhat special, in that it will match the
16944 @code{From} header, and affect the score of not only the matching
16945 articles, but also all followups to the matching articles.  This allows
16946 you e.g. increase the score of followups to your own articles, or
16947 decrease the score of followups to the articles of some known
16948 trouble-maker.  Uses the same match types as the @code{From} header
16949 uses.  (Using this match key will lead to creation of @file{ADAPT}
16950 files.)
16951
16952 @item Thread
16953 This match key works along the same lines as the @code{Followup} match
16954 key.  If you say that you want to score on a (sub-)thread started by an
16955 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
16956 match.  This will add a new @samp{thread} match for each article that
16957 has @var{x} in its @code{References} header.  (These new @samp{thread}
16958 matches will use the @code{Message-ID}s of these matching articles.)
16959 This will ensure that you can raise/lower the score of an entire thread,
16960 even though some articles in the thread may not have complete
16961 @code{References} headers.  Note that using this may lead to
16962 undeterministic scores of the articles in the thread.  (Using this match
16963 key will lead to creation of @file{ADAPT} files.)
16964 @end table
16965 @end enumerate
16966
16967 @cindex Score File Atoms
16968 @item mark
16969 The value of this entry should be a number.  Any articles with a score
16970 lower than this number will be marked as read.
16971
16972 @item expunge
16973 The value of this entry should be a number.  Any articles with a score
16974 lower than this number will be removed from the summary buffer.
16975
16976 @item mark-and-expunge
16977 The value of this entry should be a number.  Any articles with a score
16978 lower than this number will be marked as read and removed from the
16979 summary buffer.
16980
16981 @item thread-mark-and-expunge
16982 The value of this entry should be a number.  All articles that belong to
16983 a thread that has a total score below this number will be marked as read
16984 and removed from the summary buffer.  @code{gnus-thread-score-function}
16985 says how to compute the total score for a thread.
16986
16987 @item files
16988 The value of this entry should be any number of file names.  These files
16989 are assumed to be score files as well, and will be loaded the same way
16990 this one was.
16991
16992 @item exclude-files
16993 The clue of this entry should be any number of files.  These files will
16994 not be loaded, even though they would normally be so, for some reason or
16995 other.
16996
16997 @item eval
16998 The value of this entry will be @code{eval}el.  This element will be
16999 ignored when handling global score files.
17000
17001 @item read-only
17002 Read-only score files will not be updated or saved.  Global score files
17003 should feature this atom (@pxref{Global Score Files}).  (Note:
17004 @dfn{Global} here really means @dfn{global}; not your personal
17005 apply-to-all-groups score files.)
17006
17007 @item orphan
17008 The value of this entry should be a number.  Articles that do not have
17009 parents will get this number added to their scores.  Imagine you follow
17010 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
17011 will only follow a few of the threads, also want to see any new threads.
17012
17013 You can do this with the following two score file entries:
17014
17015 @example
17016         (orphan -500)
17017         (mark-and-expunge -100)
17018 @end example
17019
17020 When you enter the group the first time, you will only see the new
17021 threads.  You then raise the score of the threads that you find
17022 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
17023 rest.  Next time you enter the group, you will see new articles in the
17024 interesting threads, plus any new threads.
17025
17026 I.e.---the orphan score atom is for high-volume groups where a few
17027 interesting threads which can't be found automatically by ordinary
17028 scoring rules exist.
17029
17030 @item adapt
17031 This entry controls the adaptive scoring.  If it is @code{t}, the
17032 default adaptive scoring rules will be used.  If it is @code{ignore}, no
17033 adaptive scoring will be performed on this group.  If it is a list, this
17034 list will be used as the adaptive scoring rules.  If it isn't present,
17035 or is something other than @code{t} or @code{ignore}, the default
17036 adaptive scoring rules will be used.  If you want to use adaptive
17037 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
17038 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
17039 not want adaptive scoring.  If you only want adaptive scoring in a few
17040 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
17041 insert @code{(adapt t)} in the score files of the groups where you want
17042 it.
17043
17044 @item adapt-file
17045 All adaptive score entries will go to the file named by this entry.  It
17046 will also be applied when entering the group.  This atom might be handy
17047 if you want to adapt on several groups at once, using the same adaptive
17048 file for a number of groups.
17049
17050 @item local
17051 @cindex local variables
17052 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
17053 Each @var{var} will be made buffer-local to the current summary buffer,
17054 and set to the value specified.  This is a convenient, if somewhat
17055 strange, way of setting variables in some groups if you don't like hooks
17056 much.  Note that the @var{value} won't be evaluated.
17057 @end table
17058
17059
17060 @node Score File Editing
17061 @section Score File Editing
17062
17063 You normally enter all scoring commands from the summary buffer, but you
17064 might feel the urge to edit them by hand as well, so we've supplied you
17065 with a mode for that.
17066
17067 It's simply a slightly customized @code{emacs-lisp} mode, with these
17068 additional commands:
17069
17070 @table @kbd
17071
17072 @item C-c C-c
17073 @kindex C-c C-c (Score)
17074 @findex gnus-score-edit-done
17075 Save the changes you have made and return to the summary buffer
17076 (@code{gnus-score-edit-done}).
17077
17078 @item C-c C-d
17079 @kindex C-c C-d (Score)
17080 @findex gnus-score-edit-insert-date
17081 Insert the current date in numerical format
17082 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
17083 you were wondering.
17084
17085 @item C-c C-p
17086 @kindex C-c C-p (Score)
17087 @findex gnus-score-pretty-print
17088 The adaptive score files are saved in an unformatted fashion.  If you
17089 intend to read one of these files, you want to @dfn{pretty print} it
17090 first.  This command (@code{gnus-score-pretty-print}) does that for
17091 you.
17092
17093 @end table
17094
17095 Type @kbd{M-x gnus-score-mode} to use this mode.
17096
17097 @vindex gnus-score-mode-hook
17098 @code{gnus-score-menu-hook} is run in score mode buffers.
17099
17100 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
17101 e} to begin editing score files.
17102
17103
17104 @node Adaptive Scoring
17105 @section Adaptive Scoring
17106 @cindex adaptive scoring
17107
17108 If all this scoring is getting you down, Gnus has a way of making it all
17109 happen automatically---as if by magic.  Or rather, as if by artificial
17110 stupidity, to be precise.
17111
17112 @vindex gnus-use-adaptive-scoring
17113 When you read an article, or mark an article as read, or kill an
17114 article, you leave marks behind.  On exit from the group, Gnus can sniff
17115 these marks and add score elements depending on what marks it finds.
17116 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
17117 @code{t} or @code{(line)}.  If you want score adaptively on separate
17118 words appearing in the subjects, you should set this variable to
17119 @code{(word)}.  If you want to use both adaptive methods, set this
17120 variable to @code{(word line)}.
17121
17122 @vindex gnus-default-adaptive-score-alist
17123 To give you complete control over the scoring process, you can customize
17124 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
17125 might look something like this:
17126
17127 @lisp
17128 (setq gnus-default-adaptive-score-alist
17129   '((gnus-unread-mark)
17130     (gnus-ticked-mark (from 4))
17131     (gnus-dormant-mark (from 5))
17132     (gnus-del-mark (from -4) (subject -1))
17133     (gnus-read-mark (from 4) (subject 2))
17134     (gnus-expirable-mark (from -1) (subject -1))
17135     (gnus-killed-mark (from -1) (subject -3))
17136     (gnus-kill-file-mark)
17137     (gnus-ancient-mark)
17138     (gnus-low-score-mark)
17139     (gnus-catchup-mark (from -1) (subject -1))))
17140 @end lisp
17141
17142 As you see, each element in this alist has a mark as a key (either a
17143 variable name or a ``real'' mark---a character).  Following this key is
17144 a arbitrary number of header/score pairs.  If there are no header/score
17145 pairs following the key, no adaptive scoring will be done on articles
17146 that have that key as the article mark.  For instance, articles with
17147 @code{gnus-unread-mark} in the example above will not get adaptive score
17148 entries.
17149
17150 Each article can have only one mark, so just a single of these rules
17151 will be applied to each article.
17152
17153 To take @code{gnus-del-mark} as an example---this alist says that all
17154 articles that have that mark (i.e., are marked with @samp{D}) will have a
17155 score entry added to lower based on the @code{From} header by -4, and
17156 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
17157
17158 If you have marked 10 articles with the same subject with
17159 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
17160 That means that that subject will get a score of ten times -1, which
17161 should be, unless I'm much mistaken, -10.
17162
17163 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
17164 the read articles will be marked with the @samp{E} mark.  This'll
17165 probably make adaptive scoring slightly impossible, so auto-expiring and
17166 adaptive scoring doesn't really mix very well.
17167
17168 The headers you can score on are @code{from}, @code{subject},
17169 @code{message-id}, @code{references}, @code{xref}, @code{lines},
17170 @code{chars} and @code{date}.  In addition, you can score on
17171 @code{followup}, which will create an adaptive score entry that matches
17172 on the @code{References} header using the @code{Message-ID} of the
17173 current article, thereby matching the following thread.
17174
17175 You can also score on @code{thread}, which will try to score all
17176 articles that appear in a thread.  @code{thread} matches uses a
17177 @code{Message-ID} to match on the @code{References} header of the
17178 article.  If the match is made, the @code{Message-ID} of the article is
17179 added to the @code{thread} rule.  (Think about it.  I'd recommend two
17180 aspirins afterwards.)
17181
17182 If you use this scheme, you should set the score file atom @code{mark}
17183 to something small---like -300, perhaps, to avoid having small random
17184 changes result in articles getting marked as read.
17185
17186 After using adaptive scoring for a week or so, Gnus should start to
17187 become properly trained and enhance the authors you like best, and kill
17188 the authors you like least, without you having to say so explicitly.
17189
17190 You can control what groups the adaptive scoring is to be performed on
17191 by using the score files (@pxref{Score File Format}).  This will also
17192 let you use different rules in different groups.
17193
17194 @vindex gnus-adaptive-file-suffix
17195 The adaptive score entries will be put into a file where the name is the
17196 group name with @code{gnus-adaptive-file-suffix} appended.  The default
17197 is @samp{ADAPT}.
17198
17199 @vindex gnus-score-exact-adapt-limit
17200 When doing adaptive scoring, substring or fuzzy matching would probably
17201 give you the best results in most cases.  However, if the header one
17202 matches is short, the possibility for false positives is great, so if
17203 the length of the match is less than
17204 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
17205 this variable is @code{nil}, exact matching will always be used to avoid
17206 this problem.
17207
17208 @vindex gnus-default-adaptive-word-score-alist
17209 As mentioned above, you can adapt either on individual words or entire
17210 headers.  If you adapt on words, the
17211 @code{gnus-default-adaptive-word-score-alist} variable says what score
17212 each instance of a word should add given a mark.
17213
17214 @lisp
17215 (setq gnus-default-adaptive-word-score-alist
17216       `((,gnus-read-mark . 30)
17217         (,gnus-catchup-mark . -10)
17218         (,gnus-killed-mark . -20)
17219         (,gnus-del-mark . -15)))
17220 @end lisp
17221
17222 This is the default value.  If you have adaption on words enabled, every
17223 word that appears in subjects of articles marked with
17224 @code{gnus-read-mark} will result in a score rule that increase the
17225 score with 30 points.
17226
17227 @vindex gnus-default-ignored-adaptive-words
17228 @vindex gnus-ignored-adaptive-words
17229 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
17230 will be ignored.  If you wish to add more words to be ignored, use the
17231 @code{gnus-ignored-adaptive-words} list instead.
17232
17233 @vindex gnus-adaptive-word-length-limit
17234 Some may feel that short words shouldn't count when doing adaptive
17235 scoring.  If so, you may set @code{gnus-adaptive-word-length-limit} to
17236 an integer.  Words shorter than this number will be ignored.  This
17237 variable defaults til @code{nil}.
17238
17239 @vindex gnus-adaptive-word-syntax-table
17240 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
17241 syntax table in effect.  It is similar to the standard syntax table, but
17242 it considers numbers to be non-word-constituent characters.
17243
17244 @vindex gnus-adaptive-word-minimum
17245 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
17246 word scoring process will never bring down the score of an article to
17247 below this number.  The default is @code{nil}.
17248
17249 @vindex gnus-adaptive-word-no-group-words
17250 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
17251 won't adaptively word score any of the words in the group name.  Useful
17252 for groups like @samp{comp.editors.emacs}, where most of the subject
17253 lines contain the word @samp{emacs}.
17254
17255 After using this scheme for a while, it might be nice to write a
17256 @code{gnus-psychoanalyze-user} command to go through the rules and see
17257 what words you like and what words you don't like.  Or perhaps not.
17258
17259 Note that the adaptive word scoring thing is highly experimental and is
17260 likely to change in the future.  Initial impressions seem to indicate
17261 that it's totally useless as it stands.  Some more work (involving more
17262 rigorous statistical methods) will have to be done to make this useful.
17263
17264
17265 @node Home Score File
17266 @section Home Score File
17267
17268 The score file where new score file entries will go is called the
17269 @dfn{home score file}.  This is normally (and by default) the score file
17270 for the group itself.  For instance, the home score file for
17271 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
17272
17273 However, this may not be what you want.  It is often convenient to share
17274 a common home score file among many groups---all @samp{emacs} groups
17275 could perhaps use the same home score file.
17276
17277 @vindex gnus-home-score-file
17278 The variable that controls this is @code{gnus-home-score-file}.  It can
17279 be:
17280
17281 @enumerate
17282 @item
17283 A string.  Then this file will be used as the home score file for all
17284 groups.
17285
17286 @item
17287 A function.  The result of this function will be used as the home score
17288 file.  The function will be called with the name of the group as the
17289 parameter.
17290
17291 @item
17292 A list.  The elements in this list can be:
17293
17294 @enumerate
17295 @item
17296 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
17297 group name, the @var{file-name} will be used as the home score file.
17298
17299 @item
17300 A function.  If the function returns non-nil, the result will be used as
17301 the home score file.
17302
17303 @item
17304 A string.  Use the string as the home score file.
17305 @end enumerate
17306
17307 The list will be traversed from the beginning towards the end looking
17308 for matches.
17309
17310 @end enumerate
17311
17312 So, if you want to use just a single score file, you could say:
17313
17314 @lisp
17315 (setq gnus-home-score-file
17316       "my-total-score-file.SCORE")
17317 @end lisp
17318
17319 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
17320 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
17321
17322 @findex gnus-hierarchial-home-score-file
17323 @lisp
17324 (setq gnus-home-score-file
17325       'gnus-hierarchial-home-score-file)
17326 @end lisp
17327
17328 This is a ready-made function provided for your convenience.
17329 Other functions include
17330
17331 @table @code
17332 @item gnus-current-home-score-file
17333 @findex gnus-current-home-score-file
17334 Return the ``current'' regular score file.  This will make scoring
17335 commands add entry to the ``innermost'' matching score file.
17336
17337 @end table
17338
17339 If you want to have one score file for the @samp{emacs} groups and
17340 another for the @samp{comp} groups, while letting all other groups use
17341 their own home score files:
17342
17343 @lisp
17344 (setq gnus-home-score-file
17345       ;; All groups that match the regexp "\\.emacs"
17346       '(("\\.emacs" "emacs.SCORE")
17347         ;; All the comp groups in one score file
17348         ("^comp" "comp.SCORE")))
17349 @end lisp
17350
17351 @vindex gnus-home-adapt-file
17352 @code{gnus-home-adapt-file} works exactly the same way as
17353 @code{gnus-home-score-file}, but says what the home adaptive score file
17354 is instead.  All new adaptive file entries will go into the file
17355 specified by this variable, and the same syntax is allowed.
17356
17357 In addition to using @code{gnus-home-score-file} and
17358 @code{gnus-home-adapt-file}, you can also use group parameters
17359 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
17360 Parameters}) to achieve much the same.  Group and topic parameters take
17361 precedence over this variable.
17362
17363
17364 @node Followups To Yourself
17365 @section Followups To Yourself
17366
17367 Gnus offers two commands for picking out the @code{Message-ID} header in
17368 the current buffer.  Gnus will then add a score rule that scores using
17369 this @code{Message-ID} on the @code{References} header of other
17370 articles.  This will, in effect, increase the score of all articles that
17371 respond to the article in the current buffer.  Quite useful if you want
17372 to easily note when people answer what you've said.
17373
17374 @table @code
17375
17376 @item gnus-score-followup-article
17377 @findex gnus-score-followup-article
17378 This will add a score to articles that directly follow up your own
17379 article.
17380
17381 @item gnus-score-followup-thread
17382 @findex gnus-score-followup-thread
17383 This will add a score to all articles that appear in a thread ``below''
17384 your own article.
17385 @end table
17386
17387 @vindex message-sent-hook
17388 These two functions are both primarily meant to be used in hooks like
17389 @code{message-sent-hook}, like this:
17390 @lisp
17391 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
17392 @end lisp
17393
17394
17395 If you look closely at your own @code{Message-ID}, you'll notice that
17396 the first two or three characters are always the same.  Here's two of
17397 mine:
17398
17399 @example
17400 <x6u3u47icf.fsf@@eyesore.no>
17401 <x6sp9o7ibw.fsf@@eyesore.no>
17402 @end example
17403
17404 So ``my'' ident on this machine is @samp{x6}.  This can be
17405 exploited---the following rule will raise the score on all followups to
17406 myself:
17407
17408 @lisp
17409 ("references"
17410  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
17411   1000 nil r))
17412 @end lisp
17413
17414 Whether it's the first two or first three characters that are ``yours''
17415 is system-dependent.
17416
17417
17418 @node Scoring On Other Headers
17419 @section Scoring On Other Headers
17420 @cindex scoring on other headers
17421
17422 Gnus is quite fast when scoring the ``traditional''
17423 headers---@samp{From}, @samp{Subject} and so on.  However, scoring
17424 other headers requires writing a @code{head} scoring rule, which means
17425 that Gnus has to request every single article from the back end to find
17426 matches.  This takes a long time in big groups.
17427
17428 Now, there's not much you can do about this for news groups, but for
17429 mail groups, you have greater control.  In the @pxref{To From
17430 Newsgroups} section of the manual, it's explained in greater detail what
17431 this mechanism does, but here's a cookbook example for @code{nnml} on
17432 how to allow scoring on the @samp{To} and @samp{Cc} headers.
17433
17434 Put the following in your @file{.gnus.el} file. 
17435
17436 @lisp
17437 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
17438       nnmail-extra-headers gnus-extra-headers)
17439 @end lisp
17440
17441 Restart Gnus and rebuild your @code{nnml} overview files with the
17442 @kbd{M-x nnml-generate-nov-databases} command.  This will take a long
17443 time if you have much mail.
17444
17445 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
17446 so: @kbd{I e s p To RET <your name> RET}.
17447
17448 See?  Simple.
17449
17450
17451 @node Scoring Tips
17452 @section Scoring Tips
17453 @cindex scoring tips
17454
17455 @table @dfn
17456
17457 @item Crossposts
17458 @cindex crossposts
17459 @cindex scoring crossposts
17460 If you want to lower the score of crossposts, the line to match on is
17461 the @code{Xref} header.
17462 @lisp
17463 ("xref" (" talk.politics.misc:" -1000))
17464 @end lisp
17465
17466 @item Multiple crossposts
17467 If you want to lower the score of articles that have been crossposted to
17468 more than, say, 3 groups:
17469 @lisp
17470 ("xref"
17471   ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
17472    -1000 nil r))
17473 @end lisp
17474
17475 @item Matching on the body
17476 This is generally not a very good idea---it takes a very long time.
17477 Gnus actually has to fetch each individual article from the server.  But
17478 you might want to anyway, I guess.  Even though there are three match
17479 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
17480 and stick with it in each score file.  If you use any two, each article
17481 will be fetched @emph{twice}.  If you want to match a bit on the
17482 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
17483 the matches.
17484
17485 @item Marking as read
17486 You will probably want to mark articles that have scores below a certain
17487 number as read.  This is most easily achieved by putting the following
17488 in your @file{all.SCORE} file:
17489 @lisp
17490 ((mark -100))
17491 @end lisp
17492 You may also consider doing something similar with @code{expunge}.
17493
17494 @item Negated character classes
17495 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
17496 That will match newlines, which might lead to, well, The Unknown.  Say
17497 @code{[^abcd\n]*} instead.
17498 @end table
17499
17500
17501 @node Reverse Scoring
17502 @section Reverse Scoring
17503 @cindex reverse scoring
17504
17505 If you want to keep just articles that have @samp{Sex with Emacs} in the
17506 subject header, and expunge all other articles, you could put something
17507 like this in your score file:
17508
17509 @lisp
17510 (("subject"
17511   ("Sex with Emacs" 2))
17512  (mark 1)
17513  (expunge 1))
17514 @end lisp
17515
17516 So, you raise all articles that match @samp{Sex with Emacs} and mark the
17517 rest as read, and expunge them to boot.
17518
17519
17520 @node Global Score Files
17521 @section Global Score Files
17522 @cindex global score files
17523
17524 Sure, other newsreaders have ``global kill files''.  These are usually
17525 nothing more than a single kill file that applies to all groups, stored
17526 in the user's home directory.  Bah!  Puny, weak newsreaders!
17527
17528 What I'm talking about here are Global Score Files.  Score files from
17529 all over the world, from users everywhere, uniting all nations in one
17530 big, happy score file union!  Ange-score!  New and untested!
17531
17532 @vindex gnus-global-score-files
17533 All you have to do to use other people's score files is to set the
17534 @code{gnus-global-score-files} variable.  One entry for each score file,
17535 or each score file directory.  Gnus will decide by itself what score
17536 files are applicable to which group.
17537
17538 To use the score file
17539 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
17540 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
17541 say this:
17542
17543 @lisp
17544 (setq gnus-global-score-files
17545       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
17546         "/ftp@@ftp.some-where:/pub/score/"))
17547 @end lisp
17548
17549 @findex gnus-score-search-global-directories
17550 @noindent
17551 Simple, eh?  Directory names must end with a @samp{/}.  These
17552 directories are typically scanned only once during each Gnus session.
17553 If you feel the need to manually re-scan the remote directories, you can
17554 use the @code{gnus-score-search-global-directories} command.
17555
17556 Note that, at present, using this option will slow down group entry
17557 somewhat.  (That is---a lot.)
17558
17559 If you want to start maintaining score files for other people to use,
17560 just put your score file up for anonymous ftp and announce it to the
17561 world.  Become a retro-moderator!  Participate in the retro-moderator
17562 wars sure to ensue, where retro-moderators battle it out for the
17563 sympathy of the people, luring them to use their score files on false
17564 premises!  Yay!  The net is saved!
17565
17566 Here are some tips for the would-be retro-moderator, off the top of my
17567 head:
17568
17569 @itemize @bullet
17570
17571 @item
17572 Articles heavily crossposted are probably junk.
17573 @item
17574 To lower a single inappropriate article, lower by @code{Message-ID}.
17575 @item
17576 Particularly brilliant authors can be raised on a permanent basis.
17577 @item
17578 Authors that repeatedly post off-charter for the group can safely be
17579 lowered out of existence.
17580 @item
17581 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
17582 articles completely.
17583
17584 @item
17585 Use expiring score entries to keep the size of the file down.  You
17586 should probably have a long expiry period, though, as some sites keep
17587 old articles for a long time.
17588 @end itemize
17589
17590 ... I wonder whether other newsreaders will support global score files
17591 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
17592 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
17593 holding our breath yet?
17594
17595
17596 @node Kill Files
17597 @section Kill Files
17598 @cindex kill files
17599
17600 Gnus still supports those pesky old kill files.  In fact, the kill file
17601 entries can now be expiring, which is something I wrote before Daniel
17602 Quinlan thought of doing score files, so I've left the code in there.
17603
17604 In short, kill processing is a lot slower (and I do mean @emph{a lot})
17605 than score processing, so it might be a good idea to rewrite your kill
17606 files into score files.
17607
17608 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
17609 forms into this file, which means that you can use kill files as some
17610 sort of primitive hook function to be run on group entry, even though
17611 that isn't a very good idea.
17612
17613 Normal kill files look like this:
17614
17615 @lisp
17616 (gnus-kill "From" "Lars Ingebrigtsen")
17617 (gnus-kill "Subject" "ding")
17618 (gnus-expunge "X")
17619 @end lisp
17620
17621 This will mark every article written by me as read, and remove the
17622 marked articles from the summary buffer.  Very useful, you'll agree.
17623
17624 Other programs use a totally different kill file syntax.  If Gnus
17625 encounters what looks like a @code{rn} kill file, it will take a stab at
17626 interpreting it.
17627
17628 Two summary functions for editing a GNUS kill file:
17629
17630 @table @kbd
17631
17632 @item M-k
17633 @kindex M-k (Summary)
17634 @findex gnus-summary-edit-local-kill
17635 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
17636
17637 @item M-K
17638 @kindex M-K (Summary)
17639 @findex gnus-summary-edit-global-kill
17640 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
17641 @end table
17642
17643 Two group mode functions for editing the kill files:
17644
17645 @table @kbd
17646
17647 @item M-k
17648 @kindex M-k (Group)
17649 @findex gnus-group-edit-local-kill
17650 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
17651
17652 @item M-K
17653 @kindex M-K (Group)
17654 @findex gnus-group-edit-global-kill
17655 Edit the general kill file (@code{gnus-group-edit-global-kill}).
17656 @end table
17657
17658 Kill file variables:
17659
17660 @table @code
17661 @item gnus-kill-file-name
17662 @vindex gnus-kill-file-name
17663 A kill file for the group @samp{soc.motss} is normally called
17664 @file{soc.motss.KILL}.  The suffix appended to the group name to get
17665 this file name is detailed by the @code{gnus-kill-file-name} variable.
17666 The ``global'' kill file (not in the score file sense of ``global'', of
17667 course) is just called @file{KILL}.
17668
17669 @vindex gnus-kill-save-kill-file
17670 @item gnus-kill-save-kill-file
17671 If this variable is non-@code{nil}, Gnus will save the
17672 kill file after processing, which is necessary if you use expiring
17673 kills.
17674
17675 @item gnus-apply-kill-hook
17676 @vindex gnus-apply-kill-hook
17677 @findex gnus-apply-kill-file-unless-scored
17678 @findex gnus-apply-kill-file
17679 A hook called to apply kill files to a group.  It is
17680 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
17681 kill file if you have a score file for the same group, you can set this
17682 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
17683 kill files to be processed, you should set this variable to @code{nil}.
17684
17685 @item gnus-kill-file-mode-hook
17686 @vindex gnus-kill-file-mode-hook
17687 A hook called in kill-file mode buffers.
17688
17689 @end table
17690
17691
17692 @node Converting Kill Files
17693 @section Converting Kill Files
17694 @cindex kill files
17695 @cindex converting kill files
17696
17697 If you have loads of old kill files, you may want to convert them into
17698 score files.  If they are ``regular'', you can use
17699 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
17700 by hand.
17701
17702 The kill to score conversion package isn't included in Gnus by default.
17703 You can fetch it from
17704 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
17705
17706 If your old kill files are very complex---if they contain more
17707 non-@code{gnus-kill} forms than not, you'll have to convert them by
17708 hand.  Or just let them be as they are.  Gnus will still use them as
17709 before.
17710
17711
17712 @node GroupLens
17713 @section GroupLens
17714 @cindex GroupLens
17715
17716 GroupLens (@uref{http://www.cs.umn.edu/Research/GroupLens/}) is a
17717 collaborative filtering system that helps you work together with other
17718 people to find the quality news articles out of the huge volume of
17719 news articles generated every day.
17720
17721 To accomplish this the GroupLens system combines your opinions about
17722 articles you have already read with the opinions of others who have done
17723 likewise and gives you a personalized prediction for each unread news
17724 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
17725 rate articles, and finds other people that rate articles the same way.
17726 Once it has found some people you agree with it tells you, in the form
17727 of a prediction, what they thought of the article.  You can use this
17728 prediction to help you decide whether or not you want to read the
17729 article.
17730
17731 @sc{Note:} Unfortunately the GroupLens system seems to have shut down,
17732 so this section is mostly of historical interest.
17733
17734 @menu
17735 * Using GroupLens::             How to make Gnus use GroupLens.
17736 * Rating Articles::             Letting GroupLens know how you rate articles.
17737 * Displaying Predictions::      Displaying predictions given by GroupLens.
17738 * GroupLens Variables::         Customizing GroupLens.
17739 @end menu
17740
17741
17742 @node Using GroupLens
17743 @subsection Using GroupLens
17744
17745 To use GroupLens you must register a pseudonym with your local Better
17746 Bit Bureau (BBB).
17747 @uref{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
17748 better bit in town at the moment.
17749
17750 Once you have registered you'll need to set a couple of variables.
17751
17752 @table @code
17753
17754 @item gnus-use-grouplens
17755 @vindex gnus-use-grouplens
17756 Setting this variable to a non-@code{nil} value will make Gnus hook into
17757 all the relevant GroupLens functions.
17758
17759 @item grouplens-pseudonym
17760 @vindex grouplens-pseudonym
17761 This variable should be set to the pseudonym you got when registering
17762 with the Better Bit Bureau.
17763
17764 @item grouplens-newsgroups
17765 @vindex grouplens-newsgroups
17766 A list of groups that you want to get GroupLens predictions for.
17767
17768 @end table
17769
17770 That's the minimum of what you need to get up and running with GroupLens.
17771 Once you've registered, GroupLens will start giving you scores for
17772 articles based on the average of what other people think.  But, to get
17773 the real benefit of GroupLens you need to start rating articles
17774 yourself.  Then the scores GroupLens gives you will be personalized for
17775 you, based on how the people you usually agree with have already rated.
17776
17777
17778 @node Rating Articles
17779 @subsection Rating Articles
17780
17781 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
17782 Where 1 means something like this article is a waste of bandwidth and 5
17783 means that the article was really good.  The basic question to ask
17784 yourself is, "on a scale from 1 to 5 would I like to see more articles
17785 like this one?"
17786
17787 There are four ways to enter a rating for an article in GroupLens.
17788
17789 @table @kbd
17790
17791 @item r
17792 @kindex r (GroupLens)
17793 @findex bbb-summary-rate-article
17794 This function will prompt you for a rating on a scale of one to five.
17795
17796 @item k
17797 @kindex k (GroupLens)
17798 @findex grouplens-score-thread
17799 This function will prompt you for a rating, and rate all the articles in
17800 the thread.  This is really useful for some of those long running giant
17801 threads in rec.humor.
17802
17803 @end table
17804
17805 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
17806 the score of the article you're reading.
17807
17808 @table @kbd
17809
17810 @item 1-5 n
17811 @kindex n (GroupLens)
17812 @findex grouplens-next-unread-article
17813 Rate the article and go to the next unread article.
17814
17815 @item 1-5 ,
17816 @kindex , (GroupLens)
17817 @findex grouplens-best-unread-article
17818 Rate the article and go to the next unread article with the highest score.
17819
17820 @end table
17821
17822 If you want to give the current article a score of 4 and then go to the
17823 next article, just type @kbd{4 n}.
17824
17825
17826 @node Displaying Predictions
17827 @subsection Displaying Predictions
17828
17829 GroupLens makes a prediction for you about how much you will like a
17830 news article.  The predictions from GroupLens are on a scale from 1 to
17831 5, where 1 is the worst and 5 is the best.  You can use the predictions
17832 from GroupLens in one of three ways controlled by the variable
17833 @code{gnus-grouplens-override-scoring}.
17834
17835 @vindex gnus-grouplens-override-scoring
17836 There are three ways to display predictions in grouplens.  You may
17837 choose to have the GroupLens scores contribute to, or override the
17838 regular gnus scoring mechanism.  override is the default; however, some
17839 people prefer to see the Gnus scores plus the grouplens scores.  To get
17840 the separate scoring behavior you need to set
17841 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
17842 GroupLens predictions combined with the grouplens scores set it to
17843 @code{'override} and to combine the scores set
17844 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
17845 the combine option you will also want to set the values for
17846 @code{grouplens-prediction-offset} and
17847 @code{grouplens-score-scale-factor}.
17848
17849 @vindex grouplens-prediction-display
17850 In either case, GroupLens gives you a few choices for how you would like
17851 to see your predictions displayed.  The display of predictions is
17852 controlled by the @code{grouplens-prediction-display} variable.
17853
17854 The following are valid values for that variable.
17855
17856 @table @code
17857 @item prediction-spot
17858 The higher the prediction, the further to the right an @samp{*} is
17859 displayed.
17860
17861 @item confidence-interval
17862 A numeric confidence interval.
17863
17864 @item prediction-bar
17865 The higher the prediction, the longer the bar.
17866
17867 @item confidence-bar
17868 Numerical confidence.
17869
17870 @item confidence-spot
17871 The spot gets bigger with more confidence.
17872
17873 @item prediction-num
17874 Plain-old numeric value.
17875
17876 @item confidence-plus-minus
17877 Prediction +/- confidence.
17878
17879 @end table
17880
17881
17882 @node GroupLens Variables
17883 @subsection GroupLens Variables
17884
17885 @table @code
17886
17887 @item gnus-summary-grouplens-line-format
17888 The summary line format used in GroupLens-enhanced summary buffers.  It
17889 accepts the same specs as the normal summary line format (@pxref{Summary
17890 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-23,23n%]%)
17891 %s\n}.
17892
17893 @item grouplens-bbb-host
17894 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
17895 default.
17896
17897 @item grouplens-bbb-port
17898 Port of the host running the bbbd server.  The default is 9000.
17899
17900 @item grouplens-score-offset
17901 Offset the prediction by this value.  In other words, subtract the
17902 prediction value by this number to arrive at the effective score.  The
17903 default is 0.
17904
17905 @item grouplens-score-scale-factor
17906 This variable allows the user to magnify the effect of GroupLens scores.
17907 The scale factor is applied after the offset.  The default is 1.
17908
17909 @end table
17910
17911
17912 @node Advanced Scoring
17913 @section Advanced Scoring
17914
17915 Scoring on Subjects and From headers is nice enough, but what if you're
17916 really interested in what a person has to say only when she's talking
17917 about a particular subject?  Or what if you really don't want to
17918 read what person A has to say when she's following up to person B, but
17919 want to read what she says when she's following up to person C?
17920
17921 By using advanced scoring rules you may create arbitrarily complex
17922 scoring patterns.
17923
17924 @menu
17925 * Advanced Scoring Syntax::     A definition.
17926 * Advanced Scoring Examples::   What they look like.
17927 * Advanced Scoring Tips::       Getting the most out of it.
17928 @end menu
17929
17930
17931 @node Advanced Scoring Syntax
17932 @subsection Advanced Scoring Syntax
17933
17934 Ordinary scoring rules have a string as the first element in the rule.
17935 Advanced scoring rules have a list as the first element.  The second
17936 element is the score to be applied if the first element evaluated to a
17937 non-@code{nil} value.
17938
17939 These lists may consist of three logical operators, one redirection
17940 operator, and various match operators.
17941
17942 Logical operators:
17943
17944 @table @code
17945 @item &
17946 @itemx and
17947 This logical operator will evaluate each of its arguments until it finds
17948 one that evaluates to @code{false}, and then it'll stop.  If all arguments
17949 evaluate to @code{true} values, then this operator will return
17950 @code{true}.
17951
17952 @item |
17953 @itemx or
17954 This logical operator will evaluate each of its arguments until it finds
17955 one that evaluates to @code{true}.  If no arguments are @code{true},
17956 then this operator will return @code{false}.
17957
17958 @item !
17959 @itemx not
17960 @itemx Â¬
17961 This logical operator only takes a single argument.  It returns the
17962 logical negation of the value of its argument.
17963
17964 @end table
17965
17966 There is an @dfn{indirection operator} that will make its arguments
17967 apply to the ancestors of the current article being scored.  For
17968 instance, @code{1-} will make score rules apply to the parent of the
17969 current article.  @code{2-} will make score rules apply to the
17970 grandparent of the current article.  Alternatively, you can write
17971 @code{^^}, where the number of @code{^}s (carets) says how far back into
17972 the ancestry you want to go.
17973
17974 Finally, we have the match operators.  These are the ones that do the
17975 real work.  Match operators are header name strings followed by a match
17976 and a match type.  A typical match operator looks like @samp{("from"
17977 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
17978 simple scoring, and the match types are also the same.
17979
17980
17981 @node Advanced Scoring Examples
17982 @subsection Advanced Scoring Examples
17983
17984 Please note that the following examples are score file rules.  To
17985 make a complete score file from them, surround them with another pair
17986 of parentheses.
17987
17988 Let's say you want to increase the score of articles written by Lars
17989 when he's talking about Gnus:
17990
17991 @example
17992 ((&
17993   ("from" "Lars Ingebrigtsen")
17994   ("subject" "Gnus"))
17995  1000)
17996 @end example
17997
17998 Quite simple, huh?
17999
18000 When he writes long articles, he sometimes has something nice to say:
18001
18002 @example
18003 ((&
18004   ("from" "Lars Ingebrigtsen")
18005   (|
18006    ("subject" "Gnus")
18007    ("lines" 100 >)))
18008  1000)
18009 @end example
18010
18011 However, when he responds to things written by Reig Eigil Logge, you
18012 really don't want to read what he's written:
18013
18014 @example
18015 ((&
18016   ("from" "Lars Ingebrigtsen")
18017   (1- ("from" "Reig Eigir Logge")))
18018  -100000)
18019 @end example
18020
18021 Everybody that follows up Redmondo when he writes about disappearing
18022 socks should have their scores raised, but only when they talk about
18023 white socks.  However, when Lars talks about socks, it's usually not
18024 very interesting:
18025
18026 @example
18027 ((&
18028   (1-
18029    (&
18030     ("from" "redmondo@@.*no" r)
18031     ("body" "disappearing.*socks" t)))
18032   (! ("from" "Lars Ingebrigtsen"))
18033   ("body" "white.*socks"))
18034  1000)
18035 @end example
18036
18037 The possibilities are endless.
18038
18039
18040 @node Advanced Scoring Tips
18041 @subsection Advanced Scoring Tips
18042
18043 The @code{&} and @code{|} logical operators do short-circuit logic.
18044 That is, they stop processing their arguments when it's clear what the
18045 result of the operation will be.  For instance, if one of the arguments
18046 of an @code{&} evaluates to @code{false}, there's no point in evaluating
18047 the rest of the arguments.  This means that you should put slow matches
18048 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
18049 @samp{subject}) first.
18050
18051 The indirection arguments (@code{1-} and so on) will make their
18052 arguments work on previous generations of the thread.  If you say
18053 something like:
18054
18055 @example
18056 ...
18057 (1-
18058  (1-
18059   ("from" "lars")))
18060 ...
18061 @end example
18062
18063 Then that means "score on the from header of the grandparent of the
18064 current article".  An indirection is quite fast, but it's better to say:
18065
18066 @example
18067 (1-
18068  (&
18069   ("from" "Lars")
18070   ("subject" "Gnus")))
18071 @end example
18072
18073 than it is to say:
18074
18075 @example
18076 (&
18077  (1- ("from" "Lars"))
18078  (1- ("subject" "Gnus")))
18079 @end example
18080
18081
18082 @node Score Decays
18083 @section Score Decays
18084 @cindex score decays
18085 @cindex decays
18086
18087 You may find that your scores have a tendency to grow without
18088 bounds, especially if you're using adaptive scoring.  If scores get too
18089 big, they lose all meaning---they simply max out and it's difficult to
18090 use them in any sensible way.
18091
18092 @vindex gnus-decay-scores
18093 @findex gnus-decay-score
18094 @vindex gnus-decay-score-function
18095 Gnus provides a mechanism for decaying scores to help with this problem.
18096 When score files are loaded and @code{gnus-decay-scores} is
18097 non-@code{nil}, Gnus will run the score files through the decaying
18098 mechanism thereby lowering the scores of all non-permanent score rules.
18099 The decay itself if performed by the @code{gnus-decay-score-function}
18100 function, which is @code{gnus-decay-score} by default.  Here's the
18101 definition of that function:
18102
18103 @lisp
18104 (defun gnus-decay-score (score)
18105   "Decay SCORE.
18106 This is done according to `gnus-score-decay-constant'
18107 and `gnus-score-decay-scale'."
18108   (floor
18109    (- score
18110       (* (if (< score 0) 1 -1)
18111          (min (abs score)
18112               (max gnus-score-decay-constant
18113                    (* (abs score)
18114                       gnus-score-decay-scale)))))))
18115 @end lisp
18116
18117 @vindex gnus-score-decay-scale
18118 @vindex gnus-score-decay-constant
18119 @code{gnus-score-decay-constant} is 3 by default and
18120 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
18121
18122 @enumerate
18123 @item
18124 Scores between -3 and 3 will be set to 0 when this function is called.
18125
18126 @item
18127 Scores with magnitudes between 3 and 60 will be shrunk by 3.
18128
18129 @item
18130 Scores with magnitudes greater than 60 will be shrunk by 5% of the
18131 score.
18132 @end enumerate
18133
18134 If you don't like this decay function, write your own.  It is called
18135 with the score to be decayed as its only parameter, and it should return
18136 the new score, which should be an integer.
18137
18138 Gnus will try to decay scores once a day.  If you haven't run Gnus for
18139 four days, Gnus will decay the scores four times, for instance.
18140
18141 @iftex
18142 @iflatex
18143 @chapter Message
18144 @include message.texi
18145 @chapter Emacs MIME
18146 @include emacs-mime.texi
18147 @chapter Sieve
18148 @include sieve.texi
18149 @end iflatex
18150 @end iftex
18151
18152 @node Various
18153 @chapter Various
18154
18155 @menu
18156 * Process/Prefix::              A convention used by many treatment commands.
18157 * Interactive::                 Making Gnus ask you many questions.
18158 * Symbolic Prefixes::           How to supply some Gnus functions with options.
18159 * Formatting Variables::        You can specify what buffers should look like.
18160 * Window Layout::               Configuring the Gnus buffer windows.
18161 * Faces and Fonts::             How to change how faces look.
18162 * Compilation::                 How to speed Gnus up.
18163 * Mode Lines::                  Displaying information in the mode lines.
18164 * Highlighting and Menus::      Making buffers look all nice and cozy.
18165 * Buttons::                     Get tendinitis in ten easy steps!
18166 * Daemons::                     Gnus can do things behind your back.
18167 * NoCeM::                       How to avoid spam and other fatty foods.
18168 * Undo::                        Some actions can be undone.
18169 * Moderation::                  What to do if you're a moderator.
18170 * XEmacs Enhancements::         There are more pictures and stuff under XEmacs.
18171 * Fuzzy Matching::              What's the big fuzz?
18172 * Thwarting Email Spam::        A how-to on avoiding unsolicited commercial email.
18173 * Various Various::             Things that are really various.
18174 @end menu
18175
18176
18177 @node Process/Prefix
18178 @section Process/Prefix
18179 @cindex process/prefix convention
18180
18181 Many functions, among them functions for moving, decoding and saving
18182 articles, use what is known as the @dfn{Process/Prefix convention}.
18183
18184 This is a method for figuring out what articles the user wants the
18185 command to be performed on.
18186
18187 It goes like this:
18188
18189 If the numeric prefix is N, perform the operation on the next N
18190 articles, starting with the current one.  If the numeric prefix is
18191 negative, perform the operation on the previous N articles, starting
18192 with the current one.
18193
18194 @vindex transient-mark-mode
18195 If @code{transient-mark-mode} in non-@code{nil} and the region is
18196 active, all articles in the region will be worked upon.
18197
18198 If there is no numeric prefix, but some articles are marked with the
18199 process mark, perform the operation on the articles marked with
18200 the process mark.
18201
18202 If there is neither a numeric prefix nor any articles marked with the
18203 process mark, just perform the operation on the current article.
18204
18205 Quite simple, really, but it needs to be made clear so that surprises
18206 are avoided.
18207
18208 Commands that react to the process mark will push the current list of
18209 process marked articles onto a stack and will then clear all process
18210 marked articles.  You can restore the previous configuration with the
18211 @kbd{M P y} command (@pxref{Setting Process Marks}).
18212
18213 @vindex gnus-summary-goto-unread
18214 One thing that seems to shock & horrify lots of people is that, for
18215 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
18216 Since each @kbd{d} (which marks the current article as read) by default
18217 goes to the next unread article after marking, this means that @kbd{3 d}
18218 will mark the next three unread articles as read, no matter what the
18219 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
18220 @code{nil} for a more straightforward action.
18221
18222 Many commands do not use the process/prefix convention.  All commands
18223 that do explicitly say so in this manual.  To apply the process/prefix
18224 convention to commands that do not use it, you can use the @kbd{M-&}
18225 command.  For instance, to mark all the articles in the group as
18226 expirable, you could say `M P b M-& E'.
18227
18228
18229 @node Interactive
18230 @section Interactive
18231 @cindex interaction
18232
18233 @table @code
18234
18235 @item gnus-novice-user
18236 @vindex gnus-novice-user
18237 If this variable is non-@code{nil}, you are either a newcomer to the
18238 World of Usenet, or you are very cautious, which is a nice thing to be,
18239 really.  You will be given questions of the type ``Are you sure you want
18240 to do this?'' before doing anything dangerous.  This is @code{t} by
18241 default.
18242
18243 @item gnus-expert-user
18244 @vindex gnus-expert-user
18245 If this variable is non-@code{nil}, you will seldom be asked any
18246 questions by Gnus.  It will simply assume you know what you're doing, no
18247 matter how strange.
18248
18249 @item gnus-interactive-catchup
18250 @vindex gnus-interactive-catchup
18251 Require confirmation before catching up a group if non-@code{nil}.  It
18252 is @code{t} by default.
18253
18254 @item gnus-interactive-exit
18255 @vindex gnus-interactive-exit
18256 Require confirmation before exiting Gnus.  This variable is @code{t} by
18257 default.
18258 @end table
18259
18260
18261 @node Symbolic Prefixes
18262 @section Symbolic Prefixes
18263 @cindex symbolic prefixes
18264
18265 Quite a lot of Emacs commands react to the (numeric) prefix.  For
18266 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
18267 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
18268 rule of 900 to the current article.
18269
18270 This is all nice and well, but what if you want to give a command some
18271 additional information?  Well, what most commands do is interpret the
18272 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
18273 doesn't want a backup file to be created when saving the current buffer,
18274 for instance.  But what if you want to save without making a backup
18275 file, and you want Emacs to flash lights and play a nice tune at the
18276 same time?  You can't, and you're probably perfectly happy that way.
18277
18278 @kindex M-i (Summary)
18279 @findex gnus-symbolic-argument
18280 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
18281 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
18282 character typed in is the value.  You can stack as many @kbd{M-i}
18283 prefixes as you want.  @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
18284 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b C-M-u} means
18285 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
18286 @code{b}''.  You get the drift.
18287
18288 Typing in symbolic prefixes to commands that don't accept them doesn't
18289 hurt, but it doesn't do any good either.  Currently not many Gnus
18290 functions make use of the symbolic prefix.
18291
18292 If you're interested in how Gnus implements this, @pxref{Extended
18293 Interactive}.
18294
18295
18296 @node Formatting Variables
18297 @section Formatting Variables
18298 @cindex formatting variables
18299
18300 Throughout this manual you've probably noticed lots of variables called
18301 things like @code{gnus-group-line-format} and
18302 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
18303 output lines in the various buffers.  There's quite a lot of them.
18304 Fortunately, they all use the same syntax, so there's not that much to
18305 be annoyed by.
18306
18307 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
18308 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
18309 lots of percentages everywhere.
18310
18311 @menu
18312 * Formatting Basics::           A formatting variable is basically a format string.
18313 * Mode Line Formatting::        Some rules about mode line formatting variables.
18314 * Advanced Formatting::         Modifying output in various ways.
18315 * User-Defined Specs::          Having Gnus call your own functions.
18316 * Formatting Fonts::            Making the formatting look colorful and nice.
18317 * Positioning Point::           Moving point to a position after an operation.
18318 * Tabulation::                  Tabulating your output.
18319 * Wide Characters::             Dealing with wide characters.
18320 @end menu
18321
18322 Currently Gnus uses the following formatting variables:
18323 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
18324 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
18325 @code{gnus-group-mode-line-format},
18326 @code{gnus-summary-mode-line-format},
18327 @code{gnus-article-mode-line-format},
18328 @code{gnus-server-mode-line-format}, and
18329 @code{gnus-summary-pick-line-format}.
18330
18331 All these format variables can also be arbitrary elisp forms.  In that
18332 case, they will be @code{eval}ed to insert the required lines.
18333
18334 @kindex M-x gnus-update-format
18335 @findex gnus-update-format
18336 Gnus includes a command to help you while creating your own format
18337 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
18338 update the spec in question and pop you to a buffer where you can
18339 examine the resulting lisp code to be run to generate the line.
18340
18341
18342
18343 @node Formatting Basics
18344 @subsection Formatting Basics
18345
18346 Each @samp{%} element will be replaced by some string or other when the
18347 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
18348 spec, and pad with spaces to get a 5-character field''.
18349
18350 As with normal C and Emacs Lisp formatting strings, the numerical
18351 modifier between the @samp{%} and the formatting type character will
18352 @dfn{pad} the output so that it is always at least that long.
18353 @samp{%5y} will make the field always (at least) five characters wide by
18354 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
18355 the right instead.
18356
18357 You may also wish to limit the length of the field to protect against
18358 particularly wide values.  For that you can say @samp{%4,6y}, which
18359 means that the field will never be more than 6 characters wide and never
18360 less than 4 characters wide.
18361
18362 Also Gnus supports some extended format specifications, such as
18363 @samp{%&user-date;}.
18364
18365 @node Mode Line Formatting
18366 @subsection Mode Line Formatting
18367
18368 Mode line formatting variables (e.g.,
18369 @code{gnus-summary-mode-line-format}) follow the same rules as other,
18370 buffer line oriented formatting variables (@pxref{Formatting Basics})
18371 with the following two differences:
18372
18373 @enumerate
18374
18375 @item
18376 There must be no newline (@samp{\n}) at the end.
18377
18378 @item
18379 The special @samp{%%b} spec can be used to display the buffer name.
18380 Well, it's no spec at all, really---@samp{%%} is just a way to quote
18381 @samp{%} to allow it to pass through the formatting machinery unmangled,
18382 so that Emacs receives @samp{%b}, which is something the Emacs mode line
18383 display interprets to mean ``show the buffer name''.  For a full list of
18384 mode line specs Emacs understands, see the documentation of the
18385 @code{mode-line-format} variable.
18386
18387 @end enumerate
18388
18389
18390 @node Advanced Formatting
18391 @subsection Advanced Formatting
18392
18393 It is frequently useful to post-process the fields in some way.
18394 Padding, limiting, cutting off parts and suppressing certain values can
18395 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
18396 look like @samp{%~(cut 3)~(ignore "0")y}.
18397
18398 These are the valid modifiers:
18399
18400 @table @code
18401 @item pad
18402 @itemx pad-left
18403 Pad the field to the left with spaces until it reaches the required
18404 length.
18405
18406 @item pad-right
18407 Pad the field to the right with spaces until it reaches the required
18408 length.
18409
18410 @item max
18411 @itemx max-left
18412 Cut off characters from the left until it reaches the specified length.
18413
18414 @item max-right
18415 Cut off characters from the right until it reaches the specified
18416 length.
18417
18418 @item cut
18419 @itemx cut-left
18420 Cut off the specified number of characters from the left.
18421
18422 @item cut-right
18423 Cut off the specified number of characters from the right.
18424
18425 @item ignore
18426 Return an empty string if the field is equal to the specified value.
18427
18428 @item form
18429 Use the specified form as the field value when the @samp{@@} spec is
18430 used.
18431 @end table
18432
18433 Let's take an example.  The @samp{%o} spec in the summary mode lines
18434 will return a date in compact ISO8601 format---@samp{19960809T230410}.
18435 This is quite a mouthful, so we want to shave off the century number and
18436 the time, leaving us with a six-character date.  That would be
18437 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
18438 maxing, and we need the padding to ensure that the date is never less
18439 than 6 characters to make it look nice in columns.)
18440
18441 Ignoring is done first; then cutting; then maxing; and then as the very
18442 last operation, padding.
18443
18444 @vindex gnus-compile-user-specs
18445 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
18446 default) with your strong personality, and use a lots of these advanced
18447 thingies, you'll find that Gnus gets quite slow.  This can be helped
18448 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
18449 the look of your lines.
18450 @xref{Compilation}.
18451
18452
18453 @node User-Defined Specs
18454 @subsection User-Defined Specs
18455
18456 All the specs allow for inserting user defined specifiers---@samp{u}.
18457 The next character in the format string should be a letter.  Gnus
18458 will call the function @code{gnus-user-format-function-}@samp{X}, where
18459 @samp{X} is the letter following @samp{%u}.  The function will be passed
18460 a single parameter---what the parameter means depends on what buffer
18461 it's being called from.  The function should return a string, which will
18462 be inserted into the buffer just like information from any other
18463 specifier.  This function may also be called with dummy values, so it
18464 should protect against that.
18465
18466 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
18467 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
18468
18469 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
18470 much the same without defining new functions.  Here's an example:
18471 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
18472 given here will be evaluated to yield the current line number, and then
18473 inserted.
18474
18475
18476 @node Formatting Fonts
18477 @subsection Formatting Fonts
18478
18479 There are specs for highlighting, and these are shared by all the format
18480 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
18481 the special @code{mouse-face} property set, which means that it will be
18482 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
18483 over it.
18484
18485 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
18486 normal faces set using @code{gnus-face-0}, which is @code{bold} by
18487 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
18488 and so on.  Create as many faces as you wish.  The same goes for the
18489 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
18490 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
18491
18492 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
18493 @code{balloon-help} property set to @code{gnus-balloon-face-0}.  If you
18494 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on.  The
18495 @code{gnus-balloon-face-*} variables should be either strings or symbols
18496 naming functions that return a string.  Under @code{balloon-help-mode},
18497 when the mouse passes over text with this property set, a balloon window
18498 will appear and display the string.  Please refer to the doc string of
18499 @code{balloon-help-mode} for more information on this.
18500
18501 Here's an alternative recipe for the group buffer:
18502
18503 @lisp
18504 ;; Create three face types.
18505 (setq gnus-face-1 'bold)
18506 (setq gnus-face-3 'italic)
18507
18508 ;; We want the article count to be in
18509 ;; a bold and green face.  So we create
18510 ;; a new face called `my-green-bold'.
18511 (copy-face 'bold 'my-green-bold)
18512 ;; Set the color.
18513 (set-face-foreground 'my-green-bold "ForestGreen")
18514 (setq gnus-face-2 'my-green-bold)
18515
18516 ;; Set the new & fancy format.
18517 (setq gnus-group-line-format
18518       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
18519 @end lisp
18520
18521 I'm sure you'll be able to use this scheme to create totally unreadable
18522 and extremely vulgar displays.  Have fun!
18523
18524 Note that the @samp{%(} specs (and friends) do not make any sense on the
18525 mode-line variables.
18526
18527 @node Positioning Point
18528 @subsection Positioning Point
18529
18530 Gnus usually moves point to a pre-defined place on each line in most
18531 buffers.  By default, point move to the first colon character on the
18532 line.  You can customize this behaviour in three different ways.
18533
18534 You can move the colon character to somewhere else on the line.
18535
18536 @findex gnus-goto-colon
18537 You can redefine the function that moves the point to the colon.  The
18538 function is called @code{gnus-goto-colon}.
18539
18540 But perhaps the most convenient way to deal with this, if you don't want
18541 to have a colon in your line, is to use the @samp{%C} specifier.  If you
18542 put a @samp{%C} somewhere in your format line definition, Gnus will
18543 place point there.
18544
18545
18546 @node Tabulation
18547 @subsection Tabulation
18548
18549 You can usually line up your displays by padding and cutting your
18550 strings.  However, when combining various strings of different size, it
18551 can often be more convenient to just output the strings, and then worry
18552 about lining up the following text afterwards.
18553
18554 To do that, Gnus supplies tabulator specs--@samp{%=}.  There are two
18555 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
18556
18557 @samp{%50=} will insert space characters to pad the line up to column
18558 50.  If the text is already past column 50, nothing will be inserted.
18559 This is the soft tabulator.
18560
18561 @samp{%-50=} will insert space characters to pad the line up to column
18562 50.  If the text is already past column 50, the excess text past column
18563 50 will be removed.  This is the hard tabulator.
18564
18565
18566 @node Wide Characters
18567 @subsection Wide Characters
18568
18569 Proportional fonts in most countries have characters of the same width.
18570 Some countries, however, use Latin characters mixed with wider
18571 characters---most notable East Asian countries.
18572
18573 The problem is that when formatting, Gnus assumes that if a string is 10
18574 characters wide, it'll be 10 Latin characters wide on the screen.  In
18575 these coutries, that's not true.
18576
18577 @vindex gnus-use-correct-string-widths
18578 To help fix this, you can set @code{gnus-use-correct-string-widths} to
18579 @code{t}.  This makes buffer generation slower, but the results will be
18580 prettieer.  The default value is @code{t}.
18581
18582
18583
18584 @node Window Layout
18585 @section Window Layout
18586 @cindex window layout
18587
18588 No, there's nothing here about X, so be quiet.
18589
18590 @vindex gnus-use-full-window
18591 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
18592 other windows and occupy the entire Emacs screen by itself.  It is
18593 @code{t} by default.
18594
18595 Setting this variable to @code{nil} kinda works, but there are
18596 glitches.  Use at your own peril.
18597
18598 @vindex gnus-buffer-configuration
18599 @code{gnus-buffer-configuration} describes how much space each Gnus
18600 buffer should be given.  Here's an excerpt of this variable:
18601
18602 @lisp
18603 ((group (vertical 1.0 (group 1.0 point)
18604                       (if gnus-carpal (group-carpal 4))))
18605  (article (vertical 1.0 (summary 0.25 point)
18606                         (article 1.0))))
18607 @end lisp
18608
18609 This is an alist.  The @dfn{key} is a symbol that names some action or
18610 other.  For instance, when displaying the group buffer, the window
18611 configuration function will use @code{group} as the key.  A full list of
18612 possible names is listed below.
18613
18614 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
18615 should occupy.  To take the @code{article} split as an example -
18616
18617 @lisp
18618 (article (vertical 1.0 (summary 0.25 point)
18619                        (article 1.0)))
18620 @end lisp
18621
18622 This @dfn{split} says that the summary buffer should occupy 25% of upper
18623 half of the screen, and that it is placed over the article buffer.  As
18624 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
18625 reaching for that calculator there).  However, the special number
18626 @code{1.0} is used to signal that this buffer should soak up all the
18627 rest of the space available after the rest of the buffers have taken
18628 whatever they need.  There should be only one buffer with the @code{1.0}
18629 size spec per split.
18630
18631 Point will be put in the buffer that has the optional third element
18632 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
18633 split where the tag @code{frame-focus} is a member (i.e. is the third or
18634 fourth element in the list, depending on whether the @code{point} tag is
18635 present) gets focus.
18636
18637 Here's a more complicated example:
18638
18639 @lisp
18640 (article (vertical 1.0 (group 4)
18641                        (summary 0.25 point)
18642                        (if gnus-carpal (summary-carpal 4))
18643                        (article 1.0)))
18644 @end lisp
18645
18646 If the size spec is an integer instead of a floating point number,
18647 then that number will be used to say how many lines a buffer should
18648 occupy, not a percentage.
18649
18650 If the @dfn{split} looks like something that can be @code{eval}ed (to be
18651 precise---if the @code{car} of the split is a function or a subr), this
18652 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
18653 be used as a split.  This means that there will be three buffers if
18654 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
18655 is non-@code{nil}.
18656
18657 Not complicated enough for you?  Well, try this on for size:
18658
18659 @lisp
18660 (article (horizontal 1.0
18661              (vertical 0.5
18662                  (group 1.0)
18663                  (gnus-carpal 4))
18664              (vertical 1.0
18665                  (summary 0.25 point)
18666                  (summary-carpal 4)
18667                  (article 1.0))))
18668 @end lisp
18669
18670 Whoops.  Two buffers with the mystery 100% tag.  And what's that
18671 @code{horizontal} thingie?
18672
18673 If the first element in one of the split is @code{horizontal}, Gnus will
18674 split the window horizontally, giving you two windows side-by-side.
18675 Inside each of these strips you may carry on all you like in the normal
18676 fashion.  The number following @code{horizontal} says what percentage of
18677 the screen is to be given to this strip.
18678
18679 For each split, there @emph{must} be one element that has the 100% tag.
18680 The splitting is never accurate, and this buffer will eat any leftover
18681 lines from the splits.
18682
18683 To be slightly more formal, here's a definition of what a valid split
18684 may look like:
18685
18686 @example
18687 split      = frame | horizontal | vertical | buffer | form
18688 frame      = "(frame " size *split ")"
18689 horizontal = "(horizontal " size *split ")"
18690 vertical   = "(vertical " size *split ")"
18691 buffer     = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
18692 size       = number | frame-params
18693 buf-name   = group | article | summary ...
18694 @end example
18695
18696 The limitations are that the @code{frame} split can only appear as the
18697 top-level split.  @var{form} should be an Emacs Lisp form that should
18698 return a valid split.  We see that each split is fully recursive, and
18699 may contain any number of @code{vertical} and @code{horizontal} splits.
18700
18701 @vindex gnus-window-min-width
18702 @vindex gnus-window-min-height
18703 @cindex window height
18704 @cindex window width
18705 Finding the right sizes can be a bit complicated.  No window may be less
18706 than @code{gnus-window-min-height} (default 1) characters high, and all
18707 windows must be at least @code{gnus-window-min-width} (default 1)
18708 characters wide.  Gnus will try to enforce this before applying the
18709 splits.  If you want to use the normal Emacs window width/height limit,
18710 you can just set these two variables to @code{nil}.
18711
18712 If you're not familiar with Emacs terminology, @code{horizontal} and
18713 @code{vertical} splits may work the opposite way of what you'd expect.
18714 Windows inside a @code{horizontal} split are shown side-by-side, and
18715 windows within a @code{vertical} split are shown above each other.
18716
18717 @findex gnus-configure-frame
18718 If you want to experiment with window placement, a good tip is to call
18719 @code{gnus-configure-frame} directly with a split.  This is the function
18720 that does all the real work when splitting buffers.  Below is a pretty
18721 nonsensical configuration with 5 windows; two for the group buffer and
18722 three for the article buffer.  (I said it was nonsensical.)  If you
18723 @code{eval} the statement below, you can get an idea of how that would
18724 look straight away, without going through the normal Gnus channels.
18725 Play with it until you're satisfied, and then use
18726 @code{gnus-add-configuration} to add your new creation to the buffer
18727 configuration list.
18728
18729 @lisp
18730 (gnus-configure-frame
18731  '(horizontal 1.0
18732     (vertical 10
18733       (group 1.0)
18734       (article 0.3 point))
18735     (vertical 1.0
18736       (article 1.0)
18737       (horizontal 4
18738         (group 1.0)
18739         (article 10)))))
18740 @end lisp
18741
18742 You might want to have several frames as well.  No prob---just use the
18743 @code{frame} split:
18744
18745 @lisp
18746 (gnus-configure-frame
18747  '(frame 1.0
18748          (vertical 1.0
18749                    (summary 0.25 point frame-focus)
18750                    (article 1.0))
18751          (vertical ((height . 5) (width . 15)
18752                     (user-position . t)
18753                     (left . -1) (top . 1))
18754                    (picon 1.0))))
18755
18756 @end lisp
18757
18758 This split will result in the familiar summary/article window
18759 configuration in the first (or ``main'') frame, while a small additional
18760 frame will be created where picons will be shown.  As you can see,
18761 instead of the normal @code{1.0} top-level spec, each additional split
18762 should have a frame parameter alist as the size spec.
18763 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
18764 Reference Manual}.  Under XEmacs, a frame property list will be
18765 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
18766 is such a plist.
18767 The list of all possible keys for @code{gnus-buffer-configuration} can
18768 be found in its default value.
18769
18770 Note that the @code{message} key is used for both
18771 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
18772 it is desirable to distinguish between the two, something like this
18773 might be used:
18774
18775 @lisp
18776 (message (horizontal 1.0
18777                      (vertical 1.0 (message 1.0 point))
18778                      (vertical 0.24
18779                                (if (buffer-live-p gnus-summary-buffer)
18780                                    '(summary 0.5))
18781                                (group 1.0)))))
18782 @end lisp
18783
18784 One common desire for a multiple frame split is to have a separate frame
18785 for composing mail and news while leaving the original frame intact.  To
18786 accomplish that, something like the following can be done:
18787
18788 @lisp
18789 (message
18790   (frame 1.0
18791          (if (not (buffer-live-p gnus-summary-buffer))
18792              (car (cdr (assoc 'group gnus-buffer-configuration)))
18793            (car (cdr (assoc 'summary gnus-buffer-configuration))))
18794          (vertical ((user-position . t) (top . 1) (left . 1)
18795                     (name . "Message"))
18796                    (message 1.0 point))))
18797 @end lisp
18798
18799 @findex gnus-add-configuration
18800 Since the @code{gnus-buffer-configuration} variable is so long and
18801 complicated, there's a function you can use to ease changing the config
18802 of a single setting: @code{gnus-add-configuration}.  If, for instance,
18803 you want to change the @code{article} setting, you could say:
18804
18805 @lisp
18806 (gnus-add-configuration
18807  '(article (vertical 1.0
18808                (group 4)
18809                (summary .25 point)
18810                (article 1.0))))
18811 @end lisp
18812
18813 You'd typically stick these @code{gnus-add-configuration} calls in your
18814 @file{.gnus.el} file or in some startup hook---they should be run after
18815 Gnus has been loaded.
18816
18817 @vindex gnus-always-force-window-configuration
18818 If all windows mentioned in the configuration are already visible, Gnus
18819 won't change the window configuration.  If you always want to force the
18820 ``right'' window configuration, you can set
18821 @code{gnus-always-force-window-configuration} to non-@code{nil}.
18822
18823 If you're using tree displays (@pxref{Tree Display}), and the tree
18824 window is displayed vertically next to another window, you may also want
18825 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
18826 windows resized.
18827
18828 @subsection Example Window Configurations
18829
18830 @itemize @bullet
18831 @item
18832 Narrow left hand side occupied by group buffer.  Right hand side split
18833 between summary buffer (top one-sixth) and article buffer (bottom).
18834
18835 @ifinfo
18836 @example
18837 +---+---------+
18838 | G | Summary |
18839 | r +---------+
18840 | o |         |
18841 | u | Article |
18842 | p |         |
18843 +---+---------+
18844 @end example
18845 @end ifinfo
18846
18847 @lisp
18848 (gnus-add-configuration
18849  '(article
18850    (horizontal 1.0
18851                (vertical 25 (group 1.0))
18852                (vertical 1.0
18853                          (summary 0.16 point)
18854                          (article 1.0)))))
18855
18856 (gnus-add-configuration
18857  '(summary
18858    (horizontal 1.0
18859                (vertical 25 (group 1.0))
18860                (vertical 1.0 (summary 1.0 point)))))
18861 @end lisp
18862
18863 @end itemize
18864
18865
18866 @node Faces and Fonts
18867 @section Faces and Fonts
18868 @cindex faces
18869 @cindex fonts
18870 @cindex colors
18871
18872 Fiddling with fonts and faces used to be very difficult, but these days
18873 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
18874 the face you want to alter, and alter it via the standard Customize
18875 interface.
18876
18877
18878 @node Compilation
18879 @section Compilation
18880 @cindex compilation
18881 @cindex byte-compilation
18882
18883 @findex gnus-compile
18884
18885 Remember all those line format specification variables?
18886 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
18887 on.  By default, T-gnus will use the byte-compiled codes of these
18888 variables and we can keep a slow-down to a minimum.  However, if you set
18889 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
18890 unfortunately, changing them will mean a quite significant slow-down.
18891 (The default values of these variables have byte-compiled functions
18892 associated with them, while the user-generated versions do not, of
18893 course.)
18894
18895 To help with this, you can run @kbd{M-x gnus-compile} after you've
18896 fiddled around with the variables and feel that you're (kind of)
18897 satisfied.  This will result in the new specs being byte-compiled, and
18898 you'll get top speed again.  Note that T-gnus will not save these
18899 compiled specs in the @file{.newsrc.eld} file.
18900
18901 @table @code
18902 @item gnus-compile-user-specs
18903 @vindex gnus-compile-user-specs
18904 If it is non-nil, the user-defined format specs will be byte-compiled
18905 automatically.  The default value of this variable is @code{t}.  It has
18906 an effect on the values of @code{gnus-*-line-format-spec}.
18907 @end table
18908
18909
18910 @node Mode Lines
18911 @section Mode Lines
18912 @cindex mode lines
18913
18914 @vindex gnus-updated-mode-lines
18915 @code{gnus-updated-mode-lines} says what buffers should keep their mode
18916 lines updated.  It is a list of symbols.  Supported symbols include
18917 @code{group}, @code{article}, @code{summary}, @code{server},
18918 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
18919 Gnus will keep that mode line updated with information that may be
18920 pertinent.  If this variable is @code{nil}, screen refresh may be
18921 quicker.
18922
18923 @cindex display-time
18924
18925 @vindex gnus-mode-non-string-length
18926 By default, Gnus displays information on the current article in the mode
18927 lines of the summary and article buffers.  The information Gnus wishes
18928 to display (e.g. the subject of the article) is often longer than the
18929 mode lines, and therefore have to be cut off at some point.  The
18930 @code{gnus-mode-non-string-length} variable says how long the other
18931 elements on the line is (i.e., the non-info part).  If you put
18932 additional elements on the mode line (e.g. a clock), you should modify
18933 this variable:
18934
18935 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
18936 @lisp
18937 (add-hook 'display-time-hook
18938           (lambda () (setq gnus-mode-non-string-length
18939                            (+ 21
18940                               (if line-number-mode 5 0)
18941                               (if column-number-mode 4 0)
18942                               (length display-time-string)))))
18943 @end lisp
18944
18945 If this variable is @code{nil} (which is the default), the mode line
18946 strings won't be chopped off, and they won't be padded either.  Note
18947 that the default is unlikely to be desirable, as even the percentage
18948 complete in the buffer may be crowded off the mode line; the user should
18949 configure this variable appropriately for her configuration.
18950
18951
18952 @node Highlighting and Menus
18953 @section Highlighting and Menus
18954 @cindex visual
18955 @cindex highlighting
18956 @cindex menus
18957
18958 @vindex gnus-visual
18959 The @code{gnus-visual} variable controls most of the Gnus-prettifying
18960 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
18961 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
18962 file.
18963
18964 This variable can be a list of visual properties that are enabled.  The
18965 following elements are valid, and are all included by default:
18966
18967 @table @code
18968 @item group-highlight
18969 Do highlights in the group buffer.
18970 @item summary-highlight
18971 Do highlights in the summary buffer.
18972 @item article-highlight
18973 Do highlights in the article buffer.
18974 @item highlight
18975 Turn on highlighting in all buffers.
18976 @item group-menu
18977 Create menus in the group buffer.
18978 @item summary-menu
18979 Create menus in the summary buffers.
18980 @item article-menu
18981 Create menus in the article buffer.
18982 @item browse-menu
18983 Create menus in the browse buffer.
18984 @item server-menu
18985 Create menus in the server buffer.
18986 @item score-menu
18987 Create menus in the score buffers.
18988 @item menu
18989 Create menus in all buffers.
18990 @end table
18991
18992 So if you only want highlighting in the article buffer and menus in all
18993 buffers, you could say something like:
18994
18995 @lisp
18996 (setq gnus-visual '(article-highlight menu))
18997 @end lisp
18998
18999 If you want highlighting only and no menus whatsoever, you'd say:
19000
19001 @lisp
19002 (setq gnus-visual '(highlight))
19003 @end lisp
19004
19005 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
19006 in all Gnus buffers.
19007
19008 Other general variables that influence the look of all buffers include:
19009
19010 @table @code
19011 @item gnus-mouse-face
19012 @vindex gnus-mouse-face
19013 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
19014 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
19015
19016 @end table
19017
19018 There are hooks associated with the creation of all the different menus:
19019
19020 @table @code
19021
19022 @item gnus-article-menu-hook
19023 @vindex gnus-article-menu-hook
19024 Hook called after creating the article mode menu.
19025
19026 @item gnus-group-menu-hook
19027 @vindex gnus-group-menu-hook
19028 Hook called after creating the group mode menu.
19029
19030 @item gnus-summary-menu-hook
19031 @vindex gnus-summary-menu-hook
19032 Hook called after creating the summary mode menu.
19033
19034 @item gnus-server-menu-hook
19035 @vindex gnus-server-menu-hook
19036 Hook called after creating the server mode menu.
19037
19038 @item gnus-browse-menu-hook
19039 @vindex gnus-browse-menu-hook
19040 Hook called after creating the browse mode menu.
19041
19042 @item gnus-score-menu-hook
19043 @vindex gnus-score-menu-hook
19044 Hook called after creating the score mode menu.
19045
19046 @end table
19047
19048
19049 @node Buttons
19050 @section Buttons
19051 @cindex buttons
19052 @cindex mouse
19053 @cindex click
19054
19055 Those new-fangled @dfn{mouse} contraptions is very popular with the
19056 young, hep kids who don't want to learn the proper way to do things
19057 these days.  Why, I remember way back in the summer of '89, when I was
19058 using Emacs on a Tops 20 system.  Three hundred users on one single
19059 machine, and every user was running Simula compilers.  Bah!
19060
19061 Right.
19062
19063 @vindex gnus-carpal
19064 Well, you can make Gnus display bufferfuls of buttons you can click to
19065 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
19066 really.  Tell the chiropractor I sent you.
19067
19068
19069 @table @code
19070
19071 @item gnus-carpal-mode-hook
19072 @vindex gnus-carpal-mode-hook
19073 Hook run in all carpal mode buffers.
19074
19075 @item gnus-carpal-button-face
19076 @vindex gnus-carpal-button-face
19077 Face used on buttons.
19078
19079 @item gnus-carpal-header-face
19080 @vindex gnus-carpal-header-face
19081 Face used on carpal buffer headers.
19082
19083 @item gnus-carpal-group-buffer-buttons
19084 @vindex gnus-carpal-group-buffer-buttons
19085 Buttons in the group buffer.
19086
19087 @item gnus-carpal-summary-buffer-buttons
19088 @vindex gnus-carpal-summary-buffer-buttons
19089 Buttons in the summary buffer.
19090
19091 @item gnus-carpal-server-buffer-buttons
19092 @vindex gnus-carpal-server-buffer-buttons
19093 Buttons in the server buffer.
19094
19095 @item gnus-carpal-browse-buffer-buttons
19096 @vindex gnus-carpal-browse-buffer-buttons
19097 Buttons in the browse buffer.
19098 @end table
19099
19100 All the @code{buttons} variables are lists.  The elements in these list
19101 are either cons cells where the @code{car} contains a text to be displayed and
19102 the @code{cdr} contains a function symbol, or a simple string.
19103
19104
19105 @node Daemons
19106 @section Daemons
19107 @cindex demons
19108 @cindex daemons
19109
19110 Gnus, being larger than any program ever written (allegedly), does lots
19111 of strange stuff that you may wish to have done while you're not
19112 present.  For instance, you may want it to check for new mail once in a
19113 while.  Or you may want it to close down all connections to all servers
19114 when you leave Emacs idle.  And stuff like that.
19115
19116 Gnus will let you do stuff like that by defining various
19117 @dfn{handlers}.  Each handler consists of three elements:  A
19118 @var{function}, a @var{time}, and an @var{idle} parameter.
19119
19120 Here's an example of a handler that closes connections when Emacs has
19121 been idle for thirty minutes:
19122
19123 @lisp
19124 (gnus-demon-close-connections nil 30)
19125 @end lisp
19126
19127 Here's a handler that scans for PGP headers every hour when Emacs is
19128 idle:
19129
19130 @lisp
19131 (gnus-demon-scan-pgp 60 t)
19132 @end lisp
19133
19134 This @var{time} parameter and than @var{idle} parameter work together
19135 in a strange, but wonderful fashion.  Basically, if @var{idle} is
19136 @code{nil}, then the function will be called every @var{time} minutes.
19137
19138 If @var{idle} is @code{t}, then the function will be called after
19139 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
19140 the function will never be called.  But once Emacs goes idle, the
19141 function will be called every @var{time} minutes.
19142
19143 If @var{idle} is a number and @var{time} is a number, the function will
19144 be called every @var{time} minutes only when Emacs has been idle for
19145 @var{idle} minutes.
19146
19147 If @var{idle} is a number and @var{time} is @code{nil}, the function
19148 will be called once every time Emacs has been idle for @var{idle}
19149 minutes.
19150
19151 And if @var{time} is a string, it should look like @samp{07:31}, and
19152 the function will then be called once every day somewhere near that
19153 time.  Modified by the @var{idle} parameter, of course.
19154
19155 @vindex gnus-demon-timestep
19156 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
19157 seconds.  This is 60 by default.  If you change that variable,
19158 all the timings in the handlers will be affected.)
19159
19160 So, if you want to add a handler, you could put something like this in
19161 your @file{.gnus} file:
19162
19163 @findex gnus-demon-add-handler
19164 @lisp
19165 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
19166 @end lisp
19167
19168 @findex gnus-demon-add-nocem
19169 @findex gnus-demon-add-scanmail
19170 @findex gnus-demon-add-rescan
19171 @findex gnus-demon-add-scan-timestamps
19172 @findex gnus-demon-add-disconnection
19173 Some ready-made functions to do this have been created:
19174 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
19175 @code{gnus-demon-add-nntp-close-connection},
19176 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
19177 @code{gnus-demon-add-scanmail}.  Just put those functions in your
19178 @file{.gnus} if you want those abilities.
19179
19180 @findex gnus-demon-init
19181 @findex gnus-demon-cancel
19182 @vindex gnus-demon-handlers
19183 If you add handlers to @code{gnus-demon-handlers} directly, you should
19184 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
19185 daemons, you can use the @code{gnus-demon-cancel} function.
19186
19187 Note that adding daemons can be pretty naughty if you over do it.  Adding
19188 functions that scan all news and mail from all servers every two seconds
19189 is a sure-fire way of getting booted off any respectable system.  So
19190 behave.
19191
19192
19193 @node NoCeM
19194 @section NoCeM
19195 @cindex nocem
19196 @cindex spam
19197
19198 @dfn{Spamming} is posting the same article lots and lots of times.
19199 Spamming is bad.  Spamming is evil.
19200
19201 Spamming is usually canceled within a day or so by various anti-spamming
19202 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
19203 NoCeM is pronounced ``no see-'em'', and means what the name
19204 implies---these are messages that make the offending articles, like, go
19205 away.
19206
19207 What use are these NoCeM messages if the articles are canceled anyway?
19208 Some sites do not honor cancel messages and some sites just honor cancels
19209 from a select few people.  Then you may wish to make use of the NoCeM
19210 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
19211
19212 Gnus can read and parse the messages in this group automatically, and
19213 this will make spam disappear.
19214
19215 There are some variables to customize, of course:
19216
19217 @table @code
19218 @item gnus-use-nocem
19219 @vindex gnus-use-nocem
19220 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
19221 by default.
19222
19223 @item gnus-nocem-groups
19224 @vindex gnus-nocem-groups
19225 Gnus will look for NoCeM messages in the groups in this list.  The
19226 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
19227 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
19228
19229 @item gnus-nocem-issuers
19230 @vindex gnus-nocem-issuers
19231 There are many people issuing NoCeM messages.  This list says what
19232 people you want to listen to.  The default is @code{("Automoose-1"
19233 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
19234 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
19235
19236 Known despammers that you can put in this list are listed at
19237 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
19238
19239 You do not have to heed NoCeM messages from all these people---just the
19240 ones you want to listen to.  You also don't have to accept all NoCeM
19241 messages from the people you like.  Each NoCeM message has a @dfn{type}
19242 header that gives the message a (more or less, usually less) rigorous
19243 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
19244 @samp{binary}, and @samp{troll}.  To specify this, you have to use
19245 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
19246 Each condition is either a string (which is a regexp that matches types
19247 you want to use) or a list on the form @code{(not @var{string})}, where
19248 @var{string} is a regexp that matches types you don't want to use.
19249
19250 For instance, if you want all NoCeM messages from Chris Lewis except his
19251 @samp{troll} messages, you'd say:
19252
19253 @lisp
19254 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
19255 @end lisp
19256
19257 On the other hand, if you just want nothing but his @samp{spam} and
19258 @samp{spew} messages, you'd say:
19259
19260 @lisp
19261 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
19262 @end lisp
19263
19264 The specs are applied left-to-right.
19265
19266
19267 @item gnus-nocem-verifyer
19268 @vindex gnus-nocem-verifyer
19269 @findex mc-verify
19270 This should be a function for verifying that the NoCeM issuer is who she
19271 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
19272 function.  If this is too slow and you don't care for verification
19273 (which may be dangerous), you can set this variable to @code{nil}.
19274
19275 If you want signed NoCeM messages to be verified and unsigned messages
19276 not to be verified (but used anyway), you could do something like:
19277
19278 @lisp
19279 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
19280
19281 (defun my-gnus-mc-verify ()
19282   (not (eq 'forged
19283            (ignore-errors
19284              (if (mc-verify)
19285                  t
19286                'forged)))))
19287 @end lisp
19288
19289 This might be dangerous, though.
19290
19291 @item gnus-nocem-directory
19292 @vindex gnus-nocem-directory
19293 This is where Gnus will store its NoCeM cache files.  The default is
19294 @file{~/News/NoCeM/}.
19295
19296 @item gnus-nocem-expiry-wait
19297 @vindex gnus-nocem-expiry-wait
19298 The number of days before removing old NoCeM entries from the cache.
19299 The default is 15.  If you make it shorter Gnus will be faster, but you
19300 might then see old spam.
19301
19302 @item gnus-nocem-check-from
19303 @vindex gnus-nocem-check-from
19304 Non-@code{nil} means check for valid issuers in message bodies.
19305 Otherwise don't bother fetching articles unless their author matches a
19306 valid issuer; that is much faster if you are selective about the
19307 issuers.
19308
19309 @item gnus-nocem-check-article-limit
19310 @vindex gnus-nocem-check-article-limit
19311 If non-@code{nil}, the maximum number of articles to check in any NoCeM
19312 group.  NoCeM groups can be huge and very slow to process.
19313
19314 @end table
19315
19316 Using NoCeM could potentially be a memory hog.  If you have many living
19317 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
19318 big.  If this is a problem, you should kill off all (or most) of your
19319 unsubscribed groups (@pxref{Subscription Commands}).
19320
19321
19322 @node Undo
19323 @section Undo
19324 @cindex undo
19325
19326 It is very useful to be able to undo actions one has done.  In normal
19327 Emacs buffers, it's easy enough---you just push the @code{undo} button.
19328 In Gnus buffers, however, it isn't that simple.
19329
19330 The things Gnus displays in its buffer is of no value whatsoever to
19331 Gnus---it's all just data designed to look nice to the user.
19332 Killing a group in the group buffer with @kbd{C-k} makes the line
19333 disappear, but that's just a side-effect of the real action---the
19334 removal of the group in question from the internal Gnus structures.
19335 Undoing something like that can't be done by the normal Emacs
19336 @code{undo} function.
19337
19338 Gnus tries to remedy this somewhat by keeping track of what the user
19339 does and coming up with actions that would reverse the actions the user
19340 takes.  When the user then presses the @code{undo} key, Gnus will run
19341 the code to reverse the previous action, or the previous actions.
19342 However, not all actions are easily reversible, so Gnus currently offers
19343 a few key functions to be undoable.  These include killing groups,
19344 yanking groups, and changing the list of read articles of groups.
19345 That's it, really.  More functions may be added in the future, but each
19346 added function means an increase in data to be stored, so Gnus will
19347 never be totally undoable.
19348
19349 @findex gnus-undo-mode
19350 @vindex gnus-use-undo
19351 @findex gnus-undo
19352 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
19353 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
19354 default.  The @kbd{C-M-_} key performs the @code{gnus-undo}
19355 command, which should feel kinda like the normal Emacs @code{undo}
19356 command.
19357
19358
19359 @node Moderation
19360 @section Moderation
19361 @cindex moderation
19362
19363 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
19364 It is not included in the standard Gnus package.  Write a mail to
19365 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
19366 get a copy.
19367
19368 The moderation package is implemented as a minor mode for summary
19369 buffers.  Put
19370
19371 @lisp
19372 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
19373 @end lisp
19374
19375 in your @file{.gnus.el} file.
19376
19377 If you are the moderator of @samp{rec.zoofle}, this is how it's
19378 supposed to work:
19379
19380 @enumerate
19381 @item
19382 You split your incoming mail by matching on
19383 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
19384 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
19385
19386 @item
19387 You enter that group once in a while and post articles using the @kbd{e}
19388 (edit-and-post) or @kbd{s} (just send unedited) commands.
19389
19390 @item
19391 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
19392 articles that weren't approved by you, you can cancel them with the
19393 @kbd{c} command.
19394 @end enumerate
19395
19396 To use moderation mode in these two groups, say:
19397
19398 @lisp
19399 (setq gnus-moderated-list
19400       "^nnml:rec.zoofle$\\|^rec.zoofle$")
19401 @end lisp
19402
19403
19404 @node XEmacs Enhancements
19405 @section XEmacs Enhancements
19406 @cindex XEmacs
19407
19408 XEmacs is able to display pictures and stuff, so Gnus has taken
19409 advantage of that.
19410
19411 @menu
19412 * Picons::                      How to display pictures of what your reading.
19413 * Smileys::                     Show all those happy faces the way they were meant to be shown.
19414 * Toolbar::                     Click'n'drool.
19415 * XVarious::                    Other XEmacsy Gnusey variables.
19416 @end menu
19417
19418
19419 @node Picons
19420 @subsection Picons
19421
19422 @iftex
19423 @iflatex
19424 \include{picons}
19425 @end iflatex
19426 @end iftex
19427
19428 So@dots{}  You want to slow down your news reader even more!  This is a
19429 good way to do so.  Its also a great way to impress people staring
19430 over your shoulder as you read news.
19431
19432 @menu
19433 * Picon Basics::                What are picons and How do I get them.
19434 * Picon Requirements::          Don't go further if you aren't using XEmacs.
19435 * Easy Picons::                 Displaying Picons---the easy way.
19436 * Hard Picons::                 The way you should do it.  You'll learn something.
19437 * Picon Useless Configuration::  Other variables you can trash/tweak/munge/play with.
19438 @end menu
19439
19440
19441 @node Picon Basics
19442 @subsubsection Picon Basics
19443
19444 What are Picons?  To quote directly from the Picons Web site:
19445
19446 @iftex
19447 @iflatex
19448 \margindex{}
19449 @end iflatex
19450 @end iftex
19451
19452 @quotation
19453 @dfn{Picons} is short for ``personal icons''.  They're small,
19454 constrained images used to represent users and domains on the net,
19455 organized into databases so that the appropriate image for a given
19456 e-mail address can be found.  Besides users and domains, there are picon
19457 databases for Usenet newsgroups and weather forecasts.  The picons are
19458 in either monochrome @code{XBM} format or color @code{XPM} and
19459 @code{GIF} formats.
19460 @end quotation
19461
19462 @vindex gnus-picons-piconsearch-url
19463 If you have a permanent connection to the Internet you can use Steve
19464 Kinzler's Picons Search engine by setting
19465 @code{gnus-picons-piconsearch-url} to the string @*
19466 @uref{http://www.cs.indiana.edu/picons/search.html}.
19467
19468 @vindex gnus-picons-database
19469 Otherwise you need a local copy of his database.  For instructions on
19470 obtaining and installing the picons databases, point your Web browser at @*
19471 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
19472 picons to be installed into a location pointed to by
19473 @code{gnus-picons-database}.
19474
19475
19476 @node Picon Requirements
19477 @subsubsection Picon Requirements
19478
19479 To have Gnus display Picons for you, you must have @code{x} support
19480 compiled into XEmacs.  To display color picons which are much nicer
19481 than the black & white one, you also need one of @code{xpm} or
19482 @code{gif} compiled into XEmacs.
19483
19484 @vindex gnus-picons-convert-x-face
19485 If you want to display faces from @code{X-Face} headers, you should have
19486 the @code{xface} support compiled into XEmacs.  Otherwise you must have
19487 the @code{netpbm} utilities installed, or munge the
19488 @code{gnus-picons-convert-x-face} variable to use something else.
19489 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
19490
19491 @node Easy Picons
19492 @subsubsection Easy Picons
19493
19494 To enable displaying picons, simply put the following line in your
19495 @file{~/.gnus} file and start Gnus.
19496
19497 @lisp
19498 (setq gnus-use-picons t)
19499 (setq gnus-treat-display-picons t)
19500 @end lisp
19501
19502 and make sure @code{gnus-picons-database} points to the directory
19503 containing the Picons databases.
19504
19505 Alternatively if you want to use the web piconsearch engine add this:
19506
19507 @lisp
19508 (setq gnus-picons-piconsearch-url
19509       "http://www.cs.indiana.edu:800/piconsearch")
19510 @end lisp
19511
19512
19513 @node Hard Picons
19514 @subsubsection Hard Picons
19515
19516 @iftex
19517 @iflatex
19518 \margindex{}
19519 @end iflatex
19520 @end iftex
19521
19522 Gnus can display picons for you as you enter and leave groups and
19523 articles.  It knows how to interact with three sections of the picons
19524 database.  Namely, it can display the picons newsgroup pictures,
19525 author's face picture(s), and the authors domain.  To enable this
19526 feature, you need to select where to get the picons from, and where to
19527 display them.
19528
19529 @table @code
19530
19531 @item gnus-picons-database
19532 @vindex gnus-picons-database
19533 The location of the picons database.  Should point to a directory
19534 containing the @file{news}, @file{domains}, @file{users} (and so on)
19535 subdirectories.  This is only useful if
19536 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
19537 @file{/usr/local/faces/}.
19538
19539 @item gnus-picons-piconsearch-url
19540 @vindex gnus-picons-piconsearch-url
19541 The URL for the web picons search engine.  The only currently known
19542 engine is @uref{http://www.cs.indiana.edu:800/piconsearch}.  To
19543 workaround network delays, icons will be fetched in the background.  If
19544 this is @code{nil} 'the default), then picons are fetched from local
19545 database indicated by @code{gnus-picons-database}.
19546
19547 @item gnus-picons-display-where
19548 @vindex gnus-picons-display-where
19549 Where the picon images should be displayed.  It is @code{picons} by
19550 default (which by default maps to the buffer @samp{*Picons*}).  Other
19551 valid places could be @code{article}, @code{summary}, or
19552 @samp{*scratch*} for all I care.  Just make sure that you've made the
19553 buffer visible using the standard Gnus window configuration
19554 routines---@pxref{Window Layout}.
19555
19556 @item gnus-picons-group-excluded-groups
19557 @vindex gnus-picons-group-excluded-groups
19558 Groups that are matched by this regexp won't have their group icons
19559 displayed.
19560
19561 @end table
19562
19563 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
19564 window configuration for you to include the @code{picons} buffer.
19565
19566 Now that you've made those decision, you need to add the following
19567 functions to the appropriate hooks so these pictures will get displayed
19568 at the right time.
19569
19570 @vindex gnus-picons-display-where
19571 @table @code
19572 @item gnus-article-display-picons
19573 @findex gnus-article-display-picons
19574 Looks up and displays the picons for the author and the author's domain
19575 in the @code{gnus-picons-display-where} buffer.
19576
19577 @item gnus-picons-article-display-x-face
19578 @findex gnus-picons-article-display-x-face
19579 Decodes and displays the X-Face header if present.
19580 (NOTE: @code{x-face} is used in the function name, not @code{xface})
19581
19582 @end table
19583
19584
19585
19586 @node Picon Useless Configuration
19587 @subsubsection Picon Useless Configuration
19588
19589 @iftex
19590 @iflatex
19591 \margindex{}
19592 @end iflatex
19593 @end iftex
19594
19595 The following variables offer further control over how things are
19596 done, where things are located, and other useless stuff you really
19597 don't need to worry about.
19598
19599 @table @code
19600
19601 @item gnus-picons-news-directories
19602 @vindex gnus-picons-news-directories
19603 List of subdirectories to search in @code{gnus-picons-database} for
19604 newsgroups faces.  @code{("news")} is the default.
19605
19606 @item gnus-picons-user-directories
19607 @vindex gnus-picons-user-directories
19608 List of subdirectories to search in @code{gnus-picons-database} for user
19609 faces.  @code{("local" "users" "usenix" "misc")} is the default.
19610
19611 @item gnus-picons-domain-directories
19612 @vindex gnus-picons-domain-directories
19613 List of subdirectories to search in @code{gnus-picons-database} for
19614 domain name faces.  Defaults to @code{("domains")}.  Some people may
19615 want to add @samp{"unknown"} to this list.
19616
19617 @item gnus-picons-convert-x-face
19618 @vindex gnus-picons-convert-x-face
19619 If you don't have @code{xface} support builtin XEmacs, this is the
19620 command to use to convert the @code{X-Face} header to an X bitmap
19621 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
19622 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
19623 gnus-picons-x-face-file-name)}
19624 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
19625
19626 @item gnus-picons-x-face-file-name
19627 @vindex gnus-picons-x-face-file-name
19628 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
19629 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
19630 (NOTE: @code{x-face} is used in the variable name, not @code{xface})
19631
19632 @item gnus-picons-has-modeline-p
19633 @vindex gnus-picons-has-modeline-p
19634 If you have set @code{gnus-picons-display-where} to @code{picons}, your
19635 XEmacs frame will become really cluttered.  To alleviate this a bit you
19636 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
19637 remove the mode line from the Picons buffer.  This is only useful if
19638 @code{gnus-picons-display-where} is @code{picons}.
19639
19640 @item gnus-picons-refresh-before-display
19641 @vindex gnus-picons-refresh-before-display
19642 If non-nil, display the article buffer before computing the picons.
19643 Defaults to @code{nil}.
19644
19645 @item gnus-picons-display-as-address
19646 @vindex gnus-picons-display-as-address
19647 If @code{t} display textual email addresses along with pictures.
19648 Defaults to @code{t}.
19649
19650 @item gnus-picons-file-suffixes
19651 @vindex gnus-picons-file-suffixes
19652 Ordered list of suffixes on picon file names to try.  Defaults to
19653 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
19654
19655 @item gnus-picons-setup-hook
19656 @vindex gnus-picons-setup-hook
19657 Hook run in the picon buffer, if that is displayed.
19658
19659 @item gnus-picons-display-article-move-p
19660 @vindex gnus-picons-display-article-move-p
19661 Whether to move point to first empty line when displaying picons.  This
19662 has only an effect if `gnus-picons-display-where' has value `article'.
19663
19664 If @code{nil}, display the picons in the @code{From} and
19665 @code{Newsgroups} lines.  This is the default.
19666
19667 @item gnus-picons-clear-cache-on-shutdown
19668 @vindex gnus-picons-clear-cache-on-shutdown
19669 Whether to clear the picons cache when exiting gnus.  Gnus caches every
19670 picons it finds while it is running.  This saves some time in the search
19671 process but eats some memory.  If this variable is set to @code{nil},
19672 Gnus will never clear the cache itself; you will have to manually call
19673 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
19674 cleared every time you exit Gnus.  Defaults to @code{t}.
19675
19676 @iftex
19677 @iflatex
19678 \margindex{}
19679 @end iflatex
19680 @end iftex
19681
19682 @end table
19683
19684 @node Smileys
19685 @subsection Smileys
19686 @cindex smileys
19687
19688 @iftex
19689 @iflatex
19690 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
19691 \input{smiley}
19692 @end iflatex
19693 @end iftex
19694
19695 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
19696 currently the only package that uses Smiley, it is documented here.
19697
19698 In short---to use Smiley in Gnus, put the following in your
19699 @file{.gnus.el} file:
19700
19701 @lisp
19702 (setq gnus-treat-display-smileys t)
19703 @end lisp
19704
19705 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
19706 the like---to pictures and displays those instead of the text smiley
19707 faces.  The conversion is controlled by a list of regexps that matches
19708 text and maps that to file names.
19709
19710 @vindex smiley-nosey-regexp-alist
19711 @vindex smiley-deformed-regexp-alist
19712 Smiley supplies two example conversion alists by default:
19713 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
19714 and so on), and @code{smiley-nosey-regexp-alist} (which matches
19715 @samp{:-)}, @samp{:-(} and so on).
19716
19717 The alist used is specified by the @code{smiley-regexp-alist} variable,
19718 which defaults to the value of @code{smiley-deformed-regexp-alist}.
19719
19720 The first item in each element is the regexp to be matched; the second
19721 element is the regexp match group that is to be replaced by the picture;
19722 and the third element is the name of the file to be displayed.
19723
19724 The following variables customize where Smiley will look for these
19725 files, as well as the color to be used and stuff:
19726
19727 @table @code
19728
19729 @item smiley-data-directory
19730 @vindex smiley-data-directory
19731 Where Smiley will look for smiley faces files.
19732
19733 @item smiley-flesh-color
19734 @vindex smiley-flesh-color
19735 Skin color.  The default is @samp{yellow}, which is really racist.
19736
19737 @item smiley-features-color
19738 @vindex smiley-features-color
19739 Color of the features of the face.  The default is @samp{black}.
19740
19741 @item smiley-tongue-color
19742 @vindex smiley-tongue-color
19743 Color of the tongue.  The default is @samp{red}.
19744
19745 @item smiley-circle-color
19746 @vindex smiley-circle-color
19747 Color of the circle around the face.  The default is @samp{black}.
19748
19749 @item smiley-mouse-face
19750 @vindex smiley-mouse-face
19751 Face used for mouse highlighting over the smiley face.
19752
19753 @end table
19754
19755
19756 @node Toolbar
19757 @subsection Toolbar
19758
19759 @table @code
19760
19761 @iftex
19762 @iflatex
19763 \margindex{}
19764 @end iflatex
19765 @end iftex
19766
19767 @item gnus-use-toolbar
19768 @vindex gnus-use-toolbar
19769 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
19770 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
19771 @code{right-toolbar}, or @code{left-toolbar}.
19772
19773 @item gnus-group-toolbar
19774 @vindex gnus-group-toolbar
19775 The toolbar in the group buffer.
19776
19777 @item gnus-summary-toolbar
19778 @vindex gnus-summary-toolbar
19779 The toolbar in the summary buffer.
19780
19781 @item gnus-summary-mail-toolbar
19782 @vindex gnus-summary-mail-toolbar
19783 The toolbar in the summary buffer of mail groups.
19784
19785 @end table
19786
19787
19788 @node XVarious
19789 @subsection Various XEmacs Variables
19790
19791 @table @code
19792 @item gnus-xmas-glyph-directory
19793 @vindex gnus-xmas-glyph-directory
19794 This is where Gnus will look for pictures.  Gnus will normally
19795 auto-detect this directory, but you may set it manually if you have an
19796 unusual directory structure.
19797
19798 @item gnus-xmas-logo-color-alist
19799 @vindex gnus-xmas-logo-color-alist
19800 This is an alist where the key is a type symbol and the values are the
19801 foreground and background color of the splash page glyph.
19802
19803 @item gnus-xmas-logo-color-style
19804 @vindex gnus-xmas-logo-color-style
19805 This is the key used to look up the color in the alist described above.
19806 Valid values include @code{flame}, @code{pine}, @code{moss},
19807 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
19808 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
19809
19810 @item gnus-xmas-modeline-glyph
19811 @vindex gnus-xmas-modeline-glyph
19812 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
19813 default.
19814
19815 @iftex
19816 @iflatex
19817 \margindex{}
19818 @end iflatex
19819 @end iftex
19820
19821 @end table
19822
19823
19824
19825
19826 @node Fuzzy Matching
19827 @section Fuzzy Matching
19828 @cindex fuzzy matching
19829
19830 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
19831 things like scoring, thread gathering and thread comparison.
19832
19833 As opposed to regular expression matching, fuzzy matching is very fuzzy.
19834 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
19835 means, and the implementation has changed over time.
19836
19837 Basically, it tries to remove all noise from lines before comparing.
19838 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
19839 out of the strings before comparing the results.  This often leads to
19840 adequate results---even when faced with strings generated by text
19841 manglers masquerading as newsreaders.
19842
19843
19844 @node Thwarting Email Spam
19845 @section Thwarting Email Spam
19846 @cindex email spam
19847 @cindex spam
19848 @cindex UCE
19849 @cindex unsolicited commercial email
19850
19851 In these last days of the Usenet, commercial vultures are hanging about
19852 and grepping through news like crazy to find email addresses they can
19853 foist off their scams and products to.  As a reaction to this, many
19854 people have started putting nonsense addresses into their @code{From}
19855 lines.  I think this is counterproductive---it makes it difficult for
19856 people to send you legitimate mail in response to things you write, as
19857 well as making it difficult to see who wrote what.  This rewriting may
19858 perhaps be a bigger menace than the unsolicited commercial email itself
19859 in the end.
19860
19861 The biggest problem I have with email spam is that it comes in under
19862 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
19863 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
19864 mail group, only to find two pyramid schemes, seven advertisements
19865 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
19866 and one mail asking me to repent and find some god.
19867
19868 This is annoying.
19869
19870 The way to deal with this is having Gnus split out all spam into a
19871 @samp{spam} mail group (@pxref{Splitting Mail}).
19872
19873 First, pick one (1) valid mail address that you can be reached at, and
19874 put it in your @code{From} header of all your news articles.  (I've
19875 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
19876 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
19877 sysadmin whether your sendmail installation accepts keywords in the local
19878 part of the mail address.)
19879
19880 @lisp
19881 (setq message-default-news-headers
19882       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
19883 @end lisp
19884
19885 Then put the following split rule in @code{nnmail-split-fancy}
19886 (@pxref{Fancy Mail Splitting}):
19887
19888 @lisp
19889 (
19890  ...
19891  (to "larsi@@trym.ifi.uio.no"
19892       (| ("subject" "re:.*" "misc")
19893          ("references" ".*@@.*" "misc")
19894          "spam"))
19895  ...
19896 )
19897 @end lisp
19898
19899 This says that all mail to this address is suspect, but if it has a
19900 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
19901 header, it's probably ok.  All the rest goes to the @samp{spam} group.
19902 (This idea probably comes from Tim Pierce.)
19903
19904 In addition, many mail spammers talk directly to your @code{smtp} server
19905 and do not include your email address explicitly in the @code{To}
19906 header.  Why they do this is unknown---perhaps it's to thwart this
19907 thwarting scheme?  In any case, this is trivial to deal with---you just
19908 put anything not addressed to you in the @samp{spam} group by ending
19909 your fancy split rule in this way:
19910
19911 @lisp
19912 (
19913  ...
19914  (to "larsi" "misc")
19915  "spam")
19916 @end lisp
19917
19918 In my experience, this will sort virtually everything into the right
19919 group.  You still have to check the @samp{spam} group from time to time to
19920 check for legitimate mail, though.  If you feel like being a good net
19921 citizen, you can even send off complaints to the proper authorities on
19922 each unsolicited commercial email---at your leisure.
19923
19924 If you are also a lazy net citizen, you will probably prefer complaining
19925 automatically with the @file{gnus-junk.el} package, available FOR FREE
19926 at @* @uref{http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html}.
19927 Since most e-mail spam is sent automatically, this may reconcile the
19928 cosmic balance somewhat.
19929
19930 This works for me.  It allows people an easy way to contact me (they can
19931 just press @kbd{r} in the usual way), and I'm not bothered at all with
19932 spam.  It's a win-win situation.  Forging @code{From} headers to point
19933 to non-existent domains is yucky, in my opinion.
19934
19935
19936 @node Various Various
19937 @section Various Various
19938 @cindex mode lines
19939 @cindex highlights
19940
19941 @table @code
19942
19943 @item gnus-home-directory
19944 All Gnus path variables will be initialized from this variable, which
19945 defaults to @file{~/}.
19946
19947 @item gnus-directory
19948 @vindex gnus-directory
19949 Most Gnus storage path variables will be initialized from this variable,
19950 which defaults to the @samp{SAVEDIR} environment variable, or
19951 @file{~/News/} if that variable isn't set.
19952
19953 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
19954 This means that other directory variables that are initialized from this
19955 variable won't be set properly if you set this variable in
19956 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
19957
19958 @item gnus-default-directory
19959 @vindex gnus-default-directory
19960 Not related to the above variable at all---this variable says what the
19961 default directory of all Gnus buffers should be.  If you issue commands
19962 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
19963 default directory.  If this variable is @code{nil} (which is the
19964 default), the default directory will be the default directory of the
19965 buffer you were in when you started Gnus.
19966
19967 @item gnus-verbose
19968 @vindex gnus-verbose
19969 This variable is an integer between zero and ten.  The higher the value,
19970 the more messages will be displayed.  If this variable is zero, Gnus
19971 will never flash any messages, if it is seven (which is the default),
19972 most important messages will be shown, and if it is ten, Gnus won't ever
19973 shut up, but will flash so many messages it will make your head swim.
19974
19975 @item gnus-verbose-backends
19976 @vindex gnus-verbose-backends
19977 This variable works the same way as @code{gnus-verbose}, but it applies
19978 to the Gnus back ends instead of Gnus proper.
19979
19980 @item nnheader-max-head-length
19981 @vindex nnheader-max-head-length
19982 When the back ends read straight heads of articles, they all try to read
19983 as little as possible.  This variable (default 4096) specifies
19984 the absolute max length the back ends will try to read before giving up
19985 on finding a separator line between the head and the body.  If this
19986 variable is @code{nil}, there is no upper read bound.  If it is
19987 @code{t}, the back ends won't try to read the articles piece by piece,
19988 but read the entire articles.  This makes sense with some versions of
19989 @code{ange-ftp} or @code{efs}.
19990
19991 @item nnheader-head-chop-length
19992 @vindex nnheader-head-chop-length
19993 This variable (default 2048) says how big a piece of each article to
19994 read when doing the operation described above.
19995
19996 @item nnheader-file-name-translation-alist
19997 @vindex nnheader-file-name-translation-alist
19998 @cindex file names
19999 @cindex invalid characters in file names
20000 @cindex characters in file names
20001 This is an alist that says how to translate characters in file names.
20002 For instance, if @samp{:} is invalid as a file character in file names
20003 on your system (you OS/2 user you), you could say something like:
20004
20005 @lisp
20006 (setq nnheader-file-name-translation-alist
20007       '((?: . ?_)))
20008 @end lisp
20009
20010 In fact, this is the default value for this variable on OS/2 and MS
20011 Windows (phooey) systems.
20012
20013 @item gnus-hidden-properties
20014 @vindex gnus-hidden-properties
20015 This is a list of properties to use to hide ``invisible'' text.  It is
20016 @code{(invisible t intangible t)} by default on most systems, which
20017 makes invisible text invisible and intangible.
20018
20019 @item gnus-parse-headers-hook
20020 @vindex gnus-parse-headers-hook
20021 A hook called before parsing headers.  It can be used, for instance, to
20022 gather statistics on the headers fetched, or perhaps you'd like to prune
20023 some headers.  I don't see why you'd want that, though.
20024
20025 @item gnus-shell-command-separator
20026 @vindex gnus-shell-command-separator
20027 String used to separate two shell commands.  The default is @samp{;}.
20028
20029 @item gnus-invalid-group-regexp
20030 @vindex gnus-invalid-group-regexp
20031
20032 Regexp to match ``invalid'' group names when querying user for a group
20033 name.  The default value catches some @strong{really} invalid group
20034 names who could possibly mess up Gnus internally (like allowing
20035 @samp{:} in a group name, which is normally used to delimit method and
20036 group).
20037
20038 @sc{imap} users might want to allow @samp{/} in group names though.
20039
20040
20041 @end table
20042
20043 @node The End
20044 @chapter The End
20045
20046 Well, that's the manual---you can get on with your life now.  Keep in
20047 touch.  Say hello to your cats from me.
20048
20049 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
20050
20051 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
20052
20053 @quotation
20054 @strong{Te Deum}
20055
20056 @sp 1
20057 Not because of victories @*
20058 I sing,@*
20059 having none,@*
20060 but for the common sunshine,@*
20061 the breeze,@*
20062 the largess of the spring.
20063
20064 @sp 1
20065 Not for victory@*
20066 but for the day's work done@*
20067 as well as I was able;@*
20068 not for a seat upon the dais@*
20069 but at the common table.@*
20070 @end quotation
20071
20072
20073 @node Appendices
20074 @chapter Appendices
20075
20076 @menu
20077 * History::                     How Gnus got where it is today.
20078 * On Writing Manuals::          Why this is not a beginner's guide.
20079 * Terminology::                 We use really difficult, like, words here.
20080 * Customization::               Tailoring Gnus to your needs.
20081 * Troubleshooting::             What you might try if things do not work.
20082 * Gnus Reference Guide::        Rilly, rilly technical stuff.
20083 * Emacs for Heathens::          A short introduction to Emacsian terms.
20084 * Frequently Asked Questions::
20085 @end menu
20086
20087
20088 @node History
20089 @section History
20090
20091 @cindex history
20092 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
20093 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
20094
20095 If you want to investigate the person responsible for this outrage,
20096 you can point your (feh!) web browser to
20097 @uref{http://quimby.gnus.org/}.  This is also the primary
20098 distribution point for the new and spiffy versions of Gnus, and is
20099 known as The Site That Destroys Newsrcs And Drives People Mad.
20100
20101 During the first extended alpha period of development, the new Gnus was
20102 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
20103 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
20104 (Besides, the ``Gnus'' in this abbreviation should probably be
20105 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
20106 appropriate name, don't you think?)
20107
20108 In any case, after spending all that energy on coming up with a new and
20109 spunky name, we decided that the name was @emph{too} spunky, so we
20110 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
20111 ``@sc{gnus}''.  New vs. old.
20112
20113 @menu
20114 * Gnus Versions::               What Gnus versions have been released.
20115 * Other Gnus Versions::         Other Gnus versions that also have been released.
20116 * Why?::                        What's the point of Gnus?
20117 * Compatibility::               Just how compatible is Gnus with @sc{gnus}?
20118 * Conformity::                  Gnus tries to conform to all standards.
20119 * Emacsen::                     Gnus can be run on a few modern Emacsen.
20120 * Gnus Development::            How Gnus is developed.
20121 * Contributors::                Oodles of people.
20122 * New Features::                Pointers to some of the new stuff in Gnus.
20123 @end menu
20124
20125
20126 @node Gnus Versions
20127 @subsection Gnus Versions
20128 @cindex Pterodactyl Gnus
20129 @cindex ding Gnus
20130 @cindex September Gnus
20131 @cindex Quassia Gnus
20132
20133 The first ``proper'' release of Gnus 5 was done in November 1995 when it
20134 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
20135 plus 15 Gnus 5.0 releases).
20136
20137 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
20138 releases)) was released under the name ``Gnus 5.2'' (40 releases).
20139
20140 On July 28th 1996 work on Red Gnus was begun, and it was released on
20141 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
20142
20143 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
20144 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
20145
20146 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
20147 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
20148 1999.
20149
20150 On the 26th of October 2000, Oort Gnus was begun.
20151
20152 If you happen upon a version of Gnus that has a prefixed name --
20153 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
20154 ``Pterodactyl Gnus'', ``Oort Gnus'' -- don't panic.  Don't let it know
20155 that you're frightened.  Back away.  Slowly.  Whatever you do, don't
20156 run.  Walk away, calmly, until you're out of its reach.  Find a proper
20157 released version of Gnus and snuggle up to that instead.
20158
20159
20160 @node Other Gnus Versions
20161 @subsection Other Gnus Versions
20162 @cindex Semi-gnus
20163
20164 In addition to the versions of Gnus which have had their releases
20165 coordinated by Lars, one major development has been Semi-gnus from
20166 Japan.  It's based on a library called @sc{semi}, which provides
20167 @sc{mime} capabilities.
20168
20169 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
20170 Collectively, they are called ``Semi-gnus'', and different strains are
20171 called T-gnus, ET-gnus, Nana-gnus and Chaos.  These provide powerful
20172 @sc{mime} and multilingualization things, especially important for
20173 Japanese users.
20174
20175
20176 @node Why?
20177 @subsection Why?
20178
20179 What's the point of Gnus?
20180
20181 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
20182 newsreader, that lets you do anything you can think of.  That was my
20183 original motivation, but while working on Gnus, it has become clear to
20184 me that this generation of newsreaders really belong in the stone age.
20185 Newsreaders haven't developed much since the infancy of the net.  If the
20186 volume continues to rise with the current rate of increase, all current
20187 newsreaders will be pretty much useless.  How do you deal with
20188 newsgroups that have thousands of new articles each day?  How do you
20189 keep track of millions of people who post?
20190
20191 Gnus offers no real solutions to these questions, but I would very much
20192 like to see Gnus being used as a testing ground for new methods of
20193 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
20194 to separate the newsreader from the back ends, Gnus now offers a simple
20195 interface for anybody who wants to write new back ends for fetching mail
20196 and news from different sources.  I have added hooks for customizations
20197 everywhere I could imagine it being useful.  By doing so, I'm inviting
20198 every one of you to explore and invent.
20199
20200 May Gnus never be complete.  @kbd{C-u 100 M-x all-hail-emacs} and
20201 @kbd{C-u 100 M-x all-hail-xemacs}.
20202
20203
20204 @node Compatibility
20205 @subsection Compatibility
20206
20207 @cindex compatibility
20208 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
20209 bindings have been kept.  More key bindings have been added, of course,
20210 but only in one or two obscure cases have old bindings been changed.
20211
20212 Our motto is:
20213 @quotation
20214 @cartouche
20215 @center In a cloud bones of steel.
20216 @end cartouche
20217 @end quotation
20218
20219 All commands have kept their names.  Some internal functions have changed
20220 their names.
20221
20222 The @code{gnus-uu} package has changed drastically.  @xref{Decoding
20223 Articles}.
20224
20225 One major compatibility question is the presence of several summary
20226 buffers.  All variables relevant while reading a group are
20227 buffer-local to the summary buffer they belong in.  Although many
20228 important variables have their values copied into their global
20229 counterparts whenever a command is executed in the summary buffer, this
20230 change might lead to incorrect values being used unless you are careful.
20231
20232 All code that relies on knowledge of @sc{gnus} internals will probably
20233 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
20234 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
20235 maintains a hash table that points to the entries in this alist (which
20236 speeds up many functions), and changing the alist directly will lead to
20237 peculiar results.
20238
20239 @cindex hilit19
20240 @cindex highlighting
20241 Old hilit19 code does not work at all.  In fact, you should probably
20242 remove all hilit code from all Gnus hooks
20243 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
20244 Gnus provides various integrated functions for highlighting.  These are
20245 faster and more accurate.  To make life easier for everybody, Gnus will
20246 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
20247 Away!
20248
20249 Packages like @code{expire-kill} will no longer work.  As a matter of
20250 fact, you should probably remove all old @sc{gnus} packages (and other
20251 code) when you start using Gnus.  More likely than not, Gnus already
20252 does what you have written code to make @sc{gnus} do.  (Snicker.)
20253
20254 Even though old methods of doing things are still supported, only the
20255 new methods are documented in this manual.  If you detect a new method of
20256 doing something while reading this manual, that does not mean you have
20257 to stop doing it the old way.
20258
20259 Gnus understands all @sc{gnus} startup files.
20260
20261 @kindex M-x gnus-bug
20262 @findex gnus-bug
20263 @cindex reporting bugs
20264 @cindex bugs
20265 Overall, a casual user who hasn't written much code that depends on
20266 @sc{gnus} internals should suffer no problems.  If problems occur,
20267 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
20268
20269 @vindex gnus-bug-create-help-buffer
20270 If you are in the habit of sending bug reports @emph{very} often, you
20271 may find the helpful help buffer annoying after a while.  If so, set
20272 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
20273 up at you.
20274
20275
20276 @node Conformity
20277 @subsection Conformity
20278
20279 No rebels without a clue here, ma'am.  We conform to all standards known
20280 to (wo)man.  Except for those standards and/or conventions we disagree
20281 with, of course.
20282
20283 @table @strong
20284
20285 @item RFC 822
20286 @cindex RFC 822
20287 There are no known breaches of this standard.
20288
20289 @item RFC 1036
20290 @cindex RFC 1036
20291 There are no known breaches of this standard, either.
20292
20293 @item Son-of-RFC 1036
20294 @cindex Son-of-RFC 1036
20295 We do have some breaches to this one.
20296
20297 @table @emph
20298
20299 @item X-Newsreader
20300 @itemx User-Agent
20301 These are considered to be ``vanity headers'', while I consider them
20302 to be consumer information.  After seeing so many badly formatted
20303 articles coming from @code{tin} and @code{Netscape} I know not to use
20304 either of those for posting articles.  I would not have known that if
20305 it wasn't for the @code{X-Newsreader} header.
20306 @end table
20307
20308 @item USEFOR
20309 @cindex USEFOR
20310 USEFOR is an IETF working group writing a successor to RFC 1036, based
20311 on Son-of-RFC 1036.  They have produced a number of drafts proposing
20312 various changes to the format of news articles.  The Gnus towers will
20313 look into implementing the changes when the draft is accepted as an RFC.
20314
20315 @end table
20316
20317 If you ever notice Gnus acting non-compliant with regards to the texts
20318 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
20319 know.
20320
20321
20322 @node Emacsen
20323 @subsection Emacsen
20324 @cindex Emacsen
20325 @cindex XEmacs
20326 @cindex Mule
20327 @cindex Emacs
20328
20329 Gnus should work on :
20330
20331 @itemize @bullet
20332
20333 @item
20334 Emacs 20.3 and up.
20335
20336 @item
20337 XEmacs 21.1.1 and up.
20338
20339 @end itemize
20340
20341 This Gnus version will absolutely not work on any Emacsen older than
20342 that.  Not reliably, at least.  Older versions of Gnus may work on older
20343 Emacs versions.  However, T-gnus does support ``Mule 2.3 based on Emacs
20344 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
20345 See the file ``README'' in the T-gnus distribution for more details.
20346
20347 There are some vague differences between Gnus on the various
20348 platforms---XEmacs features more graphics (a logo and a toolbar)---but
20349 other than that, things should look pretty much the same under all
20350 Emacsen.
20351
20352
20353 @node Gnus Development
20354 @subsection Gnus Development
20355
20356 Gnus is developed in a two-phased cycle.  The first phase involves much
20357 discussion on the @samp{ding@@gnus.org} mailing list, where people
20358 propose changes and new features, post patches and new back ends.  This
20359 phase is called the @dfn{alpha} phase, since the Gnusae released in this
20360 phase are @dfn{alpha releases}, or (perhaps more commonly in other
20361 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
20362 unstable and should not be used by casual users.  Gnus alpha releases
20363 have names like ``Red Gnus'' and ``Quassia Gnus''.
20364
20365 After futzing around for 50-100 alpha releases, Gnus is declared
20366 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
20367 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
20368 supposed to be able to use these, and these are mostly discussed on the
20369 @samp{gnu.emacs.gnus} newsgroup.
20370
20371 @cindex Incoming*
20372 @vindex mail-source-delete-incoming
20373 Some variable defaults differ between alpha Gnusae and released Gnusae.
20374 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
20375 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
20376 lossage of mail if an alpha release hiccups while handling the mail.
20377
20378 The division of discussion between the ding mailing list and the Gnus
20379 newsgroup is not purely based on publicity concerns.  It's true that
20380 having people write about the horrible things that an alpha Gnus release
20381 can do (sometimes) in a public forum may scare people off, but more
20382 importantly, talking about new experimental features that have been
20383 introduced may confuse casual users.  New features are frequently
20384 introduced, fiddled with, and judged to be found wanting, and then
20385 either discarded or totally rewritten.  People reading the mailing list
20386 usually keep up with these rapid changes, while people on the newsgroup
20387 can't be assumed to do so.
20388
20389
20390
20391 @node Contributors
20392 @subsection Contributors
20393 @cindex contributors
20394
20395 The new Gnus version couldn't have been done without the help of all the
20396 people on the (ding) mailing list.  Every day for over a year I have
20397 gotten billions of nice bug reports from them, filling me with joy,
20398 every single one of them.  Smooches.  The people on the list have been
20399 tried beyond endurance, what with my ``oh, that's a neat idea <type
20400 type>, yup, I'll release it right away <ship off> no wait, that doesn't
20401 work at all <type type>, yup, I'll ship that one off right away <ship
20402 off> no, wait, that absolutely does not work'' policy for releases.
20403 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
20404 ``worser''? ``much worser''?  ``worsest''?)
20405
20406 I would like to take this opportunity to thank the Academy for...  oops,
20407 wrong show.
20408
20409 @itemize @bullet
20410
20411 @item
20412 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
20413
20414 @item
20415 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
20416 nnwarchive and many, many other things connected with @sc{mime} and
20417 other types of en/decoding, as well as general bug fixing, new
20418 functionality and stuff.
20419
20420 @item
20421 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
20422 well as numerous other things).
20423
20424 @item
20425 Luis Fernandes---design and graphics.
20426
20427 @item
20428 Joe Reiss---creator of the smiley faces.
20429
20430 @item
20431 Justin Sheehy--the FAQ maintainer.
20432
20433 @item
20434 Erik Naggum---help, ideas, support, code and stuff.
20435
20436 @item
20437 Wes Hardaker---@file{gnus-picon.el} and the manual section on
20438 @dfn{picons} (@pxref{Picons}).
20439
20440 @item
20441 Kim-Minh Kaplan---further work on the picon code.
20442
20443 @item
20444 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
20445 (@pxref{GroupLens}).
20446
20447 @item
20448 Sudish Joseph---innumerable bug fixes.
20449
20450 @item
20451 Ilja Weis---@file{gnus-topic.el}.
20452
20453 @item
20454 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
20455
20456 @item
20457 Vladimir Alexiev---the refcard and reference booklets.
20458
20459 @item
20460 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
20461 distribution by Felix Lee and JWZ.
20462
20463 @item
20464 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
20465
20466 @item
20467 Peter Mutsaers---orphan article scoring code.
20468
20469 @item
20470 Ken Raeburn---POP mail support.
20471
20472 @item
20473 Hallvard B Furuseth---various bits and pieces, especially dealing with
20474 .newsrc files.
20475
20476 @item
20477 Brian Edmonds---@file{gnus-bbdb.el}.
20478
20479 @item
20480 David Moore---rewrite of @file{nnvirtual.el} and many other things.
20481
20482 @item
20483 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
20484
20485 @item
20486 François Pinard---many, many interesting and thorough bug reports, as
20487 well as autoconf support.
20488
20489 @end itemize
20490
20491 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
20492 Borges, and Jost Krieger proof-reading parts of the manual.
20493
20494 The following people have contributed many patches and suggestions:
20495
20496 Christopher Davis,
20497 Andrew Eskilsson,
20498 Kai Grossjohann,
20499 David KÃ¥gedal,
20500 Richard Pieri,
20501 Fabrice Popineau,
20502 Daniel Quinlan,
20503 Jason L. Tibbitts, III,
20504 and
20505 Jack Vinson.
20506
20507 Also thanks to the following for patches and stuff:
20508
20509 Jari Aalto,
20510 Adrian Aichner,
20511 Vladimir Alexiev,
20512 Russ Allbery,
20513 Peter Arius,
20514 Matt Armstrong,
20515 Marc Auslander,
20516 Miles Bader,
20517 Alexei V. Barantsev,
20518 Frank Bennett,
20519 Robert Bihlmeyer,
20520 Chris Bone,
20521 Mark Borges,
20522 Mark Boyns,
20523 Lance A. Brown,
20524 Rob Browning,
20525 Kees de Bruin,
20526 Martin Buchholz,
20527 Joe Buehler,
20528 Kevin Buhr,
20529 Alastair Burt,
20530 Joao Cachopo,
20531 Zlatko Calusic,
20532 Massimo Campostrini,
20533 Castor,
20534 David Charlap,
20535 Dan Christensen,
20536 Kevin Christian,
20537 Jae-you Chung, @c ?
20538 James H. Cloos, Jr.,
20539 Laura Conrad,
20540 Michael R. Cook,
20541 Glenn Coombs,
20542 Andrew J. Cosgriff,
20543 Neil Crellin,
20544 Frank D. Cringle,
20545 Geoffrey T. Dairiki,
20546 Andre Deparade,
20547 Ulrik Dickow,
20548 Dave Disser,
20549 Rui-Tao Dong, @c ?
20550 Joev Dubach,
20551 Michael Welsh Duggan,
20552 Dave Edmondson,
20553 Paul Eggert,
20554 Mark W. Eichin,
20555 Karl Eichwalder,
20556 Enami Tsugutomo, @c Enami
20557 Michael Ernst,
20558 Luc Van Eycken,
20559 Sam Falkner,
20560 Nelson Jose dos Santos Ferreira,
20561 Sigbjorn Finne,
20562 Sven Fischer,
20563 Paul Fisher,
20564 Decklin Foster,
20565 Gary D. Foster,
20566 Paul Franklin,
20567 Guy Geens,
20568 Arne Georg Gleditsch,
20569 David S. Goldberg,
20570 Michelangelo Grigni,
20571 Dale Hagglund,
20572 D. Hall,
20573 Magnus Hammerin,
20574 Kenichi Handa, @c Handa
20575 Raja R. Harinath,
20576 Yoshiki Hayashi, @c ?
20577 P. E. Jareth Hein,
20578 Hisashige Kenji, @c Hisashige
20579 Scott Hofmann,
20580 Marc Horowitz,
20581 Gunnar Horrigmo,
20582 Richard Hoskins,
20583 Brad Howes,
20584 Miguel de Icaza,
20585 François Felix Ingrand,
20586 Tatsuya Ichikawa, @c ?
20587 Ishikawa Ichiro, @c Ishikawa
20588 Lee Iverson,
20589 Iwamuro Motonori, @c Iwamuro
20590 Rajappa Iyer,
20591 Andreas Jaeger,
20592 Adam P. Jenkins,
20593 Randell Jesup,
20594 Fred Johansen,
20595 Gareth Jones,
20596 Simon Josefsson,
20597 Greg Klanderman,
20598 Karl Kleinpaste,
20599 Michael Klingbeil,
20600 Peter Skov Knudsen,
20601 Shuhei Kobayashi, @c Kobayashi
20602 Petr Konecny,
20603 Koseki Yoshinori, @c Koseki
20604 Thor Kristoffersen,
20605 Jens Lautenbacher,
20606 Martin Larose,
20607 Seokchan Lee, @c Lee
20608 Joerg Lenneis,
20609 Carsten Leonhardt,
20610 James LewisMoss,
20611 Christian Limpach,
20612 Markus Linnala,
20613 Dave Love,
20614 Mike McEwan,
20615 Tonny Madsen,
20616 Shlomo Mahlab,
20617 Nat Makarevitch,
20618 Istvan Marko,
20619 David Martin,
20620 Jason R. Mastaler,
20621 Gordon Matzigkeit,
20622 Timo Metzemakers,
20623 Richard Mlynarik,
20624 Lantz Moore,
20625 Morioka Tomohiko, @c Morioka
20626 Erik Toubro Nielsen,
20627 Hrvoje Niksic,
20628 Andy Norman,
20629 Fred Oberhauser,
20630 C. R. Oldham,
20631 Alexandre Oliva,
20632 Ken Olstad,
20633 Masaharu Onishi, @c Onishi
20634 Hideki Ono, @c Ono
20635 Ettore Perazzoli,
20636 William Perry,
20637 Stephen Peters,
20638 Jens-Ulrik Holger Petersen,
20639 Ulrich Pfeifer,
20640 Matt Pharr,
20641 Andy Piper,
20642 John McClary Prevost,
20643 Bill Pringlemeir,
20644 Mike Pullen,
20645 Jim Radford,
20646 Colin Rafferty,
20647 Lasse Rasinen,
20648 Lars Balker Rasmussen,
20649 Joe Reiss,
20650 Renaud Rioboo,
20651 Roland B. Roberts,
20652 Bart Robinson,
20653 Christian von Roques,
20654 Markus Rost,
20655 Jason Rumney,
20656 Wolfgang Rupprecht,
20657 Jay Sachs,
20658 Dewey M. Sasser,
20659 Conrad Sauerwald,
20660 Loren Schall,
20661 Dan Schmidt,
20662 Ralph Schleicher,
20663 Philippe Schnoebelen,
20664 Andreas Schwab,
20665 Randal L. Schwartz,
20666 Danny Siu,
20667 Matt Simmons,
20668 Paul D. Smith,
20669 Jeff Sparkes,
20670 Toby Speight,
20671 Michael Sperber,
20672 Darren Stalder,
20673 Richard Stallman,
20674 Greg Stark,
20675 Sam Steingold,
20676 Paul Stevenson,
20677 Jonas Steverud,
20678 Paul Stodghill,
20679 Kiyokazu Suto, @c Suto
20680 Kurt Swanson,
20681 Samuel Tardieu,
20682 Teddy,
20683 Chuck Thompson,
20684 Tozawa Akihiko, @c Tozawa
20685 Philippe Troin,
20686 James Troup,
20687 Trung Tran-Duc,
20688 Jack Twilley,
20689 Aaron M. Ucko,
20690 Aki Vehtari,
20691 Didier Verna,
20692 Vladimir Volovich,
20693 Jan Vroonhof,
20694 Stefan Waldherr,
20695 Pete Ware,
20696 Barry A. Warsaw,
20697 Christoph Wedler,
20698 Joe Wells,
20699 Lee Willis,
20700 Katsumi Yamaoka @c Yamaoka
20701 and
20702 Lloyd Zusman.
20703
20704
20705 For a full overview of what each person has done, the ChangeLogs
20706 included in the Gnus alpha distributions should give ample reading
20707 (550kB and counting).
20708
20709 Apologies to everybody that I've forgotten, of which there are many, I'm
20710 sure.
20711
20712 Gee, that's quite a list of people.  I guess that must mean that there
20713 actually are people who are using Gnus.  Who'd'a thunk it!
20714
20715
20716 @node New Features
20717 @subsection New Features
20718 @cindex new features
20719
20720 @menu
20721 * ding Gnus::                   New things in Gnus 5.0/5.1, the first new Gnus.
20722 * September Gnus::              The Thing Formally Known As Gnus 5.2/5.3.
20723 * Red Gnus::                    Third time best---Gnus 5.4/5.5.
20724 * Quassia Gnus::                Two times two is four, or Gnus 5.6/5.7.
20725 * Pterodactyl Gnus::            Pentad also starts with P, AKA Gnus 5.8/5.9.
20726 @end menu
20727
20728 These lists are, of course, just @emph{short} overviews of the
20729 @emph{most} important new features.  No, really.  There are tons more.
20730 Yes, we have feeping creaturism in full effect.
20731
20732 @node ding Gnus
20733 @subsubsection (ding) Gnus
20734
20735 New features in Gnus 5.0/5.1:
20736
20737 @itemize @bullet
20738
20739 @item
20740 The look of all buffers can be changed by setting format-like variables
20741 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
20742
20743 @item
20744 Local spool and several @sc{nntp} servers can be used at once
20745 (@pxref{Select Methods}).
20746
20747 @item
20748 You can combine groups into virtual groups (@pxref{Virtual Groups}).
20749
20750 @item
20751 You can read a number of different mail formats (@pxref{Getting Mail}).
20752 All the mail back ends implement a convenient mail expiry scheme
20753 (@pxref{Expiring Mail}).
20754
20755 @item
20756 Gnus can use various strategies for gathering threads that have lost
20757 their roots (thereby gathering loose sub-threads into one thread) or it
20758 can go back and retrieve enough headers to build a complete thread
20759 (@pxref{Customizing Threading}).
20760
20761 @item
20762 Killed groups can be displayed in the group buffer, and you can read
20763 them as well (@pxref{Listing Groups}).
20764
20765 @item
20766 Gnus can do partial group updates---you do not have to retrieve the
20767 entire active file just to check for new articles in a few groups
20768 (@pxref{The Active File}).
20769
20770 @item
20771 Gnus implements a sliding scale of subscribedness to groups
20772 (@pxref{Group Levels}).
20773
20774 @item
20775 You can score articles according to any number of criteria
20776 (@pxref{Scoring}).  You can even get Gnus to find out how to score
20777 articles for you (@pxref{Adaptive Scoring}).
20778
20779 @item
20780 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
20781 manner, so it should be difficult to lose much data on what you have
20782 read if your machine should go down (@pxref{Auto Save}).
20783
20784 @item
20785 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
20786 the @file{.emacs} file.
20787
20788 @item
20789 You can set the process mark on both groups and articles and perform
20790 operations on all the marked items (@pxref{Process/Prefix}).
20791
20792 @item
20793 You can grep through a subset of groups and create a group from the
20794 results (@pxref{Kibozed Groups}).
20795
20796 @item
20797 You can list subsets of groups according to, well, anything
20798 (@pxref{Listing Groups}).
20799
20800 @item
20801 You can browse foreign servers and subscribe to groups from those
20802 servers (@pxref{Browse Foreign Server}).
20803
20804 @item
20805 Gnus can fetch articles, asynchronously, on a second connection to the
20806 server (@pxref{Asynchronous Fetching}).
20807
20808 @item
20809 You can cache articles locally (@pxref{Article Caching}).
20810
20811 @item
20812 The uudecode functions have been expanded and generalized
20813 (@pxref{Decoding Articles}).
20814
20815 @item
20816 You can still post uuencoded articles, which was a little-known feature
20817 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
20818
20819 @item
20820 Fetching parents (and other articles) now actually works without
20821 glitches (@pxref{Finding the Parent}).
20822
20823 @item
20824 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
20825
20826 @item
20827 Digests (and other files) can be used as the basis for groups
20828 (@pxref{Document Groups}).
20829
20830 @item
20831 Articles can be highlighted and customized (@pxref{Customizing
20832 Articles}).
20833
20834 @item
20835 URLs and other external references can be buttonized (@pxref{Article
20836 Buttons}).
20837
20838 @item
20839 You can do lots of strange stuff with the Gnus window & frame
20840 configuration (@pxref{Window Layout}).
20841
20842 @item
20843 You can click on buttons instead of using the keyboard
20844 (@pxref{Buttons}).
20845
20846 @end itemize
20847
20848
20849 @node September Gnus
20850 @subsubsection September Gnus
20851
20852 @iftex
20853 @iflatex
20854 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
20855 @end iflatex
20856 @end iftex
20857
20858 New features in Gnus 5.2/5.3:
20859
20860 @itemize @bullet
20861
20862 @item
20863 A new message composition mode is used.  All old customization variables
20864 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
20865 now obsolete.
20866
20867 @item
20868 Gnus is now able to generate @dfn{sparse} threads---threads where
20869 missing articles are represented by empty nodes (@pxref{Customizing
20870 Threading}).
20871
20872 @lisp
20873 (setq gnus-build-sparse-threads 'some)
20874 @end lisp
20875
20876 @item
20877 Outgoing articles are stored on a special archive server
20878 (@pxref{Archived Messages}).
20879
20880 @item
20881 Partial thread regeneration now happens when articles are
20882 referred.
20883
20884 @item
20885 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
20886
20887 @item
20888 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
20889
20890 @item
20891 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
20892
20893 @lisp
20894 (setq gnus-use-trees t)
20895 @end lisp
20896
20897 @item
20898 An @code{nn}-like pick-and-read minor mode is available for the summary
20899 buffers (@pxref{Pick and Read}).
20900
20901 @lisp
20902 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
20903 @end lisp
20904
20905 @item
20906 In binary groups you can use a special binary minor mode (@pxref{Binary
20907 Groups}).
20908
20909 @item
20910 Groups can be grouped in a folding topic hierarchy (@pxref{Group
20911 Topics}).
20912
20913 @lisp
20914 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
20915 @end lisp
20916
20917 @item
20918 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
20919
20920 @item
20921 Groups can now have a score, and bubbling based on entry frequency
20922 is possible (@pxref{Group Score}).
20923
20924 @lisp
20925 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
20926 @end lisp
20927
20928 @item
20929 Groups can be process-marked, and commands can be performed on
20930 groups of groups (@pxref{Marking Groups}).
20931
20932 @item
20933 Caching is possible in virtual groups.
20934
20935 @item
20936 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
20937 news batches, ClariNet briefs collections, and just about everything
20938 else (@pxref{Document Groups}).
20939
20940 @item
20941 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
20942 (@pxref{SOUP}).
20943
20944 @item
20945 The Gnus cache is much faster.
20946
20947 @item
20948 Groups can be sorted according to many criteria (@pxref{Sorting
20949 Groups}).
20950
20951 @item
20952 New group parameters have been introduced to set list-addresses and
20953 expiry times (@pxref{Group Parameters}).
20954
20955 @item
20956 All formatting specs allow specifying faces to be used
20957 (@pxref{Formatting Fonts}).
20958
20959 @item
20960 There are several more commands for setting/removing/acting on process
20961 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
20962
20963 @item
20964 The summary buffer can be limited to show parts of the available
20965 articles based on a wide range of criteria.  These commands have been
20966 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
20967
20968 @item
20969 Articles can be made persistent with the @kbd{*} command
20970 (@pxref{Persistent Articles}).
20971
20972 @item
20973 All functions for hiding article elements are now toggles.
20974
20975 @item
20976 Article headers can be buttonized (@pxref{Article Washing}).
20977
20978 @item
20979 All mail back ends support fetching articles by @code{Message-ID}.
20980
20981 @item
20982 Duplicate mail can now be treated properly (@pxref{Duplicates}).
20983
20984 @item
20985 All summary mode commands are available directly from the article
20986 buffer (@pxref{Article Keymap}).
20987
20988 @item
20989 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
20990 Layout}).
20991
20992 @item
20993 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
20994 @iftex
20995 @iflatex
20996 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
20997 @end iflatex
20998 @end iftex
20999
21000 @item
21001 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
21002
21003 @lisp
21004 (setq gnus-use-nocem t)
21005 @end lisp
21006
21007 @item
21008 Groups can be made permanently visible (@pxref{Listing Groups}).
21009
21010 @lisp
21011 (setq gnus-permanently-visible-groups "^nnml:")
21012 @end lisp
21013
21014 @item
21015 Many new hooks have been introduced to make customizing easier.
21016
21017 @item
21018 Gnus respects the @code{Mail-Copies-To} header.
21019
21020 @item
21021 Threads can be gathered by looking at the @code{References} header
21022 (@pxref{Customizing Threading}).
21023
21024 @lisp
21025 (setq gnus-summary-thread-gathering-function
21026       'gnus-gather-threads-by-references)
21027 @end lisp
21028
21029 @item
21030 Read articles can be stored in a special backlog buffer to avoid
21031 refetching (@pxref{Article Backlog}).
21032
21033 @lisp
21034 (setq gnus-keep-backlog 50)
21035 @end lisp
21036
21037 @item
21038 A clean copy of the current article is always stored in a separate
21039 buffer to allow easier treatment.
21040
21041 @item
21042 Gnus can suggest where to save articles (@pxref{Saving Articles}).
21043
21044 @item
21045 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
21046 Articles}).
21047
21048 @lisp
21049 (setq gnus-prompt-before-saving t)
21050 @end lisp
21051
21052 @item
21053 @code{gnus-uu} can view decoded files asynchronously while fetching
21054 articles (@pxref{Other Decode Variables}).
21055
21056 @lisp
21057 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
21058 @end lisp
21059
21060 @item
21061 Filling in the article buffer now works properly on cited text
21062 (@pxref{Article Washing}).
21063
21064 @item
21065 Hiding cited text adds buttons to toggle hiding, and how much
21066 cited text to hide is now customizable (@pxref{Article Hiding}).
21067
21068 @lisp
21069 (setq gnus-cited-lines-visible 2)
21070 @end lisp
21071
21072 @item
21073 Boring headers can be hidden (@pxref{Article Hiding}).
21074
21075 @item
21076 Default scoring values can now be set from the menu bar.
21077
21078 @item
21079 Further syntax checking of outgoing articles have been added.
21080
21081 @end itemize
21082
21083
21084 @node Red Gnus
21085 @subsubsection Red Gnus
21086
21087 New features in Gnus 5.4/5.5:
21088
21089 @iftex
21090 @iflatex
21091 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
21092 @end iflatex
21093 @end iftex
21094
21095 @itemize @bullet
21096
21097 @item
21098 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
21099
21100 @item
21101 Article prefetching functionality has been moved up into
21102 Gnus (@pxref{Asynchronous Fetching}).
21103
21104 @item
21105 Scoring can now be performed with logical operators like @code{and},
21106 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
21107 Scoring}).
21108
21109 @item
21110 Article washing status can be displayed in the
21111 article mode line (@pxref{Misc Article}).
21112
21113 @item
21114 @file{gnus.el} has been split into many smaller files.
21115
21116 @item
21117 Suppression of duplicate articles based on Message-ID can be done
21118 (@pxref{Duplicate Suppression}).
21119
21120 @lisp
21121 (setq gnus-suppress-duplicates t)
21122 @end lisp
21123
21124 @item
21125 New variables for specifying what score and adapt files are to be
21126 considered home score and adapt files (@pxref{Home Score File}) have
21127 been added.
21128
21129 @item
21130 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
21131 Server Internals}).
21132
21133 @item
21134 Groups can inherit group parameters from parent topics (@pxref{Topic
21135 Parameters}).
21136
21137 @item
21138 Article editing has been revamped and is now actually usable.
21139
21140 @item
21141 Signatures can be recognized in more intelligent fashions
21142 (@pxref{Article Signature}).
21143
21144 @item
21145 Summary pick mode has been made to look more @code{nn}-like.  Line
21146 numbers are displayed and the @kbd{.} command can be used to pick
21147 articles (@code{Pick and Read}).
21148
21149 @item
21150 Commands for moving the @file{.newsrc.eld} from one server to
21151 another have been added (@pxref{Changing Servers}).
21152
21153 @item
21154 There's a way now to specify that ``uninteresting'' fields be suppressed
21155 when generating lines in buffers (@pxref{Advanced Formatting}).
21156
21157 @item
21158 Several commands in the group buffer can be undone with @kbd{C-M-_}
21159 (@pxref{Undo}).
21160
21161 @item
21162 Scoring can be done on words using the new score type @code{w}
21163 (@pxref{Score File Format}).
21164
21165 @item
21166 Adaptive scoring can be done on a Subject word-by-word basis
21167 (@pxref{Adaptive Scoring}).
21168
21169 @lisp
21170 (setq gnus-use-adaptive-scoring '(word))
21171 @end lisp
21172
21173 @item
21174 Scores can be decayed (@pxref{Score Decays}).
21175
21176 @lisp
21177 (setq gnus-decay-scores t)
21178 @end lisp
21179
21180 @item
21181 Scoring can be performed using a regexp on the Date header.  The Date is
21182 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
21183
21184 @item
21185 A new command has been added to remove all data on articles from
21186 the native server (@pxref{Changing Servers}).
21187
21188 @item
21189 A new command for reading collections of documents
21190 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
21191 (@pxref{Really Various Summary Commands}).
21192
21193 @item
21194 Process mark sets can be pushed and popped (@pxref{Setting Process
21195 Marks}).
21196
21197 @item
21198 A new mail-to-news back end makes it possible to post even when the @sc{nntp}
21199 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
21200
21201 @item
21202 A new back end for reading searches from Web search engines
21203 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
21204 (@pxref{Web Searches}).
21205
21206 @item
21207 Groups inside topics can now be sorted using the standard sorting
21208 functions, and each topic can be sorted independently (@pxref{Topic
21209 Sorting}).
21210
21211 @item
21212 Subsets of the groups can be sorted independently (@code{Sorting
21213 Groups}).
21214
21215 @item
21216 Cached articles can be pulled into the groups (@pxref{Summary Generation
21217 Commands}).
21218 @iftex
21219 @iflatex
21220 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
21221 @end iflatex
21222 @end iftex
21223
21224 @item
21225 Score files are now applied in a more reliable order (@pxref{Score
21226 Variables}).
21227
21228 @item
21229 Reports on where mail messages end up can be generated (@pxref{Splitting
21230 Mail}).
21231
21232 @item
21233 More hooks and functions have been added to remove junk from incoming
21234 mail before saving the mail (@pxref{Washing Mail}).
21235
21236 @item
21237 Emphasized text can be properly fontisized:
21238
21239 @end itemize
21240
21241
21242 @node Quassia Gnus
21243 @subsubsection Quassia Gnus
21244
21245 New features in Gnus 5.6:
21246
21247 @itemize @bullet
21248
21249 @item
21250 New functionality for using Gnus as an offline newsreader has been
21251 added.  A plethora of new commands and modes have been added.  See
21252 @pxref{Gnus Unplugged} for the full story.
21253
21254 @item
21255  The @code{nndraft} back end has returned, but works differently than
21256 before.  All Message buffers are now also articles in the @code{nndraft}
21257 group, which is created automatically.
21258
21259 @item
21260 @code{gnus-alter-header-function} can now be used to alter header
21261 values.
21262
21263 @item
21264  @code{gnus-summary-goto-article} now accept Message-ID's.
21265
21266 @item
21267  A new Message command for deleting text in the body of a message
21268 outside the region: @kbd{C-c C-v}.
21269
21270 @item
21271  You can now post to component group in @code{nnvirtual} groups with
21272 @kbd{C-u C-c C-c}.
21273
21274 @item
21275  @code{nntp-rlogin-program}---new variable to ease customization.
21276
21277 @item
21278  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
21279 re-highlighting of the article buffer.
21280
21281 @item
21282  New element in @code{gnus-boring-article-headers}---@code{long-to}.
21283
21284 @item
21285  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
21286 Prefixes" in the Gnus manual for details.
21287
21288 @item
21289  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
21290 @kbd{a} to add the score rule to the "all.SCORE" file.
21291
21292 @item
21293  @code{gnus-simplify-subject-functions} variable to allow greater
21294 control over simplification.
21295
21296 @item
21297  @kbd{A T}---new command for fetching the current thread.
21298
21299 @item
21300  @kbd{/ T}---new command for including the current thread in the
21301 limit.
21302
21303 @item
21304  @kbd{M-RET} is a new Message command for breaking cited text.
21305
21306 @item
21307  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
21308
21309 @item
21310  The @code{custom-face-lookup} function has been removed.
21311 If you used this function in your initialization files, you must
21312 rewrite them to use @code{face-spec-set} instead.
21313
21314 @item
21315  Canceling now uses the current select method.  Symbolic prefix
21316 @kbd{a} forces normal posting method.
21317
21318 @item
21319  New command to translate M******** sm*rtq**t*s into proper
21320 text---@kbd{W d}.
21321
21322 @item
21323  For easier debugging of @code{nntp}, you can set
21324 @code{nntp-record-commands} to a non-@code{nil} value.
21325
21326 @item
21327  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
21328 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
21329
21330 @item
21331  A command for editing group parameters from the summary buffer
21332 has been added.
21333
21334 @item
21335  A history of where mails have been split is available.
21336
21337 @item
21338  A new article date command has been added---@code{article-date-iso8601}.
21339
21340 @item
21341  Subjects can be simplified when threading by setting
21342 @code{gnus-score-thread-simplify}.
21343
21344 @item
21345  A new function for citing in Message has been
21346 added---@code{message-cite-original-without-signature}.
21347
21348 @item
21349  @code{article-strip-all-blank-lines}---new article command.
21350
21351 @item
21352  A new Message command to kill to the end of the article has
21353 been added.
21354
21355 @item
21356  A minimum adaptive score can be specified by using the
21357 @code{gnus-adaptive-word-minimum} variable.
21358
21359 @item
21360  The "lapsed date" article header can be kept continually
21361 updated by the @code{gnus-start-date-timer} command.
21362
21363 @item
21364  Web listserv archives can be read with the @code{nnlistserv} back end.
21365
21366 @item
21367  Old dejanews archives can now be read by @code{nnweb}.
21368
21369 @end itemize
21370
21371 @node Pterodactyl Gnus
21372 @subsubsection Pterodactyl Gnus
21373
21374 New features in Gnus 5.8:
21375
21376 @itemize @bullet
21377
21378 @item 
21379 The mail-fetching functions have changed.  See the manual for the
21380 many details.  In particular, all procmail fetching variables are gone.
21381
21382 If you used procmail like in
21383
21384 @lisp
21385 (setq nnmail-use-procmail t)
21386 (setq nnmail-spool-file 'procmail)
21387 (setq nnmail-procmail-directory "~/mail/incoming/")
21388 (setq nnmail-procmail-suffix "\\.in")
21389 @end lisp
21390
21391 this now has changed to
21392
21393 @lisp
21394 (setq mail-sources
21395       '((directory :path "~/mail/incoming/"
21396                    :suffix ".in")))
21397 @end lisp
21398
21399 More information is available in the info doc at Select Methods ->
21400 Getting Mail -> Mail Sources
21401
21402 @item 
21403 Gnus is now a MIME-capable reader.  This affects many parts of
21404 Gnus, and adds a slew of new commands.  See the manual for details.
21405
21406 @item
21407 Gnus has also been multilingualized.  This also affects too
21408 many parts of Gnus to summarize here, and adds many new variables.
21409
21410 @item
21411 @code{gnus-auto-select-first} can now be a function to be
21412 called to position point.
21413
21414 @item
21415 The user can now decide which extra headers should be included in
21416 summary buffers and NOV files.
21417
21418 @item
21419 @code{gnus-article-display-hook} has been removed.  Instead, a number
21420 of variables starting with @code{gnus-treat-} have been added.
21421
21422 @item
21423 The Gnus posting styles have been redone again and now works in a
21424 subtly different manner.
21425
21426 @item
21427 New web-based back ends have been added: @code{nnslashdot},
21428 @code{nnwarchive} and @code{nnultimate}.  nnweb has been revamped,
21429 again, to keep up with ever-changing layouts.
21430
21431 @item
21432 Gnus can now read IMAP mail via @code{nnimap}.
21433
21434 @end itemize
21435
21436 @iftex
21437
21438 @page
21439 @node The Manual
21440 @section The Manual
21441 @cindex colophon
21442 @cindex manual
21443
21444 This manual was generated from a TeXinfo file and then run through
21445 either @code{texi2dvi}
21446 @iflatex
21447 or my own home-brewed TeXinfo to \LaTeX\ transformer,
21448 and then run through @code{latex} and @code{dvips}
21449 @end iflatex
21450 to get what you hold in your hands now.
21451
21452 The following conventions have been used:
21453
21454 @enumerate
21455
21456 @item
21457 This is a @samp{string}
21458
21459 @item
21460 This is a @kbd{keystroke}
21461
21462 @item
21463 This is a @file{file}
21464
21465 @item
21466 This is a @code{symbol}
21467
21468 @end enumerate
21469
21470 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
21471 mean:
21472
21473 @lisp
21474 (setq flargnoze "yes")
21475 @end lisp
21476
21477 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
21478
21479 @lisp
21480 (setq flumphel 'yes)
21481 @end lisp
21482
21483 @samp{yes} and @code{yes} are two @emph{very} different things---don't
21484 ever get them confused.
21485
21486 @iflatex
21487 @c @head
21488 Of course, everything in this manual is of vital interest, so you should
21489 read it all.  Several times.  However, if you feel like skimming the
21490 manual, look for that gnu head you should see in the margin over
21491 there---it means that what's being discussed is of more importance than
21492 the rest of the stuff.  (On the other hand, if everything is infinitely
21493 important, how can anything be more important than that?  Just one more
21494 of the mysteries of this world, I guess.)
21495 @end iflatex
21496
21497 @end iftex
21498
21499
21500 @node On Writing Manuals
21501 @section On Writing Manuals
21502
21503 I guess most manuals are written after-the-fact; documenting a program
21504 that's already there.  This is not how this manual is written.  When
21505 implementing something, I write the manual entry for that something
21506 straight away.  I then see that it's difficult to explain the
21507 functionality, so I write how it's supposed to be, and then I change the
21508 implementation.  Writing the documentation and writing the code goes
21509 hand in hand.
21510
21511 This, of course, means that this manual has no, or little, flow.  It
21512 documents absolutely everything in Gnus, but often not where you're
21513 looking for it.  It is a reference manual, and not a guide to how to get
21514 started with Gnus.
21515
21516 That would be a totally different book, that should be written using the
21517 reference manual as source material.  It would look quite differently.
21518
21519
21520 @page
21521 @node Terminology
21522 @section Terminology
21523
21524 @cindex terminology
21525 @table @dfn
21526
21527 @item news
21528 @cindex news
21529 This is what you are supposed to use this thing for---reading news.
21530 News is generally fetched from a nearby @sc{nntp} server, and is
21531 generally publicly available to everybody.  If you post news, the entire
21532 world is likely to read just what you have written, and they'll all
21533 snigger mischievously.  Behind your back.
21534
21535 @item mail
21536 @cindex mail
21537 Everything that's delivered to you personally is mail.  Some news/mail
21538 readers (like Gnus) blur the distinction between mail and news, but
21539 there is a difference.  Mail is private.  News is public.  Mailing is
21540 not posting, and replying is not following up.
21541
21542 @item reply
21543 @cindex reply
21544 Send a mail to the person who has written what you are reading.
21545
21546 @item follow up
21547 @cindex follow up
21548 Post an article to the current newsgroup responding to the article you
21549 are reading.
21550
21551 @item back end
21552 @cindex back end
21553 Gnus gets fed articles from a number of back ends, both news and mail
21554 back ends.  Gnus does not handle the underlying media, so to speak---this
21555 is all done by the back ends.
21556
21557 @item native
21558 @cindex native
21559 Gnus will always use one method (and back end) as the @dfn{native}, or
21560 default, way of getting news.
21561
21562 @item foreign
21563 @cindex foreign
21564 You can also have any number of foreign groups active at the same time.
21565 These are groups that use non-native non-secondary back ends for getting
21566 news.
21567
21568 @item secondary
21569 @cindex secondary
21570 Secondary back ends are somewhere half-way between being native and being
21571 foreign, but they mostly act like they are native.
21572
21573 @item article
21574 @cindex article
21575 A message that has been posted as news.
21576
21577 @item mail message
21578 @cindex mail message
21579 A message that has been mailed.
21580
21581 @item message
21582 @cindex message
21583 A mail message or news article
21584
21585 @item head
21586 @cindex head
21587 The top part of a message, where administrative information (etc.) is
21588 put.
21589
21590 @item body
21591 @cindex body
21592 The rest of an article.  Everything not in the head is in the
21593 body.
21594
21595 @item header
21596 @cindex header
21597 A line from the head of an article.
21598
21599 @item headers
21600 @cindex headers
21601 A collection of such lines, or a collection of heads.  Or even a
21602 collection of @sc{nov} lines.
21603
21604 @item @sc{nov}
21605 @cindex nov
21606 When Gnus enters a group, it asks the back end for the headers of all
21607 unread articles in the group.  Most servers support the News OverView
21608 format, which is more compact and much faster to read and parse than the
21609 normal @sc{head} format.
21610
21611 @item level
21612 @cindex levels
21613 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
21614 that have a lower level are ``more'' subscribed than the groups with a
21615 higher level.  In fact, groups on levels 1-5 are considered
21616 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
21617 are @dfn{killed}.  Commands for listing groups and scanning for new
21618 articles will all use the numeric prefix as @dfn{working level}.
21619
21620 @item killed groups
21621 @cindex killed groups
21622 No information on killed groups is stored or updated, which makes killed
21623 groups much easier to handle than subscribed groups.
21624
21625 @item zombie groups
21626 @cindex zombie groups
21627 Just like killed groups, only slightly less dead.
21628
21629 @item active file
21630 @cindex active file
21631 The news server has to keep track of what articles it carries, and what
21632 groups exist.  All this information in stored in the active file, which
21633 is rather large, as you might surmise.
21634
21635 @item bogus groups
21636 @cindex bogus groups
21637 A group that exists in the @file{.newsrc} file, but isn't known to the
21638 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
21639 This means that the group probably doesn't exist (any more).
21640
21641 @item activating
21642 @cindex activating groups
21643 The act of asking the server for info on a group and computing the
21644 number of unread articles is called @dfn{activating the group}.
21645 Un-activated groups are listed with @samp{*} in the group buffer.
21646
21647 @item server
21648 @cindex server
21649 A machine one can connect to and get news (or mail) from.
21650
21651 @item select method
21652 @cindex select method
21653 A structure that specifies the back end, the server and the virtual
21654 server settings.
21655
21656 @item virtual server
21657 @cindex virtual server
21658 A named select method.  Since a select method defines all there is to
21659 know about connecting to a (physical) server, taking the thing as a
21660 whole is a virtual server.
21661
21662 @item washing
21663 @cindex washing
21664 Taking a buffer and running it through a filter of some sort.  The
21665 result will (more often than not) be cleaner and more pleasing than the
21666 original.
21667
21668 @item ephemeral groups
21669 @cindex ephemeral groups
21670 Most groups store data on what articles you have read.  @dfn{Ephemeral}
21671 groups are groups that will have no data stored---when you exit the
21672 group, it'll disappear into the aether.
21673
21674 @item solid groups
21675 @cindex solid groups
21676 This is the opposite of ephemeral groups.  All groups listed in the
21677 group buffer are solid groups.
21678
21679 @item sparse articles
21680 @cindex sparse articles
21681 These are article placeholders shown in the summary buffer when
21682 @code{gnus-build-sparse-threads} has been switched on.
21683
21684 @item threading
21685 @cindex threading
21686 To put responses to articles directly after the articles they respond
21687 to---in a hierarchical fashion.
21688
21689 @item root
21690 @cindex root
21691 @cindex thread root
21692 The first article in a thread is the root.  It is the ancestor of all
21693 articles in the thread.
21694
21695 @item parent
21696 @cindex parent
21697 An article that has responses.
21698
21699 @item child
21700 @cindex child
21701 An article that responds to a different article---its parent.
21702
21703 @item digest
21704 @cindex digest
21705 A collection of messages in one file.  The most common digest format is
21706 specified by RFC 1153.
21707
21708 @end table
21709
21710
21711 @page
21712 @node Customization
21713 @section Customization
21714 @cindex general customization
21715
21716 All variables are properly documented elsewhere in this manual.  This
21717 section is designed to give general pointers on how to customize Gnus
21718 for some quite common situations.
21719
21720 @menu
21721 * Slow/Expensive Connection::   You run a local Emacs and get the news elsewhere.
21722 * Slow Terminal Connection::    You run a remote Emacs.
21723 * Little Disk Space::           You feel that having large setup files is icky.
21724 * Slow Machine::                You feel like buying a faster machine.
21725 @end menu
21726
21727
21728 @node Slow/Expensive Connection
21729 @subsection Slow/Expensive @sc{nntp} Connection
21730
21731 If you run Emacs on a machine locally, and get your news from a machine
21732 over some very thin strings, you want to cut down on the amount of data
21733 Gnus has to get from the @sc{nntp} server.
21734
21735 @table @code
21736
21737 @item gnus-read-active-file
21738 Set this to @code{nil}, which will inhibit Gnus from requesting the
21739 entire active file from the server.  This file is often v.  large.  You
21740 also have to set @code{gnus-check-new-newsgroups} and
21741 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
21742 doesn't suddenly decide to fetch the active file anyway.
21743
21744 @item gnus-nov-is-evil
21745 This one has to be @code{nil}.  If not, grabbing article headers from
21746 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
21747 support @sc{xover}; Gnus will detect this by itself.
21748 @end table
21749
21750
21751 @node Slow Terminal Connection
21752 @subsection Slow Terminal Connection
21753
21754 Let's say you use your home computer for dialing up the system that runs
21755 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
21756 possible) the amount of data sent over the wires.
21757
21758 @table @code
21759
21760 @item gnus-auto-center-summary
21761 Set this to @code{nil} to inhibit Gnus from re-centering the summary
21762 buffer all the time.  If it is @code{vertical}, do only vertical
21763 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
21764 horizontal and vertical recentering.
21765
21766 @item gnus-visible-headers
21767 Cut down on the headers included in the articles to the
21768 minimum.  You can, in fact, make do without them altogether---most of the
21769 useful data is in the summary buffer, anyway.  Set this variable to
21770 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
21771
21772 Set this hook to all the available hiding commands:
21773 @lisp
21774 (setq gnus-treat-hide-headers 'head
21775       gnus-treat-hide-signature t
21776       gnus-treat-hide-citation t)
21777 @end lisp
21778
21779 @item gnus-use-full-window
21780 By setting this to @code{nil}, you can make all the windows smaller.
21781 While this doesn't really cut down much generally, it means that you
21782 have to see smaller portions of articles before deciding that you didn't
21783 want to read them anyway.
21784
21785 @item gnus-thread-hide-subtree
21786 If this is non-@code{nil}, all threads in the summary buffer will be
21787 hidden initially.
21788
21789 @item gnus-updated-mode-lines
21790 If this is @code{nil}, Gnus will not put information in the buffer mode
21791 lines, which might save some time.
21792 @end table
21793
21794
21795 @node Little Disk Space
21796 @subsection Little Disk Space
21797 @cindex disk space
21798
21799 The startup files can get rather large, so you may want to cut their
21800 sizes a bit if you are running out of space.
21801
21802 @table @code
21803
21804 @item gnus-save-newsrc-file
21805 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
21806 only save @file{.newsrc.eld}.  This means that you will not be able to
21807 use any other newsreaders than Gnus.  This variable is @code{t} by
21808 default.
21809
21810 @item gnus-read-newsrc-file
21811 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
21812 only read @file{.newsrc.eld}.  This means that you will not be able to
21813 use any other newsreaders than Gnus.  This variable is @code{t} by
21814 default.
21815
21816 @item gnus-save-killed-list
21817 If this is @code{nil}, Gnus will not save the list of dead groups.  You
21818 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
21819 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
21820 variable to @code{nil}.  This variable is @code{t} by default.
21821
21822 @end table
21823
21824
21825 @node Slow Machine
21826 @subsection Slow Machine
21827 @cindex slow machine
21828
21829 If you have a slow machine, or are just really impatient, there are a
21830 few things you can do to make Gnus run faster.
21831
21832 Set @code{gnus-check-new-newsgroups} and
21833 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
21834
21835 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
21836 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
21837 summary buffer faster.
21838
21839
21840 @page
21841 @node Troubleshooting
21842 @section Troubleshooting
21843 @cindex troubleshooting
21844
21845 Gnus works @emph{so} well straight out of the box---I can't imagine any
21846 problems, really.
21847
21848 Ahem.
21849
21850 @enumerate
21851
21852 @item
21853 Make sure your computer is switched on.
21854
21855 @item
21856 Make sure that you really load the current Gnus version.  If you have
21857 been running @sc{gnus}, you need to exit Emacs and start it up again before
21858 Gnus will work.
21859
21860 @item
21861 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
21862 like @samp{T-gnus 6.15.* (based on Oort Gnus v0.*; for SEMI 1.1*, FLIM
21863 1.1*)} you have the right files loaded.  If, on the other hand, you get
21864 something like @samp{NNTP 3.x} or @samp{nntp flee}, you have some old
21865 @file{.el} files lying around.  Delete these.
21866
21867 @item
21868 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
21869 how-to.
21870
21871 @item
21872 @vindex max-lisp-eval-depth
21873 Gnus works on many recursive structures, and in some extreme (and very
21874 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
21875 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
21876 something like that.
21877 @end enumerate
21878
21879 If all else fails, report the problem as a bug.
21880
21881 @cindex bugs
21882 @cindex reporting bugs
21883
21884 @kindex M-x gnus-bug
21885 @findex gnus-bug
21886 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
21887 command.  @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
21888 me the backtrace.  I will fix bugs, but I can only fix them if you send
21889 me a precise description as to how to reproduce the bug.
21890
21891 You really can never be too detailed in a bug report.  Always use the
21892 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
21893 a 10Kb mail each time you use it, and even if you have sent me your
21894 environment 500 times before.  I don't care.  I want the full info each
21895 time.
21896
21897 It is also important to remember that I have no memory whatsoever.  If
21898 you send a bug report, and I send you a reply, and then you just send
21899 back ``No, it's not! Moron!'', I will have no idea what you are
21900 insulting me about.  Always over-explain everything.  It's much easier
21901 for all of us---if I don't have all the information I need, I will just
21902 mail you and ask for more info, and everything takes more time.
21903
21904 If the problem you're seeing is very visual, and you can't quite explain
21905 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
21906 it somewhere it can be reached, and include the URL of the picture in
21907 the bug report.
21908
21909 @cindex patches
21910 If you would like to contribute a patch to fix bugs or make
21911 improvements, please produce the patch using @samp{diff -u}.
21912
21913 If you just need help, you are better off asking on
21914 @samp{gnu.emacs.gnus}.  I'm not very helpful.
21915
21916 @cindex gnu.emacs.gnus
21917 @cindex ding mailing list
21918 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
21919 Write to @samp{ding-request@@gnus.org} to subscribe.
21920
21921
21922 @page
21923 @node Gnus Reference Guide
21924 @section Gnus Reference Guide
21925
21926 It is my hope that other people will figure out smart stuff that Gnus
21927 can do, and that other people will write those smart things as well.  To
21928 facilitate that I thought it would be a good idea to describe the inner
21929 workings of Gnus.  And some of the not-so-inner workings, while I'm at
21930 it.
21931
21932 You can never expect the internals of a program not to change, but I
21933 will be defining (in some details) the interface between Gnus and its
21934 back ends (this is written in stone), the format of the score files
21935 (ditto), data structures (some are less likely to change than others)
21936 and general methods of operation.
21937
21938 @menu
21939 * Gnus Utility Functions::      Common functions and variable to use.
21940 * Back End Interface::          How Gnus communicates with the servers.
21941 * Score File Syntax::           A BNF definition of the score file standard.
21942 * Headers::                     How Gnus stores headers internally.
21943 * Ranges::                      A handy format for storing mucho numbers.
21944 * Group Info::                  The group info format.
21945 * Extended Interactive::        Symbolic prefixes and stuff.
21946 * Emacs/XEmacs Code::           Gnus can be run under all modern Emacsen.
21947 * Various File Formats::        Formats of files that Gnus use.
21948 @end menu
21949
21950
21951 @node Gnus Utility Functions
21952 @subsection Gnus Utility Functions
21953 @cindex Gnus utility functions
21954 @cindex utility functions
21955 @cindex functions
21956 @cindex internal variables
21957
21958 When writing small functions to be run from hooks (and stuff), it's
21959 vital to have access to the Gnus internal functions and variables.
21960 Below is a list of the most common ones.
21961
21962 @table @code
21963
21964 @item gnus-newsgroup-name
21965 @vindex gnus-newsgroup-name
21966 This variable holds the name of the current newsgroup.
21967
21968 @item gnus-find-method-for-group
21969 @findex gnus-find-method-for-group
21970 A function that returns the select method for @var{group}.
21971
21972 @item gnus-group-real-name
21973 @findex gnus-group-real-name
21974 Takes a full (prefixed) Gnus group name, and returns the unprefixed
21975 name.
21976
21977 @item gnus-group-prefixed-name
21978 @findex gnus-group-prefixed-name
21979 Takes an unprefixed group name and a select method, and returns the full
21980 (prefixed) Gnus group name.
21981
21982 @item gnus-get-info
21983 @findex gnus-get-info
21984 Returns the group info list for @var{group}.
21985
21986 @item gnus-group-unread
21987 @findex gnus-group-unread
21988 The number of unread articles in @var{group}, or @code{t} if that is
21989 unknown.
21990
21991 @item gnus-active
21992 @findex gnus-active
21993 The active entry for @var{group}.
21994
21995 @item gnus-set-active
21996 @findex gnus-set-active
21997 Set the active entry for @var{group}.
21998
21999 @item gnus-add-current-to-buffer-list
22000 @findex gnus-add-current-to-buffer-list
22001 Adds the current buffer to the list of buffers to be killed on Gnus
22002 exit.
22003
22004 @item gnus-continuum-version
22005 @findex gnus-continuum-version
22006 Takes a Gnus version string as a parameter and returns a floating point
22007 number.  Earlier versions will always get a lower number than later
22008 versions.
22009
22010 @item gnus-group-read-only-p
22011 @findex gnus-group-read-only-p
22012 Says whether @var{group} is read-only or not.
22013
22014 @item gnus-news-group-p
22015 @findex gnus-news-group-p
22016 Says whether @var{group} came from a news back end.
22017
22018 @item gnus-ephemeral-group-p
22019 @findex gnus-ephemeral-group-p
22020 Says whether @var{group} is ephemeral or not.
22021
22022 @item gnus-server-to-method
22023 @findex gnus-server-to-method
22024 Returns the select method corresponding to @var{server}.
22025
22026 @item gnus-server-equal
22027 @findex gnus-server-equal
22028 Says whether two virtual servers are equal.
22029
22030 @item gnus-group-native-p
22031 @findex gnus-group-native-p
22032 Says whether @var{group} is native or not.
22033
22034 @item gnus-group-secondary-p
22035 @findex gnus-group-secondary-p
22036 Says whether @var{group} is secondary or not.
22037
22038 @item gnus-group-foreign-p
22039 @findex gnus-group-foreign-p
22040 Says whether @var{group} is foreign or not.
22041
22042 @item group-group-find-parameter
22043 @findex group-group-find-parameter
22044 Returns the parameter list of @var{group}.  If given a second parameter,
22045 returns the value of that parameter for @var{group}.
22046
22047 @item gnus-group-set-parameter
22048 @findex gnus-group-set-parameter
22049 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
22050
22051 @item gnus-narrow-to-body
22052 @findex gnus-narrow-to-body
22053 Narrows the current buffer to the body of the article.
22054
22055 @item gnus-check-backend-function
22056 @findex gnus-check-backend-function
22057 Takes two parameters, @var{function} and @var{group}.  If the back end
22058 @var{group} comes from supports @var{function}, return non-@code{nil}.
22059
22060 @lisp
22061 (gnus-check-backend-function "request-scan" "nnml:misc")
22062 @result{} t
22063 @end lisp
22064
22065 @item gnus-read-method
22066 @findex gnus-read-method
22067 Prompts the user for a select method.
22068
22069 @end table
22070
22071
22072 @node Back End Interface
22073 @subsection Back End Interface
22074
22075 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
22076 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
22077 server is a @dfn{back end} and some @dfn{back end variables}.  As examples
22078 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
22079 examples of the latter we have @code{nntp-port-number} and
22080 @code{nnmbox-directory}.
22081
22082 When Gnus asks for information from a back end---say @code{nntp}---on
22083 something, it will normally include a virtual server name in the
22084 function parameters.  (If not, the back end should use the ``current''
22085 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
22086 server as its only (optional) parameter.  If this virtual server hasn't
22087 been opened, the function should fail.
22088
22089 Note that a virtual server name has no relation to some physical server
22090 name.  Take this example:
22091
22092 @lisp
22093 (nntp "odd-one"
22094       (nntp-address "ifi.uio.no")
22095       (nntp-port-number 4324))
22096 @end lisp
22097
22098 Here the virtual server name is @samp{odd-one} while the name of
22099 the physical server is @samp{ifi.uio.no}.
22100
22101 The back ends should be able to switch between several virtual servers.
22102 The standard back ends implement this by keeping an alist of virtual
22103 server environments that they pull down/push up when needed.
22104
22105 There are two groups of interface functions: @dfn{required functions},
22106 which must be present, and @dfn{optional functions}, which Gnus will
22107 always check for presence before attempting to call 'em.
22108
22109 All these functions are expected to return data in the buffer
22110 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
22111 unfortunately named, but we'll have to live with it.  When I talk about
22112 @dfn{resulting data}, I always refer to the data in that buffer.  When I
22113 talk about @dfn{return value}, I talk about the function value returned by
22114 the function call.  Functions that fail should return @code{nil} as the
22115 return value.
22116
22117 Some back ends could be said to be @dfn{server-forming} back ends, and
22118 some might be said not to be.  The latter are back ends that generally
22119 only operate on one group at a time, and have no concept of ``server''
22120 -- they have a group, and they deliver info on that group and nothing
22121 more.
22122
22123 Gnus identifies each message by way of group name and article number.  A
22124 few remarks about these article numbers might be useful.  First of all,
22125 the numbers are positive integers.  Secondly, it is normally not
22126 possible for later articles to `re-use' older article numbers without
22127 confusing Gnus.  That is, if a group has ever contained a message
22128 numbered 42, then no other message may get that number, or Gnus will get
22129 mightily confused.@footnote{See the function
22130 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
22131 Third, article numbers must be assigned in order of arrival in the
22132 group; this is not necessarily the same as the date of the message.
22133
22134 The previous paragraph already mentions all the `hard' restrictions that
22135 article numbers must fulfill.  But it seems that it might be useful to
22136 assign @emph{consecutive} article numbers, for Gnus gets quite confused
22137 if there are holes in the article numbering sequence.  However, due to
22138 the `no-reuse' restriction, holes cannot be avoided altogether.  It's
22139 also useful for the article numbers to start at 1 to avoid running out
22140 of numbers as long as possible.
22141
22142 In the examples and definitions I will refer to the imaginary back end
22143 @code{nnchoke}.
22144
22145 @cindex @code{nnchoke}
22146
22147 @menu
22148 * Required Back End Functions:: Functions that must be implemented.
22149 * Optional Back End Functions:: Functions that need not be implemented.
22150 * Error Messaging::             How to get messages and report errors.
22151 * Writing New Back Ends::       Extending old back ends.
22152 * Hooking New Back Ends Into Gnus::  What has to be done on the Gnus end.
22153 * Mail-like Back Ends::         Some tips on mail back ends.
22154 @end menu
22155
22156
22157 @node Required Back End Functions
22158 @subsubsection Required Back End Functions
22159
22160 @table @code
22161
22162 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
22163
22164 @var{articles} is either a range of article numbers or a list of
22165 @code{Message-ID}s.  Current back ends do not fully support either---only
22166 sequences (lists) of article numbers, and most back ends do not support
22167 retrieval of @code{Message-ID}s.  But they should try for both.
22168
22169 The result data should either be HEADs or NOV lines, and the result
22170 value should either be @code{headers} or @code{nov} to reflect this.
22171 This might later be expanded to @code{various}, which will be a mixture
22172 of HEADs and NOV lines, but this is currently not supported by Gnus.
22173
22174 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
22175 headers", in some meaning of the word.  This is generally done by
22176 fetching (at most) @var{fetch-old} extra headers less than the smallest
22177 article number in @code{articles}, and filling the gaps as well.  The
22178 presence of this parameter can be ignored if the back end finds it
22179 cumbersome to follow the request.  If this is non-@code{nil} and not a
22180 number, do maximum fetches.
22181
22182 Here's an example HEAD:
22183
22184 @example
22185 221 1056 Article retrieved.
22186 Path: ifi.uio.no!sturles
22187 From: sturles@@ifi.uio.no (Sturle Sunde)
22188 Newsgroups: ifi.discussion
22189 Subject: Re: Something very droll
22190 Date: 27 Oct 1994 14:02:57 +0100
22191 Organization: Dept. of Informatics, University of Oslo, Norway
22192 Lines: 26
22193 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
22194 References: <38jdmq$4qu@@visbur.ifi.uio.no>
22195 NNTP-Posting-Host: holmenkollen.ifi.uio.no
22196 .
22197 @end example
22198
22199 So a @code{headers} return value would imply that there's a number of
22200 these in the data buffer.
22201
22202 Here's a BNF definition of such a buffer:
22203
22204 @example
22205 headers        = *head
22206 head           = error / valid-head
22207 error-message  = [ "4" / "5" ] 2number " " <error message> eol
22208 valid-head     = valid-message *header "." eol
22209 valid-message  = "221 " <number> " Article retrieved." eol
22210 header         = <text> eol
22211 @end example
22212
22213 If the return value is @code{nov}, the data buffer should contain
22214 @dfn{network overview database} lines.  These are basically fields
22215 separated by tabs.
22216
22217 @example
22218 nov-buffer = *nov-line
22219 nov-line   = 8*9 [ field <TAB> ] eol
22220 field      = <text except TAB>
22221 @end example
22222
22223 For a closer look at what should be in those fields,
22224 @pxref{Headers}.
22225
22226
22227 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
22228
22229 @var{server} is here the virtual server name.  @var{definitions} is a
22230 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
22231
22232 If the server can't be opened, no error should be signaled.  The back end
22233 may then choose to refuse further attempts at connecting to this
22234 server.  In fact, it should do so.
22235
22236 If the server is opened already, this function should return a
22237 non-@code{nil} value.  There should be no data returned.
22238
22239
22240 @item (nnchoke-close-server &optional SERVER)
22241
22242 Close connection to @var{server} and free all resources connected
22243 to it.  Return @code{nil} if the server couldn't be closed for some
22244 reason.
22245
22246 There should be no data returned.
22247
22248
22249 @item (nnchoke-request-close)
22250
22251 Close connection to all servers and free all resources that the back end
22252 have reserved.  All buffers that have been created by that back end
22253 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
22254 function is generally only called when Gnus is shutting down.
22255
22256 There should be no data returned.
22257
22258
22259 @item (nnchoke-server-opened &optional SERVER)
22260
22261 If @var{server} is the current virtual server, and the connection to the
22262 physical server is alive, then this function should return a
22263 non-@code{nil} vlue.  This function should under no circumstances
22264 attempt to reconnect to a server we have lost connection to.
22265
22266 There should be no data returned.
22267
22268
22269 @item (nnchoke-status-message &optional SERVER)
22270
22271 This function should return the last error message from @var{server}.
22272
22273 There should be no data returned.
22274
22275
22276 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
22277
22278 The result data from this function should be the article specified by
22279 @var{article}.  This might either be a @code{Message-ID} or a number.
22280 It is optional whether to implement retrieval by @code{Message-ID}, but
22281 it would be nice if that were possible.
22282
22283 If @var{to-buffer} is non-@code{nil}, the result data should be returned
22284 in this buffer instead of the normal data buffer.  This is to make it
22285 possible to avoid copying large amounts of data from one buffer to
22286 another, while Gnus mainly requests articles to be inserted directly
22287 into its article buffer.
22288
22289 If it is at all possible, this function should return a cons cell where
22290 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
22291 the article number.  This will enable Gnus to find out what the real
22292 group and article numbers are when fetching articles by
22293 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
22294 on successful article retrieval.
22295
22296
22297 @item (nnchoke-request-group GROUP &optional SERVER FAST)
22298
22299 Get data on @var{group}.  This function also has the side effect of
22300 making @var{group} the current group.
22301
22302 If @var{fast}, don't bother to return useful data, just make @var{group}
22303 the current group.
22304
22305 Here's an example of some result data and a definition of the same:
22306
22307 @example
22308 211 56 1000 1059 ifi.discussion
22309 @end example
22310
22311 The first number is the status, which should be 211.  Next is the
22312 total number of articles in the group, the lowest article number, the
22313 highest article number, and finally the group name.  Note that the total
22314 number of articles may be less than one might think while just
22315 considering the highest and lowest article numbers, but some articles
22316 may have been canceled.  Gnus just discards the total-number, so
22317 whether one should take the bother to generate it properly (if that is a
22318 problem) is left as an exercise to the reader.
22319
22320 @example
22321 group-status = [ error / info ] eol
22322 error        = [ "4" / "5" ] 2<number> " " <Error message>
22323 info         = "211 " 3* [ <number> " " ] <string>
22324 @end example
22325
22326
22327 @item (nnchoke-close-group GROUP &optional SERVER)
22328
22329 Close @var{group} and free any resources connected to it.  This will be
22330 a no-op on most back ends.
22331
22332 There should be no data returned.
22333
22334
22335 @item (nnchoke-request-list &optional SERVER)
22336
22337 Return a list of all groups available on @var{server}.  And that means
22338 @emph{all}.
22339
22340 Here's an example from a server that only carries two groups:
22341
22342 @example
22343 ifi.test 0000002200 0000002000 y
22344 ifi.discussion 3324 3300 n
22345 @end example
22346
22347 On each line we have a group name, then the highest article number in
22348 that group, the lowest article number, and finally a flag.
22349
22350 @example
22351 active-file = *active-line
22352 active-line = name " " <number> " " <number> " " flags eol
22353 name        = <string>
22354 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
22355 @end example
22356
22357 The flag says whether the group is read-only (@samp{n}), is moderated
22358 (@samp{m}), is dead (@samp{x}), is aliased to some other group
22359 (@samp{=other-group}) or none of the above (@samp{y}).
22360
22361
22362 @item (nnchoke-request-post &optional SERVER)
22363
22364 This function should post the current buffer.  It might return whether
22365 the posting was successful or not, but that's not required.  If, for
22366 instance, the posting is done asynchronously, it has generally not been
22367 completed by the time this function concludes.  In that case, this
22368 function should set up some kind of sentinel to beep the user loud and
22369 clear if the posting could not be completed.
22370
22371 There should be no result data from this function.
22372
22373 @end table
22374
22375
22376 @node Optional Back End Functions
22377 @subsubsection Optional Back End Functions
22378
22379 @table @code
22380
22381 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
22382
22383 @var{groups} is a list of groups, and this function should request data
22384 on all those groups.  How it does it is of no concern to Gnus, but it
22385 should attempt to do this in a speedy fashion.
22386
22387 The return value of this function can be either @code{active} or
22388 @code{group}, which says what the format of the result data is.  The
22389 former is in the same format as the data from
22390 @code{nnchoke-request-list}, while the latter is a buffer full of lines
22391 in the same format as @code{nnchoke-request-group} gives.
22392
22393 @example
22394 group-buffer = *active-line / *group-status
22395 @end example
22396
22397
22398 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
22399
22400 A Gnus group info (@pxref{Group Info}) is handed to the back end for
22401 alterations.  This comes in handy if the back end really carries all the
22402 information (as is the case with virtual and imap groups).  This
22403 function should destructively alter the info to suit its needs, and
22404 should return the (altered) group info.
22405
22406 There should be no result data from this function.
22407
22408
22409 @item (nnchoke-request-type GROUP &optional ARTICLE)
22410
22411 When the user issues commands for ``sending news'' (@kbd{F} in the
22412 summary buffer, for instance), Gnus has to know whether the article the
22413 user is following up on is news or mail.  This function should return
22414 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
22415 is mail and @code{unknown} if the type can't be decided.  (The
22416 @var{article} parameter is necessary in @code{nnvirtual} groups which
22417 might very well combine mail groups and news groups.)  Both @var{group}
22418 and @var{article} may be @code{nil}.
22419
22420 There should be no result data from this function.
22421
22422
22423 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
22424
22425 Set/remove/add marks on articles.  Normally Gnus handles the article
22426 marks (such as read, ticked, expired etc) internally, and store them in
22427 @code{~/.newsrc.eld}.  Some back ends (such as @sc{imap}) however carry
22428 all information about the articles on the server, so Gnus need to
22429 propagate the mark information to the server.
22430
22431 ACTION is a list of mark setting requests, having this format:
22432
22433 @example
22434 (RANGE ACTION MARK)
22435 @end example
22436
22437 RANGE is a range of articles you wish to update marks on.  ACTION is
22438 @code{add} or @code{del}, used to add marks or remove marks
22439 (preserving all marks not mentioned).  MARK is a list of marks; where
22440 each mark is a symbol.  Currently used marks are @code{read},
22441 @code{tick}, @code{reply}, @code{expire}, @code{killed},
22442 @code{dormant}, @code{save}, @code{download}, @code{unsend},
22443 @code{forward} and @code{recent}, but your back end should, if
22444 possible, not limit itself to these.
22445
22446 Given contradictory actions, the last action in the list should be the
22447 effective one.  That is, if your action contains a request to add the
22448 @code{tick} mark on article 1 and, later in the list, a request to
22449 remove the mark on the same article, the mark should in fact be removed.
22450
22451 An example action list:
22452
22453 @example
22454 (((5 12 30) 'del '(tick))
22455  ((10 . 90) 'add '(read expire))
22456  ((92 94) 'del '(read)))
22457 @end example
22458
22459 The function should return a range of articles it wasn't able to set the
22460 mark on (currently not used for anything).
22461
22462 There should be no result data from this function.
22463
22464 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
22465
22466 If the user tries to set a mark that the back end doesn't like, this
22467 function may change the mark.  Gnus will use whatever this function
22468 returns as the mark for @var{article} instead of the original
22469 @var{mark}.  If the back end doesn't care, it must return the original
22470 @var{mark}, and not @code{nil} or any other type of garbage.
22471
22472 The only use for this I can see is what @code{nnvirtual} does with
22473 it---if a component group is auto-expirable, marking an article as read
22474 in the virtual group should result in the article being marked as
22475 expirable.
22476
22477 There should be no result data from this function.
22478
22479
22480 @item (nnchoke-request-scan &optional GROUP SERVER)
22481
22482 This function may be called at any time (by Gnus or anything else) to
22483 request that the back end check for incoming articles, in one way or
22484 another.  A mail back end will typically read the spool file or query the
22485 POP server when this function is invoked.  The @var{group} doesn't have
22486 to be heeded---if the back end decides that it is too much work just
22487 scanning for a single group, it may do a total scan of all groups.  It
22488 would be nice, however, to keep things local if that's practical.
22489
22490 There should be no result data from this function.
22491
22492
22493 @item (nnchoke-request-group-description GROUP &optional SERVER)
22494
22495 The result data from this function should be a description of
22496 @var{group}.
22497
22498 @example
22499 description-line = name <TAB> description eol
22500 name             = <string>
22501 description      = <text>
22502 @end example
22503
22504 @item (nnchoke-request-list-newsgroups &optional SERVER)
22505
22506 The result data from this function should be the description of all
22507 groups available on the server.
22508
22509 @example
22510 description-buffer = *description-line
22511 @end example
22512
22513
22514 @item (nnchoke-request-newgroups DATE &optional SERVER)
22515
22516 The result data from this function should be all groups that were
22517 created after @samp{date}, which is in normal human-readable date format
22518 (i.e., the date format used in mail and news headers, and returned by
22519 the function @code{message-make-date} by default).  The data should be
22520 in the active buffer format.
22521
22522 It is okay for this function to return `too many' groups; some back ends
22523 might find it cheaper to return the full list of groups, rather than
22524 just the new groups.  But don't do this for back ends with many groups.
22525 Normally, if the user creates the groups herself, there won't be too
22526 many groups, so nnml and the like are probably safe.  But for back ends
22527 like nntp, where the groups have been created by the server, it is quite
22528 likely that there can be many groups.
22529
22530
22531 @item (nnchoke-request-create-group GROUP &optional SERVER)
22532
22533 This function should create an empty group with name @var{group}.
22534
22535 There should be no return data.
22536
22537
22538 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
22539
22540 This function should run the expiry process on all articles in the
22541 @var{articles} range (which is currently a simple list of article
22542 numbers.)  It is left up to the back end to decide how old articles
22543 should be before they are removed by this function.  If @var{force} is
22544 non-@code{nil}, all @var{articles} should be deleted, no matter how new
22545 they are.
22546
22547 This function should return a list of articles that it did not/was not
22548 able to delete.
22549
22550 There should be no result data returned.
22551
22552
22553 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
22554 &optional LAST)
22555
22556 This function should move @var{article} (which is a number) from
22557 @var{group} by calling @var{accept-form}.
22558
22559 This function should ready the article in question for moving by
22560 removing any header lines it has added to the article, and generally
22561 should ``tidy up'' the article.  Then it should @code{eval}
22562 @var{accept-form} in the buffer where the ``tidy'' article is.  This
22563 will do the actual copying.  If this @code{eval} returns a
22564 non-@code{nil} value, the article should be removed.
22565
22566 If @var{last} is @code{nil}, that means that there is a high likelihood
22567 that there will be more requests issued shortly, so that allows some
22568 optimizations.
22569
22570 The function should return a cons where the @code{car} is the group name and
22571 the @code{cdr} is the article number that the article was entered as.
22572
22573 There should be no data returned.
22574
22575
22576 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
22577
22578 This function takes the current buffer and inserts it into @var{group}.
22579 If @var{last} in @code{nil}, that means that there will be more calls to
22580 this function in short order.
22581
22582 The function should return a cons where the @code{car} is the group name and
22583 the @code{cdr} is the article number that the article was entered as.
22584
22585 There should be no data returned.
22586
22587
22588 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
22589
22590 This function should remove @var{article} (which is a number) from
22591 @var{group} and insert @var{buffer} there instead.
22592
22593 There should be no data returned.
22594
22595
22596 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
22597
22598 This function should delete @var{group}.  If @var{force}, it should
22599 really delete all the articles in the group, and then delete the group
22600 itself.  (If there is such a thing as ``the group itself''.)
22601
22602 There should be no data returned.
22603
22604
22605 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
22606
22607 This function should rename @var{group} into @var{new-name}.  All
22608 articles in @var{group} should move to @var{new-name}.
22609
22610 There should be no data returned.
22611
22612 @end table
22613
22614
22615 @node Error Messaging
22616 @subsubsection Error Messaging
22617
22618 @findex nnheader-report
22619 @findex nnheader-get-report
22620 The back ends should use the function @code{nnheader-report} to report
22621 error conditions---they should not raise errors when they aren't able to
22622 perform a request.  The first argument to this function is the back end
22623 symbol, and the rest are interpreted as arguments to @code{format} if
22624 there are multiple of them, or just a string if there is one of them.
22625 This function must always returns @code{nil}.
22626
22627 @lisp
22628 (nnheader-report 'nnchoke "You did something totally bogus")
22629
22630 (nnheader-report 'nnchoke "Could not request group %s" group)
22631 @end lisp
22632
22633 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
22634 @code{nil} back from a server, and this function returns the most
22635 recently reported message for the back end in question.  This function
22636 takes one argument---the server symbol.
22637
22638 Internally, these functions access @var{back-end}@code{-status-string},
22639 so the @code{nnchoke} back end will have its error message stored in
22640 @code{nnchoke-status-string}.
22641
22642
22643 @node Writing New Back Ends
22644 @subsubsection Writing New Back Ends
22645
22646 Many back ends are quite similar.  @code{nnml} is just like
22647 @code{nnspool}, but it allows you to edit the articles on the server.
22648 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
22649 and it doesn't maintain overview databases.  @code{nndir} is just like
22650 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
22651 editing articles.
22652
22653 It would make sense if it were possible to ``inherit'' functions from
22654 back ends when writing new back ends.  And, indeed, you can do that if you
22655 want to.  (You don't have to if you don't want to, of course.)
22656
22657 All the back ends declare their public variables and functions by using a
22658 package called @code{nnoo}.
22659
22660 To inherit functions from other back ends (and allow other back ends to
22661 inherit functions from the current back end), you should use the
22662 following macros:
22663
22664 @table @code
22665
22666 @item nnoo-declare
22667 This macro declares the first parameter to be a child of the subsequent
22668 parameters.  For instance:
22669
22670 @lisp
22671 (nnoo-declare nndir
22672   nnml nnmh)
22673 @end lisp
22674
22675 @code{nndir} has declared here that it intends to inherit functions from
22676 both @code{nnml} and @code{nnmh}.
22677
22678 @item defvoo
22679 This macro is equivalent to @code{defvar}, but registers the variable as
22680 a public server variable.  Most state-oriented variables should be
22681 declared with @code{defvoo} instead of @code{defvar}.
22682
22683 In addition to the normal @code{defvar} parameters, it takes a list of
22684 variables in the parent back ends to map the variable to when executing
22685 a function in those back ends.
22686
22687 @lisp
22688 (defvoo nndir-directory nil
22689   "Where nndir will look for groups."
22690   nnml-current-directory nnmh-current-directory)
22691 @end lisp
22692
22693 This means that @code{nnml-current-directory} will be set to
22694 @code{nndir-directory} when an @code{nnml} function is called on behalf
22695 of @code{nndir}.  (The same with @code{nnmh}.)
22696
22697 @item nnoo-define-basics
22698 This macro defines some common functions that almost all back ends should
22699 have.
22700
22701 @example
22702 (nnoo-define-basics nndir)
22703 @end example
22704
22705 @item deffoo
22706 This macro is just like @code{defun} and takes the same parameters.  In
22707 addition to doing the normal @code{defun} things, it registers the
22708 function as being public so that other back ends can inherit it.
22709
22710 @item nnoo-map-functions
22711 This macro allows mapping of functions from the current back end to
22712 functions from the parent back ends.
22713
22714 @example
22715 (nnoo-map-functions nndir
22716   (nnml-retrieve-headers 0 nndir-current-group 0 0)
22717   (nnmh-request-article 0 nndir-current-group 0 0))
22718 @end example
22719
22720 This means that when @code{nndir-retrieve-headers} is called, the first,
22721 third, and fourth parameters will be passed on to
22722 @code{nnml-retrieve-headers}, while the second parameter is set to the
22723 value of @code{nndir-current-group}.
22724
22725 @item nnoo-import
22726 This macro allows importing functions from back ends.  It should be the
22727 last thing in the source file, since it will only define functions that
22728 haven't already been defined.
22729
22730 @example
22731 (nnoo-import nndir
22732   (nnmh
22733    nnmh-request-list
22734    nnmh-request-newgroups)
22735   (nnml))
22736 @end example
22737
22738 This means that calls to @code{nndir-request-list} should just be passed
22739 on to @code{nnmh-request-list}, while all public functions from
22740 @code{nnml} that haven't been defined in @code{nndir} yet should be
22741 defined now.
22742
22743 @end table
22744
22745 Below is a slightly shortened version of the @code{nndir} back end.
22746
22747 @lisp
22748 ;;; nndir.el --- single directory newsgroup access for Gnus
22749 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
22750
22751 ;;; Code:
22752
22753 (require 'nnheader)
22754 (require 'nnmh)
22755 (require 'nnml)
22756 (require 'nnoo)
22757 (eval-when-compile (require 'cl))
22758
22759 (nnoo-declare nndir
22760   nnml nnmh)
22761
22762 (defvoo nndir-directory nil
22763   "Where nndir will look for groups."
22764   nnml-current-directory nnmh-current-directory)
22765
22766 (defvoo nndir-nov-is-evil nil
22767   "*Non-nil means that nndir will never retrieve NOV headers."
22768   nnml-nov-is-evil)
22769
22770 (defvoo nndir-current-group ""
22771   nil
22772   nnml-current-group nnmh-current-group)
22773 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
22774 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
22775
22776 (defvoo nndir-status-string "" nil nnmh-status-string)
22777 (defconst nndir-version "nndir 1.0")
22778
22779 ;;; Interface functions.
22780
22781 (nnoo-define-basics nndir)
22782
22783 (deffoo nndir-open-server (server &optional defs)
22784   (setq nndir-directory
22785         (or (cadr (assq 'nndir-directory defs))
22786             server))
22787   (unless (assq 'nndir-directory defs)
22788     (push `(nndir-directory ,server) defs))
22789   (push `(nndir-current-group
22790           ,(file-name-nondirectory
22791             (directory-file-name nndir-directory)))
22792         defs)
22793   (push `(nndir-top-directory
22794           ,(file-name-directory (directory-file-name nndir-directory)))
22795         defs)
22796   (nnoo-change-server 'nndir server defs))
22797
22798 (nnoo-map-functions nndir
22799   (nnml-retrieve-headers 0 nndir-current-group 0 0)
22800   (nnmh-request-article 0 nndir-current-group 0 0)
22801   (nnmh-request-group nndir-current-group 0 0)
22802   (nnmh-close-group nndir-current-group 0))
22803
22804 (nnoo-import nndir
22805   (nnmh
22806    nnmh-status-message
22807    nnmh-request-list
22808    nnmh-request-newgroups))
22809
22810 (provide 'nndir)
22811 @end lisp
22812
22813
22814 @node Hooking New Back Ends Into Gnus
22815 @subsubsection Hooking New Back Ends Into Gnus
22816
22817 @vindex gnus-valid-select-methods
22818 @findex gnus-declare-backend
22819 Having Gnus start using your new back end is rather easy---you just
22820 declare it with the @code{gnus-declare-backend} functions.  This will
22821 enter the back end into the @code{gnus-valid-select-methods} variable.
22822
22823 @code{gnus-declare-backend} takes two parameters---the back end name and
22824 an arbitrary number of @dfn{abilities}.
22825
22826 Here's an example:
22827
22828 @lisp
22829 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
22830 @end lisp
22831
22832 The above line would then go in the @file{nnchoke.el} file.
22833
22834 The abilities can be:
22835
22836 @table @code
22837 @item mail
22838 This is a mailish back end---followups should (probably) go via mail.
22839 @item post
22840 This is a newsish back end---followups should (probably) go via news.
22841 @item post-mail
22842 This back end supports both mail and news.
22843 @item none
22844 This is neither a post nor mail back end---it's something completely
22845 different.
22846 @item respool
22847 It supports respooling---or rather, it is able to modify its source
22848 articles and groups.
22849 @item address
22850 The name of the server should be in the virtual server name.  This is
22851 true for almost all back ends.
22852 @item prompt-address
22853 The user should be prompted for an address when doing commands like
22854 @kbd{B} in the group buffer.  This is true for back ends like
22855 @code{nntp}, but not @code{nnmbox}, for instance.
22856 @end table
22857
22858
22859 @node Mail-like Back Ends
22860 @subsubsection Mail-like Back Ends
22861
22862 One of the things that separate the mail back ends from the rest of the
22863 back ends is the heavy dependence by the mail back ends on common
22864 functions in @file{nnmail.el}.  For instance, here's the definition of
22865 @code{nnml-request-scan}:
22866
22867 @lisp
22868 (deffoo nnml-request-scan (&optional group server)
22869   (setq nnml-article-file-alist nil)
22870   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
22871 @end lisp
22872
22873 It simply calls @code{nnmail-get-new-mail} with a few parameters,
22874 and @code{nnmail} takes care of all the moving and splitting of the
22875 mail.
22876
22877 This function takes four parameters.
22878
22879 @table @var
22880 @item method
22881 This should be a symbol to designate which back end is responsible for
22882 the call.
22883
22884 @item exit-function
22885 This function should be called after the splitting has been performed.
22886
22887 @item temp-directory
22888 Where the temporary files should be stored.
22889
22890 @item group
22891 This optional argument should be a group name if the splitting is to be
22892 performed for one group only.
22893 @end table
22894
22895 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
22896 save each article.  @var{back-end}@code{-active-number} will be called to
22897 find the article number assigned to this article.
22898
22899 The function also uses the following variables:
22900 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
22901 this back end); and @var{back-end}@code{-group-alist} and
22902 @var{back-end}@code{-active-file} to generate the new active file.
22903 @var{back-end}@code{-group-alist} should be a group-active alist, like
22904 this:
22905
22906 @example
22907 (("a-group" (1 . 10))
22908  ("some-group" (34 . 39)))
22909 @end example
22910
22911
22912 @node Score File Syntax
22913 @subsection Score File Syntax
22914
22915 Score files are meant to be easily parseable, but yet extremely
22916 mallable.   It was decided that something that had the same read syntax
22917 as an Emacs Lisp list would fit that spec.
22918
22919 Here's a typical score file:
22920
22921 @lisp
22922 (("summary"
22923   ("win95" -10000 nil s)
22924   ("Gnus"))
22925  ("from"
22926   ("Lars" -1000))
22927  (mark -100))
22928 @end lisp
22929
22930 BNF definition of a score file:
22931
22932 @example
22933 score-file      = "" / "(" *element ")"
22934 element         = rule / atom
22935 rule            = string-rule / number-rule / date-rule
22936 string-rule     = "(" quote string-header quote space *string-match ")"
22937 number-rule     = "(" quote number-header quote space *number-match ")"
22938 date-rule       = "(" quote date-header quote space *date-match ")"
22939 quote           = <ascii 34>
22940 string-header   = "subject" / "from" / "references" / "message-id" /
22941                   "xref" / "body" / "head" / "all" / "followup"
22942 number-header   = "lines" / "chars"
22943 date-header     = "date"
22944 string-match    = "(" quote <string> quote [ "" / [ space score [ "" /
22945                   space date [ "" / [ space string-match-t ] ] ] ] ] ")"
22946 score           = "nil" / <integer>
22947 date            = "nil" / <natural number>
22948 string-match-t  = "nil" / "s" / "substring" / "S" / "Substring" /
22949                   "r" / "regex" / "R" / "Regex" /
22950                   "e" / "exact" / "E" / "Exact" /
22951                   "f" / "fuzzy" / "F" / "Fuzzy"
22952 number-match    = "(" <integer> [ "" / [ space score [ "" /
22953                   space date [ "" / [ space number-match-t ] ] ] ] ] ")"
22954 number-match-t  = "nil" / "=" / "<" / ">" / ">=" / "<="
22955 date-match      = "(" quote <string> quote [ "" / [ space score [ "" /
22956                   space date [ "" / [ space date-match-t ] ] ] ] ")"
22957 date-match-t    = "nil" / "at" / "before" / "after"
22958 atom            = "(" [ required-atom / optional-atom ] ")"
22959 required-atom   = mark / expunge / mark-and-expunge / files /
22960                   exclude-files / read-only / touched
22961 optional-atom   = adapt / local / eval
22962 mark            = "mark" space nil-or-number
22963 nil-or-number   = "nil" / <integer>
22964 expunge         = "expunge" space nil-or-number
22965 mark-and-expunge = "mark-and-expunge" space nil-or-number
22966 files           = "files" *[ space <string> ]
22967 exclude-files   = "exclude-files" *[ space <string> ]
22968 read-only       = "read-only" [ space "nil" / space "t" ]
22969 adapt        = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
22970 adapt-rule      = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
22971 local           = "local" *[ space "(" <string> space <form> ")" ]
22972 eval            = "eval" space <form>
22973 space           = *[ " " / <TAB> / <NEWLINE> ]
22974 @end example
22975
22976 Any unrecognized elements in a score file should be ignored, but not
22977 discarded.
22978
22979 As you can see, white space is needed, but the type and amount of white
22980 space is irrelevant.  This means that formatting of the score file is
22981 left up to the programmer---if it's simpler to just spew it all out on
22982 one looong line, then that's ok.
22983
22984 The meaning of the various atoms are explained elsewhere in this
22985 manual (@pxref{Score File Format}).
22986
22987
22988 @node Headers
22989 @subsection Headers
22990
22991 Internally Gnus uses a format for storing article headers that
22992 corresponds to the @sc{nov} format in a mysterious fashion.  One could
22993 almost suspect that the author looked at the @sc{nov} specification and
22994 just shamelessly @emph{stole} the entire thing, and one would be right.
22995
22996 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
22997 RFC 1036 to talk about lines in the head of an article (e.g.,
22998 @code{From}).  It is used by many people as a synonym for
22999 ``head''---``the header and the body''.  (That should be avoided, in my
23000 opinion.)  And Gnus uses a format internally that it calls ``header'',
23001 which is what I'm talking about here.  This is a 9-element vector,
23002 basically, with each header (ouch) having one slot.
23003
23004 These slots are, in order: @code{number}, @code{subject}, @code{from},
23005 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
23006 @code{xref}, and @code{extra}.  There are macros for accessing and
23007 setting these slots---they all have predictable names beginning with
23008 @code{mail-header-} and @code{mail-header-set-}, respectively.
23009
23010 All these slots contain strings, except the @code{extra} slot, which
23011 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
23012
23013
23014 @node Ranges
23015 @subsection Ranges
23016
23017 @sc{gnus} introduced a concept that I found so useful that I've started
23018 using it a lot and have elaborated on it greatly.
23019
23020 The question is simple: If you have a large amount of objects that are
23021 identified by numbers (say, articles, to take a @emph{wild} example)
23022 that you want to qualify as being ``included'', a normal sequence isn't
23023 very useful.  (A 200,000 length sequence is a bit long-winded.)
23024
23025 The solution is as simple as the question: You just collapse the
23026 sequence.
23027
23028 @example
23029 (1 2 3 4 5 6 10 11 12)
23030 @end example
23031
23032 is transformed into
23033
23034 @example
23035 ((1 . 6) (10 . 12))
23036 @end example
23037
23038 To avoid having those nasty @samp{(13 . 13)} elements to denote a
23039 lonesome object, a @samp{13} is a valid element:
23040
23041 @example
23042 ((1 . 6) 7 (10 . 12))
23043 @end example
23044
23045 This means that comparing two ranges to find out whether they are equal
23046 is slightly tricky:
23047
23048 @example
23049 ((1 . 5) 7 8 (10 . 12))
23050 @end example
23051
23052 and
23053
23054 @example
23055 ((1 . 5) (7 . 8) (10 . 12))
23056 @end example
23057
23058 are equal.  In fact, any non-descending list is a range:
23059
23060 @example
23061 (1 2 3 4 5)
23062 @end example
23063
23064 is a perfectly valid range, although a pretty long-winded one.  This is
23065 also valid:
23066
23067 @example
23068 (1 . 5)
23069 @end example
23070
23071 and is equal to the previous range.
23072
23073 Here's a BNF definition of ranges.  Of course, one must remember the
23074 semantic requirement that the numbers are non-descending.  (Any number
23075 of repetition of the same number is allowed, but apt to disappear in
23076 range handling.)
23077
23078 @example
23079 range           = simple-range / normal-range
23080 simple-range    = "(" number " . " number ")"
23081 normal-range    = "(" start-contents ")"
23082 contents        = "" / simple-range *[ " " contents ] /
23083                   number *[ " " contents ]
23084 @end example
23085
23086 Gnus currently uses ranges to keep track of read articles and article
23087 marks.  I plan on implementing a number of range operators in C if The
23088 Powers That Be are willing to let me.  (I haven't asked yet, because I
23089 need to do some more thinking on what operators I need to make life
23090 totally range-based without ever having to convert back to normal
23091 sequences.)
23092
23093
23094 @node Group Info
23095 @subsection Group Info
23096
23097 Gnus stores all permanent info on groups in a @dfn{group info} list.
23098 This list is from three to six elements (or more) long and exhaustively
23099 describes the group.
23100
23101 Here are two example group infos; one is a very simple group while the
23102 second is a more complex one:
23103
23104 @example
23105 ("no.group" 5 ((1 . 54324)))
23106
23107 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
23108                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
23109                 (nnml "")
23110                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
23111 @end example
23112
23113 The first element is the @dfn{group name}---as Gnus knows the group,
23114 anyway.  The second element is the @dfn{subscription level}, which
23115 normally is a small integer.  (It can also be the @dfn{rank}, which is a
23116 cons cell where the @code{car} is the level and the @code{cdr} is the
23117 score.)  The third element is a list of ranges of read articles.  The
23118 fourth element is a list of lists of article marks of various kinds.
23119 The fifth element is the select method (or virtual server, if you like).
23120 The sixth element is a list of @dfn{group parameters}, which is what
23121 this section is about.
23122
23123 Any of the last three elements may be missing if they are not required.
23124 In fact, the vast majority of groups will normally only have the first
23125 three elements, which saves quite a lot of cons cells.
23126
23127 Here's a BNF definition of the group info format:
23128
23129 @example
23130 info          = "(" group space ralevel space read
23131                 [ "" / [ space marks-list [ "" / [ space method [ "" /
23132                 space parameters ] ] ] ] ] ")"
23133 group         = quote <string> quote
23134 ralevel       = rank / level
23135 level         = <integer in the range of 1 to inf>
23136 rank          = "(" level "." score ")"
23137 score         = <integer in the range of 1 to inf>
23138 read          = range
23139 marks-lists   = nil / "(" *marks ")"
23140 marks         = "(" <string> range ")"
23141 method        = "(" <string> *elisp-forms ")"
23142 parameters    = "(" *elisp-forms ")"
23143 @end example
23144
23145 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
23146 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
23147 in pseudo-BNF.
23148
23149 If you have a Gnus info and want to access the elements, Gnus offers a
23150 series of macros for getting/setting these elements.
23151
23152 @table @code
23153 @item gnus-info-group
23154 @itemx gnus-info-set-group
23155 @findex gnus-info-group
23156 @findex gnus-info-set-group
23157 Get/set the group name.
23158
23159 @item gnus-info-rank
23160 @itemx gnus-info-set-rank
23161 @findex gnus-info-rank
23162 @findex gnus-info-set-rank
23163 Get/set the group rank (@pxref{Group Score}).
23164
23165 @item gnus-info-level
23166 @itemx gnus-info-set-level
23167 @findex gnus-info-level
23168 @findex gnus-info-set-level
23169 Get/set the group level.
23170
23171 @item gnus-info-score
23172 @itemx gnus-info-set-score
23173 @findex gnus-info-score
23174 @findex gnus-info-set-score
23175 Get/set the group score (@pxref{Group Score}).
23176
23177 @item gnus-info-read
23178 @itemx gnus-info-set-read
23179 @findex gnus-info-read
23180 @findex gnus-info-set-read
23181 Get/set the ranges of read articles.
23182
23183 @item gnus-info-marks
23184 @itemx gnus-info-set-marks
23185 @findex gnus-info-marks
23186 @findex gnus-info-set-marks
23187 Get/set the lists of ranges of marked articles.
23188
23189 @item gnus-info-method
23190 @itemx gnus-info-set-method
23191 @findex gnus-info-method
23192 @findex gnus-info-set-method
23193 Get/set the group select method.
23194
23195 @item gnus-info-params
23196 @itemx gnus-info-set-params
23197 @findex gnus-info-params
23198 @findex gnus-info-set-params
23199 Get/set the group parameters.
23200 @end table
23201
23202 All the getter functions take one parameter---the info list.  The setter
23203 functions take two parameters---the info list and the new value.
23204
23205 The last three elements in the group info aren't mandatory, so it may be
23206 necessary to extend the group info before setting the element.  If this
23207 is necessary, you can just pass on a non-@code{nil} third parameter to
23208 the three final setter functions to have this happen automatically.
23209
23210
23211 @node Extended Interactive
23212 @subsection Extended Interactive
23213 @cindex interactive
23214 @findex gnus-interactive
23215
23216 Gnus extends the standard Emacs @code{interactive} specification
23217 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
23218 Prefixes}).  Here's an example of how this is used:
23219
23220 @lisp
23221 (defun gnus-summary-increase-score (&optional score symp)
23222   (interactive (gnus-interactive "P\ny"))
23223   ...
23224   )
23225 @end lisp
23226
23227 The best thing to do would have been to implement
23228 @code{gnus-interactive} as a macro which would have returned an
23229 @code{interactive} form, but this isn't possible since Emacs checks
23230 whether a function is interactive or not by simply doing an @code{assq}
23231 on the lambda form.  So, instead we have @code{gnus-interactive}
23232 function that takes a string and returns values that are usable to
23233 @code{interactive}.
23234
23235 This function accepts (almost) all normal @code{interactive} specs, but
23236 adds a few more.
23237
23238 @table @samp
23239 @item y
23240 @vindex gnus-current-prefix-symbol
23241 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
23242 variable.
23243
23244 @item Y
23245 @vindex gnus-current-prefix-symbols
23246 A list of the current symbolic prefixes---the
23247 @code{gnus-current-prefix-symbol} variable.
23248
23249 @item A
23250 The current article number---the @code{gnus-summary-article-number}
23251 function.
23252
23253 @item H
23254 The current article header---the @code{gnus-summary-article-header}
23255 function.
23256
23257 @item g
23258 The current group name---the @code{gnus-group-group-name}
23259 function.
23260
23261 @end table
23262
23263
23264 @node Emacs/XEmacs Code
23265 @subsection Emacs/XEmacs Code
23266 @cindex XEmacs
23267 @cindex Emacsen
23268
23269 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
23270 platforms must be the primary one.  I chose Emacs.  Not because I don't
23271 like XEmacs or Mule, but because it comes first alphabetically.
23272
23273 This means that Gnus will byte-compile under Emacs with nary a warning,
23274 while XEmacs will pump out gigabytes of warnings while byte-compiling.
23275 As I use byte-compilation warnings to help me root out trivial errors in
23276 Gnus, that's very useful.
23277
23278 I've also consistently used Emacs function interfaces, but have used
23279 Gnusey aliases for the functions.  To take an example:  Emacs defines a
23280 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
23281 function.  I then define a function called @code{gnus-run-at-time} that
23282 takes the same parameters as the Emacs @code{run-at-time}.  When running
23283 Gnus under Emacs, the former function is just an alias for the latter.
23284 However, when running under XEmacs, the former is an alias for the
23285 following function:
23286
23287 @lisp
23288 (defun gnus-xmas-run-at-time (time repeat function &rest args)
23289   (start-itimer
23290    "gnus-run-at-time"
23291    `(lambda ()
23292       (,function ,@@args))
23293    time repeat))
23294 @end lisp
23295
23296 This sort of thing has been done for bunches of functions.  Gnus does
23297 not redefine any native Emacs functions while running under XEmacs---it
23298 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
23299 all over.
23300
23301 In the cases where the XEmacs function interface was obviously cleaner,
23302 I used it instead.  For example @code{gnus-region-active-p} is an alias
23303 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
23304
23305 Of course, I could have chosen XEmacs as my native platform and done
23306 mapping functions the other way around.  But I didn't.  The performance
23307 hit these indirections impose on Gnus under XEmacs should be slight.
23308
23309
23310 @node Various File Formats
23311 @subsection Various File Formats
23312
23313 @menu
23314 * Active File Format::          Information on articles and groups available.
23315 * Newsgroups File Format::      Group descriptions.
23316 @end menu
23317
23318
23319 @node Active File Format
23320 @subsubsection Active File Format
23321
23322 The active file lists all groups available on the server in
23323 question.  It also lists the highest and lowest current article numbers
23324 in each group.
23325
23326 Here's an excerpt from a typical active file:
23327
23328 @example
23329 soc.motss 296030 293865 y
23330 alt.binaries.pictures.fractals 3922 3913 n
23331 comp.sources.unix 1605 1593 m
23332 comp.binaries.ibm.pc 5097 5089 y
23333 no.general 1000 900 y
23334 @end example
23335
23336 Here's a pseudo-BNF definition of this file:
23337
23338 @example
23339 active      = *group-line
23340 group-line  = group spc high-number spc low-number spc flag <NEWLINE>
23341 group       = <non-white-space string>
23342 spc         = " "
23343 high-number = <non-negative integer>
23344 low-number  = <positive integer>
23345 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
23346 @end example
23347
23348 For a full description of this file, see the manual pages for
23349 @samp{innd}, in particular @samp{active(5)}.
23350
23351
23352 @node Newsgroups File Format
23353 @subsubsection Newsgroups File Format
23354
23355 The newsgroups file lists groups along with their descriptions.  Not all
23356 groups on the server have to be listed,  and not all groups in the file
23357 have to exist on the server.  The file is meant purely as information to
23358 the user.
23359
23360 The format is quite simple; a group name, a tab, and the description.
23361 Here's the definition:
23362
23363 @example
23364 newsgroups    = *line
23365 line          = group tab description <NEWLINE>
23366 group         = <non-white-space string>
23367 tab           = <TAB>
23368 description   = <string>
23369 @end example
23370
23371
23372 @page
23373 @node Emacs for Heathens
23374 @section Emacs for Heathens
23375
23376 Believe it or not, but some people who use Gnus haven't really used
23377 Emacs much before they embarked on their journey on the Gnus Love Boat.
23378 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
23379 region'', and ``set @code{gnus-flargblossen} to an alist where the key
23380 is a regexp that is used for matching on the group name'' are magical
23381 phrases with little or no meaning, then this appendix is for you.  If
23382 you are already familiar with Emacs, just ignore this and go fondle your
23383 cat instead.
23384
23385 @menu
23386 * Keystrokes::                  Entering text and executing commands.
23387 * Emacs Lisp::                  The built-in Emacs programming language.
23388 @end menu
23389
23390
23391 @node Keystrokes
23392 @subsection Keystrokes
23393
23394 @itemize @bullet
23395 @item
23396 Q: What is an experienced Emacs user?
23397
23398 @item
23399 A: A person who wishes that the terminal had pedals.
23400 @end itemize
23401
23402 Yes, when you use Emacs, you are apt to use the control key, the shift
23403 key and the meta key a lot.  This is very annoying to some people
23404 (notably @code{vi}le users), and the rest of us just love the hell out
23405 of it.  Just give up and submit.  Emacs really does stand for
23406 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
23407 may have heard from other disreputable sources (like the Emacs author).
23408
23409 The shift keys are normally located near your pinky fingers, and are
23410 normally used to get capital letters and stuff.  You probably use it all
23411 the time.  The control key is normally marked ``CTRL'' or something like
23412 that.  The meta key is, funnily enough, never marked as such on any
23413 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
23414 which is the meta key on this keyboard.  It's usually located somewhere
23415 to the left hand side of the keyboard, usually on the bottom row.
23416
23417 Now, us Emacs people don't say ``press the meta-control-m key'',
23418 because that's just too inconvenient.  We say ``press the @kbd{C-M-m}
23419 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
23420 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
23421 down the control key, and hold it down while you press @kbd{k}''.
23422 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
23423 the control key and then press @kbd{k}''.  Simple, ay?
23424
23425 This is somewhat complicated by the fact that not all keyboards have a
23426 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
23427 means ``press escape, release escape, press @kbd{k}''.  That's much more
23428 work than if you have a meta key, so if that's the case, I respectfully
23429 suggest you get a real keyboard with a meta key.  You can't live without
23430 it.
23431
23432
23433
23434 @node Emacs Lisp
23435 @subsection Emacs Lisp
23436
23437 Emacs is the King of Editors because it's really a Lisp interpreter.
23438 Each and every key you tap runs some Emacs Lisp code snippet, and since
23439 Emacs Lisp is an interpreted language, that means that you can configure
23440 any key to run any arbitrary code.  You just, like, do it.
23441
23442 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
23443 functions.  (These are byte-compiled for speed, but it's still
23444 interpreted.)  If you decide that you don't like the way Gnus does
23445 certain things, it's trivial to have it do something a different way.
23446 (Well, at least if you know how to write Lisp code.)  However, that's
23447 beyond the scope of this manual, so we are simply going to talk about
23448 some common constructs that you normally use in your @file{.emacs} file
23449 to customize Gnus.
23450
23451 If you want to set the variable @code{gnus-florgbnize} to four (4), you
23452 write the following:
23453
23454 @lisp
23455 (setq gnus-florgbnize 4)
23456 @end lisp
23457
23458 This function (really ``special form'') @code{setq} is the one that can
23459 set a variable to some value.  This is really all you need to know.  Now
23460 you can go and fill your @code{.emacs} file with lots of these to change
23461 how Gnus works.
23462
23463 If you have put that thing in your @code{.emacs} file, it will be read
23464 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
23465 start Emacs.  If you want to change the variable right away, simply say
23466 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
23467 previous ``form'', which is a simple @code{setq} statement here.
23468
23469 Go ahead---just try it, if you're located at your Emacs.  After you
23470 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
23471 is the return value of the form you @code{eval}ed.
23472
23473 Some pitfalls:
23474
23475 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
23476 that means:
23477
23478 @lisp
23479 (setq gnus-read-active-file 'some)
23480 @end lisp
23481
23482 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
23483 @samp{nntp.ifi.uio.no}'', that means:
23484
23485 @lisp
23486 (setq gnus-nntp-server "nntp.ifi.uio.no")
23487 @end lisp
23488
23489 So be careful not to mix up strings (the latter) with symbols (the
23490 former).  The manual is unambiguous, but it can be confusing.
23491
23492 @page
23493 @include gnus-faq.texi
23494
23495 @node Index
23496 @chapter Index
23497 @printindex cp
23498
23499 @node Key Index
23500 @chapter Key Index
23501 @printindex ky
23502
23503 @summarycontents
23504 @contents
23505 @bye
23506
23507 @iftex
23508 @iflatex
23509 \end{document}
23510 @end iflatex
23511 @end iftex
23512
23513 @c End:
23514 % LocalWords:  BNF mucho detailmenu cindex kindex kbd
23515 % LocalWords:  findex Gnusae vindex dfn dfn samp nntp setq nnspool nntpserver
23516 % LocalWords:  nnmbox newusers Blllrph NEWGROUPS dingnusdingnusdingnus
23517 % LocalWords:  pre fab rec comp nnslashdot regex ga ga sci nnml nnbabyl nnmh
23518 % LocalWords:  nnfolder emph looong eld newsreaders defun init elc pxref