t-gnus-6_15-quimby: New branch for developing and synchronizing with Oort Gnus.
[elisp/gnus.git-] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-  -*- coding: iso-latin-1 -*-
2
3 @setfilename gnus
4 @settitle T-gnus 6.14 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @dircategory Editors
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{bembo}
24 \usepackage{pixidx}
25
26 \makeindex
27 \begin{document}
28
29 \newcommand{\gnuschaptername}{}
30 \newcommand{\gnussectionname}{}
31
32 \newcommand{\gnusbackslash}{/}
33
34 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
35 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
36
37 \newcommand{\gnuskindex}[1]{\index{#1}}
38 \newcommand{\gnusindex}[1]{\index{#1}}
39
40 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
41 \newcommand{\gnuscode}[1]{\gnustt{#1}}
42 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
43 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
44 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
46 \newcommand{\gnusdfn}[1]{\textit{#1}}
47 \newcommand{\gnusi}[1]{\textit{#1}}
48 \newcommand{\gnusstrong}[1]{\textbf{#1}}
49 \newcommand{\gnusemph}[1]{\textit{#1}}
50 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
51 \newcommand{\gnussc}[1]{\textsc{#1}}
52 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
53 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
54 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
55
56 \newcommand{\gnusbullet}{{${\bullet}$}}
57 \newcommand{\gnusdollar}{\$}
58 \newcommand{\gnusampersand}{\&}
59 \newcommand{\gnuspercent}{\%}
60 \newcommand{\gnushash}{\#}
61 \newcommand{\gnushat}{\symbol{"5E}}
62 \newcommand{\gnusunderline}{\symbol{"5F}}
63 \newcommand{\gnusnot}{$\neg$}
64 \newcommand{\gnustilde}{\symbol{"7E}}
65 \newcommand{\gnusless}{{$<$}}
66 \newcommand{\gnusgreater}{{$>$}}
67 \newcommand{\gnusbraceleft}{{$>$}}
68 \newcommand{\gnusbraceright}{{$>$}}
69
70 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
71 \newcommand{\gnusinteresting}{
72 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
73 }
74
75 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
76
77 \newcommand{\gnuspagechapter}[1]{
78 {\mbox{}}
79 }
80
81 \newdimen{\gnusdimen}
82 \gnusdimen 0pt
83
84 \newcommand{\gnuschapter}[2]{
85 \gnuscleardoublepage
86 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
87 \chapter{#2}
88 \renewcommand{\gnussectionname}{}
89 \renewcommand{\gnuschaptername}{#2}
90 \thispagestyle{empty}
91 \hspace*{-2cm}
92 \begin{picture}(500,500)(0,0)
93 \put(480,350){\makebox(0,0)[tr]{#1}}
94 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
95 \end{picture}
96 \clearpage
97 }
98
99 \newcommand{\gnusfigure}[3]{
100 \begin{figure}
101 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
102 #3
103 \end{picture}
104 \caption{#1}
105 \end{figure}
106 }
107
108 \newcommand{\gnusicon}[1]{
109 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
110 }
111
112 \newcommand{\gnuspicon}[1]{
113 \margindex{\epsfig{figure=#1,width=2cm}}
114 }
115
116 \newcommand{\gnusxface}[2]{
117 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
118 }
119
120 \newcommand{\gnussmiley}[2]{
121 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
122 }
123
124 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
125
126 \newcommand{\gnussection}[1]{
127 \renewcommand{\gnussectionname}{#1}
128 \section{#1}
129 }
130
131 \newenvironment{codelist}%
132 {\begin{list}{}{
133 }
134 }{\end{list}}
135
136 \newenvironment{kbdlist}%
137 {\begin{list}{}{
138 \labelwidth=0cm
139 }
140 }{\end{list}}
141
142 \newenvironment{dfnlist}%
143 {\begin{list}{}{
144 }
145 }{\end{list}}
146
147 \newenvironment{stronglist}%
148 {\begin{list}{}{
149 }
150 }{\end{list}}
151
152 \newenvironment{samplist}%
153 {\begin{list}{}{
154 }
155 }{\end{list}}
156
157 \newenvironment{varlist}%
158 {\begin{list}{}{
159 }
160 }{\end{list}}
161
162 \newenvironment{emphlist}%
163 {\begin{list}{}{
164 }
165 }{\end{list}}
166
167 \newlength\gnusheadtextwidth
168 \setlength{\gnusheadtextwidth}{\headtextwidth}
169 \addtolength{\gnusheadtextwidth}{1cm}
170
171 \newpagestyle{gnuspreamble}%
172 {
173 {
174 \ifodd\count0
175 {
176 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
177 }
178 \else
179 {
180 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
181 }
182 }
183 \fi
184 }
185 }
186 {
187 \ifodd\count0
188 \mbox{} \hfill
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \else
191 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
192 \hfill \mbox{}
193 \fi
194 }
195
196 \newpagestyle{gnusindex}%
197 {
198 {
199 \ifodd\count0
200 {
201 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
202 }
203 \else
204 {
205 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
206 }
207 \fi
208 }
209 }
210 {
211 \ifodd\count0
212 \mbox{} \hfill
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \else
215 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
216 \hfill \mbox{}
217 \fi
218 }
219
220 \newpagestyle{gnus}%
221 {
222 {
223 \ifodd\count0
224 {
225 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
226 }
227 \else
228 {
229 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
230 }
231 \fi
232 }
233 }
234 {
235 \ifodd\count0
236 \mbox{} \hfill
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \else
239 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
240 \hfill \mbox{}
241 \fi
242 }
243
244 \pagenumbering{roman}
245 \pagestyle{gnuspreamble}
246
247 @end iflatex
248 @end iftex
249
250 @iftex
251 @iflatex
252 \begin{titlepage}
253 {
254
255 %\addtolength{\oddsidemargin}{-5cm}
256 %\addtolength{\evensidemargin}{-5cm}
257 \parindent=0cm
258 \addtolength{\textheight}{2cm}
259
260 \gnustitle{\gnustitlename}\\
261 \rule{15cm}{1mm}\\
262 \vfill
263 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
264 \vfill
265 \rule{15cm}{1mm}\\
266 \gnusauthor{by Lars Magne Ingebrigtsen}
267 \newpage
268 }
269
270 \mbox{}
271 \vfill
272
273 \thispagestyle{empty}
274
275 Copyright \copyright{} 1995,96,97,98,99,2000 Free Software Foundation, Inc.
276
277
278 Permission is granted to copy, distribute and/or modify this document
279 under the terms of the GNU Free Documentation License, Version 1.1 or
280 any later version published by the Free Software Foundation; with no
281 Invariant Sections, with the Front-Cover texts being ``A GNU
282 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
283 license is included in the section entitled ``GNU Free Documentation
284 License'' in the Emacs manual.
285
286 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
287 this GNU Manual, like GNU software.  Copies published by the Free
288 Software Foundation raise funds for GNU development.''
289
290 This document is part of a collection distributed under the GNU Free
291 Documentation License.  If you want to distribute this document
292 separately from the collection, you can do so by adding a copy of the
293 license to the document, as described in section 6 of the license.
294 \newpage
295 \end{titlepage}
296 @end iflatex
297 @end iftex
298
299 @ifnottex
300
301 This file documents gnus, the GNU Emacs newsreader.
302
303 Copyright (C) 1995,96,97,98,99,2000 Free Software Foundation, Inc.
304
305 Permission is granted to copy, distribute and/or modify this document
306 under the terms of the GNU Free Documentation License, Version 1.1 or
307 any later version published by the Free Software Foundation; with the
308 Invariant Sections being none, with the Front-Cover texts being ``A GNU
309 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
310 license is included in the section entitled ``GNU Free Documentation
311 License'' in the Emacs manual.
312
313 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
314 this GNU Manual, like GNU software.  Copies published by the Free
315 Software Foundation raise funds for GNU development.''
316
317 This document is part of a collection distributed under the GNU Free
318 Documentation License.  If you want to distribute this document
319 separately from the collection, you can do so by adding a copy of the
320 license to the document, as described in section 6 of the license.
321 @end ifnottex
322
323 @tex
324
325 @titlepage
326 @title T-gnus 6.14 Manual
327
328 @author by Lars Magne Ingebrigtsen
329 @page
330
331 @vskip 0pt plus 1filll
332 Copyright @copyright{} 1995,96,97,98,99,2000 Free Software Foundation, Inc.
333
334 Permission is granted to copy, distribute and/or modify this document
335 under the terms of the GNU Free Documentation License, Version 1.1 or
336 any later version published by the Free Software Foundation; with no
337 Invariant Sections, with the Front-Cover texts being ``A GNU
338 Manual'', and with the Back-Cover Texts as in (a) below.  A copy of the
339 license is included in the section entitled ``GNU Free Documentation
340 License'' in the Emacs manual.
341
342 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
343 this GNU Manual, like GNU software.  Copies published by the Free
344 Software Foundation raise funds for GNU development.''
345
346 This document is part of a collection distributed under the GNU Free
347 Documentation License.  If you want to distribute this document
348 separately from the collection, you can do so by adding a copy of the
349 license to the document, as described in section 6 of the license.
350
351 @end titlepage
352 @page
353
354 @end tex
355
356
357 @node Top
358 @top The gnus Newsreader
359
360 @ifinfo
361
362 You can read news (and mail) from within Emacs by using gnus.  The news
363 can be gotten by any nefarious means you can think of---@sc{nntp}, local
364 spool or your mbox file.  All at the same time, if you want to push your
365 luck.
366
367 T-gnus provides MIME features based on SEMI API.  So T-gnus supports
368 your right to read strange messages including big images or other
369 various kinds of formats.  T-gnus also supports
370 internationalization/localization and multiscript features based on MULE
371 API.  So T-gnus does not discriminate various language communities.
372 Oh, if you are a Klingon, please wait Unicode Next Generation.
373
374 This manual corresponds to T-gnus 6.14.
375
376 @end ifinfo
377
378 @iftex
379
380 @iflatex
381 \tableofcontents
382 \gnuscleardoublepage
383 @end iflatex
384
385 Gnus is the advanced, self-documenting, customizable, extensible
386 unreal-time newsreader for GNU Emacs.
387
388 Oops.  That sounds oddly familiar, so let's start over again to avoid
389 being accused of plagiarism:
390
391 Gnus is a message-reading laboratory.  It will let you look at just
392 about anything as if it were a newsgroup.  You can read mail with it,
393 you can browse directories with it, you can @code{ftp} with it---you
394 can even read news with it!
395
396 Gnus tries to empower people who read news the same way Emacs empowers
397 people who edit text.  Gnus sets no limits to what the user should be
398 allowed to do.  Users are encouraged to extend gnus to make it behave
399 like they want it to behave.  A program should not control people;
400 people should be empowered to do what they want by using (or abusing)
401 the program.
402
403 @end iftex
404
405 @menu
406 * Starting Up::           Finding news can be a pain.
407 * The Group Buffer::      Selecting, subscribing and killing groups.
408 * The Summary Buffer::    Reading, saving and posting articles.
409 * The Article Buffer::    Displaying and handling articles.
410 * Composing Messages::    Information on sending mail and news.
411 * Select Methods::        Gnus reads all messages from various select methods.
412 * Scoring::               Assigning values to articles.
413 * Various::               General purpose settings.
414 * The End::               Farewell and goodbye.
415 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
416 * Index::                 Variable, function and concept index.
417 * Key Index::             Key Index.
418
419 @detailmenu
420  --- The Detailed Node Listing ---
421
422 Starting Gnus
423
424 * Finding the News::    Choosing a method for getting news.
425 * The First Time::      What does Gnus do the first time you start it?
426 * The Server is Down::  How can I read my mail then?
427 * Slave Gnusae::        You can have more than one Gnus active at a time.
428 * Fetching a Group::    Starting Gnus just to read a group.
429 * New Groups::          What is Gnus supposed to do with new groups?
430 * Startup Files::       Those pesky startup files---@file{.newsrc}.
431 * Auto Save::           Recovering from a crash.
432 * The Active File::     Reading the active file over a slow line Takes Time.
433 * Changing Servers::    You may want to move from one server to another.
434 * Startup Variables::   Other variables you might change.
435
436 New Groups
437
438 * Checking New Groups::      Determining what groups are new.
439 * Subscription Methods::     What Gnus should do with new groups.
440 * Filtering New Groups::     Making Gnus ignore certain new groups.
441
442 The Group Buffer
443
444 * Group Buffer Format::    Information listed and how you can change it.
445 * Group Maneuvering::      Commands for moving in the group buffer.
446 * Selecting a Group::      Actually reading news.
447 * Group Data::             Changing the info for a group.
448 * Subscription Commands::  Unsubscribing, killing, subscribing.
449 * Group Levels::           Levels? What are those, then?
450 * Group Score::            A mechanism for finding out what groups you like.
451 * Marking Groups::         You can mark groups for later processing.
452 * Foreign Groups::         Creating and editing groups.
453 * Group Parameters::       Each group may have different parameters set.
454 * Listing Groups::         Gnus can list various subsets of the groups.
455 * Sorting Groups::         Re-arrange the group order.
456 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
457 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
458 * Exiting Gnus::           Stop reading news and get some work done.
459 * Group Topics::           A folding group mode divided into topics.
460 * Misc Group Stuff::       Other stuff that you can to do.
461
462 Group Buffer Format
463
464 * Group Line Specification::       Deciding how the group buffer is to look.
465 * Group Modeline Specification::   The group buffer modeline.
466 * Group Highlighting::             Having nice colors in the group buffer.
467
468 Group Topics
469
470 * Topic Variables::    How to customize the topics the Lisp Way.
471 * Topic Commands::     Interactive E-Z commands.
472 * Topic Sorting::      Sorting each topic individually.
473 * Topic Topology::     A map of the world.
474 * Topic Parameters::   Parameters that apply to all groups in a topic.
475
476 Misc Group Stuff
477
478 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
479 * Group Information::     Information and help on groups and Gnus.
480 * Group Timestamp::       Making Gnus keep track of when you last read a group.
481 * File Commands::         Reading and writing the Gnus files.
482
483 The Summary Buffer
484
485 * Summary Buffer Format::       Deciding how the summary buffer is to look.
486 * Summary Maneuvering::         Moving around the summary buffer.
487 * Choosing Articles::           Reading articles.
488 * Paging the Article::          Scrolling the current article.
489 * Reply Followup and Post::     Posting articles.
490 * Marking Articles::            Marking articles as read, expirable, etc.
491 * Limiting::                    You can limit the summary buffer.
492 * Threading::                   How threads are made.
493 * Sorting::                     How articles and threads are sorted.
494 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
495 * Article Caching::             You may store articles in a cache.
496 * Persistent Articles::         Making articles expiry-resistant.
497 * Article Backlog::             Having already read articles hang around.
498 * Saving Articles::             Ways of customizing article saving.
499 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
500 * Article Treatment::           The article buffer can be mangled at will.
501 * MIME Commands::               Doing MIMEy things with the articles.
502 * Charsets::                    Character set issues.
503 * Article Commands::            Doing various things with the article buffer.
504 * Summary Sorting::             Sorting the summary buffer in various ways.
505 * Finding the Parent::          No child support? Get the parent.
506 * Alternative Approaches::      Reading using non-default summaries.
507 * Tree Display::                A more visual display of threads.
508 * Mail Group Commands::         Some commands can only be used in mail groups.
509 * Various Summary Stuff::       What didn't fit anywhere else.
510 * Exiting the Summary Buffer::  Returning to the Group buffer.
511 * Crosspost Handling::          How crossposted articles are dealt with.
512 * Duplicate Suppression::       An alternative when crosspost handling fails.
513 * Security::                    Decrypt and Verify.
514
515 Summary Buffer Format
516
517 * Summary Buffer Lines::     You can specify how summary lines should look.
518 * To From Newsgroups::       How to not display your own name.
519 * Summary Buffer Mode Line:: You can say how the mode line should look.
520 * Summary Highlighting::     Making the summary buffer all pretty and nice.
521
522 Choosing Articles
523
524 * Choosing Commands::        Commands for choosing articles.
525 * Choosing Variables::       Variables that influence these commands.
526
527 Reply, Followup and Post
528
529 * Summary Mail Commands::    Sending mail.
530 * Summary Post Commands::    Sending news.
531 * Summary Message Commands:: Other Message-related commands.
532 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
533
534 Marking Articles
535
536 * Unread Articles::          Marks for unread articles.
537 * Read Articles::            Marks for read articles.
538 * Other Marks::              Marks that do not affect readedness.
539 * Setting Marks::            How to set and remove marks.
540 * Generic Marking Commands:: How to customize the marking.
541 * Setting Process Marks::    How to mark articles for later processing.
542
543 Threading
544
545 * Customizing Threading::    Variables you can change to affect the threading.
546 * Thread Commands::          Thread based commands in the summary buffer.
547
548 Customizing Threading
549
550 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
551 * Filling In Threads::   Making the threads displayed look fuller.
552 * More Threading::       Even more variables for fiddling with threads.
553 * Low-Level Threading::  You thought it was over... but you were wrong!
554
555 Decoding Articles
556
557 * Uuencoded Articles::    Uudecode articles.
558 * Shell Archives::        Unshar articles.
559 * PostScript Files::      Split PostScript.
560 * Other Files::           Plain save and binhex.
561 * Decoding Variables::    Variables for a happy decoding.
562 * Viewing Files::         You want to look at the result of the decoding?
563
564 Decoding Variables
565
566 * Rule Variables::          Variables that say how a file is to be viewed.
567 * Other Decode Variables::  Other decode variables.
568 * Uuencoding and Posting::  Variables for customizing uuencoding.
569
570 Article Treatment
571
572 * Article Highlighting::    You want to make the article look like fruit salad.
573 * Article Fontisizing::     Making emphasized text look nice.
574 * Article Hiding::          You also want to make certain info go away.
575 * Article Washing::         Lots of way-neat functions to make life better.
576 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
577 * Article Date::            Grumble, UT!
578 * Article Signature::       What is a signature?
579 * Article Miscellania::     Various other stuff.
580
581 Alternative Approaches
582
583 * Pick and Read::               First mark articles and then read them.
584 * Binary Groups::               Auto-decode all articles.
585
586 Various Summary Stuff
587
588 * Summary Group Information::         Information oriented commands.
589 * Searching for Articles::            Multiple article commands.
590 * Summary Generation Commands::       (Re)generating the summary buffer.
591 * Really Various Summary Commands::   Those pesky non-conformant commands.
592
593 The Article Buffer
594
595 * Hiding Headers::        Deciding what headers should be displayed.
596 * Using MIME::            Pushing articles through @sc{mime} before reading them.
597 * Customizing Articles::  Tailoring the look of the articles.
598 * Article Keymap::        Keystrokes available in the article buffer.
599 * Misc Article::          Other stuff.
600
601 Composing Messages
602
603 * Mail::                 Mailing and replying.
604 * Post::                 Posting and following up.
605 * Posting Server::       What server should you post via?
606 * Mail and Post::        Mailing and posting at the same time.
607 * Archived Messages::    Where Gnus stores the messages you've sent.
608 * Posting Styles::       An easier way to specify who you are.
609 * Drafts::               Postponing messages and rejected messages.
610 * Rejected Articles::    What happens if the server doesn't like your article?
611
612 Select Methods
613
614 * The Server Buffer::     Making and editing virtual servers.
615 * Getting News::          Reading USENET news with Gnus.
616 * Getting Mail::          Reading your personal mail with Gnus.
617 * Browsing the Web::      Getting messages from a plethora of Web sources.
618 * Other Sources::         Reading directories, files, SOUP packets.
619 * Combined Groups::       Combining groups into one group.
620 * Gnus Unplugged::        Reading news and mail offline.
621
622 The Server Buffer
623
624 * Server Buffer Format::      You can customize the look of this buffer.
625 * Server Commands::           Commands to manipulate servers.
626 * Example Methods::           Examples server specifications.
627 * Creating a Virtual Server:: An example session.
628 * Server Variables::          Which variables to set.
629 * Servers and Methods::       You can use server names as select methods.
630 * Unavailable Servers::       Some servers you try to contact may be down.
631
632 Getting News
633
634 * NNTP::               Reading news from an @sc{nntp} server.
635 * News Spool::         Reading news from the local spool.
636
637 Getting Mail
638
639 * Mail in a Newsreader::         Important introductory notes.  
640 * Getting Started Reading Mail:: A simple cookbook example.
641 * Splitting Mail::               How to create mail groups.
642 * Mail Sources::                 How to tell Gnus where to get mail from.
643 * Mail Backend Variables::       Variables for customizing mail handling.
644 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
645 * Group Mail Splitting::         Use group customize to drive mail splitting.
646 * Incorporating Old Mail::       What about the old mail you have?
647 * Expiring Mail::                Getting rid of unwanted mail.
648 * Washing Mail::                 Removing gruft from the mail you get.
649 * Duplicates::                   Dealing with duplicated mail.
650 * Not Reading Mail::             Using mail backends for reading other files.
651 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
652
653 Mail Sources
654
655 * Mail Source Specifiers::       How to specify what a mail source is.
656 * Mail Source Customization::    Some variables that influence things.
657 * Fetching Mail::                Using the mail source specifiers.
658
659 Choosing a Mail Backend
660
661 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
662 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
663 * Mail Spool::                  Store your mail in a private spool?
664 * MH Spool::                    An mhspool-like backend.
665 * Mail Folders::                Having one file for each group.
666 * Comparing Mail Backends::     An in-depth looks at pros and cons.
667
668 Browsing the Web
669
670 * Web Searches::          Creating groups from articles that match a string.
671 * Slashdot::              Reading the Slashdot comments.
672 * Ultimate::              The Ultimate Bulletin Board systems.
673 * Web Archive::           Reading mailing list archived on web.
674
675 Other Sources
676
677 * Directory Groups::      You can read a directory as if it was a newsgroup.
678 * Anything Groups::       Dired?  Who needs dired?
679 * Document Groups::       Single files can be the basis of a group.
680 * SOUP::                  Reading @sc{soup} packets ``offline''.
681 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
682 * IMAP::                  Using Gnus as a @sc{imap} client.
683
684 Document Groups
685
686 * Document Server Internals::   How to add your own document types.
687
688 SOUP
689
690 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
691 * SOUP Groups::       A backend for reading @sc{soup} packets.
692 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
693
694 @sc{imap}
695
696 * Splitting in IMAP::     Splitting mail with nnimap.
697 * Editing IMAP ACLs::     Limiting/enabling other users access to a mailbox.
698 * Expunging mailboxes::   Equivalent of a "compress mailbox" button.
699
700 Combined Groups
701
702 * Virtual Groups::     Combining articles from many groups.
703 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
704
705 Gnus Unplugged
706
707 * Agent Basics::           How it all is supposed to work.
708 * Agent Categories::       How to tell the Gnus Agent what to download.
709 * Agent Commands::         New commands for all the buffers.
710 * Agent Expiry::           How to make old articles go away.
711 * Agent and IMAP::         How to use the Agent with IMAP.
712 * Outgoing Messages::      What happens when you post/mail something?
713 * Agent Variables::        Customizing is fun.
714 * Example Setup::          An example @file{.gnus.el} file for offline people.
715 * Batching Agents::        How to fetch news from a @code{cron} job.
716 * Agent Caveats::          What you think it'll do and what it does.
717
718 Agent Categories
719
720 * Category Syntax::       What a category looks like.
721 * The Category Buffer::   A buffer for maintaining categories.
722 * Category Variables::    Customize'r'Us.
723
724 Agent Commands
725
726 * Group Agent Commands::
727 * Summary Agent Commands::
728 * Server Agent Commands::
729
730 Scoring
731
732 * Summary Score Commands::   Adding score entries for the current group.
733 * Group Score Commands::     General score commands.
734 * Score Variables::          Customize your scoring.  (My, what terminology).
735 * Score File Format::        What a score file may contain.
736 * Score File Editing::       You can edit score files by hand as well.
737 * Adaptive Scoring::         Big Sister Gnus knows what you read.
738 * Home Score File::          How to say where new score entries are to go.
739 * Followups To Yourself::    Having Gnus notice when people answer you.
740 * Scoring Tips::             How to score effectively.
741 * Reverse Scoring::          That problem child of old is not problem.
742 * Global Score Files::       Earth-spanning, ear-splitting score files.
743 * Kill Files::               They are still here, but they can be ignored.
744 * Converting Kill Files::    Translating kill files to score files.
745 * GroupLens::                Getting predictions on what you like to read.
746 * Advanced Scoring::         Using logical expressions to build score rules.
747 * Score Decays::             It can be useful to let scores wither away.
748
749 GroupLens
750
751 * Using GroupLens::          How to make Gnus use GroupLens.
752 * Rating Articles::          Letting GroupLens know how you rate articles.
753 * Displaying Predictions::   Displaying predictions given by GroupLens.
754 * GroupLens Variables::      Customizing GroupLens.
755
756 Advanced Scoring
757
758 * Advanced Scoring Syntax::     A definition.
759 * Advanced Scoring Examples::   What they look like.
760 * Advanced Scoring Tips::       Getting the most out of it.
761
762 Various
763
764 * Process/Prefix::             A convention used by many treatment commands.
765 * Interactive::                Making Gnus ask you many questions.
766 * Symbolic Prefixes::          How to supply some Gnus functions with options.
767 * Formatting Variables::       You can specify what buffers should look like.
768 * Windows Configuration::      Configuring the Gnus buffer windows.
769 * Faces and Fonts::            How to change how faces look.
770 * Compilation::                How to speed Gnus up.
771 * Mode Lines::                 Displaying information in the mode lines.
772 * Highlighting and Menus::     Making buffers look all nice and cozy.
773 * Buttons::                    Get tendonitis in ten easy steps!
774 * Daemons::                    Gnus can do things behind your back.
775 * NoCeM::                      How to avoid spam and other fatty foods.
776 * Undo::                       Some actions can be undone.
777 * Moderation::                 What to do if you're a moderator.
778 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
779 * Fuzzy Matching::             What's the big fuzz?
780 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
781 * Various Various::            Things that are really various.
782
783 Formatting Variables
784
785 * Formatting Basics::     A formatting variable is basically a format string.
786 * Mode Line Formatting::  Some rules about mode line formatting variables.
787 * Advanced Formatting::   Modifying output in various ways.
788 * User-Defined Specs::    Having Gnus call your own functions.
789 * Formatting Fonts::      Making the formatting look colorful and nice.
790
791 XEmacs Enhancements
792
793 * Picons::    How to display pictures of what your reading.
794 * Smileys::   Show all those happy faces the way they were meant to be shown.
795 * Toolbar::   Click'n'drool.
796 * XVarious::  Other XEmacsy Gnusey variables.
797
798 Picons
799
800 * Picon Basics::           What are picons and How do I get them.
801 * Picon Requirements::     Don't go further if you aren't using XEmacs.
802 * Easy Picons::            Displaying Picons---the easy way.
803 * Hard Picons::            The way you should do it.  You'll learn something.
804 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
805
806 Appendices
807
808 * History::                        How Gnus got where it is today.
809 * On Writing Manuals::             Why this is not a beginner's guide.
810 * Terminology::                    We use really difficult, like, words here.
811 * Customization::                  Tailoring Gnus to your needs.
812 * Troubleshooting::                What you might try if things do not work.
813 * Gnus Reference Guide::           Rilly, rilly technical stuff.
814 * Emacs for Heathens::             A short introduction to Emacsian terms.
815 * Frequently Asked Questions::     A question-and-answer session.
816
817 History
818
819 * Gnus Versions::       What Gnus versions have been released.
820 * Other Gnus Versions:: Other Gnus versions that also have been released.
821 * Why?::                What's the point of Gnus?
822 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
823 * Conformity::          Gnus tries to conform to all standards.
824 * Emacsen::             Gnus can be run on a few modern Emacsen.
825 * Gnus Development::    How Gnus is developed.
826 * Contributors::        Oodles of people.
827 * New Features::        Pointers to some of the new stuff in Gnus.
828 * Newest Features::     Features so new that they haven't been written yet.
829
830 New Features
831
832 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
833 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
834 * Red Gnus::           Third time best---Gnus 5.4/5.5.
835 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
836
837 Customization
838
839 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
840 * Slow Terminal Connection::  You run a remote Emacs.
841 * Little Disk Space::         You feel that having large setup files is icky.
842 * Slow Machine::              You feel like buying a faster machine.
843
844 Gnus Reference Guide
845
846 * Gnus Utility Functions::   Common functions and variable to use.
847 * Backend Interface::        How Gnus communicates with the servers.
848 * Score File Syntax::        A BNF definition of the score file standard.
849 * Headers::                  How Gnus stores headers internally.
850 * Ranges::                   A handy format for storing mucho numbers.
851 * Group Info::               The group info format.
852 * Extended Interactive::     Symbolic prefixes and stuff.
853 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
854 * Various File Formats::     Formats of files that Gnus use.
855
856 Backend Interface
857
858 * Required Backend Functions::        Functions that must be implemented.
859 * Optional Backend Functions::        Functions that need not be implemented.
860 * Error Messaging::                   How to get messages and report errors.
861 * Writing New Backends::              Extending old backends.
862 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
863 * Mail-like Backends::                Some tips on mail backends.
864
865 Various File Formats
866
867 * Active File Format::      Information on articles and groups available.
868 * Newsgroups File Format::  Group descriptions.
869
870 Emacs for Heathens
871
872 * Keystrokes::      Entering text and executing commands.
873 * Emacs Lisp::      The built-in Emacs programming language.
874
875 @end detailmenu
876 @end menu
877
878 @node Starting Up
879 @chapter Starting gnus
880 @cindex starting up
881
882 @kindex M-x gnus
883 @findex gnus
884 If your system administrator has set things up properly, starting gnus
885 and reading news is extremely easy---you just type @kbd{M-x gnus} in
886 your Emacs.
887
888 @findex gnus-other-frame
889 @kindex M-x gnus-other-frame
890 If you want to start gnus in a different frame, you can use the command
891 @kbd{M-x gnus-other-frame} instead.
892
893 If things do not go smoothly at startup, you have to twiddle some
894 variables in your @file{~/.gnus} file.  This file is similar to
895 @file{~/.emacs}, but is read when gnus starts.
896
897 If you puzzle at any terms used in this manual, please refer to the
898 terminology section (@pxref{Terminology}).
899
900 @menu
901 * Finding the News::    Choosing a method for getting news.
902 * The First Time::      What does gnus do the first time you start it?
903 * The Server is Down::  How can I read my mail then?
904 * Slave Gnusae::        You can have more than one gnus active at a time.
905 * Fetching a Group::    Starting gnus just to read a group.
906 * New Groups::          What is gnus supposed to do with new groups?
907 * Startup Files::       Those pesky startup files---@file{.newsrc}.
908 * Auto Save::           Recovering from a crash.
909 * The Active File::     Reading the active file over a slow line Takes Time.
910 * Changing Servers::    You may want to move from one server to another.
911 * Startup Variables::   Other variables you might change.
912 @end menu
913
914
915 @node Finding the News
916 @section Finding the News
917 @cindex finding news
918
919 @vindex gnus-select-method
920 @c @head
921 The @code{gnus-select-method} variable says where gnus should look for
922 news.  This variable should be a list where the first element says
923 @dfn{how} and the second element says @dfn{where}.  This method is your
924 native method.  All groups not fetched with this method are
925 foreign groups.
926
927 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
928 you want to get your daily dosage of news from, you'd say:
929
930 @lisp
931 (setq gnus-select-method '(nntp "news.somewhere.edu"))
932 @end lisp
933
934 If you want to read directly from the local spool, say:
935
936 @lisp
937 (setq gnus-select-method '(nnspool ""))
938 @end lisp
939
940 If you can use a local spool, you probably should, as it will almost
941 certainly be much faster.
942
943 @vindex gnus-nntpserver-file
944 @cindex NNTPSERVER
945 @cindex @sc{nntp} server
946 If this variable is not set, gnus will take a look at the
947 @code{NNTPSERVER} environment variable.  If that variable isn't set,
948 gnus will see whether @code{gnus-nntpserver-file}
949 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
950 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
951
952 @vindex gnus-nntp-server
953 If @code{gnus-nntp-server} is set, this variable will override
954 @code{gnus-select-method}.  You should therefore set
955 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
956
957 @vindex gnus-secondary-servers
958 @vindex gnus-nntp-server
959 You can also make gnus prompt you interactively for the name of an
960 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
961 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
962 in the @code{gnus-secondary-servers} list (if any).  You can also just
963 type in the name of any server you feel like visiting.  (Note that this
964 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
965 gnus} later in the same Emacs session, Gnus will contact the same
966 server.)
967
968 @findex gnus-group-browse-foreign-server
969 @kindex B (Group)
970 However, if you use one @sc{nntp} server regularly and are just
971 interested in a couple of groups from a different server, you would be
972 better served by using the @kbd{B} command in the group buffer.  It will
973 let you have a look at what groups are available, and you can subscribe
974 to any of the groups you want to.  This also makes @file{.newsrc}
975 maintenance much tidier.  @xref{Foreign Groups}.
976
977 @vindex gnus-secondary-select-methods
978 @c @head
979 A slightly different approach to foreign groups is to set the
980 @code{gnus-secondary-select-methods} variable.  The select methods
981 listed in this variable are in many ways just as native as the
982 @code{gnus-select-method} server.  They will also be queried for active
983 files during startup (if that's required), and new newsgroups that
984 appear on these servers will be subscribed (or not) just as native
985 groups are.
986
987 For instance, if you use the @code{nnmbox} backend to read your mail, you
988 would typically set this variable to
989
990 @lisp
991 (setq gnus-secondary-select-methods '((nnmbox "")))
992 @end lisp
993
994
995 @node The First Time
996 @section The First Time
997 @cindex first time usage
998
999 If no startup files exist, gnus will try to determine what groups should
1000 be subscribed by default.
1001
1002 @vindex gnus-default-subscribed-newsgroups
1003 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
1004 will subscribe you to just those groups in that list, leaving the rest
1005 killed.  Your system administrator should have set this variable to
1006 something useful.
1007
1008 Since she hasn't, gnus will just subscribe you to a few arbitrarily
1009 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
1010 here as @dfn{whatever Lars thinks you should read}.)
1011
1012 You'll also be subscribed to the gnus documentation group, which should
1013 help you with most common problems.
1014
1015 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
1016 use the normal functions for handling new groups, and not do anything
1017 special.
1018
1019
1020 @node The Server is Down
1021 @section The Server is Down
1022 @cindex server errors
1023
1024 If the default server is down, gnus will understandably have some
1025 problems starting.  However, if you have some mail groups in addition to
1026 the news groups, you may want to start gnus anyway.
1027
1028 Gnus, being the trusting sort of program, will ask whether to proceed
1029 without a native select method if that server can't be contacted.  This
1030 will happen whether the server doesn't actually exist (i.e., you have
1031 given the wrong address) or the server has just momentarily taken ill
1032 for some reason or other.  If you decide to continue and have no foreign
1033 groups, you'll find it difficult to actually do anything in the group
1034 buffer.  But, hey, that's your problem.  Blllrph!
1035
1036 @findex gnus-no-server
1037 @kindex M-x gnus-no-server
1038 @c @head
1039 If you know that the server is definitely down, or you just want to read
1040 your mail without bothering with the server at all, you can use the
1041 @code{gnus-no-server} command to start gnus.  That might come in handy
1042 if you're in a hurry as well.  This command will not attempt to contact
1043 your primary server---instead, it will just activate all groups on level
1044 1 and 2.  (You should preferably keep no native groups on those two
1045 levels.)
1046
1047
1048 @node Slave Gnusae
1049 @section Slave Gnusae
1050 @cindex slave
1051
1052 You might want to run more than one Emacs with more than one gnus at the
1053 same time.  If you are using different @file{.newsrc} files (e.g., if you
1054 are using the two different gnusae to read from two different servers),
1055 that is no problem whatsoever.  You just do it.
1056
1057 The problem appears when you want to run two Gnusae that use the same
1058 @code{.newsrc} file.
1059
1060 To work around that problem some, we here at the Think-Tank at the gnus
1061 Towers have come up with a new concept: @dfn{Masters} and
1062 @dfn{slaves}.  (We have applied for a patent on this concept, and have
1063 taken out a copyright on those words.  If you wish to use those words in
1064 conjunction with each other, you have to send $1 per usage instance to
1065 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
1066 Applications}) will be much more expensive, of course.)
1067
1068 Anyways, you start one gnus up the normal way with @kbd{M-x gnus} (or
1069 however you do it).  Each subsequent slave gnusae should be started with
1070 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
1071 files, but instead save @dfn{slave files} that contain information only
1072 on what groups have been read in the slave session.  When a master gnus
1073 starts, it will read (and delete) these slave files, incorporating all
1074 information from them.  (The slave files will be read in the sequence
1075 they were created, so the latest changes will have precedence.)
1076
1077 Information from the slave files has, of course, precedence over the
1078 information in the normal (i.e., master) @code{.newsrc} file.
1079
1080
1081 @node Fetching a Group
1082 @section Fetching a Group
1083 @cindex fetching a group
1084
1085 @findex gnus-fetch-group
1086 It is sometimes convenient to be able to just say ``I want to read this
1087 group and I don't care whether gnus has been started or not''.  This is
1088 perhaps more useful for people who write code than for users, but the
1089 command @code{gnus-fetch-group} provides this functionality in any case.
1090 It takes the group name as a parameter.
1091
1092
1093 @node New Groups
1094 @section New Groups
1095 @cindex new groups
1096 @cindex subscription
1097
1098 @vindex gnus-check-new-newsgroups
1099 If you are satisfied that you really never want to see any new groups,
1100 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
1101 also save you some time at startup.  Even if this variable is
1102 @code{nil}, you can always subscribe to the new groups just by pressing
1103 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
1104 is @code{ask-server} by default.  If you set this variable to
1105 @code{always}, then gnus will query the backends for new groups even
1106 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1107
1108 @menu
1109 * Checking New Groups::      Determining what groups are new.
1110 * Subscription Methods::     What gnus should do with new groups.
1111 * Filtering New Groups::     Making gnus ignore certain new groups.
1112 @end menu
1113
1114
1115 @node Checking New Groups
1116 @subsection Checking New Groups
1117
1118 Gnus normally determines whether a group is new or not by comparing the
1119 list of groups from the active file(s) with the lists of subscribed and
1120 dead groups.  This isn't a particularly fast method.  If
1121 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
1122 server for new groups since the last time.  This is both faster and
1123 cheaper.  This also means that you can get rid of the list of killed
1124 groups altogether, so you may set @code{gnus-save-killed-list} to
1125 @code{nil}, which will save time both at startup, at exit, and all over.
1126 Saves disk space, too.  Why isn't this the default, then?
1127 Unfortunately, not all servers support this command.
1128
1129 I bet I know what you're thinking now: How do I find out whether my
1130 server supports @code{ask-server}?  No?  Good, because I don't have a
1131 fail-safe answer.  I would suggest just setting this variable to
1132 @code{ask-server} and see whether any new groups appear within the next
1133 few days.  If any do, then it works.  If none do, then it doesn't
1134 work.  I could write a function to make gnus guess whether the server
1135 supports @code{ask-server}, but it would just be a guess.  So I won't.
1136 You could @code{telnet} to the server and say @code{HELP} and see
1137 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
1138 it does, then it might work.  (But there are servers that lists
1139 @samp{NEWGROUPS} without supporting the function properly.)
1140
1141 This variable can also be a list of select methods.  If so, gnus will
1142 issue an @code{ask-server} command to each of the select methods, and
1143 subscribe them (or not) using the normal methods.  This might be handy
1144 if you are monitoring a few servers for new groups.  A side effect is
1145 that startup will take much longer, so you can meditate while waiting.
1146 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1147
1148
1149 @node Subscription Methods
1150 @subsection Subscription Methods
1151
1152 @vindex gnus-subscribe-newsgroup-method
1153 What gnus does when it encounters a new group is determined by the
1154 @code{gnus-subscribe-newsgroup-method} variable.
1155
1156 This variable should contain a function.  This function will be called
1157 with the name of the new group as the only parameter.
1158
1159 Some handy pre-fab functions are:
1160
1161 @table @code
1162
1163 @item gnus-subscribe-zombies
1164 @vindex gnus-subscribe-zombies
1165 Make all new groups zombies.  This is the default.  You can browse the
1166 zombies later (with @kbd{A z}) and either kill them all off properly
1167 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1168
1169 @item gnus-subscribe-randomly
1170 @vindex gnus-subscribe-randomly
1171 Subscribe all new groups in arbitrary order.  This really means that all
1172 new groups will be added at ``the top'' of the group buffer.
1173
1174 @item gnus-subscribe-alphabetically
1175 @vindex gnus-subscribe-alphabetically
1176 Subscribe all new groups in alphabetical order.
1177
1178 @item gnus-subscribe-hierarchically
1179 @vindex gnus-subscribe-hierarchically
1180 Subscribe all new groups hierarchically.  The difference between this
1181 function and @code{gnus-subscribe-alphabetically} is slight.
1182 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1183 alphabetical fashion, while this function will enter groups into its
1184 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
1185 @samp{comp} hierarchy, this function will not mess that configuration
1186 up.  Or something like that.
1187
1188 @item gnus-subscribe-interactively
1189 @vindex gnus-subscribe-interactively
1190 Subscribe new groups interactively.  This means that gnus will ask
1191 you about @strong{all} new groups.  The groups you choose to subscribe
1192 to will be subscribed hierarchically.
1193
1194 @item gnus-subscribe-killed
1195 @vindex gnus-subscribe-killed
1196 Kill all new groups.
1197
1198 @item gnus-subscribe-topics
1199 @vindex gnus-subscribe-topics
1200 Put the groups into the topic that has a matching @code{subscribe} topic 
1201 parameter (@pxref{Topic Parameters}).  For instance, a @code{subscribe}
1202 topic parameter that looks like
1203
1204 @example
1205 "nnslashdot"
1206 @end example
1207
1208 will mean that all groups that match that regex will be subscribed under 
1209 that topic.
1210
1211 If no topics match the groups, the groups will be subscribed in the
1212 top-level topic.
1213
1214 @end table
1215
1216 @vindex gnus-subscribe-hierarchical-interactive
1217 A closely related variable is
1218 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
1219 mouthful.)  If this variable is non-@code{nil}, gnus will ask you in a
1220 hierarchical fashion whether to subscribe to new groups or not.  Gnus
1221 will ask you for each sub-hierarchy whether you want to descend the
1222 hierarchy or not.
1223
1224 One common mistake is to set the variable a few paragraphs above
1225 (@code{gnus-subscribe-newsgroup-method}) to
1226 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
1227 will not work.  This is ga-ga.  So don't do it.
1228
1229
1230 @node Filtering New Groups
1231 @subsection Filtering New Groups
1232
1233 A nice and portable way to control which new newsgroups should be
1234 subscribed (or ignored) is to put an @dfn{options} line at the start of
1235 the @file{.newsrc} file.  Here's an example:
1236
1237 @example
1238 options -n !alt.all !rec.all sci.all
1239 @end example
1240
1241 @vindex gnus-subscribe-options-newsgroup-method
1242 This line obviously belongs to a serious-minded intellectual scientific
1243 person (or she may just be plain old boring), because it says that all
1244 groups that have names beginning with @samp{alt} and @samp{rec} should
1245 be ignored, and all groups with names beginning with @samp{sci} should
1246 be subscribed.  Gnus will not use the normal subscription method for
1247 subscribing these groups.
1248 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
1249 variable defaults to @code{gnus-subscribe-alphabetically}.
1250
1251 @vindex gnus-options-not-subscribe
1252 @vindex gnus-options-subscribe
1253 If you don't want to mess with your @file{.newsrc} file, you can just
1254 set the two variables @code{gnus-options-subscribe} and
1255 @code{gnus-options-not-subscribe}.  These two variables do exactly the
1256 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
1257 and if the new group matches the former, it will be unconditionally
1258 subscribed, and if it matches the latter, it will be ignored.
1259
1260 @vindex gnus-auto-subscribed-groups
1261 Yet another variable that meddles here is
1262 @code{gnus-auto-subscribed-groups}.  It works exactly like
1263 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
1264 thought it would be nice to have two of these.  This variable is more
1265 meant for setting some ground rules, while the other variable is used
1266 more for user fiddling.  By default this variable makes all new groups
1267 that come from mail backends (@code{nnml}, @code{nnbabyl},
1268 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
1269 don't like that, just set this variable to @code{nil}.
1270
1271 New groups that match this regexp are subscribed using
1272 @code{gnus-subscribe-options-newsgroup-method}.
1273
1274
1275 @node Changing Servers
1276 @section Changing Servers
1277 @cindex changing servers
1278
1279 Sometimes it is necessary to move from one @sc{nntp} server to another.
1280 This happens very rarely, but perhaps you change jobs, or one server is
1281 very flaky and you want to use another.
1282
1283 Changing the server is pretty easy, right?  You just change
1284 @code{gnus-select-method} to point to the new server?
1285
1286 @emph{Wrong!}
1287
1288 Article numbers are not (in any way) kept synchronized between different
1289 @sc{nntp} servers, and the only way Gnus keeps track of what articles
1290 you have read is by keeping track of article numbers.  So when you
1291 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1292 worthless.
1293
1294 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1295 file from one server to another.  They all have one thing in
1296 common---they take a looong time to run.  You don't want to use these
1297 functions more than absolutely necessary.
1298
1299 @kindex M-x gnus-change-server
1300 @findex gnus-change-server
1301 If you have access to both servers, Gnus can request the headers for all
1302 the articles you have read and compare @code{Message-ID}s and map the
1303 article numbers of the read articles and article marks.  The @kbd{M-x
1304 gnus-change-server} command will do this for all your native groups.  It
1305 will prompt for the method you want to move to.
1306
1307 @kindex M-x gnus-group-move-group-to-server
1308 @findex gnus-group-move-group-to-server
1309 You can also move individual groups with the @kbd{M-x
1310 gnus-group-move-group-to-server} command.  This is useful if you want to
1311 move a (foreign) group from one server to another.
1312
1313 @kindex M-x gnus-group-clear-data-on-native-groups
1314 @findex gnus-group-clear-data-on-native-groups
1315 If you don't have access to both the old and new server, all your marks
1316 and read ranges have become worthless.  You can use the @kbd{M-x
1317 gnus-group-clear-data-on-native-groups} command to clear out all data
1318 that you have on your native groups.  Use with caution.
1319
1320 After changing servers, you @strong{must} move the cache hierarchy away,
1321 since the cached articles will have wrong article numbers, which will
1322 affect which articles Gnus thinks are read.
1323
1324
1325 @node Startup Files
1326 @section Startup Files
1327 @cindex startup files
1328 @cindex .newsrc
1329 @cindex .newsrc.el
1330 @cindex .newsrc.eld
1331
1332 Now, you all know about the @file{.newsrc} file.  All subscription
1333 information is traditionally stored in this file.
1334
1335 Things got a bit more complicated with @sc{gnus}.  In addition to
1336 keeping the @file{.newsrc} file updated, it also used a file called
1337 @file{.newsrc.el} for storing all the information that didn't fit into
1338 the @file{.newsrc} file.  (Actually, it also duplicated everything in
1339 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
1340 files was the most recently saved, which enabled people to swap between
1341 @sc{gnus} and other newsreaders.
1342
1343 That was kinda silly, so Gnus went one better: In addition to the
1344 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1345 @file{.newsrc.eld}.  It will read whichever of these files that are most
1346 recent, but it will never write a @file{.newsrc.el} file.  You should
1347 never delete the @file{.newsrc.eld} file---it contains much information
1348 not stored in the @file{.newsrc} file.
1349
1350 @vindex gnus-save-newsrc-file
1351 @vindex gnus-read-newsrc-file
1352 You can turn off writing the @file{.newsrc} file by setting
1353 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1354 the file and save some space, as well as exiting from gnus faster.
1355 However, this will make it impossible to use other newsreaders than
1356 gnus.  But hey, who would want to, right?  Similarly, setting
1357 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
1358 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
1359 convenient if you have a tendency to use Netscape once in a while.
1360
1361 @vindex gnus-save-killed-list
1362 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1363 will not save the list of killed groups to the startup file.  This will
1364 save both time (when starting and quitting) and space (on disk).  It
1365 will also mean that Gnus has no record of what groups are new or old,
1366 so the automatic new groups subscription methods become meaningless.
1367 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1368 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1369 Groups}).  This variable can also be a regular expression.  If that's
1370 the case, remove all groups that do not match this regexp before
1371 saving.  This can be useful in certain obscure situations that involve
1372 several servers where not all servers support @code{ask-server}.
1373
1374 @vindex gnus-startup-file
1375 The @code{gnus-startup-file} variable says where the startup files are.
1376 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1377 file being whatever that one is, with a @samp{.eld} appended.
1378
1379 @vindex gnus-save-newsrc-hook
1380 @vindex gnus-save-quick-newsrc-hook
1381 @vindex gnus-save-standard-newsrc-hook
1382 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1383 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1384 saving the @file{.newsrc.eld} file, and
1385 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1386 @file{.newsrc} file.  The latter two are commonly used to turn version
1387 control on or off.  Version control is on by default when saving the
1388 startup files.  If you want to turn backup creation off, say something like:
1389
1390 @lisp
1391 (defun turn-off-backup ()
1392   (set (make-local-variable 'backup-inhibited) t))
1393
1394 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1395 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1396 @end lisp
1397
1398 @vindex gnus-init-file
1399 When gnus starts, it will read the @code{gnus-site-init-file}
1400 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
1401 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
1402 and can be used to avoid cluttering your @file{~/.emacs} and
1403 @file{site-init} files with gnus stuff.  Gnus will also check for files
1404 with the same names as these, but with @file{.elc} and @file{.el}
1405 suffixes.  In other words, if you have set @code{gnus-init-file} to
1406 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1407 and finally @file{~/.gnus} (in this order).
1408
1409
1410
1411 @node Auto Save
1412 @section Auto Save
1413 @cindex dribble file
1414 @cindex auto-save
1415
1416 Whenever you do something that changes the gnus data (reading articles,
1417 catching up, killing/subscribing groups), the change is added to a
1418 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
1419 Emacs way.  If your Emacs should crash before you have saved the
1420 @file{.newsrc} files, all changes you have made can be recovered from
1421 this file.
1422
1423 If gnus detects this file at startup, it will ask the user whether to
1424 read it.  The auto save file is deleted whenever the real startup file is
1425 saved.
1426
1427 @vindex gnus-use-dribble-file
1428 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
1429 maintain a dribble buffer.  The default is @code{t}.
1430
1431 @vindex gnus-dribble-directory
1432 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
1433 this variable is @code{nil}, which it is by default, gnus will dribble
1434 into the directory where the @file{.newsrc} file is located.  (This is
1435 normally the user's home directory.)  The dribble file will get the same
1436 file permissions as the @code{.newsrc} file.
1437
1438 @vindex gnus-always-read-dribble-file
1439 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1440 read the dribble file on startup without querying the user.
1441
1442
1443 @node The Active File
1444 @section The Active File
1445 @cindex active file
1446 @cindex ignored groups
1447
1448 When gnus starts, or indeed whenever it tries to determine whether new
1449 articles have arrived, it reads the active file.  This is a very large
1450 file that lists all the active groups and articles on the server.
1451
1452 @vindex gnus-ignored-newsgroups
1453 Before examining the active file, gnus deletes all lines that match the
1454 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
1455 any groups with bogus names, but you can use this variable to make gnus
1456 ignore hierarchies you aren't ever interested in.  However, this is not
1457 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
1458 Groups} for an overview of other variables that can be used instead.
1459
1460 @c This variable is
1461 @c @code{nil} by default, and will slow down active file handling somewhat
1462 @c if you set it to anything else.
1463
1464 @vindex gnus-read-active-file
1465 @c @head
1466 The active file can be rather Huge, so if you have a slow network, you
1467 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
1468 reading the active file.  This variable is @code{some} by default.
1469
1470 Gnus will try to make do by getting information just on the groups that
1471 you actually subscribe to.
1472
1473 Note that if you subscribe to lots and lots of groups, setting this
1474 variable to @code{nil} will probably make gnus slower, not faster.  At
1475 present, having this variable @code{nil} will slow gnus down
1476 considerably, unless you read news over a 2400 baud modem.
1477
1478 This variable can also have the value @code{some}.  Gnus will then
1479 attempt to read active info only on the subscribed groups.  On some
1480 servers this is quite fast (on sparkling, brand new INN servers that
1481 support the @code{LIST ACTIVE group} command), on others this isn't fast
1482 at all.  In any case, @code{some} should be faster than @code{nil}, and
1483 is certainly faster than @code{t} over slow lines.
1484
1485 Some news servers (Leafnode and old versions of INN, for instance) do
1486 not support the @code{LIST ACTIVE group}.  For these servers, @code{nil}
1487 is probably the most efficient value for this variable.
1488
1489 If this variable is @code{nil}, gnus will ask for group info in total
1490 lock-step, which isn't very fast.  If it is @code{some} and you use an
1491 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1492 read all the replies in one swoop.  This will normally result in better
1493 performance, but if the server does not support the aforementioned
1494 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1495
1496 If you think that starting up Gnus takes too long, try all the three
1497 different values for this variable and see what works best for you.
1498
1499 In any case, if you use @code{some} or @code{nil}, you should definitely
1500 kill all groups that you aren't interested in to speed things up.
1501
1502 Note that this variable also affects active file retrieval from
1503 secondary select methods.
1504
1505
1506 @node Startup Variables
1507 @section Startup Variables
1508
1509 @table @code
1510
1511 @item gnus-load-hook
1512 @vindex gnus-load-hook
1513 A hook run while gnus is being loaded.  Note that this hook will
1514 normally be run just once in each Emacs session, no matter how many
1515 times you start gnus.
1516
1517 @item gnus-before-startup-hook
1518 @vindex gnus-before-startup-hook
1519 A hook run after starting up gnus successfully.
1520
1521 @item gnus-startup-hook
1522 @vindex gnus-startup-hook
1523 A hook run as the very last thing after starting up gnus
1524
1525 @item gnus-started-hook
1526 @vindex gnus-started-hook
1527 A hook that is run as the very last thing after starting up gnus
1528 successfully.
1529
1530 @item gnus-setup-news-hook
1531 @vindex gnus-setup-news-hook
1532 A hook that is run after reading the @file{.newsrc} file(s), but before
1533 generating the group buffer.
1534
1535 @item gnus-check-bogus-newsgroups
1536 @vindex gnus-check-bogus-newsgroups
1537 If non-@code{nil}, gnus will check for and delete all bogus groups at
1538 startup.  A @dfn{bogus group} is a group that you have in your
1539 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
1540 bogus groups can take quite a while, so to save time and resources it's
1541 best to leave this option off, and do the checking for bogus groups once
1542 in a while from the group buffer instead (@pxref{Group Maintenance}).
1543
1544 @item gnus-inhibit-startup-message
1545 @vindex gnus-inhibit-startup-message
1546 If non-@code{nil}, the startup message won't be displayed.  That way,
1547 your boss might not notice as easily that you are reading news instead
1548 of doing your job.  Note that this variable is used before
1549 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1550
1551 @item gnus-no-groups-message
1552 @vindex gnus-no-groups-message
1553 Message displayed by gnus when no groups are available.
1554
1555 @item gnus-play-startup-jingle
1556 @vindex gnus-play-startup-jingle
1557 If non-@code{nil}, play the gnus jingle at startup.
1558
1559 @item gnus-startup-jingle
1560 @vindex gnus-startup-jingle
1561 Jingle to be played if the above variable is non-@code{nil}.  The
1562 default is @samp{Tuxedomoon.Jingle4.au}.
1563
1564 @end table
1565
1566
1567 @node The Group Buffer
1568 @chapter The Group Buffer
1569 @cindex group buffer
1570
1571 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1572 is the first buffer shown when gnus starts, and will never be killed as
1573 long as gnus is active.
1574
1575 @iftex
1576 @iflatex
1577 \gnusfigure{The Group Buffer}{320}{
1578 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1579 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1580 \put(120,38){\vector(1,2){10}}
1581 \put(40,60){\makebox(0,0)[r]{Mode line}}
1582 \put(40,58){\vector(1,0){30}}
1583 \put(200,28){\makebox(0,0)[t]{Native select method}}
1584 \put(200,26){\vector(-1,2){15}}
1585 }
1586 @end iflatex
1587 @end iftex
1588
1589 @menu
1590 * Group Buffer Format::    Information listed and how you can change it.
1591 * Group Maneuvering::      Commands for moving in the group buffer.
1592 * Selecting a Group::      Actually reading news.
1593 * Group Data::             Changing the info for a group.
1594 * Subscription Commands::  Unsubscribing, killing, subscribing.
1595 * Group Levels::           Levels? What are those, then?
1596 * Group Score::            A mechanism for finding out what groups you like.
1597 * Marking Groups::         You can mark groups for later processing.
1598 * Foreign Groups::         Creating and editing groups.
1599 * Group Parameters::       Each group may have different parameters set.
1600 * Listing Groups::         Gnus can list various subsets of the groups.
1601 * Sorting Groups::         Re-arrange the group order.
1602 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1603 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1604 * Exiting Gnus::           Stop reading news and get some work done.
1605 * Group Topics::           A folding group mode divided into topics.
1606 * Misc Group Stuff::       Other stuff that you can to do.
1607 @end menu
1608
1609
1610 @node Group Buffer Format
1611 @section Group Buffer Format
1612
1613 @menu
1614 * Group Line Specification::       Deciding how the group buffer is to look.
1615 * Group Modeline Specification::   The group buffer modeline.
1616 * Group Highlighting::             Having nice colors in the group buffer.
1617 @end menu
1618
1619
1620 @node Group Line Specification
1621 @subsection Group Line Specification
1622 @cindex group buffer format
1623
1624 The default format of the group buffer is nice and dull, but you can
1625 make it as exciting and ugly as you feel like.
1626
1627 Here's a couple of example group lines:
1628
1629 @example
1630      25: news.announce.newusers
1631  *    0: alt.fan.andrea-dworkin
1632 @end example
1633
1634 Quite simple, huh?
1635
1636 You can see that there are 25 unread articles in
1637 @samp{news.announce.newusers}.  There are no unread articles, but some
1638 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1639 asterisk at the beginning of the line?).
1640
1641 @vindex gnus-group-line-format
1642 You can change that format to whatever you want by fiddling with the
1643 @code{gnus-group-line-format} variable.  This variable works along the
1644 lines of a @code{format} specification, which is pretty much the same as
1645 a @code{printf} specifications, for those of you who use (feh!) C.
1646 @xref{Formatting Variables}.
1647
1648 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1649
1650 There should always be a colon on the line; the cursor always moves to
1651 the colon after performing an operation.  Nothing else is required---not
1652 even the group name.  All displayed text is just window dressing, and is
1653 never examined by gnus.  Gnus stores all real information it needs using
1654 text properties.
1655
1656 (Note that if you make a really strange, wonderful, spreadsheet-like
1657 layout, everybody will believe you are hard at work with the accounting
1658 instead of wasting time reading news.)
1659
1660 Here's a list of all available format characters:
1661
1662 @table @samp
1663
1664 @item M
1665 An asterisk if the group only has marked articles.
1666
1667 @item S
1668 Whether the group is subscribed.
1669
1670 @item L
1671 Level of subscribedness.
1672
1673 @item N
1674 Number of unread articles.
1675
1676 @item I
1677 Number of dormant articles.
1678
1679 @item T
1680 Number of ticked articles.
1681
1682 @item R
1683 Number of read articles.
1684
1685 @item t
1686 Estimated total number of articles.  (This is really @var{max-number}
1687 minus @var{min-number} plus 1.)
1688
1689 @item y
1690 Number of unread, unticked, non-dormant articles.
1691
1692 @item i
1693 Number of ticked and dormant articles.
1694
1695 @item g
1696 Full group name.
1697
1698 @item G
1699 Group name.
1700
1701 @item D
1702 Newsgroup description.
1703
1704 @item o
1705 @samp{m} if moderated.
1706
1707 @item O
1708 @samp{(m)} if moderated.
1709
1710 @item s
1711 Select method.
1712
1713 @item n
1714 Select from where.
1715
1716 @item z
1717 A string that looks like @samp{<%s:%n>} if a foreign select method is
1718 used.
1719
1720 @item P
1721 Indentation based on the level of the topic (@pxref{Group Topics}).
1722
1723 @item c
1724 @vindex gnus-group-uncollapsed-levels
1725 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1726 variable says how many levels to leave at the end of the group name.
1727 The default is 1---this will mean that group names like
1728 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1729
1730 @item m
1731 @vindex gnus-new-mail-mark
1732 @cindex %
1733 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1734 the group lately.
1735
1736 @item d
1737 A string that says when you last read the group (@pxref{Group
1738 Timestamp}).
1739
1740 @item u
1741 User defined specifier.  The next character in the format string should
1742 be a letter.  Gnus will call the function
1743 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1744 following @samp{%u}.  The function will be passed a single dummy
1745 parameter as argument.  The function should return a string, which will
1746 be inserted into the buffer just like information from any other
1747 specifier.
1748 @end table
1749
1750 @cindex *
1751 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1752 if no info is available---for instance, if it is a non-activated foreign
1753 group, or a bogus native group.
1754
1755
1756 @node Group Modeline Specification
1757 @subsection Group Modeline Specification
1758 @cindex group modeline
1759
1760 @vindex gnus-group-mode-line-format
1761 The mode line can be changed by setting
1762 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
1763 doesn't understand that many format specifiers:
1764
1765 @table @samp
1766 @item S
1767 The native news server.
1768 @item M
1769 The native select method.
1770 @end table
1771
1772
1773 @node Group Highlighting
1774 @subsection Group Highlighting
1775 @cindex highlighting
1776 @cindex group highlighting
1777
1778 @vindex gnus-group-highlight
1779 Highlighting in the group buffer is controlled by the
1780 @code{gnus-group-highlight} variable.  This is an alist with elements
1781 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
1782 something non-@code{nil}, the @var{face} will be used on the line.
1783
1784 Here's an example value for this variable that might look nice if the
1785 background is dark:
1786
1787 @lisp
1788 (cond (window-system
1789        (setq custom-background-mode 'light)
1790        (defface my-group-face-1
1791          '((t (:foreground "Red" :bold t))) "First group face")
1792        (defface my-group-face-2
1793          '((t (:foreground "DarkSeaGreen4" :bold t))) "Second group face")
1794        (defface my-group-face-3
1795          '((t (:foreground "Green4" :bold t))) "Third group face")
1796        (defface my-group-face-4
1797          '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1798        (defface my-group-face-5
1799          '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1800
1801 (setq gnus-group-highlight
1802       '(((> unread 200) . my-group-face-1)
1803         ((and (< level 3) (zerop unread)) . my-group-face-2)
1804         ((< level 3) . my-group-face-3)
1805         ((zerop unread) . my-group-face-4)
1806         (t . my-group-face-5)))
1807 @end lisp
1808
1809 Also @pxref{Faces and Fonts}.
1810
1811 Variables that are dynamically bound when the forms are evaluated
1812 include:
1813
1814 @table @code
1815 @item group
1816 The group name.
1817 @item unread
1818 The number of unread articles in the group.
1819 @item method
1820 The select method.
1821 @item mailp
1822 Whether the group is a mail group.
1823 @item level
1824 The level of the group.
1825 @item score
1826 The score of the group.
1827 @item ticked
1828 The number of ticked articles in the group.
1829 @item total
1830 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1831 MIN-NUMBER plus one.
1832 @item topic
1833 When using the topic minor mode, this variable is bound to the current
1834 topic being inserted.
1835 @end table
1836
1837 When the forms are @code{eval}ed, point is at the beginning of the line
1838 of the group in question, so you can use many of the normal gnus
1839 functions for snarfing info on the group.
1840
1841 @vindex gnus-group-update-hook
1842 @findex gnus-group-highlight-line
1843 @code{gnus-group-update-hook} is called when a group line is changed.
1844 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1845 calls @code{gnus-group-highlight-line} by default.
1846
1847
1848 @node Group Maneuvering
1849 @section Group Maneuvering
1850 @cindex group movement
1851
1852 All movement commands understand the numeric prefix and will behave as
1853 expected, hopefully.
1854
1855 @table @kbd
1856
1857 @item n
1858 @kindex n (Group)
1859 @findex gnus-group-next-unread-group
1860 Go to the next group that has unread articles
1861 (@code{gnus-group-next-unread-group}).
1862
1863 @item p
1864 @itemx DEL
1865 @kindex DEL (Group)
1866 @kindex p (Group)
1867 @findex gnus-group-prev-unread-group
1868 Go to the previous group that has unread articles
1869 (@code{gnus-group-prev-unread-group}).
1870
1871 @item N
1872 @kindex N (Group)
1873 @findex gnus-group-next-group
1874 Go to the next group (@code{gnus-group-next-group}).
1875
1876 @item P
1877 @kindex P (Group)
1878 @findex gnus-group-prev-group
1879 Go to the previous group (@code{gnus-group-prev-group}).
1880
1881 @item M-n
1882 @kindex M-n (Group)
1883 @findex gnus-group-next-unread-group-same-level
1884 Go to the next unread group on the same (or lower) level
1885 (@code{gnus-group-next-unread-group-same-level}).
1886
1887 @item M-p
1888 @kindex M-p (Group)
1889 @findex gnus-group-prev-unread-group-same-level
1890 Go to the previous unread group on the same (or lower) level
1891 (@code{gnus-group-prev-unread-group-same-level}).
1892 @end table
1893
1894 Three commands for jumping to groups:
1895
1896 @table @kbd
1897
1898 @item j
1899 @kindex j (Group)
1900 @findex gnus-group-jump-to-group
1901 Jump to a group (and make it visible if it isn't already)
1902 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1903 like living groups.
1904
1905 @item ,
1906 @kindex , (Group)
1907 @findex gnus-group-best-unread-group
1908 Jump to the unread group with the lowest level
1909 (@code{gnus-group-best-unread-group}).
1910
1911 @item .
1912 @kindex . (Group)
1913 @findex gnus-group-first-unread-group
1914 Jump to the first group with unread articles
1915 (@code{gnus-group-first-unread-group}).
1916 @end table
1917
1918 @vindex gnus-group-goto-unread
1919 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1920 commands will move to the next group, not the next unread group.  Even
1921 the commands that say they move to the next unread group.  The default
1922 is @code{t}.
1923
1924
1925 @node Selecting a Group
1926 @section Selecting a Group
1927 @cindex group selection
1928
1929 @table @kbd
1930
1931 @item SPACE
1932 @kindex SPACE (Group)
1933 @findex gnus-group-read-group
1934 Select the current group, switch to the summary buffer and display the
1935 first unread article (@code{gnus-group-read-group}).  If there are no
1936 unread articles in the group, or if you give a non-numerical prefix to
1937 this command, gnus will offer to fetch all the old articles in this
1938 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1939 determines the number of articles gnus will fetch.  If @var{N} is
1940 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1941 negative, Gnus fetches the @code{abs(@var{N})} oldest articles.
1942
1943 @item RET
1944 @kindex RET (Group)
1945 @findex gnus-group-select-group
1946 Select the current group and switch to the summary buffer
1947 (@code{gnus-group-select-group}).  Takes the same arguments as
1948 @code{gnus-group-read-group}---the only difference is that this command
1949 does not display the first unread article automatically upon group
1950 entry.
1951
1952 @item M-RET
1953 @kindex M-RET (Group)
1954 @findex gnus-group-quick-select-group
1955 This does the same as the command above, but tries to do it with the
1956 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1957 scoring/killing will be performed, there will be no highlights and no
1958 expunging.  This might be useful if you're in a real hurry and have to
1959 enter some humongous group.  If you give a 0 prefix to this command
1960 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1961 which is useful if you want to toggle threading before generating the
1962 summary buffer (@pxref{Summary Generation Commands}).
1963
1964 @item M-SPACE
1965 @kindex M-SPACE (Group)
1966 @findex gnus-group-visible-select-group
1967 This is yet one more command that does the same as the @kbd{RET}
1968 command, but this one does it without expunging and hiding dormants
1969 (@code{gnus-group-visible-select-group}).
1970
1971 @item M-C-RET
1972 @kindex M-C-RET (Group)
1973 @findex gnus-group-select-group-ephemerally
1974 Finally, this command selects the current group ephemerally without
1975 doing any processing of its contents
1976 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1977 turned off.  Everything you do in the group after selecting it in this
1978 manner will have no permanent effects.
1979
1980 @end table
1981
1982 @vindex gnus-large-newsgroup
1983 The @code{gnus-large-newsgroup} variable says what gnus should consider
1984 to be a big group.  This is 200 by default.  If the group has more
1985 (unread and/or ticked) articles than this, gnus will query the user
1986 before entering the group.  The user can then specify how many articles
1987 should be fetched from the server.  If the user specifies a negative
1988 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1989 is positive, the @code{n} articles that have arrived most recently will
1990 be fetched.
1991
1992 @vindex gnus-select-group-hook
1993 @vindex gnus-auto-select-first
1994 @code{gnus-auto-select-first} control whether any articles are selected
1995 automatically when entering a group with the @kbd{SPACE} command.
1996
1997 @table @code
1998
1999 @item nil
2000 Don't select any articles when entering the group.  Just display the
2001 full summary buffer.
2002
2003 @item t
2004 Select the first unread article when entering the group.
2005
2006 @item best
2007 Select the highest scored article in the group when entering the
2008 group.
2009
2010 @end table
2011
2012 This variable can also be a function.  In that case, that function will
2013 be called to place point on a subject line, and/or select some article.
2014 Useful functions include:
2015
2016 @table @code
2017 @item gnus-summary-first-unread-subject
2018 Place point on the subject line of the first unread article, but
2019 don't select the article.
2020
2021 @item gnus-summary-first-unread-article
2022 Select the first unread article.
2023
2024 @item gnus-summary-best-unread-article
2025 Select the highest-scored unread article.
2026 @end table
2027
2028
2029 If you want to prevent automatic selection in some group (say, in a
2030 binary group with Huge articles) you can set this variable to @code{nil}
2031 in @code{gnus-select-group-hook}, which is called when a group is
2032 selected.
2033
2034
2035 @node Subscription Commands
2036 @section Subscription Commands
2037 @cindex subscription
2038
2039 @table @kbd
2040
2041 @item S t
2042 @itemx u
2043 @kindex S t (Group)
2044 @kindex u (Group)
2045 @findex gnus-group-unsubscribe-current-group
2046 @c @icon{gnus-group-unsubscribe}
2047 Toggle subscription to the current group
2048 (@code{gnus-group-unsubscribe-current-group}).
2049
2050 @item S s
2051 @itemx U
2052 @kindex S s (Group)
2053 @kindex U (Group)
2054 @findex gnus-group-unsubscribe-group
2055 Prompt for a group to subscribe, and then subscribe it.  If it was
2056 subscribed already, unsubscribe it instead
2057 (@code{gnus-group-unsubscribe-group}).
2058
2059 @item S k
2060 @itemx C-k
2061 @kindex S k (Group)
2062 @kindex C-k (Group)
2063 @findex gnus-group-kill-group
2064 @c @icon{gnus-group-kill-group}
2065 Kill the current group (@code{gnus-group-kill-group}).
2066
2067 @item S y
2068 @itemx C-y
2069 @kindex S y (Group)
2070 @kindex C-y (Group)
2071 @findex gnus-group-yank-group
2072 Yank the last killed group (@code{gnus-group-yank-group}).
2073
2074 @item C-x C-t
2075 @kindex C-x C-t (Group)
2076 @findex gnus-group-transpose-groups
2077 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
2078 really a subscription command, but you can use it instead of a
2079 kill-and-yank sequence sometimes.
2080
2081 @item S w
2082 @itemx C-w
2083 @kindex S w (Group)
2084 @kindex C-w (Group)
2085 @findex gnus-group-kill-region
2086 Kill all groups in the region (@code{gnus-group-kill-region}).
2087
2088 @item S z
2089 @kindex S z (Group)
2090 @findex gnus-group-kill-all-zombies
2091 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2092
2093 @item S C-k
2094 @kindex S C-k (Group)
2095 @findex gnus-group-kill-level
2096 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2097 These groups can't be yanked back after killing, so this command should
2098 be used with some caution.  The only time where this command comes in
2099 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2100 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
2101 kill off all unsubscribed groups that do not have message numbers in the
2102 @file{.newsrc} file.
2103
2104 @end table
2105
2106 Also @pxref{Group Levels}.
2107
2108
2109 @node Group Data
2110 @section Group Data
2111
2112 @table @kbd
2113
2114 @item c
2115 @kindex c (Group)
2116 @findex gnus-group-catchup-current
2117 @vindex gnus-group-catchup-group-hook
2118 @c @icon{gnus-group-catchup-current}
2119 Mark all unticked articles in this group as read
2120 (@code{gnus-group-catchup-current}).
2121 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2122 the group buffer.
2123
2124 @item C
2125 @kindex C (Group)
2126 @findex gnus-group-catchup-current-all
2127 Mark all articles in this group, even the ticked ones, as read
2128 (@code{gnus-group-catchup-current-all}).
2129
2130 @item M-c
2131 @kindex M-c (Group)
2132 @findex gnus-group-clear-data
2133 Clear the data from the current group---nix out marks and the list of
2134 read articles (@code{gnus-group-clear-data}).
2135
2136 @item M-x gnus-group-clear-data-on-native-groups
2137 @kindex M-x gnus-group-clear-data-on-native-groups
2138 @findex gnus-group-clear-data-on-native-groups
2139 If you have switched from one @sc{nntp} server to another, all your marks
2140 and read ranges have become worthless.  You can use this command to
2141 clear out all data that you have on your native groups.  Use with
2142 caution.
2143
2144 @end table
2145
2146
2147 @node Group Levels
2148 @section Group Levels
2149 @cindex group level
2150 @cindex level
2151
2152 All groups have a level of @dfn{subscribedness}.  For instance, if a
2153 group is on level 2, it is more subscribed than a group on level 5.  You
2154 can ask gnus to just list groups on a given level or lower
2155 (@pxref{Listing Groups}), or to just check for new articles in groups on
2156 a given level or lower (@pxref{Scanning New Messages}).
2157
2158 Remember:  The higher the level of the group, the less important it is.
2159
2160 @table @kbd
2161
2162 @item S l
2163 @kindex S l (Group)
2164 @findex gnus-group-set-current-level
2165 Set the level of the current group.  If a numeric prefix is given, the
2166 next @var{n} groups will have their levels set.  The user will be
2167 prompted for a level.
2168 @end table
2169
2170 @vindex gnus-level-killed
2171 @vindex gnus-level-zombie
2172 @vindex gnus-level-unsubscribed
2173 @vindex gnus-level-subscribed
2174 Gnus considers groups from levels 1 to
2175 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2176 @code{gnus-level-subscribed} (exclusive) and
2177 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2178 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2179 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2180 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
2181 same, but zombie and killed groups have no information on what articles
2182 you have read, etc, stored.  This distinction between dead and living
2183 groups isn't done because it is nice or clever, it is done purely for
2184 reasons of efficiency.
2185
2186 It is recommended that you keep all your mail groups (if any) on quite
2187 low levels (e.g. 1 or 2).
2188
2189 Maybe the following description of the default behavior of Gnus helps to
2190 understand what these levels are all about.  By default, Gnus shows you
2191 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2192 empty subscribed groups and unsubscribed groups, too.  Type @kbd{l} to
2193 go back to showing nonempty subscribed groups again.  Thus, unsubscribed
2194 groups are hidden, in a way.
2195
2196 Zombie and killed groups are similar to unsubscribed groups in that they
2197 are hidden by default.  But they are different from subscribed and
2198 unsubscribed groups in that Gnus doesn't ask the news server for
2199 information (number of messages, number of unread messages) on zombie
2200 and killed groups.  Normally, you use @kbd{C-k} to kill the groups you
2201 aren't interested in.  If most groups are killed, Gnus is faster.
2202
2203 Why does Gnus distinguish between zombie and killed groups?  Well, when
2204 a new group arrives on the server, Gnus by default makes it a zombie
2205 group.  This means that you are normally not bothered with new groups,
2206 but you can type @kbd{A z} to get a list of all new groups.  Subscribe
2207 the ones you like and kill the ones you don't want.  (@kbd{A k} shows a
2208 list of killed groups.)
2209
2210 If you want to play with the level variables, you should show some care.
2211 Set them once, and don't touch them ever again.  Better yet, don't touch
2212 them at all unless you know exactly what you're doing.
2213
2214 @vindex gnus-level-default-unsubscribed
2215 @vindex gnus-level-default-subscribed
2216 Two closely related variables are @code{gnus-level-default-subscribed}
2217 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2218 which are the levels that new groups will be put on if they are
2219 (un)subscribed.  These two variables should, of course, be inside the
2220 relevant valid ranges.
2221
2222 @vindex gnus-keep-same-level
2223 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2224 will only move to groups of the same level (or lower).  In
2225 particular, going from the last article in one group to the next group
2226 will go to the next group of the same level (or lower).  This might be
2227 handy if you want to read the most important groups before you read the
2228 rest.
2229
2230 If this variable is @code{best}, Gnus will make the next newsgroup the
2231 one with the best level.
2232
2233 @vindex gnus-group-default-list-level
2234 All groups with a level less than or equal to
2235 @code{gnus-group-default-list-level} will be listed in the group buffer
2236 by default.
2237
2238 @vindex gnus-group-list-inactive-groups
2239 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2240 groups will be listed along with the unread groups.  This variable is
2241 @code{t} by default.  If it is @code{nil}, inactive groups won't be
2242 listed.
2243
2244 @vindex gnus-group-use-permanent-levels
2245 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2246 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2247 use this level as the ``work'' level.
2248
2249 @vindex gnus-activate-level
2250 Gnus will normally just activate (i. e., query the server about) groups
2251 on level @code{gnus-activate-level} or less.  If you don't want to
2252 activate unsubscribed groups, for instance, you might set this variable
2253 to 5.  The default is 6.
2254
2255
2256 @node Group Score
2257 @section Group Score
2258 @cindex group score
2259 @cindex group rank
2260 @cindex rank
2261
2262 You would normally keep important groups on high levels, but that scheme
2263 is somewhat restrictive.  Don't you wish you could have Gnus sort the
2264 group buffer according to how often you read groups, perhaps?  Within
2265 reason?
2266
2267 This is what @dfn{group score} is for.  You can have Gnus assign a score
2268 to each group through the mechanism described below.  You can then sort
2269 the group buffer based on this score.  Alternatively, you can sort on
2270 score and then level.  (Taken together, the level and the score is
2271 called the @dfn{rank} of the group.  A group that is on level 4 and has
2272 a score of 1 has a higher rank than a group on level 5 that has a score
2273 of 300.  (The level is the most significant part and the score is the
2274 least significant part.))
2275
2276 @findex gnus-summary-bubble-group
2277 If you want groups you read often to get higher scores than groups you
2278 read seldom you can add the @code{gnus-summary-bubble-group} function to
2279 the @code{gnus-summary-exit-hook} hook.  This will result (after
2280 sorting) in a bubbling sort of action.  If you want to see that in
2281 action after each summary exit, you can add
2282 @code{gnus-group-sort-groups-by-rank} or
2283 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2284 slow things down somewhat.
2285
2286
2287 @node Marking Groups
2288 @section Marking Groups
2289 @cindex marking groups
2290
2291 If you want to perform some command on several groups, and they appear
2292 subsequently in the group buffer, you would normally just give a
2293 numerical prefix to the command.  Most group commands will then do your
2294 bidding on those groups.
2295
2296 However, if the groups are not in sequential order, you can still
2297 perform a command on several groups.  You simply mark the groups first
2298 with the process mark and then execute the command.
2299
2300 @table @kbd
2301
2302 @item #
2303 @kindex # (Group)
2304 @itemx M m
2305 @kindex M m (Group)
2306 @findex gnus-group-mark-group
2307 Set the mark on the current group (@code{gnus-group-mark-group}).
2308
2309 @item M-#
2310 @kindex M-# (Group)
2311 @itemx M u
2312 @kindex M u (Group)
2313 @findex gnus-group-unmark-group
2314 Remove the mark from the current group
2315 (@code{gnus-group-unmark-group}).
2316
2317 @item M U
2318 @kindex M U (Group)
2319 @findex gnus-group-unmark-all-groups
2320 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2321
2322 @item M w
2323 @kindex M w (Group)
2324 @findex gnus-group-mark-region
2325 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2326
2327 @item M b
2328 @kindex M b (Group)
2329 @findex gnus-group-mark-buffer
2330 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2331
2332 @item M r
2333 @kindex M r (Group)
2334 @findex gnus-group-mark-regexp
2335 Mark all groups that match some regular expression
2336 (@code{gnus-group-mark-regexp}).
2337 @end table
2338
2339 Also @pxref{Process/Prefix}.
2340
2341 @findex gnus-group-universal-argument
2342 If you want to execute some command on all groups that have been marked
2343 with the process mark, you can use the @kbd{M-&}
2344 (@code{gnus-group-universal-argument}) command.  It will prompt you for
2345 the command to be executed.
2346
2347
2348 @node Foreign Groups
2349 @section Foreign Groups
2350 @cindex foreign groups
2351
2352 Below are some group mode commands for making and editing general foreign
2353 groups, as well as commands to ease the creation of a few
2354 special-purpose groups.  All these commands insert the newly created
2355 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2356 consulted.
2357
2358 @table @kbd
2359
2360 @item G m
2361 @kindex G m (Group)
2362 @findex gnus-group-make-group
2363 @cindex making groups
2364 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
2365 for a name, a method and possibly an @dfn{address}.  For an easier way
2366 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
2367
2368 @item G r
2369 @kindex G r (Group)
2370 @findex gnus-group-rename-group
2371 @cindex renaming groups
2372 Rename the current group to something else
2373 (@code{gnus-group-rename-group}).  This is valid only on some
2374 groups---mail groups mostly.  This command might very well be quite slow
2375 on some backends.
2376
2377 @item G c
2378 @kindex G c (Group)
2379 @cindex customizing
2380 @findex gnus-group-customize
2381 Customize the group parameters (@code{gnus-group-customize}).
2382
2383 @item G e
2384 @kindex G e (Group)
2385 @findex gnus-group-edit-group-method
2386 @cindex renaming groups
2387 Enter a buffer where you can edit the select method of the current
2388 group (@code{gnus-group-edit-group-method}).
2389
2390 @item G p
2391 @kindex G p (Group)
2392 @findex gnus-group-edit-group-parameters
2393 Enter a buffer where you can edit the group parameters
2394 (@code{gnus-group-edit-group-parameters}).
2395
2396 @item G E
2397 @kindex G E (Group)
2398 @findex gnus-group-edit-group
2399 Enter a buffer where you can edit the group info
2400 (@code{gnus-group-edit-group}).
2401
2402 @item G d
2403 @kindex G d (Group)
2404 @findex gnus-group-make-directory-group
2405 @cindex nndir
2406 Make a directory group (@pxref{Directory Groups}).  You will be prompted
2407 for a directory name (@code{gnus-group-make-directory-group}).
2408
2409 @item G h
2410 @kindex G h (Group)
2411 @cindex help group
2412 @findex gnus-group-make-help-group
2413 Make the gnus help group (@code{gnus-group-make-help-group}).
2414
2415 @item G a
2416 @kindex G a (Group)
2417 @cindex (ding) archive
2418 @cindex archive group
2419 @findex gnus-group-make-archive-group
2420 @vindex gnus-group-archive-directory
2421 @vindex gnus-group-recent-archive-directory
2422 Make a gnus archive group (@code{gnus-group-make-archive-group}).  By
2423 default a group pointing to the most recent articles will be created
2424 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2425 group will be created from @code{gnus-group-archive-directory}.
2426
2427 @item G k
2428 @kindex G k (Group)
2429 @findex gnus-group-make-kiboze-group
2430 @cindex nnkiboze
2431 Make a kiboze group.  You will be prompted for a name, for a regexp to
2432 match groups to be ``included'' in the kiboze group, and a series of
2433 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2434 @xref{Kibozed Groups}.
2435
2436 @item G D
2437 @kindex G D (Group)
2438 @findex gnus-group-enter-directory
2439 @cindex nneething
2440 Read an arbitrary directory as if it were a newsgroup with the
2441 @code{nneething} backend (@code{gnus-group-enter-directory}).
2442 @xref{Anything Groups}.
2443
2444 @item G f
2445 @kindex G f (Group)
2446 @findex gnus-group-make-doc-group
2447 @cindex ClariNet Briefs
2448 @cindex nndoc
2449 Make a group based on some file or other
2450 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
2451 command, you will be prompted for a file name and a file type.
2452 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
2453 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
2454 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
2455 If you run this command without a prefix, Gnus will guess at the file
2456 type.  @xref{Document Groups}.
2457
2458 @item G u
2459 @kindex G u (Group)
2460 @vindex gnus-useful-groups
2461 @findex gnus-group-make-useful-group
2462 Create one of the groups mentioned in @code{gnus-useful-groups}
2463 (@code{gnus-group-make-useful-group}).
2464
2465 @item G w
2466 @kindex G w (Group)
2467 @findex gnus-group-make-web-group
2468 @cindex DejaNews
2469 @cindex Alta Vista
2470 @cindex InReference
2471 @cindex nnweb
2472 Make an ephemeral group based on a web search
2473 (@code{gnus-group-make-web-group}).  If you give a prefix to this
2474 command, make a solid group instead.  You will be prompted for the
2475 search engine type and the search string.  Valid search engine types
2476 include @code{dejanews}, @code{altavista} and @code{reference}.
2477 @xref{Web Searches}.
2478
2479 If you use the @code{dejanews} search engine, you can limit the search
2480 to a particular group by using a match string like
2481 @samp{~g alt.sysadmin.recovery shaving}.
2482
2483 @item G DEL
2484 @kindex G DEL (Group)
2485 @findex gnus-group-delete-group
2486 This function will delete the current group
2487 (@code{gnus-group-delete-group}).  If given a prefix, this function will
2488 actually delete all the articles in the group, and forcibly remove the
2489 group itself from the face of the Earth.  Use a prefix only if you are
2490 absolutely sure of what you are doing.  This command can't be used on
2491 read-only groups (like @code{nntp} group), though.
2492
2493 @item G V
2494 @kindex G V (Group)
2495 @findex gnus-group-make-empty-virtual
2496 Make a new, fresh, empty @code{nnvirtual} group
2497 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
2498
2499 @item G v
2500 @kindex G v (Group)
2501 @findex gnus-group-add-to-virtual
2502 Add the current group to an @code{nnvirtual} group
2503 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
2504 @end table
2505
2506 @xref{Select Methods}, for more information on the various select
2507 methods.
2508
2509 @vindex gnus-activate-foreign-newsgroups
2510 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2511 gnus will check all foreign groups with this level or lower at startup.
2512 This might take quite a while, especially if you subscribe to lots of
2513 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
2514 @code{gnus-activate-level} also affects activation of foreign
2515 newsgroups.
2516
2517
2518 @node Group Parameters
2519 @section Group Parameters
2520 @cindex group parameters
2521
2522 The group parameters store information local to a particular group.
2523 Here's an example group parameter list:
2524
2525 @example
2526 ((to-address . "ding@@gnus.org")
2527  (auto-expire . t))
2528 @end example
2529
2530 We see that each element consists of a "dotted pair"---the thing before
2531 the dot is the key, while the thing after the dot is the value.  All the
2532 parameters have this form @emph{except} local variable specs, which are
2533 not dotted pairs, but proper lists.
2534
2535 The following group parameters can be used:
2536
2537 @table @code
2538 @item to-address
2539 @cindex to-address
2540 Address used by when doing followups and new posts.
2541
2542 @example
2543 (to-address .  "some@@where.com")
2544 @end example
2545
2546 This is primarily useful in mail groups that represent closed mailing
2547 lists---mailing lists where it's expected that everybody that writes to
2548 the mailing list is subscribed to it.  Since using this parameter
2549 ensures that the mail only goes to the mailing list itself, it means
2550 that members won't receive two copies of your followups.
2551
2552 Using @code{to-address} will actually work whether the group is foreign
2553 or not.  Let's say there's a group on the server that is called
2554 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
2555 the articles from a mail-to-news gateway.  Posting directly to this
2556 group is therefore impossible---you have to send mail to the mailing
2557 list address instead.
2558
2559 @item to-list
2560 @cindex to-list
2561 Address used when doing @kbd{a} in that group.
2562
2563 @example
2564 (to-list . "some@@where.com")
2565 @end example
2566
2567 It is totally ignored
2568 when doing a followup---except that if it is present in a news group,
2569 you'll get mail group semantics when doing @kbd{f}.
2570
2571 If you do an @kbd{a} command in a mail group and you have neither a
2572 @code{to-list} group parameter nor a @code{to-address} group parameter,
2573 then a @code{to-list} group parameter will be added automatically upon
2574 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2575 @vindex gnus-add-to-list
2576
2577 If you do an @kbd{a} command in a mail group and you don't have a
2578 @code{to-list} group parameter, one will be added automatically upon
2579 sending the message.
2580
2581 @item visible
2582 @cindex visible
2583 If the group parameter list has the element @code{(visible . t)},
2584 that group will always be visible in the Group buffer, regardless
2585 of whether it has any unread articles.
2586
2587 @item broken-reply-to
2588 @cindex broken-reply-to
2589 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2590 headers in this group are to be ignored.  This can be useful if you're
2591 reading a mailing list group where the listserv has inserted
2592 @code{Reply-To} headers that point back to the listserv itself.  This is
2593 broken behavior.  So there!
2594
2595 @item to-group
2596 @cindex to-group
2597 Elements like @code{(to-group . "some.group.name")} means that all
2598 posts in that group will be sent to @code{some.group.name}.
2599
2600 @item newsgroup
2601 @cindex newsgroup
2602 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2603 will treat all responses as if they were responses to news articles.
2604 This can be useful if you have a mail group that's really a mirror of a
2605 news group.
2606
2607 @item gcc-self
2608 @cindex gcc-self
2609 If @code{(gcc-self . t)} is present in the group parameter list, newly
2610 composed messages will be @code{Gcc}'d to the current group.  If
2611 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2612 generated, if @code{(gcc-self . "string")} is present, this string will
2613 be inserted literally as a @code{gcc} header.  This parameter takes
2614 precedence over any default @code{Gcc} rules as described later
2615 (@pxref{Archived Messages}).
2616
2617 @item auto-expire
2618 @cindex auto-expire
2619 If the group parameter has an element that looks like @code{(auto-expire
2620 . t)}, all articles read will be marked as expirable.  For an
2621 alternative approach, @pxref{Expiring Mail}.
2622
2623 @item total-expire
2624 @cindex total-expire
2625 If the group parameter has an element that looks like
2626 @code{(total-expire . t)}, all read articles will be put through the
2627 expiry process, even if they are not marked as expirable.  Use with
2628 caution.  Unread, ticked and dormant articles are not eligible for
2629 expiry.
2630
2631 @item expiry-wait
2632 @cindex expiry-wait
2633 @vindex nnmail-expiry-wait-function
2634 If the group parameter has an element that looks like @code{(expiry-wait
2635 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2636 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2637 The value can either be a number of days (not necessarily an integer) or
2638 the symbols @code{never} or @code{immediate}.
2639
2640 @item score-file
2641 @cindex score file group parameter
2642 Elements that look like @code{(score-file . "file")} will make
2643 @file{file} into the current score file for the group in question.  All
2644 interactive score entries will be put into this file.
2645
2646 @item adapt-file
2647 @cindex adapt file group parameter
2648 Elements that look like @code{(adapt-file . "file")} will make
2649 @file{file} into the current adaptive file for the group in question.
2650 All adaptive score entries will be put into this file.
2651
2652 @item admin-address
2653 When unsubscribing from a mailing list you should never send the
2654 unsubscription notice to the mailing list itself.  Instead, you'd send
2655 messages to the administrative address.  This parameter allows you to
2656 put the admin address somewhere convenient.
2657
2658 @item display
2659 Elements that look like @code{(display . MODE)} say which articles to
2660 display on entering the group.  Valid values are:
2661
2662 @table @code
2663 @item all
2664 Display all articles, both read and unread.
2665
2666 @item default
2667 Display the default visible articles, which normally includes unread and
2668 ticked articles.
2669 @end table
2670
2671 @item comment
2672 Elements that look like @code{(comment . "This is a comment")}
2673 are arbitrary comments on the group.  They are currently ignored by
2674 gnus, but provide a place for you to store information on particular
2675 groups.
2676
2677 @item charset
2678 Elements that look like @code{(charset . iso-8859-1)} will make
2679 @code{iso-8859-1} the default charset; that is, the charset that will be
2680 used for all articles that do not specify a charset.
2681
2682 @item (@var{variable} @var{form})
2683 You can use the group parameters to set variables local to the group you
2684 are entering.  If you want to turn threading off in @samp{news.answers},
2685 you could put @code{(gnus-show-threads nil)} in the group parameters of
2686 that group.  @code{gnus-show-threads} will be made into a local variable
2687 in the summary buffer you enter, and the form @code{nil} will be
2688 @code{eval}ed there.
2689
2690 This can also be used as a group-specific hook function, if you'd like.
2691 If you want to hear a beep when you enter a group, you could put
2692 something like @code{(dummy-variable (ding))} in the parameters of that
2693 group.  @code{dummy-variable} will be set to the result of the
2694 @code{(ding)} form, but who cares?
2695
2696 @item posting-style
2697 You can store additional posting style information for this group only
2698 here (@pxref{Posting Styles}).  The format is that of an entry in the
2699 @code{gnus-posting-styles} alist, except that there's no regexp matching
2700 the group name (of course).  Style elements in this group parameter will
2701 take precedence over the ones found in @code{gnus-posting-styles}.
2702
2703 For instance, if you want a funky name and signature in this group only,
2704 instead of hacking @code{gnus-posting-styles}, you could put something
2705 like this in the group parameters:
2706
2707 @example
2708 (posting-style
2709   (name "Funky Name")
2710   (signature "Funky Signature"))
2711 @end example
2712
2713 @end table
2714
2715 Use the @kbd{G p} command to edit group parameters of a group.  You
2716 might also be interested in reading about topic parameters (@pxref{Topic
2717 Parameters}).
2718
2719
2720 @node Listing Groups
2721 @section Listing Groups
2722 @cindex group listing
2723
2724 These commands all list various slices of the groups available.
2725
2726 @table @kbd
2727
2728 @item l
2729 @itemx A s
2730 @kindex A s (Group)
2731 @kindex l (Group)
2732 @findex gnus-group-list-groups
2733 List all groups that have unread articles
2734 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2735 command will list only groups of level ARG and lower.  By default, it
2736 only lists groups of level five (i. e.,
2737 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2738 groups).
2739
2740 @item L
2741 @itemx A u
2742 @kindex A u (Group)
2743 @kindex L (Group)
2744 @findex gnus-group-list-all-groups
2745 List all groups, whether they have unread articles or not
2746 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2747 this command will list only groups of level ARG and lower.  By default,
2748 it lists groups of level seven or lower (i.e., just subscribed and
2749 unsubscribed groups).
2750
2751 @item A l
2752 @kindex A l (Group)
2753 @findex gnus-group-list-level
2754 List all unread groups on a specific level
2755 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2756 with no unread articles.
2757
2758 @item A k
2759 @kindex A k (Group)
2760 @findex gnus-group-list-killed
2761 List all killed groups (@code{gnus-group-list-killed}).  If given a
2762 prefix argument, really list all groups that are available, but aren't
2763 currently (un)subscribed.  This could entail reading the active file
2764 from the server.
2765
2766 @item A z
2767 @kindex A z (Group)
2768 @findex gnus-group-list-zombies
2769 List all zombie groups (@code{gnus-group-list-zombies}).
2770
2771 @item A m
2772 @kindex A m (Group)
2773 @findex gnus-group-list-matching
2774 List all unread, subscribed groups with names that match a regexp
2775 (@code{gnus-group-list-matching}).
2776
2777 @item A M
2778 @kindex A M (Group)
2779 @findex gnus-group-list-all-matching
2780 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2781
2782 @item A A
2783 @kindex A A (Group)
2784 @findex gnus-group-list-active
2785 List absolutely all groups in the active file(s) of the
2786 server(s) you are connected to (@code{gnus-group-list-active}).  This
2787 might very well take quite a while.  It might actually be a better idea
2788 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2789 thing to match on.  Also note that this command may list groups that
2790 don't exist (yet)---these will be listed as if they were killed groups.
2791 Take the output with some grains of salt.
2792
2793 @item A a
2794 @kindex A a (Group)
2795 @findex gnus-group-apropos
2796 List all groups that have names that match a regexp
2797 (@code{gnus-group-apropos}).
2798
2799 @item A d
2800 @kindex A d (Group)
2801 @findex gnus-group-description-apropos
2802 List all groups that have names or descriptions that match a regexp
2803 (@code{gnus-group-description-apropos}).
2804
2805 @item A c
2806 @kindex A c (Group)
2807 @findex gnus-group-list-cached
2808 List all groups with cached articles (@code{gnus-group-list-cached}).
2809
2810 @item A ?
2811 @kindex A ? (Group)
2812 @findex gnus-group-list-dormant
2813 List all groups with dormant articles (@code{gnus-group-list-dormant}).
2814
2815 @item A /
2816 @kindex A / (Group)
2817 @findex gnus-group-list-limit
2818 List groups limited within the current selection
2819 (@code{gnus-group-list-limit}).
2820
2821 @item A f
2822 @kindex A f (Group)
2823 @findex gnus-group-list-flush
2824 Flush groups from the current selection (@code{gnus-group-list-flush}).
2825
2826 @item A p
2827 @kindex A p (Group)
2828 @findex gnus-group-list-plus
2829 List groups plus the current selection (@code{gnus-group-list-plus}).
2830
2831 @end table
2832
2833 @vindex gnus-permanently-visible-groups
2834 @cindex visible group parameter
2835 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2836 always be shown, whether they have unread articles or not.  You can also
2837 add the @code{visible} element to the group parameters in question to
2838 get the same effect.
2839
2840 @vindex gnus-list-groups-with-ticked-articles
2841 Groups that have just ticked articles in it are normally listed in the
2842 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2843 @code{nil}, these groups will be treated just like totally empty
2844 groups.  It is @code{t} by default.
2845
2846
2847 @node Sorting Groups
2848 @section Sorting Groups
2849 @cindex sorting groups
2850
2851 @kindex C-c C-s (Group)
2852 @findex gnus-group-sort-groups
2853 @vindex gnus-group-sort-function
2854 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2855 group buffer according to the function(s) given by the
2856 @code{gnus-group-sort-function} variable.  Available sorting functions
2857 include:
2858
2859 @table @code
2860
2861 @item gnus-group-sort-by-alphabet
2862 @findex gnus-group-sort-by-alphabet
2863 Sort the group names alphabetically.  This is the default.
2864
2865 @item gnus-group-sort-by-real-name
2866 @findex gnus-group-sort-by-real-name
2867 Sort the group alphabetically on the real (unprefixed) group names.
2868
2869 @item gnus-group-sort-by-level
2870 @findex gnus-group-sort-by-level
2871 Sort by group level.
2872
2873 @item gnus-group-sort-by-score
2874 @findex gnus-group-sort-by-score
2875 Sort by group score.  @xref{Group Score}.
2876
2877 @item gnus-group-sort-by-rank
2878 @findex gnus-group-sort-by-rank
2879 Sort by group score and then the group level.  The level and the score
2880 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
2881
2882 @item gnus-group-sort-by-unread
2883 @findex gnus-group-sort-by-unread
2884 Sort by number of unread articles.
2885
2886 @item gnus-group-sort-by-method
2887 @findex gnus-group-sort-by-method
2888 Sort alphabetically on the select method.
2889
2890
2891 @end table
2892
2893 @code{gnus-group-sort-function} can also be a list of sorting
2894 functions.  In that case, the most significant sort key function must be
2895 the last one.
2896
2897
2898 There are also a number of commands for sorting directly according to
2899 some sorting criteria:
2900
2901 @table @kbd
2902 @item G S a
2903 @kindex G S a (Group)
2904 @findex gnus-group-sort-groups-by-alphabet
2905 Sort the group buffer alphabetically by group name
2906 (@code{gnus-group-sort-groups-by-alphabet}).
2907
2908 @item G S u
2909 @kindex G S u (Group)
2910 @findex gnus-group-sort-groups-by-unread
2911 Sort the group buffer by the number of unread articles
2912 (@code{gnus-group-sort-groups-by-unread}).
2913
2914 @item G S l
2915 @kindex G S l (Group)
2916 @findex gnus-group-sort-groups-by-level
2917 Sort the group buffer by group level
2918 (@code{gnus-group-sort-groups-by-level}).
2919
2920 @item G S v
2921 @kindex G S v (Group)
2922 @findex gnus-group-sort-groups-by-score
2923 Sort the group buffer by group score
2924 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2925
2926 @item G S r
2927 @kindex G S r (Group)
2928 @findex gnus-group-sort-groups-by-rank
2929 Sort the group buffer by group rank
2930 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2931
2932 @item G S m
2933 @kindex G S m (Group)
2934 @findex gnus-group-sort-groups-by-method
2935 Sort the group buffer alphabetically by backend name
2936 (@code{gnus-group-sort-groups-by-method}).
2937
2938 @end table
2939
2940 All the commands below obey the process/prefix convention
2941 (@pxref{Process/Prefix}).
2942
2943 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2944 commands will sort in reverse order.
2945
2946 You can also sort a subset of the groups:
2947
2948 @table @kbd
2949 @item G P a
2950 @kindex G P a (Group)
2951 @findex gnus-group-sort-selected-groups-by-alphabet
2952 Sort the groups alphabetically by group name
2953 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2954
2955 @item G P u
2956 @kindex G P u (Group)
2957 @findex gnus-group-sort-selected-groups-by-unread
2958 Sort the groups by the number of unread articles
2959 (@code{gnus-group-sort-selected-groups-by-unread}).
2960
2961 @item G P l
2962 @kindex G P l (Group)
2963 @findex gnus-group-sort-selected-groups-by-level
2964 Sort the groups by group level
2965 (@code{gnus-group-sort-selected-groups-by-level}).
2966
2967 @item G P v
2968 @kindex G P v (Group)
2969 @findex gnus-group-sort-selected-groups-by-score
2970 Sort the groups by group score
2971 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2972
2973 @item G P r
2974 @kindex G P r (Group)
2975 @findex gnus-group-sort-selected-groups-by-rank
2976 Sort the groups by group rank
2977 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2978
2979 @item G P m
2980 @kindex G P m (Group)
2981 @findex gnus-group-sort-selected-groups-by-method
2982 Sort the groups alphabetically by backend name
2983 (@code{gnus-group-sort-selected-groups-by-method}).
2984
2985 @end table
2986
2987
2988
2989 @node Group Maintenance
2990 @section Group Maintenance
2991 @cindex bogus groups
2992
2993 @table @kbd
2994 @item b
2995 @kindex b (Group)
2996 @findex gnus-group-check-bogus-groups
2997 Find bogus groups and delete them
2998 (@code{gnus-group-check-bogus-groups}).
2999
3000 @item F
3001 @kindex F (Group)
3002 @findex gnus-group-find-new-groups
3003 Find new groups and process them (@code{gnus-group-find-new-groups}).
3004 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3005 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
3006 to query the server for new groups, and subscribe the new groups as
3007 zombies.
3008
3009 @item C-c C-x
3010 @kindex C-c C-x (Group)
3011 @findex gnus-group-expire-articles
3012 Run all expirable articles in the current group through the expiry
3013 process (if any) (@code{gnus-group-expire-articles}).
3014
3015 @item C-c M-C-x
3016 @kindex C-c M-C-x (Group)
3017 @findex gnus-group-expire-all-groups
3018 Run all articles in all groups through the expiry process
3019 (@code{gnus-group-expire-all-groups}).
3020
3021 @end table
3022
3023
3024 @node Browse Foreign Server
3025 @section Browse Foreign Server
3026 @cindex foreign servers
3027 @cindex browsing servers
3028
3029 @table @kbd
3030 @item B
3031 @kindex B (Group)
3032 @findex gnus-group-browse-foreign-server
3033 You will be queried for a select method and a server name.  Gnus will
3034 then attempt to contact this server and let you browse the groups there
3035 (@code{gnus-group-browse-foreign-server}).
3036 @end table
3037
3038 @findex gnus-browse-mode
3039 A new buffer with a list of available groups will appear.  This buffer
3040 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
3041 a lot) like a normal group buffer.
3042
3043 Here's a list of keystrokes available in the browse mode:
3044
3045 @table @kbd
3046 @item n
3047 @kindex n (Browse)
3048 @findex gnus-group-next-group
3049 Go to the next group (@code{gnus-group-next-group}).
3050
3051 @item p
3052 @kindex p (Browse)
3053 @findex gnus-group-prev-group
3054 Go to the previous group (@code{gnus-group-prev-group}).
3055
3056 @item SPACE
3057 @kindex SPACE (Browse)
3058 @findex gnus-browse-read-group
3059 Enter the current group and display the first article
3060 (@code{gnus-browse-read-group}).
3061
3062 @item RET
3063 @kindex RET (Browse)
3064 @findex gnus-browse-select-group
3065 Enter the current group (@code{gnus-browse-select-group}).
3066
3067 @item u
3068 @kindex u (Browse)
3069 @findex gnus-browse-unsubscribe-current-group
3070 Unsubscribe to the current group, or, as will be the case here,
3071 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3072
3073 @item l
3074 @itemx q
3075 @kindex q (Browse)
3076 @kindex l (Browse)
3077 @findex gnus-browse-exit
3078 Exit browse mode (@code{gnus-browse-exit}).
3079
3080 @item ?
3081 @kindex ? (Browse)
3082 @findex gnus-browse-describe-briefly
3083 Describe browse mode briefly (well, there's not much to describe, is
3084 there) (@code{gnus-browse-describe-briefly}).
3085 @end table
3086
3087
3088 @node Exiting Gnus
3089 @section Exiting gnus
3090 @cindex exiting gnus
3091
3092 Yes, gnus is ex(c)iting.
3093
3094 @table @kbd
3095 @item z
3096 @kindex z (Group)
3097 @findex gnus-group-suspend
3098 Suspend gnus (@code{gnus-group-suspend}).  This doesn't really exit gnus,
3099 but it kills all buffers except the Group buffer.  I'm not sure why this
3100 is a gain, but then who am I to judge?
3101
3102 @item q
3103 @kindex q (Group)
3104 @findex gnus-group-exit
3105 @c @icon{gnus-group-exit}
3106 Quit gnus (@code{gnus-group-exit}).
3107
3108 @item Q
3109 @kindex Q (Group)
3110 @findex gnus-group-quit
3111 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3112 The dribble file will be saved, though (@pxref{Auto Save}).
3113 @end table
3114
3115 @vindex gnus-exit-gnus-hook
3116 @vindex gnus-suspend-gnus-hook
3117 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
3118 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
3119 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3120 exiting gnus.
3121
3122 @findex gnus-unload
3123 @cindex unloading
3124 If you wish to completely unload gnus and all its adherents, you can use
3125 the @code{gnus-unload} command.  This command is also very handy when
3126 trying to customize meta-variables.
3127
3128 Note:
3129
3130 @quotation
3131 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3132 numbly heavy and herself fall into a hazy trance as the boy sitting
3133 behind her drew repeated lines with his pencil across the back of her
3134 plastic chair.
3135 @end quotation
3136
3137
3138 @node Group Topics
3139 @section Group Topics
3140 @cindex topics
3141
3142 If you read lots and lots of groups, it might be convenient to group
3143 them hierarchically according to topics.  You put your Emacs groups over
3144 here, your sex groups over there, and the rest (what, two groups or so?)
3145 you put in some misc section that you never bother with anyway.  You can
3146 even group the Emacs sex groups as a sub-topic to either the Emacs
3147 groups or the sex groups---or both!  Go wild!
3148
3149 @iftex
3150 @iflatex
3151 \gnusfigure{Group Topics}{400}{
3152 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
3153 }
3154 @end iflatex
3155 @end iftex
3156
3157 Here's an example:
3158
3159 @example
3160 Gnus
3161   Emacs -- I wuw it!
3162      3: comp.emacs
3163      2: alt.religion.emacs
3164     Naughty Emacs
3165      452: alt.sex.emacs
3166        0: comp.talk.emacs.recovery
3167   Misc
3168      8: comp.binaries.fractals
3169     13: comp.sources.unix
3170 @end example
3171
3172 @findex gnus-topic-mode
3173 @kindex t (Group)
3174 To get this @emph{fab} functionality you simply turn on (ooh!) the
3175 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
3176 is a toggling command.)
3177
3178 Go ahead, just try it.  I'll still be here when you get back.  La de
3179 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
3180 press @kbd{l}.  There.  All your groups are now listed under
3181 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
3182 bothered?
3183
3184 If you want this permanently enabled, you should add that minor mode to
3185 the hook for the group mode:
3186
3187 @lisp
3188 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3189 @end lisp
3190
3191 @menu
3192 * Topic Variables::    How to customize the topics the Lisp Way.
3193 * Topic Commands::     Interactive E-Z commands.
3194 * Topic Sorting::      Sorting each topic individually.
3195 * Topic Topology::     A map of the world.
3196 * Topic Parameters::   Parameters that apply to all groups in a topic.
3197 @end menu
3198
3199
3200 @node Topic Variables
3201 @subsection Topic Variables
3202 @cindex topic variables
3203
3204 Now, if you select a topic, it will fold/unfold that topic, which is
3205 really neat, I think.
3206
3207 @vindex gnus-topic-line-format
3208 The topic lines themselves are created according to the
3209 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3210 Valid elements are:
3211
3212 @table @samp
3213 @item i
3214 Indentation.
3215 @item n
3216 Topic name.
3217 @item v
3218 Visibility.
3219 @item l
3220 Level.
3221 @item g
3222 Number of groups in the topic.
3223 @item a
3224 Number of unread articles in the topic.
3225 @item A
3226 Number of unread articles in the topic and all its subtopics.
3227 @end table
3228
3229 @vindex gnus-topic-indent-level
3230 Each sub-topic (and the groups in the sub-topics) will be indented with
3231 @code{gnus-topic-indent-level} times the topic level number of spaces.
3232 The default is 2.
3233
3234 @vindex gnus-topic-mode-hook
3235 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3236
3237 @vindex gnus-topic-display-empty-topics
3238 The @code{gnus-topic-display-empty-topics} says whether to display even
3239 topics that have no unread articles in them.  The default is @code{t}.
3240
3241
3242 @node Topic Commands
3243 @subsection Topic Commands
3244 @cindex topic commands
3245
3246 When the topic minor mode is turned on, a new @kbd{T} submap will be
3247 available.  In addition, a few of the standard keys change their
3248 definitions slightly.
3249
3250 @table @kbd
3251
3252 @item T n
3253 @kindex T n (Topic)
3254 @findex gnus-topic-create-topic
3255 Prompt for a new topic name and create it
3256 (@code{gnus-topic-create-topic}).
3257
3258 @item T m
3259 @kindex T m (Topic)
3260 @findex gnus-topic-move-group
3261 Move the current group to some other topic
3262 (@code{gnus-topic-move-group}).  This command uses the process/prefix
3263 convention (@pxref{Process/Prefix}).
3264
3265 @item T j
3266 @kindex T j (Topic)
3267 @findex gnus-topic-jump-to-topic
3268 Go to a topic (@code{gnus-topic-jump-to-topic}).
3269
3270 @item T c
3271 @kindex T c (Topic)
3272 @findex gnus-topic-copy-group
3273 Copy the current group to some other topic
3274 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
3275 convention (@pxref{Process/Prefix}).
3276
3277 @item T h
3278 @kindex T h (Topic)
3279 @findex gnus-topic-hide-topic
3280 Hide the current topic (@code{gnus-topic-hide-topic}).  If given
3281 a prefix, hide the topic permanently.
3282
3283 @item T s
3284 @kindex T s (Topic)
3285 @findex gnus-topic-show-topic
3286 Show the current topic (@code{gnus-topic-show-topic}).  If given
3287 a prefix, show the topic permanently.
3288
3289 @item T D
3290 @kindex T D (Topic)
3291 @findex gnus-topic-remove-group
3292 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3293 This command is mainly useful if you have the same group in several
3294 topics and wish to remove it from one of the topics.  You may also
3295 remove a group from all topics, but in that case, Gnus will add it to
3296 the root topic the next time you start Gnus.  In fact, all new groups
3297 (which, naturally, don't belong to any topic) will show up in the root
3298 topic.
3299
3300 This command uses the process/prefix convention
3301 (@pxref{Process/Prefix}).
3302
3303 @item T M
3304 @kindex T M (Topic)
3305 @findex gnus-topic-move-matching
3306 Move all groups that match some regular expression to a topic
3307 (@code{gnus-topic-move-matching}).
3308
3309 @item T C
3310 @kindex T C (Topic)
3311 @findex gnus-topic-copy-matching
3312 Copy all groups that match some regular expression to a topic
3313 (@code{gnus-topic-copy-matching}).
3314
3315 @item T H
3316 @kindex T H (Topic)
3317 @findex gnus-topic-toggle-display-empty-topics
3318 Toggle hiding empty topics
3319 (@code{gnus-topic-toggle-display-empty-topics}).
3320
3321 @item T #
3322 @kindex T # (Topic)
3323 @findex gnus-topic-mark-topic
3324 Mark all groups in the current topic with the process mark
3325 (@code{gnus-topic-mark-topic}).
3326
3327 @item T M-#
3328 @kindex T M-# (Topic)
3329 @findex gnus-topic-unmark-topic
3330 Remove the process mark from all groups in the current topic
3331 (@code{gnus-topic-unmark-topic}).
3332
3333 @item T TAB
3334 @itemx TAB
3335 @kindex T TAB (Topic)
3336 @kindex TAB (Topic)
3337 @findex gnus-topic-indent
3338 ``Indent'' the current topic so that it becomes a sub-topic of the
3339 previous topic (@code{gnus-topic-indent}).  If given a prefix,
3340 ``un-indent'' the topic instead.
3341
3342 @item M-TAB
3343 @kindex M-TAB (Topic)
3344 @findex gnus-topic-unindent
3345 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3346 parent of its current parent (@code{gnus-topic-unindent}).
3347
3348 @item RET
3349 @kindex RET (Topic)
3350 @findex gnus-topic-select-group
3351 @itemx SPACE
3352 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3353 When you perform this command on a group, you'll enter the group, as
3354 usual.  When done on a topic line, the topic will be folded (if it was
3355 visible) or unfolded (if it was folded already).  So it's basically a
3356 toggling command on topics.  In addition, if you give a numerical
3357 prefix, group on that level (and lower) will be displayed.
3358
3359 @item C-c C-x
3360 @kindex C-c C-x (Topic)
3361 @findex gnus-topic-expire-articles
3362 Run all expirable articles in the current group or topic through the expiry
3363 process (if any) (@code{gnus-topic-expire-articles}).
3364
3365 @item C-k
3366 @kindex C-k (Topic)
3367 @findex gnus-topic-kill-group
3368 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
3369 topic will be removed along with the topic.
3370
3371 @item C-y
3372 @kindex C-y (Topic)
3373 @findex gnus-topic-yank-group
3374 Yank the previously killed group or topic
3375 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
3376 before all groups.
3377
3378 @item T r
3379 @kindex T r (Topic)
3380 @findex gnus-topic-rename
3381 Rename a topic (@code{gnus-topic-rename}).
3382
3383 @item T DEL
3384 @kindex T DEL (Topic)
3385 @findex gnus-topic-delete
3386 Delete an empty topic (@code{gnus-topic-delete}).
3387
3388 @item A T
3389 @kindex A T (Topic)
3390 @findex gnus-topic-list-active
3391 List all groups that gnus knows about in a topics-ified way
3392 (@code{gnus-topic-list-active}).
3393
3394 @item G p
3395 @kindex G p (Topic)
3396 @findex gnus-topic-edit-parameters
3397 @cindex group parameters
3398 @cindex topic parameters
3399 @cindex parameters
3400 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3401 @xref{Topic Parameters}.
3402
3403 @end table
3404
3405
3406 @node Topic Sorting
3407 @subsection Topic Sorting
3408 @cindex topic sorting
3409
3410 You can sort the groups in each topic individually with the following
3411 commands:
3412
3413
3414 @table @kbd
3415 @item T S a
3416 @kindex T S a (Topic)
3417 @findex gnus-topic-sort-groups-by-alphabet
3418 Sort the current topic alphabetically by group name
3419 (@code{gnus-topic-sort-groups-by-alphabet}).
3420
3421 @item T S u
3422 @kindex T S u (Topic)
3423 @findex gnus-topic-sort-groups-by-unread
3424 Sort the current topic by the number of unread articles
3425 (@code{gnus-topic-sort-groups-by-unread}).
3426
3427 @item T S l
3428 @kindex T S l (Topic)
3429 @findex gnus-topic-sort-groups-by-level
3430 Sort the current topic by group level
3431 (@code{gnus-topic-sort-groups-by-level}).
3432
3433 @item T S v
3434 @kindex T S v (Topic)
3435 @findex gnus-topic-sort-groups-by-score
3436 Sort the current topic by group score
3437 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
3438
3439 @item T S r
3440 @kindex T S r (Topic)
3441 @findex gnus-topic-sort-groups-by-rank
3442 Sort the current topic by group rank
3443 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
3444
3445 @item T S m
3446 @kindex T S m (Topic)
3447 @findex gnus-topic-sort-groups-by-method
3448 Sort the current topic alphabetically by backend name
3449 (@code{gnus-topic-sort-groups-by-method}).
3450
3451 @end table
3452
3453 @xref{Sorting Groups}, for more information about group sorting.
3454
3455
3456 @node Topic Topology
3457 @subsection Topic Topology
3458 @cindex topic topology
3459 @cindex topology
3460
3461 So, let's have a look at an example group buffer:
3462
3463 @example
3464 Gnus
3465   Emacs -- I wuw it!
3466      3: comp.emacs
3467      2: alt.religion.emacs
3468     Naughty Emacs
3469      452: alt.sex.emacs
3470        0: comp.talk.emacs.recovery
3471   Misc
3472      8: comp.binaries.fractals
3473     13: comp.sources.unix
3474 @end example
3475
3476 So, here we have one top-level topic (@samp{Gnus}), two topics under
3477 that, and one sub-topic under one of the sub-topics.  (There is always
3478 just one (1) top-level topic).  This topology can be expressed as
3479 follows:
3480
3481 @lisp
3482 (("Gnus" visible)
3483  (("Emacs -- I wuw it!" visible)
3484   (("Naughty Emacs" visible)))
3485  (("Misc" visible)))
3486 @end lisp
3487
3488 @vindex gnus-topic-topology
3489 This is in fact how the variable @code{gnus-topic-topology} would look
3490 for the display above.  That variable is saved in the @file{.newsrc.eld}
3491 file, and shouldn't be messed with manually---unless you really want
3492 to.  Since this variable is read from the @file{.newsrc.eld} file,
3493 setting it in any other startup files will have no effect.
3494
3495 This topology shows what topics are sub-topics of what topics (right),
3496 and which topics are visible.  Two settings are currently
3497 allowed---@code{visible} and @code{invisible}.
3498
3499
3500 @node Topic Parameters
3501 @subsection Topic Parameters
3502 @cindex topic parameters
3503
3504 All groups in a topic will inherit group parameters from the parent (and
3505 ancestor) topic parameters.  All valid group parameters are valid topic
3506 parameters (@pxref{Group Parameters}).
3507
3508 In addition, the following parameters are only valid as topic
3509 parameters:
3510
3511 @table @code
3512 @item subscribe
3513 When subscribing new groups by topic (@pxref{Subscription Methods}), the 
3514 @code{subscribe} topic parameter says what groups go in what topic.  Its 
3515 value should be a regexp to match the groups that should go in that
3516 topic. 
3517
3518 @end table
3519
3520 Group parameters (of course) override topic parameters, and topic
3521 parameters in sub-topics override topic parameters in super-topics.  You
3522 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
3523 verb, although you may feel free to disagree with me here.)
3524
3525 @example
3526 Gnus
3527   Emacs
3528      3: comp.emacs
3529      2: alt.religion.emacs
3530    452: alt.sex.emacs
3531     Relief
3532      452: alt.sex.emacs
3533        0: comp.talk.emacs.recovery
3534   Misc
3535      8: comp.binaries.fractals
3536     13: comp.sources.unix
3537    452: alt.sex.emacs
3538 @end example
3539
3540 The @samp{Emacs} topic has the topic parameter @code{(score-file
3541 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
3542 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
3543 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
3544 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
3545 . "religion.SCORE")}.
3546
3547 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
3548 will get the @file{relief.SCORE} home score file.  If you enter the same
3549 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
3550 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
3551 get the @file{religion.SCORE} home score file.
3552
3553 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
3554 there are some problems, especially with the @code{total-expiry}
3555 parameter.  Say you have a mail group in two topics; one with
3556 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
3557 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
3558 of these topics you mean to expire articles from, so anything may
3559 happen.  In fact, I hereby declare that it is @dfn{undefined} what
3560 happens.  You just have to be careful if you do stuff like that.
3561
3562
3563 @node Misc Group Stuff
3564 @section Misc Group Stuff
3565
3566 @menu
3567 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
3568 * Group Information::     Information and help on groups and gnus.
3569 * Group Timestamp::       Making gnus keep track of when you last read a group.
3570 * File Commands::         Reading and writing the gnus files.
3571 @end menu
3572
3573 @table @kbd
3574
3575 @item ^
3576 @kindex ^ (Group)
3577 @findex gnus-group-enter-server-mode
3578 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3579 @xref{The Server Buffer}.
3580
3581 @item a
3582 @kindex a (Group)
3583 @findex gnus-group-post-news
3584 Post an article to a group (@code{gnus-group-post-news}).  If given a
3585 prefix, the current group name will be used as the default.
3586
3587 @item m
3588 @kindex m (Group)
3589 @findex gnus-group-mail
3590 Mail a message somewhere (@code{gnus-group-mail}).
3591
3592 @end table
3593
3594 Variables for the group buffer:
3595
3596 @table @code
3597
3598 @item gnus-group-mode-hook
3599 @vindex gnus-group-mode-hook
3600 is called after the group buffer has been
3601 created.
3602
3603 @item gnus-group-prepare-hook
3604 @vindex gnus-group-prepare-hook
3605 is called after the group buffer is
3606 generated.  It may be used to modify the buffer in some strange,
3607 unnatural way.
3608
3609 @item gnus-group-prepared-hook
3610 @vindex gnus-group-prepare-hook
3611 is called as the very last thing after the group buffer has been
3612 generated.  It may be used to move point around, for instance.
3613
3614 @item gnus-permanently-visible-groups
3615 @vindex gnus-permanently-visible-groups
3616 Groups matching this regexp will always be listed in the group buffer,
3617 whether they are empty or not.
3618
3619 @item gnus-group-name-charset-method-alist
3620 @vindex gnus-group-name-charset-method-alist
3621 An alist of method and the charset for group names. It is used to show
3622 non-ASCII group names.
3623
3624 For example:
3625 @lisp
3626 (setq gnus-group-name-charset-method-alist
3627     '(((nntp "news.com.cn") . cn-gb-2312)))
3628 @end lisp
3629
3630 @item gnus-group-name-charset-group-alist
3631 @vindex gnus-group-name-charset-group-alist
3632 An alist of regexp of group name and the charset for group names. 
3633 It is used to show non-ASCII group names.
3634
3635 For example:
3636 @lisp
3637 (setq gnus-group-name-charset-group-alist
3638     '(("\\.com\\.cn:" . cn-gb-2312)))
3639 @end lisp
3640
3641 @end table
3642
3643 @node Scanning New Messages
3644 @subsection Scanning New Messages
3645 @cindex new messages
3646 @cindex scanning new news
3647
3648 @table @kbd
3649
3650 @item g
3651 @kindex g (Group)
3652 @findex gnus-group-get-new-news
3653 @c @icon{gnus-group-get-new-news}
3654 Check the server(s) for new articles.  If the numerical prefix is used,
3655 this command will check only groups of level @var{arg} and lower
3656 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
3657 command will force a total re-reading of the active file(s) from the
3658 backend(s).
3659
3660 @item M-g
3661 @kindex M-g (Group)
3662 @findex gnus-group-get-new-news-this-group
3663 @vindex gnus-goto-next-group-when-activating
3664 @c @icon{gnus-group-get-new-news-this-group}
3665 Check whether new articles have arrived in the current group
3666 (@code{gnus-group-get-new-news-this-group}).
3667 @code{gnus-goto-next-group-when-activating} says whether this command is
3668 to move point to the next group or not.  It is @code{t} by default.
3669
3670 @findex gnus-activate-all-groups
3671 @cindex activating groups
3672 @item C-c M-g
3673 @kindex C-c M-g (Group)
3674 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3675
3676 @item R
3677 @kindex R (Group)
3678 @cindex restarting
3679 @findex gnus-group-restart
3680 Restart gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
3681 file(s), closes the connection to all servers, clears up all run-time
3682 gnus variables, and then starts gnus all over again.
3683
3684 @end table
3685
3686 @vindex gnus-get-new-news-hook
3687 @code{gnus-get-new-news-hook} is run just before checking for new news.
3688
3689 @vindex gnus-after-getting-new-news-hook
3690 @code{gnus-after-getting-new-news-hook} is run after checking for new
3691 news.
3692
3693
3694 @node Group Information
3695 @subsection Group Information
3696 @cindex group information
3697 @cindex information on groups
3698
3699 @table @kbd
3700
3701
3702 @item H f
3703 @kindex H f (Group)
3704 @findex gnus-group-fetch-faq
3705 @vindex gnus-group-faq-directory
3706 @cindex FAQ
3707 @cindex ange-ftp
3708 Try to fetch the FAQ for the current group
3709 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
3710 @code{gnus-group-faq-directory}, which is usually a directory on a
3711 remote machine.  This variable can also be a list of directories.  In
3712 that case, giving a prefix to this command will allow you to choose
3713 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
3714 for fetching the file.
3715
3716 If fetching from the first site is unsuccessful, gnus will attempt to go
3717 through @code{gnus-group-faq-directory} and try to open them one by one.
3718
3719 @item H d
3720 @itemx C-c C-d
3721 @c @icon{gnus-group-describe-group}
3722 @kindex H d (Group)
3723 @kindex C-c C-d (Group)
3724 @cindex describing groups
3725 @cindex group description
3726 @findex gnus-group-describe-group
3727 Describe the current group (@code{gnus-group-describe-group}).  If given
3728 a prefix, force Gnus to re-read the description from the server.
3729
3730 @item M-d
3731 @kindex M-d (Group)
3732 @findex gnus-group-describe-all-groups
3733 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
3734 prefix, force gnus to re-read the description file from the server.
3735
3736 @item H v
3737 @itemx V
3738 @kindex V (Group)
3739 @kindex H v (Group)
3740 @cindex version
3741 @findex gnus-version
3742 Display current gnus version numbers (@code{gnus-version}).
3743
3744 @item ?
3745 @kindex ? (Group)
3746 @findex gnus-group-describe-briefly
3747 Give a very short help message (@code{gnus-group-describe-briefly}).
3748
3749 @item C-c C-i
3750 @kindex C-c C-i (Group)
3751 @cindex info
3752 @cindex manual
3753 @findex gnus-info-find-node
3754 Go to the gnus info node (@code{gnus-info-find-node}).
3755 @end table
3756
3757
3758 @node Group Timestamp
3759 @subsection Group Timestamp
3760 @cindex timestamps
3761 @cindex group timestamps
3762
3763 It can be convenient to let gnus keep track of when you last read a
3764 group.  To set the ball rolling, you should add
3765 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3766
3767 @lisp
3768 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3769 @end lisp
3770
3771 After doing this, each time you enter a group, it'll be recorded.
3772
3773 This information can be displayed in various ways---the easiest is to
3774 use the @samp{%d} spec in the group line format:
3775
3776 @lisp
3777 (setq gnus-group-line-format
3778       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3779 @end lisp
3780
3781 This will result in lines looking like:
3782
3783 @example
3784 *        0: mail.ding                                19961002T012943
3785          0: custom                                   19961002T012713
3786 @end example
3787
3788 As you can see, the date is displayed in compact ISO 8601 format.  This
3789 may be a bit too much, so to just display the date, you could say
3790 something like:
3791
3792 @lisp
3793 (setq gnus-group-line-format
3794       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3795 @end lisp
3796
3797
3798 @node File Commands
3799 @subsection File Commands
3800 @cindex file commands
3801
3802 @table @kbd
3803
3804 @item r
3805 @kindex r (Group)
3806 @findex gnus-group-read-init-file
3807 @vindex gnus-init-file
3808 @cindex reading init file
3809 Re-read the init file (@code{gnus-init-file}, which defaults to
3810 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3811
3812 @item s
3813 @kindex s (Group)
3814 @findex gnus-group-save-newsrc
3815 @cindex saving .newsrc
3816 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3817 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3818 file(s) whether Gnus thinks it is necessary or not.
3819
3820 @c @item Z
3821 @c @kindex Z (Group)
3822 @c @findex gnus-group-clear-dribble
3823 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3824
3825 @end table
3826
3827
3828 @node The Summary Buffer
3829 @chapter The Summary Buffer
3830 @cindex summary buffer
3831
3832 A line for each article is displayed in the summary buffer.  You can
3833 move around, read articles, post articles and reply to articles.
3834
3835 The most common way to a summary buffer is to select a group from the
3836 group buffer (@pxref{Selecting a Group}).
3837
3838 You can have as many summary buffers open as you wish.
3839
3840 @menu
3841 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3842 * Summary Maneuvering::         Moving around the summary buffer.
3843 * Choosing Articles::           Reading articles.
3844 * Paging the Article::          Scrolling the current article.
3845 * Reply Followup and Post::     Posting articles.
3846 * Marking Articles::            Marking articles as read, expirable, etc.
3847 * Limiting::                    You can limit the summary buffer.
3848 * Threading::                   How threads are made.
3849 * Sorting::                     How articles and threads are sorted.
3850 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3851 * Article Caching::             You may store articles in a cache.
3852 * Persistent Articles::         Making articles expiry-resistant.
3853 * Article Backlog::             Having already read articles hang around.
3854 * Saving Articles::             Ways of customizing article saving.
3855 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3856 * Article Treatment::           The article buffer can be mangled at will.
3857 * MIME Commands::               Doing MIMEy things with the articles.
3858 * Charsets::                    Character set issues.
3859 * Article Commands::            Doing various things with the article buffer.
3860 * Summary Sorting::             Sorting the summary buffer in various ways.
3861 * Finding the Parent::          No child support? Get the parent.
3862 * Alternative Approaches::      Reading using non-default summaries.
3863 * Tree Display::                A more visual display of threads.
3864 * Mail Group Commands::         Some commands can only be used in mail groups.
3865 * Various Summary Stuff::       What didn't fit anywhere else.
3866 * Exiting the Summary Buffer::  Returning to the Group buffer.
3867 * Crosspost Handling::          How crossposted articles are dealt with.
3868 * Duplicate Suppression::       An alternative when crosspost handling fails.
3869 * Security::                    Decrypt and Verify.
3870 @end menu
3871
3872
3873 @node Summary Buffer Format
3874 @section Summary Buffer Format
3875 @cindex summary buffer format
3876
3877 @iftex
3878 @iflatex
3879 \gnusfigure{The Summary Buffer}{180}{
3880 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3881 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3882 }
3883 @end iflatex
3884 @end iftex
3885
3886 @menu
3887 * Summary Buffer Lines::     You can specify how summary lines should look.
3888 * To From Newsgroups::       How to not display your own name.
3889 * Summary Buffer Mode Line:: You can say how the mode line should look.
3890 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3891 @end menu
3892
3893 @findex mail-extract-address-components
3894 @findex gnus-extract-address-components
3895 @vindex gnus-extract-address-components
3896 Gnus will use the value of the @code{gnus-extract-address-components}
3897 variable as a function for getting the name and address parts of a
3898 @code{From} header.  Three pre-defined functions exist:
3899 @code{gnus-extract-address-components}, which is the default, quite
3900 fast, and too simplistic solution;
3901 @code{mail-extract-address-components}, which works nicely, but is
3902 slower; and @code{std11-extract-address-components}, which works very
3903 nicely, but is slower.  The default function will return the wrong
3904 answer in 5% of the cases.  If this is unacceptable to you, use the
3905 other function instead:
3906
3907 @lisp
3908 (setq gnus-extract-address-components
3909       'mail-extract-address-components)
3910 @end lisp
3911
3912 @vindex gnus-summary-same-subject
3913 @code{gnus-summary-same-subject} is a string indicating that the current
3914 article has the same subject as the previous.  This string will be used
3915 with those specs that require it.  The default is @code{""}.
3916
3917
3918 @node Summary Buffer Lines
3919 @subsection Summary Buffer Lines
3920
3921 @vindex gnus-summary-line-format
3922 You can change the format of the lines in the summary buffer by changing
3923 the @code{gnus-summary-line-format} variable.  It works along the same
3924 lines as a normal @code{format} string, with some extensions
3925 (@pxref{Formatting Variables}).
3926
3927 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3928
3929 The following format specification characters are understood:
3930
3931 @table @samp
3932 @item N
3933 Article number.
3934 @item S
3935 Subject string.  List identifiers stripped,
3936 @code{gnus-list-identifies}.  @xref{Article Hiding}.
3937 @item s
3938 Subject if the article is the root of the thread or the previous article
3939 had a different subject, @code{gnus-summary-same-subject} otherwise.
3940 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3941 @item F
3942 Full @code{From} header.
3943 @item n
3944 The name (from the @code{From} header).
3945 @item f
3946 The name, code @code{To} header or the @code{Newsgroups} header
3947 (@pxref{To From Newsgroups}).
3948 @item a
3949 The name (from the @code{From} header).  This differs from the @code{n}
3950 spec in that it uses the function designated by the
3951 @code{gnus-extract-address-components} variable, which is slower, but
3952 may be more thorough.
3953 @item A
3954 The address (from the @code{From} header).  This works the same way as
3955 the @code{a} spec.
3956 @item L
3957 Number of lines in the article.
3958 @item c
3959 Number of characters in the article. This specifier is not supported in some
3960 methods (like nnfolder).
3961 @item I
3962 Indentation based on thread level (@pxref{Customizing Threading}).
3963 @item T
3964 Nothing if the article is a root and lots of spaces if it isn't (it
3965 pushes everything after it off the screen).
3966 @item [
3967 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3968 for adopted articles (@pxref{Customizing Threading}).
3969 @item ]
3970 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3971 for adopted articles.
3972 @item >
3973 One space for each thread level.
3974 @item <
3975 Twenty minus thread level spaces.
3976 @item U
3977 Unread.
3978
3979 @item R
3980 This misleadingly named specifier is the @dfn{secondary mark}.  This
3981 mark will say whether the article has been replied to, has been cached,
3982 or has been saved.
3983
3984 @item i
3985 Score as a number (@pxref{Scoring}).
3986 @item z
3987 @vindex gnus-summary-zcore-fuzz
3988 Zcore, @samp{+} if above the default level and @samp{-} if below the
3989 default level.  If the difference between
3990 @code{gnus-summary-default-score} and the score is less than
3991 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3992 @item V
3993 Total thread score.
3994 @item x
3995 @code{Xref}.
3996 @item D
3997 @code{Date}.
3998 @item d
3999 The @code{Date} in @code{DD-MMM} format.
4000 @item o
4001 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4002 @item M
4003 @code{Message-ID}.
4004 @item r
4005 @code{References}.
4006 @item t
4007 Number of articles in the current sub-thread.  Using this spec will slow
4008 down summary buffer generation somewhat.
4009 @item e
4010 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4011 article has any children.
4012 @item P
4013 The line number.
4014 @item O
4015 Download mark.
4016 @item u
4017 User defined specifier.  The next character in the format string should
4018 be a letter.  Gnus will call the function
4019 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
4020 following @samp{%u}.  The function will be passed the current header as
4021 argument.  The function should return a string, which will be inserted
4022 into the summary just like information from any other summary specifier.
4023 @end table
4024
4025 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4026 have to be handled with care.  For reasons of efficiency, gnus will
4027 compute what column these characters will end up in, and ``hard-code''
4028 that.  This means that it is invalid to have these specs after a
4029 variable-length spec.  Well, you might not be arrested, but your summary
4030 buffer will look strange, which is bad enough.
4031
4032 The smart choice is to have these specs as far to the left as possible.
4033 (Isn't that the case with everything, though?  But I digress.)
4034
4035 This restriction may disappear in later versions of gnus.
4036
4037
4038 @node To From Newsgroups
4039 @subsection To From Newsgroups
4040 @cindex To
4041 @cindex Newsgroups
4042
4043 In some groups (particularly in archive groups), the @code{From} header
4044 isn't very interesting, since all the articles there are written by
4045 you.  To display the information in the @code{To} or @code{Newsgroups}
4046 headers instead, you need to decide three things: What information to
4047 gather; where to display it; and when to display it.
4048
4049 @enumerate
4050 @item
4051 @vindex gnus-extra-headers
4052 The reading of extra header information is controlled by the
4053 @code{gnus-extra-headers}.  This is a list of header symbols.  For
4054 instance:
4055
4056 @lisp
4057 (setq gnus-extra-headers
4058       '(To Newsgroups X-Newsreader))
4059 @end lisp
4060
4061 This will result in Gnus trying to obtain these three headers, and
4062 storing it in header structures for later easy retrieval.
4063
4064 @item
4065 @findex gnus-extra-header
4066 The value of these extra headers can be accessed via the
4067 @code{gnus-extra-header} function.  Here's a format line spec that will
4068 access the @code{X-Newsreader} header:
4069
4070 @example
4071 "%~(form (gnus-extra-header 'X-Newsreader))@@"
4072 @end example
4073
4074 @item
4075 @vindex gnus-ignored-from-addresses
4076 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
4077 summary line spec returns the @code{To}, @code{Newsreader} or
4078 @code{From} header.  If this regexp matches the contents of the
4079 @code{From} header, the value of the @code{To} or @code{Newsreader}
4080 headers are used instead.
4081
4082 @end enumerate
4083
4084 @vindex nnmail-extra-headers
4085 A related variable is @code{nnmail-extra-headers}, which controls when
4086 to include extra headers when generating overview (@sc{nov}) files.  If
4087 you have old overview files, you should regenerate them after changing
4088 this variable.
4089
4090 @vindex gnus-summary-line-format
4091 You also have to instruct Gnus to display the data by changing the
4092 @code{%n} spec to the @code{%f} spec in the
4093 @code{gnus-summary-line-format} variable.
4094
4095 In summary, you'd typically do something like the following:
4096
4097 @lisp
4098 (setq gnus-extra-headers
4099       '(To Newsgroups))
4100 (setq nnmail-extra-headers gnus-extra-headers)
4101 (setq gnus-summary-line-format
4102       "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
4103 (setq gnus-ignored-from-addresses
4104       "Your Name Here")
4105 @end lisp
4106
4107 Now, this is mostly useful for mail groups, where you have control over
4108 the @sc{nov} files that are created.  However, if you can persuade your
4109 nntp admin to add:
4110
4111 @example
4112 Newsgroups:full
4113 @end example
4114
4115 to the end of her @file{overview.fmt} file, then you can use that just
4116 as you would the extra headers from the mail groups.
4117
4118
4119 @node Summary Buffer Mode Line
4120 @subsection Summary Buffer Mode Line
4121
4122 @vindex gnus-summary-mode-line-format
4123 You can also change the format of the summary mode bar (@pxref{Mode Line
4124 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
4125 like.  The default is @samp{Gnus: %%b [%A] %Z}.
4126
4127 Here are the elements you can play with:
4128
4129 @table @samp
4130 @item G
4131 Group name.
4132 @item p
4133 Unprefixed group name.
4134 @item A
4135 Current article number.
4136 @item z
4137 Current article score.
4138 @item V
4139 Gnus version.
4140 @item U
4141 Number of unread articles in this group.
4142 @item e
4143 Number of unread articles in this group that aren't displayed in the
4144 summary buffer.
4145 @item Z
4146 A string with the number of unread and unselected articles represented
4147 either as @samp{<%U(+%e) more>} if there are both unread and unselected
4148 articles, and just as @samp{<%U more>} if there are just unread articles
4149 and no unselected ones.
4150 @item g
4151 Shortish group name.  For instance, @samp{rec.arts.anime} will be
4152 shortened to @samp{r.a.anime}.
4153 @item S
4154 Subject of the current article.
4155 @item u
4156 User-defined spec (@pxref{User-Defined Specs}).
4157 @item s
4158 Name of the current score file (@pxref{Scoring}).
4159 @item d
4160 Number of dormant articles (@pxref{Unread Articles}).
4161 @item t
4162 Number of ticked articles (@pxref{Unread Articles}).
4163 @item r
4164 Number of articles that have been marked as read in this session.
4165 @item E
4166 Number of articles expunged by the score files.
4167 @end table
4168
4169
4170 @node Summary Highlighting
4171 @subsection Summary Highlighting
4172
4173 @table @code
4174
4175 @item gnus-visual-mark-article-hook
4176 @vindex gnus-visual-mark-article-hook
4177 This hook is run after selecting an article.  It is meant to be used for
4178 highlighting the article in some way.  It is not run if
4179 @code{gnus-visual} is @code{nil}.
4180
4181 @item gnus-summary-update-hook
4182 @vindex gnus-summary-update-hook
4183 This hook is called when a summary line is changed.  It is not run if
4184 @code{gnus-visual} is @code{nil}.
4185
4186 @item gnus-summary-selected-face
4187 @vindex gnus-summary-selected-face
4188 This is the face (or @dfn{font} as some people call it) used to
4189 highlight the current article in the summary buffer.
4190
4191 @item gnus-summary-highlight
4192 @vindex gnus-summary-highlight
4193 Summary lines are highlighted according to this variable, which is a
4194 list where the elements are of the format @code{(@var{form}
4195 . @var{face})}.  If you would, for instance, like ticked articles to be
4196 italic and high-scored articles to be bold, you could set this variable
4197 to something like
4198 @lisp
4199 (((eq mark gnus-ticked-mark) . italic)
4200  ((> score default) . bold))
4201 @end lisp
4202 As you may have guessed, if @var{form} returns a non-@code{nil} value,
4203 @var{face} will be applied to the line.
4204 @end table
4205
4206
4207 @node Summary Maneuvering
4208 @section Summary Maneuvering
4209 @cindex summary movement
4210
4211 All the straight movement commands understand the numeric prefix and
4212 behave pretty much as you'd expect.
4213
4214 None of these commands select articles.
4215
4216 @table @kbd
4217 @item G M-n
4218 @itemx M-n
4219 @kindex M-n (Summary)
4220 @kindex G M-n (Summary)
4221 @findex gnus-summary-next-unread-subject
4222 Go to the next summary line of an unread article
4223 (@code{gnus-summary-next-unread-subject}).
4224
4225 @item G M-p
4226 @itemx M-p
4227 @kindex M-p (Summary)
4228 @kindex G M-p (Summary)
4229 @findex gnus-summary-prev-unread-subject
4230 Go to the previous summary line of an unread article
4231 (@code{gnus-summary-prev-unread-subject}).
4232
4233 @item G j
4234 @itemx j
4235 @kindex j (Summary)
4236 @kindex G j (Summary)
4237 @findex gnus-summary-goto-article
4238 Ask for an article number or @code{Message-ID}, and then go to that
4239 article (@code{gnus-summary-goto-article}).
4240
4241 @item G g
4242 @kindex G g (Summary)
4243 @findex gnus-summary-goto-subject
4244 Ask for an article number and then go to the summary line of that article
4245 without displaying the article (@code{gnus-summary-goto-subject}).
4246 @end table
4247
4248 If gnus asks you to press a key to confirm going to the next group, you
4249 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
4250 buffer, searching for the next group to read without actually returning
4251 to the group buffer.
4252
4253 Variables related to summary movement:
4254
4255 @table @code
4256
4257 @vindex gnus-auto-select-next
4258 @item gnus-auto-select-next
4259 If you issue one of the movement commands (like @kbd{n}) and there are
4260 no more unread articles after the current one, gnus will offer to go to
4261 the next group.  If this variable is @code{t} and the next group is
4262 empty, gnus will exit summary mode and return to the group buffer.  If
4263 this variable is neither @code{t} nor @code{nil}, gnus will select the
4264 next group, no matter whether it has any unread articles or not.  As a
4265 special case, if this variable is @code{quietly}, gnus will select the
4266 next group without asking for confirmation.  If this variable is
4267 @code{almost-quietly}, the same will happen only if you are located on
4268 the last article in the group.  Finally, if this variable is
4269 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
4270 without confirmation.  Also @pxref{Group Levels}.
4271
4272 @item gnus-auto-select-same
4273 @vindex gnus-auto-select-same
4274 If non-@code{nil}, all the movement commands will try to go to the next
4275 article with the same subject as the current.  (@dfn{Same} here might
4276 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
4277 for details (@pxref{Customizing Threading}).)  If there are no more
4278 articles with the same subject, go to the first unread article.
4279
4280 This variable is not particularly useful if you use a threaded display.
4281
4282 @item gnus-summary-check-current
4283 @vindex gnus-summary-check-current
4284 If non-@code{nil}, all the ``unread'' movement commands will not proceed
4285 to the next (or previous) article if the current article is unread.
4286 Instead, they will choose the current article.
4287
4288 @item gnus-auto-center-summary
4289 @vindex gnus-auto-center-summary
4290 If non-@code{nil}, gnus will keep the point in the summary buffer
4291 centered at all times.  This makes things quite tidy, but if you have a
4292 slow network connection, or simply do not like this un-Emacsism, you can
4293 set this variable to @code{nil} to get the normal Emacs scrolling
4294 action.  This will also inhibit horizontal re-centering of the summary
4295 buffer, which might make it more inconvenient to read extremely long
4296 threads.
4297
4298 This variable can also be a number.  In that case, center the window at
4299 the given number of lines from the top.
4300
4301 @end table
4302
4303
4304 @node Choosing Articles
4305 @section Choosing Articles
4306 @cindex selecting articles
4307
4308 @menu
4309 * Choosing Commands::        Commands for choosing articles.
4310 * Choosing Variables::       Variables that influence these commands.
4311 @end menu
4312
4313
4314 @node Choosing Commands
4315 @subsection Choosing Commands
4316
4317 None of the following movement commands understand the numeric prefix,
4318 and they all select and display an article.
4319
4320 @table @kbd
4321 @item SPACE
4322 @kindex SPACE (Summary)
4323 @findex gnus-summary-next-page
4324 Select the current article, or, if that one's read already, the next
4325 unread article (@code{gnus-summary-next-page}).
4326
4327 @item G n
4328 @itemx n
4329 @kindex n (Summary)
4330 @kindex G n (Summary)
4331 @findex gnus-summary-next-unread-article
4332 @c @icon{gnus-summary-next-unread}
4333 Go to next unread article (@code{gnus-summary-next-unread-article}).
4334
4335 @item G p
4336 @itemx p
4337 @kindex p (Summary)
4338 @findex gnus-summary-prev-unread-article
4339 @c @icon{gnus-summary-prev-unread}
4340 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
4341
4342 @item G N
4343 @itemx N
4344 @kindex N (Summary)
4345 @kindex G N (Summary)
4346 @findex gnus-summary-next-article
4347 Go to the next article (@code{gnus-summary-next-article}).
4348
4349 @item G P
4350 @itemx P
4351 @kindex P (Summary)
4352 @kindex G P (Summary)
4353 @findex gnus-summary-prev-article
4354 Go to the previous article (@code{gnus-summary-prev-article}).
4355
4356 @item G C-n
4357 @kindex G C-n (Summary)
4358 @findex gnus-summary-next-same-subject
4359 Go to the next article with the same subject
4360 (@code{gnus-summary-next-same-subject}).
4361
4362 @item G C-p
4363 @kindex G C-p (Summary)
4364 @findex gnus-summary-prev-same-subject
4365 Go to the previous article with the same subject
4366 (@code{gnus-summary-prev-same-subject}).
4367
4368 @item G f
4369 @itemx .
4370 @kindex G f  (Summary)
4371 @kindex .  (Summary)
4372 @findex gnus-summary-first-unread-article
4373 Go to the first unread article
4374 (@code{gnus-summary-first-unread-article}).
4375
4376 @item G b
4377 @itemx ,
4378 @kindex G b (Summary)
4379 @kindex , (Summary)
4380 @findex gnus-summary-best-unread-article
4381 Go to the article with the highest score
4382 (@code{gnus-summary-best-unread-article}).
4383
4384 @item G l
4385 @itemx l
4386 @kindex l (Summary)
4387 @kindex G l (Summary)
4388 @findex gnus-summary-goto-last-article
4389 Go to the previous article read (@code{gnus-summary-goto-last-article}).
4390
4391 @item G o
4392 @kindex G o (Summary)
4393 @findex gnus-summary-pop-article
4394 @cindex history
4395 @cindex article history
4396 Pop an article off the summary history and go to this article
4397 (@code{gnus-summary-pop-article}).  This command differs from the
4398 command above in that you can pop as many previous articles off the
4399 history as you like, while @kbd{l} toggles the two last read articles.
4400 For a somewhat related issue (if you use these commands a lot),
4401 @pxref{Article Backlog}.
4402 @end table
4403
4404
4405 @node Choosing Variables
4406 @subsection Choosing Variables
4407
4408 Some variables relevant for moving and selecting articles:
4409
4410 @table @code
4411 @item gnus-auto-extend-newsgroup
4412 @vindex gnus-auto-extend-newsgroup
4413 All the movement commands will try to go to the previous (or next)
4414 article, even if that article isn't displayed in the Summary buffer if
4415 this variable is non-@code{nil}.  Gnus will then fetch the article from
4416 the server and display it in the article buffer.
4417
4418 @item gnus-select-article-hook
4419 @vindex gnus-select-article-hook
4420 This hook is called whenever an article is selected.  By default it
4421 exposes any threads hidden under the selected article.
4422
4423 @item gnus-mark-article-hook
4424 @vindex gnus-mark-article-hook
4425 @findex gnus-summary-mark-unread-as-read
4426 @findex gnus-summary-mark-read-and-unread-as-read
4427 @findex gnus-unread-mark
4428 This hook is called whenever an article is selected.  It is intended to
4429 be used for marking articles as read.  The default value is
4430 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
4431 mark of almost any article you read to @code{gnus-unread-mark}.  The
4432 only articles not affected by this function are ticked, dormant, and
4433 expirable articles.  If you'd instead like to just have unread articles
4434 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
4435 instead.  It will leave marks like @code{gnus-low-score-mark},
4436 @code{gnus-del-mark} (and so on) alone.
4437
4438 @end table
4439
4440
4441 @node Paging the Article
4442 @section Scrolling the Article
4443 @cindex article scrolling
4444
4445 @table @kbd
4446
4447 @item SPACE
4448 @kindex SPACE (Summary)
4449 @findex gnus-summary-next-page
4450 Pressing @kbd{SPACE} will scroll the current article forward one page,
4451 or, if you have come to the end of the current article, will choose the
4452 next article (@code{gnus-summary-next-page}).
4453
4454 @item DEL
4455 @kindex DEL (Summary)
4456 @findex gnus-summary-prev-page
4457 Scroll the current article back one page (@code{gnus-summary-prev-page}).
4458
4459 @item RET
4460 @kindex RET (Summary)
4461 @findex gnus-summary-scroll-up
4462 Scroll the current article one line forward
4463 (@code{gnus-summary-scroll-up}).
4464
4465 @item M-RET
4466 @kindex M-RET (Summary)
4467 @findex gnus-summary-scroll-down
4468 Scroll the current article one line backward
4469 (@code{gnus-summary-scroll-down}).
4470
4471 @item A g
4472 @itemx g
4473 @kindex A g (Summary)
4474 @kindex g (Summary)
4475 @findex gnus-summary-show-article
4476 @vindex gnus-summary-show-article-charset-alist
4477 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
4478 given a prefix, fetch the current article, but don't run any of the
4479 article treatment functions.  This will give you a ``raw'' article, just
4480 the way it came from the server.
4481
4482 If given a numerical prefix, you can do semi-manual charset stuff.
4483 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
4484 encoded in the @code{cn-gb-2312} charset.  If you have
4485
4486 @lisp
4487 (setq gnus-summary-show-article-charset-alist 
4488       '((1 . cn-gb-2312) 
4489         (2 . big5)))
4490 @end lisp
4491
4492 then you can say @kbd{C-u 1 g} to get the same effect.
4493
4494 @item A <
4495 @itemx <
4496 @kindex < (Summary)
4497 @kindex A < (Summary)
4498 @findex gnus-summary-beginning-of-article
4499 Scroll to the beginning of the article
4500 (@code{gnus-summary-beginning-of-article}).
4501
4502 @item A >
4503 @itemx >
4504 @kindex > (Summary)
4505 @kindex A > (Summary)
4506 @findex gnus-summary-end-of-article
4507 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
4508
4509 @item A s
4510 @itemx s
4511 @kindex A s (Summary)
4512 @kindex s (Summary)
4513 @findex gnus-summary-isearch-article
4514 Perform an isearch in the article buffer
4515 (@code{gnus-summary-isearch-article}).
4516
4517 @item h
4518 @kindex h (Summary)
4519 @findex gnus-summary-select-article-buffer
4520 Select the article buffer (@code{gnus-summary-select-article-buffer}).
4521
4522 @end table
4523
4524
4525 @node Reply Followup and Post
4526 @section Reply, Followup and Post
4527
4528 @menu
4529 * Summary Mail Commands::       Sending mail.
4530 * Summary Post Commands::       Sending news.
4531 * Summary Message Commands::    Other Message-related commands.
4532 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
4533 @end menu
4534
4535
4536 @node Summary Mail Commands
4537 @subsection Summary Mail Commands
4538 @cindex mail
4539 @cindex composing mail
4540
4541 Commands for composing a mail message:
4542
4543 @table @kbd
4544
4545 @item S r
4546 @itemx r
4547 @kindex S r (Summary)
4548 @kindex r (Summary)
4549 @findex gnus-summary-reply
4550 @c @icon{gnus-summary-mail-reply}
4551 @c @icon{gnus-summary-reply}
4552 Mail a reply to the author of the current article
4553 (@code{gnus-summary-reply}).
4554
4555 @item S R
4556 @itemx R
4557 @kindex R (Summary)
4558 @kindex S R (Summary)
4559 @findex gnus-summary-reply-with-original
4560 @c @icon{gnus-summary-reply-with-original}
4561 Mail a reply to the author of the current article and include the
4562 original message (@code{gnus-summary-reply-with-original}).  This
4563 command uses the process/prefix convention.
4564
4565 @item S w
4566 @kindex S w (Summary)
4567 @findex gnus-summary-wide-reply
4568 Mail a wide reply to the author of the current article
4569 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
4570 goes out to all people listed in the @code{To}, @code{From} (or
4571 @code{Reply-to}) and @code{Cc} headers.
4572
4573 @item S W
4574 @kindex S W (Summary)
4575 @findex gnus-summary-wide-reply-with-original
4576 Mail a wide reply to the current article and include the original
4577 message (@code{gnus-summary-wide-reply-with-original}).  This command uses
4578 the process/prefix convention.
4579
4580 @item S o m
4581 @itemx C-c C-f
4582 @kindex S o m (Summary)
4583 @kindex C-c C-f (Summary)
4584 @findex gnus-summary-mail-forward
4585 @c @icon{gnus-summary-mail-forward}
4586 Forward the current article to some other person
4587 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
4588 headers of the forwarded article.
4589
4590 @item S m
4591 @itemx m
4592 @kindex m (Summary)
4593 @kindex S m (Summary)
4594 @findex gnus-summary-mail-other-window
4595 @c @icon{gnus-summary-mail-originate}
4596 Send a mail to some other person
4597 (@code{gnus-summary-mail-other-window}).
4598
4599 @item S D b
4600 @kindex S D b (Summary)
4601 @findex gnus-summary-resend-bounced-mail
4602 @cindex bouncing mail
4603 If you have sent a mail, but the mail was bounced back to you for some
4604 reason (wrong address, transient failure), you can use this command to
4605 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
4606 will be popped into a mail buffer where you can edit the headers before
4607 sending the mail off again.  If you give a prefix to this command, and
4608 the bounced mail is a reply to some other mail, gnus will try to fetch
4609 that mail and display it for easy perusal of its headers.  This might
4610 very well fail, though.
4611
4612 @item S D r
4613 @kindex S D r (Summary)
4614 @findex gnus-summary-resend-message
4615 Not to be confused with the previous command,
4616 @code{gnus-summary-resend-message} will prompt you for an address to
4617 send the current message off to, and then send it to that place.  The
4618 headers of the message won't be altered---but lots of headers that say
4619 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
4620 means that you actually send a mail to someone that has a @code{To}
4621 header that (probably) points to yourself.  This will confuse people.
4622 So, natcherly you'll only do that if you're really eVIl.
4623
4624 This command is mainly used if you have several accounts and want to
4625 ship a mail to a different account of yours.  (If you're both
4626 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4627 to the @code{root} account, you may want to resend it to
4628 @code{postmaster}.  Ordnung muß sein!
4629
4630 This command understands the process/prefix convention
4631 (@pxref{Process/Prefix}).
4632
4633 @item S O m
4634 @kindex S O m (Summary)
4635 @findex gnus-uu-digest-mail-forward
4636 Digest the current series (@pxref{Decoding Articles}) and forward the
4637 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
4638 uses the process/prefix convention (@pxref{Process/Prefix}).
4639
4640 @item S M-c
4641 @kindex S M-c (Summary)
4642 @findex gnus-summary-mail-crosspost-complaint
4643 @cindex crossposting
4644 @cindex excessive crossposting
4645 Send a complaint about excessive crossposting to the author of the
4646 current article (@code{gnus-summary-mail-crosspost-complaint}).
4647
4648 @findex gnus-crosspost-complaint
4649 This command is provided as a way to fight back against the current
4650 crossposting pandemic that's sweeping Usenet.  It will compose a reply
4651 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
4652 command understands the process/prefix convention
4653 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4654
4655 @end table
4656
4657 Also @pxref{(message)Header Commands} for more information.
4658
4659
4660 @node Summary Post Commands
4661 @subsection Summary Post Commands
4662 @cindex post
4663 @cindex composing news
4664
4665 Commands for posting a news article:
4666
4667 @table @kbd
4668 @item S p
4669 @itemx a
4670 @kindex a (Summary)
4671 @kindex S p (Summary)
4672 @findex gnus-summary-post-news
4673 @c @icon{gnus-summary-post-news}
4674 Post an article to the current group
4675 (@code{gnus-summary-post-news}).
4676
4677 @item S f
4678 @itemx f
4679 @kindex f (Summary)
4680 @kindex S f (Summary)
4681 @findex gnus-summary-followup
4682 @c @icon{gnus-summary-followup}
4683 Post a followup to the current article (@code{gnus-summary-followup}).
4684
4685 @item S F
4686 @itemx F
4687 @kindex S F (Summary)
4688 @kindex F (Summary)
4689 @c @icon{gnus-summary-followup-with-original}
4690 @findex gnus-summary-followup-with-original
4691 Post a followup to the current article and include the original message
4692 (@code{gnus-summary-followup-with-original}).   This command uses the
4693 process/prefix convention.
4694
4695 @item S n
4696 @kindex S n (Summary)
4697 @findex gnus-summary-followup-to-mail
4698 Post a followup to the current article via news, even if you got the
4699 message through mail (@code{gnus-summary-followup-to-mail}).
4700
4701 @item S N
4702 @kindex S N (Summary)
4703 @findex gnus-summary-followup-to-mail-with-original
4704 Post a followup to the current article via news, even if you got the
4705 message through mail and include the original message
4706 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
4707 the process/prefix convention.
4708
4709 @item S o p
4710 @kindex S o p (Summary)
4711 @findex gnus-summary-post-forward
4712 Forward the current article to a newsgroup
4713 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
4714 headers of the forwarded article.
4715
4716 @item S O p
4717 @kindex S O p (Summary)
4718 @findex gnus-uu-digest-post-forward
4719 @cindex digests
4720 @cindex making digests
4721 Digest the current series and forward the result to a newsgroup
4722 (@code{gnus-uu-digest-mail-forward}).  This command uses the
4723 process/prefix convention.
4724
4725 @item S u
4726 @kindex S u (Summary)
4727 @findex gnus-uu-post-news
4728 @c @icon{gnus-uu-post-news}
4729 Uuencode a file, split it into parts, and post it as a series
4730 (@code{gnus-uu-post-news}).  (@pxref{Uuencoding and Posting}).
4731 @end table
4732
4733 Also @pxref{(message)Header Commands} for more information.
4734
4735
4736 @node Summary Message Commands
4737 @subsection Summary Message Commands
4738
4739 @table @kbd
4740 @item S y
4741 @kindex S y (Summary)
4742 @findex gnus-summary-yank-message
4743 Yank the current article into an already existing Message composition
4744 buffer (@code{gnus-summary-yank-message}).  This command prompts for
4745 what message buffer you want to yank into, and understands the
4746 process/prefix convention (@pxref{Process/Prefix}).
4747
4748 @end table
4749
4750
4751 @node Canceling and Superseding
4752 @subsection Canceling Articles
4753 @cindex canceling articles
4754 @cindex superseding articles
4755
4756 Have you ever written something, and then decided that you really,
4757 really, really wish you hadn't posted that?
4758
4759 Well, you can't cancel mail, but you can cancel posts.
4760
4761 @findex gnus-summary-cancel-article
4762 @kindex C (Summary)
4763 @c @icon{gnus-summary-cancel-article}
4764 Find the article you wish to cancel (you can only cancel your own
4765 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
4766 c} (@code{gnus-summary-cancel-article}).  Your article will be
4767 canceled---machines all over the world will be deleting your article.
4768 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4769
4770 Be aware, however, that not all sites honor cancels, so your article may
4771 live on here and there, while most sites will delete the article in
4772 question.
4773
4774 Gnus will use the ``current'' select method when canceling.  If you
4775 want to use the standard posting method, use the @samp{a} symbolic
4776 prefix (@pxref{Symbolic Prefixes}).
4777
4778 If you discover that you have made some mistakes and want to do some
4779 corrections, you can post a @dfn{superseding} article that will replace
4780 your original article.
4781
4782 @findex gnus-summary-supersede-article
4783 @kindex S (Summary)
4784 Go to the original article and press @kbd{S s}
4785 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
4786 where you can edit the article all you want before sending it off the
4787 usual way.
4788
4789 The same goes for superseding as for canceling, only more so: Some
4790 sites do not honor superseding.  On those sites, it will appear that you
4791 have posted almost the same article twice.
4792
4793 If you have just posted the article, and change your mind right away,
4794 there is a trick you can use to cancel/supersede the article without
4795 waiting for the article to appear on your site first.  You simply return
4796 to the post buffer (which is called @code{*sent ...*}).  There you will
4797 find the article you just posted, with all the headers intact.  Change
4798 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4799 header by substituting one of those words for the word
4800 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
4801 you would do normally.  The previous article will be
4802 canceled/superseded.
4803
4804 Just remember, kids: There is no 'c' in 'supersede'.
4805
4806
4807 @node Marking Articles
4808 @section Marking Articles
4809 @cindex article marking
4810 @cindex article ticking
4811 @cindex marks
4812
4813 There are several marks you can set on an article.
4814
4815 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4816 neologism ohoy!) of the article.  Alphabetic marks generally mean
4817 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4818
4819 In addition, you also have marks that do not affect readedness.
4820
4821 @menu
4822 * Unread Articles::      Marks for unread articles.
4823 * Read Articles::        Marks for read articles.
4824 * Other Marks::          Marks that do not affect readedness.
4825 @end menu
4826
4827 @ifinfo
4828 There's a plethora of commands for manipulating these marks:
4829 @end ifinfo
4830
4831 @menu
4832 * Setting Marks::             How to set and remove marks.
4833 * Generic Marking Commands::  How to customize the marking.
4834 * Setting Process Marks::     How to mark articles for later processing.
4835 @end menu
4836
4837
4838 @node Unread Articles
4839 @subsection Unread Articles
4840
4841 The following marks mark articles as (kinda) unread, in one form or
4842 other.
4843
4844 @table @samp
4845 @item !
4846 @vindex gnus-ticked-mark
4847 Marked as ticked (@code{gnus-ticked-mark}).
4848
4849 @dfn{Ticked articles} are articles that will remain visible always.  If
4850 you see an article that you find interesting, or you want to put off
4851 reading it, or replying to it, until sometime later, you'd typically
4852 tick it.  However, articles can be expired, so if you want to keep an
4853 article forever, you'll have to make it persistent (@pxref{Persistent
4854 Articles}).
4855
4856 @item ?
4857 @vindex gnus-dormant-mark
4858 Marked as dormant (@code{gnus-dormant-mark}).
4859
4860 @dfn{Dormant articles} will only appear in the summary buffer if there
4861 are followups to it.  If you want to see them even if they don't have
4862 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4863
4864 @item SPACE
4865 @vindex gnus-unread-mark
4866 Marked as unread (@code{gnus-unread-mark}).
4867
4868 @dfn{Unread articles} are articles that haven't been read at all yet.
4869 @end table
4870
4871
4872 @node Read Articles
4873 @subsection Read Articles
4874 @cindex expirable mark
4875
4876 All the following marks mark articles as read.
4877
4878 @table @samp
4879
4880 @item r
4881 @vindex gnus-del-mark
4882 These are articles that the user has marked as read with the @kbd{d}
4883 command manually, more or less (@code{gnus-del-mark}).
4884
4885 @item R
4886 @vindex gnus-read-mark
4887 Articles that have actually been read (@code{gnus-read-mark}).
4888
4889 @item O
4890 @vindex gnus-ancient-mark
4891 Articles that were marked as read in previous sessions and are now
4892 @dfn{old} (@code{gnus-ancient-mark}).
4893
4894 @item K
4895 @vindex gnus-killed-mark
4896 Marked as killed (@code{gnus-killed-mark}).
4897
4898 @item X
4899 @vindex gnus-kill-file-mark
4900 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4901
4902 @item Y
4903 @vindex gnus-low-score-mark
4904 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4905
4906 @item C
4907 @vindex gnus-catchup-mark
4908 Marked as read by a catchup (@code{gnus-catchup-mark}).
4909
4910 @item G
4911 @vindex gnus-canceled-mark
4912 Canceled article (@code{gnus-canceled-mark})
4913
4914 @item F
4915 @vindex gnus-souped-mark
4916 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
4917
4918 @item Q
4919 @vindex gnus-sparse-mark
4920 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
4921 Threading}.
4922
4923 @item M
4924 @vindex gnus-duplicate-mark
4925 Article marked as read by duplicate suppression
4926 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
4927
4928 @end table
4929
4930 All these marks just mean that the article is marked as read, really.
4931 They are interpreted differently when doing adaptive scoring, though.
4932
4933 One more special mark, though:
4934
4935 @table @samp
4936 @item E
4937 @vindex gnus-expirable-mark
4938 Marked as expirable (@code{gnus-expirable-mark}).
4939
4940 Marking articles as @dfn{expirable} (or have them marked as such
4941 automatically) doesn't make much sense in normal groups---a user doesn't
4942 control expiring of news articles, but in mail groups, for instance,
4943 articles marked as @dfn{expirable} can be deleted by gnus at
4944 any time.
4945 @end table
4946
4947
4948 @node Other Marks
4949 @subsection Other Marks
4950 @cindex process mark
4951 @cindex bookmarks
4952
4953 There are some marks that have nothing to do with whether the article is
4954 read or not.
4955
4956 @itemize @bullet
4957
4958 @item
4959 You can set a bookmark in the current article.  Say you are reading a
4960 long thesis on cats' urinary tracts, and have to go home for dinner
4961 before you've finished reading the thesis.  You can then set a bookmark
4962 in the article, and gnus will jump to this bookmark the next time it
4963 encounters the article.  @xref{Setting Marks}.
4964
4965 @item
4966 @vindex gnus-replied-mark
4967 All articles that you have replied to or made a followup to (i.e., have
4968 answered) will be marked with an @samp{A} in the second column
4969 (@code{gnus-replied-mark}).
4970
4971 @item
4972 @vindex gnus-cached-mark
4973 Articles stored in the article cache will be marked with an @samp{*} in
4974 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
4975
4976 @item
4977 @vindex gnus-saved-mark
4978 Articles ``saved'' (in some manner or other; not necessarily
4979 religiously) are marked with an @samp{S} in the second column
4980 (@code{gnus-saved-mark}).
4981
4982 @item
4983 @vindex gnus-not-empty-thread-mark
4984 @vindex gnus-empty-thread-mark
4985 If the @samp{%e} spec is used, the presence of threads or not will be
4986 marked with @code{gnus-not-empty-thread-mark} and
4987 @code{gnus-empty-thread-mark} in the third column, respectively.
4988
4989 @item
4990 @vindex gnus-process-mark
4991 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
4992 variety of commands react to the presence of the process mark.  For
4993 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4994 all articles that have been marked with the process mark.  Articles
4995 marked with the process mark have a @samp{#} in the second column.
4996
4997 @end itemize
4998
4999 You might have noticed that most of these ``non-readedness'' marks
5000 appear in the second column by default.  So if you have a cached, saved,
5001 replied article that you have process-marked, what will that look like?
5002
5003 Nothing much.  The precedence rules go as follows: process -> cache ->
5004 replied -> saved.  So if the article is in the cache and is replied,
5005 you'll only see the cache mark and not the replied mark.
5006
5007
5008 @node Setting Marks
5009 @subsection Setting Marks
5010 @cindex setting marks
5011
5012 All the marking commands understand the numeric prefix.
5013
5014 @table @kbd
5015 @item M c
5016 @itemx M-u
5017 @kindex M c (Summary)
5018 @kindex M-u (Summary)
5019 @findex gnus-summary-clear-mark-forward
5020 @cindex mark as unread
5021 Clear all readedness-marks from the current article
5022 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
5023 article as unread.
5024
5025 @item M t
5026 @itemx !
5027 @kindex ! (Summary)
5028 @kindex M t (Summary)
5029 @findex gnus-summary-tick-article-forward
5030 Tick the current article (@code{gnus-summary-tick-article-forward}).
5031 @xref{Article Caching}.
5032
5033 @item M ?
5034 @itemx ?
5035 @kindex ? (Summary)
5036 @kindex M ? (Summary)
5037 @findex gnus-summary-mark-as-dormant
5038 Mark the current article as dormant
5039 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
5040
5041 @item M d
5042 @itemx d
5043 @kindex M d (Summary)
5044 @kindex d (Summary)
5045 @findex gnus-summary-mark-as-read-forward
5046 Mark the current article as read
5047 (@code{gnus-summary-mark-as-read-forward}).
5048
5049 @item D
5050 @kindex D (Summary)
5051 @findex gnus-summary-mark-as-read-backward
5052 Mark the current article as read and move point to the previous line
5053 (@code{gnus-summary-mark-as-read-backward}).
5054
5055 @item M k
5056 @itemx k
5057 @kindex k (Summary)
5058 @kindex M k (Summary)
5059 @findex gnus-summary-kill-same-subject-and-select
5060 Mark all articles that have the same subject as the current one as read,
5061 and then select the next unread article
5062 (@code{gnus-summary-kill-same-subject-and-select}).
5063
5064 @item M K
5065 @itemx C-k
5066 @kindex M K (Summary)
5067 @kindex C-k (Summary)
5068 @findex gnus-summary-kill-same-subject
5069 Mark all articles that have the same subject as the current one as read
5070 (@code{gnus-summary-kill-same-subject}).
5071
5072 @item M C
5073 @kindex M C (Summary)
5074 @findex gnus-summary-catchup
5075 @c @icon{gnus-summary-catchup}
5076 Mark all unread articles as read (@code{gnus-summary-catchup}).
5077
5078 @item M C-c
5079 @kindex M C-c (Summary)
5080 @findex gnus-summary-catchup-all
5081 Mark all articles in the group as read---even the ticked and dormant
5082 articles (@code{gnus-summary-catchup-all}).
5083
5084 @item M H
5085 @kindex M H (Summary)
5086 @findex gnus-summary-catchup-to-here
5087 Catchup the current group to point
5088 (@code{gnus-summary-catchup-to-here}).
5089
5090 @item C-w
5091 @kindex C-w (Summary)
5092 @findex gnus-summary-mark-region-as-read
5093 Mark all articles between point and mark as read
5094 (@code{gnus-summary-mark-region-as-read}).
5095
5096 @item M V k
5097 @kindex M V k (Summary)
5098 @findex gnus-summary-kill-below
5099 Kill all articles with scores below the default score (or below the
5100 numeric prefix) (@code{gnus-summary-kill-below}).
5101
5102 @item M e
5103 @itemx E
5104 @kindex M e (Summary)
5105 @kindex E (Summary)
5106 @findex gnus-summary-mark-as-expirable
5107 Mark the current article as expirable
5108 (@code{gnus-summary-mark-as-expirable}).
5109
5110 @item M b
5111 @kindex M b (Summary)
5112 @findex gnus-summary-set-bookmark
5113 Set a bookmark in the current article
5114 (@code{gnus-summary-set-bookmark}).
5115
5116 @item M B
5117 @kindex M B (Summary)
5118 @findex gnus-summary-remove-bookmark
5119 Remove the bookmark from the current article
5120 (@code{gnus-summary-remove-bookmark}).
5121
5122 @item M V c
5123 @kindex M V c (Summary)
5124 @findex gnus-summary-clear-above
5125 Clear all marks from articles with scores over the default score (or
5126 over the numeric prefix) (@code{gnus-summary-clear-above}).
5127
5128 @item M V u
5129 @kindex M V u (Summary)
5130 @findex gnus-summary-tick-above
5131 Tick all articles with scores over the default score (or over the
5132 numeric prefix) (@code{gnus-summary-tick-above}).
5133
5134 @item M V m
5135 @kindex M V m (Summary)
5136 @findex gnus-summary-mark-above
5137 Prompt for a mark, and mark all articles with scores over the default
5138 score (or over the numeric prefix) with this mark
5139 (@code{gnus-summary-clear-above}).
5140 @end table
5141
5142 @vindex gnus-summary-goto-unread
5143 The @code{gnus-summary-goto-unread} variable controls what action should
5144 be taken after setting a mark.  If non-@code{nil}, point will move to
5145 the next/previous unread article.  If @code{nil}, point will just move
5146 one line up or down.  As a special case, if this variable is
5147 @code{never}, all the marking commands as well as other commands (like
5148 @kbd{SPACE}) will move to the next article, whether it is unread or not.
5149 The default is @code{t}.
5150
5151
5152 @node Generic Marking Commands
5153 @subsection Generic Marking Commands
5154
5155 Some people would like the command that ticks an article (@kbd{!}) go to
5156 the next article.  Others would like it to go to the next unread
5157 article.  Yet others would like it to stay on the current article.  And
5158 even though I haven't heard of anybody wanting it to go to the
5159 previous (unread) article, I'm sure there are people that want that as
5160 well.
5161
5162 Multiply these five behaviours with five different marking commands, and
5163 you get a potentially complex set of variable to control what each
5164 command should do.
5165
5166 To sidestep that mess, Gnus provides commands that do all these
5167 different things.  They can be found on the @kbd{M M} map in the summary
5168 buffer.  Type @kbd{M M C-h} to see them all---there are too many of them
5169 to list in this manual.
5170
5171 While you can use these commands directly, most users would prefer
5172 altering the summary mode keymap.  For instance, if you would like the
5173 @kbd{!} command to go to the next article instead of the next unread
5174 article, you could say something like:
5175
5176 @lisp
5177 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
5178 (defun my-alter-summary-map ()
5179   (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
5180 @end lisp
5181
5182 or
5183
5184 @lisp
5185 (defun my-alter-summary-map ()
5186   (local-set-key "!" "MM!n"))
5187 @end lisp
5188
5189
5190 @node Setting Process Marks
5191 @subsection Setting Process Marks
5192 @cindex setting process marks
5193
5194 @table @kbd
5195
5196 @item M P p
5197 @itemx #
5198 @kindex # (Summary)
5199 @kindex M P p (Summary)
5200 @findex gnus-summary-mark-as-processable
5201 Mark the current article with the process mark
5202 (@code{gnus-summary-mark-as-processable}).
5203 @findex gnus-summary-unmark-as-processable
5204
5205 @item M P u
5206 @itemx M-#
5207 @kindex M P u (Summary)
5208 @kindex M-# (Summary)
5209 Remove the process mark, if any, from the current article
5210 (@code{gnus-summary-unmark-as-processable}).
5211
5212 @item M P U
5213 @kindex M P U (Summary)
5214 @findex gnus-summary-unmark-all-processable
5215 Remove the process mark from all articles
5216 (@code{gnus-summary-unmark-all-processable}).
5217
5218 @item M P i
5219 @kindex M P i (Summary)
5220 @findex gnus-uu-invert-processable
5221 Invert the list of process marked articles
5222 (@code{gnus-uu-invert-processable}).
5223
5224 @item M P R
5225 @kindex M P R (Summary)
5226 @findex gnus-uu-mark-by-regexp
5227 Mark articles that have a @code{Subject} header that matches a regular
5228 expression (@code{gnus-uu-mark-by-regexp}).
5229
5230 @item M P G
5231 @kindex M P G (Summary)
5232 @findex gnus-uu-unmark-by-regexp
5233 Unmark articles that have a @code{Subject} header that matches a regular
5234 expression (@code{gnus-uu-unmark-by-regexp}).
5235
5236 @item M P r
5237 @kindex M P r (Summary)
5238 @findex gnus-uu-mark-region
5239 Mark articles in region (@code{gnus-uu-mark-region}).
5240
5241 @item M P t
5242 @kindex M P t (Summary)
5243 @findex gnus-uu-mark-thread
5244 Mark all articles in the current (sub)thread
5245 (@code{gnus-uu-mark-thread}).
5246
5247 @item M P T
5248 @kindex M P T (Summary)
5249 @findex gnus-uu-unmark-thread
5250 Unmark all articles in the current (sub)thread
5251 (@code{gnus-uu-unmark-thread}).
5252
5253 @item M P v
5254 @kindex M P v (Summary)
5255 @findex gnus-uu-mark-over
5256 Mark all articles that have a score above the prefix argument
5257 (@code{gnus-uu-mark-over}).
5258
5259 @item M P s
5260 @kindex M P s (Summary)
5261 @findex gnus-uu-mark-series
5262 Mark all articles in the current series (@code{gnus-uu-mark-series}).
5263
5264 @item M P S
5265 @kindex M P S (Summary)
5266 @findex gnus-uu-mark-sparse
5267 Mark all series that have already had some articles marked
5268 (@code{gnus-uu-mark-sparse}).
5269
5270 @item M P a
5271 @kindex M P a (Summary)
5272 @findex gnus-uu-mark-all
5273 Mark all articles in series order (@code{gnus-uu-mark-series}).
5274
5275 @item M P b
5276 @kindex M P b (Summary)
5277 @findex gnus-uu-mark-buffer
5278 Mark all articles in the buffer in the order they appear
5279 (@code{gnus-uu-mark-buffer}).
5280
5281 @item M P k
5282 @kindex M P k (Summary)
5283 @findex gnus-summary-kill-process-mark
5284 Push the current process mark set onto the stack and unmark all articles
5285 (@code{gnus-summary-kill-process-mark}).
5286
5287 @item M P y
5288 @kindex M P y (Summary)
5289 @findex gnus-summary-yank-process-mark
5290 Pop the previous process mark set from the stack and restore it
5291 (@code{gnus-summary-yank-process-mark}).
5292
5293 @item M P w
5294 @kindex M P w (Summary)
5295 @findex gnus-summary-save-process-mark
5296 Push the current process mark set onto the stack
5297 (@code{gnus-summary-save-process-mark}).
5298
5299 @end table
5300
5301 Also see the @kbd{&} command in @pxref{Searching for Articles} for how to
5302 set process marks based on article body contents.
5303
5304
5305 @node Limiting
5306 @section Limiting
5307 @cindex limiting
5308
5309 It can be convenient to limit the summary buffer to just show some
5310 subset of the articles currently in the group.  The effect most limit
5311 commands have is to remove a few (or many) articles from the summary
5312 buffer.
5313
5314 All limiting commands work on subsets of the articles already fetched
5315 from the servers.  None of these commands query the server for
5316 additional articles.
5317
5318 @table @kbd
5319
5320 @item / /
5321 @itemx / s
5322 @kindex / / (Summary)
5323 @findex gnus-summary-limit-to-subject
5324 Limit the summary buffer to articles that match some subject
5325 (@code{gnus-summary-limit-to-subject}).
5326
5327 @item / a
5328 @kindex / a (Summary)
5329 @findex gnus-summary-limit-to-author
5330 Limit the summary buffer to articles that match some author
5331 (@code{gnus-summary-limit-to-author}).
5332
5333 @item / x
5334 @kindex / x (Summary)
5335 @findex gnus-summary-limit-to-extra
5336 Limit the summary buffer to articles that match one of the ``extra''
5337 headers (@pxref{To From Newsgroups})
5338 (@code{gnus-summary-limit-to-extra}).
5339
5340 @item / u
5341 @itemx x
5342 @kindex / u (Summary)
5343 @kindex x (Summary)
5344 @findex gnus-summary-limit-to-unread
5345 Limit the summary buffer to articles not marked as read
5346 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
5347 buffer to articles strictly unread.  This means that ticked and
5348 dormant articles will also be excluded.
5349
5350 @item / m
5351 @kindex / m (Summary)
5352 @findex gnus-summary-limit-to-marks
5353 Ask for a mark and then limit to all articles that have been marked
5354 with that mark (@code{gnus-summary-limit-to-marks}).
5355
5356 @item / t
5357 @kindex / t (Summary)
5358 @findex gnus-summary-limit-to-age
5359 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
5360 (@code{gnus-summary-limit-to-age}).  If given a prefix, limit to
5361 articles younger than that number of days.
5362
5363 @item / n
5364 @kindex / n (Summary)
5365 @findex gnus-summary-limit-to-articles
5366 Limit the summary buffer to the current article
5367 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
5368 convention (@pxref{Process/Prefix}).
5369
5370 @item / w
5371 @kindex / w (Summary)
5372 @findex gnus-summary-pop-limit
5373 Pop the previous limit off the stack and restore it
5374 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
5375 the stack.
5376
5377 @item / v
5378 @kindex / v (Summary)
5379 @findex gnus-summary-limit-to-score
5380 Limit the summary buffer to articles that have a score at or above some
5381 score (@code{gnus-summary-limit-to-score}).
5382
5383 @item / E
5384 @itemx M S
5385 @kindex M S (Summary)
5386 @kindex / E (Summary)
5387 @findex gnus-summary-limit-include-expunged
5388 Include all expunged articles in the limit
5389 (@code{gnus-summary-limit-include-expunged}).
5390
5391 @item / D
5392 @kindex / D (Summary)
5393 @findex gnus-summary-limit-include-dormant
5394 Include all dormant articles in the limit
5395 (@code{gnus-summary-limit-include-dormant}).
5396
5397 @item / *
5398 @kindex / * (Summary)
5399 @findex gnus-summary-limit-include-cached
5400 Include all cached articles in the limit
5401 (@code{gnus-summary-limit-include-cached}).
5402
5403 @item / d
5404 @kindex / d (Summary)
5405 @findex gnus-summary-limit-exclude-dormant
5406 Exclude all dormant articles from the limit
5407 (@code{gnus-summary-limit-exclude-dormant}).
5408
5409 @item / M
5410 @kindex / M (Summary)
5411 @findex gnus-summary-limit-exclude-marks
5412 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
5413
5414 @item / T
5415 @kindex / T (Summary)
5416 @findex gnus-summary-limit-include-thread
5417 Include all the articles in the current thread in the limit.
5418
5419 @item / c
5420 @kindex / c (Summary)
5421 @findex gnus-summary-limit-exclude-childless-dormant
5422 Exclude all dormant articles that have no children from the limit
5423 (@code{gnus-summary-limit-exclude-childless-dormant}).
5424
5425 @item / C
5426 @kindex / C (Summary)
5427 @findex gnus-summary-limit-mark-excluded-as-read
5428 Mark all excluded unread articles as read
5429 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
5430 also mark excluded ticked and dormant articles as read.
5431
5432 @end table
5433
5434
5435 @node Threading
5436 @section Threading
5437 @cindex threading
5438 @cindex article threading
5439
5440 Gnus threads articles by default.  @dfn{To thread} is to put responses
5441 to articles directly after the articles they respond to---in a
5442 hierarchical fashion.
5443
5444 Threading is done by looking at the @code{References} headers of the
5445 articles.  In a perfect world, this would be enough to build pretty
5446 trees, but unfortunately, the @code{References} header is often broken
5447 or simply missing.  Weird news propagation excarcerbates the problem,
5448 so one has to employ other heuristics to get pleasing results.  A
5449 plethora of approaches exists, as detailed in horrible detail in
5450 @pxref{Customizing Threading}.
5451
5452 First, a quick overview of the concepts:
5453
5454 @table @dfn
5455 @item root
5456 The top-most article in a thread; the first article in the thread.
5457
5458 @item thread
5459 A tree-like article structure.
5460
5461 @item sub-thread
5462 A small(er) section of this tree-like structure.
5463
5464 @item loose threads
5465 Threads often lose their roots due to article expiry, or due to the root
5466 already having been read in a previous session, and not displayed in the
5467 summary buffer.  We then typically have many sub-threads that really
5468 belong to one thread, but are without connecting roots.  These are
5469 called loose threads.
5470
5471 @item thread gathering
5472 An attempt to gather loose threads into bigger threads.
5473
5474 @item sparse threads
5475 A thread where the missing articles have been ``guessed'' at, and are
5476 displayed as empty lines in the summary buffer.
5477
5478 @end table
5479
5480
5481 @menu
5482 * Customizing Threading::     Variables you can change to affect the threading.
5483 * Thread Commands::           Thread based commands in the summary buffer.
5484 @end menu
5485
5486
5487 @node Customizing Threading
5488 @subsection Customizing Threading
5489 @cindex customizing threading
5490
5491 @menu
5492 * Loose Threads::        How gnus gathers loose threads into bigger threads.
5493 * Filling In Threads::   Making the threads displayed look fuller.
5494 * More Threading::       Even more variables for fiddling with threads.
5495 * Low-Level Threading::  You thought it was over... but you were wrong!
5496 @end menu
5497
5498
5499 @node Loose Threads
5500 @subsubsection Loose Threads
5501 @cindex <
5502 @cindex >
5503 @cindex loose threads
5504
5505 @table @code
5506 @item gnus-summary-make-false-root
5507 @vindex gnus-summary-make-false-root
5508 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
5509 and create a dummy root at the top.  (Wait a minute.  Root at the top?
5510 Yup.)  Loose subtrees occur when the real root has expired, or you've
5511 read or killed the root in a previous session.
5512
5513 When there is no real root of a thread, gnus will have to fudge
5514 something.  This variable says what fudging method gnus should use.
5515 There are four possible values:
5516
5517 @iftex
5518 @iflatex
5519 \gnusfigure{The Summary Buffer}{390}{
5520 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
5521 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
5522 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
5523 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
5524 }
5525 @end iflatex
5526 @end iftex
5527
5528 @cindex adopting articles
5529
5530 @table @code
5531
5532 @item adopt
5533 Gnus will make the first of the orphaned articles the parent.  This
5534 parent will adopt all the other articles.  The adopted articles will be
5535 marked as such by pointy brackets (@samp{<>}) instead of the standard
5536 square brackets (@samp{[]}).  This is the default method.
5537
5538 @item dummy
5539 @vindex gnus-summary-dummy-line-format
5540 Gnus will create a dummy summary line that will pretend to be the
5541 parent.  This dummy line does not correspond to any real article, so
5542 selecting it will just select the first real article after the dummy
5543 article.  @code{gnus-summary-dummy-line-format} is used to specify the
5544 format of the dummy roots.  It accepts only one format spec:  @samp{S},
5545 which is the subject of the article.  @xref{Formatting Variables}.
5546
5547 @item empty
5548 Gnus won't actually make any article the parent, but simply leave the
5549 subject field of all orphans except the first empty.  (Actually, it will
5550 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
5551 Buffer Format}).)
5552
5553 @item none
5554 Don't make any article parent at all.  Just gather the threads and
5555 display them after one another.
5556
5557 @item nil
5558 Don't gather loose threads.
5559 @end table
5560
5561 @item gnus-summary-gather-subject-limit
5562 @vindex gnus-summary-gather-subject-limit
5563 Loose threads are gathered by comparing subjects of articles.  If this
5564 variable is @code{nil}, gnus requires an exact match between the
5565 subjects of the loose threads before gathering them into one big
5566 super-thread.  This might be too strict a requirement, what with the
5567 presence of stupid newsreaders that chop off long subject lines.  If
5568 you think so, set this variable to, say, 20 to require that only the
5569 first 20 characters of the subjects have to match.  If you set this
5570 variable to a really low number, you'll find that gnus will gather
5571 everything in sight into one thread, which isn't very helpful.
5572
5573 @cindex fuzzy article gathering
5574 If you set this variable to the special value @code{fuzzy}, gnus will
5575 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
5576 Matching}).
5577
5578 @item gnus-simplify-subject-fuzzy-regexp
5579 @vindex gnus-simplify-subject-fuzzy-regexp
5580 This can either be a regular expression or list of regular expressions
5581 that match strings that will be removed from subjects if fuzzy subject
5582 simplification is used.
5583
5584 @item gnus-simplify-ignored-prefixes
5585 @vindex gnus-simplify-ignored-prefixes
5586 If you set @code{gnus-summary-gather-subject-limit} to something as low
5587 as 10, you might consider setting this variable to something sensible:
5588
5589 @c Written by Michael Ernst <mernst@cs.rice.edu>
5590 @lisp
5591 (setq gnus-simplify-ignored-prefixes
5592       (concat
5593        "\\`\\[?\\("
5594        (mapconcat
5595         'identity
5596         '("looking"
5597           "wanted" "followup" "summary\\( of\\)?"
5598           "help" "query" "problem" "question"
5599           "answer" "reference" "announce"
5600           "How can I" "How to" "Comparison of"
5601           ;; ...
5602           )
5603         "\\|")
5604        "\\)\\s *\\("
5605        (mapconcat 'identity
5606                   '("for" "for reference" "with" "about")
5607                   "\\|")
5608        "\\)?\\]?:?[ \t]*"))
5609 @end lisp
5610
5611 All words that match this regexp will be removed before comparing two
5612 subjects.
5613
5614 @item gnus-simplify-subject-functions
5615 @vindex gnus-simplify-subject-functions
5616 If non-@code{nil}, this variable overrides
5617 @code{gnus-summary-gather-subject-limit}.  This variable should be a
5618 list of functions to apply to the @code{Subject} string iteratively to
5619 arrive at the simplified version of the string.
5620
5621 Useful functions to put in this list include:
5622
5623 @table @code
5624 @item gnus-simplify-subject-re
5625 @findex gnus-simplify-subject-re
5626 Strip the leading @samp{Re:}.
5627
5628 @item gnus-simplify-subject-fuzzy
5629 @findex gnus-simplify-subject-fuzzy
5630 Simplify fuzzily.
5631
5632 @item gnus-simplify-whitespace
5633 @findex gnus-simplify-whitespace
5634 Remove excessive whitespace.
5635 @end table
5636
5637 You may also write your own functions, of course.
5638
5639
5640 @item gnus-summary-gather-exclude-subject
5641 @vindex gnus-summary-gather-exclude-subject
5642 Since loose thread gathering is done on subjects only, that might lead
5643 to many false hits, especially with certain common subjects like
5644 @samp{} and @samp{(none)}.  To make the situation slightly better,
5645 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5646 what subjects should be excluded from the gathering process.@*
5647 The default is @samp{^ *$\\|^(none)$}.
5648
5649 @item gnus-summary-thread-gathering-function
5650 @vindex gnus-summary-thread-gathering-function
5651 Gnus gathers threads by looking at @code{Subject} headers.  This means
5652 that totally unrelated articles may end up in the same ``thread'', which
5653 is confusing.  An alternate approach is to look at all the
5654 @code{Message-ID}s in all the @code{References} headers to find matches.
5655 This will ensure that no gathered threads ever include unrelated
5656 articles, but it also means that people who have posted with broken
5657 newsreaders won't be gathered properly.  The choice is yours---plague or
5658 cholera:
5659
5660 @table @code
5661 @item gnus-gather-threads-by-subject
5662 @findex gnus-gather-threads-by-subject
5663 This function is the default gathering function and looks at
5664 @code{Subject}s exclusively.
5665
5666 @item gnus-gather-threads-by-references
5667 @findex gnus-gather-threads-by-references
5668 This function looks at @code{References} headers exclusively.
5669 @end table
5670
5671 If you want to test gathering by @code{References}, you could say
5672 something like:
5673
5674 @lisp
5675 (setq gnus-summary-thread-gathering-function
5676       'gnus-gather-threads-by-references)
5677 @end lisp
5678
5679 @end table
5680
5681
5682 @node Filling In Threads
5683 @subsubsection Filling In Threads
5684
5685 @table @code
5686 @item gnus-fetch-old-headers
5687 @vindex gnus-fetch-old-headers
5688 If non-@code{nil}, gnus will attempt to build old threads by fetching
5689 more old headers---headers to articles marked as read.  If you
5690 would like to display as few summary lines as possible, but still
5691 connect as many loose threads as possible, you should set this variable
5692 to @code{some} or a number.  If you set it to a number, no more than
5693 that number of extra old headers will be fetched.  In either case,
5694 fetching old headers only works if the backend you are using carries
5695 overview files---this would normally be @code{nntp}, @code{nnspool} and
5696 @code{nnml}.  Also remember that if the root of the thread has been
5697 expired by the server, there's not much gnus can do about that.
5698
5699 This variable can also be set to @code{invisible}.  This won't have any
5700 visible effects, but is useful if you use the @kbd{A T} command a lot
5701 (@pxref{Finding the Parent}).
5702
5703 @item gnus-build-sparse-threads
5704 @vindex gnus-build-sparse-threads
5705 Fetching old headers can be slow.  A low-rent similar effect can be
5706 gotten by setting this variable to @code{some}.  Gnus will then look at
5707 the complete @code{References} headers of all articles and try to string
5708 together articles that belong in the same thread.  This will leave
5709 @dfn{gaps} in the threading display where gnus guesses that an article
5710 is missing from the thread.  (These gaps appear like normal summary
5711 lines.  If you select a gap, gnus will try to fetch the article in
5712 question.)  If this variable is @code{t}, gnus will display all these
5713 ``gaps'' without regard for whether they are useful for completing the
5714 thread or not.  Finally, if this variable is @code{more}, gnus won't cut
5715 off sparse leaf nodes that don't lead anywhere.  This variable is
5716 @code{nil} by default.
5717
5718 @end table
5719
5720
5721 @node More Threading
5722 @subsubsection More Threading
5723
5724 @table @code
5725 @item gnus-show-threads
5726 @vindex gnus-show-threads
5727 If this variable is @code{nil}, no threading will be done, and all of
5728 the rest of the variables here will have no effect.  Turning threading
5729 off will speed group selection up a bit, but it is sure to make reading
5730 slower and more awkward.
5731
5732 @item gnus-thread-hide-subtree
5733 @vindex gnus-thread-hide-subtree
5734 If non-@code{nil}, all threads will be hidden when the summary buffer is
5735 generated.
5736
5737 @item gnus-thread-expunge-below
5738 @vindex gnus-thread-expunge-below
5739 All threads that have a total score (as defined by
5740 @code{gnus-thread-score-function}) less than this number will be
5741 expunged.  This variable is @code{nil} by default, which means that no
5742 threads are expunged.
5743
5744 @item gnus-thread-hide-killed
5745 @vindex gnus-thread-hide-killed
5746 if you kill a thread and this variable is non-@code{nil}, the subtree
5747 will be hidden.
5748
5749 @item gnus-thread-ignore-subject
5750 @vindex gnus-thread-ignore-subject
5751 Sometimes somebody changes the subject in the middle of a thread.  If
5752 this variable is non-@code{nil}, the subject change is ignored.  If it
5753 is @code{nil}, which is the default, a change in the subject will result
5754 in a new thread.
5755
5756 @item gnus-thread-indent-level
5757 @vindex gnus-thread-indent-level
5758 This is a number that says how much each sub-thread should be indented.
5759 The default is 4.
5760
5761 @item gnus-sort-gathered-threads-function
5762 @vindex gnus-sort-gathered-threads-function
5763 Sometimes, particularly with mailing lists, the order in which mails
5764 arrive locally is not necessarily the same as the order in which they
5765 arrived on the mailing list.  Consequently, when sorting sub-threads
5766 using the default @code{gnus-thread-sort-by-number}, responses can end
5767 up appearing before the article to which they are responding to.
5768 Setting this variable to an alternate value
5769 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5770 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5771 more logical sub-thread ordering in such instances.
5772
5773 @end table
5774
5775
5776 @node Low-Level Threading
5777 @subsubsection Low-Level Threading
5778
5779 @table @code
5780
5781 @item gnus-parse-headers-hook
5782 @vindex gnus-parse-headers-hook
5783 Hook run before parsing any headers.  The default value is
5784 @code{(gnus-set-summary-default-charset)}, which sets up local value of
5785 @code{default-mime-charset} in summary buffer based on variable
5786 @code{gnus-newsgroup-default-charset-alist}.
5787
5788 @item gnus-alter-header-function
5789 @vindex gnus-alter-header-function
5790 If non-@code{nil}, this function will be called to allow alteration of
5791 article header structures.  The function is called with one parameter,
5792 the article header vector, which it may alter in any way.  For instance,
5793 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5794 in systematic ways (by adding prefixes and such), you can use this
5795 variable to un-scramble the @code{Message-ID}s so that they are more
5796 meaningful.  Here's one example:
5797
5798 @lisp
5799 (setq gnus-alter-header-function 'my-alter-message-id)
5800
5801 (defun my-alter-message-id (header)
5802   (let ((id (mail-header-id header)))
5803     (when (string-match
5804            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5805       (mail-header-set-id
5806        (concat (match-string 1 id) "@@" (match-string 2 id))
5807        header))))
5808 @end lisp
5809
5810 @end table
5811
5812
5813 @node Thread Commands
5814 @subsection Thread Commands
5815 @cindex thread commands
5816
5817 @table @kbd
5818
5819 @item T k
5820 @itemx M-C-k
5821 @kindex T k (Summary)
5822 @kindex M-C-k (Summary)
5823 @findex gnus-summary-kill-thread
5824 Mark all articles in the current (sub-)thread as read
5825 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
5826 remove all marks instead.  If the prefix argument is negative, tick
5827 articles instead.
5828
5829 @item T l
5830 @itemx M-C-l
5831 @kindex T l (Summary)
5832 @kindex M-C-l (Summary)
5833 @findex gnus-summary-lower-thread
5834 Lower the score of the current (sub-)thread
5835 (@code{gnus-summary-lower-thread}).
5836
5837 @item T i
5838 @kindex T i (Summary)
5839 @findex gnus-summary-raise-thread
5840 Increase the score of the current (sub-)thread
5841 (@code{gnus-summary-raise-thread}).
5842
5843 @item T #
5844 @kindex T # (Summary)
5845 @findex gnus-uu-mark-thread
5846 Set the process mark on the current (sub-)thread
5847 (@code{gnus-uu-mark-thread}).
5848
5849 @item T M-#
5850 @kindex T M-# (Summary)
5851 @findex gnus-uu-unmark-thread
5852 Remove the process mark from the current (sub-)thread
5853 (@code{gnus-uu-unmark-thread}).
5854
5855 @item T T
5856 @kindex T T (Summary)
5857 @findex gnus-summary-toggle-threads
5858 Toggle threading (@code{gnus-summary-toggle-threads}).
5859
5860 @item T s
5861 @kindex T s (Summary)
5862 @findex gnus-summary-show-thread
5863 Expose the (sub-)thread hidden under the current article, if any
5864 (@code{gnus-summary-show-thread}).
5865
5866 @item T h
5867 @kindex T h (Summary)
5868 @findex gnus-summary-hide-thread
5869 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5870
5871 @item T S
5872 @kindex T S (Summary)
5873 @findex gnus-summary-show-all-threads
5874 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5875
5876 @item T H
5877 @kindex T H (Summary)
5878 @findex gnus-summary-hide-all-threads
5879 Hide all threads (@code{gnus-summary-hide-all-threads}).
5880
5881 @item T t
5882 @kindex T t (Summary)
5883 @findex gnus-summary-rethread-current
5884 Re-thread the current article's thread
5885 (@code{gnus-summary-rethread-current}).  This works even when the
5886 summary buffer is otherwise unthreaded.
5887
5888 @item T ^
5889 @kindex T ^ (Summary)
5890 @findex gnus-summary-reparent-thread
5891 Make the current article the child of the marked (or previous) article
5892 (@code{gnus-summary-reparent-thread}).
5893
5894 @end table
5895
5896 The following commands are thread movement commands.  They all
5897 understand the numeric prefix.
5898
5899 @table @kbd
5900
5901 @item T n
5902 @kindex T n (Summary)
5903 @itemx M-C-n
5904 @kindex M-C-n (Summary)
5905 @itemx M-down
5906 @kindex M-down (Summary)
5907 @findex gnus-summary-next-thread
5908 Go to the next thread (@code{gnus-summary-next-thread}).
5909
5910 @item T p
5911 @kindex T p (Summary)
5912 @itemx M-C-p
5913 @kindex M-C-p (Summary)
5914 @itemx M-up
5915 @kindex M-up (Summary)
5916 @findex gnus-summary-prev-thread
5917 Go to the previous thread (@code{gnus-summary-prev-thread}).
5918
5919 @item T d
5920 @kindex T d (Summary)
5921 @findex gnus-summary-down-thread
5922 Descend the thread (@code{gnus-summary-down-thread}).
5923
5924 @item T u
5925 @kindex T u (Summary)
5926 @findex gnus-summary-up-thread
5927 Ascend the thread (@code{gnus-summary-up-thread}).
5928
5929 @item T o
5930 @kindex T o (Summary)
5931 @findex gnus-summary-top-thread
5932 Go to the top of the thread (@code{gnus-summary-top-thread}).
5933 @end table
5934
5935 @vindex gnus-thread-operation-ignore-subject
5936 If you ignore subject while threading, you'll naturally end up with
5937 threads that have several different subjects in them.  If you then issue
5938 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5939 wish to kill the entire thread, but just those parts of the thread that
5940 have the same subject as the current article.  If you like this idea,
5941 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
5942 is non-@code{nil} (which it is by default), subjects will be ignored
5943 when doing thread commands.  If this variable is @code{nil}, articles in
5944 the same thread with different subjects will not be included in the
5945 operation in question.  If this variable is @code{fuzzy}, only articles
5946 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5947 Matching}).
5948
5949
5950 @node Sorting
5951 @section Sorting
5952
5953 @findex gnus-thread-sort-by-total-score
5954 @findex gnus-thread-sort-by-date
5955 @findex gnus-thread-sort-by-score
5956 @findex gnus-thread-sort-by-subject
5957 @findex gnus-thread-sort-by-author
5958 @findex gnus-thread-sort-by-number
5959 @vindex gnus-thread-sort-functions
5960 If you are using a threaded summary display, you can sort the threads by
5961 setting @code{gnus-thread-sort-functions}, which can be either a single
5962 function, a list of functions, or a list containing functions and
5963 @code{(not some-function)} elements.
5964
5965 By default, sorting is done on article numbers.  Ready-made sorting
5966 predicate functions include @code{gnus-thread-sort-by-number},
5967 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5968 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5969 @code{gnus-thread-sort-by-total-score}.
5970
5971 Each function takes two threads and returns non-@code{nil} if the first
5972 thread should be sorted before the other.  Note that sorting really is
5973 normally done by looking only at the roots of each thread.
5974
5975 If you use more than one function, the primary sort key should be the
5976 last function in the list.  You should probably always include
5977 @code{gnus-thread-sort-by-number} in the list of sorting
5978 functions---preferably first.  This will ensure that threads that are
5979 equal with respect to the other sort criteria will be displayed in
5980 ascending article order.
5981
5982 If you would like to sort by reverse score, then by subject, and finally
5983 by number, you could do something like:
5984
5985 @lisp
5986 (setq gnus-thread-sort-functions
5987       '(gnus-thread-sort-by-number
5988         gnus-thread-sort-by-subject
5989         (not gnus-thread-sort-by-total-score)))
5990 @end lisp
5991
5992 The threads that have highest score will be displayed first in the
5993 summary buffer.  When threads have the same score, they will be sorted
5994 alphabetically.  The threads that have the same score and the same
5995 subject will be sorted by number, which is (normally) the sequence in
5996 which the articles arrived.
5997
5998 If you want to sort by score and then reverse arrival order, you could
5999 say something like:
6000
6001 @lisp
6002 (setq gnus-thread-sort-functions
6003       '((lambda (t1 t2)
6004           (not (gnus-thread-sort-by-number t1 t2)))
6005         gnus-thread-sort-by-score))
6006 @end lisp
6007
6008 @vindex gnus-thread-score-function
6009 The function in the @code{gnus-thread-score-function} variable (default
6010 @code{+}) is used for calculating the total score of a thread.  Useful
6011 functions might be @code{max}, @code{min}, or squared means, or whatever
6012 tickles your fancy.
6013
6014 @findex gnus-article-sort-functions
6015 @findex gnus-article-sort-by-date
6016 @findex gnus-article-sort-by-score
6017 @findex gnus-article-sort-by-subject
6018 @findex gnus-article-sort-by-author
6019 @findex gnus-article-sort-by-number
6020 If you are using an unthreaded display for some strange reason or other,
6021 you have to fiddle with the @code{gnus-article-sort-functions} variable.
6022 It is very similar to the @code{gnus-thread-sort-functions}, except that
6023 it uses slightly different functions for article comparison.  Available
6024 sorting predicate functions are @code{gnus-article-sort-by-number},
6025 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
6026 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
6027
6028 If you want to sort an unthreaded summary display by subject, you could
6029 say something like:
6030
6031 @lisp
6032 (setq gnus-article-sort-functions
6033       '(gnus-article-sort-by-number
6034         gnus-article-sort-by-subject))
6035 @end lisp
6036
6037
6038
6039 @node Asynchronous Fetching
6040 @section Asynchronous Article Fetching
6041 @cindex asynchronous article fetching
6042 @cindex article pre-fetch
6043 @cindex pre-fetch
6044
6045 If you read your news from an @sc{nntp} server that's far away, the
6046 network latencies may make reading articles a chore.  You have to wait
6047 for a while after pressing @kbd{n} to go to the next article before the
6048 article appears.  Why can't gnus just go ahead and fetch the article
6049 while you are reading the previous one?  Why not, indeed.
6050
6051 First, some caveats.  There are some pitfalls to using asynchronous
6052 article fetching, especially the way gnus does it.
6053
6054 Let's say you are reading article 1, which is short, and article 2 is
6055 quite long, and you are not interested in reading that.  Gnus does not
6056 know this, so it goes ahead and fetches article 2.  You decide to read
6057 article 3, but since gnus is in the process of fetching article 2, the
6058 connection is blocked.
6059
6060 To avoid these situations, gnus will open two (count 'em two)
6061 connections to the server.  Some people may think this isn't a very nice
6062 thing to do, but I don't see any real alternatives.  Setting up that
6063 extra connection takes some time, so gnus startup will be slower.
6064
6065 Gnus will fetch more articles than you will read.  This will mean that
6066 the link between your machine and the @sc{nntp} server will become more
6067 loaded than if you didn't use article pre-fetch.  The server itself will
6068 also become more loaded---both with the extra article requests, and the
6069 extra connection.
6070
6071 Ok, so now you know that you shouldn't really use this thing...  unless
6072 you really want to.
6073
6074 @vindex gnus-asynchronous
6075 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
6076 happen automatically.
6077
6078 @vindex gnus-use-article-prefetch
6079 You can control how many articles are to be pre-fetched by setting
6080 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
6081 that when you read an article in the group, the backend will pre-fetch
6082 the next 30 articles.  If this variable is @code{t}, the backend will
6083 pre-fetch all the articles it can without bound.  If it is
6084 @code{nil}, no pre-fetching will be done.
6085
6086 @vindex gnus-async-prefetch-article-p
6087 @findex gnus-async-read-p
6088 There are probably some articles that you don't want to pre-fetch---read
6089 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
6090 return non-@code{nil} when the article in question is to be
6091 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
6092 @code{nil} on read articles.  The function is called with an article
6093 data structure as the only parameter.
6094
6095 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
6096
6097 @lisp
6098 (defun my-async-short-unread-p (data)
6099   "Return non-nil for short, unread articles."
6100   (and (gnus-data-unread-p data)
6101        (< (mail-header-lines (gnus-data-header data))
6102           100)))
6103
6104 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
6105 @end lisp
6106
6107 These functions will be called many, many times, so they should
6108 preferably be short and sweet to avoid slowing down gnus too much.
6109 It's probably a good idea to byte-compile things like this.
6110
6111 @vindex gnus-prefetched-article-deletion-strategy
6112 Articles have to be removed from the asynch buffer sooner or later.  The
6113 @code{gnus-prefetched-article-deletion-strategy} says when to remove
6114 articles.  This is a list that may contain the following elements:
6115
6116 @table @code
6117 @item read
6118 Remove articles when they are read.
6119
6120 @item exit
6121 Remove articles when exiting the group.
6122 @end table
6123
6124 The default value is @code{(read exit)}.
6125
6126 @c @vindex gnus-use-header-prefetch
6127 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
6128 @c from the next group.
6129
6130
6131 @node Article Caching
6132 @section Article Caching
6133 @cindex article caching
6134 @cindex caching
6135
6136 If you have an @emph{extremely} slow @sc{nntp} connection, you may
6137 consider turning article caching on.  Each article will then be stored
6138 locally under your home directory.  As you may surmise, this could
6139 potentially use @emph{huge} amounts of disk space, as well as eat up all
6140 your inodes so fast it will make your head swim.  In vodka.
6141
6142 Used carefully, though, it could be just an easier way to save articles.
6143
6144 @vindex gnus-use-long-file-name
6145 @vindex gnus-cache-directory
6146 @vindex gnus-use-cache
6147 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
6148 all articles ticked or marked as dormant will then be copied
6149 over to your local cache (@code{gnus-cache-directory}).  Whether this
6150 cache is flat or hierarchal is controlled by the
6151 @code{gnus-use-long-file-name} variable, as usual.
6152
6153 When re-selecting a ticked or dormant article, it will be fetched from the
6154 cache instead of from the server.  As articles in your cache will never
6155 expire, this might serve as a method of saving articles while still
6156 keeping them where they belong.  Just mark all articles you want to save
6157 as dormant, and don't worry.
6158
6159 When an article is marked as read, is it removed from the cache.
6160
6161 @vindex gnus-cache-remove-articles
6162 @vindex gnus-cache-enter-articles
6163 The entering/removal of articles from the cache is controlled by the
6164 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
6165 variables.  Both are lists of symbols.  The first is @code{(ticked
6166 dormant)} by default, meaning that ticked and dormant articles will be
6167 put in the cache.  The latter is @code{(read)} by default, meaning that
6168 articles marked as read are removed from the cache.  Possibly
6169 symbols in these two lists are @code{ticked}, @code{dormant},
6170 @code{unread} and @code{read}.
6171
6172 @findex gnus-jog-cache
6173 So where does the massive article-fetching and storing come into the
6174 picture?  The @code{gnus-jog-cache} command will go through all
6175 subscribed newsgroups, request all unread articles, score them, and
6176 store them in the cache.  You should only ever, ever ever ever, use this
6177 command if 1) your connection to the @sc{nntp} server is really, really,
6178 really slow and 2) you have a really, really, really huge disk.
6179 Seriously.  One way to cut down on the number of articles downloaded is
6180 to score unwanted articles down and have them marked as read.  They will
6181 not then be downloaded by this command.
6182
6183 @vindex gnus-uncacheable-groups
6184 @vindex gnus-cacheable-groups
6185 It is likely that you do not want caching on all groups.  For instance,
6186 if your @code{nnml} mail is located under your home directory, it makes no
6187 sense to cache it somewhere else under your home directory.  Unless you
6188 feel that it's neat to use twice as much space.
6189
6190 To limit the caching, you could set @code{gnus-cacheable-groups} to a
6191 regexp of groups to cache, @samp{^nntp} for instance, or set the
6192 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
6193 Both variables are @code{nil} by default.  If a group matches both
6194 variables, the group is not cached.
6195
6196 @findex gnus-cache-generate-nov-databases
6197 @findex gnus-cache-generate-active
6198 @vindex gnus-cache-active-file
6199 The cache stores information on what articles it contains in its active
6200 file (@code{gnus-cache-active-file}).  If this file (or any other parts
6201 of the cache) becomes all messed up for some reason or other, gnus
6202 offers two functions that will try to set things right.  @kbd{M-x
6203 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
6204 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
6205 file.
6206
6207
6208 @node Persistent Articles
6209 @section Persistent Articles
6210 @cindex persistent articles
6211
6212 Closely related to article caching, we have @dfn{persistent articles}.
6213 In fact, it's just a different way of looking at caching, and much more
6214 useful in my opinion.
6215
6216 Say you're reading a newsgroup, and you happen on to some valuable gem
6217 that you want to keep and treasure forever.  You'd normally just save it
6218 (using one of the many saving commands) in some file.  The problem with
6219 that is that it's just, well, yucky.  Ideally you'd prefer just having
6220 the article remain in the group where you found it forever; untouched by
6221 the expiry going on at the news server.
6222
6223 This is what a @dfn{persistent article} is---an article that just won't
6224 be deleted.  It's implemented using the normal cache functions, but
6225 you use two explicit commands for managing persistent articles:
6226
6227 @table @kbd
6228
6229 @item *
6230 @kindex * (Summary)
6231 @findex gnus-cache-enter-article
6232 Make the current article persistent (@code{gnus-cache-enter-article}).
6233
6234 @item M-*
6235 @kindex M-* (Summary)
6236 @findex gnus-cache-remove-article
6237 Remove the current article from the persistent articles
6238 (@code{gnus-cache-remove-article}).  This will normally delete the
6239 article.
6240 @end table
6241
6242 Both these commands understand the process/prefix convention.
6243
6244 To avoid having all ticked articles (and stuff) entered into the cache,
6245 you should set @code{gnus-use-cache} to @code{passive} if you're just
6246 interested in persistent articles:
6247
6248 @lisp
6249 (setq gnus-use-cache 'passive)
6250 @end lisp
6251
6252
6253 @node Article Backlog
6254 @section Article Backlog
6255 @cindex backlog
6256 @cindex article backlog
6257
6258 If you have a slow connection, but the idea of using caching seems
6259 unappealing to you (and it is, really), you can help the situation some
6260 by switching on the @dfn{backlog}.  This is where gnus will buffer
6261 already read articles so that it doesn't have to re-fetch articles
6262 you've already read.  This only helps if you are in the habit of
6263 re-selecting articles you've recently read, of course.  If you never do
6264 that, turning the backlog on will slow gnus down a little bit, and
6265 increase memory usage some.
6266
6267 @vindex gnus-keep-backlog
6268 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
6269 at most @var{n} old articles in a buffer for later re-fetching.  If this
6270 variable is non-@code{nil} and is not a number, gnus will store
6271 @emph{all} read articles, which means that your Emacs will grow without
6272 bound before exploding and taking your machine down with you.  I put
6273 that in there just to keep y'all on your toes.
6274
6275 This variable is @code{nil} by default.
6276
6277
6278 @node Saving Articles
6279 @section Saving Articles
6280 @cindex saving articles
6281
6282 Gnus can save articles in a number of ways.  Below is the documentation
6283 for saving articles in a fairly straight-forward fashion (i.e., little
6284 processing of the article is done before it is saved).  For a different
6285 approach (uudecoding, unsharing) you should use @code{gnus-uu}
6286 (@pxref{Decoding Articles}).
6287
6288 @vindex gnus-save-all-headers
6289 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
6290 unwanted headers before saving the article.
6291
6292 @vindex gnus-saved-headers
6293 If the preceding variable is @code{nil}, all headers that match the
6294 @code{gnus-saved-headers} regexp will be kept, while the rest will be
6295 deleted before saving.
6296
6297 @table @kbd
6298
6299 @item O o
6300 @itemx o
6301 @kindex O o (Summary)
6302 @kindex o (Summary)
6303 @findex gnus-summary-save-article
6304 @c @icon{gnus-summary-save-article}
6305 Save the current article using the default article saver
6306 (@code{gnus-summary-save-article}).
6307
6308 @item O m
6309 @kindex O m (Summary)
6310 @findex gnus-summary-save-article-mail
6311 Save the current article in mail format
6312 (@code{gnus-summary-save-article-mail}).
6313
6314 @item O r
6315 @kindex O r (Summary)
6316 @findex gnus-summary-save-article-rmail
6317 Save the current article in rmail format
6318 (@code{gnus-summary-save-article-rmail}).
6319
6320 @item O f
6321 @kindex O f (Summary)
6322 @findex gnus-summary-save-article-file
6323 @c @icon{gnus-summary-save-article-file}
6324 Save the current article in plain file format
6325 (@code{gnus-summary-save-article-file}).
6326
6327 @item O F
6328 @kindex O F (Summary)
6329 @findex gnus-summary-write-article-file
6330 Write the current article in plain file format, overwriting any previous
6331 file contents (@code{gnus-summary-write-article-file}).
6332
6333 @item O b
6334 @kindex O b (Summary)
6335 @findex gnus-summary-save-article-body-file
6336 Save the current article body in plain file format
6337 (@code{gnus-summary-save-article-body-file}).
6338
6339 @item O h
6340 @kindex O h (Summary)
6341 @findex gnus-summary-save-article-folder
6342 Save the current article in mh folder format
6343 (@code{gnus-summary-save-article-folder}).
6344
6345 @item O v
6346 @kindex O v (Summary)
6347 @findex gnus-summary-save-article-vm
6348 Save the current article in a VM folder
6349 (@code{gnus-summary-save-article-vm}).
6350
6351 @item O p
6352 @kindex O p (Summary)
6353 @findex gnus-summary-pipe-output
6354 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
6355 the current article to a process (@code{gnus-summary-pipe-output}).
6356 @end table
6357
6358 @vindex gnus-prompt-before-saving
6359 All these commands use the process/prefix convention
6360 (@pxref{Process/Prefix}).  If you save bunches of articles using these
6361 functions, you might get tired of being prompted for files to save each
6362 and every article in.  The prompting action is controlled by
6363 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
6364 default, giving you that excessive prompting action you know and
6365 loathe.  If you set this variable to @code{t} instead, you'll be prompted
6366 just once for each series of articles you save.  If you like to really
6367 have Gnus do all your thinking for you, you can even set this variable
6368 to @code{nil}, which means that you will never be prompted for files to
6369 save articles in.  Gnus will simply save all the articles in the default
6370 files.
6371
6372
6373 @vindex gnus-default-article-saver
6374 You can customize the @code{gnus-default-article-saver} variable to make
6375 gnus do what you want it to.  You can use any of the six ready-made
6376 functions below, or you can create your own.
6377
6378 @table @code
6379
6380 @item gnus-summary-save-in-rmail
6381 @findex gnus-summary-save-in-rmail
6382 @vindex gnus-rmail-save-name
6383 @findex gnus-plain-save-name
6384 This is the default format, @dfn{babyl}.  Uses the function in the
6385 @code{gnus-rmail-save-name} variable to get a file name to save the
6386 article in.  The default is @code{gnus-plain-save-name}.
6387
6388 @item gnus-summary-save-in-mail
6389 @findex gnus-summary-save-in-mail
6390 @vindex gnus-mail-save-name
6391 Save in a Unix mail (mbox) file.  Uses the function in the
6392 @code{gnus-mail-save-name} variable to get a file name to save the
6393 article in.  The default is @code{gnus-plain-save-name}.
6394
6395 @item gnus-summary-save-in-file
6396 @findex gnus-summary-save-in-file
6397 @vindex gnus-file-save-name
6398 @findex gnus-numeric-save-name
6399 Append the article straight to an ordinary file.  Uses the function in
6400 the @code{gnus-file-save-name} variable to get a file name to save the
6401 article in.  The default is @code{gnus-numeric-save-name}.
6402
6403 @item gnus-summary-save-body-in-file
6404 @findex gnus-summary-save-body-in-file
6405 Append the article body to an ordinary file.  Uses the function in the
6406 @code{gnus-file-save-name} variable to get a file name to save the
6407 article in.  The default is @code{gnus-numeric-save-name}.
6408
6409 @item gnus-summary-save-in-folder
6410 @findex gnus-summary-save-in-folder
6411 @findex gnus-folder-save-name
6412 @findex gnus-Folder-save-name
6413 @vindex gnus-folder-save-name
6414 @cindex rcvstore
6415 @cindex MH folders
6416 Save the article to an MH folder using @code{rcvstore} from the MH
6417 library.  Uses the function in the @code{gnus-folder-save-name} variable
6418 to get a file name to save the article in.  The default is
6419 @code{gnus-folder-save-name}, but you can also use
6420 @code{gnus-Folder-save-name}, which creates capitalized names.
6421
6422 @item gnus-summary-save-in-vm
6423 @findex gnus-summary-save-in-vm
6424 Save the article in a VM folder.  You have to have the VM mail
6425 reader to use this setting.
6426 @end table
6427
6428 @vindex gnus-article-save-directory
6429 All of these functions, except for the last one, will save the article
6430 in the @code{gnus-article-save-directory}, which is initialized from the
6431 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
6432 default.
6433
6434 As you can see above, the functions use different functions to find a
6435 suitable name of a file to save the article in.  Below is a list of
6436 available functions that generate names:
6437
6438 @table @code
6439
6440 @item gnus-Numeric-save-name
6441 @findex gnus-Numeric-save-name
6442 File names like @file{~/News/Alt.andrea-dworkin/45}.
6443
6444 @item gnus-numeric-save-name
6445 @findex gnus-numeric-save-name
6446 File names like @file{~/News/alt.andrea-dworkin/45}.
6447
6448 @item gnus-Plain-save-name
6449 @findex gnus-Plain-save-name
6450 File names like @file{~/News/Alt.andrea-dworkin}.
6451
6452 @item gnus-plain-save-name
6453 @findex gnus-plain-save-name
6454 File names like @file{~/News/alt.andrea-dworkin}.
6455 @end table
6456
6457 @vindex gnus-split-methods
6458 You can have gnus suggest where to save articles by plonking a regexp into
6459 the @code{gnus-split-methods} alist.  For instance, if you would like to
6460 save articles related to gnus in the file @file{gnus-stuff}, and articles
6461 related to VM in @code{vm-stuff}, you could set this variable to something
6462 like:
6463
6464 @lisp
6465 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
6466  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
6467  (my-choosing-function "../other-dir/my-stuff")
6468  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
6469 @end lisp
6470
6471 We see that this is a list where each element is a list that has two
6472 elements---the @dfn{match} and the @dfn{file}.  The match can either be
6473 a string (in which case it is used as a regexp to match on the article
6474 head); it can be a symbol (which will be called as a function with the
6475 group name as a parameter); or it can be a list (which will be
6476 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
6477 the @dfn{file} will be used as a default prompt.  In addition, the
6478 result of the operation itself will be used if the function or form
6479 called returns a string or a list of strings.
6480
6481 You basically end up with a list of file names that might be used when
6482 saving the current article.  (All ``matches'' will be used.)  You will
6483 then be prompted for what you really want to use as a name, with file
6484 name completion over the results from applying this variable.
6485
6486 This variable is @code{((gnus-article-archive-name))} by default, which
6487 means that gnus will look at the articles it saves for an
6488 @code{Archive-name} line and use that as a suggestion for the file
6489 name.
6490
6491 Here's an example function to clean up file names somewhat.  If you have
6492 lots of mail groups called things like
6493 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
6494 these group names before creating the file name to save to.  The
6495 following will do just that:
6496
6497 @lisp
6498 (defun my-save-name (group)
6499   (when (string-match "^nnml:mail." group)
6500     (substring group (match-end 0))))
6501
6502 (setq gnus-split-methods
6503       '((gnus-article-archive-name)
6504         (my-save-name)))
6505 @end lisp
6506
6507
6508 @vindex gnus-use-long-file-name
6509 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
6510 @code{nil}, all the preceding functions will replace all periods
6511 (@samp{.}) in the group names with slashes (@samp{/})---which means that
6512 the functions will generate hierarchies of directories instead of having
6513 all the files in the top level directory
6514 (@file{~/News/alt/andrea-dworkin} instead of
6515 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
6516 on most systems.  However, for historical reasons, this is @code{nil} on
6517 Xenix and usg-unix-v machines by default.
6518
6519 This function also affects kill and score file names.  If this variable
6520 is a list, and the list contains the element @code{not-score}, long file
6521 names will not be used for score files, if it contains the element
6522 @code{not-save}, long file names will not be used for saving, and if it
6523 contains the element @code{not-kill}, long file names will not be used
6524 for kill files.
6525
6526 If you'd like to save articles in a hierarchy that looks something like
6527 a spool, you could
6528
6529 @lisp
6530 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
6531 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
6532 @end lisp
6533
6534 Then just save with @kbd{o}.  You'd then read this hierarchy with
6535 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
6536 the top level directory as the argument (@file{~/News/}).  Then just walk
6537 around to the groups/directories with @code{nneething}.
6538
6539
6540 @node Decoding Articles
6541 @section Decoding Articles
6542 @cindex decoding articles
6543
6544 Sometime users post articles (or series of articles) that have been
6545 encoded in some way or other.  Gnus can decode them for you.
6546
6547 @menu
6548 * Uuencoded Articles::    Uudecode articles.
6549 * Shell Archives::        Unshar articles.
6550 * PostScript Files::      Split PostScript.
6551 * Other Files::           Plain save and binhex.
6552 * Decoding Variables::    Variables for a happy decoding.
6553 * Viewing Files::         You want to look at the result of the decoding?
6554 @end menu
6555
6556 @cindex series
6557 @cindex article series
6558 All these functions use the process/prefix convention
6559 (@pxref{Process/Prefix}) for finding out what articles to work on, with
6560 the extension that a ``single article'' means ``a single series''.  Gnus
6561 can find out by itself what articles belong to a series, decode all the
6562 articles and unpack/view/save the resulting file(s).
6563
6564 Gnus guesses what articles are in the series according to the following
6565 simplish rule: The subjects must be (nearly) identical, except for the
6566 last two numbers of the line.  (Spaces are largely ignored, however.)
6567
6568 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
6569 will find all the articles that match the regexp @samp{^cat.gif
6570 ([0-9]+/[0-9]+).*$}.
6571
6572 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
6573 series}, will not be properly recognized by any of the automatic viewing
6574 commands, and you have to mark the articles manually with @kbd{#}.
6575
6576
6577 @node Uuencoded Articles
6578 @subsection Uuencoded Articles
6579 @cindex uudecode
6580 @cindex uuencoded articles
6581
6582 @table @kbd
6583
6584 @item X u
6585 @kindex X u (Summary)
6586 @findex gnus-uu-decode-uu
6587 @c @icon{gnus-uu-decode-uu}
6588 Uudecodes the current series (@code{gnus-uu-decode-uu}).
6589
6590 @item X U
6591 @kindex X U (Summary)
6592 @findex gnus-uu-decode-uu-and-save
6593 Uudecodes and saves the current series
6594 (@code{gnus-uu-decode-uu-and-save}).
6595
6596 @item X v u
6597 @kindex X v u (Summary)
6598 @findex gnus-uu-decode-uu-view
6599 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
6600
6601 @item X v U
6602 @kindex X v U (Summary)
6603 @findex gnus-uu-decode-uu-and-save-view
6604 Uudecodes, views and saves the current series
6605 (@code{gnus-uu-decode-uu-and-save-view}).
6606
6607 @end table
6608
6609 Remember that these all react to the presence of articles marked with
6610 the process mark.  If, for instance, you'd like to decode and save an
6611 entire newsgroup, you'd typically do @kbd{M P a}
6612 (@code{gnus-uu-mark-all}) and then @kbd{X U}
6613 (@code{gnus-uu-decode-uu-and-save}).
6614
6615 All this is very much different from how @code{gnus-uu} worked with
6616 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
6617 the sun.  This version of @code{gnus-uu} generally assumes that you mark
6618 articles in some way (@pxref{Setting Process Marks}) and then press
6619 @kbd{X u}.
6620
6621 @vindex gnus-uu-notify-files
6622 Note: When trying to decode articles that have names matching
6623 @code{gnus-uu-notify-files}, which is hard-coded to
6624 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
6625 automatically post an article on @samp{comp.unix.wizards} saying that
6626 you have just viewed the file in question.  This feature can't be turned
6627 off.
6628
6629
6630 @node Shell Archives
6631 @subsection Shell Archives
6632 @cindex unshar
6633 @cindex shell archives
6634 @cindex shared articles
6635
6636 Shell archives (``shar files'') used to be a popular way to distribute
6637 sources, but it isn't used all that much today.  In any case, we have
6638 some commands to deal with these:
6639
6640 @table @kbd
6641
6642 @item X s
6643 @kindex X s (Summary)
6644 @findex gnus-uu-decode-unshar
6645 Unshars the current series (@code{gnus-uu-decode-unshar}).
6646
6647 @item X S
6648 @kindex X S (Summary)
6649 @findex gnus-uu-decode-unshar-and-save
6650 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6651
6652 @item X v s
6653 @kindex X v s (Summary)
6654 @findex gnus-uu-decode-unshar-view
6655 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6656
6657 @item X v S
6658 @kindex X v S (Summary)
6659 @findex gnus-uu-decode-unshar-and-save-view
6660 Unshars, views and saves the current series
6661 (@code{gnus-uu-decode-unshar-and-save-view}).
6662 @end table
6663
6664
6665 @node PostScript Files
6666 @subsection PostScript Files
6667 @cindex PostScript
6668
6669 @table @kbd
6670
6671 @item X p
6672 @kindex X p (Summary)
6673 @findex gnus-uu-decode-postscript
6674 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6675
6676 @item X P
6677 @kindex X P (Summary)
6678 @findex gnus-uu-decode-postscript-and-save
6679 Unpack and save the current PostScript series
6680 (@code{gnus-uu-decode-postscript-and-save}).
6681
6682 @item X v p
6683 @kindex X v p (Summary)
6684 @findex gnus-uu-decode-postscript-view
6685 View the current PostScript series
6686 (@code{gnus-uu-decode-postscript-view}).
6687
6688 @item X v P
6689 @kindex X v P (Summary)
6690 @findex gnus-uu-decode-postscript-and-save-view
6691 View and save the current PostScript series
6692 (@code{gnus-uu-decode-postscript-and-save-view}).
6693 @end table
6694
6695
6696 @node Other Files
6697 @subsection Other Files
6698
6699 @table @kbd
6700 @item X o
6701 @kindex X o (Summary)
6702 @findex gnus-uu-decode-save
6703 Save the current series
6704 (@code{gnus-uu-decode-save}).
6705
6706 @item X b
6707 @kindex X b (Summary)
6708 @findex gnus-uu-decode-binhex
6709 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
6710 doesn't really work yet.
6711 @end table
6712
6713
6714 @node Decoding Variables
6715 @subsection Decoding Variables
6716
6717 Adjective, not verb.
6718
6719 @menu
6720 * Rule Variables::          Variables that say how a file is to be viewed.
6721 * Other Decode Variables::  Other decode variables.
6722 * Uuencoding and Posting::  Variables for customizing uuencoding.
6723 @end menu
6724
6725
6726 @node Rule Variables
6727 @subsubsection Rule Variables
6728 @cindex rule variables
6729
6730 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
6731 variables are of the form
6732
6733 @lisp
6734       (list '(regexp1 command2)
6735             '(regexp2 command2)
6736             ...)
6737 @end lisp
6738
6739 @table @code
6740
6741 @item gnus-uu-user-view-rules
6742 @vindex gnus-uu-user-view-rules
6743 @cindex sox
6744 This variable is consulted first when viewing files.  If you wish to use,
6745 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6746 say something like:
6747 @lisp
6748 (setq gnus-uu-user-view-rules
6749       (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6750 @end lisp
6751
6752 @item gnus-uu-user-view-rules-end
6753 @vindex gnus-uu-user-view-rules-end
6754 This variable is consulted if gnus couldn't make any matches from the
6755 user and default view rules.
6756
6757 @item gnus-uu-user-archive-rules
6758 @vindex gnus-uu-user-archive-rules
6759 This variable can be used to say what commands should be used to unpack
6760 archives.
6761 @end table
6762
6763
6764 @node Other Decode Variables
6765 @subsubsection Other Decode Variables
6766
6767 @table @code
6768 @vindex gnus-uu-grabbed-file-functions
6769
6770 @item gnus-uu-grabbed-file-functions
6771 All functions in this list will be called right after each file has been
6772 successfully decoded---so that you can move or view files right away,
6773 and don't have to wait for all files to be decoded before you can do
6774 anything.  Ready-made functions you can put in this list are:
6775
6776 @table @code
6777
6778 @item gnus-uu-grab-view
6779 @findex gnus-uu-grab-view
6780 View the file.
6781
6782 @item gnus-uu-grab-move
6783 @findex gnus-uu-grab-move
6784 Move the file (if you're using a saving function.)
6785 @end table
6786
6787 @item gnus-uu-be-dangerous
6788 @vindex gnus-uu-be-dangerous
6789 Specifies what to do if unusual situations arise during decoding.  If
6790 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
6791 that didn't work, and overwrite existing files.  Otherwise, ask each
6792 time.
6793
6794 @item gnus-uu-ignore-files-by-name
6795 @vindex gnus-uu-ignore-files-by-name
6796 Files with name matching this regular expression won't be viewed.
6797
6798 @item gnus-uu-ignore-files-by-type
6799 @vindex gnus-uu-ignore-files-by-type
6800 Files with a @sc{mime} type matching this variable won't be viewed.
6801 Note that Gnus tries to guess what type the file is based on the name.
6802 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6803 kludgey.
6804
6805 @item gnus-uu-tmp-dir
6806 @vindex gnus-uu-tmp-dir
6807 Where @code{gnus-uu} does its work.
6808
6809 @item gnus-uu-do-not-unpack-archives
6810 @vindex gnus-uu-do-not-unpack-archives
6811 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6812 looking for files to display.
6813
6814 @item gnus-uu-view-and-save
6815 @vindex gnus-uu-view-and-save
6816 Non-@code{nil} means that the user will always be asked to save a file
6817 after viewing it.
6818
6819 @item gnus-uu-ignore-default-view-rules
6820 @vindex gnus-uu-ignore-default-view-rules
6821 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6822 rules.
6823
6824 @item gnus-uu-ignore-default-archive-rules
6825 @vindex gnus-uu-ignore-default-archive-rules
6826 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6827 unpacking commands.
6828
6829 @item gnus-uu-kill-carriage-return
6830 @vindex gnus-uu-kill-carriage-return
6831 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6832 from articles.
6833
6834 @item gnus-uu-unmark-articles-not-decoded
6835 @vindex gnus-uu-unmark-articles-not-decoded
6836 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6837 decoded articles as unread.
6838
6839 @item gnus-uu-correct-stripped-uucode
6840 @vindex gnus-uu-correct-stripped-uucode
6841 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6842 uuencoded files that have had trailing spaces deleted.
6843
6844 @item gnus-uu-pre-uudecode-hook
6845 @vindex gnus-uu-pre-uudecode-hook
6846 Hook run before sending a message to @code{uudecode}.
6847
6848 @item gnus-uu-view-with-metamail
6849 @vindex gnus-uu-view-with-metamail
6850 @cindex metamail
6851 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6852 commands defined by the rule variables and just fudge a @sc{mime}
6853 content type based on the file name.  The result will be fed to
6854 @code{metamail} for viewing.
6855
6856 @item gnus-uu-save-in-digest
6857 @vindex gnus-uu-save-in-digest
6858 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6859 decoding, will save in digests.  If this variable is @code{nil},
6860 @code{gnus-uu} will just save everything in a file without any
6861 embellishments.  The digesting almost conforms to RFC 1153---no easy way
6862 to specify any meaningful volume and issue numbers were found, so I
6863 simply dropped them.
6864
6865 @end table
6866
6867
6868 @node Uuencoding and Posting
6869 @subsubsection Uuencoding and Posting
6870
6871 @table @code
6872
6873 @item gnus-uu-post-include-before-composing
6874 @vindex gnus-uu-post-include-before-composing
6875 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6876 before you compose the article.  If this variable is @code{t}, you can
6877 either include an encoded file with @kbd{C-c C-i} or have one included
6878 for you when you post the article.
6879
6880 @item gnus-uu-post-length
6881 @vindex gnus-uu-post-length
6882 Maximum length of an article.  The encoded file will be split into how
6883 many articles it takes to post the entire file.
6884
6885 @item gnus-uu-post-threaded
6886 @vindex gnus-uu-post-threaded
6887 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6888 thread.  This may not be smart, as no other decoder I have seen is able
6889 to follow threads when collecting uuencoded articles.  (Well, I have
6890 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6891 think that counts...) Default is @code{nil}.
6892
6893 @item gnus-uu-post-separate-description
6894 @vindex gnus-uu-post-separate-description
6895 Non-@code{nil} means that the description will be posted in a separate
6896 article.  The first article will typically be numbered (0/x).  If this
6897 variable is @code{nil}, the description the user enters will be included
6898 at the beginning of the first article, which will be numbered (1/x).
6899 Default is @code{t}.
6900
6901 @end table
6902
6903
6904 @node Viewing Files
6905 @subsection Viewing Files
6906 @cindex viewing files
6907 @cindex pseudo-articles
6908
6909 After decoding, if the file is some sort of archive, gnus will attempt
6910 to unpack the archive and see if any of the files in the archive can be
6911 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
6912 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
6913 uncompress and de-tar the main file, and then view the two pictures.
6914 This unpacking process is recursive, so if the archive contains archives
6915 of archives, it'll all be unpacked.
6916
6917 Finally, gnus will normally insert a @dfn{pseudo-article} for each
6918 extracted file into the summary buffer.  If you go to these
6919 ``articles'', you will be prompted for a command to run (usually Gnus
6920 will make a suggestion), and then the command will be run.
6921
6922 @vindex gnus-view-pseudo-asynchronously
6923 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6924 until the viewing is done before proceeding.
6925
6926 @vindex gnus-view-pseudos
6927 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6928 the pseudo-articles into the summary buffer, but view them
6929 immediately.  If this variable is @code{not-confirm}, the user won't even
6930 be asked for a confirmation before viewing is done.
6931
6932 @vindex gnus-view-pseudos-separately
6933 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6934 pseudo-article will be created for each file to be viewed.  If
6935 @code{nil}, all files that use the same viewing command will be given as
6936 a list of parameters to that command.
6937
6938 @vindex gnus-insert-pseudo-articles
6939 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6940 pseudo-articles when decoding.  It is @code{t} by default.
6941
6942 So; there you are, reading your @emph{pseudo-articles} in your
6943 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6944 Why isn't anything real anymore? How did we get here?
6945
6946
6947 @node Article Treatment
6948 @section Article Treatment
6949
6950 Reading through this huge manual, you may have quite forgotten that the
6951 object of newsreaders is to actually, like, read what people have
6952 written.  Reading articles.  Unfortunately, people are quite bad at
6953 writing, so there are tons of functions and variables to make reading
6954 these articles easier.
6955
6956 @menu
6957 * Article Highlighting::    You want to make the article look like fruit salad.
6958 * Article Fontisizing::     Making emphasized text look nice.
6959 * Article Hiding::          You also want to make certain info go away.
6960 * Article Washing::         Lots of way-neat functions to make life better.
6961 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
6962 * Article Date::            Grumble, UT!
6963 * Article Signature::       What is a signature?
6964 * Article Miscellania::     Various other stuff.
6965 @end menu
6966
6967
6968 @node Article Highlighting
6969 @subsection Article Highlighting
6970 @cindex highlighting
6971
6972 Not only do you want your article buffer to look like fruit salad, but
6973 you want it to look like technicolor fruit salad.
6974
6975 @table @kbd
6976
6977 @item W H a
6978 @kindex W H a (Summary)
6979 @findex gnus-article-highlight
6980 @findex gnus-article-maybe-highlight
6981 Do much highlighting of the current article
6982 (@code{gnus-article-highlight}).  This function highlights header, cited
6983 text, the signature, and adds buttons to the body and the head.
6984
6985 @item W H h
6986 @kindex W H h (Summary)
6987 @findex gnus-article-highlight-headers
6988 @vindex gnus-header-face-alist
6989 Highlight the headers (@code{gnus-article-highlight-headers}).  The
6990 highlighting will be done according to the @code{gnus-header-face-alist}
6991 variable, which is a list where each element has the form
6992 @code{(@var{regexp} @var{name} @var{content})}.
6993 @var{regexp} is a regular expression for matching the
6994 header, @var{name} is the face used for highlighting the header name
6995 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6996 the header value.  The first match made will be used.  Note that
6997 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6998
6999 @item W H c
7000 @kindex W H c (Summary)
7001 @findex gnus-article-highlight-citation
7002 Highlight cited text (@code{gnus-article-highlight-citation}).
7003
7004 Some variables to customize the citation highlights:
7005
7006 @table @code
7007 @vindex gnus-cite-parse-max-size
7008
7009 @item gnus-cite-parse-max-size
7010 If the article size if bigger than this variable (which is 25000 by
7011 default), no citation highlighting will be performed.
7012
7013 @item gnus-cite-max-prefix
7014 @vindex gnus-cite-max-prefix
7015 Maximum possible length for a citation prefix (default 20).
7016
7017 @item gnus-cite-face-list
7018 @vindex gnus-cite-face-list
7019 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
7020 When there are citations from multiple articles in the same message,
7021 gnus will try to give each citation from each article its own face.
7022 This should make it easier to see who wrote what.
7023
7024 @item gnus-supercite-regexp
7025 @vindex gnus-supercite-regexp
7026 Regexp matching normal Supercite attribution lines.
7027
7028 @item gnus-supercite-secondary-regexp
7029 @vindex gnus-supercite-secondary-regexp
7030 Regexp matching mangled Supercite attribution lines.
7031
7032 @item gnus-cite-minimum-match-count
7033 @vindex gnus-cite-minimum-match-count
7034 Minimum number of identical prefixes we have to see before we believe
7035 that it's a citation.
7036
7037 @item gnus-cite-attribution-prefix
7038 @vindex gnus-cite-attribution-prefix
7039 Regexp matching the beginning of an attribution line.
7040
7041 @item gnus-cite-attribution-suffix
7042 @vindex gnus-cite-attribution-suffix
7043 Regexp matching the end of an attribution line.
7044
7045 @item gnus-cite-attribution-face
7046 @vindex gnus-cite-attribution-face
7047 Face used for attribution lines.  It is merged with the face for the
7048 cited text belonging to the attribution.
7049
7050 @end table
7051
7052
7053 @item W H s
7054 @kindex W H s (Summary)
7055 @vindex gnus-signature-separator
7056 @vindex gnus-signature-face
7057 @findex gnus-article-highlight-signature
7058 Highlight the signature (@code{gnus-article-highlight-signature}).
7059 Everything after @code{gnus-signature-separator} (@pxref{Article
7060 Signature}) in an article will be considered a signature and will be
7061 highlighted with @code{gnus-signature-face}, which is @code{italic} by
7062 default.
7063
7064 @end table
7065
7066 @xref{Customizing Articles}, for how to highlight articles automatically.
7067
7068
7069 @node Article Fontisizing
7070 @subsection Article Fontisizing
7071 @cindex emphasis
7072 @cindex article emphasis
7073
7074 @findex gnus-article-emphasize
7075 @kindex W e (Summary)
7076 People commonly add emphasis to words in news articles by writing things
7077 like @samp{_this_} or @samp{*this*} or @samp{/this/}.  Gnus can make
7078 this look nicer by running the article through the @kbd{W e}
7079 (@code{gnus-article-emphasize}) command.
7080
7081 @vindex gnus-emphasis-alist
7082 How the emphasis is computed is controlled by the
7083 @code{gnus-emphasis-alist} variable.  This is an alist where the first
7084 element is a regular expression to be matched.  The second is a number
7085 that says what regular expression grouping is used to find the entire
7086 emphasized word.  The third is a number that says what regexp grouping
7087 should be displayed and highlighted.  (The text between these two
7088 groupings will be hidden.)  The fourth is the face used for
7089 highlighting.
7090
7091 @lisp
7092 (setq gnus-article-emphasis
7093       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
7094         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
7095 @end lisp
7096
7097 @cindex slash
7098 @cindex asterisk
7099 @cindex underline
7100 @cindex /
7101 @cindex *
7102
7103 @vindex gnus-emphasis-underline
7104 @vindex gnus-emphasis-bold
7105 @vindex gnus-emphasis-italic
7106 @vindex gnus-emphasis-underline-bold
7107 @vindex gnus-emphasis-underline-italic
7108 @vindex gnus-emphasis-bold-italic
7109 @vindex gnus-emphasis-underline-bold-italic
7110 By default, there are seven rules, and they use the following faces:
7111 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
7112 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
7113 @code{gnus-emphasis-underline-italic},
7114 @code{gnus-emphasis-underline-bold}, and
7115 @code{gnus-emphasis-underline-bold-italic}.
7116
7117 If you want to change these faces, you can either use @kbd{M-x
7118 customize}, or you can use @code{copy-face}.  For instance, if you want
7119 to make @code{gnus-emphasis-italic} use a red face instead, you could
7120 say something like:
7121
7122 @lisp
7123 (copy-face 'red 'gnus-emphasis-italic)
7124 @end lisp
7125
7126 @vindex gnus-group-highlight-words-alist
7127
7128 If you want to highlight arbitrary words, you can use the
7129 @code{gnus-group-highlight-words-alist} variable, which uses the same
7130 syntax as @code{gnus-emphasis-alist}.  The @code{highlight-words} group
7131 parameter (@pxref{Group Parameters}) can also be used.
7132
7133 @xref{Customizing Articles}, for how to fontize articles automatically.
7134
7135
7136 @node Article Hiding
7137 @subsection Article Hiding
7138 @cindex article hiding
7139
7140 Or rather, hiding certain things in each article.  There usually is much
7141 too much cruft in most articles.
7142
7143 @table @kbd
7144
7145 @item W W a
7146 @kindex W W a (Summary)
7147 @findex gnus-article-hide
7148 Do quite a lot of hiding on the article buffer
7149 (@kbd{gnus-article-hide}).  In particular, this function will hide
7150 headers, PGP, cited text and the signature.
7151
7152 @item W W h
7153 @kindex W W h (Summary)
7154 @findex gnus-article-toggle-headers
7155 Toggle hiding of headers (@code{gnus-article-toggle-headers}).  @xref{Hiding
7156 Headers}.
7157
7158 @item W W b
7159 @kindex W W b (Summary)
7160 @findex gnus-article-hide-boring-headers
7161 Hide headers that aren't particularly interesting
7162 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
7163
7164 @item W W s
7165 @kindex W W s (Summary)
7166 @findex gnus-article-hide-signature
7167 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
7168 Signature}.
7169
7170 @item W W l
7171 @kindex W W l (Summary)
7172 @findex gnus-article-hide-list-identifiers
7173 @vindex gnus-list-identifiers
7174 Strip list identifiers specified in @code{gnus-list-identifiers}.  These
7175 are strings some mailing list servers add to the beginning of all
7176 @code{Subject} headers---for example, @samp{[zebra 4711]}.  Any leading
7177 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
7178 may not contain @code{\\(..\\)}.
7179
7180 @table @code
7181
7182 @item gnus-list-identifiers
7183 @vindex gnus-list-identifiers
7184 A regular expression that matches list identifiers to be removed from
7185 subject.  This can also be a list of regular expressions.
7186
7187 @end table
7188
7189 @item W W p
7190 @kindex W W p (Summary)
7191 @findex gnus-article-hide-pgp
7192 @vindex gnus-article-hide-pgp-hook
7193 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
7194 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
7195 signature has been hidden.  For example, to automatically verify
7196 articles that have signatures in them do:
7197 @lisp
7198 ;;; Hide pgp cruft if any.
7199
7200 (setq gnus-treat-strip-pgp t)
7201
7202 ;;; After hiding pgp, verify the message;
7203 ;;; only happens if pgp signature is found.
7204
7205 (add-hook 'gnus-article-hide-pgp-hook
7206           (lambda ()
7207             (save-excursion
7208               (set-buffer gnus-original-article-buffer)
7209               (mc-verify))))
7210 @end lisp
7211
7212 @item W W P
7213 @kindex W W P (Summary)
7214 @findex gnus-article-hide-pem
7215 Hide @sc{pem} (privacy enhanced messages) cruft
7216 (@code{gnus-article-hide-pem}).
7217
7218 @item W W B
7219 @kindex W W B (Summary)
7220 @findex gnus-article-strip-banner
7221 @cindex banner
7222 @cindex OneList
7223 @cindex stripping advertisments
7224 @cindex advertisments
7225 Strip the banner specified by the @code{banner} group parameter
7226 (@code{gnus-article-strip-banner}).  This is mainly used to hide those
7227 annoying banners and/or signatures that some mailing lists and moderated
7228 groups adds to all the messages.  The way to use this function is to add
7229 the @code{banner} group parameter (@pxref{Group Parameters}) to the
7230 group you want banners stripped from.  The parameter either be a string,
7231 which will be interpreted as a regular expression matching text to be
7232 removed, or the symbol @code{signature}, meaning that the (last)
7233 signature should be removed, or other symbol, meaning that the
7234 corresponding regular expression in @code{gnus-article-banner-alist} is
7235 used.
7236
7237 @item W W c
7238 @kindex W W c (Summary)
7239 @findex gnus-article-hide-citation
7240 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
7241 customizing the hiding:
7242
7243 @table @code
7244
7245 @item gnus-cited-opened-text-button-line-format
7246 @itemx gnus-cited-closed-text-button-line-format
7247 @vindex gnus-cited-closed-text-button-line-format
7248 @vindex gnus-cited-opened-text-button-line-format
7249 Gnus adds buttons to show where the cited text has been hidden, and to
7250 allow toggle hiding the text.  The format of the variable is specified
7251 by these format-like variable (@pxref{Formatting Variables}).  These
7252 specs are valid:
7253
7254 @table @samp
7255 @item b
7256 Starting point of the hidden text.
7257 @item e
7258 Ending point of the hidden text.
7259 @item l
7260 Number of characters in the hidden region.
7261 @item n
7262 Number of lines of hidden text.
7263 @end table
7264
7265 @item gnus-cited-lines-visible
7266 @vindex gnus-cited-lines-visible
7267 The number of lines at the beginning of the cited text to leave
7268 shown. This can also be a cons cell with the number of lines at the top
7269 and bottom of the text, respectively, to remain visible.
7270
7271 @end table
7272
7273 @item W W C-c
7274 @kindex W W C-c (Summary)
7275 @findex gnus-article-hide-citation-maybe
7276
7277 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
7278 following two variables:
7279
7280 @table @code
7281 @item gnus-cite-hide-percentage
7282 @vindex gnus-cite-hide-percentage
7283 If the cited text is of a bigger percentage than this variable (default
7284 50), hide the cited text.
7285
7286 @item gnus-cite-hide-absolute
7287 @vindex gnus-cite-hide-absolute
7288 The cited text must have at least this length (default 10) before it
7289 is hidden.
7290 @end table
7291
7292 @item W W C
7293 @kindex W W C (Summary)
7294 @findex gnus-article-hide-citation-in-followups
7295 Hide cited text in articles that aren't roots
7296 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
7297 useful as an interactive command, but might be a handy function to stick
7298 have happen automatically (@pxref{Customizing Articles}).
7299
7300 @end table
7301
7302 All these ``hiding'' commands are toggles, but if you give a negative
7303 prefix to these commands, they will show what they have previously
7304 hidden.  If you give a positive prefix, they will always hide.
7305
7306 Also @pxref{Article Highlighting} for further variables for
7307 citation customization.
7308
7309 @xref{Customizing Articles}, for how to hide article elements
7310 automatically.
7311
7312
7313 @node Article Washing
7314 @subsection Article Washing
7315 @cindex washing
7316 @cindex article washing
7317
7318 We call this ``article washing'' for a really good reason.  Namely, the
7319 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
7320
7321 @dfn{Washing} is defined by us as ``changing something from something to
7322 something else'', but normally results in something looking better.
7323 Cleaner, perhaps.
7324
7325 @table @kbd
7326
7327 @item W l
7328 @kindex W l (Summary)
7329 @findex gnus-summary-stop-page-breaking
7330 Remove page breaks from the current article
7331 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
7332 delimiters.
7333
7334 @item W r
7335 @kindex W r (Summary)
7336 @findex gnus-summary-caesar-message
7337 @c @icon{gnus-summary-caesar-message}
7338 Do a Caesar rotate (rot13) on the article buffer
7339 (@code{gnus-summary-caesar-message}).
7340 Unreadable articles that tell you to read them with Caesar rotate or rot13.
7341 (Typically offensive jokes and such.)
7342
7343 It's commonly called ``rot13'' because each letter is rotated 13
7344 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
7345 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
7346 is rumored to have employed this form of, uh, somewhat weak encryption.
7347
7348 @item W t
7349 @item t
7350 @kindex W t (Summary)
7351 @kindex t (Summary)
7352 @findex gnus-article-toggle-headers
7353 Toggle whether to display all headers in the article buffer
7354 (@code{gnus-article-toggle-headers}).
7355
7356 @item W v
7357 @kindex W v (Summary)
7358 @findex gnus-summary-verbose-header
7359 Toggle whether to display all headers in the article buffer permanently
7360 (@code{gnus-summary-verbose-header}).
7361
7362 @item W m
7363 @kindex W m (Summary)
7364 @findex gnus-summary-toggle-mime
7365 Toggle whether to run the article through @sc{mime} before displaying
7366 (@code{gnus-summary-toggle-mime}).
7367
7368 @item W o
7369 @kindex W o (Summary)
7370 @findex gnus-article-treat-overstrike
7371 Treat overstrike (@code{gnus-article-treat-overstrike}).
7372
7373 @item W d
7374 @kindex W d (Summary)
7375 @findex gnus-article-treat-dumbquotes
7376 @vindex gnus-article-dumbquotes-map
7377 @cindex Smartquotes
7378 @cindex M******** sm*rtq**t*s
7379 @cindex Latin 1
7380 Treat M******** sm*rtq**t*s according to
7381 @code{gnus-article-dumbquotes-map}
7382 (@code{gnus-article-treat-dumbquotes}).  Note that this function guesses
7383 whether a character is a sm*rtq**t* or not, so it should only be used
7384 interactively.
7385
7386 @item W w
7387 @kindex W w (Summary)
7388 @findex gnus-article-fill-cited-article
7389 Do word wrap (@code{gnus-article-fill-cited-article}).
7390
7391 You can give the command a numerical prefix to specify the width to use
7392 when filling.
7393
7394 @item W Q
7395 @kindex W Q (Summary)
7396 @findex gnus-article-fill-long-lines 
7397 Fill long lines (@code{gnus-article-fill-long-lines}).
7398
7399 @item W C
7400 @kindex W C (Summary)
7401 @findex gnus-article-capitalize-sentences
7402 Capitalize the first word in each sentence
7403 (@code{gnus-article-capitalize-sentences}).
7404
7405 @item W c
7406 @kindex W c (Summary)
7407 @findex gnus-article-remove-cr
7408 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
7409 (this takes care of DOS line endings), and then translate any remaining
7410 CRs into LF (this takes care of Mac line endings)
7411 (@code{gnus-article-remove-cr}).
7412
7413 @item W 6
7414 @kindex W 6 (Summary)
7415 @findex gnus-article-de-base64-unreadable
7416 Treat base64 (@code{gnus-article-de-base64-unreadable}).
7417 Base64 is one common @sc{mime} encoding employed when sending non-ASCII
7418 (i. e., 8-bit) articles.  Note that the this is usually done
7419 automatically by Gnus if the message in question has a
7420 @code{Content-Transfer-Encoding} header that says that this encoding has
7421 been done.
7422
7423 @item W Z
7424 @kindex W Z (Summary)
7425 @findex gnus-article-decode-HZ
7426 Treat HZ or HZP (@code{gnus-article-decode-HZ}).  HZ (or HZP) is one
7427 common encoding employed when sending Chinese articles.  It typically
7428 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
7429
7430 @item W h
7431 @kindex W h (Summary)
7432 @findex gnus-article-wash-html
7433 Treat HTML (@code{gnus-article-wash-html}).  
7434 Note that the this is usually done automatically by Gnus if the message
7435 in question has a @code{Content-Type} header that says that this type
7436 has been done.
7437
7438 @item W f
7439 @kindex W f (Summary)
7440 @cindex x-face
7441 @findex gnus-article-display-x-face
7442 @findex gnus-article-x-face-command
7443 @vindex gnus-article-x-face-command
7444 @vindex gnus-article-x-face-too-ugly
7445 @iftex
7446 @iflatex
7447 \include{xface}
7448 @end iflatex
7449 @end iftex
7450 Look for and display any X-Face headers
7451 (@code{gnus-article-display-x-face}).  The command executed by this
7452 function is given by the @code{gnus-article-x-face-command} variable.
7453 If this variable is a string, this string will be executed in a
7454 sub-shell.  If it is a function, this function will be called with the
7455 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
7456 is a regexp) matches the @code{From} header, the face will not be shown.
7457 The default action under Emacs is to fork off the @code{display}
7458 program@footnote{@code{display} is from the ImageMagick package.  For the
7459 @code{uncompface} and @code{icontopbm} programs look for a package
7460 like `compface' or `faces-xface' on a GNU/Linux system.}
7461 to view the face.  Under XEmacs or Emacs 21+ with suitable image
7462 support, the default action is to display the face before the
7463 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
7464 support---that will make display somewhat faster.  If there's no native
7465 X-Face support, Gnus will try to convert the @code{X-Face} header using
7466 external programs from the @code{pbmplus} package and
7467 friends.@footnote{On a GNU/Linux system look for packages with names
7468 like @code{netpbm} or @code{libgr-progs}.})  If you
7469 want to have this function in the display hook, it should probably come
7470 last.
7471
7472 @item W b
7473 @kindex W b (Summary)
7474 @findex gnus-article-add-buttons
7475 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
7476 @xref{Article Buttons}.
7477
7478 @item W B
7479 @kindex W B (Summary)
7480 @findex gnus-article-add-buttons-to-head
7481 Add clickable buttons to the article headers
7482 (@code{gnus-article-add-buttons-to-head}).
7483
7484 @item W W H
7485 @kindex W W H (Summary)
7486 @findex gnus-article-strip-headers-from-body
7487 Strip headers like the @code{X-No-Archive} header from the beginning of
7488 article bodies (@code{gnus-article-strip-headers-from-body}).
7489
7490 @item W E l
7491 @kindex W E l (Summary)
7492 @findex gnus-article-strip-leading-blank-lines
7493 Remove all blank lines from the beginning of the article
7494 (@code{gnus-article-strip-leading-blank-lines}).
7495
7496 @item W E m
7497 @kindex W E m (Summary)
7498 @findex gnus-article-strip-multiple-blank-lines
7499 Replace all blank lines with empty lines and then all multiple empty
7500 lines with a single empty line.
7501 (@code{gnus-article-strip-multiple-blank-lines}).
7502
7503 @item W E t
7504 @kindex W E t (Summary)
7505 @findex gnus-article-remove-trailing-blank-lines
7506 Remove all blank lines at the end of the article
7507 (@code{gnus-article-remove-trailing-blank-lines}).
7508
7509 @item W E a
7510 @kindex W E a (Summary)
7511 @findex gnus-article-strip-blank-lines
7512 Do all the three commands above
7513 (@code{gnus-article-strip-blank-lines}).
7514
7515 @item W E A
7516 @kindex W E A (Summary)
7517 @findex gnus-article-strip-all-blank-lines
7518 Remove all blank lines
7519 (@code{gnus-article-strip-all-blank-lines}).
7520
7521 @item W E s
7522 @kindex W E s (Summary)
7523 @findex gnus-article-strip-leading-space
7524 Remove all white space from the beginning of all lines of the article
7525 body (@code{gnus-article-strip-leading-space}).
7526
7527 @item W E e
7528 @kindex W E e (Summary)
7529 @findex gnus-article-strip-trailing-space
7530 Remove all white space from the end of all lines of the article
7531 body (@code{gnus-article-strip-trailing-space}).
7532
7533 @end table
7534
7535 @xref{Customizing Articles}, for how to wash articles automatically.
7536
7537
7538 @node Article Buttons
7539 @subsection Article Buttons
7540 @cindex buttons
7541
7542 People often include references to other stuff in articles, and it would
7543 be nice if Gnus could just fetch whatever it is that people talk about
7544 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
7545 button on these references.
7546
7547 Gnus adds @dfn{buttons} to certain standard references by default:
7548 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
7549 two variables, one that handles article bodies and one that handles
7550 article heads:
7551
7552 @table @code
7553
7554 @item gnus-button-alist
7555 @vindex gnus-button-alist
7556 This is an alist where each entry has this form:
7557
7558 @lisp
7559 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7560 @end lisp
7561
7562 @table @var
7563
7564 @item regexp
7565 All text that match this regular expression will be considered an
7566 external reference.  Here's a typical regexp that matches embedded URLs:
7567 @samp{<URL:\\([^\n\r>]*\\)>}.
7568
7569 @item button-par
7570 Gnus has to know which parts of the matches is to be highlighted.  This
7571 is a number that says what sub-expression of the regexp is to be
7572 highlighted.  If you want it all highlighted, you use 0 here.
7573
7574 @item use-p
7575 This form will be @code{eval}ed, and if the result is non-@code{nil},
7576 this is considered a match.  This is useful if you want extra sifting to
7577 avoid false matches.
7578
7579 @item function
7580 This function will be called when you click on this button.
7581
7582 @item data-par
7583 As with @var{button-par}, this is a sub-expression number, but this one
7584 says which part of the match is to be sent as data to @var{function}.
7585
7586 @end table
7587
7588 So the full entry for buttonizing URLs is then
7589
7590 @lisp
7591 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
7592 @end lisp
7593
7594 @item gnus-header-button-alist
7595 @vindex gnus-header-button-alist
7596 This is just like the other alist, except that it is applied to the
7597 article head only, and that each entry has an additional element that is
7598 used to say what headers to apply the buttonize coding to:
7599
7600 @lisp
7601 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
7602 @end lisp
7603
7604 @var{header} is a regular expression.
7605
7606 @item gnus-button-url-regexp
7607 @vindex gnus-button-url-regexp
7608 A regular expression that matches embedded URLs.  It is used in the
7609 default values of the variables above.
7610
7611 @item gnus-article-button-face
7612 @vindex gnus-article-button-face
7613 Face used on buttons.
7614
7615 @item gnus-article-mouse-face
7616 @vindex gnus-article-mouse-face
7617 Face used when the mouse cursor is over a button.
7618
7619 @end table
7620
7621 @xref{Customizing Articles}, for how to buttonize articles automatically.
7622
7623
7624 @node Article Date
7625 @subsection Article Date
7626
7627 The date is most likely generated in some obscure timezone you've never
7628 heard of, so it's quite nice to be able to find out what the time was
7629 when the article was sent.
7630
7631 @table @kbd
7632
7633 @item W T u
7634 @kindex W T u (Summary)
7635 @findex gnus-article-date-ut
7636 Display the date in UT (aka. GMT, aka ZULU)
7637 (@code{gnus-article-date-ut}).
7638
7639 @item W T i
7640 @kindex W T i (Summary)
7641 @findex gnus-article-date-iso8601
7642 @cindex ISO 8601
7643 Display the date in international format, aka. ISO 8601
7644 (@code{gnus-article-date-iso8601}).
7645
7646 @item W T l
7647 @kindex W T l (Summary)
7648 @findex gnus-article-date-local
7649 Display the date in the local timezone (@code{gnus-article-date-local}).
7650
7651 @item W T s
7652 @kindex W T s (Summary)
7653 @vindex gnus-article-time-format
7654 @findex gnus-article-date-user
7655 @findex format-time-string
7656 Display the date using a user-defined format
7657 (@code{gnus-article-date-user}).  The format is specified by the
7658 @code{gnus-article-time-format} variable, and is a string that's passed
7659 to @code{format-time-string}.  See the documentation of that variable
7660 for a list of possible format specs.
7661
7662 @item W T e
7663 @kindex W T e (Summary)
7664 @findex gnus-article-date-lapsed
7665 @findex gnus-start-date-timer
7666 @findex gnus-stop-date-timer
7667 Say how much time has elapsed between the article was posted and now
7668 (@code{gnus-article-date-lapsed}).  It looks something like:
7669
7670 @example
7671 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
7672 @end example
7673
7674 The value of @code{gnus-article-date-lapsed-new-header} determines
7675 whether this header will just be added below the old Date one, or will
7676 replace it.
7677
7678 An advantage of using Gnus to read mail is that it converts simple bugs
7679 into wonderful absurdities.
7680
7681 If you want to have this line updated continually, you can put
7682
7683 @lisp
7684 (gnus-start-date-timer)
7685 @end lisp
7686
7687 in your @file{.gnus.el} file, or you can run it off of some hook.  If
7688 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7689 command.
7690
7691 @item W T o
7692 @kindex W T o (Summary)
7693 @findex gnus-article-date-original
7694 Display the original date (@code{gnus-article-date-original}).  This can
7695 be useful if you normally use some other conversion function and are
7696 worried that it might be doing something totally wrong.  Say, claiming
7697 that the article was posted in 1854.  Although something like that is
7698 @emph{totally} impossible.  Don't you trust me? *titter*
7699
7700 @end table
7701
7702 @xref{Customizing Articles}, for how to display the date in your
7703 preferred format automatically.
7704
7705
7706 @node Article Signature
7707 @subsection Article Signature
7708 @cindex signatures
7709 @cindex article signature
7710
7711 @vindex gnus-signature-separator
7712 Each article is divided into two parts---the head and the body.  The
7713 body can be divided into a signature part and a text part.  The variable
7714 that says what is to be considered a signature is
7715 @code{gnus-signature-separator}.  This is normally the standard
7716 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
7717 non-standard signature separators, so this variable can also be a list
7718 of regular expressions to be tested, one by one.  (Searches are done
7719 from the end of the body towards the beginning.)  One likely value is:
7720
7721 @lisp
7722 (setq gnus-signature-separator
7723       '("^-- $"         ; The standard
7724         "^-- *$"        ; A common mangling
7725         "^-------*$"    ; Many people just use a looong
7726                         ; line of dashes.  Shame!
7727         "^ *--------*$" ; Double-shame!
7728         "^________*$"   ; Underscores are also popular
7729         "^========*$")) ; Pervert!
7730 @end lisp
7731
7732 The more permissive you are, the more likely it is that you'll get false
7733 positives.
7734
7735 @vindex gnus-signature-limit
7736 @code{gnus-signature-limit} provides a limit to what is considered a
7737 signature when displaying articles.
7738
7739 @enumerate
7740 @item
7741 If it is an integer, no signature may be longer (in characters) than
7742 that integer.
7743 @item
7744 If it is a floating point number, no signature may be longer (in lines)
7745 than that number.
7746 @item
7747 If it is a function, the function will be called without any parameters,
7748 and if it returns @code{nil}, there is no signature in the buffer.
7749 @item
7750 If it is a string, it will be used as a regexp.  If it matches, the text
7751 in question is not a signature.
7752 @end enumerate
7753
7754 This variable can also be a list where the elements may be of the types
7755 listed above.  Here's an example:
7756
7757 @lisp
7758 (setq gnus-signature-limit
7759       '(200.0 "^---*Forwarded article"))
7760 @end lisp
7761
7762 This means that if there are more than 200 lines after the signature
7763 separator, or the text after the signature separator is matched by
7764 the regular expression @samp{^---*Forwarded article}, then it isn't a
7765 signature after all.
7766
7767
7768 @node Article Miscellania
7769 @subsection Article Miscellania
7770
7771 @table @kbd
7772 @item A t
7773 @kindex A t (Summary)
7774 @findex gnus-article-babel
7775 Translate the article from one language to another
7776 (@code{gnus-article-babel}).
7777
7778 @end table
7779
7780
7781 @node MIME Commands
7782 @section @sc{mime} Commands
7783 @cindex MIME decoding
7784 @cindex attachments
7785 @cindex viewing attachments
7786
7787 The following commands all understand the numerical prefix.  For
7788 instance, @kbd{3 b} means ``view the third @sc{mime} part''.
7789
7790 @table @kbd
7791 @item b
7792 @itemx K v
7793 @kindex b (Summary)
7794 @kindex K v (Summary)
7795 View the @sc{mime} part.
7796
7797 @item K o
7798 @kindex K o (Summary)
7799 Save the @sc{mime} part.
7800
7801 @item K c
7802 @kindex K c (Summary)
7803 Copy the @sc{mime} part.
7804
7805 @item K e
7806 @kindex K e (Summary)
7807 View the @sc{mime} part externally.
7808
7809 @item K i
7810 @kindex K i (Summary)
7811 View the @sc{mime} part internally.
7812
7813 @item K |
7814 @kindex K | (Summary)
7815 Pipe the @sc{mime} part to an external command.
7816 @end table
7817
7818 The rest of these @sc{mime} commands do not use the numerical prefix in
7819 the same manner:
7820
7821 @table @kbd
7822 @item K b
7823 @kindex K b (Summary)
7824 Make all the @sc{mime} parts have buttons in front of them.  This is
7825 mostly useful if you wish to save (or perform other actions) on inlined
7826 parts.
7827
7828 @item K m
7829 @kindex K m (Summary)
7830 @findex gnus-summary-repair-multipart
7831 Some multipart messages are transmitted with missing or faulty headers.
7832 This command will attempt to ``repair'' these messages so that they can
7833 be viewed in a more pleasant manner
7834 (@code{gnus-summary-repair-multipart}).
7835
7836 @item X m
7837 @kindex X m (Summary)
7838 @findex gnus-summary-save-parts
7839 Save all parts matching a @sc{mime} type to a directory
7840 (@code{gnus-summary-save-parts}).  Understands the process/prefix
7841 convention (@pxref{Process/Prefix}).
7842
7843 @item M-t
7844 @kindex M-t (Summary)
7845 @findex gnus-summary-display-buttonized
7846 Toggle the buttonized display of the article buffer
7847 (@code{gnus-summary-toggle-display-buttonized}).
7848
7849 @item W M w
7850 @kindex W M w (Summary)
7851 Decode RFC 2047-encoded words in the article headers
7852 (@code{gnus-article-decode-mime-words}).
7853
7854 @item W M c
7855 @kindex W M c (Summary)
7856 Decode encoded article bodies as well as charsets
7857 (@code{gnus-article-decode-charset}).
7858
7859 This command looks in the @code{Content-Type} header to determine the
7860 charset.  If there is no such header in the article, you can give it a
7861 prefix, which will prompt for the charset to decode as.  In regional
7862 groups where people post using some common encoding (but do not include
7863 MIME headers), you can set the @code{charset} group/topic parameter to
7864 the required charset (@pxref{Group Parameters}).
7865
7866 @item W M v
7867 @kindex W M v (Summary)
7868 View all the @sc{mime} parts in the current article
7869 (@code{gnus-mime-view-all-parts}).
7870
7871 @end table
7872
7873 Relevant variables:
7874
7875 @table @code
7876 @item gnus-ignored-mime-types
7877 @vindex gnus-ignored-mime-types
7878 This is a list of regexps.  @sc{mime} types that match a regexp from
7879 this list will be completely ignored by Gnus.  The default value is
7880 @code{nil}.
7881
7882 To have all Vcards be ignored, you'd say something like this:
7883
7884 @lisp
7885 (setq gnus-ignored-mime-types
7886       '("text/x-vcard"))
7887 @end lisp
7888
7889 @item gnus-unbuttonized-mime-types
7890 @vindex gnus-unbuttonized-mime-types
7891 This is a list of regexps.  @sc{mime} types that match a regexp from
7892 this list won't have @sc{mime} buttons inserted unless they aren't
7893 displayed.  The default value is @code{(".*/.*")}.
7894
7895 @item gnus-article-mime-part-function
7896 @vindex gnus-article-mime-part-function
7897 For each @sc{mime} part, this function will be called with the @sc{mime}
7898 handle as the parameter.  The function is meant to be used to allow
7899 users to gather information from the article (e. g., add Vcard info to
7900 the bbdb database) or to do actions based on parts (e. g., automatically
7901 save all jpegs into some directory).
7902
7903 Here's an example function the does the latter:
7904
7905 @lisp
7906 (defun my-save-all-jpeg-parts (handle)
7907   (when (equal (car (mm-handle-type handle)) "image/jpeg")
7908     (with-temp-buffer
7909       (insert (mm-get-part handle))
7910       (write-region (point-min) (point-max)
7911                     (read-file-name "Save jpeg to: ")))))
7912 (setq gnus-article-mime-part-function
7913       'my-save-all-jpeg-parts)
7914 @end lisp
7915
7916 @vindex gnus-mime-multipart-functions
7917 @item gnus-mime-multipart-functions
7918 Alist of @sc{mime} multipart types and functions to handle them.
7919
7920 @end table
7921
7922
7923 @node Charsets
7924 @section Charsets
7925 @cindex charsets
7926
7927 People use different charsets, and we have @sc{mime} to let us know what
7928 charsets they use.  Or rather, we wish we had.  Many people use
7929 newsreaders and mailers that do not understand or use @sc{mime}, and
7930 just send out messages without saying what character sets they use.  To
7931 help a bit with this, some local news hierarchies have policies that say
7932 what character set is the default.  For instance, the @samp{fj}
7933 hierarchy uses @code{iso-2022-jp-2}.
7934
7935 @vindex gnus-group-charset-alist
7936 This knowledge is encoded in the @code{gnus-group-charset-alist}
7937 variable, which is an alist of regexps (to match group names) and
7938 default charsets to be used when reading these groups.
7939
7940 In addition, some people do use soi-disant @sc{mime}-aware agents that
7941 aren't.  These blitely mark messages as being in @code{iso-8859-1} even
7942 if they really are in @code{koi-8}.  To help here, the
7943 @code{gnus-newsgroup-ignored-charsets} variable can be used.  The
7944 charsets that are listed here will be ignored.  The variable can be set
7945 on a group-by-group basis using the group parameters (@pxref{Group
7946 Parameters}).  The default value is @code{(unknown-8bit)}, which is
7947 something some agents insist on having in there.
7948
7949 @vindex gnus-group-posting-charset-alist
7950 When posting, @code{gnus-group-posting-charset-alist} is used to
7951 determine which charsets should not be encoded using the @sc{mime}
7952 encodings.  For instance, some hierarchies discourage using
7953 quoted-printable header encoding.
7954
7955 This variable is an alist of regexps and permitted unencoded charsets
7956 for posting.  Each element of the alist has the form @code{(}@var{test
7957 header body-list}@code{)}, where:
7958
7959 @table @var
7960 @item test
7961 is either a regular expression matching the newsgroup header or a
7962 variable to query,
7963 @item header
7964 is the charset which may be left unencoded in the header (@code{nil}
7965 means encode all charsets),
7966 @item body-list
7967 is a list of charsets which may be encoded using 8bit content-transfer
7968 encoding in the body, or one of the special values @code{nil} (always
7969 encode using quoted-printable) or @code{t} (always use 8bit).
7970 @end table
7971
7972 @cindex Russian
7973 @cindex koi8-r
7974 @cindex koi8-u
7975 @cindex iso-8859-5
7976 @cindex coding system aliases
7977 @cindex preferred charset
7978
7979 Other charset tricks that may be useful, although not Gnus-specific:
7980
7981 If there are several @sc{mime} charsets that encode the same Emacs
7982 charset, you can choose what charset to use by saying the following:
7983
7984 @lisp
7985 (put-charset-property 'cyrillic-iso8859-5
7986                       'preferred-coding-system 'koi8-r)
7987 @end lisp
7988
7989 This means that Russian will be encoded using @code{koi8-r} instead of
7990 the default @code{iso-8859-5} @sc{mime} charset.
7991
7992 If you want to read messages in @code{koi8-u}, you can cheat and say
7993
7994 @lisp
7995 (define-coding-system-alias 'koi8-u 'koi8-r)
7996 @end lisp
7997
7998 This will almost do the right thing.
7999
8000 And finally, to read charsets like @code{windows-1251}, you can say
8001 something like
8002
8003 @lisp
8004 (codepage-setup 1251)
8005 (define-coding-system-alias 'windows-1251 'cp1251)
8006 @end lisp
8007
8008
8009 @node Article Commands
8010 @section Article Commands
8011
8012 @table @kbd
8013
8014 @item A P
8015 @cindex PostScript
8016 @cindex printing
8017 @kindex A P (Summary)
8018 @vindex gnus-ps-print-hook
8019 @findex gnus-summary-print-article
8020 Generate and print a PostScript image of the article buffer
8021 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
8022 run just before printing the buffer.
8023
8024 @end table
8025
8026
8027 @node Summary Sorting
8028 @section Summary Sorting
8029 @cindex summary sorting
8030
8031 You can have the summary buffer sorted in various ways, even though I
8032 can't really see why you'd want that.
8033
8034 @table @kbd
8035
8036 @item C-c C-s C-n
8037 @kindex C-c C-s C-n (Summary)
8038 @findex gnus-summary-sort-by-number
8039 Sort by article number (@code{gnus-summary-sort-by-number}).
8040
8041 @item C-c C-s C-a
8042 @kindex C-c C-s C-a (Summary)
8043 @findex gnus-summary-sort-by-author
8044 Sort by author (@code{gnus-summary-sort-by-author}).
8045
8046 @item C-c C-s C-s
8047 @kindex C-c C-s C-s (Summary)
8048 @findex gnus-summary-sort-by-subject
8049 Sort by subject (@code{gnus-summary-sort-by-subject}).
8050
8051 @item C-c C-s C-d
8052 @kindex C-c C-s C-d (Summary)
8053 @findex gnus-summary-sort-by-date
8054 Sort by date (@code{gnus-summary-sort-by-date}).
8055
8056 @item C-c C-s C-l
8057 @kindex C-c C-s C-l (Summary)
8058 @findex gnus-summary-sort-by-lines
8059 Sort by lines (@code{gnus-summary-sort-by-lines}).
8060
8061 @item C-c C-s C-c
8062 @kindex C-c C-s C-c (Summary)
8063 @findex gnus-summary-sort-by-chars
8064 Sort by article length (@code{gnus-summary-sort-by-chars}).
8065
8066 @item C-c C-s C-i
8067 @kindex C-c C-s C-i (Summary)
8068 @findex gnus-summary-sort-by-score
8069 Sort by score (@code{gnus-summary-sort-by-score}).
8070 @end table
8071
8072 These functions will work both when you use threading and when you don't
8073 use threading.  In the latter case, all summary lines will be sorted,
8074 line by line.  In the former case, sorting will be done on a
8075 root-by-root basis, which might not be what you were looking for.  To
8076 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
8077 Commands}).
8078
8079
8080 @node Finding the Parent
8081 @section Finding the Parent
8082 @cindex parent articles
8083 @cindex referring articles
8084
8085 @table @kbd
8086 @item ^
8087 @kindex ^ (Summary)
8088 @findex gnus-summary-refer-parent-article
8089 If you'd like to read the parent of the current article, and it is not
8090 displayed in the summary buffer, you might still be able to.  That is,
8091 if the current group is fetched by @sc{nntp}, the parent hasn't expired
8092 and the @code{References} in the current article are not mangled, you
8093 can just press @kbd{^} or @kbd{A r}
8094 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
8095 you'll get the parent.  If the parent is already displayed in the
8096 summary buffer, point will just move to this article.
8097
8098 If given a positive numerical prefix, fetch that many articles back into
8099 the ancestry.  If given a negative numerical prefix, fetch just that
8100 ancestor.  So if you say @kbd{3 ^}, gnus will fetch the parent, the
8101 grandparent and the grandgrandparent of the current article.  If you say
8102 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
8103 article.
8104
8105 @item A R (Summary)
8106 @findex gnus-summary-refer-references
8107 @kindex A R (Summary)
8108 Fetch all articles mentioned in the @code{References} header of the
8109 article (@code{gnus-summary-refer-references}).
8110
8111 @item A T (Summary)
8112 @findex gnus-summary-refer-thread
8113 @kindex A T (Summary)
8114 Display the full thread where the current article appears
8115 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
8116 headers in the current group to work, so it usually takes a while.  If
8117 you do it often, you may consider setting @code{gnus-fetch-old-headers}
8118 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
8119 visible effects normally, but it'll make this command work a whole lot
8120 faster.  Of course, it'll make group entry somewhat slow.
8121
8122 @vindex gnus-refer-thread-limit
8123 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
8124 articles before the first displayed in the current group) headers to
8125 fetch when doing this command.  The default is 200.  If @code{t}, all
8126 the available headers will be fetched.  This variable can be overridden
8127 by giving the @kbd{A T} command a numerical prefix.
8128
8129 @item M-^ (Summary)
8130 @findex gnus-summary-refer-article
8131 @kindex M-^ (Summary)
8132 @cindex Message-ID
8133 @cindex fetching by Message-ID
8134 You can also ask the @sc{nntp} server for an arbitrary article, no
8135 matter what group it belongs to.  @kbd{M-^}
8136 (@code{gnus-summary-refer-article}) will ask you for a
8137 @code{Message-ID}, which is one of those long, hard-to-read thingies
8138 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
8139 have to get it all exactly right.  No fuzzy searches, I'm afraid.
8140 @end table
8141
8142 The current select method will be used when fetching by
8143 @code{Message-ID} from non-news select method, but you can override this
8144 by giving this command a prefix.
8145
8146 @vindex gnus-refer-article-method
8147 If the group you are reading is located on a backend that does not
8148 support fetching by @code{Message-ID} very well (like @code{nnspool}),
8149 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
8150 would, perhaps, be best if the @sc{nntp} server you consult is the one
8151 updating the spool you are reading from, but that's not really
8152 necessary.
8153
8154 It can also be a list of select methods, as well as the special symbol
8155 @code{current}, which means to use the current select method.  If it
8156 is a list, Gnus will try all the methods in the list until it finds a
8157 match.
8158
8159 Here's an example setting that will first try the current method, and
8160 then ask Deja if that fails:
8161
8162 @lisp
8163 (setq gnus-refer-article-method
8164       '(current
8165         (nnweb "refer" (nnweb-type dejanews))))
8166 @end lisp
8167
8168 Most of the mail backends support fetching by @code{Message-ID}, but do
8169 not do a particularly excellent job at it.  That is, @code{nnmbox} and
8170 @code{nnbabyl} are able to locate articles from any groups, while
8171 @code{nnml} and @code{nnfolder} are only able to locate articles that
8172 have been posted to the current group.  (Anything else would be too time
8173 consuming.)  @code{nnmh} does not support this at all.
8174
8175
8176 @node Alternative Approaches
8177 @section Alternative Approaches
8178
8179 Different people like to read news using different methods.  This being
8180 gnus, we offer a small selection of minor modes for the summary buffers.
8181
8182 @menu
8183 * Pick and Read::               First mark articles and then read them.
8184 * Binary Groups::               Auto-decode all articles.
8185 @end menu
8186
8187
8188 @node Pick and Read
8189 @subsection Pick and Read
8190 @cindex pick and read
8191
8192 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
8193 a two-phased reading interface.  The user first marks in a summary
8194 buffer the articles she wants to read.  Then she starts reading the
8195 articles with just an article buffer displayed.
8196
8197 @findex gnus-pick-mode
8198 @kindex M-x gnus-pick-mode
8199 Gnus provides a summary buffer minor mode that allows
8200 this---@code{gnus-pick-mode}.  This basically means that a few process
8201 mark commands become one-keystroke commands to allow easy marking, and
8202 it provides one additional command for switching to the summary buffer.
8203
8204 Here are the available keystrokes when using pick mode:
8205
8206 @table @kbd
8207 @item .
8208 @kindex . (Pick)
8209 @findex gnus-pick-article-or-thread
8210 Pick the article or thread on the current line
8211 (@code{gnus-pick-article-or-thread}).  If the variable
8212 @code{gnus-thread-hide-subtree} is true, then this key selects the
8213 entire thread when used at the first article of the thread.  Otherwise,
8214 it selects just the article.  If given a numerical prefix, go to that
8215 thread or article and pick it.  (The line number is normally displayed
8216 at the beginning of the summary pick lines.)
8217
8218 @item SPACE
8219 @kindex SPACE (Pick)
8220 @findex gnus-pick-next-page
8221 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
8222 at the end of the buffer, start reading the picked articles.
8223
8224 @item u
8225 @kindex u (Pick)
8226 @findex gnus-pick-unmark-article-or-thread.
8227 Unpick the thread or article
8228 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
8229 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
8230 thread if used at the first article of the thread.  Otherwise it unpicks
8231 just the article.  You can give this key a numerical prefix to unpick
8232 the thread or article at that line.
8233
8234 @item RET
8235 @kindex RET (Pick)
8236 @findex gnus-pick-start-reading
8237 @vindex gnus-pick-display-summary
8238 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
8239 given a prefix, mark all unpicked articles as read first.  If
8240 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
8241 will still be visible when you are reading.
8242
8243 @end table
8244
8245 All the normal summary mode commands are still available in the
8246 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
8247 which is mapped to the same function
8248 @code{gnus-summary-tick-article-forward}.
8249
8250 If this sounds like a good idea to you, you could say:
8251
8252 @lisp
8253 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
8254 @end lisp
8255
8256 @vindex gnus-pick-mode-hook
8257 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
8258
8259 @vindex gnus-mark-unpicked-articles-as-read
8260 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
8261 all unpicked articles as read.  The default is @code{nil}.
8262
8263 @vindex gnus-summary-pick-line-format
8264 The summary line format in pick mode is slightly different from the
8265 standard format.  At the beginning of each line the line number is
8266 displayed.  The pick mode line format is controlled by the
8267 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
8268 Variables}).  It accepts the same format specs that
8269 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
8270
8271
8272 @node Binary Groups
8273 @subsection Binary Groups
8274 @cindex binary groups
8275
8276 @findex gnus-binary-mode
8277 @kindex M-x gnus-binary-mode
8278 If you spend much time in binary groups, you may grow tired of hitting
8279 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
8280 is a minor mode for summary buffers that makes all ordinary Gnus article
8281 selection functions uudecode series of articles and display the result
8282 instead of just displaying the articles the normal way.
8283
8284 @kindex g (Binary)
8285 @findex gnus-binary-show-article
8286 The only way, in fact, to see the actual articles is the @kbd{g}
8287 command, when you have turned on this mode
8288 (@code{gnus-binary-show-article}).
8289
8290 @vindex gnus-binary-mode-hook
8291 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
8292
8293
8294 @node Tree Display
8295 @section Tree Display
8296 @cindex trees
8297
8298 @vindex gnus-use-trees
8299 If you don't like the normal gnus summary display, you might try setting
8300 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
8301 additional @dfn{tree buffer}.  You can execute all summary mode commands
8302 in the tree buffer.
8303
8304 There are a few variables to customize the tree display, of course:
8305
8306 @table @code
8307 @item gnus-tree-mode-hook
8308 @vindex gnus-tree-mode-hook
8309 A hook called in all tree mode buffers.
8310
8311 @item gnus-tree-mode-line-format
8312 @vindex gnus-tree-mode-line-format
8313 A format string for the mode bar in the tree mode buffers (@pxref{Mode
8314 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
8315 of valid specs, @pxref{Summary Buffer Mode Line}.
8316
8317 @item gnus-selected-tree-face
8318 @vindex gnus-selected-tree-face
8319 Face used for highlighting the selected article in the tree buffer.  The
8320 default is @code{modeline}.
8321
8322 @item gnus-tree-line-format
8323 @vindex gnus-tree-line-format
8324 A format string for the tree nodes.  The name is a bit of a misnomer,
8325 though---it doesn't define a line, but just the node.  The default value
8326 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
8327 the name of the poster.  It is vital that all nodes are of the same
8328 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
8329
8330 Valid specs are:
8331
8332 @table @samp
8333 @item n
8334 The name of the poster.
8335 @item f
8336 The @code{From} header.
8337 @item N
8338 The number of the article.
8339 @item [
8340 The opening bracket.
8341 @item ]
8342 The closing bracket.
8343 @item s
8344 The subject.
8345 @end table
8346
8347 @xref{Formatting Variables}.
8348
8349 Variables related to the display are:
8350
8351 @table @code
8352 @item gnus-tree-brackets
8353 @vindex gnus-tree-brackets
8354 This is used for differentiating between ``real'' articles and
8355 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
8356 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
8357 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
8358
8359 @item gnus-tree-parent-child-edges
8360 @vindex gnus-tree-parent-child-edges
8361 This is a list that contains the characters used for connecting parent
8362 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
8363
8364 @end table
8365
8366 @item gnus-tree-minimize-window
8367 @vindex gnus-tree-minimize-window
8368 If this variable is non-@code{nil}, gnus will try to keep the tree
8369 buffer as small as possible to allow more room for the other gnus
8370 windows.  If this variable is a number, the tree buffer will never be
8371 higher than that number.  The default is @code{t}.  Note that if you
8372 have several windows displayed side-by-side in a frame and the tree
8373 buffer is one of these, minimizing the tree window will also resize all
8374 other windows displayed next to it.
8375
8376 @item gnus-generate-tree-function
8377 @vindex gnus-generate-tree-function
8378 @findex gnus-generate-horizontal-tree
8379 @findex gnus-generate-vertical-tree
8380 The function that actually generates the thread tree.  Two predefined
8381 functions are available: @code{gnus-generate-horizontal-tree} and
8382 @code{gnus-generate-vertical-tree} (which is the default).
8383
8384 @end table
8385
8386 Here's an example from a horizontal tree buffer:
8387
8388 @example
8389 @{***@}-(***)-[odd]-[Gun]
8390      |      \[Jan]
8391      |      \[odd]-[Eri]
8392      |      \(***)-[Eri]
8393      |            \[odd]-[Paa]
8394      \[Bjo]
8395      \[Gun]
8396      \[Gun]-[Jor]
8397 @end example
8398
8399 Here's the same thread displayed in a vertical tree buffer:
8400
8401 @example
8402 @{***@}
8403   |--------------------------\-----\-----\
8404 (***)                         [Bjo] [Gun] [Gun]
8405   |--\-----\-----\                          |
8406 [odd] [Jan] [odd] (***)                   [Jor]
8407   |           |     |--\
8408 [Gun]       [Eri] [Eri] [odd]
8409                           |
8410                         [Paa]
8411 @end example
8412
8413 If you're using horizontal trees, it might be nice to display the trees
8414 side-by-side with the summary buffer.  You could add something like the
8415 following to your @file{.gnus.el} file:
8416
8417 @lisp
8418 (setq gnus-use-trees t
8419       gnus-generate-tree-function 'gnus-generate-horizontal-tree
8420       gnus-tree-minimize-window nil)
8421 (gnus-add-configuration
8422  '(article
8423    (vertical 1.0
8424              (horizontal 0.25
8425                          (summary 0.75 point)
8426                          (tree 1.0))
8427              (article 1.0))))
8428 @end lisp
8429
8430 @xref{Windows Configuration}.
8431
8432
8433 @node Mail Group Commands
8434 @section Mail Group Commands
8435 @cindex mail group commands
8436
8437 Some commands only make sense in mail groups.  If these commands are
8438 invalid in the current group, they will raise a hell and let you know.
8439
8440 All these commands (except the expiry and edit commands) use the
8441 process/prefix convention (@pxref{Process/Prefix}).
8442
8443 @table @kbd
8444
8445 @item B e
8446 @kindex B e (Summary)
8447 @findex gnus-summary-expire-articles
8448 Expire all expirable articles in the group
8449 (@code{gnus-summary-expire-articles}).
8450
8451 @item B M-C-e
8452 @kindex B M-C-e (Summary)
8453 @findex gnus-summary-expire-articles-now
8454 Delete all the expirable articles in the group
8455 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
8456 articles eligible for expiry in the current group will
8457 disappear forever into that big @file{/dev/null} in the sky.
8458
8459 @item B DEL
8460 @kindex B DEL (Summary)
8461 @findex gnus-summary-delete-article
8462 @c @icon{gnus-summary-mail-delete}
8463 Delete the mail article.  This is ``delete'' as in ``delete it from your
8464 disk forever and ever, never to return again.'' Use with caution.
8465 (@code{gnus-summary-delete-article}).
8466
8467 @item B m
8468 @kindex B m (Summary)
8469 @cindex move mail
8470 @findex gnus-summary-move-article
8471 @vindex gnus-preserve-marks
8472 Move the article from one mail group to another
8473 (@code{gnus-summary-move-article}).  Marks will be preserved if
8474 @var{gnus-preserve-marks} is non-@code{nil} (which is the default). 
8475
8476 @item B c
8477 @kindex B c (Summary)
8478 @cindex copy mail
8479 @findex gnus-summary-copy-article
8480 @c @icon{gnus-summary-mail-copy}
8481 Copy the article from one group (mail group or not) to a mail group
8482 (@code{gnus-summary-copy-article}).  Marks will be preserved if
8483 @var{gnus-preserve-marks} is non-@code{nil} (which is the default).
8484
8485 @item B B
8486 @kindex B B (Summary)
8487 @cindex crosspost mail
8488 @findex gnus-summary-crosspost-article
8489 Crosspost the current article to some other group
8490 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
8491 the article in the other group, and the Xref headers of the article will
8492 be properly updated.
8493
8494 @item B i
8495 @kindex B i (Summary)
8496 @findex gnus-summary-import-article
8497 Import an arbitrary file into the current mail newsgroup
8498 (@code{gnus-summary-import-article}).  You will be prompted for a file
8499 name, a @code{From} header and a @code{Subject} header.
8500
8501 @item B r
8502 @kindex B r (Summary)
8503 @findex gnus-summary-respool-article
8504 Respool the mail article (@code{gnus-summary-respool-article}).
8505 @code{gnus-summary-respool-default-method} will be used as the default
8506 select method when respooling.  This variable is @code{nil} by default,
8507 which means that the current group select method will be used instead.
8508 Marks will be preserved if @var{gnus-preserve-marks} is non-@code{nil}
8509 (which is the default).
8510
8511 @item B w
8512 @itemx e
8513 @kindex B w (Summary)
8514 @kindex e (Summary)
8515 @findex gnus-summary-edit-article
8516 @kindex C-c C-c (Article)
8517 Edit the current article (@code{gnus-summary-edit-article}).  To finish
8518 editing and make the changes permanent, type @kbd{C-c C-c}
8519 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
8520 @kbd{C-c C-c} command, gnus won't re-highlight the article.
8521
8522 @item B q
8523 @kindex B q (Summary)
8524 @findex gnus-summary-respool-query
8525 If you want to re-spool an article, you might be curious as to what group
8526 the article will end up in before you do the re-spooling.  This command
8527 will tell you (@code{gnus-summary-respool-query}).
8528
8529 @item B t
8530 @kindex B t (Summary)
8531 @findex gnus-summary-respool-trace
8532 Similarly, this command will display all fancy splitting patterns used
8533 when repooling, if any (@code{gnus-summary-respool-trace}).
8534
8535 @item B p
8536 @kindex B p (Summary)
8537 @findex gnus-summary-article-posted-p
8538 Some people have a tendency to send you "courtesy" copies when they
8539 follow up to articles you have posted.  These usually have a
8540 @code{Newsgroups} header in them, but not always.  This command
8541 (@code{gnus-summary-article-posted-p}) will try to fetch the current
8542 article from your news server (or rather, from
8543 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
8544 report back whether it found the article or not.  Even if it says that
8545 it didn't find the article, it may have been posted anyway---mail
8546 propagation is much faster than news propagation, and the news copy may
8547 just not have arrived yet.
8548
8549 @end table
8550
8551 @vindex gnus-move-split-methods
8552 @cindex moving articles
8553 If you move (or copy) articles regularly, you might wish to have gnus
8554 suggest where to put the articles.  @code{gnus-move-split-methods} is a
8555 variable that uses the same syntax as @code{gnus-split-methods}
8556 (@pxref{Saving Articles}).  You may customize that variable to create
8557 suggestions you find reasonable.  (Note that
8558 @code{gnus-move-split-methods} uses group names where
8559 @code{gnus-split-methods} uses file names.)
8560
8561 @lisp
8562 (setq gnus-move-split-methods
8563       '(("^From:.*Lars Magne" "nnml:junk")
8564         ("^Subject:.*gnus" "nnfolder:important")
8565         (".*" "nnml:misc")))
8566 @end lisp
8567
8568
8569 @node Various Summary Stuff
8570 @section Various Summary Stuff
8571
8572 @menu
8573 * Summary Group Information::         Information oriented commands.
8574 * Searching for Articles::            Multiple article commands.
8575 * Summary Generation Commands::       (Re)generating the summary buffer.
8576 * Really Various Summary Commands::   Those pesky non-conformant commands.
8577 @end menu
8578
8579 @table @code
8580 @vindex gnus-summary-mode-hook
8581 @item gnus-summary-mode-hook
8582 This hook is called when creating a summary mode buffer.
8583
8584 @vindex gnus-summary-generate-hook
8585 @item gnus-summary-generate-hook
8586 This is called as the last thing before doing the threading and the
8587 generation of the summary buffer.  It's quite convenient for customizing
8588 the threading variables based on what data the newsgroup has.  This hook
8589 is called from the summary buffer after most summary buffer variables
8590 have been set.
8591
8592 @vindex gnus-summary-prepare-hook
8593 @item gnus-summary-prepare-hook
8594 It is called after the summary buffer has been generated.  You might use
8595 it to, for instance, highlight lines or modify the look of the buffer in
8596 some other ungodly manner.  I don't care.
8597
8598 @vindex gnus-summary-prepared-hook
8599 @item gnus-summary-prepared-hook
8600 A hook called as the very last thing after the summary buffer has been
8601 generated.
8602
8603 @vindex gnus-summary-ignore-duplicates
8604 @item gnus-summary-ignore-duplicates
8605 When gnus discovers two articles that have the same @code{Message-ID},
8606 it has to do something drastic.  No articles are allowed to have the
8607 same @code{Message-ID}, but this may happen when reading mail from some
8608 sources.  Gnus allows you to customize what happens with this variable.
8609 If it is @code{nil} (which is the default), gnus will rename the
8610 @code{Message-ID} (for display purposes only) and display the article as
8611 any other article.  If this variable is @code{t}, it won't display the
8612 article---it'll be as if it never existed.
8613
8614 @vindex gnus-alter-articles-to-read-function
8615 @item gnus-alter-articles-to-read-function
8616 This function, which takes two parameters (the group name and the list
8617 of articles to be selected), is called to allow the user to alter the
8618 list of articles to be selected.
8619
8620 For instance, the following function adds the list of cached articles to
8621 the list in one particular group:
8622
8623 @lisp
8624 (defun my-add-cached-articles (group articles)
8625   (if (string= group "some.group")
8626       (append gnus-newsgroup-cached articles)
8627     articles))
8628 @end lisp
8629
8630 @end table
8631
8632
8633 @node Summary Group Information
8634 @subsection Summary Group Information
8635
8636 @table @kbd
8637
8638 @item H f
8639 @kindex H f (Summary)
8640 @findex gnus-summary-fetch-faq
8641 @vindex gnus-group-faq-directory
8642 Try to fetch the FAQ (list of frequently asked questions) for the
8643 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
8644 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
8645 on a remote machine.  This variable can also be a list of directories.
8646 In that case, giving a prefix to this command will allow you to choose
8647 between the various sites.  @code{ange-ftp} or @code{efs} will probably
8648 be used for fetching the file.
8649
8650 @item H d
8651 @kindex H d (Summary)
8652 @findex gnus-summary-describe-group
8653 Give a brief description of the current group
8654 (@code{gnus-summary-describe-group}).  If given a prefix, force
8655 rereading the description from the server.
8656
8657 @item H h
8658 @kindex H h (Summary)
8659 @findex gnus-summary-describe-briefly
8660 Give an extremely brief description of the most important summary
8661 keystrokes (@code{gnus-summary-describe-briefly}).
8662
8663 @item H i
8664 @kindex H i (Summary)
8665 @findex gnus-info-find-node
8666 Go to the gnus info node (@code{gnus-info-find-node}).
8667 @end table
8668
8669
8670 @node Searching for Articles
8671 @subsection Searching for Articles
8672
8673 @table @kbd
8674
8675 @item M-s
8676 @kindex M-s (Summary)
8677 @findex gnus-summary-search-article-forward
8678 Search through all subsequent articles for a regexp
8679 (@code{gnus-summary-search-article-forward}).
8680
8681 @item M-r
8682 @kindex M-r (Summary)
8683 @findex gnus-summary-search-article-backward
8684 Search through all previous articles for a regexp
8685 (@code{gnus-summary-search-article-backward}).
8686
8687 @item &
8688 @kindex & (Summary)
8689 @findex gnus-summary-execute-command
8690 This command will prompt you for a header, a regular expression to match
8691 on this field, and a command to be executed if the match is made
8692 (@code{gnus-summary-execute-command}).  If the header is an empty
8693 string, the match is done on the entire article.  If given a prefix,
8694 search backward instead.
8695
8696 For instance, @kbd{& RET some.*string #} will put the process mark on
8697 all articles that have heads or bodies that match @samp{some.*string}.
8698
8699 @item M-&
8700 @kindex M-& (Summary)
8701 @findex gnus-summary-universal-argument
8702 Perform any operation on all articles that have been marked with
8703 the process mark (@code{gnus-summary-universal-argument}).
8704 @end table
8705
8706 @node Summary Generation Commands
8707 @subsection Summary Generation Commands
8708
8709 @table @kbd
8710
8711 @item Y g
8712 @kindex Y g (Summary)
8713 @findex gnus-summary-prepare
8714 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
8715
8716 @item Y c
8717 @kindex Y c (Summary)
8718 @findex gnus-summary-insert-cached-articles
8719 Pull all cached articles (for the current group) into the summary buffer
8720 (@code{gnus-summary-insert-cached-articles}).
8721
8722 @end table
8723
8724
8725 @node Really Various Summary Commands
8726 @subsection Really Various Summary Commands
8727
8728 @table @kbd
8729
8730 @item A D
8731 @itemx C-d
8732 @kindex C-d (Summary)
8733 @kindex A D (Summary)
8734 @findex gnus-summary-enter-digest-group
8735 If the current article is a collection of other articles (for instance,
8736 a digest), you might use this command to enter a group based on the that
8737 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
8738 guess what article type is currently displayed unless you give a prefix
8739 to this command, which forces a ``digest'' interpretation.  Basically,
8740 whenever you see a message that is a collection of other messages of
8741 some format, you @kbd{C-d} and read these messages in a more convenient
8742 fashion.
8743
8744 @item M-C-d
8745 @kindex M-C-d (Summary)
8746 @findex gnus-summary-read-document
8747 This command is very similar to the one above, but lets you gather
8748 several documents into one biiig group
8749 (@code{gnus-summary-read-document}).  It does this by opening several
8750 @code{nndoc} groups for each document, and then opening an
8751 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
8752 command understands the process/prefix convention
8753 (@pxref{Process/Prefix}).
8754
8755 @item C-t
8756 @kindex C-t (Summary)
8757 @findex gnus-summary-toggle-truncation
8758 Toggle truncation of summary lines
8759 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
8760 line centering function in the summary buffer, so it's not a good idea
8761 to have truncation switched off while reading articles.
8762
8763 @item =
8764 @kindex = (Summary)
8765 @findex gnus-summary-expand-window
8766 Expand the summary buffer window (@code{gnus-summary-expand-window}).
8767 If given a prefix, force an @code{article} window configuration.
8768
8769 @item M-C-e
8770 @kindex M-C-e (Summary)
8771 @findex gnus-summary-edit-parameters
8772 Edit the group parameters (@pxref{Group Parameters}) of the current
8773 group (@code{gnus-summary-edit-parameters}).
8774
8775 @item M-C-a
8776 @kindex M-C-a (Summary)
8777 @findex gnus-summary-customize-parameters
8778 Customize the group parameters (@pxref{Group Parameters}) of the current
8779 group (@code{gnus-summary-customize-parameters}).
8780
8781 @end table
8782
8783
8784 @node Exiting the Summary Buffer
8785 @section Exiting the Summary Buffer
8786 @cindex summary exit
8787 @cindex exiting groups
8788
8789 Exiting from the summary buffer will normally update all info on the
8790 group and return you to the group buffer.
8791
8792 @table @kbd
8793
8794 @item Z Z
8795 @itemx q
8796 @kindex Z Z (Summary)
8797 @kindex q (Summary)
8798 @findex gnus-summary-exit
8799 @vindex gnus-summary-exit-hook
8800 @vindex gnus-summary-prepare-exit-hook
8801 @c @icon{gnus-summary-exit}
8802 Exit the current group and update all information on the group
8803 (@code{gnus-summary-exit}).  @code{gnus-summary-prepare-exit-hook} is
8804 called before doing much of the exiting, which calls
8805 @code{gnus-summary-expire-articles} by default.
8806 @code{gnus-summary-exit-hook} is called after finishing the exit
8807 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
8808 group mode having no more (unread) groups.
8809
8810 @item Z E
8811 @itemx Q
8812 @kindex Z E (Summary)
8813 @kindex Q (Summary)
8814 @findex gnus-summary-exit-no-update
8815 Exit the current group without updating any information on the group
8816 (@code{gnus-summary-exit-no-update}).
8817
8818 @item Z c
8819 @itemx c
8820 @kindex Z c (Summary)
8821 @kindex c (Summary)
8822 @findex gnus-summary-catchup-and-exit
8823 @c @icon{gnus-summary-catchup-and-exit}
8824 Mark all unticked articles in the group as read and then exit
8825 (@code{gnus-summary-catchup-and-exit}).
8826
8827 @item Z C
8828 @kindex Z C (Summary)
8829 @findex gnus-summary-catchup-all-and-exit
8830 Mark all articles, even the ticked ones, as read and then exit
8831 (@code{gnus-summary-catchup-all-and-exit}).
8832
8833 @item Z n
8834 @kindex Z n (Summary)
8835 @findex gnus-summary-catchup-and-goto-next-group
8836 Mark all articles as read and go to the next group
8837 (@code{gnus-summary-catchup-and-goto-next-group}).
8838
8839 @item Z R
8840 @kindex Z R (Summary)
8841 @findex gnus-summary-reselect-current-group
8842 Exit this group, and then enter it again
8843 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
8844 all articles, both read and unread.
8845
8846 @item Z G
8847 @itemx M-g
8848 @kindex Z G (Summary)
8849 @kindex M-g (Summary)
8850 @findex gnus-summary-rescan-group
8851 @c @icon{gnus-summary-mail-get}
8852 Exit the group, check for new articles in the group, and select the
8853 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
8854 articles, both read and unread.
8855
8856 @item Z N
8857 @kindex Z N (Summary)
8858 @findex gnus-summary-next-group
8859 Exit the group and go to the next group
8860 (@code{gnus-summary-next-group}).
8861
8862 @item Z P
8863 @kindex Z P (Summary)
8864 @findex gnus-summary-prev-group
8865 Exit the group and go to the previous group
8866 (@code{gnus-summary-prev-group}).
8867
8868 @item Z s
8869 @kindex Z s (Summary)
8870 @findex gnus-summary-save-newsrc
8871 Save the current number of read/marked articles in the dribble buffer
8872 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
8873 given a prefix, also save the @file{.newsrc} file(s).  Using this
8874 command will make exit without updating (the @kbd{Q} command) worthless.
8875 @end table
8876
8877 @vindex gnus-exit-group-hook
8878 @code{gnus-exit-group-hook} is called when you exit the current group
8879 with an ``updating'' exit.  For instance @kbd{Q}
8880 (@code{gnus-summary-exit-no-update}) does not call this hook.
8881
8882 @findex gnus-summary-wake-up-the-dead
8883 @findex gnus-dead-summary-mode
8884 @vindex gnus-kill-summary-on-exit
8885 If you're in the habit of exiting groups, and then changing your mind
8886 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8887 If you do that, gnus won't kill the summary buffer when you exit it.
8888 (Quelle surprise!)  Instead it will change the name of the buffer to
8889 something like @samp{*Dead Summary ... *} and install a minor mode
8890 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
8891 buffer, you'll find that all keys are mapped to a function called
8892 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
8893 summary buffer will result in a live, normal summary buffer.
8894
8895 There will never be more than one dead summary buffer at any one time.
8896
8897 @vindex gnus-use-cross-reference
8898 The data on the current group will be updated (which articles you have
8899 read, which articles you have replied to, etc.) when you exit the
8900 summary buffer.  If the @code{gnus-use-cross-reference} variable is
8901 @code{t} (which is the default), articles that are cross-referenced to
8902 this group and are marked as read, will also be marked as read in the
8903 other subscribed groups they were cross-posted to.  If this variable is
8904 neither @code{nil} nor @code{t}, the article will be marked as read in
8905 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8906
8907
8908 @node Crosspost Handling
8909 @section Crosspost Handling
8910
8911 @cindex velveeta
8912 @cindex spamming
8913 Marking cross-posted articles as read ensures that you'll never have to
8914 read the same article more than once.  Unless, of course, somebody has
8915 posted it to several groups separately.  Posting the same article to
8916 several groups (not cross-posting) is called @dfn{spamming}, and you are
8917 by law required to send nasty-grams to anyone who perpetrates such a
8918 heinous crime.  You may want to try NoCeM handling to filter out spam
8919 (@pxref{NoCeM}).
8920
8921 Remember: Cross-posting is kinda ok, but posting the same article
8922 separately to several groups is not.  Massive cross-posting (aka.
8923 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8924 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8925 excessive crossposting (@pxref{Summary Mail Commands}).
8926
8927 @cindex cross-posting
8928 @cindex Xref
8929 @cindex @sc{nov}
8930 One thing that may cause Gnus to not do the cross-posting thing
8931 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8932 (which is very nice, because it speeds things up considerably) which
8933 does not include the @code{Xref} header in its @sc{nov} lines.  This is
8934 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
8935 even with @sc{xover} by registering the @code{Xref} lines of all
8936 articles you actually read, but if you kill the articles, or just mark
8937 them as read without reading them, Gnus will not get a chance to snoop
8938 the @code{Xref} lines out of these articles, and will be unable to use
8939 the cross reference mechanism.
8940
8941 @cindex LIST overview.fmt
8942 @cindex overview.fmt
8943 To check whether your @sc{nntp} server includes the @code{Xref} header
8944 in its overview files, try @samp{telnet your.nntp.server nntp},
8945 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8946 overview.fmt}.  This may not work, but if it does, and the last line you
8947 get does not read @samp{Xref:full}, then you should shout and whine at
8948 your news admin until she includes the @code{Xref} header in the
8949 overview files.
8950
8951 @vindex gnus-nov-is-evil
8952 If you want Gnus to get the @code{Xref}s right all the time, you have to
8953 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8954 considerably.
8955
8956 C'est la vie.
8957
8958 For an alternative approach, @pxref{Duplicate Suppression}.
8959
8960
8961 @node Duplicate Suppression
8962 @section Duplicate Suppression
8963
8964 By default, gnus tries to make sure that you don't have to read the same
8965 article more than once by utilizing the crossposting mechanism
8966 (@pxref{Crosspost Handling}).  However, that simple and efficient
8967 approach may not work satisfactory for some users for various
8968 reasons.
8969
8970 @enumerate
8971 @item
8972 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
8973 is evil and not very common.
8974
8975 @item
8976 The @sc{nntp} server may fail to include the @code{Xref} header in the
8977 @file{.overview} data bases.  This is evil and all too common, alas.
8978
8979 @item
8980 You may be reading the same group (or several related groups) from
8981 different @sc{nntp} servers.
8982
8983 @item
8984 You may be getting mail that duplicates articles posted to groups.
8985 @end enumerate
8986
8987 I'm sure there are other situations where @code{Xref} handling fails as
8988 well, but these four are the most common situations.
8989
8990 If, and only if, @code{Xref} handling fails for you, then you may
8991 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
8992 will remember the @code{Message-ID}s of all articles you have read or
8993 otherwise marked as read, and then, as if by magic, mark them as read
8994 all subsequent times you see them---in @emph{all} groups.  Using this
8995 mechanism is quite likely to be somewhat inefficient, but not overly
8996 so.  It's certainly preferable to reading the same articles more than
8997 once.
8998
8999 Duplicate suppression is not a very subtle instrument.  It's more like a
9000 sledge hammer than anything else.  It works in a very simple
9001 fashion---if you have marked an article as read, it adds this Message-ID
9002 to a cache.  The next time it sees this Message-ID, it will mark the
9003 article as read with the @samp{M} mark.  It doesn't care what group it
9004 saw the article in.
9005
9006 @table @code
9007 @item gnus-suppress-duplicates
9008 @vindex gnus-suppress-duplicates
9009 If non-@code{nil}, suppress duplicates.
9010
9011 @item gnus-save-duplicate-list
9012 @vindex gnus-save-duplicate-list
9013 If non-@code{nil}, save the list of duplicates to a file.  This will
9014 make startup and shutdown take longer, so the default is @code{nil}.
9015 However, this means that only duplicate articles read in a single gnus
9016 session are suppressed.
9017
9018 @item gnus-duplicate-list-length
9019 @vindex gnus-duplicate-list-length
9020 This variable says how many @code{Message-ID}s to keep in the duplicate
9021 suppression list.  The default is 10000.
9022
9023 @item gnus-duplicate-file
9024 @vindex gnus-duplicate-file
9025 The name of the file to store the duplicate suppression list in.  The
9026 default is @file{~/News/suppression}.
9027 @end table
9028
9029 If you have a tendency to stop and start gnus often, setting
9030 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
9031 you leave gnus running for weeks on end, you may have it @code{nil}.  On
9032 the other hand, saving the list makes startup and shutdown much slower,
9033 so that means that if you stop and start gnus often, you should set
9034 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
9035 to you to figure out, I think.
9036
9037 @node Security
9038 @section Security
9039
9040 Gnus is able to verify PGP or S/MIME signed messages or decrypt PGP
9041 encrypted messages.
9042
9043 @enumerate
9044 @item 
9045 To verify or decrypt PGP messages, you have to install mailcrypt or
9046 gpg.el.
9047
9048 @end enumerate
9049
9050 @table @code
9051 @item mm-verify-option
9052 @vindex mm-verify-option
9053 Option of verifying signed parts.  @code{never}, not verify;
9054 @code{always}, always verify; @code{known}, only verify known
9055 protocols. Otherwise, ask user.
9056
9057 @item mm-decrypt-option
9058 @vindex mm-decrypt-option
9059 Option of decrypting encrypted parts.  @code{never}, no decryption;
9060 @code{always}, always decrypt @code{known}, only decrypt known
9061 protocols. Otherwise, ask user.
9062
9063 @end table
9064
9065 @node The Article Buffer
9066 @chapter The Article Buffer
9067 @cindex article buffer
9068
9069 The articles are displayed in the article buffer, of which there is only
9070 one.  All the summary buffers share the same article buffer unless you
9071 tell gnus otherwise.
9072
9073 @menu
9074 * Hiding Headers::        Deciding what headers should be displayed.
9075 * Using MIME::            Pushing articles through @sc{mime} before reading them.
9076 * Customizing Articles::  Tailoring the look of the articles.
9077 * Article Keymap::        Keystrokes available in the article buffer.
9078 * Misc Article::          Other stuff.
9079 @end menu
9080
9081
9082 @node Hiding Headers
9083 @section Hiding Headers
9084 @cindex hiding headers
9085 @cindex deleting headers
9086
9087 The top section of each article is the @dfn{head}.  (The rest is the
9088 @dfn{body}, but you may have guessed that already.)
9089
9090 @vindex gnus-show-all-headers
9091 There is a lot of useful information in the head: the name of the person
9092 who wrote the article, the date it was written and the subject of the
9093 article.  That's well and nice, but there's also lots of information
9094 most people do not want to see---what systems the article has passed
9095 through before reaching you, the @code{Message-ID}, the
9096 @code{References}, etc. ad nauseum---and you'll probably want to get rid
9097 of some of those lines.  If you want to keep all those lines in the
9098 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
9099
9100 Gnus provides you with two variables for sifting headers:
9101
9102 @table @code
9103
9104 @item gnus-visible-headers
9105 @vindex gnus-visible-headers
9106 If this variable is non-@code{nil}, it should be a regular expression
9107 that says what headers you wish to keep in the article buffer.  All
9108 headers that do not match this variable will be hidden.
9109
9110 For instance, if you only want to see the name of the person who wrote
9111 the article and the subject, you'd say:
9112
9113 @lisp
9114 (setq gnus-visible-headers "^From:\\|^Subject:")
9115 @end lisp
9116
9117 This variable can also be a list of regexps to match headers to
9118 remain visible.
9119
9120 @item gnus-ignored-headers
9121 @vindex gnus-ignored-headers
9122 This variable is the reverse of @code{gnus-visible-headers}.  If this
9123 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
9124 should be a regular expression that matches all lines that you want to
9125 hide.  All lines that do not match this variable will remain visible.
9126
9127 For instance, if you just want to get rid of the @code{References} field
9128 and the @code{Xref} field, you might say:
9129
9130 @lisp
9131 (setq gnus-ignored-headers "^References:\\|^Xref:")
9132 @end lisp
9133
9134 This variable can also be a list of regexps to match headers to
9135 be removed.
9136
9137 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
9138 variable will have no effect.
9139
9140 @end table
9141
9142 @vindex gnus-sorted-header-list
9143 Gnus can also sort the headers for you.  (It does this by default.)  You
9144 can control the sorting by setting the @code{gnus-sorted-header-list}
9145 variable.  It is a list of regular expressions that says in what order
9146 the headers are to be displayed.
9147
9148 For instance, if you want the name of the author of the article first,
9149 and then the subject, you might say something like:
9150
9151 @lisp
9152 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
9153 @end lisp
9154
9155 Any headers that are to remain visible, but are not listed in this
9156 variable, will be displayed in random order after all the headers listed in this variable.
9157
9158 @findex gnus-article-hide-boring-headers
9159 @vindex gnus-boring-article-headers
9160 You can hide further boring headers by setting
9161 @code{gnus-treat-hide-boring-headers} to @code{head}.  What this function
9162 does depends on the @code{gnus-boring-article-headers} variable.  It's a
9163 list, but this list doesn't actually contain header names.  Instead is
9164 lists various @dfn{boring conditions} that Gnus can check and remove
9165 from sight.
9166
9167 These conditions are:
9168 @table @code
9169 @item empty
9170 Remove all empty headers.
9171 @item followup-to
9172 Remove the @code{Followup-To} header if it is identical to the
9173 @code{Newsgroups} header.
9174 @item reply-to
9175 Remove the @code{Reply-To} header if it lists the same address as the
9176 @code{From} header.
9177 @item newsgroups
9178 Remove the @code{Newsgroups} header if it only contains the current group
9179 name.
9180 @item date
9181 Remove the @code{Date} header if the article is less than three days
9182 old.
9183 @item long-to
9184 Remove the @code{To} header if it is very long.
9185 @item many-to
9186 Remove all @code{To} headers if there are more than one.
9187 @end table
9188
9189 To include the four three elements, you could say something like;
9190
9191 @lisp
9192 (setq gnus-boring-article-headers
9193       '(empty followup-to reply-to))
9194 @end lisp
9195
9196 This is also the default value for this variable.
9197
9198
9199 @node Using MIME
9200 @section Using @sc{mime}
9201 @cindex @sc{mime}
9202
9203 Mime is a standard for waving your hands through the air, aimlessly,
9204 while people stand around yawning.
9205
9206 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
9207 while all newsreaders die of fear.
9208
9209 @sc{mime} may specify what character set the article uses, the encoding
9210 of the characters, and it also makes it possible to embed pictures and
9211 other naughty stuff in innocent-looking articles.
9212
9213 @vindex gnus-show-mime
9214 @vindex gnus-article-display-method-for-mime
9215 @vindex gnus-strict-mime
9216 @findex gnus-article-display-mime-message
9217 Gnus handles @sc{mime} by pushing the articles through
9218 @code{gnus-article-display-method-for-mime}, which is
9219 @code{gnus-article-display-mime-message} by default.  This function
9220 calls the SEMI MIME-View program to actually do the work.  For more
9221 information on SEMI MIME-View, see its manual page (however it is not
9222 existed yet, sorry).
9223
9224 Set @code{gnus-show-mime} to @code{t} if you want to use
9225 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
9226 non-@code{nil}, the @sc{mime} method will only be used if there are
9227 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
9228 set, then you'll see some unfortunate display glitches in the article
9229 buffer.  These can't be avoided.
9230
9231 In GNUS or Gnus, it might be best to just use the toggling functions
9232 from the summary buffer to avoid getting nasty surprises. (For instance,
9233 you enter the group @samp{alt.sing-a-long} and, before you know it,
9234 @sc{mime} has decoded the sound file in the article and some horrible
9235 sing-a-long song comes screaming out your speakers, and you can't find
9236 the volume button, because there isn't one, and people are starting to
9237 look at you, and you try to stop the program, but you can't, and you
9238 can't find the program to control the volume, and everybody else in the
9239 room suddenly decides to look at you disdainfully, and you'll feel
9240 rather stupid.)
9241
9242 Any similarity to real events and people is purely coincidental.  Ahem.
9243
9244 To avoid such kind of situation, gnus stops to use
9245 @code{metamail-buffer}.  So now, you can set @code{gnus-show-mime} to
9246 non-@code{nil} every-time, then you can push button in the article
9247 buffer when there are nobody else.
9248
9249 Also see @pxref{MIME Commands}.
9250
9251
9252 @node Customizing Articles
9253 @section Customizing Articles
9254 @cindex article customization
9255
9256 A slew of functions for customizing how the articles are to look like
9257 exist.  You can call these functions interactively, or you can have them
9258 called automatically when you select the articles.
9259
9260 To have them called automatically, you should set the corresponding
9261 ``treatment'' variable.  For instance, to have headers hidden, you'd set
9262 @code{gnus-treat-hide-headers}.  Below is a list of variables that can
9263 be set, but first we discuss the values these variables can have.
9264
9265 Note: Some values, while valid, make little sense.  Check the list below
9266 for sensible values.
9267
9268 @enumerate
9269 @item
9270 @code{nil}: Don't do this treatment.
9271
9272 @item
9273 @code{t}: Do this treatment on all body parts.
9274
9275 @item
9276 @code{head}: Do the treatment on the headers.
9277
9278 @item
9279 @code{last}: Do this treatment on the last part.
9280
9281 @item
9282 An integer: Do this treatment on all body parts that have a length less
9283 than this number.
9284
9285 @item
9286 A list of strings: Do this treatment on all body parts that are in
9287 articles that are read in groups that have names that match one of the
9288 regexps in the list.
9289
9290 @item
9291 A list where the first element is not a string:
9292
9293 The list is evaluated recursively.  The first element of the list is a
9294 predicate.  The following predicates are recognized: @code{or},
9295 @code{and}, @code{not} and @code{typep}.  Here's an example:
9296
9297 @lisp
9298 (or last
9299     (typep "text/x-vcard"))
9300 @end lisp
9301
9302 @item
9303 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
9304 non-nil.
9305
9306 @end enumerate
9307
9308 You may have noticed that the word @dfn{part} is used here.  This refers
9309 to the fact that some messages are @sc{mime} multipart articles that may
9310 be divided into several parts.  Articles that are not multiparts are
9311 considered to contain just a single part.
9312
9313 @vindex gnus-article-treat-types
9314 Are the treatments applied to all sorts of multipart parts?  Yes, if you
9315 want to, but by default, only @samp{text/plain} parts are given the
9316 treatment.  This is controlled by the @code{gnus-article-treat-types}
9317 variable, which is a list of regular expressions that are matched to the
9318 type of the part.  This variable is ignored if the value of the
9319 controlling variable is a predicate list, as described above.
9320
9321 The following treatment options are available.  The easiest way to
9322 customize this is to examine the @code{gnus-article-treat} customization
9323 group.  Values in parenthesis are suggested sensible values.  Others are
9324 possible but those listed are probably sufficient for most people.
9325
9326 @table @code
9327 @item gnus-treat-highlight-signature (t, last)
9328 @item gnus-treat-buttonize (t, integer)
9329 @item gnus-treat-buttonize-head (head)
9330 @item gnus-treat-emphasize (t, head, integer)
9331 @item gnus-treat-fill-article (t, integer)
9332 @item gnus-treat-strip-cr (t, integer)
9333 @item gnus-treat-hide-headers (head)
9334 @item gnus-treat-hide-boring-headers (head)
9335 @item gnus-treat-hide-signature (t, last)
9336 @item gnus-treat-hide-citation (t, integer)
9337 @item gnus-treat-strip-pgp (t, last, integer)
9338 @item gnus-treat-strip-pem (t, last, integer)
9339 @item gnus-treat-highlight-headers (head)
9340 @item gnus-treat-highlight-citation (t, integer)
9341 @item gnus-treat-highlight-signature (t, last, integer)
9342 @item gnus-treat-date-ut (head)
9343 @item gnus-treat-date-local (head)
9344 @item gnus-treat-date-lapsed (head)
9345 @item gnus-treat-date-original (head)
9346 @item gnus-treat-strip-headers-in-body (t, integer)
9347 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
9348 @item gnus-treat-strip-leading-blank-lines (t, integer)
9349 @item gnus-treat-strip-multiple-blank-lines (t, integer)
9350 @item gnus-treat-overstrike (t, integer)
9351 @item gnus-treat-display-xface (head)
9352 @item gnus-treat-display-smileys (t, integer)
9353 @item gnus-treat-display-picons (head)
9354 @item gnus-treat-capitalize-sentences (t, integer)
9355 @item gnus-treat-fill-long-lines (t, integer)
9356 @item gnus-treat-play-sounds
9357 @item gnus-treat-translate
9358 @item gnus-treat-decode-article-as-default-mime-charset
9359 @end table
9360
9361 @vindex gnus-part-display-hook
9362 You can, of course, write your own functions to be called from
9363 @code{gnus-part-display-hook}.  The functions are called narrowed to the
9364 part, and you can do anything you like, pretty much.  There is no
9365 information that you have to keep in the buffer---you can change
9366 everything.  
9367
9368
9369 @node Article Keymap
9370 @section Article Keymap
9371
9372 Most of the keystrokes in the summary buffer can also be used in the
9373 article buffer.  They should behave as if you typed them in the summary
9374 buffer, which means that you don't actually have to have a summary
9375 buffer displayed while reading.  You can do it all from the article
9376 buffer.
9377
9378 A few additional keystrokes are available:
9379
9380 @table @kbd
9381
9382 @item SPACE
9383 @kindex SPACE (Article)
9384 @findex gnus-article-next-page
9385 Scroll forwards one page (@code{gnus-article-next-page}).
9386
9387 @item DEL
9388 @kindex DEL (Article)
9389 @findex gnus-article-prev-page
9390 Scroll backwards one page (@code{gnus-article-prev-page}).
9391
9392 @item C-c ^
9393 @kindex C-c ^ (Article)
9394 @findex gnus-article-refer-article
9395 If point is in the neighborhood of a @code{Message-ID} and you press
9396 @kbd{C-c ^}, Gnus will try to get that article from the server
9397 (@code{gnus-article-refer-article}).
9398
9399 @item C-c C-m
9400 @kindex C-c C-m (Article)
9401 @findex gnus-article-mail
9402 Send a reply to the address near point (@code{gnus-article-mail}).  If
9403 given a prefix, include the mail.
9404
9405 @item s
9406 @kindex s (Article)
9407 @findex gnus-article-show-summary
9408 Reconfigure the buffers so that the summary buffer becomes visible
9409 (@code{gnus-article-show-summary}).
9410
9411 @item ?
9412 @kindex ? (Article)
9413 @findex gnus-article-describe-briefly
9414 Give a very brief description of the available keystrokes
9415 (@code{gnus-article-describe-briefly}).
9416
9417 @item TAB
9418 @kindex TAB (Article)
9419 @findex gnus-article-next-button
9420 Go to the next button, if any (@code{gnus-article-next-button}).  This
9421 only makes sense if you have buttonizing turned on.
9422
9423 @item M-TAB
9424 @kindex M-TAB (Article)
9425 @findex gnus-article-prev-button
9426 Go to the previous button, if any (@code{gnus-article-prev-button}).
9427
9428 @end table
9429
9430
9431 @node Misc Article
9432 @section Misc Article
9433
9434 @table @code
9435
9436 @item gnus-single-article-buffer
9437 @vindex gnus-single-article-buffer
9438 If non-@code{nil}, use the same article buffer for all the groups.
9439 (This is the default.)  If @code{nil}, each group will have its own
9440 article buffer.
9441
9442 @vindex gnus-article-decode-hook
9443 @item gnus-article-decode-hook
9444 @cindex MIME
9445 Hook used to decode @sc{mime} articles.  The default value is
9446 @code{(article-decode-charset article-decode-encoded-words)}
9447
9448 @vindex gnus-article-prepare-hook
9449 @item gnus-article-prepare-hook
9450 This hook is called right after the article has been inserted into the
9451 article buffer.  It is mainly intended for functions that do something
9452 depending on the contents; it should probably not be used for changing
9453 the contents of the article buffer.
9454
9455 @item gnus-article-mode-hook
9456 @vindex gnus-article-mode-hook
9457 Hook called in article mode buffers.
9458
9459 @item gnus-article-mode-syntax-table
9460 @vindex gnus-article-mode-syntax-table
9461 Syntax table used in article buffers.  It is initialized from
9462 @code{text-mode-syntax-table}.
9463
9464 @vindex gnus-article-mode-line-format
9465 @item gnus-article-mode-line-format
9466 This variable is a format string along the same lines as
9467 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
9468 accepts the same format specifications as that variable, with two
9469 extensions:
9470
9471 @table @samp
9472 @item w
9473 The @dfn{wash status} of the article.  This is a short string with one
9474 character for each possible article wash operation that may have been
9475 performed.
9476 @item m
9477 The number of @sc{mime} parts in the article.
9478 @end table
9479
9480 @vindex gnus-break-pages
9481
9482 @item gnus-break-pages
9483 Controls whether @dfn{page breaking} is to take place.  If this variable
9484 is non-@code{nil}, the articles will be divided into pages whenever a
9485 page delimiter appears in the article.  If this variable is @code{nil},
9486 paging will not be done.
9487
9488 @item gnus-page-delimiter
9489 @vindex gnus-page-delimiter
9490 This is the delimiter mentioned above.  By default, it is @samp{^L}
9491 (formfeed).
9492 @end table
9493
9494
9495 @node Composing Messages
9496 @chapter Composing Messages
9497 @cindex composing messages
9498 @cindex messages
9499 @cindex mail
9500 @cindex sending mail
9501 @cindex reply
9502 @cindex followup
9503 @cindex post
9504 @cindex using gpg
9505
9506 @kindex C-c C-c (Post)
9507 All commands for posting and mailing will put you in a message buffer
9508 where you can edit the article all you like, before you send the
9509 article by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The
9510 Message Manual}.  Where the message will be posted/mailed to depends
9511 on your setup (@pxref{Posting Server}).
9512
9513 @menu
9514 * Mail::                 Mailing and replying.
9515 * Post::                 Posting and following up.
9516 * Posting Server::       What server should you post via?
9517 * Mail and Post::        Mailing and posting at the same time.
9518 * Archived Messages::    Where gnus stores the messages you've sent.
9519 * Posting Styles::       An easier way to specify who you are.
9520 * Drafts::               Postponing messages and rejected messages.
9521 * Rejected Articles::    What happens if the server doesn't like your article?
9522 * Using GPG::            How to use GPG and MML to sign and encrypt messages
9523 @end menu
9524
9525 Also see @pxref{Canceling and Superseding} for information on how to
9526 remove articles you shouldn't have posted.
9527
9528
9529 @node Mail
9530 @section Mail
9531
9532 Variables for customizing outgoing mail:
9533
9534 @table @code
9535 @item gnus-uu-digest-headers
9536 @vindex gnus-uu-digest-headers
9537 List of regexps to match headers included in digested messages.  The
9538 headers will be included in the sequence they are matched.
9539
9540 @item gnus-add-to-list
9541 @vindex gnus-add-to-list
9542 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
9543 that have none when you do a @kbd{a}.
9544
9545 @item message-send-mail-partially-limit
9546 @vindex message-send-mail-partially-limit
9547 The limitation of messages sent as message/partial.
9548 The lower bound of message size in characters, beyond which the message 
9549 should be sent in several parts. If it is nil, the size is unlimited.
9550
9551 @end table
9552
9553
9554 @node Post
9555 @section Post
9556
9557 Variables for composing news articles:
9558
9559 @table @code
9560 @item gnus-sent-message-ids-file
9561 @vindex gnus-sent-message-ids-file
9562 Gnus will keep a @code{Message-ID} history file of all the mails it has
9563 sent.  If it discovers that it has already sent a mail, it will ask the
9564 user whether to re-send the mail.  (This is primarily useful when
9565 dealing with @sc{soup} packets and the like where one is apt to send the
9566 same packet multiple times.)  This variable says what the name of this
9567 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
9568 this variable to @code{nil} if you don't want gnus to keep a history
9569 file.
9570
9571 @item gnus-sent-message-ids-length
9572 @vindex gnus-sent-message-ids-length
9573 This variable says how many @code{Message-ID}s to keep in the history
9574 file.  It is 1000 by default.
9575
9576 @end table
9577
9578
9579 @node Posting Server
9580 @section Posting Server
9581
9582 When you press those magical @kbd{C-c C-c} keys to ship off your latest
9583 (extremely intelligent, of course) article, where does it go?
9584
9585 Thank you for asking.  I hate you.
9586
9587 @vindex gnus-post-method
9588
9589 It can be quite complicated.  Normally, gnus will use the same native
9590 server.  However.  If your native server doesn't allow posting, just
9591 reading, you probably want to use some other server to post your
9592 (extremely intelligent and fabulously interesting) articles.  You can
9593 then set the @code{gnus-post-method} to some other method:
9594
9595 @lisp
9596 (setq gnus-post-method '(nnspool ""))
9597 @end lisp
9598
9599 Now, if you've done this, and then this server rejects your article, or
9600 this server is down, what do you do then?  To override this variable you
9601 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
9602 the ``current'' server for posting.
9603
9604 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
9605 gnus will prompt you for what method to use for posting.
9606
9607 You can also set @code{gnus-post-method} to a list of select methods.
9608 If that's the case, gnus will always prompt you for what method to use
9609 for posting.
9610
9611 Finally, if you want to always post using the same select method as
9612 you're reading from (which might be convenient if you're reading lots of
9613 groups from different private servers), you can set this variable to
9614 @code{current}.
9615
9616
9617 @node Mail and Post
9618 @section Mail and Post
9619
9620 Here's a list of variables relevant to both mailing and
9621 posting:
9622
9623 @table @code
9624 @item gnus-mailing-list-groups
9625 @findex gnus-mailing-list-groups
9626 @cindex mailing lists
9627
9628 If your news server offers groups that are really mailing lists
9629 gatewayed to the @sc{nntp} server, you can read those groups without
9630 problems, but you can't post/followup to them without some difficulty.
9631 One solution is to add a @code{to-address} to the group parameters
9632 (@pxref{Group Parameters}).  An easier thing to do is set the
9633 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
9634 really are mailing lists.  Then, at least, followups to the mailing
9635 lists will work most of the time.  Posting to these groups (@kbd{a}) is
9636 still a pain, though.
9637
9638 @end table
9639
9640 You may want to do spell-checking on messages that you send out.  Or, if
9641 you don't want to spell-check by hand, you could add automatic
9642 spell-checking via the @code{ispell} package:
9643
9644 @cindex ispell
9645 @findex ispell-message
9646 @lisp
9647 (add-hook 'message-send-hook 'ispell-message)
9648 @end lisp
9649
9650 If you want to change the @code{ispell} dictionary based on what group
9651 you're in, you could say something like the following:
9652
9653 @lisp
9654 (add-hook 'gnus-select-group-hook
9655           (lambda ()
9656             (cond
9657              ((string-match "^de\\." gnus-newsgroup-name)
9658               (ispell-change-dictionary "deutsch"))
9659              (t
9660               (ispell-change-dictionary "english")))))
9661 @end lisp
9662
9663 Modify to suit your needs.
9664
9665
9666 @node Archived Messages
9667 @section Archived Messages
9668 @cindex archived messages
9669 @cindex sent messages
9670
9671 Gnus provides a few different methods for storing the mail and news you
9672 send.  The default method is to use the @dfn{archive virtual server} to
9673 store the messages.  If you want to disable this completely, the
9674 @code{gnus-message-archive-group} variable should be @code{nil}, which
9675 is the default.
9676
9677 @vindex gnus-message-archive-method
9678 @code{gnus-message-archive-method} says what virtual server gnus is to
9679 use to store sent messages.  The default is:
9680
9681 @lisp
9682 (nnfolder "archive"
9683           (nnfolder-directory   "~/Mail/archive")
9684           (nnfolder-active-file "~/Mail/archive/active")
9685           (nnfolder-get-new-mail nil)
9686           (nnfolder-inhibit-expiry t))
9687 @end lisp
9688
9689 You can, however, use any mail select method (@code{nnml},
9690 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
9691 for doing this sort of thing, though.  If you don't like the default
9692 directory chosen, you could say something like:
9693
9694 @lisp
9695 (setq gnus-message-archive-method
9696       '(nnfolder "archive"
9697                  (nnfolder-inhibit-expiry t)
9698                  (nnfolder-active-file "~/News/sent-mail/active")
9699                  (nnfolder-directory "~/News/sent-mail/")))
9700 @end lisp
9701
9702 @vindex gnus-message-archive-group
9703 @cindex Gcc
9704 Gnus will insert @code{Gcc} headers in all outgoing messages that point
9705 to one or more group(s) on that server.  Which group to use is
9706 determined by the @code{gnus-message-archive-group} variable.
9707
9708 This variable can be used to do the following:
9709
9710 @itemize @bullet
9711 @item a string
9712 Messages will be saved in that group.
9713
9714 Note that you can include a select method in the group name, then the
9715 message will not be stored in the select method given by
9716 @code{gnus-message-archive-method}, but in the select method specified
9717 by the group name, instead.  Suppose @code{gnus-message-archive-method}
9718 has the default value shown above.  Then setting
9719 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
9720 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
9721 value @code{"nnml:foo"}, then outgoing messages will be stored in
9722 @samp{nnml:foo}.
9723 @item a list of strings
9724 Messages will be saved in all those groups.
9725 @item an alist of regexps, functions and forms
9726 When a key ``matches'', the result is used.
9727 @item @code{nil}
9728 No message archiving will take place.  This is the default.
9729 @end itemize
9730
9731 Let's illustrate:
9732
9733 Just saving to a single group called @samp{MisK}:
9734 @lisp
9735 (setq gnus-message-archive-group "MisK")
9736 @end lisp
9737
9738 Saving to two groups, @samp{MisK} and @samp{safe}:
9739 @lisp
9740 (setq gnus-message-archive-group '("MisK" "safe"))
9741 @end lisp
9742
9743 Save to different groups based on what group you are in:
9744 @lisp
9745 (setq gnus-message-archive-group
9746       '(("^alt" "sent-to-alt")
9747         ("mail" "sent-to-mail")
9748         (".*" "sent-to-misc")))
9749 @end lisp
9750
9751 More complex stuff:
9752 @lisp
9753 (setq gnus-message-archive-group
9754       '((if (message-news-p)
9755             "misc-news"
9756           "misc-mail")))
9757 @end lisp
9758
9759 How about storing all news messages in one file, but storing all mail
9760 messages in one file per month:
9761
9762 @lisp
9763 (setq gnus-message-archive-group
9764       '((if (message-news-p)
9765             "misc-news"
9766           (concat "mail." (format-time-string "%Y-%m")))))
9767 @end lisp
9768
9769 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
9770 use a different value for @code{gnus-message-archive-group} there.)
9771
9772 Now, when you send a message off, it will be stored in the appropriate
9773 group.  (If you want to disable storing for just one particular message,
9774 you can just remove the @code{Gcc} header that has been inserted.)  The
9775 archive group will appear in the group buffer the next time you start
9776 gnus, or the next time you press @kbd{F} in the group buffer.  You can
9777 enter it and read the articles in it just like you'd read any other
9778 group.  If the group gets really big and annoying, you can simply rename
9779 if (using @kbd{G r} in the group buffer) to something
9780 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
9781 continue to be stored in the old (now empty) group.
9782
9783 That's the default method of archiving sent messages.  Gnus offers a
9784 different way for the people who don't like the default method.  In that
9785 case you should set @code{gnus-message-archive-group} to @code{nil};
9786 this will disable archiving.
9787
9788 @table @code
9789 @item gnus-outgoing-message-group
9790 @vindex gnus-outgoing-message-group
9791 All outgoing messages will be put in this group.  If you want to store
9792 all your outgoing mail and articles in the group @samp{nnml:archive},
9793 you set this variable to that value.  This variable can also be a list of
9794 group names.
9795
9796 If you want to have greater control over what group to put each
9797 message in, you can set this variable to a function that checks the
9798 current newsgroup name and then returns a suitable group name (or list
9799 of names).
9800
9801 This variable can be used instead of @code{gnus-message-archive-group},
9802 but the latter is the preferred method.
9803
9804 @item gnus-inews-mark-gcc-as-read
9805 @vindex gnus-inews-mark-gcc-as-read
9806 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
9807
9808 @end table
9809
9810
9811 @node Posting Styles
9812 @section Posting Styles
9813 @cindex posting styles
9814 @cindex styles
9815
9816 All them variables, they make my head swim.
9817
9818 So what if you want a different @code{Organization} and signature based
9819 on what groups you post to?  And you post both from your home machine
9820 and your work machine, and you want different @code{From} lines, and so
9821 on?
9822
9823 @vindex gnus-posting-styles
9824 One way to do stuff like that is to write clever hooks that change the
9825 variables you need to have changed.  That's a bit boring, so somebody
9826 came up with the bright idea of letting the user specify these things in
9827 a handy alist.  Here's an example of a @code{gnus-posting-styles}
9828 variable:
9829
9830 @lisp
9831 ((".*"
9832   (signature "Peace and happiness")
9833   (organization "What me?"))
9834  ("^comp"
9835   (signature "Death to everybody"))
9836  ("comp.emacs.i-love-it"
9837   (organization "Emacs is it")))
9838 @end lisp
9839
9840 As you might surmise from this example, this alist consists of several
9841 @dfn{styles}.  Each style will be applicable if the first element
9842 ``matches'', in some form or other.  The entire alist will be iterated
9843 over, from the beginning towards the end, and each match will be
9844 applied, which means that attributes in later styles that match override
9845 the same attributes in earlier matching styles.  So
9846 @samp{comp.programming.literate} will have the @samp{Death to everybody}
9847 signature and the @samp{What me?} @code{Organization} header.
9848
9849 The first element in each style is called the @code{match}.  If it's a
9850 string, then Gnus will try to regexp match it against the group name.
9851 If it is the symbol @code{header}, then Gnus will look for header that
9852 match the next element in the match, and compare that to the last header
9853 in the match.  If it's a function symbol, that function will be called
9854 with no arguments.  If it's a variable symbol, then the variable will be
9855 referenced.  If it's a list, then that list will be @code{eval}ed.  In
9856 any case, if this returns a non-@code{nil} value, then the style is said
9857 to @dfn{match}.
9858
9859 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
9860 attribute consists of a @code{(@var{name} . @var{value})} pair.  The
9861 attribute name can be one of @code{signature}, @code{signature-file},
9862 @code{organization}, @code{address}, @code{name} or @code{body}.  The
9863 attribute name can also be a string.  In that case, this will be used as
9864 a header name, and the value will be inserted in the headers of the
9865 article; if the value is @code{nil}, the header name will be removed.
9866 If the attribute name is @code{eval}, the form is evaluated, and the
9867 result is thrown away.
9868
9869 The attribute value can be a string (used verbatim), a function with
9870 zero arguments (the return value will be used), a variable (its value
9871 will be used) or a list (it will be @code{eval}ed and the return value
9872 will be used).  The functions and sexps are called/@code{eval}ed in the
9873 message buffer that is being set up.  The headers of the current article
9874 are available through the @code{message-reply-headers} variable.
9875
9876 If you wish to check whether the message you are about to compose is
9877 meant to be a news article or a mail message, you can check the values
9878 of the @code{message-news-p} and @code{message-mail-p} functions.
9879
9880 @findex message-mail-p
9881 @findex message-news-p
9882
9883 So here's a new example:
9884
9885 @lisp
9886 (setq gnus-posting-styles
9887       '((".*"
9888          (signature-file "~/.signature")
9889          (name "User Name")
9890          ("X-Home-Page" (getenv "WWW_HOME"))
9891          (organization "People's Front Against MWM"))
9892         ("^rec.humor"
9893          (signature my-funny-signature-randomizer))
9894         ((equal (system-name) "gnarly")
9895          (signature my-quote-randomizer))
9896         ((message-news-p)
9897          (signature my-news-signature))
9898         (header "From\\|To" "larsi.*org"
9899          (Organization "Somewhere, Inc."))
9900         ((posting-from-work-p)
9901          (signature-file "~/.work-signature")
9902          (address "user@@bar.foo")
9903          (body "You are fired.\n\nSincerely, your boss.")
9904          (organization "Important Work, Inc"))
9905         ("^nn.+:"
9906          (signature-file "~/.mail-signature"))))
9907 @end lisp
9908
9909
9910 @node Drafts
9911 @section Drafts
9912 @cindex drafts
9913
9914 If you are writing a message (mail or news) and suddenly remember that
9915 you have a steak in the oven (or some pesto in the food processor, you
9916 craaazy vegetarians), you'll probably wish there was a method to save
9917 the message you are writing so that you can continue editing it some
9918 other day, and send it when you feel its finished.
9919
9920 Well, don't worry about it.  Whenever you start composing a message of
9921 some sort using the gnus mail and post commands, the buffer you get will
9922 automatically associate to an article in a special @dfn{draft} group.
9923 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9924 article will be saved there.  (Auto-save files also go to the draft
9925 group.)
9926
9927 @cindex nndraft
9928 @vindex nndraft-directory
9929 The draft group is a special group (which is implemented as an
9930 @code{nndraft} group, if you absolutely have to know) called
9931 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
9932 @code{nndraft} is to store its files.  What makes this group special is
9933 that you can't tick any articles in it or mark any articles as
9934 read---all articles in the group are permanently unread.
9935
9936 If the group doesn't exist, it will be created and you'll be subscribed
9937 to it.  The only way to make it disappear from the Group buffer is to
9938 unsubscribe it.
9939
9940 @c @findex gnus-dissociate-buffer-from-draft
9941 @c @kindex C-c M-d (Mail)
9942 @c @kindex C-c M-d (Post)
9943 @c @findex gnus-associate-buffer-with-draft
9944 @c @kindex C-c C-d (Mail)
9945 @c @kindex C-c C-d (Post)
9946 @c If you're writing some super-secret message that you later want to
9947 @c encode with PGP before sending, you may wish to turn the auto-saving
9948 @c (and association with the draft group) off.  You never know who might be
9949 @c interested in reading all your extremely valuable and terribly horrible
9950 @c and interesting secrets.  The @kbd{C-c M-d}
9951 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9952 @c If you change your mind and want to turn the auto-saving back on again,
9953 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9954 @c
9955 @c @vindex gnus-use-draft
9956 @c To leave association with the draft group off by default, set
9957 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
9958
9959 @findex gnus-draft-edit-message
9960 @kindex D e (Draft)
9961 When you want to continue editing the article, you simply enter the
9962 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9963 that.  You will be placed in a buffer where you left off.
9964
9965 Rejected articles will also be put in this draft group (@pxref{Rejected
9966 Articles}).
9967
9968 @findex gnus-draft-send-all-messages
9969 @findex gnus-draft-send-message
9970 If you have lots of rejected messages you want to post (or mail) without
9971 doing further editing, you can use the @kbd{D s} command
9972 (@code{gnus-draft-send-message}).  This command understands the
9973 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
9974 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9975 in the buffer.
9976
9977 If you have some messages that you wish not to send, you can use the
9978 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9979 as unsendable.  This is a toggling command.
9980
9981
9982 @node Rejected Articles
9983 @section Rejected Articles
9984 @cindex rejected articles
9985
9986 Sometimes a news server will reject an article.  Perhaps the server
9987 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
9988 @emph{there be demons}.  Perhaps you have included too much cited text.
9989 Perhaps the disk is full.  Perhaps the server is down.
9990
9991 These situations are, of course, totally beyond the control of gnus.
9992 (Gnus, of course, loves the way you look, always feels great, has angels
9993 fluttering around inside of it, doesn't care about how much cited text
9994 you include, never runs full and never goes down.)  So gnus saves these
9995 articles until some later time when the server feels better.
9996
9997 The rejected articles will automatically be put in a special draft group
9998 (@pxref{Drafts}).  When the server comes back up again, you'd then
9999 typically enter that group and send all the articles off.
10000
10001 @node Using GPG
10002 @section Using GPG
10003 @cindex using gpg
10004
10005 Gnus has an ALPHA support to GPG that's provided by @file{gpg.el} and
10006 @file{mml2015.el}. When viewing signed or encrypted messages, Gnus automatically
10007 asks if you want to verify or decrypt them. 
10008
10009 To use this correctly with GPG, you'll need the following lisp code in your
10010 @file{~/.emacs} or @file{~/.gnus}:
10011
10012 @lisp
10013 (setq mml2015-use 'gpg)
10014 (setq gpg-temp-directory "~/.gnupg/tmp")
10015 @end lisp
10016
10017 The @code{gpg-temp-directory} need to point to a directory with permissions set
10018 to 700, for your own safety.
10019
10020 If you want to benefit of PGP2.6 compatibility, you might create a script named
10021 @file{gpg-2comp} with these instructions:
10022
10023 @code{
10024 #!/bin/sh
10025 exec gpg --rfc1991 "$@@"
10026 }
10027
10028 If you don't want to use such compatibility, you can add the following line to
10029 your @file{~/.emacs} or @file{~/.gnus}:
10030
10031 @lisp
10032 (setq gpg-command-default-alist (quote ((gpg . "gpg") (gpg-2comp . "gpg"))))
10033 @end lisp
10034
10035 To sign or encrypt your message you may choose to use the MML Security menu or
10036 @kbd{M-m s p} to sign your message using PGP/MIME, @kbd{M-m s s} to sign your
10037 message using S/MIME. There's also @kbd{M-m c p} to encrypt your message with
10038 PGP/MIME and @kbd{M-m c s} to encrypt using S/MIME.
10039
10040 Gnus will ask for your passphrase three times and then it will send your
10041 message, if you've typed it correctly.
10042
10043
10044 @node Select Methods
10045 @chapter Select Methods
10046 @cindex foreign groups
10047 @cindex select methods
10048
10049 A @dfn{foreign group} is a group not read by the usual (or
10050 default) means.  It could be, for instance, a group from a different
10051 @sc{nntp} server, it could be a virtual group, or it could be your own
10052 personal mail group.
10053
10054 A foreign group (or any group, really) is specified by a @dfn{name} and
10055 a @dfn{select method}.  To take the latter first, a select method is a
10056 list where the first element says what backend to use (e.g. @code{nntp},
10057 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
10058 name}.  There may be additional elements in the select method, where the
10059 value may have special meaning for the backend in question.
10060
10061 One could say that a select method defines a @dfn{virtual server}---so
10062 we do just that (@pxref{The Server Buffer}).
10063
10064 The @dfn{name} of the group is the name the backend will recognize the
10065 group as.
10066
10067 For instance, the group @samp{soc.motss} on the @sc{nntp} server
10068 @samp{some.where.edu} will have the name @samp{soc.motss} and select
10069 method @code{(nntp "some.where.edu")}.  Gnus will call this group
10070 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
10071 backend just knows this group as @samp{soc.motss}.
10072
10073 The different methods all have their peculiarities, of course.
10074
10075 @menu
10076 * The Server Buffer::     Making and editing virtual servers.
10077 * Getting News::          Reading USENET news with Gnus.
10078 * Getting Mail::          Reading your personal mail with Gnus.
10079 * Browsing the Web::      Getting messages from a plethora of Web sources.
10080 * Other Sources::         Reading directories, files, SOUP packets.
10081 * Combined Groups::       Combining groups into one group.
10082 * Gnus Unplugged::        Reading news and mail offline.
10083 @end menu
10084
10085
10086 @node The Server Buffer
10087 @section The Server Buffer
10088
10089 Traditionally, a @dfn{server} is a machine or a piece of software that
10090 one connects to, and then requests information from.  Gnus does not
10091 connect directly to any real servers, but does all transactions through
10092 one backend or other.  But that's just putting one layer more between
10093 the actual media and Gnus, so we might just as well say that each
10094 backend represents a virtual server.
10095
10096 For instance, the @code{nntp} backend may be used to connect to several
10097 different actual @sc{nntp} servers, or, perhaps, to many different ports
10098 on the same actual @sc{nntp} server.  You tell Gnus which backend to
10099 use, and what parameters to set by specifying a @dfn{select method}.
10100
10101 These select method specifications can sometimes become quite
10102 complicated---say, for instance, that you want to read from the
10103 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
10104 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
10105 Anyways, if you had to specify that for each group that used this
10106 server, that would be too much work, so Gnus offers a way of naming
10107 select methods, which is what you do in the server buffer.
10108
10109 To enter the server buffer, use the @kbd{^}
10110 (@code{gnus-group-enter-server-mode}) command in the group buffer.
10111
10112 @menu
10113 * Server Buffer Format::      You can customize the look of this buffer.
10114 * Server Commands::           Commands to manipulate servers.
10115 * Example Methods::           Examples server specifications.
10116 * Creating a Virtual Server:: An example session.
10117 * Server Variables::          Which variables to set.
10118 * Servers and Methods::       You can use server names as select methods.
10119 * Unavailable Servers::       Some servers you try to contact may be down.
10120 @end menu
10121
10122 @vindex gnus-server-mode-hook
10123 @code{gnus-server-mode-hook} is run when creating the server buffer.
10124
10125
10126 @node Server Buffer Format
10127 @subsection Server Buffer Format
10128 @cindex server buffer format
10129
10130 @vindex gnus-server-line-format
10131 You can change the look of the server buffer lines by changing the
10132 @code{gnus-server-line-format} variable.  This is a @code{format}-like
10133 variable, with some simple extensions:
10134
10135 @table @samp
10136
10137 @item h
10138 How the news is fetched---the backend name.
10139
10140 @item n
10141 The name of this server.
10142
10143 @item w
10144 Where the news is to be fetched from---the address.
10145
10146 @item s
10147 The opened/closed/denied status of the server.
10148 @end table
10149
10150 @vindex gnus-server-mode-line-format
10151 The mode line can also be customized by using the
10152 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
10153 Formatting}).  The following specs are understood:
10154
10155 @table @samp
10156 @item S
10157 Server name.
10158
10159 @item M
10160 Server method.
10161 @end table
10162
10163 Also @pxref{Formatting Variables}.
10164
10165
10166 @node Server Commands
10167 @subsection Server Commands
10168 @cindex server commands
10169
10170 @table @kbd
10171
10172 @item a
10173 @kindex a (Server)
10174 @findex gnus-server-add-server
10175 Add a new server (@code{gnus-server-add-server}).
10176
10177 @item e
10178 @kindex e (Server)
10179 @findex gnus-server-edit-server
10180 Edit a server (@code{gnus-server-edit-server}).
10181
10182 @item SPACE
10183 @kindex SPACE (Server)
10184 @findex gnus-server-read-server
10185 Browse the current server (@code{gnus-server-read-server}).
10186
10187 @item q
10188 @kindex q (Server)
10189 @findex gnus-server-exit
10190 Return to the group buffer (@code{gnus-server-exit}).
10191
10192 @item k
10193 @kindex k (Server)
10194 @findex gnus-server-kill-server
10195 Kill the current server (@code{gnus-server-kill-server}).
10196
10197 @item y
10198 @kindex y (Server)
10199 @findex gnus-server-yank-server
10200 Yank the previously killed server (@code{gnus-server-yank-server}).
10201
10202 @item c
10203 @kindex c (Server)
10204 @findex gnus-server-copy-server
10205 Copy the current server (@code{gnus-server-copy-server}).
10206
10207 @item l
10208 @kindex l (Server)
10209 @findex gnus-server-list-servers
10210 List all servers (@code{gnus-server-list-servers}).
10211
10212 @item s
10213 @kindex s (Server)
10214 @findex gnus-server-scan-server
10215 Request that the server scan its sources for new articles
10216 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
10217 servers.
10218
10219 @item g
10220 @kindex g (Server)
10221 @findex gnus-server-regenerate-server
10222 Request that the server regenerate all its data structures
10223 (@code{gnus-server-regenerate-server}).  This can be useful if you have
10224 a mail backend that has gotten out of synch.
10225
10226 @end table
10227
10228
10229 @node Example Methods
10230 @subsection Example Methods
10231
10232 Most select methods are pretty simple and self-explanatory:
10233
10234 @lisp
10235 (nntp "news.funet.fi")
10236 @end lisp
10237
10238 Reading directly from the spool is even simpler:
10239
10240 @lisp
10241 (nnspool "")
10242 @end lisp
10243
10244 As you can see, the first element in a select method is the name of the
10245 backend, and the second is the @dfn{address}, or @dfn{name}, if you
10246 will.
10247
10248 After these two elements, there may be an arbitrary number of
10249 @code{(@var{variable} @var{form})} pairs.
10250
10251 To go back to the first example---imagine that you want to read from
10252 port 15 on that machine.  This is what the select method should
10253 look like then:
10254
10255 @lisp
10256 (nntp "news.funet.fi" (nntp-port-number 15))
10257 @end lisp
10258
10259 You should read the documentation to each backend to find out what
10260 variables are relevant, but here's an @code{nnmh} example:
10261
10262 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
10263 you have two structures that you wish to access: One is your private
10264 mail spool, and the other is a public one.  Here's the possible spec for
10265 your private mail:
10266
10267 @lisp
10268 (nnmh "private" (nnmh-directory "~/private/mail/"))
10269 @end lisp
10270
10271 (This server is then called @samp{private}, but you may have guessed
10272 that.)
10273
10274 Here's the method for a public spool:
10275
10276 @lisp
10277 (nnmh "public"
10278       (nnmh-directory "/usr/information/spool/")
10279       (nnmh-get-new-mail nil))
10280 @end lisp
10281
10282 @cindex proxy
10283 @cindex firewall
10284
10285 If you are behind a firewall and only have access to the @sc{nntp}
10286 server from the firewall machine, you can instruct Gnus to @code{rlogin}
10287 on the firewall machine and telnet from there to the @sc{nntp} server.
10288 Doing this can be rather fiddly, but your virtual server definition
10289 should probably look something like this:
10290
10291 @lisp
10292 (nntp "firewall"
10293       (nntp-address "the.firewall.machine")
10294       (nntp-open-connection-function nntp-open-rlogin)
10295       (nntp-end-of-line "\n")
10296       (nntp-rlogin-parameters
10297        ("telnet" "the.real.nntp.host" "nntp")))
10298 @end lisp
10299
10300 If you want to use the wonderful @code{ssh} program to provide a
10301 compressed connection over the modem line, you could create a virtual
10302 server that would look something like this:
10303
10304 @lisp
10305 (nntp "news"
10306        (nntp-address "copper.uio.no")
10307        (nntp-rlogin-program "ssh")
10308        (nntp-open-connection-function nntp-open-rlogin)
10309        (nntp-end-of-line "\n")
10310        (nntp-rlogin-parameters
10311         ("telnet" "news.uio.no" "nntp")))
10312 @end lisp
10313
10314 This means that you have to have set up @code{ssh-agent} correctly to
10315 provide automatic authorization, of course.  And to get a compressed
10316 connection, you have to have the @samp{Compression} option in the
10317 @code{ssh} @file{config} file.
10318
10319
10320 @node Creating a Virtual Server
10321 @subsection Creating a Virtual Server
10322
10323 If you're saving lots of articles in the cache by using persistent
10324 articles, you may want to create a virtual server to read the cache.
10325
10326 First you need to add a new server.  The @kbd{a} command does that.  It
10327 would probably be best to use @code{nnspool} to read the cache.  You
10328 could also use @code{nnml} or @code{nnmh}, though.
10329
10330 Type @kbd{a nnspool RET cache RET}.
10331
10332 You should now have a brand new @code{nnspool} virtual server called
10333 @samp{cache}.  You now need to edit it to have the right definitions.
10334 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
10335 will contain the following:
10336
10337 @lisp
10338 (nnspool "cache")
10339 @end lisp
10340
10341 Change that to:
10342
10343 @lisp
10344 (nnspool "cache"
10345          (nnspool-spool-directory "~/News/cache/")
10346          (nnspool-nov-directory "~/News/cache/")
10347          (nnspool-active-file "~/News/cache/active"))
10348 @end lisp
10349
10350 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
10351 @kbd{RET} over this virtual server, you should be entered into a browse
10352 buffer, and you should be able to enter any of the groups displayed.
10353
10354
10355 @node Server Variables
10356 @subsection Server Variables
10357
10358 One sticky point when defining variables (both on backends and in Emacs
10359 in general) is that some variables are typically initialized from other
10360 variables when the definition of the variables is being loaded.  If you
10361 change the "base" variable after the variables have been loaded, you
10362 won't change the "derived" variables.
10363
10364 This typically affects directory and file variables.  For instance,
10365 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
10366 directory variables are initialized from that variable, so
10367 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
10368 new virtual @code{nnml} server, it will @emph{not} suffice to set just
10369 @code{nnml-directory}---you have to explicitly set all the file
10370 variables to be what you want them to be.  For a complete list of
10371 variables for each backend, see each backend's section later in this
10372 manual, but here's an example @code{nnml} definition:
10373
10374 @lisp
10375 (nnml "public"
10376       (nnml-directory "~/my-mail/")
10377       (nnml-active-file "~/my-mail/active")
10378       (nnml-newsgroups-file "~/my-mail/newsgroups"))
10379 @end lisp
10380
10381
10382 @node Servers and Methods
10383 @subsection Servers and Methods
10384
10385 Wherever you would normally use a select method
10386 (e.g. @code{gnus-secondary-select-method}, in the group select method,
10387 when browsing a foreign server) you can use a virtual server name
10388 instead.  This could potentially save lots of typing.  And it's nice all
10389 over.
10390
10391
10392 @node Unavailable Servers
10393 @subsection Unavailable Servers
10394
10395 If a server seems to be unreachable, Gnus will mark that server as
10396 @code{denied}.  That means that any subsequent attempt to make contact
10397 with that server will just be ignored.  ``It can't be opened,'' Gnus
10398 will tell you, without making the least effort to see whether that is
10399 actually the case or not.
10400
10401 That might seem quite naughty, but it does make sense most of the time.
10402 Let's say you have 10 groups subscribed to on server
10403 @samp{nephelococcygia.com}.  This server is located somewhere quite far
10404 away from you and the machine is quite slow, so it takes 1 minute just
10405 to find out that it refuses connection to you today.  If Gnus were to
10406 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
10407 attempt to do that.  Once it has gotten a single ``connection refused'',
10408 it will regard that server as ``down''.
10409
10410 So, what happens if the machine was only feeling unwell temporarily?
10411 How do you test to see whether the machine has come up again?
10412
10413 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
10414 with the following commands:
10415
10416 @table @kbd
10417
10418 @item O
10419 @kindex O (Server)
10420 @findex gnus-server-open-server
10421 Try to establish connection to the server on the current line
10422 (@code{gnus-server-open-server}).
10423
10424 @item C
10425 @kindex C (Server)
10426 @findex gnus-server-close-server
10427 Close the connection (if any) to the server
10428 (@code{gnus-server-close-server}).
10429
10430 @item D
10431 @kindex D (Server)
10432 @findex gnus-server-deny-server
10433 Mark the current server as unreachable
10434 (@code{gnus-server-deny-server}).
10435
10436 @item M-o
10437 @kindex M-o (Server)
10438 @findex gnus-server-open-all-servers
10439 Open the connections to all servers in the buffer
10440 (@code{gnus-server-open-all-servers}).
10441
10442 @item M-c
10443 @kindex M-c (Server)
10444 @findex gnus-server-close-all-servers
10445 Close the connections to all servers in the buffer
10446 (@code{gnus-server-close-all-servers}).
10447
10448 @item R
10449 @kindex R (Server)
10450 @findex gnus-server-remove-denials
10451 Remove all marks to whether Gnus was denied connection from any servers
10452 (@code{gnus-server-remove-denials}).
10453
10454 @end table
10455
10456
10457 @node Getting News
10458 @section Getting News
10459 @cindex reading news
10460 @cindex news backends
10461
10462 A newsreader is normally used for reading news.  Gnus currently provides
10463 only two methods of getting news---it can read from an @sc{nntp} server,
10464 or it can read from a local spool.
10465
10466 @menu
10467 * NNTP::               Reading news from an @sc{nntp} server.
10468 * News Spool::         Reading news from the local spool.
10469 @end menu
10470
10471
10472 @node NNTP
10473 @subsection @sc{nntp}
10474 @cindex nntp
10475
10476 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
10477 You just specify @code{nntp} as method and the address of the @sc{nntp}
10478 server as the, uhm, address.
10479
10480 If the @sc{nntp} server is located at a non-standard port, setting the
10481 third element of the select method to this port number should allow you
10482 to connect to the right port.  You'll have to edit the group info for
10483 that (@pxref{Foreign Groups}).
10484
10485 The name of the foreign group can be the same as a native group.  In
10486 fact, you can subscribe to the same group from as many different servers
10487 you feel like.  There will be no name collisions.
10488
10489 The following variables can be used to create a virtual @code{nntp}
10490 server:
10491
10492 @table @code
10493
10494 @item nntp-server-opened-hook
10495 @vindex nntp-server-opened-hook
10496 @cindex @sc{mode reader}
10497 @cindex authinfo
10498 @cindex authentification
10499 @cindex nntp authentification
10500 @findex nntp-send-authinfo
10501 @findex nntp-send-mode-reader
10502 is run after a connection has been made.  It can be used to send
10503 commands to the @sc{nntp} server after it has been contacted.  By
10504 default it sends the command @code{MODE READER} to the server with the
10505 @code{nntp-send-mode-reader} function.  This function should always be
10506 present in this hook.
10507
10508 @item nntp-authinfo-function
10509 @vindex nntp-authinfo-function
10510 @findex nntp-send-authinfo
10511 @vindex nntp-authinfo-file
10512 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
10513 server.  The default function is @code{nntp-send-authinfo}, which looks
10514 through your @file{~/.authinfo} (or whatever you've set the
10515 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
10516 are found, it will prompt you for a login name and a password.  The
10517 format of the @file{~/.authinfo} file is (almost) the same as the
10518 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
10519 manual page, but here are the salient facts:
10520
10521 @enumerate
10522 @item
10523 The file contains one or more line, each of which define one server.
10524
10525 @item
10526 Each line may contain an arbitrary number of token/value pairs.  
10527 @end enumerate
10528
10529 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
10530 @samp{default}.  Gnus introduce two new tokens, not present in the
10531 original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
10532 @samp{force}.  (This is the only way the @file{.authinfo} file format
10533 deviates from the @file{.netrc} file format.) @samp{port} is used to
10534 indicate what port on the server the credentials apply to, @samp{force}
10535 is explained below.
10536
10537 Here's an example file:
10538
10539 @example
10540 machine news.uio.no login larsi password geheimnis
10541 machine nntp.ifi.uio.no login larsi force yes
10542 @end example
10543
10544 The token/value pairs may appear in any order; @samp{machine} doesn't
10545 have to be first, for instance.
10546
10547 In this example, both login name and password have been supplied for the
10548 former server, while the latter has only the login name listed, and the
10549 user will be prompted for the password.  The latter also has the
10550 @samp{force} tag, which means that the authinfo will be sent to the
10551 @var{nntp} server upon connection; the default (i.e., when there is not
10552 @samp{force} tag) is to not send authinfo to the @var{nntp} server
10553 until the @var{nntp} server asks for it.
10554
10555 You can also add @samp{default} lines that will apply to all servers
10556 that don't have matching @samp{machine} lines.
10557
10558 @example
10559 default force yes
10560 @end example
10561
10562 This will force sending @samp{AUTHINFO} commands to all servers not
10563 previously mentioned.
10564
10565 Remember to not leave the @file{~/.authinfo} file world-readable.
10566
10567 @item nntp-server-action-alist
10568 @vindex nntp-server-action-alist
10569 This is a list of regexps to match on server types and actions to be
10570 taken when matches are made.  For instance, if you want Gnus to beep
10571 every time you connect to innd, you could say something like:
10572
10573 @lisp
10574 (setq nntp-server-action-alist
10575       '(("innd" (ding))))
10576 @end lisp
10577
10578 You probably don't want to do that, though.
10579
10580 The default value is
10581
10582 @lisp
10583 '(("nntpd 1\\.5\\.11t"
10584    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
10585 @end lisp
10586
10587 This ensures that Gnus doesn't send the @code{MODE READER} command to
10588 nntpd 1.5.11t, since that command chokes that server, I've been told.
10589
10590 @item nntp-maximum-request
10591 @vindex nntp-maximum-request
10592 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
10593 will collect headers by sending a series of @code{head} commands.  To
10594 speed things up, the backend sends lots of these commands without
10595 waiting for reply, and then reads all the replies.  This is controlled
10596 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
10597 your network is buggy, you should set this to 1.
10598
10599 @item nntp-connection-timeout
10600 @vindex nntp-connection-timeout
10601 If you have lots of foreign @code{nntp} groups that you connect to
10602 regularly, you're sure to have problems with @sc{nntp} servers not
10603 responding properly, or being too loaded to reply within reasonable
10604 time.  This is can lead to awkward problems, which can be helped
10605 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
10606 that says how many seconds the @code{nntp} backend should wait for a
10607 connection before giving up.  If it is @code{nil}, which is the default,
10608 no timeouts are done.
10609
10610 @c @item nntp-command-timeout
10611 @c @vindex nntp-command-timeout
10612 @c @cindex PPP connections
10613 @c @cindex dynamic IP addresses
10614 @c If you're running Gnus on a machine that has a dynamically assigned
10615 @c address, Gnus may become confused.  If the address of your machine
10616 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
10617 @c waiting forever for replies from the server.  To help with this
10618 @c unfortunate problem, you can set this command to a number.  Gnus will
10619 @c then, if it sits waiting for a reply from the server longer than that
10620 @c number of seconds, shut down the connection, start a new one, and resend
10621 @c the command.  This should hopefully be transparent to the user.  A
10622 @c likely number is 30 seconds.
10623 @c
10624 @c @item nntp-retry-on-break
10625 @c @vindex nntp-retry-on-break
10626 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
10627 @c hangs.  This will have much the same effect as the command timeout
10628 @c described above.
10629
10630 @item nntp-server-hook
10631 @vindex nntp-server-hook
10632 This hook is run as the last step when connecting to an @sc{nntp}
10633 server.
10634
10635 @findex nntp-open-rlogin
10636 @findex nntp-open-telnet
10637 @findex nntp-open-network-stream
10638 @item nntp-open-connection-function
10639 @vindex nntp-open-connection-function
10640 This function is used to connect to the remote system.  Four pre-made
10641 functions are supplied:
10642
10643 @table @code
10644 @item nntp-open-network-stream
10645 This is the default, and simply connects to some port or other on the
10646 remote system.
10647
10648 @item nntp-open-rlogin
10649 Does an @samp{rlogin} on the
10650 remote system, and then does a @samp{telnet} to the @sc{nntp} server
10651 available there.
10652
10653 @code{nntp-open-rlogin}-related variables:
10654
10655 @table @code
10656
10657 @item nntp-rlogin-program
10658 @vindex nntp-rlogin-program
10659 Program used to log in on remote machines.  The default is @samp{rsh},
10660 but @samp{ssh} is a popular alternative.
10661
10662 @item nntp-rlogin-parameters
10663 @vindex nntp-rlogin-parameters
10664 This list will be used as the parameter list given to @code{rsh}.
10665
10666 @item nntp-rlogin-user-name
10667 @vindex nntp-rlogin-user-name
10668 User name on the remote system.
10669
10670 @end table
10671
10672 @item nntp-open-telnet
10673 Does a @samp{telnet} to the remote system and then another @samp{telnet}
10674 to get to the @sc{nntp} server.
10675
10676 @code{nntp-open-telnet}-related variables:
10677
10678 @table @code
10679 @item nntp-telnet-command
10680 @vindex nntp-telnet-command
10681 Command used to start @code{telnet}.
10682
10683 @item nntp-telnet-switches
10684 @vindex nntp-telnet-switches
10685 List of strings to be used as the switches to the @code{telnet} command.
10686
10687 @item nntp-telnet-user-name
10688 @vindex nntp-telnet-user-name
10689 User name for log in on the remote system.
10690
10691 @item nntp-telnet-passwd
10692 @vindex nntp-telnet-passwd
10693 Password to use when logging in.
10694
10695 @item nntp-telnet-parameters
10696 @vindex nntp-telnet-parameters
10697 A list of strings executed as a command after logging in
10698 via @code{telnet}.
10699
10700 @item nntp-telnet-shell-prompt
10701 @vindex nntp-telnet-shell-prompt
10702 Regexp matching the shell prompt on the remote machine.  The default is
10703 @samp{bash\\|\$ *\r?$\\|> *\r?}.
10704
10705 @item nntp-open-telnet-envuser
10706 @vindex nntp-open-telnet-envuser
10707 If non-@code{nil}, the @code{telnet} session (client and server both)
10708 will support the @code{ENVIRON} option and not prompt for login name.
10709 This works for Solaris @code{telnet}, for instance.
10710
10711 @end table
10712
10713 @findex nntp-open-ssl-stream
10714 @item nntp-open-ssl-stream
10715 Opens a connection to a server over a @dfn{secure} channel.  To use this
10716 you must have SSLay installed
10717 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
10718 @file{ssl.el} (from the W3 distributeion, for instance).  You then
10719 define a server as follows:
10720
10721 @lisp
10722 ;; Type `C-c C-c' after you've finished editing.
10723 ;;
10724 ;; "snews" is port 563 and is predefined in our /etc/services
10725 ;;
10726 (nntp "snews.bar.com"
10727       (nntp-open-connection-function nntp-open-ssl-stream)
10728       (nntp-port-number "snews")
10729       (nntp-address "snews.bar.com"))
10730 @end lisp
10731
10732 @end table
10733
10734 @item nntp-end-of-line
10735 @vindex nntp-end-of-line
10736 String to use as end-of-line marker when talking to the @sc{nntp}
10737 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
10738 using @code{rlogin} to talk to the server.
10739
10740 @item nntp-rlogin-user-name
10741 @vindex nntp-rlogin-user-name
10742 User name on the remote system when using the @code{rlogin} connect
10743 function.
10744
10745 @item nntp-address
10746 @vindex nntp-address
10747 The address of the remote system running the @sc{nntp} server.
10748
10749 @item nntp-port-number
10750 @vindex nntp-port-number
10751 Port number to connect to when using the @code{nntp-open-network-stream}
10752 connect function.
10753
10754 @item nntp-list-options
10755 @vindex nntp-list-options
10756 List of newsgroup name used for a option of the LIST command to restrict
10757 the listing output to only the specified newsgroups.  Each newsgroup name
10758 can be a shell-style wildcard, for instance, @dfn{fj.*}, @dfn{japan.*},
10759 etc.  Fortunately, if the server can accept such a option, it will
10760 probably make gnus run faster.  You may use it as a server variable as
10761 follows:
10762
10763 @lisp
10764 (setq gnus-select-method
10765       '(nntp "news.somewhere.edu"
10766              (nntp-list-options ("fj.*" "japan.*"))))
10767 @end lisp
10768
10769 @item nntp-options-subscribe
10770 @vindex nntp-options-subscribe
10771 Regexp matching the newsgroup names which will be subscribed
10772 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
10773 It may be effective as well as @code{nntp-list-options} even though the
10774 server could not accept a shell-style wildcard as a option of the LIST
10775 command.  You may use it as a server variable as follows:
10776
10777 @lisp
10778 (setq gnus-select-method
10779       '(nntp "news.somewhere.edu"
10780              (nntp-options-subscribe "^fj\\.\\|^japan\\.")))
10781 @end lisp
10782
10783 @item nntp-options-not-subscribe
10784 @vindex nntp-options-not-subscribe
10785 Regexp matching the newsgroup names which will not be subscribed
10786 unconditionally.  Use @dfn{ } instead of @dfn{$} for a regexp string.
10787 It may be effective as well as @code{nntp-list-options} even though the
10788 server could not accept a shell-style wildcard as a option of the LIST
10789 command.  You may use it as a server variable as follows:
10790
10791 @lisp
10792 (setq gnus-select-method
10793       '(nntp "news.somewhere.edu"
10794              (nntp-options-not-subscribe "\\.binaries\\.")))
10795 @end lisp
10796
10797 @item nntp-buggy-select
10798 @vindex nntp-buggy-select
10799 Set this to non-@code{nil} if your select routine is buggy.
10800
10801 @item nntp-nov-is-evil
10802 @vindex nntp-nov-is-evil
10803 If the @sc{nntp} server does not support @sc{nov}, you could set this
10804 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
10805 can be used.
10806
10807 @item nntp-xover-commands
10808 @vindex nntp-xover-commands
10809 @cindex nov
10810 @cindex XOVER
10811 List of strings used as commands to fetch @sc{nov} lines from a
10812 server.  The default value of this variable is @code{("XOVER"
10813 "XOVERVIEW")}.
10814
10815 @item nntp-nov-gap
10816 @vindex nntp-nov-gap
10817 @code{nntp} normally sends just one big request for @sc{nov} lines to
10818 the server.  The server responds with one huge list of lines.  However,
10819 if you have read articles 2-5000 in the group, and only want to read
10820 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
10821 lines that you will not need.  This variable says how
10822 big a gap between two consecutive articles is allowed to be before the
10823 @code{XOVER} request is split into several request.  Note that if your
10824 network is fast, setting this variable to a really small number means
10825 that fetching will probably be slower.  If this variable is @code{nil},
10826 @code{nntp} will never split requests.  The default is 5.
10827
10828 @item nntp-prepare-server-hook
10829 @vindex nntp-prepare-server-hook
10830 A hook run before attempting to connect to an @sc{nntp} server.
10831
10832 @item nntp-warn-about-losing-connection
10833 @vindex nntp-warn-about-losing-connection
10834 If this variable is non-@code{nil}, some noise will be made when a
10835 server closes connection.
10836
10837 @item nntp-record-commands
10838 @vindex nntp-record-commands
10839 If non-@code{nil}, @code{nntp} will log all commands it sends to the
10840 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
10841 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
10842 that doesn't seem to work.
10843
10844 @end table
10845
10846
10847 @node News Spool
10848 @subsection News Spool
10849 @cindex nnspool
10850 @cindex news spool
10851
10852 Subscribing to a foreign group from the local spool is extremely easy,
10853 and might be useful, for instance, to speed up reading groups that
10854 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
10855 instance.
10856
10857 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
10858 anything else) as the address.
10859
10860 If you have access to a local spool, you should probably use that as the
10861 native select method (@pxref{Finding the News}).  It is normally faster
10862 than using an @code{nntp} select method, but might not be.  It depends.
10863 You just have to try to find out what's best at your site.
10864
10865 @table @code
10866
10867 @item nnspool-inews-program
10868 @vindex nnspool-inews-program
10869 Program used to post an article.
10870
10871 @item nnspool-inews-switches
10872 @vindex nnspool-inews-switches
10873 Parameters given to the inews program when posting an article.
10874
10875 @item nnspool-spool-directory
10876 @vindex nnspool-spool-directory
10877 Where @code{nnspool} looks for the articles.  This is normally
10878 @file{/usr/spool/news/}.
10879
10880 @item nnspool-nov-directory
10881 @vindex nnspool-nov-directory
10882 Where @code{nnspool} will look for @sc{nov} files.  This is normally
10883 @file{/usr/spool/news/over.view/}.
10884
10885 @item nnspool-lib-dir
10886 @vindex nnspool-lib-dir
10887 Where the news lib dir is (@file{/usr/lib/news/} by default).
10888
10889 @item nnspool-active-file
10890 @vindex nnspool-active-file
10891 The path to the active file.
10892
10893 @item nnspool-newsgroups-file
10894 @vindex nnspool-newsgroups-file
10895 The path to the group descriptions file.
10896
10897 @item nnspool-history-file
10898 @vindex nnspool-history-file
10899 The path to the news history file.
10900
10901 @item nnspool-active-times-file
10902 @vindex nnspool-active-times-file
10903 The path to the active date file.
10904
10905 @item nnspool-nov-is-evil
10906 @vindex nnspool-nov-is-evil
10907 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
10908 that it finds.
10909
10910 @item nnspool-sift-nov-with-sed
10911 @vindex nnspool-sift-nov-with-sed
10912 @cindex sed
10913 If non-@code{nil}, which is the default, use @code{sed} to get the
10914 relevant portion from the overview file.  If nil, @code{nnspool} will
10915 load the entire file into a buffer and process it there.
10916
10917 @end table
10918
10919
10920 @node Getting Mail
10921 @section Getting Mail
10922 @cindex reading mail
10923 @cindex mail
10924
10925 Reading mail with a newsreader---isn't that just plain WeIrD? But of
10926 course.
10927
10928 @menu
10929 * Mail in a Newsreader::         Important introductory notes. 
10930 * Getting Started Reading Mail:: A simple cookbook example.
10931 * Splitting Mail::               How to create mail groups.
10932 * Mail Sources::                 How to tell Gnus where to get mail from.
10933 * Mail Backend Variables::       Variables for customizing mail handling.
10934 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
10935 * Group Mail Splitting::         Use group customize to drive mail splitting.
10936 * Incorporating Old Mail::       What about the old mail you have?
10937 * Expiring Mail::                Getting rid of unwanted mail.
10938 * Washing Mail::                 Removing gruft from the mail you get.
10939 * Duplicates::                   Dealing with duplicated mail.
10940 * Not Reading Mail::             Using mail backends for reading other files.
10941 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
10942 @end menu
10943
10944
10945 @node Mail in a Newsreader
10946 @subsection Mail in a Newsreader
10947
10948 If you are used to traditional mail readers, but have decided to switch
10949 to reading mail with Gnus, you may find yourself experiencing something
10950 of a culture shock.
10951
10952 Gnus does not behave like traditional mail readers.  If you want to make
10953 it behave that way, you can, but it's an uphill battle.
10954
10955 Gnus, by default, handles all its groups using the same approach.  This
10956 approach is very newsreaderly---you enter a group, see the new/unread
10957 messages, and when you read the messages, they get marked as read, and
10958 you don't see them any more.  (Unless you explicitly ask for them.)
10959
10960 In particular, you do not do anything explicitly to delete messages.
10961
10962 Does this mean that all the messages that have been marked as read are
10963 deleted?  How awful!
10964
10965 But, no, it means that old messages are @dfn{expired} according to some
10966 scheme or other.  For news messages, the expire process is controlled by
10967 the news administrator; for mail, the expire process is controlled by
10968 you.  The expire process for mail is covered in depth in @pxref{Expiring
10969 Mail}.
10970
10971 What many Gnus users find, after using it a while for both news and
10972 mail, is that the transport mechanism has very little to do with how
10973 they want to treat a message.
10974
10975 Many people subscribe to several mailing lists.  These are transported
10976 via SMTP, and are therefore mail.  But we might go for weeks without
10977 answering, or even reading these messages very carefully.  We may not
10978 need to save them because if we should need to read one again, they are
10979 archived somewhere else.
10980
10981 Some people have local news groups which have only a handful of readers.
10982 These are transported via @sc{nntp}, and are therefore news.  But we may need
10983 to read and answer a large fraction of the messages very carefully in
10984 order to do our work.  And there may not be an archive, so we may need
10985 to save the interesting messages the same way we would personal mail.
10986
10987 The important distinction turns out to be not the transport mechanism,
10988 but other factors such as how interested we are in the subject matter,
10989 or how easy it is to retrieve the message if we need to read it again.
10990
10991 Gnus provides many options for sorting mail into ``groups'' which behave
10992 like newsgroups, and for treating each group (whether mail or news)
10993 differently.
10994
10995 Some users never get comfortable using the Gnus (ahem) paradigm and wish
10996 that Gnus should grow up and be a male, er, mail reader.  It is possible
10997 to whip Gnus into a more mailreaderly being, but, as said before, it's
10998 not easy.  People who prefer proper mail readers should try @sc{vm}
10999 instead, which is an excellent, and proper, mail reader.
11000
11001 I don't mean to scare anybody off, but I want to make it clear that you
11002 may be required to learn a new way of thinking about messages.  After
11003 you've been subjected to The Gnus Way, you will come to love it.  I can
11004 guarantee it.  (At least the guy who sold me the Emacs Subliminal
11005 Brain-Washing Functions that I've put into Gnus did guarantee it.  You
11006 Will Be Assimilated.  You Love Gnus.  You Love The Gnus Mail Way.
11007 You Do.)
11008
11009
11010 @node Getting Started Reading Mail
11011 @subsection Getting Started Reading Mail
11012
11013 It's quite easy to use Gnus to read your new mail.  You just plonk the
11014 mail backend of your choice into @code{gnus-secondary-select-methods},
11015 and things will happen automatically.
11016
11017 For instance, if you want to use @code{nnml} (which is a "one file per
11018 mail" backend), you could put the following in your @file{.gnus} file:
11019
11020 @lisp
11021 (setq gnus-secondary-select-methods
11022       '((nnml "private")))
11023 @end lisp
11024
11025 Now, the next time you start Gnus, this backend will be queried for new
11026 articles, and it will move all the messages in your spool file to its
11027 directory, which is @code{~/Mail/} by default.  The new group that will
11028 be created (@samp{mail.misc}) will be subscribed, and you can read it
11029 like any other group.
11030
11031 You will probably want to split the mail into several groups, though:
11032
11033 @lisp
11034 (setq nnmail-split-methods
11035       '(("junk" "^From:.*Lars Ingebrigtsen")
11036         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
11037         ("other" "")))
11038 @end lisp
11039
11040 This will result in three new @code{nnml} mail groups being created:
11041 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
11042 mail that doesn't fit into the first two groups will be placed in the
11043 last group.
11044
11045 This should be sufficient for reading mail with Gnus.  You might want to
11046 give the other sections in this part of the manual a perusal, though.
11047 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
11048
11049
11050 @node Splitting Mail
11051 @subsection Splitting Mail
11052 @cindex splitting mail
11053 @cindex mail splitting
11054
11055 @vindex nnmail-split-methods
11056 The @code{nnmail-split-methods} variable says how the incoming mail is
11057 to be split into groups.
11058
11059 @lisp
11060 (setq nnmail-split-methods
11061   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
11062     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
11063     ("mail.other" "")))
11064 @end lisp
11065
11066 This variable is a list of lists, where the first element of each of
11067 these lists is the name of the mail group (they do not have to be called
11068 something beginning with @samp{mail}, by the way), and the second
11069 element is a regular expression used on the header of each mail to
11070 determine if it belongs in this mail group.  The first string may
11071 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
11072 insert sub-expressions from the matched text.  For instance:
11073
11074 @lisp
11075 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
11076 @end lisp
11077
11078 The second element can also be a function.  In that case, it will be
11079 called narrowed to the headers with the first element of the rule as the
11080 argument.  It should return a non-@code{nil} value if it thinks that the
11081 mail belongs in that group.
11082
11083 The last of these groups should always be a general one, and the regular
11084 expression should @emph{always} be @samp{} so that it matches any mails
11085 that haven't been matched by any of the other regexps.  (These rules are
11086 processed from the beginning of the alist toward the end.  The first
11087 rule to make a match will "win", unless you have crossposting enabled.
11088 In that case, all matching rules will "win".)
11089
11090 If you like to tinker with this yourself, you can set this variable to a
11091 function of your choice.  This function will be called without any
11092 arguments in a buffer narrowed to the headers of an incoming mail
11093 message.  The function should return a list of group names that it
11094 thinks should carry this mail message.
11095
11096 Note that the mail backends are free to maul the poor, innocent,
11097 incoming headers all they want to.  They all add @code{Lines} headers;
11098 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
11099 @code{From<SPACE>} line to something else.
11100
11101 @vindex nnmail-crosspost
11102 The mail backends all support cross-posting.  If several regexps match,
11103 the mail will be ``cross-posted'' to all those groups.
11104 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
11105 that no articles are crossposted to the general (@samp{}) group.
11106
11107 @vindex nnmail-crosspost-link-function
11108 @cindex crosspost
11109 @cindex links
11110 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
11111 the crossposted articles.  However, not all file systems support hard
11112 links.  If that's the case for you, set
11113 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
11114 variable is @code{add-name-to-file} by default.)
11115
11116 @kindex M-x nnmail-split-history
11117 @kindex nnmail-split-history
11118 If you wish to see where the previous mail split put the messages, you
11119 can use the @kbd{M-x nnmail-split-history} command.  If you wish to see
11120 where re-spooling messages would put the messages, you can use
11121 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
11122 Group Commands}). 
11123
11124 Gnus gives you all the opportunity you could possibly want for shooting
11125 yourself in the foot.  Let's say you create a group that will contain
11126 all the mail you get from your boss.  And then you accidentally
11127 unsubscribe from the group.  Gnus will still put all the mail from your
11128 boss in the unsubscribed group, and so, when your boss mails you ``Have
11129 that report ready by Monday or you're fired!'', you'll never see it and,
11130 come Tuesday, you'll still believe that you're gainfully employed while
11131 you really should be out collecting empty bottles to save up for next
11132 month's rent money.
11133
11134
11135 @node Mail Sources
11136 @subsection Mail Sources
11137
11138 Mail can be gotten from many different sources---the mail spool, from a
11139 POP mail server, from a procmail directory, or from a maildir, for
11140 instance.
11141
11142 @menu
11143 * Mail Source Specifiers::       How to specify what a mail source is.
11144 * Mail Source Customization::    Some variables that influence things.
11145 * Fetching Mail::                Using the mail source specifiers.
11146 @end menu
11147
11148
11149 @node Mail Source Specifiers
11150 @subsubsection Mail Source Specifiers
11151 @cindex POP
11152 @cindex mail server
11153 @cindex procmail
11154 @cindex mail spool
11155 @cindex mail source
11156
11157 You tell Gnus how to fetch mail by setting @code{mail-sources}
11158 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
11159
11160 Here's an example:
11161
11162 @lisp
11163 (pop :server "pop3.mailserver.com" :user "myname")
11164 @end lisp
11165
11166 As can be observed, a mail source specifier is a list where the first
11167 element is a @dfn{mail source type}, followed by an arbitrary number of
11168 @dfn{keywords}.  Keywords that are not explicitly specified are given
11169 default values.
11170
11171 The following mail source types are available:
11172
11173 @table @code
11174 @item file
11175 Get mail from a single file; typically from the mail spool.
11176
11177 Keywords:
11178
11179 @table @code
11180 @item :path
11181 The path of the file.  Defaults to the value of the @code{MAIL}
11182 environment variable or @file{/usr/mail/spool/user-name}.
11183 @end table
11184
11185 An example file mail source:
11186
11187 @lisp
11188 (file :path "/usr/spool/mail/user-name")
11189 @end lisp
11190
11191 Or using the default path:
11192
11193 @lisp
11194 (file)
11195 @end lisp
11196
11197 If the mail spool file is not located on the local machine, it's best to 
11198 use POP or @sc{imap} or the like to fetch the mail.  You can not use ange-ftp 
11199 file names here---it has no way to lock the mail spool while moving the
11200 mail.
11201
11202 If it's impossible to set up a proper server, you can use ssh instead.
11203
11204 @lisp
11205 (setq mail-sources
11206       '((file :prescript "ssh host bin/getmail >%t")))
11207 @end lisp
11208
11209 The @samp{getmail} script would look something like the following:
11210
11211 @example
11212 #!/bin/sh
11213 #  getmail - move mail from spool to stdout
11214 #  flu@@iki.fi
11215
11216 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
11217 TMP=$HOME/Mail/tmp
11218 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
11219 @end example
11220
11221 Alter this script to fit find the @samp{movemail} you want to use.
11222
11223
11224 @item directory
11225 Get mail from several files in a directory.  This is typically used when
11226 you have procmail split the incoming mail into several files.  Setting
11227 @code{nnmail-scan-directory-mail-source-once} to non-nil force Gnus to
11228 scan the mail source only once.
11229
11230 Keywords:
11231
11232 @table @code
11233 @item :path
11234 The path of the directory where the files are.  There is no default
11235 value.
11236
11237 @item :suffix
11238 Only files ending with this suffix are used.  The default is
11239 @samp{.spool}.
11240
11241 @item :predicate
11242 Only files that have this predicate return non-@code{nil} are returned.
11243 The default is @code{identity}.  This is used as an additional
11244 filter---only files that have the right suffix @emph{and} satisfy this
11245 predicate are considered.
11246
11247 @item :prescript
11248 @itemx :postscript
11249 Script run before/after fetching mail.
11250
11251 @end table
11252
11253 An example directory mail source:
11254
11255 @lisp
11256 (directory :path "/home/user-name/procmail-dir/"
11257            :suffix ".prcml")
11258 @end lisp
11259
11260 @item pop
11261 Get mail from a POP server.
11262
11263 Keywords:
11264
11265 @table @code
11266 @item :server
11267 The name of the POP server.  The default is taken from the
11268 @code{MAILHOST} environment variable.
11269
11270 @item :port
11271 The port number of the POP server.  This can be a number (eg,
11272 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}).  If it is a
11273 string, it should be a service name as listed in @file{/etc/services} on
11274 Unix systems.  The default is @samp{"pop3"}.
11275
11276 @item :user
11277 The user name to give to the POP server.  The default is the login
11278 name.
11279
11280 @item :password
11281 The password to give to the POP server.  If not specified, the user is
11282 prompted.
11283
11284 @item :program
11285 The program to use to fetch mail from the POP server.  This is should be
11286 a @code{format}-like string.  Here's an example:
11287
11288 @example
11289 fetchmail %u@@%s -P %p %t
11290 @end example
11291
11292 The valid format specifier characters are:
11293
11294 @table @samp
11295 @item t
11296 The name of the file the mail is to be moved to.  This must always be
11297 included in this string.
11298
11299 @item s
11300 The name of the server.
11301
11302 @item P
11303 The port number of the server.
11304
11305 @item u
11306 The user name to use.
11307
11308 @item p
11309 The password to use.
11310 @end table
11311
11312 The values used for these specs are taken from the values you give the
11313 corresponding keywords.
11314
11315 @item :prescript
11316 A script to be run before fetching the mail.  The syntax is the same as
11317 the @code{:program} keyword.  This can also be a function to be run.
11318
11319 @item :postscript
11320 A script to be run after fetching the mail.  The syntax is the same as
11321 the @code{:program} keyword.  This can also be a function to be run.
11322
11323 @item :function
11324 The function to use to fetch mail from the POP server.  The function is
11325 called with one parameter---the name of the file where the mail should
11326 be moved to.
11327
11328 @item :authentication
11329 This can be either the symbol @code{password} or the symbol @code{apop}
11330 and says what authentication scheme to use.  The default is
11331 @code{password}.
11332
11333 @end table
11334
11335 If the @code{:program} and @code{:function} keywords aren't specified,
11336 @code{pop3-movemail} will be used.
11337
11338 Here are some examples.  Fetch from the default POP server, using the
11339 default user name, and default fetcher:
11340
11341 @lisp
11342 (pop)
11343 @end lisp
11344
11345 Fetch from a named server with a named user and password:
11346
11347 @lisp
11348 (pop :server "my.pop.server"
11349      :user "user-name" :password "secret")
11350 @end lisp
11351
11352 Use @samp{movemail} to move the mail:
11353
11354 @lisp
11355 (pop :program "movemail po:%u %t %p")
11356 @end lisp
11357
11358 @item maildir
11359 Get mail from a maildir.  This is a type of mailbox that is supported by
11360 at least qmail and postfix, where each file in a special directory
11361 contains exactly one mail.
11362
11363 Keywords:
11364
11365 @table @code
11366 @item :path
11367 The path of the directory where the mails are stored.  The default is
11368 taken from the @code{MAILDIR} environment variable or
11369 @samp{~/Maildir/}.
11370 @item :subdirs
11371 The subdirectories of the Maildir.  The default is
11372 @samp{("new" "cur")}.
11373
11374 @c If you sometimes look at your mail through a pop3 daemon before fetching
11375 @c them with Gnus, you may also have to fetch your mails from the
11376 @c @code{cur} directory inside the maildir, like in the first example
11377 @c below.
11378
11379 You can also get mails from remote hosts (because maildirs don't suffer
11380 from locking problems).
11381
11382 @end table
11383
11384 Two example maildir mail sources:
11385
11386 @lisp
11387 (maildir :path "/home/user-name/Maildir/" :subdirs ("cur" "new"))
11388 @end lisp
11389
11390 @lisp
11391 (maildir :path "/user@@remotehost.org:~/Maildir/" :subdirs ("new"))
11392 @end lisp
11393
11394 @item imap
11395 Get mail from a @sc{imap} server.  If you don't want to use @sc{imap} as
11396 intended, as a network mail reading protocol (ie with nnimap), for some
11397 reason or other, Gnus let you treat it similar to a POP server and
11398 fetches articles from a given @sc{imap} mailbox.
11399
11400 Keywords:
11401
11402 @table @code
11403 @item :server
11404 The name of the @sc{imap} server.  The default is taken from the
11405 @code{MAILHOST} environment variable.
11406
11407 @item :port
11408 The port number of the @sc{imap} server.  The default is @samp{143}, or
11409 @samp{993} for SSL connections.
11410
11411 @item :user
11412 The user name to give to the @sc{imap} server.  The default is the login
11413 name.
11414
11415 @item :password
11416 The password to give to the @sc{imap} server.  If not specified, the user is
11417 prompted.
11418
11419 @item :stream
11420 What stream to use for connecting to the server, this is one of the
11421 symbols in @code{imap-stream-alist}.  Right now, this means
11422 @samp{kerberos4}, @samp{ssl} or the default @samp{network}.
11423
11424 @item :authentication
11425 Which authenticator to use for authenticating to the server, this is one
11426 of the symbols in @code{imap-authenticator-alist}.  Right now, this
11427 means @samp{kerberos4}, @samp{cram-md5}, @samp{anonymous} or the default
11428 @samp{login}.
11429
11430 @item :mailbox
11431 The name of the mailbox to get mail from.  The default is @samp{INBOX}
11432 which normally is the mailbox which receive incoming mail.
11433
11434 @item :predicate
11435 The predicate used to find articles to fetch.  The default, @samp{UNSEEN
11436 UNDELETED}, is probably the best choice for most people, but if you
11437 sometimes peek in your mailbox with a @sc{imap} client and mark some
11438 articles as read (or; SEEN) you might want to set this to @samp{nil}.
11439 Then all articles in the mailbox is fetched, no matter what.  For a
11440 complete list of predicates, see RFC 2060 Â§6.4.4.
11441
11442 @item :fetchflag
11443 How to flag fetched articles on the server, the default @samp{\Deleted}
11444 will mark them as deleted, an alternative would be @samp{\Seen} which
11445 would simply mark them as read.  These are the two most likely choices,
11446 but more flags are defined in RFC 2060 Â§2.3.2.
11447
11448 @item :dontexpunge
11449 If non-nil, don't remove all articles marked as deleted in the mailbox
11450 after finishing the fetch.
11451
11452 @end table
11453
11454 An example @sc{imap} mail source:
11455
11456 @lisp
11457 (imap :server "mail.mycorp.com" :stream kerberos4 :fetchflag "\\Seen")
11458 @end lisp
11459
11460 @item webmail
11461 Get mail from a webmail server, such as www.hotmail.com,
11462 webmail.netscape.com, www.netaddress.com, www.my-deja.com.
11463
11464 NOTE: Now mail.yahoo.com provides POP3 service, so @sc{pop} mail source
11465 is suggested.
11466
11467 NOTE: Webmail largely depends cookies. A "one-line-cookie" patch is
11468 required for url "4.0pre.46".
11469
11470 WARNING: Mails may lost.  NO WARRANTY.
11471
11472 Keywords:
11473
11474 @table @code
11475 @item :subtype
11476 The type of the webmail server.  The default is @code{hotmail}.  The
11477 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
11478
11479 @item :user
11480 The user name to give to the webmail server.  The default is the login
11481 name.
11482
11483 @item :password
11484 The password to give to the webmail server.  If not specified, the user is
11485 prompted.
11486
11487 @item :dontexpunge
11488 If non-nil, only fetch unread articles and don't move them to trash
11489 folder after finishing the fetch.
11490
11491 @end table
11492
11493 An example webmail source:
11494
11495 @lisp
11496 (webmail :subtype 'hotmail :user "user-name" :password "secret")
11497 @end lisp
11498 @end table
11499
11500 @table @dfn
11501 @item Common Keywords
11502 Common keywords can be used in any type of mail source.
11503
11504 Keywords:
11505
11506 @table @code
11507 @item :plugged
11508 If non-nil, fetch the mail even when Gnus is unplugged.  If you use
11509 directory source to get mail, you can specify it as in this example:
11510
11511 @lisp
11512 (setq mail-sources
11513       '((directory :path "/home/pavel/.Spool/" 
11514                    :suffix ""
11515                    :plugged t)))
11516 @end lisp
11517
11518 Gnus will then fetch your mail even when you are unplugged.  This is
11519 useful when you use local mail and news.
11520
11521 @end table
11522 @end table
11523
11524 @subsubheading Function Interface
11525
11526 Some of the above keywords specify a Lisp function to be executed.
11527 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
11528 the value of the keyword while the function is executing.  For example,
11529 consider the following mail-source setting:
11530
11531 @lisp
11532 (setq mail-sources '((pop :user "jrl"
11533                           :server "pophost" :function fetchfunc)))
11534 @end lisp
11535
11536 While the function @code{fetchfunc} is executing, the symbol @code{user}
11537 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
11538 @code{"pophost"}.  The symbols @code{port}, @code{password},
11539 @code{program}, @code{prescript}, @code{postscript}, @code{function},
11540 and @code{authentication} are also bound (to their default values).
11541
11542 See above for a list of keywords for each type of mail source.
11543
11544
11545 @node Mail Source Customization
11546 @subsubsection Mail Source Customization
11547
11548 The following is a list of variables that influence how the mail is
11549 fetched.  You would normally not need to set or change any of these
11550 variables.
11551
11552 @table @code
11553 @item mail-source-crash-box
11554 @vindex mail-source-crash-box
11555 File where mail will be stored while processing it.  The default is
11556 @file{~/.emacs-mail-crash-box}.
11557
11558 @item mail-source-delete-incoming
11559 @vindex mail-source-delete-incoming
11560 If non-@code{nil}, delete incoming files after handling them.
11561
11562 @item mail-source-directory
11563 @vindex mail-source-directory
11564 Directory where files (if any) will be stored.  The default is
11565 @file{~/Mail/}.  At present, the only thing this is used for is to say
11566 where the incoming files will be stored if the previous variable is
11567 @code{nil}.
11568
11569 @item mail-source-incoming-file-prefix
11570 @vindex mail-source-incoming-file-prefix
11571 Prefix for file name for storing incoming mail.  The default is
11572 @file{Incoming}, in which case files will end up with names like
11573 @file{Incoming30630D_} or @file{Incoming298602ZD}.  This is really only
11574 relevant if @code{mail-source-delete-incoming} is @code{nil}.
11575
11576 @item mail-source-default-file-modes
11577 @vindex mail-source-default-file-modes
11578 All new mail files will get this file mode.  The default is 384.
11579
11580 @end table
11581
11582
11583 @node Fetching Mail
11584 @subsubsection Fetching Mail
11585
11586 @vindex mail-sources
11587 @vindex nnmail-spool-file
11588 The way to actually tell Gnus where to get new mail from is to set
11589 @code{mail-sources} to a list of mail source specifiers
11590 (@pxref{Mail Source Specifiers}).
11591
11592 If this variable (and the obsolescent @code{nnmail-spool-file}) is
11593 @code{nil}, the mail backends will never attempt to fetch mail by
11594 themselves.
11595
11596 If you want to fetch mail both from your local spool as well as a POP
11597 mail server, you'd say something like:
11598
11599 @lisp
11600 (setq mail-sources
11601       '((file)
11602         (pop :server "pop3.mail.server"
11603              :password "secret")))
11604 @end lisp
11605
11606 Or, if you don't want to use any of the keyword defaults:
11607
11608 @lisp
11609 (setq mail-sources
11610       '((file :path "/var/spool/mail/user-name")
11611         (pop :server "pop3.mail.server"
11612              :user "user-name"
11613              :port "pop3"
11614              :password "secret")))
11615 @end lisp
11616
11617
11618 When you use a mail backend, Gnus will slurp all your mail from your
11619 inbox and plonk it down in your home directory.  Gnus doesn't move any
11620 mail if you're not using a mail backend---you have to do a lot of magic
11621 invocations first.  At the time when you have finished drawing the
11622 pentagram, lightened the candles, and sacrificed the goat, you really
11623 shouldn't be too surprised when Gnus moves your mail.
11624
11625
11626
11627 @node Mail Backend Variables
11628 @subsection Mail Backend Variables
11629
11630 These variables are (for the most part) pertinent to all the various
11631 mail backends.
11632
11633 @table @code
11634 @vindex nnmail-read-incoming-hook
11635 @item nnmail-read-incoming-hook
11636 The mail backends all call this hook after reading new mail.  You can
11637 use this hook to notify any mail watch programs, if you want to.
11638
11639 @vindex nnmail-split-hook
11640 @item nnmail-split-hook
11641 @findex article-decode-encoded-words
11642 @findex RFC 1522 decoding
11643 @findex RFC 2047 decoding
11644 Hook run in the buffer where the mail headers of each message is kept
11645 just before the splitting based on these headers is done.  The hook is
11646 free to modify the buffer contents in any way it sees fit---the buffer
11647 is discarded after the splitting has been done, and no changes performed
11648 in the buffer will show up in any files.
11649 @code{gnus-article-decode-encoded-words} is one likely function to add
11650 to this hook.
11651
11652 @vindex nnmail-pre-get-new-mail-hook
11653 @vindex nnmail-post-get-new-mail-hook
11654 @item nnmail-pre-get-new-mail-hook
11655 @itemx nnmail-post-get-new-mail-hook
11656 These are two useful hooks executed when treating new incoming
11657 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
11658 starting to handle the new mail) and
11659 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
11660 is done).  Here's and example of using these two hooks to change the
11661 default file modes the new mail files get:
11662
11663 @lisp
11664 (add-hook 'gnus-pre-get-new-mail-hook
11665           (lambda () (set-default-file-modes 511)))
11666
11667 (add-hook 'gnus-post-get-new-mail-hook
11668           (lambda () (set-default-file-modes 551)))
11669 @end lisp
11670
11671 @item nnmail-use-long-file-names
11672 @vindex nnmail-use-long-file-names
11673 If non-@code{nil}, the mail backends will use long file and directory
11674 names.  Groups like @samp{mail.misc} will end up in directories
11675 (assuming use of @code{nnml} backend) or files (assuming use of
11676 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
11677 the same group will end up in @file{mail/misc}.
11678
11679 @item nnmail-delete-file-function
11680 @vindex nnmail-delete-file-function
11681 @findex delete-file
11682 Function called to delete files.  It is @code{delete-file} by default.
11683
11684 @item nnmail-cache-accepted-message-ids
11685 @vindex nnmail-cache-accepted-message-ids
11686 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
11687 the backend (via @code{Gcc}, for instance) into the mail duplication
11688 discovery cache.  The default is @code{nil}.
11689
11690 @end table
11691
11692
11693 @node Fancy Mail Splitting
11694 @subsection Fancy Mail Splitting
11695 @cindex mail splitting
11696 @cindex fancy mail splitting
11697
11698 @vindex nnmail-split-fancy
11699 @findex nnmail-split-fancy
11700 If the rather simple, standard method for specifying how to split mail
11701 doesn't allow you to do what you want, you can set
11702 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
11703 play with the @code{nnmail-split-fancy} variable.
11704
11705 Let's look at an example value of this variable first:
11706
11707 @lisp
11708 ;; Messages from the mailer daemon are not crossposted to any of
11709 ;; the ordinary groups.  Warnings are put in a separate group
11710 ;; from real errors.
11711 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
11712                    "mail.misc"))
11713    ;; Non-error messages are crossposted to all relevant
11714    ;; groups, but we don't crosspost between the group for the
11715    ;; (ding) list and the group for other (ding) related mail.
11716    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
11717          ("subject" "ding" "ding.misc"))
11718       ;; Other mailing lists...
11719       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
11720       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
11721       ;; Both lists below have the same suffix, so prevent
11722       ;; cross-posting to mkpkg.list of messages posted only to
11723       ;; the bugs- list, but allow cross-posting when the
11724       ;; message was really cross-posted.
11725       (any "bugs-mypackage@@somewhere" "mypkg.bugs")
11726       (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
11727       ;; People...
11728       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
11729    ;; Unmatched mail goes to the catch all group.
11730    "misc.misc")
11731 @end lisp
11732
11733 This variable has the format of a @dfn{split}.  A split is a (possibly)
11734 recursive structure where each split may contain other splits.  Here are
11735 the five possible split syntaxes:
11736
11737 @enumerate
11738
11739 @item
11740 @samp{group}: If the split is a string, that will be taken as a group
11741 name.  Normal regexp match expansion will be done.  See below for
11742 examples.
11743
11744 @item
11745 @code{(@var{field} @var{value} @code{[-} @var{restrict}
11746 @code{[@dots{}]}@code{]} @var{split})}: If the split is a list, the
11747 first element of which is a string, then store the message as
11748 specified by @var{split}, if header @var{field} (a regexp) contains
11749 @var{value} (also a regexp).  If @var{restrict} (yet another regexp)
11750 matches some string after @var{field} and before the end of the
11751 matched @var{value}, the @var{split} is ignored.  If none of the
11752 @var{restrict} clauses match, @var{split} is processed.
11753
11754 @item
11755 @code{(| @var{split}@dots{})}: If the split is a list, and the first
11756 element is @code{|} (vertical bar), then process each @var{split} until
11757 one of them matches.  A @var{split} is said to match if it will cause
11758 the mail message to be stored in one or more groups.
11759
11760 @item
11761 @code{(& @var{split}@dots{})}: If the split is a list, and the first
11762 element is @code{&}, then process all @var{split}s in the list.
11763
11764 @item
11765 @code{junk}: If the split is the symbol @code{junk}, then don't save
11766 this message.  Use with extreme caution.
11767
11768 @item
11769 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is
11770 a list, and the first element is @code{:}, then the second element will
11771 be called as a function with @var{args} given as arguments.  The
11772 function should return a @var{split}.
11773
11774 For instance, the following function could be used to split based on the
11775 body of the messages:
11776
11777 @lisp
11778 (defun split-on-body ()
11779   (save-excursion
11780     (set-buffer " *nnmail incoming*")
11781     (goto-char (point-min))
11782     (when (re-search-forward "Some.*string" nil t)
11783       "string.group")))
11784 @end lisp
11785
11786 @item
11787 @code{(! @var{func} @var{split})}: If the split is a list, and the first
11788 element is @code{!}, then SPLIT will be processed, and FUNC will be
11789 called as a function with the result of SPLIT as argument.  FUNC should
11790 return a split.
11791
11792 @item
11793 @code{nil}: If the split is @code{nil}, it is ignored.
11794
11795 @end enumerate
11796
11797 In these splits, @var{field} must match a complete field name.
11798 @var{value} must match a complete word according to the fundamental mode
11799 syntax table.  You can use @code{.*} in the regexps to match partial
11800 field names or words.  In other words, all @var{value}'s are wrapped in
11801 @samp{\<} and @samp{\>} pairs.
11802
11803 @vindex nnmail-split-abbrev-alist
11804 @var{field} and @var{value} can also be lisp symbols, in that case they
11805 are expanded as specified by the variable
11806 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
11807 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
11808 value.
11809
11810 @vindex nnmail-split-fancy-syntax-table
11811 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
11812 when all this splitting is performed.
11813
11814 If you want to have Gnus create groups dynamically based on some
11815 information in the headers (i.e., do @code{replace-match}-like
11816 substitutions in the group names), you can say things like:
11817
11818 @example
11819 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
11820 @end example
11821
11822 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
11823 will be filed in @samp{mail.debian.foo}.
11824
11825 If the string contains the element @samp{\&}, then the previously
11826 matched string will be substituted.  Similarly, the elements @samp{\\1}
11827 up to @samp{\\9} will be substituted with the text matched by the
11828 groupings 1 through 9.
11829
11830 @findex nnmail-split-fancy-with-parent
11831 @code{nnmail-split-fancy-with-parent} is a function which allows you to
11832 split followups into the same groups their parents are in.  Sometimes
11833 you can't make splitting rules for all your mail.  For example, your
11834 boss might send you personal mail regarding different projects you are
11835 working on, and as you can't tell your boss to put a distinguishing
11836 string into the subject line, you have to resort to manually moving the
11837 messages into the right group.  With this function, you only have to do
11838 it once per thread.
11839
11840 To use this feature, you have to set @code{nnmail-treat-duplicates} to a
11841 non-nil value.  And then you can include
11842 @code{nnmail-split-fancy-with-parent} using the colon feature, like so:
11843 @lisp
11844 (setq nnmail-split-fancy
11845       '(| (: nnmail-split-fancy-with-parent)
11846           ;; other splits go here
11847         ))
11848 @end lisp
11849
11850 This feature works as follows: when @code{nnmail-treat-duplicates} is
11851 non-nil, Gnus records the message id of every message it sees in the
11852 file specified by the variable @code{nnmail-message-id-cache-file},
11853 together with the group it is in (the group is omitted for non-mail
11854 messages).  When mail splitting is invoked, the function
11855 @code{nnmail-split-fancy-with-parent} then looks at the References (and
11856 In-Reply-To) header of each message to split and searches the file
11857 specified by @code{nnmail-message-id-cache-file} for the message ids.
11858 When it has found a parent, it returns the corresponding group name.  It
11859 is recommended that you set @code{nnmail-message-id-cache-length} to a
11860 somewhat higher number than the default so that the message ids are
11861 still in the cache.  (A value of 5000 appears to create a file some 300
11862 kBytes in size.)  When @code{nnmail-cache-accepted-message-ids} is
11863 non-nil, Gnus also records the message ids of moved articles, so that
11864 the followup messages goes into the new group.
11865
11866
11867 @node Group Mail Splitting
11868 @subsection Group Mail Splitting
11869 @cindex mail splitting
11870 @cindex group mail splitting
11871
11872 @findex gnus-group-split
11873 If you subscribe to dozens of mailing lists but you don't want to
11874 maintain mail splitting rules manually, group mail splitting is for you.
11875 You just have to set @var{to-list} and/or @var{to-address} in group
11876 parameters or group customization and set @code{nnmail-split-methods} to
11877 @code{gnus-group-split}.  This splitting function will scan all groups
11878 for those parameters and split mail accordingly, i.e., messages posted
11879 from or to the addresses specified in the parameters @var{to-list} or
11880 @var{to-address} of a mail group will be stored in that group.
11881
11882 Sometimes, mailing lists have multiple addresses, and you may want mail
11883 splitting to recognize them all: just set the @var{extra-aliases} group
11884 parameter to the list of additional addresses and it's done.  If you'd
11885 rather use a regular expression, set @var{split-regexp}.
11886
11887 All these parameters in a group will be used to create an
11888 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
11889 the @var{value} is a single regular expression that matches
11890 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
11891 matches of @var{split-regexp}, and the @var{split} is the name of the
11892 group.  @var{restrict}s are also supported: just set the
11893 @var{split-exclude} parameter to a list of regular expressions.
11894
11895 If you can't get the right split to be generated using all these
11896 parameters, or you just need something fancier, you can set the
11897 parameter @var{split-spec} to an @code{nnmail-split-fancy} split.  In
11898 this case, all other aforementioned parameters will be ignored by
11899 @code{gnus-group-split}.  In particular, @var{split-spec} may be set to
11900 @code{nil}, in which case the group will be ignored by
11901 @code{gnus-group-split}.
11902
11903 @vindex gnus-group-split-default-catch-all-group
11904 @code{gnus-group-split} will do cross-posting on all groups that match,
11905 by defining a single @code{&} fancy split containing one split for each
11906 group.  If a message doesn't match any split, it will be stored in the
11907 group named in @code{gnus-group-split-default-catch-all-group}, unless
11908 some group has @var{split-spec} set to @code{catch-all}, in which case
11909 that group is used as the catch-all group.  Even though this variable is
11910 often used just to name a group, it may also be set to an arbitrarily
11911 complex fancy split (after all, a group name is a fancy split), and this
11912 may be useful to split mail that doesn't go to any mailing list to
11913 personal mail folders.  Note that this fancy split is added as the last
11914 element of a @code{|} split list that also contains a @code{&} split
11915 with the rules extracted from group parameters.
11916
11917 It's time for an example.  Assume the following group parameters have
11918 been defined:
11919
11920 @example
11921 nnml:mail.bar:
11922 ((to-address . "bar@@femail.com")
11923  (split-regexp . ".*@@femail\\.com"))
11924 nnml:mail.foo:
11925 ((to-list . "foo@@nowhere.gov")
11926  (extra-aliases "foo@@localhost" "foo-redist@@home")
11927  (split-exclude "bugs-foo" "rambling-foo")
11928  (admin-address . "foo-request@@nowhere.gov"))
11929 nnml:mail.others:
11930 ((split-spec . catch-all))
11931 @end example
11932
11933 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
11934 behave as if @code{nnmail-split-fancy} had been selected and variable
11935 @code{nnmail-split-fancy} had been set as follows:
11936
11937 @lisp
11938 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
11939       (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
11940            - "bugs-foo" - "rambling-foo" "mail.foo"))
11941    "mail.others")
11942 @end lisp
11943
11944 @findex gnus-group-split-fancy
11945 If you'd rather not use group splitting for all your mail groups, you
11946 may use it for only some of them, by using @code{nnmail-split-fancy}
11947 splits like this:
11948
11949 @lisp
11950 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
11951 @end lisp
11952
11953 @var{groups} may be a regular expression or a list of group names whose
11954 parameters will be scanned to generate the output split.
11955 @var{no-crosspost} can be used to disable cross-posting; in this case, a
11956 single @code{|} split will be output.  @var{catch-all} is the fallback
11957 fancy split, used like @var{gnus-group-split-default-catch-all-group}.
11958 If @var{catch-all} is @code{nil}, or if @var{split-regexp} matches the
11959 empty string in any selected group, no catch-all split will be issued.
11960 Otherwise, if some group has @var{split-spec} set to @code{catch-all},
11961 this group will override the value of the @var{catch-all} argument.
11962
11963 @findex gnus-group-split-setup
11964 Unfortunately, scanning all groups and their parameters can be quite
11965 slow, especially considering that it has to be done for every message.
11966 But don't despair!  The function @code{gnus-group-split-setup} can be
11967 used to enable @code{gnus-group-split} in a much more efficient way.  It
11968 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
11969 @code{nnmail-split-fancy} to the split produced by
11970 @code{gnus-group-split-fancy}.  Thus, the group parameters are only
11971 scanned once, no matter how many messages are split.
11972
11973 @findex gnus-group-split-update
11974 However, if you change group parameters, you'd have to update
11975 @code{nnmail-split-fancy} manually.  You can do it by running
11976 @code{gnus-group-split-update}.  If you'd rather have it updated
11977 automatically, just tell @code{gnus-group-split-setup} to do it for
11978 you.  For example, add to your @file{.gnus}:
11979
11980 @lisp
11981 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
11982 @end lisp
11983
11984 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
11985 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
11986 have to worry about updating @code{nnmail-split-fancy} again.  If you
11987 don't omit @var{catch-all} (it's optional; same as nil),
11988 @code{gnus-group-split-default-catch-all-group} will be set to its
11989 value.
11990
11991 @vindex gnus-group-split-updated-hook
11992 Because you may want to change @code{nnmail-split-fancy} after it is set
11993 by @code{gnus-group-split-update}, this function will run
11994 @code{gnus-group-split-updated-hook} just before finishing.
11995
11996 @node Incorporating Old Mail
11997 @subsection Incorporating Old Mail
11998
11999 Most people have lots of old mail stored in various file formats.  If
12000 you have set up Gnus to read mail using one of the spiffy Gnus mail
12001 backends, you'll probably wish to have that old mail incorporated into
12002 your mail groups.
12003
12004 Doing so can be quite easy.
12005
12006 To take an example: You're reading mail using @code{nnml}
12007 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
12008 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
12009 file filled with important, but old, mail.  You want to move it into
12010 your @code{nnml} groups.
12011
12012 Here's how:
12013
12014 @enumerate
12015 @item
12016 Go to the group buffer.
12017
12018 @item
12019 Type `G f' and give the path to the mbox file when prompted to create an
12020 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
12021
12022 @item
12023 Type `SPACE' to enter the newly created group.
12024
12025 @item
12026 Type `M P b' to process-mark all articles in this group's buffer
12027 (@pxref{Setting Process Marks}).
12028
12029 @item
12030 Type `B r' to respool all the process-marked articles, and answer
12031 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
12032 @end enumerate
12033
12034 All the mail messages in the mbox file will now also be spread out over
12035 all your @code{nnml} groups.  Try entering them and check whether things
12036 have gone without a glitch.  If things look ok, you may consider
12037 deleting the mbox file, but I wouldn't do that unless I was absolutely
12038 sure that all the mail has ended up where it should be.
12039
12040 Respooling is also a handy thing to do if you're switching from one mail
12041 backend to another.  Just respool all the mail in the old mail groups
12042 using the new mail backend.
12043
12044
12045 @node Expiring Mail
12046 @subsection Expiring Mail
12047 @cindex article expiry
12048
12049 Traditional mail readers have a tendency to remove mail articles when
12050 you mark them as read, in some way.  Gnus takes a fundamentally
12051 different approach to mail reading.
12052
12053 Gnus basically considers mail just to be news that has been received in
12054 a rather peculiar manner.  It does not think that it has the power to
12055 actually change the mail, or delete any mail messages.  If you enter a
12056 mail group, and mark articles as ``read'', or kill them in some other
12057 fashion, the mail articles will still exist on the system.  I repeat:
12058 Gnus will not delete your old, read mail.  Unless you ask it to, of
12059 course.
12060
12061 To make Gnus get rid of your unwanted mail, you have to mark the
12062 articles as @dfn{expirable}.  This does not mean that the articles will
12063 disappear right away, however.  In general, a mail article will be
12064 deleted from your system if, 1) it is marked as expirable, AND 2) it is
12065 more than one week old.  If you do not mark an article as expirable, it
12066 will remain on your system until hell freezes over.  This bears
12067 repeating one more time, with some spurious capitalizations: IF you do
12068 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
12069
12070 @vindex gnus-auto-expirable-newsgroups
12071 You do not have to mark articles as expirable by hand.  Groups that
12072 match the regular expression @code{gnus-auto-expirable-newsgroups} will
12073 have all articles that you read marked as expirable automatically.  All
12074 articles marked as expirable have an @samp{E} in the first
12075 column in the summary buffer.
12076
12077 By default, if you have auto expiry switched on, Gnus will mark all the
12078 articles you read as expirable, no matter if they were read or unread
12079 before.  To avoid having articles marked as read marked as expirable
12080 automatically, you can put something like the following in your
12081 @file{.gnus} file:
12082
12083 @vindex gnus-mark-article-hook
12084 @lisp
12085 (remove-hook 'gnus-mark-article-hook
12086              'gnus-summary-mark-read-and-unread-as-read)
12087 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
12088 @end lisp
12089
12090 Note that making a group auto-expirable doesn't mean that all read
12091 articles are expired---only the articles marked as expirable
12092 will be expired.  Also note that using the @kbd{d} command won't make
12093 groups expirable---only semi-automatic marking of articles as read will
12094 mark the articles as expirable in auto-expirable groups.
12095
12096 Let's say you subscribe to a couple of mailing lists, and you want the
12097 articles you have read to disappear after a while:
12098
12099 @lisp
12100 (setq gnus-auto-expirable-newsgroups
12101       "mail.nonsense-list\\|mail.nice-list")
12102 @end lisp
12103
12104 Another way to have auto-expiry happen is to have the element
12105 @code{auto-expire} in the group parameters of the group.
12106
12107 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
12108 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
12109 don't really mix very well.
12110
12111 @vindex nnmail-expiry-wait
12112 The @code{nnmail-expiry-wait} variable supplies the default time an
12113 expirable article has to live.  Gnus starts counting days from when the
12114 message @emph{arrived}, not from when it was sent.  The default is seven
12115 days.
12116
12117 Gnus also supplies a function that lets you fine-tune how long articles
12118 are to live, based on what group they are in.  Let's say you want to
12119 have one month expiry period in the @samp{mail.private} group, a one day
12120 expiry period in the @samp{mail.junk} group, and a six day expiry period
12121 everywhere else:
12122
12123 @vindex nnmail-expiry-wait-function
12124 @lisp
12125 (setq nnmail-expiry-wait-function
12126       (lambda (group)
12127        (cond ((string= group "mail.private")
12128                31)
12129              ((string= group "mail.junk")
12130                1)
12131              ((string= group "important")
12132                'never)
12133              (t
12134                6))))
12135 @end lisp
12136
12137 The group names this function is fed are ``unadorned'' group
12138 names---no @samp{nnml:} prefixes and the like.
12139
12140 The @code{nnmail-expiry-wait} variable and
12141 @code{nnmail-expiry-wait-function} function can either be a number (not
12142 necessarily an integer) or one of the symbols @code{immediate} or
12143 @code{never}.
12144
12145 You can also use the @code{expiry-wait} group parameter to selectively
12146 change the expiry period (@pxref{Group Parameters}).
12147
12148 @vindex nnmail-expiry-target
12149 The normal action taken when expiring articles is to delete them.
12150 However, in some circumstances it might make more sense to move them to
12151 other groups instead of deleting them.  The variable @code{nnmail-expiry-target}
12152 (and the @code{expiry-target} group parameter) controls this.  The
12153 variable supplies a default value for all groups, which can be
12154 overridden for specific groups by the group parameter.
12155 default value is @code{delete}, but this can also be a string (which
12156 should be the name of the group the message should be moved to), or a
12157 function (which will be called in a buffer narrowed to the message in
12158 question, and with the name of the group being moved from as its
12159 parameter) which should return a target -- either a group name or
12160 @code{delete}.
12161
12162 Here's an example for specifying a group name:
12163 @lisp
12164 (setq nnmail-expiry-target "nnml:expired")
12165 @end lisp
12166
12167
12168 @vindex nnmail-keep-last-article
12169 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
12170 expire the final article in a mail newsgroup.  This is to make life
12171 easier for procmail users.
12172
12173 @vindex gnus-total-expirable-newsgroups
12174 By the way: That line up there, about Gnus never expiring non-expirable
12175 articles, is a lie.  If you put @code{total-expire} in the group
12176 parameters, articles will not be marked as expirable, but all read
12177 articles will be put through the expiry process.  Use with extreme
12178 caution.  Even more dangerous is the
12179 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
12180 this regexp will have all read articles put through the expiry process,
12181 which means that @emph{all} old mail articles in the groups in question
12182 will be deleted after a while.  Use with extreme caution, and don't come
12183 crying to me when you discover that the regexp you used matched the
12184 wrong group and all your important mail has disappeared.  Be a
12185 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
12186 with!  So there!
12187
12188 Most people make most of their mail groups total-expirable, though.
12189
12190 @vindex gnus-inhibit-user-auto-expire
12191 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
12192 commands will not mark an article as expirable, even if the group has
12193 auto-expire turned on.
12194
12195
12196 @node Washing Mail
12197 @subsection Washing Mail
12198 @cindex mail washing
12199 @cindex list server brain damage
12200 @cindex incoming mail treatment
12201
12202 Mailers and list servers are notorious for doing all sorts of really,
12203 really stupid things with mail.  ``Hey, RFC 822 doesn't explicitly
12204 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
12205 end of all lines passing through our server, so let's do that!!!!1!''
12206 Yes, but RFC 822 wasn't designed to be read by morons.  Things that were
12207 considered to be self-evident were not discussed.  So.  Here we are.
12208
12209 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
12210 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
12211 be shocked and dismayed by this, but I haven't got the energy.  It is to
12212 laugh.
12213
12214 Gnus provides a plethora of functions for washing articles while
12215 displaying them, but it might be nicer to do the filtering before
12216 storing the mail to disc.  For that purpose, we have three hooks and
12217 various functions that can be put in these hooks.
12218
12219 @table @code
12220 @item nnmail-prepare-incoming-hook
12221 @vindex nnmail-prepare-incoming-hook
12222 This hook is called before doing anything with the mail and is meant for
12223 grand, sweeping gestures.  It is called in a buffer that contains all
12224 the new, incoming mail.  Functions to be used include:
12225
12226 @table @code
12227 @item nnheader-ms-strip-cr
12228 @findex nnheader-ms-strip-cr
12229 Remove trailing carriage returns from each line.  This is default on
12230 Emacs running on MS machines.
12231
12232 @end table
12233
12234 @item nnmail-prepare-incoming-header-hook
12235 @vindex nnmail-prepare-incoming-header-hook
12236 This hook is called narrowed to each header.  It can be used when
12237 cleaning up the headers.  Functions that can be used include:
12238
12239 @table @code
12240 @item nnmail-remove-leading-whitespace
12241 @findex nnmail-remove-leading-whitespace
12242 Clear leading white space that ``helpful'' listservs have added to the
12243 headers to make them look nice.  Aaah.
12244
12245 @item nnmail-remove-list-identifiers
12246 @findex nnmail-remove-list-identifiers
12247 Some list servers add an identifier---for example, @samp{(idm)}---to the
12248 beginning of all @code{Subject} headers.  I'm sure that's nice for
12249 people who use stone age mail readers.  This function will remove
12250 strings that match the @code{nnmail-list-identifiers} regexp, which can
12251 also be a list of regexp.  @code{nnmail-list-identifiers} may not contain
12252 @code{\\(..\\)}.
12253
12254 For instance, if you want to remove the @samp{(idm)} and the
12255 @samp{nagnagnag} identifiers:
12256
12257 @lisp
12258 (setq nnmail-list-identifiers
12259       '("(idm)" "nagnagnag"))
12260 @end lisp
12261
12262 This can also be done non-destructively with
12263 @code{gnus-list-identifiers}, @xref{Article Hiding}.
12264
12265 @item nnmail-remove-tabs
12266 @findex nnmail-remove-tabs
12267 Translate all @samp{TAB} characters into @samp{SPACE} characters.
12268
12269 @item nnmail-fix-eudora-headers
12270 @findex nnmail-fix-eudora-headers
12271 @cindex Eudora
12272 Eudora produces broken @code{References} headers, but OK
12273 @code{In-Reply-To} headers.  This function will get rid of the
12274 @code{References} headers.
12275
12276 @end table
12277
12278 @item nnmail-prepare-incoming-message-hook
12279 @vindex nnmail-prepare-incoming-message-hook
12280 This hook is called narrowed to each message.  Functions to be used
12281 include:
12282
12283 @table @code
12284 @item article-de-quoted-unreadable
12285 @findex article-de-quoted-unreadable
12286 Decode Quoted Readable encoding.
12287
12288 @end table
12289 @end table
12290
12291
12292 @node Duplicates
12293 @subsection Duplicates
12294
12295 @vindex nnmail-treat-duplicates
12296 @vindex nnmail-message-id-cache-length
12297 @vindex nnmail-message-id-cache-file
12298 @cindex duplicate mails
12299 If you are a member of a couple of mailing lists, you will sometimes
12300 receive two copies of the same mail.  This can be quite annoying, so
12301 @code{nnmail} checks for and treats any duplicates it might find.  To do
12302 this, it keeps a cache of old @code{Message-ID}s---
12303 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
12304 default.  The approximate maximum number of @code{Message-ID}s stored
12305 there is controlled by the @code{nnmail-message-id-cache-length}
12306 variable, which is 1000 by default.  (So 1000 @code{Message-ID}s will be
12307 stored.) If all this sounds scary to you, you can set
12308 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
12309 default), and @code{nnmail} won't delete duplicate mails.  Instead it
12310 will insert a warning into the head of the mail saying that it thinks
12311 that this is a duplicate of a different message.
12312
12313 This variable can also be a function.  If that's the case, the function
12314 will be called from a buffer narrowed to the message in question with
12315 the @code{Message-ID} as a parameter.  The function must return either
12316 @code{nil}, @code{warn}, or @code{delete}.
12317
12318 You can turn this feature off completely by setting the variable to
12319 @code{nil}.
12320
12321 If you want all the duplicate mails to be put into a special
12322 @dfn{duplicates} group, you could do that using the normal mail split
12323 methods:
12324
12325 @lisp
12326 (setq nnmail-split-fancy
12327       '(| ;; Messages duplicates go to a separate group.
12328           ("gnus-warning" "duplication of message" "duplicate")
12329           ;; Message from daemons, postmaster, and the like to another.
12330           (any mail "mail.misc")
12331           ;; Other rules.
12332           [ ... ] ))
12333 @end lisp
12334
12335 Or something like:
12336 @lisp
12337 (setq nnmail-split-methods
12338       '(("duplicates" "^Gnus-Warning:")
12339         ;; Other rules.
12340         [...]))
12341 @end lisp
12342
12343 Here's a neat feature: If you know that the recipient reads her mail
12344 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
12345 @code{delete}, you can send her as many insults as you like, just by
12346 using a @code{Message-ID} of a mail that you know that she's already
12347 received.  Think of all the fun!  She'll never see any of it!  Whee!
12348
12349
12350 @node Not Reading Mail
12351 @subsection Not Reading Mail
12352
12353 If you start using any of the mail backends, they have the annoying
12354 habit of assuming that you want to read mail with them.  This might not
12355 be unreasonable, but it might not be what you want.
12356
12357 If you set @code{mail-sources} and @code{nnmail-spool-file} to
12358 @code{nil}, none of the backends will ever attempt to read incoming
12359 mail, which should help.
12360
12361 @vindex nnbabyl-get-new-mail
12362 @vindex nnmbox-get-new-mail
12363 @vindex nnml-get-new-mail
12364 @vindex nnmh-get-new-mail
12365 @vindex nnfolder-get-new-mail
12366 This might be too much, if, for instance, you are reading mail quite
12367 happily with @code{nnml} and just want to peek at some old @sc{rmail}
12368 file you have stashed away with @code{nnbabyl}.  All backends have
12369 variables called backend-@code{get-new-mail}.  If you want to disable
12370 the @code{nnbabyl} mail reading, you edit the virtual server for the
12371 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
12372
12373 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
12374 narrowed to the article to be saved before saving it when reading
12375 incoming mail.
12376
12377
12378 @node Choosing a Mail Backend
12379 @subsection Choosing a Mail Backend
12380
12381 Gnus will read the mail spool when you activate a mail group.  The mail
12382 file is first copied to your home directory.  What happens after that
12383 depends on what format you want to store your mail in.
12384
12385 There are five different mail backends in the standard Gnus, and more
12386 backends are available separately.  The mail backend most people use
12387 (because it is the fastest and most flexible) is @code{nnml}
12388 (@pxref{Mail Spool}).
12389
12390 @menu
12391 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
12392 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
12393 * Mail Spool::                  Store your mail in a private spool?
12394 * MH Spool::                    An mhspool-like backend.
12395 * Mail Folders::                Having one file for each group.
12396 * Comparing Mail Backends::     An in-depth looks at pros and cons.
12397 @end menu
12398
12399
12400 @node Unix Mail Box
12401 @subsubsection Unix Mail Box
12402 @cindex nnmbox
12403 @cindex unix mail box
12404
12405 @vindex nnmbox-active-file
12406 @vindex nnmbox-mbox-file
12407 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
12408 mail.  @code{nnmbox} will add extra headers to each mail article to say
12409 which group it belongs in.
12410
12411 Virtual server settings:
12412
12413 @table @code
12414 @item nnmbox-mbox-file
12415 @vindex nnmbox-mbox-file
12416 The name of the mail box in the user's home directory.
12417
12418 @item nnmbox-active-file
12419 @vindex nnmbox-active-file
12420 The name of the active file for the mail box.
12421
12422 @item nnmbox-get-new-mail
12423 @vindex nnmbox-get-new-mail
12424 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
12425 into groups.
12426 @end table
12427
12428
12429 @node Rmail Babyl
12430 @subsubsection Rmail Babyl
12431 @cindex nnbabyl
12432 @cindex rmail mbox
12433
12434 @vindex nnbabyl-active-file
12435 @vindex nnbabyl-mbox-file
12436 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
12437 mbox}) to store mail.  @code{nnbabyl} will add extra headers to each
12438 mail article to say which group it belongs in.
12439
12440 Virtual server settings:
12441
12442 @table @code
12443 @item nnbabyl-mbox-file
12444 @vindex nnbabyl-mbox-file
12445 The name of the rmail mbox file.
12446
12447 @item nnbabyl-active-file
12448 @vindex nnbabyl-active-file
12449 The name of the active file for the rmail box.
12450
12451 @item nnbabyl-get-new-mail
12452 @vindex nnbabyl-get-new-mail
12453 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
12454 @end table
12455
12456
12457 @node Mail Spool
12458 @subsubsection Mail Spool
12459 @cindex nnml
12460 @cindex mail @sc{nov} spool
12461
12462 The @dfn{nnml} spool mail format isn't compatible with any other known
12463 format.  It should be used with some caution.
12464
12465 @vindex nnml-directory
12466 If you use this backend, Gnus will split all incoming mail into files,
12467 one file for each mail, and put the articles into the corresponding
12468 directories under the directory specified by the @code{nnml-directory}
12469 variable.  The default value is @file{~/Mail/}.
12470
12471 You do not have to create any directories beforehand; Gnus will take
12472 care of all that.
12473
12474 If you have a strict limit as to how many files you are allowed to store
12475 in your account, you should not use this backend.  As each mail gets its
12476 own file, you might very well occupy thousands of inodes within a few
12477 weeks.  If this is no problem for you, and it isn't a problem for you
12478 having your friendly systems administrator walking around, madly,
12479 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
12480 know that this is probably the fastest format to use.  You do not have
12481 to trudge through a big mbox file just to read your new mail.
12482
12483 @code{nnml} is probably the slowest backend when it comes to article
12484 splitting.  It has to create lots of files, and it also generates
12485 @sc{nov} databases for the incoming mails.  This makes it the fastest
12486 backend when it comes to reading mail.
12487
12488 Virtual server settings:
12489
12490 @table @code
12491 @item nnml-directory
12492 @vindex nnml-directory
12493 All @code{nnml} directories will be placed under this directory.
12494
12495 @item nnml-active-file
12496 @vindex nnml-active-file
12497 The active file for the @code{nnml} server.
12498
12499 @item nnml-newsgroups-file
12500 @vindex nnml-newsgroups-file
12501 The @code{nnml} group descriptions file.  @xref{Newsgroups File
12502 Format}.
12503
12504 @item nnml-get-new-mail
12505 @vindex nnml-get-new-mail
12506 If non-@code{nil}, @code{nnml} will read incoming mail.
12507
12508 @item nnml-nov-is-evil
12509 @vindex nnml-nov-is-evil
12510 If non-@code{nil}, this backend will ignore any @sc{nov} files.
12511
12512 @item nnml-nov-file-name
12513 @vindex nnml-nov-file-name
12514 The name of the @sc{nov} files.  The default is @file{.overview}.
12515
12516 @item nnml-prepare-save-mail-hook
12517 @vindex nnml-prepare-save-mail-hook
12518 Hook run narrowed to an article before saving.
12519
12520 @end table
12521
12522 @findex nnml-generate-nov-databases
12523 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
12524 you can do a complete update by typing @kbd{M-x
12525 nnml-generate-nov-databases}.  This command will trawl through the
12526 entire @code{nnml} hierarchy, looking at each and every article, so it
12527 might take a while to complete.  A better interface to this
12528 functionality can be found in the server buffer (@pxref{Server
12529 Commands}).
12530
12531
12532 @node MH Spool
12533 @subsubsection MH Spool
12534 @cindex nnmh
12535 @cindex mh-e mail spool
12536
12537 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
12538 @sc{nov} databases and it doesn't keep an active file.  This makes
12539 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
12540 makes it easier to write procmail scripts for.
12541
12542 Virtual server settings:
12543
12544 @table @code
12545 @item nnmh-directory
12546 @vindex nnmh-directory
12547 All @code{nnmh} directories will be located under this directory.
12548
12549 @item nnmh-get-new-mail
12550 @vindex nnmh-get-new-mail
12551 If non-@code{nil}, @code{nnmh} will read incoming mail.
12552
12553 @item nnmh-be-safe
12554 @vindex nnmh-be-safe
12555 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
12556 sure that the articles in the folder are actually what Gnus thinks they
12557 are.  It will check date stamps and stat everything in sight, so
12558 setting this to @code{t} will mean a serious slow-down.  If you never
12559 use anything but Gnus to read the @code{nnmh} articles, you do not have
12560 to set this variable to @code{t}.
12561 @end table
12562
12563
12564 @node Mail Folders
12565 @subsubsection Mail Folders
12566 @cindex nnfolder
12567 @cindex mbox folders
12568 @cindex mail folders
12569
12570 @code{nnfolder} is a backend for storing each mail group in a separate
12571 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
12572 will add extra headers to keep track of article numbers and arrival
12573 dates.
12574
12575 Virtual server settings:
12576
12577 @table @code
12578 @item nnfolder-directory
12579 @vindex nnfolder-directory
12580 All the @code{nnfolder} mail boxes will be stored under this directory.
12581
12582 @item nnfolder-active-file
12583 @vindex nnfolder-active-file
12584 The name of the active file.
12585
12586 @item nnfolder-newsgroups-file
12587 @vindex nnfolder-newsgroups-file
12588 The name of the group descriptions file.  @xref{Newsgroups File Format}.
12589
12590 @item nnfolder-get-new-mail
12591 @vindex nnfolder-get-new-mail
12592 If non-@code{nil}, @code{nnfolder} will read incoming mail.
12593
12594 @item nnfolder-save-buffer-hook
12595 @vindex nnfolder-save-buffer-hook
12596 @cindex backup files
12597 Hook run before saving the folders.  Note that Emacs does the normal
12598 backup renaming of files even with the @code{nnfolder} buffers.  If you
12599 wish to switch this off, you could say something like the following in
12600 your @file{.emacs} file:
12601
12602 @lisp
12603 (defun turn-off-backup ()
12604   (set (make-local-variable 'backup-inhibited) t))
12605
12606 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
12607 @end lisp
12608
12609 @item nnfolder-delete-mail-hook
12610 @vindex nnfolder-delete-mail-hook
12611 Hook run in a buffer narrowed to the message that is to be deleted.
12612 This function can be used to copy the message to somewhere else, or to
12613 extract some information from it before removing it.
12614
12615 @item nnfolder-nov-is-evil
12616 @vindex nnfolder-nov-is-evil
12617 If non-@code{nil}, this backend will ignore any @sc{nov} files.
12618
12619 @end table
12620
12621
12622 @findex nnfolder-generate-active-file
12623 @kindex M-x nnfolder-generate-active-file
12624 If you have lots of @code{nnfolder}-like files you'd like to read with
12625 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
12626 command to make @code{nnfolder} aware of all likely files in
12627 @code{nnfolder-directory}.  This only works if you use long file names,
12628 though.
12629
12630 @node Comparing Mail Backends
12631 @subsubsection Comparing Mail Backends
12632
12633 First, just for terminology, the @dfn{backend} is the common word for a
12634 low-level access method---a transport, if you will, by which something
12635 is acquired.  The sense is that one's mail has to come from somewhere,
12636 and so selection of a suitable backend is required in order to get that
12637 mail within spitting distance of Gnus.
12638
12639 The same concept exists for Usenet itself: Though access to articles is
12640 typically done by @sc{nntp} these days, once upon a midnight dreary, everyone
12641 in the world got at Usenet by running a reader on the machine where the
12642 articles lay (the machine which today we call an @sc{nntp} server), and
12643 access was by the reader stepping into the articles' directory spool
12644 area directly.  One can still select between either the @code{nntp} or
12645 @code{nnspool} backends, to select between these methods, if one happens
12646 actually to live on the server (or can see its spool directly, anyway,
12647 via NFS).
12648
12649 The goal in selecting a mail backend is to pick one which
12650 simultaneously represents a suitable way of dealing with the original
12651 format plus leaving mail in a form that is convenient to use in the
12652 future.  Here are some high and low points on each:
12653
12654 @table @code
12655 @item nnmbox
12656
12657 UNIX systems have historically had a single, very common, and well-
12658 defined format.  All messages arrive in a single @dfn{spool file}, and
12659 they are delineated by a line whose regular expression matches
12660 @samp{^From_}.  (My notational use of @samp{_} is to indicate a space,
12661 to make it clear in this instance that this is not the RFC-specified
12662 @samp{From:} header.)  Because Emacs and therefore Gnus emanate
12663 historically from the Unix environment, it is simplest if one does not
12664 mess a great deal with the original mailbox format, so if one chooses
12665 this backend, Gnus' primary activity in getting mail from the real spool
12666 area to Gnus' preferred directory is simply to copy it, with no
12667 (appreciable) format change in the process.  It is the ``dumbest'' way
12668 to move mail into availability in the Gnus environment.  This makes it
12669 fast to move into place, but slow to parse, when Gnus has to look at
12670 what's where.
12671
12672 @item nnbabyl
12673
12674 Once upon a time, there was the DEC-10 and DEC-20, running operating
12675 systems called TOPS and related things, and the usual (only?) mail
12676 reading environment was a thing called Babyl.  I don't know what format
12677 was used for mail landing on the system, but Babyl had its own internal
12678 format to which mail was converted, primarily involving creating a
12679 spool-file-like entity with a scheme for inserting Babyl-specific
12680 headers and status bits above the top of each message in the file.
12681 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
12682 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
12683 to understand the mail files folks already had in existence.  Gnus (and
12684 VM, for that matter) continue to support this format because it's
12685 perceived as having some good qualities in those mailer-specific
12686 headers/status bits stuff.  RMAIL itself still exists as well, of
12687 course, and is still maintained by Stallman.
12688
12689 Both of the above forms leave your mail in a single file on your
12690 filesystem, and they must parse that entire file each time you take a
12691 look at your mail.
12692
12693 @item nnml
12694
12695 @code{nnml} is the backend which smells the most as though you were
12696 actually operating with an @code{nnspool}-accessed Usenet system.  (In
12697 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
12698 lo these years ago.)  One's mail is taken from the original spool file,
12699 and is then cut up into individual message files, 1:1.  It maintains a
12700 Usenet-style active file (analogous to what one finds in an INN- or
12701 CNews-based news system in (for instance) @file{/var/lib/news/active},
12702 or what is returned via the @samp{NNTP LIST} verb) and also creates
12703 @dfn{overview} files for efficient group entry, as has been defined for
12704 @sc{nntp} servers for some years now.  It is slower in mail-splitting,
12705 due to the creation of lots of files, updates to the @code{nnml} active
12706 file, and additions to overview files on a per-message basis, but it is
12707 extremely fast on access because of what amounts to the indexing support
12708 provided by the active file and overviews.
12709
12710 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
12711 resource which defines available places in the filesystem to put new
12712 files.  Sysadmins take a dim view of heavy inode occupation within
12713 tight, shared filesystems.  But if you live on a personal machine where
12714 the filesystem is your own and space is not at a premium, @code{nnml}
12715 wins big.
12716
12717 It is also problematic using this backend if you are living in a
12718 FAT16-based Windows world, since much space will be wasted on all these
12719 tiny files.
12720
12721 @item nnmh
12722
12723 The Rand MH mail-reading system has been around UNIX systems for a very
12724 long time; it operates by splitting one's spool file of messages into
12725 individual files, but with little or no indexing support -- @code{nnmh}
12726 is considered to be semantically equivalent to ``@code{nnml} without
12727 active file or overviews''.  This is arguably the worst choice, because
12728 one gets the slowness of individual file creation married to the
12729 slowness of access parsing when learning what's new in one's groups.
12730
12731 @item nnfolder
12732
12733 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
12734 method described above) on a per-group basis.  That is, @code{nnmbox}
12735 itself puts *all* one's mail in one file; @code{nnfolder} provides a
12736 little bit of optimization to this so that each of one's mail groups has
12737 a Unix mail box file.  It's faster than @code{nnmbox} because each group
12738 can be parsed separately, and still provides the simple Unix mail box
12739 format requiring minimal effort in moving the mail around.  In addition,
12740 it maintains an ``active'' file making it much faster for Gnus to figure
12741 out how many messages there are in each separate group.
12742
12743 If you have groups that are expected to have a massive amount of
12744 messages, @code{nnfolder} is not the best choice, but if you receive
12745 only a moderate amount of mail, @code{nnfolder} is probably the most
12746 friendly mail backend all over.
12747
12748 @end table
12749
12750
12751 @node Browsing the Web
12752 @section Browsing the Web
12753 @cindex web
12754 @cindex browsing the web
12755 @cindex www
12756 @cindex http
12757
12758 Web-based discussion forums are getting more and more popular.  On many
12759 subjects, the web-based forums have become the most important forums,
12760 eclipsing the importance of mailing lists and news groups.  The reason
12761 is easy to understand---they are friendly to new users; you just point
12762 and click, and there's the discussion.  With mailing lists, you have to
12763 go through a cumbersome subscription procedure, and most people don't
12764 even know what a news group is.
12765
12766 The problem with this scenario is that web browsers are not very good at 
12767 being newsreaders.  They do not keep track of what articles you've read; 
12768 they do not allow you to score on subjects you're interested in; they do 
12769 not allow off-line browsing; they require you to click around and drive
12770 you mad in the end.
12771
12772 So---if web browsers suck at reading discussion forums, why not use Gnus 
12773 to do it instead?
12774
12775 Gnus has been getting a bit of a collection of backends for providing
12776 interfaces to these sources.
12777
12778 @menu
12779 * Web Searches::          Creating groups from articles that match a string.
12780 * Slashdot::              Reading the Slashdot comments.
12781 * Ultimate::              The Ultimate Bulletin Board systems.
12782 * Web Archive::           Reading mailing list archived on web.
12783 * Customizing w3::        Doing stuff to Emacs/w3 from Gnus.
12784 @end menu
12785
12786 All the web sources require Emacs/w3 and the url library to work.
12787
12788 The main caveat with all these web sources is that they probably won't
12789 work for a very long time.  Gleaning information from the @sc{html} data 
12790 is guesswork at best, and when the layout is altered, the Gnus backend
12791 will fail.  If you have reasonably new versions of these backends,
12792 though, you should be ok.
12793
12794 One thing all these Web methods have in common is that the Web sources
12795 are often down, unavailable or just plain too slow to be fun.  In those
12796 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
12797 Unplugged}) handle downloading articles, and then you can read them at
12798 leisure from your local disk.  No more World Wide Wait for you.
12799
12800
12801 @node Web Searches
12802 @subsection Web Searches
12803 @cindex nnweb
12804 @cindex DejaNews
12805 @cindex Alta Vista
12806 @cindex InReference
12807 @cindex Usenet searches
12808 @cindex searching the Usenet
12809
12810 It's, like, too neat to search the Usenet for articles that match a
12811 string, but it, like, totally @emph{sucks}, like, totally, to use one of
12812 those, like, Web browsers, and you, like, have to, rilly, like, look at
12813 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
12814 searches without having to use a browser.
12815
12816 The @code{nnweb} backend allows an easy interface to the mighty search
12817 engine.  You create an @code{nnweb} group, enter a search pattern, and
12818 then enter the group and read the articles like you would any normal
12819 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
12820 Groups}) will do this in an easy-to-use fashion.
12821
12822 @code{nnweb} groups don't really lend themselves to being solid
12823 groups---they have a very fleeting idea of article numbers.  In fact,
12824 each time you enter an @code{nnweb} group (not even changing the search
12825 pattern), you are likely to get the articles ordered in a different
12826 manner.  Not even using duplicate suppression (@pxref{Duplicate
12827 Suppression}) will help, since @code{nnweb} doesn't even know the
12828 @code{Message-ID} of the articles before reading them using some search
12829 engines (DejaNews, for instance).  The only possible way to keep track
12830 of which articles you've read is by scoring on the @code{Date}
12831 header---mark all articles posted before the last date you read the
12832 group as read.
12833
12834 If the search engine changes its output substantially, @code{nnweb}
12835 won't be able to parse it and will fail.  One could hardly fault the Web
12836 providers if they were to do this---their @emph{raison d'être} is to
12837 make money off of advertisements, not to provide services to the
12838 community.  Since @code{nnweb} washes the ads off all the articles, one
12839 might think that the providers might be somewhat miffed.  We'll see.
12840
12841 You must have the @code{url} and @code{w3} package installed to be able
12842 to use @code{nnweb}.
12843
12844 Virtual server variables:
12845
12846 @table @code
12847 @item nnweb-type
12848 @vindex nnweb-type
12849 What search engine type is being used.  The currently supported types
12850 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
12851 @code{reference}.
12852
12853 @item nnweb-search
12854 @vindex nnweb-search
12855 The search string to feed to the search engine.
12856
12857 @item nnweb-max-hits
12858 @vindex nnweb-max-hits
12859 Advisory maximum number of hits per search to display.  The default is
12860 100.
12861
12862 @item nnweb-type-definition
12863 @vindex nnweb-type-definition
12864 Type-to-definition alist.  This alist says what @code{nnweb} should do
12865 with the various search engine types.  The following elements must be
12866 present:
12867
12868 @table @code
12869 @item article
12870 Function to decode the article and provide something that Gnus
12871 understands.
12872
12873 @item map
12874 Function to create an article number to message header and URL alist.
12875
12876 @item search
12877 Function to send the search string to the search engine.
12878
12879 @item address
12880 The address the aforementioned function should send the search string
12881 to.
12882
12883 @item id
12884 Format string URL to fetch an article by @code{Message-ID}.
12885 @end table
12886
12887 @end table
12888
12889
12890 @node Slashdot
12891 @subsection Slashdot
12892 @cindex Slashdot
12893 @cindex nnslashdot
12894
12895 Slashdot (@file{http://slashdot.org/}) is a popular news site, with
12896 lively discussion following the news articles.  @code{nnslashdot} will
12897 let you read this forum in a convenient manner.
12898
12899 The easiest way to read this source is to put something like the
12900 following in your @file{.gnus.el} file:
12901
12902 @lisp
12903 (setq gnus-secondary-select-methods
12904       '((nnslashdot "")))
12905 @end lisp
12906
12907 This will make Gnus query the @code{nnslashdot} backend for new comments
12908 and groups.  The @kbd{F} command will subscribe each new news article as
12909 a new Gnus group, and you can read the comments by entering these
12910 groups.  (Note that the default subscription method is to subscribe new
12911 groups as zombies.  Other methods are available (@pxref{Subscription
12912 Methods}).
12913
12914 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
12915 command is the most handy tool (@pxref{Foreign Groups}).
12916
12917 When following up to @code{nnslashdot} comments (or posting new
12918 comments), some light @sc{html}izations will be performed.  In
12919 particular, text quoted with @samp{> } will be quoted with
12920 @code{blockquote} instead, and signatures will have @code{br} added to
12921 the end of each line.  Other than that, you can just write @sc{html}
12922 directly into the message buffer.  Note that Slashdot filters out some
12923 @sc{html} forms.
12924
12925 The following variables can be altered to change its behavior:
12926
12927 @table @code
12928 @item nnslashdot-threaded
12929 Whether @code{nnslashdot} should display threaded groups or not.  The
12930 default is @code{t}.  To be able to display threads, @code{nnslashdot}
12931 has to retrieve absolutely all comments in a group upon entry.  If a
12932 threaded display is not required, @code{nnslashdot} will only retrieve
12933 the comments that are actually wanted by the user.  Threading is nicer,
12934 but much, much slower than untreaded.
12935
12936 @item nnslashdot-login-name
12937 @vindex nnslashdot-login-name
12938 The login name to use when posting.
12939
12940 @item nnslashdot-password
12941 @vindex nnslashdot-password
12942 The password to use when posting.
12943
12944 @item nnslashdot-directory
12945 @vindex nnslashdot-directory
12946 Where @code{nnslashdot} will store its files.  The default value is
12947 @samp{~/News/slashdot/}.
12948
12949 @item nnslashdot-active-url
12950 @vindex nnslashdot-active-url
12951 The @sc{url} format string that will be used to fetch the information on 
12952 news articles and comments.  The default is
12953 @samp{http://slashdot.org/search.pl?section=&min=%d}.
12954
12955 @item nnslashdot-comments-url
12956 @vindex nnslashdot-comments-url
12957 The @sc{url} format string that will be used to fetch comments.  The
12958 default is
12959 @samp{http://slashdot.org/comments.pl?sid=%s&threshold=%d&commentsort=%d&mode=flat&startat=%d}.
12960
12961 @item nnslashdot-article-url
12962 @vindex nnslashdot-article-url
12963 The @sc{url} format string that will be used to fetch the news article.  The
12964 default is
12965 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
12966
12967 @item nnslashdot-threshold
12968 @vindex nnslashdot-threshold
12969 The score threshold.  The default is -1.
12970
12971 @item nnslashdot-group-number
12972 @vindex nnslashdot-group-number
12973 The number of old groups, in addition to the ten latest, to keep
12974 updated.  The default is 0.
12975
12976 @end table
12977
12978
12979
12980 @node Ultimate
12981 @subsection Ultimate
12982 @cindex nnultimate
12983 @cindex Ultimate Bulletin Board
12984
12985 The Ultimate Bulletin Board (@file{http://www.ultimatebb.com/}) is
12986 probably the most popular Web bulletin board system used.  It has a
12987 quite regular and nice interface, and it's possible to get the
12988 information Gnus needs to keep groups updated.
12989
12990 The easiest way to get started with @code{nnultimate} is to say
12991 something like the following in the group buffer:  @kbd{B nnultimate RET 
12992 http://www.tcj.com/messboard/ubbcgi/ RET}.  (Substitute the @sc{url}
12993 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
12994 you're interested in; there's quite a list of them on the Ultimate web
12995 site.)  Then subscribe to the groups you're interested in from the
12996 server buffer, and read them from the group buffer.
12997
12998 The following @code{nnultimate} variables can be altered:
12999
13000 @table @code
13001 @item nnultimate-directory
13002 @vindex nnultimate-directory
13003 The directory where @code{nnultimate} stores its files.  The default is
13004 @samp{~/News/ultimate/}.
13005 @end table
13006
13007
13008 @node Web Archive
13009 @subsection Web Archive
13010 @cindex nnwarchive
13011 @cindex Web Archive
13012
13013 Some mailing lists only have archives on Web servers, such as
13014 @file{http://www.egroups.com/} and
13015 @file{http://www.mail-archive.com/}.  It has a quite regular and nice
13016 interface, and it's possible to get the information Gnus needs to keep
13017 groups updated.
13018
13019 The easiest way to get started with @code{nnwarchive} is to say
13020 something like the following in the group buffer: @kbd{M-x
13021 gnus-group-make-warchive-group RET an_egroup RET egroups RET
13022 www.egroups.com RET your@@email.address RET}.  (Substitute the
13023 @sc{an_egroup} with the mailing list you subscribed, the
13024 @sc{your@@email.address} with your email address.), or to browse the
13025 backend by @kbd{B nnwarchive RET mail-archive RET}.
13026
13027 The following @code{nnwarchive} variables can be altered:
13028
13029 @table @code
13030 @item nnwarchive-directory
13031 @vindex nnwarchive-directory
13032 The directory where @code{nnwarchive} stores its files.  The default is
13033 @samp{~/News/warchive/}.
13034
13035 @item nnwarchive-login
13036 @vindex nnwarchive-login
13037 The account name on the web server.
13038
13039 @item nnwarchive-passwd
13040 @vindex nnwarchive-passwd
13041 The password for your account on the web server.
13042 @end table
13043
13044
13045 @node Customizing w3
13046 @subsection Customizing w3
13047 @cindex w3
13048 @cindex html
13049 @cindex url
13050 @cindex Netscape
13051
13052 Gnus uses the url library to fetch web pages and Emacs/w3 to display web 
13053 pages.  Emacs/w3 is documented in its own manual, but there are some
13054 things that may be more relevant for Gnus users.
13055
13056 For instance, a common question is how to make Emacs/w3 follow links
13057 using the @code{browse-url} functions (which will call some external web 
13058 browser like Netscape).  Here's one way:
13059
13060 @lisp
13061 (eval-after-load "w3"
13062   '(progn
13063     (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
13064     (defun w3-fetch (&optional url target)
13065       (interactive (list (w3-read-url-with-default)))
13066       (if (eq major-mode 'gnus-article-mode)
13067           (browse-url url)
13068         (w3-fetch-orig url target)))))
13069 @end lisp
13070
13071 Put that in your @file{.emacs} file, and hitting links in w3-rendered
13072 @sc{html} in the Gnus article buffers will use @code{browse-url} to
13073 follow the link.
13074
13075
13076 @node Other Sources
13077 @section Other Sources
13078
13079 Gnus can do more than just read news or mail.  The methods described
13080 below allow Gnus to view directories and files as if they were
13081 newsgroups.
13082
13083 @menu
13084 * Directory Groups::      You can read a directory as if it was a newsgroup.
13085 * Anything Groups::       Dired?  Who needs dired?
13086 * Document Groups::       Single files can be the basis of a group.
13087 * SOUP::                  Reading @sc{soup} packets ``offline''.
13088 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
13089 * IMAP::                  Using Gnus as a @sc{imap} client.
13090 @end menu
13091
13092
13093 @node Directory Groups
13094 @subsection Directory Groups
13095 @cindex nndir
13096 @cindex directory groups
13097
13098 If you have a directory that has lots of articles in separate files in
13099 it, you might treat it as a newsgroup.  The files have to have numerical
13100 names, of course.
13101
13102 This might be an opportune moment to mention @code{ange-ftp} (and its
13103 successor @code{efs}), that most wonderful of all wonderful Emacs
13104 packages.  When I wrote @code{nndir}, I didn't think much about it---a
13105 backend to read directories.  Big deal.
13106
13107 @code{ange-ftp} changes that picture dramatically.  For instance, if you
13108 enter the @code{ange-ftp} file name
13109 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
13110 @code{ange-ftp} or @code{efs} will actually allow you to read this
13111 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
13112
13113 @code{nndir} will use @sc{nov} files if they are present.
13114
13115 @code{nndir} is a ``read-only'' backend---you can't delete or expire
13116 articles with this method.  You can use @code{nnmh} or @code{nnml} for
13117 whatever you use @code{nndir} for, so you could switch to any of those
13118 methods if you feel the need to have a non-read-only @code{nndir}.
13119
13120
13121 @node Anything Groups
13122 @subsection Anything Groups
13123 @cindex nneething
13124
13125 From the @code{nndir} backend (which reads a single spool-like
13126 directory), it's just a hop and a skip to @code{nneething}, which
13127 pretends that any arbitrary directory is a newsgroup.  Strange, but
13128 true.
13129
13130 When @code{nneething} is presented with a directory, it will scan this
13131 directory and assign article numbers to each file.  When you enter such
13132 a group, @code{nneething} must create ``headers'' that Gnus can use.
13133 After all, Gnus is a newsreader, in case you're forgetting.
13134 @code{nneething} does this in a two-step process.  First, it snoops each
13135 file in question.  If the file looks like an article (i.e., the first
13136 few lines look like headers), it will use this as the head.  If this is
13137 just some arbitrary file without a head (e.g. a C source file),
13138 @code{nneething} will cobble up a header out of thin air.  It will use
13139 file ownership, name and date and do whatever it can with these
13140 elements.
13141
13142 All this should happen automatically for you, and you will be presented
13143 with something that looks very much like a newsgroup.  Totally like a
13144 newsgroup, to be precise.  If you select an article, it will be displayed
13145 in the article buffer, just as usual.
13146
13147 If you select a line that represents a directory, Gnus will pop you into
13148 a new summary buffer for this @code{nneething} group.  And so on.  You can
13149 traverse the entire disk this way, if you feel like, but remember that
13150 Gnus is not dired, really, and does not intend to be, either.
13151
13152 There are two overall modes to this action---ephemeral or solid.  When
13153 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
13154 will not store information on what files you have read, and what files
13155 are new, and so on.  If you create a solid @code{nneething} group the
13156 normal way with @kbd{G m}, Gnus will store a mapping table between
13157 article numbers and file names, and you can treat this group like any
13158 other groups.  When you activate a solid @code{nneething} group, you will
13159 be told how many unread articles it contains, etc., etc.
13160
13161 Some variables:
13162
13163 @table @code
13164 @item nneething-map-file-directory
13165 @vindex nneething-map-file-directory
13166 All the mapping files for solid @code{nneething} groups will be stored
13167 in this directory, which defaults to @file{~/.nneething/}.
13168
13169 @item nneething-exclude-files
13170 @vindex nneething-exclude-files
13171 All files that match this regexp will be ignored.  Nice to use to exclude
13172 auto-save files and the like, which is what it does by default.
13173
13174 @item nneething-include-files
13175 @vindex nneething-include-files
13176 Regexp saying what files to include in the group.  If this variable is
13177 non-@code{nil}, only files matching this regexp will be included.
13178
13179 @item nneething-map-file
13180 @vindex nneething-map-file
13181 Name of the map files.
13182 @end table
13183
13184
13185 @node Document Groups
13186 @subsection Document Groups
13187 @cindex nndoc
13188 @cindex documentation group
13189 @cindex help group
13190
13191 @code{nndoc} is a cute little thing that will let you read a single file
13192 as a newsgroup.  Several files types are supported:
13193
13194 @table @code
13195 @cindex babyl
13196 @cindex rmail mbox
13197
13198 @item babyl
13199 The babyl (rmail) mail box.
13200 @cindex mbox
13201 @cindex Unix mbox
13202
13203 @item mbox
13204 The standard Unix mbox file.
13205
13206 @cindex MMDF mail box
13207 @item mmdf
13208 The MMDF mail box format.
13209
13210 @item news
13211 Several news articles appended into a file.
13212
13213 @item rnews
13214 @cindex rnews batch files
13215 The rnews batch transport format.
13216 @cindex forwarded messages
13217
13218 @item forward
13219 Forwarded articles.
13220
13221 @item nsmail
13222 Netscape mail boxes.
13223
13224 @item mime-parts
13225 MIME multipart messages.
13226
13227 @item standard-digest
13228 The standard (RFC 1153) digest format.
13229
13230 @item slack-digest
13231 Non-standard digest format---matches most things, but does it badly.
13232 @end table
13233
13234 You can also use the special ``file type'' @code{guess}, which means
13235 that @code{nndoc} will try to guess what file type it is looking at.
13236 @code{digest} means that @code{nndoc} should guess what digest type the
13237 file is.
13238
13239 @code{nndoc} will not try to change the file or insert any extra headers into
13240 it---it will simply, like, let you use the file as the basis for a
13241 group.  And that's it.
13242
13243 If you have some old archived articles that you want to insert into your
13244 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
13245 that.  Say you have an old @file{RMAIL} file with mail that you now want
13246 to split into your new @code{nnml} groups.  You look at that file using
13247 @code{nndoc} (using the @kbd{G f} command in the group buffer
13248 (@pxref{Foreign Groups})), set the process mark on all the articles in
13249 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
13250 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
13251 file is now also stored in lots of @code{nnml} directories, and you can
13252 delete that pesky @file{RMAIL} file.  If you have the guts!
13253
13254 Virtual server variables:
13255
13256 @table @code
13257 @item nndoc-article-type
13258 @vindex nndoc-article-type
13259 This should be one of @code{mbox}, @code{babyl}, @code{digest},
13260 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
13261 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
13262 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
13263
13264 @item nndoc-post-type
13265 @vindex nndoc-post-type
13266 This variable says whether Gnus is to consider the group a news group or
13267 a mail group.  There are two valid values:  @code{mail} (the default)
13268 and @code{news}.
13269 @end table
13270
13271 @menu
13272 * Document Server Internals::   How to add your own document types.
13273 @end menu
13274
13275
13276 @node Document Server Internals
13277 @subsubsection Document Server Internals
13278
13279 Adding new document types to be recognized by @code{nndoc} isn't
13280 difficult.  You just have to whip up a definition of what the document
13281 looks like, write a predicate function to recognize that document type,
13282 and then hook into @code{nndoc}.
13283
13284 First, here's an example document type definition:
13285
13286 @example
13287 (mmdf
13288  (article-begin .  "^\^A\^A\^A\^A\n")
13289  (body-end .  "^\^A\^A\^A\^A\n"))
13290 @end example
13291
13292 The definition is simply a unique @dfn{name} followed by a series of
13293 regexp pseudo-variable settings.  Below are the possible
13294 variables---don't be daunted by the number of variables; most document
13295 types can be defined with very few settings:
13296
13297 @table @code
13298 @item first-article
13299 If present, @code{nndoc} will skip past all text until it finds
13300 something that match this regexp.  All text before this will be
13301 totally ignored.
13302
13303 @item article-begin
13304 This setting has to be present in all document type definitions.  It
13305 says what the beginning of each article looks like.
13306
13307 @item head-begin-function
13308 If present, this should be a function that moves point to the head of
13309 the article.
13310
13311 @item nndoc-head-begin
13312 If present, this should be a regexp that matches the head of the
13313 article.
13314
13315 @item nndoc-head-end
13316 This should match the end of the head of the article.  It defaults to
13317 @samp{^$}---the empty line.
13318
13319 @item body-begin-function
13320 If present, this function should move point to the beginning of the body
13321 of the article.
13322
13323 @item body-begin
13324 This should match the beginning of the body of the article.  It defaults
13325 to @samp{^\n}.
13326
13327 @item body-end-function
13328 If present, this function should move point to the end of the body of
13329 the article.
13330
13331 @item body-end
13332 If present, this should match the end of the body of the article.
13333
13334 @item file-end
13335 If present, this should match the end of the file.  All text after this
13336 regexp will be totally ignored.
13337
13338 @end table
13339
13340 So, using these variables @code{nndoc} is able to dissect a document
13341 file into a series of articles, each with a head and a body.  However, a
13342 few more variables are needed since not all document types are all that
13343 news-like---variables needed to transform the head or the body into
13344 something that's palatable for Gnus:
13345
13346 @table @code
13347 @item prepare-body-function
13348 If present, this function will be called when requesting an article.  It
13349 will be called with point at the start of the body, and is useful if the
13350 document has encoded some parts of its contents.
13351
13352 @item article-transform-function
13353 If present, this function is called when requesting an article.  It's
13354 meant to be used for more wide-ranging transformation of both head and
13355 body of the article.
13356
13357 @item generate-head-function
13358 If present, this function is called to generate a head that Gnus can
13359 understand.  It is called with the article number as a parameter, and is
13360 expected to generate a nice head for the article in question.  It is
13361 called when requesting the headers of all articles.
13362
13363 @end table
13364
13365 Let's look at the most complicated example I can come up with---standard
13366 digests:
13367
13368 @example
13369 (standard-digest
13370  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
13371  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
13372  (prepare-body-function . nndoc-unquote-dashes)
13373  (body-end-function . nndoc-digest-body-end)
13374  (head-end . "^ ?$")
13375  (body-begin . "^ ?\n")
13376  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
13377  (subtype digest guess))
13378 @end example
13379
13380 We see that all text before a 70-width line of dashes is ignored; all
13381 text after a line that starts with that @samp{^End of} is also ignored;
13382 each article begins with a 30-width line of dashes; the line separating
13383 the head from the body may contain a single space; and that the body is
13384 run through @code{nndoc-unquote-dashes} before being delivered.
13385
13386 To hook your own document definition into @code{nndoc}, use the
13387 @code{nndoc-add-type} function.  It takes two parameters---the first is
13388 the definition itself and the second (optional) parameter says where in
13389 the document type definition alist to put this definition.  The alist is
13390 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
13391 is of @code{mmdf} type, and so on.  These type predicates should return
13392 @code{nil} if the document is not of the correct type; @code{t} if it is
13393 of the correct type; and a number if the document might be of the
13394 correct type.  A high number means high probability; a low number means
13395 low probability with @samp{0} being the lowest valid number.
13396
13397
13398 @node SOUP
13399 @subsection SOUP
13400 @cindex SOUP
13401 @cindex offline
13402
13403 In the PC world people often talk about ``offline'' newsreaders.  These
13404 are thingies that are combined reader/news transport monstrosities.
13405 With built-in modem programs.  Yecchh!
13406
13407 Of course, us Unix Weenie types of human beans use things like
13408 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
13409 transport things like Ghod intended.  And then we just use normal
13410 newsreaders.
13411
13412 However, it can sometimes be convenient to do something that's a bit
13413 easier on the brain if you have a very slow modem, and you're not really
13414 that interested in doing things properly.
13415
13416 A file format called @sc{soup} has been developed for transporting news
13417 and mail from servers to home machines and back again.  It can be a bit
13418 fiddly.
13419
13420 First some terminology:
13421
13422 @table @dfn
13423
13424 @item server
13425 This is the machine that is connected to the outside world and where you
13426 get news and/or mail from.
13427
13428 @item home machine
13429 This is the machine that you want to do the actual reading and responding
13430 on.  It is typically not connected to the rest of the world in any way.
13431
13432 @item packet
13433 Something that contains messages and/or commands.  There are two kinds
13434 of packets:
13435
13436 @table @dfn
13437 @item message packets
13438 These are packets made at the server, and typically contain lots of
13439 messages for you to read.  These are called @file{SoupoutX.tgz} by
13440 default, where @var{x} is a number.
13441
13442 @item response packets
13443 These are packets made at the home machine, and typically contains
13444 replies that you've written.  These are called @file{SoupinX.tgz} by
13445 default, where @var{x} is a number.
13446
13447 @end table
13448
13449 @end table
13450
13451
13452 @enumerate
13453
13454 @item
13455 You log in on the server and create a @sc{soup} packet.  You can either
13456 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
13457 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
13458 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
13459
13460 @item
13461 You transfer the packet home.  Rail, boat, car or modem will do fine.
13462
13463 @item
13464 You put the packet in your home directory.
13465
13466 @item
13467 You fire up Gnus on your home machine using the @code{nnsoup} backend as
13468 the native or secondary server.
13469
13470 @item
13471 You read articles and mail and answer and followup to the things you
13472 want (@pxref{SOUP Replies}).
13473
13474 @item
13475 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
13476 packet.
13477
13478 @item
13479 You transfer this packet to the server.
13480
13481 @item
13482 You use Gnus to mail this packet out with the @kbd{G s s} command.
13483
13484 @item
13485 You then repeat until you die.
13486
13487 @end enumerate
13488
13489 So you basically have a bipartite system---you use @code{nnsoup} for
13490 reading and Gnus for packing/sending these @sc{soup} packets.
13491
13492 @menu
13493 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
13494 * SOUP Groups::       A backend for reading @sc{soup} packets.
13495 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
13496 @end menu
13497
13498
13499 @node SOUP Commands
13500 @subsubsection SOUP Commands
13501
13502 These are commands for creating and manipulating @sc{soup} packets.
13503
13504 @table @kbd
13505 @item G s b
13506 @kindex G s b (Group)
13507 @findex gnus-group-brew-soup
13508 Pack all unread articles in the current group
13509 (@code{gnus-group-brew-soup}).  This command understands the
13510 process/prefix convention.
13511
13512 @item G s w
13513 @kindex G s w (Group)
13514 @findex gnus-soup-save-areas
13515 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
13516
13517 @item G s s
13518 @kindex G s s (Group)
13519 @findex gnus-soup-send-replies
13520 Send all replies from the replies packet
13521 (@code{gnus-soup-send-replies}).
13522
13523 @item G s p
13524 @kindex G s p (Group)
13525 @findex gnus-soup-pack-packet
13526 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
13527
13528 @item G s r
13529 @kindex G s r (Group)
13530 @findex nnsoup-pack-replies
13531 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
13532
13533 @item O s
13534 @kindex O s (Summary)
13535 @findex gnus-soup-add-article
13536 This summary-mode command adds the current article to a @sc{soup} packet
13537 (@code{gnus-soup-add-article}).  It understands the process/prefix
13538 convention (@pxref{Process/Prefix}).
13539
13540 @end table
13541
13542
13543 There are a few variables to customize where Gnus will put all these
13544 thingies:
13545
13546 @table @code
13547
13548 @item gnus-soup-directory
13549 @vindex gnus-soup-directory
13550 Directory where Gnus will save intermediate files while composing
13551 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
13552
13553 @item gnus-soup-replies-directory
13554 @vindex gnus-soup-replies-directory
13555 This is what Gnus will use as a temporary directory while sending our
13556 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
13557
13558 @item gnus-soup-prefix-file
13559 @vindex gnus-soup-prefix-file
13560 Name of the file where Gnus stores the last used prefix.  The default is
13561 @samp{gnus-prefix}.
13562
13563 @item gnus-soup-packer
13564 @vindex gnus-soup-packer
13565 A format string command for packing a @sc{soup} packet.  The default is
13566 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
13567
13568 @item gnus-soup-unpacker
13569 @vindex gnus-soup-unpacker
13570 Format string command for unpacking a @sc{soup} packet.  The default is
13571 @samp{gunzip -c %s | tar xvf -}.
13572
13573 @item gnus-soup-packet-directory
13574 @vindex gnus-soup-packet-directory
13575 Where Gnus will look for reply packets.  The default is @file{~/}.
13576
13577 @item gnus-soup-packet-regexp
13578 @vindex gnus-soup-packet-regexp
13579 Regular expression matching @sc{soup} reply packets in
13580 @code{gnus-soup-packet-directory}.
13581
13582 @end table
13583
13584
13585 @node SOUP Groups
13586 @subsubsection @sc{soup} Groups
13587 @cindex nnsoup
13588
13589 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
13590 read incoming packets, unpack them, and put them in a directory where
13591 you can read them at leisure.
13592
13593 These are the variables you can use to customize its behavior:
13594
13595 @table @code
13596
13597 @item nnsoup-tmp-directory
13598 @vindex nnsoup-tmp-directory
13599 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
13600 directory.  (@file{/tmp/} by default.)
13601
13602 @item nnsoup-directory
13603 @vindex nnsoup-directory
13604 @code{nnsoup} then moves each message and index file to this directory.
13605 The default is @file{~/SOUP/}.
13606
13607 @item nnsoup-replies-directory
13608 @vindex nnsoup-replies-directory
13609 All replies will be stored in this directory before being packed into a
13610 reply packet.  The default is @file{~/SOUP/replies/"}.
13611
13612 @item nnsoup-replies-format-type
13613 @vindex nnsoup-replies-format-type
13614 The @sc{soup} format of the replies packets.  The default is @samp{?n}
13615 (rnews), and I don't think you should touch that variable.  I probably
13616 shouldn't even have documented it.  Drats!  Too late!
13617
13618 @item nnsoup-replies-index-type
13619 @vindex nnsoup-replies-index-type
13620 The index type of the replies packet.  The default is @samp{?n}, which
13621 means ``none''.  Don't fiddle with this one either!
13622
13623 @item nnsoup-active-file
13624 @vindex nnsoup-active-file
13625 Where @code{nnsoup} stores lots of information.  This is not an ``active
13626 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
13627 this file or mess it up in any way, you're dead.  The default is
13628 @file{~/SOUP/active}.
13629
13630 @item nnsoup-packer
13631 @vindex nnsoup-packer
13632 Format string command for packing a reply @sc{soup} packet.  The default
13633 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
13634
13635 @item nnsoup-unpacker
13636 @vindex nnsoup-unpacker
13637 Format string command for unpacking incoming @sc{soup} packets.  The
13638 default is @samp{gunzip -c %s | tar xvf -}.
13639
13640 @item nnsoup-packet-directory
13641 @vindex nnsoup-packet-directory
13642 Where @code{nnsoup} will look for incoming packets.  The default is
13643 @file{~/}.
13644
13645 @item nnsoup-packet-regexp
13646 @vindex nnsoup-packet-regexp
13647 Regular expression matching incoming @sc{soup} packets.  The default is
13648 @samp{Soupout}.
13649
13650 @item nnsoup-always-save
13651 @vindex nnsoup-always-save
13652 If non-@code{nil}, save the replies buffer after each posted message.
13653
13654 @end table
13655
13656
13657 @node SOUP Replies
13658 @subsubsection SOUP Replies
13659
13660 Just using @code{nnsoup} won't mean that your postings and mailings end
13661 up in @sc{soup} reply packets automagically.  You have to work a bit
13662 more for that to happen.
13663
13664 @findex nnsoup-set-variables
13665 The @code{nnsoup-set-variables} command will set the appropriate
13666 variables to ensure that all your followups and replies end up in the
13667 @sc{soup} system.
13668
13669 In specific, this is what it does:
13670
13671 @lisp
13672 (setq message-send-news-function 'nnsoup-request-post)
13673 (setq message-send-mail-function 'nnsoup-request-mail)
13674 @end lisp
13675
13676 And that's it, really.  If you only want news to go into the @sc{soup}
13677 system you just use the first line.  If you only want mail to be
13678 @sc{soup}ed you use the second.
13679
13680
13681 @node Mail-To-News Gateways
13682 @subsection Mail-To-News Gateways
13683 @cindex mail-to-news gateways
13684 @cindex gateways
13685
13686 If your local @code{nntp} server doesn't allow posting, for some reason
13687 or other, you can post using one of the numerous mail-to-news gateways.
13688 The @code{nngateway} backend provides the interface.
13689
13690 Note that you can't read anything from this backend---it can only be
13691 used to post with.
13692
13693 Server variables:
13694
13695 @table @code
13696 @item nngateway-address
13697 @vindex nngateway-address
13698 This is the address of the mail-to-news gateway.
13699
13700 @item nngateway-header-transformation
13701 @vindex nngateway-header-transformation
13702 News headers often have to be transformed in some odd way or other
13703 for the mail-to-news gateway to accept it.  This variable says what
13704 transformation should be called, and defaults to
13705 @code{nngateway-simple-header-transformation}.  The function is called
13706 narrowed to the headers to be transformed and with one parameter---the
13707 gateway address.
13708
13709 This default function just inserts a new @code{To} header based on the
13710 @code{Newsgroups} header and the gateway address.
13711 For instance, an article with this @code{Newsgroups} header:
13712
13713 @example
13714 Newsgroups: alt.religion.emacs
13715 @end example
13716
13717 will get this @code{From} header inserted:
13718
13719 @example
13720 To: alt-religion-emacs@@GATEWAY
13721 @end example
13722
13723 The following pre-defined functions exist:
13724
13725 @findex nngateway-simple-header-transformation
13726 @table @code
13727
13728 @item nngateway-simple-header-transformation
13729 Creates a @code{To} header that looks like
13730 @var{newsgroup}@@@code{nngateway-address}.
13731
13732 @findex nngateway-mail2news-header-transformation
13733
13734 @item nngateway-mail2news-header-transformation
13735 Creates a @code{To} header that looks like
13736 @code{nngateway-address}.
13737
13738 Here's an example:
13739
13740 @lisp
13741 (setq gnus-post-method
13742       '(nngateway "mail2news@@replay.com"
13743                   (nngateway-header-transformation
13744                    nngateway-mail2news-header-transformation)))
13745 @end lisp
13746
13747 @end table
13748
13749
13750 @end table
13751
13752 So, to use this, simply say something like:
13753
13754 @lisp
13755 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
13756 @end lisp
13757
13758
13759
13760 @node IMAP
13761 @subsection @sc{imap}
13762 @cindex nnimap
13763 @cindex @sc{imap}
13764
13765 @sc{imap} is a network protocol for reading mail (or news, or ...),
13766 think of it as a modernized @sc{nntp}.  Connecting to a @sc{imap} server
13767 is much similar to connecting to a news server, you just specify the
13768 network address of the server.
13769
13770 A server configuration in @code{~/.gnus} with a few @sc{imap} servers
13771 might look something like this:
13772
13773 @lisp
13774 (setq gnus-secondary-select-methods 
13775       '((nnimap "simpleserver") ; no special configuration
13776         ; perhaps a ssh port forwarded server:
13777         (nnimap "dolk"
13778                 (nnimap-address "localhost")
13779                 (nnimap-server-port 1430))
13780         ; a UW server running on localhost
13781         (nnimap "barbar"
13782                 (nnimap-server-port 143)
13783                 (nnimap-address "localhost")
13784                 (nnimap-list-pattern ("INBOX" "mail/*")))
13785         ; anonymous public cyrus server:
13786         (nnimap "cyrus.andrew.cmu.edu"
13787                 (nnimap-authenticator anonymous)
13788                 (nnimap-list-pattern "archive.*")
13789                 (nnimap-stream network))
13790         ; a ssl server on a non-standard port:
13791         (nnimap "vic20"
13792                 (nnimap-address "vic20.somewhere.com")
13793                 (nnimap-server-port 9930)
13794                 (nnimap-stream ssl))))
13795 @end lisp
13796
13797 The following variables can be used to create a virtual @code{nnimap}
13798 server:
13799
13800 @table @code
13801
13802 @item nnimap-address
13803 @vindex nnimap-address
13804
13805 The address of the remote @sc{imap} server.  Defaults to the virtual
13806 server name if not specified.
13807
13808 @item nnimap-server-port
13809 @vindex nnimap-server-port
13810 Port on server to contact.  Defaults to port 143, or 993 for SSL.
13811
13812 Note that this should be a integer, example server specification:
13813
13814 @lisp
13815 (nnimap "mail.server.com"
13816         (nnimap-server-port 4711))
13817 @end lisp
13818
13819 @item nnimap-list-pattern
13820 @vindex nnimap-list-pattern
13821 String or list of strings of mailboxes to limit available groups to.
13822 This is used when the server has very many mailboxes and you're only
13823 interested in a few -- some servers export your home directory via
13824 @sc{imap}, you'll probably want to limit the mailboxes to those in
13825 @file{~/Mail/*} then.
13826
13827 The string can also be a cons of REFERENCE and the string as above, what
13828 REFERENCE is used for is server specific, but on the University of
13829 Washington server it's a directory that will be concatenated with the
13830 mailbox.
13831
13832 Example server specification:
13833
13834 @lisp
13835 (nnimap "mail.server.com"
13836         (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*" 
13837                                ("~friend/Mail/" . "list/*"))))
13838 @end lisp
13839
13840 @item nnimap-stream
13841 @vindex nnimap-stream
13842 The type of stream used to connect to your server.  By default, nnimap
13843 will detect and automatically use all of the below, with the exception
13844 of SSL. (SSL is being replaced by STARTTLS, which can be automatically
13845 detected, but it's not widely deployed yet).
13846
13847 Example server specification:
13848
13849 @lisp
13850 (nnimap "mail.server.com"
13851         (nnimap-stream ssl))
13852 @end lisp
13853
13854 Please note that the value of @code{nnimap-stream} is a symbol!
13855
13856 @itemize @bullet
13857 @item
13858 @dfn{gssapi:} Connect with GSSAPI (usually kerberos 5). Require the
13859 @samp{imtest} program.
13860 @item
13861 @dfn{kerberos4:} Connect with kerberos 4. Require the @samp{imtest} program.
13862 @item
13863 @dfn{starttls:} Connect via the STARTTLS extension (similar to
13864 SSL). Require the external library @samp{starttls.el} and program
13865 @samp{starttls}.
13866 @item
13867 @dfn{ssl:} Connect through SSL. Require OpenSSL (the
13868 program @samp{openssl}) or SSLeay (@samp{s_client}).
13869 @item
13870 @dfn{shell:} Use a shell command to start IMAP connection.
13871 @item
13872 @dfn{network:} Plain, TCP/IP network connection.
13873 @end itemize
13874
13875 @vindex imap-kerberos4-program
13876 The @samp{imtest} program is shipped with Cyrus IMAPD, nnimap support
13877 both @samp{imtest} version 1.5.x and version 1.6.x.  The variable
13878 @code{imap-kerberos4-program} contain parameters to pass to the imtest
13879 program. 
13880
13881 @vindex imap-ssl-program
13882 For SSL connections, the OpenSSL program is available from
13883 @file{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
13884 and nnimap support it too - although the most recent versions of
13885 SSLeay, 0.9.x, are known to have serious bugs making it
13886 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
13887 work. The variable @code{imap-ssl-program} contain parameters to pass
13888 to OpenSSL/SSLeay.
13889
13890 @vindex imap-shell-program
13891 @vindex imap-shell-host
13892 For IMAP connections using the @code{shell} stream, the variable
13893 @code{imap-shell-program} specify what program to call.
13894
13895 @item nnimap-authenticator
13896 @vindex nnimap-authenticator
13897
13898 The authenticator used to connect to the server.  By default, nnimap
13899 will use the most secure authenticator your server is capable of.
13900
13901 Example server specification:
13902
13903 @lisp
13904 (nnimap "mail.server.com"
13905         (nnimap-authenticator anonymous))
13906 @end lisp
13907
13908 Please note that the value of @code{nnimap-authenticator} is a symbol!
13909
13910 @itemize @bullet
13911 @item
13912 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Require
13913 external program @code{imtest}.
13914 @item
13915 @dfn{kerberos4:} Kerberos authentication. Require external program
13916 @code{imtest}.
13917 @item
13918 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Require
13919 external library @code{digest-md5.el}.
13920 @item
13921 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
13922 @item
13923 @dfn{login:} Plain-text username/password via LOGIN.
13924 @item
13925 @dfn{anonymous:} Login as `anonymous', supplying your emailadress as password.
13926 @end itemize
13927
13928 @item nnimap-expunge-on-close
13929 @cindex Expunging
13930 @vindex nnimap-expunge-on-close
13931 Unlike Parmenides the @sc{imap} designers has decided that things that
13932 doesn't exist actually does exist.  More specifically, @sc{imap} has
13933 this concept of marking articles @code{Deleted} which doesn't actually
13934 delete them, and this (marking them @code{Deleted}, that is) is what
13935 nnimap does when you delete a article in Gnus (with @kbd{G DEL} or
13936 similair).
13937
13938 Since the articles aren't really removed when we mark them with the
13939 @code{Deleted} flag we'll need a way to actually delete them.  Feel like
13940 running in circles yet?
13941
13942 Traditionally, nnimap has removed all articles marked as @code{Deleted}
13943 when closing a mailbox but this is now configurable by this server
13944 variable.
13945
13946 The possible options are:
13947
13948 @table @code
13949
13950 @item always
13951 The default behaviour, delete all articles marked as "Deleted" when
13952 closing a mailbox.
13953 @item never
13954 Never actually delete articles.  Currently there is no way of showing
13955 the articles marked for deletion in nnimap, but other @sc{imap} clients
13956 may allow you to do this.  If you ever want to run the EXPUNGE command
13957 manually, @xref{Expunging mailboxes}.
13958 @item ask
13959 When closing mailboxes, nnimap will ask if you wish to expunge deleted
13960 articles or not.
13961
13962 @end table
13963
13964 @item nnimap-authinfo-file
13965 @vindex nnimap-authinfo-file
13966
13967 A file containing credentials used to log in on servers.  The format
13968 is (almost) the same as the @code{ftp} @file{~/.netrc} file.  See
13969 `nntp-authinfo-file' for exact syntax.
13970
13971 A file containing credentials used to log in on servers.  The format is
13972 (almost) the same as the @code{ftp} @file{~/.netrc} file.  See the
13973 variable @code{nntp-authinfo-file} for exact syntax; also see
13974 @xref{NNTP}.
13975
13976 @end table
13977
13978 @menu
13979 * Splitting in IMAP::     Splitting mail with nnimap.
13980 * Editing IMAP ACLs::     Limiting/enabling other users access to a mailbox.
13981 * Expunging mailboxes::   Equivalent of a "compress mailbox" button.
13982 @end menu
13983
13984
13985
13986 @node Splitting in IMAP
13987 @subsubsection Splitting in @sc{imap}
13988 @cindex splitting imap mail
13989
13990 Splitting is something Gnus users has loved and used for years, and now
13991 the rest of the world is catching up.  Yeah, dream on, not many
13992 @sc{imap} server has server side splitting and those that have splitting
13993 seem to use some non-standard protocol.  This means that @sc{imap}
13994 support for Gnus has to do it's own splitting.
13995
13996 And it does.
13997
13998 Here are the variables of interest:
13999
14000 @table @code
14001
14002 @item nnimap-split-crosspost
14003 @cindex splitting, crosspost
14004 @cindex crosspost
14005 @vindex nnimap-split-crosspost
14006
14007 If non-nil, do crossposting if several split methods match the mail.  If
14008 nil, the first match in @code{nnimap-split-rule} found will be used.
14009
14010 Nnmail equivalent: @code{nnmail-crosspost}.
14011
14012 @item nnimap-split-inbox
14013 @cindex splitting, inbox
14014 @cindex inbox
14015 @vindex nnimap-split-inbox
14016
14017 A string or a list of strings that gives the name(s) of @sc{imap}
14018 mailboxes to split from.  Defaults to nil, which means that splitting is
14019 disabled!
14020
14021 @lisp
14022 (setq nnimap-split-inbox
14023       '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
14024 @end lisp
14025
14026 No nnmail equivalent.
14027
14028 @item nnimap-split-rule
14029 @cindex Splitting, rules
14030 @vindex nnimap-split-rule
14031
14032 New mail found in @code{nnimap-split-inbox} will be split according to
14033 this variable.
14034
14035 This variable contains a list of lists, where the first element in the
14036 sublist gives the name of the @sc{imap} mailbox to move articles
14037 matching the regexp in the second element in the sublist.  Got that?
14038 Neither did I, we need examples.
14039
14040 @lisp
14041 (setq nnimap-split-rule
14042       '(("INBOX.nnimap"  "^Sender: owner-nnimap@@vic20.globalcom.se")
14043         ("INBOX.junk"    "^Subject:.*MAKE MONEY")
14044         ("INBOX.private" "")))
14045 @end lisp
14046
14047 This will put all articles from the nnimap mailing list into mailbox
14048 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
14049 into INBOX.spam and everything else in INBOX.private.
14050
14051 The first string may contain `\\1' forms, like the ones used by
14052 replace-match to insert sub-expressions from the matched text.  For
14053 instance:
14054
14055 @lisp
14056 ("INBOX.lists.\\1"     "^Sender: owner-\\([a-z-]+\\)@@")
14057 @end lisp
14058
14059 The second element can also be a function.  In that case, it will be
14060 called with the first element of the rule as the argument, in a buffer
14061 containing the headers of the article.  It should return a non-nil value
14062 if it thinks that the mail belongs in that group.
14063
14064 Nnmail users might recollect that the last regexp had to be empty to
14065 match all articles (like in the example above).  This is not required in
14066 nnimap.  Articles not matching any of the regexps will not be moved out
14067 of your inbox.  (This might might affect performance if you keep lots of
14068 unread articles in your inbox, since the splitting code would go over
14069 them every time you fetch new mail.)
14070
14071 These rules are processed from the beginning of the alist toward the
14072 end.  The first rule to make a match will "win", unless you have
14073 crossposting enabled.  In that case, all matching rules will "win".
14074
14075 This variable can also have a function as its value, the function will
14076 be called with the headers narrowed and should return a group where it
14077 thinks the article should be splitted to.  See @code{nnimap-split-fancy}.
14078
14079 The splitting code tries to create mailboxes if it need too.
14080
14081 To allow for different split rules on different virtual servers, and
14082 even different split rules in different inboxes on the same server,
14083 the syntax of this variable have been extended along the lines of:
14084
14085 @lisp
14086 (setq nnimap-split-rule
14087       '(("my1server"    (".*"    (("ding"    "ding@@gnus.org")
14088                                   ("junk"    "From:.*Simon")))
14089         ("my2server"    ("INBOX" nnimap-split-fancy))
14090         ("my[34]server" (".*"    (("private" "To:.*Simon")
14091                                   ("junk"    my-junk-func)))))
14092 @end lisp
14093
14094 The virtual server name is in fact a regexp, so that the same rules
14095 may apply to several servers.  In the example, the servers
14096 @code{my3server} and @code{my4server} both use the same rules.
14097 Similarly, the inbox string is also a regexp.  The actual splitting
14098 rules are as before, either a function, or a list with group/regexp or
14099 group/function elements.
14100
14101 Nnmail equivalent: @code{nnmail-split-methods}.
14102
14103 @item nnimap-split-predicate
14104 @cindex splitting
14105 @vindex nnimap-split-predicate
14106
14107 Mail matching this predicate in @code{nnimap-split-inbox} will be
14108 splitted, it is a string and the default is @samp{UNSEEN UNDELETED}.
14109
14110 This might be useful if you use another @sc{imap} client to read mail in
14111 your inbox but would like Gnus to split all articles in the inbox
14112 regardless of readedness. Then you might change this to
14113 @samp{UNDELETED}.
14114
14115 @item nnimap-split-fancy
14116 @cindex splitting, fancy
14117 @findex nnimap-split-fancy
14118 @vindex nnimap-split-fancy
14119
14120 It's possible to set @code{nnimap-split-rule} to
14121 @code{nnmail-split-fancy} if you want to use fancy
14122 splitting. @xref{Fancy Mail Splitting}.
14123
14124 However, to be able to have different fancy split rules for nnmail and
14125 nnimap backends you can set @code{nnimap-split-rule} to
14126 @code{nnimap-split-fancy} and define the nnimap specific fancy split
14127 rule in @code{nnimap-split-fancy}.
14128
14129 Example:
14130
14131 @lisp
14132 (setq nnimap-split-rule 'nnimap-split-fancy
14133       nnimap-split-fancy ...)
14134 @end lisp
14135
14136 Nnmail equivalent: @code{nnmail-split-fancy}.
14137
14138 @end table
14139
14140 @node Editing IMAP ACLs
14141 @subsubsection Editing @sc{imap} ACLs
14142 @cindex editing imap acls
14143 @cindex Access Control Lists
14144 @cindex Editing @sc{imap} ACLs
14145 @kindex G l
14146 @findex gnus-group-nnimap-edit-acl
14147
14148 ACL stands for Access Control List.  ACLs are used in @sc{imap} for
14149 limiting (or enabling) other users access to your mail boxes.  Not all
14150 @sc{imap} servers support this, this function will give an error if it
14151 doesn't.
14152
14153 To edit a ACL for a mailbox, type @kbd{G l}
14154 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with a ACL
14155 editing window with detailed instructions.
14156
14157 Some possible uses:
14158
14159 @itemize @bullet
14160 @item
14161 Giving "anyone" the "lrs" rights (lookup, read, keep seen/unseen flags)
14162 on your mailing list mailboxes enables other users on the same server to
14163 follow the list without subscribing to it.
14164 @item
14165 At least with the Cyrus server, you are required to give the user
14166 "anyone" posting ("p") capabilities to have "plussing" work (that is,
14167 mail sent to user+mailbox@@domain ending up in the @sc{imap} mailbox
14168 INBOX.mailbox).
14169 @end itemize
14170
14171 @node Expunging mailboxes
14172 @subsubsection Expunging mailboxes
14173 @cindex expunging
14174
14175 @cindex Expunge
14176 @cindex Manual expunging
14177 @kindex G x
14178 @findex gnus-group-nnimap-expunge
14179
14180 If you're using the @code{never} setting of @code{nnimap-expunge-close},
14181 you may want the option of expunging all deleted articles in a mailbox
14182 manually.  This is exactly what @kbd{G x} does.
14183
14184 Currently there is no way of showing deleted articles, you can just
14185 delete them.
14186
14187
14188
14189 @node Combined Groups
14190 @section Combined Groups
14191
14192 Gnus allows combining a mixture of all the other group types into bigger
14193 groups.
14194
14195 @menu
14196 * Virtual Groups::     Combining articles from many groups.
14197 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
14198 @end menu
14199
14200
14201 @node Virtual Groups
14202 @subsection Virtual Groups
14203 @cindex nnvirtual
14204 @cindex virtual groups
14205 @cindex merging groups
14206
14207 An @dfn{nnvirtual group} is really nothing more than a collection of
14208 other groups.
14209
14210 For instance, if you are tired of reading many small groups, you can
14211 put them all in one big group, and then grow tired of reading one
14212 big, unwieldy group.  The joys of computing!
14213
14214 You specify @code{nnvirtual} as the method.  The address should be a
14215 regexp to match component groups.
14216
14217 All marks in the virtual group will stick to the articles in the
14218 component groups.  So if you tick an article in a virtual group, the
14219 article will also be ticked in the component group from whence it came.
14220 (And vice versa---marks from the component groups will also be shown in
14221 the virtual group.)
14222
14223 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
14224 newsgroups into one, big, happy newsgroup:
14225
14226 @lisp
14227 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
14228 @end lisp
14229
14230 The component groups can be native or foreign; everything should work
14231 smoothly, but if your computer explodes, it was probably my fault.
14232
14233 Collecting the same group from several servers might actually be a good
14234 idea if users have set the Distribution header to limit distribution.
14235 If you would like to read @samp{soc.motss} both from a server in Japan
14236 and a server in Norway, you could use the following as the group regexp:
14237
14238 @example
14239 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
14240 @end example
14241
14242 (Remember, though, that if you're creating the group with @kbd{G m}, you
14243 shouldn't double the backslashes, and you should leave off the quote
14244 characters at the beginning and the end of the string.)
14245
14246 This should work kinda smoothly---all articles from both groups should
14247 end up in this one, and there should be no duplicates.  Threading (and
14248 the rest) will still work as usual, but there might be problems with the
14249 sequence of articles.  Sorting on date might be an option here
14250 (@pxref{Selecting a Group}).
14251
14252 One limitation, however---all groups included in a virtual
14253 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
14254 zombie groups can't be component groups for @code{nnvirtual} groups.
14255
14256 @vindex nnvirtual-always-rescan
14257 If the @code{nnvirtual-always-rescan} is non-@code{nil},
14258 @code{nnvirtual} will always scan groups for unread articles when
14259 entering a virtual group.  If this variable is @code{nil} (which is the
14260 default) and you read articles in a component group after the virtual
14261 group has been activated, the read articles from the component group
14262 will show up when you enter the virtual group.  You'll also see this
14263 effect if you have two virtual groups that have a component group in
14264 common.  If that's the case, you should set this variable to @code{t}.
14265 Or you can just tap @code{M-g} on the virtual group every time before
14266 you enter it---it'll have much the same effect.
14267
14268 @code{nnvirtual} can have both mail and news groups as component groups.
14269 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
14270 has to ask the backend of the component group the article comes from
14271 whether it is a news or mail backend.  However, when you do a @kbd{^},
14272 there is typically no sure way for the component backend to know this,
14273 and in that case @code{nnvirtual} tells Gnus that the article came from a
14274 not-news backend.  (Just to be on the safe side.)
14275
14276 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
14277 line from the article you respond to in these cases.
14278
14279
14280
14281 @node Kibozed Groups
14282 @subsection Kibozed Groups
14283 @cindex nnkiboze
14284 @cindex kibozing
14285
14286 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
14287 the news feed''.  @code{nnkiboze} is a backend that will do this for
14288 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
14289 with useless requests!  Oh happiness!
14290
14291 @kindex G k (Group)
14292 To create a kibozed group, use the @kbd{G k} command in the group
14293 buffer.
14294
14295 The address field of the @code{nnkiboze} method is, as with
14296 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
14297 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
14298 and @code{nnvirtual} end.
14299
14300 In addition to this regexp detailing component groups, an @code{nnkiboze} group
14301 must have a score file to say what articles are to be included in
14302 the group (@pxref{Scoring}).
14303
14304 @kindex M-x nnkiboze-generate-groups
14305 @findex nnkiboze-generate-groups
14306 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
14307 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
14308 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
14309 all the articles in all the component groups and run them through the
14310 scoring process to determine if there are any articles in the groups
14311 that are to be part of the @code{nnkiboze} groups.
14312
14313 Please limit the number of component groups by using restrictive
14314 regexps.  Otherwise your sysadmin may become annoyed with you, and the
14315 @sc{nntp} site may throw you off and never let you back in again.
14316 Stranger things have happened.
14317
14318 @code{nnkiboze} component groups do not have to be alive---they can be dead,
14319 and they can be foreign.  No restrictions.
14320
14321 @vindex nnkiboze-directory
14322 The generation of an @code{nnkiboze} group means writing two files in
14323 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
14324 contains the @sc{nov} header lines for all the articles in the group,
14325 and the other is an additional @file{.newsrc} file to store information
14326 on what groups have been searched through to find component articles.
14327
14328 Articles marked as read in the @code{nnkiboze} group will have
14329 their @sc{nov} lines removed from the @sc{nov} file.
14330
14331
14332 @node Gnus Unplugged
14333 @section Gnus Unplugged
14334 @cindex offline
14335 @cindex unplugged
14336 @cindex Agent
14337 @cindex Gnus Agent
14338 @cindex Gnus Unplugged
14339
14340 In olden times (ca. February '88), people used to run their newsreaders
14341 on big machines with permanent connections to the net.  News transport
14342 was dealt with by news servers, and all the newsreaders had to do was to
14343 read news.  Believe it or not.
14344
14345 Nowadays most people read news and mail at home, and use some sort of
14346 modem to connect to the net.  To avoid running up huge phone bills, it
14347 would be nice to have a way to slurp down all the news and mail, hang up
14348 the phone, read for several hours, and then upload any responses you
14349 have to make.  And then you repeat the procedure.
14350
14351 Of course, you can use news servers for doing this as well.  I've used
14352 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
14353 for some years, but doing that's a bore.  Moving the news server
14354 functionality up to the newsreader makes sense if you're the only person
14355 reading news on a machine.
14356
14357 Using Gnus as an ``offline'' newsreader is quite simple.
14358
14359 @itemize @bullet
14360 @item
14361 First, set up Gnus as you would do if you were running it on a machine
14362 that has full connection to the net.  Go ahead.  I'll still be waiting
14363 here.
14364
14365 @item
14366 Then, put the following magical incantation at the end of your
14367 @file{.gnus.el} file:
14368
14369 @lisp
14370 (gnus-agentize)
14371 @end lisp
14372 @end itemize
14373
14374 That's it.  Gnus is now an ``offline'' newsreader.
14375
14376 Of course, to use it as such, you have to learn a few new commands.
14377
14378 @menu
14379 * Agent Basics::           How it all is supposed to work.
14380 * Agent Categories::       How to tell the Gnus Agent what to download.
14381 * Agent Commands::         New commands for all the buffers.
14382 * Agent Expiry::           How to make old articles go away.
14383 * Agent and IMAP::         How to use the Agent with IMAP.
14384 * Outgoing Messages::      What happens when you post/mail something?
14385 * Agent Variables::        Customizing is fun.
14386 * Example Setup::          An example @file{.gnus.el} file for offline people.
14387 * Batching Agents::        How to fetch news from a @code{cron} job.
14388 * Agent Caveats::          What you think it'll do and what it does.
14389 @end menu
14390
14391
14392 @node Agent Basics
14393 @subsection Agent Basics
14394
14395 First, let's get some terminology out of the way.
14396
14397 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
14398 connection to the net (and notified the Agent that this is the case).
14399 When the connection to the net is up again (and Gnus knows this), the
14400 Agent is @dfn{plugged}.
14401
14402 The @dfn{local} machine is the one you're running on, and which isn't
14403 connected to the net continuously.
14404
14405 @dfn{Downloading} means fetching things from the net to your local
14406 machine.  @dfn{Uploading} is doing the opposite.
14407
14408 Let's take a typical Gnus session using the Agent.
14409
14410 @itemize @bullet
14411
14412 @item
14413 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
14414 Agent in a disconnected state.  You can read all the news that you have
14415 already fetched while in this mode.
14416
14417 @item
14418 You then decide to see whether any new news has arrived.  You connect
14419 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
14420 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
14421 as usual.  To check for new mail in unplugged mode, see (@pxref{Mail
14422 Source Specifiers}).
14423
14424 @item
14425 You can then read the new news immediately, or you can download the news
14426 onto your local machine.  If you want to do the latter, you press @kbd{g}
14427 to check if there are any new news and then @kbd{J
14428 s} to fetch all the eligible articles in all the groups.  (To let Gnus
14429 know which articles you want to download, @pxref{Agent Categories}.)
14430
14431 @item
14432 After fetching the articles, you press @kbd{J j} to make Gnus become
14433 unplugged again, and you shut down the PPP thing (or whatever).  And
14434 then you read the news offline.
14435
14436 @item
14437 And then you go to step 2.
14438 @end itemize
14439
14440 Here are some things you should do the first time (or so) that you use
14441 the Agent.
14442
14443 @itemize @bullet
14444
14445 @item
14446 Decide which servers should be covered by the Agent.  If you have a mail
14447 backend, it would probably be nonsensical to have it covered by the
14448 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
14449 @kbd{J a} the server (or servers) that you wish to have covered by the
14450 Agent (@pxref{Server Agent Commands}).  This will typically be only the
14451 primary select method, which is listed on the bottom in the buffer.
14452
14453 @item
14454 Decide on download policy.  @xref{Agent Categories}.
14455
14456 @item
14457 Uhm... that's it.
14458 @end itemize
14459
14460
14461 @node Agent Categories
14462 @subsection Agent Categories
14463
14464 One of the main reasons to integrate the news transport layer into the
14465 newsreader is to allow greater control over what articles to download.
14466 There's not much point in downloading huge amounts of articles, just to
14467 find out that you're not interested in reading any of them.  It's better
14468 to be somewhat more conservative in choosing what to download, and then
14469 mark the articles for downloading manually if it should turn out that
14470 you're interested in the articles anyway.
14471
14472 The main way to control what is to be downloaded is to create a
14473 @dfn{category} and then assign some (or all) groups to this category.
14474 Groups that do not belong in any other category belong to the
14475 @code{default} category.  Gnus has its own buffer for creating and
14476 managing categories.
14477
14478 @menu
14479 * Category Syntax::       What a category looks like.
14480 * The Category Buffer::   A buffer for maintaining categories.
14481 * Category Variables::    Customize'r'Us.
14482 @end menu
14483
14484
14485 @node Category Syntax
14486 @subsubsection Category Syntax
14487
14488 A category consists of two things.
14489
14490 @enumerate
14491 @item
14492 A predicate which (generally) gives a rough outline of which articles
14493 are eligible for downloading; and
14494
14495 @item
14496 a score rule which (generally) gives you a finer granularity when
14497 deciding what articles to download.  (Note that this @dfn{download
14498 score} is not necessarily related to normal scores.)
14499 @end enumerate
14500
14501 A predicate in its simplest form can be a single predicate such as
14502 @code{true} or @code{false}.  These two will download every available
14503 article or nothing respectively.  In the case of these two special
14504 predicates an additional score rule is superfluous.
14505
14506 Predicates of @code{high} or @code{low} download articles in respect of
14507 their scores in relationship to @code{gnus-agent-high-score} and
14508 @code{gnus-agent-low-score} as described below.
14509
14510 To gain even finer control of what is to be regarded eligible for
14511 download a predicate can consist of a number of predicates with logical
14512 operators sprinkled in between.
14513
14514 Perhaps some examples are in order.
14515
14516 Here's a simple predicate.  (It's the default predicate, in fact, used
14517 for all groups that don't belong to any other category.)
14518
14519 @lisp
14520 short
14521 @end lisp
14522
14523 Quite simple, eh?  This predicate is true if and only if the article is
14524 short (for some value of ``short'').
14525
14526 Here's a more complex predicate:
14527
14528 @lisp
14529 (or high
14530     (and
14531      (not low)
14532      (not long)))
14533 @end lisp
14534
14535 This means that an article should be downloaded if it has a high score,
14536 or if the score is not low and the article is not long.  You get the
14537 drift.
14538
14539 The available logical operators are @code{or}, @code{and} and
14540 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
14541 @samp{|}, @code{&} and @code{!} instead.)
14542
14543 The following predicates are pre-defined, but if none of these fit what
14544 you want to do, you can write your own.
14545
14546 @table @code
14547 @item short
14548 True iff the article is shorter than @code{gnus-agent-short-article}
14549 lines; default 100.
14550
14551 @item long
14552 True iff the article is longer than @code{gnus-agent-long-article}
14553 lines; default 200.
14554
14555 @item low
14556 True iff the article has a download score less than
14557 @code{gnus-agent-low-score}; default 0.
14558
14559 @item high
14560 True iff the article has a download score greater than
14561 @code{gnus-agent-high-score}; default 0.
14562
14563 @item spam
14564 True iff the Gnus Agent guesses that the article is spam.  The
14565 heuristics may change over time, but at present it just computes a
14566 checksum and sees whether articles match.
14567
14568 @item true
14569 Always true.
14570
14571 @item false
14572 Always false.
14573 @end table
14574
14575 If you want to create your own predicate function, here's what you have
14576 to know:  The functions are called with no parameters, but the
14577 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
14578 useful values.
14579
14580 For example, you could decide that you don't want to download articles
14581 that were posted more than a certain number of days ago (e.g. posted
14582 more than @code{gnus-agent-expire-days} ago) you might write a function
14583 something along the lines of the following:
14584
14585 @lisp
14586 (defun my-article-old-p ()
14587   "Say whether an article is old."
14588   (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
14589      (- (time-to-days (current-time)) gnus-agent-expire-days)))
14590 @end lisp
14591
14592 with the predicate then defined as:
14593
14594 @lisp
14595 (not my-article-old-p)
14596 @end lisp
14597
14598 or you could append your predicate to the predefined
14599 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
14600 wherever.  (Note: this would have to be at a point *after*
14601 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
14602
14603 @lisp
14604 (defvar  gnus-category-predicate-alist
14605   (append gnus-category-predicate-alist
14606          '((old . my-article-old-p))))
14607 @end lisp
14608
14609 and simply specify your predicate as:
14610
14611 @lisp
14612 (not old)
14613 @end lisp
14614
14615 If/when using something like the above, be aware that there are many
14616 misconfigured systems/mailers out there and so an article's date is not
14617 always a reliable indication of when it was posted.  Hell, some people
14618 just don't give a damm.
14619
14620 The above predicates apply to *all* the groups which belong to the
14621 category.  However, if you wish to have a specific predicate for an
14622 individual group within a category, or you're just too lazy to set up a
14623 new category, you can enter a group's individual predicate in it's group
14624 parameters like so:
14625
14626 @lisp
14627 (agent-predicate . short)
14628 @end lisp
14629
14630 This is the group parameter equivalent of the agent category default.
14631 Note that when specifying a single word predicate like this, the
14632 @code{agent-predicate} specification must be in dotted pair notation.
14633
14634 The equivalent of the longer example from above would be:
14635
14636 @lisp
14637 (agent-predicate or high (and (not low) (not long)))
14638 @end lisp
14639
14640 The outer parenthesis required in the category specification are not
14641 entered here as, not being in dotted pair notation, the value of the
14642 predicate is assumed to be a list.
14643
14644
14645 Now, the syntax of the download score is the same as the syntax of
14646 normal score files, except that all elements that require actually
14647 seeing the article itself are verboten.  This means that only the
14648 following headers can be scored on: @code{Subject}, @code{From},
14649 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
14650 @code{Lines}, and @code{Xref}.
14651
14652 As with predicates, the specification of the @code{download score rule}
14653 to use in respect of a group can be in either the category definition if
14654 it's to be applicable to all groups in therein, or a group's parameters
14655 if it's to be specific to that group.
14656
14657 In both of these places the @code{download score rule} can take one of
14658 three forms:
14659
14660 @enumerate
14661 @item
14662 Score rule
14663
14664 This has the same syntax as a normal gnus score file except only a
14665 subset of scoring keywords are available as mentioned above.
14666
14667 example:
14668
14669 @itemize @bullet
14670 @item
14671 Category specification
14672
14673 @lisp
14674 (("from"
14675        ("Lars Ingebrigtsen" 1000000 nil s))
14676 ("lines"
14677        (500 -100 nil <)))
14678 @end lisp
14679
14680 @item
14681 Group Parameter specification
14682
14683 @lisp
14684 (agent-score ("from"
14685                    ("Lars Ingebrigtsen" 1000000 nil s))
14686              ("lines"
14687                    (500 -100 nil <)))
14688 @end lisp
14689
14690 Again, note the omission of the outermost parenthesis here.
14691 @end itemize
14692
14693 @item
14694 Agent score file
14695
14696 These score files must *only* contain the permitted scoring keywords
14697 stated above.
14698
14699 example:
14700
14701 @itemize @bullet
14702 @item
14703 Category specification
14704
14705 @lisp
14706 ("~/News/agent.SCORE")
14707 @end lisp
14708
14709 or perhaps
14710
14711 @lisp
14712 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
14713 @end lisp
14714
14715 @item
14716 Group Parameter specification
14717
14718 @lisp
14719 (agent-score "~/News/agent.SCORE")
14720 @end lisp
14721
14722 Additional score files can be specified as above.  Need I say anything
14723 about parenthesis?
14724 @end itemize
14725
14726 @item
14727 Use @code{normal} score files
14728
14729 If you dont want to maintain two sets of scoring rules for a group, and
14730 your desired @code{downloading} criteria for a group are the same as your
14731 @code{reading} criteria then you can tell the agent to refer to your
14732 @code{normal} score files when deciding what to download.
14733
14734 These directives in either the category definition or a group's
14735 parameters will cause the agent to read in all the applicable score
14736 files for a group, *filtering out* those those sections that do not
14737 relate to one of the permitted subset of scoring keywords.
14738
14739 @itemize @bullet
14740 @item
14741 Category Specification
14742
14743 @lisp
14744 file
14745 @end lisp
14746
14747 @item
14748 Group Parameter specification
14749
14750 @lisp
14751 (agent-score . file)
14752 @end lisp
14753 @end itemize
14754 @end enumerate
14755
14756 @node The Category Buffer
14757 @subsubsection The Category Buffer
14758
14759 You'd normally do all category maintenance from the category buffer.
14760 When you enter it for the first time (with the @kbd{J c} command from
14761 the group buffer), you'll only see the @code{default} category.
14762
14763 The following commands are available in this buffer:
14764
14765 @table @kbd
14766 @item q
14767 @kindex q (Category)
14768 @findex gnus-category-exit
14769 Return to the group buffer (@code{gnus-category-exit}).
14770
14771 @item k
14772 @kindex k (Category)
14773 @findex gnus-category-kill
14774 Kill the current category (@code{gnus-category-kill}).
14775
14776 @item c
14777 @kindex c (Category)
14778 @findex gnus-category-copy
14779 Copy the current category (@code{gnus-category-copy}).
14780
14781 @item a
14782 @kindex a (Category)
14783 @findex gnus-category-add
14784 Add a new category (@code{gnus-category-add}).
14785
14786 @item p
14787 @kindex p (Category)
14788 @findex gnus-category-edit-predicate
14789 Edit the predicate of the current category
14790 (@code{gnus-category-edit-predicate}).
14791
14792 @item g
14793 @kindex g (Category)
14794 @findex gnus-category-edit-groups
14795 Edit the list of groups belonging to the current category
14796 (@code{gnus-category-edit-groups}).
14797
14798 @item s
14799 @kindex s (Category)
14800 @findex gnus-category-edit-score
14801 Edit the download score rule of the current category
14802 (@code{gnus-category-edit-score}).
14803
14804 @item l
14805 @kindex l (Category)
14806 @findex gnus-category-list
14807 List all the categories (@code{gnus-category-list}).
14808 @end table
14809
14810
14811 @node Category Variables
14812 @subsubsection Category Variables
14813
14814 @table @code
14815 @item gnus-category-mode-hook
14816 @vindex gnus-category-mode-hook
14817 Hook run in category buffers.
14818
14819 @item gnus-category-line-format
14820 @vindex gnus-category-line-format
14821 Format of the lines in the category buffer (@pxref{Formatting
14822 Variables}).  Valid elements are:
14823
14824 @table @samp
14825 @item c
14826 The name of the category.
14827
14828 @item g
14829 The number of groups in the category.
14830 @end table
14831
14832 @item gnus-category-mode-line-format
14833 @vindex gnus-category-mode-line-format
14834 Format of the category mode line (@pxref{Mode Line Formatting}).
14835
14836 @item gnus-agent-short-article
14837 @vindex gnus-agent-short-article
14838 Articles that have fewer lines than this are short.  Default 100.
14839
14840 @item gnus-agent-long-article
14841 @vindex gnus-agent-long-article
14842 Articles that have more lines than this are long.  Default 200.
14843
14844 @item gnus-agent-low-score
14845 @vindex gnus-agent-low-score
14846 Articles that have a score lower than this have a low score.  Default
14847 0.
14848
14849 @item gnus-agent-high-score
14850 @vindex gnus-agent-high-score
14851 Articles that have a score higher than this have a high score.  Default
14852 0.
14853
14854 @end table
14855
14856
14857 @node Agent Commands
14858 @subsection Agent Commands
14859
14860 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
14861 (@code{gnus-agent-toggle-plugged} command works in all modes, and
14862 toggles the plugged/unplugged state of the Gnus Agent.
14863
14864
14865 @menu
14866 * Group Agent Commands::
14867 * Summary Agent Commands::
14868 * Server Agent Commands::
14869 @end menu
14870
14871 You can run a complete batch fetch from the command line with the
14872 following incantation:
14873
14874 @cindex gnus-agent-batch-fetch
14875 @example
14876 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
14877 @end example
14878
14879
14880
14881 @node Group Agent Commands
14882 @subsubsection Group Agent Commands
14883
14884 @table @kbd
14885 @item J u
14886 @kindex J u (Agent Group)
14887 @findex gnus-agent-fetch-groups
14888 Fetch all eligible articles in the current group
14889 (@code{gnus-agent-fetch-groups}).
14890
14891 @item J c
14892 @kindex J c (Agent Group)
14893 @findex gnus-enter-category-buffer
14894 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
14895
14896 @item J s
14897 @kindex J s (Agent Group)
14898 @findex gnus-agent-fetch-session
14899 Fetch all eligible articles in all groups
14900 (@code{gnus-agent-fetch-session}).
14901
14902 @item J S
14903 @kindex J S (Agent Group)
14904 @findex gnus-group-send-drafts
14905 Send all sendable messages in the draft group
14906 (@code{gnus-group-send-drafts}).  @xref{Drafts}.
14907
14908 @item J a
14909 @kindex J a (Agent Group)
14910 @findex gnus-agent-add-group
14911 Add the current group to an Agent category
14912 (@code{gnus-agent-add-group}).  This command understands the
14913 process/prefix convention (@pxref{Process/Prefix}).
14914
14915 @item J r
14916 @kindex J r (Agent Group)
14917 @findex gnus-agent-remove-group
14918 Remove the current group from its category, if any
14919 (@code{gnus-agent-remove-group}).  This command understands the
14920 process/prefix convention (@pxref{Process/Prefix}).
14921
14922 @item J Y
14923 @kindex J Y (Agent Group)
14924 @findex gnus-agent-synchronize-flags
14925 Synchronize flags changed while unplugged with remote server, if any.
14926
14927
14928 @end table
14929
14930
14931 @node Summary Agent Commands
14932 @subsubsection Summary Agent Commands
14933
14934 @table @kbd
14935 @item J #
14936 @kindex J # (Agent Summary)
14937 @findex gnus-agent-mark-article
14938 Mark the article for downloading (@code{gnus-agent-mark-article}).
14939
14940 @item J M-#
14941 @kindex J M-# (Agent Summary)
14942 @findex gnus-agent-unmark-article
14943 Remove the downloading mark from the article
14944 (@code{gnus-agent-unmark-article}).
14945
14946 @item @@
14947 @kindex @@ (Agent Summary)
14948 @findex gnus-agent-toggle-mark
14949 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
14950
14951 @item J c
14952 @kindex J c (Agent Summary)
14953 @findex gnus-agent-catchup
14954 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
14955
14956 @end table
14957
14958
14959 @node Server Agent Commands
14960 @subsubsection Server Agent Commands
14961
14962 @table @kbd
14963 @item J a
14964 @kindex J a (Agent Server)
14965 @findex gnus-agent-add-server
14966 Add the current server to the list of servers covered by the Gnus Agent
14967 (@code{gnus-agent-add-server}).
14968
14969 @item J r
14970 @kindex J r (Agent Server)
14971 @findex gnus-agent-remove-server
14972 Remove the current server from the list of servers covered by the Gnus
14973 Agent (@code{gnus-agent-remove-server}).
14974
14975 @end table
14976
14977
14978 @node Agent Expiry
14979 @subsection Agent Expiry
14980
14981 @vindex gnus-agent-expire-days
14982 @findex gnus-agent-expire
14983 @kindex M-x gnus-agent-expire
14984 @cindex Agent expiry
14985 @cindex Gnus Agent expiry
14986 @cindex expiry
14987
14988 @code{nnagent} doesn't handle expiry.  Instead, there's a special
14989 @code{gnus-agent-expire} command that will expire all read articles that
14990 are older than @code{gnus-agent-expire-days} days.  It can be run
14991 whenever you feel that you're running out of space.  It's not
14992 particularly fast or efficient, and it's not a particularly good idea to
14993 interrupt it (with @kbd{C-g} or anything else) once you've started it.
14994
14995 @vindex gnus-agent-expire-all
14996 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
14997 expire all articles---unread, read, ticked and dormant.  If @code{nil}
14998 (which is the default), only read articles are eligible for expiry, and
14999 unread, ticked and dormant articles will be kept indefinitely.
15000
15001
15002 @node Agent and IMAP
15003 @subsection Agent and IMAP
15004
15005 The Agent work with any Gnus backend, including nnimap.  However, since
15006 there are some conceptual differences between NNTP and IMAP, this
15007 section (should) provide you with some information to make Gnus Agent
15008 work smoother as a IMAP Disconnected Mode client.
15009
15010 The first thing to keep in mind is that all flags (read, ticked, etc)
15011 are kept on the IMAP server, rather than in @code{.newsrc} as is the
15012 case for nntp.  Thus Gnus need to remember flag changes when
15013 disconnected, and synchronize these flags when you plug back in.
15014
15015 Gnus keep track of flag changes when reading nnimap groups under the
15016 Agent by default.  When you plug back in, by default Gnus will check if
15017 you have any changed any flags and ask if you wish to synchronize theese
15018 with the server.  This behaviour is customizable with
15019 @code{gnus-agent-synchronize-flags}.
15020
15021 @vindex gnus-agent-synchronize-flags
15022 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
15023 never automatically synchronize flags.  If it is @code{ask}, the
15024 default, the Agent will check if you made any changes and if so ask if
15025 you wish to synchronize these when you re-connect.  If it has any other
15026 value, all flags will be synchronized automatically.
15027
15028 If you do not wish to automatically synchronize flags when you
15029 re-connect, this can be done manually with the
15030 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
15031 in the group buffer by default.
15032
15033 Some things are currently not implemented in the Agent that you'd might
15034 expect from a disconnected IMAP client, including:
15035
15036 @itemize @bullet
15037
15038 @item
15039 Copying/moving articles into nnimap groups when unplugged.
15040
15041 @item
15042 Creating/deleting nnimap groups when unplugged.
15043
15044 @end itemize
15045
15046 Technical note: the synchronization algorithm does not work by "pushing"
15047 all local flags to the server, but rather incrementally update the
15048 server view of flags by changing only those flags that were changed by
15049 the user.  Thus, if you set one flag on a article, quit the group and
15050 re-select the group and remove the flag; the flag will be set and
15051 removed from the server when you "synchronize".  The queued flag
15052 operations can be found in the per-server @code{flags} file in the Agent
15053 directory.  It's emptied when you synchronize flags.
15054
15055
15056 @node Outgoing Messages
15057 @subsection Outgoing Messages
15058
15059 When Gnus is unplugged, all outgoing messages (both mail and news) are
15060 stored in the draft groups (@pxref{Drafts}).  You can view them there
15061 after posting, and edit them at will.
15062
15063 When Gnus is plugged again, you can send the messages either from the
15064 draft group with the special commands available there, or you can use
15065 the @kbd{J S} command in the group buffer to send all the sendable
15066 messages in the draft group.
15067
15068
15069
15070 @node Agent Variables
15071 @subsection Agent Variables
15072
15073 @table @code
15074 @item gnus-agent-directory
15075 @vindex gnus-agent-directory
15076 Where the Gnus Agent will store its files.  The default is
15077 @file{~/News/agent/}.
15078
15079 @item gnus-agent-handle-level
15080 @vindex gnus-agent-handle-level
15081 Groups on levels (@pxref{Group Levels}) higher than this variable will
15082 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
15083 which means that only subscribed group will be considered by the Agent
15084 by default.
15085
15086 @item gnus-agent-plugged-hook
15087 @vindex gnus-agent-plugged-hook
15088 Hook run when connecting to the network.
15089
15090 @item gnus-agent-unplugged-hook
15091 @vindex gnus-agent-unplugged-hook
15092 Hook run when disconnecting from the network.
15093
15094 @end table
15095
15096
15097 @node Example Setup
15098 @subsection Example Setup
15099
15100 If you don't want to read this manual, and you have a fairly standard
15101 setup, you may be able to use something like the following as your
15102 @file{.gnus.el} file to get started.
15103
15104 @lisp
15105 ;;; Define how Gnus is to fetch news.  We do this over @sc{nntp}
15106 ;;; from your ISP's server.
15107 (setq gnus-select-method '(nntp "news.your-isp.com"))
15108
15109 ;;; Define how Gnus is to read your mail.  We read mail from
15110 ;;; your ISP's POP server.
15111 (setq mail-sources '((pop :server "pop.your-isp.com")))
15112
15113 ;;; Say how Gnus is to store the mail.  We use nnml groups.
15114 (setq gnus-secondary-select-methods '((nnml "")))
15115
15116 ;;; Make Gnus into an offline newsreader.
15117 (gnus-agentize)
15118 @end lisp
15119
15120 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
15121 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
15122 gnus}.
15123
15124 If this is the first time you've run Gnus, you will be subscribed
15125 automatically to a few default newsgroups.  You'll probably want to
15126 subscribe to more groups, and to do that, you have to query the
15127 @sc{nntp} server for a complete list of groups with the @kbd{A A}
15128 command.  This usually takes quite a while, but you only have to do it
15129 once.
15130
15131 After reading and parsing a while, you'll be presented with a list of
15132 groups.  Subscribe to the ones you want to read with the @kbd{u}
15133 command.  @kbd{l} to make all the killed groups disappear after you've
15134 subscribe to all the groups you want to read.  (@kbd{A k} will bring
15135 back all the killed groups.)
15136
15137 You can now read the groups at once, or you can download the articles
15138 with the @kbd{J s} command.  And then read the rest of this manual to
15139 find out which of the other gazillion things you want to customize.
15140
15141
15142 @node Batching Agents
15143 @subsection Batching Agents
15144
15145 Having the Gnus Agent fetch articles (and post whatever messages you've
15146 written) is quite easy once you've gotten things set up properly.  The
15147 following shell script will do everything that is necessary:
15148
15149 @example
15150 #!/bin/sh
15151 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
15152 @end example
15153
15154
15155 @node Agent Caveats
15156 @subsection Agent Caveats
15157
15158 The Gnus Agent doesn't seem to work like most other offline
15159 newsreaders.  Here are some common questions that some imaginary people
15160 may ask:
15161
15162 @table @dfn
15163 @item If I read an article while plugged, do they get entered into the
15164 Agent?
15165
15166 @strong{No.}
15167
15168 @item If I read an article while plugged, and the article already exists
15169 in the Agent, will it get downloaded once more?
15170
15171 @strong{Yes.}
15172
15173 @end table
15174
15175 In short, when Gnus is unplugged, it only looks into the locally stored
15176 articles; when it's plugged, it only talks to your ISP.
15177
15178
15179 @node Scoring
15180 @chapter Scoring
15181 @cindex scoring
15182
15183 Other people use @dfn{kill files}, but we here at Gnus Towers like
15184 scoring better than killing, so we'd rather switch than fight.  They do
15185 something completely different as well, so sit up straight and pay
15186 attention!
15187
15188 @vindex gnus-summary-mark-below
15189 All articles have a default score (@code{gnus-summary-default-score}),
15190 which is 0 by default.  This score may be raised or lowered either
15191 interactively or by score files.  Articles that have a score lower than
15192 @code{gnus-summary-mark-below} are marked as read.
15193
15194 Gnus will read any @dfn{score files} that apply to the current group
15195 before generating the summary buffer.
15196
15197 There are several commands in the summary buffer that insert score
15198 entries based on the current article.  You can, for instance, ask Gnus to
15199 lower or increase the score of all articles with a certain subject.
15200
15201 There are two sorts of scoring entries: Permanent and temporary.
15202 Temporary score entries are self-expiring entries.  Any entries that are
15203 temporary and have not been used for, say, a week, will be removed
15204 silently to help keep the sizes of the score files down.
15205
15206 @menu
15207 * Summary Score Commands::   Adding score entries for the current group.
15208 * Group Score Commands::     General score commands.
15209 * Score Variables::          Customize your scoring.  (My, what terminology).
15210 * Score File Format::        What a score file may contain.
15211 * Score File Editing::       You can edit score files by hand as well.
15212 * Adaptive Scoring::         Big Sister Gnus knows what you read.
15213 * Home Score File::          How to say where new score entries are to go.
15214 * Followups To Yourself::    Having Gnus notice when people answer you.
15215 * Scoring Tips::             How to score effectively.
15216 * Reverse Scoring::          That problem child of old is not problem.
15217 * Global Score Files::       Earth-spanning, ear-splitting score files.
15218 * Kill Files::               They are still here, but they can be ignored.
15219 * Converting Kill Files::    Translating kill files to score files.
15220 * GroupLens::                Getting predictions on what you like to read.
15221 * Advanced Scoring::         Using logical expressions to build score rules.
15222 * Score Decays::             It can be useful to let scores wither away.
15223 @end menu
15224
15225
15226 @node Summary Score Commands
15227 @section Summary Score Commands
15228 @cindex score commands
15229
15230 The score commands that alter score entries do not actually modify real
15231 score files.  That would be too inefficient.  Gnus maintains a cache of
15232 previously loaded score files, one of which is considered the
15233 @dfn{current score file alist}.  The score commands simply insert
15234 entries into this list, and upon group exit, this list is saved.
15235
15236 The current score file is by default the group's local score file, even
15237 if no such score file actually exists.  To insert score commands into
15238 some other score file (e.g. @file{all.SCORE}), you must first make this
15239 score file the current one.
15240
15241 General score commands that don't actually change the score file:
15242
15243 @table @kbd
15244
15245 @item V s
15246 @kindex V s (Summary)
15247 @findex gnus-summary-set-score
15248 Set the score of the current article (@code{gnus-summary-set-score}).
15249
15250 @item V S
15251 @kindex V S (Summary)
15252 @findex gnus-summary-current-score
15253 Display the score of the current article
15254 (@code{gnus-summary-current-score}).
15255
15256 @item V t
15257 @kindex V t (Summary)
15258 @findex gnus-score-find-trace
15259 Display all score rules that have been used on the current article
15260 (@code{gnus-score-find-trace}).
15261
15262 @item V R
15263 @kindex V R (Summary)
15264 @findex gnus-summary-rescore
15265 Run the current summary through the scoring process
15266 (@code{gnus-summary-rescore}).  This might be useful if you're playing
15267 around with your score files behind Gnus' back and want to see the
15268 effect you're having.
15269
15270 @item V c
15271 @kindex V c (Summary)
15272 @findex gnus-score-change-score-file
15273 Make a different score file the current
15274 (@code{gnus-score-change-score-file}).
15275
15276 @item V e
15277 @kindex V e (Summary)
15278 @findex gnus-score-edit-current-scores
15279 Edit the current score file (@code{gnus-score-edit-current-scores}).
15280 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
15281 File Editing}).
15282
15283 @item V f
15284 @kindex V f (Summary)
15285 @findex gnus-score-edit-file
15286 Edit a score file and make this score file the current one
15287 (@code{gnus-score-edit-file}).
15288
15289 @item V F
15290 @kindex V F (Summary)
15291 @findex gnus-score-flush-cache
15292 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
15293 after editing score files.
15294
15295 @item V C
15296 @kindex V C (Summary)
15297 @findex gnus-score-customize
15298 Customize a score file in a visually pleasing manner
15299 (@code{gnus-score-customize}).
15300
15301 @end table
15302
15303 The rest of these commands modify the local score file.
15304
15305 @table @kbd
15306
15307 @item V m
15308 @kindex V m (Summary)
15309 @findex gnus-score-set-mark-below
15310 Prompt for a score, and mark all articles with a score below this as
15311 read (@code{gnus-score-set-mark-below}).
15312
15313 @item V x
15314 @kindex V x (Summary)
15315 @findex gnus-score-set-expunge-below
15316 Prompt for a score, and add a score rule to the current score file to
15317 expunge all articles below this score
15318 (@code{gnus-score-set-expunge-below}).
15319 @end table
15320
15321 The keystrokes for actually making score entries follow a very regular
15322 pattern, so there's no need to list all the commands.  (Hundreds of
15323 them.)
15324
15325 @findex gnus-summary-increase-score
15326 @findex gnus-summary-lower-score
15327
15328 @enumerate
15329 @item
15330 The first key is either @kbd{I} (upper case i) for increasing the score
15331 or @kbd{L} for lowering the score.
15332 @item
15333 The second key says what header you want to score on.  The following
15334 keys are available:
15335 @table @kbd
15336
15337 @item a
15338 Score on the author name.
15339
15340 @item s
15341 Score on the subject line.
15342
15343 @item x
15344 Score on the @code{Xref} line---i.e., the cross-posting line.
15345
15346 @item r
15347 Score on the @code{References} line.
15348
15349 @item d
15350 Score on the date.
15351
15352 @item l
15353 Score on the number of lines.
15354
15355 @item i
15356 Score on the @code{Message-ID} header.
15357
15358 @item f
15359 Score on followups---this matches the author name, and adds scores to
15360 the followups to this author.
15361
15362 @item b
15363 Score on the body.
15364
15365 @item h
15366 Score on the head.
15367
15368 @item t
15369 Score on thread.
15370
15371 @end table
15372
15373 @item
15374 The third key is the match type.  Which match types are valid depends on
15375 what headers you are scoring on.
15376
15377 @table @code
15378
15379 @item strings
15380
15381 @table @kbd
15382
15383 @item e
15384 Exact matching.
15385
15386 @item s
15387 Substring matching.
15388
15389 @item f
15390 Fuzzy matching (@pxref{Fuzzy Matching}).
15391
15392 @item r
15393 Regexp matching
15394 @end table
15395
15396 @item date
15397 @table @kbd
15398
15399 @item b
15400 Before date.
15401
15402 @item a
15403 After date.
15404
15405 @item n
15406 This date.
15407 @end table
15408
15409 @item number
15410 @table @kbd
15411
15412 @item <
15413 Less than number.
15414
15415 @item =
15416 Equal to number.
15417
15418 @item >
15419 Greater than number.
15420 @end table
15421 @end table
15422
15423 @item
15424 The fourth and final key says whether this is a temporary (i.e., expiring)
15425 score entry, or a permanent (i.e., non-expiring) score entry, or whether
15426 it is to be done immediately, without adding to the score file.
15427 @table @kbd
15428
15429 @item t
15430 Temporary score entry.
15431
15432 @item p
15433 Permanent score entry.
15434
15435 @item i
15436 Immediately scoring.
15437 @end table
15438
15439 @end enumerate
15440
15441 So, let's say you want to increase the score on the current author with
15442 exact matching permanently: @kbd{I a e p}.  If you want to lower the
15443 score based on the subject line, using substring matching, and make a
15444 temporary score entry: @kbd{L s s t}.  Pretty easy.
15445
15446 To make things a bit more complicated, there are shortcuts.  If you use
15447 a capital letter on either the second or third keys, Gnus will use
15448 defaults for the remaining one or two keystrokes.  The defaults are
15449 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
15450 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
15451
15452 These functions take both the numerical prefix and the symbolic prefix
15453 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
15454 (or increase) the score of the article.  A symbolic prefix of @code{a}
15455 says to use the @file{all.SCORE} file for the command instead of the
15456 current score file.
15457
15458 @vindex gnus-score-mimic-keymap
15459 The @code{gnus-score-mimic-keymap} says whether these commands will
15460 pretend they are keymaps or not.
15461
15462
15463 @node Group Score Commands
15464 @section Group Score Commands
15465 @cindex group score commands
15466
15467 There aren't many of these as yet, I'm afraid.
15468
15469 @table @kbd
15470
15471 @item W f
15472 @kindex W f (Group)
15473 @findex gnus-score-flush-cache
15474 Gnus maintains a cache of score alists to avoid having to reload them
15475 all the time.  This command will flush the cache
15476 (@code{gnus-score-flush-cache}).
15477
15478 @end table
15479
15480 You can do scoring from the command line by saying something like:
15481
15482 @findex gnus-batch-score
15483 @cindex batch scoring
15484 @example
15485 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
15486 @end example
15487
15488
15489 @node Score Variables
15490 @section Score Variables
15491 @cindex score variables
15492
15493 @table @code
15494
15495 @item gnus-use-scoring
15496 @vindex gnus-use-scoring
15497 If @code{nil}, Gnus will not check for score files, and will not, in
15498 general, do any score-related work.  This is @code{t} by default.
15499
15500 @item gnus-kill-killed
15501 @vindex gnus-kill-killed
15502 If this variable is @code{nil}, Gnus will never apply score files to
15503 articles that have already been through the kill process.  While this
15504 may save you lots of time, it also means that if you apply a kill file
15505 to a group, and then change the kill file and want to run it over you
15506 group again to kill more articles, it won't work.  You have to set this
15507 variable to @code{t} to do that.  (It is @code{t} by default.)
15508
15509 @item gnus-kill-files-directory
15510 @vindex gnus-kill-files-directory
15511 All kill and score files will be stored in this directory, which is
15512 initialized from the @code{SAVEDIR} environment variable by default.
15513 This is @file{~/News/} by default.
15514
15515 @item gnus-score-file-suffix
15516 @vindex gnus-score-file-suffix
15517 Suffix to add to the group name to arrive at the score file name
15518 (@samp{SCORE} by default.)
15519
15520 @item gnus-score-uncacheable-files
15521 @vindex gnus-score-uncacheable-files
15522 @cindex score cache
15523 All score files are normally cached to avoid excessive re-loading of
15524 score files.  However, if this might make your Emacs grow big and
15525 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
15526 @file{all.SCORE}, while it might be a good idea to not cache
15527 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
15528 variable is @samp{ADAPT$} by default, so no adaptive score files will
15529 be cached.
15530
15531 @item gnus-save-score
15532 @vindex gnus-save-score
15533 If you have really complicated score files, and do lots of batch
15534 scoring, then you might set this variable to @code{t}.  This will make
15535 Gnus save the scores into the @file{.newsrc.eld} file.
15536
15537 If you do not set this to @code{t}, then manual scores (like those set
15538 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
15539 across group visits.
15540
15541 @item gnus-score-interactive-default-score
15542 @vindex gnus-score-interactive-default-score
15543 Score used by all the interactive raise/lower commands to raise/lower
15544 score with.  Default is 1000, which may seem excessive, but this is to
15545 ensure that the adaptive scoring scheme gets enough room to play with.
15546 We don't want the small changes from the adaptive scoring to overwrite
15547 manually entered data.
15548
15549 @item gnus-summary-default-score
15550 @vindex gnus-summary-default-score
15551 Default score of an article, which is 0 by default.
15552
15553 @item gnus-summary-expunge-below
15554 @vindex gnus-summary-expunge-below
15555 Don't display the summary lines of articles that have scores lower than
15556 this variable.  This is @code{nil} by default, which means that no
15557 articles will be hidden.  This variable is local to the summary buffers,
15558 and has to be set from @code{gnus-summary-mode-hook}.
15559
15560 @item gnus-score-over-mark
15561 @vindex gnus-score-over-mark
15562 Mark (in the third column) used for articles with a score over the
15563 default.  Default is @samp{+}.
15564
15565 @item gnus-score-below-mark
15566 @vindex gnus-score-below-mark
15567 Mark (in the third column) used for articles with a score below the
15568 default.  Default is @samp{-}.
15569
15570 @item gnus-score-find-score-files-function
15571 @vindex gnus-score-find-score-files-function
15572 Function used to find score files for the current group.  This function
15573 is called with the name of the group as the argument.
15574
15575 Predefined functions available are:
15576 @table @code
15577
15578 @item gnus-score-find-single
15579 @findex gnus-score-find-single
15580 Only apply the group's own score file.
15581
15582 @item gnus-score-find-bnews
15583 @findex gnus-score-find-bnews
15584 Apply all score files that match, using bnews syntax.  This is the
15585 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
15586 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
15587 @file{gnu.all.SCORE} would all apply.  In short, the instances of
15588 @samp{all} in the score file names are translated into @samp{.*}, and
15589 then a regexp match is done.
15590
15591 This means that if you have some score entries that you want to apply to
15592 all groups, then you put those entries in the @file{all.SCORE} file.
15593
15594 The score files are applied in a semi-random order, although Gnus will
15595 try to apply the more general score files before the more specific score
15596 files.  It does this by looking at the number of elements in the score
15597 file names---discarding the @samp{all} elements.
15598
15599 @item gnus-score-find-hierarchical
15600 @findex gnus-score-find-hierarchical
15601 Apply all score files from all the parent groups.  This means that you
15602 can't have score files like @file{all.SCORE}, but you can have
15603 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
15604 server.
15605
15606 @end table
15607 This variable can also be a list of functions.  In that case, all these
15608 functions will be called with the group name as argument, and all the
15609 returned lists of score files will be applied.  These functions can also
15610 return lists of score alists directly.  In that case, the functions that
15611 return these non-file score alists should probably be placed before the
15612 ``real'' score file functions, to ensure that the last score file
15613 returned is the local score file.  Phu.
15614
15615 For example, to do hierarchical scoring but use a non-server-specific
15616 overall score file, you could use the value
15617 @example
15618 (list (lambda (group) ("all.SCORE")) 'gnus-score-find-hierarchical)
15619 @end example
15620
15621 @item gnus-score-expiry-days
15622 @vindex gnus-score-expiry-days
15623 This variable says how many days should pass before an unused score file
15624 entry is expired.  If this variable is @code{nil}, no score file entries
15625 are expired.  It's 7 by default.
15626
15627 @item gnus-update-score-entry-dates
15628 @vindex gnus-update-score-entry-dates
15629 If this variable is non-@code{nil}, matching score entries will have
15630 their dates updated.  (This is how Gnus controls expiry---all
15631 non-matching entries will become too old while matching entries will
15632 stay fresh and young.)  However, if you set this variable to @code{nil},
15633 even matching entries will grow old and will have to face that oh-so
15634 grim reaper.
15635
15636 @item gnus-score-after-write-file-function
15637 @vindex gnus-score-after-write-file-function
15638 Function called with the name of the score file just written.
15639
15640 @item gnus-score-thread-simplify
15641 @vindex gnus-score-thread-simplify
15642 If this variable is non-@code{nil}, article subjects will be simplified
15643 for subject scoring purposes in the same manner as with
15644 threading---according to the current value of
15645 gnus-simplify-subject-functions.  If the scoring entry uses
15646 @code{substring} or @code{exact} matching, the match will also be
15647 simplified in this manner.
15648
15649 @end table
15650
15651
15652 @node Score File Format
15653 @section Score File Format
15654 @cindex score file format
15655
15656 A score file is an @code{emacs-lisp} file that normally contains just a
15657 single form.  Casual users are not expected to edit these files;
15658 everything can be changed from the summary buffer.
15659
15660 Anyway, if you'd like to dig into it yourself, here's an example:
15661
15662 @lisp
15663 (("from"
15664   ("Lars Ingebrigtsen" -10000)
15665   ("Per Abrahamsen")
15666   ("larsi\\|lmi" -50000 nil R))
15667  ("subject"
15668   ("Ding is Badd" nil 728373))
15669  ("xref"
15670   ("alt.politics" -1000 728372 s))
15671  ("lines"
15672   (2 -100 nil <))
15673  (mark 0)
15674  (expunge -1000)
15675  (mark-and-expunge -10)
15676  (read-only nil)
15677  (orphan -10)
15678  (adapt t)
15679  (files "/hom/larsi/News/gnu.SCORE")
15680  (exclude-files "all.SCORE")
15681  (local (gnus-newsgroup-auto-expire t)
15682         (gnus-summary-make-false-root empty))
15683  (eval (ding)))
15684 @end lisp
15685
15686 This example demonstrates most score file elements.  For a different
15687 approach, see @pxref{Advanced Scoring}.
15688
15689 Even though this looks much like lisp code, nothing here is actually
15690 @code{eval}ed.  The lisp reader is used to read this form, though, so it
15691 has to be valid syntactically, if not semantically.
15692
15693 Six keys are supported by this alist:
15694
15695 @table @code
15696
15697 @item STRING
15698 If the key is a string, it is the name of the header to perform the
15699 match on.  Scoring can only be performed on these eight headers:
15700 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
15701 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
15702 these headers, there are three strings to tell Gnus to fetch the entire
15703 article and do the match on larger parts of the article: @code{Body}
15704 will perform the match on the body of the article, @code{Head} will
15705 perform the match on the head of the article, and @code{All} will
15706 perform the match on the entire article.  Note that using any of these
15707 last three keys will slow down group entry @emph{considerably}.  The
15708 final ``header'' you can score on is @code{Followup}.  These score
15709 entries will result in new score entries being added for all follow-ups
15710 to articles that matches these score entries.
15711
15712 Following this key is a arbitrary number of score entries, where each
15713 score entry has one to four elements.
15714 @enumerate
15715
15716 @item
15717 The first element is the @dfn{match element}.  On most headers this will
15718 be a string, but on the Lines and Chars headers, this must be an
15719 integer.
15720
15721 @item
15722 If the second element is present, it should be a number---the @dfn{score
15723 element}.  This number should be an integer in the neginf to posinf
15724 interval.  This number is added to the score of the article if the match
15725 is successful.  If this element is not present, the
15726 @code{gnus-score-interactive-default-score} number will be used
15727 instead.  This is 1000 by default.
15728
15729 @item
15730 If the third element is present, it should be a number---the @dfn{date
15731 element}.  This date says when the last time this score entry matched,
15732 which provides a mechanism for expiring the score entries.  It this
15733 element is not present, the score entry is permanent.  The date is
15734 represented by the number of days since December 31, 1 BCE.
15735
15736 @item
15737 If the fourth element is present, it should be a symbol---the @dfn{type
15738 element}.  This element specifies what function should be used to see
15739 whether this score entry matches the article.  What match types that can
15740 be used depends on what header you wish to perform the match on.
15741 @table @dfn
15742
15743 @item From, Subject, References, Xref, Message-ID
15744 For most header types, there are the @code{r} and @code{R} (regexp), as
15745 well as @code{s} and @code{S} (substring) types, and @code{e} and
15746 @code{E} (exact match), and @code{w} (word match) types.  If this
15747 element is not present, Gnus will assume that substring matching should
15748 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
15749 that the matches will be done in a case-sensitive manner.  All these
15750 one-letter types are really just abbreviations for the @code{regexp},
15751 @code{string}, @code{exact}, and @code{word} types, which you can use
15752 instead, if you feel like.
15753
15754 @item Lines, Chars
15755 These two headers use different match types: @code{<}, @code{>},
15756 @code{=}, @code{>=} and @code{<=}.
15757
15758 These predicates are true if
15759
15760 @example
15761 (PREDICATE HEADER MATCH)
15762 @end example
15763
15764 evaluates to non-@code{nil}.  For instance, the advanced match
15765 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
15766 following form:
15767
15768 @lisp
15769 (< header-value 4)
15770 @end lisp
15771
15772 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
15773 the match, we get the score added if the article has less than 4 lines.
15774 (It's easy to get confused and think it's the other way around.  But
15775 it's not.  I think.)
15776
15777 When matching on @code{Lines}, be careful because some backends (like
15778 @code{nndir}) do not generate @code{Lines} header, so every article ends
15779 up being marked as having 0 lines.  This can lead to strange results if
15780 you happen to lower score of the articles with few lines.
15781
15782 @item Date
15783 For the Date header we have three kinda silly match types:
15784 @code{before}, @code{at} and @code{after}.  I can't really imagine this
15785 ever being useful, but, like, it would feel kinda silly not to provide
15786 this function.  Just in case.  You never know.  Better safe than sorry.
15787 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
15788 sex on a first date.  (I have been told that at least one person, and I
15789 quote, ``found this function indispensable'', however.)
15790
15791 @cindex ISO8601
15792 @cindex date
15793 A more useful match type is @code{regexp}.  With it, you can match the
15794 date string using a regular expression.  The date is normalized to
15795 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
15796 you want to match all articles that have been posted on April 1st in
15797 every year, you could use @samp{....0401.........} as a match string,
15798 for instance.  (Note that the date is kept in its original time zone, so
15799 this will match articles that were posted when it was April 1st where
15800 the article was posted from.  Time zones are such wholesome fun for the
15801 whole family, eh?)
15802
15803 @item Head, Body, All
15804 These three match keys use the same match types as the @code{From} (etc)
15805 header uses.
15806
15807 @item Followup
15808 This match key is somewhat special, in that it will match the
15809 @code{From} header, and affect the score of not only the matching
15810 articles, but also all followups to the matching articles.  This allows
15811 you e.g. increase the score of followups to your own articles, or
15812 decrease the score of followups to the articles of some known
15813 trouble-maker.  Uses the same match types as the @code{From} header
15814 uses.  (Using this match key will lead to creation of @file{ADAPT}
15815 files.)
15816
15817 @item Thread
15818 This match key works along the same lines as the @code{Followup} match
15819 key.  If you say that you want to score on a (sub-)thread started by an
15820 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
15821 match.  This will add a new @samp{thread} match for each article that
15822 has @var{x} in its @code{References} header.  (These new @samp{thread}
15823 matches will use the @code{Message-ID}s of these matching articles.)
15824 This will ensure that you can raise/lower the score of an entire thread,
15825 even though some articles in the thread may not have complete
15826 @code{References} headers.  Note that using this may lead to
15827 undeterministic scores of the articles in the thread.  (Using this match
15828 key will lead to creation of @file{ADAPT} files.)
15829 @end table
15830 @end enumerate
15831
15832 @cindex Score File Atoms
15833 @item mark
15834 The value of this entry should be a number.  Any articles with a score
15835 lower than this number will be marked as read.
15836
15837 @item expunge
15838 The value of this entry should be a number.  Any articles with a score
15839 lower than this number will be removed from the summary buffer.
15840
15841 @item mark-and-expunge
15842 The value of this entry should be a number.  Any articles with a score
15843 lower than this number will be marked as read and removed from the
15844 summary buffer.
15845
15846 @item thread-mark-and-expunge
15847 The value of this entry should be a number.  All articles that belong to
15848 a thread that has a total score below this number will be marked as read
15849 and removed from the summary buffer.  @code{gnus-thread-score-function}
15850 says how to compute the total score for a thread.
15851
15852 @item files
15853 The value of this entry should be any number of file names.  These files
15854 are assumed to be score files as well, and will be loaded the same way
15855 this one was.
15856
15857 @item exclude-files
15858 The clue of this entry should be any number of files.  These files will
15859 not be loaded, even though they would normally be so, for some reason or
15860 other.
15861
15862 @item eval
15863 The value of this entry will be @code{eval}el.  This element will be
15864 ignored when handling global score files.
15865
15866 @item read-only
15867 Read-only score files will not be updated or saved.  Global score files
15868 should feature this atom (@pxref{Global Score Files}).  (Note:
15869 @dfn{Global} here really means @dfn{global}; not your personal
15870 apply-to-all-groups score files.)
15871
15872 @item orphan
15873 The value of this entry should be a number.  Articles that do not have
15874 parents will get this number added to their scores.  Imagine you follow
15875 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
15876 will only follow a few of the threads, also want to see any new threads.
15877
15878 You can do this with the following two score file entries:
15879
15880 @example
15881         (orphan -500)
15882         (mark-and-expunge -100)
15883 @end example
15884
15885 When you enter the group the first time, you will only see the new
15886 threads.  You then raise the score of the threads that you find
15887 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
15888 rest.  Next time you enter the group, you will see new articles in the
15889 interesting threads, plus any new threads.
15890
15891 I.e.---the orphan score atom is for high-volume groups where there
15892 exist a few interesting threads which can't be found automatically by
15893 ordinary scoring rules.
15894
15895 @item adapt
15896 This entry controls the adaptive scoring.  If it is @code{t}, the
15897 default adaptive scoring rules will be used.  If it is @code{ignore}, no
15898 adaptive scoring will be performed on this group.  If it is a list, this
15899 list will be used as the adaptive scoring rules.  If it isn't present,
15900 or is something other than @code{t} or @code{ignore}, the default
15901 adaptive scoring rules will be used.  If you want to use adaptive
15902 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
15903 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
15904 not want adaptive scoring.  If you only want adaptive scoring in a few
15905 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
15906 insert @code{(adapt t)} in the score files of the groups where you want
15907 it.
15908
15909 @item adapt-file
15910 All adaptive score entries will go to the file named by this entry.  It
15911 will also be applied when entering the group.  This atom might be handy
15912 if you want to adapt on several groups at once, using the same adaptive
15913 file for a number of groups.
15914
15915 @item local
15916 @cindex local variables
15917 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
15918 Each @var{var} will be made buffer-local to the current summary buffer,
15919 and set to the value specified.  This is a convenient, if somewhat
15920 strange, way of setting variables in some groups if you don't like hooks
15921 much.  Note that the @var{value} won't be evaluated.
15922 @end table
15923
15924
15925 @node Score File Editing
15926 @section Score File Editing
15927
15928 You normally enter all scoring commands from the summary buffer, but you
15929 might feel the urge to edit them by hand as well, so we've supplied you
15930 with a mode for that.
15931
15932 It's simply a slightly customized @code{emacs-lisp} mode, with these
15933 additional commands:
15934
15935 @table @kbd
15936
15937 @item C-c C-c
15938 @kindex C-c C-c (Score)
15939 @findex gnus-score-edit-done
15940 Save the changes you have made and return to the summary buffer
15941 (@code{gnus-score-edit-done}).
15942
15943 @item C-c C-d
15944 @kindex C-c C-d (Score)
15945 @findex gnus-score-edit-insert-date
15946 Insert the current date in numerical format
15947 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
15948 you were wondering.
15949
15950 @item C-c C-p
15951 @kindex C-c C-p (Score)
15952 @findex gnus-score-pretty-print
15953 The adaptive score files are saved in an unformatted fashion.  If you
15954 intend to read one of these files, you want to @dfn{pretty print} it
15955 first.  This command (@code{gnus-score-pretty-print}) does that for
15956 you.
15957
15958 @end table
15959
15960 Type @kbd{M-x gnus-score-mode} to use this mode.
15961
15962 @vindex gnus-score-mode-hook
15963 @code{gnus-score-menu-hook} is run in score mode buffers.
15964
15965 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
15966 e} to begin editing score files.
15967
15968
15969 @node Adaptive Scoring
15970 @section Adaptive Scoring
15971 @cindex adaptive scoring
15972
15973 If all this scoring is getting you down, Gnus has a way of making it all
15974 happen automatically---as if by magic.  Or rather, as if by artificial
15975 stupidity, to be precise.
15976
15977 @vindex gnus-use-adaptive-scoring
15978 When you read an article, or mark an article as read, or kill an
15979 article, you leave marks behind.  On exit from the group, Gnus can sniff
15980 these marks and add score elements depending on what marks it finds.
15981 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
15982 @code{t} or @code{(line)}.  If you want score adaptively on separate
15983 words appearing in the subjects, you should set this variable to
15984 @code{(word)}.  If you want to use both adaptive methods, set this
15985 variable to @code{(word line)}.
15986
15987 @vindex gnus-default-adaptive-score-alist
15988 To give you complete control over the scoring process, you can customize
15989 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
15990 might look something like this:
15991
15992 @lisp
15993 (defvar gnus-default-adaptive-score-alist
15994   '((gnus-unread-mark)
15995     (gnus-ticked-mark (from 4))
15996     (gnus-dormant-mark (from 5))
15997     (gnus-del-mark (from -4) (subject -1))
15998     (gnus-read-mark (from 4) (subject 2))
15999     (gnus-expirable-mark (from -1) (subject -1))
16000     (gnus-killed-mark (from -1) (subject -3))
16001     (gnus-kill-file-mark)
16002     (gnus-ancient-mark)
16003     (gnus-low-score-mark)
16004     (gnus-catchup-mark (from -1) (subject -1))))
16005 @end lisp
16006
16007 As you see, each element in this alist has a mark as a key (either a
16008 variable name or a ``real'' mark---a character).  Following this key is
16009 a arbitrary number of header/score pairs.  If there are no header/score
16010 pairs following the key, no adaptive scoring will be done on articles
16011 that have that key as the article mark.  For instance, articles with
16012 @code{gnus-unread-mark} in the example above will not get adaptive score
16013 entries.
16014
16015 Each article can have only one mark, so just a single of these rules
16016 will be applied to each article.
16017
16018 To take @code{gnus-del-mark} as an example---this alist says that all
16019 articles that have that mark (i.e., are marked with @samp{D}) will have a
16020 score entry added to lower based on the @code{From} header by -4, and
16021 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
16022
16023 If you have marked 10 articles with the same subject with
16024 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
16025 That means that that subject will get a score of ten times -1, which
16026 should be, unless I'm much mistaken, -10.
16027
16028 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
16029 the read articles will be marked with the @samp{E} mark.  This'll
16030 probably make adaptive scoring slightly impossible, so auto-expiring and
16031 adaptive scoring doesn't really mix very well.
16032
16033 The headers you can score on are @code{from}, @code{subject},
16034 @code{message-id}, @code{references}, @code{xref}, @code{lines},
16035 @code{chars} and @code{date}.  In addition, you can score on
16036 @code{followup}, which will create an adaptive score entry that matches
16037 on the @code{References} header using the @code{Message-ID} of the
16038 current article, thereby matching the following thread.
16039
16040 You can also score on @code{thread}, which will try to score all
16041 articles that appear in a thread.  @code{thread} matches uses a
16042 @code{Message-ID} to match on the @code{References} header of the
16043 article.  If the match is made, the @code{Message-ID} of the article is
16044 added to the @code{thread} rule.  (Think about it.  I'd recommend two
16045 aspirins afterwards.)
16046
16047 If you use this scheme, you should set the score file atom @code{mark}
16048 to something small---like -300, perhaps, to avoid having small random
16049 changes result in articles getting marked as read.
16050
16051 After using adaptive scoring for a week or so, Gnus should start to
16052 become properly trained and enhance the authors you like best, and kill
16053 the authors you like least, without you having to say so explicitly.
16054
16055 You can control what groups the adaptive scoring is to be performed on
16056 by using the score files (@pxref{Score File Format}).  This will also
16057 let you use different rules in different groups.
16058
16059 @vindex gnus-adaptive-file-suffix
16060 The adaptive score entries will be put into a file where the name is the
16061 group name with @code{gnus-adaptive-file-suffix} appended.  The default
16062 is @samp{ADAPT}.
16063
16064 @vindex gnus-score-exact-adapt-limit
16065 When doing adaptive scoring, substring or fuzzy matching would probably
16066 give you the best results in most cases.  However, if the header one
16067 matches is short, the possibility for false positives is great, so if
16068 the length of the match is less than
16069 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
16070 this variable is @code{nil}, exact matching will always be used to avoid
16071 this problem.
16072
16073 @vindex gnus-default-adaptive-word-score-alist
16074 As mentioned above, you can adapt either on individual words or entire
16075 headers.  If you adapt on words, the
16076 @code{gnus-default-adaptive-word-score-alist} variable says what score
16077 each instance of a word should add given a mark.
16078
16079 @lisp
16080 (setq gnus-default-adaptive-word-score-alist
16081       `((,gnus-read-mark . 30)
16082         (,gnus-catchup-mark . -10)
16083         (,gnus-killed-mark . -20)
16084         (,gnus-del-mark . -15)))
16085 @end lisp
16086
16087 This is the default value.  If you have adaption on words enabled, every
16088 word that appears in subjects of articles marked with
16089 @code{gnus-read-mark} will result in a score rule that increase the
16090 score with 30 points.
16091
16092 @vindex gnus-default-ignored-adaptive-words
16093 @vindex gnus-ignored-adaptive-words
16094 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
16095 will be ignored.  If you wish to add more words to be ignored, use the
16096 @code{gnus-ignored-adaptive-words} list instead.
16097
16098 @vindex gnus-adaptive-word-syntax-table
16099 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
16100 syntax table in effect.  It is similar to the standard syntax table, but
16101 it considers numbers to be non-word-constituent characters.
16102
16103 @vindex gnus-adaptive-word-minimum
16104 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
16105 word scoring process will never bring down the score of an article to
16106 below this number.  The default is @code{nil}.
16107
16108 @vindex gnus-adaptive-word-no-group-words
16109 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
16110 won't adaptively word score any of the words in the group name.  Useful
16111 for groups like @samp{comp.editors.emacs}, where most of the subject
16112 lines contain the word @samp{emacs}.
16113
16114 After using this scheme for a while, it might be nice to write a
16115 @code{gnus-psychoanalyze-user} command to go through the rules and see
16116 what words you like and what words you don't like.  Or perhaps not.
16117
16118 Note that the adaptive word scoring thing is highly experimental and is
16119 likely to change in the future.  Initial impressions seem to indicate
16120 that it's totally useless as it stands.  Some more work (involving more
16121 rigorous statistical methods) will have to be done to make this useful.
16122
16123
16124 @node Home Score File
16125 @section Home Score File
16126
16127 The score file where new score file entries will go is called the
16128 @dfn{home score file}.  This is normally (and by default) the score file
16129 for the group itself.  For instance, the home score file for
16130 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
16131
16132 However, this may not be what you want.  It is often convenient to share
16133 a common home score file among many groups---all @samp{emacs} groups
16134 could perhaps use the same home score file.
16135
16136 @vindex gnus-home-score-file
16137 The variable that controls this is @code{gnus-home-score-file}.  It can
16138 be:
16139
16140 @enumerate
16141 @item
16142 A string.  Then this file will be used as the home score file for all
16143 groups.
16144
16145 @item
16146 A function.  The result of this function will be used as the home score
16147 file.  The function will be called with the name of the group as the
16148 parameter.
16149
16150 @item
16151 A list.  The elements in this list can be:
16152
16153 @enumerate
16154 @item
16155 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the
16156 group name, the @var{file-name} will will be used as the home score file.
16157
16158 @item
16159 A function.  If the function returns non-nil, the result will be used as
16160 the home score file.
16161
16162 @item
16163 A string.  Use the string as the home score file.
16164 @end enumerate
16165
16166 The list will be traversed from the beginning towards the end looking
16167 for matches.
16168
16169 @end enumerate
16170
16171 So, if you want to use just a single score file, you could say:
16172
16173 @lisp
16174 (setq gnus-home-score-file
16175       "my-total-score-file.SCORE")
16176 @end lisp
16177
16178 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
16179 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
16180
16181 @findex gnus-hierarchial-home-score-file
16182 @lisp
16183 (setq gnus-home-score-file
16184       'gnus-hierarchial-home-score-file)
16185 @end lisp
16186
16187 This is a ready-made function provided for your convenience.
16188 Other functions include
16189
16190 @table @code
16191 @item gnus-current-home-score-file
16192 @findex gnus-current-home-score-file
16193 Return the ``current'' regular score file.  This will make scoring
16194 commands add entry to the ``innermost'' matching score file.
16195
16196 @end table
16197
16198 If you want to have one score file for the @samp{emacs} groups and
16199 another for the @samp{comp} groups, while letting all other groups use
16200 their own home score files:
16201
16202 @lisp
16203 (setq gnus-home-score-file
16204       ;; All groups that match the regexp "\\.emacs"
16205       '(("\\.emacs" "emacs.SCORE")
16206         ;; All the comp groups in one score file
16207         ("^comp" "comp.SCORE")))
16208 @end lisp
16209
16210 @vindex gnus-home-adapt-file
16211 @code{gnus-home-adapt-file} works exactly the same way as
16212 @code{gnus-home-score-file}, but says what the home adaptive score file
16213 is instead.  All new adaptive file entries will go into the file
16214 specified by this variable, and the same syntax is allowed.
16215
16216 In addition to using @code{gnus-home-score-file} and
16217 @code{gnus-home-adapt-file}, you can also use group parameters
16218 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
16219 Parameters}) to achieve much the same.  Group and topic parameters take
16220 precedence over this variable.
16221
16222
16223 @node Followups To Yourself
16224 @section Followups To Yourself
16225
16226 Gnus offers two commands for picking out the @code{Message-ID} header in
16227 the current buffer.  Gnus will then add a score rule that scores using
16228 this @code{Message-ID} on the @code{References} header of other
16229 articles.  This will, in effect, increase the score of all articles that
16230 respond to the article in the current buffer.  Quite useful if you want
16231 to easily note when people answer what you've said.
16232
16233 @table @code
16234
16235 @item gnus-score-followup-article
16236 @findex gnus-score-followup-article
16237 This will add a score to articles that directly follow up your own
16238 article.
16239
16240 @item gnus-score-followup-thread
16241 @findex gnus-score-followup-thread
16242 This will add a score to all articles that appear in a thread ``below''
16243 your own article.
16244 @end table
16245
16246 @vindex message-sent-hook
16247 These two functions are both primarily meant to be used in hooks like
16248 @code{message-sent-hook}.
16249
16250 If you look closely at your own @code{Message-ID}, you'll notice that
16251 the first two or three characters are always the same.  Here's two of
16252 mine:
16253
16254 @example
16255 <x6u3u47icf.fsf@@eyesore.no>
16256 <x6sp9o7ibw.fsf@@eyesore.no>
16257 @end example
16258
16259 So ``my'' ident on this machine is @samp{x6}.  This can be
16260 exploited---the following rule will raise the score on all followups to
16261 myself:
16262
16263 @lisp
16264 ("references"
16265  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
16266   1000 nil r))
16267 @end lisp
16268
16269 Whether it's the first two or first three characters that are ``yours''
16270 is system-dependent.
16271
16272
16273 @node Scoring Tips
16274 @section Scoring Tips
16275 @cindex scoring tips
16276
16277 @table @dfn
16278
16279 @item Crossposts
16280 @cindex crossposts
16281 @cindex scoring crossposts
16282 If you want to lower the score of crossposts, the line to match on is
16283 the @code{Xref} header.
16284 @lisp
16285 ("xref" (" talk.politics.misc:" -1000))
16286 @end lisp
16287
16288 @item Multiple crossposts
16289 If you want to lower the score of articles that have been crossposted to
16290 more than, say, 3 groups:
16291 @lisp
16292 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
16293 @end lisp
16294
16295 @item Matching on the body
16296 This is generally not a very good idea---it takes a very long time.
16297 Gnus actually has to fetch each individual article from the server.  But
16298 you might want to anyway, I guess.  Even though there are three match
16299 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
16300 and stick with it in each score file.  If you use any two, each article
16301 will be fetched @emph{twice}.  If you want to match a bit on the
16302 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
16303 the matches.
16304
16305 @item Marking as read
16306 You will probably want to mark articles that have scores below a certain
16307 number as read.  This is most easily achieved by putting the following
16308 in your @file{all.SCORE} file:
16309 @lisp
16310 ((mark -100))
16311 @end lisp
16312 You may also consider doing something similar with @code{expunge}.
16313
16314 @item Negated character classes
16315 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
16316 That will match newlines, which might lead to, well, The Unknown.  Say
16317 @code{[^abcd\n]*} instead.
16318 @end table
16319
16320
16321 @node Reverse Scoring
16322 @section Reverse Scoring
16323 @cindex reverse scoring
16324
16325 If you want to keep just articles that have @samp{Sex with Emacs} in the
16326 subject header, and expunge all other articles, you could put something
16327 like this in your score file:
16328
16329 @lisp
16330 (("subject"
16331   ("Sex with Emacs" 2))
16332  (mark 1)
16333  (expunge 1))
16334 @end lisp
16335
16336 So, you raise all articles that match @samp{Sex with Emacs} and mark the
16337 rest as read, and expunge them to boot.
16338
16339
16340 @node Global Score Files
16341 @section Global Score Files
16342 @cindex global score files
16343
16344 Sure, other newsreaders have ``global kill files''.  These are usually
16345 nothing more than a single kill file that applies to all groups, stored
16346 in the user's home directory.  Bah!  Puny, weak newsreaders!
16347
16348 What I'm talking about here are Global Score Files.  Score files from
16349 all over the world, from users everywhere, uniting all nations in one
16350 big, happy score file union!  Ange-score!  New and untested!
16351
16352 @vindex gnus-global-score-files
16353 All you have to do to use other people's score files is to set the
16354 @code{gnus-global-score-files} variable.  One entry for each score file,
16355 or each score file directory.  Gnus will decide by itself what score
16356 files are applicable to which group.
16357
16358 Say you want to use the score file
16359 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
16360 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
16361
16362 @lisp
16363 (setq gnus-global-score-files
16364       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
16365         "/ftp@@ftp.some-where:/pub/score/"))
16366 @end lisp
16367
16368 @findex gnus-score-search-global-directories
16369 Simple, eh?  Directory names must end with a @samp{/}.  These
16370 directories are typically scanned only once during each Gnus session.
16371 If you feel the need to manually re-scan the remote directories, you can
16372 use the @code{gnus-score-search-global-directories} command.
16373
16374 Note that, at present, using this option will slow down group entry
16375 somewhat.  (That is---a lot.)
16376
16377 If you want to start maintaining score files for other people to use,
16378 just put your score file up for anonymous ftp and announce it to the
16379 world.  Become a retro-moderator!  Participate in the retro-moderator
16380 wars sure to ensue, where retro-moderators battle it out for the
16381 sympathy of the people, luring them to use their score files on false
16382 premises!  Yay!  The net is saved!
16383
16384 Here are some tips for the would-be retro-moderator, off the top of my
16385 head:
16386
16387 @itemize @bullet
16388
16389 @item
16390 Articles heavily crossposted are probably junk.
16391 @item
16392 To lower a single inappropriate article, lower by @code{Message-ID}.
16393 @item
16394 Particularly brilliant authors can be raised on a permanent basis.
16395 @item
16396 Authors that repeatedly post off-charter for the group can safely be
16397 lowered out of existence.
16398 @item
16399 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
16400 articles completely.
16401
16402 @item
16403 Use expiring score entries to keep the size of the file down.  You
16404 should probably have a long expiry period, though, as some sites keep
16405 old articles for a long time.
16406 @end itemize
16407
16408 ... I wonder whether other newsreaders will support global score files
16409 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
16410 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
16411 holding our breath yet?
16412
16413
16414 @node Kill Files
16415 @section Kill Files
16416 @cindex kill files
16417
16418 Gnus still supports those pesky old kill files.  In fact, the kill file
16419 entries can now be expiring, which is something I wrote before Daniel
16420 Quinlan thought of doing score files, so I've left the code in there.
16421
16422 In short, kill processing is a lot slower (and I do mean @emph{a lot})
16423 than score processing, so it might be a good idea to rewrite your kill
16424 files into score files.
16425
16426 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
16427 forms into this file, which means that you can use kill files as some
16428 sort of primitive hook function to be run on group entry, even though
16429 that isn't a very good idea.
16430
16431 Normal kill files look like this:
16432
16433 @lisp
16434 (gnus-kill "From" "Lars Ingebrigtsen")
16435 (gnus-kill "Subject" "ding")
16436 (gnus-expunge "X")
16437 @end lisp
16438
16439 This will mark every article written by me as read, and remove the
16440 marked articles from the summary buffer.  Very useful, you'll agree.
16441
16442 Other programs use a totally different kill file syntax.  If Gnus
16443 encounters what looks like a @code{rn} kill file, it will take a stab at
16444 interpreting it.
16445
16446 Two summary functions for editing a GNUS kill file:
16447
16448 @table @kbd
16449
16450 @item M-k
16451 @kindex M-k (Summary)
16452 @findex gnus-summary-edit-local-kill
16453 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
16454
16455 @item M-K
16456 @kindex M-K (Summary)
16457 @findex gnus-summary-edit-global-kill
16458 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
16459 @end table
16460
16461 Two group mode functions for editing the kill files:
16462
16463 @table @kbd
16464
16465 @item M-k
16466 @kindex M-k (Group)
16467 @findex gnus-group-edit-local-kill
16468 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
16469
16470 @item M-K
16471 @kindex M-K (Group)
16472 @findex gnus-group-edit-global-kill
16473 Edit the general kill file (@code{gnus-group-edit-global-kill}).
16474 @end table
16475
16476 Kill file variables:
16477
16478 @table @code
16479 @item gnus-kill-file-name
16480 @vindex gnus-kill-file-name
16481 A kill file for the group @samp{soc.motss} is normally called
16482 @file{soc.motss.KILL}.  The suffix appended to the group name to get
16483 this file name is detailed by the @code{gnus-kill-file-name} variable.
16484 The ``global'' kill file (not in the score file sense of ``global'', of
16485 course) is just called @file{KILL}.
16486
16487 @vindex gnus-kill-save-kill-file
16488 @item gnus-kill-save-kill-file
16489 If this variable is non-@code{nil}, Gnus will save the
16490 kill file after processing, which is necessary if you use expiring
16491 kills.
16492
16493 @item gnus-apply-kill-hook
16494 @vindex gnus-apply-kill-hook
16495 @findex gnus-apply-kill-file-unless-scored
16496 @findex gnus-apply-kill-file
16497 A hook called to apply kill files to a group.  It is
16498 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
16499 kill file if you have a score file for the same group, you can set this
16500 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
16501 kill files to be processed, you should set this variable to @code{nil}.
16502
16503 @item gnus-kill-file-mode-hook
16504 @vindex gnus-kill-file-mode-hook
16505 A hook called in kill-file mode buffers.
16506
16507 @end table
16508
16509
16510 @node Converting Kill Files
16511 @section Converting Kill Files
16512 @cindex kill files
16513 @cindex converting kill files
16514
16515 If you have loads of old kill files, you may want to convert them into
16516 score files.  If they are ``regular'', you can use
16517 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
16518 by hand.
16519
16520 The kill to score conversion package isn't included in Gnus by default.
16521 You can fetch it from
16522 @file{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
16523
16524 If your old kill files are very complex---if they contain more
16525 non-@code{gnus-kill} forms than not, you'll have to convert them by
16526 hand.  Or just let them be as they are.  Gnus will still use them as
16527 before.
16528
16529
16530 @node GroupLens
16531 @section GroupLens
16532 @cindex GroupLens
16533
16534 GroupLens is a collaborative filtering system that helps you work
16535 together with other people to find the quality news articles out of the
16536 huge volume of news articles generated every day.
16537
16538 To accomplish this the GroupLens system combines your opinions about
16539 articles you have already read with the opinions of others who have done
16540 likewise and gives you a personalized prediction for each unread news
16541 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
16542 rate articles, and finds other people that rate articles the same way.
16543 Once it has found some people you agree with it tells you, in the form
16544 of a prediction, what they thought of the article.  You can use this
16545 prediction to help you decide whether or not you want to read the
16546 article.
16547
16548 @menu
16549 * Using GroupLens::          How to make Gnus use GroupLens.
16550 * Rating Articles::          Letting GroupLens know how you rate articles.
16551 * Displaying Predictions::   Displaying predictions given by GroupLens.
16552 * GroupLens Variables::      Customizing GroupLens.
16553 @end menu
16554
16555
16556 @node Using GroupLens
16557 @subsection Using GroupLens
16558
16559 To use GroupLens you must register a pseudonym with your local Better
16560 Bit Bureau (BBB).
16561 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
16562 better bit in town at the moment.
16563
16564 Once you have registered you'll need to set a couple of variables.
16565
16566 @table @code
16567
16568 @item gnus-use-grouplens
16569 @vindex gnus-use-grouplens
16570 Setting this variable to a non-@code{nil} value will make Gnus hook into
16571 all the relevant GroupLens functions.
16572
16573 @item grouplens-pseudonym
16574 @vindex grouplens-pseudonym
16575 This variable should be set to the pseudonym you got when registering
16576 with the Better Bit Bureau.
16577
16578 @item grouplens-newsgroups
16579 @vindex grouplens-newsgroups
16580 A list of groups that you want to get GroupLens predictions for.
16581
16582 @end table
16583
16584 That's the minimum of what you need to get up and running with GroupLens.
16585 Once you've registered, GroupLens will start giving you scores for
16586 articles based on the average of what other people think.  But, to get
16587 the real benefit of GroupLens you need to start rating articles
16588 yourself.  Then the scores GroupLens gives you will be personalized for
16589 you, based on how the people you usually agree with have already rated.
16590
16591
16592 @node Rating Articles
16593 @subsection Rating Articles
16594
16595 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
16596 Where 1 means something like this article is a waste of bandwidth and 5
16597 means that the article was really good.  The basic question to ask
16598 yourself is, "on a scale from 1 to 5 would I like to see more articles
16599 like this one?"
16600
16601 There are four ways to enter a rating for an article in GroupLens.
16602
16603 @table @kbd
16604
16605 @item r
16606 @kindex r (GroupLens)
16607 @findex bbb-summary-rate-article
16608 This function will prompt you for a rating on a scale of one to five.
16609
16610 @item k
16611 @kindex k (GroupLens)
16612 @findex grouplens-score-thread
16613 This function will prompt you for a rating, and rate all the articles in
16614 the thread.  This is really useful for some of those long running giant
16615 threads in rec.humor.
16616
16617 @end table
16618
16619 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
16620 the score of the article you're reading.
16621
16622 @table @kbd
16623
16624 @item 1-5 n
16625 @kindex n (GroupLens)
16626 @findex grouplens-next-unread-article
16627 Rate the article and go to the next unread article.
16628
16629 @item 1-5 ,
16630 @kindex , (GroupLens)
16631 @findex grouplens-best-unread-article
16632 Rate the article and go to the next unread article with the highest score.
16633
16634 @end table
16635
16636 If you want to give the current article a score of 4 and then go to the
16637 next article, just type @kbd{4 n}.
16638
16639
16640 @node Displaying Predictions
16641 @subsection Displaying Predictions
16642
16643 GroupLens makes a prediction for you about how much you will like a
16644 news article.  The predictions from GroupLens are on a scale from 1 to
16645 5, where 1 is the worst and 5 is the best.  You can use the predictions
16646 from GroupLens in one of three ways controlled by the variable
16647 @code{gnus-grouplens-override-scoring}.
16648
16649 @vindex gnus-grouplens-override-scoring
16650 There are three ways to display predictions in grouplens.  You may
16651 choose to have the GroupLens scores contribute to, or override the
16652 regular gnus scoring mechanism.  override is the default; however, some
16653 people prefer to see the Gnus scores plus the grouplens scores.  To get
16654 the separate scoring behavior you need to set
16655 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
16656 GroupLens predictions combined with the grouplens scores set it to
16657 @code{'override} and to combine the scores set
16658 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
16659 the combine option you will also want to set the values for
16660 @code{grouplens-prediction-offset} and
16661 @code{grouplens-score-scale-factor}.
16662
16663 @vindex grouplens-prediction-display
16664 In either case, GroupLens gives you a few choices for how you would like
16665 to see your predictions displayed.  The display of predictions is
16666 controlled by the @code{grouplens-prediction-display} variable.
16667
16668 The following are valid values for that variable.
16669
16670 @table @code
16671 @item prediction-spot
16672 The higher the prediction, the further to the right an @samp{*} is
16673 displayed.
16674
16675 @item confidence-interval
16676 A numeric confidence interval.
16677
16678 @item prediction-bar
16679 The higher the prediction, the longer the bar.
16680
16681 @item confidence-bar
16682 Numerical confidence.
16683
16684 @item confidence-spot
16685 The spot gets bigger with more confidence.
16686
16687 @item prediction-num
16688 Plain-old numeric value.
16689
16690 @item confidence-plus-minus
16691 Prediction +/- confidence.
16692
16693 @end table
16694
16695
16696 @node GroupLens Variables
16697 @subsection GroupLens Variables
16698
16699 @table @code
16700
16701 @item gnus-summary-grouplens-line-format
16702 The summary line format used in GroupLens-enhanced summary buffers.  It
16703 accepts the same specs as the normal summary line format (@pxref{Summary
16704 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
16705 %s\n}.
16706
16707 @item grouplens-bbb-host
16708 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
16709 default.
16710
16711 @item grouplens-bbb-port
16712 Port of the host running the bbbd server.  The default is 9000.
16713
16714 @item grouplens-score-offset
16715 Offset the prediction by this value.  In other words, subtract the
16716 prediction value by this number to arrive at the effective score.  The
16717 default is 0.
16718
16719 @item grouplens-score-scale-factor
16720 This variable allows the user to magnify the effect of GroupLens scores.
16721 The scale factor is applied after the offset.  The default is 1.
16722
16723 @end table
16724
16725
16726 @node Advanced Scoring
16727 @section Advanced Scoring
16728
16729 Scoring on Subjects and From headers is nice enough, but what if you're
16730 really interested in what a person has to say only when she's talking
16731 about a particular subject?  Or what if you really don't want to
16732 read what person A has to say when she's following up to person B, but
16733 want to read what she says when she's following up to person C?
16734
16735 By using advanced scoring rules you may create arbitrarily complex
16736 scoring patterns.
16737
16738 @menu
16739 * Advanced Scoring Syntax::     A definition.
16740 * Advanced Scoring Examples::   What they look like.
16741 * Advanced Scoring Tips::       Getting the most out of it.
16742 @end menu
16743
16744
16745 @node Advanced Scoring Syntax
16746 @subsection Advanced Scoring Syntax
16747
16748 Ordinary scoring rules have a string as the first element in the rule.
16749 Advanced scoring rules have a list as the first element.  The second
16750 element is the score to be applied if the first element evaluated to a
16751 non-@code{nil} value.
16752
16753 These lists may consist of three logical operators, one redirection
16754 operator, and various match operators.
16755
16756 Logical operators:
16757
16758 @table @code
16759 @item &
16760 @itemx and
16761 This logical operator will evaluate each of its arguments until it finds
16762 one that evaluates to @code{false}, and then it'll stop.  If all arguments
16763 evaluate to @code{true} values, then this operator will return
16764 @code{true}.
16765
16766 @item |
16767 @itemx or
16768 This logical operator will evaluate each of its arguments until it finds
16769 one that evaluates to @code{true}.  If no arguments are @code{true},
16770 then this operator will return @code{false}.
16771
16772 @item !
16773 @itemx not
16774 @itemx Â¬
16775 This logical operator only takes a single argument.  It returns the
16776 logical negation of the value of its argument.
16777
16778 @end table
16779
16780 There is an @dfn{indirection operator} that will make its arguments
16781 apply to the ancestors of the current article being scored.  For
16782 instance, @code{1-} will make score rules apply to the parent of the
16783 current article.  @code{2-} will make score rules apply to the
16784 grandparent of the current article.  Alternatively, you can write
16785 @code{^^}, where the number of @code{^}s (carets) says how far back into
16786 the ancestry you want to go.
16787
16788 Finally, we have the match operators.  These are the ones that do the
16789 real work.  Match operators are header name strings followed by a match
16790 and a match type.  A typical match operator looks like @samp{("from"
16791 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
16792 simple scoring, and the match types are also the same.
16793
16794
16795 @node Advanced Scoring Examples
16796 @subsection Advanced Scoring Examples
16797
16798 Let's say you want to increase the score of articles written by Lars
16799 when he's talking about Gnus:
16800
16801 @example
16802 ((&
16803   ("from" "Lars Ingebrigtsen")
16804   ("subject" "Gnus"))
16805  1000)
16806 @end example
16807
16808 Quite simple, huh?
16809
16810 When he writes long articles, he sometimes has something nice to say:
16811
16812 @example
16813 ((&
16814   ("from" "Lars Ingebrigtsen")
16815   (|
16816    ("subject" "Gnus")
16817    ("lines" 100 >)))
16818  1000)
16819 @end example
16820
16821 However, when he responds to things written by Reig Eigil Logge, you
16822 really don't want to read what he's written:
16823
16824 @example
16825 ((&
16826   ("from" "Lars Ingebrigtsen")
16827   (1- ("from" "Reig Eigir Logge")))
16828  -100000)
16829 @end example
16830
16831 Everybody that follows up Redmondo when he writes about disappearing
16832 socks should have their scores raised, but only when they talk about
16833 white socks.  However, when Lars talks about socks, it's usually not
16834 very interesting:
16835
16836 @example
16837 ((&
16838   (1-
16839    (&
16840     ("from" "redmondo@@.*no" r)
16841     ("body" "disappearing.*socks" t)))
16842   (! ("from" "Lars Ingebrigtsen"))
16843   ("body" "white.*socks"))
16844  1000)
16845 @end example
16846
16847 The possibilities are endless.
16848
16849
16850 @node Advanced Scoring Tips
16851 @subsection Advanced Scoring Tips
16852
16853 The @code{&} and @code{|} logical operators do short-circuit logic.
16854 That is, they stop processing their arguments when it's clear what the
16855 result of the operation will be.  For instance, if one of the arguments
16856 of an @code{&} evaluates to @code{false}, there's no point in evaluating
16857 the rest of the arguments.  This means that you should put slow matches
16858 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
16859 @samp{subject}) first.
16860
16861 The indirection arguments (@code{1-} and so on) will make their
16862 arguments work on previous generations of the thread.  If you say
16863 something like:
16864
16865 @example
16866 ...
16867 (1-
16868  (1-
16869   ("from" "lars")))
16870 ...
16871 @end example
16872
16873 Then that means "score on the from header of the grandparent of the
16874 current article".  An indirection is quite fast, but it's better to say:
16875
16876 @example
16877 (1-
16878  (&
16879   ("from" "Lars")
16880   ("subject" "Gnus")))
16881 @end example
16882
16883 than it is to say:
16884
16885 @example
16886 (&
16887  (1- ("from" "Lars"))
16888  (1- ("subject" "Gnus")))
16889 @end example
16890
16891
16892 @node Score Decays
16893 @section Score Decays
16894 @cindex score decays
16895 @cindex decays
16896
16897 You may find that your scores have a tendency to grow without
16898 bounds, especially if you're using adaptive scoring.  If scores get too
16899 big, they lose all meaning---they simply max out and it's difficult to
16900 use them in any sensible way.
16901
16902 @vindex gnus-decay-scores
16903 @findex gnus-decay-score
16904 @vindex gnus-decay-score-function
16905 Gnus provides a mechanism for decaying scores to help with this problem.
16906 When score files are loaded and @code{gnus-decay-scores} is
16907 non-@code{nil}, Gnus will run the score files through the decaying
16908 mechanism thereby lowering the scores of all non-permanent score rules.
16909 The decay itself if performed by the @code{gnus-decay-score-function}
16910 function, which is @code{gnus-decay-score} by default.  Here's the
16911 definition of that function:
16912
16913 @lisp
16914 (defun gnus-decay-score (score)
16915   "Decay SCORE.
16916 This is done according to `gnus-score-decay-constant'
16917 and `gnus-score-decay-scale'."
16918   (floor
16919    (- score
16920       (* (if (< score 0) 1 -1)
16921          (min (abs score)
16922               (max gnus-score-decay-constant
16923                    (* (abs score)
16924                       gnus-score-decay-scale)))))))
16925 @end lisp
16926
16927 @vindex gnus-score-decay-scale
16928 @vindex gnus-score-decay-constant
16929 @code{gnus-score-decay-constant} is 3 by default and
16930 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
16931
16932 @enumerate
16933 @item
16934 Scores between -3 and 3 will be set to 0 when this function is called.
16935
16936 @item
16937 Scores with magnitudes between 3 and 60 will be shrunk by 3.
16938
16939 @item
16940 Scores with magnitudes greater than 60 will be shrunk by 5% of the
16941 score.
16942 @end enumerate
16943
16944 If you don't like this decay function, write your own.  It is called
16945 with the score to be decayed as its only parameter, and it should return
16946 the new score, which should be an integer.
16947
16948 Gnus will try to decay scores once a day.  If you haven't run Gnus for
16949 four days, Gnus will decay the scores four times, for instance.
16950
16951
16952 @node Various
16953 @chapter Various
16954
16955 @menu
16956 * Process/Prefix::             A convention used by many treatment commands.
16957 * Interactive::                Making Gnus ask you many questions.
16958 * Symbolic Prefixes::          How to supply some Gnus functions with options.
16959 * Formatting Variables::       You can specify what buffers should look like.
16960 * Windows Configuration::      Configuring the Gnus buffer windows.
16961 * Faces and Fonts::            How to change how faces look.
16962 * Compilation::                How to speed Gnus up.
16963 * Mode Lines::                 Displaying information in the mode lines.
16964 * Highlighting and Menus::     Making buffers look all nice and cozy.
16965 * Buttons::                    Get tendonitis in ten easy steps!
16966 * Daemons::                    Gnus can do things behind your back.
16967 * NoCeM::                      How to avoid spam and other fatty foods.
16968 * Undo::                       Some actions can be undone.
16969 * Moderation::                 What to do if you're a moderator.
16970 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
16971 * Fuzzy Matching::             What's the big fuzz?
16972 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
16973 * Various Various::            Things that are really various.
16974 @end menu
16975
16976
16977 @node Process/Prefix
16978 @section Process/Prefix
16979 @cindex process/prefix convention
16980
16981 Many functions, among them functions for moving, decoding and saving
16982 articles, use what is known as the @dfn{Process/Prefix convention}.
16983
16984 This is a method for figuring out what articles the user wants the
16985 command to be performed on.
16986
16987 It goes like this:
16988
16989 If the numeric prefix is N, perform the operation on the next N
16990 articles, starting with the current one.  If the numeric prefix is
16991 negative, perform the operation on the previous N articles, starting
16992 with the current one.
16993
16994 @vindex transient-mark-mode
16995 If @code{transient-mark-mode} in non-@code{nil} and the region is
16996 active, all articles in the region will be worked upon.
16997
16998 If there is no numeric prefix, but some articles are marked with the
16999 process mark, perform the operation on the articles marked with
17000 the process mark.
17001
17002 If there is neither a numeric prefix nor any articles marked with the
17003 process mark, just perform the operation on the current article.
17004
17005 Quite simple, really, but it needs to be made clear so that surprises
17006 are avoided.
17007
17008 Commands that react to the process mark will push the current list of
17009 process marked articles onto a stack and will then clear all process
17010 marked articles.  You can restore the previous configuration with the
17011 @kbd{M P y} command (@pxref{Setting Process Marks}).
17012
17013 @vindex gnus-summary-goto-unread
17014 One thing that seems to shock & horrify lots of people is that, for
17015 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
17016 Since each @kbd{d} (which marks the current article as read) by default
17017 goes to the next unread article after marking, this means that @kbd{3 d}
17018 will mark the next three unread articles as read, no matter what the
17019 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
17020 @code{nil} for a more straightforward action.
17021
17022 Many commands do not use the process/prefix convention.  All commands
17023 that do explicitly say so in this manual.  To apply the process/prefix
17024 convention to commands that do not use it, you can use the @kbd{M-&}
17025 command.  For instance, to mark all the articles in the group as
17026 expirable, you could say `M P b M-& E'.
17027
17028
17029 @node Interactive
17030 @section Interactive
17031 @cindex interaction
17032
17033 @table @code
17034
17035 @item gnus-novice-user
17036 @vindex gnus-novice-user
17037 If this variable is non-@code{nil}, you are either a newcomer to the
17038 World of Usenet, or you are very cautious, which is a nice thing to be,
17039 really.  You will be given questions of the type ``Are you sure you want
17040 to do this?'' before doing anything dangerous.  This is @code{t} by
17041 default.
17042
17043 @item gnus-expert-user
17044 @vindex gnus-expert-user
17045 If this variable is non-@code{nil}, you will seldom be asked any
17046 questions by Gnus.  It will simply assume you know what you're doing, no
17047 matter how strange.
17048
17049 @item gnus-interactive-catchup
17050 @vindex gnus-interactive-catchup
17051 Require confirmation before catching up a group if non-@code{nil}.  It
17052 is @code{t} by default.
17053
17054 @item gnus-interactive-exit
17055 @vindex gnus-interactive-exit
17056 Require confirmation before exiting Gnus.  This variable is @code{t} by
17057 default.
17058 @end table
17059
17060
17061 @node Symbolic Prefixes
17062 @section Symbolic Prefixes
17063 @cindex symbolic prefixes
17064
17065 Quite a lot of Emacs commands react to the (numeric) prefix.  For
17066 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
17067 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
17068 rule of 900 to the current article.
17069
17070 This is all nice and well, but what if you want to give a command some
17071 additional information?  Well, what most commands do is interpret the
17072 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
17073 doesn't want a backup file to be created when saving the current buffer,
17074 for instance.  But what if you want to save without making a backup
17075 file, and you want Emacs to flash lights and play a nice tune at the
17076 same time?  You can't, and you're probably perfectly happy that way.
17077
17078 @kindex M-i (Summary)
17079 @findex gnus-symbolic-argument
17080 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
17081 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
17082 character typed in is the value.  You can stack as many @kbd{M-i}
17083 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
17084 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
17085 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
17086 @code{b}''.  You get the drift.
17087
17088 Typing in symbolic prefixes to commands that don't accept them doesn't
17089 hurt, but it doesn't do any good either.  Currently not many Gnus
17090 functions make use of the symbolic prefix.
17091
17092 If you're interested in how Gnus implements this, @pxref{Extended
17093 Interactive}.
17094
17095
17096 @node Formatting Variables
17097 @section Formatting Variables
17098 @cindex formatting variables
17099
17100 Throughout this manual you've probably noticed lots of variables called
17101 things like @code{gnus-group-line-format} and
17102 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
17103 output lines in the various buffers.  There's quite a lot of them.
17104 Fortunately, they all use the same syntax, so there's not that much to
17105 be annoyed by.
17106
17107 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
17108 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
17109 lots of percentages everywhere.
17110
17111 @menu
17112 * Formatting Basics::     A formatting variable is basically a format string.
17113 * Mode Line Formatting::  Some rules about mode line formatting variables.
17114 * Advanced Formatting::   Modifying output in various ways.
17115 * User-Defined Specs::    Having Gnus call your own functions.
17116 * Formatting Fonts::      Making the formatting look colorful and nice.
17117 @end menu
17118
17119 Currently Gnus uses the following formatting variables:
17120 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
17121 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
17122 @code{gnus-group-mode-line-format},
17123 @code{gnus-summary-mode-line-format},
17124 @code{gnus-article-mode-line-format},
17125 @code{gnus-server-mode-line-format}, and
17126 @code{gnus-summary-pick-line-format}.
17127
17128 All these format variables can also be arbitrary elisp forms.  In that
17129 case, they will be @code{eval}ed to insert the required lines.
17130
17131 @kindex M-x gnus-update-format
17132 @findex gnus-update-format
17133 Gnus includes a command to help you while creating your own format
17134 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
17135 update the spec in question and pop you to a buffer where you can
17136 examine the resulting lisp code to be run to generate the line.
17137
17138
17139
17140 @node Formatting Basics
17141 @subsection Formatting Basics
17142
17143 Each @samp{%} element will be replaced by some string or other when the
17144 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
17145 spec, and pad with spaces to get a 5-character field''.
17146
17147 As with normal C and Emacs Lisp formatting strings, the numerical
17148 modifier between the @samp{%} and the formatting type character will
17149 @dfn{pad} the output so that it is always at least that long.
17150 @samp{%5y} will make the field always (at least) five characters wide by
17151 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
17152 the right instead.
17153
17154 You may also wish to limit the length of the field to protect against
17155 particularly wide values.  For that you can say @samp{%4,6y}, which
17156 means that the field will never be more than 6 characters wide and never
17157 less than 4 characters wide.
17158
17159
17160 @node Mode Line Formatting
17161 @subsection Mode Line Formatting
17162
17163 Mode line formatting variables (e.g.,
17164 @code{gnus-summary-mode-line-format}) follow the same rules as other,
17165 buffer line oriented formatting variables (@pxref{Formatting Basics})
17166 with the following two differences:
17167
17168 @enumerate
17169
17170 @item
17171 There must be no newline (@samp{\n}) at the end.
17172
17173 @item
17174 The special @samp{%%b} spec can be used to display the buffer name.
17175 Well, it's no spec at all, really---@samp{%%} is just a way to quote
17176 @samp{%} to allow it to pass through the formatting machinery unmangled,
17177 so that Emacs receives @samp{%b}, which is something the Emacs mode line
17178 display interprets to mean ``show the buffer name''.  For a full list of
17179 mode line specs Emacs understands, see the documentation of the
17180 @code{mode-line-format} variable.
17181
17182 @end enumerate
17183
17184
17185 @node Advanced Formatting
17186 @subsection Advanced Formatting
17187
17188 It is frequently useful to post-process the fields in some way.
17189 Padding, limiting, cutting off parts and suppressing certain values can
17190 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
17191 look like @samp{%~(cut 3)~(ignore "0")y}.
17192
17193 These are the valid modifiers:
17194
17195 @table @code
17196 @item pad
17197 @itemx pad-left
17198 Pad the field to the left with spaces until it reaches the required
17199 length.
17200
17201 @item pad-right
17202 Pad the field to the right with spaces until it reaches the required
17203 length.
17204
17205 @item max
17206 @itemx max-left
17207 Cut off characters from the left until it reaches the specified length.
17208
17209 @item max-right
17210 Cut off characters from the right until it reaches the specified
17211 length.
17212
17213 @item cut
17214 @itemx cut-left
17215 Cut off the specified number of characters from the left.
17216
17217 @item cut-right
17218 Cut off the specified number of characters from the right.
17219
17220 @item ignore
17221 Return an empty string if the field is equal to the specified value.
17222
17223 @item form
17224 Use the specified form as the field value when the @samp{@@} spec is
17225 used.
17226 @end table
17227
17228 Let's take an example.  The @samp{%o} spec in the summary mode lines
17229 will return a date in compact ISO8601 format---@samp{19960809T230410}.
17230 This is quite a mouthful, so we want to shave off the century number and
17231 the time, leaving us with a six-character date.  That would be
17232 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
17233 maxing, and we need the padding to ensure that the date is never less
17234 than 6 characters to make it look nice in columns.)
17235
17236 Ignoring is done first; then cutting; then maxing; and then as the very
17237 last operation, padding.
17238
17239 @vindex gnus-compile-user-specs
17240 If @code{gnus-compile-user-specs} is set to @code{nil} (@code{t} by
17241 default) with your strong personality, and use a lots of these advanced
17242 thingies, you'll find that Gnus gets quite slow.  This can be helped
17243 enormously by running @kbd{M-x gnus-compile} when you are satisfied with
17244 the look of your lines.
17245 @xref{Compilation}.
17246
17247
17248 @node User-Defined Specs
17249 @subsection User-Defined Specs
17250
17251 All the specs allow for inserting user defined specifiers---@samp{u}.
17252 The next character in the format string should be a letter.  Gnus
17253 will call the function @code{gnus-user-format-function-}@samp{X}, where
17254 @samp{X} is the letter following @samp{%u}.  The function will be passed
17255 a single parameter---what the parameter means depends on what buffer
17256 it's being called from.  The function should return a string, which will
17257 be inserted into the buffer just like information from any other
17258 specifier.  This function may also be called with dummy values, so it
17259 should protect against that.
17260
17261 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
17262 much the same without defining new functions.  Here's an example:
17263 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
17264 given here will be evaluated to yield the current line number, and then
17265 inserted.
17266
17267
17268 @node Formatting Fonts
17269 @subsection Formatting Fonts
17270
17271 There are specs for highlighting, and these are shared by all the format
17272 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
17273 the special @code{mouse-face} property set, which means that it will be
17274 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
17275 over it.
17276
17277 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
17278 normal faces set using @code{gnus-face-0}, which is @code{bold} by
17279 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
17280 and so on.  Create as many faces as you wish.  The same goes for the
17281 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
17282 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
17283
17284 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
17285 @code{balloon-help} property set to @code{gnus-balloon-face-0}.  If you
17286 say @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on.  The
17287 @code{gnus-balloon-face-*} variables should be either strings or symbols
17288 naming functions that return a string.  Under @code{balloon-help-mode},
17289 when the mouse passes over text with this property set, a balloon window
17290 will appear and display the string.  Please refer to the doc string of
17291 @code{balloon-help-mode} for more information on this.
17292
17293 Here's an alternative recipe for the group buffer:
17294
17295 @lisp
17296 ;; Create three face types.
17297 (setq gnus-face-1 'bold)
17298 (setq gnus-face-3 'italic)
17299
17300 ;; We want the article count to be in
17301 ;; a bold and green face.  So we create
17302 ;; a new face called `my-green-bold'.
17303 (copy-face 'bold 'my-green-bold)
17304 ;; Set the color.
17305 (set-face-foreground 'my-green-bold "ForestGreen")
17306 (setq gnus-face-2 'my-green-bold)
17307
17308 ;; Set the new & fancy format.
17309 (setq gnus-group-line-format
17310       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
17311 @end lisp
17312
17313 I'm sure you'll be able to use this scheme to create totally unreadable
17314 and extremely vulgar displays.  Have fun!
17315
17316 Note that the @samp{%(} specs (and friends) do not make any sense on the
17317 mode-line variables.
17318
17319
17320 @node Windows Configuration
17321 @section Windows Configuration
17322 @cindex windows configuration
17323
17324 No, there's nothing here about X, so be quiet.
17325
17326 @vindex gnus-use-full-window
17327 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
17328 other windows and occupy the entire Emacs screen by itself.  It is
17329 @code{t} by default.
17330
17331 Setting this variable to @code{nil} kinda works, but there are
17332 glitches.  Use at your own peril.
17333
17334 @vindex gnus-buffer-configuration
17335 @code{gnus-buffer-configuration} describes how much space each Gnus
17336 buffer should be given.  Here's an excerpt of this variable:
17337
17338 @lisp
17339 ((group (vertical 1.0 (group 1.0 point)
17340                       (if gnus-carpal (group-carpal 4))))
17341  (article (vertical 1.0 (summary 0.25 point)
17342                         (article 1.0))))
17343 @end lisp
17344
17345 This is an alist.  The @dfn{key} is a symbol that names some action or
17346 other.  For instance, when displaying the group buffer, the window
17347 configuration function will use @code{group} as the key.  A full list of
17348 possible names is listed below.
17349
17350 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
17351 should occupy.  To take the @code{article} split as an example -
17352
17353 @lisp
17354 (article (vertical 1.0 (summary 0.25 point)
17355                        (article 1.0)))
17356 @end lisp
17357
17358 This @dfn{split} says that the summary buffer should occupy 25% of upper
17359 half of the screen, and that it is placed over the article buffer.  As
17360 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
17361 reaching for that calculator there).  However, the special number
17362 @code{1.0} is used to signal that this buffer should soak up all the
17363 rest of the space available after the rest of the buffers have taken
17364 whatever they need.  There should be only one buffer with the @code{1.0}
17365 size spec per split.
17366
17367 Point will be put in the buffer that has the optional third element
17368 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
17369 split where the tag @code{frame-focus} is a member (i.e. is the third or
17370 fourth element in the list, depending on whether the @code{point} tag is
17371 present) gets focus.
17372
17373 Here's a more complicated example:
17374
17375 @lisp
17376 (article (vertical 1.0 (group 4)
17377                        (summary 0.25 point)
17378                        (if gnus-carpal (summary-carpal 4))
17379                        (article 1.0)))
17380 @end lisp
17381
17382 If the size spec is an integer instead of a floating point number,
17383 then that number will be used to say how many lines a buffer should
17384 occupy, not a percentage.
17385
17386 If the @dfn{split} looks like something that can be @code{eval}ed (to be
17387 precise---if the @code{car} of the split is a function or a subr), this
17388 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
17389 be used as a split.  This means that there will be three buffers if
17390 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
17391 is non-@code{nil}.
17392
17393 Not complicated enough for you?  Well, try this on for size:
17394
17395 @lisp
17396 (article (horizontal 1.0
17397              (vertical 0.5
17398                  (group 1.0)
17399                  (gnus-carpal 4))
17400              (vertical 1.0
17401                  (summary 0.25 point)
17402                  (summary-carpal 4)
17403                  (article 1.0))))
17404 @end lisp
17405
17406 Whoops.  Two buffers with the mystery 100% tag.  And what's that
17407 @code{horizontal} thingie?
17408
17409 If the first element in one of the split is @code{horizontal}, Gnus will
17410 split the window horizontally, giving you two windows side-by-side.
17411 Inside each of these strips you may carry on all you like in the normal
17412 fashion.  The number following @code{horizontal} says what percentage of
17413 the screen is to be given to this strip.
17414
17415 For each split, there @emph{must} be one element that has the 100% tag.
17416 The splitting is never accurate, and this buffer will eat any leftover
17417 lines from the splits.
17418
17419 To be slightly more formal, here's a definition of what a valid split
17420 may look like:
17421
17422 @example
17423 split       = frame | horizontal | vertical | buffer | form
17424 frame       = "(frame " size *split ")"
17425 horizontal  = "(horizontal " size *split ")"
17426 vertical    = "(vertical " size *split ")"
17427 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
17428 size        = number | frame-params
17429 buffer-name = group | article | summary ...
17430 @end example
17431
17432 The limitations are that the @code{frame} split can only appear as the
17433 top-level split.  @var{form} should be an Emacs Lisp form that should
17434 return a valid split.  We see that each split is fully recursive, and
17435 may contain any number of @code{vertical} and @code{horizontal} splits.
17436
17437 @vindex gnus-window-min-width
17438 @vindex gnus-window-min-height
17439 @cindex window height
17440 @cindex window width
17441 Finding the right sizes can be a bit complicated.  No window may be less
17442 than @code{gnus-window-min-height} (default 1) characters high, and all
17443 windows must be at least @code{gnus-window-min-width} (default 1)
17444 characters wide.  Gnus will try to enforce this before applying the
17445 splits.  If you want to use the normal Emacs window width/height limit,
17446 you can just set these two variables to @code{nil}.
17447
17448 If you're not familiar with Emacs terminology, @code{horizontal} and
17449 @code{vertical} splits may work the opposite way of what you'd expect.
17450 Windows inside a @code{horizontal} split are shown side-by-side, and
17451 windows within a @code{vertical} split are shown above each other.
17452
17453 @findex gnus-configure-frame
17454 If you want to experiment with window placement, a good tip is to call
17455 @code{gnus-configure-frame} directly with a split.  This is the function
17456 that does all the real work when splitting buffers.  Below is a pretty
17457 nonsensical configuration with 5 windows; two for the group buffer and
17458 three for the article buffer.  (I said it was nonsensical.)  If you
17459 @code{eval} the statement below, you can get an idea of how that would
17460 look straight away, without going through the normal Gnus channels.
17461 Play with it until you're satisfied, and then use
17462 @code{gnus-add-configuration} to add your new creation to the buffer
17463 configuration list.
17464
17465 @lisp
17466 (gnus-configure-frame
17467  '(horizontal 1.0
17468     (vertical 10
17469       (group 1.0)
17470       (article 0.3 point))
17471     (vertical 1.0
17472       (article 1.0)
17473       (horizontal 4
17474         (group 1.0)
17475         (article 10)))))
17476 @end lisp
17477
17478 You might want to have several frames as well.  No prob---just use the
17479 @code{frame} split:
17480
17481 @lisp
17482 (gnus-configure-frame
17483  '(frame 1.0
17484          (vertical 1.0
17485                    (summary 0.25 point frame-focus)
17486                    (article 1.0))
17487          (vertical ((height . 5) (width . 15)
17488                     (user-position . t)
17489                     (left . -1) (top . 1))
17490                    (picon 1.0))))
17491
17492 @end lisp
17493
17494 This split will result in the familiar summary/article window
17495 configuration in the first (or ``main'') frame, while a small additional
17496 frame will be created where picons will be shown.  As you can see,
17497 instead of the normal @code{1.0} top-level spec, each additional split
17498 should have a frame parameter alist as the size spec.
17499 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
17500 Reference Manual}.  Under XEmacs, a frame property list will be
17501 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
17502 is such a plist.
17503 The list of all possible keys for @code{gnus-buffer-configuration} can
17504 be found in its default value.
17505
17506 Note that the @code{message} key is used for both
17507 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
17508 it is desirable to distinguish between the two, something like this
17509 might be used:
17510
17511 @lisp
17512 (message (horizontal 1.0
17513                      (vertical 1.0 (message 1.0 point))
17514                      (vertical 0.24
17515                                (if (buffer-live-p gnus-summary-buffer)
17516                                    '(summary 0.5))
17517                                (group 1.0)))))
17518 @end lisp
17519
17520 One common desire for a multiple frame split is to have a separate frame
17521 for composing mail and news while leaving the original frame intact.  To
17522 accomplish that, something like the following can be done:
17523
17524 @lisp
17525 (message (frame 1.0
17526                 (if (not (buffer-live-p gnus-summary-buffer))
17527                     (car (cdr (assoc 'group gnus-buffer-configuration)))
17528                   (car (cdr (assoc 'summary gnus-buffer-configuration))))
17529                 (vertical ((user-position . t) (top . 1) (left . 1)
17530                            (name . "Message"))
17531                           (message 1.0 point))))
17532 @end lisp
17533
17534 @findex gnus-add-configuration
17535 Since the @code{gnus-buffer-configuration} variable is so long and
17536 complicated, there's a function you can use to ease changing the config
17537 of a single setting: @code{gnus-add-configuration}.  If, for instance,
17538 you want to change the @code{article} setting, you could say:
17539
17540 @lisp
17541 (gnus-add-configuration
17542  '(article (vertical 1.0
17543                (group 4)
17544                (summary .25 point)
17545                (article 1.0))))
17546 @end lisp
17547
17548 You'd typically stick these @code{gnus-add-configuration} calls in your
17549 @file{.gnus.el} file or in some startup hook---they should be run after
17550 Gnus has been loaded.
17551
17552 @vindex gnus-always-force-window-configuration
17553 If all windows mentioned in the configuration are already visible, Gnus
17554 won't change the window configuration.  If you always want to force the
17555 ``right'' window configuration, you can set
17556 @code{gnus-always-force-window-configuration} to non-@code{nil}.
17557
17558 If you're using tree displays (@pxref{Tree Display}), and the tree
17559 window is displayed vertically next to another window, you may also want
17560 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
17561 windows resized.
17562
17563 @subsection Example Window Configurations
17564
17565 @itemize @bullet
17566 @item 
17567 Narrow left hand side occupied by group buffer.  Right hand side split
17568 between summary buffer (top one-sixth) and article buffer (bottom).
17569
17570 @ifinfo
17571 @example
17572 +---+---------+
17573 | G | Summary |
17574 | r +---------+
17575 | o |         |
17576 | u | Article |
17577 | p |         |
17578 +---+---------+
17579 @end example
17580 @end ifinfo
17581
17582 @lisp
17583 (gnus-add-configuration
17584  '(article
17585    (horizontal 1.0
17586                (vertical 25 (group 1.0))
17587                (vertical 1.0
17588                          (summary 0.16 point)
17589                          (article 1.0)))))
17590
17591 (gnus-add-configuration
17592  '(summary
17593    (horizontal 1.0
17594                (vertical 25 (group 1.0))
17595                (vertical 1.0 (summary 1.0 point)))))
17596 @end lisp
17597
17598 @end itemize
17599
17600
17601 @node Faces and Fonts
17602 @section Faces and Fonts
17603 @cindex faces
17604 @cindex fonts
17605 @cindex colors
17606
17607 Fiddling with fonts and faces used to be very difficult, but these days
17608 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
17609 the face you want to alter, and alter it via the standard Customize
17610 interface.
17611
17612
17613 @node Compilation
17614 @section Compilation
17615 @cindex compilation
17616 @cindex byte-compilation
17617
17618 @findex gnus-compile
17619
17620 Remember all those line format specification variables?
17621 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
17622 on.  By default, T-gnus will use the byte-compiled codes of these
17623 variables and we can keep a slow-down to a minimum.  However, if you set
17624 @code{gnus-compile-user-specs} to @code{nil} (@code{t} by default),
17625 unfortunately, changing them will mean a quite significant slow-down.
17626 (The default values of these variables have byte-compiled functions
17627 associated with them, while the user-generated versions do not, of
17628 course.)
17629
17630 To help with this, you can run @kbd{M-x gnus-compile} after you've
17631 fiddled around with the variables and feel that you're (kind of)
17632 satisfied.  This will result in the new specs being byte-compiled, and
17633 you'll get top speed again.  Note that T-gnus will not save these
17634 compiled specs in the @file{.newsrc.eld} file.
17635
17636 @table @code
17637 @item gnus-compile-user-specs
17638 @vindex gnus-compile-user-specs
17639 If it is non-nil, the user-defined format specs will be byte-compiled
17640 automatically.  The default value of this variable is @code{t}.  It has
17641 an effect on the values of @code{gnus-*-line-format-spec}.
17642 @end table
17643
17644
17645 @node Mode Lines
17646 @section Mode Lines
17647 @cindex mode lines
17648
17649 @vindex gnus-updated-mode-lines
17650 @code{gnus-updated-mode-lines} says what buffers should keep their mode
17651 lines updated.  It is a list of symbols.  Supported symbols include
17652 @code{group}, @code{article}, @code{summary}, @code{server},
17653 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
17654 Gnus will keep that mode line updated with information that may be
17655 pertinent.  If this variable is @code{nil}, screen refresh may be
17656 quicker.
17657
17658 @cindex display-time
17659
17660 @vindex gnus-mode-non-string-length
17661 By default, Gnus displays information on the current article in the mode
17662 lines of the summary and article buffers.  The information Gnus wishes
17663 to display (e.g. the subject of the article) is often longer than the
17664 mode lines, and therefore have to be cut off at some point.  The
17665 @code{gnus-mode-non-string-length} variable says how long the other
17666 elements on the line is (i.e., the non-info part).  If you put
17667 additional elements on the mode line (e.g. a clock), you should modify
17668 this variable:
17669
17670 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
17671 @lisp
17672 (add-hook 'display-time-hook
17673           (lambda () (setq gnus-mode-non-string-length
17674                            (+ 21
17675                               (if line-number-mode 5 0)
17676                               (if column-number-mode 4 0)
17677                               (length display-time-string)))))
17678 @end lisp
17679
17680 If this variable is @code{nil} (which is the default), the mode line
17681 strings won't be chopped off, and they won't be padded either.  Note
17682 that the default is unlikely to be desirable, as even the percentage
17683 complete in the buffer may be crowded off the mode line; the user should
17684 configure this variable appropriately for her configuration.
17685
17686
17687 @node Highlighting and Menus
17688 @section Highlighting and Menus
17689 @cindex visual
17690 @cindex highlighting
17691 @cindex menus
17692
17693 @vindex gnus-visual
17694 The @code{gnus-visual} variable controls most of the Gnus-prettifying
17695 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
17696 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
17697 file.
17698
17699 This variable can be a list of visual properties that are enabled.  The
17700 following elements are valid, and are all included by default:
17701
17702 @table @code
17703 @item group-highlight
17704 Do highlights in the group buffer.
17705 @item summary-highlight
17706 Do highlights in the summary buffer.
17707 @item article-highlight
17708 Do highlights in the article buffer.
17709 @item highlight
17710 Turn on highlighting in all buffers.
17711 @item group-menu
17712 Create menus in the group buffer.
17713 @item summary-menu
17714 Create menus in the summary buffers.
17715 @item article-menu
17716 Create menus in the article buffer.
17717 @item browse-menu
17718 Create menus in the browse buffer.
17719 @item server-menu
17720 Create menus in the server buffer.
17721 @item score-menu
17722 Create menus in the score buffers.
17723 @item menu
17724 Create menus in all buffers.
17725 @end table
17726
17727 So if you only want highlighting in the article buffer and menus in all
17728 buffers, you could say something like:
17729
17730 @lisp
17731 (setq gnus-visual '(article-highlight menu))
17732 @end lisp
17733
17734 If you want highlighting only and no menus whatsoever, you'd say:
17735
17736 @lisp
17737 (setq gnus-visual '(highlight))
17738 @end lisp
17739
17740 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
17741 in all Gnus buffers.
17742
17743 Other general variables that influence the look of all buffers include:
17744
17745 @table @code
17746 @item gnus-mouse-face
17747 @vindex gnus-mouse-face
17748 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
17749 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
17750
17751 @end table
17752
17753 There are hooks associated with the creation of all the different menus:
17754
17755 @table @code
17756
17757 @item gnus-article-menu-hook
17758 @vindex gnus-article-menu-hook
17759 Hook called after creating the article mode menu.
17760
17761 @item gnus-group-menu-hook
17762 @vindex gnus-group-menu-hook
17763 Hook called after creating the group mode menu.
17764
17765 @item gnus-summary-menu-hook
17766 @vindex gnus-summary-menu-hook
17767 Hook called after creating the summary mode menu.
17768
17769 @item gnus-server-menu-hook
17770 @vindex gnus-server-menu-hook
17771 Hook called after creating the server mode menu.
17772
17773 @item gnus-browse-menu-hook
17774 @vindex gnus-browse-menu-hook
17775 Hook called after creating the browse mode menu.
17776
17777 @item gnus-score-menu-hook
17778 @vindex gnus-score-menu-hook
17779 Hook called after creating the score mode menu.
17780
17781 @end table
17782
17783
17784 @node Buttons
17785 @section Buttons
17786 @cindex buttons
17787 @cindex mouse
17788 @cindex click
17789
17790 Those new-fangled @dfn{mouse} contraptions is very popular with the
17791 young, hep kids who don't want to learn the proper way to do things
17792 these days.  Why, I remember way back in the summer of '89, when I was
17793 using Emacs on a Tops 20 system.  Three hundred users on one single
17794 machine, and every user was running Simula compilers.  Bah!
17795
17796 Right.
17797
17798 @vindex gnus-carpal
17799 Well, you can make Gnus display bufferfuls of buttons you can click to
17800 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
17801 really.  Tell the chiropractor I sent you.
17802
17803
17804 @table @code
17805
17806 @item gnus-carpal-mode-hook
17807 @vindex gnus-carpal-mode-hook
17808 Hook run in all carpal mode buffers.
17809
17810 @item gnus-carpal-button-face
17811 @vindex gnus-carpal-button-face
17812 Face used on buttons.
17813
17814 @item gnus-carpal-header-face
17815 @vindex gnus-carpal-header-face
17816 Face used on carpal buffer headers.
17817
17818 @item gnus-carpal-group-buffer-buttons
17819 @vindex gnus-carpal-group-buffer-buttons
17820 Buttons in the group buffer.
17821
17822 @item gnus-carpal-summary-buffer-buttons
17823 @vindex gnus-carpal-summary-buffer-buttons
17824 Buttons in the summary buffer.
17825
17826 @item gnus-carpal-server-buffer-buttons
17827 @vindex gnus-carpal-server-buffer-buttons
17828 Buttons in the server buffer.
17829
17830 @item gnus-carpal-browse-buffer-buttons
17831 @vindex gnus-carpal-browse-buffer-buttons
17832 Buttons in the browse buffer.
17833 @end table
17834
17835 All the @code{buttons} variables are lists.  The elements in these list
17836 are either cons cells where the @code{car} contains a text to be displayed and
17837 the @code{cdr} contains a function symbol, or a simple string.
17838
17839
17840 @node Daemons
17841 @section Daemons
17842 @cindex demons
17843 @cindex daemons
17844
17845 Gnus, being larger than any program ever written (allegedly), does lots
17846 of strange stuff that you may wish to have done while you're not
17847 present.  For instance, you may want it to check for new mail once in a
17848 while.  Or you may want it to close down all connections to all servers
17849 when you leave Emacs idle.  And stuff like that.
17850
17851 Gnus will let you do stuff like that by defining various
17852 @dfn{handlers}.  Each handler consists of three elements:  A
17853 @var{function}, a @var{time}, and an @var{idle} parameter.
17854
17855 Here's an example of a handler that closes connections when Emacs has
17856 been idle for thirty minutes:
17857
17858 @lisp
17859 (gnus-demon-close-connections nil 30)
17860 @end lisp
17861
17862 Here's a handler that scans for PGP headers every hour when Emacs is
17863 idle:
17864
17865 @lisp
17866 (gnus-demon-scan-pgp 60 t)
17867 @end lisp
17868
17869 This @var{time} parameter and than @var{idle} parameter work together
17870 in a strange, but wonderful fashion.  Basically, if @var{idle} is
17871 @code{nil}, then the function will be called every @var{time} minutes.
17872
17873 If @var{idle} is @code{t}, then the function will be called after
17874 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
17875 the function will never be called.  But once Emacs goes idle, the
17876 function will be called every @var{time} minutes.
17877
17878 If @var{idle} is a number and @var{time} is a number, the function will
17879 be called every @var{time} minutes only when Emacs has been idle for
17880 @var{idle} minutes.
17881
17882 If @var{idle} is a number and @var{time} is @code{nil}, the function
17883 will be called once every time Emacs has been idle for @var{idle}
17884 minutes.
17885
17886 And if @var{time} is a string, it should look like @samp{07:31}, and
17887 the function will then be called once every day somewhere near that
17888 time.  Modified by the @var{idle} parameter, of course.
17889
17890 @vindex gnus-demon-timestep
17891 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
17892 seconds.  This is 60 by default.  If you change that variable,
17893 all the timings in the handlers will be affected.)
17894
17895 So, if you want to add a handler, you could put something like this in
17896 your @file{.gnus} file:
17897
17898 @findex gnus-demon-add-handler
17899 @lisp
17900 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
17901 @end lisp
17902
17903 @findex gnus-demon-add-nocem
17904 @findex gnus-demon-add-scanmail
17905 @findex gnus-demon-add-rescan
17906 @findex gnus-demon-add-scan-timestamps
17907 @findex gnus-demon-add-disconnection
17908 Some ready-made functions to do this have been created:
17909 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
17910 @code{gnus-demon-add-nntp-close-connection},
17911 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
17912 @code{gnus-demon-add-scanmail}.  Just put those functions in your
17913 @file{.gnus} if you want those abilities.
17914
17915 @findex gnus-demon-init
17916 @findex gnus-demon-cancel
17917 @vindex gnus-demon-handlers
17918 If you add handlers to @code{gnus-demon-handlers} directly, you should
17919 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
17920 daemons, you can use the @code{gnus-demon-cancel} function.
17921
17922 Note that adding daemons can be pretty naughty if you over do it.  Adding
17923 functions that scan all news and mail from all servers every two seconds
17924 is a sure-fire way of getting booted off any respectable system.  So
17925 behave.
17926
17927
17928 @node NoCeM
17929 @section NoCeM
17930 @cindex nocem
17931 @cindex spam
17932
17933 @dfn{Spamming} is posting the same article lots and lots of times.
17934 Spamming is bad.  Spamming is evil.
17935
17936 Spamming is usually canceled within a day or so by various anti-spamming
17937 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
17938 NoCeM is pronounced ``no see-'em'', and means what the name
17939 implies---these are messages that make the offending articles, like, go
17940 away.
17941
17942 What use are these NoCeM messages if the articles are canceled anyway?
17943 Some sites do not honor cancel messages and some sites just honor cancels
17944 from a select few people.  Then you may wish to make use of the NoCeM
17945 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
17946
17947 Gnus can read and parse the messages in this group automatically, and
17948 this will make spam disappear.
17949
17950 There are some variables to customize, of course:
17951
17952 @table @code
17953 @item gnus-use-nocem
17954 @vindex gnus-use-nocem
17955 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
17956 by default.
17957
17958 @item gnus-nocem-groups
17959 @vindex gnus-nocem-groups
17960 Gnus will look for NoCeM messages in the groups in this list.  The
17961 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
17962 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
17963
17964 @item gnus-nocem-issuers
17965 @vindex gnus-nocem-issuers
17966 There are many people issuing NoCeM messages.  This list says what
17967 people you want to listen to.  The default is @code{("Automoose-1"
17968 "clewis@@ferret.ocunix.on.ca" "cosmo.roadkill" "SpamHippo"
17969 "hweede@@snafu.de")}; fine, upstanding citizens all of them.
17970
17971 Known despammers that you can put in this list are listed at
17972 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
17973
17974 You do not have to heed NoCeM messages from all these people---just the
17975 ones you want to listen to.  You also don't have to accept all NoCeM
17976 messages from the people you like.  Each NoCeM message has a @dfn{type}
17977 header that gives the message a (more or less, usually less) rigorous
17978 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
17979 @samp{binary}, and @samp{troll}.  To specify this, you have to use
17980 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
17981 Each condition is either a string (which is a regexp that matches types
17982 you want to use) or a list on the form @code{(not @var{string})}, where
17983 @var{string} is a regexp that matches types you don't want to use.
17984
17985 For instance, if you want all NoCeM messages from Chris Lewis except his
17986 @samp{troll} messages, you'd say:
17987
17988 @lisp
17989 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
17990 @end lisp
17991
17992 On the other hand, if you just want nothing but his @samp{spam} and
17993 @samp{spew} messages, you'd say:
17994
17995 @lisp
17996 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
17997 @end lisp
17998
17999 The specs are applied left-to-right.
18000
18001
18002 @item gnus-nocem-verifyer
18003 @vindex gnus-nocem-verifyer
18004 @findex mc-verify
18005 This should be a function for verifying that the NoCeM issuer is who she
18006 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
18007 function.  If this is too slow and you don't care for verification
18008 (which may be dangerous), you can set this variable to @code{nil}.
18009
18010 If you want signed NoCeM messages to be verified and unsigned messages
18011 not to be verified (but used anyway), you could do something like:
18012
18013 @lisp
18014 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
18015
18016 (defun my-gnus-mc-verify ()
18017   (not (eq 'forged
18018            (ignore-errors
18019              (if (mc-verify)
18020                  t
18021                'forged)))))
18022 @end lisp
18023
18024 This might be dangerous, though.
18025
18026 @item gnus-nocem-directory
18027 @vindex gnus-nocem-directory
18028 This is where Gnus will store its NoCeM cache files.  The default is
18029 @file{~/News/NoCeM/}.
18030
18031 @item gnus-nocem-expiry-wait
18032 @vindex gnus-nocem-expiry-wait
18033 The number of days before removing old NoCeM entries from the cache.
18034 The default is 15.  If you make it shorter Gnus will be faster, but you
18035 might then see old spam.
18036
18037 @item gnus-nocem-check-from
18038 @vindex gnus-nocem-check-from
18039 Non-@code{nil} means check for valid issuers in message bodies.
18040 Otherwise don't bother fetching articles unless their author matches a
18041 valid issuer; that is much faster if you are selective about the
18042 issuers.
18043
18044 @item gnus-nocem-check-article-limit
18045 @vindex gnus-nocem-check-article-limit
18046 If non-@code{nil}, the maximum number of articles to check in any NoCeM
18047 group.  NoCeM groups can be huge and very slow to process.
18048
18049 @end table
18050
18051 Using NoCeM could potentially be a memory hog.  If you have many living
18052 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
18053 big.  If this is a problem, you should kill off all (or most) of your
18054 unsubscribed groups (@pxref{Subscription Commands}).
18055
18056
18057 @node Undo
18058 @section Undo
18059 @cindex undo
18060
18061 It is very useful to be able to undo actions one has done.  In normal
18062 Emacs buffers, it's easy enough---you just push the @code{undo} button.
18063 In Gnus buffers, however, it isn't that simple.
18064
18065 The things Gnus displays in its buffer is of no value whatsoever to
18066 Gnus---it's all just data designed to look nice to the user.
18067 Killing a group in the group buffer with @kbd{C-k} makes the line
18068 disappear, but that's just a side-effect of the real action---the
18069 removal of the group in question from the internal Gnus structures.
18070 Undoing something like that can't be done by the normal Emacs
18071 @code{undo} function.
18072
18073 Gnus tries to remedy this somewhat by keeping track of what the user
18074 does and coming up with actions that would reverse the actions the user
18075 takes.  When the user then presses the @code{undo} key, Gnus will run
18076 the code to reverse the previous action, or the previous actions.
18077 However, not all actions are easily reversible, so Gnus currently offers
18078 a few key functions to be undoable.  These include killing groups,
18079 yanking groups, and changing the list of read articles of groups.
18080 That's it, really.  More functions may be added in the future, but each
18081 added function means an increase in data to be stored, so Gnus will
18082 never be totally undoable.
18083
18084 @findex gnus-undo-mode
18085 @vindex gnus-use-undo
18086 @findex gnus-undo
18087 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
18088 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
18089 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
18090 command, which should feel kinda like the normal Emacs @code{undo}
18091 command.
18092
18093
18094 @node Moderation
18095 @section Moderation
18096 @cindex moderation
18097
18098 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
18099 It is not included in the standard Gnus package.  Write a mail to
18100 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
18101 get a copy.
18102
18103 The moderation package is implemented as a minor mode for summary
18104 buffers.  Put
18105
18106 @lisp
18107 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
18108 @end lisp
18109
18110 in your @file{.gnus.el} file.
18111
18112 If you are the moderator of @samp{rec.zoofle}, this is how it's
18113 supposed to work:
18114
18115 @enumerate
18116 @item
18117 You split your incoming mail by matching on
18118 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
18119 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
18120
18121 @item
18122 You enter that group once in a while and post articles using the @kbd{e}
18123 (edit-and-post) or @kbd{s} (just send unedited) commands.
18124
18125 @item
18126 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
18127 articles that weren't approved by you, you can cancel them with the
18128 @kbd{c} command.
18129 @end enumerate
18130
18131 To use moderation mode in these two groups, say:
18132
18133 @lisp
18134 (setq gnus-moderated-list
18135       "^nnml:rec.zoofle$\\|^rec.zoofle$")
18136 @end lisp
18137
18138
18139 @node XEmacs Enhancements
18140 @section XEmacs Enhancements
18141 @cindex XEmacs
18142
18143 XEmacs is able to display pictures and stuff, so Gnus has taken
18144 advantage of that.
18145
18146 @menu
18147 * Picons::    How to display pictures of what your reading.
18148 * Smileys::   Show all those happy faces the way they were meant to be shown.
18149 * Toolbar::   Click'n'drool.
18150 * XVarious::  Other XEmacsy Gnusey variables.
18151 @end menu
18152
18153
18154 @node Picons
18155 @subsection Picons
18156
18157 @iftex
18158 @iflatex
18159 \include{picons}
18160 @end iflatex
18161 @end iftex
18162
18163 So...  You want to slow down your news reader even more!  This is a
18164 good way to do so.  Its also a great way to impress people staring
18165 over your shoulder as you read news.
18166
18167 @menu
18168 * Picon Basics::           What are picons and How do I get them.
18169 * Picon Requirements::     Don't go further if you aren't using XEmacs.
18170 * Easy Picons::            Displaying Picons---the easy way.
18171 * Hard Picons::            The way you should do it.  You'll learn something.
18172 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
18173 @end menu
18174
18175
18176 @node Picon Basics
18177 @subsubsection Picon Basics
18178
18179 What are Picons?  To quote directly from the Picons Web site:
18180
18181 @iftex
18182 @iflatex
18183 \margindex{}
18184 @end iflatex
18185 @end iftex
18186
18187 @quotation
18188 @dfn{Picons} is short for ``personal icons''.  They're small,
18189 constrained images used to represent users and domains on the net,
18190 organized into databases so that the appropriate image for a given
18191 e-mail address can be found.  Besides users and domains, there are picon
18192 databases for Usenet newsgroups and weather forecasts.  The picons are
18193 in either monochrome @code{XBM} format or color @code{XPM} and
18194 @code{GIF} formats.
18195 @end quotation
18196
18197 @vindex gnus-picons-piconsearch-url
18198 If you have a permanent connection to the Internet you can use Steve
18199 Kinzler's Picons Search engine by setting
18200 @code{gnus-picons-piconsearch-url} to the string @*
18201 @file{http://www.cs.indiana.edu/picons/search.html}.
18202
18203 @vindex gnus-picons-database
18204 Otherwise you need a local copy of his database.  For instructions on
18205 obtaining and installing the picons databases, point your Web browser at @*
18206 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
18207 picons to be installed into a location pointed to by
18208 @code{gnus-picons-database}.
18209
18210
18211 @node Picon Requirements
18212 @subsubsection Picon Requirements
18213
18214 To have Gnus display Picons for you, you must be running XEmacs
18215 19.13 or greater since all other versions of Emacs aren't yet able to
18216 display images.
18217
18218 Additionally, you must have @code{x} support compiled into XEmacs.  To
18219 display color picons which are much nicer than the black & white one,
18220 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
18221
18222 @vindex gnus-picons-convert-x-face
18223 If you want to display faces from @code{X-Face} headers, you should have
18224 the @code{xface} support compiled into XEmacs.  Otherwise you must have
18225 the @code{netpbm} utilities installed, or munge the
18226 @code{gnus-picons-convert-x-face} variable to use something else.
18227
18228
18229 @node Easy Picons
18230 @subsubsection Easy Picons
18231
18232 To enable displaying picons, simply put the following line in your
18233 @file{~/.gnus} file and start Gnus.
18234
18235 @lisp
18236 (setq gnus-use-picons t)
18237 (setq gnus-treat-display-picons t)
18238 @end lisp
18239
18240 and make sure @code{gnus-picons-database} points to the directory
18241 containing the Picons databases.
18242
18243 Alternatively if you want to use the web piconsearch engine add this:
18244
18245 @lisp
18246 (setq gnus-picons-piconsearch-url
18247       "http://www.cs.indiana.edu:800/piconsearch")
18248 @end lisp
18249
18250
18251 @node Hard Picons
18252 @subsubsection Hard Picons
18253
18254 @iftex
18255 @iflatex
18256 \margindex{}
18257 @end iflatex
18258 @end iftex
18259
18260 Gnus can display picons for you as you enter and leave groups and
18261 articles.  It knows how to interact with three sections of the picons
18262 database.  Namely, it can display the picons newsgroup pictures,
18263 author's face picture(s), and the authors domain.  To enable this
18264 feature, you need to select where to get the picons from, and where to
18265 display them.
18266
18267 @table @code
18268
18269 @item gnus-picons-database
18270 @vindex gnus-picons-database
18271 The location of the picons database.  Should point to a directory
18272 containing the @file{news}, @file{domains}, @file{users} (and so on)
18273 subdirectories.  This is only useful if
18274 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
18275 @file{/usr/local/faces/}.
18276
18277 @item gnus-picons-piconsearch-url
18278 @vindex gnus-picons-piconsearch-url
18279 The URL for the web picons search engine.  The only currently known
18280 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
18281 workaround network delays, icons will be fetched in the background.  If
18282 this is @code{nil} 'the default), then picons are fetched from local
18283 database indicated by @code{gnus-picons-database}.
18284
18285 @item gnus-picons-display-where
18286 @vindex gnus-picons-display-where
18287 Where the picon images should be displayed.  It is @code{picons} by
18288 default (which by default maps to the buffer @samp{*Picons*}).  Other
18289 valid places could be @code{article}, @code{summary}, or
18290 @samp{*scratch*} for all I care.  Just make sure that you've made the
18291 buffer visible using the standard Gnus window configuration
18292 routines---@pxref{Windows Configuration}.
18293
18294 @item gnus-picons-group-excluded-groups
18295 @vindex gnus-picons-group-excluded-groups
18296 Groups that are matched by this regexp won't have their group icons
18297 displayed.
18298
18299 @end table
18300
18301 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
18302 window configuration for you to include the @code{picons} buffer.
18303
18304 Now that you've made those decision, you need to add the following
18305 functions to the appropriate hooks so these pictures will get displayed
18306 at the right time.
18307
18308 @vindex gnus-picons-display-where
18309 @table @code
18310 @item gnus-article-display-picons
18311 @findex gnus-article-display-picons
18312 Looks up and displays the picons for the author and the author's domain
18313 in the @code{gnus-picons-display-where} buffer.
18314
18315 @item gnus-picons-article-display-x-face
18316 @findex gnus-article-display-picons
18317 Decodes and displays the X-Face header if present.
18318
18319 @end table
18320
18321
18322
18323 @node Picon Useless Configuration
18324 @subsubsection Picon Useless Configuration
18325
18326 @iftex
18327 @iflatex
18328 \margindex{}
18329 @end iflatex
18330 @end iftex
18331
18332 The following variables offer further control over how things are
18333 done, where things are located, and other useless stuff you really
18334 don't need to worry about.
18335
18336 @table @code
18337
18338 @item gnus-picons-news-directories
18339 @vindex gnus-picons-news-directories
18340 List of subdirectories to search in @code{gnus-picons-database} for
18341 newsgroups faces.  @code{("news")} is the default.
18342
18343 @item gnus-picons-user-directories
18344 @vindex gnus-picons-user-directories
18345 List of subdirectories to search in @code{gnus-picons-database} for user
18346 faces.  @code{("local" "users" "usenix" "misc")} is the default.
18347
18348 @item gnus-picons-domain-directories
18349 @vindex gnus-picons-domain-directories
18350 List of subdirectories to search in @code{gnus-picons-database} for
18351 domain name faces.  Defaults to @code{("domains")}.  Some people may
18352 want to add @samp{"unknown"} to this list.
18353
18354 @item gnus-picons-convert-x-face
18355 @vindex gnus-picons-convert-x-face
18356 If you don't have @code{xface} support builtin XEmacs, this is the
18357 command to use to convert the @code{X-Face} header to an X bitmap
18358 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
18359 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
18360 gnus-picons-x-face-file-name)}
18361
18362 @item gnus-picons-x-face-file-name
18363 @vindex gnus-picons-x-face-file-name
18364 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
18365 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
18366
18367 @item gnus-picons-has-modeline-p
18368 @vindex gnus-picons-has-modeline-p
18369 If you have set @code{gnus-picons-display-where} to @code{picons}, your
18370 XEmacs frame will become really cluttered.  To alleviate this a bit you
18371 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
18372 remove the mode line from the Picons buffer.  This is only useful if
18373 @code{gnus-picons-display-where} is @code{picons}.
18374
18375 @item gnus-picons-refresh-before-display
18376 @vindex gnus-picons-refresh-before-display
18377 If non-nil, display the article buffer before computing the picons.
18378 Defaults to @code{nil}.
18379
18380 @item gnus-picons-display-as-address
18381 @vindex gnus-picons-display-as-address
18382 If @code{t} display textual email addresses along with pictures.
18383 Defaults to @code{t}.
18384
18385 @item gnus-picons-file-suffixes
18386 @vindex gnus-picons-file-suffixes
18387 Ordered list of suffixes on picon file names to try.  Defaults to
18388 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
18389
18390 @item gnus-picons-setup-hook
18391 @vindex gnus-picons-setup-hook
18392 Hook run in the picon buffer, if that is displayed.
18393
18394 @item gnus-picons-display-article-move-p
18395 @vindex gnus-picons-display-article-move-p
18396 Whether to move point to first empty line when displaying picons.  This
18397 has only an effect if `gnus-picons-display-where' has value `article'.
18398
18399 If @code{nil}, display the picons in the @code{From} and
18400 @code{Newsgroups} lines.  This is the defailt.
18401
18402 @item gnus-picons-clear-cache-on-shutdown
18403 @vindex gnus-picons-clear-cache-on-shutdown
18404 Whether to clear the picons cache when exiting gnus.  Gnus caches every
18405 picons it finds while it is running.  This saves some time in the search
18406 process but eats some memory.  If this variable is set to @code{nil},
18407 Gnus will never clear the cache itself; you will have to manually call
18408 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
18409 cleared every time you exit Gnus.  Defaults to @code{t}.
18410
18411 @iftex
18412 @iflatex
18413 \margindex{}
18414 @end iflatex
18415 @end iftex
18416
18417 @end table
18418
18419 @node Smileys
18420 @subsection Smileys
18421 @cindex smileys
18422
18423 @iftex
18424 @iflatex
18425 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
18426 \input{smiley}
18427 @end iflatex
18428 @end iftex
18429
18430 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
18431 currently the only package that uses Smiley, it is documented here.
18432
18433 In short---to use Smiley in Gnus, put the following in your
18434 @file{.gnus.el} file:
18435
18436 @lisp
18437 (setq gnus-treat-display-smileys t)
18438 @end lisp
18439
18440 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
18441 the like---to pictures and displays those instead of the text smiley
18442 faces.  The conversion is controlled by a list of regexps that matches
18443 text and maps that to file names.
18444
18445 @vindex smiley-nosey-regexp-alist
18446 @vindex smiley-deformed-regexp-alist
18447 Smiley supplies two example conversion alists by default:
18448 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
18449 and so on), and @code{smiley-nosey-regexp-alist} (which matches
18450 @samp{:-)}, @samp{:-(} and so on).
18451
18452 The alist used is specified by the @code{smiley-regexp-alist} variable,
18453 which defaults to the value of @code{smiley-deformed-regexp-alist}.
18454
18455 The first item in each element is the regexp to be matched; the second
18456 element is the regexp match group that is to be replaced by the picture;
18457 and the third element is the name of the file to be displayed.
18458
18459 The following variables customize where Smiley will look for these
18460 files, as well as the color to be used and stuff:
18461
18462 @table @code
18463
18464 @item smiley-data-directory
18465 @vindex smiley-data-directory
18466 Where Smiley will look for smiley faces files.
18467
18468 @item smiley-flesh-color
18469 @vindex smiley-flesh-color
18470 Skin color.  The default is @samp{yellow}, which is really racist.
18471
18472 @item smiley-features-color
18473 @vindex smiley-features-color
18474 Color of the features of the face.  The default is @samp{black}.
18475
18476 @item smiley-tongue-color
18477 @vindex smiley-tongue-color
18478 Color of the tongue.  The default is @samp{red}.
18479
18480 @item smiley-circle-color
18481 @vindex smiley-circle-color
18482 Color of the circle around the face.  The default is @samp{black}.
18483
18484 @item smiley-mouse-face
18485 @vindex smiley-mouse-face
18486 Face used for mouse highlighting over the smiley face.
18487
18488 @end table
18489
18490
18491 @node Toolbar
18492 @subsection Toolbar
18493
18494 @table @code
18495
18496 @iftex
18497 @iflatex
18498 \margindex{}
18499 @end iflatex
18500 @end iftex
18501
18502 @item gnus-use-toolbar
18503 @vindex gnus-use-toolbar
18504 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
18505 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
18506 @code{right-toolbar}, or @code{left-toolbar}.
18507
18508 @item gnus-group-toolbar
18509 @vindex gnus-group-toolbar
18510 The toolbar in the group buffer.
18511
18512 @item gnus-summary-toolbar
18513 @vindex gnus-summary-toolbar
18514 The toolbar in the summary buffer.
18515
18516 @item gnus-summary-mail-toolbar
18517 @vindex gnus-summary-mail-toolbar
18518 The toolbar in the summary buffer of mail groups.
18519
18520 @end table
18521
18522
18523 @node XVarious
18524 @subsection Various XEmacs Variables
18525
18526 @table @code
18527 @item gnus-xmas-glyph-directory
18528 @vindex gnus-xmas-glyph-directory
18529 This is where Gnus will look for pictures.  Gnus will normally
18530 auto-detect this directory, but you may set it manually if you have an
18531 unusual directory structure.
18532
18533 @item gnus-xmas-logo-color-alist
18534 @vindex gnus-xmas-logo-color-alist
18535 This is an alist where the key is a type symbol and the values are the
18536 foreground and background color of the splash page glyph.
18537
18538 @item gnus-xmas-logo-color-style
18539 @vindex gnus-xmas-logo-color-style
18540 This is the key used to look up the color in the alist described above.
18541 Valid values include @code{flame}, @code{pine}, @code{moss},
18542 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
18543 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
18544
18545 @item gnus-xmas-modeline-glyph
18546 @vindex gnus-xmas-modeline-glyph
18547 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
18548 default.
18549
18550 @iftex
18551 @iflatex
18552 \margindex{}
18553 @end iflatex
18554 @end iftex
18555
18556 @end table
18557
18558
18559
18560
18561 @node Fuzzy Matching
18562 @section Fuzzy Matching
18563 @cindex fuzzy matching
18564
18565 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
18566 things like scoring, thread gathering and thread comparison.
18567
18568 As opposed to regular expression matching, fuzzy matching is very fuzzy.
18569 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
18570 means, and the implementation has changed over time.
18571
18572 Basically, it tries to remove all noise from lines before comparing.
18573 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
18574 out of the strings before comparing the results.  This often leads to
18575 adequate results---even when faced with strings generated by text
18576 manglers masquerading as newsreaders.
18577
18578
18579 @node Thwarting Email Spam
18580 @section Thwarting Email Spam
18581 @cindex email spam
18582 @cindex spam
18583 @cindex UCE
18584 @cindex unsolicited commercial email
18585
18586 In these last days of the Usenet, commercial vultures are hanging about
18587 and grepping through news like crazy to find email addresses they can
18588 foist off their scams and products to.  As a reaction to this, many
18589 people have started putting nonsense addresses into their @code{From}
18590 lines.  I think this is counterproductive---it makes it difficult for
18591 people to send you legitimate mail in response to things you write, as
18592 well as making it difficult to see who wrote what.  This rewriting may
18593 perhaps be a bigger menace than the unsolicited commercial email itself
18594 in the end.
18595
18596 The biggest problem I have with email spam is that it comes in under
18597 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
18598 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
18599 mail group, only to find two pyramid schemes, seven advertisements
18600 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
18601 and one mail asking me to repent and find some god.
18602
18603 This is annoying.
18604
18605 The way to deal with this is having Gnus split out all spam into a
18606 @samp{spam} mail group (@pxref{Splitting Mail}).
18607
18608 First, pick one (1) valid mail address that you can be reached at, and
18609 put it in your @code{From} header of all your news articles.  (I've
18610 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
18611 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
18612 sysadm whether your sendmail installation accepts keywords in the local
18613 part of the mail address.)
18614
18615 @lisp
18616 (setq message-default-news-headers
18617       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
18618 @end lisp
18619
18620 Then put the following split rule in @code{nnmail-split-fancy}
18621 (@pxref{Fancy Mail Splitting}):
18622
18623 @lisp
18624 (
18625  ...
18626  (to "larsi@@trym.ifi.uio.no"
18627       (| ("subject" "re:.*" "misc")
18628          ("references" ".*@@.*" "misc")
18629          "spam"))
18630  ...
18631 )
18632 @end lisp
18633
18634 This says that all mail to this address is suspect, but if it has a
18635 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
18636 header, it's probably ok.  All the rest goes to the @samp{spam} group.
18637 (This idea probably comes from Tim Pierce.)
18638
18639 In addition, many mail spammers talk directly to your @code{smtp} server
18640 and do not include your email address explicitly in the @code{To}
18641 header.  Why they do this is unknown---perhaps it's to thwart this
18642 thwarting scheme?  In any case, this is trivial to deal with---you just
18643 put anything not addressed to you in the @samp{spam} group by ending
18644 your fancy split rule in this way:
18645
18646 @lisp
18647 (
18648  ...
18649  (to "larsi" "misc")
18650  "spam")
18651 @end lisp
18652
18653 In my experience, this will sort virtually everything into the right
18654 group.  You still have to check the @samp{spam} group from time to time to
18655 check for legitimate mail, though.  If you feel like being a good net
18656 citizen, you can even send off complaints to the proper authorities on
18657 each unsolicited commercial email---at your leisure.
18658
18659 If you are also a lazy net citizen, you will probably prefer complaining
18660 automatically with the @file{gnus-junk.el} package, available FOR FREE
18661 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
18662 Since most e-mail spam is sent automatically, this may reconcile the
18663 cosmic balance somewhat.
18664
18665 This works for me.  It allows people an easy way to contact me (they can
18666 just press @kbd{r} in the usual way), and I'm not bothered at all with
18667 spam.  It's a win-win situation.  Forging @code{From} headers to point
18668 to non-existent domains is yucky, in my opinion.
18669
18670
18671 @node Various Various
18672 @section Various Various
18673 @cindex mode lines
18674 @cindex highlights
18675
18676 @table @code
18677
18678 @item gnus-home-directory
18679 All Gnus path variables will be initialized from this variable, which
18680 defaults to @file{~/}.
18681
18682 @item gnus-directory
18683 @vindex gnus-directory
18684 Most Gnus storage path variables will be initialized from this variable,
18685 which defaults to the @samp{SAVEDIR} environment variable, or
18686 @file{~/News/} if that variable isn't set.
18687
18688 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
18689 This means that other directory variables that are initialized from this
18690 variable won't be set properly if you set this variable in
18691 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
18692
18693 @item gnus-default-directory
18694 @vindex gnus-default-directory
18695 Not related to the above variable at all---this variable says what the
18696 default directory of all Gnus buffers should be.  If you issue commands
18697 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
18698 default directory.  If this variable is @code{nil} (which is the
18699 default), the default directory will be the default directory of the
18700 buffer you were in when you started Gnus.
18701
18702 @item gnus-verbose
18703 @vindex gnus-verbose
18704 This variable is an integer between zero and ten.  The higher the value,
18705 the more messages will be displayed.  If this variable is zero, Gnus
18706 will never flash any messages, if it is seven (which is the default),
18707 most important messages will be shown, and if it is ten, Gnus won't ever
18708 shut up, but will flash so many messages it will make your head swim.
18709
18710 @item gnus-verbose-backends
18711 @vindex gnus-verbose-backends
18712 This variable works the same way as @code{gnus-verbose}, but it applies
18713 to the Gnus backends instead of Gnus proper.
18714
18715 @item nnheader-max-head-length
18716 @vindex nnheader-max-head-length
18717 When the backends read straight heads of articles, they all try to read
18718 as little as possible.  This variable (default 4096) specifies
18719 the absolute max length the backends will try to read before giving up
18720 on finding a separator line between the head and the body.  If this
18721 variable is @code{nil}, there is no upper read bound.  If it is
18722 @code{t}, the backends won't try to read the articles piece by piece,
18723 but read the entire articles.  This makes sense with some versions of
18724 @code{ange-ftp} or @code{efs}.
18725
18726 @item nnheader-head-chop-length
18727 @vindex nnheader-head-chop-length
18728 This variable (default 2048) says how big a piece of each article to
18729 read when doing the operation described above.
18730
18731 @item nnheader-file-name-translation-alist
18732 @vindex nnheader-file-name-translation-alist
18733 @cindex file names
18734 @cindex invalid characters in file names
18735 @cindex characters in file names
18736 This is an alist that says how to translate characters in file names.
18737 For instance, if @samp{:} is invalid as a file character in file names
18738 on your system (you OS/2 user you), you could say something like:
18739
18740 @lisp
18741 (setq nnheader-file-name-translation-alist
18742       '((?: . ?_)))
18743 @end lisp
18744
18745 In fact, this is the default value for this variable on OS/2 and MS
18746 Windows (phooey) systems.
18747
18748 @item gnus-hidden-properties
18749 @vindex gnus-hidden-properties
18750 This is a list of properties to use to hide ``invisible'' text.  It is
18751 @code{(invisible t intangible t)} by default on most systems, which
18752 makes invisible text invisible and intangible.
18753
18754 @item gnus-parse-headers-hook
18755 @vindex gnus-parse-headers-hook
18756 A hook called before parsing headers.  It can be used, for instance, to
18757 gather statistics on the headers fetched, or perhaps you'd like to prune
18758 some headers.  I don't see why you'd want that, though.
18759
18760 @item gnus-shell-command-separator
18761 @vindex gnus-shell-command-separator
18762 String used to separate two shell commands.  The default is @samp{;}.
18763
18764 @item gnus-invalid-group-regexp
18765 @vindex gnus-invalid-group-regexp
18766
18767 Regexp to match ``invalid'' group names when querying user for a group
18768 name.  The default value catches some @strong{really} invalid group
18769 names who could possibly mess up Gnus internally (like allowing
18770 @samp{:} in a group name, which is normally used to delimit method and
18771 group).
18772
18773 IMAP users might want to allow @samp{/} in group names though.
18774
18775
18776 @end table
18777
18778
18779 @node The End
18780 @chapter The End
18781
18782 Well, that's the manual---you can get on with your life now.  Keep in
18783 touch.  Say hello to your cats from me.
18784
18785 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
18786
18787 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
18788
18789 @quotation
18790 @strong{Te Deum}
18791
18792 @sp 1
18793 Not because of victories @*
18794 I sing,@*
18795 having none,@*
18796 but for the common sunshine,@*
18797 the breeze,@*
18798 the largess of the spring.
18799
18800 @sp 1
18801 Not for victory@*
18802 but for the day's work done@*
18803 as well as I was able;@*
18804 not for a seat upon the dais@*
18805 but at the common table.@*
18806 @end quotation
18807
18808
18809 @node Appendices
18810 @chapter Appendices
18811
18812 @menu
18813 * History::                        How Gnus got where it is today.
18814 * On Writing Manuals::             Why this is not a beginner's guide.
18815 * Terminology::                    We use really difficult, like, words here.
18816 * Customization::                  Tailoring Gnus to your needs.
18817 * Troubleshooting::                What you might try if things do not work.
18818 * Gnus Reference Guide::           Rilly, rilly technical stuff.
18819 * Emacs for Heathens::             A short introduction to Emacsian terms.
18820 * Frequently Asked Questions::     A question-and-answer session.
18821 @end menu
18822
18823
18824 @node History
18825 @section History
18826
18827 @cindex history
18828 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
18829 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
18830
18831 If you want to investigate the person responsible for this outrage,
18832 you can point your (feh!) web browser to
18833 @file{http://quimby.gnus.org/~larsi/}.  This is also the primary
18834 distribution point for the new and spiffy versions of Gnus, and is
18835 known as The Site That Destroys Newsrcs And Drives People Mad.
18836
18837 During the first extended alpha period of development, the new Gnus was
18838 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
18839 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
18840 (Besides, the ``Gnus'' in this abbreviation should probably be
18841 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
18842 appropriate name, don't you think?)
18843
18844 In any case, after spending all that energy on coming up with a new and
18845 spunky name, we decided that the name was @emph{too} spunky, so we
18846 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
18847 ``@sc{gnus}''.  New vs. old.
18848
18849 @menu
18850 * Gnus Versions::       What Gnus versions have been released.
18851 * Other Gnus Versions:: Other Gnus versions that also have been released.
18852 * Why?::                What's the point of Gnus?
18853 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
18854 * Conformity::          Gnus tries to conform to all standards.
18855 * Emacsen::             Gnus can be run on a few modern Emacsen.
18856 * Gnus Development::    How Gnus is developed.
18857 * Contributors::        Oodles of people.
18858 * New Features::        Pointers to some of the new stuff in Gnus.
18859 * Newest Features::     Features so new that they haven't been written yet.
18860 @end menu
18861
18862
18863 @node Gnus Versions
18864 @subsection Gnus Versions
18865 @cindex Pterodactyl Gnus
18866 @cindex ding Gnus
18867 @cindex September Gnus
18868 @cindex Quassia Gnus
18869
18870 The first ``proper'' release of Gnus 5 was done in November 1995 when it
18871 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
18872 plus 15 Gnus 5.0 releases).
18873
18874 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
18875 releases)) was released under the name ``Gnus 5.2'' (40 releases).
18876
18877 On July 28th 1996 work on Red Gnus was begun, and it was released on
18878 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
18879
18880 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
18881 If was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
18882
18883 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
18884 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
18885 1999. 
18886
18887 If you happen upon a version of Gnus that has a prefixed name --
18888 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
18889 don't panic.  Don't let it know that you're frightened.  Back away.
18890 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
18891 out of its reach.  Find a proper released version of Gnus and snuggle up
18892 to that instead.
18893
18894
18895 @node Other Gnus Versions
18896 @subsection Other Gnus Versions
18897 @cindex Semi-gnus
18898
18899 In addition to the versions of Gnus which have had their releases
18900 coordinated by Lars, one major development has been Semi-gnus from
18901 Japan.  It's based on a library called @sc{semi}, which provides
18902 @sc{mime} capabilities.
18903
18904 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
18905 Collectively, they are called ``Semi-gnus'', and different strains are
18906 called T-gnus, ET-gnus, Nana-gnus and Chaos.  These provide powerful
18907 @sc{mime} and multilingualization things, especially important for
18908 Japanese users.
18909
18910
18911 @node Why?
18912 @subsection Why?
18913
18914 What's the point of Gnus?
18915
18916 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
18917 newsreader, that lets you do anything you can think of.  That was my
18918 original motivation, but while working on Gnus, it has become clear to
18919 me that this generation of newsreaders really belong in the stone age.
18920 Newsreaders haven't developed much since the infancy of the net.  If the
18921 volume continues to rise with the current rate of increase, all current
18922 newsreaders will be pretty much useless.  How do you deal with
18923 newsgroups that have thousands of new articles each day?  How do you
18924 keep track of millions of people who post?
18925
18926 Gnus offers no real solutions to these questions, but I would very much
18927 like to see Gnus being used as a testing ground for new methods of
18928 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
18929 to separate the newsreader from the backends, Gnus now offers a simple
18930 interface for anybody who wants to write new backends for fetching mail
18931 and news from different sources.  I have added hooks for customizations
18932 everywhere I could imagine it being useful.  By doing so, I'm inviting
18933 every one of you to explore and invent.
18934
18935 May Gnus never be complete.  @kbd{C-u 100 M-x all-hail-emacs} and
18936 @kbd{C-u 100 M-x all-hail-xemacs}.
18937
18938
18939 @node Compatibility
18940 @subsection Compatibility
18941
18942 @cindex compatibility
18943 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
18944 bindings have been kept.  More key bindings have been added, of course,
18945 but only in one or two obscure cases have old bindings been changed.
18946
18947 Our motto is:
18948 @quotation
18949 @cartouche
18950 @center In a cloud bones of steel.
18951 @end cartouche
18952 @end quotation
18953
18954 All commands have kept their names.  Some internal functions have changed
18955 their names.
18956
18957 The @code{gnus-uu} package has changed drastically.  @xref{Decoding
18958 Articles}.
18959
18960 One major compatibility question is the presence of several summary
18961 buffers.  All variables relevant while reading a group are
18962 buffer-local to the summary buffer they belong in.  Although many
18963 important variables have their values copied into their global
18964 counterparts whenever a command is executed in the summary buffer, this
18965 change might lead to incorrect values being used unless you are careful.
18966
18967 All code that relies on knowledge of @sc{gnus} internals will probably
18968 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
18969 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
18970 maintains a hash table that points to the entries in this alist (which
18971 speeds up many functions), and changing the alist directly will lead to
18972 peculiar results.
18973
18974 @cindex hilit19
18975 @cindex highlighting
18976 Old hilit19 code does not work at all.  In fact, you should probably
18977 remove all hilit code from all Gnus hooks
18978 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
18979 Gnus provides various integrated functions for highlighting.  These are
18980 faster and more accurate.  To make life easier for everybody, Gnus will
18981 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
18982 Away!
18983
18984 Packages like @code{expire-kill} will no longer work.  As a matter of
18985 fact, you should probably remove all old @sc{gnus} packages (and other
18986 code) when you start using Gnus.  More likely than not, Gnus already
18987 does what you have written code to make @sc{gnus} do.  (Snicker.)
18988
18989 Even though old methods of doing things are still supported, only the
18990 new methods are documented in this manual.  If you detect a new method of
18991 doing something while reading this manual, that does not mean you have
18992 to stop doing it the old way.
18993
18994 Gnus understands all @sc{gnus} startup files.
18995
18996 @kindex M-x gnus-bug
18997 @findex gnus-bug
18998 @cindex reporting bugs
18999 @cindex bugs
19000 Overall, a casual user who hasn't written much code that depends on
19001 @sc{gnus} internals should suffer no problems.  If problems occur,
19002 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
19003
19004 @vindex gnus-bug-create-help-buffer
19005 If you are in the habit of sending bug reports @emph{very} often, you
19006 may find the helpful help buffer annoying after a while.  If so, set
19007 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
19008 up at you.
19009
19010
19011 @node Conformity
19012 @subsection Conformity
19013
19014 No rebels without a clue here, ma'am.  We conform to all standards known
19015 to (wo)man.  Except for those standards and/or conventions we disagree
19016 with, of course.
19017
19018 @table @strong
19019
19020 @item RFC 822
19021 @cindex RFC 822
19022 There are no known breaches of this standard.
19023
19024 @item RFC 1036
19025 @cindex RFC 1036
19026 There are no known breaches of this standard, either.
19027
19028 @item Son-of-RFC 1036
19029 @cindex Son-of-RFC 1036
19030 We do have some breaches to this one.
19031
19032 @table @emph
19033
19034 @item X-Newsreader
19035 @itemx User-Agent
19036 These are considered to be ``vanity headers'', while I consider them
19037 to be consumer information.  After seeing so many badly formatted
19038 articles coming from @code{tin} and @code{Netscape} I know not to use
19039 either of those for posting articles.  I would not have known that if
19040 it wasn't for the @code{X-Newsreader} header.
19041 @end table
19042
19043 @item USEFOR
19044 @cindex USEFOR
19045 USEFOR is an IETF working group writing a successor to RFC 1036, based
19046 on Son-of-RFC 1036.  They have produced a number of drafts proposing
19047 various changes to the format of news articles.  The Gnus towers will
19048 look into implementing the changes when the draft is accepted as an RFC.
19049
19050 @end table
19051
19052 If you ever notice Gnus acting non-compliant with regards to the texts
19053 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
19054 know.
19055
19056
19057 @node Emacsen
19058 @subsection Emacsen
19059 @cindex Emacsen
19060 @cindex XEmacs
19061 @cindex Mule
19062 @cindex Emacs
19063
19064 Gnus should work on :
19065
19066 @itemize @bullet
19067
19068 @item
19069 Emacs 20.3 and up.
19070
19071 @item
19072 XEmacs 21.1.1 and up.
19073
19074 @end itemize
19075
19076 This Gnus version will absolutely not work on any Emacsen older than
19077 that.  Not reliably, at least.  Older versions of Gnus may work on older
19078 Emacs versions.  However, T-gnus does support ``Mule 2.3 based on Emacs
19079 19.34'' and possibly the versions of XEmacs prior to 21.1.1, e.g. 20.4.
19080 See the file ``README'' in the T-gnus distribution for more details.
19081
19082 There are some vague differences between Gnus on the various
19083 platforms---XEmacs features more graphics (a logo and a toolbar)---but
19084 other than that, things should look pretty much the same under all
19085 Emacsen.
19086
19087
19088 @node Gnus Development
19089 @subsection Gnus Development
19090
19091 Gnus is developed in a two-phased cycle.  The first phase involves much
19092 discussion on the @samp{ding@@gnus.org} mailing list, where people
19093 propose changes and new features, post patches and new backends.  This
19094 phase is called the @dfn{alpha} phase, since the Gnusae released in this
19095 phase are @dfn{alpha releases}, or (perhaps more commonly in other
19096 circles) @dfn{snapshots}.  During this phase, Gnus is assumed to be
19097 unstable and should not be used by casual users.  Gnus alpha releases
19098 have names like ``Red Gnus'' and ``Quassia Gnus''.
19099
19100 After futzing around for 50-100 alpha releases, Gnus is declared
19101 @dfn{frozen}, and only bug fixes are applied.  Gnus loses the prefix,
19102 and is called things like ``Gnus 5.6.32'' instead.  Normal people are
19103 supposed to be able to use these, and these are mostly discussed on the
19104 @samp{gnu.emacs.gnus} newsgroup.
19105
19106 @cindex Incoming*
19107 @vindex mail-source-delete-incoming
19108 Some variable defaults differ between alpha Gnusae and released Gnusae.
19109 In particular, @code{mail-source-delete-incoming} defaults to @code{nil} in
19110 alpha Gnusae and @code{t} in released Gnusae.  This is to prevent
19111 lossage of mail if an alpha release hiccups while handling the mail.
19112
19113 The division of discussion between the ding mailing list and the Gnus
19114 newsgroup is not purely based on publicity concerns.  It's true that
19115 having people write about the horrible things that an alpha Gnus release
19116 can do (sometimes) in a public forum may scare people off, but more
19117 importantly, talking about new experimental features that have been
19118 introduced may confuse casual users.  New features are frequently
19119 introduced, fiddled with, and judged to be found wanting, and then
19120 either discarded or totally rewritten.  People reading the mailing list
19121 usually keep up with these rapid changes, whille people on the newsgroup
19122 can't be assumed to do so.
19123
19124
19125
19126 @node Contributors
19127 @subsection Contributors
19128 @cindex contributors
19129
19130 The new Gnus version couldn't have been done without the help of all the
19131 people on the (ding) mailing list.  Every day for over a year I have
19132 gotten billions of nice bug reports from them, filling me with joy,
19133 every single one of them.  Smooches.  The people on the list have been
19134 tried beyond endurance, what with my ``oh, that's a neat idea <type
19135 type>, yup, I'll release it right away <ship off> no wait, that doesn't
19136 work at all <type type>, yup, I'll ship that one off right away <ship
19137 off> no, wait, that absolutely does not work'' policy for releases.
19138 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
19139 ``worser''? ``much worser''?  ``worsest''?)
19140
19141 I would like to take this opportunity to thank the Academy for...  oops,
19142 wrong show.
19143
19144 @itemize @bullet
19145
19146 @item
19147 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
19148
19149 @item
19150 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
19151 nnwarchive and many, many other things connected with @sc{mime} and
19152 other types of en/decoding, as well as general bug fixing, new
19153 functionality and stuff.
19154
19155 @item
19156 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
19157 well as numerous other things).
19158
19159 @item
19160 Luis Fernandes---design and graphics.
19161
19162 @item
19163 Justin Sheehy--the FAQ maintainer.
19164
19165 @item
19166 Erik Naggum---help, ideas, support, code and stuff.
19167
19168 @item
19169 Wes Hardaker---@file{gnus-picon.el} and the manual section on
19170 @dfn{picons} (@pxref{Picons}).
19171
19172 @item
19173 Kim-Minh Kaplan---further work on the picon code.
19174
19175 @item
19176 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
19177 (@pxref{GroupLens}).
19178
19179 @item
19180 Sudish Joseph---innumerable bug fixes.
19181
19182 @item
19183 Ilja Weis---@file{gnus-topic.el}.
19184
19185 @item
19186 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
19187
19188 @item
19189 Vladimir Alexiev---the refcard and reference booklets.
19190
19191 @item
19192 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
19193 distribution by Felix Lee and JWZ.
19194
19195 @item
19196 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
19197
19198 @item
19199 Peter Mutsaers---orphan article scoring code.
19200
19201 @item
19202 Ken Raeburn---POP mail support.
19203
19204 @item
19205 Hallvard B Furuseth---various bits and pieces, especially dealing with
19206 .newsrc files.
19207
19208 @item
19209 Brian Edmonds---@file{gnus-bbdb.el}.
19210
19211 @item
19212 David Moore---rewrite of @file{nnvirtual.el} and many other things.
19213
19214 @item
19215 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
19216
19217 @item
19218 François Pinard---many, many interesting and thorough bug reports, as
19219 well as autoconf support.
19220
19221 @end itemize
19222
19223 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
19224 Borges, and Jost Krieger proof-reading parts of the manual.
19225
19226 The following people have contributed many patches and suggestions:
19227
19228 Christopher Davis,
19229 Andrew Eskilsson,
19230 Kai Grossjohann,
19231 David KÃ¥gedal,
19232 Richard Pieri,
19233 Fabrice Popineau,
19234 Daniel Quinlan,
19235 Jason L. Tibbitts, III,
19236 and
19237 Jack Vinson.
19238
19239 Also thanks to the following for patches and stuff:
19240
19241 Jari Aalto,
19242 Adrian Aichner,
19243 Vladimir Alexiev,
19244 Russ Allbery,
19245 Peter Arius,
19246 Matt Armstrong,
19247 Marc Auslander,
19248 Miles Bader,
19249 Alexei V. Barantsev,
19250 Frank Bennett,
19251 Robert Bihlmeyer,
19252 Chris Bone,
19253 Mark Borges,
19254 Mark Boyns,
19255 Lance A. Brown,
19256 Rob Browning,
19257 Kees de Bruin,
19258 Martin Buchholz,
19259 Joe Buehler,
19260 Kevin Buhr,
19261 Alastair Burt,
19262 Joao Cachopo,
19263 Zlatko Calusic,
19264 Massimo Campostrini,
19265 Castor,
19266 David Charlap,
19267 Dan Christensen,
19268 Kevin Christian,
19269 Jae-you Chung, @c ?
19270 James H. Cloos, Jr.,
19271 Laura Conrad,
19272 Michael R. Cook,
19273 Glenn Coombs,
19274 Andrew J. Cosgriff,
19275 Neil Crellin,
19276 Frank D. Cringle,
19277 Geoffrey T. Dairiki,
19278 Andre Deparade,
19279 Ulrik Dickow,
19280 Dave Disser,
19281 Rui-Tao Dong, @c ?
19282 Joev Dubach,
19283 Michael Welsh Duggan,
19284 Dave Edmondson,
19285 Paul Eggert,
19286 Mark W. Eichin,
19287 Karl Eichwalder,
19288 Enami Tsugutomo, @c Enami
19289 Michael Ernst,
19290 Luc Van Eycken,
19291 Sam Falkner,
19292 Nelson Jose dos Santos Ferreira,
19293 Sigbjorn Finne,
19294 Sven Fischer,
19295 Paul Fisher,
19296 Decklin Foster,
19297 Gary D. Foster,
19298 Paul Franklin,
19299 Guy Geens,
19300 Arne Georg Gleditsch,
19301 David S. Goldberg,
19302 Michelangelo Grigni,
19303 Dale Hagglund,
19304 D. Hall,
19305 Magnus Hammerin,
19306 Kenichi Handa, @c Handa
19307 Raja R. Harinath,
19308 Yoshiki Hayashi, @c ?
19309 P. E. Jareth Hein,
19310 Hisashige Kenji, @c Hisashige
19311 Scott Hofmann,
19312 Marc Horowitz,
19313 Gunnar Horrigmo,
19314 Richard Hoskins,
19315 Brad Howes,
19316 Miguel de Icaza,
19317 François Felix Ingrand,
19318 Tatsuya Ichikawa, @c ?
19319 Ishikawa Ichiro, @c Ishikawa
19320 Lee Iverson,
19321 Iwamuro Motonori, @c Iwamuro
19322 Rajappa Iyer,
19323 Andreas Jaeger,
19324 Adam P. Jenkins,
19325 Randell Jesup,
19326 Fred Johansen,
19327 Gareth Jones,
19328 Simon Josefsson,
19329 Greg Klanderman,
19330 Karl Kleinpaste,
19331 Michael Klingbeil,
19332 Peter Skov Knudsen,
19333 Shuhei Kobayashi, @c Kobayashi
19334 Petr Konecny,
19335 Koseki Yoshinori, @c Koseki
19336 Thor Kristoffersen,
19337 Jens Lautenbacher,
19338 Martin Larose,
19339 Seokchan Lee, @c Lee
19340 Joerg Lenneis,
19341 Carsten Leonhardt,
19342 James LewisMoss,
19343 Christian Limpach,
19344 Markus Linnala,
19345 Dave Love,
19346 Mike McEwan,
19347 Tonny Madsen,
19348 Shlomo Mahlab,
19349 Nat Makarevitch,
19350 Istvan Marko,
19351 David Martin,
19352 Jason R. Mastaler,
19353 Gordon Matzigkeit,
19354 Timo Metzemakers,
19355 Richard Mlynarik,
19356 Lantz Moore,
19357 Morioka Tomohiko, @c Morioka
19358 Erik Toubro Nielsen,
19359 Hrvoje Niksic,
19360 Andy Norman,
19361 Fred Oberhauser,
19362 C. R. Oldham,
19363 Alexandre Oliva,
19364 Ken Olstad,
19365 Masaharu Onishi, @c Onishi
19366 Hideki Ono, @c Ono
19367 Ettore Perazzoli,
19368 William Perry,
19369 Stephen Peters,
19370 Jens-Ulrik Holger Petersen,
19371 Ulrich Pfeifer,
19372 Matt Pharr,
19373 Andy Piper,
19374 John McClary Prevost,
19375 Bill Pringlemeir,
19376 Mike Pullen,
19377 Jim Radford,
19378 Colin Rafferty,
19379 Lasse Rasinen,
19380 Lars Balker Rasmussen,
19381 Joe Reiss,
19382 Renaud Rioboo,
19383 Roland B. Roberts,
19384 Bart Robinson,
19385 Christian von Roques,
19386 Markus Rost,
19387 Jason Rumney,
19388 Wolfgang Rupprecht,
19389 Jay Sachs,
19390 Dewey M. Sasser,
19391 Conrad Sauerwald,
19392 Loren Schall,
19393 Dan Schmidt,
19394 Ralph Schleicher,
19395 Philippe Schnoebelen,
19396 Andreas Schwab,
19397 Randal L. Schwartz,
19398 Danny Siu,
19399 Matt Simmons,
19400 Paul D. Smith,
19401 Jeff Sparkes,
19402 Toby Speight,
19403 Michael Sperber,
19404 Darren Stalder,
19405 Richard Stallman,
19406 Greg Stark,
19407 Sam Steingold,
19408 Paul Stevenson,
19409 Jonas Steverud,
19410 Paul Stodghill,
19411 Kiyokazu Suto, @c Suto
19412 Kurt Swanson,
19413 Samuel Tardieu,
19414 Teddy,
19415 Chuck Thompson,
19416 Tozawa Akihiko, @c Tozawa
19417 Philippe Troin,
19418 James Troup,
19419 Trung Tran-Duc,
19420 Jack Twilley,
19421 Aaron M. Ucko,
19422 Aki Vehtari,
19423 Didier Verna,
19424 Vladimir Volovich,
19425 Jan Vroonhof,
19426 Stefan Waldherr,
19427 Pete Ware,
19428 Barry A. Warsaw,
19429 Christoph Wedler,
19430 Joe Wells,
19431 Lee Willis,
19432 Katsumi Yamaoka @c Yamaoka
19433 and
19434 Lloyd Zusman.
19435
19436
19437 For a full overview of what each person has done, the ChangeLogs
19438 included in the Gnus alpha distributions should give ample reading
19439 (550kB and counting).
19440
19441 Apologies to everybody that I've forgotten, of which there are many, I'm
19442 sure.
19443
19444 Gee, that's quite a list of people.  I guess that must mean that there
19445 actually are people who are using Gnus.  Who'd'a thunk it!
19446
19447
19448 @node New Features
19449 @subsection New Features
19450 @cindex new features
19451
19452 @menu
19453 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
19454 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
19455 * Red Gnus::           Third time best---Gnus 5.4/5.5.
19456 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
19457 @end menu
19458
19459 These lists are, of course, just @emph{short} overviews of the
19460 @emph{most} important new features.  No, really.  There are tons more.
19461 Yes, we have feeping creaturism in full effect.
19462
19463
19464 @node ding Gnus
19465 @subsubsection (ding) Gnus
19466
19467 New features in Gnus 5.0/5.1:
19468
19469 @itemize @bullet
19470
19471 @item
19472 The look of all buffers can be changed by setting format-like variables
19473 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
19474
19475 @item
19476 Local spool and several @sc{nntp} servers can be used at once
19477 (@pxref{Select Methods}).
19478
19479 @item
19480 You can combine groups into virtual groups (@pxref{Virtual Groups}).
19481
19482 @item
19483 You can read a number of different mail formats (@pxref{Getting Mail}).
19484 All the mail backends implement a convenient mail expiry scheme
19485 (@pxref{Expiring Mail}).
19486
19487 @item
19488 Gnus can use various strategies for gathering threads that have lost
19489 their roots (thereby gathering loose sub-threads into one thread) or it
19490 can go back and retrieve enough headers to build a complete thread
19491 (@pxref{Customizing Threading}).
19492
19493 @item
19494 Killed groups can be displayed in the group buffer, and you can read
19495 them as well (@pxref{Listing Groups}).
19496
19497 @item
19498 Gnus can do partial group updates---you do not have to retrieve the
19499 entire active file just to check for new articles in a few groups
19500 (@pxref{The Active File}).
19501
19502 @item
19503 Gnus implements a sliding scale of subscribedness to groups
19504 (@pxref{Group Levels}).
19505
19506 @item
19507 You can score articles according to any number of criteria
19508 (@pxref{Scoring}).  You can even get Gnus to find out how to score
19509 articles for you (@pxref{Adaptive Scoring}).
19510
19511 @item
19512 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
19513 manner, so it should be difficult to lose much data on what you have
19514 read if your machine should go down (@pxref{Auto Save}).
19515
19516 @item
19517 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
19518 the @file{.emacs} file.
19519
19520 @item
19521 You can set the process mark on both groups and articles and perform
19522 operations on all the marked items (@pxref{Process/Prefix}).
19523
19524 @item
19525 You can grep through a subset of groups and create a group from the
19526 results (@pxref{Kibozed Groups}).
19527
19528 @item
19529 You can list subsets of groups according to, well, anything
19530 (@pxref{Listing Groups}).
19531
19532 @item
19533 You can browse foreign servers and subscribe to groups from those
19534 servers (@pxref{Browse Foreign Server}).
19535
19536 @item
19537 Gnus can fetch articles, asynchronously, on a second connection to the
19538 server (@pxref{Asynchronous Fetching}).
19539
19540 @item
19541 You can cache articles locally (@pxref{Article Caching}).
19542
19543 @item
19544 The uudecode functions have been expanded and generalized
19545 (@pxref{Decoding Articles}).
19546
19547 @item
19548 You can still post uuencoded articles, which was a little-known feature
19549 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
19550
19551 @item
19552 Fetching parents (and other articles) now actually works without
19553 glitches (@pxref{Finding the Parent}).
19554
19555 @item
19556 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
19557
19558 @item
19559 Digests (and other files) can be used as the basis for groups
19560 (@pxref{Document Groups}).
19561
19562 @item
19563 Articles can be highlighted and customized (@pxref{Customizing
19564 Articles}).
19565
19566 @item
19567 URLs and other external references can be buttonized (@pxref{Article
19568 Buttons}).
19569
19570 @item
19571 You can do lots of strange stuff with the Gnus window & frame
19572 configuration (@pxref{Windows Configuration}).
19573
19574 @item
19575 You can click on buttons instead of using the keyboard
19576 (@pxref{Buttons}).
19577
19578 @end itemize
19579
19580
19581 @node September Gnus
19582 @subsubsection September Gnus
19583
19584 @iftex
19585 @iflatex
19586 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
19587 @end iflatex
19588 @end iftex
19589
19590 New features in Gnus 5.2/5.3:
19591
19592 @itemize @bullet
19593
19594 @item
19595 A new message composition mode is used.  All old customization variables
19596 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
19597 now obsolete.
19598
19599 @item
19600 Gnus is now able to generate @dfn{sparse} threads---threads where
19601 missing articles are represented by empty nodes (@pxref{Customizing
19602 Threading}).
19603
19604 @lisp
19605 (setq gnus-build-sparse-threads 'some)
19606 @end lisp
19607
19608 @item
19609 Outgoing articles are stored on a special archive server
19610 (@pxref{Archived Messages}).
19611
19612 @item
19613 Partial thread regeneration now happens when articles are
19614 referred.
19615
19616 @item
19617 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
19618
19619 @item
19620 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
19621
19622 @item
19623 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
19624
19625 @lisp
19626 (setq gnus-use-trees t)
19627 @end lisp
19628
19629 @item
19630 An @code{nn}-like pick-and-read minor mode is available for the summary
19631 buffers (@pxref{Pick and Read}).
19632
19633 @lisp
19634 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
19635 @end lisp
19636
19637 @item
19638 In binary groups you can use a special binary minor mode (@pxref{Binary
19639 Groups}).
19640
19641 @item
19642 Groups can be grouped in a folding topic hierarchy (@pxref{Group
19643 Topics}).
19644
19645 @lisp
19646 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
19647 @end lisp
19648
19649 @item
19650 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
19651
19652 @item
19653 Groups can now have a score, and bubbling based on entry frequency
19654 is possible (@pxref{Group Score}).
19655
19656 @lisp
19657 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
19658 @end lisp
19659
19660 @item
19661 Groups can be process-marked, and commands can be performed on
19662 groups of groups (@pxref{Marking Groups}).
19663
19664 @item
19665 Caching is possible in virtual groups.
19666
19667 @item
19668 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
19669 news batches, ClariNet briefs collections, and just about everything
19670 else (@pxref{Document Groups}).
19671
19672 @item
19673 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
19674 (@pxref{SOUP}).
19675
19676 @item
19677 The Gnus cache is much faster.
19678
19679 @item
19680 Groups can be sorted according to many criteria (@pxref{Sorting
19681 Groups}).
19682
19683 @item
19684 New group parameters have been introduced to set list-addresses and
19685 expiry times (@pxref{Group Parameters}).
19686
19687 @item
19688 All formatting specs allow specifying faces to be used
19689 (@pxref{Formatting Fonts}).
19690
19691 @item
19692 There are several more commands for setting/removing/acting on process
19693 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
19694
19695 @item
19696 The summary buffer can be limited to show parts of the available
19697 articles based on a wide range of criteria.  These commands have been
19698 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
19699
19700 @item
19701 Articles can be made persistent with the @kbd{*} command
19702 (@pxref{Persistent Articles}).
19703
19704 @item
19705 All functions for hiding article elements are now toggles.
19706
19707 @item
19708 Article headers can be buttonized (@pxref{Article Washing}).
19709
19710 @item
19711 All mail backends support fetching articles by @code{Message-ID}.
19712
19713 @item
19714 Duplicate mail can now be treated properly (@pxref{Duplicates}).
19715
19716 @item
19717 All summary mode commands are available directly from the article
19718 buffer (@pxref{Article Keymap}).
19719
19720 @item
19721 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
19722 Configuration}).
19723
19724 @item
19725 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
19726 @iftex
19727 @iflatex
19728 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
19729 @end iflatex
19730 @end iftex
19731
19732 @item
19733 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
19734
19735 @lisp
19736 (setq gnus-use-nocem t)
19737 @end lisp
19738
19739 @item
19740 Groups can be made permanently visible (@pxref{Listing Groups}).
19741
19742 @lisp
19743 (setq gnus-permanently-visible-groups "^nnml:")
19744 @end lisp
19745
19746 @item
19747 Many new hooks have been introduced to make customizing easier.
19748
19749 @item
19750 Gnus respects the @code{Mail-Copies-To} header.
19751
19752 @item
19753 Threads can be gathered by looking at the @code{References} header
19754 (@pxref{Customizing Threading}).
19755
19756 @lisp
19757 (setq gnus-summary-thread-gathering-function
19758       'gnus-gather-threads-by-references)
19759 @end lisp
19760
19761 @item
19762 Read articles can be stored in a special backlog buffer to avoid
19763 refetching (@pxref{Article Backlog}).
19764
19765 @lisp
19766 (setq gnus-keep-backlog 50)
19767 @end lisp
19768
19769 @item
19770 A clean copy of the current article is always stored in a separate
19771 buffer to allow easier treatment.
19772
19773 @item
19774 Gnus can suggest where to save articles (@pxref{Saving Articles}).
19775
19776 @item
19777 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
19778 Articles}).
19779
19780 @lisp
19781 (setq gnus-prompt-before-saving t)
19782 @end lisp
19783
19784 @item
19785 @code{gnus-uu} can view decoded files asynchronously while fetching
19786 articles (@pxref{Other Decode Variables}).
19787
19788 @lisp
19789 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
19790 @end lisp
19791
19792 @item
19793 Filling in the article buffer now works properly on cited text
19794 (@pxref{Article Washing}).
19795
19796 @item
19797 Hiding cited text adds buttons to toggle hiding, and how much
19798 cited text to hide is now customizable (@pxref{Article Hiding}).
19799
19800 @lisp
19801 (setq gnus-cited-lines-visible 2)
19802 @end lisp
19803
19804 @item
19805 Boring headers can be hidden (@pxref{Article Hiding}).
19806
19807 @item
19808 Default scoring values can now be set from the menu bar.
19809
19810 @item
19811 Further syntax checking of outgoing articles have been added.
19812
19813 @end itemize
19814
19815
19816 @node Red Gnus
19817 @subsubsection Red Gnus
19818
19819 New features in Gnus 5.4/5.5:
19820
19821 @iftex
19822 @iflatex
19823 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
19824 @end iflatex
19825 @end iftex
19826
19827 @itemize @bullet
19828
19829 @item
19830 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
19831
19832 @item
19833 Article prefetching functionality has been moved up into
19834 Gnus (@pxref{Asynchronous Fetching}).
19835
19836 @item
19837 Scoring can now be performed with logical operators like @code{and},
19838 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
19839 Scoring}).
19840
19841 @item
19842 Article washing status can be displayed in the
19843 article mode line (@pxref{Misc Article}).
19844
19845 @item
19846 @file{gnus.el} has been split into many smaller files.
19847
19848 @item
19849 Suppression of duplicate articles based on Message-ID can be done
19850 (@pxref{Duplicate Suppression}).
19851
19852 @lisp
19853 (setq gnus-suppress-duplicates t)
19854 @end lisp
19855
19856 @item
19857 New variables for specifying what score and adapt files are to be
19858 considered home score and adapt files (@pxref{Home Score File}) have
19859 been added.
19860
19861 @item
19862 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
19863 Server Internals}).
19864
19865 @item
19866 Groups can inherit group parameters from parent topics (@pxref{Topic
19867 Parameters}).
19868
19869 @item
19870 Article editing has been revamped and is now actually usable.
19871
19872 @item
19873 Signatures can be recognized in more intelligent fashions
19874 (@pxref{Article Signature}).
19875
19876 @item
19877 Summary pick mode has been made to look more @code{nn}-like.  Line
19878 numbers are displayed and the @kbd{.} command can be used to pick
19879 articles (@code{Pick and Read}).
19880
19881 @item
19882 Commands for moving the @file{.newsrc.eld} from one server to
19883 another have been added (@pxref{Changing Servers}).
19884
19885 @item
19886 There's a way now to specify that ``uninteresting'' fields be suppressed
19887 when generating lines in buffers (@pxref{Advanced Formatting}).
19888
19889 @item
19890 Several commands in the group buffer can be undone with @kbd{M-C-_}
19891 (@pxref{Undo}).
19892
19893 @item
19894 Scoring can be done on words using the new score type @code{w}
19895 (@pxref{Score File Format}).
19896
19897 @item
19898 Adaptive scoring can be done on a Subject word-by-word basis
19899 (@pxref{Adaptive Scoring}).
19900
19901 @lisp
19902 (setq gnus-use-adaptive-scoring '(word))
19903 @end lisp
19904
19905 @item
19906 Scores can be decayed (@pxref{Score Decays}).
19907
19908 @lisp
19909 (setq gnus-decay-scores t)
19910 @end lisp
19911
19912 @item
19913 Scoring can be performed using a regexp on the Date header.  The Date is
19914 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
19915
19916 @item
19917 A new command has been added to remove all data on articles from
19918 the native server (@pxref{Changing Servers}).
19919
19920 @item
19921 A new command for reading collections of documents
19922 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
19923 (@pxref{Really Various Summary Commands}).
19924
19925 @item
19926 Process mark sets can be pushed and popped (@pxref{Setting Process
19927 Marks}).
19928
19929 @item
19930 A new mail-to-news backend makes it possible to post even when the @sc{nntp}
19931 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
19932
19933 @item
19934 A new backend for reading searches from Web search engines
19935 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
19936 (@pxref{Web Searches}).
19937
19938 @item
19939 Groups inside topics can now be sorted using the standard sorting
19940 functions, and each topic can be sorted independently (@pxref{Topic
19941 Sorting}).
19942
19943 @item
19944 Subsets of the groups can be sorted independently (@code{Sorting
19945 Groups}).
19946
19947 @item
19948 Cached articles can be pulled into the groups (@pxref{Summary Generation
19949 Commands}).
19950 @iftex
19951 @iflatex
19952 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
19953 @end iflatex
19954 @end iftex
19955
19956 @item
19957 Score files are now applied in a more reliable order (@pxref{Score
19958 Variables}).
19959
19960 @item
19961 Reports on where mail messages end up can be generated (@pxref{Splitting
19962 Mail}).
19963
19964 @item
19965 More hooks and functions have been added to remove junk from incoming
19966 mail before saving the mail (@pxref{Washing Mail}).
19967
19968 @item
19969 Emphasized text can be properly fontisized:
19970
19971 @end itemize
19972
19973
19974 @node Quassia Gnus
19975 @subsubsection Quassia Gnus
19976
19977 New features in Gnus 5.6:
19978
19979 @itemize @bullet
19980
19981 @item
19982 New functionality for using Gnus as an offline newsreader has been
19983 added.  A plethora of new commands and modes have been added.  See
19984 @pxref{Gnus Unplugged} for the full story.
19985
19986 @item
19987  The @code{nndraft} backend has returned, but works differently than
19988 before.  All Message buffers are now also articles in the @code{nndraft}
19989 group, which is created automatically.
19990
19991 @item
19992 @code{gnus-alter-header-function} can now be used to alter header
19993 values.
19994
19995 @item
19996  @code{gnus-summary-goto-article} now accept Message-ID's.
19997
19998 @item
19999  A new Message command for deleting text in the body of a message
20000 outside the region: @kbd{C-c C-v}.
20001
20002 @item
20003  You can now post to component group in @code{nnvirtual} groups with
20004 @kbd{C-u C-c C-c}.
20005
20006 @item
20007  @code{nntp-rlogin-program}---new variable to ease customization.
20008
20009 @item
20010  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
20011 re-highlighting of the article buffer.
20012
20013 @item
20014  New element in @code{gnus-boring-article-headers}---@code{long-to}.
20015
20016 @item
20017  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
20018 Prefixes" in the Gnus manual for details.
20019
20020 @item
20021  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
20022 @kbd{a} to add the score rule to the "all.SCORE" file.
20023
20024 @item
20025  @code{gnus-simplify-subject-functions} variable to allow greater
20026 control over simplification.
20027
20028 @item
20029  @kbd{A T}---new command for fetching the current thread.
20030
20031 @item
20032  @kbd{/ T}---new command for including the current thread in the
20033 limit.
20034
20035 @item
20036  @kbd{M-RET} is a new Message command for breaking cited text.
20037
20038 @item
20039  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
20040
20041 @item
20042  The @code{custom-face-lookup} function has been removed.
20043 If you used this function in your initialization files, you must
20044 rewrite them to use @code{face-spec-set} instead.
20045
20046 @item
20047  Canceling now uses the current select method.  Symbolic prefix
20048 @kbd{a} forces normal posting method.
20049
20050 @item
20051  New command to translate M******** sm*rtq**t*s into proper
20052 text---@kbd{W d}.
20053
20054 @item
20055  For easier debugging of @code{nntp}, you can set
20056 @code{nntp-record-commands} to a non-@code{nil} value.
20057
20058 @item
20059  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
20060 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
20061
20062 @item
20063  A command for editing group parameters from the summary buffer
20064 has been added.
20065
20066 @item
20067  A history of where mails have been split is available.
20068
20069 @item
20070  A new article date command has been added---@code{article-date-iso8601}.
20071
20072 @item
20073  Subjects can be simplified when threading by setting
20074 @code{gnus-score-thread-simplify}.
20075
20076 @item
20077  A new function for citing in Message has been
20078 added---@code{message-cite-original-without-signature}.
20079
20080 @item
20081  @code{article-strip-all-blank-lines}---new article command.
20082
20083 @item
20084  A new Message command to kill to the end of the article has
20085 been added.
20086
20087 @item
20088  A minimum adaptive score can be specified by using the
20089 @code{gnus-adaptive-word-minimum} variable.
20090
20091 @item
20092  The "lapsed date" article header can be kept continually
20093 updated by the @code{gnus-start-date-timer} command.
20094
20095 @item
20096  Web listserv archives can be read with the @code{nnlistserv} backend.
20097
20098 @item
20099  Old dejanews archives can now be read by @code{nnweb}.
20100
20101 @end itemize
20102
20103
20104 @node Newest Features
20105 @subsection Newest Features
20106 @cindex todo
20107
20108 Also known as the @dfn{todo list}.  Sure to be implemented before the
20109 next millennium.
20110
20111 Be afraid.  Be very afraid.
20112
20113 (That a feature appears in this list doesn't necessarily mean that I've
20114 decided to actually implement it.  It just means that I think it sounds
20115 interesting.)
20116
20117 (Yes, this is the actual, up-to-the-second todo list.)
20118
20119 @itemize @bullet
20120
20121 @item
20122  I would like the zombie-page to contain an URL to the source of the
20123 latest version of gnus or some explanation on where to find it.
20124
20125 @item
20126  A way to continue editing the latest Message composition.
20127
20128 @item
20129  http://www.sonicnet.com/feature/ari3/
20130
20131 @item
20132  facep is not declared.
20133
20134 @item
20135  Include a section in the manual on why the number of articles
20136 isn't the same in the group buffer and on the SPC prompt.
20137
20138 @item
20139  Interacting with rmail fcc isn't easy.
20140
20141 @item
20142 @example
20143  Hypermail:
20144 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
20145 <URL:http://www.eit.com/software/hypermail/hypermail.html>
20146 <URL:http://homer.ncm.com/>
20147 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
20148 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
20149 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
20150 http://www.miranova.com/gnus-list/
20151
20152 @end example
20153
20154 @item
20155 @samp{^-- } is made into - in LaTeX.
20156
20157 @item
20158  gnus-kill is much slower than it was in GNUS 4.1.3.
20159
20160 @item
20161  when expunging articles on low score, the sparse nodes keep hanging on?
20162 @item
20163  starting the first time seems to hang Gnus on some systems.  Does
20164 NEWGROUPS answer too fast?
20165 @item
20166  nndir doesn't read gzipped files.
20167 @item
20168  FAQ doesn't have an up node?
20169 @item
20170  when moving mail from a procmail spool to the crash-box,
20171 the crash-box is only appropriate to one specific group.
20172 @item
20173  `t' `t' makes X-Faces disappear.
20174 @item
20175  nnmh-be-safe means that crossposted articles will
20176 be marked as unread.
20177 @item
20178  Orphan score entries don't show on "V t" score trace
20179 @item
20180  when clearing out data, the cache data should also be reset.
20181 @item
20182  rewrite gnus-summary-limit-children to be non-recursive
20183 to avoid exceeding lisp nesting on huge groups.
20184 @item
20185  expunged articles are counted when computing scores.
20186 @item
20187  implement gnus-batch-brew-soup
20188 @item
20189  ticked articles aren't easy to read in pick mode -- `n' and
20190 stuff just skips past them.  Read articles are the same.
20191 @item
20192  topics that contain just groups with ticked
20193 articles aren't displayed.
20194 @item
20195  nndoc should always allocate unique Message-IDs.
20196 @item
20197  If there are mail groups the first time you use Gnus, Gnus'll
20198 make the mail groups killed.
20199 @item
20200  no "no news is good news" when using topics.
20201 @item
20202  when doing crosspost marking, the cache has to be consulted
20203 and articles have to be removed.
20204 @item
20205  nnweb should fetch complete articles when they are split into several
20206 parts.
20207 @item
20208  scoring on head immediate doesn't work.
20209 @item
20210  finding short score file names takes forever.
20211 @item
20212  canceling articles in foreign groups.
20213 @item
20214  nntp-open-rlogin no longer works.
20215 @item
20216  C-u C-x C-s (Summary) switches to the group buffer.
20217 @item
20218  move nnmail-split-history out to the backends.
20219 @item
20220  nnweb doesn't work properly.
20221 @item
20222  using a virtual server name as `gnus-select-method' doesn't work?
20223 @item
20224  when killing/yanking a group from one topic to another in a slave, the
20225 master will yank it first to one topic and then add it to another.
20226 Perhaps.
20227
20228 @item
20229  warn user about `=' redirection of a group in the active file?
20230 @item
20231  take over the XEmacs menubar and offer a toggle between the XEmacs
20232 bar and the Gnus bar.
20233 @item
20234 @example
20235  push active file and NOV file parsing down into C code.
20236 `(canonize-message-id id)'
20237 `(mail-parent-message-id references n)'
20238 `(parse-news-nov-line &optional dependency-hashtb)'
20239 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
20240 `(parse-news-active-region beg end hashtb)'
20241
20242 @end example
20243
20244 @item
20245  nnml .overview directory with splits.
20246 @item
20247  asynchronous cache
20248 @item
20249  postponed commands.
20250 @item
20251  the selected article show have its Subject displayed in its summary line.
20252 @item
20253  when entering groups, get the real number of unread articles from
20254 the server?
20255 @item
20256  sort after gathering threads -- make false roots have the
20257 headers of the oldest orphan with a 0 article number?
20258 @item
20259  nndoc groups should inherit the score files of their parents?  Also
20260 inherit copy prompts and save files.
20261 @item
20262  command to start up Gnus (if not running) and enter a mail mode buffer.
20263 @item
20264  allow editing the group description from the group buffer
20265 for backends that support that.
20266 @item
20267 gnus-hide,show-all-topics
20268 @item
20269  groups and sub-topics should be allowed to mingle inside each topic,
20270 and not just list all subtopics at the end.
20271 @item
20272  a command to remove all read articles that are not needed to connect
20273 threads -- `gnus-summary-limit-to-sparse-unread'?
20274 @item
20275  a variable to turn off limiting/cutting of threads in the tree buffer.
20276 @item
20277  a variable to limit how many files are uudecoded.
20278 @item
20279  add zombie groups to a special "New Groups" topic.
20280 @item
20281  server mode command: close/open all connections
20282 @item
20283  put a file date in gnus-score-alist and check whether the file
20284 has been changed before using it.
20285 @item
20286  on exit from a digest group, go to the next article in the parent group.
20287 @item
20288  hide (sub)threads with low score.
20289 @item
20290  when expiring, remove all marks from expired articles.
20291 @item
20292  gnus-summary-limit-to-body
20293 @item
20294  a regexp alist that says what level groups are to be subscribed
20295 on.  Eg. -- `(("nnml:" . 1))'.
20296 @item
20297  easier interface to nnkiboze to create ephemeral groups that
20298 contain groups that match a regexp.
20299 @item
20300  allow newlines in <URL:> urls, but remove them before using
20301 the URL.
20302 @item
20303  If there is no From line, the mail backends should fudge one from the
20304 "From " line.
20305 @item
20306  fuzzy simplifying should strip all non-alpha-numerical info
20307 from subject lines.
20308 @item
20309  gnus-soup-brew-soup-with-high-scores.
20310 @item
20311  nntp-ping-before-connect
20312 @item
20313  command to check whether NOV is evil.  "list overview.fmt".
20314 @item
20315  when entering a group, Gnus should look through the score
20316 files very early for `local' atoms and set those local variables.
20317 @item
20318  message annotations.
20319 @item
20320  topics are always yanked before groups, and that's not good.
20321 @item
20322  (set-extent-property extent 'help-echo "String to display in minibuf")
20323 to display help in the minibuffer on buttons under XEmacs.
20324 @item
20325  allow group line format spec to say how many articles there
20326 are in the cache.
20327 @item
20328  AUTHINFO GENERIC
20329 @item
20330  `run-with-idle-timer' in gnus-demon.
20331 @item
20332  stop using invisible text properties and start using overlays instead
20333 @item
20334  C-c C-f C-e to add an Expires header.
20335 @item
20336  go from one group to the next; everything is expunged; go to the
20337 next group instead of going to the group buffer.
20338 @item
20339  gnus-renumber-cache -- to renumber the cache using "low" numbers.
20340 @item
20341  record topic changes in the dribble buffer.
20342 @item
20343  `nnfolder-generate-active-file' should look at the folders it
20344 finds and generate proper active ranges.
20345 @item
20346  nneething-look-in-files-for-article-heads variable to control
20347 whether nneething should sniff all files in the directories.
20348 @item
20349  gnus-fetch-article -- start Gnus, enter group, display article
20350 @item
20351  gnus-dont-move-articles-to-same-group variable when respooling.
20352 @item
20353  when messages are crossposted between several auto-expirable groups,
20354 articles aren't properly marked as expirable.
20355 @item
20356  nneething should allow deletion/moving.
20357 @item
20358  TAB on the last button should go to the first button.
20359 @item
20360  if the car of an element in `mail-split-methods' is a function,
20361 and the function returns non-nil, use that as the name of the group(s) to
20362 save mail in.
20363 @item
20364  command for listing all score files that have been applied.
20365 @item
20366  a command in the article buffer to return to `summary' config.
20367 @item
20368  `gnus-always-post-using-current-server' -- variable to override
20369 `C-c C-c' when posting.
20370 @item
20371  nnmail-group-spool-alist -- says where each group should use
20372 as a spool file.
20373 @item
20374  when an article is crossposted to an auto-expirable group, the article
20375 should be marker as expirable.
20376 @item
20377  article mode command/menu for "send region as URL to browser".
20378 @item
20379  on errors, jump to info nodes that explain the error.  For instance,
20380 on invalid From headers, or on error messages from the nntp server.
20381 @item
20382  when gathering threads, make the article that has no "Re: " the parent.
20383 Also consult Date headers.
20384 @item
20385  a token in splits to call shrink-window-if-larger-than-buffer
20386 @item
20387  `1 0 A M' to do matches on the active hashtb.
20388 @item
20389  duplicates -- command to remove Gnus-Warning header, use the read
20390 Message-ID, delete the "original".
20391 @item
20392  when replying to several messages at once, put the "other" message-ids
20393 into a See-Also header.
20394 @item
20395  support setext: URL:http://www.bsdi.com/setext/
20396 @item
20397  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
20398 @item
20399  when browsing a foreign server, the groups that are already subscribed
20400 should be listed as such and not as "K".
20401 @item
20402  generate font names dynamically.
20403 @item
20404  score file mode auto-alist.
20405 @item
20406  allow nndoc to change/add/delete things from documents.  Implement
20407 methods for each format for adding an article to the document.
20408 @item
20409  `gnus-fetch-old-headers' `all' value to incorporate
20410 absolutely all headers there is.
20411 @item
20412  function like `|', but concatenate all marked articles
20413 and pipe them to the process.
20414 @item
20415  cache the list of killed (or active) groups in a separate file.  Update
20416 the file whenever we read the active file or the list
20417 of killed groups in the .eld file reaches a certain length.
20418 @item
20419  function for starting to edit a file to put into
20420 the current mail group.
20421 @item
20422  score-find-trace should display the total score of the article.
20423 @item
20424  "ghettozie" -- score on Xref header and nix it out after using it
20425 to avoid marking as read in other groups it has been crossposted to.
20426 @item
20427  look at procmail splitting.  The backends should create
20428 the groups automatically if a spool file exists for that group.
20429 @item
20430  function for backends to register themselves with Gnus.
20431 @item
20432  when replying to several process-marked articles,
20433 have all the From end up in Cc headers?  Variable to toggle.
20434 @item
20435  command to delete a crossposted mail article from all
20436 groups it has been mailed to.
20437 @item
20438  `B c' and `B m' should be crosspost aware.
20439 @item
20440  hide-pgp should also hide PGP public key blocks.
20441 @item
20442  Command in the group buffer to respool process-marked groups.
20443 @item
20444  `gnus-summary-find-matching' should accept
20445 pseudo-"headers" like "body", "head" and "all"
20446 @item
20447  When buttifying <URL: > things, all white space (including
20448 newlines) should be ignored.
20449 @item
20450  Process-marking all groups in a topic should process-mark
20451 groups in subtopics as well.
20452 @item
20453  Add non-native groups to the list of killed groups when killing them.
20454 @item
20455  nntp-suggest-kewl-config to probe the nntp server and suggest
20456 variable settings.
20457 @item
20458  add edit and forward secondary marks.
20459 @item
20460  nnml shouldn't visit its .overview files.
20461 @item
20462  allow customizing sorting within gathered threads.
20463 @item
20464  `B q' shouldn't select the current article.
20465 @item
20466  nnmbox should support a newsgroups file for descriptions.
20467 @item
20468  allow fetching mail from several pop servers.
20469 @item
20470  Be able to specify whether the saving commands save the original
20471 or the formatted article.
20472 @item
20473  a command to reparent with the child process-marked (cf. `T ^'.).
20474 @item
20475  I think the possibility to send a password with nntp-open-rlogin
20476 should be a feature in Red Gnus.
20477 @item
20478  The `Z n' command should be possible to execute from a mouse click.
20479 @item
20480  more limiting functions -- date, etc.
20481 @item
20482  be able to limit on a random header; on body; using reverse matches.
20483 @item
20484  a group parameter (`absofucking-total-expiry') that will make Gnus expire
20485 even unread articles.
20486 @item
20487  a command to print the article buffer as postscript.
20488 @item
20489  variable to disable password fetching when opening by nntp-open-telnet.
20490 @item
20491  manual: more example servers -- nntp with rlogin, telnet
20492 @item
20493  checking for bogus groups should clean topic alists as well.
20494 @item
20495  canceling articles in foreign groups.
20496 @item
20497  article number in folded topics isn't properly updated by
20498 Xref handling.
20499 @item
20500  Movement in the group buffer to the next unread group should go to the
20501 next closed topic with unread messages if no group can be found.
20502 @item
20503  Extensive info pages generated on the fly with help everywhere --
20504 in the "*Gnus edit*" buffers, for instance.
20505 @item
20506  Topic movement commands -- like thread movement.  Up, down, forward, next.
20507 @item
20508  a way to tick/mark as read Gcc'd articles.
20509 @item
20510  a way to say that all groups within a specific topic comes
20511 from a particular server?  Hm.
20512 @item
20513  `gnus-article-fill-if-long-lines' -- a function to fill
20514 the article buffer if there are any looong lines there.
20515 @item
20516  `T h' should jump to the parent topic and fold it.
20517 @item
20518  a command to create an ephemeral nndoc group out of a file,
20519 and then splitting it/moving it to some other group/backend.
20520 @item
20521  a group parameter for nnkiboze groups that says that
20522 all kibozed articles should be entered into the cache.
20523 @item
20524  It should also probably be possible to delimit what
20525 `gnus-jog-cache' does -- for instance, work on just some groups, or on
20526 some levels, and entering just articles that have a score higher than
20527 a certain number.
20528 @item
20529  nnfolder should append to the folder instead of re-writing
20530 the entire folder to disk when accepting new messages.
20531 @item
20532  allow all backends to do the proper thing with .gz files.
20533 @item
20534  a backend for reading collections of babyl files nnbabylfolder?
20535 @item
20536  a command for making the native groups into foreign groups.
20537 @item
20538  server mode command for clearing read marks from all groups
20539 from a server.
20540 @item
20541  when following up multiple articles, include all To, Cc, etc headers
20542 from all articles.
20543 @item
20544  a command for deciding what the total score of the current
20545 thread is.  Also a way to highlight based on this.
20546 @item
20547  command to show and edit group scores
20548 @item
20549  a gnus-tree-minimize-horizontal to minimize tree buffers
20550 horizontally.
20551 @item
20552  command to generate nnml overview file for one group.
20553 @item
20554  `C-u C-u a' -- prompt for many crossposted groups.
20555 @item
20556  keep track of which mail groups have received new articles (in this session).
20557 Be able to generate a report and perhaps do some marking in the group
20558 buffer.
20559 @item
20560  gnus-build-sparse-threads to a number -- build only sparse threads
20561 that are of that length.
20562 @item
20563  have nnmh respect mh's unseen sequence in .mh_profile.
20564 @item
20565  cache the newsgroups descriptions locally.
20566 @item
20567  asynchronous posting under nntp.
20568 @item
20569  be able to control word adaptive scoring from the score files.
20570 @item
20571  a variable to make `C-c C-c' post using the "current" select method.
20572 @item
20573  `limit-exclude-low-scored-articles'.
20574 @item
20575  if `gnus-summary-show-thread' is a number, hide threads that have
20576 a score lower than this number.
20577 @item
20578  split newsgroup subscription variable up into "order" and "method".
20579 @item
20580  buttonize ange-ftp file names.
20581 @item
20582  a command to make a duplicate copy of the current article
20583 so that each copy can be edited separately.
20584 @item
20585  nnweb should allow fetching from the local nntp server.
20586 @item
20587  record the sorting done in the summary buffer so that
20588 it can be repeated when limiting/regenerating the buffer.
20589 @item
20590  nnml-generate-nov-databses should generate for
20591 all nnml servers.
20592 @item
20593  when the user does commands in the group buffer, check
20594 the modification time of the .newsrc.eld file and use
20595 ask-user-about-supersession-threat.  Also warn when trying
20596 to save .newsrc.eld and it has changed.
20597 @item
20598  M-g on a topic will display all groups with 0 articles in
20599 the topic.
20600 @item
20601  command to remove all topic stuff.
20602 @item
20603  allow exploding incoming digests when reading incoming mail
20604 and splitting the resulting digests.
20605 @item
20606  nnsoup shouldn't set the `message-' variables.
20607 @item
20608  command to nix out all nnoo state information.
20609 @item
20610  nnmail-process-alist that calls functions if group names
20611 matches an alist -- before saving.
20612 @item
20613  use buffer-invisibility-spec everywhere for hiding text.
20614 @item
20615  variable to activate each group before entering them
20616 to get the (new) number of articles.  `gnus-activate-before-entering'.
20617 @item
20618  command to fetch a Message-ID from any buffer, even
20619 starting Gnus first if necessary.
20620 @item
20621  when posting and checking whether a group exists or not, just
20622 ask the nntp server instead of relying on the active hashtb.
20623 @item
20624  buttonize the output of `C-c C-a' in an apropos-like way.
20625 @item
20626  `G p' should understand process/prefix, and allow editing
20627 of several groups at once.
20628 @item
20629  command to create an ephemeral nnvirtual group that
20630 matches some regexp(s).
20631 @item
20632  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
20633 @item
20634  it should be possible to score "thread" on the From header.
20635 @item
20636  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
20637 @item
20638  `B i' should display the article at once in the summary buffer.
20639 @item
20640  remove the "*" mark at once when unticking an article.
20641 @item
20642  `M-s' should highlight the matching text.
20643 @item
20644  when checking for duplicated mails, use Resent-Message-ID if present.
20645 @item
20646  killing and yanking groups in topics should be better.  If killing one copy
20647 of a group that exists in multiple topics, only that copy should
20648 be removed.  Yanking should insert the copy, and yanking topics
20649 should be possible to be interspersed with the other yankings.
20650 @item
20651  command for enter a group just to read the cached articles.  A way to say
20652 "ignore the nntp connection; just read from the cache."
20653 @item
20654  `X u' should decode base64 articles.
20655 @item
20656  a way to hide all "inner" cited text, leaving just the most
20657 recently cited text.
20658 @item
20659  nnvirtual should be asynchronous.
20660 @item
20661  after editing an article, gnus-original-article-buffer should
20662 be invalidated.
20663 @item
20664  there should probably be a way to make Gnus not connect to the
20665 server and just read the articles in the server
20666 @item
20667  allow a `set-default' (or something) to change the default
20668 value of nnoo variables.
20669 @item
20670  a command to import group infos from a .newsrc.eld file.
20671 @item
20672  groups from secondary servers have the entire select method
20673 listed in each group info.
20674 @item
20675  a command for just switching from the summary buffer to the group
20676 buffer.
20677 @item
20678  a way to specify that some incoming mail washing functions
20679 should only be applied to some groups.
20680 @item
20681  Message `C-f C-t' should ask the user whether to heed
20682 mail-copies-to: never.
20683 @item
20684  new group parameter -- `post-to-server' that says to post
20685 using the current server.  Also a variable to do the same.
20686 @item
20687  the slave dribble files should auto-save to the slave file names.
20688 @item
20689  a group parameter that says what articles to display on group entry, based
20690 on article marks.
20691 @item
20692  a way to visually distinguish slave Gnusae from masters.  (Whip instead
20693 of normal logo?)
20694 @item
20695  Use DJ Bernstein "From " quoting/dequoting, where applicable.
20696 @item
20697  Why is hide-citation-maybe and hide-citation different?  Also
20698 clear up info.
20699 @item
20700  group user-defined meta-parameters.
20701
20702
20703
20704 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
20705 @item
20706  I like the option for trying to retrieve the FAQ for a group and I was
20707 thinking it would be great if for those newsgroups that had archives
20708 you could also try to read the archive for that group.  Part of the
20709 problem is that archives are spread all over the net, unlike FAQs.
20710 What would be best I suppose is to find the one closest to your site.
20711
20712 In any case, there is a list of general news group archives at @*
20713 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
20714
20715
20716
20717
20718 @item
20719 @example
20720 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
20721 (add-hook 'gnus-select-group-hook
20722   (lambda ()
20723     (gnus-group-add-parameter group
20724        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
20725
20726 (defun gnus-user-format-function-d (headers)
20727   "Return the date the group was last read."
20728   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
20729       (t "")))
20730 @end example
20731
20732 @item
20733  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
20734 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
20735 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
20736 hatt forskjellige serveres startup-filer forskjellige steder.
20737
20738
20739 @item
20740 LMI> Well, nnbabyl could alter the group info to heed labels like
20741 LMI> answered and read, I guess.
20742
20743 It could also keep them updated (the same for the Status: header of
20744 unix mbox files).
20745
20746 They could be used like this:
20747
20748
20749 @example
20750 `M l <name> RET' add label <name> to current message.
20751 `M u <name> RET' remove label <name> from current message.
20752 `/ l <expr> RET' limit summary buffer according to <expr>.
20753
20754 <expr> would be a boolean expression on the labels, e.g.
20755
20756 `/ l bug & !fixed RET'
20757 @end example
20758
20759 would show all the messages which are labeled `bug' but not labeled
20760 `fixed'.
20761
20762 One could also imagine the labels being used for highlighting, or
20763 affect the summary line format.
20764
20765
20766 @item
20767 Sender: abraham@@dina.kvl.dk
20768
20769 I'd like a gnus-find-file which work like find file, except that it
20770 would recognize things that looks like messages or folders:
20771
20772 - If it is a directory containing numbered files, create an nndir
20773 summary buffer.
20774
20775 - For other directories, create a nneething summary buffer.
20776
20777 - For files matching "\\`From ", create a nndoc/mbox summary.
20778
20779 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
20780
20781 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
20782
20783 - For other files, just find them normally.
20784
20785 I'd like `nneething' to use this function, so it would work on a
20786 directory potentially containing mboxes or babyl files.
20787
20788 @item
20789 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
20790 tell him what you are doing.
20791
20792 @item
20793 Currently, I get prompted:
20794
20795 decend into sci?
20796 - type y
20797 decend into sci.something ?
20798 - type n
20799 decend into ucd?
20800
20801 The problem above is that since there is really only one subsection of
20802 science, shouldn't it prompt you for only descending sci.something?  If
20803 there was a sci.somethingelse group or section, then it should prompt
20804 for sci? first the sci.something? then sci.somethingelse?...
20805
20806 @item
20807 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
20808 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
20809 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
20810 "no.all.SCORE", osv.
20811
20812 @item
20813 What i want is for Gnus to treat any sequence or combination of the following
20814 as a single spoiler warning and hide it all, replacing it with a "Next Page"
20815 button:
20816
20817
20818 ^L's
20819
20820 more than n blank lines
20821
20822 more than m identical lines
20823 (which should be replaced with button to show them)
20824
20825 any whitespace surrounding any of the above
20826
20827
20828 @item
20829 Well, we could allow a new value to `gnus-thread-ignore-subject' --
20830 `spaces', or something.  (We could even default to that.)  And then
20831 subjects that differ in white space only could be considered the
20832 "same" subject for threading purposes.
20833
20834 @item
20835 Modes to preprocess the contents (e.g. jka-compr) use the second form
20836 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
20837 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
20838 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
20839
20840 @item
20841  Under XEmacs -- do funny article marks:
20842 tick - thumb tack
20843 killed - skull
20844 soup - bowl of soup
20845 score below - dim light bulb
20846 score over - bright light bulb
20847
20848 @item
20849 Yes. I think the algorithm is as follows:
20850
20851 @example
20852 Group-mode
20853
20854    show-list-of-articles-in-group
20855         if (key-pressed == SPACE)
20856                 if (no-more-articles-in-group-to-select)
20857                         if (articles-selected)
20858                                 start-reading-selected-articles;
20859                         junk-unread-articles;
20860                         next-group;
20861                  else
20862                         show-next-page;
20863
20864          else if (key-pressed = '.')
20865                 if (consolidated-menus)         # same as hide-thread in Gnus
20866                         select-thread-under-cursor;
20867                 else
20868                         select-article-under-cursor;
20869
20870
20871 Article-mode
20872         if (key-pressed == SPACE)
20873                 if (more-pages-in-article)
20874                         next-page;
20875                 else if (more-selected-articles-to-read)
20876                         next-article;
20877                 else
20878                         next-group;
20879 @end example
20880
20881 @item
20882 My precise need here would have been to limit files to Incoming*.
20883 One could think of some `nneething-only-files' variable, but I guess
20884 it would have been unacceptable if one was using many unrelated such
20885 nneething groups.
20886
20887 A more useful approach would be to, in response to the `G D' prompt, be
20888 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
20889 the top-level directory only (in case directories would be matched by
20890 the wildcard expression).
20891
20892 @item
20893 It would be nice if it also handled
20894
20895         <URL:news://sunsite.auc.dk/>
20896
20897 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
20898
20899
20900 @item
20901
20902   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
20903 really well.  Each menu is 'named' by a symbol that would be on a
20904 gnus-*-menus (where * would be whatever, but at least group, summary, and
20905 article versions) variable.
20906
20907   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
20908
20909   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
20910 the main menubar.  This approach works really well for Emacs-W3 and VM.
20911
20912
20913 @item
20914  nndoc should take care to create unique Message-IDs for all its
20915 articles.
20916 @item
20917  gnus-score-followup-article only works when you have a summary buffer
20918 active.  Make it work when posting from the group buffer as well.
20919 (message-sent-hook).
20920 @item
20921  rewrite gnus-demon to use run-with-idle-timers.
20922
20923 @item
20924  * Enhancements to Gnus:
20925
20926   Add two commands:
20927
20928   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
20929     straight to the server buffer, without opening any connections to
20930     servers first.
20931
20932   * gnus-server-read-server-newsrc--produces a buffer very similar to
20933     the group buffer, but with only groups from that server listed;
20934     quitting this buffer returns to the server buffer.
20935
20936 @item
20937  add a command to check the integrity of an nnfolder folder --
20938 go through the article numbers and see that there are no duplicates,
20939 and stuff.
20940
20941 @item
20942  `unsmileyfy-buffer' to undo smileification.
20943
20944 @item
20945  a command to give all relevant info on an article, including all
20946 secondary marks.
20947
20948 @item
20949  when doing `-request-accept-article', the backends should do
20950 the nnmail duplicate checking.
20951
20952 @item
20953  allow `message-signature-file' to be a function to return the
20954 value of the signature file.
20955
20956 @item
20957  In addition, I would love it if I could configure message-tab so that it
20958 could call `bbdb-complete-name' in other headers.  So, some sort of
20959 interface like
20960
20961 (setq message-tab-alist
20962       '((message-header-regexp message-expand-group)
20963         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
20964
20965 then you could run the relevant function to complete the information in
20966 the header
20967
20968 @item
20969  cache the newsgroups file locally to avoid reloading it all the time.
20970
20971 @item
20972  a command to import a buffer into a group.
20973
20974 @item
20975  nnweb should allow fetching by Message-ID from servers.
20976
20977 @item
20978  point in the article buffer doesn't always go to the
20979 beginning of the buffer when selecting new articles.
20980
20981 @item
20982  a command to process mark all unread articles.
20983
20984 @item
20985  `gnus-gather-threads-by-references-and-subject' -- first
20986 do gathering by references, and then go through the dummy roots and
20987 do more gathering by subject.
20988
20989 @item
20990  gnus-uu-mark-in-numerical-order -- process mark articles in
20991 article numerical order.
20992
20993 @item
20994  (gnus-thread-total-score
20995  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
20996 bind to a key.
20997
20998 @item
20999  sorting by score is wrong when using sparse threads.
21000
21001 @item
21002  a command to fetch an arbitrary article -- without having to be
21003 in the summary buffer.
21004
21005 @item
21006  a new nncvs backend.  Each group would show an article, using
21007 version branches as threading, checkin date as the date, etc.
21008
21009 @item
21010  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
21011 This filter allows one to construct advance queries on the Dejanews
21012 database such as specifying start and end dates, subject, author,
21013 and/or newsgroup name.
21014
21015 @item
21016  new Date header scoring type -- older, newer
21017
21018 @item
21019  use the summary toolbar in the article buffer.
21020
21021 @item
21022  a command to fetch all articles that are less than X days old.
21023
21024 @item
21025  in pick mode, `q' should save the list of selected articles in the
21026 group info.  The next time the group is selected, these articles
21027 will automatically get the process mark.
21028
21029 @item
21030  Isn't it possible to (also?) allow M-^ to automatically try the
21031 default server if it fails on the current server?  (controlled by a
21032 user variable, (nil, t, 'ask)).
21033
21034 @item
21035  make it possible to cancel articles using the select method for the
21036 current group.
21037
21038 @item
21039  `gnus-summary-select-article-on-entry' or something.  It'll default
21040 to t and will select whatever article decided by `gnus-auto-select-first'.
21041
21042 @item
21043  a new variable to control which selection commands should be unselecting.
21044 `first', `best', `next', `prev', `next-unread', `prev-unread' are
21045 candidates.
21046
21047 @item
21048  be able to select groups that have no articles in them
21049 to be able to post in them (using the current select method).
21050
21051 @item
21052  be able to post via DejaNews.
21053
21054 @item
21055  `x' should retain any sortings that have been performed.
21056
21057 @item
21058  allow the user to specify the precedence of the secondary marks.  Also
21059 allow them to be displayed separately.
21060
21061 @item
21062  gnus-summary-save-in-pipe should concatenate the results from
21063 the processes when doing a process marked pipe.
21064
21065 @item
21066  a new match type, like Followup, but which adds Thread matches on all
21067 articles that match a certain From header.
21068
21069 @item
21070  a function that can be read from kill-emacs-query-functions to offer
21071 saving living summary buffers.
21072
21073 @item
21074  a function for selecting a particular group which will contain
21075 the articles listed in a list of article numbers/id's.
21076
21077 @item
21078  a battery of character translation functions to translate common
21079 Mac, MS (etc) characters into ISO 8859-1.
21080
21081 @example
21082 (defun article-fix-m$word ()
21083   "Fix M$Word smartquotes in an article."
21084   (interactive)
21085   (save-excursion
21086     (let ((buffer-read-only nil))
21087       (goto-char (point-min))
21088       (while (search-forward "\221" nil t)
21089         (replace-match "`" t t))
21090       (goto-char (point-min))
21091       (while (search-forward "\222" nil t)
21092         (replace-match "'" t t))
21093       (goto-char (point-min))
21094       (while (search-forward "\223" nil t)
21095         (replace-match "\"" t t))
21096       (goto-char (point-min))
21097       (while (search-forward "\224" nil t)
21098         (replace-match "\"" t t)))))
21099 @end example
21100
21101 @item
21102 @example
21103  (add-hook 'gnus-exit-query-functions
21104 '(lambda ()
21105    (if (and (file-exists-p nnmail-spool-file)
21106             (> (nnheader-file-size nnmail-spool-file) 0))
21107        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
21108        (y-or-n-p "Are you sure you want to quit Gnus? "))))
21109 @end example
21110
21111 @item
21112  allow message-default-headers to be a function.
21113
21114 @item
21115  new Date score match types -- < > = (etc) that take floating point
21116 numbers and match on the age of the article.
21117
21118 @item
21119 @example
21120 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
21121 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
21122 >  > > buffer in the frame that it was called from =:-O
21123 >
21124 >  > Hm.  How do you start up Gnus?  From the toolbar or with
21125 >  > `M-x gnus-other-frame'?
21126 >
21127 >    I normally start it up from the toolbar; at
21128 > least that's the way I've caught it doing the
21129 > deed before.
21130 @end example
21131
21132 @item
21133  all commands that react to the process mark should push
21134 the current process mark set onto the stack.
21135
21136 @item
21137  gnus-article-hide-pgp
21138 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
21139 @example
21140 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
21141 @end example
21142 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
21143 er min type heuristikk og langt fra alles.
21144
21145 @item
21146  `gnus-subscribe-sorted' -- insert new groups where they would have been
21147 sorted to if `gnus-group-sort-function' were run.
21148
21149 @item
21150  gnus-(group,summary)-highlight should respect any `face' text props set
21151 on the lines.
21152
21153 @item
21154  use run-with-idle-timer for gnus-demon instead of the
21155 home-brewed stuff for better reliability.
21156
21157 @item
21158  add a way to select which NoCeM type to apply -- spam, troll, etc.
21159
21160 @item
21161  nndraft-request-group should tally auto-save files.
21162
21163 @item
21164  implement nntp-retry-on-break and nntp-command-timeout.
21165
21166 @item
21167  gnus-article-highlight-limit that says when not to highlight (long)
21168 articles.
21169
21170 @item
21171  (nnoo-set SERVER VARIABLE VALUE)
21172
21173 @item
21174  nn*-spool-methods
21175
21176 @item
21177  interrupitng agent fetching of articles should save articles.
21178
21179 @item
21180  command to open a digest group, and copy all the articles there to the
21181 current group.
21182
21183 @item
21184  a variable to disable article body highlights if there's more than
21185 X characters in the body.
21186
21187 @item
21188  handle 480/381 authinfo requests separately.
21189
21190 @item
21191  include the texi/dir file in the distribution.
21192
21193 @item
21194  format spec to "tab" to a position.
21195
21196 @item
21197  Move all prompting to the new `M-n' default style.
21198
21199 @item
21200  command to display all dormant articles.
21201
21202 @item
21203  gnus-auto-select-next makeover -- list of things it should do.
21204
21205 @item
21206  a score match type that adds scores matching on From if From has replied
21207 to something someone else has said.
21208
21209 @item
21210  Read Netscape discussion groups:
21211 snews://secnews.netscape.com/netscape.communicator.unix
21212
21213 @item
21214 One command to edit the original version if an article, and one to edit
21215 the displayed version.
21216
21217 @item
21218 @kbd{T v} -- make all process-marked articles the children of the
21219 current article.
21220
21221 @item
21222 Switch from initial text to the new default text mechanism.
21223
21224 @item
21225 How about making it possible to expire local articles?  Will it be
21226 possible to make various constraints on when an article can be
21227 expired, e.g. (read), (age > 14 days), or the more interesting (read
21228 & age > 14 days)?
21229
21230 @item
21231 New limit command---limit to articles that have a certain string
21232 in the head or body.
21233
21234 @item
21235 Allow breaking lengthy @sc{nntp} commands.
21236
21237 @item
21238 gnus-article-highlight-limit, to disable highlighting in big articles.
21239
21240 @item
21241 Editing an article should put the article to be edited
21242 in a special, unique buffer.
21243
21244 @item
21245 A command to send a mail to the admin-address group param.
21246
21247 @item
21248 A Date scoring type that will match if the article
21249 is less than a certain number of days old.
21250
21251 @item
21252 New spec: %~(tab 56) to put point on column 56
21253
21254 @item
21255 Allow Gnus Agent scoring to use normal score files.
21256
21257 @item
21258 Rething the Agent active file thing.  `M-g' doesn't update the active
21259 file, for instance.
21260
21261 @item
21262 With dummy roots, `^' and then selecing the first article
21263 in any other dummy thread will make gnus highlight the
21264 dummy root instead of the first article.
21265
21266 @item
21267 Propagate all group properties (marks, article numbers, etc) up to the
21268 topics for displaying.
21269
21270 @item
21271 `n' in the group buffer with topics should go to the next group
21272 with unread articles, even if that group is hidden in a topic.
21273
21274 @item
21275 gnus-posting-styles doesn't work in drafts.
21276
21277 @item
21278 gnus-summary-limit-include-cached is slow when there are
21279 many articles in the cache, since it regenerates big parts of the
21280 summary buffer for each article.
21281
21282 @item
21283 Implement gnus-batch-brew-soup.
21284
21285 @item
21286 Group parameters and summary commands for un/subscribing to mailing
21287 lists.
21288
21289 @item
21290 Introduce nnmail-home-directory.
21291
21292 @item
21293 gnus-fetch-group and friends should exit Gnus when the user
21294 exits the group.
21295
21296 @item
21297 The jingle is only played on the second invocation of Gnus.
21298
21299 @item
21300 Bouncing articles should do MIME.
21301
21302 @item
21303 Crossposted articles should "inherit" the % or @ mark from the other
21304 groups it has been crossposted to, or something.  (Agent.)
21305
21306 @item
21307 If point is on a group that appears multiple times in topics, and
21308 you press `l', point will move to the first instance of the group.
21309
21310 @item
21311 A spec for the group line format to display the number of
21312 agent-downloaded articles in the group.
21313
21314 @item
21315 Some nntp servers never respond when posting, so there should be a
21316 timeout for all commands.
21317
21318 @item
21319 When stading on a topic line and `t'-ing, point goes to the last line.
21320 It should go somewhere else.
21321
21322 @item
21323 I'm having trouble accessing a newsgroup with a "+" in its name with
21324 Gnus.  There is a new newsgroup on msnews.microsoft.com named
21325 "microsoft.public.multimedia.directx.html+time" that I'm trying to
21326 access as
21327 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
21328 but it gives an error that it cant access the group.
21329
21330 Is the "+" character illegal in newsgroup names?  Is there any way in
21331 Gnus to work around this?  (gnus 5.6.45 - XEmacs 20.4)
21332
21333 @item
21334
21335 When `#F', do:
21336
21337 @example
21338 Subject: Answer to your mails 01.01.1999-01.05.1999
21339  --text follows this line--
21340 Sorry I killfiled you...
21341
21342 Under the subject "foo", you wrote on 01.01.1999:
21343 > bar
21344 Under the subject "foo1", you wrote on 01.01.1999:
21345 > bar 1
21346 @end example
21347
21348 @item
21349 Allow "orphan" scores in the Agent scoring.
21350
21351 @item
21352 @example
21353     - Edit article's summary line.
21354     - End edit
21355     - Sort lines in buffer by subject
21356
21357     --> the old subject line appears in Summary buffer, not the one that was
21358     just changed to.
21359 @end example
21360
21361
21362 @item
21363 Remove list identifiers from the subject in the summary when doing `^'
21364 and the like.
21365
21366 @item
21367 Have the Agent write out articles, one by one, as it retrieves them,
21368 to avoid having to re-fetch them all if Emacs should crash while
21369 fetching. 
21370
21371 @item
21372 Be able to forward groups of messages as MIME digests.
21373
21374 @item
21375 nnweb should include the "get whole article" article when getting articles. 
21376
21377 @item
21378 When I type W W c (gnus-article-hide-citation) in the summary
21379 buffer, the citations are revealed, but the [+] buttons don't turn
21380 into [-] buttons.  (If I click on one of the [+] buttons, it does
21381 turn into a [-] button.)
21382
21383 @item
21384 Perhaps there should be a command to "attach" a buffer of comments to
21385 a message?  That is, `B WHATEVER', you're popped into a buffer, write
21386 something, end with `C-c C-c', and then the thing you've written gets
21387 to be the child of the message you're commenting.
21388
21389 @item
21390 Handle external-body parts.
21391
21392 @item
21393 When renaming a group name, nnmail-split-history does not get the group
21394 name renamed.
21395
21396 @item
21397 Allow mail splitting on bodies when using advanced mail splitting.
21398
21399 @lisp
21400   (body "whatever.text")
21401 @end lisp
21402
21403 @item
21404 Be able to run `J u' from summary buffers.
21405
21406 @item
21407 Solve the halting problem.
21408
21409 @c TODO
21410 @end itemize
21411
21412 @iftex
21413
21414 @page
21415 @node The Manual
21416 @section The Manual
21417 @cindex colophon
21418 @cindex manual
21419
21420 This manual was generated from a TeXinfo file and then run through
21421 either @code{texi2dvi}
21422 @iflatex
21423 or my own home-brewed TeXinfo to \LaTeX\ transformer,
21424 and then run through @code{latex} and @code{dvips}
21425 @end iflatex
21426 to get what you hold in your hands now.
21427
21428 The following conventions have been used:
21429
21430 @enumerate
21431
21432 @item
21433 This is a @samp{string}
21434
21435 @item
21436 This is a @kbd{keystroke}
21437
21438 @item
21439 This is a @file{file}
21440
21441 @item
21442 This is a @code{symbol}
21443
21444 @end enumerate
21445
21446 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
21447 mean:
21448
21449 @lisp
21450 (setq flargnoze "yes")
21451 @end lisp
21452
21453 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
21454
21455 @lisp
21456 (setq flumphel 'yes)
21457 @end lisp
21458
21459 @samp{yes} and @code{yes} are two @emph{very} different things---don't
21460 ever get them confused.
21461
21462 @iflatex
21463 @c @head
21464 Of course, everything in this manual is of vital interest, so you should
21465 read it all.  Several times.  However, if you feel like skimming the
21466 manual, look for that gnu head you should see in the margin over
21467 there---it means that what's being discussed is of more importance than
21468 the rest of the stuff.  (On the other hand, if everything is infinitely
21469 important, how can anything be more important than that?  Just one more
21470 of the mysteries of this world, I guess.)
21471 @end iflatex
21472
21473 @end iftex
21474
21475
21476 @node On Writing Manuals
21477 @section On Writing Manuals
21478
21479 I guess most manuals are written after-the-fact; documenting a program
21480 that's already there.  This is not how this manual is written.  When
21481 implementing something, I write the manual entry for that something
21482 straight away.  I then see that it's difficult to explain the
21483 functionality, so I write how it's supposed to be, and then I change the 
21484 implementation.  Writing the documentation and writing the code goes
21485 hand in hand.
21486
21487 This, of course, means that this manual has no, or little, flow.  It
21488 documents absolutely everything in Gnus, but often not where you're
21489 looking for it.  It is a reference manual, and not a guide to how to get 
21490 started with Gnus.
21491
21492 That would be a totally different book, that should be written using the 
21493 reference manual as source material.  It would look quite differently.
21494
21495
21496 @page
21497 @node Terminology
21498 @section Terminology
21499
21500 @cindex terminology
21501 @table @dfn
21502
21503 @item news
21504 @cindex news
21505 This is what you are supposed to use this thing for---reading news.
21506 News is generally fetched from a nearby @sc{nntp} server, and is
21507 generally publicly available to everybody.  If you post news, the entire
21508 world is likely to read just what you have written, and they'll all
21509 snigger mischievously.  Behind your back.
21510
21511 @item mail
21512 @cindex mail
21513 Everything that's delivered to you personally is mail.  Some news/mail
21514 readers (like Gnus) blur the distinction between mail and news, but
21515 there is a difference.  Mail is private.  News is public.  Mailing is
21516 not posting, and replying is not following up.
21517
21518 @item reply
21519 @cindex reply
21520 Send a mail to the person who has written what you are reading.
21521
21522 @item follow up
21523 @cindex follow up
21524 Post an article to the current newsgroup responding to the article you
21525 are reading.
21526
21527 @item backend
21528 @cindex backend
21529 Gnus gets fed articles from a number of backends, both news and mail
21530 backends.  Gnus does not handle the underlying media, so to speak---this
21531 is all done by the backends.
21532
21533 @item native
21534 @cindex native
21535 Gnus will always use one method (and backend) as the @dfn{native}, or
21536 default, way of getting news.
21537
21538 @item foreign
21539 @cindex foreign
21540 You can also have any number of foreign groups active at the same time.
21541 These are groups that use non-native non-secondary backends for getting
21542 news.
21543
21544 @item secondary
21545 @cindex secondary
21546 Secondary backends are somewhere half-way between being native and being
21547 foreign, but they mostly act like they are native.
21548
21549 @item article
21550 @cindex article
21551 A message that has been posted as news.
21552
21553 @item mail message
21554 @cindex mail message
21555 A message that has been mailed.
21556
21557 @item message
21558 @cindex message
21559 A mail message or news article
21560
21561 @item head
21562 @cindex head
21563 The top part of a message, where administrative information (etc.) is
21564 put.
21565
21566 @item body
21567 @cindex body
21568 The rest of an article.  Everything not in the head is in the
21569 body.
21570
21571 @item header
21572 @cindex header
21573 A line from the head of an article.
21574
21575 @item headers
21576 @cindex headers
21577 A collection of such lines, or a collection of heads.  Or even a
21578 collection of @sc{nov} lines.
21579
21580 @item @sc{nov}
21581 @cindex nov
21582 When Gnus enters a group, it asks the backend for the headers of all
21583 unread articles in the group.  Most servers support the News OverView
21584 format, which is more compact and much faster to read and parse than the
21585 normal @sc{head} format.
21586
21587 @item level
21588 @cindex levels
21589 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
21590 that have a lower level are ``more'' subscribed than the groups with a
21591 higher level.  In fact, groups on levels 1-5 are considered
21592 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
21593 are @dfn{killed}.  Commands for listing groups and scanning for new
21594 articles will all use the numeric prefix as @dfn{working level}.
21595
21596 @item killed groups
21597 @cindex killed groups
21598 No information on killed groups is stored or updated, which makes killed
21599 groups much easier to handle than subscribed groups.
21600
21601 @item zombie groups
21602 @cindex zombie groups
21603 Just like killed groups, only slightly less dead.
21604
21605 @item active file
21606 @cindex active file
21607 The news server has to keep track of what articles it carries, and what
21608 groups exist.  All this information in stored in the active file, which
21609 is rather large, as you might surmise.
21610
21611 @item bogus groups
21612 @cindex bogus groups
21613 A group that exists in the @file{.newsrc} file, but isn't known to the
21614 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
21615 This means that the group probably doesn't exist (any more).
21616
21617 @item activating
21618 @cindex activating groups
21619 The act of asking the server for info on a group and computing the
21620 number of unread articles is called @dfn{activating the group}.
21621 Un-activated groups are listed with @samp{*} in the group buffer.
21622
21623 @item server
21624 @cindex server
21625 A machine one can connect to and get news (or mail) from.
21626
21627 @item select method
21628 @cindex select method
21629 A structure that specifies the backend, the server and the virtual
21630 server settings.
21631
21632 @item virtual server
21633 @cindex virtual server
21634 A named select method.  Since a select method defines all there is to
21635 know about connecting to a (physical) server, taking the thing as a
21636 whole is a virtual server.
21637
21638 @item washing
21639 @cindex washing
21640 Taking a buffer and running it through a filter of some sort.  The
21641 result will (more often than not) be cleaner and more pleasing than the
21642 original.
21643
21644 @item ephemeral groups
21645 @cindex ephemeral groups
21646 Most groups store data on what articles you have read.  @dfn{Ephemeral}
21647 groups are groups that will have no data stored---when you exit the
21648 group, it'll disappear into the aether.
21649
21650 @item solid groups
21651 @cindex solid groups
21652 This is the opposite of ephemeral groups.  All groups listed in the
21653 group buffer are solid groups.
21654
21655 @item sparse articles
21656 @cindex sparse articles
21657 These are article placeholders shown in the summary buffer when
21658 @code{gnus-build-sparse-threads} has been switched on.
21659
21660 @item threading
21661 @cindex threading
21662 To put responses to articles directly after the articles they respond
21663 to---in a hierarchical fashion.
21664
21665 @item root
21666 @cindex root
21667 @cindex thread root
21668 The first article in a thread is the root.  It is the ancestor of all
21669 articles in the thread.
21670
21671 @item parent
21672 @cindex parent
21673 An article that has responses.
21674
21675 @item child
21676 @cindex child
21677 An article that responds to a different article---its parent.
21678
21679 @item digest
21680 @cindex digest
21681 A collection of messages in one file.  The most common digest format is
21682 specified by RFC 1153.
21683
21684 @end table
21685
21686
21687 @page
21688 @node Customization
21689 @section Customization
21690 @cindex general customization
21691
21692 All variables are properly documented elsewhere in this manual.  This
21693 section is designed to give general pointers on how to customize Gnus
21694 for some quite common situations.
21695
21696 @menu
21697 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
21698 * Slow Terminal Connection::  You run a remote Emacs.
21699 * Little Disk Space::         You feel that having large setup files is icky.
21700 * Slow Machine::              You feel like buying a faster machine.
21701 @end menu
21702
21703
21704 @node Slow/Expensive Connection
21705 @subsection Slow/Expensive @sc{nntp} Connection
21706
21707 If you run Emacs on a machine locally, and get your news from a machine
21708 over some very thin strings, you want to cut down on the amount of data
21709 Gnus has to get from the @sc{nntp} server.
21710
21711 @table @code
21712
21713 @item gnus-read-active-file
21714 Set this to @code{nil}, which will inhibit Gnus from requesting the
21715 entire active file from the server.  This file is often v.  large.  You
21716 also have to set @code{gnus-check-new-newsgroups} and
21717 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
21718 doesn't suddenly decide to fetch the active file anyway.
21719
21720 @item gnus-nov-is-evil
21721 This one has to be @code{nil}.  If not, grabbing article headers from
21722 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
21723 support @sc{xover}; Gnus will detect this by itself.
21724 @end table
21725
21726
21727 @node Slow Terminal Connection
21728 @subsection Slow Terminal Connection
21729
21730 Let's say you use your home computer for dialing up the system that runs
21731 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
21732 possible) the amount of data sent over the wires.
21733
21734 @table @code
21735
21736 @item gnus-auto-center-summary
21737 Set this to @code{nil} to inhibit Gnus from re-centering the summary
21738 buffer all the time.  If it is @code{vertical}, do only vertical
21739 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
21740 horizontal and vertical recentering.
21741
21742 @item gnus-visible-headers
21743 Cut down on the headers included in the articles to the
21744 minimum.  You can, in fact, make do without them altogether---most of the
21745 useful data is in the summary buffer, anyway.  Set this variable to
21746 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
21747
21748 Set this hook to all the available hiding commands:
21749 @lisp
21750 (setq gnus-treat-hide-headers 'head
21751       gnus-treat-hide-signature t
21752       gnus-treat-hide-citation t)
21753 @end lisp
21754
21755 @item gnus-use-full-window
21756 By setting this to @code{nil}, you can make all the windows smaller.
21757 While this doesn't really cut down much generally, it means that you
21758 have to see smaller portions of articles before deciding that you didn't
21759 want to read them anyway.
21760
21761 @item gnus-thread-hide-subtree
21762 If this is non-@code{nil}, all threads in the summary buffer will be
21763 hidden initially.
21764
21765 @item gnus-updated-mode-lines
21766 If this is @code{nil}, Gnus will not put information in the buffer mode
21767 lines, which might save some time.
21768 @end table
21769
21770
21771 @node Little Disk Space
21772 @subsection Little Disk Space
21773 @cindex disk space
21774
21775 The startup files can get rather large, so you may want to cut their
21776 sizes a bit if you are running out of space.
21777
21778 @table @code
21779
21780 @item gnus-save-newsrc-file
21781 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
21782 only save @file{.newsrc.eld}.  This means that you will not be able to
21783 use any other newsreaders than Gnus.  This variable is @code{t} by
21784 default.
21785
21786 @item gnus-read-newsrc-file
21787 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
21788 only read @file{.newsrc.eld}.  This means that you will not be able to
21789 use any other newsreaders than Gnus.  This variable is @code{t} by
21790 default.
21791
21792 @item gnus-save-killed-list
21793 If this is @code{nil}, Gnus will not save the list of dead groups.  You
21794 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
21795 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
21796 variable to @code{nil}.  This variable is @code{t} by default.
21797
21798 @end table
21799
21800
21801 @node Slow Machine
21802 @subsection Slow Machine
21803 @cindex slow machine
21804
21805 If you have a slow machine, or are just really impatient, there are a
21806 few things you can do to make Gnus run faster.
21807
21808 Set @code{gnus-check-new-newsgroups} and
21809 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
21810
21811 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
21812 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
21813 summary buffer faster.
21814
21815
21816 @page
21817 @node Troubleshooting
21818 @section Troubleshooting
21819 @cindex troubleshooting
21820
21821 Gnus works @emph{so} well straight out of the box---I can't imagine any
21822 problems, really.
21823
21824 Ahem.
21825
21826 @enumerate
21827
21828 @item
21829 Make sure your computer is switched on.
21830
21831 @item
21832 Make sure that you really load the current Gnus version.  If you have
21833 been running @sc{gnus}, you need to exit Emacs and start it up again before
21834 Gnus will work.
21835
21836 @item
21837 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
21838 like @samp{T-gnus 6.14.* (based on Pterodactyl Gnus v0.*; for SEMI 1.1*,
21839 FLIM 1.1*)} you have the right files loaded.  If, on the other hand, you
21840 get something like @samp{NNTP 3.x} or @samp{nntp flee}, you have some
21841 old @file{.el} files lying around.  Delete these.
21842
21843 @item
21844 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
21845 how-to.
21846
21847 @item
21848 @vindex max-lisp-eval-depth
21849 Gnus works on many recursive structures, and in some extreme (and very
21850 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
21851 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
21852 something like that.
21853 @end enumerate
21854
21855 If all else fails, report the problem as a bug.
21856
21857 @cindex bugs
21858 @cindex reporting bugs
21859
21860 @kindex M-x gnus-bug
21861 @findex gnus-bug
21862 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
21863 command.  @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
21864 me the backtrace.  I will fix bugs, but I can only fix them if you send
21865 me a precise description as to how to reproduce the bug.
21866
21867 You really can never be too detailed in a bug report.  Always use the
21868 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
21869 a 10Kb mail each time you use it, and even if you have sent me your
21870 environment 500 times before.  I don't care.  I want the full info each
21871 time.
21872
21873 It is also important to remember that I have no memory whatsoever.  If
21874 you send a bug report, and I send you a reply, and then you just send
21875 back ``No, it's not! Moron!'', I will have no idea what you are
21876 insulting me about.  Always over-explain everything.  It's much easier
21877 for all of us---if I don't have all the information I need, I will just
21878 mail you and ask for more info, and everything takes more time.
21879
21880 If the problem you're seeing is very visual, and you can't quite explain
21881 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
21882 it somewhere it can be reached, and include the URL of the picture in
21883 the bug report.
21884
21885 If you just need help, you are better off asking on
21886 @samp{gnu.emacs.gnus}.  I'm not very helpful.
21887
21888 @cindex gnu.emacs.gnus
21889 @cindex ding mailing list
21890 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
21891 Write to @samp{ding-request@@gnus.org} to subscribe.
21892
21893
21894 @page
21895 @node Gnus Reference Guide
21896 @section Gnus Reference Guide
21897
21898 It is my hope that other people will figure out smart stuff that Gnus
21899 can do, and that other people will write those smart things as well.  To
21900 facilitate that I thought it would be a good idea to describe the inner
21901 workings of Gnus.  And some of the not-so-inner workings, while I'm at
21902 it.
21903
21904 You can never expect the internals of a program not to change, but I
21905 will be defining (in some details) the interface between Gnus and its
21906 backends (this is written in stone), the format of the score files
21907 (ditto), data structures (some are less likely to change than others)
21908 and general methods of operation.
21909
21910 @menu
21911 * Gnus Utility Functions::   Common functions and variable to use.
21912 * Backend Interface::        How Gnus communicates with the servers.
21913 * Score File Syntax::        A BNF definition of the score file standard.
21914 * Headers::                  How Gnus stores headers internally.
21915 * Ranges::                   A handy format for storing mucho numbers.
21916 * Group Info::               The group info format.
21917 * Extended Interactive::     Symbolic prefixes and stuff.
21918 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
21919 * Various File Formats::     Formats of files that Gnus use.
21920 @end menu
21921
21922
21923 @node Gnus Utility Functions
21924 @subsection Gnus Utility Functions
21925 @cindex Gnus utility functions
21926 @cindex utility functions
21927 @cindex functions
21928 @cindex internal variables
21929
21930 When writing small functions to be run from hooks (and stuff), it's
21931 vital to have access to the Gnus internal functions and variables.
21932 Below is a list of the most common ones.
21933
21934 @table @code
21935
21936 @item gnus-newsgroup-name
21937 @vindex gnus-newsgroup-name
21938 This variable holds the name of the current newsgroup.
21939
21940 @item gnus-find-method-for-group
21941 @findex gnus-find-method-for-group
21942 A function that returns the select method for @var{group}.
21943
21944 @item gnus-group-real-name
21945 @findex gnus-group-real-name
21946 Takes a full (prefixed) Gnus group name, and returns the unprefixed
21947 name.
21948
21949 @item gnus-group-prefixed-name
21950 @findex gnus-group-prefixed-name
21951 Takes an unprefixed group name and a select method, and returns the full
21952 (prefixed) Gnus group name.
21953
21954 @item gnus-get-info
21955 @findex gnus-get-info
21956 Returns the group info list for @var{group}.
21957
21958 @item gnus-group-unread
21959 @findex gnus-group-unread
21960 The number of unread articles in @var{group}, or @code{t} if that is
21961 unknown.
21962
21963 @item gnus-active
21964 @findex gnus-active
21965 The active entry for @var{group}.
21966
21967 @item gnus-set-active
21968 @findex gnus-set-active
21969 Set the active entry for @var{group}.
21970
21971 @item gnus-add-current-to-buffer-list
21972 @findex gnus-add-current-to-buffer-list
21973 Adds the current buffer to the list of buffers to be killed on Gnus
21974 exit.
21975
21976 @item gnus-continuum-version
21977 @findex gnus-continuum-version
21978 Takes a Gnus version string as a parameter and returns a floating point
21979 number.  Earlier versions will always get a lower number than later
21980 versions.
21981
21982 @item gnus-group-read-only-p
21983 @findex gnus-group-read-only-p
21984 Says whether @var{group} is read-only or not.
21985
21986 @item gnus-news-group-p
21987 @findex gnus-news-group-p
21988 Says whether @var{group} came from a news backend.
21989
21990 @item gnus-ephemeral-group-p
21991 @findex gnus-ephemeral-group-p
21992 Says whether @var{group} is ephemeral or not.
21993
21994 @item gnus-server-to-method
21995 @findex gnus-server-to-method
21996 Returns the select method corresponding to @var{server}.
21997
21998 @item gnus-server-equal
21999 @findex gnus-server-equal
22000 Says whether two virtual servers are equal.
22001
22002 @item gnus-group-native-p
22003 @findex gnus-group-native-p
22004 Says whether @var{group} is native or not.
22005
22006 @item gnus-group-secondary-p
22007 @findex gnus-group-secondary-p
22008 Says whether @var{group} is secondary or not.
22009
22010 @item gnus-group-foreign-p
22011 @findex gnus-group-foreign-p
22012 Says whether @var{group} is foreign or not.
22013
22014 @item group-group-find-parameter
22015 @findex group-group-find-parameter
22016 Returns the parameter list of @var{group}.  If given a second parameter,
22017 returns the value of that parameter for @var{group}.
22018
22019 @item gnus-group-set-parameter
22020 @findex gnus-group-set-parameter
22021 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
22022
22023 @item gnus-narrow-to-body
22024 @findex gnus-narrow-to-body
22025 Narrows the current buffer to the body of the article.
22026
22027 @item gnus-check-backend-function
22028 @findex gnus-check-backend-function
22029 Takes two parameters, @var{function} and @var{group}.  If the backend
22030 @var{group} comes from supports @var{function}, return non-@code{nil}.
22031
22032 @lisp
22033 (gnus-check-backend-function "request-scan" "nnml:misc")
22034 @result{} t
22035 @end lisp
22036
22037 @item gnus-read-method
22038 @findex gnus-read-method
22039 Prompts the user for a select method.
22040
22041 @end table
22042
22043
22044 @node Backend Interface
22045 @subsection Backend Interface
22046
22047 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
22048 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
22049 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
22050 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
22051 examples of the latter we have @code{nntp-port-number} and
22052 @code{nnmbox-directory}.
22053
22054 When Gnus asks for information from a backend---say @code{nntp}---on
22055 something, it will normally include a virtual server name in the
22056 function parameters.  (If not, the backend should use the ``current''
22057 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
22058 server as its only (optional) parameter.  If this virtual server hasn't
22059 been opened, the function should fail.
22060
22061 Note that a virtual server name has no relation to some physical server
22062 name.  Take this example:
22063
22064 @lisp
22065 (nntp "odd-one"
22066       (nntp-address "ifi.uio.no")
22067       (nntp-port-number 4324))
22068 @end lisp
22069
22070 Here the virtual server name is @samp{odd-one} while the name of
22071 the physical server is @samp{ifi.uio.no}.
22072
22073 The backends should be able to switch between several virtual servers.
22074 The standard backends implement this by keeping an alist of virtual
22075 server environments that they pull down/push up when needed.
22076
22077 There are two groups of interface functions: @dfn{required functions},
22078 which must be present, and @dfn{optional functions}, which Gnus will
22079 always check for presence before attempting to call 'em.
22080
22081 All these functions are expected to return data in the buffer
22082 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
22083 unfortunately named, but we'll have to live with it.  When I talk about
22084 @dfn{resulting data}, I always refer to the data in that buffer.  When I
22085 talk about @dfn{return value}, I talk about the function value returned by
22086 the function call.  Functions that fail should return @code{nil} as the
22087 return value.
22088
22089 Some backends could be said to be @dfn{server-forming} backends, and
22090 some might be said not to be.  The latter are backends that generally
22091 only operate on one group at a time, and have no concept of ``server''
22092 -- they have a group, and they deliver info on that group and nothing
22093 more.
22094
22095 In the examples and definitions I will refer to the imaginary backend
22096 @code{nnchoke}.
22097
22098 @cindex @code{nnchoke}
22099
22100 @menu
22101 * Required Backend Functions::        Functions that must be implemented.
22102 * Optional Backend Functions::        Functions that need not be implemented.
22103 * Error Messaging::                   How to get messages and report errors.
22104 * Writing New Backends::              Extending old backends.
22105 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
22106 * Mail-like Backends::                Some tips on mail backends.
22107 @end menu
22108
22109
22110 @node Required Backend Functions
22111 @subsubsection Required Backend Functions
22112
22113 @table @code
22114
22115 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
22116
22117 @var{articles} is either a range of article numbers or a list of
22118 @code{Message-ID}s.  Current backends do not fully support either---only
22119 sequences (lists) of article numbers, and most backends do not support
22120 retrieval of @code{Message-ID}s.  But they should try for both.
22121
22122 The result data should either be HEADs or NOV lines, and the result
22123 value should either be @code{headers} or @code{nov} to reflect this.
22124 This might later be expanded to @code{various}, which will be a mixture
22125 of HEADs and NOV lines, but this is currently not supported by Gnus.
22126
22127 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
22128 headers", in some meaning of the word.  This is generally done by
22129 fetching (at most) @var{fetch-old} extra headers less than the smallest
22130 article number in @code{articles}, and filling the gaps as well.  The
22131 presence of this parameter can be ignored if the backend finds it
22132 cumbersome to follow the request.  If this is non-@code{nil} and not a
22133 number, do maximum fetches.
22134
22135 Here's an example HEAD:
22136
22137 @example
22138 221 1056 Article retrieved.
22139 Path: ifi.uio.no!sturles
22140 From: sturles@@ifi.uio.no (Sturle Sunde)
22141 Newsgroups: ifi.discussion
22142 Subject: Re: Something very droll
22143 Date: 27 Oct 1994 14:02:57 +0100
22144 Organization: Dept. of Informatics, University of Oslo, Norway
22145 Lines: 26
22146 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
22147 References: <38jdmq$4qu@@visbur.ifi.uio.no>
22148 NNTP-Posting-Host: holmenkollen.ifi.uio.no
22149 .
22150 @end example
22151
22152 So a @code{headers} return value would imply that there's a number of
22153 these in the data buffer.
22154
22155 Here's a BNF definition of such a buffer:
22156
22157 @example
22158 headers        = *head
22159 head           = error / valid-head
22160 error-message  = [ "4" / "5" ] 2number " " <error message> eol
22161 valid-head     = valid-message *header "." eol
22162 valid-message  = "221 " <number> " Article retrieved." eol
22163 header         = <text> eol
22164 @end example
22165
22166 If the return value is @code{nov}, the data buffer should contain
22167 @dfn{network overview database} lines.  These are basically fields
22168 separated by tabs.
22169
22170 @example
22171 nov-buffer = *nov-line
22172 nov-line   = 8*9 [ field <TAB> ] eol
22173 field      = <text except TAB>
22174 @end example
22175
22176 For a closer look at what should be in those fields,
22177 @pxref{Headers}.
22178
22179
22180 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
22181
22182 @var{server} is here the virtual server name.  @var{definitions} is a
22183 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
22184
22185 If the server can't be opened, no error should be signaled.  The backend
22186 may then choose to refuse further attempts at connecting to this
22187 server.  In fact, it should do so.
22188
22189 If the server is opened already, this function should return a
22190 non-@code{nil} value.  There should be no data returned.
22191
22192
22193 @item (nnchoke-close-server &optional SERVER)
22194
22195 Close connection to @var{server} and free all resources connected
22196 to it.  Return @code{nil} if the server couldn't be closed for some
22197 reason.
22198
22199 There should be no data returned.
22200
22201
22202 @item (nnchoke-request-close)
22203
22204 Close connection to all servers and free all resources that the backend
22205 have reserved.  All buffers that have been created by that backend
22206 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
22207 function is generally only called when Gnus is shutting down.
22208
22209 There should be no data returned.
22210
22211
22212 @item (nnchoke-server-opened &optional SERVER)
22213
22214 If @var{server} is the current virtual server, and the connection to the
22215 physical server is alive, then this function should return a
22216 non-@code{nil} vlue.  This function should under no circumstances
22217 attempt to reconnect to a server we have lost connection to.
22218
22219 There should be no data returned.
22220
22221
22222 @item (nnchoke-status-message &optional SERVER)
22223
22224 This function should return the last error message from @var{server}.
22225
22226 There should be no data returned.
22227
22228
22229 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
22230
22231 The result data from this function should be the article specified by
22232 @var{article}.  This might either be a @code{Message-ID} or a number.
22233 It is optional whether to implement retrieval by @code{Message-ID}, but
22234 it would be nice if that were possible.
22235
22236 If @var{to-buffer} is non-@code{nil}, the result data should be returned
22237 in this buffer instead of the normal data buffer.  This is to make it
22238 possible to avoid copying large amounts of data from one buffer to
22239 another, while Gnus mainly requests articles to be inserted directly
22240 into its article buffer.
22241
22242 If it is at all possible, this function should return a cons cell where
22243 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
22244 the article number.  This will enable Gnus to find out what the real
22245 group and article numbers are when fetching articles by
22246 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
22247 on successful article retrieval.
22248
22249
22250 @item (nnchoke-request-group GROUP &optional SERVER FAST)
22251
22252 Get data on @var{group}.  This function also has the side effect of
22253 making @var{group} the current group.
22254
22255 If @var{fast}, don't bother to return useful data, just make @var{group}
22256 the current group.
22257
22258 Here's an example of some result data and a definition of the same:
22259
22260 @example
22261 211 56 1000 1059 ifi.discussion
22262 @end example
22263
22264 The first number is the status, which should be 211.  Next is the
22265 total number of articles in the group, the lowest article number, the
22266 highest article number, and finally the group name.  Note that the total
22267 number of articles may be less than one might think while just
22268 considering the highest and lowest article numbers, but some articles
22269 may have been canceled.  Gnus just discards the total-number, so
22270 whether one should take the bother to generate it properly (if that is a
22271 problem) is left as an exercise to the reader.
22272
22273 @example
22274 group-status = [ error / info ] eol
22275 error        = [ "4" / "5" ] 2<number> " " <Error message>
22276 info         = "211 " 3* [ <number> " " ] <string>
22277 @end example
22278
22279
22280 @item (nnchoke-close-group GROUP &optional SERVER)
22281
22282 Close @var{group} and free any resources connected to it.  This will be
22283 a no-op on most backends.
22284
22285 There should be no data returned.
22286
22287
22288 @item (nnchoke-request-list &optional SERVER)
22289
22290 Return a list of all groups available on @var{server}.  And that means
22291 @emph{all}.
22292
22293 Here's an example from a server that only carries two groups:
22294
22295 @example
22296 ifi.test 0000002200 0000002000 y
22297 ifi.discussion 3324 3300 n
22298 @end example
22299
22300 On each line we have a group name, then the highest article number in
22301 that group, the lowest article number, and finally a flag.
22302
22303 @example
22304 active-file = *active-line
22305 active-line = name " " <number> " " <number> " " flags eol
22306 name        = <string>
22307 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
22308 @end example
22309
22310 The flag says whether the group is read-only (@samp{n}), is moderated
22311 (@samp{m}), is dead (@samp{x}), is aliased to some other group
22312 (@samp{=other-group}) or none of the above (@samp{y}).
22313
22314
22315 @item (nnchoke-request-post &optional SERVER)
22316
22317 This function should post the current buffer.  It might return whether
22318 the posting was successful or not, but that's not required.  If, for
22319 instance, the posting is done asynchronously, it has generally not been
22320 completed by the time this function concludes.  In that case, this
22321 function should set up some kind of sentinel to beep the user loud and
22322 clear if the posting could not be completed.
22323
22324 There should be no result data from this function.
22325
22326 @end table
22327
22328
22329 @node Optional Backend Functions
22330 @subsubsection Optional Backend Functions
22331
22332 @table @code
22333
22334 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
22335
22336 @var{groups} is a list of groups, and this function should request data
22337 on all those groups.  How it does it is of no concern to Gnus, but it
22338 should attempt to do this in a speedy fashion.
22339
22340 The return value of this function can be either @code{active} or
22341 @code{group}, which says what the format of the result data is.  The
22342 former is in the same format as the data from
22343 @code{nnchoke-request-list}, while the latter is a buffer full of lines
22344 in the same format as @code{nnchoke-request-group} gives.
22345
22346 @example
22347 group-buffer = *active-line / *group-status
22348 @end example
22349
22350
22351 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
22352
22353 A Gnus group info (@pxref{Group Info}) is handed to the backend for
22354 alterations.  This comes in handy if the backend really carries all the
22355 information (as is the case with virtual and imap groups).  This
22356 function should destructively alter the info to suit its needs, and
22357 should return the (altered) group info.
22358
22359 There should be no result data from this function.
22360
22361
22362 @item (nnchoke-request-type GROUP &optional ARTICLE)
22363
22364 When the user issues commands for ``sending news'' (@kbd{F} in the
22365 summary buffer, for instance), Gnus has to know whether the article the
22366 user is following up on is news or mail.  This function should return
22367 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
22368 is mail and @code{unknown} if the type can't be decided.  (The
22369 @var{article} parameter is necessary in @code{nnvirtual} groups which
22370 might very well combine mail groups and news groups.)  Both @var{group}
22371 and @var{article} may be @code{nil}.
22372
22373 There should be no result data from this function.
22374
22375
22376 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
22377
22378 Set/remove/add marks on articles.  Normally Gnus handles the article
22379 marks (such as read, ticked, expired etc) internally, and store them in
22380 @code{~/.newsrc.eld}.  Some backends (such as @sc{imap}) however carry
22381 all information about the articles on the server, so Gnus need to
22382 propagate the mark information to the server.
22383
22384 ACTION is a list of mark setting requests, having this format:
22385
22386 @example
22387 (RANGE ACTION MARK)
22388 @end example
22389
22390 Range is a range of articles you wish to update marks on.  Action is
22391 @code{set}, @code{add} or @code{del}, respectively used for removing all
22392 existing marks and setting them as specified, adding (preserving the
22393 marks not mentioned) mark and removing (preserving the marks not
22394 mentioned) marks.  Mark is a list of marks; where each mark is a symbol.
22395 Currently used marks are @code{read}, @code{tick}, @code{reply},
22396 @code{expire}, @code{killed}, @code{dormant}, @code{save},
22397 @code{download} and @code{unsend}, but your backend should, if possible,
22398 not limit itself to these.
22399
22400 Given contradictory actions, the last action in the list should be the
22401 effective one.  That is, if your action contains a request to add the
22402 @code{tick} mark on article 1 and, later in the list, a request to
22403 remove the mark on the same article, the mark should in fact be removed.
22404
22405 An example action list:
22406
22407 @example
22408 (((5 12 30) 'del '(tick))
22409  ((10 . 90) 'add '(read expire))
22410  ((92 94) 'del '(read)))
22411 @end example
22412
22413 The function should return a range of articles it wasn't able to set the
22414 mark on (currently not used for anything).
22415
22416 There should be no result data from this function.
22417
22418 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
22419
22420 If the user tries to set a mark that the backend doesn't like, this
22421 function may change the mark.  Gnus will use whatever this function
22422 returns as the mark for @var{article} instead of the original
22423 @var{mark}.  If the backend doesn't care, it must return the original
22424 @var{mark}, and not @code{nil} or any other type of garbage.
22425
22426 The only use for this I can see is what @code{nnvirtual} does with
22427 it---if a component group is auto-expirable, marking an article as read
22428 in the virtual group should result in the article being marked as
22429 expirable.
22430
22431 There should be no result data from this function.
22432
22433
22434 @item (nnchoke-request-scan &optional GROUP SERVER)
22435
22436 This function may be called at any time (by Gnus or anything else) to
22437 request that the backend check for incoming articles, in one way or
22438 another.  A mail backend will typically read the spool file or query the
22439 POP server when this function is invoked.  The @var{group} doesn't have
22440 to be heeded---if the backend decides that it is too much work just
22441 scanning for a single group, it may do a total scan of all groups.  It
22442 would be nice, however, to keep things local if that's practical.
22443
22444 There should be no result data from this function.
22445
22446
22447 @item (nnchoke-request-group-description GROUP &optional SERVER)
22448
22449 The result data from this function should be a description of
22450 @var{group}.
22451
22452 @example
22453 description-line = name <TAB> description eol
22454 name             = <string>
22455 description      = <text>
22456 @end example
22457
22458 @item (nnchoke-request-list-newsgroups &optional SERVER)
22459
22460 The result data from this function should be the description of all
22461 groups available on the server.
22462
22463 @example
22464 description-buffer = *description-line
22465 @end example
22466
22467
22468 @item (nnchoke-request-newgroups DATE &optional SERVER)
22469
22470 The result data from this function should be all groups that were
22471 created after @samp{date}, which is in normal human-readable date
22472 format.  The data should be in the active buffer format.
22473
22474
22475 @item (nnchoke-request-create-group GROUP &optional SERVER)
22476
22477 This function should create an empty group with name @var{group}.
22478
22479 There should be no return data.
22480
22481
22482 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
22483
22484 This function should run the expiry process on all articles in the
22485 @var{articles} range (which is currently a simple list of article
22486 numbers.)  It is left up to the backend to decide how old articles
22487 should be before they are removed by this function.  If @var{force} is
22488 non-@code{nil}, all @var{articles} should be deleted, no matter how new
22489 they are.
22490
22491 This function should return a list of articles that it did not/was not
22492 able to delete.
22493
22494 There should be no result data returned.
22495
22496
22497 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
22498 &optional LAST)
22499
22500 This function should move @var{article} (which is a number) from
22501 @var{group} by calling @var{accept-form}.
22502
22503 This function should ready the article in question for moving by
22504 removing any header lines it has added to the article, and generally
22505 should ``tidy up'' the article.  Then it should @code{eval}
22506 @var{accept-form} in the buffer where the ``tidy'' article is.  This
22507 will do the actual copying.  If this @code{eval} returns a
22508 non-@code{nil} value, the article should be removed.
22509
22510 If @var{last} is @code{nil}, that means that there is a high likelihood
22511 that there will be more requests issued shortly, so that allows some
22512 optimizations.
22513
22514 The function should return a cons where the @code{car} is the group name and
22515 the @code{cdr} is the article number that the article was entered as.
22516
22517 There should be no data returned.
22518
22519
22520 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
22521
22522 This function takes the current buffer and inserts it into @var{group}.
22523 If @var{last} in @code{nil}, that means that there will be more calls to
22524 this function in short order.
22525
22526 The function should return a cons where the @code{car} is the group name and
22527 the @code{cdr} is the article number that the article was entered as.
22528
22529 There should be no data returned.
22530
22531
22532 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
22533
22534 This function should remove @var{article} (which is a number) from
22535 @var{group} and insert @var{buffer} there instead.
22536
22537 There should be no data returned.
22538
22539
22540 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
22541
22542 This function should delete @var{group}.  If @var{force}, it should
22543 really delete all the articles in the group, and then delete the group
22544 itself.  (If there is such a thing as ``the group itself''.)
22545
22546 There should be no data returned.
22547
22548
22549 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
22550
22551 This function should rename @var{group} into @var{new-name}.  All
22552 articles in @var{group} should move to @var{new-name}.
22553
22554 There should be no data returned.
22555
22556 @end table
22557
22558
22559 @node Error Messaging
22560 @subsubsection Error Messaging
22561
22562 @findex nnheader-report
22563 @findex nnheader-get-report
22564 The backends should use the function @code{nnheader-report} to report
22565 error conditions---they should not raise errors when they aren't able to
22566 perform a request.  The first argument to this function is the backend
22567 symbol, and the rest are interpreted as arguments to @code{format} if
22568 there are multiple of them, or just a string if there is one of them.
22569 This function must always returns @code{nil}.
22570
22571 @lisp
22572 (nnheader-report 'nnchoke "You did something totally bogus")
22573
22574 (nnheader-report 'nnchoke "Could not request group %s" group)
22575 @end lisp
22576
22577 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
22578 @code{nil} back from a server, and this function returns the most
22579 recently reported message for the backend in question.  This function
22580 takes one argument---the server symbol.
22581
22582 Internally, these functions access @var{backend}@code{-status-string},
22583 so the @code{nnchoke} backend will have its error message stored in
22584 @code{nnchoke-status-string}.
22585
22586
22587 @node Writing New Backends
22588 @subsubsection Writing New Backends
22589
22590 Many backends are quite similar.  @code{nnml} is just like
22591 @code{nnspool}, but it allows you to edit the articles on the server.
22592 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
22593 and it doesn't maintain overview databases.  @code{nndir} is just like
22594 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
22595 editing articles.
22596
22597 It would make sense if it were possible to ``inherit'' functions from
22598 backends when writing new backends.  And, indeed, you can do that if you
22599 want to.  (You don't have to if you don't want to, of course.)
22600
22601 All the backends declare their public variables and functions by using a
22602 package called @code{nnoo}.
22603
22604 To inherit functions from other backends (and allow other backends to
22605 inherit functions from the current backend), you should use the
22606 following macros:
22607
22608 @table @code
22609
22610 @item nnoo-declare
22611 This macro declares the first parameter to be a child of the subsequent
22612 parameters.  For instance:
22613
22614 @lisp
22615 (nnoo-declare nndir
22616   nnml nnmh)
22617 @end lisp
22618
22619 @code{nndir} has declared here that it intends to inherit functions from
22620 both @code{nnml} and @code{nnmh}.
22621
22622 @item defvoo
22623 This macro is equivalent to @code{defvar}, but registers the variable as
22624 a public server variable.  Most state-oriented variables should be
22625 declared with @code{defvoo} instead of @code{defvar}.
22626
22627 In addition to the normal @code{defvar} parameters, it takes a list of
22628 variables in the parent backends to map the variable to when executing
22629 a function in those backends.
22630
22631 @lisp
22632 (defvoo nndir-directory nil
22633   "Where nndir will look for groups."
22634   nnml-current-directory nnmh-current-directory)
22635 @end lisp
22636
22637 This means that @code{nnml-current-directory} will be set to
22638 @code{nndir-directory} when an @code{nnml} function is called on behalf
22639 of @code{nndir}.  (The same with @code{nnmh}.)
22640
22641 @item nnoo-define-basics
22642 This macro defines some common functions that almost all backends should
22643 have.
22644
22645 @example
22646 (nnoo-define-basics nndir)
22647 @end example
22648
22649 @item deffoo
22650 This macro is just like @code{defun} and takes the same parameters.  In
22651 addition to doing the normal @code{defun} things, it registers the
22652 function as being public so that other backends can inherit it.
22653
22654 @item nnoo-map-functions
22655 This macro allows mapping of functions from the current backend to
22656 functions from the parent backends.
22657
22658 @example
22659 (nnoo-map-functions nndir
22660   (nnml-retrieve-headers 0 nndir-current-group 0 0)
22661   (nnmh-request-article 0 nndir-current-group 0 0))
22662 @end example
22663
22664 This means that when @code{nndir-retrieve-headers} is called, the first,
22665 third, and fourth parameters will be passed on to
22666 @code{nnml-retrieve-headers}, while the second parameter is set to the
22667 value of @code{nndir-current-group}.
22668
22669 @item nnoo-import
22670 This macro allows importing functions from backends.  It should be the
22671 last thing in the source file, since it will only define functions that
22672 haven't already been defined.
22673
22674 @example
22675 (nnoo-import nndir
22676   (nnmh
22677    nnmh-request-list
22678    nnmh-request-newgroups)
22679   (nnml))
22680 @end example
22681
22682 This means that calls to @code{nndir-request-list} should just be passed
22683 on to @code{nnmh-request-list}, while all public functions from
22684 @code{nnml} that haven't been defined in @code{nndir} yet should be
22685 defined now.
22686
22687 @end table
22688
22689 Below is a slightly shortened version of the @code{nndir} backend.
22690
22691 @lisp
22692 ;;; nndir.el --- single directory newsgroup access for Gnus
22693 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
22694
22695 ;;; Code:
22696
22697 (require 'nnheader)
22698 (require 'nnmh)
22699 (require 'nnml)
22700 (require 'nnoo)
22701 (eval-when-compile (require 'cl))
22702
22703 (nnoo-declare nndir
22704   nnml nnmh)
22705
22706 (defvoo nndir-directory nil
22707   "Where nndir will look for groups."
22708   nnml-current-directory nnmh-current-directory)
22709
22710 (defvoo nndir-nov-is-evil nil
22711   "*Non-nil means that nndir will never retrieve NOV headers."
22712   nnml-nov-is-evil)
22713
22714 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
22715 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
22716 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
22717
22718 (defvoo nndir-status-string "" nil nnmh-status-string)
22719 (defconst nndir-version "nndir 1.0")
22720
22721 ;;; Interface functions.
22722
22723 (nnoo-define-basics nndir)
22724
22725 (deffoo nndir-open-server (server &optional defs)
22726   (setq nndir-directory
22727         (or (cadr (assq 'nndir-directory defs))
22728             server))
22729   (unless (assq 'nndir-directory defs)
22730     (push `(nndir-directory ,server) defs))
22731   (push `(nndir-current-group
22732           ,(file-name-nondirectory (directory-file-name nndir-directory)))
22733         defs)
22734   (push `(nndir-top-directory
22735           ,(file-name-directory (directory-file-name nndir-directory)))
22736         defs)
22737   (nnoo-change-server 'nndir server defs))
22738
22739 (nnoo-map-functions nndir
22740   (nnml-retrieve-headers 0 nndir-current-group 0 0)
22741   (nnmh-request-article 0 nndir-current-group 0 0)
22742   (nnmh-request-group nndir-current-group 0 0)
22743   (nnmh-close-group nndir-current-group 0))
22744
22745 (nnoo-import nndir
22746   (nnmh
22747    nnmh-status-message
22748    nnmh-request-list
22749    nnmh-request-newgroups))
22750
22751 (provide 'nndir)
22752 @end lisp
22753
22754
22755 @node Hooking New Backends Into Gnus
22756 @subsubsection Hooking New Backends Into Gnus
22757
22758 @vindex gnus-valid-select-methods
22759 Having Gnus start using your new backend is rather easy---you just
22760 declare it with the @code{gnus-declare-backend} functions.  This will
22761 enter the backend into the @code{gnus-valid-select-methods} variable.
22762
22763 @code{gnus-declare-backend} takes two parameters---the backend name and
22764 an arbitrary number of @dfn{abilities}.
22765
22766 Here's an example:
22767
22768 @lisp
22769 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
22770 @end lisp
22771
22772 The abilities can be:
22773
22774 @table @code
22775 @item mail
22776 This is a mailish backend---followups should (probably) go via mail.
22777 @item post
22778 This is a newsish backend---followups should (probably) go via news.
22779 @item post-mail
22780 This backend supports both mail and news.
22781 @item none
22782 This is neither a post nor mail backend---it's something completely
22783 different.
22784 @item respool
22785 It supports respooling---or rather, it is able to modify its source
22786 articles and groups.
22787 @item address
22788 The name of the server should be in the virtual server name.  This is
22789 true for almost all backends.
22790 @item prompt-address
22791 The user should be prompted for an address when doing commands like
22792 @kbd{B} in the group buffer.  This is true for backends like
22793 @code{nntp}, but not @code{nnmbox}, for instance.
22794 @end table
22795
22796
22797 @node Mail-like Backends
22798 @subsubsection Mail-like Backends
22799
22800 One of the things that separate the mail backends from the rest of the
22801 backends is the heavy dependence by the mail backends on common
22802 functions in @file{nnmail.el}.  For instance, here's the definition of
22803 @code{nnml-request-scan}:
22804
22805 @lisp
22806 (deffoo nnml-request-scan (&optional group server)
22807   (setq nnml-article-file-alist nil)
22808   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
22809 @end lisp
22810
22811 It simply calls @code{nnmail-get-new-mail} with a few parameters,
22812 and @code{nnmail} takes care of all the moving and splitting of the
22813 mail.
22814
22815 This function takes four parameters.
22816
22817 @table @var
22818 @item method
22819 This should be a symbol to designate which backend is responsible for
22820 the call.
22821
22822 @item exit-function
22823 This function should be called after the splitting has been performed.
22824
22825 @item temp-directory
22826 Where the temporary files should be stored.
22827
22828 @item group
22829 This optional argument should be a group name if the splitting is to be
22830 performed for one group only.
22831 @end table
22832
22833 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
22834 save each article.  @var{backend}@code{-active-number} will be called to
22835 find the article number assigned to this article.
22836
22837 The function also uses the following variables:
22838 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
22839 this backend); and @var{backend}@code{-group-alist} and
22840 @var{backend}@code{-active-file} to generate the new active file.
22841 @var{backend}@code{-group-alist} should be a group-active alist, like
22842 this:
22843
22844 @example
22845 (("a-group" (1 . 10))
22846  ("some-group" (34 . 39)))
22847 @end example
22848
22849
22850 @node Score File Syntax
22851 @subsection Score File Syntax
22852
22853 Score files are meant to be easily parseable, but yet extremely
22854 mallable.   It was decided that something that had the same read syntax
22855 as an Emacs Lisp list would fit that spec.
22856
22857 Here's a typical score file:
22858
22859 @lisp
22860 (("summary"
22861   ("win95" -10000 nil s)
22862   ("Gnus"))
22863  ("from"
22864   ("Lars" -1000))
22865  (mark -100))
22866 @end lisp
22867
22868 BNF definition of a score file:
22869
22870 @example
22871 score-file       = "" / "(" *element ")"
22872 element          = rule / atom
22873 rule             = string-rule / number-rule / date-rule
22874 string-rule      = "(" quote string-header quote space *string-match ")"
22875 number-rule      = "(" quote number-header quote space *number-match ")"
22876 date-rule        = "(" quote date-header quote space *date-match ")"
22877 quote            = <ascii 34>
22878 string-header    = "subject" / "from" / "references" / "message-id" /
22879                    "xref" / "body" / "head" / "all" / "followup"
22880 number-header    = "lines" / "chars"
22881 date-header      = "date"
22882 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
22883                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
22884 score            = "nil" / <integer>
22885 date             = "nil" / <natural number>
22886 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
22887                    "r" / "regex" / "R" / "Regex" /
22888                    "e" / "exact" / "E" / "Exact" /
22889                    "f" / "fuzzy" / "F" / "Fuzzy"
22890 number-match     = "(" <integer> [ "" / [ space score [ "" /
22891                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
22892 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
22893 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
22894                    space date [ "" / [ space date-match-t ] ] ] ] ")"
22895 date-match-t     = "nil" / "at" / "before" / "after"
22896 atom             = "(" [ required-atom / optional-atom ] ")"
22897 required-atom    = mark / expunge / mark-and-expunge / files /
22898                    exclude-files / read-only / touched
22899 optional-atom    = adapt / local / eval
22900 mark             = "mark" space nil-or-number
22901 nil-or-number    = "nil" / <integer>
22902 expunge          = "expunge" space nil-or-number
22903 mark-and-expunge = "mark-and-expunge" space nil-or-number
22904 files            = "files" *[ space <string> ]
22905 exclude-files    = "exclude-files" *[ space <string> ]
22906 read-only        = "read-only" [ space "nil" / space "t" ]
22907 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
22908 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
22909 local            = "local" *[ space "(" <string> space <form> ")" ]
22910 eval             = "eval" space <form>
22911 space            = *[ " " / <TAB> / <NEWLINE> ]
22912 @end example
22913
22914 Any unrecognized elements in a score file should be ignored, but not
22915 discarded.
22916
22917 As you can see, white space is needed, but the type and amount of white
22918 space is irrelevant.  This means that formatting of the score file is
22919 left up to the programmer---if it's simpler to just spew it all out on
22920 one looong line, then that's ok.
22921
22922 The meaning of the various atoms are explained elsewhere in this
22923 manual (@pxref{Score File Format}).
22924
22925
22926 @node Headers
22927 @subsection Headers
22928
22929 Internally Gnus uses a format for storing article headers that
22930 corresponds to the @sc{nov} format in a mysterious fashion.  One could
22931 almost suspect that the author looked at the @sc{nov} specification and
22932 just shamelessly @emph{stole} the entire thing, and one would be right.
22933
22934 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
22935 RFC 1036 to talk about lines in the head of an article (e.g.,
22936 @code{From}).  It is used by many people as a synonym for
22937 ``head''---``the header and the body''.  (That should be avoided, in my
22938 opinion.)  And Gnus uses a format internally that it calls ``header'',
22939 which is what I'm talking about here.  This is a 9-element vector,
22940 basically, with each header (ouch) having one slot.
22941
22942 These slots are, in order: @code{number}, @code{subject}, @code{from},
22943 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
22944 @code{xref}, and @code{extra}.  There are macros for accessing and
22945 setting these slots---they all have predictable names beginning with
22946 @code{mail-header-} and @code{mail-header-set-}, respectively.
22947
22948 All these slots contain strings, except the @code{extra} slot, which
22949 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
22950
22951
22952 @node Ranges
22953 @subsection Ranges
22954
22955 @sc{gnus} introduced a concept that I found so useful that I've started
22956 using it a lot and have elaborated on it greatly.
22957
22958 The question is simple: If you have a large amount of objects that are
22959 identified by numbers (say, articles, to take a @emph{wild} example)
22960 that you want to qualify as being ``included'', a normal sequence isn't
22961 very useful.  (A 200,000 length sequence is a bit long-winded.)
22962
22963 The solution is as simple as the question: You just collapse the
22964 sequence.
22965
22966 @example
22967 (1 2 3 4 5 6 10 11 12)
22968 @end example
22969
22970 is transformed into
22971
22972 @example
22973 ((1 . 6) (10 . 12))
22974 @end example
22975
22976 To avoid having those nasty @samp{(13 . 13)} elements to denote a
22977 lonesome object, a @samp{13} is a valid element:
22978
22979 @example
22980 ((1 . 6) 7 (10 . 12))
22981 @end example
22982
22983 This means that comparing two ranges to find out whether they are equal
22984 is slightly tricky:
22985
22986 @example
22987 ((1 . 5) 7 8 (10 . 12))
22988 @end example
22989
22990 and
22991
22992 @example
22993 ((1 . 5) (7 . 8) (10 . 12))
22994 @end example
22995
22996 are equal.  In fact, any non-descending list is a range:
22997
22998 @example
22999 (1 2 3 4 5)
23000 @end example
23001
23002 is a perfectly valid range, although a pretty long-winded one.  This is
23003 also valid:
23004
23005 @example
23006 (1 . 5)
23007 @end example
23008
23009 and is equal to the previous range.
23010
23011 Here's a BNF definition of ranges.  Of course, one must remember the
23012 semantic requirement that the numbers are non-descending.  (Any number
23013 of repetition of the same number is allowed, but apt to disappear in
23014 range handling.)
23015
23016 @example
23017 range           = simple-range / normal-range
23018 simple-range    = "(" number " . " number ")"
23019 normal-range    = "(" start-contents ")"
23020 contents        = "" / simple-range *[ " " contents ] /
23021                   number *[ " " contents ]
23022 @end example
23023
23024 Gnus currently uses ranges to keep track of read articles and article
23025 marks.  I plan on implementing a number of range operators in C if The
23026 Powers That Be are willing to let me.  (I haven't asked yet, because I
23027 need to do some more thinking on what operators I need to make life
23028 totally range-based without ever having to convert back to normal
23029 sequences.)
23030
23031
23032 @node Group Info
23033 @subsection Group Info
23034
23035 Gnus stores all permanent info on groups in a @dfn{group info} list.
23036 This list is from three to six elements (or more) long and exhaustively
23037 describes the group.
23038
23039 Here are two example group infos; one is a very simple group while the
23040 second is a more complex one:
23041
23042 @example
23043 ("no.group" 5 ((1 . 54324)))
23044
23045 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
23046                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
23047                 (nnml "")
23048                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
23049 @end example
23050
23051 The first element is the @dfn{group name}---as Gnus knows the group,
23052 anyway.  The second element is the @dfn{subscription level}, which
23053 normally is a small integer.  (It can also be the @dfn{rank}, which is a
23054 cons cell where the @code{car} is the level and the @code{cdr} is the
23055 score.)  The third element is a list of ranges of read articles.  The
23056 fourth element is a list of lists of article marks of various kinds.
23057 The fifth element is the select method (or virtual server, if you like).
23058 The sixth element is a list of @dfn{group parameters}, which is what
23059 this section is about.
23060
23061 Any of the last three elements may be missing if they are not required.
23062 In fact, the vast majority of groups will normally only have the first
23063 three elements, which saves quite a lot of cons cells.
23064
23065 Here's a BNF definition of the group info format:
23066
23067 @example
23068 info          = "(" group space ralevel space read
23069                 [ "" / [ space marks-list [ "" / [ space method [ "" /
23070                 space parameters ] ] ] ] ] ")"
23071 group         = quote <string> quote
23072 ralevel       = rank / level
23073 level         = <integer in the range of 1 to inf>
23074 rank          = "(" level "." score ")"
23075 score         = <integer in the range of 1 to inf>
23076 read          = range
23077 marks-lists   = nil / "(" *marks ")"
23078 marks         = "(" <string> range ")"
23079 method        = "(" <string> *elisp-forms ")"
23080 parameters    = "(" *elisp-forms ")"
23081 @end example
23082
23083 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
23084 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
23085 in pseudo-BNF.
23086
23087 If you have a Gnus info and want to access the elements, Gnus offers a
23088 series of macros for getting/setting these elements.
23089
23090 @table @code
23091 @item gnus-info-group
23092 @itemx gnus-info-set-group
23093 @findex gnus-info-group
23094 @findex gnus-info-set-group
23095 Get/set the group name.
23096
23097 @item gnus-info-rank
23098 @itemx gnus-info-set-rank
23099 @findex gnus-info-rank
23100 @findex gnus-info-set-rank
23101 Get/set the group rank (@pxref{Group Score}).
23102
23103 @item gnus-info-level
23104 @itemx gnus-info-set-level
23105 @findex gnus-info-level
23106 @findex gnus-info-set-level
23107 Get/set the group level.
23108
23109 @item gnus-info-score
23110 @itemx gnus-info-set-score
23111 @findex gnus-info-score
23112 @findex gnus-info-set-score
23113 Get/set the group score (@pxref{Group Score}).
23114
23115 @item gnus-info-read
23116 @itemx gnus-info-set-read
23117 @findex gnus-info-read
23118 @findex gnus-info-set-read
23119 Get/set the ranges of read articles.
23120
23121 @item gnus-info-marks
23122 @itemx gnus-info-set-marks
23123 @findex gnus-info-marks
23124 @findex gnus-info-set-marks
23125 Get/set the lists of ranges of marked articles.
23126
23127 @item gnus-info-method
23128 @itemx gnus-info-set-method
23129 @findex gnus-info-method
23130 @findex gnus-info-set-method
23131 Get/set the group select method.
23132
23133 @item gnus-info-params
23134 @itemx gnus-info-set-params
23135 @findex gnus-info-params
23136 @findex gnus-info-set-params
23137 Get/set the group parameters.
23138 @end table
23139
23140 All the getter functions take one parameter---the info list.  The setter
23141 functions take two parameters---the info list and the new value.
23142
23143 The last three elements in the group info aren't mandatory, so it may be
23144 necessary to extend the group info before setting the element.  If this
23145 is necessary, you can just pass on a non-@code{nil} third parameter to
23146 the three final setter functions to have this happen automatically.
23147
23148
23149 @node Extended Interactive
23150 @subsection Extended Interactive
23151 @cindex interactive
23152 @findex gnus-interactive
23153
23154 Gnus extends the standard Emacs @code{interactive} specification
23155 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
23156 Prefixes}).  Here's an example of how this is used:
23157
23158 @lisp
23159 (defun gnus-summary-increase-score (&optional score symp)
23160   (interactive (gnus-interactive "P\ny"))
23161   ...
23162   )
23163 @end lisp
23164
23165 The best thing to do would have been to implement
23166 @code{gnus-interactive} as a macro which would have returned an
23167 @code{interactive} form, but this isn't possible since Emacs checks
23168 whether a function is interactive or not by simply doing an @code{assq}
23169 on the lambda form.  So, instead we have @code{gnus-interactive}
23170 function that takes a string and returns values that are usable to
23171 @code{interactive}.
23172
23173 This function accepts (almost) all normal @code{interactive} specs, but
23174 adds a few more.
23175
23176 @table @samp
23177 @item y
23178 @vindex gnus-current-prefix-symbol
23179 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
23180 variable.
23181
23182 @item Y
23183 @vindex gnus-current-prefix-symbols
23184 A list of the current symbolic prefixes---the
23185 @code{gnus-current-prefix-symbol} variable.
23186
23187 @item A
23188 The current article number---the @code{gnus-summary-article-number}
23189 function.
23190
23191 @item H
23192 The current article header---the @code{gnus-summary-article-header}
23193 function.
23194
23195 @item g
23196 The current group name---the @code{gnus-group-group-name}
23197 function.
23198
23199 @end table
23200
23201
23202 @node Emacs/XEmacs Code
23203 @subsection Emacs/XEmacs Code
23204 @cindex XEmacs
23205 @cindex Emacsen
23206
23207 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
23208 platforms must be the primary one.  I chose Emacs.  Not because I don't
23209 like XEmacs or Mule, but because it comes first alphabetically.
23210
23211 This means that Gnus will byte-compile under Emacs with nary a warning,
23212 while XEmacs will pump out gigabytes of warnings while byte-compiling.
23213 As I use byte-compilation warnings to help me root out trivial errors in
23214 Gnus, that's very useful.
23215
23216 I've also consistently used Emacs function interfaces, but have used
23217 Gnusey aliases for the functions.  To take an example:  Emacs defines a
23218 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
23219 function.  I then define a function called @code{gnus-run-at-time} that
23220 takes the same parameters as the Emacs @code{run-at-time}.  When running
23221 Gnus under Emacs, the former function is just an alias for the latter.
23222 However, when running under XEmacs, the former is an alias for the
23223 following function:
23224
23225 @lisp
23226 (defun gnus-xmas-run-at-time (time repeat function &rest args)
23227   (start-itimer
23228    "gnus-run-at-time"
23229    `(lambda ()
23230       (,function ,@@args))
23231    time repeat))
23232 @end lisp
23233
23234 This sort of thing has been done for bunches of functions.  Gnus does
23235 not redefine any native Emacs functions while running under XEmacs---it
23236 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
23237 all over.
23238
23239 In the cases where the XEmacs function interface was obviously cleaner,
23240 I used it instead.  For example @code{gnus-region-active-p} is an alias
23241 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
23242
23243 Of course, I could have chosen XEmacs as my native platform and done
23244 mapping functions the other way around.  But I didn't.  The performance
23245 hit these indirections impose on Gnus under XEmacs should be slight.
23246
23247
23248 @node Various File Formats
23249 @subsection Various File Formats
23250
23251 @menu
23252 * Active File Format::      Information on articles and groups available.
23253 * Newsgroups File Format::  Group descriptions.
23254 @end menu
23255
23256
23257 @node Active File Format
23258 @subsubsection Active File Format
23259
23260 The active file lists all groups available on the server in
23261 question.  It also lists the highest and lowest current article numbers
23262 in each group.
23263
23264 Here's an excerpt from a typical active file:
23265
23266 @example
23267 soc.motss 296030 293865 y
23268 alt.binaries.pictures.fractals 3922 3913 n
23269 comp.sources.unix 1605 1593 m
23270 comp.binaries.ibm.pc 5097 5089 y
23271 no.general 1000 900 y
23272 @end example
23273
23274 Here's a pseudo-BNF definition of this file:
23275
23276 @example
23277 active      = *group-line
23278 group-line  = group space high-number space low-number space flag <NEWLINE>
23279 group       = <non-white-space string>
23280 space       = " "
23281 high-number = <non-negative integer>
23282 low-number  = <positive integer>
23283 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
23284 @end example
23285
23286 For a full description of this file, see the manual pages for
23287 @samp{innd}, in particular @samp{active(5)}.
23288
23289
23290 @node Newsgroups File Format
23291 @subsubsection Newsgroups File Format
23292
23293 The newsgroups file lists groups along with their descriptions.  Not all
23294 groups on the server have to be listed,  and not all groups in the file
23295 have to exist on the server.  The file is meant purely as information to
23296 the user.
23297
23298 The format is quite simple; a group name, a tab, and the description.
23299 Here's the definition:
23300
23301 @example
23302 newsgroups    = *line
23303 line          = group tab description <NEWLINE>
23304 group         = <non-white-space string>
23305 tab           = <TAB>
23306 description   = <string>
23307 @end example
23308
23309
23310 @page
23311 @node Emacs for Heathens
23312 @section Emacs for Heathens
23313
23314 Believe it or not, but some people who use Gnus haven't really used
23315 Emacs much before they embarked on their journey on the Gnus Love Boat.
23316 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
23317 region'', and ``set @code{gnus-flargblossen} to an alist where the key
23318 is a regexp that is used for matching on the group name'' are magical
23319 phrases with little or no meaning, then this appendix is for you.  If
23320 you are already familiar with Emacs, just ignore this and go fondle your
23321 cat instead.
23322
23323 @menu
23324 * Keystrokes::      Entering text and executing commands.
23325 * Emacs Lisp::      The built-in Emacs programming language.
23326 @end menu
23327
23328
23329 @node Keystrokes
23330 @subsection Keystrokes
23331
23332 @itemize @bullet
23333 @item
23334 Q: What is an experienced Emacs user?
23335
23336 @item
23337 A: A person who wishes that the terminal had pedals.
23338 @end itemize
23339
23340 Yes, when you use Emacs, you are apt to use the control key, the shift
23341 key and the meta key a lot.  This is very annoying to some people
23342 (notably @code{vi}le users), and the rest of us just love the hell out
23343 of it.  Just give up and submit.  Emacs really does stand for
23344 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
23345 may have heard from other disreputable sources (like the Emacs author).
23346
23347 The shift keys are normally located near your pinky fingers, and are
23348 normally used to get capital letters and stuff.  You probably use it all
23349 the time.  The control key is normally marked ``CTRL'' or something like
23350 that.  The meta key is, funnily enough, never marked as such on any
23351 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
23352 which is the meta key on this keyboard.  It's usually located somewhere
23353 to the left hand side of the keyboard, usually on the bottom row.
23354
23355 Now, us Emacs people don't say ``press the meta-control-m key'',
23356 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
23357 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
23358 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
23359 down the control key, and hold it down while you press @kbd{k}''.
23360 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
23361 the control key and then press @kbd{k}''.  Simple, ay?
23362
23363 This is somewhat complicated by the fact that not all keyboards have a
23364 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
23365 means ``press escape, release escape, press @kbd{k}''.  That's much more
23366 work than if you have a meta key, so if that's the case, I respectfully
23367 suggest you get a real keyboard with a meta key.  You can't live without
23368 it.
23369
23370
23371
23372 @node Emacs Lisp
23373 @subsection Emacs Lisp
23374
23375 Emacs is the King of Editors because it's really a Lisp interpreter.
23376 Each and every key you tap runs some Emacs Lisp code snippet, and since
23377 Emacs Lisp is an interpreted language, that means that you can configure
23378 any key to run any arbitrary code.  You just, like, do it.
23379
23380 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
23381 functions.  (These are byte-compiled for speed, but it's still
23382 interpreted.)  If you decide that you don't like the way Gnus does
23383 certain things, it's trivial to have it do something a different way.
23384 (Well, at least if you know how to write Lisp code.)  However, that's
23385 beyond the scope of this manual, so we are simply going to talk about
23386 some common constructs that you normally use in your @file{.emacs} file
23387 to customize Gnus.
23388
23389 If you want to set the variable @code{gnus-florgbnize} to four (4), you
23390 write the following:
23391
23392 @lisp
23393 (setq gnus-florgbnize 4)
23394 @end lisp
23395
23396 This function (really ``special form'') @code{setq} is the one that can
23397 set a variable to some value.  This is really all you need to know.  Now
23398 you can go and fill your @code{.emacs} file with lots of these to change
23399 how Gnus works.
23400
23401 If you have put that thing in your @code{.emacs} file, it will be read
23402 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
23403 start Emacs.  If you want to change the variable right away, simply say
23404 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
23405 previous ``form'', which is a simple @code{setq} statement here.
23406
23407 Go ahead---just try it, if you're located at your Emacs.  After you
23408 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
23409 is the return value of the form you @code{eval}ed.
23410
23411 Some pitfalls:
23412
23413 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
23414 that means:
23415
23416 @lisp
23417 (setq gnus-read-active-file 'some)
23418 @end lisp
23419
23420 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
23421 @samp{nntp.ifi.uio.no}'', that means:
23422
23423 @lisp
23424 (setq gnus-nntp-server "nntp.ifi.uio.no")
23425 @end lisp
23426
23427 So be careful not to mix up strings (the latter) with symbols (the
23428 former).  The manual is unambiguous, but it can be confusing.
23429
23430 @page
23431 @include gnus-faq.texi
23432
23433 @node Index
23434 @chapter Index
23435 @printindex cp
23436
23437 @node Key Index
23438 @chapter Key Index
23439 @printindex ky
23440
23441 @summarycontents
23442 @contents
23443 @bye
23444
23445 @iftex
23446 @iflatex
23447 \end{document}
23448 @end iflatex
23449 @end iftex
23450
23451 @c End: