*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.4 Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @iftex
9 @finalout
10 @end iftex
11 @setchapternewpage odd
12
13 @iftex
14 @iflatex
15 \documentclass[twoside,a4paper,openright]{book}
16 \usepackage[latin1]{inputenc}
17 \usepackage{pagestyle}
18 \usepackage{epsfig}
19 \fontfamily{bembo}\selectfont
20
21 \makeindex
22 \begin{document}
23
24 \newcommand{\gnuschaptername}{}
25 \newcommand{\gnussectionname}{}
26
27 \newcommand{\gnusbackslash}{/}
28
29 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
30 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
31
32 \newcommand{\gnuskindex}[1]{\index{#1}}
33 \newcommand{\gnusindex}[1]{\index{#1}}
34
35 \newcommand{\gnustt}[1]{{\textbf{\textsf{#1}}}}
36 \newcommand{\gnuscode}[1]{\gnustt{#1}}
37 \newcommand{\gnussamp}[1]{``\gnustt{#1}''}
38 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
39 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
40 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
41 \newcommand{\gnusdfn}[1]{\textit{#1}}
42 \newcommand{\gnusi}[1]{\textit{#1}}
43 \newcommand{\gnusstrong}[1]{\textbf{#1}}
44 \newcommand{\gnusemph}[1]{\textit{#1}}
45 \newcommand{\gnusvar}[1]{\textsl{\textsf{#1}}}
46 \newcommand{\gnussc}[1]{\textsc{#1}}
47 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
48 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
49
50 \newcommand{\gnusbullet}{{${\bullet}$}}
51 \newcommand{\gnusdollar}{\$}
52 \newcommand{\gnusampersand}{\&}
53 \newcommand{\gnuspercent}{\%}
54 \newcommand{\gnushash}{\#}
55 \newcommand{\gnushat}{\symbol{"5E}}
56 \newcommand{\gnusunderline}{\symbol{"5F}}
57 \newcommand{\gnusnot}{$\neg$}
58 \newcommand{\gnustilde}{\symbol{"7E}}
59 \newcommand{\gnusless}{{$<$}}
60 \newcommand{\gnusgreater}{{$>$}}
61
62 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=gnus-head.eps,height=1cm}}}
63 \newcommand{\gnusinteresting}{
64 \marginpar[\hspace{2.5cm}\gnushead]{\gnushead}
65 }
66
67 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
68
69 \newcommand{\gnuspagechapter}[1]{
70 {\mbox{}}
71 }
72
73 \newdimen{\gnusdimen}
74 \gnusdimen 0pt
75
76 \newcommand{\gnuschapter}[2]{
77 \gnuscleardoublepage
78 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
79 \chapter{#2}
80 \renewcommand{\gnussectionname}{}
81 \renewcommand{\gnuschaptername}{#2}
82 \thispagestyle{empty}
83 \hspace*{-2cm}
84 \begin{picture}(500,500)(0,0)
85 \put(0,0){\makebox(480,350)[tr]{#1}}
86 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
87 \end{picture}
88 \clearpage
89 }
90
91 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
92
93 \newcommand{\gnussection}[1]{
94 \renewcommand{\gnussectionname}{#1}
95 \section{#1}
96 }
97
98 \newenvironment{codelist}%
99 {\begin{list}{}{
100 }
101 }{\end{list}}
102
103 \newenvironment{kbdlist}%
104 {\begin{list}{}{
105 \labelwidth=0cm
106 }
107 }{\end{list}}
108
109 \newenvironment{dfnlist}%
110 {\begin{list}{}{
111 }
112 }{\end{list}}
113
114 \newenvironment{stronglist}%
115 {\begin{list}{}{
116 }
117 }{\end{list}}
118
119 \newenvironment{samplist}%
120 {\begin{list}{}{
121 }
122 }{\end{list}}
123
124 \newenvironment{varlist}%
125 {\begin{list}{}{
126 }
127 }{\end{list}}
128
129 \newenvironment{emphlist}%
130 {\begin{list}{}{
131 }
132 }{\end{list}}
133
134 \newlength\gnusheadtextwidth
135 \setlength{\gnusheadtextwidth}{\headtextwidth}
136 \addtolength{\gnusheadtextwidth}{1cm}
137
138 \newpagestyle{gnuspreamble}%
139 {
140 {
141 \ifodd\count0
142 {
143 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
144 }
145 \else
146 {
147 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
148 }
149 }
150 \fi
151 }
152 }
153 {
154 \ifodd\count0
155 \mbox{} \hfill 
156 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
157 \else
158 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
159 \hfill \mbox{}
160 \fi
161 }
162
163 \newpagestyle{gnusindex}%
164 {
165 {
166 \ifodd\count0
167 {
168 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
169 }
170 \else
171 {
172 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
173 }
174 \fi
175 }
176 }
177 {
178 \ifodd\count0
179 \mbox{} \hfill 
180 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
181 \else
182 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
183 \hfill \mbox{}
184 \fi
185 }
186
187 \newpagestyle{gnus}%
188 {
189 {
190 \ifodd\count0
191 {
192 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}
193 }
194 \else
195 {
196 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
197 }
198 \fi
199 }
200 }
201 {
202 \ifodd\count0
203 \mbox{} \hfill 
204 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
205 \else
206 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
207 \hfill \mbox{}
208 \fi
209 }
210
211 \pagenumbering{roman}
212 \pagestyle{gnuspreamble}
213
214 @end iflatex
215 @end iftex
216
217 @iftex
218 @iflatex
219 \begin{titlepage}
220 {
221
222 %\addtolength{\oddsidemargin}{-5cm}
223 %\addtolength{\evensidemargin}{-5cm}
224 \parindent=0cm
225 \addtolength{\textheight}{2cm}
226
227 \gnustitle{\gnustitlename}\\
228 \rule{15cm}{1mm}\\
229 \vfill
230 \hspace*{-1cm}\epsfig{figure=gnus-big-logo.eps,height=15cm}
231 \vfill
232 \rule{15cm}{1mm}\\
233 \gnusauthor{by Lars Magne Ingebrigtsen}
234 \newpage
235 }
236
237 \mbox{}
238 \vfill
239
240 \thispagestyle{empty}
241
242 Copyright \copyright{} 1995,96 Free Software Foundation, Inc. 
243
244 Permission is granted to make and distribute verbatim copies of
245 this manual provided the copyright notice and this permission notice
246 are preserved on all copies.
247
248 Permission is granted to copy and distribute modified versions of this
249 manual under the conditions for verbatim copying, provided that the
250 entire resulting derived work is distributed under the terms of a
251 permission notice identical to this one.
252
253 Permission is granted to copy and distribute translations of this manual
254 into another language, under the above conditions for modified versions.
255
256 \newpage
257 \end{titlepage}
258 @end iflatex
259 @end iftex
260
261 @ifinfo
262
263 This file documents Gnus, the GNU Emacs newsreader.
264
265 Copyright (C) 1995,96 Free Software Foundation, Inc.
266
267 Permission is granted to make and distribute verbatim copies of
268 this manual provided the copyright notice and this permission notice
269 are preserved on all copies.
270
271 @ignore
272 Permission is granted to process this file through Tex and print the
273 results, provided the printed document carries copying permission
274 notice identical to this one except for the removal of this paragraph
275 (this paragraph not being relevant to the printed manual).
276
277 @end ignore
278 Permission is granted to copy and distribute modified versions of this
279 manual under the conditions for verbatim copying, provided also that the
280 entire resulting derived work is distributed under the terms of a
281 permission notice identical to this one.
282
283 Permission is granted to copy and distribute translations of this manual
284 into another language, under the above conditions for modified versions.
285 @end ifinfo
286
287 @tex
288
289 @titlepage
290 @title Gnus 5.4 Manual
291
292 @author by Lars Magne Ingebrigtsen
293 @page
294
295 @vskip 0pt plus 1filll
296 Copyright @copyright{} 1995,96 Free Software Foundation, Inc. 
297
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
301
302 Permission is granted to copy and distribute modified versions of this
303 manual under the conditions for verbatim copying, provided that the
304 entire resulting derived work is distributed under the terms of a
305 permission notice identical to this one.
306
307 Permission is granted to copy and distribute translations of this manual
308 into another language, under the above conditions for modified versions.
309
310 @end titlepage
311 @page
312
313 @end tex
314
315
316 @node Top
317 @top The Gnus Newsreader
318
319 @ifinfo
320
321 You can read news (and mail) from within Emacs by using Gnus.  The news
322 can be gotten by any nefarious means you can think of---@sc{nntp}, local
323 spool or your mbox file.  All at the same time, if you want to push your
324 luck.
325
326 This manual corresponds to Gnus 5.4.
327
328 @end ifinfo
329
330 @iftex
331
332 @iflatex
333 \tableofcontents
334 \gnuscleardoublepage
335 @end iflatex
336
337 Gnus is the advanced, self-documenting, customizable, extensible
338 unreal-time newsreader for GNU Emacs.  
339
340 Oops.  That sounds oddly familiar, so let's start over again to avoid
341 being accused of plagiarism:
342
343 Gnus is a message-reading laboratory.  It will let you look at just
344 about anything as if it were a newsgroup.  You can read mail with it,
345 you can browse directories with it, you can @code{ftp} with it---you can
346 even read news with it!
347
348 Gnus tries to empower people who read news the same way Emacs empowers
349 people who edit text.  Gnus sets no limits to what the user should be
350 allowed to do.  Users are encouraged to extend Gnus to make it behave
351 like they want it to behave.  A program should not control people;
352 people should be empowered to do what they want by using (or abusing)
353 the program.
354
355 @end iftex
356
357
358 @menu
359 * Starting Up::           Finding news can be a pain.
360 * The Group Buffer::      Selecting, subscribing and killing groups.
361 * The Summary Buffer::    Reading, saving and posting articles.
362 * The Article Buffer::    Displaying and handling articles.
363 * Composing Messages::    Information on sending mail and news.
364 * Select Methods::        Gnus reads all messages from various select methods.
365 * Scoring::               Assigning values to articles.
366 * Various::               General purpose settings.
367 * The End::               Farewell and goodbye.
368 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
369 * Index::                 Variable, function and concept index.
370 * Key Index::             Key Index.
371 @end menu
372
373 @node Starting Up
374 @chapter Starting Gnus
375 @cindex starting up
376
377 @kindex M-x gnus
378 @findex gnus
379 If your system administrator has set things up properly, starting Gnus
380 and reading news is extremely easy---you just type @kbd{M-x gnus} in
381 your Emacs. 
382
383 @findex gnus-other-frame
384 @kindex M-x gnus-other-frame
385 If you want to start Gnus in a different frame, you can use the command
386 @kbd{M-x gnus-other-frame} instead.
387
388 If things do not go smoothly at startup, you have to twiddle some
389 variables. 
390
391 @menu
392 * Finding the News::    Choosing a method for getting news.
393 * The First Time::      What does Gnus do the first time you start it?
394 * The Server is Down::  How can I read my mail then?
395 * Slave Gnusae::        You can have more than one Gnus active at a time.
396 * Fetching a Group::    Starting Gnus just to read a group.
397 * New Groups::          What is Gnus supposed to do with new groups?
398 * Startup Files::       Those pesky startup files---@file{.newsrc}.
399 * Auto Save::           Recovering from a crash.
400 * The Active File::     Reading the active file over a slow line Takes Time.
401 * Changing Servers::    You may want to move from one server to another.
402 * Startup Variables::   Other variables you might change.
403 @end menu
404
405
406 @node Finding the News
407 @section Finding the News
408 @cindex finding news
409
410 @vindex gnus-select-method
411 @c @head
412 The @code{gnus-select-method} variable says where Gnus should look for
413 news.  This variable should be a list where the first element says
414 @dfn{how} and the second element says @dfn{where}.  This method is your
415 native method.  All groups that are not fetched with this method are
416 foreign groups.
417
418 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
419 you want to get your daily dosage of news from, you'd say:
420
421 @lisp
422 (setq gnus-select-method '(nntp "news.somewhere.edu"))
423 @end lisp
424
425 If you want to read directly from the local spool, say:
426
427 @lisp
428 (setq gnus-select-method '(nnspool ""))
429 @end lisp
430
431 If you can use a local spool, you probably should, as it will almost
432 certainly be much faster.
433
434 @vindex gnus-nntpserver-file
435 @cindex NNTPSERVER
436 @cindex @sc{nntp} server
437 If this variable is not set, Gnus will take a look at the
438 @code{NNTPSERVER} environment variable.  If that variable isn't set,
439 Gnus will see whether @code{gnus-nntpserver-file}
440 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
441 that fails as well, Gnus will will try to use the machine that is
442 running Emacs as an @sc{nntp} server.  That's a long shot, though.
443
444 @vindex gnus-nntp-server
445 If @code{gnus-nntp-server} is set, this variable will override
446 @code{gnus-select-method}.  You should therefore set
447 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
448
449 @vindex gnus-secondary-servers
450 You can also make Gnus prompt you interactively for the name of an
451 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
452 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
453 in the @code{gnus-secondary-servers} list (if any).  You can also just
454 type in the name of any server you feel like visiting.
455
456 @findex gnus-group-browse-foreign-server
457 @kindex B (Group)
458 However, if you use one @sc{nntp} server regularly and are just
459 interested in a couple of groups from a different server, you would be
460 better served by using the @kbd{B} command in the group buffer.  It will
461 let you have a look at what groups are available, and you can subscribe
462 to any of the groups you want to.  This also makes @file{.newsrc}
463 maintenance much tidier.  @xref{Foreign Groups}.
464
465 @vindex gnus-secondary-select-methods
466 @c @head
467 A slightly different approach to foreign groups is to set the
468 @code{gnus-secondary-select-methods} variable.  The select methods
469 listed in this variable are in many ways just as native as the
470 @code{gnus-select-method} server.  They will also be queried for active
471 files during startup (if that's required), and new newsgroups that
472 appear on these servers will be subscribed (or not) just as native
473 groups are.
474
475 For instance, if you use the @code{nnmbox} backend to read your mail, you
476 would typically set this variable to
477
478 @lisp
479 (setq gnus-secondary-select-methods '((nnmbox "")))
480 @end lisp
481
482
483 @node The First Time
484 @section The First Time
485 @cindex first time usage
486
487 If no startup files exist, Gnus will try to determine what groups should
488 be subscribed by default.
489
490 @vindex gnus-default-subscribed-newsgroups
491 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
492 will subscribe you to just those groups in that list, leaving the rest
493 killed.  Your system administrator should have set this variable to
494 something useful.
495
496 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
497 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is here
498 defined as @dfn{whatever Lars thinks you should read}.)
499
500 You'll also be subscribed to the Gnus documentation group, which should
501 help you with most common problems.  
502
503 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
504 use the normal functions for handling new groups, and not do anything
505 special.
506
507
508 @node The Server is Down
509 @section The Server is Down
510 @cindex server errors
511
512 If the default server is down, Gnus will understandably have some
513 problems starting.  However, if you have some mail groups in addition to
514 the news groups, you may want to start Gnus anyway.
515
516 Gnus, being the trusting sort of program, will ask whether to proceed
517 without a native select method if that server can't be contacted.  This
518 will happen whether the server doesn't actually exist (i.e., you have
519 given the wrong address) or the server has just momentarily taken ill
520 for some reason or other.  If you decide to continue and have no foreign
521 groups, you'll find it difficult to actually do anything in the group
522 buffer.  But, hey, that's your problem.  Blllrph!
523
524 @findex gnus-no-server
525 @kindex M-x gnus-no-server
526 @c @head
527 If you know that the server is definitely down, or you just want to read
528 your mail without bothering with the server at all, you can use the
529 @code{gnus-no-server} command to start Gnus.  That might come in handy
530 if you're in a hurry as well.  This command will not attempt to contact
531 your primary server---instead, it will just activate all groups on level
532 1 and 2.  (You should preferably keep no native groups on those two
533 levels.)
534
535
536 @node Slave Gnusae
537 @section Slave Gnusae
538 @cindex slave
539
540 You might want to run more than one Emacs with more than one Gnus at the
541 same time.  If you are using different @file{.newsrc} files (e.g., if you
542 are using the two different Gnusae to read from two different servers),
543 that is no problem whatsoever.  You just do it.
544
545 The problem appears when you want to run two Gnusae that use the same
546 @code{.newsrc} file.
547
548 To work around that problem some, we here at the Think-Tank at the Gnus
549 Towers have come up with a new concept: @dfn{Masters} and
550 @dfn{slaves}.  (We have applied for a patent on this concept, and have
551 taken out a copyright on those words.  If you wish to use those words in
552 conjunction with each other, you have to send $1 per usage instance to
553 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
554 Applications}) will be much more expensive, of course.)
555
556 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
557 however you do it).  Each subsequent slave Gnusae should be started with
558 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
559 files, but instead save @dfn{slave files} that contain information only
560 on what groups have been read in the slave session.  When a master Gnus
561 starts, it will read (and delete) these slave files, incorporating all
562 information from them.  (The slave files will be read in the sequence
563 they were created, so the latest changes will have precedence.)
564
565 Information from the slave files has, of course, precedence over the
566 information in the normal (i.e., master) @code{.newsrc} file.
567
568
569 @node Fetching a Group
570 @section Fetching a Group
571 @cindex fetching a group
572
573 @findex gnus-fetch-group
574 It it sometimes convenient to be able to just say ``I want to read this
575 group and I don't care whether Gnus has been started or not''.  This is
576 perhaps more useful for people who write code than for users, but the
577 command @code{gnus-fetch-group} provides this functionality in any case.
578 It takes the group name as a parameter.
579
580
581 @node New Groups
582 @section New Groups
583 @cindex new groups
584 @cindex subscription
585
586 @vindex gnus-check-new-newsgroups
587 If you are satisfied that you really never want to see any new groups,
588 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
589 also save you some time at startup.  Even if this variable is
590 @code{nil}, you can always subscribe to the new groups just by pressing
591 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
592 is @code{t} by default.  If you set this variable to @code{always}, then
593 Gnus will query the backends for new groups even when you do the @kbd{g}
594 command (@pxref{Scanning New Messages}).
595
596 @menu
597 * Checking New Groups::      Determining what groups are new.
598 * Subscription Methods::     What Gnus should do with new groups.
599 * Filtering New Groups::     Making Gnus ignore certain new groups.
600 @end menu
601
602
603 @node Checking New Groups
604 @subsection Checking New Groups
605
606 Gnus normally determines whether a group is new or not by comparing the
607 list of groups from the active file(s) with the lists of subscribed and
608 dead groups.  This isn't a particularly fast method.  If
609 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
610 server for new groups since the last time.  This is both faster and
611 cheaper.  This also means that you can get rid of the list of killed
612 groups altogether, so you may set @code{gnus-save-killed-list} to
613 @code{nil}, which will save time both at startup, at exit, and all over.
614 Saves disk space, too.  Why isn't this the default, then?
615 Unfortunately, not all servers support this command. 
616
617 I bet I know what you're thinking now: How do I find out whether my
618 server supports @code{ask-server}?  No?  Good, because I don't have a
619 fail-safe answer.  I would suggest just setting this variable to
620 @code{ask-server} and see whether any new groups appear within the next
621 few days.  If any do, then it works.  If none do, then it doesn't
622 work.  I could write a function to make Gnus guess whether the server
623 supports @code{ask-server}, but it would just be a guess.  So I won't.
624 You could @code{telnet} to the server and say @code{HELP} and see
625 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
626 it does, then it might work.  (But there are servers that lists
627 @samp{NEWGROUPS} without supporting the function properly.)
628
629 This variable can also be a list of select methods.  If so, Gnus will
630 issue an @code{ask-server} command to each of the select methods, and
631 subscribe them (or not) using the normal methods.  This might be handy
632 if you are monitoring a few servers for new groups.  A side effect is
633 that startup will take much longer, so you can meditate while waiting.
634 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
635
636
637 @node Subscription Methods
638 @subsection Subscription Methods
639
640 @vindex gnus-subscribe-newsgroup-method
641 What Gnus does when it encounters a new group is determined by the
642 @code{gnus-subscribe-newsgroup-method} variable.
643
644 This variable should contain a function.  Some handy pre-fab values
645 are:
646
647 @table @code
648
649 @item gnus-subscribe-zombies
650 @vindex gnus-subscribe-zombies
651 Make all new groups zombies.  This is the default.  You can browse the
652 zombies later (with @kbd{A z}) and either kill them all off properly
653 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
654
655 @item gnus-subscribe-randomly
656 @vindex gnus-subscribe-randomly
657 Subscribe all new groups randomly.
658
659 @item gnus-subscribe-alphabetically
660 @vindex gnus-subscribe-alphabetically
661 Subscribe all new groups alphabetically.
662
663 @item gnus-subscribe-hierarchically
664 @vindex gnus-subscribe-hierarchically
665 Subscribe all new groups hierarchically.  The difference between this
666 function and @code{gnus-subscribe-alphabetically} is slight.
667 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
668 alphabetical fashion, while this function will enter groups into it's
669 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
670 @samp{comp} hierarchy, this function will not mess that configuration
671 up.  Or something like that.
672
673 @item gnus-subscribe-interactively
674 @vindex gnus-subscribe-interactively
675 Subscribe new groups interactively.  This means that Gnus will ask
676 you about @strong{all} new groups.
677
678 @item gnus-subscribe-killed
679 @vindex gnus-subscribe-killed
680 Kill all new groups.
681
682 @end table
683
684 @vindex gnus-subscribe-hierarchical-interactive
685 A closely related variable is
686 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
687 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
688 hierarchical fashion whether to subscribe to new groups or not.  Gnus
689 will ask you for each sub-hierarchy whether you want to descend the
690 hierarchy or not.  
691
692 One common mistake is to set the variable a few paragraphs above to
693 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
694 will not work.  This is ga-ga.  So don't do it.
695
696
697 @node Filtering New Groups
698 @subsection Filtering New Groups
699
700 A nice and portable way to control which new newsgroups should be
701 subscribed (or ignored) is to put an @dfn{options} line at the start of
702 the @file{.newsrc} file.  Here's an example:
703
704 @example
705 options -n !alt.all !rec.all sci.all
706 @end example
707
708 @vindex gnus-subscribe-options-newsgroup-method
709 This line obviously belongs to a serious-minded intellectual scientific
710 person (or she may just be plain old boring), because it says that all
711 groups that have names beginning with @samp{alt} and @samp{rec} should
712 be ignored, and all groups with names beginning with @samp{sci} should
713 be subscribed.  Gnus will not use the normal subscription method for
714 subscribing these groups.
715 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
716 variable defaults to @code{gnus-subscribe-alphabetically}.
717
718 @vindex gnus-options-not-subscribe
719 @vindex gnus-options-subscribe
720 If you don't want to mess with your @file{.newsrc} file, you can just
721 set the two variables @code{gnus-options-subscribe} and
722 @code{gnus-options-not-subscribe}.  These two variables do exactly the
723 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
724 and if the the new group matches the former, it will be unconditionally
725 subscribed, and if it matches the latter, it will be ignored.
726
727 @vindex gnus-auto-subscribed-groups
728 Yet another variable that meddles here is
729 @code{gnus-auto-subscribed-groups}.  It works exactly like
730 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
731 thought it would be nice to have two of these.  This variable is more
732 meant for setting some ground rules, while the other variable is used
733 more for user fiddling.  By default this variable makes all new groups
734 that come from mail backends (@code{nnml}, @code{nnbabyl},
735 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
736 don't like that, just set this variable to @code{nil}.
737
738 New groups that match this regexp are subscribed using
739 @code{gnus-subscribe-options-newsgroup-method}.
740
741
742 @node Changing Servers
743 @section Changing Servers
744 @cindex changing servers
745
746 Sometimes it is necessary to move from one @sc{nntp} server to another.
747 This happens very rarely, but perhaps you change jobs, or one server is
748 very flaky and you want to use another.  
749
750 Changing the server is pretty easy, right?  You just change
751 @code{gnus-select-method} to point to the new server?  
752
753 @emph{Wrong!}
754
755 Article numbers are not (in any way) kept synchronized between different
756 @sc{nntp} servers, and the only way Gnus keeps track of what articles
757 you have read is by keeping track of article numbers.  So when you
758 change @code{gnus-select-method}, your @file{.newsrc} file becomes
759 worthless.  
760
761 Gnus provides a few functions to attempt to translate a @file{.newsrc}
762 file from one server to another.  They all have one thing in
763 common---they take a looong time to run.  You don't want to use these
764 functions more than absolutely necessary.
765
766 @kindex M-x gnus-change-server
767 @findex gnus-change-server
768 If you have access to both servers, Gnus can request the headers for all
769 the articles you have read and compare @code{Message-ID}s and map the
770 article numbers of the read articles and article marks.  The @kbd{M-x
771 gnus-change-server} command will do this for all your native groups.  It
772 will prompt for the method you want to move to.
773
774 @kindex M-x gnus-group-move-group-to-server
775 @findex gnus-group-move-group-to-server
776 You can also move individual groups with the @kbd{M-x
777 gnus-group-move-group-to-server} command.  This is useful if you want to
778 move a (foreign) group from one server to another.
779
780 @kindex M-x gnus-group-clear-data-on-native-groups
781 @findex gnus-group-clear-data-on-native-groups
782 If you don't have access to both the old and new server, all your marks
783 and read ranges have become worthless.  You can use the @kbd{M-x
784 gnus-group-clear-data-on-native-groups} command to clear out all data
785 that you have on your native groups.  Use with caution.
786
787
788 @node Startup Files
789 @section Startup Files
790 @cindex startup files
791 @cindex .newsrc
792 @cindex .newsrc.el
793 @cindex .newsrc.eld
794
795 Now, you all know about the @file{.newsrc} file.  All subscription
796 information is traditionally stored in this file.
797
798 Things got a bit more complicated with @sc{gnus}.  In addition to
799 keeping the @file{.newsrc} file updated, it also used a file called
800 @file{.newsrc.el} for storing all the information that didn't fit into
801 the @file{.newsrc} file.  (Actually, it also duplicated everything in
802 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
803 files was the most recently saved, which enabled people to swap between
804 @sc{gnus} and other newsreaders.
805
806 That was kinda silly, so Gnus went one better: In addition to the
807 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
808 @file{.newsrc.eld}.  It will read whichever of these files that are most
809 recent, but it will never write a @file{.newsrc.el} file.
810
811 @vindex gnus-save-newsrc-file
812 You can turn off writing the @file{.newsrc} file by setting
813 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
814 the file and save some space, as well as making exit from Gnus faster.
815 However, this will make it impossible to use other newsreaders than
816 Gnus.  But hey, who would want to, right?
817
818 @vindex gnus-save-killed-list
819 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
820 will not save the list of killed groups to the startup file.  This will
821 save both time (when starting and quitting) and space (on disk).  It
822 will also mean that Gnus has no record of what groups are new or old,
823 so the automatic new groups subscription methods become meaningless.
824 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
825 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
826 Groups}).  This variable can also be a regular expression.  If that's
827 the case, remove all groups that do not match this regexp before
828 saving.  This can be useful in certain obscure situations that involve
829 several servers where not all servers support @code{ask-server}.
830
831 @vindex gnus-startup-file
832 The @code{gnus-startup-file} variable says where the startup files are.
833 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
834 file being whatever that one is with a @samp{.eld} appended.
835
836 @vindex gnus-save-newsrc-hook
837 @vindex gnus-save-quick-newsrc-hook
838 @vindex gnus-save-standard-newsrc-hook
839 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
840 files, while @code{gnus-save-quick-newsrc-hook} is called just before
841 saving the @file{.newsrc.eld} file, and
842 @code{gnus-save-standard-newsrc-hook} is called just before saving the
843 @file{.newsrc} file.  The latter two are commonly used to turn version
844 control on or off.  Version control is on by default when saving the
845 startup files.  If you want to turn backup creation off, say something like: 
846
847 @lisp
848 (defun turn-off-backup ()
849   (set (make-local-variable 'backup-inhibited) t))
850
851 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
852 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
853 @end lisp
854
855 @vindex gnus-init-file
856 When Gnus starts, it will read the @code{gnus-site-init-file}
857 (@file{.../site-lisp/gnus.el} by default) and @code{gnus-init-file}
858 (@file{~/.gnus.el} by default) files.  These are normal Emacs Lisp files
859 and can be used to avoid cluttering your @file{.emacs} and
860 @file{site-init} files with Gnus stuff.
861
862
863 @node Auto Save
864 @section Auto Save
865 @cindex dribble file
866 @cindex auto-save
867
868 Whenever you do something that changes the Gnus data (reading articles,
869 catching up, killing/subscribing groups), the change is added to a
870 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
871 Emacs way.  If your Emacs should crash before you have saved the
872 @file{.newsrc} files, all changes you have made can be recovered from
873 this file.
874
875 If Gnus detects this file at startup, it will ask the user whether to
876 read it.  The auto save file is deleted whenever the real startup file is
877 saved.
878
879 @vindex gnus-use-dribble-file
880 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
881 maintain a dribble buffer.  The default is @code{t}.
882
883 @vindex gnus-dribble-directory
884 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
885 this variable is @code{nil}, which it is by default, Gnus will dribble
886 into the directory where the @file{.newsrc} file is located.  (This is
887 normally the user's home directory.)  The dribble file will get the same
888 file permissions as the @code{.newsrc} file.
889
890
891 @node The Active File
892 @section The Active File
893 @cindex active file
894 @cindex ignored groups
895
896 When Gnus starts, or indeed whenever it tries to determine whether new
897 articles have arrived, it reads the active file.  This is a very large
898 file that lists all the active groups and articles on the server.
899
900 @vindex gnus-ignored-newsgroups
901 Before examining the active file, Gnus deletes all lines that match the
902 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
903 any groups with bogus names, but you can use this variable to make Gnus
904 ignore hierarchies you aren't ever interested in.  However, this is not
905 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
906 Groups} for an overview of other variables that can be used instead.
907
908 @c This variable is
909 @c @code{nil} by default, and will slow down active file handling somewhat
910 @c if you set it to anything else.
911
912 @vindex gnus-read-active-file
913 @c @head
914 The active file can be rather Huge, so if you have a slow network, you
915 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
916 reading the active file.  This variable is @code{t} by default.
917
918 Gnus will try to make do by getting information just on the groups that
919 you actually subscribe to.
920
921 Note that if you subscribe to lots and lots of groups, setting this
922 variable to @code{nil} will probably make Gnus slower, not faster.  At
923 present, having this variable @code{nil} will slow Gnus down
924 considerably, unless you read news over a 2400 baud modem.  
925
926 This variable can also have the value @code{some}.  Gnus will then
927 attempt to read active info only on the subscribed groups.  On some
928 servers this is quite fast (on sparkling, brand new INN servers that
929 support the @code{LIST ACTIVE group} command), on others this isn't fast
930 at all.  In any case, @code{some} should be faster than @code{nil}, and
931 is certainly faster than @code{t} over slow lines.
932
933 If this variable is @code{nil}, Gnus will ask for group info in total
934 lock-step, which isn't very fast.  If it is @code{some} and you use an
935 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
936 read all the replies in one swoop.  This will normally result in better
937 performance, but if the server does not support the aforementioned
938 @code{LIST ACTIVE group} command, this isn't very nice to the server.
939
940 In any case, if you use @code{some} or @code{nil}, you should definitely
941 kill all groups that you aren't interested in to speed things up.
942
943 Note that this variable also affects active file retrieval from
944 secondary select methods.
945
946
947 @node Startup Variables
948 @section Startup Variables
949
950 @table @code
951
952 @item gnus-load-hook
953 @vindex gnus-load-hook
954 A hook that is run while Gnus is being loaded.  Note that this hook will
955 normally be run just once in each Emacs session, no matter how many
956 times you start Gnus.
957
958 @item gnus-startup-hook
959 @vindex gnus-startup-hook
960 A hook that is run after starting up Gnus successfully.
961
962 @item gnus-check-bogus-newsgroups
963 @vindex gnus-check-bogus-newsgroups
964 If non-@code{nil}, Gnus will check for and delete all bogus groups at
965 startup.  A @dfn{bogus group} is a group that you have in your
966 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
967 bogus groups can take quite a while, so to save time and resources it's
968 best to leave this option off, and do the checking for bogus groups once
969 in a while from the group buffer instead (@pxref{Group Maintenance}).
970
971 @item gnus-inhibit-startup-message
972 @vindex gnus-inhibit-startup-message
973 If non-@code{nil}, the startup message won't be displayed.  That way,
974 your boss might not notice as easily that you are reading news instead
975 of doing your job.  Note that this variable is used before
976 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
977
978 @item gnus-no-groups-message
979 @vindex gnus-no-groups-message
980 Message displayed by Gnus when no groups are available.
981
982 @item gnus-play-startup-jingle
983 @vindex gnus-play-startup-jingle
984 If non-@code{nil}, play the Gnus jingle at startup.
985
986 @item gnus-startup-jingle
987 @vindex gnus-startup-jingle
988 Jingle to be played if the above variable is non-@code{nil}.  The
989 default is @samp{Tuxedomoon.Jingle4.au}.
990
991 @end table
992
993
994 @node The Group Buffer
995 @chapter The Group Buffer
996 @cindex group buffer
997
998 The @dfn{group buffer} lists all (or parts) of the available groups.  It
999 is the first buffer shown when Gnus starts, and will never be killed as
1000 long as Gnus is active.
1001
1002 @menu
1003 * Group Buffer Format::    Information listed and how you can change it.
1004 * Group Maneuvering::      Commands for moving in the group buffer.
1005 * Selecting a Group::      Actually reading news.
1006 * Group Data::             Changing the info for a group.
1007 * Subscription Commands::  Unsubscribing, killing, subscribing.
1008 * Group Levels::           Levels? What are those, then?
1009 * Group Score::            A mechanism for finding out what groups you like.
1010 * Marking Groups::         You can mark groups for later processing.
1011 * Foreign Groups::         Creating and editing groups.
1012 * Group Parameters::       Each group may have different parameters set.
1013 * Listing Groups::         Gnus can list various subsets of the groups.
1014 * Sorting Groups::         Re-arrange the group order.
1015 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1016 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1017 * Exiting Gnus::           Stop reading news and get some work done.
1018 * Group Topics::           A folding group mode divided into topics.
1019 * Misc Group Stuff::       Other stuff that you can to do.
1020 @end menu
1021
1022
1023 @node Group Buffer Format
1024 @section Group Buffer Format
1025
1026 @menu 
1027 * Group Line Specification::       Deciding how the group buffer is to look.
1028 * Group Modeline Specification::   The group buffer modeline.
1029 * Group Highlighting::             Having nice colors in the group buffer.
1030 @end menu
1031
1032
1033 @node Group Line Specification
1034 @subsection Group Line Specification
1035 @cindex group buffer format
1036
1037 The default format of the group buffer is nice and dull, but you can
1038 make it as exciting and ugly as you feel like.
1039
1040 Here's a couple of example group lines:
1041
1042 @example
1043      25: news.announce.newusers
1044  *    0: alt.fan.andrea-dworkin
1045 @end example
1046
1047 Quite simple, huh?
1048
1049 You can see that there are 25 unread articles in
1050 @samp{news.announce.newusers}.  There are no unread articles, but some
1051 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1052 asterisk at the beginning of the line?)
1053
1054 @vindex gnus-group-line-format
1055 You can change that format to whatever you want by fiddling with the
1056 @code{gnus-group-line-format} variable.  This variable works along the
1057 lines of a @code{format} specification, which is pretty much the same as
1058 a @code{printf} specifications, for those of you who use (feh!) C.
1059 @xref{Formatting Variables}. 
1060
1061 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1062
1063 There should always be a colon on the line; the cursor always moves to
1064 the colon after performing an operation.  Nothing else is required---not
1065 even the group name.  All displayed text is just window dressing, and is
1066 never examined by Gnus.  Gnus stores all real information it needs using
1067 text properties.
1068
1069 (Note that if you make a really strange, wonderful, spreadsheet-like
1070 layout, everybody will believe you are hard at work with the accounting
1071 instead of wasting time reading news.)
1072
1073 Here's a list of all available format characters:
1074
1075 @table @samp
1076
1077 @item M    
1078 An asterisk if the group only has marked articles.
1079
1080 @item S
1081 Whether the group is subscribed.
1082
1083 @item L    
1084 Level of subscribedness.
1085
1086 @item N
1087 Number of unread articles.
1088
1089 @item I
1090 Number of dormant articles.
1091
1092 @item T
1093 Number of ticked articles.
1094
1095 @item R
1096 Number of read articles.
1097
1098 @item t
1099 Estimated total number of articles.  (This is really @var{max-number}
1100 minus @var{min-number} plus 1.)
1101
1102 @item y
1103 Number of unread, unticked, non-dormant articles.
1104
1105 @item i
1106 Number of ticked and dormant articles.
1107
1108 @item g
1109 Full group name.
1110
1111 @item G
1112 Group name.
1113
1114 @item D
1115 Newsgroup description.
1116
1117 @item o
1118 @samp{m} if moderated.
1119
1120 @item O
1121 @samp{(m)} if moderated.
1122
1123 @item s
1124 Select method.
1125
1126 @item n
1127 Select from where.
1128
1129 @item z
1130 A string that looks like @samp{<%s:%n>} if a foreign select method is
1131 used.
1132
1133 @item P
1134 Indentation based on the level of the topic (@pxref{Group Topics}). 
1135
1136 @item c
1137 @vindex gnus-group-uncollapsed-levels
1138 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1139 variable says how many levels to leave at the end of the group name.
1140 The default is 1---this will mean that group names like
1141 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1142
1143 @item m
1144 @vindex gnus-new-mail-mark
1145 @cindex %
1146 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1147 the group lately.
1148
1149 @item d
1150 A string that says when you last read the group (@pxref{Group
1151 Timestamp}). 
1152
1153 @item u
1154 User defined specifier.  The next character in the format string should
1155 be a letter.  @sc{gnus} will call the function
1156 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1157 following @samp{%u}.  The function will be passed a single dummy
1158 paratere as argument.  The function should return a string, which will
1159 be inserted into the buffer just like information from any other
1160 specifier.
1161 @end table
1162
1163 @cindex *
1164 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1165 if no info is available---for instance, if it is a non-activated foreign
1166 group, or a bogus native group.
1167
1168
1169 @node Group Modeline Specification
1170 @subsection Group Modeline Specification
1171 @cindex group modeline
1172
1173 @vindex gnus-group-mode-line-format
1174 The mode line can be changed by setting
1175 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1176 doesn't understand that many format specifiers:
1177
1178 @table @samp
1179 @item S
1180 The native news server.
1181 @item M
1182 The native select method.
1183 @end table
1184
1185
1186 @node Group Highlighting
1187 @subsection Group Highlighting
1188 @cindex highlighting
1189 @cindex group highlighting
1190
1191 @vindex gnus-group-highlight
1192 Highlighting in the group buffer is controlled by the
1193 @code{gnus-group-highlight} variable.  This is an alist with elements
1194 that look like @var{(form . face)}.  If @var{form} evaluates to
1195 something non-@code{nil}, the @var{face} will be used on the line.
1196
1197 Here's an example value for this variable that might look nice if the
1198 background is dark:
1199
1200 @lisp
1201 (setq gnus-group-highlight
1202       `(((> unread 200) . 
1203          ,(custom-face-lookup "Red" nil nil t nil nil))
1204         ((and (< level 3) (zerop unread)) . 
1205          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1206         ((< level 3) . 
1207          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1208         ((zerop unread) . 
1209          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1210         (t . 
1211          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1212 @end lisp
1213
1214 Variables that are dynamically bound when the forms are evaluated
1215 include:
1216
1217 @table @code
1218 @item group
1219 The group name.
1220 @item unread
1221 The number of unread articles in the group.
1222 @item method
1223 The select method.
1224 @item mailp
1225 Whether the group is a mail group.
1226 @item level
1227 The level of the group.
1228 @item score
1229 The score of the group.
1230 @item ticked 
1231 The number of ticked articles in the group.
1232 @item total
1233 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1234 MIN-NUMBER.
1235 @item topic
1236 When using the topic minor mode, this variable is bound to the current
1237 topic being inserted.
1238 @end table
1239
1240 When the forms are @code{eval}ed, point is at the beginning of the line
1241 of the group in question, so you can use many of the normal Gnus
1242 functions for snarfing info on the group.
1243
1244 @vindex gnus-group-update-hook
1245 @findex gnus-group-highlight-line
1246 @code{gnus-group-update-hook} is called when a group line is changed.
1247 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1248 calls @code{gnus-group-highlight-line} by default.
1249
1250
1251 @node Group Maneuvering
1252 @section Group Maneuvering
1253 @cindex group movement
1254
1255 All movement commands understand the numeric prefix and will behave as
1256 expected, hopefully. 
1257
1258 @table @kbd
1259
1260 @item n
1261 @kindex n (Group)
1262 @findex gnus-group-next-unread-group
1263 Go to the next group that has unread articles
1264 (@code{gnus-group-next-unread-group}).
1265
1266 @item p
1267 @itemx DEL
1268 @kindex DEL (Group)
1269 @kindex p (Group)
1270 @findex gnus-group-prev-unread-group
1271 Go to the previous group that has unread articles
1272 (@code{gnus-group-prev-unread-group}).
1273
1274 @item N
1275 @kindex N (Group)
1276 @findex gnus-group-next-group
1277 Go to the next group (@code{gnus-group-next-group}).
1278
1279 @item P
1280 @kindex P (Group)
1281 @findex gnus-group-prev-group
1282 Go to the previous group (@code{gnus-group-prev-group}).
1283
1284 @item M-p
1285 @kindex M-p (Group)
1286 @findex gnus-group-next-unread-group-same-level
1287 Go to the next unread group on the same (or lower) level
1288 (@code{gnus-group-next-unread-group-same-level}). 
1289
1290 @item M-n
1291 @kindex M-n (Group)
1292 @findex gnus-group-prev-unread-group-same-level
1293 Go to the previous unread group on the same (or lower) level
1294 (@code{gnus-group-prev-unread-group-same-level}). 
1295 @end table
1296
1297 Three commands for jumping to groups:
1298
1299 @table @kbd
1300
1301 @item j
1302 @kindex j (Group)
1303 @findex gnus-group-jump-to-group
1304 Jump to a group (and make it visible if it isn't already)
1305 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1306 like living groups.
1307
1308 @item ,
1309 @kindex , (Group)
1310 @findex gnus-group-best-unread-group
1311 Jump to the unread group with the lowest level
1312 (@code{gnus-group-best-unread-group}). 
1313
1314 @item .
1315 @kindex . (Group)
1316 @findex gnus-group-first-unread-group
1317 Jump to the first group with unread articles
1318 (@code{gnus-group-first-unread-group}).  
1319 @end table
1320
1321 @vindex gnus-group-goto-unread
1322 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1323 commands will move to the next group, not the next unread group.  Even
1324 the commands that say they move to the next unread group.  The default
1325 is @code{t}.
1326
1327
1328 @node Selecting a Group
1329 @section Selecting a Group
1330 @cindex group selection
1331
1332 @table @kbd
1333
1334 @item SPACE
1335 @kindex SPACE (Group)
1336 @findex gnus-group-read-group
1337 Select the current group, switch to the summary buffer and display the
1338 first unread article (@code{gnus-group-read-group}).  If there are no
1339 unread articles in the group, or if you give a non-numerical prefix to
1340 this command, Gnus will offer to fetch all the old articles in this
1341 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1342 determines the number of articles Gnus will fetch.  If @var{N} is
1343 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1344 negative, Gnus fetches the @var{abs(N)} oldest articles.
1345
1346 @item RET
1347 @kindex RET (Group)
1348 @findex gnus-group-select-group
1349 Select the current group and switch to the summary buffer
1350 (@code{gnus-group-select-group}).  Takes the same arguments as
1351 @code{gnus-group-read-group}---the only difference is that this command
1352 does not display the first unread article automatically upon group
1353 entry. 
1354
1355 @item M-RET
1356 @kindex M-RET (Group)
1357 @findex gnus-group-quick-select-group
1358 This does the same as the command above, but tries to do it with the
1359 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1360 scoring/killing will be performed, there will be no highlights and no
1361 expunging.  This might be useful if you're in a real hurry and have to
1362 enter some humongous group.  If you give a 0 prefix to this command
1363 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1364 This might be useful if you want to toggle threading before entering the
1365 group.
1366
1367 @item M-SPACE
1368 @kindex M-SPACE (Group)
1369 @findex gnus-group-visible-select-group
1370 This is yet one more command that does the same as the @kbd{RET}
1371 command, but this one does it without expunging and hiding dormants
1372 (@code{gnus-group-visible-select-group}).
1373
1374 @item M-C-RET
1375 @kindex M-C-RET (Group)
1376 @findex gnus-group-select-group-ephemerally
1377 Finally, this command selects the current group ephemerally without
1378 doing any processing of its contents
1379 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1380 turned off.  Everything you do in the group after selecting it in this
1381 manner will have no permanent effects.
1382
1383 @end table
1384
1385 @vindex gnus-large-newsgroup
1386 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1387 to be a big group.  This is 200 by default.  If the group has more
1388 (unread and/or ticked) articles than this, Gnus will query the user
1389 before entering the group.  The user can then specify how many articles
1390 should be fetched from the server.  If the user specifies a negative
1391 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1392 is positive, the @code{n} articles that have arrived most recently will
1393 be fetched.
1394
1395 @vindex gnus-select-group-hook
1396 @vindex gnus-auto-select-first
1397 @code{gnus-auto-select-first} control whether any articles are selected
1398 automatically when entering a group with the @kbd{SPACE} command.
1399
1400 @table @code
1401
1402 @item nil
1403 Don't select any articles when entering the group.  Just display the
1404 full summary buffer.
1405
1406 @item t
1407 Select the first unread article when entering the group.  
1408
1409 @item best
1410 Select the most high-scored article in the group when entering the
1411 group. 
1412 @end table
1413         
1414 If you want to prevent automatic selection in some group (say, in a
1415 binary group with Huge articles) you can set this variable to @code{nil}
1416 in @code{gnus-select-group-hook}, which is called when a group is
1417 selected.
1418
1419
1420 @node Subscription Commands
1421 @section Subscription Commands
1422 @cindex subscription
1423
1424 @table @kbd
1425
1426 @item S t
1427 @itemx u
1428 @kindex S t (Group)
1429 @kindex u (Group)
1430 @findex gnus-group-unsubscribe-current-group
1431 Toggle subscription to the current group
1432 (@code{gnus-group-unsubscribe-current-group}).  
1433
1434 @item S s
1435 @itemx U
1436 @kindex S s (Group)
1437 @kindex U (Group)
1438 @findex gnus-group-unsubscribe-group
1439 Prompt for a group to subscribe, and then subscribe it.  If it was
1440 subscribed already, unsubscribe it instead
1441 (@code{gnus-group-unsubscribe-group}).
1442
1443 @item S k
1444 @itemx C-k
1445 @kindex S k (Group)
1446 @kindex C-k (Group)
1447 @findex gnus-group-kill-group
1448 Kill the current group (@code{gnus-group-kill-group}).
1449
1450 @item S y
1451 @itemx C-y
1452 @kindex S y (Group)
1453 @kindex C-y (Group)
1454 @findex gnus-group-yank-group
1455 Yank the last killed group (@code{gnus-group-yank-group}).
1456
1457 @item C-x C-t
1458 @kindex C-x C-t (Group)
1459 @findex gnus-group-transpose-groups
1460 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1461 really a subscription command, but you can use it instead of a
1462 kill-and-yank sequence sometimes.
1463
1464 @item S w
1465 @itemx C-w
1466 @kindex S w (Group)
1467 @kindex C-w (Group)
1468 @findex gnus-group-kill-region
1469 Kill all groups in the region (@code{gnus-group-kill-region}). 
1470
1471 @item S z
1472 @kindex S z (Group)
1473 @findex gnus-group-kill-all-zombies
1474 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1475
1476 @item S C-k
1477 @kindex S C-k (Group)
1478 @findex gnus-group-kill-level
1479 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1480 These groups can't be yanked back after killing, so this command should
1481 be used with some caution.  The only time where this command comes in
1482 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1483 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1484 kill off all unsubscribed groups that do not have message numbers in the
1485 @file{.newsrc} file.  
1486
1487 @end table
1488
1489 Also @pxref{Group Levels}.
1490
1491
1492 @node Group Data
1493 @section Group Data
1494
1495 @table @kbd
1496
1497 @item c
1498 @kindex c (Group)
1499 @findex gnus-group-catchup-current
1500 @vindex gnus-group-catchup-group-hook
1501 Mark all unticked articles in this group as read
1502 (@code{gnus-group-catchup-current}).
1503 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1504 the group buffer.
1505
1506 @item C
1507 @kindex C (Group)
1508 @findex gnus-group-catchup-current-all
1509 Mark all articles in this group, even the ticked ones, as read
1510 (@code{gnus-group-catchup-current-all}).   
1511
1512 @item M-c
1513 @kindex M-c (Group)
1514 @findex gnus-group-clear-data
1515 Clear the data from the current group---nix out marks and the list of
1516 read articles (@code{gnus-group-clear-data}).
1517
1518 @item M-x gnus-group-clear-data-on-native-groups
1519 @kindex M-x gnus-group-clear-data-on-native-groups
1520 @findex gnus-group-clear-data-on-native-groups
1521 If you have switched from one @sc{nntp} server to another, all your marks
1522 and read ranges have become worthless.  You can use this command to
1523 clear out all data that you have on your native groups.  Use with
1524 caution. 
1525
1526 @end table
1527
1528
1529 @node Group Levels
1530 @section Group Levels
1531 @cindex group level
1532 @cindex level
1533
1534 All groups have a level of @dfn{subscribedness}.  For instance, if a
1535 group is on level 2, it is more subscribed than a group on level 5.  You
1536 can ask Gnus to just list groups on a given level or lower
1537 (@pxref{Listing Groups}), or to just check for new articles in groups on
1538 a given level or lower (@pxref{Scanning New Messages}).
1539
1540 Remember:  The higher the level of the group, the less important it is. 
1541
1542 @table @kbd
1543
1544 @item S l
1545 @kindex S l (Group)
1546 @findex gnus-group-set-current-level
1547 Set the level of the current group.  If a numeric prefix is given, the
1548 next @var{n} groups will have their levels set.  The user will be
1549 prompted for a level.
1550 @end table
1551
1552 @vindex gnus-level-killed
1553 @vindex gnus-level-zombie
1554 @vindex gnus-level-unsubscribed
1555 @vindex gnus-level-subscribed
1556 Gnus considers groups on between levels 1 and
1557 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1558 @code{gnus-level-subscribed} (exclusive) and
1559 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1560 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1561 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1562 completely dead.  Gnus treats subscribed and unsubscribed groups exactly
1563 the same, but zombie and killed groups have no information on what
1564 articles you have read, etc, stored.  This distinction between dead and
1565 living groups isn't done because it is nice or clever, it is done purely
1566 for reasons of efficiency.
1567
1568 It is recommended that you keep all your mail groups (if any) on quite
1569 low levels (e.g. 1 or 2).
1570
1571 If you want to play with the level variables, you should show some care.
1572 Set them once, and don't touch them ever again.  Better yet, don't touch
1573 them at all unless you know exactly what you're doing.
1574
1575 @vindex gnus-level-default-unsubscribed
1576 @vindex gnus-level-default-subscribed
1577 Two closely related variables are @code{gnus-level-default-subscribed}
1578 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1579 which are the levels that new groups will be put on if they are
1580 (un)subscribed.  These two variables should, of course, be inside the
1581 relevant legal ranges.
1582
1583 @vindex gnus-keep-same-level
1584 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1585 will only move to groups that are of the same level (or lower).  In
1586 particular, going from the last article in one group to the next group
1587 will go to the next group of the same level (or lower).  This might be
1588 handy if you want to read the most important groups before you read the
1589 rest.
1590
1591 @vindex gnus-group-default-list-level
1592 All groups with a level less than or equal to
1593 @code{gnus-group-default-list-level} will be listed in the group buffer
1594 by default.
1595
1596 @vindex gnus-group-list-inactive-groups
1597 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1598 groups will be listed along with the unread groups.  This variable is
1599 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1600 listed. 
1601
1602 @vindex gnus-group-use-permanent-levels
1603 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1604 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1605 use this level as the ``work'' level.
1606
1607 @vindex gnus-activate-level
1608 Gnus will normally just activate groups that are on level
1609 @code{gnus-activate-level} or less.  If you don't want to activate
1610 unsubscribed groups, for instance, you might set this variable to
1611 5.  The default is 6.
1612
1613
1614 @node Group Score
1615 @section Group Score
1616 @cindex group score
1617
1618 You would normally keep important groups on high levels, but that scheme
1619 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1620 group buffer according to how often you read groups, perhaps?  Within
1621 reason?  
1622
1623 This is what @dfn{group score} is for.  You can assign a score to each
1624 group.  You can then sort the group buffer based on this score.
1625 Alternatively, you can sort on score and then level.  (Taken together,
1626 the level and the score is called the @dfn{rank} of the group.  A group
1627 that is on level 4 and has a score of 1 has a higher rank than a group
1628 on level 5 that has a score of 300.  (The level is the most significant
1629 part and the score is the least significant part.))
1630
1631 @findex gnus-summary-bubble-group
1632 If you want groups you read often to get higher scores than groups you
1633 read seldom you can add the @code{gnus-summary-bubble-group} function to
1634 the @code{gnus-summary-exit-hook} hook.  This will result (after
1635 sorting) in a bubbling sort of action.  If you want to see that in
1636 action after each summary exit, you can add
1637 @code{gnus-group-sort-groups-by-rank} or
1638 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1639 slow things down somewhat.
1640
1641
1642 @node Marking Groups
1643 @section Marking Groups
1644 @cindex marking groups
1645
1646 If you want to perform some command on several groups, and they appear
1647 subsequently in the group buffer, you would normally just give a
1648 numerical prefix to the command.  Most group commands will then do your
1649 bidding on those groups.
1650
1651 However, if the groups are not in sequential order, you can still
1652 perform a command on several groups.  You simply mark the groups first
1653 with the process mark and then execute the command.
1654
1655 @table @kbd
1656
1657 @item #
1658 @kindex # (Group)
1659 @itemx M m
1660 @kindex M m (Group)
1661 @findex gnus-group-mark-group
1662 Set the mark on the current group (@code{gnus-group-mark-group}). 
1663
1664 @item M-#
1665 @kindex M-# (Group)
1666 @itemx M u
1667 @kindex M u (Group)
1668 @findex gnus-group-unmark-group
1669 Remove the mark from the current group
1670 (@code{gnus-group-unmark-group}). 
1671
1672 @item M U
1673 @kindex M U (Group)
1674 @findex gnus-group-unmark-all-groups
1675 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1676
1677 @item M w
1678 @kindex M w (Group)
1679 @findex gnus-group-mark-region
1680 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1681
1682 @item M b
1683 @kindex M b (Group)
1684 @findex gnus-group-mark-buffer
1685 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1686
1687 @item M r
1688 @kindex M r (Group)
1689 @findex gnus-group-mark-regexp
1690 Mark all groups that match some regular expression
1691 (@code{gnus-group-mark-regexp}).  
1692 @end table
1693
1694 Also @pxref{Process/Prefix}.
1695
1696 @findex gnus-group-universal-argument
1697 If you want to execute some command on all groups that have been marked
1698 with the process mark, you can use the @kbd{M-&}
1699 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1700 the command to be executed.
1701
1702
1703 @node Foreign Groups
1704 @section Foreign Groups
1705 @cindex foreign groups
1706
1707 Below are some group mode commands for making and editing general foreign
1708 groups, as well as commands to ease the creation of a few
1709 special-purpose groups.  All these commands insert the newly created
1710 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1711 consulted.
1712
1713 @table @kbd
1714
1715 @item G m
1716 @kindex G m (Group)
1717 @findex gnus-group-make-group
1718 @cindex making groups
1719 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1720 for a name, a method and possibly an @dfn{address}.  For an easier way
1721 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1722
1723 @item G r
1724 @kindex G r (Group)
1725 @findex gnus-group-rename-group
1726 @cindex renaming groups
1727 Rename the current group to something else
1728 (@code{gnus-group-rename-group}).  This is legal only on some
1729 groups---mail groups mostly.  This command might very well be quite slow
1730 on some backends.
1731
1732 @item G c
1733 @kindex G c (Group)
1734 @cindex customizing
1735 @findex gnus-group-customize
1736 Customize the group parameters (@code{gnus-group-customize}).
1737
1738 @item G e
1739 @kindex G e (Group)
1740 @findex gnus-group-edit-group-method
1741 @cindex renaming groups
1742 Enter a buffer where you can edit the select method of the current
1743 group (@code{gnus-group-edit-group-method}).
1744
1745 @item G p
1746 @kindex G p (Group)
1747 @findex gnus-group-edit-group-parameters
1748 Enter a buffer where you can edit the group parameters
1749 (@code{gnus-group-edit-group-parameters}). 
1750
1751 @item G E
1752 @kindex G E (Group)
1753 @findex gnus-group-edit-group
1754 Enter a buffer where you can edit the group info
1755 (@code{gnus-group-edit-group}).
1756
1757 @item G d
1758 @kindex G d (Group)
1759 @findex gnus-group-make-directory-group
1760 @cindex nndir
1761 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1762 for a directory name (@code{gnus-group-make-directory-group}).
1763
1764 @item G h 
1765 @kindex G h (Group)
1766 @cindex help group
1767 @findex gnus-group-make-help-group
1768 Make the Gnus help group (@code{gnus-group-make-help-group}).
1769
1770 @item G a
1771 @kindex G a (Group)
1772 @cindex (ding) archive
1773 @cindex archive group
1774 @findex gnus-group-make-archive-group
1775 @vindex gnus-group-archive-directory
1776 @vindex gnus-group-recent-archive-directory
1777 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1778 default a group pointing to the most recent articles will be created
1779 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1780 group will be created from @code{gnus-group-archive-directory}.
1781
1782 @item G k
1783 @kindex G k (Group)
1784 @findex gnus-group-make-kiboze-group
1785 @cindex nnkiboze
1786 Make a kiboze group.  You will be prompted for a name, for a regexp to
1787 match groups to be ``included'' in the kiboze group, and a series of
1788 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1789 @xref{Kibozed Groups}.
1790
1791 @item G D
1792 @kindex G D (Group)
1793 @findex gnus-group-enter-directory
1794 @cindex nneething
1795 Read an arbitrary directory as if with were a newsgroup with the
1796 @code{nneething} backend (@code{gnus-group-enter-directory}).
1797 @xref{Anything Groups}. 
1798
1799 @item G f
1800 @kindex G f (Group)
1801 @findex gnus-group-make-doc-group
1802 @cindex ClariNet Briefs
1803 @cindex nndoc
1804 Make a group based on some file or other
1805 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1806 command, you will be prompted for a file name and a file type.
1807 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1808 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs}, and
1809 @code{forward}.  If you run this command without a prefix, Gnus will
1810 guess at the file type.  @xref{Document Groups}.
1811
1812 @item G w
1813 @kindex G w (Group)
1814 @findex gnus-group-make-web-group
1815 @cindex DejaNews
1816 @cindex Alta Vista
1817 @cindex InReference
1818 @cindex nnweb
1819 Make an ephemeral group based on a web search
1820 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1821 command, make a solid group instead.  You will be prompted for the
1822 search engine type and the search string.  Legal search engine types
1823 include @code{dejanews}, @code{altavista} and @code{reference}.
1824 @xref{Web Searches}.
1825
1826 @item G DEL
1827 @kindex G DEL (Group)
1828 @findex gnus-group-delete-group
1829 This function will delete the current group
1830 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1831 actually delete all the articles in the group, and forcibly remove the
1832 group itself from the face of the Earth.  Use a prefix only if you are
1833 absolutely sure of what you are doing.
1834
1835 @item G V
1836 @kindex G V (Group)
1837 @findex gnus-group-make-empty-virtual
1838 Make a new, fresh, empty @code{nnvirtual} group
1839 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1840
1841 @item G v
1842 @kindex G v (Group)
1843 @findex gnus-group-add-to-virtual
1844 Add the current group to an @code{nnvirtual} group
1845 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1846 @end table
1847
1848 @xref{Select Methods} for more information on the various select
1849 methods. 
1850
1851 @vindex gnus-activate-foreign-newsgroups
1852 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1853 Gnus will check all foreign groups with this level or lower at startup.
1854 This might take quite a while, especially if you subscribe to lots of
1855 groups from different @sc{nntp} servers.
1856
1857
1858 @node Group Parameters
1859 @section Group Parameters
1860 @cindex group parameters
1861
1862 The group parameters store information local to a particular group:
1863
1864 @table @code
1865 @item to-address
1866 @cindex to-address
1867 If the group parameter list contains an element that looks like
1868 @code{(to-address .  "some@@where.com")}, that address will be used by
1869 the backend when doing followups and posts.  This is primarily useful in
1870 mail groups that represent closed mailing lists---mailing lists where
1871 it's expected that everybody that writes to the mailing list is
1872 subscribed to it.  Since using this parameter ensures that the mail only
1873 goes to the mailing list itself, it means that members won't receive two
1874 copies of your followups.
1875
1876 Using @code{to-address} will actually work whether the group is foreign
1877 or not.  Let's say there's a group on the server that is called
1878 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1879 the articles from a mail-to-news gateway.  Posting directly to this
1880 group is therefore impossible---you have to send mail to the mailing
1881 list address instead. 
1882
1883 @item to-list
1884 @cindex to-list
1885 If the group parameter list has an element that looks like
1886 @code{(to-list . "some@@where.com")}, that address will be used when
1887 doing a @kbd{a} in any group.  It is totally ignored when doing a
1888 followup---except that if it is present in a news group, you'll get mail
1889 group semantics when doing @kbd{f}.
1890
1891 @item broken-reply-to
1892 @cindex broken-reply-to
1893 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1894 headers in this group are to be ignored.  This can be useful if you're
1895 reading a mailing list group where the listserv has inserted
1896 @code{Reply-To} headers that point back to the listserv itself.  This is
1897 broken behavior.  So there!
1898
1899 @item to-group
1900 @cindex to-group
1901 Elements like @code{(to-group . "some.group.name")} means that all
1902 posts in that group will be sent to @code{some.group.name}.  
1903
1904 @item newsgroup
1905 @cindex newsgroup
1906 If this symbol is present in the group parameter list, Gnus will treat
1907 all responses as if they were responses to news articles.  This can be
1908 useful if you have a mail group that's really a mirror of a news group. 
1909
1910 @item gcc-self
1911 @cindex gcc-self
1912 If this symbol is present in the group parameter list and set to
1913 @code{t}, new composed messages will be @code{Gcc}'d to the current
1914 group. If it is present and set to @code{none}, no @code{Gcc:} header
1915 will be generated, if it is present and a string, this string will be
1916 inserted literally as a @code{gcc} header (this symbol takes precedence over
1917 any default @code{Gcc} rules as described later).
1918
1919 @item auto-expire
1920 @cindex auto-expire
1921 If the group parameter has an element that looks like @code{(auto-expire
1922 . t)}, , all articles that are read will be marked as expirable.  For an
1923 alternative approach, @pxref{Expiring Mail}.
1924
1925 @item total-expire
1926 @cindex total-expire
1927 If the group parameter has an element that looks like
1928 @code{(total-expire . t)}, all read articles will be put through the
1929 expiry process, even if they are not marked as expirable.  Use with
1930 caution.
1931
1932 @item expiry-wait
1933 @cindex expiry-wait
1934 @vindex nnmail-expiry-wait-function
1935 If the group parameter has an element that looks like @code{(expiry-wait
1936 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1937 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1938 The value can either be a number of days (not necessarily an integer) or
1939 the symbols @code{never} or @code{immediate}.
1940
1941 @item score-file
1942 @cindex score file group parameter
1943 Elements that look like @code{(score-file . "file")} will make
1944 @file{file} into the current score file for the group in question.  This
1945 means that all score commands you issue will end up in that file. 
1946
1947 @item adapt-file
1948 @cindex adapt file group parameter
1949 Elements that look like @code{(adapt-file . "file")} will make
1950 @file{file} into the current adaptive file for the group in question.
1951 All adaptive score entries will be put into this file.
1952
1953 @item admin-address
1954 When unsubscribing to a mailing list you should never send the
1955 unsubscription notice to the mailing list itself.  Instead, you'd send
1956 messages to the administrative address.  This parameter allows you to
1957 put the admin address somewhere convenient.
1958
1959 @item display
1960 Elements that look like @code{(display . MODE)} says which articles to
1961 display on entering the group.  Legal values are:
1962
1963 @table @code
1964 @item all
1965 Display all articles, both read and unread.
1966
1967 @item default
1968 Display the default visible articles, which normally includes unread and
1969 ticked articles.
1970 @end table
1971
1972 @item comment
1973 Elements that look like @code{(comment . "This is a comment")}
1974 are arbitrary comments on the group.  They are currently ignored by
1975 Gnus, but provide a place for you to store information on particular
1976 groups. 
1977
1978 @item @var{(variable form)}
1979 You can use the group parameters to set variables local to the group you
1980 are entering.  If you want to turn threading off in @samp{news.answers},
1981 you could put @code{(gnus-show-threads nil)} in the group parameters of
1982 that group.  @code{gnus-show-threads} will be made into a local variable
1983 in the summary buffer you enter, and the form @code{nil} will be
1984 @code{eval}ed there.
1985
1986 This can also be used as a group-specific hook function, if you'd like.
1987 If you want to hear a beep when you enter a group, you could put
1988 something like @code{(dummy-variable (ding))} in the parameters of that
1989 group.  @code{dummy-variable} will be set to the result of the
1990 @code{(ding)} form, but who cares?
1991
1992 @end table
1993
1994 Use the @kbd{G p} command to edit group parameters of a group.
1995
1996 Also @pxref{Topic Parameters}.
1997
1998
1999 @node Listing Groups
2000 @section Listing Groups
2001 @cindex group listing
2002
2003 These commands all list various slices of the groups that are available.
2004
2005 @table @kbd
2006
2007 @item l
2008 @itemx A s
2009 @kindex A s (Group)
2010 @kindex l (Group)
2011 @findex gnus-group-list-groups
2012 List all groups that have unread articles
2013 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2014 command will list only groups of level ARG and lower.  By default, it
2015 only lists groups of level five (i. e.,
2016 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2017 groups).
2018
2019 @item L
2020 @itemx A u
2021 @kindex A u (Group)
2022 @kindex L (Group)
2023 @findex gnus-group-list-all-groups
2024 List all groups, whether they have unread articles or not
2025 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2026 this command will list only groups of level ARG and lower.  By default,
2027 it lists groups of level seven or lower (i.e., just subscribed and
2028 unsubscribed groups).
2029
2030 @item A l
2031 @kindex A l (Group)
2032 @findex gnus-group-list-level
2033 List all unread groups on a specific level
2034 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2035 with no unread articles.
2036
2037 @item A k
2038 @kindex A k (Group)
2039 @findex gnus-group-list-killed
2040 List all killed groups (@code{gnus-group-list-killed}).  If given a
2041 prefix argument, really list all groups that are available, but aren't
2042 currently (un)subscribed.  This could entail reading the active file
2043 from the server.
2044
2045 @item A z
2046 @kindex A z (Group)
2047 @findex gnus-group-list-zombies
2048 List all zombie groups (@code{gnus-group-list-zombies}).
2049
2050 @item A m
2051 @kindex A m (Group)
2052 @findex gnus-group-list-matching
2053 List all unread, subscribed groups with names that match a regexp
2054 (@code{gnus-group-list-matching}). 
2055
2056 @item A M
2057 @kindex A M (Group)
2058 @findex gnus-group-list-all-matching
2059 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2060
2061 @item A A
2062 @kindex A A (Group)
2063 @findex gnus-group-list-active
2064 List absolutely all groups that are in the active file(s) of the
2065 server(s) you are connected to (@code{gnus-group-list-active}).  This
2066 might very well take quite a while.  It might actually be a better idea
2067 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2068 thing to match on.  Also note that this command may list group that
2069 don't exist (yet)---these will be listed as if they are killed groups.
2070 Take the output with some grains of salt.
2071
2072 @item A a
2073 @kindex A a (Group)
2074 @findex gnus-group-apropos
2075 List all groups that have names that match a regexp
2076 (@code{gnus-group-apropos}).
2077
2078 @item A d
2079 @kindex A d (Group)
2080 @findex gnus-group-description-apropos
2081 List all groups that have names or descriptions that match a regexp
2082 (@code{gnus-group-description-apropos}).
2083
2084 @end table
2085
2086 @vindex gnus-permanently-visible-groups
2087 @cindex visible group parameter
2088 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2089 always be shown, whether they have unread articles or not.  You can also
2090 add the @code{visible} element to the group parameters in question to
2091 get the same effect.
2092
2093 @vindex gnus-list-groups-with-ticked-articles
2094 Groups that have just ticked articles in it are normally listed in the
2095 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2096 @code{nil}, these groups will be treated just like totally empty
2097 groups.  It is @code{t} by default.
2098
2099
2100 @node Sorting Groups
2101 @section Sorting Groups
2102 @cindex sorting groups
2103
2104 @kindex C-c C-s (Group)
2105 @findex gnus-group-sort-groups
2106 @vindex gnus-group-sort-function
2107 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2108 group buffer according to the function(s) given by the
2109 @code{gnus-group-sort-function} variable.  Available sorting functions
2110 include: 
2111
2112 @table @code
2113
2114 @item gnus-group-sort-by-alphabet
2115 @findex gnus-group-sort-by-alphabet
2116 Sort the group names alphabetically.  This is the default.
2117
2118 @item gnus-group-sort-by-real-name
2119 @findex gnus-group-sort-by-real-name
2120 Sort the group alphabetically on the real (unprefixed) group names.
2121
2122 @item gnus-group-sort-by-level
2123 @findex gnus-group-sort-by-level
2124 Sort by group level.
2125
2126 @item gnus-group-sort-by-score
2127 @findex gnus-group-sort-by-score
2128 Sort by group score.
2129
2130 @item gnus-group-sort-by-rank
2131 @findex gnus-group-sort-by-rank
2132 Sort by group score and then the group level.  The level and the score
2133 are, when taken together, the group's @dfn{rank}. 
2134
2135 @item gnus-group-sort-by-unread
2136 @findex gnus-group-sort-by-unread
2137 Sort by number of unread articles.
2138
2139 @item gnus-group-sort-by-method
2140 @findex gnus-group-sort-by-method
2141 Sort alphabetically on the select method.
2142
2143
2144 @end table
2145
2146 @code{gnus-group-sort-function} can also be a list of sorting
2147 functions.  In that case, the most significant sort key function must be
2148 the last one.
2149
2150
2151 There are also a number of commands for sorting directly according to
2152 some sorting criteria:
2153
2154 @table @kbd
2155 @item G S a
2156 @kindex G S a (Group)
2157 @findex gnus-group-sort-groups-by-alphabet
2158 Sort the group buffer alphabetically by group name
2159 (@code{gnus-group-sort-groups-by-alphabet}). 
2160
2161 @item G S u
2162 @kindex G S u (Group)
2163 @findex gnus-group-sort-groups-by-unread
2164 Sort the group buffer by the number of unread articles
2165 (@code{gnus-group-sort-groups-by-unread}).
2166
2167 @item G S l
2168 @kindex G S l (Group)
2169 @findex gnus-group-sort-groups-by-level
2170 Sort the group buffer by group level
2171 (@code{gnus-group-sort-groups-by-level}). 
2172
2173 @item G S v
2174 @kindex G S v (Group)
2175 @findex gnus-group-sort-groups-by-score
2176 Sort the group buffer by group score
2177 (@code{gnus-group-sort-groups-by-score}). 
2178
2179 @item G S r
2180 @kindex G S r (Group)
2181 @findex gnus-group-sort-groups-by-rank
2182 Sort the group buffer by group rank
2183 (@code{gnus-group-sort-groups-by-rank}). 
2184
2185 @item G S m
2186 @kindex G S m (Group)
2187 @findex gnus-group-sort-groups-by-method
2188 Sort the group buffer alphabetically by backend name
2189 (@code{gnus-group-sort-groups-by-method}). 
2190
2191 @end table
2192
2193 When given a prefix, all these commands will sort in reverse order. 
2194
2195 You can also sort a subset of the groups:
2196
2197 @table @kbd
2198 @item G P a
2199 @kindex G P a (Group)
2200 @findex gnus-group-sort-selected-groups-by-alphabet
2201 Sort the process/prefixed groups in the group buffer alphabetically by
2202 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2203
2204 @item G P u
2205 @kindex G P u (Group)
2206 @findex gnus-group-sort-selected-groups-by-unread
2207 Sort the process/prefixed groups in the group buffer by the number of
2208 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2209
2210 @item G P l
2211 @kindex G P l (Group)
2212 @findex gnus-group-sort-selected-groups-by-level
2213 Sort the process/prefixed groups in the group buffer by group level
2214 (@code{gnus-group-sort-selected-groups-by-level}).
2215
2216 @item G P v
2217 @kindex G P v (Group)
2218 @findex gnus-group-sort-selected-groups-by-score
2219 Sort the process/prefixed groups in the group buffer by group score
2220 (@code{gnus-group-sort-selected-groups-by-score}).
2221
2222 @item G P r
2223 @kindex G P r (Group)
2224 @findex gnus-group-sort-selected-groups-by-rank
2225 Sort the process/prefixed groups in the group buffer by group rank
2226 (@code{gnus-group-sort-selected-groups-by-rank}).
2227
2228 @item G P m
2229 @kindex G P m (Group)
2230 @findex gnus-group-sort-selected-groups-by-method
2231 Sort the process/prefixed groups in the group buffer alphabetically by
2232 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2233
2234 @end table
2235
2236
2237
2238 @node Group Maintenance
2239 @section Group Maintenance
2240 @cindex bogus groups
2241
2242 @table @kbd
2243 @item b
2244 @kindex b (Group)
2245 @findex gnus-group-check-bogus-groups
2246 Find bogus groups and delete them
2247 (@code{gnus-group-check-bogus-groups}).
2248
2249 @item F
2250 @kindex F (Group)
2251 @findex gnus-find-new-newsgroups
2252 Find new groups and process them (@code{gnus-find-new-newsgroups}).  If
2253 given a prefix, use the @code{ask-server} method to query the server for
2254 new groups.
2255
2256 @item C-c C-x
2257 @kindex C-c C-x (Group)
2258 @findex gnus-group-expire-articles
2259 Run all expirable articles in the current group through the expiry
2260 process (if any) (@code{gnus-group-expire-articles}).
2261
2262 @item C-c M-C-x
2263 @kindex C-c M-C-x (Group)
2264 @findex gnus-group-expire-all-groups
2265 Run all articles in all groups through the expiry process
2266 (@code{gnus-group-expire-all-groups}).
2267
2268 @end table
2269
2270
2271 @node Browse Foreign Server
2272 @section Browse Foreign Server
2273 @cindex foreign servers
2274 @cindex browsing servers
2275
2276 @table @kbd
2277 @item B
2278 @kindex B (Group)
2279 @findex gnus-group-browse-foreign-server
2280 You will be queried for a select method and a server name.  Gnus will
2281 then attempt to contact this server and let you browse the groups there
2282 (@code{gnus-group-browse-foreign-server}).
2283 @end table
2284
2285 @findex gnus-browse-mode
2286 A new buffer with a list of available groups will appear.  This buffer
2287 will be use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2288 a lot) like a normal group buffer.
2289
2290 Here's a list of keystrokes available in the browse mode:
2291
2292 @table @kbd
2293 @item n
2294 @kindex n (Browse)
2295 @findex gnus-group-next-group
2296 Go to the next group (@code{gnus-group-next-group}).
2297
2298 @item p
2299 @kindex p (Browse)
2300 @findex gnus-group-prev-group
2301 Go to the previous group (@code{gnus-group-prev-group}).
2302
2303 @item SPACE
2304 @kindex SPACE (Browse)
2305 @findex gnus-browse-read-group
2306 Enter the current group and display the first article
2307 (@code{gnus-browse-read-group}). 
2308
2309 @item RET
2310 @kindex RET (Browse)
2311 @findex gnus-browse-select-group
2312 Enter the current group (@code{gnus-browse-select-group}). 
2313
2314 @item u
2315 @kindex u (Browse)
2316 @findex gnus-browse-unsubscribe-current-group
2317 Unsubscribe to the current group, or, as will be the case here,
2318 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2319
2320 @item l
2321 @itemx q
2322 @kindex q (Browse)
2323 @kindex l (Browse)
2324 @findex gnus-browse-exit
2325 Exit browse mode (@code{gnus-browse-exit}).
2326
2327 @item ?
2328 @kindex ? (Browse)
2329 @findex gnus-browse-describe-briefly
2330 Describe browse mode briefly (well, there's not much to describe, is
2331 there) (@code{gnus-browse-describe-briefly}).
2332 @end table
2333
2334
2335 @node Exiting Gnus
2336 @section Exiting Gnus
2337 @cindex exiting Gnus
2338
2339 Yes, Gnus is ex(c)iting.
2340
2341 @table @kbd
2342 @item z
2343 @kindex z (Group)
2344 @findex gnus-group-suspend
2345 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2346 but it kills all buffers except the Group buffer.  I'm not sure why this
2347 is a gain, but then who am I to judge?
2348
2349 @item q
2350 @kindex q (Group)
2351 @findex gnus-group-exit
2352 Quit Gnus (@code{gnus-group-exit}).
2353
2354 @item Q
2355 @kindex Q (Group)
2356 @findex gnus-group-quit
2357 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2358 The dribble file will be saved, though (@pxref{Auto Save}).
2359 @end table
2360
2361 @vindex gnus-exit-gnus-hook
2362 @vindex gnus-suspend-gnus-hook
2363 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2364 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2365 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2366 exiting Gnus.
2367
2368 @findex gnus-unload
2369 @cindex unloading
2370 If you wish to completely unload Gnus and all its adherents, you can use
2371 the @code{gnus-unload} command.  This command is also very handy when
2372 trying to customize meta-variables.
2373
2374 Note:
2375
2376 @quotation
2377 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2378 numbly heavy and herself fall into a hazy trance as the boy sitting
2379 behind her drew repeated lines with his pencil across the back of her
2380 plastic chair.
2381 @end quotation
2382
2383
2384 @node Group Topics
2385 @section Group Topics
2386 @cindex topics
2387
2388 If you read lots and lots of groups, it might be convenient to group
2389 them hierarchically according to topics.  You put your Emacs groups over
2390 here, your sex groups over there, and the rest (what, two groups or so?)
2391 you put in some misc section that you never bother with anyway.  You can
2392 even group the Emacs sex groups as a sub-topic to either the Emacs
2393 groups or the sex groups---or both!  Go wild!
2394
2395 Here's an example:
2396
2397 @example
2398 Gnus
2399   Emacs -- I wuw it!
2400      3: comp.emacs
2401      2: alt.religion.emacs
2402     Naughty Emacs
2403      452: alt.sex.emacs
2404        0: comp.talk.emacs.recovery
2405   Misc
2406      8: comp.binaries.fractals
2407     13: comp.sources.unix
2408 @end example
2409
2410 @findex gnus-topic-mode
2411 @kindex t (Group)
2412 To get this @emph{fab} functionality you simply turn on (ooh!) the
2413 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2414 is a toggling command.)
2415
2416 Go ahead, just try it.  I'll still be here when you get back.  La de
2417 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2418 press @kbd{l}.  There.  All your groups are now listed under
2419 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2420 bothered?
2421
2422 If you want this permanently enabled, you should add that minor mode to
2423 the hook for the group mode:
2424
2425 @lisp
2426 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2427 @end lisp
2428
2429 @menu 
2430 * Topic Variables::    How to customize the topics the Lisp Way.
2431 * Topic Commands::     Interactive E-Z commands.
2432 * Topic Sorting::      Sorting each topic individually.
2433 * Topic Topology::     A map of the world.
2434 * Topic Parameters::   Parameters that apply to all groups in a topic.
2435 @end menu
2436
2437
2438 @node Topic Variables
2439 @subsection Topic Variables
2440 @cindex topic variables
2441
2442 Now, if you select a topic, if will fold/unfold that topic, which is
2443 really neat, I think.
2444
2445 @vindex gnus-topic-line-format
2446 The topic lines themselves are created according to the
2447 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2448 Legal elements are:
2449
2450 @table @samp
2451 @item i
2452 Indentation.
2453 @item n
2454 Topic name.
2455 @item v
2456 Visibility.
2457 @item l
2458 Level.
2459 @item g
2460 Number of groups in the topic.
2461 @item a
2462 Number of unread articles in the topic.
2463 @item A 
2464 Number of unread articles in the topic and all its subtopics. 
2465 @end table
2466
2467 @vindex gnus-topic-indent-level
2468 Each sub-topic (and the groups in the sub-topics) will be indented with
2469 @code{gnus-topic-indent-level} times the topic level number of spaces.
2470 The default is 2.
2471
2472 @vindex gnus-topic-mode-hook
2473 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2474
2475 @vindex gnus-topic-display-empty-topics
2476 The @code{gnus-topic-display-empty-topics} says whether to display even
2477 topics that have no unread articles in them.  The default is @code{t}.
2478
2479
2480 @node Topic Commands
2481 @subsection Topic Commands
2482 @cindex topic commands
2483
2484 When the topic minor mode is turned on, a new @kbd{T} submap will be
2485 available.  In addition, a few of the standard keys change their
2486 definitions slightly.
2487
2488 @table @kbd
2489
2490 @item T n
2491 @kindex T n (Topic)
2492 @findex gnus-topic-create-topic
2493 Prompt for a new topic name and create it 
2494 (@code{gnus-topic-create-topic}). 
2495
2496 @item T m
2497 @kindex T m (Topic)
2498 @findex gnus-topic-move-group
2499 Move the current group to some other topic
2500 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2501 convention (@pxref{Process/Prefix}).
2502
2503 @item T c
2504 @kindex T c (Topic)
2505 @findex gnus-topic-copy-group
2506 Copy the current group to some other topic
2507 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2508 convention (@pxref{Process/Prefix}).
2509
2510 @item T D
2511 @kindex T D (Topic)
2512 @findex gnus-topic-remove-group
2513 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2514 This command uses the process/prefix convention
2515 (@pxref{Process/Prefix}).
2516
2517 @item T M
2518 @kindex T M (Topic)
2519 @findex gnus-topic-move-matching
2520 Move all groups that match some regular expression to a topic
2521 (@code{gnus-topic-move-matching}). 
2522
2523 @item T C
2524 @kindex T C (Topic)
2525 @findex gnus-topic-copy-matching
2526 Copy all groups that match some regular expression to a topic
2527 (@code{gnus-topic-copy-matching}). 
2528
2529 @item T #
2530 @kindex T # (Topic)
2531 @findex gnus-topic-mark-topic
2532 Mark all groups in the current topic with the process mark
2533 (@code{gnus-topic-mark-topic}). 
2534
2535 @item T M-#
2536 @kindex T M-# (Topic)
2537 @findex gnus-topic-unmark-topic
2538 Remove the process mark from all groups in the current topic
2539 (@code{gnus-topic-unmark-topic}). 
2540
2541 @item RET
2542 @kindex RET (Topic)
2543 @findex gnus-topic-select-group
2544 @itemx SPACE
2545 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2546 When you perform this command on a group, you'll enter the group, as
2547 usual.  When done on a topic line, the topic will be folded (if it was
2548 visible) or unfolded (if it was folded already).  So it's basically a
2549 toggling command on topics.  In addition, if you give a numerical
2550 prefix, group on that level (and lower) will be displayed.
2551
2552 @item T TAB
2553 @kindex T TAB (Topic)
2554 @findex gnus-topic-indent
2555 ``Indent'' the current topic so that it becomes a sub-topic of the
2556 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2557 ``un-indent'' the topic instead.
2558
2559 @item C-k
2560 @kindex C-k (Topic)
2561 @findex gnus-topic-kill-group
2562 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2563 topic will be removed along with the topic.
2564
2565 @item C-y
2566 @kindex C-y (Topic)
2567 @findex gnus-topic-yank-group
2568 Yank the previously killed group or topic
2569 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2570 before all groups. 
2571
2572 @item T r
2573 @kindex T r (Topic)
2574 @findex gnus-topic-rename
2575 Rename a topic (@code{gnus-topic-rename}). 
2576
2577 @item T DEL
2578 @kindex T DEL (Topic)
2579 @findex gnus-topic-delete
2580 Delete an empty topic (@code{gnus-topic-delete}). 
2581
2582 @item A T
2583 @kindex A T (Topic)
2584 @findex gnus-topic-list-active
2585 List all groups that Gnus knows about in a topics-ified way
2586 (@code{gnus-topic-list-active}).
2587
2588 @item G p
2589 @kindex G p (Topic)
2590 @findex gnus-topic-edit-parameters
2591 @cindex group parameters
2592 @cindex topic parameters
2593 @cindex parameters
2594 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2595 @xref{Topic Parameters}.
2596
2597 @end table
2598
2599
2600 @node Topic Sorting
2601 @subsection Topic Sorting
2602 @cindex topic sorting
2603
2604 You can sort the groups in each topic individually with the following
2605 commands: 
2606
2607
2608 @table @kbd
2609 @item T S a
2610 @kindex T S a (Topic)
2611 @findex gnus-topic-sort-groups-by-alphabet
2612 Sort the current topic alphabetically by group name
2613 (@code{gnus-topic-sort-groups-by-alphabet}). 
2614
2615 @item T S u
2616 @kindex T S u (Topic)
2617 @findex gnus-topic-sort-groups-by-unread
2618 Sort the current topic by the number of unread articles
2619 (@code{gnus-topic-sort-groups-by-unread}).
2620
2621 @item T S l
2622 @kindex T S l (Topic)
2623 @findex gnus-topic-sort-groups-by-level
2624 Sort the current topic by group level
2625 (@code{gnus-topic-sort-groups-by-level}). 
2626
2627 @item T S v
2628 @kindex T S v (Topic)
2629 @findex gnus-topic-sort-groups-by-score
2630 Sort the current topic by group score
2631 (@code{gnus-topic-sort-groups-by-score}). 
2632
2633 @item T S r
2634 @kindex T S r (Topic)
2635 @findex gnus-topic-sort-groups-by-rank
2636 Sort the current topic by group rank
2637 (@code{gnus-topic-sort-groups-by-rank}). 
2638
2639 @item T S m
2640 @kindex T S m (Topic)
2641 @findex gnus-topic-sort-groups-by-method
2642 Sort the current topic alphabetically by backend name
2643 (@code{gnus-topic-sort-groups-by-method}). 
2644
2645 @end table
2646
2647 @xref{Sorting Groups} for more information about group sorting. 
2648
2649
2650 @node Topic Topology
2651 @subsection Topic Topology
2652 @cindex topic topology
2653 @cindex topology
2654
2655 So, let's have a look at an example group buffer:
2656
2657 @example
2658 Gnus
2659   Emacs -- I wuw it!
2660      3: comp.emacs
2661      2: alt.religion.emacs
2662     Naughty Emacs
2663      452: alt.sex.emacs
2664        0: comp.talk.emacs.recovery
2665   Misc
2666      8: comp.binaries.fractals
2667     13: comp.sources.unix
2668 @end example
2669
2670 So, here we have one top-level topic (@samp{Gnus}), two topics under
2671 that, and one sub-topic under one of the sub-topics.  (There is always
2672 just one (1) top-level topic).  This topology can be expressed as
2673 follows:
2674
2675 @lisp
2676 (("Gnus" visible)
2677  (("Emacs -- I wuw it!" visible) 
2678   (("Naughty Emacs" visible)))
2679  (("Misc" visible)))
2680 @end lisp
2681
2682 @vindex gnus-topic-topology
2683 This is in fact how the variable @code{gnus-topic-topology} would look
2684 for the display above.  That variable is saved in the @file{.newsrc.eld}
2685 file, and shouldn't be messed with manually---unless you really want
2686 to.  Since this variable is read from the @file{.newsrc.eld} file,
2687 setting it in any other startup files will have no effect.  
2688
2689 This topology shows what topics are sub-topics of what topics (right),
2690 and which topics are visible.  Two settings are currently
2691 allowed---@code{visible} and @code{invisible}.
2692
2693
2694 @node Topic Parameters
2695 @subsection Topic Parameters
2696 @cindex topic parameters
2697
2698 All groups in a topic will inherit group parameters from the parent (and
2699 ancestor) topic parameters.  All legal group parameters are legal topic
2700 parameters (@pxref{Group Parameters}).  
2701
2702 Group parameters (of course) override topic parameters, and topic
2703 parameters in sub-topics override topic parameters in super-topics.  You
2704 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2705 verb, although you may feel free to disagree with me here.)
2706
2707 @example
2708 Gnus
2709   Emacs
2710      3: comp.emacs
2711      2: alt.religion.emacs
2712    452: alt.sex.emacs
2713     Relief
2714      452: alt.sex.emacs
2715        0: comp.talk.emacs.recovery
2716   Misc
2717      8: comp.binaries.fractals
2718     13: comp.sources.unix
2719    452: alt.sex.emacs
2720 @end example
2721
2722 The @samp{Emacs} topic has the topic parameter @code{(score-file
2723 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2724 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2725 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2726 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2727 . "religion.SCORE")}.
2728
2729 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2730 will get the @file{relief.SCORE} home score file.  If you enter the same
2731 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2732 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2733 get the @file{religion.SCORE} home score file.
2734
2735 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2736 there are some problems, especially with the @code{total-expiry}
2737 parameter.  Say you have a mail group in two topics; one with
2738 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2739 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2740 of these topics you mean to expire articles from, so anything may
2741 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2742 happens.  You just have to be careful if you do stuff like that.
2743
2744
2745 @node Misc Group Stuff
2746 @section Misc Group Stuff
2747
2748 @menu
2749 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2750 * Group Information::     Information and help on groups and Gnus.
2751 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2752 * File Commands::         Reading and writing the Gnus files.
2753 @end menu
2754
2755 @table @kbd
2756
2757 @item ^
2758 @kindex ^ (Group)
2759 @findex gnus-group-enter-server-mode
2760 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2761 @xref{The Server Buffer}.
2762
2763 @item a
2764 @kindex a (Group)
2765 @findex gnus-group-post-news
2766 Post an article to a group (@code{gnus-group-post-news}).  The current
2767 group name will be used as the default.
2768
2769 @item m
2770 @kindex m (Group)
2771 @findex gnus-group-mail
2772 Mail a message somewhere (@code{gnus-group-mail}).
2773
2774 @end table
2775
2776 Variables for the group buffer:
2777
2778 @table @code
2779
2780 @item gnus-group-mode-hook
2781 @vindex gnus-group-mode-hook
2782 @code{gnus-group-mode-hook} is called after the group buffer has been
2783 created. 
2784
2785 @item gnus-group-prepare-hook
2786 @vindex gnus-group-prepare-hook
2787 @code{gnus-group-prepare-hook} is called after the group buffer is
2788 generated.  It may be used to modify the buffer in some strange,
2789 unnatural way.
2790
2791 @item gnus-permanently-visible-groups
2792 @vindex gnus-permanently-visible-groups
2793 Groups matching this regexp will always be listed in the group buffer,
2794 whether they are empty or not.
2795
2796 @end table
2797
2798
2799 @node Scanning New Messages
2800 @subsection Scanning New Messages
2801 @cindex new messages
2802 @cindex scanning new news
2803
2804 @table @kbd
2805
2806 @item g
2807 @kindex g (Group)
2808 @findex gnus-group-get-new-news
2809 Check the server(s) for new articles.  If the numerical prefix is used,
2810 this command will check only groups of level @var{arg} and lower
2811 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2812 command will force a total rereading of the active file(s) from the
2813 backend(s).
2814
2815 @item M-g
2816 @kindex M-g (Group)
2817 @findex gnus-group-get-new-news-this-group
2818 @vindex gnus-goto-next-group-when-activating
2819 Check whether new articles have arrived in the current group
2820 (@code{gnus-group-get-new-news-this-group}).
2821 @code{gnus-goto-next-group-when-activating} says whether this command is
2822 to move point to the next group or not.  It is @code{t} by default.
2823
2824 @findex gnus-activate-all-groups
2825 @cindex activating groups
2826 @item C-c M-g
2827 @kindex C-c M-g (Group)
2828 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2829
2830 @item R
2831 @kindex R (Group)
2832 @cindex restarting
2833 @findex gnus-group-restart
2834 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2835 file(s), closes the connection to all servers, clears up all run-time
2836 Gnus variables, and then starts Gnus all over again.
2837
2838 @end table
2839
2840 @vindex gnus-get-new-news-hook
2841 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2842
2843 @vindex gnus-after-getting-new-news-hook
2844 @code{gnus-after-getting-new-news-hook} is run after checking for new
2845 news.
2846
2847
2848 @node Group Information
2849 @subsection Group Information
2850 @cindex group information
2851 @cindex information on groups
2852
2853 @table @kbd
2854
2855
2856 @item H f
2857 @kindex H f (Group)
2858 @itemx M-f
2859 @findex gnus-group-fetch-faq
2860 @vindex gnus-group-faq-directory
2861 @cindex FAQ
2862 @cindex ange-ftp
2863 Try to fetch the FAQ for the current group
2864 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2865 @code{gnus-group-faq-directory}, which is usually a directory on a
2866 remote machine.  This variable can also be a list of directories.  In
2867 that case, giving a prefix to this command will allow you to choose
2868 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2869 for fetching the file.
2870
2871 If fetching from the first site is unsuccessful, Gnus will attempt to go
2872 through @code{gnus-group-faq-directory} and try to open them one by one.
2873
2874 @item H d
2875 @itemx C-c C-d
2876 @kindex H d (Group)
2877 @kindex C-c C-d (Group)
2878 @cindex describing groups
2879 @cindex group description
2880 @findex gnus-group-describe-group
2881 Describe the current group (@code{gnus-group-describe-group}).  If given
2882 a prefix, force Gnus to re-read the description from the server.
2883
2884 @item M-d
2885 @kindex M-d (Group)
2886 @findex gnus-group-describe-all-groups
2887 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2888 prefix, force Gnus to re-read the description file from the server.
2889
2890 @item V
2891 @kindex V (Group)
2892 @cindex version
2893 @findex gnus-version
2894 Display current Gnus version numbers (@code{gnus-version}).
2895
2896 @item ?
2897 @kindex ? (Group)
2898 @findex gnus-group-describe-briefly
2899 Give a very short help message (@code{gnus-group-describe-briefly}).
2900
2901 @item C-c C-i
2902 @kindex C-c C-i (Group)
2903 @cindex info
2904 @cindex manual
2905 @findex gnus-info-find-node
2906 Go to the Gnus info node (@code{gnus-info-find-node}).
2907 @end table
2908
2909
2910 @node Group Timestamp
2911 @subsection Group Timestamp
2912 @cindex timestamps
2913 @cindex group timestamps
2914
2915 It can be convenient to let Gnus keep track of when you last read a
2916 group.  To set the ball rolling, you should add
2917 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2918
2919 @lisp
2920 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2921 @end lisp
2922
2923 After doing this, each time you enter a group, it'll be recorded.
2924
2925 This information can be displayed in various ways---the easiest is to
2926 use the @samp{%d} spec in the group line format:
2927
2928 @lisp
2929 (setq gnus-group-line-format 
2930       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2931 @end lisp
2932
2933 This will result in lines looking like:
2934
2935 @example
2936 *        0: mail.ding                                19961002T012943
2937          0: custom                                   19961002T012713
2938 @end example
2939
2940 As you can see, the date is displayed in compact ISO 8601 format.  This
2941 may be a bit too much, so to just display the date, you could say
2942 something like:
2943
2944 @lisp
2945 (setq gnus-group-line-format 
2946       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2947 @end lisp
2948
2949
2950 @node File Commands
2951 @subsection File Commands
2952 @cindex file commands
2953
2954 @table @kbd
2955
2956 @item r
2957 @kindex r (Group)
2958 @findex gnus-group-read-init-file
2959 @vindex gnus-init-file
2960 @cindex reading init file
2961 Re-read the init file (@code{gnus-init-file}, which defaults to
2962 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2963
2964 @item s
2965 @kindex s (Group)
2966 @findex gnus-group-save-newsrc
2967 @cindex saving .newsrc
2968 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2969 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2970 file(s) whether Gnus thinks it is necessary or not.
2971
2972 @c @item Z
2973 @c @kindex Z (Group)
2974 @c @findex gnus-group-clear-dribble
2975 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2976
2977 @end table
2978
2979
2980 @node The Summary Buffer
2981 @chapter The Summary Buffer
2982 @cindex summary buffer
2983
2984 A line for each article is displayed in the summary buffer.  You can
2985 move around, read articles, post articles and reply to articles.
2986
2987 The most common way to a summary buffer is to select a group from the
2988 group buffer (@pxref{Selecting a Group}).  
2989
2990 You can have as many summary buffers open as you wish.
2991
2992 @menu
2993 * Summary Buffer Format::       Deciding how the summary buffer is to look.
2994 * Summary Maneuvering::         Moving around the summary buffer.
2995 * Choosing Articles::           Reading articles.
2996 * Paging the Article::          Scrolling the current article.
2997 * Reply Followup and Post::     Posting articles.
2998 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
2999 * Marking Articles::            Marking articles as read, expirable, etc.
3000 * Limiting::                    You can limit the summary buffer.
3001 * Threading::                   How threads are made.
3002 * Sorting::                     How articles and threads are sorted.
3003 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3004 * Article Caching::             You may store articles in a cache.
3005 * Persistent Articles::         Making articles expiry-resistant.
3006 * Article Backlog::             Having already read articles hang around.
3007 * Saving Articles::             Ways of customizing article saving.
3008 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3009 * Article Treatment::           The article buffer can be mangled at will.
3010 * Article Commands::            Doing various things with the article buffer.
3011 * Summary Sorting::             Sorting the summary buffer in various ways.
3012 * Finding the Parent::          No child support? Get the parent.
3013 * Alternative Approaches::      Reading using non-default summaries.
3014 * Tree Display::                A more visual display of threads.
3015 * Mail Group Commands::         Some commands can only be used in mail groups.
3016 * Various Summary Stuff::       What didn't fit anywhere else.
3017 * Exiting the Summary Buffer::  Returning to the Group buffer.
3018 * Crosspost Handling::          How crossposted articles are dealt with.
3019 * Duplicate Suppression::       An alternative when crosspost handling fails.
3020 @end menu
3021
3022
3023 @node Summary Buffer Format
3024 @section Summary Buffer Format
3025 @cindex summary buffer format
3026
3027 @menu
3028 * Summary Buffer Lines::     You can specify how summary lines should look.
3029 * Summary Buffer Mode Line:: You can say how the mode line should look.
3030 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3031 @end menu
3032
3033 @findex mail-extract-address-components
3034 @findex gnus-extract-address-components
3035 @vindex gnus-extract-address-components
3036 Gnus will use the value of the @code{gnus-extract-address-components}
3037 variable as a function for getting the name and address parts of a
3038 @code{From} header.  Two pre-defined function exist:
3039 @code{gnus-extract-address-components}, which is the default, quite
3040 fast, and too simplistic solution; and
3041 @code{mail-extract-address-components}, which works very nicely, but is
3042 slower.  The default function will return the wrong answer in 5% of the
3043 cases.  If this is unacceptable to you, use the other function instead.
3044
3045 @vindex gnus-summary-same-subject
3046 @code{gnus-summary-same-subject} is a string indicating that the current
3047 article has the same subject as the previous.  This string will be used
3048 with those specs that require it.  The default is @samp{}.
3049
3050
3051 @node Summary Buffer Lines
3052 @subsection Summary Buffer Lines
3053
3054 @vindex gnus-summary-line-format
3055 You can change the format of the lines in the summary buffer by changing
3056 the @code{gnus-summary-line-format} variable.  It works along the same
3057 lines a a normal @code{format} string, with some extensions
3058 (@pxref{Formatting Variables}).
3059
3060 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3061
3062 The following format specification characters are understood:
3063
3064 @table @samp
3065 @item N 
3066 Article number.
3067 @item S
3068 Subject string.
3069 @item s
3070 Subject if the article is the root or the previous article had a
3071 different subject, @code{gnus-summary-same-subject} otherwise.
3072 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3073 @item F
3074 Full @code{From} header.
3075 @item n
3076 The name (from the @code{From} header).
3077 @item a
3078 The name (from the @code{From} header).  This differs from the @code{n}
3079 spec in that it uses the function designated by the
3080 @code{gnus-extract-address-components} variable, which is slower, but
3081 may be more thorough.
3082 @item A
3083 The address (from the @code{From} header).  This works the same way as
3084 the @code{a} spec.
3085 @item L
3086 Number of lines in the article.
3087 @item c
3088 Number of characters in the article.
3089 @item I
3090 Indentation based on thread level (@pxref{Customizing Threading}).
3091 @item T
3092 Nothing if the article is a root and lots of spaces if it isn't (it
3093 pushes everything after it off the screen).
3094 @item [
3095 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3096 for adopted articles (@pxref{Customizing Threading}).
3097 @item ]
3098 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3099 for adopted articles.
3100 @item >
3101 One space for each thread level.
3102 @item <
3103 Twenty minus thread level spaces.
3104 @item U
3105 Unread.
3106 @item R
3107 Replied.
3108 @item i
3109 Score as a number.
3110 @item z
3111 @vindex gnus-summary-zcore-fuzz
3112 Zcore, @samp{+} if above the default level and @samp{-} if below the
3113 default level.  If the difference between
3114 @code{gnus-summary-default-level} and the score is less than
3115 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3116 @item V
3117 Total thread score.
3118 @item x
3119 @code{Xref}.
3120 @item D
3121 @code{Date}.
3122 @item d
3123 The @code{Date} in @code{DD-MMM} format.
3124 @item o
3125 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3126 @item M
3127 @code{Message-ID}.
3128 @item r
3129 @code{References}.
3130 @item t
3131 Number of articles in the current sub-thread.  Using this spec will slow
3132 down summary buffer generation somewhat.
3133 @item e
3134 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3135 article has any children.
3136 @item P
3137 The line number.
3138 @item u
3139 User defined specifier.  The next character in the format string should
3140 be a letter.  @sc{gnus} will call the function
3141 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3142 following @samp{%u}.  The function will be passed the current header as
3143 argument.  The function should return a string, which will be inserted
3144 into the summary just like information from any other summary specifier.
3145 @end table
3146
3147 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3148 have to be handled with care.  For reasons of efficiency, Gnus will
3149 compute what column these characters will end up in, and ``hard-code''
3150 that.  This means that it is illegal to have these specs after a
3151 variable-length spec.  Well, you might not be arrested, but your summary
3152 buffer will look strange, which is bad enough.
3153
3154 The smart choice is to have these specs as far to the left as possible.
3155 (Isn't that the case with everything, though?  But I digress.)
3156
3157 This restriction may disappear in later versions of Gnus.
3158
3159
3160 @node Summary Buffer Mode Line
3161 @subsection Summary Buffer Mode Line
3162
3163 @vindex gnus-summary-mode-line-format
3164 You can also change the format of the summary mode bar.  Set
3165 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3166 is @samp{Gnus: %%b [%A] %Z}.  
3167
3168 Here are the elements you can play with:
3169
3170 @table @samp
3171 @item G
3172 Group name.
3173 @item p
3174 Unprefixed group name.
3175 @item A
3176 Current article number.
3177 @item V
3178 Gnus version.
3179 @item U
3180 Number of unread articles in this group.
3181 @item e
3182 Number of unselected articles in this group.
3183 @item Z
3184 A string with the number of unread and unselected articles represented
3185 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3186 articles, and just as @samp{<%U more>} if there are just unread articles
3187 and no unselected ones.
3188 @item g
3189 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3190 shortened to @samp{r.a.anime}. 
3191 @item S
3192 Subject of the current article.
3193 @item u
3194 User-defined spec.
3195 @item s
3196 Name of the current score file.
3197 @item d
3198 Number of dormant articles.
3199 @item t
3200 Number of ticked articles.
3201 @item r
3202 Number of articles that have been marked as read in this session. 
3203 @item E
3204 Number of articles expunged by the score files.
3205 @end table
3206
3207
3208 @node Summary Highlighting
3209 @subsection Summary Highlighting
3210
3211 @table @code
3212
3213 @item gnus-visual-mark-article-hook
3214 @vindex gnus-visual-mark-article-hook
3215 This hook is run after selecting an article.  It is meant to be used for
3216 highlighting the article in some way.  It is not run if
3217 @code{gnus-visual} is @code{nil}.
3218
3219 @item gnus-summary-update-hook
3220 @vindex gnus-summary-update-hook
3221 This hook is called when a summary line is changed.  It is not run if
3222 @code{gnus-visual} is @code{nil}.
3223
3224 @item gnus-summary-selected-face
3225 @vindex gnus-summary-selected-face
3226 This is the face (or @dfn{font} as some people call it) that is used to
3227 highlight the current article in the summary buffer.
3228
3229 @item gnus-summary-highlight
3230 @vindex gnus-summary-highlight
3231 Summary lines are highlighted according to this variable, which is a
3232 list where the elements are on the format @var{(FORM . FACE)}.  If you
3233 would, for instance, like ticked articles to be italic and high-scored
3234 articles to be bold, you could set this variable to something like
3235 @lisp
3236 (((eq mark gnus-ticked-mark) . italic)
3237  ((> score default) . bold))
3238 @end lisp
3239 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3240 @var{FACE} will be applied to the line.
3241 @end table
3242
3243
3244 @node Summary Maneuvering
3245 @section Summary Maneuvering
3246 @cindex summary movement
3247
3248 All the straight movement commands understand the numeric prefix and
3249 behave pretty much as you'd expect. 
3250
3251 None of these commands select articles.
3252
3253 @table @kbd
3254 @item G M-n
3255 @itemx M-n
3256 @kindex M-n (Summary)
3257 @kindex G M-n (Summary)
3258 @findex gnus-summary-next-unread-subject
3259 Go to the next summary line of an unread article
3260 (@code{gnus-summary-next-unread-subject}). 
3261
3262 @item G M-p
3263 @itemx M-p
3264 @kindex M-p (Summary)
3265 @kindex G M-p (Summary)
3266 @findex gnus-summary-prev-unread-subject
3267 Go to the previous summary line of an unread article
3268 (@code{gnus-summary-prev-unread-subject}). 
3269
3270 @item G j
3271 @itemx j
3272 @kindex j (Summary)
3273 @kindex G j (Summary)
3274 @findex gnus-summary-goto-article
3275 Ask for an article number and then go to that article
3276 (@code{gnus-summary-goto-article}). 
3277
3278 @item G g
3279 @kindex G g (Summary)
3280 @findex gnus-summary-goto-subject
3281 Ask for an article number and then go the summary line of that article
3282 without displaying the article (@code{gnus-summary-goto-subject}).
3283 @end table
3284
3285 If Gnus asks you to press a key to confirm going to the next group, you
3286 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3287 buffer, searching for the next group to read without actually returning
3288 to the group buffer.
3289
3290 Variables related to summary movement:
3291
3292 @table @code
3293
3294 @vindex gnus-auto-select-next
3295 @item gnus-auto-select-next
3296 If you issue one of the movement commands (like @kbd{n}) and there are
3297 no more unread articles after the current one, Gnus will offer to go to
3298 the next group.  If this variable is @code{t} and the next group is
3299 empty, Gnus will exit summary mode and return to the group buffer.  If
3300 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3301 next group, no matter whether it has any unread articles or not.  As a
3302 special case, if this variable is @code{quietly}, Gnus will select the
3303 next group without asking for confirmation.  If this variable is
3304 @code{almost-quietly}, the same will happen only if you are located on
3305 the last article in the group.  Finally, if this variable is
3306 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3307 without confirmation.  Also @pxref{Group Levels}.
3308
3309 @item gnus-auto-select-same
3310 @vindex gnus-auto-select-same
3311 If non-@code{nil}, all the movement commands will try to go to the next
3312 article with the same subject as the current.  (@dfn{Same} here might
3313 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3314 for details (@pxref{Customizing Threading}).)  This variable is not
3315 particularly useful if you use a threaded display.
3316
3317 @item gnus-summary-check-current
3318 @vindex gnus-summary-check-current
3319 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3320 to the next (or previous) article if the current article is unread.
3321 Instead, they will choose the current article.
3322
3323 @item gnus-auto-center-summary
3324 @vindex gnus-auto-center-summary
3325 If non-@code{nil}, Gnus will keep the point in the summary buffer
3326 centered at all times.  This makes things quite tidy, but if you have a
3327 slow network connection, or simply do not like this un-Emacsism, you can
3328 set this variable to @code{nil} to get the normal Emacs scrolling
3329 action.  This will also inhibit horizontal re-centering of the summary
3330 buffer, which might make it more inconvenient to read extremely long
3331 threads.
3332
3333 @end table
3334
3335
3336 @node Choosing Articles
3337 @section Choosing Articles
3338 @cindex selecting articles
3339
3340 @menu
3341 * Choosing Commands::        Commands for choosing articles.
3342 * Choosing Variables::       Variables that influence these commands.
3343 @end menu
3344
3345
3346 @node Choosing Commands
3347 @subsection Choosing Commands
3348
3349 None of the following movement commands understand the numeric prefix,
3350 and they all select and display an article.
3351
3352 @table @kbd
3353 @item SPACE
3354 @kindex SPACE (Summary)
3355 @findex gnus-summary-next-page
3356 Select the current article, or, if that one's read already, the next
3357 unread article (@code{gnus-summary-next-page}).
3358
3359 @item G n
3360 @itemx n
3361 @kindex n (Summary)
3362 @kindex G n (Summary)
3363 @findex gnus-summary-next-unread-article
3364 Go to next unread article (@code{gnus-summary-next-unread-article}).
3365
3366 @item G p
3367 @itemx p
3368 @kindex p (Summary)
3369 @findex gnus-summary-prev-unread-article
3370 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3371
3372 @item G N
3373 @itemx N
3374 @kindex N (Summary)
3375 @kindex G N (Summary)
3376 @findex gnus-summary-next-article
3377 Go to the next article (@code{gnus-summary-next-article}).
3378
3379 @item G P
3380 @itemx P
3381 @kindex P (Summary)
3382 @kindex G P (Summary)
3383 @findex gnus-summary-prev-article
3384 Go to the previous article (@code{gnus-summary-prev-article}).
3385
3386 @item G C-n
3387 @kindex G C-n (Summary)
3388 @findex gnus-summary-next-same-subject
3389 Go to the next article with the same subject
3390 (@code{gnus-summary-next-same-subject}). 
3391
3392 @item G C-p
3393 @kindex G C-p (Summary)
3394 @findex gnus-summary-prev-same-subject
3395 Go to the previous article with the same subject
3396 (@code{gnus-summary-prev-same-subject}). 
3397
3398 @item G f
3399 @itemx .
3400 @kindex G f  (Summary)
3401 @kindex .  (Summary)
3402 @findex gnus-summary-first-unread-article
3403 Go to the first unread article
3404 (@code{gnus-summary-first-unread-article}).
3405
3406 @item G b
3407 @itemx ,
3408 @kindex G b (Summary)
3409 @kindex , (Summary)
3410 @findex gnus-summary-best-unread-article
3411 Go to the article with the highest score
3412 (@code{gnus-summary-best-unread-article}). 
3413
3414 @item G l
3415 @itemx l
3416 @kindex l (Summary)
3417 @kindex G l (Summary)
3418 @findex gnus-summary-goto-last-article
3419 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3420
3421 @item G p
3422 @kindex G p (Summary)
3423 @findex gnus-summary-pop-article
3424 Pop an article off the summary history and go to this article
3425 (@code{gnus-summary-pop-article}).  This command differs from the
3426 command above in that you can pop as many previous articles off the
3427 history as you like.
3428 @end table
3429
3430
3431 @node Choosing Variables
3432 @subsection Choosing Variables
3433
3434 Some variables that are relevant for moving and selecting articles:
3435
3436 @table @code
3437 @item gnus-auto-extend-newsgroup
3438 @vindex gnus-auto-extend-newsgroup
3439 All the movement commands will try to go to the previous (or next)
3440 article, even if that article isn't displayed in the Summary buffer if
3441 this variable is non-@code{nil}.  Gnus will then fetch the article from
3442 the server and display it in the article buffer.
3443
3444 @item gnus-select-article-hook
3445 @vindex gnus-select-article-hook
3446 This hook is called whenever an article is selected.  By default it
3447 exposes any threads hidden under the selected article.
3448
3449 @item gnus-mark-article-hook
3450 @vindex gnus-mark-article-hook
3451 @findex gnus-summary-mark-unread-as-read
3452 @findex gnus-summary-mark-read-and-unread-as-read
3453 @findex gnus-unread-mark
3454 This hook is called whenever an article is selected.  It is intended to
3455 be used for marking articles as read.  The default value is
3456 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3457 mark of almost any article you read to @code{gnus-unread-mark}.  The
3458 only articles not affected by this function are ticked, dormant, and
3459 expirable articles.  If you'd instead like to just have unread articles
3460 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3461 instead.  It will leave marks like @code{gnus-low-score-mark},
3462 @code{gnus-del-mark} (and so on) alone.
3463
3464 @end table
3465
3466
3467 @node Paging the Article
3468 @section Scrolling the Article
3469 @cindex article scrolling
3470
3471 @table @kbd
3472
3473 @item SPACE
3474 @kindex SPACE (Summary)
3475 @findex gnus-summary-next-page
3476 Pressing @kbd{SPACE} will scroll the current article forward one page,
3477 or, if you have come to the end of the current article, will choose the
3478 next article (@code{gnus-summary-next-page}).
3479
3480 @item DEL
3481 @kindex DEL (Summary)
3482 @findex gnus-summary-prev-page
3483 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3484
3485 @item RET
3486 @kindex RET (Summary)
3487 @findex gnus-summary-scroll-up
3488 Scroll the current article one line forward
3489 (@code{gnus-summary-scroll-up}).
3490
3491 @item A g
3492 @itemx g
3493 @kindex A g (Summary)
3494 @kindex g (Summary)
3495 @findex gnus-summary-show-article
3496 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3497 given a prefix, fetch the current article, but don't run any of the
3498 article treatment functions.  This will give you a ``raw'' article, just
3499 the way it came from the server.
3500
3501 @item A <
3502 @itemx <
3503 @kindex < (Summary)
3504 @kindex A < (Summary)
3505 @findex gnus-summary-beginning-of-article
3506 Scroll to the beginning of the article
3507 (@code{gnus-summary-beginning-of-article}).
3508
3509 @item A >
3510 @itemx >
3511 @kindex > (Summary)
3512 @kindex A > (Summary)
3513 @findex gnus-summary-end-of-article
3514 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3515
3516 @item A s 
3517 @itemx s
3518 @kindex A s (Summary)
3519 @kindex s (Summary)
3520 @findex gnus-summary-isearch-article
3521 Perform an isearch in the article buffer
3522 (@code{gnus-summary-isearch-article}). 
3523
3524 @end table
3525
3526
3527 @node Reply Followup and Post
3528 @section Reply, Followup and Post
3529
3530 @menu
3531 * Summary Mail Commands::            Sending mail.
3532 * Summary Post Commands::            Sending news.
3533 @end menu
3534
3535
3536 @node Summary Mail Commands
3537 @subsection Summary Mail Commands
3538 @cindex mail
3539 @cindex composing mail
3540
3541 Commands for composing a mail message:
3542
3543 @table @kbd
3544
3545 @item S r
3546 @itemx r
3547 @kindex S r (Summary)
3548 @kindex r (Summary)
3549 @findex gnus-summary-reply
3550 Mail a reply to the author of the current article
3551 (@code{gnus-summary-reply}). 
3552
3553 @item S R
3554 @itemx R
3555 @kindex R (Summary)
3556 @kindex S R (Summary)
3557 @findex gnus-summary-reply-with-original
3558 Mail a reply to the author of the current article and include the
3559 original message (@code{gnus-summary-reply-with-original}).  This
3560 command uses the process/prefix convention.
3561
3562 @item S w
3563 @kindex S w (Summary)
3564 @findex gnus-summary-wide-reply
3565 Mail a wide reply to the author of the current article
3566 (@code{gnus-summary-wide-reply}). 
3567
3568 @item S W
3569 @kindex S W (Summary)
3570 @findex gnus-summary-wide-reply-with-original
3571 Mail a wide reply to the current article and include the original
3572 message (@code{gnus-summary-reply-with-original}).  This command uses
3573 the process/prefix convention.
3574
3575 @item S o m
3576 @kindex S o m (Summary)
3577 @findex gnus-summary-mail-forward
3578 Forward the current article to some other person
3579 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3580 headers of the forwarded article.
3581
3582 @item S m
3583 @itemx m
3584 @kindex m (Summary)
3585 @kindex S m (Summary)
3586 @findex gnus-summary-mail-other-window
3587 Send a mail to some other person
3588 (@code{gnus-summary-mail-other-window}).
3589
3590 @item S D b
3591 @kindex S D b (Summary)
3592 @findex gnus-summary-resend-bounced-mail
3593 @cindex bouncing mail
3594 If you have sent a mail, but the mail was bounced back to you for some
3595 reason (wrong address, transient failure), you can use this command to
3596 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3597 will be popped into a mail buffer where you can edit the headers before
3598 sending the mail off again.  If you give a prefix to this command, and
3599 the bounced mail is a reply to some other mail, Gnus will try to fetch
3600 that mail and display it for easy perusal of its headers.  This might
3601 very well fail, though.
3602
3603 @item S D r
3604 @kindex S D r (Summary)
3605 @findex gnus-summary-resend-message
3606 Not to be confused with the previous command,
3607 @code{gnus-summary-resend-message} will prompt you for an address to
3608 send the current message off to, and then send it to that place.  The
3609 headers of the message won't be altered---but lots of headers that say
3610 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3611 means that you actually send a mail to someone that has a @code{To}
3612 header that (probably) points to yourself.  This will confuse people.
3613 So, natcherly you'll only do that if you're really eVIl.  
3614
3615 This command is mainly used if you have several accounts and want to
3616 ship a mail to a different account of yours.  (If you're both
3617 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3618 to the @code{root} account, you may want to resend it to
3619 @code{postmaster}.  Ordnung muß sein!
3620
3621 This command understands the process/prefix convention
3622 (@pxref{Process/Prefix}). 
3623
3624 @item S O m
3625 @kindex S O m (Summary)
3626 @findex gnus-uu-digest-mail-forward
3627 Digest the current series and forward the result using mail
3628 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3629 process/prefix convention (@pxref{Process/Prefix}). 
3630
3631 @item S M-c
3632 @kindex S M-c (Summary)
3633 @findex gnus-summary-mail-crosspost-complaint
3634 @cindex crossposting
3635 @cindex excessive crossposting
3636 Send a complaint about excessive crossposting to the author of the
3637 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3638
3639 @findex gnus-crosspost-complaint
3640 This command is provided as a way to fight back agains the current
3641 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3642 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3643 command understands the process/prefix convention
3644 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3645
3646 @end table
3647
3648
3649 @node Summary Post Commands
3650 @subsection Summary Post Commands
3651 @cindex post
3652 @cindex composing news
3653
3654 Commands for posting a news article:
3655
3656 @table @kbd
3657 @item S p
3658 @itemx a
3659 @kindex a (Summary)
3660 @kindex S p (Summary)
3661 @findex gnus-summary-post-news
3662 Post an article to the current group
3663 (@code{gnus-summary-post-news}).
3664
3665 @item S f
3666 @itemx f
3667 @kindex f (Summary)
3668 @kindex S f (Summary)
3669 @findex gnus-summary-followup
3670 Post a followup to the current article (@code{gnus-summary-followup}).
3671
3672 @item S F
3673 @itemx F
3674 @kindex S F (Summary)
3675 @kindex F (Summary)
3676 @findex gnus-summary-followup-with-original
3677 Post a followup to the current article and include the original message
3678 (@code{gnus-summary-followup-with-original}).   This command uses the
3679 process/prefix convention.
3680
3681 @item S n
3682 @kindex S n (Summary)
3683 @findex gnus-summary-followup-to-mail
3684 Post a followup to the current article via news, even if you got the
3685 message through mail (@code{gnus-summary-followup-to-mail}).
3686
3687 @item S n
3688 @kindex S n (Summary)
3689 @findex gnus-summary-followup-to-mail
3690 Post a followup to the current article via news, even if you got the
3691 message through mail and include the original message
3692 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3693 the process/prefix convention.
3694
3695 @item S o p
3696 @kindex S o p (Summary)
3697 @findex gnus-summary-post-forward
3698 Forward the current article to a newsgroup
3699 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3700 headers of the forwarded article.
3701
3702 @item S O p
3703 @kindex S O p (Summary)
3704 @findex gnus-uu-digest-post-forward
3705 Digest the current series and forward the result to a newsgroup
3706 (@code{gnus-uu-digest-mail-forward}).  
3707
3708 @item S u
3709 @kindex S u (Summary)
3710 @findex gnus-uu-post-news
3711 Uuencode a file, split it into parts, and post it as a series
3712 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3713 @end table
3714
3715
3716 @node Canceling and Superseding
3717 @section Canceling Articles
3718 @cindex canceling articles
3719 @cindex superseding articles
3720
3721 Have you ever written something, and then decided that you really,
3722 really, really wish you hadn't posted that?
3723
3724 Well, you can't cancel mail, but you can cancel posts.
3725
3726 @findex gnus-summary-cancel-article
3727 @kindex C (Summary)
3728 Find the article you wish to cancel (you can only cancel your own
3729 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3730 c} (@code{gnus-summary-cancel-article}).  Your article will be
3731 canceled---machines all over the world will be deleting your article. 
3732
3733 Be aware, however, that not all sites honor cancels, so your article may
3734 live on here and there, while most sites will delete the article in
3735 question.
3736
3737 If you discover that you have made some mistakes and want to do some
3738 corrections, you can post a @dfn{superseding} article that will replace
3739 your original article.
3740
3741 @findex gnus-summary-supersede-article
3742 @kindex S (Summary)
3743 Go to the original article and press @kbd{S s}
3744 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3745 where you can edit the article all you want before sending it off the
3746 usual way.
3747
3748 The same goes for superseding as for canceling, only more so: Some
3749 sites do not honor superseding.  On those sites, it will appear that you
3750 have posted almost the same article twice.
3751
3752 If you have just posted the article, and change your mind right away,
3753 there is a trick you can use to cancel/supersede the article without
3754 waiting for the article to appear on your site first.  You simply return
3755 to the post buffer (which is called @code{*sent ...*}).  There you will
3756 find the article you just posted, with all the headers intact.  Change
3757 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3758 header by substituting one of those words for the word
3759 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3760 you would do normally.  The previous article will be
3761 canceled/superseded.
3762
3763 Just remember, kids: There is no 'c' in 'supersede'.
3764
3765
3766 @node Marking Articles
3767 @section Marking Articles
3768 @cindex article marking
3769 @cindex article ticking
3770 @cindex marks
3771
3772 There are several marks you can set on an article. 
3773
3774 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3775 neologism ohoy!) of the article.  Alphabetic marks generally mean
3776 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3777
3778 In addition, you also have marks that do not affect readedness.
3779
3780 @menu
3781 * Unread Articles::      Marks for unread articles.
3782 * Read Articles::        Marks for read articles.
3783 * Other Marks::          Marks that do not affect readedness.
3784 @end menu
3785
3786 @ifinfo
3787 There's a plethora of commands for manipulating these marks:
3788 @end ifinfo
3789
3790 @menu
3791 * Setting Marks::           How to set and remove marks.
3792 * Setting Process Marks::   How to mark articles for later processing.
3793 @end menu
3794
3795
3796 @node Unread Articles
3797 @subsection Unread Articles
3798
3799 The following marks mark articles as (kinda) unread, in one form or
3800 other.
3801
3802 @table @samp
3803 @item !
3804 @vindex gnus-ticked-mark
3805 Marked as ticked (@code{gnus-ticked-mark}).
3806
3807 @dfn{Ticked articles} are articles that will remain visible always.  If
3808 you see an article that you find interesting, or you want to put off
3809 reading it, or replying to it, until sometime later, you'd typically
3810 tick it.  However, articles can be expired, so if you want to keep an
3811 article forever, you'll have to make it persistent (@pxref{Persistent
3812 Articles}).  
3813
3814 @item ?
3815 @vindex gnus-dormant-mark
3816 Marked as dormant (@code{gnus-dormant-mark}).  
3817
3818 @dfn{Dormant articles} will only appear in the summary buffer if there
3819 are followups to it.
3820
3821 @item SPACE
3822 @vindex gnus-unread-mark
3823 Markes as unread (@code{gnus-unread-mark}).
3824
3825 @dfn{Unread articles} are articles that haven't been read at all yet.
3826 @end table
3827
3828
3829 @node Read Articles
3830 @subsection Read Articles
3831 @cindex expirable mark
3832
3833 All the following marks mark articles as read.
3834
3835 @table @samp
3836
3837 @item r
3838 @vindex gnus-del-mark
3839 These are articles that the user has marked as read with the @kbd{d}
3840 command manually, more or less (@code{gnus-del-mark}).
3841
3842 @item R
3843 @vindex gnus-read-mark
3844 Articles that have actually been read (@code{gnus-read-mark}).
3845
3846 @item O
3847 @vindex gnus-ancient-mark
3848 Articles that were marked as read in previous sessions and are now
3849 @dfn{old} (@code{gnus-ancient-mark}).
3850
3851 @item K
3852 @vindex gnus-killed-mark
3853 Marked as killed (@code{gnus-killed-mark}).
3854
3855 @item X
3856 @vindex gnus-kill-file-mark
3857 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3858
3859 @item Y
3860 @vindex gnus-low-score-mark
3861 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3862
3863 @item C
3864 @vindex gnus-catchup-mark
3865 Marked as read by a catchup (@code{gnus-catchup-mark}).
3866
3867 @item G
3868 @vindex gnus-canceled-mark
3869 Canceled article (@code{gnus-canceled-mark})
3870
3871 @item F
3872 @vindex gnus-souped-mark
3873 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3874
3875 @item Q
3876 @vindex gnus-sparse-mark
3877 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3878 Threading}.
3879
3880 @item M
3881 @vindex gnus-duplicate-mark
3882 Article marked as read by duplicate suppression
3883 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3884
3885 @end table
3886
3887 All these marks just mean that the article is marked as read, really.
3888 They are interpreted differently when doing adaptive scoring, though.
3889
3890 One more special mark, though:
3891
3892 @table @samp
3893 @item E
3894 @vindex gnus-expirable-mark
3895 Marked as expirable (@code{gnus-expirable-mark}).
3896
3897 Marking articles as @dfn{expirable} (or have them marked as such
3898 automatically) doesn't make much sense in normal groups---a user doesn't
3899 control the expiring of news articles, but in mail groups, for instance,
3900 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3901 any time.
3902 @end table
3903
3904
3905 @node Other Marks
3906 @subsection Other Marks
3907 @cindex process mark
3908 @cindex bookmarks
3909
3910 There are some marks that have nothing to do with whether the article is
3911 read or not.
3912
3913 @itemize @bullet
3914
3915 @item 
3916 You can set a bookmark in the current article.  Say you are reading a
3917 long thesis on cats' urinary tracts, and have to go home for dinner
3918 before you've finished reading the thesis.  You can then set a bookmark
3919 in the article, and Gnus will jump to this bookmark the next time it
3920 encounters the article.  @xref{Setting Marks}
3921
3922 @item
3923 @vindex gnus-replied-mark
3924 All articles that you have replied to or made a followup to (i.e., have
3925 answered) will be marked with an @samp{A} in the second column
3926 (@code{gnus-replied-mark}).
3927
3928 @item 
3929 @vindex gnus-cached-mark
3930 Articles that are stored in the article cache will be marked with an
3931 @samp{*} in the second column (@code{gnus-cached-mark}).
3932
3933 @item 
3934 @vindex gnus-saved-mark
3935 Articles that are ``saved'' (in some manner or other; not necessarily
3936 religiously) are marked with an @samp{S} in the second column
3937 (@code{gnus-saved-mark}.
3938
3939 @item 
3940 @vindex gnus-not-empty-thread-mark
3941 @vindex gnus-empty-thread-mark
3942 It the @samp{%e} spec is used, the presence of threads or not will be
3943 marked with @code{gnus-not-empty-thread-mark} and
3944 @code{gnus-empty-thread-mark} in the third column, respectively.
3945
3946 @item 
3947 @vindex gnus-process-mark
3948 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3949 variety of commands react to the presence of the process mark.  For
3950 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3951 all articles that have been marked with the process mark.  Articles
3952 marked with the process mark have a @samp{#} in the second column.
3953
3954 @end itemize
3955
3956 You might have noticed that most of these ``non-readedness'' marks
3957 appear in the second column by default.  So if you have a cached, saved,
3958 replied article that you have process-marked, what will that look like?
3959
3960 Nothing much.  The precedence rules go as follows: process -> cache ->
3961 replied -> saved.  So if the article is in the cache and is replied,
3962 you'll only see the cache mark and not the replied mark.
3963
3964
3965 @node Setting Marks
3966 @subsection Setting Marks
3967 @cindex setting marks
3968
3969 All the marking commands understand the numeric prefix.
3970
3971 @table @kbd
3972 @item M t
3973 @itemx !
3974 @kindex ! (Summary)
3975 @kindex M t (Summary)
3976 @findex gnus-summary-tick-article-forward
3977 Tick the current article (@code{gnus-summary-tick-article-forward}).
3978
3979 @item M ?
3980 @itemx ?
3981 @kindex ? (Summary)
3982 @kindex M ? (Summary)
3983 @findex gnus-summary-mark-as-dormant
3984 Mark the current article as dormant
3985 (@code{gnus-summary-mark-as-dormant}).
3986
3987 @item M d
3988 @itemx d
3989 @kindex M d (Summary)
3990 @kindex d (Summary)
3991 @findex gnus-summary-mark-as-read-forward
3992 Mark the current article as read
3993 (@code{gnus-summary-mark-as-read-forward}).
3994
3995 @item D
3996 @kindex D (Summary)
3997 @findex gnus-summary-mark-as-read-backward
3998 Mark the current article as read and move point to the previous line
3999 (@code{gnus-summary-mark-as-read-backward}).
4000
4001 @item M k
4002 @itemx k
4003 @kindex k (Summary)
4004 @kindex M k (Summary)
4005 @findex gnus-summary-kill-same-subject-and-select
4006 Mark all articles that have the same subject as the current one as read,
4007 and then select the next unread article
4008 (@code{gnus-summary-kill-same-subject-and-select}).
4009
4010 @item M K
4011 @itemx C-k
4012 @kindex M K (Summary)
4013 @kindex C-k (Summary)
4014 @findex gnus-summary-kill-same-subject
4015 Mark all articles that have the same subject as the current one as read
4016 (@code{gnus-summary-kill-same-subject}).  
4017
4018 @item M C
4019 @kindex M C (Summary)
4020 @findex gnus-summary-catchup
4021 Mark all unread articles as read (@code{gnus-summary-catchup}).
4022
4023 @item M C-c
4024 @kindex M C-c (Summary)
4025 @findex gnus-summary-catchup-all
4026 Mark all articles in the group as read---even the ticked and dormant
4027 articles (@code{gnus-summary-catchup-all}).
4028
4029 @item M H
4030 @kindex M H (Summary)
4031 @findex gnus-summary-catchup-to-here
4032 Catchup the current group to point
4033 (@code{gnus-summary-catchup-to-here}). 
4034
4035 @item C-w
4036 @kindex C-w (Summary)
4037 @findex gnus-summary-mark-region-as-read
4038 Mark all articles between point and mark as read
4039 (@code{gnus-summary-mark-region-as-read}). 
4040
4041 @item M V k
4042 @kindex M V k (Summary)
4043 @findex gnus-summary-kill-below
4044 Kill all articles with scores below the default score (or below the
4045 numeric prefix) (@code{gnus-summary-kill-below}).
4046
4047 @item M c
4048 @itemx M-u
4049 @kindex M c (Summary)
4050 @kindex M-u (Summary)
4051 @findex gnus-summary-clear-mark-forward
4052 Clear all readedness-marks from the current article
4053 (@code{gnus-summary-clear-mark-forward}).
4054
4055 @item M e
4056 @itemx E
4057 @kindex M e (Summary)
4058 @kindex E (Summary)
4059 @findex gnus-summary-mark-as-expirable
4060 Mark the current article as expirable
4061 (@code{gnus-summary-mark-as-expirable}).
4062
4063 @item M b
4064 @kindex M b (Summary)
4065 @findex gnus-summary-set-bookmark
4066 Set a bookmark in the current article
4067 (@code{gnus-summary-set-bookmark}).
4068
4069 @item M B
4070 @kindex M B (Summary)
4071 @findex gnus-summary-remove-bookmark
4072 Remove the bookmark from the current article
4073 (@code{gnus-summary-remove-bookmark}).
4074
4075 @item M V c
4076 @kindex M V c (Summary)
4077 @findex gnus-summary-clear-above
4078 Clear all marks from articles with scores over the default score (or
4079 over the numeric prefix) (@code{gnus-summary-clear-above}).
4080
4081 @item M V u
4082 @kindex M V u (Summary)
4083 @findex gnus-summary-tick-above
4084 Tick all articles with scores over the default score (or over the
4085 numeric prefix) (@code{gnus-summary-tick-above}).
4086
4087 @item M V m
4088 @kindex M V m (Summary)
4089 @findex gnus-summary-mark-above
4090 Prompt for a mark, and mark all articles with scores over the default
4091 score (or over the numeric prefix) with this mark
4092 (@code{gnus-summary-clear-above}).
4093 @end table
4094
4095 @vindex gnus-summary-goto-unread
4096 The @code{gnus-summary-goto-unread} variable controls what action should
4097 be taken after setting a mark.  If non-@code{nil}, point will move to
4098 the next/previous unread article.  If @code{nil}, point will just move
4099 one line up or down.  As a special case, if this variable is
4100 @code{never}, all the marking commands as well as other commands (like
4101 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4102 The default is @code{t}.
4103
4104
4105 @node Setting Process Marks
4106 @subsection Setting Process Marks
4107 @cindex setting process marks
4108
4109 @table @kbd
4110
4111 @item M P p
4112 @itemx #
4113 @kindex # (Summary)
4114 @kindex M P p (Summary)
4115 @findex gnus-summary-mark-as-processable
4116 Mark the current article with the process mark
4117 (@code{gnus-summary-mark-as-processable}). 
4118 @findex gnus-summary-unmark-as-processable
4119
4120 @item M P u 
4121 @itemx M-#
4122 @kindex M P u (Summary)
4123 @kindex M-# (Summary)
4124 Remove the process mark, if any, from the current article
4125 (@code{gnus-summary-unmark-as-processable}).
4126
4127 @item M P U
4128 @kindex M P U (Summary)
4129 @findex gnus-summary-unmark-all-processable
4130 Remove the process mark from all articles
4131 (@code{gnus-summary-unmark-all-processable}). 
4132
4133 @item M P i
4134 @kindex M P i (Summary)
4135 @findex gnus-uu-invert-processable
4136 Invert the list of process marked articles
4137 (@code{gnus-uu-invert-processable}). 
4138
4139 @item M P R
4140 @kindex M P R (Summary)
4141 @findex gnus-uu-mark-by-regexp
4142 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4143
4144 @item M P r
4145 @kindex M P r (Summary)
4146 @findex gnus-uu-mark-region
4147 Mark articles in region (@code{gnus-uu-mark-region}).
4148
4149 @item M P t
4150 @kindex M P t (Summary)
4151 @findex gnus-uu-mark-thread
4152 Mark all articles in the current (sub)thread
4153 (@code{gnus-uu-mark-thread}).
4154
4155 @item M P T
4156 @kindex M P T (Summary)
4157 @findex gnus-uu-unmark-thread
4158 Unmark all articles in the current (sub)thread
4159 (@code{gnus-uu-unmark-thread}).
4160
4161 @item M P v
4162 @kindex M P v (Summary)
4163 @findex gnus-uu-mark-over
4164 Mark all articles that have a score above the prefix argument
4165 (@code{gnus-uu-mark-over}).
4166
4167 @item M P s
4168 @kindex M P s (Summary)
4169 @findex gnus-uu-mark-series
4170 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4171
4172 @item M P S
4173 @kindex M P S (Summary)
4174 @findex gnus-uu-mark-sparse
4175 Mark all series that have already had some articles marked
4176 (@code{gnus-uu-mark-sparse}).
4177
4178 @item M P a
4179 @kindex M P a (Summary)
4180 @findex gnus-uu-mark-all
4181 Mark all articles in series order (@code{gnus-uu-mark-series}).
4182
4183 @item M P b
4184 @kindex M P b (Summary)
4185 @findex gnus-uu-mark-buffer
4186 Mark all articles in the buffer in the order they appear
4187 (@code{gnus-uu-mark-buffer}). 
4188
4189 @item M P k
4190 @kindex M P k (Summary)
4191 @findex gnus-summary-kill-process-mark
4192 Push the current process mark set onto the stack and unmark all articles
4193 (@code{gnus-summary-kill-process-mark}).
4194
4195 @item M P y
4196 @kindex M P y (Summary)
4197 @findex gnus-summary-yank-process-mark
4198 Pop the previous process mark set from the stack and restore it
4199 (@code{gnus-summary-yank-process-mark}).
4200
4201 @item M P w
4202 @kindex M P w (Summary)
4203 @findex gnus-summary-save-process-mark
4204 Push the current process mark set onto the stack
4205 (@code{gnus-summary-save-process-mark}).
4206
4207 @end table
4208
4209
4210 @node Limiting
4211 @section Limiting
4212 @cindex limiting
4213
4214 It can be convenient to limit the summary buffer to just show some
4215 subset of the articles currently in the group.  The effect most limit
4216 commands have is to remove a few (or many) articles from the summary
4217 buffer. 
4218
4219 @table @kbd
4220
4221 @item / /
4222 @itemx / s
4223 @kindex / / (Summary)
4224 @findex gnus-summary-limit-to-subject
4225 Limit the summary buffer to articles that match some subject
4226 (@code{gnus-summary-limit-to-subject}). 
4227
4228 @item / a
4229 @kindex / a (Summary)
4230 @findex gnus-summary-limit-to-author
4231 Limit the summary buffer to articles that match some author
4232 (@code{gnus-summary-limit-to-author}).
4233
4234 @item / u
4235 @itemx x
4236 @kindex / u (Summary)
4237 @kindex x (Summary)
4238 @findex gnus-summary-limit-to-unread
4239 Limit the summary buffer to articles that are not marked as read
4240 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4241 buffer to articles that are strictly unread.  This means that ticked and
4242 dormant articles will also be excluded.
4243
4244 @item / m
4245 @kindex / m (Summary)
4246 @findex gnus-summary-limit-to-marks
4247 Ask for a mark and then limit to all articles that have not been marked
4248 with that mark (@code{gnus-summary-limit-to-marks}).
4249
4250 @item / t
4251 @kindex / t (Summary)
4252 @findex gnus-summary-limit-to-age
4253 Ask for a number and then limit the summary buffer to articles that are
4254 older than (or equal to) that number of days
4255 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4256 articles that are younger than that number of days.
4257
4258 @item / n
4259 @kindex / n (Summary)
4260 @findex gnus-summary-limit-to-articles
4261 Limit the summary buffer to the current article
4262 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4263 convention (@pxref{Process/Prefix}).
4264
4265 @item / w
4266 @kindex / w (Summary)
4267 @findex gnus-summary-pop-limit
4268 Pop the previous limit off the stack and restore it
4269 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4270 the stack.
4271
4272 @item / v
4273 @kindex / v (Summary)
4274 @findex gnus-summary-limit-to-score
4275 Limit the summary buffer to articles that have a score at or above some
4276 score (@code{gnus-summary-limit-to-score}).
4277
4278 @item / E
4279 @itemx M S
4280 @kindex M S (Summary)
4281 @kindex / E (Summary)
4282 @findex gnus-summary-limit-include-expunged
4283 Display all expunged articles
4284 (@code{gnus-summary-limit-include-expunged}). 
4285
4286 @item / D
4287 @kindex / D (Summary)
4288 @findex gnus-summary-limit-include-dormant
4289 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4290
4291 @item / d
4292 @kindex / d (Summary)
4293 @findex gnus-summary-limit-exclude-dormant
4294 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4295
4296 @item / c
4297 @kindex / c (Summary)
4298 @findex gnus-summary-limit-exclude-childless-dormant
4299 Hide all dormant articles that have no children
4300 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4301
4302 @item / C
4303 @kindex / C (Summary)
4304 @findex gnus-summary-limit-mark-excluded-as-read
4305 Mark all excluded unread articles as read
4306 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4307 also mark excluded ticked and dormant articles as read.
4308
4309 @end table
4310
4311
4312 @node Threading
4313 @section Threading
4314 @cindex threading
4315 @cindex article threading
4316
4317 Gnus threads articles by default.  @dfn{To thread} is to put replies to
4318 articles directly after the articles they reply to---in a hierarchical
4319 fashion.
4320
4321 @menu
4322 * Customizing Threading::     Variables you can change to affect the threading.
4323 * Thread Commands::           Thread based commands in the summary buffer.
4324 @end menu
4325
4326
4327 @node Customizing Threading
4328 @subsection Customizing Threading
4329 @cindex customizing threading
4330 @cindex <
4331 @cindex >
4332
4333 @table @code
4334
4335 @item gnus-show-threads
4336 @vindex gnus-show-threads
4337 If this variable is @code{nil}, no threading will be done, and all of
4338 the rest of the variables here will have no effect.  Turning threading
4339 off will speed group selection up a bit, but it is sure to make reading
4340 slower and more awkward.
4341
4342 @item gnus-fetch-old-headers
4343 @vindex gnus-fetch-old-headers
4344 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4345 more old headers---headers to articles that are marked as read.  If you
4346 would like to display as few summary lines as possible, but still
4347 connect as many loose threads as possible, you should set this variable
4348 to @code{some} or a number.  If you set it to a number, no more than
4349 that number of extra old headers will be fetched.  In either case,
4350 fetching old headers only works if the backend you are using carries
4351 overview files---this would normally be @code{nntp}, @code{nnspool} and
4352 @code{nnml}.  Also remember that if the root of the thread has been
4353 expired by the server, there's not much Gnus can do about that.
4354
4355 @item gnus-build-sparse-threads
4356 @vindex gnus-build-sparse-threads
4357 Fetching old headers can be slow.  A low-rent similar effect can be
4358 gotten by setting this variable to @code{some}.  Gnus will then look at
4359 the complete @code{References} headers of all articles and try to string
4360 articles that belong in the same thread together.  This will leave
4361 @dfn{gaps} in the threading display where Gnus guesses that an article
4362 is missing from the thread.  (These gaps appear like normal summary
4363 lines.  If you select a gap, Gnus will try to fetch the article in
4364 question.)  If this variable is @code{t}, Gnus will display all these
4365 ``gaps'' without regard for whether they are useful for completing the
4366 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4367 off sparse leaf nodes that don't lead anywhere.  This variable is
4368 @code{nil} by default.
4369
4370 @item gnus-summary-gather-subject-limit
4371 @vindex gnus-summary-gather-subject-limit
4372 Loose threads are gathered by comparing subjects of articles.  If this
4373 variable is @code{nil}, Gnus requires an exact match between the
4374 subjects of the loose threads before gathering them into one big
4375 super-thread.  This might be too strict a requirement, what with the
4376 presence of stupid newsreaders that chop off long subjects lines.  If
4377 you think so, set this variable to, say, 20 to require that only the
4378 first 20 characters of the subjects have to match.  If you set this
4379 variable to a really low number, you'll find that Gnus will gather
4380 everything in sight into one thread, which isn't very helpful.
4381
4382 @cindex fuzzy article gathering
4383 If you set this variable to the special value @code{fuzzy}, Gnus will
4384 use a fuzzy string comparison algorithm on the subjects.
4385
4386 @item gnus-simplify-subject-fuzzy-regexp
4387 @vindex gnus-simplify-subject-fuzzy-regexp
4388 This can either be a regular expression or list of regular expressions
4389 that match strings that will be removed from subjects if fuzzy subject
4390 simplification is used.
4391
4392 @item gnus-simplify-ignored-prefixes
4393 @vindex gnus-simplify-ignored-prefixes
4394 If you set @code{gnus-summary-gather-subject-limit} to something as low
4395 as 10, you might consider setting this variable to something sensible:
4396
4397 @c Written by Michael Ernst <mernst@cs.rice.edu>
4398 @lisp
4399 (setq gnus-simplify-ignored-prefixes
4400       (concat 
4401        "\\`\\[?\\("
4402        (mapconcat 
4403         'identity
4404         '("looking"
4405           "wanted" "followup" "summary\\( of\\)?"
4406           "help" "query" "problem" "question" 
4407           "answer" "reference" "announce"
4408           "How can I" "How to" "Comparison of"
4409           ;; ...
4410           )
4411         "\\|")
4412        "\\)\\s *\\("
4413        (mapconcat 'identity
4414                   '("for" "for reference" "with" "about")
4415                   "\\|")
4416        "\\)?\\]?:?[ \t]*"))
4417 @end lisp
4418
4419 All words that match this regexp will be removed before comparing two
4420 subjects. 
4421
4422 @item gnus-summary-gather-exclude-subject
4423 @vindex gnus-summary-gather-exclude-subject
4424 Since loose thread gathering is done on subjects only, that might lead
4425 to many false hits, especially with certain common subjects like
4426 @samp{} and @samp{(none)}.  To make the situation slightly better,
4427 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4428 what subjects should be excluded from the gathering process.  The
4429 default is @samp{^ *$\\|^(none)$}.  
4430
4431 @item gnus-summary-thread-gathering-function
4432 @vindex gnus-summary-thread-gathering-function
4433 Gnus gathers threads by looking at @code{Subject} headers.  This means
4434 that totally unrelated articles may end up in the same ``thread'', which
4435 is confusing.  An alternate approach is to look at all the
4436 @code{Message-ID}s in all the @code{References} headers to find matches.
4437 This will ensure that no gathered threads ever includes unrelated
4438 articles, but it's also means that people who have posted with broken
4439 newsreaders won't be gathered properly.  The choice is yours---plague or
4440 cholera:
4441
4442 @table @code
4443 @item gnus-gather-threads-by-subject
4444 @findex gnus-gather-threads-by-subject
4445 This function is the default gathering function and looks at
4446 @code{Subject}s exclusively.
4447
4448 @item gnus-gather-threads-by-references
4449 @findex gnus-gather-threads-by-references
4450 This function looks at @code{References} headers exclusively.
4451 @end table
4452
4453 If you want to test gathering by @code{References}, you could say
4454 something like:
4455
4456 @lisp
4457 (setq gnus-summary-thread-gathering-function
4458       'gnus-gather-threads-by-references)
4459 @end lisp
4460
4461 @item gnus-summary-make-false-root
4462 @vindex gnus-summary-make-false-root
4463 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4464 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4465 Yup.)  Loose subtrees occur when the real root has expired, or you've
4466 read or killed the root in a previous session.
4467
4468 When there is no real root of a thread, Gnus will have to fudge
4469 something.  This variable says what fudging method Gnus should use.
4470 There are four possible values:
4471
4472 @cindex adopting articles
4473
4474 @table @code
4475
4476 @item adopt
4477 Gnus will make the first of the orphaned articles the parent.  This
4478 parent will adopt all the other articles.  The adopted articles will be
4479 marked as such by pointy brackets (@samp{<>}) instead of the standard
4480 square brackets (@samp{[]}).  This is the default method.
4481
4482 @item dummy
4483 @vindex gnus-summary-dummy-line-format
4484 Gnus will create a dummy summary line that will pretend to be the
4485 parent.  This dummy line does not correspond to any real article, so
4486 selecting it will just select the first real article after the dummy
4487 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4488 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4489 which is the subject of the article.  @xref{Formatting Variables}.
4490
4491 @item empty
4492 Gnus won't actually make any article the parent, but simply leave the
4493 subject field of all orphans except the first empty.  (Actually, it will
4494 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4495 Buffer Format}).)
4496
4497 @item none
4498 Don't make any article parent at all.  Just gather the threads and
4499 display them after one another.
4500
4501 @item nil
4502 Don't gather loose threads.
4503 @end table
4504
4505 @item gnus-thread-hide-subtree
4506 @vindex gnus-thread-hide-subtree
4507 If non-@code{nil}, all threads will be hidden when the summary buffer is
4508 generated.
4509
4510 @item gnus-thread-expunge-below
4511 @vindex gnus-thread-expunge-below
4512 All threads that have a total score (as defined by
4513 @code{gnus-thread-score-function}) less than this number will be
4514 expunged.  This variable is @code{nil} by default, which means that no
4515 threads are expunged.
4516
4517 @item gnus-thread-hide-killed
4518 @vindex gnus-thread-hide-killed
4519 if you kill a thread and this variable is non-@code{nil}, the subtree
4520 will be hidden.
4521
4522 @item gnus-thread-ignore-subject
4523 @vindex gnus-thread-ignore-subject
4524 Sometimes somebody changes the subject in the middle of a thread.  If
4525 this variable is non-@code{nil}, the subject change is ignored.  If it
4526 is @code{nil}, which is the default, a change in the subject will result
4527 in a new thread.
4528
4529 @item gnus-thread-indent-level
4530 @vindex gnus-thread-indent-level
4531 This is a number that says how much each sub-thread should be indented.
4532 The default is 4.
4533
4534 @item gnus-parse-headers-hook
4535 @vindex gnus-parse-headers-hook
4536 Hook run before parsing any headers.  The default value is
4537 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4538 slightly decoded in a hackish way.  This is likely to change in the
4539 future when Gnus becomes @sc{MIME}ified.
4540
4541 @end table
4542
4543
4544 @node Thread Commands
4545 @subsection Thread Commands
4546 @cindex thread commands
4547
4548 @table @kbd
4549
4550 @item T k
4551 @itemx M-C-k
4552 @kindex T k (Summary)
4553 @kindex M-C-k (Summary)
4554 @findex gnus-summary-kill-thread
4555 Mark all articles in the current (sub-)thread as read
4556 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4557 remove all marks instead.  If the prefix argument is negative, tick
4558 articles instead.
4559
4560 @item T l
4561 @itemx M-C-l
4562 @kindex T l (Summary)
4563 @kindex M-C-l (Summary)
4564 @findex gnus-summary-lower-thread
4565 Lower the score of the current (sub-)thread
4566 (@code{gnus-summary-lower-thread}). 
4567
4568 @item T i
4569 @kindex T i (Summary)
4570 @findex gnus-summary-raise-thread
4571 Increase the score of the current (sub-)thread
4572 (@code{gnus-summary-raise-thread}).
4573
4574 @item T #
4575 @kindex T # (Summary)
4576 @findex gnus-uu-mark-thread
4577 Set the process mark on the current (sub-)thread
4578 (@code{gnus-uu-mark-thread}).
4579
4580 @item T M-#
4581 @kindex T M-# (Summary)
4582 @findex gnus-uu-unmark-thread
4583 Remove the process mark from the current (sub-)thread
4584 (@code{gnus-uu-unmark-thread}).
4585
4586 @item T T
4587 @kindex T T (Summary)
4588 @findex gnus-summary-toggle-threads
4589 Toggle threading (@code{gnus-summary-toggle-threads}).
4590
4591 @item T s
4592 @kindex T s (Summary)
4593 @findex gnus-summary-show-thread
4594 Expose the (sub-)thread hidden under the current article, if any
4595 (@code{gnus-summary-show-thread}).
4596
4597 @item T h
4598 @kindex T h (Summary)
4599 @findex gnus-summary-hide-thread
4600 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4601
4602 @item T S
4603 @kindex T S (Summary)
4604 @findex gnus-summary-show-all-threads
4605 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4606
4607 @item T H
4608 @kindex T H (Summary)
4609 @findex gnus-summary-hide-all-threads
4610 Hide all threads (@code{gnus-summary-hide-all-threads}).
4611
4612 @item T t
4613 @kindex T t (Summary)
4614 @findex gnus-summary-rethread-current
4615 Re-thread the thread the current article is part of
4616 (@code{gnus-summary-rethread-current}).  This works even when the
4617 summary buffer is otherwise unthreaded.
4618
4619 @item T ^
4620 @kindex T ^ (Summary)
4621 @findex gnus-summary-reparent-thread
4622 Make the current article the child of the marked (or previous) article
4623 (@code{gnus-summary-reparent-thread}.
4624
4625 @end table
4626
4627 The following commands are thread movement commands.  They all
4628 understand the numeric prefix.
4629
4630 @table @kbd
4631
4632 @item T n
4633 @kindex T n (Summary)
4634 @findex gnus-summary-next-thread
4635 Go to the next thread (@code{gnus-summary-next-thread}).
4636
4637 @item T p
4638 @kindex T p (Summary)
4639 @findex gnus-summary-prev-thread
4640 Go to the previous thread (@code{gnus-summary-prev-thread}).
4641
4642 @item T d
4643 @kindex T d (Summary)
4644 @findex gnus-summary-down-thread
4645 Descend the thread (@code{gnus-summary-down-thread}).
4646
4647 @item T u
4648 @kindex T u (Summary)
4649 @findex gnus-summary-up-thread
4650 Ascend the thread (@code{gnus-summary-up-thread}).
4651
4652 @item T o
4653 @kindex T o (Summary)
4654 @findex gnus-summary-top-thread
4655 Go to the top of the thread (@code{gnus-summary-top-thread}).
4656 @end table
4657
4658 @vindex gnus-thread-operation-ignore-subject 
4659 If you ignore subject while threading, you'll naturally end up with
4660 threads that have several different subjects in them.  If you then issue
4661 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4662 wish to kill the entire thread, but just those parts of the thread that
4663 have the same subject as the current article.  If you like this idea,
4664 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4665 is non-@code{nil} (which it is by default), subjects will be ignored
4666 when doing thread commands.  If this variable is @code{nil}, articles in
4667 the same thread with different subjects will not be included in the
4668 operation in question.  If this variable is @code{fuzzy}, only articles
4669 that have subjects that are fuzzily equal will be included.
4670
4671
4672 @node Sorting
4673 @section Sorting
4674
4675 @findex gnus-thread-sort-by-total-score
4676 @findex gnus-thread-sort-by-date
4677 @findex gnus-thread-sort-by-score
4678 @findex gnus-thread-sort-by-subject
4679 @findex gnus-thread-sort-by-author
4680 @findex gnus-thread-sort-by-number
4681 @vindex gnus-thread-sort-functions
4682 If you are using a threaded summary display, you can sort the threads by
4683 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4684 By default, sorting is done on article numbers.  Ready-made sorting
4685 predicate functions include @code{gnus-thread-sort-by-number},
4686 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4687 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4688 @code{gnus-thread-sort-by-total-score}.
4689
4690 Each function takes two threads and return non-@code{nil} if the first
4691 thread should be sorted before the other.  Note that sorting really is
4692 normally done by looking only at the roots of each thread.  If you use
4693 more than one function, the primary sort key should be the last function
4694 in the list.  You should probably always include
4695 @code{gnus-thread-sort-by-number} in the list of sorting
4696 functions---preferably first.  This will ensure that threads that are
4697 equal with respect to the other sort criteria will be displayed in
4698 ascending article order.
4699
4700 If you would like to sort by score, then by subject, and finally by
4701 number, you could do something like:
4702
4703 @lisp
4704 (setq gnus-thread-sort-functions 
4705       '(gnus-thread-sort-by-number
4706         gnus-thread-sort-by-subject
4707         gnus-thread-sort-by-score))
4708 @end lisp
4709
4710 The threads that have highest score will be displayed first in the
4711 summary buffer.  When threads have the same score, they will be sorted
4712 alphabetically.  The threads that have the same score and the same
4713 subject will be sorted by number, which is (normally) the sequence in
4714 which the articles arrived.
4715
4716 If you want to sort by score and then reverse arrival order, you could
4717 say something like:
4718
4719 @lisp
4720 (setq gnus-thread-sort-functions
4721       '((lambda (t1 t2) 
4722           (not (gnus-thread-sort-by-number t1 t2)))
4723         gnus-thread-sort-by-score))
4724 @end lisp
4725
4726 @vindex gnus-thread-score-function
4727 The function in the @code{gnus-thread-score-function} variable (default
4728 @code{+}) is used for calculating the total score of a thread.  Useful
4729 functions might be @code{max}, @code{min}, or squared means, or whatever
4730 tickles your fancy.
4731
4732 @findex gnus-article-sort-functions
4733 @findex gnus-article-sort-by-date
4734 @findex gnus-article-sort-by-score
4735 @findex gnus-article-sort-by-subject
4736 @findex gnus-article-sort-by-author
4737 @findex gnus-article-sort-by-number
4738 If you are using an unthreaded display for some strange reason or other,
4739 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4740 It is very similar to the @code{gnus-thread-sort-functions}, except that
4741 is uses slightly different functions for article comparison.  Available
4742 sorting predicate functions are @code{gnus-article-sort-by-number},
4743 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4744 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4745
4746 If you want to sort an unthreaded summary display by subject, you could
4747 say something like:
4748
4749 @lisp
4750 (setq gnus-article-sort-functions 
4751       '(gnus-article-sort-by-number
4752         gnus-article-sort-by-subject))
4753 @end lisp
4754
4755
4756
4757 @node Asynchronous Fetching
4758 @section Asynchronous Article Fetching
4759 @cindex asynchronous article fetching
4760 @cindex article pre-fetch
4761 @cindex pre-fetch
4762
4763 If you read your news from an @sc{nntp} server that's far away, the
4764 network latencies may make reading articles a chore.  You have to wait
4765 for a while after pressing @kbd{n} to go to the next article before the
4766 article appears.  Why can't Gnus just go ahead and fetch the article
4767 while you are reading the previous one?  Why not, indeed.
4768
4769 First, some caveats.  There are some pitfalls to using asynchronous
4770 article fetching, especially the way Gnus does it.  
4771
4772 Let's say you are reading article 1, which is short, and article 2 is
4773 quite long, and you are not interested in reading that.  Gnus does not
4774 know this, so it goes ahead and fetches article 2.  You decide to read
4775 article 3, but since Gnus is in the process of fetching article 2, the
4776 connection is blocked.
4777
4778 To avoid these situations, Gnus will open two (count 'em two)
4779 connections to the server.  Some people may think this isn't a very nice
4780 thing to do, but I don't see any real alternatives.  Setting up that
4781 extra connection takes some time, so Gnus startup will be slower.
4782
4783 Gnus will fetch more articles than you will read.  This will mean that
4784 the link between your machine and the @sc{nntp} server will become more
4785 loaded than if you didn't use article pre-fetch.  The server itself will
4786 also become more loaded---both with the extra article requests, and the
4787 extra connection.
4788
4789 Ok, so now you know that you shouldn't really use this thing...  unless
4790 you really want to.
4791
4792 @vindex gnus-asynchronous
4793 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4794 happen automatically.
4795
4796 @vindex gnus-use-article-prefetch
4797 You can control how many articles that are to be pre-fetched by setting
4798 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4799 that when you read an article in the group, the backend will pre-fetch
4800 the next 30 articles.  If this variable is @code{t}, the backend will
4801 pre-fetch all the articles that it can without bound.  If it is
4802 @code{nil}, no pre-fetching will be made.
4803
4804 @vindex gnus-async-prefetch-article-p
4805 @findex gnus-async-read-p
4806 There are probably some articles that you don't want to pre-fetch---read
4807 articles, for instance.  Which articles to pre-fetch is controlled by
4808 the @code{gnus-async-prefetch-article-p} variable.  This function should
4809 return non-@code{nil} when the article in question is to be
4810 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4811 @code{nil} on read articles.  The function is called with an article
4812 data structure as the only parameter.
4813
4814 If, for instance, you wish to pre-fetch only unread articles that are
4815 shorter than 100 lines, you could say something like:
4816
4817 @lisp
4818 (defun my-async-short-unread-p (data)
4819   "Return non-nil for short, unread articles."
4820   (and (gnus-data-unread-p data)
4821        (< (mail-header-lines (gnus-data-header data))
4822           100)))
4823
4824 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4825 @end lisp
4826
4827 These functions will be called many, many times, so they should
4828 preferrably be short and sweet to avoid slowing down Gnus too much.
4829 It's also probably a good idea to byte-compile things like this.
4830
4831 @vindex gnus-prefetched-article-deletion-strategy
4832 Articles have to be removed from the asynch buffer sooner or later.  The
4833 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4834 articles.  This is a list that may contain the following elements:
4835
4836 @table @code
4837 @item read
4838 Remove articles when they are read.
4839
4840 @item exit
4841 Remove articles when exiting the group.
4842 @end table
4843
4844 The default value is @code{(read exit)}.
4845
4846 @vindex gnus-use-header-prefetch
4847 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4848 from the next group.
4849
4850
4851 @node Article Caching
4852 @section Article Caching
4853 @cindex article caching
4854 @cindex caching
4855
4856 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4857 consider turning article caching on.  Each article will then be stored
4858 locally under your home directory.  As you may surmise, this could
4859 potentially use @emph{huge} amounts of disk space, as well as eat up all
4860 your inodes so fast it will make your head swim.  In vodka.
4861
4862 Used carefully, though, it could be just an easier way to save articles.
4863
4864 @vindex gnus-use-long-file-name
4865 @vindex gnus-cache-directory
4866 @vindex gnus-use-cache
4867 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4868 all articles that are ticked or marked as dormant will then be copied
4869 over to your local cache (@code{gnus-cache-directory}).  Whether this
4870 cache is flat or hierarchal is controlled by the
4871 @code{gnus-use-long-file-name} variable, as usual.
4872
4873 When re-select a ticked or dormant article, it will be fetched from the
4874 cache instead of from the server.  As articles in your cache will never
4875 expire, this might serve as a method of saving articles while still
4876 keeping them where they belong.  Just mark all articles you want to save
4877 as dormant, and don't worry.
4878
4879 When an article is marked as read, is it removed from the cache.
4880
4881 @vindex gnus-cache-remove-articles
4882 @vindex gnus-cache-enter-articles
4883 The entering/removal of articles from the cache is controlled by the
4884 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4885 variables.  Both are lists of symbols.  The first is @code{(ticked
4886 dormant)} by default, meaning that ticked and dormant articles will be
4887 put in the cache.  The latter is @code{(read)} by default, meaning that
4888 articles that are marked as read are removed from the cache.  Possibly
4889 symbols in these two lists are @code{ticked}, @code{dormant},
4890 @code{unread} and @code{read}.
4891
4892 @findex gnus-jog-cache
4893 So where does the massive article-fetching and storing come into the
4894 picture?  The @code{gnus-jog-cache} command will go through all
4895 subscribed newsgroups, request all unread articles, and store them in
4896 the cache.  You should only ever, ever ever ever, use this command if 1)
4897 your connection to the @sc{nntp} server is really, really, really slow
4898 and 2) you have a really, really, really huge disk.  Seriously.
4899
4900 @vindex gnus-uncacheable-groups
4901 It is likely that you do not want caching on some groups.  For instance,
4902 if your @code{nnml} mail is located under your home directory, it makes no
4903 sense to cache it somewhere else under your home directory.  Unless you
4904 feel that it's neat to use twice as much space.  To limit the caching,
4905 you could set the @code{gnus-uncacheable-groups} regexp to
4906 @samp{^nnml}, for instance.  This variable is @code{nil} by
4907 default.
4908
4909 @findex gnus-cache-generate-nov-databases
4910 @findex gnus-cache-generate-active
4911 @vindex gnus-cache-active-file
4912 The cache stores information on what articles it contains in its active
4913 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4914 of the cache) becomes all messed up for some reason or other, Gnus
4915 offers two functions that will try to set things right.  @kbd{M-x
4916 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4917 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4918 file.
4919
4920
4921 @node Persistent Articles
4922 @section Persistent Articles
4923 @cindex persistent articles
4924
4925 Closely related to article caching, we have @dfn{persistent articles}.
4926 In fact, it's just a different way of looking at caching, and much more
4927 useful in my opinion.
4928
4929 Say you're reading a newsgroup, and you happen on to some valuable gem
4930 that you want to keep and treasure forever.  You'd normally just save it
4931 (using one of the many saving commands) in some file.  The problem with
4932 that is that it's just, well, yucky.  Ideally you'd prefer just having
4933 the article remain in the group where you found it forever; untouched by
4934 the expiry going on at the news server.
4935
4936 This is what a @dfn{persistent article} is---an article that just won't
4937 be deleted.  It's implemented using the normal cache functions, but
4938 you use two explicit commands for managing persistent articles:
4939
4940 @table @kbd
4941
4942 @item *
4943 @kindex * (Summary)
4944 @findex gnus-cache-enter-article
4945 Make the current article persistent (@code{gnus-cache-enter-article}). 
4946
4947 @item M-*
4948 @kindex M-* (Summary)
4949 @findex gnus-cache-remove-article
4950 Remove the current article from the persistent articles
4951 (@code{gnus-cache-remove-article}).  This will normally delete the
4952 article. 
4953 @end table
4954
4955 Both these commands understand the process/prefix convention. 
4956
4957 To avoid having all ticked articles (and stuff) entered into the cache,
4958 you should set @code{gnus-use-cache} to @code{passive} if you're just
4959 interested in persistent articles:
4960
4961 @lisp
4962 (setq gnus-use-cache 'passive)
4963 @end lisp
4964
4965
4966 @node Article Backlog
4967 @section Article Backlog
4968 @cindex backlog
4969 @cindex article backlog
4970
4971 If you have a slow connection, but the idea of using caching seems
4972 unappealing to you (and it is, really), you can help the situation some
4973 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4974 already read articles so that it doesn't have to re-fetch articles
4975 you've already read.  This only helps if you are in the habit of
4976 re-selecting articles you've recently read, of course.  If you never do
4977 that, turning the backlog on will slow Gnus down a little bit, and
4978 increase memory usage some.
4979
4980 @vindex gnus-keep-backlog
4981 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
4982 at most @var{n} old articles in a buffer for later re-fetching.  If this
4983 variable is non-@code{nil} and is not a number, Gnus will store
4984 @emph{all} read articles, which means that your Emacs will grow without
4985 bound before exploding and taking your machine down with you.  I put
4986 that in there just to keep y'all on your toes.  
4987
4988 This variable is @code{nil} by default.
4989
4990
4991 @node Saving Articles
4992 @section Saving Articles
4993 @cindex saving articles
4994
4995 Gnus can save articles in a number of ways.  Below is the documentation
4996 for saving articles in a fairly straight-forward fashion (i.e., little
4997 processing of the article is done before it is saved).  For a different
4998 approach (uudecoding, unsharing) you should use @code{gnus-uu}
4999 (@pxref{Decoding Articles}).
5000
5001 @vindex gnus-save-all-headers
5002 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5003 unwanted headers before saving the article.
5004
5005 @vindex gnus-saved-headers
5006 If the preceding variable is @code{nil}, all headers that match the
5007 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5008 deleted before saving.
5009
5010 @table @kbd
5011
5012 @item O o
5013 @itemx o
5014 @kindex O o (Summary)
5015 @kindex o (Summary)
5016 @findex gnus-summary-save-article
5017 Save the current article using the default article saver
5018 (@code{gnus-summary-save-article}). 
5019
5020 @item O m
5021 @kindex O m (Summary)
5022 @findex gnus-summary-save-article-mail
5023 Save the current article in mail format
5024 (@code{gnus-summary-save-article-mail}). 
5025
5026 @item O r
5027 @kindex O r (Summary)
5028 @findex gnus-summary-save-article-rmail
5029 Save the current article in rmail format
5030 (@code{gnus-summary-save-article-rmail}). 
5031
5032 @item O f
5033 @kindex O f (Summary)
5034 @findex gnus-summary-save-article-file
5035 Save the current article in plain file format
5036 (@code{gnus-summary-save-article-file}). 
5037
5038 @item O F
5039 @kindex O F (Summary)
5040 @findex gnus-summary-write-article-file
5041 Write the current article in plain file format, overwriting any previous
5042 file contents (@code{gnus-summary-write-article-file}). 
5043
5044 @item O b
5045 @kindex O b (Summary)
5046 @findex gnus-summary-save-article-body-file
5047 Save the current article body in plain file format
5048 (@code{gnus-summary-save-article-body-file}). 
5049
5050 @item O h
5051 @kindex O h (Summary)
5052 @findex gnus-summary-save-article-folder
5053 Save the current article in mh folder format
5054 (@code{gnus-summary-save-article-folder}). 
5055
5056 @item O v
5057 @kindex O v (Summary)
5058 @findex gnus-summary-save-article-vm
5059 Save the current article in a VM folder
5060 (@code{gnus-summary-save-article-vm}).
5061
5062 @item O p
5063 @kindex O p (Summary)
5064 @findex gnus-summary-pipe-output
5065 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5066 the current article to a process (@code{gnus-summary-pipe-output}).
5067 @end table
5068
5069 @vindex gnus-prompt-before-saving
5070 All these commands use the process/prefix convention
5071 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5072 functions, you might get tired of being prompted for files to save each
5073 and every article in.  The prompting action is controlled by
5074 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5075 default, giving you that excessive prompting action you know and
5076 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5077 just once for each series of articles you save.  If you like to really
5078 have Gnus do all your thinking for you, you can even set this variable
5079 to @code{nil}, which means that you will never be prompted for files to
5080 save articles in.  Gnus will simply save all the articles in the default
5081 files. 
5082
5083
5084 @vindex gnus-default-article-saver
5085 You can customize the @code{gnus-default-article-saver} variable to make
5086 Gnus do what you want it to.  You can use any of the four ready-made
5087 functions below, or you can create your own.
5088
5089 @table @code
5090
5091 @item gnus-summary-save-in-rmail
5092 @findex gnus-summary-save-in-rmail
5093 @vindex gnus-rmail-save-name
5094 @findex gnus-plain-save-name
5095 This is the default format, @dfn{babyl}.  Uses the function in the
5096 @code{gnus-rmail-save-name} variable to get a file name to save the
5097 article in.  The default is @code{gnus-plain-save-name}.
5098
5099 @item gnus-summary-save-in-mail
5100 @findex gnus-summary-save-in-mail
5101 @vindex gnus-mail-save-name
5102 Save in a Unix mail (mbox) file.  Uses the function in the
5103 @code{gnus-mail-save-name} variable to get a file name to save the
5104 article in.  The default is @code{gnus-plain-save-name}.
5105
5106 @item gnus-summary-save-in-file
5107 @findex gnus-summary-save-in-file
5108 @vindex gnus-file-save-name
5109 @findex gnus-numeric-save-name
5110 Append the article straight to an ordinary file.  Uses the function in
5111 the @code{gnus-file-save-name} variable to get a file name to save the
5112 article in.  The default is @code{gnus-numeric-save-name}.
5113
5114 @item gnus-summary-save-body-in-file
5115 @findex gnus-summary-save-body-in-file
5116 Append the article body to an ordinary file.  Uses the function in the
5117 @code{gnus-file-save-name} variable to get a file name to save the
5118 article in.  The default is @code{gnus-numeric-save-name}.
5119
5120 @item gnus-summary-save-in-folder
5121 @findex gnus-summary-save-in-folder
5122 @findex gnus-folder-save-name
5123 @findex gnus-Folder-save-name
5124 @vindex gnus-folder-save-name
5125 @cindex rcvstore
5126 @cindex MH folders
5127 Save the article to an MH folder using @code{rcvstore} from the MH
5128 library.  Uses the function in the @code{gnus-folder-save-name} variable
5129 to get a file name to save the article in.  The default is
5130 @code{gnus-folder-save-name}, but you can also use
5131 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5132 the latter does not.
5133
5134 @item gnus-summary-save-in-vm
5135 @findex gnus-summary-save-in-vm
5136 Save the article in a VM folder.  You have to have the VM mail
5137 reader to use this setting.
5138 @end table
5139
5140 @vindex gnus-article-save-directory
5141 All of these functions, except for the last one, will save the article
5142 in the @code{gnus-article-save-directory}, which is initialized from the
5143 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5144 default. 
5145
5146 As you can see above, the functions use different functions to find a
5147 suitable name of a file to save the article in.  Below is a list of
5148 available functions that generate names:
5149
5150 @table @code
5151
5152 @item gnus-Numeric-save-name
5153 @findex gnus-Numeric-save-name
5154 File names like @file{~/News/Alt.andrea-dworkin/45}.
5155
5156 @item gnus-numeric-save-name
5157 @findex gnus-numeric-save-name
5158 File names like @file{~/News/alt.andrea-dworkin/45}.
5159
5160 @item gnus-Plain-save-name
5161 @findex gnus-Plain-save-name
5162 File names like @file{~/News/Alt.andrea-dworkin}.
5163
5164 @item gnus-plain-save-name
5165 @findex gnus-plain-save-name
5166 File names like @file{~/News/alt.andrea-dworkin}.
5167 @end table
5168
5169 @vindex gnus-split-methods
5170 You can have Gnus suggest where to save articles by plonking a regexp into
5171 the @code{gnus-split-methods} alist.  For instance, if you would like to
5172 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5173 related to VM in @code{vm-stuff}, you could set this variable to something
5174 like:
5175
5176 @lisp
5177 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5178  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5179  (my-choosing-function "../other-dir/my-stuff")
5180  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5181 @end lisp
5182
5183 We see that this is a list where each element is a list that has two
5184 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5185 a string (in which case it is used as a regexp to match on the article
5186 head); it can be a symbol (which will be called as a function with the
5187 group name as a parameter); or it can be a list (which will be
5188 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5189 the @dfn{file} will be used as a default prompt.  In addition, the
5190 result of the operation itself will be used if the function or form
5191 called returns a string or a list of strings.
5192
5193 You basically end up with a list of file names that might be used when
5194 saving the current article.  (All ``matches'' will be used.)  You will
5195 then be prompted for what you really want to use as a name, with file
5196 name completion over the results from applying this variable.
5197
5198 This variable is @code{((gnus-article-archive-name))} by default, which
5199 means that Gnus will look at the articles it saves for an
5200 @code{Archive-name} line and use that as a suggestion for the file
5201 name. 
5202
5203 @vindex gnus-use-long-file-name
5204 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5205 @code{nil}, all the preceding functions will replace all periods
5206 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5207 the functions will generate hierarchies of directories instead of having
5208 all the files in the toplevel directory
5209 (@file{~/News/alt/andrea-dworkin} instead of
5210 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5211 on most systems.  However, for historical reasons, this is @code{nil} on
5212 Xenix and usg-unix-v machines by default.
5213
5214 This function also affects kill and score file names.  If this variable
5215 is a list, and the list contains the element @code{not-score}, long file
5216 names will not be used for score files, if it contains the element
5217 @code{not-save}, long file names will not be used for saving, and if it
5218 contains the element @code{not-kill}, long file names will not be used
5219 for kill files.
5220
5221 If you'd like to save articles in a hierarchy that looks something like
5222 a spool, you could
5223
5224 @lisp
5225 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5226 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5227 @end lisp
5228
5229 Then just save with @kbd{o}.  You'd then read this hierarchy with
5230 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5231 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5232 around to the groups/directories with @code{nneething}.
5233
5234
5235 @node Decoding Articles
5236 @section Decoding Articles
5237 @cindex decoding articles
5238
5239 Sometime users post articles (or series of articles) that have been
5240 encoded in some way or other.  Gnus can decode them for you.
5241
5242 @menu 
5243 * Uuencoded Articles::    Uudecode articles.
5244 * Shared Articles::       Unshar articles.
5245 * PostScript Files::      Split PostScript.
5246 * Decoding Variables::    Variables for a happy decoding.
5247 * Viewing Files::         You want to look at the result of the decoding?
5248 @end menu
5249
5250 All these functions use the process/prefix convention
5251 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5252 the extension that a ``single article'' means ``a single series''.  Gnus
5253 can find out by itself what articles belong to a series, decode all the
5254 articles and unpack/view/save the resulting file(s).
5255
5256 Gnus guesses what articles are in the series according to the following
5257 simplish rule: The subjects must be (nearly) identical, except for the
5258 last two numbers of the line.  (Spaces are largely ignored, however.)
5259
5260 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5261 will find all the articles that match the regexp @samp{^cat.gif
5262 ([0-9]+/[0-9]+).*$}.  
5263
5264 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5265 series}, will not be properly recognized by any of the automatic viewing
5266 commands, and you have to mark the articles manually with @kbd{#}.
5267
5268
5269 @node Uuencoded Articles
5270 @subsection Uuencoded Articles
5271 @cindex uudecode
5272 @cindex uuencoded articles
5273
5274 @table @kbd
5275
5276 @item X u
5277 @kindex X u (Summary)
5278 @findex gnus-uu-decode-uu
5279 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5280
5281 @item X U
5282 @kindex X U (Summary)
5283 @findex gnus-uu-decode-uu-and-save
5284 Uudecodes and saves the current series
5285 (@code{gnus-uu-decode-uu-and-save}).
5286
5287 @item X v u
5288 @kindex X v u (Summary)
5289 @findex gnus-uu-decode-uu-view
5290 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5291
5292 @item X v U
5293 @kindex X v U (Summary)
5294 @findex gnus-uu-decode-uu-and-save-view
5295 Uudecodes, views and saves the current series
5296 (@code{gnus-uu-decode-uu-and-save-view}). 
5297 @end table
5298
5299 Remember that these all react to the presence of articles marked with
5300 the process mark.  If, for instance, you'd like to decode and save an
5301 entire newsgroup, you'd typically do @kbd{M P a}
5302 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5303 (@code{gnus-uu-decode-uu-and-save}).
5304
5305 All this is very much different from how @code{gnus-uu} worked with
5306 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5307 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5308 articles in some way (@pxref{Setting Process Marks}) and then press
5309 @kbd{X u}.
5310
5311 @vindex gnus-uu-notify-files
5312 Note: When trying to decode articles that have names matching
5313 @code{gnus-uu-notify-files}, which is hard-coded to
5314 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5315 automatically post an article on @samp{comp.unix.wizards} saying that
5316 you have just viewed the file in question.  This feature can't be turned
5317 off.
5318
5319
5320 @node Shared Articles
5321 @subsection Shared Articles
5322 @cindex unshar
5323 @cindex shared articles
5324
5325 @table @kbd
5326
5327 @item X s
5328 @kindex X s (Summary)
5329 @findex gnus-uu-decode-unshar
5330 Unshars the current series (@code{gnus-uu-decode-unshar}).
5331
5332 @item X S
5333 @kindex X S (Summary)
5334 @findex gnus-uu-decode-unshar-and-save
5335 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5336
5337 @item X v s
5338 @kindex X v s (Summary)
5339 @findex gnus-uu-decode-unshar-view
5340 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5341
5342 @item X v S
5343 @kindex X v S (Summary)
5344 @findex gnus-uu-decode-unshar-and-save-view
5345 Unshars, views and saves the current series
5346 (@code{gnus-uu-decode-unshar-and-save-view}). 
5347 @end table
5348
5349
5350 @node PostScript Files
5351 @subsection PostScript Files
5352 @cindex PostScript
5353
5354 @table @kbd
5355
5356 @item X p
5357 @kindex X p (Summary)
5358 @findex gnus-uu-decode-postscript
5359 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5360
5361 @item X P
5362 @kindex X P (Summary)
5363 @findex gnus-uu-decode-postscript-and-save
5364 Unpack and save the current PostScript series
5365 (@code{gnus-uu-decode-postscript-and-save}).
5366
5367 @item X v p
5368 @kindex X v p (Summary)
5369 @findex gnus-uu-decode-postscript-view
5370 View the current PostScript series
5371 (@code{gnus-uu-decode-postscript-view}).
5372
5373 @item X v P
5374 @kindex X v P (Summary)
5375 @findex gnus-uu-decode-postscript-and-save-view
5376 View and save the current PostScript series
5377 (@code{gnus-uu-decode-postscript-and-save-view}). 
5378 @end table
5379
5380
5381 @node Decoding Variables
5382 @subsection Decoding Variables
5383
5384 Adjective, not verb.
5385
5386 @menu 
5387 * Rule Variables::          Variables that say how a file is to be viewed.
5388 * Other Decode Variables::  Other decode variables.
5389 * Uuencoding and Posting::  Variables for customizing uuencoding.
5390 @end menu
5391
5392
5393 @node Rule Variables
5394 @subsubsection Rule Variables
5395 @cindex rule variables
5396
5397 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5398 variables are on the form
5399   
5400 @lisp
5401       (list '(regexp1 command2)
5402             '(regexp2 command2)
5403             ...)
5404 @end lisp
5405
5406 @table @code
5407
5408 @item gnus-uu-user-view-rules
5409 @vindex gnus-uu-user-view-rules
5410 @cindex sox
5411 This variable is consulted first when viewing files.  If you wish to use,
5412 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5413 say something like:
5414 @lisp
5415 (setq gnus-uu-user-view-rules
5416       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5417 @end lisp
5418
5419 @item gnus-uu-user-view-rules-end
5420 @vindex gnus-uu-user-view-rules-end
5421 This variable is consulted if Gnus couldn't make any matches from the
5422 user and default view rules.
5423
5424 @item gnus-uu-user-archive-rules
5425 @vindex gnus-uu-user-archive-rules
5426 This variable can be used to say what commands should be used to unpack
5427 archives.
5428 @end table
5429
5430
5431 @node Other Decode Variables
5432 @subsubsection Other Decode Variables
5433
5434 @table @code
5435 @vindex gnus-uu-grabbed-file-functions
5436
5437 @item gnus-uu-grabbed-file-functions
5438 All functions in this list will be called right each file has been
5439 successfully decoded---so that you can move or view files right away,
5440 and don't have to wait for all files to be decoded before you can do
5441 anything.  Ready-made functions you can put in this list are:
5442
5443 @table @code
5444
5445 @item gnus-uu-grab-view
5446 @findex gnus-uu-grab-view
5447 View the file.
5448
5449 @item gnus-uu-grab-move
5450 @findex gnus-uu-grab-move
5451 Move the file (if you're using a saving function.)
5452 @end table
5453
5454 @item gnus-uu-be-dangerous
5455 @vindex gnus-uu-be-dangerous
5456 Specifies what to do if unusual situations arise during decoding.  If
5457 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5458 that didn't work, and overwrite existing files.  Otherwise, ask each
5459 time.
5460
5461 @item gnus-uu-ignore-files-by-name
5462 @vindex gnus-uu-ignore-files-by-name
5463 Files with name matching this regular expression won't be viewed.
5464
5465 @item gnus-uu-ignore-files-by-type
5466 @vindex gnus-uu-ignore-files-by-type
5467 Files with a @sc{mime} type matching this variable won't be viewed.
5468 Note that Gnus tries to guess what type the file is based on the name.
5469 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5470 kludgey.
5471
5472 @item gnus-uu-tmp-dir
5473 @vindex gnus-uu-tmp-dir
5474 Where @code{gnus-uu} does its work.
5475
5476 @item gnus-uu-do-not-unpack-archives
5477 @vindex gnus-uu-do-not-unpack-archives
5478 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5479 looking for files to display.
5480
5481 @item gnus-uu-view-and-save
5482 @vindex gnus-uu-view-and-save
5483 Non-@code{nil} means that the user will always be asked to save a file
5484 after viewing it.
5485
5486 @item gnus-uu-ignore-default-view-rules
5487 @vindex gnus-uu-ignore-default-view-rules
5488 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5489 rules.
5490
5491 @item gnus-uu-ignore-default-archive-rules
5492 @vindex gnus-uu-ignore-default-archive-rules
5493 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5494 unpacking commands.
5495
5496 @item gnus-uu-kill-carriage-return
5497 @vindex gnus-uu-kill-carriage-return
5498 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5499 from articles.
5500
5501 @item gnus-uu-unmark-articles-not-decoded
5502 @vindex gnus-uu-unmark-articles-not-decoded
5503 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5504 unsuccessfully decoded as unread.
5505
5506 @item gnus-uu-correct-stripped-uucode
5507 @vindex gnus-uu-correct-stripped-uucode
5508 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5509 uuencoded files that have had trailing spaces deleted.
5510
5511 @item gnus-uu-view-with-metamail
5512 @vindex gnus-uu-view-with-metamail
5513 @cindex metamail
5514 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5515 commands defined by the rule variables and just fudge a @sc{mime}
5516 content type based on the file name.  The result will be fed to
5517 @code{metamail} for viewing.
5518
5519 @item gnus-uu-save-in-digest
5520 @vindex gnus-uu-save-in-digest
5521 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5522 decoding, will save in digests.  If this variable is @code{nil},
5523 @code{gnus-uu} will just save everything in a file without any
5524 embellishments.  The digesting almost conforms to RFC1153---no easy way
5525 to specify any meaningful volume and issue numbers were found, so I
5526 simply dropped them.
5527
5528 @end table
5529
5530
5531 @node Uuencoding and Posting
5532 @subsubsection Uuencoding and Posting
5533
5534 @table @code
5535
5536 @item gnus-uu-post-include-before-composing
5537 @vindex gnus-uu-post-include-before-composing
5538 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5539 before you compose the article.  If this variable is @code{t}, you can
5540 either include an encoded file with @kbd{C-c C-i} or have one included
5541 for you when you post the article.
5542
5543 @item gnus-uu-post-length
5544 @vindex gnus-uu-post-length
5545 Maximum length of an article.  The encoded file will be split into how
5546 many articles it takes to post the entire file.
5547
5548 @item gnus-uu-post-threaded
5549 @vindex gnus-uu-post-threaded
5550 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5551 thread.  This may not be smart, as no other decoder I have seen are able
5552 to follow threads when collecting uuencoded articles.  (Well, I have
5553 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5554 think that counts...) Default is @code{nil}.
5555
5556 @item gnus-uu-post-separate-description
5557 @vindex gnus-uu-post-separate-description
5558 Non-@code{nil} means that the description will be posted in a separate
5559 article.  The first article will typically be numbered (0/x).  If this
5560 variable is @code{nil}, the description the user enters will be included
5561 at the beginning of the first article, which will be numbered (1/x).
5562 Default is @code{t}.
5563
5564 @end table
5565
5566
5567 @node Viewing Files
5568 @subsection Viewing Files
5569 @cindex viewing files
5570 @cindex pseudo-articles
5571
5572 After decoding, if the file is some sort of archive, Gnus will attempt
5573 to unpack the archive and see if any of the files in the archive can be
5574 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5575 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5576 uncompress and de-tar the main file, and then view the two pictures.
5577 This unpacking process is recursive, so if the archive contains archives
5578 of archives, it'll all be unpacked.
5579
5580 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5581 extracted file into the summary buffer.  If you go to these
5582 ``articles'', you will be prompted for a command to run (usually Gnus
5583 will make a suggestion), and then the command will be run.
5584
5585 @vindex gnus-view-pseudo-asynchronously
5586 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5587 until the viewing is done before proceeding.
5588
5589 @vindex gnus-view-pseudos
5590 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5591 the pseudo-articles into the summary buffer, but view them
5592 immediately.  If this variable is @code{not-confirm}, the user won't even
5593 be asked for a confirmation before viewing is done.
5594
5595 @vindex gnus-view-pseudos-separately 
5596 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5597 pseudo-article will be created for each file to be viewed.  If
5598 @code{nil}, all files that use the same viewing command will be given as
5599 a list of parameters to that command.
5600
5601 @vindex gnus-insert-pseudo-articles
5602 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5603 pseudo-articles when decoding.  It is @code{t} by default.
5604
5605 So; there you are, reading your @emph{pseudo-articles} in your
5606 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5607 Why isn't anything real anymore? How did we get here?
5608
5609
5610 @node Article Treatment
5611 @section Article Treatment
5612
5613 Reading through this huge manual, you may have quite forgotten that the
5614 object of newsreaders are to actually, like, read what people have
5615 written.  Reading articles.  Unfortunately, people are quite bad at
5616 writing, so there are tons of functions and variables to make reading
5617 these articles easier.
5618
5619 @menu
5620 * Article Highlighting::    You want to make the article look like fruit salad.
5621 * Article Fontisizing::     Making emphasized text look niced.
5622 * Article Hiding::          You also want to make certain info go away.
5623 * Article Washing::         Lots of way-neat functions to make life better.
5624 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5625 * Article Date::            Grumble, UT!
5626 * Article Signature::       What is a signature?
5627 @end menu
5628
5629
5630 @node Article Highlighting
5631 @subsection Article Highlighting
5632 @cindex highlight
5633
5634 Not only do you want your article buffer to look like fruit salad, but
5635 you want it to look like technicolor fruit salad.
5636
5637 @table @kbd
5638
5639 @item W H a
5640 @kindex W H a (Summary)
5641 @findex gnus-article-highlight
5642 Highlight the current article (@code{gnus-article-highlight}).
5643
5644 @item W H h
5645 @kindex W H h (Summary)
5646 @findex gnus-article-highlight-headers
5647 @vindex gnus-header-face-alist
5648 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5649 highlighting will be done according to the @code{gnus-header-face-alist}
5650 variable, which is a list where each element has the form @var{(regexp
5651 name content)}.  @var{regexp} is a regular expression for matching the
5652 header, @var{name} is the face used for highlighting the header name and
5653 @var{content} is the face for highlighting the header value.  The first
5654 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5655 prepended---Gnus will add one.
5656
5657 @item W H c
5658 @kindex W H c (Summary)
5659 @findex gnus-article-highlight-citation
5660 Highlight cited text (@code{gnus-article-highlight-citation}). 
5661
5662 Some variables to customize the citation highlights:
5663
5664 @table @code
5665 @vindex gnus-cite-parse-max-size
5666
5667 @item gnus-cite-parse-max-size
5668 If the article size if bigger than this variable (which is 25000 by
5669 default), no citation highlighting will be performed.  
5670
5671 @item gnus-cite-prefix-regexp
5672 @vindex gnus-cite-prefix-regexp
5673 Regexp matching the longest possible citation prefix on a line. 
5674
5675 @item gnus-cite-max-prefix
5676 @vindex gnus-cite-max-prefix
5677 Maximum possible length for a citation prefix (default 20).
5678
5679 @item gnus-cite-face-list
5680 @vindex gnus-cite-face-list
5681 List of faces used for highlighting citations.  When there are citations
5682 from multiple articles in the same message, Gnus will try to give each
5683 citation from each article its own face.  This should make it easier to
5684 see who wrote what.
5685
5686 @item gnus-supercite-regexp
5687 @vindex gnus-supercite-regexp
5688 Regexp matching normal Supercite attribution lines.  
5689
5690 @item gnus-supercite-secondary-regexp
5691 @vindex gnus-supercite-secondary-regexp
5692 Regexp matching mangled Supercite attribution lines.
5693
5694 @item gnus-cite-minimum-match-count
5695 @vindex gnus-cite-minimum-match-count
5696 Minimum number of identical prefixes we have to see before we believe
5697 that it's a citation.
5698
5699 @item gnus-cite-attribution-prefix
5700 @vindex gnus-cite-attribution-prefix
5701 Regexp matching the beginning of an attribution line.
5702
5703 @item gnus-cite-attribution-suffix
5704 @vindex gnus-cite-attribution-suffix
5705 Regexp matching the end of an attribution line.
5706
5707 @item gnus-cite-attribution-face
5708 @vindex gnus-cite-attribution-face
5709 Face used for attribution lines.  It is merged with the face for the
5710 cited text belonging to the attribution.
5711
5712 @end table
5713
5714
5715 @item W H s
5716 @kindex W H s (Summary)
5717 @vindex gnus-signature-separator
5718 @vindex gnus-signature-face
5719 @findex gnus-article-highlight-signature
5720 Highlight the signature (@code{gnus-article-highlight-signature}).
5721 Everything after @code{gnus-signature-separator} (@pxref{Article
5722 Signature}) in an article will be considered a signature and will be
5723 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5724 default.
5725
5726 @end table
5727
5728
5729 @node Article Fontisizing
5730 @subsection Article Fontisizing
5731 @cindex emphasis
5732 @cindex article emphasis
5733
5734 @findex gnus-article-emphasize
5735 @kindex W e (Summary)
5736 People commonly add emphasis to words in news articles by writing things
5737 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5738 running the article through the @kbd{W e}
5739 (@code{gnus-article-emphasize}) command.
5740
5741 @vindex gnus-article-emphasis
5742 How the emphasis is computed is controlled by the
5743 @code{gnus-article-emphasis} variable.  This is an alist where the first
5744 element is a regular expression to be matched.  The second is a number
5745 that says what regular expression grouping used to find the entire
5746 emphasized word.  The third is a number that says what regexp grouping
5747 should be displayed and highlighted.  (The text between these two
5748 groupings will be hidden.)  The fourth is the face used for
5749 highlighting.
5750
5751 @lisp
5752 (setq gnus-article-emphasis
5753       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5754         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5755 @end lisp
5756
5757 @vindex gnus-emphasis-underline
5758 @vindex gnus-emphasis-bold
5759 @vindex gnus-emphasis-italic
5760 @vindex gnus-emphasis-underline-bold
5761 @vindex gnus-emphasis-underline-italic
5762 @vindex gnus-emphasis-bold-italic
5763 @vindex gnus-emphasis-underline-bold-italic
5764 By default, there are seven rules, and they use the following faces:
5765 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5766 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5767 @code{gnus-emphasis-underline-italic},
5768 @code{gnus-emphasis-undeline-bold}, and
5769 @code{gnus-emphasis-underline-bold-italic}.  
5770
5771 If you want to change these faces, you can either use @kbd{M-x
5772 customize}, or you can use @code{copy-face}.  For instance, if you want
5773 to make @code{gnus-emphasis-italic} use a red face instead, you could
5774 say something like:
5775
5776 @lisp
5777 (copy-face 'red 'gnus-emphasis-italic)
5778 @end lisp
5779
5780
5781 @node Article Hiding
5782 @subsection Article Hiding
5783 @cindex article hiding
5784
5785 Or rather, hiding certain things in each article.  There usually is much
5786 too much cruft in most articles.  
5787
5788 @table @kbd
5789
5790 @item W W a
5791 @kindex W W a (Summary)
5792 @findex gnus-article-hide
5793 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5794
5795 @item W W h
5796 @kindex W W h (Summary)
5797 @findex gnus-article-hide-headers
5798 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5799 Headers}. 
5800
5801 @item W W b
5802 @kindex W W b (Summary)
5803 @findex gnus-article-hide-boring-headers
5804 Hide headers that aren't particularly interesting
5805 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5806
5807 @item W W s
5808 @kindex W W s (Summary)
5809 @findex gnus-article-hide-signature
5810 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5811 Signature}. 
5812
5813 @item W W p
5814 @kindex W W p (Summary)
5815 @findex gnus-article-hide-pgp
5816 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5817
5818 @item W W P
5819 @kindex W W P (Summary)
5820 @findex gnus-article-hide-pem
5821 Hide @sc{pem} (privacy enhanced messages) gruft
5822 (@code{gnus-article-hide-pem}).
5823
5824 @item W W c
5825 @kindex W W c (Summary)
5826 @findex gnus-article-hide-citation
5827 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5828 customizing the hiding:
5829
5830 @table @code
5831
5832 @item gnus-cite-hide-percentage
5833 @vindex gnus-cite-hide-percentage
5834 If the cited text is of a bigger percentage than this variable (default
5835 50), hide the cited text.
5836
5837 @item gnus-cite-hide-absolute
5838 @vindex gnus-cite-hide-absolute
5839 The cited text must be have at least this length (default 10) before it
5840 is hidden.
5841
5842 @item gnus-cited-text-button-line-format
5843 @vindex gnus-cited-text-button-line-format
5844 Gnus adds buttons show where the cited text has been hidden, and to
5845 allow toggle hiding the text.  The format of the variable is specified
5846 by this format-like variable (@pxref{Formatting Variables}).  These
5847 specs are legal:
5848
5849 @table @samp
5850 @item b
5851 Start point of the hidden text.
5852 @item e
5853 End point of the hidden text.
5854 @item l
5855 Length of the hidden text.
5856 @end table
5857
5858 @item gnus-cited-lines-visible
5859 @vindex gnus-cited-lines-visible
5860 The number of lines at the beginning of the cited text to leave shown. 
5861
5862 @end table
5863
5864 @item W W C
5865 @kindex W W C (Summary)
5866 @findex gnus-article-hide-citation-in-followups
5867 Hide cited text in articles that aren't roots
5868 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5869 useful as an interactive command, but might be a handy function to stick
5870 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5871
5872 @end table
5873
5874 All these ``hiding'' commands are toggles, but if you give a negative
5875 prefix to these commands, they will show what they have previously
5876 hidden.  If you give a positive prefix, they will always hide.
5877
5878 Also @pxref{Article Highlighting} for further variables for
5879 citation customization.
5880
5881
5882 @node Article Washing
5883 @subsection Article Washing
5884 @cindex washing
5885 @cindex article washing
5886
5887 We call this ``article washing'' for a really good reason.  Namely, the
5888 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5889
5890 @dfn{Washing} is defined by us as ``changing something from something to
5891 something else'', but normally results in something looking better.
5892 Cleaner, perhaps.
5893
5894 @table @kbd
5895
5896 @item W l
5897 @kindex W l (Summary)
5898 @findex gnus-summary-stop-page-breaking
5899 Remove page breaks from the current article
5900 (@code{gnus-summary-stop-page-breaking}).
5901
5902 @item W r
5903 @kindex W r (Summary)
5904 @findex gnus-summary-caesar-message
5905 Do a Caesar rotate (rot13) on the article buffer
5906 (@code{gnus-summary-caesar-message}). 
5907
5908 @item W t
5909 @kindex W t (Summary)
5910 @findex gnus-summary-toggle-header
5911 Toggle whether to display all headers in the article buffer
5912 (@code{gnus-summary-toggle-header}). 
5913
5914 @item W v
5915 @kindex W v (Summary)
5916 @findex gnus-summary-verbose-header
5917 Toggle whether to display all headers in the article buffer permanently
5918 (@code{gnus-summary-verbose-header}).
5919
5920 @item W m
5921 @kindex W m (Summary)
5922 @findex gnus-summary-toggle-mime
5923 Toggle whether to run the article through @sc{mime} before displaying
5924 (@code{gnus-summary-toggle-mime}).
5925
5926 @item W o
5927 @kindex W o (Summary)
5928 @findex gnus-article-treat-overstrike
5929 Treat overstrike (@code{gnus-article-treat-overstrike}).
5930
5931 @item W w
5932 @kindex W w (Summary)
5933 @findex gnus-article-fill-cited-article
5934 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5935 function in @code{gnus-article-display-hook}, it should be run fairly
5936 late and certainly after any highlighting.
5937
5938 You can give the command a numerical prefix to specify the width to use
5939 when filling.
5940
5941 @item W c
5942 @kindex W c (Summary)
5943 @findex gnus-article-remove-cr
5944 Remove CR (@code{gnus-article-remove-cr}).
5945
5946 @item W q
5947 @kindex W q (Summary)
5948 @findex gnus-article-de-quoted-unreadable
5949 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5950
5951 @item W f
5952 @kindex W f (Summary)
5953 @cindex x-face
5954 @findex gnus-article-display-x-face
5955 @findex gnus-article-x-face-command
5956 @vindex gnus-article-x-face-command
5957 @vindex gnus-article-x-face-too-ugly
5958 Look for and display any X-Face headers
5959 (@code{gnus-article-display-x-face}).  The command executed by this
5960 function is given by the @code{gnus-article-x-face-command} variable.
5961 If this variable is a string, this string will be executed in a
5962 sub-shell.  If it is a function, this function will be called with the
5963 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
5964 is a regexp) matches the @code{From} header, the face will not be shown.
5965 The default action under Emacs is to fork off an @code{xv} to view the
5966 face; under XEmacs the default action is to display the face before the
5967 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
5968 support---that will make display somewhat faster.  If there's no native
5969 X-Face support, Gnus will try to convert the @code{X-Face} header using
5970 external programs from the @code{pbmplus} package and friends.)  If you
5971 want to have this function in the display hook, it should probably come
5972 last.
5973
5974 @item W b
5975 @kindex W b (Summary)
5976 @findex gnus-article-add-buttons
5977 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
5978
5979 @item W B
5980 @kindex W B (Summary)
5981 @findex gnus-article-add-buttons-to-head
5982 Add clickable buttons to the article headers
5983 (@code{gnus-article-add-buttons-to-head}).  
5984
5985 @item W E l
5986 @kindex W E l (Summary)
5987 @findex gnus-article-strip-leading-blank-lines
5988 Remove all blank lines from the beginning of the article
5989 (@code{gnus-article-strip-leading-blank-lines}).
5990
5991 @item W E m
5992 @kindex W E m (Summary)
5993 @findex gnus-article-strip-multiple-blank-lines
5994 Replace all blank lines with empty lines and then all multiple empty
5995 lines with a single empty line.
5996 (@code{gnus-article-strip-multiple-blank-lines}).
5997
5998 @item W E t
5999 @kindex W E t (Summary)
6000 @findex gnus-article-remove-trailing-blank-lines
6001 Remove all blank lines at the end of the article
6002 (@code{gnus-article-remove-trailing-blank-lines}).
6003
6004 @item W E a
6005 @kindex W E a (Summary)
6006 @findex gnus-article-strip-blank-lines
6007 Do all the three commands above
6008 (@code{gnus-article-strip-blank-lines}).
6009
6010 @end table
6011
6012
6013 @node Article Buttons
6014 @subsection Article Buttons
6015 @cindex buttons
6016
6017 People often include references to other stuff in articles, and it would
6018 be nice if Gnus could just fetch whatever it is that people talk about
6019 with the minimum of fuzz.
6020
6021 Gnus adds @dfn{buttons} to certain standard references by default:
6022 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6023 two variables, one that handles article bodies and one that handles
6024 article heads:
6025
6026 @table @code
6027
6028 @item gnus-button-alist
6029 @vindex gnus-button-alist
6030 This is an alist where each entry has this form:
6031
6032 @lisp
6033 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6034 @end lisp
6035
6036 @table @var
6037
6038 @item regexp
6039 All text that match this regular expression will be considered an
6040 external reference.  Here's a typical regexp that match embedded URLs:
6041 @samp{<URL:\\([^\n\r>]*\\)>}. 
6042
6043 @item button-par
6044 Gnus has to know which parts of the match is to be highlighted.  This is
6045 a number that says what sub-expression of the regexp that is to be
6046 highlighted.  If you want it all highlighted, you use 0 here.
6047
6048 @item use-p
6049 This form will be @code{eval}ed, and if the result is non-@code{nil},
6050 this is considered a match.  This is useful if you want extra sifting to
6051 avoid false matches.
6052
6053 @item function
6054 This function will be called when you click on this button.
6055
6056 @item data-par
6057 As with @var{button-par}, this is a sub-expression number, but this one
6058 says which part of the match is to be sent as data to @var{function}. 
6059
6060 @end table
6061
6062 So the full entry for buttonizing URLs is then
6063
6064 @lisp
6065 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6066 @end lisp
6067
6068 @item gnus-header-button-alist
6069 @vindex gnus-header-button-alist
6070 This is just like the other alist, except that it is applied to the
6071 article head only, and that each entry has an additional element that is
6072 used to say what headers to apply the buttonize coding to:
6073
6074 @lisp
6075 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6076 @end lisp
6077
6078 @var{header} is a regular expression.
6079
6080 @item gnus-button-url-regexp
6081 @vindex gnus-button-url-regexp
6082 A regular expression that matches embedded URLs.  It is used in the
6083 default values of the variables above.
6084
6085 @item gnus-article-button-face
6086 @vindex gnus-article-button-face
6087 Face used on buttons.
6088
6089 @item gnus-article-mouse-face
6090 @vindex gnus-article-mouse-face
6091 Face is used when the mouse cursor is over a button.
6092
6093 @end table
6094
6095
6096 @node Article Date
6097 @subsection Article Date
6098
6099 The date is most likely generated in some obscure timezone you've never
6100 heard of, so it's quite nice to be able to find out what the time was
6101 when the article was sent.
6102
6103 @table @kbd
6104
6105 @item W T u
6106 @kindex W T u (Summary)
6107 @findex gnus-article-date-ut
6108 Display the date in UT (aka. GMT, aka ZULU)
6109 (@code{gnus-article-date-ut}). 
6110
6111 @item W T l
6112 @kindex W T l (Summary)
6113 @findex gnus-article-date-local
6114 Display the date in the local timezone (@code{gnus-article-date-local}).
6115
6116 @item W T s
6117 @kindex W T s (Summary)
6118 @vindex gnus-article-time-format
6119 @findex gnus-article-date-user
6120 @findex format-time-string
6121 Display the date using a user-defined format
6122 (@code{gnus-article-date-user}).  The format is specified by the
6123 @code{gnus-article-time-format} variable, and is a string that's passed
6124 to @code{format-time-string}.  See the documentation of that variable
6125 for a list possible format specs.
6126
6127 @item W T e
6128 @kindex W T e (Summary)
6129 @findex gnus-article-date-lapsed
6130 Say how much time has (e)lapsed between the article was posted and now
6131 (@code{gnus-article-date-lapsed}).
6132
6133 @item W T o
6134 @kindex W T o (Summary)
6135 @findex gnus-article-date-original
6136 Display the original date (@code{gnus-article-date-original}).  This can
6137 be useful if you normally use some other conversion function and is
6138 worried that it might be doing something totally wrong.  Say, claiming
6139 that the article was posted in 1854.  Although something like that is
6140 @emph{totally} impossible.  Don't you trust me? *titter*
6141
6142 @end table
6143
6144
6145 @node Article Signature
6146 @subsection Article Signature
6147 @cindex signatures
6148 @cindex article signature
6149
6150 @vindex gnus-signature-separator
6151 Each article is divided into two parts---the head and the body.  The
6152 body can be divided into a signature part and a text part.  The variable
6153 that says what is to be considered a signature is
6154 @code{gnus-signature-separator}.  This is normally the standard
6155 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6156 non-standard signature separators, so this variable can also be a list
6157 of regular expressions to be tested, one by one.  (Searches are done
6158 from the end of the body towards the beginning.)  One likely value is:
6159
6160 @lisp
6161 (setq gnus-signature-separator
6162       '("^-- $"         ; The standard
6163         "^-- *$"        ; A common mangling
6164         "^-------*$"    ; Many people just use a looong 
6165                         ; line of dashes.  Shame!
6166         "^ *--------*$" ; Double-shame!
6167         "^________*$"   ; Underscores are also popular
6168         "^========*$")) ; Pervert!
6169 @end lisp
6170
6171 The more permissive you are, the more likely it is that you'll get false
6172 positives.
6173
6174 @vindex gnus-signature-limit
6175 @code{gnus-signature-limit} provides a limit to what is considered a
6176 signature. 
6177
6178 @enumerate
6179 @item 
6180 If it is an integer, no signature may be longer (in characters) than
6181 that integer.
6182 @item 
6183 If it is a floating point number, no signature may be longer (in lines)
6184 than that number.
6185 @item 
6186 If it is a function, the function will be called without any parameters,
6187 and if it returns @code{nil}, there is no signature in the buffer.
6188 @item
6189 If it is a string, it will be used as a regexp.  If it matches, the text
6190 in question is not a signature.
6191 @end enumerate
6192
6193 This variable can also be a list where the elements may be of the types
6194 listed above.  
6195
6196
6197 @node Article Commands
6198 @section Article Commands
6199
6200 @table @kbd
6201
6202 @item A P
6203 @cindex PostScript
6204 @cindex printing
6205 @kindex A P (Summary)
6206 @findex gnus-summary-print-article 
6207 Generate and print a PostScript image of the article buffer
6208 (@code{gnus-summary-print-article}).
6209
6210 @end table
6211
6212
6213 @node Summary Sorting
6214 @section Summary Sorting
6215 @cindex summary sorting
6216
6217 You can have the summary buffer sorted in various ways, even though I
6218 can't really see why you'd want that.
6219
6220 @table @kbd
6221
6222 @item C-c C-s C-n
6223 @kindex C-c C-s C-n (Summary)
6224 @findex gnus-summary-sort-by-number
6225 Sort by article number (@code{gnus-summary-sort-by-number}).
6226
6227 @item C-c C-s C-a
6228 @kindex C-c C-s C-a (Summary)
6229 @findex gnus-summary-sort-by-author
6230 Sort by author (@code{gnus-summary-sort-by-author}).
6231
6232 @item C-c C-s C-s
6233 @kindex C-c C-s C-s (Summary)
6234 @findex gnus-summary-sort-by-subject
6235 Sort by subject (@code{gnus-summary-sort-by-subject}).
6236
6237 @item C-c C-s C-d
6238 @kindex C-c C-s C-d (Summary)
6239 @findex gnus-summary-sort-by-date
6240 Sort by date (@code{gnus-summary-sort-by-date}).
6241
6242 @item C-c C-s C-l
6243 @kindex C-c C-s C-l (Summary)
6244 @findex gnus-summary-sort-by-lines
6245 Sort by lines (@code{gnus-summary-sort-by-lines}).
6246
6247 @item C-c C-s C-i
6248 @kindex C-c C-s C-i (Summary)
6249 @findex gnus-summary-sort-by-score
6250 Sort by score (@code{gnus-summary-sort-by-score}).
6251 @end table
6252
6253 These functions will work both when you use threading and when you don't
6254 use threading.  In the latter case, all summary lines will be sorted,
6255 line by line.  In the former case, sorting will be done on a
6256 root-by-root basis, which might not be what you were looking for.  To
6257 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6258 Commands}).
6259
6260
6261 @node Finding the Parent
6262 @section Finding the Parent
6263 @cindex parent articles
6264 @cindex referring articles
6265
6266 @findex gnus-summary-refer-parent-article
6267 @kindex ^ (Summary)
6268 If you'd like to read the parent of the current article, and it is not
6269 displayed in the summary buffer, you might still be able to.  That is,
6270 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6271 and the @code{References} in the current article are not mangled, you
6272 can just press @kbd{^} or @kbd{A r}
6273 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6274 you'll get the parent.  If the parent is already displayed in the
6275 summary buffer, point will just move to this article.
6276
6277 If given a positive numerical prefix, fetch that many articles back into
6278 the ancestry.  If given a negative numerical prefix, fetch just that
6279 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6280 grandparent and the grandgrandparent of the current article.  If you say
6281 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6282 article. 
6283
6284 @findex gnus-summary-refer-references
6285 @kindex A R (Summary)
6286 You can have Gnus fetch all articles mentioned in the @code{References}
6287 header of the article by pushing @kbd{A R}
6288 (@code{gnus-summary-refer-references}). 
6289
6290 @findex gnus-summary-refer-article
6291 @kindex M-^ (Summary)
6292 @cindex Message-ID
6293 @cindex fetching by Message-ID
6294 You can also ask the @sc{nntp} server for an arbitrary article, no
6295 matter what group it belongs to.  @kbd{M-^}
6296 (@code{gnus-summary-refer-article}) will ask you for a
6297 @code{Message-ID}, which is one of those long, hard-to-read thingies
6298 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6299 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6300
6301 @vindex gnus-refer-article-method
6302 If the group you are reading is located on a backend that does not
6303 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6304 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6305 would, perhaps, be best if the @sc{nntp} server you consult is the same
6306 as the one that keeps the spool you are reading from updated, but that's
6307 not really necessary.
6308
6309 Most of the mail backends support fetching by @code{Message-ID}, but do
6310 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6311 @code{nnbabyl} are able to locate articles from any groups, while
6312 @code{nnml} and @code{nnfolder} are only able to locate articles that
6313 have been posted to the current group.  (Anything else would be too time
6314 consuming.)  @code{nnmh} does not support this at all.
6315
6316
6317 @node Alternative Approaches
6318 @section Alternative Approaches
6319
6320 Different people like to read news using different methods.  This being
6321 Gnus, we offer a small selection of minor modes for the summary buffers.
6322
6323 @menu
6324 * Pick and Read::               First mark articles and then read them.
6325 * Binary Groups::               Auto-decode all articles.
6326 @end menu
6327
6328
6329 @node Pick and Read
6330 @subsection Pick and Read
6331 @cindex pick and read
6332
6333 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6334 reading interface.  The user first marks the articles she wants to read
6335 from a summary buffer.  Then she starts reading the articles with just
6336 an article buffer displayed.
6337
6338 @findex gnus-pick-mode
6339 @kindex M-x gnus-pick-mode
6340 Gnus provides a summary buffer minor mode that allows
6341 this---@code{gnus-pick-mode}.  This basically means that a few process
6342 mark commands become one-keystroke commands to allow easy marking, and
6343 it makes one additional command for switching to the summary buffer
6344 available. 
6345
6346 Here are the available keystrokes when using pick mode:
6347
6348 @table @kbd
6349 @item .
6350 @kindex . (Pick)
6351 @findex gnus-summary-mark-as-processable
6352 Pick the article on the current line
6353 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6354 go to the article on that line and pick that article.  (The line number
6355 is normally displayed on the beginning of the summary pick lines.)
6356
6357 @item SPACE
6358 @kindex SPACE (Pick)
6359 @findex gnus-pick-next-page
6360 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6361 at the end of the buffer, start reading the picked articles.
6362
6363 @item u
6364 @kindex u (Pick)
6365 @findex gnus-summary-unmark-as-processable
6366 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6367
6368 @item U
6369 @kindex U (Pick)
6370 @findex gnus-summary-unmark-all-processable
6371 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6372
6373 @item t
6374 @kindex t (Pick)
6375 @findex gnus-uu-mark-thread
6376 Pick the thread (@code{gnus-uu-mark-thread}). 
6377
6378 @item T
6379 @kindex T (Pick)
6380 @findex gnus-uu-unmark-thread
6381 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6382
6383 @item r
6384 @kindex r (Pick)
6385 @findex gnus-uu-mark-region
6386 Pick the region (@code{gnus-uu-mark-region}). 
6387
6388 @item R
6389 @kindex R (Pick)
6390 @findex gnus-uu-unmark-region
6391 Unpick the region (@code{gnus-uu-unmark-region}). 
6392
6393 @item e
6394 @kindex e (Pick)
6395 @findex gnus-uu-mark-by-regexp
6396 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6397
6398 @item E
6399 @kindex E (Pick)
6400 @findex gnus-uu-unmark-by-regexp
6401 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6402
6403 @item b
6404 @kindex b (Pick)
6405 @findex gnus-uu-mark-buffer
6406 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6407
6408 @item B
6409 @kindex B (Pick)
6410 @findex gnus-uu-unmark-buffer
6411 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6412
6413 @item RET
6414 @kindex RET (Pick)
6415 @findex gnus-pick-start-reading
6416 @vindex gnus-pick-display-summary
6417 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6418 given a prefix, mark all unpicked articles as read first.  If
6419 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6420 will still be visible when you are reading.
6421
6422 @end table
6423
6424 If this sounds like a good idea to you, you could say:
6425
6426 @lisp
6427 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6428 @end lisp
6429
6430 @vindex gnus-pick-mode-hook
6431 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6432
6433 @vindex gnus-mark-unpicked-articles-as-read
6434 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6435 all unpicked articles as read.  The default is @code{nil}.
6436
6437 @vindex gnus-summary-pick-line-format
6438 The summary line format in pick mode is slightly different than the
6439 standard format.  At the beginning of each line the line number is
6440 displayed.  The pick mode line format is controlled by the
6441 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6442 Variables}).  It accepts the same format specs that
6443 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6444
6445
6446 @node Binary Groups
6447 @subsection Binary Groups
6448 @cindex binary groups
6449
6450 @findex gnus-binary-mode
6451 @kindex M-x gnus-binary-mode
6452 If you spend much time in binary groups, you may grow tired of hitting
6453 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6454 is a minor mode for summary buffers that makes all ordinary Gnus article
6455 selection functions uudecode series of articles and display the result
6456 instead of just displaying the articles the normal way.  
6457
6458 @kindex g (Binary)
6459 @findex gnus-binary-show-article
6460 In fact, the only way to see the actual articles if you have turned this
6461 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6462
6463 @vindex gnus-binary-mode-hook
6464 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6465
6466
6467 @node Tree Display
6468 @section Tree Display
6469 @cindex trees
6470
6471 @vindex gnus-use-trees
6472 If you don't like the normal Gnus summary display, you might try setting
6473 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6474 additional @dfn{tree buffer}.  You can execute all summary mode commands
6475 in the tree buffer.  
6476
6477 There are a few variables to customize the tree display, of course:
6478
6479 @table @code
6480 @item gnus-tree-mode-hook
6481 @vindex gnus-tree-mode-hook
6482 A hook called in all tree mode buffers.
6483
6484 @item gnus-tree-mode-line-format
6485 @vindex gnus-tree-mode-line-format
6486 A format string for the mode bar in the tree mode buffers.  The default
6487 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6488 Buffer Mode Line}. 
6489
6490 @item gnus-selected-tree-face
6491 @vindex gnus-selected-tree-face
6492 Face used for highlighting the selected article in the tree buffer.  The
6493 default is @code{modeline}.
6494
6495 @item gnus-tree-line-format
6496 @vindex gnus-tree-line-format
6497 A format string for the tree nodes.  The name is a bit of a misnomer,
6498 though---it doesn't define a line, but just the node.  The default value
6499 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6500 the name of the poster.  It is vital that all nodes are of the same
6501 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6502
6503 Legal specs are:
6504
6505 @table @samp
6506 @item n
6507 The name of the poster.
6508 @item f
6509 The @code{From} header.
6510 @item N
6511 The number of the article.
6512 @item [
6513 The opening bracket.
6514 @item ] 
6515 The closing bracket.
6516 @item s
6517 The subject.
6518 @end table
6519
6520 @xref{Formatting Variables}.
6521
6522 Variables related to the display are:
6523
6524 @table @code
6525 @item gnus-tree-brackets
6526 @vindex gnus-tree-brackets
6527 This is used for differentiating between ``real'' articles and
6528 ``sparse'' articles.  The format is @var{((real-open . real-close)
6529 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6530 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6531
6532 @item gnus-tree-parent-child-edges
6533 @vindex gnus-tree-parent-child-edges
6534 This is a list that contains the characters used for connecting parent
6535 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6536
6537 @end table
6538
6539 @item gnus-tree-minimize-window
6540 @vindex gnus-tree-minimize-window
6541 If this variable is non-@code{nil}, Gnus will try to keep the tree
6542 buffer as small as possible to allow more room for the other Gnus
6543 windows.  If this variable is a number, the tree buffer will never be
6544 higher than that number.  The default is @code{t}.
6545
6546 @item gnus-generate-tree-function
6547 @vindex gnus-generate-tree-function
6548 @findex gnus-generate-horizontal-tree
6549 @findex gnus-generate-vertical-tree
6550 The function that actually generates the thread tree.  Two predefined
6551 functions are available: @code{gnus-generate-horizontal-tree} and
6552 @code{gnus-generate-vertical-tree} (which is the default).
6553
6554 @end table
6555
6556 Here's and example from a horizontal tree buffer:
6557
6558 @example
6559 @{***@}-(***)-[odd]-[Gun]
6560      |      \[Jan]
6561      |      \[odd]-[Eri]
6562      |      \(***)-[Eri]
6563      |            \[odd]-[Paa]
6564      \[Bjo]
6565      \[Gun]
6566      \[Gun]-[Jor]
6567 @end example
6568
6569 Here's the same thread displayed in a vertical tree buffer:
6570
6571 @example
6572 @{***@}
6573   |--------------------------\-----\-----\
6574 (***)                         [Bjo] [Gun] [Gun]
6575   |--\-----\-----\                          |
6576 [odd] [Jan] [odd] (***)                   [Jor]
6577   |           |     |--\
6578 [Gun]       [Eri] [Eri] [odd]
6579                           |
6580                         [Paa]
6581 @end example
6582
6583
6584 @node Mail Group Commands
6585 @section Mail Group Commands
6586 @cindex mail group commands
6587
6588 Some commands only make sense in mail groups.  If these commands are
6589 illegal in the current group, they will raise a hell and let you know.
6590
6591 All these commands (except the expiry and edit commands) use the
6592 process/prefix convention (@pxref{Process/Prefix}).
6593
6594 @table @kbd
6595
6596 @item B e
6597 @kindex B e (Summary)
6598 @findex gnus-summary-expire-articles
6599 Expire all expirable articles in the group
6600 (@code{gnus-summary-expire-articles}).
6601
6602 @item B M-C-e
6603 @kindex B M-C-e (Summary)
6604 @findex gnus-summary-expire-articles-now
6605 Delete all the expirable articles in the group
6606 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6607 articles that are eligible for expiry in the current group will
6608 disappear forever into that big @file{/dev/null} in the sky.
6609
6610 @item B DEL
6611 @kindex B DEL (Summary)
6612 @findex gnus-summary-delete-article
6613 Delete the mail article.  This is ``delete'' as in ``delete it from your
6614 disk forever and ever, never to return again.'' Use with caution.
6615 (@code{gnus-summary-delete-article}).
6616
6617 @item B m
6618 @kindex B m (Summary)
6619 @cindex move mail
6620 @findex gnus-summary-move-article
6621 Move the article from one mail group to another
6622 (@code{gnus-summary-move-article}). 
6623
6624 @item B c
6625 @kindex B c (Summary)
6626 @cindex copy mail
6627 @findex gnus-summary-copy-article
6628 Copy the article from one group (mail group or not) to a mail group
6629 (@code{gnus-summary-copy-article}).
6630
6631 @item B C
6632 @kindex B C (Summary)
6633 @cindex crosspost mail
6634 @findex gnus-summary-crosspost-article
6635 Crosspost the current article to some other group
6636 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6637 the article in the other group, and the Xref headers of the article will
6638 be properly updated.
6639
6640 @item B i
6641 @kindex B i (Summary)
6642 @findex gnus-summary-import-article
6643 Import an arbitrary file into the current mail newsgroup
6644 (@code{gnus-summary-import-article}).  You will be prompted for a file
6645 name, a @code{From} header and a @code{Subject} header.
6646
6647 @item B r
6648 @kindex B r (Summary)
6649 @findex gnus-summary-respool-article
6650 Respool the mail article (@code{gnus-summary-move-article}).
6651 @code{gnus-summary-respool-default-method} will be used as the default
6652 select method when respooling.  This variable is @code{nil} by default,
6653 which means that the current group select method will be used instead.
6654
6655 @item B w
6656 @itemx e
6657 @kindex B w (Summary)
6658 @kindex e (Summary)
6659 @findex gnus-summary-edit-article
6660 @kindex C-c C-c (Article)
6661 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6662 editing and make the changes permanent, type @kbd{C-c C-c}
6663 (@kbd{gnus-summary-edit-article-done}).
6664
6665 @item B q
6666 @kindex B q (Summary)
6667 @findex gnus-summary-respool-query
6668 If you want to re-spool an article, you might be curious as to what group
6669 the article will end up in before you do the re-spooling.  This command
6670 will tell you (@code{gnus-summary-respool-query}). 
6671
6672 @item B p
6673 @kindex B p (Summary)
6674 @findex gnus-summary-article-posted-p
6675 Some people have a tendency to send you "courtesy" copies when they
6676 follow up to articles you have posted.  These usually have a
6677 @code{Newsgroups} header in them, but not always.  This command
6678 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6679 article from your news server (or rather, from
6680 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6681 report back whether it found the article or not.  Even if it says that
6682 it didn't find the article, it may have been posted anyway---mail
6683 propagation is much faster than news propagation, and the news copy may
6684 just not have arrived yet.
6685
6686 @end table
6687
6688 @vindex gnus-move-split-methods
6689 @cindex moving articles
6690 If you move (or copy) articles regularly, you might wish to have Gnus
6691 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6692 variable that uses the same syntax as @code{gnus-split-methods}
6693 (@pxref{Saving Articles}).  You may customize that variable to create
6694 suggestions you find reasonable.
6695
6696 @lisp
6697 (setq gnus-move-split-methods
6698       '(("^From:.*Lars Magne" "nnml:junk")
6699         ("^Subject:.*gnus" "nnfolder:important")
6700         (".*" "nnml:misc")))
6701 @end lisp
6702
6703
6704 @node Various Summary Stuff
6705 @section Various Summary Stuff
6706
6707 @menu
6708 * Summary Group Information::         Information oriented commands.
6709 * Searching for Articles::            Multiple article commands.
6710 * Summary Generation Commands::       (Re)generating the summary buffer.
6711 * Really Various Summary Commands::   Those pesky non-conformant commands.
6712 @end menu
6713
6714 @table @code
6715 @vindex gnus-summary-mode-hook
6716 @item gnus-summary-mode-hook
6717 This hook is called when creating a summary mode buffer.
6718
6719 @vindex gnus-summary-generate-hook
6720 @item gnus-summary-generate-hook
6721 This is called as the last thing before doing the threading and the
6722 generation of the summary buffer.  It's quite convenient for customizing
6723 the threading variables based on what data the newsgroup has.  This hook
6724 is called from the summary buffer after most summary buffer variables
6725 has been set.
6726
6727 @vindex gnus-summary-prepare-hook
6728 @item gnus-summary-prepare-hook
6729 Is is called after the summary buffer has been generated.  You might use
6730 it to, for instance, highlight lines or modify the look of the buffer in
6731 some other ungodly manner.  I don't care.
6732
6733 @end table
6734
6735
6736 @node Summary Group Information
6737 @subsection Summary Group Information
6738
6739 @table @kbd
6740
6741 @item H f
6742 @kindex H f (Summary)
6743 @findex gnus-summary-fetch-faq
6744 @vindex gnus-group-faq-directory
6745 Try to fetch the FAQ (list of frequently asked questions) for the
6746 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6747 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6748 on a remote machine.  This variable can also be a list of directories.
6749 In that case, giving a prefix to this command will allow you to choose
6750 between the various sites.  @code{ange-ftp} probably will be used for
6751 fetching the file.
6752
6753 @item H d
6754 @kindex H d (Summary)
6755 @findex gnus-summary-describe-group
6756 Give a brief description of the current group
6757 (@code{gnus-summary-describe-group}).  If given a prefix, force
6758 rereading the description from the server.
6759
6760 @item H h
6761 @kindex H h (Summary)
6762 @findex gnus-summary-describe-briefly
6763 Give an extremely brief description of the most important summary
6764 keystrokes (@code{gnus-summary-describe-briefly}).
6765
6766 @item H i
6767 @kindex H i (Summary)
6768 @findex gnus-info-find-node
6769 Go to the Gnus info node (@code{gnus-info-find-node}).
6770 @end table
6771
6772
6773 @node Searching for Articles
6774 @subsection Searching for Articles
6775
6776 @table @kbd
6777
6778 @item M-s
6779 @kindex M-s (Summary)
6780 @findex gnus-summary-search-article-forward
6781 Search through all subsequent articles for a regexp
6782 (@code{gnus-summary-search-article-forward}). 
6783
6784 @item M-r
6785 @kindex M-r (Summary)
6786 @findex gnus-summary-search-article-backward
6787 Search through all previous articles for a regexp
6788 (@code{gnus-summary-search-article-backward}). 
6789
6790 @item &
6791 @kindex & (Summary)
6792 @findex gnus-summary-execute-command
6793 This command will prompt you for a header field, a regular expression to
6794 match on this field, and a command to be executed if the match is made
6795 (@code{gnus-summary-execute-command}).
6796
6797 @item M-&
6798 @kindex M-& (Summary)
6799 @findex gnus-summary-universal-argument
6800 Perform any operation on all articles that have been marked with
6801 the process mark (@code{gnus-summary-universal-argument}).
6802 @end table
6803
6804 @node Summary Generation Commands
6805 @subsection Summary Generation Commands
6806
6807 @table @kbd
6808
6809 @item Y g
6810 @kindex Y g (Summary)
6811 @findex gnus-summary-prepare
6812 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6813
6814 @item Y c 
6815 @kindex Y c (Summary)
6816 @findex gnus-summary-insert-cached-articles
6817 Pull all cached articles (for the current group) into the summary buffer
6818 (@code{gnus-summary-insert-cached-articles}).
6819
6820 @end table
6821
6822
6823 @node Really Various Summary Commands
6824 @subsection Really Various Summary Commands
6825
6826 @table @kbd
6827
6828 @item C-d
6829 @kindex C-d (Summary)
6830 @findex gnus-summary-enter-digest-group
6831 If the current article is a collection of other articles (for instance,
6832 a digest), you might use this command to enter a group based on the that
6833 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6834 guess what article type is currently displayed unless you give a prefix
6835 to this command, which forces a ``digest'' interpretation.  Basically,
6836 whenever you see a message that is a collection of other messages on
6837 some format, you @kbd{C-d} and read these messages in a more convenient
6838 fashion.
6839
6840 @item M-C-d
6841 @kindex M-C-d (Summary)
6842 @findex gnus-summary-read-document
6843 This command is very similar to the one above, but lets you gather
6844 several documents into one biiig group
6845 (@code{gnus-summary-read-document}).  It does this by opening several
6846 @code{nndoc} groups for each document, and then opening an
6847 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6848 command understands the process/prefix convention
6849 (@pxref{Process/Prefix}). 
6850
6851 @item C-t
6852 @kindex C-t (Summary)
6853 @findex gnus-summary-toggle-truncation
6854 Toggle truncation of summary lines
6855 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6856 line centering function in the summary buffer, so it's not a good idea
6857 to have truncation switched off while reading articles.
6858
6859 @item =
6860 @kindex = (Summary)
6861 @findex gnus-summary-expand-window
6862 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6863 If given a prefix, force an @code{article} window configuration. 
6864
6865 @end table
6866
6867
6868 @node Exiting the Summary Buffer
6869 @section Exiting the Summary Buffer
6870 @cindex summary exit
6871 @cindex exiting groups
6872
6873 Exiting from the summary buffer will normally update all info on the
6874 group and return you to the group buffer. 
6875
6876 @table @kbd
6877
6878 @item Z Z
6879 @itemx q
6880 @kindex Z Z (Summary)
6881 @kindex q (Summary)
6882 @findex gnus-summary-exit
6883 @vindex gnus-summary-exit-hook
6884 @vindex gnus-summary-prepare-exit-hook
6885 Exit the current group and update all information on the group
6886 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6887 called before doing much of the exiting, and calls
6888 @code{gnus-summary-expire-articles} by default.
6889 @code{gnus-summary-exit-hook} is called after finishing the exiting
6890 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
6891 group mode having no more (unread) groups.
6892
6893 @item Z E
6894 @itemx Q
6895 @kindex Z E (Summary)
6896 @kindex Q (Summary)
6897 @findex gnus-summary-exit-no-update
6898 Exit the current group without updating any information on the group
6899 (@code{gnus-summary-exit-no-update}).
6900
6901 @item Z c
6902 @itemx c
6903 @kindex Z c (Summary)
6904 @kindex c (Summary)
6905 @findex gnus-summary-catchup-and-exit
6906 Mark all unticked articles in the group as read and then exit
6907 (@code{gnus-summary-catchup-and-exit}).
6908
6909 @item Z C
6910 @kindex Z C (Summary)
6911 @findex gnus-summary-catchup-all-and-exit
6912 Mark all articles, even the ticked ones, as read and then exit
6913 (@code{gnus-summary-catchup-all-and-exit}).
6914
6915 @item Z n
6916 @kindex Z n (Summary)
6917 @findex gnus-summary-catchup-and-goto-next-group
6918 Mark all articles as read and go to the next group
6919 (@code{gnus-summary-catchup-and-goto-next-group}). 
6920
6921 @item Z R
6922 @kindex Z R (Summary)
6923 @findex gnus-summary-reselect-current-group
6924 Exit this group, and then enter it again
6925 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
6926 all articles, both read and unread.
6927
6928 @item Z G
6929 @itemx M-g
6930 @kindex Z G (Summary)
6931 @kindex M-g (Summary)
6932 @findex gnus-summary-rescan-group
6933 Exit the group, check for new articles in the group, and select the
6934 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
6935 articles, both read and unread.
6936
6937 @item Z N
6938 @kindex Z N (Summary)
6939 @findex gnus-summary-next-group
6940 Exit the group and go to the next group
6941 (@code{gnus-summary-next-group}). 
6942
6943 @item Z P
6944 @kindex Z P (Summary)
6945 @findex gnus-summary-prev-group
6946 Exit the group and go to the previous group
6947 (@code{gnus-summary-prev-group}). 
6948
6949 @item Z s
6950 @kindex Z s (Summary)
6951 @findex gnus-summary-save-newsrc
6952 Save the current number of read/marked articles in the dribble buffer
6953 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
6954 given a prefix, also save the @file{.newsrc} file(s).  Using this
6955 command will make exit without updating (the @kbd{Q} command) worthless.
6956 @end table
6957
6958 @vindex gnus-exit-group-hook
6959 @code{gnus-exit-group-hook} is called when you exit the current
6960 group.  
6961
6962 @findex gnus-summary-wake-up-the-dead
6963 @findex gnus-dead-summary-mode
6964 @vindex gnus-kill-summary-on-exit
6965 If you're in the habit of exiting groups, and then changing your mind
6966 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6967 If you do that, Gnus won't kill the summary buffer when you exit it.
6968 (Quelle surprise!)  Instead it will change the name of the buffer to
6969 something like @samp{*Dead Summary ... *} and install a minor mode
6970 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
6971 buffer, you'll find that all keys are mapped to a function called
6972 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
6973 summary buffer will result in a live, normal summary buffer.  
6974
6975 There will never be more than one dead summary buffer at any one time. 
6976
6977 @vindex gnus-use-cross-reference
6978 The data on the current group will be updated (which articles you have
6979 read, which articles you have replied to, etc.) when you exit the
6980 summary buffer.  If the @code{gnus-use-cross-reference} variable is
6981 @code{t} (which is the default), articles that are cross-referenced to
6982 this group and are marked as read, will also be marked as read in the
6983 other subscribed groups they were cross-posted to.  If this variable is
6984 neither @code{nil} nor @code{t}, the article will be marked as read in
6985 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
6986
6987
6988 @node Crosspost Handling
6989 @section Crosspost Handling
6990
6991 @cindex velveeta
6992 @cindex spamming
6993 Marking cross-posted articles as read ensures that you'll never have to
6994 read the same article more than once.  Unless, of course, somebody has
6995 posted it to several groups separately.  Posting the same article to
6996 several groups (not cross-posting) is called @dfn{spamming}, and you are
6997 by law required to send nasty-grams to anyone who perpetrates such a
6998 heinous crime.  You may want to try NoCeM handling to filter out spam
6999 (@pxref{NoCeM}). 
7000
7001 Remember: Cross-posting is kinda ok, but posting the same article
7002 separately to several groups is not.  Massive cross-posting (aka.
7003 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7004 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7005 excessive crossposting (@pxref{Summary Mail Commands}).
7006
7007 @cindex cross-posting
7008 @cindex Xref
7009 @cindex @sc{nov}
7010 One thing that may cause Gnus to not do the cross-posting thing
7011 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7012 (which is very nice, because it speeds things up considerably) which
7013 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7014 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7015 even with @sc{xover} by registering the @code{Xref} lines of all
7016 articles you actually read, but if you kill the articles, or just mark
7017 them as read without reading them, Gnus will not get a chance to snoop
7018 the @code{Xref} lines out of these articles, and will be unable to use
7019 the cross reference mechanism.
7020
7021 @cindex LIST overview.fmt
7022 @cindex overview.fmt
7023 To check whether your @sc{nntp} server includes the @code{Xref} header
7024 in its overview files, try @samp{telnet your.nntp.server nntp},
7025 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7026 overview.fmt}.  This may not work, but if it does, and the last line you
7027 get does not read @samp{Xref:full}, then you should shout and whine at
7028 your news admin until she includes the @code{Xref} header in the
7029 overview files.
7030
7031 @vindex gnus-nov-is-evil
7032 If you want Gnus to get the @code{Xref}s right all the time, you have to
7033 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7034 considerably.
7035
7036 C'est la vie.
7037
7038 For an alternative approach, @pxref{Duplicate Suppression}.
7039
7040
7041 @node Duplicate Suppression
7042 @section Duplicate Suppression
7043
7044 By default, Gnus tries to make sure that you don't have to read the same
7045 article more than once by utilizing the crossposting mechanism
7046 (@pxref{Crosspost Handling}).  However, that simple and efficient
7047 approach may not work satisfactorily for some users for various
7048 reasons.  
7049
7050 @enumerate
7051 @item 
7052 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7053 is evil and not very common.
7054
7055 @item 
7056 The @sc{nntp} server may fail to include the @code{Xref} header in the
7057 @file{.overview} data bases.  This is evil and all too common, alas.
7058
7059 @item
7060 You may be reading the same group (or several related groups) from
7061 different @sc{nntp} servers.
7062
7063 @item
7064 You may be getting mail that duplicates articles posted to groups.
7065 @end enumerate
7066
7067 I'm sure there are other situations that @code{Xref} handling fails as
7068 well, but these four are the most common situations.
7069
7070 If, and only if, @code{Xref} handling fails for you, then you may
7071 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7072 will remember the @code{Message-ID}s of all articles you have read or
7073 otherwise marked as read, and then, as if by magic, mark them as read
7074 all subsequent times you see them---in @emph{all} groups.  Using this
7075 mechanism is quite likely to be somewhat inefficient, but not overly
7076 so.  It's certainly preferable to reading the same articles more than
7077 once.
7078
7079 Duplicate suppression is not a very subtle instrument.  It's more like a
7080 sledge hammer than anything else.  It works in a very simple
7081 fashion---if you have marked an article as read, it adds this Message-ID
7082 to a cache.  The next time it sees this Message-ID, it will mark the
7083 article as read the the @samp{M} mark.  It doesn't care what group it
7084 saw the article in.
7085
7086 @table @code
7087 @item gnus-suppress-duplicates
7088 @vindex gnus-suppress-duplicates
7089 If non-@code{nil}, suppress duplicates.
7090
7091 @item gnus-save-duplicate-list
7092 @vindex gnus-save-duplicate-list
7093 If non-@code{nil}, save the list of duplicates to a file.  This will
7094 make startup and shutdown take longer, so the default is @code{nil}.
7095 However, this means that only duplicate articles that is read in a
7096 single Gnus session are suppressed.  
7097
7098 @item gnus-duplicate-list-length
7099 @vindex gnus-duplicate-list-length
7100 This variables says how many @code{Message-ID}s to keep in the duplicate
7101 suppression list.  The default is 10000.  
7102
7103 @item gnus-duplicate-file
7104 @vindex gnus-duplicate-file
7105 The name of the file to store the duplicate suppression list.  The
7106 default is @file{~/News/suppression}.
7107 @end table
7108
7109 If you have a tendency to stop and start Gnus often, setting
7110 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7111 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7112 the other hand, saving the list makes startup and shutdown much slower,
7113 so that means that if you stop and start Gnus often, you should set
7114 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7115 to you to figure out, I think.
7116
7117
7118 @node The Article Buffer
7119 @chapter The Article Buffer
7120 @cindex article buffer
7121
7122 The articles are displayed in the article buffer, of which there is only
7123 one.  All the summary buffers share the same article buffer unless you
7124 tell Gnus otherwise.
7125
7126 @menu
7127 * Hiding Headers::        Deciding what headers should be displayed.
7128 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7129 * Customizing Articles::  Tailoring the look of the articles.
7130 * Article Keymap::        Keystrokes available in the article buffer.
7131 * Misc Article::          Other stuff.
7132 @end menu
7133
7134
7135 @node Hiding Headers
7136 @section Hiding Headers
7137 @cindex hiding headers
7138 @cindex deleting headers
7139
7140 The top section of each article is the @dfn{head}.  (The rest is the
7141 @dfn{body}, but you may have guessed that already.)
7142
7143 @vindex gnus-show-all-headers
7144 There is a lot of useful information in the head: the name of the person
7145 who wrote the article, the date it was written and the subject of the
7146 article.  That's well and nice, but there's also lots of information
7147 most people do not want to see---what systems the article has passed
7148 through before reaching you, the @code{Message-ID}, the
7149 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7150 of some of those lines.  If you want to keep all those lines in the
7151 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7152
7153 Gnus provides you with two variables for sifting headers:
7154
7155 @table @code
7156
7157 @item gnus-visible-headers
7158 @vindex gnus-visible-headers
7159 If this variable is non-@code{nil}, it should be a regular expression
7160 that says what headers you wish to keep in the article buffer.  All
7161 headers that do not match this variable will be hidden.
7162
7163 For instance, if you only want to see the name of the person who wrote
7164 the article and the subject, you'd say:
7165
7166 @lisp
7167 (setq gnus-visible-headers "^From:\\|^Subject:")
7168 @end lisp
7169
7170 This variable can also be a list of regexps to match headers that are to
7171 remain visible.
7172
7173 @item gnus-ignored-headers
7174 @vindex gnus-ignored-headers
7175 This variable is the reverse of @code{gnus-visible-headers}.  If this
7176 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7177 should be a regular expression that matches all lines that you want to
7178 hide.  All lines that do not match this variable will remain visible.
7179
7180 For instance, if you just want to get rid of the @code{References} line
7181 and the @code{Xref} line, you might say:
7182
7183 @lisp
7184 (setq gnus-ignored-headers "^References:\\|^Xref:")
7185 @end lisp
7186
7187 This variable can also be a list of regexps to match headers that are to
7188 be removed.
7189
7190 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7191 variable will have no effect.
7192
7193 @end table
7194
7195 @vindex gnus-sorted-header-list
7196 Gnus can also sort the headers for you.  (It does this by default.)  You
7197 can control the sorting by setting the @code{gnus-sorted-header-list}
7198 variable.  It is a list of regular expressions that says in what order
7199 the headers are to be displayed.
7200
7201 For instance, if you want the name of the author of the article first,
7202 and then the subject, you might say something like:
7203
7204 @lisp
7205 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7206 @end lisp
7207
7208 Any headers that are to remain visible, but are not listed in this
7209 variable, will be displayed in random order after all the headers that
7210 are listed in this variable.
7211
7212 @findex gnus-article-hide-boring-headers
7213 @vindex gnus-article-display-hook
7214 @vindex gnus-boring-article-headers
7215 You can hide further boring headers by entering
7216 @code{gnus-article-hide-boring-headers} into
7217 @code{gnus-article-display-hook}.  What this function does depends on
7218 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7219 list doesn't actually contain header names.  Instead is lists various
7220 @dfn{boring conditions} that Gnus can check and remove from sight.
7221
7222 These conditions are:
7223 @table @code
7224 @item empty
7225 Remove all empty headers.
7226 @item newsgroups
7227 Remove the @code{Newsgroups} header if it only contains the current group
7228 name. 
7229 @item followup-to
7230 Remove the @code{Followup-To} header if it is identical to the
7231 @code{Newsgroups} header.
7232 @item reply-to
7233 Remove the @code{Reply-To} header if it lists the same address as the
7234 @code{From} header.
7235 @item date
7236 Remove the @code{Date} header if the article is less than three days
7237 old. 
7238 @end table
7239
7240 To include the four first elements, you could say something like;
7241
7242 @lisp
7243 (setq gnus-boring-article-headers 
7244       '(empty newsgroups followup-to reply-to))
7245 @end lisp
7246
7247 This is also the default value for this variable.
7248
7249
7250 @node Using MIME
7251 @section Using @sc{mime}
7252 @cindex @sc{mime}
7253
7254 Mime is a standard for waving your hands through the air, aimlessly,
7255 while people stand around yawning.
7256
7257 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7258 while all newsreaders die of fear.
7259
7260 @sc{mime} may specify what character set the article uses, the encoding
7261 of the characters, and it also makes it possible to embed pictures and
7262 other naughty stuff in innocent-looking articles.
7263
7264 @vindex gnus-show-mime
7265 @vindex gnus-show-mime-method
7266 @vindex gnus-strict-mime
7267 @findex metamail-buffer
7268 Gnus handles @sc{mime} by pushing the articles through
7269 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7270 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7271 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7272 non-@code{nil}, the @sc{mime} method will only be used if there are
7273 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7274 set, then you'll see some unfortunate display glitches in the article
7275 buffer.  These can't be avoided.
7276
7277 It might be best to just use the toggling functions from the summary
7278 buffer to avoid getting nasty surprises. (For instance, you enter the
7279 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7280 decoded the sound file in the article and some horrible sing-a-long song
7281 comes streaming out out your speakers, and you can't find the volume
7282 button, because there isn't one, and people are starting to look at you,
7283 and you try to stop the program, but you can't, and you can't find the
7284 program to control the volume, and everybody else in the room suddenly
7285 decides to look at you disdainfully, and you'll feel rather stupid.)
7286
7287 Any similarity to real events and people is purely coincidental.  Ahem.
7288
7289
7290 @node Customizing Articles
7291 @section Customizing Articles
7292 @cindex article customization
7293
7294 @vindex gnus-article-display-hook
7295 The @code{gnus-article-display-hook} is called after the article has
7296 been inserted into the article buffer.  It is meant to handle all
7297 treatment of the article before it is displayed. 
7298
7299 @findex gnus-article-maybe-highlight
7300 By default this hook just contains @code{gnus-article-hide-headers},
7301 @code{gnus-article-treat-overstrike}, and
7302 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7303 millions, of functions you can put in this hook.  For an overview of
7304 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7305 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7306 Date}.  Note that the order of functions in this hook might affect
7307 things, so you may have to fiddle a bit to get the desired results. 
7308
7309 You can, of course, write your own functions.  The functions are called
7310 from the article buffer, and you can do anything you like, pretty much.
7311 There is no information that you have to keep in the buffer---you can
7312 change everything.  However, you shouldn't delete any headers.  Instead
7313 make them invisible if you want to make them go away.
7314
7315
7316 @node Article Keymap
7317 @section Article Keymap
7318
7319 Most of the keystrokes in the summary buffer can also be used in the
7320 article buffer.  They should behave as if you typed them in the summary
7321 buffer, which means that you don't actually have to have a summary
7322 buffer displayed while reading.  You can do it all from the article
7323 buffer.
7324
7325 A few additional keystrokes are available:
7326
7327 @table @kbd
7328
7329 @item SPACE
7330 @kindex SPACE (Article)
7331 @findex gnus-article-next-page
7332 Scroll forwards one page (@code{gnus-article-next-page}).
7333
7334 @item DEL
7335 @kindex DEL (Article)
7336 @findex gnus-article-prev-page
7337 Scroll backwards one page (@code{gnus-article-prev-page}).
7338
7339 @item C-c ^
7340 @kindex C-c ^ (Article)
7341 @findex gnus-article-refer-article
7342 If point is in the neighborhood of a @code{Message-ID} and you press
7343 @kbd{r}, Gnus will try to get that article from the server
7344 (@code{gnus-article-refer-article}).
7345
7346 @item C-c C-m
7347 @kindex C-c C-m (Article)
7348 @findex gnus-article-mail
7349 Send a reply to the address near point (@code{gnus-article-mail}).  If
7350 given a prefix, include the mail.
7351
7352 @item s
7353 @kindex s (Article)
7354 @findex gnus-article-show-summary
7355 Reconfigure the buffers so that the summary buffer becomes visible
7356 (@code{gnus-article-show-summary}).
7357
7358 @item ?
7359 @kindex ? (Article)
7360 @findex gnus-article-describe-briefly
7361 Give a very brief description of the available keystrokes
7362 (@code{gnus-article-describe-briefly}). 
7363
7364 @item TAB
7365 @kindex TAB (Article)
7366 @findex gnus-article-next-button
7367 Go to the next button, if any (@code{gnus-article-next-button}.  This
7368 only makes sense if you have buttonizing turned on.
7369
7370 @item M-TAB
7371 @kindex M-TAB (Article)
7372 @findex gnus-article-prev-button
7373 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7374
7375 @end table
7376
7377
7378 @node Misc Article
7379 @section Misc Article
7380
7381 @table @code
7382
7383 @item gnus-single-article-buffer
7384 @vindex gnus-single-article-buffer
7385 If non-@code{nil}, use the same article buffer for all the groups.
7386 (This is the default.)  If @code{nil}, each group will have its own
7387 article buffer.
7388
7389 @vindex gnus-article-prepare-hook
7390 @item gnus-article-prepare-hook
7391 This hook is called right after the article has been inserted into the
7392 article buffer.  It is mainly intended for functions that do something
7393 depending on the contents; it should probably not be used for changing
7394 the contents of the article buffer.
7395
7396 @vindex gnus-article-display-hook
7397 @item gnus-article-display-hook
7398 This hook is called as the last thing when displaying an article, and is
7399 intended for modifying the contents of the buffer, doing highlights,
7400 hiding headers, and the like.
7401
7402 @item gnus-article-mode-hook
7403 @vindex gnus-article-mode-hook
7404 Hook called in article mode buffers.
7405
7406 @item gnus-article-mode-syntax-table
7407 @vindex gnus-article-mode-syntax-table
7408 Syntax table used in article buffers.  It is initialized from
7409 @code{text-mode-syntax-table}. 
7410
7411 @vindex gnus-article-mode-line-format
7412 @item gnus-article-mode-line-format
7413 This variable is a format string along the same lines as
7414 @code{gnus-summary-mode-line-format}.  It accepts the same
7415 format specifications as that variable, with one extension:
7416
7417 @table @samp
7418 @item w
7419 The @dfn{wash status} of the article.  This is a short string with one
7420 character for each possible article wash operation that may have been
7421 performed. 
7422 @end table
7423
7424 @vindex gnus-break-pages
7425
7426 @item gnus-break-pages
7427 Controls whether @dfn{page breaking} is to take place.  If this variable
7428 is non-@code{nil}, the articles will be divided into pages whenever a
7429 page delimiter appears in the article.  If this variable is @code{nil},
7430 paging will not be done.
7431
7432 @item gnus-page-delimiter
7433 @vindex gnus-page-delimiter
7434 This is the delimiter mentioned above.  By default, it is @samp{^L}
7435 (form linefeed).
7436 @end table
7437
7438
7439 @node Composing Messages
7440 @chapter Composing Messages
7441 @cindex reply
7442 @cindex followup
7443 @cindex post
7444
7445 @kindex C-c C-c (Post)
7446 All commands for posting and mailing will put you in a message buffer
7447 where you can edit the article all you like, before you send the article
7448 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7449 Manual}.  If you are in a foreign news group, and you wish to post the
7450 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7451 to make Gnus try to post using the foreign server.
7452
7453 @menu 
7454 * Mail::                 Mailing and replying.
7455 * Post::                 Posting and following up.
7456 * Posting Server::       What server should you post via?
7457 * Mail and Post::        Mailing and posting at the same time.
7458 * Archived Messages::    Where Gnus stores the messages you've sent.
7459 @c * Posting Styles::       An easier way to configure some key elements.
7460 @c * Drafts::               Postponing messages and rejected messages.
7461 @c * Rejected Articles::    What happens if the server doesn't like your article?
7462 @end menu
7463
7464 Also see @pxref{Canceling and Superseding} for information on how to
7465 remove articles you shouldn't have posted.
7466
7467
7468 @node Mail
7469 @section Mail
7470
7471 Variables for customizing outgoing mail:
7472
7473 @table @code
7474 @item gnus-uu-digest-headers
7475 @vindex gnus-uu-digest-headers
7476 List of regexps to match headers included in digested messages.  The
7477 headers will be included in the sequence they are matched.
7478
7479 @end table
7480
7481
7482 @node Post
7483 @section Post
7484
7485 Variables for composing news articles:
7486
7487 @table @code
7488 @item gnus-sent-message-ids-file
7489 @vindex gnus-sent-message-ids-file
7490 Gnus will keep a @code{Message-ID} history file of all the mails it has
7491 sent.  If it discovers that it has already sent a mail, it will ask the
7492 user whether to re-send the mail.  (This is primarily useful when
7493 dealing with @sc{soup} packets and the like where one is apt to sent the
7494 same packet multiple times.)  This variable says what the name of this
7495 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7496 this variable to @code{nil} if you don't want Gnus to keep a history
7497 file.
7498
7499 @item gnus-sent-message-ids-length
7500 @vindex gnus-sent-message-ids-length
7501 This variable says how many @code{Message-ID}s to keep in the history
7502 file.  It is 1000 by default.
7503
7504 @end table
7505
7506
7507 @node Posting Server
7508 @section Posting Server
7509
7510 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7511 (extremely intelligent, of course) article, where does it go?
7512
7513 Thank you for asking.  I hate you.
7514
7515 @vindex gnus-post-method
7516
7517 It can be quite complicated.  Normally, Gnus will use the same native
7518 server.  However.  If your native server doesn't allow posting, just
7519 reading, you probably want to use some other server to post your
7520 (extremely intelligent and fabulously interesting) articles.  You can
7521 then set the @code{gnus-post-method} to some other method:
7522
7523 @lisp
7524 (setq gnus-post-method '(nnspool ""))
7525 @end lisp
7526
7527 Now, if you've done this, and then this server rejects your article, or
7528 this server is down, what do you do then?  To override this variable you
7529 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7530 the ``current'' server for posting.
7531
7532 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7533 Gnus will prompt you for what method to use for posting.  
7534
7535 You can also set @code{gnus-post-method} to a list of select methods.
7536 If that's the case, Gnus will always prompt you for what method to use
7537 for posting. 
7538
7539
7540 @node Mail and Post
7541 @section Mail and Post
7542
7543 Here's a list of variables that are relevant to both mailing and
7544 posting:
7545
7546 @table @code
7547 @item gnus-mailing-list-groups
7548 @findex gnus-mailing-list-groups
7549 @cindex mailing lists
7550
7551 If your news server offers groups that are really mailing lists that are
7552 gatewayed to the @sc{nntp} server, you can read those groups without
7553 problems, but you can't post/followup to them without some difficulty.
7554 One solution is to add a @code{to-address} to the group parameters
7555 (@pxref{Group Parameters}).  An easier thing to do is set the
7556 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7557 really are mailing lists.  Then, at least, followups to the mailing
7558 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7559 still a pain, though.
7560
7561 @end table
7562
7563 You may want to do spell-checking on messages that you send out.  Or, if
7564 you don't want to spell-check by hand, you could add automatic
7565 spell-checking via the @code{ispell} package:
7566
7567 @cindex ispell
7568 @findex ispell-message
7569 @lisp
7570 (add-hook 'message-send-hook 'ispell-message) 
7571 @end lisp
7572
7573
7574 @node Archived Messages
7575 @section Archived Messages
7576 @cindex archived messages
7577 @cindex sent messages
7578
7579 Gnus provides a few different methods for storing the mail you send.
7580 The default method is to use the @dfn{archive virtual server} to store
7581 the mail.  If you want to disable this completely, you should set
7582 @code{gnus-message-archive-group} to @code{nil}.
7583
7584 @vindex gnus-message-archive-method
7585 @code{gnus-message-archive-method} says what virtual server Gnus is to
7586 use to store sent messages.  The default is:
7587
7588 @lisp
7589 (nnfolder "archive"
7590           (nnfolder-directory "~/Mail/archive/"))
7591 @end lisp
7592
7593 You can, however, use any mail select method (@code{nnml},
7594 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7595 for doing this sort of thing, though.  If you don't like the default
7596 directory chosen, you could say something like:
7597
7598 @lisp
7599 (setq gnus-message-archive-method
7600       '(nnfolder "archive" 
7601                  (nnfolder-inhibit-expiry t)
7602                  (nnfolder-active-file "~/News/sent-mail/active")
7603                  (nnfolder-directory "~/News/sent-mail/")))
7604 @end lisp
7605
7606 @vindex gnus-message-archive-group
7607 @cindex Gcc
7608 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7609 to one or more group(s) on that server.  Which group to use is
7610 determined by the @code{gnus-message-archive-group} variable.  
7611
7612 This variable can be:
7613
7614 @itemize @bullet
7615 @item a string
7616 Messages will be saved in that group.
7617 @item a list of strings
7618 Messages will be saved in all those groups.
7619 @item an alist of regexps, functions and forms
7620 When a key ``matches'', the result is used.
7621 @item @code{nil}
7622 No message archiving will take place.  This is the default.
7623 @end itemize
7624
7625 Let's illustrate:
7626
7627 Just saving to a single group called @samp{MisK}:
7628 @lisp
7629 (setq gnus-message-archive-group "MisK")
7630 @end lisp
7631
7632 Saving to two groups, @samp{MisK} and @samp{safe}:
7633 @lisp
7634 (setq gnus-message-archive-group '("MisK" "safe"))
7635 @end lisp
7636
7637 Save to different groups based on what group you are in:
7638 @lisp
7639 (setq gnus-message-archive-group 
7640       '(("^alt" "sent-to-alt")
7641         ("mail" "sent-to-mail")
7642         (".*" "sent-to-misc")))
7643 @end lisp
7644
7645 More complex stuff:
7646 @lisp
7647 (setq gnus-message-archive-group 
7648       '((if (message-news-p)
7649             "misc-news" 
7650           "misc-mail")))
7651 @end lisp       
7652
7653 How about storing all news messages in one file, but storing all mail
7654 messages in one file per month:
7655
7656 @lisp
7657 (setq gnus-message-archive-group
7658       '((if (message-news-p)
7659             "misc-news" 
7660           (concat "mail." (format-time-string 
7661                            "%Y-%m" (current-time))))))
7662 @end lisp
7663
7664 Now, when you send a message off, it will be stored in the appropriate
7665 group.  (If you want to disable storing for just one particular message,
7666 you can just remove the @code{Gcc} header that has been inserted.)  The
7667 archive group will appear in the group buffer the next time you start
7668 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7669 enter it and read the articles in it just like you'd read any other
7670 group.  If the group gets really big and annoying, you can simply rename
7671 if (using @kbd{G r} in the group buffer) to something
7672 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7673 continue to be stored in the old (now empty) group.
7674
7675 That's the default method of archiving sent mail.  Gnus also a different
7676 way for the people who don't like the default method.  In that case you
7677 should set @code{gnus-message-archive-group} to @code{nil}; this will
7678 disable archiving.
7679
7680 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7681 use a different value for @code{gnus-message-archive-group} there.
7682
7683 @table @code
7684 @item gnus-outgoing-message-group 
7685 @vindex gnus-outgoing-message-group 
7686 All outgoing messages will be put in this group.  If you want to store
7687 all your outgoing mail and articles in the group @samp{nnml:archive},
7688 you set this variable to that value.  This variable can also be a list of
7689 group names.
7690
7691 If you want to have greater control over what group to put each
7692 message in, you can set this variable to a function that checks the
7693 current newsgroup name and then returns a suitable group name (or list
7694 of names).
7695 @end table
7696
7697
7698 @c @node Posting Styles
7699 @c @section Posting Styles
7700 @c @cindex posting styles
7701 @c @cindex styles
7702 @c 
7703 @c All them variables, they make my head swim.  
7704 @c 
7705 @c So what if you want a different @code{Organization} and signature based
7706 @c on what groups you post to?  And you post both from your home machine
7707 @c and your work machine, and you want different @code{From} lines, and so
7708 @c on? 
7709 @c 
7710 @c @vindex gnus-posting-styles
7711 @c One way to do stuff like that is to write clever hooks that change the
7712 @c variables you need to have changed.  That's a bit boring, so somebody
7713 @c came up with the bright idea of letting the user specify these things in
7714 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7715 @c variable: 
7716 @c 
7717 @c @lisp
7718 @c ((".*" 
7719 @c   (signature . "Peace and happiness")
7720 @c   (organization . "What me?"))
7721 @c  ("^comp" 
7722 @c   (signature . "Death to everybody"))
7723 @c  ("comp.emacs.i-love-it" 
7724 @c   (organization . "Emacs is it")))
7725 @c @end lisp
7726 @c 
7727 @c As you might surmise from this example, this alist consists of several
7728 @c @dfn{styles}.  Each style will be applicable if the first element
7729 @c ``matches'', in some form or other.  The entire alist will be iterated
7730 @c over, from the beginning towards the end, and each match will be
7731 @c applied, which means that attributes in later styles that match override
7732 @c the same attributes in earlier matching styles.  So
7733 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7734 @c signature and the @samp{What me?} @code{Organization} header.
7735 @c 
7736 @c The first element in each style is called the @code{match}.  If it's a
7737 @c string, then Gnus will try to regexp match it against the group name.
7738 @c If it's a function symbol, that function will be called with no
7739 @c arguments.  If it's a variable symbol, then the variable will be
7740 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7741 @c any case, if this returns a non-@code{nil} value, then the style is said
7742 @c to @dfn{match}.
7743 @c 
7744 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7745 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7746 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7747 @c attribute name can also be a string.  In that case, this will be used as
7748 @c a header name, and the value will be inserted in the headers of the
7749 @c article.
7750 @c 
7751 @c The attribute value can be a string (used verbatim), a function (the
7752 @c return value will be used), a variable (its value will be used) or a
7753 @c list (it will be @code{eval}ed and the return value will be used).
7754 @c 
7755 @c So here's a new example:
7756 @c 
7757 @c @lisp
7758 @c (setq gnus-posting-styles
7759 @c       '((".*" 
7760 @c           (signature . "~/.signature") 
7761 @c           (from . "user@@foo (user)")
7762 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7763 @c           (organization . "People's Front Against MWM"))
7764 @c         ("^rec.humor" 
7765 @c           (signature . my-funny-signature-randomizer))
7766 @c         ((equal (system-name) "gnarly")
7767 @c           (signature . my-quote-randomizer))
7768 @c         (posting-from-work-p
7769 @c           (signature . "~/.work-signature")
7770 @c           (from . "user@@bar.foo (user)")
7771 @c           (organization . "Important Work, Inc"))
7772 @c         ("^nn.+:" 
7773 @c           (signature . "~/.mail-signature"))))
7774 @c @end lisp
7775
7776 @c @node Drafts
7777 @c @section Drafts
7778 @c @cindex drafts
7779 @c 
7780 @c If you are writing a message (mail or news) and suddenly remember that
7781 @c you have a steak in the oven (or some pesto in the food processor, you
7782 @c craazy vegetarians), you'll probably wish there was a method to save the
7783 @c message you are writing so that you can continue editing it some other
7784 @c day, and send it when you feel its finished.
7785 @c 
7786 @c Well, don't worry about it.  Whenever you start composing a message of
7787 @c some sort using the Gnus mail and post commands, the buffer you get will
7788 @c automatically associate to an article in a special @dfn{draft} group.
7789 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7790 @c article will be saved there.  (Auto-save files also go to the draft
7791 @c group.) 
7792 @c 
7793 @c @cindex nndraft
7794 @c @vindex gnus-draft-group-directory
7795 @c The draft group is a special group (which is implemented as an
7796 @c @code{nndraft} group, if you absolutely have to know) called
7797 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7798 @c controls both the name of the group and the location---the leaf element
7799 @c in the path will be used as the name of the group.  What makes this
7800 @c group special is that you can't tick any articles in it or mark any
7801 @c articles as read---all articles in the group are permanently unread.
7802 @c 
7803 @c If the group doesn't exist, it will be created and you'll be subscribed
7804 @c to it.
7805 @c 
7806 @c @findex gnus-dissociate-buffer-from-draft
7807 @c @kindex C-c M-d (Mail)
7808 @c @kindex C-c M-d (Post)
7809 @c @findex gnus-associate-buffer-with-draft
7810 @c @kindex C-c C-d (Mail)
7811 @c @kindex C-c C-d (Post)
7812 @c If you're writing some super-secret message that you later want to
7813 @c encode with PGP before sending, you may wish to turn the auto-saving
7814 @c (and association with the draft group) off.  You never know who might be
7815 @c interested in reading all your extremely valuable and terribly horrible
7816 @c and interesting secrets.  The @kbd{C-c M-d}
7817 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7818 @c If you change your mind and want to turn the auto-saving back on again,
7819 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7820 @c 
7821 @c @vindex gnus-use-draft
7822 @c To leave association with the draft group off by default, set
7823 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7824 @c 
7825 @c @findex gnus-summary-send-draft
7826 @c @kindex S D c (Summary)
7827 @c When you want to continue editing the article, you simply enter the
7828 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7829 @c that.  You will be placed in a buffer where you left off.
7830 @c 
7831 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7832 @c Articles}).
7833 @c 
7834 @c @findex gnus-summary-send-all-drafts
7835 @c If you have lots of rejected messages you want to post (or mail) without
7836 @c doing further editing, you can use the @kbd{S D a} command
7837 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7838 @c process/prefix convention (@pxref{Process/Prefix}).  
7839 @c 
7840 @c 
7841 @c @node Rejected Articles
7842 @c @section Rejected Articles
7843 @c @cindex rejected articles
7844 @c 
7845 @c Sometimes a news server will reject an article.  Perhaps the server
7846 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7847 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7848 @c Perhaps the disk is full.  Perhaps the server is down.
7849 @c 
7850 @c These situations are, of course, totally beyond the control of Gnus.
7851 @c (Gnus, of course, loves the way you look, always feels great, has angels
7852 @c fluttering around inside of it, doesn't care about how much cited text
7853 @c you include, never runs full and never goes down.)  So Gnus saves these
7854 @c articles until some later time when the server feels better.
7855 @c 
7856 @c The rejected articles will automatically be put in a special draft group
7857 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7858 @c typically enter that group and send all the articles off.
7859 @c 
7860
7861 @node Select Methods
7862 @chapter Select Methods
7863 @cindex foreign groups
7864 @cindex select methods
7865
7866 A @dfn{foreign group} is a group that is not read by the usual (or
7867 default) means.  It could be, for instance, a group from a different
7868 @sc{nntp} server, it could be a virtual group, or it could be your own
7869 personal mail group.
7870
7871 A foreign group (or any group, really) is specified by a @dfn{name} and
7872 a @dfn{select method}.  To take the latter first, a select method is a
7873 list where the first element says what backend to use (e.g. @code{nntp},
7874 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7875 name}.  There may be additional elements in the select method, where the
7876 value may have special meaning for the backend in question.
7877
7878 One could say that a select method defines a @dfn{virtual server}---so
7879 we do just that (@pxref{The Server Buffer}).
7880
7881 The @dfn{name} of the group is the name the backend will recognize the
7882 group as.
7883
7884 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7885 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7886 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7887 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7888 backend just knows this group as @samp{soc.motss}.
7889
7890 The different methods all have their peculiarities, of course.
7891
7892 @menu
7893 * The Server Buffer::     Making and editing virtual servers.
7894 * Getting News::          Reading USENET news with Gnus.
7895 * Getting Mail::          Reading your personal mail with Gnus.
7896 * Other Sources::         Reading directories, files, SOUP packets.
7897 * Combined Groups::       Combining groups into one group.
7898 @end menu
7899
7900
7901 @node The Server Buffer
7902 @section The Server Buffer
7903
7904 Traditionally, a @dfn{server} is a machine or a piece of software that
7905 one connects to, and then requests information from.  Gnus does not
7906 connect directly to any real servers, but does all transactions through
7907 one backend or other.  But that's just putting one layer more between
7908 the actual media and Gnus, so we might just as well say that each
7909 backend represents a virtual server.
7910
7911 For instance, the @code{nntp} backend may be used to connect to several
7912 different actual @sc{nntp} servers, or, perhaps, to many different ports
7913 on the same actual @sc{nntp} server.  You tell Gnus which backend to
7914 use, and what parameters to set by specifying a @dfn{select method}.
7915
7916 These select methods specifications can sometimes become quite
7917 complicated---say, for instance, that you want to read from the
7918 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7919 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
7920 Anyways, if you had to specify that for each group that used this
7921 server, that would be too much work, so Gnus offers a way of naming
7922 select methods, which is what you do in the server buffer.
7923
7924 To enter the server buffer, user the @kbd{^}
7925 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7926
7927 @menu
7928 * Server Buffer Format::      You can customize the look of this buffer.
7929 * Server Commands::           Commands to manipulate servers.
7930 * Example Methods::           Examples server specifications.
7931 * Creating a Virtual Server:: An example session.
7932 * Servers and Methods::       You can use server names as select methods.
7933 * Unavailable Servers::       Some servers you try to contact may be down.
7934 @end menu
7935
7936 @vindex gnus-server-mode-hook
7937 @code{gnus-server-mode-hook} is run when creating the server buffer.
7938
7939
7940 @node Server Buffer Format
7941 @subsection Server Buffer Format
7942 @cindex server buffer format
7943
7944 @vindex gnus-server-line-format
7945 You can change the look of the server buffer lines by changing the
7946 @code{gnus-server-line-format} variable.  This is a @code{format}-like
7947 variable, with some simple extensions:
7948
7949 @table @samp
7950
7951 @item h 
7952 How the news is fetched---the backend name.
7953
7954 @item n
7955 The name of this server.
7956
7957 @item w
7958 Where the news is to be fetched from---the address.
7959
7960 @item s
7961 The opened/closed/denied status of the server.
7962 @end table
7963
7964 @vindex gnus-server-mode-line-format
7965 The mode line can also be customized by using the
7966 @code{gnus-server-mode-line-format} variable.  The following specs are
7967 understood: 
7968
7969 @table @samp
7970 @item S
7971 Server name.
7972
7973 @item M
7974 Server method.
7975 @end table
7976
7977 Also @pxref{Formatting Variables}.
7978
7979
7980 @node Server Commands
7981 @subsection Server Commands
7982 @cindex server commands
7983
7984 @table @kbd
7985
7986 @item a
7987 @kindex a (Server)
7988 @findex gnus-server-add-server
7989 Add a new server (@code{gnus-server-add-server}).
7990
7991 @item e
7992 @kindex e (Server)
7993 @findex gnus-server-edit-server
7994 Edit a server (@code{gnus-server-edit-server}).
7995
7996 @item SPACE
7997 @kindex SPACE (Server)
7998 @findex gnus-server-read-server
7999 Browse the current server (@code{gnus-server-read-server}).
8000
8001 @item q
8002 @kindex q (Server)
8003 @findex gnus-server-exit
8004 Return to the group buffer (@code{gnus-server-exit}).
8005
8006 @item k
8007 @kindex k (Server)
8008 @findex gnus-server-kill-server
8009 Kill the current server (@code{gnus-server-kill-server}).
8010
8011 @item y
8012 @kindex y (Server)
8013 @findex gnus-server-yank-server
8014 Yank the previously killed server (@code{gnus-server-yank-server}).
8015
8016 @item c
8017 @kindex c (Server)
8018 @findex gnus-server-copy-server
8019 Copy the current server (@code{gnus-server-copy-server}).
8020
8021 @item l
8022 @kindex l (Server)
8023 @findex gnus-server-list-servers
8024 List all servers (@code{gnus-server-list-servers}).
8025
8026 @item s
8027 @kindex s (Server)
8028 @findex gnus-server-scan-server
8029 Request that the server scan its sources for new articles
8030 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8031 servers. 
8032
8033 @item g
8034 @kindex g (Server)
8035 @findex gnus-server-regenerate-server
8036 Request that the server regenerate all its data structures
8037 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8038 a mail backend that has gotten out of synch.
8039
8040 @end table
8041
8042
8043 @node Example Methods
8044 @subsection Example Methods
8045
8046 Most select methods are pretty simple and self-explanatory: 
8047
8048 @lisp
8049 (nntp "news.funet.fi")
8050 @end lisp
8051
8052 Reading directly from the spool is even simpler:
8053
8054 @lisp
8055 (nnspool "")
8056 @end lisp
8057
8058 As you can see, the first element in a select method is the name of the
8059 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8060 will. 
8061
8062 After these two elements, there may be a arbitrary number of
8063 @var{(variable form)} pairs.
8064
8065 To go back to the first example---imagine that you want to read from
8066 port 15 from that machine.  This is what the select method should
8067 look like then:
8068
8069 @lisp
8070 (nntp "news.funet.fi" (nntp-port-number 15))
8071 @end lisp
8072
8073 You should read the documentation to each backend to find out what
8074 variables are relevant, but here's an @code{nnmh} example. 
8075
8076 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8077 you have two structures that you wish to access: One is your private
8078 mail spool, and the other is a public one.  Here's the possible spec for
8079 you private mail:
8080
8081 @lisp
8082 (nnmh "private" (nnmh-directory "~/private/mail/"))
8083 @end lisp
8084
8085 (This server is then called @samp{private}, but you may have guessed
8086 that.)
8087
8088 Here's the method for a public spool:
8089
8090 @lisp
8091 (nnmh "public" 
8092       (nnmh-directory "/usr/information/spool/") 
8093       (nnmh-get-new-mail nil))
8094 @end lisp
8095
8096 If you are behind a firewall and only have access to the @sc{nntp}
8097 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8098 on the firewall machine and telnet from there to the @sc{nntp} server.
8099 Doing this can be rather fiddly, but your virtual server definition
8100 should probably look something like this:
8101
8102 @lisp
8103 (nntp "firewall"
8104       (nntp-address "the.firewall.machine")
8105       (nntp-open-connection-function nntp-open-rlogin)
8106       (nntp-end-of-line "\n")
8107       (nntp-rlogin-parameters
8108        ("telnet" "the.real.nntp.host" "nntp")))
8109 @end lisp
8110
8111
8112
8113 @node Creating a Virtual Server
8114 @subsection Creating a Virtual Server
8115
8116 If you're saving lots of articles in the cache by using persistent
8117 articles, you may want to create a virtual server to read the cache.
8118
8119 First you need to add a new server.  The @kbd{a} command does that.  It
8120 would probably be best to use @code{nnspool} to read the cache.  You
8121 could also use @code{nnml} or @code{nnmh}, though.
8122
8123 Type @kbd{a nnspool RET cache RET}.
8124
8125 You should now have a brand new @code{nnspool} virtual server called
8126 @samp{cache}.  You now need to edit it to have the right definitions.
8127 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8128 will contain the following:
8129
8130 @lisp
8131 (nnspool "cache")
8132 @end lisp
8133
8134 Change that to:
8135
8136 @lisp
8137 (nnspool "cache"
8138          (nnspool-spool-directory "~/News/cache/")
8139          (nnspool-nov-directory "~/News/cache/")
8140          (nnspool-active-file "~/News/cache/active"))
8141 @end lisp
8142
8143 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8144 @kbd{RET} over this virtual server, you should be entered into a browse
8145 buffer, and you should be able to enter any of the groups displayed.
8146
8147
8148 @node Servers and Methods
8149 @subsection Servers and Methods
8150
8151 Wherever you would normally use a select method
8152 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8153 when browsing a foreign server) you can use a virtual server name
8154 instead.  This could potentially save lots of typing.  And it's nice all
8155 over.
8156
8157
8158 @node Unavailable Servers
8159 @subsection Unavailable Servers
8160
8161 If a server seems to be unreachable, Gnus will mark that server as
8162 @code{denied}.  That means that any subsequent attempt to make contact
8163 with that server will just be ignored.  ``It can't be opened,'' Gnus
8164 will tell you, without making the least effort to see whether that is
8165 actually the case or not.
8166
8167 That might seem quite naughty, but it does make sense most of the time.
8168 Let's say you have 10 groups subscribed to the server
8169 @samp{nepholococcygia.com}.  This server is located somewhere quite far
8170 away from you, the machine is quite, so it takes 1 minute just to find
8171 out that it refuses connection from you today.  If Gnus were to attempt
8172 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8173 that.  Once it has gotten a single ``connection refused'', it will
8174 regard that server as ``down''.
8175
8176 So, what happens if the machine was only feeling unwell temporarily?
8177 How do you test to see whether the machine has come up again?
8178
8179 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8180 with the following commands:
8181
8182 @table @kbd
8183
8184 @item O
8185 @kindex O (Server)
8186 @findex gnus-server-open-server
8187 Try to establish connection to the server on the current line
8188 (@code{gnus-server-open-server}).
8189
8190 @item C
8191 @kindex C (Server)
8192 @findex gnus-server-close-server
8193 Close the connection (if any) to the server
8194 (@code{gnus-server-close-server}).
8195
8196 @item D
8197 @kindex D (Server)
8198 @findex gnus-server-deny-server
8199 Mark the current server as unreachable
8200 (@code{gnus-server-deny-server}). 
8201
8202 @item M-o
8203 @kindex M-o (Server)
8204 @findex gnus-server-open-all-servers
8205 Open the connections to all servers in the buffer
8206 (@code{gnus-server-open-all-servers}). 
8207
8208 @item M-c
8209 @kindex M-c (Server)
8210 @findex gnus-server-close-all-servers
8211 Close the connections to all servers in the buffer
8212 (@code{gnus-server-close-all-servers}). 
8213
8214 @item R
8215 @kindex R (Server)
8216 @findex gnus-server-remove-denials
8217 Remove all marks to whether Gnus was denied connection from all servers
8218 (@code{gnus-server-remove-denials}). 
8219
8220 @end table
8221
8222
8223 @node Getting News
8224 @section Getting News
8225 @cindex reading news
8226 @cindex news backends
8227
8228 A newsreader is normally used for reading news.  Gnus currently provides
8229 only two methods of getting news---it can read from an @sc{nntp} server,
8230 or it can read from a local spool.
8231
8232 @menu
8233 * NNTP::               Reading news from an @sc{nntp} server.
8234 * News Spool::         Reading news from the local spool.
8235 @end menu
8236
8237
8238 @node NNTP
8239 @subsection @sc{nntp}
8240 @cindex nntp
8241
8242 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8243 You just specify @code{nntp} as method and the address of the @sc{nntp}
8244 server as the, uhm, address.
8245
8246 If the @sc{nntp} server is located at a non-standard port, setting the
8247 third element of the select method to this port number should allow you
8248 to connect to the right port.  You'll have to edit the group info for
8249 that (@pxref{Foreign Groups}).
8250
8251 The name of the foreign group can be the same as a native group.  In
8252 fact, you can subscribe to the same group from as many different servers
8253 you feel like.  There will be no name collisions.
8254
8255 The following variables can be used to create a virtual @code{nntp}
8256 server: 
8257
8258 @table @code
8259
8260 @item nntp-server-opened-hook
8261 @vindex nntp-server-opened-hook
8262 @cindex @sc{mode reader}
8263 @cindex authinfo
8264 @cindex authentification
8265 @cindex nntp authentification
8266 @findex nntp-send-authinfo
8267 @findex nntp-send-mode-reader
8268 @code{nntp-server-opened-hook} is run after a connection has been made.
8269 It can be used to send commands to the @sc{nntp} server after it has
8270 been contacted.  By default is sends the command @code{MODE READER} to
8271 the server with the @code{nntp-send-mode-reader} function. 
8272
8273 @item nntp-authinfo-function 
8274 @vindex nntp-authinfo-function 
8275 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8276 server.  Available functions include:
8277
8278 @table @code
8279 @item nntp-send-authinfo
8280 @findex nntp-send-authinfo
8281 This function will used you current login name as the user name and will
8282 prompt you for the password.  This is the default.
8283
8284 @item nntp-send-nosy-authinfo
8285 @findex nntp-send-nosy-authinfo
8286 This function will prompt you for both user name and password.
8287
8288 @item nntp-send-authinfo-from-file
8289 @findex nntp-send-authinfo-from-file
8290 This function will use your current login name as the user name and will
8291 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8292 @end table
8293
8294 @item nntp-server-action-alist 
8295 @vindex nntp-server-action-alist 
8296 This is an list of regexps to match on server types and actions to be
8297 taken when matches are made.  For instance, if you want Gnus to beep
8298 every time you connect to innd, you could say something like:
8299
8300 @lisp
8301 (setq nntp-server-action-alist
8302       '(("innd" (ding))))
8303 @end lisp
8304
8305 You probably don't want to do that, though.
8306
8307 The default value is
8308
8309 @lisp
8310   '(("nntpd 1\\.5\\.11t" 
8311      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8312 @end lisp
8313
8314 This ensures that Gnus doesn't send the @code{MODE READER} command to
8315 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8316
8317 @item nntp-maximum-request
8318 @vindex nntp-maximum-request
8319 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8320 will collect headers by sending a series of @code{head} commands.  To
8321 speed things up, the backend sends lots of these commands without
8322 waiting for reply, and then reads all the replies.  This is controlled
8323 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8324 your network is buggy, you should set this to 1.
8325
8326 @item nntp-connection-timeout
8327 @vindex nntp-connection-timeout
8328 If you have lots of foreign @code{nntp} groups that you connect to
8329 regularly, you're sure to have problems with @sc{nntp} servers not
8330 responding properly, or being too loaded to reply within reasonable
8331 time.  This is can lead to awkward problems, which can be helped
8332 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8333 that says how many seconds the @code{nntp} backend should wait for a
8334 connection before giving up.  If it is @code{nil}, which is the default,
8335 no timeouts are done.
8336
8337 @item nntp-command-timeout
8338 @vindex nntp-command-timeout
8339 @cindex PPP connections
8340 @cindex dynamic IP addresses
8341 If you're running Gnus on a machine that has a dynamically assigned
8342 address, Gnus may become confused.  If the address of your machine
8343 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8344 waiting forever for replies from the server.  To help with this
8345 unfortunate problem, you can set this command to a number.  Gnus will
8346 then, if it sits waiting longer than that number of seconds for a reply
8347 from the server, shut down the connection, start a new one, and resend
8348 the command.  This should hopefully be transparent to the user.  A
8349 likely number is 30 seconds. 
8350
8351 @item nntp-retry-on-break
8352 @vindex nntp-retry-on-break
8353 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8354 hangs.  This will have much the same effect as the command timeout
8355 described above.
8356
8357 @item nntp-server-hook
8358 @vindex nntp-server-hook
8359 This hook is run as the last step when connecting to an @sc{nntp}
8360 server.
8361
8362 @findex nntp-open-rlogin
8363 @findex nntp-open-network-stream
8364 @item nntp-open-connection-function
8365 @vindex nntp-open-connection-function
8366 This function is used to connect to the remote system.  Two pre-made
8367 functions are @code{nntp-open-network-stream}, which is the default, and
8368 simply connects to some port or other on the remote system.  The other
8369 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8370 and then does a telnet to the @sc{nntp} server available there.
8371
8372 @item nntp-rlogin-parameters
8373 @vindex nntp-rlogin-parameters
8374 If you use @code{nntp-open-rlogin} as the
8375 @code{nntp-open-connection-function}, this list will be used as the
8376 parameter list given to @code{rsh}.
8377
8378 @item nntp-end-of-line
8379 @vindex nntp-end-of-line
8380 String to use as end-of-line markers when talking to the @sc{nntp}
8381 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8382 using @code{rlogin} to talk to the server.
8383
8384 @item nntp-rlogin-user-name
8385 @vindex nntp-rlogin-user-name
8386 User name on the remote system when using the @code{rlogin} connect
8387 function. 
8388
8389 @item nntp-address
8390 @vindex nntp-address
8391 The address of the remote system running the @sc{nntp} server.
8392
8393 @item nntp-port-number
8394 @vindex nntp-port-number
8395 Port number to connect to when using the @code{nntp-open-network-stream}
8396 connect function.
8397
8398 @item nntp-buggy-select
8399 @vindex nntp-buggy-select
8400 Set this to non-@code{nil} if your select routine is buggy.
8401
8402 @item nntp-nov-is-evil 
8403 @vindex nntp-nov-is-evil 
8404 If the @sc{nntp} server does not support @sc{nov}, you could set this
8405 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8406 can be used automatically.
8407
8408 @item nntp-xover-commands
8409 @vindex nntp-xover-commands
8410 @cindex nov
8411 @cindex XOVER
8412 List of strings that are used as commands to fetch @sc{nov} lines from a
8413 server.  The default value of this variable is @code{("XOVER"
8414 "XOVERVIEW")}. 
8415
8416 @item nntp-nov-gap
8417 @vindex nntp-nov-gap
8418 @code{nntp} normally sends just one big request for @sc{nov} lines to
8419 the server.  The server responds with one huge list of lines.  However,
8420 if you have read articles 2-5000 in the group, and only want to read
8421 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8422 lines that you do not want, and will not use.  This variable says how
8423 big a gap between two consecutive articles is allowed to be before the
8424 @code{XOVER} request is split into several request.  Note that if your
8425 network is fast, setting this variable to a really small number means
8426 that fetching will probably be slower.  If this variable is @code{nil},
8427 @code{nntp} will never split requests.
8428
8429 @item nntp-prepare-server-hook
8430 @vindex nntp-prepare-server-hook
8431 A hook run before attempting to connect to an @sc{nntp} server.
8432
8433 @item nntp-warn-about-losing-connection
8434 @vindex nntp-warn-about-losing-connection
8435 If this variable is non-@code{nil}, some noise will be made when a
8436 server closes connection.
8437
8438 @end table
8439
8440
8441 @node News Spool
8442 @subsection News Spool
8443 @cindex nnspool
8444 @cindex news spool
8445
8446 Subscribing to a foreign group from the local spool is extremely easy,
8447 and might be useful, for instance, to speed up reading groups that
8448 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8449 instance. 
8450
8451 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8452 anything else) as the address.
8453
8454 If you have access to a local spool, you should probably use that as the
8455 native select method (@pxref{Finding the News}).  It is normally faster
8456 than using an @code{nntp} select method, but might not be.  It depends.
8457 You just have to try to find out what's best at your site.
8458
8459 @table @code
8460
8461 @item nnspool-inews-program
8462 @vindex nnspool-inews-program
8463 Program used to post an article.
8464
8465 @item nnspool-inews-switches
8466 @vindex nnspool-inews-switches
8467 Parameters given to the inews program when posting an article. 
8468
8469 @item nnspool-spool-directory
8470 @vindex nnspool-spool-directory
8471 Where @code{nnspool} looks for the articles.  This is normally
8472 @file{/usr/spool/news/}.
8473
8474 @item nnspool-nov-directory 
8475 @vindex nnspool-nov-directory 
8476 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8477 @file{/usr/spool/news/over.view/}.
8478
8479 @item nnspool-lib-dir
8480 @vindex nnspool-lib-dir
8481 Where the news lib dir is (@file{/usr/lib/news/} by default).
8482
8483 @item nnspool-active-file
8484 @vindex nnspool-active-file
8485 The path of the active file.
8486
8487 @item nnspool-newsgroups-file
8488 @vindex nnspool-newsgroups-file
8489 The path of the group descriptions file.
8490
8491 @item nnspool-history-file
8492 @vindex nnspool-history-file
8493 The path of the news history file.
8494
8495 @item nnspool-active-times-file
8496 @vindex nnspool-active-times-file
8497 The path of the active date file.
8498
8499 @item nnspool-nov-is-evil
8500 @vindex nnspool-nov-is-evil
8501 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8502 that it finds.
8503
8504 @item nnspool-sift-nov-with-sed
8505 @vindex nnspool-sift-nov-with-sed
8506 @cindex sed
8507 If non-@code{nil}, which is the default, use @code{sed} to get the
8508 relevant portion from the overview file.  If nil, @code{nnspool} will
8509 load the entire file into a buffer and process it there.
8510
8511 @end table
8512
8513
8514 @node Getting Mail
8515 @section Getting Mail
8516 @cindex reading mail
8517 @cindex mail
8518
8519 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8520 course.
8521
8522 @menu
8523 * Getting Started Reading Mail:: A simple cookbook example.
8524 * Splitting Mail::               How to create mail groups.
8525 * Mail Backend Variables::       Variables for customizing mail handling.
8526 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8527 * Mail and Procmail::            Reading mail groups that procmail create.
8528 * Incorporating Old Mail::       What about the old mail you have?
8529 * Expiring Mail::                Getting rid of unwanted mail.
8530 * Washing Mail::                 Removing gruft from the mail you get.
8531 * Duplicates::                   Dealing with duplicated mail.
8532 * Not Reading Mail::             Using mail backends for reading other files.
8533 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8534 @end menu
8535
8536
8537 @node Getting Started Reading Mail
8538 @subsection Getting Started Reading Mail
8539
8540 It's quite easy to use Gnus to read your new mail.  You just plonk the
8541 mail backend of your choice into @code{gnus-secondary-select-methods},
8542 and things will happen automatically.
8543
8544 For instance, if you want to use @code{nnml} (which is a one file per
8545 mail backend), you could put the following in your @file{.gnus} file:
8546
8547 @lisp
8548 (setq gnus-secondary-select-methods
8549       '((nnml "private")))
8550 @end lisp
8551
8552 Now, the next time you start Gnus, this backend will be queried for new
8553 articles, and it will move all the messages in your spool file to its
8554 directory, which is @code{~/Mail/} by default.  The new group that will
8555 be created (@samp{mail.misc}) will be subscribed, and you can read it
8556 like any other group.
8557
8558 You will probably want to split the mail into several groups, though:
8559
8560 @lisp
8561 (setq nnmail-split-methods
8562       '(("junk" "^From:.*Lars Ingebrigtsen")
8563        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8564        ("other" "")))
8565 @end lisp
8566
8567 This will result in three new @code{nnml} mail groups being created:
8568 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8569 mail that doesn't fit into the first two groups will be placed in the
8570 latter group.
8571
8572 This should be sufficient for reading mail with Gnus.  You might want to
8573 give the other sections in this part of the manual a perusal, though,
8574 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8575
8576
8577 @node Splitting Mail
8578 @subsection Splitting Mail
8579 @cindex splitting mail
8580 @cindex mail splitting
8581
8582 @vindex nnmail-split-methods
8583 The @code{nnmail-split-methods} variable says how the incoming mail is
8584 to be split into groups.
8585
8586 @lisp
8587 (setq nnmail-split-methods
8588   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8589     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8590     ("mail.other" "")))
8591 @end lisp
8592
8593 This variable is a list of lists, where the first element of each of
8594 these lists is the name of the mail group (they do not have to be called
8595 something beginning with @samp{mail}, by the way), and the second
8596 element is a regular expression used on the header of each mail to
8597 determine if it belongs in this mail group.
8598
8599 If the first element is the special symbol @code{junk}, then messages
8600 that match the regexp will disappear into the aether.  Use with
8601 extreme caution. 
8602
8603 The second element can also be a function.  In that case, it will be
8604 called narrowed to the headers with the first element of the rule as the
8605 argument.  It should return a non-@code{nil} value if it thinks that the
8606 mail belongs in that group.
8607
8608 The last of these groups should always be a general one, and the regular
8609 expression should @emph{always} be @samp{} so that it matches any
8610 mails that haven't been matched by any of the other regexps.
8611
8612 If you like to tinker with this yourself, you can set this variable to a
8613 function of your choice.  This function will be called without any
8614 arguments in a buffer narrowed to the headers of an incoming mail
8615 message.  The function should return a list of groups names that it
8616 thinks should carry this mail message.
8617
8618 Note that the mail backends are free to maul the poor, innocent
8619 incoming headers all they want to.  They all add @code{Lines} headers;
8620 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8621 @code{From<SPACE>} line to something else.
8622
8623 @vindex nnmail-crosspost
8624 The mail backends all support cross-posting.  If several regexps match,
8625 the mail will be ``cross-posted'' to all those groups.
8626 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8627 that no articles are crossposted to the general (@samp{}) group.
8628
8629 @vindex nnmail-crosspost-link-function
8630 @cindex crosspost
8631 @cindex links
8632 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8633 the crossposted articles.  However, not all files systems support hard
8634 links.  If that's the case for you, set
8635 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8636 variable is @code{add-name-to-file} by default.)  
8637
8638 @kindex M-x nnmail-split-history
8639 @kindex nnmail-split-history
8640 If you wish to see where the previous mail split put the messages, you
8641 can use the @kbd{M-x nnmail-split-history} command.
8642
8643 Gnus gives you all the opportunity you could possibly want for shooting
8644 yourself in the foot.  Let's say you create a group that will contain
8645 all the mail you get from your boss.  And then you accidentally
8646 unsubscribe from the group.  Gnus will still put all the mail from your
8647 boss in the unsubscribed group, and so, when your boss mails you ``Have
8648 that report ready by Monday or you're fired!'', you'll never see it and,
8649 come Tuesday, you'll still believe that you're gainfully employed while
8650 you really should be out collecting empty bottles to save up for next
8651 month's rent money.
8652
8653
8654 @node Mail Backend Variables
8655 @subsection Mail Backend Variables
8656
8657 These variables are (for the most part) pertinent to all the various
8658 mail backends.
8659
8660 @table @code
8661 @vindex nnmail-read-incoming-hook
8662 @item nnmail-read-incoming-hook
8663 The mail backends all call this hook after reading new mail.  You can
8664 use this hook to notify any mail watch programs, if you want to.
8665
8666 @vindex nnmail-spool-file
8667 @item nnmail-spool-file
8668 @cindex POP mail
8669 @cindex MAILHOST
8670 @cindex movemail
8671 @vindex nnmail-pop-password
8672 @vindex nnmail-pop-password-required
8673 The backends will look for new mail in this file.  If this variable is
8674 @code{nil}, the mail backends will never attempt to fetch mail by
8675 themselves.  If you are using a POP mail server and your name is
8676 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8677 your name is not @samp{larsi}, you should probably modify that
8678 slightly, but you may have guessed that already, you smart & handsome
8679 devil!  You can also set this variable to @code{pop}, and Gnus will try
8680 to figure out the POP mail string by itself.  In any case, Gnus will
8681 call @code{movemail} which will contact the POP server named in the
8682 @code{MAILHOST} environment variable.  If the POP server needs a
8683 password, you can either set @code{nnmail-pop-password-required} to
8684 @code{t} and be prompted for the password, or set
8685 @code{nnmail-pop-password} to the password itself.
8686
8687 Your Emacs has to have been configured with @samp{--with-pop} before
8688 compilation.  This is the default, but some installations have it
8689 switched off.
8690
8691 When you use a mail backend, Gnus will slurp all your mail from your
8692 inbox and plonk it down in your home directory.  Gnus doesn't move any
8693 mail if you're not using a mail backend---you have to do a lot of magic
8694 invocations first.  At the time when you have finished drawing the
8695 pentagram, lightened the candles, and sacrificed the goat, you really
8696 shouldn't be too surprised when Gnus moves your mail.
8697
8698 @vindex nnmail-use-procmail
8699 @vindex nnmail-procmail-suffix
8700 @item nnmail-use-procmail
8701 If non-@code{nil}, the mail backends will look in
8702 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8703 that directory that have names ending in @code{nnmail-procmail-suffix}
8704 will be considered incoming mailboxes, and will be searched for new
8705 mail.
8706
8707 @vindex nnmail-crash-box
8708 @item nnmail-crash-box
8709 When the mail backends read a spool file, it is first moved to this
8710 file, which is @file{~/.gnus-crash-box} by default.  If this file
8711 already exists, it will always be read (and incorporated) before any
8712 other spool files.
8713
8714 @vindex nnmail-prepare-incoming-hook
8715 @item nnmail-prepare-incoming-hook
8716 This is run in a buffer that holds all the new incoming mail, and can be
8717 used for, well, anything, really.
8718
8719 @vindex nnmail-split-hook
8720 @item nnmail-split-hook
8721 @findex article-decode-rfc1522
8722 @findex RFC1522 decoding
8723 Hook run in the buffer where the mail headers of each message is kept
8724 just before the splitting based on these headers is done.  The hook is
8725 free to modify the buffer contents in any way it sees fit---the buffer
8726 is discarded after the splitting has been done, and no changes performed
8727 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
8728 is one likely function to add to this hook.
8729
8730 @vindex nnmail-pre-get-new-mail-hook
8731 @vindex nnmail-post-get-new-mail-hook
8732 @item nnmail-pre-get-new-mail-hook
8733 @itemx nnmail-post-get-new-mail-hook
8734 These are two useful hooks executed when treating new incoming
8735 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8736 starting to handle the new mail) and
8737 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8738 is done).  Here's and example of using these two hooks to change the
8739 default file modes the new mail files get:
8740
8741 @lisp
8742 (add-hook 'gnus-pre-get-new-mail-hook 
8743           (lambda () (set-default-file-modes 511)))
8744
8745 (add-hook 'gnus-post-get-new-mail-hook 
8746           (lambda () (set-default-file-modes 551)))
8747 @end lisp
8748
8749 @item nnmail-tmp-directory
8750 @vindex nnmail-tmp-directory
8751 This variable says where to move the incoming mail to while processing
8752 it.  This is usually done in the same directory that the mail backend
8753 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8754 it will be used instead.
8755
8756 @item nnmail-movemail-program
8757 @vindex nnmail-movemail-program
8758 This program is executed to move mail from the user's inbox to her home
8759 directory.  The default is @samp{movemail}.
8760
8761 This can also be a function.  In that case, the function will be called
8762 with two parameters -- the name of the inbox, and the file to be moved
8763 to.
8764
8765 @item nnmail-delete-incoming
8766 @vindex nnmail-delete-incoming
8767 @cindex incoming mail files
8768 @cindex deleting incoming files
8769 If non-@code{nil}, the mail backends will delete the temporary incoming
8770 file after splitting mail into the proper groups.  This is @code{nil} by
8771 default for reasons of security.
8772
8773 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8774 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8775 lost mail, I think, but that's not the point.  (Except certain versions
8776 of Red Gnus.))  By not deleting the Incoming* files, one can be sure to
8777 not lose mail -- if Gnus totally whacks out, one can always recover what
8778 was lost.
8779
8780 Delete the @file{Incoming*} files at will.
8781
8782 @item nnmail-use-long-file-names
8783 @vindex nnmail-use-long-file-names
8784 If non-@code{nil}, the mail backends will use long file and directory
8785 names.  Groups like @samp{mail.misc} will end up in directories like
8786 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8787 @file{mail/misc/}.
8788
8789 @item nnmail-delete-file-function
8790 @vindex nnmail-delete-file-function
8791 @findex delete-file
8792 Function called to delete files.  It is @code{delete-file} by default. 
8793
8794 @end table
8795
8796
8797 @node Fancy Mail Splitting
8798 @subsection Fancy Mail Splitting
8799 @cindex mail splitting
8800 @cindex fancy mail splitting
8801
8802 @vindex nnmail-split-fancy
8803 @findex nnmail-split-fancy
8804 If the rather simple, standard method for specifying how to split mail
8805 doesn't allow you to do what you want, you can set
8806 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8807 play with the @code{nnmail-split-fancy} variable.
8808
8809 Let's look at an example value of this variable first:
8810
8811 @lisp
8812 ;; Messages from the mailer daemon are not crossposted to any of
8813 ;; the ordinary groups.  Warnings are put in a separate group
8814 ;; from real errors.
8815 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8816                    "mail.misc"))
8817    ;; Non-error messages are crossposted to all relevant
8818    ;; groups, but we don't crosspost between the group for the
8819    ;; (ding) list and the group for other (ding) related mail.
8820    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8821          ("subject" "ding" "ding.misc"))
8822       ;; Other mailing lists...
8823       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8824       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8825       ;; People...
8826       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8827    ;; Unmatched mail goes to the catch all group.
8828    "misc.misc")
8829 @end lisp
8830
8831 This variable has the format of a @dfn{split}.  A split is a (possibly)
8832 recursive structure where each split may contain other splits.  Here are
8833 the five possible split syntaxes:
8834
8835 @enumerate
8836
8837 @item 
8838 @samp{group}: If the split is a string, that will be taken as a group name. 
8839
8840 @item
8841 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8842 element is a string, then that means that if header FIELD (a regexp)
8843 contains VALUE (also a regexp), then store the message as specified by
8844 SPLIT.
8845
8846 @item
8847 @var{(| SPLIT...)}: If the split is a list, and the first element is
8848 @code{|} (vertical bar), then process each SPLIT until one of them
8849 matches.  A SPLIT is said to match if it will cause the mail message to
8850 be stored in one or more groups.
8851
8852 @item
8853 @var{(& SPLIT...)}: If the split is a list, and the first element is
8854 @code{&}, then process all SPLITs in the list.
8855
8856 @item 
8857 @code{junk}: If the split is the symbol @code{junk}, then don't save
8858 this message anywhere.
8859
8860 @item
8861 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
8862 element is @code{:}, then the second element will be called as a
8863 function with @var{args} given as arguments.  The function should return
8864 a SPLIT.
8865
8866 @end enumerate
8867
8868 In these splits, @var{FIELD} must match a complete field name.
8869 @var{VALUE} must match a complete word according to the fundamental mode
8870 syntax table.  You can use @code{.*} in the regexps to match partial
8871 field names or words.  In other words, all @var{VALUE}'s are wrapped in
8872 @samp{\<} and @samp{\>} pairs.
8873
8874 @vindex nnmail-split-abbrev-alist
8875 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8876 are expanded as specified by the variable
8877 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
8878 the car of the cells contains the key, and the cdr contains a string.
8879
8880 @vindex nnmail-split-fancy-syntax-table
8881 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8882 when all this splitting is performed.
8883
8884 If you want to have Gnus create groups dynamically based on some
8885 information in the headers, you can say things like:
8886
8887 @example
8888 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8889 @end example
8890
8891 That is, do @code{replace-match}-like substitions in the group names. 
8892
8893
8894 @node Mail and Procmail
8895 @subsection Mail and Procmail
8896 @cindex procmail
8897
8898 @cindex slocal
8899 @cindex elm
8900 Many people use @code{procmail} (or some other mail filter program or
8901 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8902 incoming mail into groups.  If you do that, you should set
8903 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8904 backends never ever try to fetch mail by themselves.
8905
8906 This also means that you probably don't want to set
8907 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8908 side effects.
8909
8910 When a mail backend is queried for what groups it carries, it replies
8911 with the contents of that variable, along with any groups it has figured
8912 out that it carries by other means.  None of the backends (except
8913 @code{nnmh}) actually go out to the disk and check what groups actually
8914 exist.  (It's not trivial to distinguish between what the user thinks is
8915 a basis for a newsgroup and what is just a plain old file or directory.)
8916
8917 This means that you have to tell Gnus (and the backends) what groups
8918 exist by hand.
8919
8920 Let's take the @code{nnmh} backend as an example. 
8921
8922 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8923 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8924
8925 Go to the group buffer and type @kbd{G m}.  When prompted, answer
8926 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
8927 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
8928 to include all your mail groups.
8929
8930 That's it.  You are now set to read your mail.  An active file for this
8931 method will be created automatically.
8932
8933 @vindex nnmail-procmail-suffix
8934 @vindex nnmail-procmail-directory
8935 If you use @code{nnfolder} or any other backend that store more than a
8936 single article in each file, you should never have procmail add mails to
8937 the file that Gnus sees.  Instead, procmail should put all incoming mail
8938 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
8939 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
8940 name.  The mail backends will read the mail from these files.
8941
8942 @vindex nnmail-resplit-incoming
8943 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
8944 put in the @code{mail.misc}, as one would expect.  However, if you want
8945 Gnus to split the mail the normal way, you could set
8946 @code{nnmail-resplit-incoming} to @code{t}.
8947
8948 @vindex nnmail-keep-last-article
8949 If you use @code{procmail} to split things directory into an @code{nnmh}
8950 directory (which you shouldn't do), you should set
8951 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
8952 ever expiring the final article in a mail newsgroup.  This is quite,
8953 quite important.
8954
8955 Here's an example setup:  The incoming spools are located in
8956 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
8957 spool files have the same names as the equivalent groups).  The
8958 @code{nnfolder} backend is to be used as the mail interface, and the
8959 @code{nnfolder} directory is @file{~/fMail/}.
8960
8961 @lisp
8962 (setq nnfolder-directory "~/fMail/")
8963 (setq nnmail-spool-file 'procmail)
8964 (setq nnmail-procmail-directory "~/incoming/")
8965 (setq gnus-secondary-select-methods '((nnfolder "")))
8966 (setq nnmail-procmail-suffix "")
8967 @end lisp
8968
8969
8970 @node Incorporating Old Mail
8971 @subsection Incorporating Old Mail
8972
8973 Most people have lots of old mail stored in various file formats.  If
8974 you have set up Gnus to read mail using one of the spiffy Gnus mail
8975 backends, you'll probably wish to have that old mail incorporated into
8976 your mail groups.
8977
8978 Doing so can be quite easy.
8979
8980 To take an example: You're reading mail using @code{nnml}
8981 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
8982 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
8983 file filled with important, but old, mail.  You want to move it into
8984 your @code{nnml} groups.
8985
8986 Here's how:
8987
8988 @enumerate
8989 @item
8990 Go to the group buffer.
8991
8992 @item 
8993 Type `G f' and give the path of the mbox file when prompted to create an
8994 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
8995
8996 @item 
8997 Type `SPACE' to enter the newly created group.
8998
8999 @item
9000 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9001 Process Marks}).
9002
9003 @item 
9004 Type `B r' to respool all the process-marked articles, and answer
9005 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9006 @end enumerate
9007
9008 All the mail messages in the mbox file will now also be spread out over
9009 all your @code{nnml} groups.  Try entering them and check whether things
9010 have gone without a glitch.  If things look ok, you may consider
9011 deleting the mbox file, but I wouldn't do that unless I was absolutely
9012 sure that all the mail has ended up where it should be.
9013
9014 Respooling is also a handy thing to do if you're switching from one mail
9015 backend to another.  Just respool all the mail in the old mail groups
9016 using the new mail backend.
9017
9018
9019 @node Expiring Mail
9020 @subsection Expiring Mail
9021 @cindex article expiry
9022
9023 Traditional mail readers have a tendency to remove mail articles when
9024 you mark them as read, in some way.  Gnus takes a fundamentally
9025 different approach to mail reading.
9026
9027 Gnus basically considers mail just to be news that has been received in
9028 a rather peculiar manner.  It does not think that it has the power to
9029 actually change the mail, or delete any mail messages.  If you enter a
9030 mail group, and mark articles as ``read'', or kill them in some other
9031 fashion, the mail articles will still exist on the system.  I repeat:
9032 Gnus will not delete your old, read mail.  Unless you ask it to, of
9033 course.
9034
9035 To make Gnus get rid of your unwanted mail, you have to mark the
9036 articles as @dfn{expirable}.  This does not mean that the articles will
9037 disappear right away, however.  In general, a mail article will be
9038 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9039 more than one week old.  If you do not mark an article as expirable, it
9040 will remain on your system until hell freezes over.  This bears
9041 repeating one more time, with some spurious capitalizations: IF you do
9042 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9043
9044 @vindex gnus-auto-expirable-newsgroups
9045 You do not have to mark articles as expirable by hand.  Groups that
9046 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9047 have all articles that you read marked as expirable automatically.  All
9048 articles that are marked as expirable have an @samp{E} in the first
9049 column in the summary buffer.
9050
9051 Note that making a group auto-expirable don't mean that all read
9052 articles are expired---only the articles that are marked as expirable
9053 will be expired.  Also note the using the @kbd{d} command won't make
9054 groups expirable---only semi-automatic marking of articles as read will
9055 mark the articles as expirable in auto-expirable groups.
9056
9057 Let's say you subscribe to a couple of mailing lists, and you want the
9058 articles you have read to disappear after a while:
9059
9060 @lisp
9061 (setq gnus-auto-expirable-newsgroups 
9062       "mail.nonsense-list\\|mail.nice-list")
9063 @end lisp
9064
9065 Another way to have auto-expiry happen is to have the element
9066 @code{auto-expire} in the group parameters of the group. 
9067
9068 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9069 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9070 doesn't really mix very well.  
9071
9072 @vindex nnmail-expiry-wait
9073 The @code{nnmail-expiry-wait} variable supplies the default time an
9074 expirable article has to live.  The default is seven days.  
9075
9076 Gnus also supplies a function that lets you fine-tune how long articles
9077 are to live, based on what group they are in.  Let's say you want to
9078 have one month expiry period in the @samp{mail.private} group, a one day
9079 expiry period in the @samp{mail.junk} group, and a six day expiry period
9080 everywhere else:
9081
9082 @vindex nnmail-expiry-wait-function
9083 @lisp
9084 (setq nnmail-expiry-wait-function
9085       (lambda (group)
9086        (cond ((string= group "mail.private")
9087                31)
9088              ((string= group "mail.junk")
9089                1)
9090              ((string= group "important")
9091                'never)
9092              (t
9093                6))))
9094 @end lisp
9095
9096 The group names that this function is fed are ``unadorned'' group
9097 names---no @samp{nnml:} prefixes and the like.
9098
9099 The @code{nnmail-expiry-wait} variable and
9100 @code{nnmail-expiry-wait-function} function can be either a number (not
9101 necessarily an integer) or the symbols @code{immediate} or
9102 @code{never}.  
9103
9104 You can also use the @code{expiry-wait} group parameter to selectively
9105 change the expiry period (@pxref{Group Parameters}).
9106
9107 @vindex nnmail-keep-last-article
9108 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9109 expire the final article in a mail newsgroup.  This is to make life
9110 easier for procmail users.
9111
9112 @vindex gnus-total-expirable-newsgroups
9113 By the way, that line up there about Gnus never expiring non-expirable
9114 articles is a lie.  If you put @code{total-expire} in the group
9115 parameters, articles will not be marked as expirable, but all read
9116 articles will be put through the expiry process.  Use with extreme
9117 caution.  Even more dangerous is the
9118 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9119 this regexp will have all read articles put through the expiry process,
9120 which means that @emph{all} old mail articles in the groups in question
9121 will be deleted after a while.  Use with extreme caution, and don't come
9122 crying to me when you discover that the regexp you used matched the
9123 wrong group and all your important mail has disappeared.  Be a
9124 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9125 with!  So there!
9126
9127 Most people make most of their mail groups total-expirable, though. 
9128
9129
9130 @node Washing Mail
9131 @subsection Washing Mail
9132 @cindex mail washing
9133 @cindex list server brain damage
9134 @cindex incoming mail treatment
9135
9136 Mailers and list servers are notorious for doing all sorts of really,
9137 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9138 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9139 end of all lines passing through our server, so let's do that!!!!1!''
9140 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9141 considered to be self-evident were not discussed.  So.  Here we are.
9142
9143 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9144 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9145 be shocked and dismayed by this, but I haven't got the energy.  It is to
9146 laugh.
9147
9148 Gnus provides a plethora of functions for washing articles while
9149 displaying them, but it might be nicer to do the filtering before
9150 storing the mail to disc.  For that purpose, we have three hooks and
9151 various functions that can be put in these hooks.
9152
9153 @table @code
9154 @item nnmail-prepare-incoming-hook
9155 @vindex nnmail-prepare-incoming-hook
9156 This hook is called before doing anything with the mail and is meant for
9157 grand, sweeping gestures.  Functions to be used include:
9158
9159 @table @code
9160 @item nnheader-ms-strip-cr
9161 @findex nnheader-ms-strip-cr
9162 Remove trailing carriage returns from each line.  This is default on
9163 Emacs running on MS machines.
9164
9165 @end table
9166
9167 @item nnmail-prepare-incoming-header-hook
9168 @vindex nnmail-prepare-incoming-header-hook
9169 This hook is called narrowed to each header.  It can be used when
9170 cleaning up the headers.  Functions that can be used include:
9171
9172 @table @code
9173 @item nnmail-remove-leading-whitespace
9174 @findex nnmail-remove-leading-whitespace
9175 Clear leading white space that ``helpful'' listservs have added to the
9176 headers too make them look nice.  Aaah.  
9177
9178 @item nnmail-remove-list-identifiers
9179 @findex nnmail-remove-list-identifiers
9180 Some list servers add an identifier---for example, @samp{(idm)}---to the
9181 beginning of all @code{Subject} headers.  I'm sure that's nice for
9182 people who use stone age mail readers.  This function will remove
9183 strings that match the @code{nnmail-list-identifiers} regexp, which can
9184 also be a list of regexp.
9185
9186 For instance, if you want to remove the @samp{(idm)} and the
9187 @samp{nagnagnag} identifiers:
9188
9189 @lisp
9190 (setq nnmail-list-identifiers
9191       '("(idm)" "nagnagnag"))
9192 @end lisp
9193
9194 @item nnmail-remove-tabs
9195 @findex nnmail-remove-tabs
9196 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9197
9198 @end table
9199
9200 @item nnmail-prepare-incoming-message-hook
9201 @vindex nnmail-prepare-incoming-message-hook
9202 This hook is called narrowed to each message.  Functions to be used
9203 include: 
9204
9205 @table @code
9206 @item article-de-quoted-unreadable
9207 @findex article-de-quoted-unreadable
9208 Decode Quoted Readable encoding.
9209
9210 @end table
9211 @end table
9212
9213
9214 @node Duplicates
9215 @subsection Duplicates
9216
9217 @vindex nnmail-treat-duplicates
9218 @vindex nnmail-message-id-cache-length
9219 @vindex nnmail-message-id-cache-file
9220 @cindex duplicate mails
9221 If you are a member of a couple of mailing list, you will sometime
9222 receive two copies of the same mail.  This can be quite annoying, so
9223 @code{nnmail} checks for and treats any duplicates it might find.  To do
9224 this, it keeps a cache of old @code{Message-ID}s---
9225 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9226 default.  The approximate maximum number of @code{Message-ID}s stored
9227 there is controlled by the @code{nnmail-message-id-cache-length}
9228 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9229 stored.) If all this sounds scary to you, you can set
9230 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9231 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9232 will generate a brand new @code{Message-ID} for the mail and insert a
9233 warning into the head of the mail saying that it thinks that this is a
9234 duplicate of a different message.  
9235
9236 This variable can also be a function.  If that's the case, the function
9237 will be called from a buffer narrowed to the message in question with
9238 the @code{Message-ID} as a parameter.  The function must return either
9239 @code{nil}, @code{warn}, or @code{delete}.
9240
9241 You can turn this feature off completely by setting the variable to
9242 @code{nil}.
9243
9244 If you want all the duplicate mails to be put into a special
9245 @dfn{duplicates} group, you could do that using the normal mail split
9246 methods:
9247
9248 @lisp
9249 (setq nnmail-split-fancy
9250       '(| ;; Messages duplicates go to a separate group.
9251           ("gnus-warning" "duplication of message" "duplicate")
9252           ;; Message from daemons, postmaster, and the like to another.
9253           (any mail "mail.misc")
9254           ;; Other rules.
9255           [ ... ] ))
9256 @end lisp
9257
9258 Or something like:
9259 @lisp
9260 (setq nnmail-split-methods 
9261       '(("duplicates" "^Gnus-Warning:")
9262         ;; Other rules.
9263         [...]))
9264 @end lisp
9265
9266 Here's a neat feature: If you know that the recipient reads her mail
9267 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9268 @code{delete}, you can send her as many insults as you like, just by
9269 using a @code{Message-ID} of a mail that you know that she's already
9270 received.  Think of all the fun!  She'll never see any of it!  Whee!
9271
9272
9273 @node Not Reading Mail
9274 @subsection Not Reading Mail
9275
9276 If you start using any of the mail backends, they have the annoying
9277 habit of assuming that you want to read mail with them.  This might not
9278 be unreasonable, but it might not be what you want.
9279
9280 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9281 will ever attempt to read incoming mail, which should help.
9282
9283 @vindex nnbabyl-get-new-mail
9284 @vindex nnmbox-get-new-mail
9285 @vindex nnml-get-new-mail
9286 @vindex nnmh-get-new-mail
9287 @vindex nnfolder-get-new-mail
9288 This might be too much, if, for instance, you are reading mail quite
9289 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9290 file you have stashed away with @code{nnbabyl}.  All backends have
9291 variables called backend-@code{get-new-mail}.  If you want to disable
9292 the @code{nnbabyl} mail reading, you edit the virtual server for the
9293 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9294
9295 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9296 narrowed to the article to be saved before saving it when reading
9297 incoming mail.
9298
9299
9300 @node Choosing a Mail Backend
9301 @subsection Choosing a Mail Backend
9302
9303 Gnus will read the mail spool when you activate a mail group.  The mail
9304 file is first copied to your home directory.  What happens after that
9305 depends on what format you want to store your mail in.
9306
9307 @menu
9308 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9309 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9310 * Mail Spool::                  Store your mail in a private spool?
9311 * MH Spool::                    An mhspool-like backend.
9312 * Mail Folders::                Having one file for each group.
9313 @end menu
9314
9315
9316 @node Unix Mail Box
9317 @subsubsection Unix Mail Box
9318 @cindex nnmbox
9319 @cindex unix mail box
9320
9321 @vindex nnmbox-active-file
9322 @vindex nnmbox-mbox-file
9323 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9324 mail.  @code{nnmbox} will add extra headers to each mail article to say
9325 which group it belongs in.
9326
9327 Virtual server settings:
9328
9329 @table @code
9330 @item nnmbox-mbox-file
9331 @vindex nnmbox-mbox-file
9332 The name of the mail box in the user's home directory. 
9333
9334 @item nnmbox-active-file
9335 @vindex nnmbox-active-file
9336 The name of the active file for the mail box.
9337
9338 @item nnmbox-get-new-mail
9339 @vindex nnmbox-get-new-mail
9340 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9341 into groups.
9342 @end table
9343
9344
9345 @node Rmail Babyl
9346 @subsubsection Rmail Babyl
9347 @cindex nnbabyl
9348 @cindex rmail mbox
9349
9350 @vindex nnbabyl-active-file
9351 @vindex nnbabyl-mbox-file
9352 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9353 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9354 article to say which group it belongs in.
9355
9356 Virtual server settings:
9357
9358 @table @code
9359 @item nnbabyl-mbox-file
9360 @vindex nnbabyl-mbox-file
9361 The name of the rmail mbox file.
9362
9363 @item nnbabyl-active-file
9364 @vindex nnbabyl-active-file
9365 The name of the active file for the rmail box.
9366
9367 @item nnbabyl-get-new-mail
9368 @vindex nnbabyl-get-new-mail
9369 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9370 @end table
9371
9372
9373 @node Mail Spool
9374 @subsubsection Mail Spool
9375 @cindex nnml
9376 @cindex mail @sc{nov} spool
9377
9378 The @dfn{nnml} spool mail format isn't compatible with any other known
9379 format.  It should be used with some caution.
9380
9381 @vindex nnml-directory
9382 If you use this backend, Gnus will split all incoming mail into files;
9383 one file for each mail, and put the articles into the correct
9384 directories under the directory specified by the @code{nnml-directory}
9385 variable.  The default value is @file{~/Mail/}.
9386
9387 You do not have to create any directories beforehand; Gnus will take
9388 care of all that.
9389
9390 If you have a strict limit as to how many files you are allowed to store
9391 in your account, you should not use this backend.  As each mail gets its
9392 own file, you might very well occupy thousands of inodes within a few
9393 weeks.  If this is no problem for you, and it isn't a problem for you
9394 having your friendly systems administrator walking around, madly,
9395 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9396 know that this is probably the fastest format to use.  You do not have
9397 to trudge through a big mbox file just to read your new mail.
9398
9399 @code{nnml} is probably the slowest backend when it comes to article
9400 splitting.  It has to create lots of files, and it also generates
9401 @sc{nov} databases for the incoming mails.  This makes is the fastest
9402 backend when it comes to reading mail.
9403
9404 Virtual server settings:
9405
9406 @table @code
9407 @item nnml-directory
9408 @vindex nnml-directory
9409 All @code{nnml} directories will be placed under this directory. 
9410
9411 @item nnml-active-file
9412 @vindex nnml-active-file
9413 The active file for the @code{nnml} server.
9414
9415 @item nnml-newsgroups-file
9416 @vindex nnml-newsgroups-file
9417 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9418 Format}. 
9419
9420 @item nnml-get-new-mail
9421 @vindex nnml-get-new-mail
9422 If non-@code{nil}, @code{nnml} will read incoming mail.
9423
9424 @item nnml-nov-is-evil
9425 @vindex nnml-nov-is-evil
9426 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9427
9428 @item nnml-nov-file-name
9429 @vindex nnml-nov-file-name
9430 The name of the @sc{nov} files.  The default is @file{.overview}. 
9431
9432 @item nnml-prepare-save-mail-hook
9433 @vindex nnml-prepare-save-mail-hook
9434 Hook run narrowed to an article before saving.
9435
9436 @end table
9437
9438 @findex nnml-generate-nov-databases
9439 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9440 you can do a complete update by typing @kbd{M-x
9441 nnml-generate-nov-databases}.  This command will trawl through the
9442 entire @code{nnml} hierarchy, looking at each and every article, so it
9443 might take a while to complete.  A better interface to this
9444 functionality can be found in the server buffer (@pxref{Server
9445 Commands}). 
9446
9447
9448 @node MH Spool
9449 @subsubsection MH Spool
9450 @cindex nnmh
9451 @cindex mh-e mail spool
9452
9453 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9454 @sc{nov} databases and it doesn't keep an active file.  This makes
9455 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9456 makes it easier to write procmail scripts for.
9457
9458 Virtual server settings:
9459
9460 @table @code
9461 @item nnmh-directory
9462 @vindex nnmh-directory
9463 All @code{nnmh} directories will be located under this directory.
9464
9465 @item nnmh-get-new-mail
9466 @vindex nnmh-get-new-mail
9467 If non-@code{nil}, @code{nnmh} will read incoming mail.
9468
9469 @item nnmh-be-safe
9470 @vindex nnmh-be-safe
9471 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9472 sure that the articles in the folder are actually what Gnus thinks they
9473 are.  It will check date stamps and stat everything in sight, so
9474 setting this to @code{t} will mean a serious slow-down.  If you never
9475 use anything but Gnus to read the @code{nnmh} articles, you do not have
9476 to set this variable to @code{t}.
9477 @end table
9478
9479
9480 @node Mail Folders
9481 @subsubsection Mail Folders
9482 @cindex nnfolder
9483 @cindex mbox folders
9484 @cindex mail folders
9485
9486 @code{nnfolder} is a backend for storing each mail group in a separate
9487 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9488 will add extra headers to keep track of article numbers and arrival
9489 dates.
9490
9491 Virtual server settings:
9492
9493 @table @code
9494 @item nnfolder-directory
9495 @vindex nnfolder-directory
9496 All the @code{nnfolder} mail boxes will be stored under this directory. 
9497
9498 @item nnfolder-active-file
9499 @vindex nnfolder-active-file
9500 The name of the active file.
9501
9502 @item nnfolder-newsgroups-file
9503 @vindex nnfolder-newsgroups-file
9504 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9505
9506 @item nnfolder-get-new-mail
9507 @vindex nnfolder-get-new-mail
9508 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9509 @end table
9510
9511 @findex nnfolder-generate-active-file
9512 @kindex M-x nnfolder-generate-active-file
9513 If you have lots of @code{nnfolder}-like files you'd like to read with
9514 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9515 command to make @code{nnfolder} aware of all likely files in
9516 @code{nnfolder-directory}.
9517
9518
9519 @node Other Sources
9520 @section Other Sources
9521
9522 Gnus can do more than just read news or mail.  The methods described
9523 below allow Gnus to view directories and files as if they were
9524 newsgroups.
9525
9526 @menu
9527 * Directory Groups::      You can read a directory as if it was a newsgroup.
9528 * Anything Groups::       Dired?  Who needs dired?
9529 * Document Groups::       Single files can be the basis of a group.
9530 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9531 * Web Searches::          Creating groups from articles that match a string.
9532 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9533 @end menu
9534
9535
9536 @node Directory Groups
9537 @subsection Directory Groups
9538 @cindex nndir
9539 @cindex directory groups
9540
9541 If you have a directory that has lots of articles in separate files in
9542 it, you might treat it as a newsgroup.  The files have to have numerical
9543 names, of course.
9544
9545 This might be an opportune moment to mention @code{ange-ftp}, that most
9546 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9547 didn't think much about it---a backend to read directories.  Big deal.
9548
9549 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9550 enter the @code{ange-ftp} file name
9551 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9552 @code{ange-ftp} will actually allow you to read this directory over at
9553 @samp{sina} as a newsgroup.  Distributed news ahoy!
9554
9555 @code{nndir} will use @sc{nov} files if they are present.
9556
9557 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9558 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9559 whatever you use @code{nndir} for, so you could switch to any of those
9560 methods if you feel the need to have a non-read-only @code{nndir}.
9561
9562
9563 @node Anything Groups
9564 @subsection Anything Groups
9565 @cindex nneething
9566
9567 From the @code{nndir} backend (which reads a single spool-like
9568 directory), it's just a hop and a skip to @code{nneething}, which
9569 pretends that any arbitrary directory is a newsgroup.  Strange, but
9570 true.
9571
9572 When @code{nneething} is presented with a directory, it will scan this
9573 directory and assign article numbers to each file.  When you enter such
9574 a group, @code{nneething} must create ``headers'' that Gnus can use.
9575 After all, Gnus is a newsreader, in case you're
9576 forgetting. @code{nneething} does this in a two-step process.  First, it
9577 snoops each file in question.  If the file looks like an article (i.e.,
9578 the first few lines look like headers), it will use this as the head.
9579 If this is just some arbitrary file without a head (e.g. a C source
9580 file), @code{nneething} will cobble up a header out of thin air.  It
9581 will use file ownership, name and date and do whatever it can with these
9582 elements.
9583
9584 All this should happen automatically for you, and you will be presented
9585 with something that looks very much like a newsgroup.  Totally like a
9586 newsgroup, to be precise.  If you select an article, it will be displayed
9587 in the article buffer, just as usual.
9588
9589 If you select a line that represents a directory, Gnus will pop you into
9590 a new summary buffer for this @code{nneething} group.  And so on.  You can
9591 traverse the entire disk this way, if you feel like, but remember that
9592 Gnus is not dired, really, and does not intend to be, either.
9593
9594 There are two overall modes to this action---ephemeral or solid.  When
9595 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9596 will not store information on what files you have read, and what files
9597 are new, and so on.  If you create a solid @code{nneething} group the
9598 normal way with @kbd{G m}, Gnus will store a mapping table between
9599 article numbers and file names, and you can treat this group like any
9600 other groups.  When you activate a solid @code{nneething} group, you will
9601 be told how many unread articles it contains, etc., etc.
9602
9603 Some variables:
9604
9605 @table @code
9606 @item nneething-map-file-directory
9607 @vindex nneething-map-file-directory
9608 All the mapping files for solid @code{nneething} groups will be stored
9609 in this directory, which defaults to @file{~/.nneething/}.
9610
9611 @item nneething-exclude-files
9612 @vindex nneething-exclude-files
9613 All files that match this regexp will be ignored.  Nice to use to exclude
9614 auto-save files and the like, which is what it does by default.
9615
9616 @item nneething-map-file
9617 @vindex nneething-map-file
9618 Name of the map files.
9619 @end table
9620
9621
9622 @node Document Groups
9623 @subsection Document Groups
9624 @cindex nndoc
9625 @cindex documentation group
9626 @cindex help group
9627
9628 @code{nndoc} is a cute little thing that will let you read a single file
9629 as a newsgroup.  Several files types are supported:
9630
9631 @table @code
9632 @cindex babyl
9633 @cindex rmail mbox
9634
9635 @item babyl
9636 The babyl (rmail) mail box.
9637 @cindex mbox
9638 @cindex Unix mbox
9639
9640 @item mbox
9641 The standard Unix mbox file.
9642
9643 @cindex MMDF mail box
9644 @item mmdf
9645 The MMDF mail box format.
9646
9647 @item news
9648 Several news articles appended into a file.
9649
9650 @item rnews
9651 @cindex rnews batch files
9652 The rnews batch transport format.
9653 @cindex forwarded messages
9654
9655 @item forward
9656 Forwarded articles.
9657
9658 @item mime-digest
9659 @cindex digest
9660 @cindex MIME digest
9661 @cindex 1153 digest
9662 @cindex RFC 1153 digest
9663 @cindex RFC 341 digest
9664 MIME (RFC 1341) digest format.
9665
9666 @item standard-digest
9667 The standard (RFC 1153) digest format.
9668
9669 @item slack-digest
9670 Non-standard digest format---matches most things, but does it badly. 
9671 @end table
9672
9673 You can also use the special ``file type'' @code{guess}, which means
9674 that @code{nndoc} will try to guess what file type it is looking at.
9675 @code{digest} means that @code{nndoc} should guess what digest type the
9676 file is.
9677
9678 @code{nndoc} will not try to change the file or insert any extra headers into
9679 it---it will simply, like, let you use the file as the basis for a
9680 group.  And that's it.
9681
9682 If you have some old archived articles that you want to insert into your
9683 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9684 that.  Say you have an old @file{RMAIL} file with mail that you now want
9685 to split into your new @code{nnml} groups.  You look at that file using
9686 @code{nndoc} (using the @kbd{G f} command in the group buffer
9687 (@pxref{Foreign Groups})), set the process mark on all the articles in
9688 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9689 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9690 file is now also stored in lots of @code{nnml} directories, and you can
9691 delete that pesky @file{RMAIL} file.  If you have the guts!
9692
9693 Virtual server variables:
9694
9695 @table @code
9696 @item nndoc-article-type
9697 @vindex nndoc-article-type
9698 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9699 @code{mmdf}, @code{forward}, @code{news}, @code{rnews},
9700 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
9701
9702 @item nndoc-post-type
9703 @vindex nndoc-post-type
9704 This variable says whether Gnus is to consider the group a news group or
9705 a mail group.  There are two legal values:  @code{mail} (the default)
9706 and @code{news}.
9707 @end table
9708
9709 @menu
9710 * Document Server Internals::   How to add your own document types.
9711 @end menu
9712
9713
9714 @node Document Server Internals
9715 @subsubsection Document Server Internals
9716
9717 Adding new document types to be recognized by @code{nndoc} isn't
9718 difficult.  You just have to whip up a definition of what the document
9719 looks like, write a predicate function to recognize that document type,
9720 and then hook into @code{nndoc}.
9721
9722 First, here's an example document type definition:
9723
9724 @example
9725 (mmdf 
9726  (article-begin .  "^\^A\^A\^A\^A\n")
9727  (body-end .  "^\^A\^A\^A\^A\n"))
9728 @end example
9729
9730 The definition is simply a unique @dfn{name} followed by a series of
9731 regexp pseudo-variable settings.  Below are the possible
9732 variables---don't be daunted by the number of variables; most document
9733 types can be defined with very few settings:
9734
9735 @table @code
9736 @item first-article
9737 If present, @code{nndoc} will skip past all text until it finds
9738 something that match this regexp.  All text before this will be
9739 totally ignored. 
9740
9741 @item article-begin
9742 This setting has to be present in all document type definitions.  It
9743 says what the beginning of each article looks like.
9744
9745 @item head-begin-function
9746 If present, this should be a function that moves point to the head of
9747 the article.
9748
9749 @item nndoc-head-begin
9750 If present, this should be a regexp that matches the head of the
9751 article. 
9752
9753 @item nndoc-head-end
9754 This should match the end of the head of the article.  It defaults to
9755 @samp{^$}---the empty line.
9756
9757 @item body-begin-function
9758 If present, this function should move point to the beginning of the body
9759 of the article.
9760
9761 @item body-begin
9762 This should match the beginning of the body of the article.  It defaults
9763 to @samp{^\n}.
9764
9765 @item body-end-function
9766 If present, this function should move point to the end of the body of
9767 the article.
9768
9769 @item body-end
9770 If present, this should match the end of the body of the article.
9771
9772 @item nndoc-file-end
9773 If present, this should match the end of the file.  All text after this
9774 regexp will be totally ignored. 
9775
9776 @end table
9777
9778 So, using these variables @code{nndoc} is able to dissect a document
9779 file into a series of articles, each with a head and a body.  However, a
9780 few more variables are needed since not all document types are all that
9781 news-like---variables needed to transform the head or the body into
9782 something that's palatable for Gnus:
9783
9784 @table @code
9785 @item prepare-body-function
9786 If present, this function will be called when requesting an article.  It
9787 will be called with point at the start of the body, and is useful if the
9788 document has encoded some parts of its contents. 
9789
9790 @item article-transform-function
9791 If present, this function is called when requesting an article.  It's
9792 meant to be used how more wide-ranging transformation of both head and
9793 body of the article.
9794
9795 @item generate-head-function
9796 If present, this function is called to generate a head that Gnus can
9797 understand.  It is called with the article number as a parameter, and is
9798 expected to generate a nice head for the article in question.  It is
9799 called when requesting the headers of all articles.
9800
9801 @end table
9802
9803 Let's look at the most complicated example I can come up with---standard
9804 digests:
9805
9806 @example
9807 (standard-digest
9808  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9809  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9810  (prepare-body-function . nndoc-unquote-dashes)
9811  (body-end-function . nndoc-digest-body-end)
9812  (head-end . "^ ?$")
9813  (body-begin . "^ ?\n")
9814  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9815  (subtype digest guess))
9816 @end example
9817
9818 We see that all text before a 70-width line of dashes is ignored; all
9819 text after a line that starts with that @samp{^End of} is also ignored;
9820 each article begins with a 30-width line of dashes; the line separating
9821 the head from the body may contain a single space; and that the body is
9822 run through @code{nndoc-unquote-dashes} before being delivered.
9823
9824 To hook your own document definition into @code{nndoc}, use the
9825 @code{nndoc-add-type} function.  It takes two parameters---the first is
9826 the definition itself and the second (optional) parameter says where in
9827 the document type definition alist to put this definition.  The alist is
9828 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9829 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
9830 is of @code{mmdf} type, and so on.  These type predicates should return
9831 @code{nil} if the document is not of the correct type; @code{t} if it is
9832 of the correct type; and a number if the document might be of the
9833 correct type.  A high number means high probability; a low number means
9834 low probability with @samp{0} being the lowest legal number.
9835
9836
9837 @node SOUP
9838 @subsection SOUP
9839 @cindex SOUP
9840 @cindex offline
9841
9842 In the PC world people often talk about ``offline'' newsreaders.  These
9843 are thingies that are combined reader/news transport monstrosities.
9844 With built-in modem programs.  Yecchh!
9845
9846 Of course, us Unix Weenie types of human beans use things like
9847 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9848 transport things like Ghod intended.  And then we just use normal
9849 newsreaders.  
9850
9851 However, it can sometimes be convenient to do something a that's a bit
9852 easier on the brain if you have a very slow modem, and you're not really
9853 that interested in doing things properly.  
9854
9855 A file format called @sc{soup} has been developed for transporting news
9856 and mail from servers to home machines and back again.  It can be a bit
9857 fiddly.
9858
9859 First some terminology:
9860
9861 @table @dfn
9862
9863 @item server
9864 This is the machine that is connected to the outside world and where you
9865 get news and/or mail from.
9866
9867 @item home machine
9868 This is the machine that you want to do the actual reading and responding
9869 on.  It is typically not connected to the rest of the world in any way.
9870
9871 @item packet
9872 Something that contains messages and/or commands.  There are two kinds
9873 of packets:
9874
9875 @table @dfn
9876 @item message packets
9877 These are packets made at the server, and typically contains lots of
9878 messages for you to read.  These are called @file{SoupoutX.tgz} by
9879 default, where @var{X} is a number.
9880
9881 @item response packets
9882 These are packets made at the home machine, and typically contains
9883 replies that you've written.  These are called @file{SoupinX.tgz} by
9884 default, where @var{X} is a number.
9885
9886 @end table
9887
9888 @end table
9889
9890
9891 @enumerate
9892
9893 @item
9894 You log in on the server and create a @sc{soup} packet.  You can either
9895 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9896 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9897 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9898
9899 @item 
9900 You transfer the packet home.  Rail, boat, car or modem will do fine.
9901
9902 @item
9903 You put the packet in your home directory.
9904
9905 @item
9906 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9907 the native or secondary server.
9908
9909 @item
9910 You read articles and mail and answer and followup to the things you
9911 want (@pxref{SOUP Replies}).
9912
9913 @item 
9914 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9915 packet.
9916
9917 @item 
9918 You transfer this packet to the server.  
9919
9920 @item
9921 You use Gnus to mail this packet out with the @kbd{G s s} command.
9922
9923 @item
9924 You then repeat until you die.
9925
9926 @end enumerate
9927
9928 So you basically have a bipartite system---you use @code{nnsoup} for
9929 reading and Gnus for packing/sending these @sc{soup} packets.
9930
9931 @menu
9932 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
9933 * SOUP Groups::       A backend for reading @sc{soup} packets.
9934 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
9935 @end menu
9936
9937
9938 @node SOUP Commands
9939 @subsubsection SOUP Commands
9940
9941 These are commands for creating and manipulating @sc{soup} packets.
9942
9943 @table @kbd
9944 @item G s b
9945 @kindex G s b (Group)
9946 @findex gnus-group-brew-soup
9947 Pack all unread articles in the current group
9948 (@code{gnus-group-brew-soup}).  This command understands the
9949 process/prefix convention.
9950
9951 @item G s w
9952 @kindex G s w (Group)
9953 @findex gnus-soup-save-areas
9954 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
9955
9956 @item G s s
9957 @kindex G s s (Group)
9958 @findex gnus-soup-send-replies
9959 Send all replies from the replies packet
9960 (@code{gnus-soup-send-replies}). 
9961
9962 @item G s p
9963 @kindex G s p (Group)
9964 @findex gnus-soup-pack-packet
9965 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
9966
9967 @item G s r
9968 @kindex G s r (Group)
9969 @findex nnsoup-pack-replies
9970 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
9971
9972 @item O s
9973 @kindex O s (Summary)
9974 @findex gnus-soup-add-article
9975 This summary-mode command adds the current article to a @sc{soup} packet
9976 (@code{gnus-soup-add-article}).  It understands the process/prefix
9977 convention (@pxref{Process/Prefix}). 
9978
9979 @end table
9980
9981
9982 There are a few variables to customize where Gnus will put all these
9983 thingies:  
9984
9985 @table @code
9986
9987 @item gnus-soup-directory
9988 @vindex gnus-soup-directory
9989 Directory where Gnus will save intermediate files while composing
9990 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
9991
9992 @item gnus-soup-replies-directory
9993 @vindex gnus-soup-replies-directory
9994 This is what Gnus will use as a temporary directory while sending our
9995 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
9996
9997 @item gnus-soup-prefix-file
9998 @vindex gnus-soup-prefix-file
9999 Name of the file where Gnus stores the last used prefix.  The default is
10000 @samp{gnus-prefix}. 
10001
10002 @item gnus-soup-packer
10003 @vindex gnus-soup-packer
10004 A format string command for packing a @sc{soup} packet.  The default is
10005 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10006
10007 @item gnus-soup-unpacker
10008 @vindex gnus-soup-unpacker
10009 Format string command for unpacking a @sc{soup} packet.  The default is
10010 @samp{gunzip -c %s | tar xvf -}.
10011
10012 @item gnus-soup-packet-directory
10013 @vindex gnus-soup-packet-directory
10014 Where Gnus will look for reply packets.  The default is @file{~/}. 
10015
10016 @item gnus-soup-packet-regexp
10017 @vindex gnus-soup-packet-regexp
10018 Regular expression matching @sc{soup} reply packets in
10019 @code{gnus-soup-packet-directory}. 
10020
10021 @end table
10022  
10023
10024 @node SOUP Groups
10025 @subsubsection @sc{soup} Groups
10026 @cindex nnsoup
10027
10028 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10029 read incoming packets, unpack them, and put them in a directory where
10030 you can read them at leisure.
10031
10032 These are the variables you can use to customize its behavior:
10033
10034 @table @code
10035
10036 @item nnsoup-tmp-directory
10037 @vindex nnsoup-tmp-directory
10038 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10039 directory.  (@file{/tmp/} by default.)  
10040
10041 @item nnsoup-directory
10042 @vindex nnsoup-directory
10043 @code{nnsoup} then moves each message and index file to this directory.
10044 The default is @file{~/SOUP/}.
10045
10046 @item nnsoup-replies-directory 
10047 @vindex nnsoup-replies-directory 
10048 All replies will stored in this directory before being packed into a
10049 reply packet.  The default is @file{~/SOUP/replies/"}.
10050
10051 @item nnsoup-replies-format-type
10052 @vindex nnsoup-replies-format-type
10053 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10054 (rnews), and I don't think you should touch that variable.  I probably
10055 shouldn't even have documented it.  Drats!  Too late!
10056
10057 @item nnsoup-replies-index-type
10058 @vindex nnsoup-replies-index-type
10059 The index type of the replies packet.  The is @samp{?n}, which means
10060 ``none''.  Don't fiddle with this one either!
10061
10062 @item nnsoup-active-file
10063 @vindex nnsoup-active-file
10064 Where @code{nnsoup} stores lots of information.  This is not an ``active
10065 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10066 this file or mess it up in any way, you're dead.  The default is
10067 @file{~/SOUP/active}.
10068
10069 @item nnsoup-packer
10070 @vindex nnsoup-packer
10071 Format string command for packing a reply @sc{soup} packet.  The default
10072 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10073
10074 @item nnsoup-unpacker
10075 @vindex nnsoup-unpacker
10076 Format string command for unpacking incoming @sc{soup} packets.  The
10077 default is @samp{gunzip -c %s | tar xvf -}. 
10078
10079 @item nnsoup-packet-directory
10080 @vindex nnsoup-packet-directory
10081 Where @code{nnsoup} will look for incoming packets.  The default is
10082 @file{~/}.  
10083
10084 @item nnsoup-packet-regexp
10085 @vindex nnsoup-packet-regexp
10086 Regular expression matching incoming @sc{soup} packets.  The default is
10087 @samp{Soupout}. 
10088
10089 @end table
10090
10091
10092 @node SOUP Replies
10093 @subsubsection SOUP Replies
10094
10095 Just using @code{nnsoup} won't mean that your postings and mailings end
10096 up in @sc{soup} reply packets automagically.  You have to work a bit
10097 more for that to happen.
10098
10099 @findex nnsoup-set-variables
10100 The @code{nnsoup-set-variables} command will set the appropriate
10101 variables to ensure that all your followups and replies end up in the
10102 @sc{soup} system.
10103
10104 In specific, this is what it does:
10105
10106 @lisp
10107 (setq message-send-news-function 'nnsoup-request-post)
10108 (setq message-send-mail-function 'nnsoup-request-mail)
10109 @end lisp
10110
10111 And that's it, really.  If you only want news to go into the @sc{soup}
10112 system you just use the first line.  If you only want mail to be
10113 @sc{soup}ed you use the second.
10114
10115
10116 @node Web Searches
10117 @subsection Web Searches
10118 @cindex nnweb
10119 @cindex DejaNews
10120 @cindex Alta Vista
10121 @cindex InReference
10122 @cindex Usenet searches
10123 @cindex searching the Usenet
10124
10125 It's, like, too neat to search the Usenet for articles that match a
10126 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10127 those, like, Web browsers, and you, like, have to, rilly, like, look at
10128 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10129 searches without having to use a browser.
10130
10131 The @code{nnweb} backend allows an easy interface to the mighty search
10132 engine.  You create an @code{nnweb} group, enter a search pattern, and
10133 then enter the group and read the articles like you would any normal
10134 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10135 Groups}) will do this in an easy-to-use fashion.
10136
10137 @code{nnweb} groups don't really lend themselves to being solid
10138 groups---they have a very fleeting idea of article numbers.  In fact,
10139 each time you enter an @code{nnweb} group (not even changing the search
10140 pattern), you are likely to get the articles ordered in a different
10141 manner.  Not even using duplicate suppression (@code{Duplicate
10142 Suppression}) will help, since @code{nnweb} doesn't even know the
10143 @code{Message-ID} of the articles before reading them using some search
10144 engines (DejaNews, for instance).  The only possible way to keep track
10145 of which articles you've read is by scoring on the @code{Date}
10146 header---mark all articles that were posted before the last date you
10147 read the group as read.
10148
10149 If the search engine changes its output substantially, @code{nnweb}
10150 won't be able to parse it and will fail.  One could hardly fault the Web
10151 providers if they were to do this---their @emph{raison d'être} is to
10152 make money off of advertisements, not to provide services to the
10153 community.  Since @code{nnweb} washes the ads off all the articles, one
10154 might think that the providers might be somewhat miffed.  We'll see.
10155
10156 You must have the @code{url} and @code{w3} package installed to be able
10157 to use @code{nnweb}.
10158
10159 Virtual server variables:
10160
10161 @table @code
10162 @item nnweb-type
10163 @vindex nnweb-type
10164 What search engine type is being used.  The currently supported types
10165 are @code{dejanews}, @code{altavista} and @code{reference}.
10166
10167 @item nnweb-search
10168 @vindex nnweb-search
10169 The search string to feed to the search engine.
10170
10171 @item nnweb-max-hits
10172 @vindex nnweb-max-hits
10173 Advisory maximum number of hits per search to display.  The default is
10174 100.
10175
10176 @item nnweb-type-definition
10177 @vindex nnweb-type-definition
10178 Type-to-definition alist.  This alist says what @code{nnweb} should do
10179 with the various search engine types.  The following elements must be
10180 present: 
10181
10182 @table @code
10183 @item article
10184 Function to decode the article and provide something that Gnus
10185 understands. 
10186
10187 @item map
10188 Function to create an article number to message header and URL alist. 
10189
10190 @item search
10191 Function to send the search string to the search engine.
10192
10193 @item address
10194 The address the aforementioned function should send the search string
10195 to. 
10196
10197 @item id
10198 Format string URL to fetch an article by @code{Message-ID}.
10199 @end table
10200
10201 @end table
10202
10203
10204
10205 @node Mail-To-News Gateways
10206 @subsection Mail-To-News Gateways
10207 @cindex mail-to-news gateways
10208 @cindex gateways
10209
10210 If your local @code{nntp} server doesn't allow posting, for some reason
10211 or other, you can post using one of the numerous mail-to-news gateways.
10212 The @code{nngateway} backend provides the interface.
10213
10214 Note that you can't read anything from this backend---it can only be
10215 used to post with.
10216
10217 Server variables:
10218
10219 @table @code
10220 @item nngateway-address 
10221 @vindex nngateway-address 
10222 This is the address of the mail-to-news gateway.
10223
10224 @item nngateway-header-transformation
10225 @vindex nngateway-header-transformation
10226 News headers have often have to be transformed in some odd way or other
10227 for the mail-to-news gateway to accept it.  This variable says what 
10228 transformation should be called, and defaults to
10229 @code{nngateway-simple-header-transformation}.  The function is called
10230 narrowed to the headers to be transformed and with one parameter---the
10231 gateway address.
10232
10233 This default function just inserts a new @code{To} header based on the
10234 @code{Newsgroups} header and the gateway address---an article with this
10235 @code{Newsgroups} header:
10236
10237 @example
10238 Newsgroups: alt.religion.emacs
10239 @end example
10240
10241 will get this @code{From} header inserted:
10242
10243 @example
10244 To: alt-religion-emacs@@GATEWAY
10245 @end example
10246
10247 @end table
10248
10249 So, to use this, simply say something like:
10250
10251 @lisp
10252 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10253 @end lisp
10254
10255
10256 @node Combined Groups
10257 @section Combined Groups
10258
10259 Gnus allows combining a mixture of all the other group types into bigger
10260 groups.
10261
10262 @menu
10263 * Virtual Groups::     Combining articles from many groups.
10264 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10265 @end menu
10266
10267
10268 @node Virtual Groups
10269 @subsection Virtual Groups
10270 @cindex nnvirtual
10271 @cindex virtual groups
10272
10273 An @dfn{nnvirtual group} is really nothing more than a collection of
10274 other groups.
10275
10276 For instance, if you are tired of reading many small group, you can
10277 put them all in one big group, and then grow tired of reading one
10278 big, unwieldy group.  The joys of computing!
10279
10280 You specify @code{nnvirtual} as the method.  The address should be a
10281 regexp to match component groups.
10282
10283 All marks in the virtual group will stick to the articles in the
10284 component groups.  So if you tick an article in a virtual group, the
10285 article will also be ticked in the component group from whence it came.
10286 (And vice versa---marks from the component groups will also be shown in
10287 the virtual group.)
10288
10289 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10290 newsgroups into one, big, happy newsgroup:
10291
10292 @lisp
10293 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10294 @end lisp
10295
10296 The component groups can be native or foreign; everything should work
10297 smoothly, but if your computer explodes, it was probably my fault.
10298
10299 Collecting the same group from several servers might actually be a good
10300 idea if users have set the Distribution header to limit distribution.
10301 If you would like to read @samp{soc.motss} both from a server in Japan
10302 and a server in Norway, you could use the following as the group regexp:
10303
10304 @example
10305 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10306 @end example
10307
10308 This should work kinda smoothly---all articles from both groups should
10309 end up in this one, and there should be no duplicates.  Threading (and
10310 the rest) will still work as usual, but there might be problems with the
10311 sequence of articles.  Sorting on date might be an option here
10312 (@pxref{Selecting a Group}.
10313
10314 One limitation, however---all groups that are included in a virtual
10315 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10316 zombie groups can't be component groups for @code{nnvirtual} groups.
10317
10318 @vindex nnvirtual-always-rescan
10319 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10320 @code{nnvirtual} will always scan groups for unread articles when
10321 entering a virtual group.  If this variable is @code{nil} (which is the
10322 default) and you read articles in a component group after the virtual
10323 group has been activated, the read articles from the component group
10324 will show up when you enter the virtual group.  You'll also see this
10325 effect if you have two virtual groups that contain the same component
10326 group.  If that's the case, you should set this variable to @code{t}.
10327 Or you can just tap @code{M-g} on the virtual group every time before
10328 you enter it---it'll have much the same effect.
10329
10330
10331 @node Kibozed Groups
10332 @subsection Kibozed Groups
10333 @cindex nnkiboze
10334 @cindex kibozing
10335
10336 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10337 the news feed''.  @code{nnkiboze} is a backend that will do this for
10338 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10339 with useless requests!  Oh happiness!
10340
10341 @kindex G k (Group)
10342 To create a kibozed group, use the @kbd{G k} command in the group
10343 buffer. 
10344
10345 The address field of the @code{nnkiboze} method is, as with
10346 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10347 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10348 and @code{nnvirtual} ends.
10349
10350 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10351 must have a score file to say what articles that are to be included in
10352 the group (@pxref{Scoring}).
10353
10354 @kindex M-x nnkiboze-generate-groups
10355 @findex nnkiboze-generate-groups
10356 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10357 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10358 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10359 all the articles in all the components groups and run them through the
10360 scoring process to determine if there are any articles in the groups
10361 that are to be part of the @code{nnkiboze} groups.
10362
10363 Please limit the number of component groups by using restrictive
10364 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10365 @sc{nntp} site may throw you off and never let you back in again.
10366 Stranger things have happened.
10367
10368 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10369 and they can be foreign.  No restrictions.
10370
10371 @vindex nnkiboze-directory
10372 The generation of an @code{nnkiboze} group means writing two files in
10373 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10374 contains the @sc{nov} header lines for all the articles in the group,
10375 and the other is an additional @file{.newsrc} file to store information
10376 on what groups that have been searched through to find component
10377 articles.
10378
10379 Articles that are marked as read in the @code{nnkiboze} group will have their
10380 @sc{nov} lines removed from the @sc{nov} file.
10381
10382
10383 @node Scoring
10384 @chapter Scoring
10385 @cindex scoring
10386
10387 Other people use @dfn{kill files}, but we here at Gnus Towers like
10388 scoring better than killing, so we'd rather switch than fight.  They do
10389 something completely different as well, so sit up straight and pay
10390 attention!
10391
10392 @vindex gnus-summary-mark-below
10393 All articles have a default score (@code{gnus-summary-default-score}),
10394 which is 0 by default.  This score may be raised or lowered either
10395 interactively or by score files.  Articles that have a score lower than
10396 @code{gnus-summary-mark-below} are marked as read.
10397
10398 Gnus will read any @dfn{score files} that apply to the current group
10399 before generating the summary buffer.
10400
10401 There are several commands in the summary buffer that insert score
10402 entries based on the current article.  You can, for instance, ask Gnus to
10403 lower or increase the score of all articles with a certain subject.
10404
10405 There are two sorts of scoring entries: Permanent and temporary.
10406 Temporary score entries are self-expiring entries.  Any entries that are
10407 temporary and have not been used for, say, a week, will be removed
10408 silently to help keep the sizes of the score files down.
10409
10410 @menu 
10411 * Summary Score Commands::   Adding score entries for the current group.
10412 * Group Score Commands::     General score commands.
10413 * Score Variables::          Customize your scoring.  (My, what terminology).
10414 * Score File Format::        What a score file may contain.
10415 * Score File Editing::       You can edit score files by hand as well.
10416 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10417 * Home Score File::          How to say where new score entries are to go.
10418 * Followups To Yourself::    Having Gnus notice when people answer you.
10419 * Scoring Tips::             How to score effectively.
10420 * Reverse Scoring::          That problem child of old is not problem.
10421 * Global Score Files::       Earth-spanning, ear-splitting score files.
10422 * Kill Files::               They are still here, but they can be ignored.
10423 * Converting Kill Files::    Translating kill files to score files.
10424 * GroupLens::                Getting predictions on what you like to read.
10425 * Advanced Scoring::         Using logical expressions to build score rules.
10426 * Score Decays::             It can be useful to let scores wither away.
10427 @end menu
10428
10429
10430 @node Summary Score Commands
10431 @section Summary Score Commands
10432 @cindex score commands
10433
10434 The score commands that alter score entries do not actually modify real
10435 score files.  That would be too inefficient.  Gnus maintains a cache of
10436 previously loaded score files, one of which is considered the
10437 @dfn{current score file alist}.  The score commands simply insert
10438 entries into this list, and upon group exit, this list is saved.
10439
10440 The current score file is by default the group's local score file, even
10441 if no such score file actually exists.  To insert score commands into
10442 some other score file (e.g. @file{all.SCORE}), you must first make this
10443 score file the current one.
10444
10445 General score commands that don't actually change the score file:
10446
10447 @table @kbd
10448
10449 @item V s
10450 @kindex V s (Summary)
10451 @findex gnus-summary-set-score
10452 Set the score of the current article (@code{gnus-summary-set-score}).  
10453
10454 @item V S
10455 @kindex V S (Summary)
10456 @findex gnus-summary-current-score
10457 Display the score of the current article
10458 (@code{gnus-summary-current-score}).   
10459
10460 @item V t
10461 @kindex V t (Summary)
10462 @findex gnus-score-find-trace
10463 Display all score rules that have been used on the current article
10464 (@code{gnus-score-find-trace}).   
10465
10466 @item V R
10467 @kindex V R (Summary)
10468 @findex gnus-summary-rescore
10469 Run the current summary through the scoring process
10470 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10471 around with your score files behind Gnus' back and want to see the
10472 effect you're having.
10473
10474 @item V a
10475 @kindex V a (Summary)
10476 @findex gnus-summary-score-entry
10477 Add a new score entry, and allow specifying all elements 
10478 (@code{gnus-summary-score-entry}).
10479
10480 @item V c
10481 @kindex V c (Summary)
10482 @findex gnus-score-change-score-file
10483 Make a different score file the current
10484 (@code{gnus-score-change-score-file}). 
10485
10486 @item V e
10487 @kindex V e (Summary)
10488 @findex gnus-score-edit-current-scores
10489 Edit the current score file (@code{gnus-score-edit-current-scores}).
10490 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10491 File Editing}).
10492
10493 @item V f
10494 @kindex V f (Summary)
10495 @findex gnus-score-edit-file
10496 Edit a score file and make this score file the current one
10497 (@code{gnus-score-edit-file}).
10498
10499 @item V F
10500 @kindex V F (Summary)
10501 @findex gnus-score-flush-cache
10502 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10503 after editing score files.
10504
10505 @item V C
10506 @kindex V C (Summary)
10507 @findex gnus-score-customize
10508 Customize a score file in a visually pleasing manner
10509 (@code{gnus-score-customize}). 
10510
10511 @item I C-i
10512 @kindex I C-i (Summary)
10513 @findex gnus-summary-raise-score
10514 Increase the score of the current article
10515 (@code{gnus-summary-raise-score}).
10516
10517 @item L C-l
10518 @kindex L C-l (Summary)
10519 @findex gnus-summary-lower-score
10520 Lower the score of the current article
10521 (@code{gnus-summary-lower-score}). 
10522 @end table
10523
10524 The rest of these commands modify the local score file.
10525
10526 @table @kbd
10527
10528 @item V m
10529 @kindex V m (Summary)
10530 @findex gnus-score-set-mark-below
10531 Prompt for a score, and mark all articles with a score below this as
10532 read (@code{gnus-score-set-mark-below}).
10533
10534 @item V x
10535 @kindex V x (Summary)
10536 @findex gnus-score-set-expunge-below
10537 Prompt for a score, and add a score rule to the current score file to
10538 expunge all articles below this score
10539 (@code{gnus-score-set-expunge-below}).
10540 @end table
10541
10542 The keystrokes for actually making score entries follow a very regular
10543 pattern, so there's no need to list all the commands.  (Hundreds of
10544 them.)  
10545
10546 @enumerate
10547 @item
10548 The first key is either @kbd{I} (upper case i) for increasing the score
10549 or @kbd{L} for lowering the score. 
10550 @item
10551 The second key says what header you want to score on.  The following
10552 keys are available:
10553 @table @kbd
10554
10555 @item a
10556 Score on the author name.
10557
10558 @item s
10559 Score on the subject line.
10560
10561 @item x
10562 Score on the Xref line---i.e., the cross-posting line.
10563
10564 @item t
10565 Score on thread---the References line.
10566
10567 @item d
10568 Score on the date.
10569
10570 @item l
10571 Score on the number of lines.
10572
10573 @item i
10574 Score on the Message-ID.
10575
10576 @item f
10577 Score on followups.
10578
10579 @item b
10580 Score on the body.
10581
10582 @item h
10583 Score on the head.
10584 @end table
10585
10586 @item
10587 The third key is the match type.  Which match types are legal depends on
10588 what headers you are scoring on.
10589
10590 @table @code
10591
10592 @item strings 
10593
10594 @table @kbd
10595
10596 @item e
10597 Exact matching.
10598
10599 @item s
10600 Substring matching.
10601
10602 @item f
10603 Fuzzy matching.
10604
10605 @item r
10606 Regexp matching
10607 @end table
10608
10609 @item date
10610 @table @kbd
10611
10612 @item b
10613 Before date.
10614
10615 @item a
10616 At date.
10617
10618 @item n
10619 This date.
10620 @end table
10621
10622 @item number
10623 @table @kbd
10624
10625 @item <
10626 Less than number.
10627
10628 @item =
10629 Equal to number.
10630
10631 @item >
10632 Greater than number.
10633 @end table
10634 @end table
10635
10636 @item 
10637 The fourth and final key says whether this is a temporary (i.e., expiring)
10638 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10639 it is to be done immediately, without adding to the score file.
10640 @table @kbd
10641
10642 @item t
10643 Temporary score entry.
10644
10645 @item p
10646 Permanent score entry.
10647
10648 @item i
10649 Immediately scoring.
10650 @end table
10651
10652 @end enumerate
10653
10654 So, let's say you want to increase the score on the current author with
10655 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10656 score based on the subject line, using substring matching, and make a
10657 temporary score entry: @kbd{L s s t}.  Pretty easy.
10658
10659 To make things a bit more complicated, there are shortcuts.  If you use
10660 a capital letter on either the second or third keys, Gnus will use
10661 defaults for the remaining one or two keystrokes.  The defaults are
10662 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10663 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10664
10665 @vindex gnus-score-mimic-keymap
10666 The @code{gnus-score-mimic-keymap} says whether these commands will
10667 pretend they are keymaps or not.
10668
10669
10670 @node Group Score Commands
10671 @section Group Score Commands
10672 @cindex group score commands
10673
10674 There aren't many of these as yet, I'm afraid.
10675
10676 @table @kbd
10677
10678 @item W f
10679 @kindex W f (Group)
10680 @findex gnus-score-flush-cache
10681 Gnus maintains a cache of score alists to avoid having to reload them
10682 all the time.  This command will flush the cache
10683 (@code{gnus-score-flush-cache}). 
10684
10685 @end table
10686
10687
10688 @node Score Variables
10689 @section Score Variables
10690 @cindex score variables
10691
10692 @table @code
10693
10694 @item gnus-use-scoring
10695 @vindex gnus-use-scoring
10696 If @code{nil}, Gnus will not check for score files, and will not, in
10697 general, do any score-related work.  This is @code{t} by default.
10698
10699 @item gnus-kill-killed
10700 @vindex gnus-kill-killed
10701 If this variable is @code{nil}, Gnus will never apply score files to
10702 articles that have already been through the kill process.  While this
10703 may save you lots of time, it also means that if you apply a kill file
10704 to a group, and then change the kill file and want to run it over you
10705 group again to kill more articles, it won't work.  You have to set this
10706 variable to @code{t} to do that.  (It is @code{t} by default.)
10707
10708 @item gnus-kill-files-directory
10709 @vindex gnus-kill-files-directory
10710 All kill and score files will be stored in this directory, which is
10711 initialized from the @code{SAVEDIR} environment variable by default.
10712 This is @file{~/News/} by default.
10713
10714 @item gnus-score-file-suffix
10715 @vindex gnus-score-file-suffix
10716 Suffix to add to the group name to arrive at the score file name
10717 (@samp{SCORE} by default.)
10718
10719 @item gnus-score-uncacheable-files
10720 @vindex gnus-score-uncacheable-files
10721 @cindex score cache
10722 All score files are normally cached to avoid excessive re-loading of
10723 score files.  However, if this might make you Emacs grow big and
10724 bloated, so this regexp can be used to weed out score files that are
10725 unlikely to be needed again.  It would be a bad idea to deny caching of
10726 @file{all.SCORE}, while it might be a good idea to not cache
10727 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10728 variable is @samp{ADAPT$} by default, so no adaptive score files will
10729 be cached.
10730
10731 @item gnus-save-score
10732 @vindex gnus-save-score
10733 If you have really complicated score files, and do lots of batch
10734 scoring, then you might set this variable to @code{t}.  This will make
10735 Gnus save the scores into the @file{.newsrc.eld} file.
10736
10737 @item gnus-score-interactive-default-score
10738 @vindex gnus-score-interactive-default-score
10739 Score used by all the interactive raise/lower commands to raise/lower
10740 score with.  Default is 1000, which may seem excessive, but this is to
10741 ensure that the adaptive scoring scheme gets enough room to play with.
10742 We don't want the small changes from the adaptive scoring to overwrite
10743 manually entered data.
10744
10745 @item gnus-summary-default-score
10746 @vindex gnus-summary-default-score
10747 Default score of an article, which is 0 by default.
10748
10749 @item gnus-summary-expunge-below
10750 @vindex gnus-summary-expunge-below
10751 Don't display the summary lines of articles that have scores lower than
10752 this variable.  This is @code{nil} by default, which means that no
10753 articles will be hidden.
10754
10755 @item gnus-score-over-mark
10756 @vindex gnus-score-over-mark
10757 Mark (in the third column) used for articles with a score over the
10758 default.  Default is @samp{+}.
10759
10760 @item gnus-score-below-mark
10761 @vindex gnus-score-below-mark
10762 Mark (in the third column) used for articles with a score below the
10763 default.  Default is @samp{-}.
10764
10765 @item gnus-score-find-score-files-function
10766 @vindex gnus-score-find-score-files-function
10767 Function used to find score files for the current group.  This function
10768 is called with the name of the group as the argument. 
10769
10770 Predefined functions available are:
10771 @table @code
10772
10773 @item gnus-score-find-single
10774 @findex gnus-score-find-single
10775 Only apply the group's own score file.
10776
10777 @item gnus-score-find-bnews
10778 @findex gnus-score-find-bnews
10779 Apply all score files that match, using bnews syntax.  This is the
10780 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10781 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10782 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10783 @samp{all} in the score file names are translated into @samp{.*}, and
10784 then a regexp match is done.
10785
10786 This means that if you have some score entries that you want to apply to
10787 all groups, then you put those entries in the @file{all.SCORE} file. 
10788
10789 The score files are applied in a semi-random order, although Gnus will
10790 try to apply the more general score files before the more specific score
10791 files.  It does this by looking at the number of elements in the score
10792 file names---discarding the @samp{all} elements.
10793
10794 @item gnus-score-find-hierarchical
10795 @findex gnus-score-find-hierarchical
10796 Apply all score files from all the parent groups.  This means that you
10797 can't have score files like @file{all.SCORE}, but you can have
10798 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10799
10800 @end table
10801 This variable can also be a list of functions.  In that case, all these
10802 functions will be called, and all the returned lists of score files will
10803 be applied.  These functions can also return lists of score alists
10804 directly.  In that case, the functions that return these non-file score
10805 alists should probably be placed before the ``real'' score file
10806 functions, to ensure that the last score file returned is the local
10807 score file.  Phu.
10808
10809 @item gnus-score-expiry-days
10810 @vindex gnus-score-expiry-days
10811 This variable says how many days should pass before an unused score file
10812 entry is expired.  If this variable is @code{nil}, no score file entries
10813 are expired.  It's 7 by default.
10814
10815 @item gnus-update-score-entry-dates
10816 @vindex gnus-update-score-entry-dates
10817 If this variable is non-@code{nil}, matching score entries will have
10818 their dates updated.  (This is how Gnus controls expiry---all
10819 non-matching entries will become too old while matching entries will
10820 stay fresh and young.)  However, if you set this variable to @code{nil},
10821 even matching entries will grow old and will have to face that oh-so
10822 grim reaper.  
10823
10824 @item gnus-score-after-write-file-function
10825 @vindex gnus-score-after-write-file-function
10826 Function called with the name of the score file just written.
10827
10828 @end table
10829
10830
10831 @node Score File Format
10832 @section Score File Format
10833 @cindex score file format
10834
10835 A score file is an @code{emacs-lisp} file that normally contains just a
10836 single form.  Casual users are not expected to edit these files;
10837 everything can be changed from the summary buffer.
10838
10839 Anyway, if you'd like to dig into it yourself, here's an example:
10840
10841 @lisp
10842 (("from"
10843   ("Lars Ingebrigtsen" -10000)
10844   ("Per Abrahamsen")
10845   ("larsi\\|lmi" -50000 nil R))
10846  ("subject"
10847   ("Ding is Badd" nil 728373))
10848  ("xref"
10849   ("alt.politics" -1000 728372 s))
10850  ("lines"
10851   (2 -100 nil <))
10852  (mark 0)
10853  (expunge -1000)
10854  (mark-and-expunge -10)
10855  (read-only nil)
10856  (orphan -10)
10857  (adapt t)
10858  (files "/hom/larsi/News/gnu.SCORE")
10859  (exclude-files "all.SCORE")
10860  (local (gnus-newsgroup-auto-expire t)
10861         (gnus-summary-make-false-root 'empty))
10862  (eval (ding)))
10863 @end lisp
10864
10865 This example demonstrates absolutely everything about a score file. 
10866
10867 Even though this looks much like lisp code, nothing here is actually
10868 @code{eval}ed.  The lisp reader is used to read this form, though, so it
10869 has to be legal syntactically, if not semantically.
10870
10871 Six keys are supported by this alist:
10872
10873 @table @code
10874
10875 @item STRING
10876 If the key is a string, it is the name of the header to perform the
10877 match on.  Scoring can only be performed on these eight headers:
10878 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10879 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
10880 these headers, there are three strings to tell Gnus to fetch the entire
10881 article and do the match on larger parts of the article: @code{Body}
10882 will perform the match on the body of the article, @code{Head} will
10883 perform the match on the head of the article, and @code{All} will
10884 perform the match on the entire article.  Note that using any of these
10885 last three keys will slow down group entry @emph{considerably}.  The
10886 final ``header'' you can score on is @code{Followup}.  These score
10887 entries will result in new score entries being added for all follow-ups
10888 to articles that matches these score entries.
10889
10890 Following this key is a arbitrary number of score entries, where each
10891 score entry has one to four elements.
10892 @enumerate
10893
10894 @item 
10895 The first element is the @dfn{match element}.  On most headers this will
10896 be a string, but on the Lines and Chars headers, this must be an
10897 integer. 
10898
10899 @item 
10900 If the second element is present, it should be a number---the @dfn{score
10901 element}.  This number should be an integer in the neginf to posinf
10902 interval.  This number is added to the score of the article if the match
10903 is successful.  If this element is not present, the
10904 @code{gnus-score-interactive-default-score} number will be used
10905 instead.  This is 1000 by default.
10906
10907 @item 
10908 If the third element is present, it should be a number---the @dfn{date
10909 element}.  This date says when the last time this score entry matched,
10910 which provides a mechanism for expiring the score entries.  It this
10911 element is not present, the score entry is permanent.  The date is
10912 represented by the number of days since December 31, 1 ce.
10913
10914 @item 
10915 If the fourth element is present, it should be a symbol---the @dfn{type
10916 element}.  This element specifies what function should be used to see
10917 whether this score entry matches the article.  What match types that can
10918 be used depends on what header you wish to perform the match on.
10919 @table @dfn
10920
10921 @item From, Subject, References, Xref, Message-ID
10922 For most header types, there are the @code{r} and @code{R} (regexp), as
10923 well as @code{s} and @code{S} (substring) types, and @code{e} and
10924 @code{E} (exact match), and @code{w} (word match) types.  If this
10925 element is not present, Gnus will assume that substring matching should
10926 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
10927 that the matches will be done in a case-sensitive manner.  All these
10928 one-letter types are really just abbreviations for the @code{regexp},
10929 @code{string}, @code{exact}, and @code{word} types, which you can use
10930 instead, if you feel like.
10931
10932 @item Lines, Chars
10933 These two headers use different match types: @code{<}, @code{>},
10934 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
10935 careful because some backends (like @code{nndir}) do not generate
10936 @code{Lines} header, so every article ends up being marked as having 0
10937 lines.  This can lead to strange results if you happen to lower score of
10938 the articles with few lines.
10939
10940 @item Date
10941 For the Date header we have three kinda silly match types:
10942 @code{before}, @code{at} and @code{after}.  I can't really imagine this
10943 ever being useful, but, like, it would feel kinda silly not to provide
10944 this function.  Just in case.  You never know.  Better safe than sorry.
10945 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
10946 sex on a first date.  (I have been told that at least one person, and I
10947 quote, ``found this function indispensable'', however.)
10948
10949 @cindex ISO8601
10950 @cindex date
10951 A more useful match type is @code{regexp}.  With it, you can match the
10952 date string using a regular expression.  The date is normalized to
10953 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
10954 match all articles that have been posted on April 1st in every year, you
10955 could use @samp{....0401.........} as a match string, for instance.
10956 (Note that the date is kept in its original time zone, so this will
10957 match articles that were posted when it was April 1st where the article
10958 was posted from.  Time zones are such wholesome fun for the whole
10959 family, eh?)
10960
10961 @item Head, Body, All
10962 These three match keys use the same match types as the @code{From} (etc)
10963 header uses.
10964
10965 @item Followup
10966 This match key is somewhat special, in that it will match the
10967 @code{From} header, and affect the score of not only the matching
10968 articles, but also all followups to the matching articles.  This allows
10969 you e.g. increase the score of followups to your own articles, or
10970 decrease the score of followups to the articles of some known
10971 trouble-maker.  Uses the same match types as the @code{From} header
10972 uses.
10973
10974 @item Thread
10975 This match key works along the same lines as the @code{Followup} match
10976 key.  If you say that you want to score on a (sub-)thread that is
10977 started by an article with a @code{Message-ID} @var{X}, then you add a
10978 @samp{thread} match.  This will add a new @samp{thread} match for each
10979 article that has @var{X} in its @code{References} header.  (These new
10980 @samp{thread} matches will use the @code{Message-ID}s of these matching
10981 articles.)  This will ensure that you can raise/lower the score of an
10982 entire thread, even though some articles in the thread may not have
10983 complete @code{References} headers.  Note that using this may lead to
10984 undeterministic scores of the articles in the thread.
10985 @end table
10986 @end enumerate
10987
10988 @item mark
10989 The value of this entry should be a number.  Any articles with a score
10990 lower than this number will be marked as read.
10991
10992 @item expunge
10993 The value of this entry should be a number.  Any articles with a score
10994 lower than this number will be removed from the summary buffer.
10995
10996 @item mark-and-expunge
10997 The value of this entry should be a number.  Any articles with a score
10998 lower than this number will be marked as read and removed from the
10999 summary buffer.
11000
11001 @item thread-mark-and-expunge
11002 The value of this entry should be a number.  All articles that belong to
11003 a thread that has a total score below this number will be marked as read
11004 and removed from the summary buffer.  @code{gnus-thread-score-function}
11005 says how to compute the total score for a thread.
11006
11007 @item files
11008 The value of this entry should be any number of file names.  These files
11009 are assumed to be score files as well, and will be loaded the same way
11010 this one was.
11011
11012 @item exclude-files
11013 The clue of this entry should be any number of files.  These files will
11014 not be loaded, even though they would normally be so, for some reason or
11015 other. 
11016
11017 @item eval
11018 The value of this entry will be @code{eval}el.  This element will be
11019 ignored when handling global score files. 
11020
11021 @item read-only
11022 Read-only score files will not be updated or saved.  Global score files
11023 should feature this atom (@pxref{Global Score Files}).
11024
11025 @item orphan
11026 The value of this entry should be a number.  Articles that do not have
11027 parents will get this number added to their scores.  Imagine you follow
11028 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
11029 will only follow a few of the threads, also want to see any new threads.
11030
11031 You can do this with the following two score file entries:
11032
11033 @example
11034         (orphan -500)
11035         (mark-and-expunge -100)
11036 @end example
11037
11038 When you enter the group the first time, you will only see the new
11039 threads.  You then raise the score of the threads that you find
11040 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11041 rest.  Next time you enter the group, you will see new articles in the
11042 interesting threads, plus any new threads.
11043
11044 I.e.---the orphan score atom is for high-volume groups where there
11045 exist a few interesting threads which can't be found automatically by
11046 ordinary scoring rules.
11047
11048 @item adapt
11049 This entry controls the adaptive scoring.  If it is @code{t}, the
11050 default adaptive scoring rules will be used.  If it is @code{ignore}, no
11051 adaptive scoring will be performed on this group.  If it is a list, this
11052 list will be used as the adaptive scoring rules.  If it isn't present,
11053 or is something other than @code{t} or @code{ignore}, the default
11054 adaptive scoring rules will be used.  If you want to use adaptive
11055 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11056 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11057 not want adaptive scoring.  If you only want adaptive scoring in a few
11058 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11059 insert @code{(adapt t)} in the score files of the groups where you want
11060 it. 
11061
11062 @item adapt-file
11063 All adaptive score entries will go to the file named by this entry.  It
11064 will also be applied when entering the group.  This atom might be handy
11065 if you want to adapt on several groups at once, using the same adaptive
11066 file for a number of groups.
11067
11068 @item local
11069 @cindex local variables
11070 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11071 Each @var{var} will be made buffer-local to the current summary buffer,
11072 and set to the value specified.  This is a convenient, if somewhat
11073 strange, way of setting variables in some groups if you don't like hooks
11074 much.
11075 @end table
11076
11077
11078 @node Score File Editing
11079 @section Score File Editing
11080
11081 You normally enter all scoring commands from the summary buffer, but you
11082 might feel the urge to edit them by hand as well, so we've supplied you
11083 with a mode for that.  
11084
11085 It's simply a slightly customized @code{emacs-lisp} mode, with these
11086 additional commands:
11087
11088 @table @kbd
11089
11090 @item C-c C-c
11091 @kindex C-c C-c (Score)
11092 @findex gnus-score-edit-done
11093 Save the changes you have made and return to the summary buffer
11094 (@code{gnus-score-edit-done}). 
11095
11096 @item C-c C-d
11097 @kindex C-c C-d (Score)
11098 @findex gnus-score-edit-insert-date
11099 Insert the current date in numerical format
11100 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
11101 you were wondering.
11102
11103 @item C-c C-p
11104 @kindex C-c C-p (Score)
11105 @findex gnus-score-pretty-print
11106 The adaptive score files are saved in an unformatted fashion.  If you
11107 intend to read one of these files, you want to @dfn{pretty print} it
11108 first.  This command (@code{gnus-score-pretty-print}) does that for
11109 you. 
11110
11111 @end table
11112
11113 Type @kbd{M-x gnus-score-mode} to use this mode.
11114
11115 @vindex gnus-score-mode-hook
11116 @code{gnus-score-menu-hook} is run in score mode buffers.
11117
11118 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11119 e} to begin editing score files.
11120
11121
11122 @node Adaptive Scoring
11123 @section Adaptive Scoring
11124 @cindex adaptive scoring
11125
11126 If all this scoring is getting you down, Gnus has a way of making it all
11127 happen automatically---as if by magic.  Or rather, as if by artificial
11128 stupidity, to be precise.
11129
11130 @vindex gnus-use-adaptive-scoring
11131 When you read an article, or mark an article as read, or kill an
11132 article, you leave marks behind.  On exit from the group, Gnus can sniff
11133 these marks and add score elements depending on what marks it finds.
11134 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11135 @code{t} or @code{(line)}.  If you want score adaptively on separate
11136 words appearing in the subjects, you should set this variable to
11137 @code{(word)}.  If you want to use both adaptive methods, set this
11138 variable to @code{(word line)}.
11139
11140 @vindex gnus-default-adaptive-score-alist
11141 To give you complete control over the scoring process, you can customize
11142 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11143 might look something like this:
11144
11145 @lisp
11146 (defvar gnus-default-adaptive-score-alist
11147   '((gnus-unread-mark)
11148     (gnus-ticked-mark (from 4))
11149     (gnus-dormant-mark (from 5))
11150     (gnus-del-mark (from -4) (subject -1))
11151     (gnus-read-mark (from 4) (subject 2))
11152     (gnus-expirable-mark (from -1) (subject -1))
11153     (gnus-killed-mark (from -1) (subject -3))
11154     (gnus-kill-file-mark)
11155     (gnus-ancient-mark)
11156     (gnus-low-score-mark)
11157     (gnus-catchup-mark (from -1) (subject -1))))
11158 @end lisp
11159
11160 As you see, each element in this alist has a mark as a key (either a
11161 variable name or a ``real'' mark---a character).  Following this key is
11162 a arbitrary number of header/score pairs.  If there are no header/score
11163 pairs following the key, no adaptive scoring will be done on articles
11164 that have that key as the article mark.  For instance, articles with
11165 @code{gnus-unread-mark} in the example above will not get adaptive score
11166 entries.
11167
11168 Each article can have only one mark, so just a single of these rules
11169 will be applied to each article.
11170
11171 To take @code{gnus-del-mark} as an example---this alist says that all
11172 articles that have that mark (i.e., are marked with @samp{D}) will have a
11173 score entry added to lower based on the @code{From} header by -4, and
11174 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11175
11176 If you have marked 10 articles with the same subject with
11177 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11178 That means that that subject will get a score of ten times -1, which
11179 should be, unless I'm much mistaken, -10.
11180
11181 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11182 the read articles will be marked with the @samp{E} mark.  This'll
11183 probably make adaptive scoring slightly impossible, so auto-expiring and
11184 adaptive scoring doesn't really mix very well.
11185
11186 The headers you can score on are @code{from}, @code{subject},
11187 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11188 @code{chars} and @code{date}.  In addition, you can score on
11189 @code{followup}, which will create an adaptive score entry that matches
11190 on the @code{References} header using the @code{Message-ID} of the
11191 current article, thereby matching the following thread.  
11192
11193 You can also score on @code{thread}, which will try to score all
11194 articles that appear in a thread.  @code{thread} matches uses a
11195 @code{Message-ID} to match on the @code{References} header of the
11196 article.  If the match is made, the @code{Message-ID} of the article is
11197 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11198 aspirins afterwards.)
11199
11200 If you use this scheme, you should set the score file atom @code{mark}
11201 to something small---like -300, perhaps, to avoid having small random
11202 changes result in articles getting marked as read.
11203
11204 After using adaptive scoring for a week or so, Gnus should start to
11205 become properly trained and enhance the authors you like best, and kill
11206 the authors you like least, without you having to say so explicitly. 
11207
11208 You can control what groups the adaptive scoring is to be performed on
11209 by using the score files (@pxref{Score File Format}).  This will also
11210 let you use different rules in different groups.
11211
11212 @vindex gnus-adaptive-file-suffix
11213 The adaptive score entries will be put into a file where the name is the
11214 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11215 is @samp{ADAPT}.
11216
11217 @vindex gnus-score-exact-adapt-limit
11218 When doing adaptive scoring, substring or fuzzy matching would probably
11219 give you the best results in most cases.  However, if the header one
11220 matches is short, the possibility for false positives is great, so if
11221 the length of the match is less than
11222 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11223 this variable is @code{nil}, exact matching will always be used to avoid
11224 this problem.
11225
11226 @vindex gnus-default-adaptive-word-score-alist
11227 As mentioned above, you can adapt either on individual words or entire
11228 headers.  If you adapt on words, the
11229 @code{gnus-default-adaptive-word-score-alist} variable says what score
11230 each instance of a word should add given a mark.
11231
11232 @lisp
11233 (setq gnus-default-adaptive-word-score-alist  
11234       `((,gnus-read-mark . 30)
11235         (,gnus-catchup-mark . -10)
11236         (,gnus-killed-mark . -20)
11237         (,gnus-del-mark . -15)))
11238 @end lisp
11239
11240 This is the default value.  If you have adaption on words enabled, every
11241 word that appears in subjects of articles that are marked with
11242 @code{gnus-read-mark} will result in a score rule that increase the
11243 score with 30 points.
11244
11245 @vindex gnus-default-ignored-adaptive-words
11246 @vindex gnus-ignored-adaptive-words
11247 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11248 will be ignored.  If you wish to add more words to be ignored, use the
11249 @code{gnus-ignored-adaptive-words} list instead.
11250
11251 @vindex gnus-adaptive-word-syntax-table
11252 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11253 syntax table in effect.  It is similar to the standard syntax table, but
11254 it considers numbers to be non-word-constituent characters.
11255
11256 After using this scheme for a while, it might be nice to write a
11257 @code{gnus-psychoanalyze-user} command to go through the rules and see
11258 what words you like and what words you don't like.  Or perhaps not.
11259
11260 Note that the adaptive word scoring thing is highly experimental and is
11261 likely to change in the future.  Initial impressions seem to indicate
11262 that it's totally useless as it stands.  Some more work (involving more
11263 rigorous statistical methods) will have to be done to make this useful. 
11264
11265
11266 @node Home Score File
11267 @section Home Score File
11268
11269 The score file where new score file entries will go is called the
11270 @dfn{home score file}.  This is normally (and by default) the score file
11271 for the group itself.  For instance, the home score file for
11272 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11273
11274 However, this may not be what you want.  It is often convenient to share
11275 a common home score file among many groups---all @samp{emacs} groups
11276 could perhaps use the same home score file.
11277
11278 @vindex gnus-home-score-file
11279 The variable that controls this is @code{gnus-home-score-file}.  It can
11280 be:
11281
11282 @enumerate
11283 @item
11284 A string.  Then this file will be used as the home score file for all
11285 groups. 
11286
11287 @item
11288 A function. The result of this function will be used as the home score
11289 file.  The function will be called with the name of the group as the
11290 parameter. 
11291
11292 @item
11293 A list.  The elements in this list can be:
11294
11295 @enumerate
11296 @item 
11297 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11298 the @var{file-name} will will be used as the home score file.
11299
11300 @item 
11301 A function. If the function returns non-nil, the result will be used as
11302 the home score file.
11303
11304 @item 
11305 A string.  Use the string as the home score file.
11306 @end enumerate
11307
11308 The list will be traversed from the beginning towards the end looking
11309 for matches.
11310
11311 @end enumerate
11312
11313 So, if you want to use just a single score file, you could say:
11314
11315 @lisp
11316 (setq gnus-home-score-file
11317       "my-total-score-file.SCORE")
11318 @end lisp
11319
11320 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11321 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11322
11323 @lisp
11324 (setq gnus-home-score-file
11325       'gnus-hierarchial-home-score-file)
11326 @end lisp
11327
11328 This is a ready-made function provided for your convenience.
11329
11330 If you want to have one score file for the @samp{emacs} groups and
11331 another for the @samp{comp} groups, while letting all other groups use
11332 their own home score files:
11333
11334 @lisp
11335 (setq gnus-home-score-file
11336       ;; All groups that match the regexp "\\.emacs"
11337       '("\\.emacs" "emacs.SCORE")
11338       ;; All the comp groups in one score file
11339        ("^comp" "comp.SCORE"))
11340 @end lisp
11341    
11342 @vindex gnus-home-adapt-file
11343 @code{gnus-home-adapt-file} works exactly the same way as
11344 @code{gnus-home-score-file}, but says what the home adaptive score file
11345 is instead.  All new adaptive file entries will go into the file
11346 specified by this variable, and the same syntax is allowed.
11347
11348 In addition to using @code{gnus-home-score-file} and
11349 @code{gnus-home-adapt-file}, you can also use group parameters
11350 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11351 Parameters}) to achieve much the same.  Group and topic parameters take
11352 precedence over this variable.
11353
11354
11355 @node Followups To Yourself
11356 @section Followups To Yourself
11357
11358 Gnus offers two commands for picking out the @code{Message-ID} header in
11359 the current buffer.  Gnus will then add a score rule that scores using
11360 this @code{Message-ID} on the @code{References} header of other
11361 articles.  This will, in effect, increase the score of all articles that
11362 respond to the article in the current buffer.  Quite useful if you want
11363 to easily note when people answer what you've said.
11364
11365 @table @code
11366
11367 @item gnus-score-followup-article
11368 @findex gnus-score-followup-article
11369 This will add a score to articles that directly follow up your own
11370 article. 
11371
11372 @item gnus-score-followup-thread
11373 @findex gnus-score-followup-thread
11374 This will add a score to all articles that appear in a thread ``below''
11375 your own article.
11376 @end table
11377
11378 @vindex message-sent-hook
11379 These two functions are both primarily meant to be used in hooks like
11380 @code{message-sent-hook}.  
11381
11382 If you look closely at your own @code{Message-ID}, you'll notice that
11383 the first two or three characters are always the same.  Here's two of
11384 mine:  
11385
11386 @example
11387 <x6u3u47icf.fsf@@eyesore.no>
11388 <x6sp9o7ibw.fsf@@eyesore.no>
11389 @end example
11390
11391 So ``my'' ident on this machine is @samp{x6}.  This can be
11392 exploited---the following rule will raise the score on all followups to
11393 myself: 
11394
11395 @lisp
11396 ("references"
11397  ("<x6[0-9a-z]+\\.fsf@.*eyesore.no>" 1000 nil r))
11398 @end lisp
11399
11400 Whether it's the first two or first three characters that are ``yours''
11401 is system-dependent.
11402
11403
11404 @node Scoring Tips
11405 @section Scoring Tips
11406 @cindex scoring tips
11407
11408 @table @dfn
11409
11410 @item Crossposts
11411 @cindex crossposts
11412 @cindex scoring crossposts
11413 If you want to lower the score of crossposts, the line to match on is
11414 the @code{Xref} header.
11415 @lisp
11416 ("xref" (" talk.politics.misc:" -1000))
11417 @end lisp
11418
11419 @item Multiple crossposts
11420 If you want to lower the score of articles that have been crossposted to
11421 more than, say, 3 groups:
11422 @lisp
11423 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11424 @end lisp
11425
11426 @item Matching on the body
11427 This is generally not a very good idea---it takes a very long time.
11428 Gnus actually has to fetch each individual article from the server.  But
11429 you might want to anyway, I guess.  Even though there are three match
11430 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11431 and stick with it in each score file.  If you use any two, each article
11432 will be fetched @emph{twice}.  If you want to match a bit on the
11433 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11434 the matches.  
11435
11436 @item Marking as read
11437 You will probably want to mark articles that has a score below a certain
11438 number as read.  This is most easily achieved by putting the following
11439 in your @file{all.SCORE} file:
11440 @lisp
11441 ((mark -100))
11442 @end lisp
11443 You may also consider doing something similar with @code{expunge}.  
11444
11445 @item Negated character classes
11446 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11447 That will match newlines, which might lead to, well, The Unknown.  Say
11448 @code{[^abcd\n]*} instead.
11449 @end table
11450
11451
11452 @node Reverse Scoring
11453 @section Reverse Scoring
11454 @cindex reverse scoring
11455
11456 If you want to keep just articles that have @samp{Sex with Emacs} in the
11457 subject header, and expunge all other articles, you could put something
11458 like this in your score file:
11459
11460 @lisp
11461 (("subject"
11462   ("Sex with Emacs" 2))
11463  (mark 1)
11464  (expunge 1))
11465 @end lisp
11466
11467 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11468 rest as read, and expunge them to boot.
11469
11470
11471 @node Global Score Files
11472 @section Global Score Files
11473 @cindex global score files
11474
11475 Sure, other newsreaders have ``global kill files''.  These are usually
11476 nothing more than a single kill file that applies to all groups, stored
11477 in the user's home directory.  Bah!  Puny, weak newsreaders!
11478
11479 What I'm talking about here are Global Score Files.  Score files from
11480 all over the world, from users everywhere, uniting all nations in one
11481 big, happy score file union!  Ange-score!  New and untested!
11482
11483 @vindex gnus-global-score-files
11484 All you have to do to use other people's score files is to set the
11485 @code{gnus-global-score-files} variable.  One entry for each score file,
11486 or each score file directory.  Gnus will decide by itself what score
11487 files are applicable to which group.
11488
11489 Say you want to use the score file
11490 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11491 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11492
11493 @lisp
11494 (setq gnus-global-score-files
11495       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11496         "/ftp@@ftp.some-where:/pub/score/"))
11497 @end lisp
11498
11499 @findex gnus-score-search-global-directories
11500 Simple, eh?  Directory names must end with a @samp{/}.  These
11501 directories are typically scanned only once during each Gnus session.
11502 If you feel the need to manually re-scan the remote directories, you can
11503 use the @code{gnus-score-search-global-directories} command.
11504
11505 Note that, at present, using this option will slow down group entry
11506 somewhat.  (That is---a lot.)
11507
11508 If you want to start maintaining score files for other people to use,
11509 just put your score file up for anonymous ftp and announce it to the
11510 world.  Become a retro-moderator!  Participate in the retro-moderator
11511 wars sure to ensue, where retro-moderators battle it out for the
11512 sympathy of the people, luring them to use their score files on false
11513 premises!  Yay!  The net is saved!
11514
11515 Here are some tips for the would-be retro-moderator, off the top of my
11516 head: 
11517
11518 @itemize @bullet
11519
11520 @item 
11521 Articles that are heavily crossposted are probably junk. 
11522 @item
11523 To lower a single inappropriate article, lower by @code{Message-ID}.
11524 @item
11525 Particularly brilliant authors can be raised on a permanent basis. 
11526 @item
11527 Authors that repeatedly post off-charter for the group can safely be
11528 lowered out of existence.
11529 @item
11530 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11531 articles completely.
11532
11533 @item 
11534 Use expiring score entries to keep the size of the file down.  You
11535 should probably have a long expiry period, though, as some sites keep
11536 old articles for a long time.
11537 @end itemize
11538
11539 ... I wonder whether other newsreaders will support global score files
11540 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11541 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11542 holding our breath yet?
11543
11544
11545 @node Kill Files
11546 @section Kill Files
11547 @cindex kill files
11548
11549 Gnus still supports those pesky old kill files.  In fact, the kill file
11550 entries can now be expiring, which is something I wrote before Daniel
11551 Quinlan thought of doing score files, so I've left the code in there.
11552
11553 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11554 than score processing, so it might be a good idea to rewrite your kill
11555 files into score files.
11556
11557 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11558 forms into this file, which means that you can use kill files as some
11559 sort of primitive hook function to be run on group entry, even though
11560 that isn't a very good idea.
11561
11562 Normal kill files look like this:
11563
11564 @lisp
11565 (gnus-kill "From" "Lars Ingebrigtsen")
11566 (gnus-kill "Subject" "ding")
11567 (gnus-expunge "X")
11568 @end lisp
11569
11570 This will mark every article written by me as read, and remove them from
11571 the summary buffer.  Very useful, you'll agree.
11572
11573 Other programs use a totally different kill file syntax.  If Gnus
11574 encounters what looks like a @code{rn} kill file, it will take a stab at
11575 interpreting it. 
11576
11577 Two summary functions for editing a GNUS kill file:
11578
11579 @table @kbd
11580
11581 @item M-k
11582 @kindex M-k (Summary)
11583 @findex gnus-summary-edit-local-kill
11584 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11585
11586 @item M-K
11587 @kindex M-K (Summary)
11588 @findex gnus-summary-edit-global-kill
11589 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11590 @end table
11591
11592 Two group mode functions for editing the kill files:
11593
11594 @table @kbd
11595
11596 @item M-k
11597 @kindex M-k (Group)
11598 @findex gnus-group-edit-local-kill
11599 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11600
11601 @item M-K
11602 @kindex M-K (Group)
11603 @findex gnus-group-edit-global-kill
11604 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11605 @end table
11606
11607 Kill file variables:
11608
11609 @table @code
11610 @item gnus-kill-file-name
11611 @vindex gnus-kill-file-name
11612 A kill file for the group @samp{soc.motss} is normally called
11613 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11614 this file name is detailed by the @code{gnus-kill-file-name} variable.
11615 The ``global'' kill file (not in the score file sense of ``global'', of
11616 course) is called just @file{KILL}.
11617
11618 @vindex gnus-kill-save-kill-file
11619 @item gnus-kill-save-kill-file
11620 If this variable is non-@code{nil}, Gnus will save the
11621 kill file after processing, which is necessary if you use expiring
11622 kills. 
11623
11624 @item gnus-apply-kill-hook
11625 @vindex gnus-apply-kill-hook
11626 @findex gnus-apply-kill-file-unless-scored
11627 @findex gnus-apply-kill-file
11628 A hook called to apply kill files to a group.  It is
11629 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11630 kill file if you have a score file for the same group, you can set this
11631 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11632 kill files to be processed, you should set this variable to @code{nil}.
11633
11634 @item gnus-kill-file-mode-hook
11635 @vindex gnus-kill-file-mode-hook
11636 A hook called in kill-file mode buffers.
11637
11638 @end table
11639
11640
11641 @node Converting Kill Files
11642 @section Converting Kill Files
11643 @cindex kill files
11644 @cindex converting kill files
11645
11646 If you have loads of old kill files, you may want to convert them into
11647 score files.  If they are ``regular'', you can use
11648 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11649 by hand.
11650
11651 The kill to score conversion package isn't included in Gnus by default.
11652 You can fetch it from
11653 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11654
11655 If your old kill files are very complex---if they contain more
11656 non-@code{gnus-kill} forms than not, you'll have to convert them by
11657 hand.  Or just let them be as they are.  Gnus will still use them as
11658 before. 
11659
11660
11661 @node GroupLens
11662 @section GroupLens
11663 @cindex GroupLens
11664
11665 GroupLens is a collaborative filtering system that helps you work
11666 together with other people to find the quality news articles out of the
11667 huge volume of news articles generated every day.
11668
11669 To accomplish this the GroupLens system combines your opinions about
11670 articles you have already read with the opinions of others who have done
11671 likewise and gives you a personalized prediction for each unread news
11672 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11673 rate articles, and finds other people that rate articles the same way.
11674 Once it has found for you some people you agree with it tells you, in
11675 the form of a prediction, what they thought of the article.  You can use
11676 this prediction to help you decide whether or not you want to read the
11677 article.
11678
11679 @menu
11680 * Using GroupLens::          How to make Gnus use GroupLens.
11681 * Rating Articles::          Letting GroupLens know how you rate articles.
11682 * Displaying Predictions::   Displaying predictions given by GroupLens.
11683 * GroupLens Variables::      Customizing GroupLens.
11684 @end menu
11685
11686
11687 @node Using GroupLens
11688 @subsection Using GroupLens
11689
11690 To use GroupLens you must register a pseudonym with your local Better
11691 Bit Bureau (BBB).
11692 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11693 better bit in town is at the moment.
11694
11695 Once you have registered you'll need to set a couple of variables.
11696
11697 @table @code
11698
11699 @item gnus-use-grouplens
11700 @vindex gnus-use-grouplens
11701 Setting this variable to a non-@code{nil} value will make Gnus hook into
11702 all the relevant GroupLens functions.
11703
11704 @item grouplens-pseudonym
11705 @vindex grouplens-pseudonym
11706 This variable should be set to the pseudonym you got when registering
11707 with the Better Bit Bureau.
11708
11709 @item grouplens-newsgroups
11710 @vindex grouplens-newsgroups
11711 A list of groups that you want to get GroupLens predictions for. 
11712
11713 @end table
11714
11715 Thats the minimum of what you need to get up and running with GroupLens.
11716 Once you've registered, GroupLens will start giving you scores for
11717 articles based on the average of what other people think.  But, to get
11718 the real benefit of GroupLens you need to start rating articles
11719 yourself.  Then the scores GroupLens gives you will be personalized for
11720 you, based on how the people you usually agree with have already rated.
11721
11722
11723 @node Rating Articles
11724 @subsection Rating Articles
11725
11726 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11727 Where 1 means something like this article is a waste of bandwidth and 5
11728 means that the article was really good.  The basic question to ask
11729 yourself is, "on a scale from 1 to 5 would I like to see more articles
11730 like this one?"
11731
11732 There are four ways to enter a rating for an article in GroupLens.
11733
11734 @table @kbd
11735
11736 @item r
11737 @kindex r (GroupLens)
11738 @findex bbb-summary-rate-article
11739 This function will prompt you for a rating on a scale of one to five.
11740
11741 @item k
11742 @kindex k (GroupLens)
11743 @findex grouplens-score-thread
11744 This function will prompt you for a rating, and rate all the articles in
11745 the thread.  This is really useful for some of those long running giant
11746 threads in rec.humor.
11747
11748 @end table
11749
11750 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11751 the score of the article you're reading.
11752
11753 @table @kbd
11754
11755 @item 1-5 n
11756 @kindex n (GroupLens)
11757 @findex grouplens-next-unread-article
11758 Rate the article and go to the next unread article.
11759
11760 @item 1-5 ,
11761 @kindex , (GroupLens)
11762 @findex grouplens-best-unread-article
11763 Rate the article and go to the next unread article with the highest score.
11764
11765 @end table
11766
11767 If you want to give the current article a score of 4 and then go to the
11768 next article, just type @kbd{4 n}.
11769
11770
11771 @node Displaying Predictions
11772 @subsection Displaying Predictions
11773
11774 GroupLens makes a prediction for you about how much you will like a
11775 news article.  The predictions from GroupLens are on a scale from 1 to
11776 5, where 1 is the worst and 5 is the best.  You can use the predictions
11777 from GroupLens in one of three ways controlled by the variable
11778 @code{gnus-grouplens-override-scoring}.
11779
11780 @vindex gnus-grouplens-override-scoring
11781 There are three ways to display predictions in grouplens.  You may
11782 choose to have the GroupLens scores contribute to, or override the
11783 regular gnus scoring mechanism. override is the default; however, some
11784 people prefer to see the Gnus scores plus the grouplens scores.  To get
11785 the separate scoring behavior you need to set
11786 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11787 GroupLens predictions combined with the grouplens scores set it to
11788 @code{'override} and to combine the scores set
11789 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11790 the combine option you will also want to set the values for
11791 @code{grouplens-prediction-offset} and
11792 @code{grouplens-score-scale-factor}.
11793
11794 @vindex grouplens-prediction-display
11795 In either case, GroupLens gives you a few choices for how you would like
11796 to see your predictions displayed.  The display of predictions is
11797 controlled by the @code{grouplens-prediction-display} variable.
11798
11799 The following are legal values for that variable.
11800
11801 @table @code
11802 @item prediction-spot
11803 The higher the prediction, the further to the right an @samp{*} is
11804 displayed. 
11805
11806 @item confidence-interval
11807 A numeric confidence interval.
11808
11809 @item prediction-bar
11810 The higher the prediction, the longer the bar.
11811
11812 @item confidence-bar
11813 Numerical confidence.
11814
11815 @item confidence-spot
11816 The spot gets bigger with more confidence.
11817
11818 @item prediction-num
11819 Plain-old numeric value.
11820
11821 @item confidence-plus-minus
11822 Prediction +/i confidence.
11823
11824 @end table
11825
11826
11827 @node GroupLens Variables
11828 @subsection GroupLens Variables
11829
11830 @table @code
11831
11832 @item gnus-summary-grouplens-line-format
11833 The summary line format used in summary buffers that are GroupLens
11834 enhanced.  It accepts the same specs as the normal summary line format
11835 (@pxref{Summary Buffer Lines}).  The default is
11836 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11837
11838 @item grouplens-bbb-host
11839 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
11840 default.
11841
11842 @item grouplens-bbb-port
11843 Port of the host running the bbbd server.  The default is 9000.
11844
11845 @item grouplens-score-offset
11846 Offset the prediction by this value.  In other words, subtract the
11847 prediction value by this number to arrive at the effective score.  The
11848 default is 0.
11849
11850 @item grouplens-score-scale-factor 
11851 This variable allows the user to magnify the effect of GroupLens scores.
11852 The scale factor is applied after the offset.  The default is 1.
11853
11854 @end table
11855
11856
11857 @node Advanced Scoring
11858 @section Advanced Scoring
11859
11860 Scoring on Subjects and From headers is nice enough, but what if you're
11861 really interested in what a person has to say only when she's talking
11862 about a particular subject?  Or what about if you really don't want to
11863 read what person A has to say when she's following up to person B, but
11864 want to read what she says when she's following up to person C?
11865
11866 By using advanced scoring rules you may create arbitrarily complex
11867 scoring patterns.
11868
11869 @menu
11870 * Advanced Scoring Syntax::     A definition.
11871 * Advanced Scoring Examples::   What they look like.
11872 * Advanced Scoring Tips::       Getting the most out of it.
11873 @end menu
11874
11875
11876 @node Advanced Scoring Syntax
11877 @subsection Advanced Scoring Syntax
11878
11879 Ordinary scoring rules have a string as the first element in the rule.
11880 Advanced scoring rules have a list as the first element.  The second
11881 element is the score to be applied if the first element evaluated to a
11882 non-@code{nil} value.
11883
11884 These lists may consist of three logical operators, one redirection
11885 operator, and various match operators.
11886
11887 Logical operators:
11888
11889 @table @code
11890 @item &
11891 @itemx and
11892 This logical operator will evaluate each of its arguments until it finds
11893 one that evaluates to @code{false}, and then it'll stop.  If all arguments
11894 evaluate to @code{true} values, then this operator will return
11895 @code{true}. 
11896
11897 @item |
11898 @itemx or
11899 This logical operator will evaluate each of its arguments until it finds
11900 one that evaluates to @code{true}.  If no arguments are @code{true},
11901 then this operator will return @code{false}.
11902
11903 @item !
11904 @itemx not
11905 @itemx Â¬
11906 This logical operator only takes a single argument.  It returns the
11907 inverse of the value of its argument.
11908
11909 @end table
11910
11911 There is an @dfn{indirection operator} that will make its arguments
11912 apply to the ancestors of the current article being scored.  For
11913 instance, @code{1-} will make score rules apply to the parent of the
11914 current article.  @code{2-} will make score fules apply to the
11915 grandparent of the current article.  Alternatively, you can write
11916 @code{^^}, where the number of @code{^}s (carets) say how far back into
11917 the ancestry you want to go.
11918
11919 Finally, we have the match operators.  These are the ones that do the
11920 real work.  Match operators are header name strings followed by a match
11921 and a match type.  A typical match operator looks like @samp{("from"
11922 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
11923 simple scoring, and the match types are also the same.
11924
11925
11926 @node Advanced Scoring Examples
11927 @subsection Advanced Scoring Examples
11928
11929 Let's say you want to increase the score of articles written by Lars
11930 when he's talking about Gnus:
11931
11932 @example
11933 ((& 
11934   ("from" "Lars Ingebrigtsen")
11935   ("subject" "Gnus"))
11936  1000)
11937 @end example
11938
11939 Quite simple, huh?
11940
11941 When he writes long articles, he sometimes has something nice to say: 
11942
11943 @example
11944 ((& 
11945   ("from" "Lars Ingebrigtsen")
11946   (|
11947    ("subject" "Gnus")
11948    ("lines" 100 >)))
11949  1000)
11950 @end example
11951
11952 However, when he responds to things written by Reig Eigil Logge, you
11953 really don't want to read what he's written:
11954
11955 @example
11956 ((&
11957   ("from" "Lars Ingebrigtsen")
11958   (1- ("from" "Reig Eigir Logge")))
11959  -100000)
11960 @end example
11961
11962 Everybody that follows up Redmondo when he writes about disappearing
11963 socks should have their scores raised, but only when they talk about
11964 white socks.  However, when Lars talks about socks, it's usually not
11965 very interesting:
11966
11967 @example
11968 ((&
11969   (1-
11970    (&
11971     ("from" "redmondo@@.*no" r)
11972     ("body" "disappearing.*socks" t)))
11973   (! ("from" "Lars Ingebrigtsen"))
11974   ("body" "white.*socks"))
11975  1000)
11976 @end example
11977
11978 The possibilities are endless.
11979
11980
11981 @node Advanced Scoring Tips
11982 @subsection Advanced Scoring Tips
11983
11984 The @code{&} and @code{|} logical operators do short-circuit logic.
11985 That is, they stop processing their arguments when it's clear what the
11986 result of the operation will be.  For instance, if one of the arguments
11987 of an @code{&} evaluates to @code{false}, there's no point in evaluating
11988 the rest of the arguments.  This means that you should put slow matches
11989 (@samp{body}, @code{header}) last and quick matches (@samp{from},
11990 @samp{subject}) first.
11991
11992 The indirection arguments (@code{1-} and so on) will make their
11993 arguments work on previous generations of the thread.  If you say
11994 something like:
11995
11996 @example
11997 ...
11998 (1-
11999  (1-
12000   ("from" "lars")))
12001 ...
12002 @end example
12003
12004 Then that means "score on the from header of the grandparent of the
12005 current article".  An indirection is quite fast, but it's better to say:
12006
12007 @example
12008 (1-
12009  (& 
12010   ("from" "Lars")
12011   ("subject" "Gnus")))
12012 @end example
12013
12014 than it is to say:
12015
12016 @example
12017 (&
12018  (1- ("from" "Lars"))
12019  (1- ("subject" "Gnus")))
12020 @end example
12021
12022
12023 @node Score Decays
12024 @section Score Decays
12025 @cindex score decays
12026 @cindex decays
12027
12028 You may find that your scores have a tendency to grow without
12029 bounds, especially if you're using adaptive scoring.  If scores get too
12030 big, they lose all meaning---they simply max out and it's difficult to
12031 use them in any sensible way.
12032
12033 @vindex gnus-decay-scores
12034 @findex gnus-decay-score
12035 @vindex gnus-score-decay-function
12036 Gnus provides a mechanism for decaying scores to help with this problem.
12037 When score files are loaded and @code{gnus-decay-scores} is
12038 non-@code{nil}, Gnus will run the score files through the decaying
12039 mechanism thereby lowering the scores of all non-permanent score rules.
12040 The decay itself if performed by the @code{gnus-score-decay-function}
12041 function, which is @code{gnus-decay-score} by default.  Here's the
12042 definition of that function:
12043
12044 @lisp
12045 (defun gnus-decay-score (score)
12046   (floor
12047    (- score
12048       (* (if (< score 0) 1 -1)
12049          (min score
12050               (max gnus-score-decay-constant
12051                    (* (abs score)
12052                       gnus-score-decay-scale)))))))
12053 @end lisp
12054
12055 @vindex gnus-score-decay-scale
12056 @vindex gnus-score-decay-constant
12057 @code{gnus-score-decay-constant} is 3 by default and
12058 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
12059
12060 @enumerate
12061 @item
12062 Scores between -3 and 3 will be set to 0 when this function is called.
12063
12064 @item
12065 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12066
12067 @item
12068 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12069 score.
12070 @end enumerate
12071
12072 If you don't like this decay function, write your own.  It is called
12073 with the score to be decayed as its only parameter, and it should return
12074 the new score, which should be an integer.
12075
12076 Gnus will try to decay scores once a day.  If you haven't run Gnus for
12077 four days, Gnus will decay the scores four times, for instance.
12078
12079
12080 @node Various
12081 @chapter Various
12082
12083 @menu
12084 * Process/Prefix::             A convention used by many treatment commands.
12085 * Interactive::                Making Gnus ask you many questions.
12086 * Formatting Variables::       You can specify what buffers should look like.
12087 * Windows Configuration::      Configuring the Gnus buffer windows.
12088 * Compilation::                How to speed Gnus up.
12089 * Mode Lines::                 Displaying information in the mode lines.
12090 * Highlighting and Menus::     Making buffers look all nice and cozy.
12091 * Buttons::                    Get tendonitis in ten easy steps!
12092 * Daemons::                    Gnus can do things behind your back.
12093 * NoCeM::                      How to avoid spam and other fatty foods.
12094 * Picons::                     How to display pictures of what your reading.
12095 * Undo::                       Some actions can be undone.
12096 * Moderation::                 What to do if you're a moderator.
12097 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
12098 * Various Various::            Things that are really various.
12099 @end menu
12100
12101
12102 @node Process/Prefix
12103 @section Process/Prefix
12104 @cindex process/prefix convention
12105
12106 Many functions, among them functions for moving, decoding and saving
12107 articles, use what is known as the @dfn{Process/Prefix convention}.
12108
12109 This is a method for figuring out what articles that the user wants the
12110 command to be performed on.
12111
12112 It goes like this:
12113
12114 If the numeric prefix is N, perform the operation on the next N
12115 articles, starting with the current one.  If the numeric prefix is
12116 negative, perform the operation on the previous N articles, starting
12117 with the current one.
12118
12119 @vindex transient-mark-mode
12120 If @code{transient-mark-mode} in non-@code{nil} and the region is
12121 active, all articles in the region will be worked upon.
12122
12123 If there is no numeric prefix, but some articles are marked with the
12124 process mark, perform the operation on the articles that are marked with
12125 the process mark.
12126
12127 If there is neither a numeric prefix nor any articles marked with the
12128 process mark, just perform the operation on the current article.
12129
12130 Quite simple, really, but it needs to be made clear so that surprises
12131 are avoided.
12132
12133 Commands that react to the process mark will push the current list of
12134 process marked articles onto a stack and will then clear all process
12135 marked articles.  You can restore the previous configuration with the
12136 @kbd{M P y} command (@pxref{Setting Process Marks}).
12137
12138 @vindex gnus-summary-goto-unread
12139 One thing that seems to shock & horrify lots of people is that, for
12140 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12141 Since each @kbd{d} (which marks the current article as read) by default
12142 goes to the next unread article after marking, this means that @kbd{3 d}
12143 will mark the next three unread articles as read, no matter what the
12144 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12145 @code{nil} for a more straightforward action.
12146
12147
12148 @node Interactive
12149 @section Interactive
12150 @cindex interaction
12151
12152 @table @code
12153
12154 @item gnus-novice-user
12155 @vindex gnus-novice-user
12156 If this variable is non-@code{nil}, you are either a newcomer to the
12157 World of Usenet, or you are very cautious, which is a nice thing to be,
12158 really.  You will be given questions of the type ``Are you sure you want
12159 to do this?'' before doing anything dangerous.  This is @code{t} by
12160 default.
12161
12162 @item gnus-expert-user
12163 @vindex gnus-expert-user
12164 If this variable is non-@code{nil}, you will never ever be asked any
12165 questions by Gnus.  It will simply assume you know what you're doing, no
12166 matter how strange.
12167
12168 @item gnus-interactive-catchup
12169 @vindex gnus-interactive-catchup
12170 Require confirmation before catching up a group if non-@code{nil}.  It
12171 is @code{t} by default.
12172
12173 @item gnus-interactive-exit
12174 @vindex gnus-interactive-exit
12175 Require confirmation before exiting Gnus.  This variable is @code{t} by
12176 default. 
12177 @end table
12178
12179
12180 @node Formatting Variables
12181 @section Formatting Variables
12182 @cindex formatting variables
12183
12184 Throughout this manual you've probably noticed lots of variables that
12185 are called things like @code{gnus-group-line-format} and
12186 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12187 output lines in the various buffers.  There's quite a lot of them.
12188 Fortunately, they all use the same syntax, so there's not that much to
12189 be annoyed by.
12190
12191 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12192 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12193 lots of percentages everywhere.  
12194
12195 @menu 
12196 * Formatting Basics::     A formatting variable is basically a format string.
12197 * Advanced Formatting::   Modifying output in various ways.
12198 * User-Defined Specs::    Having Gnus call your own functions.
12199 * Formatting Fonts::      Making the formatting look colorful and nice.
12200 @end menu
12201
12202 Currently Gnus uses the following formatting variables:
12203 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12204 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12205 @code{gnus-group-mode-line-format},
12206 @code{gnus-summary-mode-line-format},
12207 @code{gnus-article-mode-line-format},
12208 @code{gnus-server-mode-line-format}, and
12209 @code{gnus-summary-pick-line-format}.
12210
12211 All these format variables can also be arbitrary elisp forms.  In that
12212 case, they will be @code{eval}ed to insert the required lines.
12213
12214 @kindex M-x gnus-update-format
12215 @findex gnus-update-format
12216 Gnus includes a command to help you while creating your own format
12217 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12218 update the spec in question and pop you to a buffer where you can
12219 examine the resulting lisp code to be run to generate the line.  
12220
12221
12222
12223 @node Formatting Basics
12224 @subsection Formatting Basics
12225
12226 Each @samp{%} element will be replaced by some string or other when the
12227 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12228 spec, and pad with spaces to get a 5-character field''.
12229
12230 As with normal C and Emacs Lisp formatting strings, the numerical
12231 modifier between the @samp{%} and the formatting type character will
12232 @dfn{pad} the output so that it is always at least that long.
12233 @samp{%5y} will make the field always (at least) five characters wide by
12234 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12235 the right instead.
12236
12237 You may also wish to limit the length of the field to protect against
12238 particularly wide values.  For that you can say @samp{%4,6y}, which
12239 means that the field will never be more than 6 characters wide and never
12240 less than 4 characters wide.
12241
12242
12243 @node Advanced Formatting
12244 @subsection Advanced Formatting
12245
12246 It is frequently useful to post-process the fields in some way.
12247 Padding, limiting, cutting off parts and suppressing certain values can
12248 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12249 look like @samp{%~(cut 3)~(ignore "0")y}.
12250
12251 These are the legal modifiers:
12252
12253 @table @code
12254 @item pad
12255 @itemx pad-left
12256 Pad the field to the left with spaces until it reaches the required
12257 length.
12258
12259 @item pad-right
12260 Pad the field to the right with spaces until it reaches the required
12261 length.
12262
12263 @item max
12264 @itemx max-left
12265 Cut off characters from the left until it reaches the specified length.
12266
12267 @item max-right
12268 Cut off characters from the right until it reaches the specified
12269 length. 
12270
12271 @item cut
12272 @itemx cut-left
12273 Cut off the specified number of characters from the left.
12274
12275 @item cut-right
12276 Cut off the specified number of characters from the right.
12277
12278 @item ignore
12279 Return an empty string if the field is equal to the specified value. 
12280
12281 @item form
12282 Use the specified form as the field value when the @samp{@@} spec is
12283 used. 
12284 @end table
12285
12286 Let's take an example.  The @samp{%o} spec in the summary mode lines
12287 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12288 This is quite a mouthful, so we want to shave off the century number and
12289 the time, leaving us with a six-character date.  That would be
12290 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12291 maxing, and we need the padding to ensure that the date is never less
12292 than 6 characters to make it look nice in columns.)
12293
12294 Ignoring is done first; then cutting; then maxing; and then as the very
12295 last operation, padding.  
12296
12297 If you use lots of these advanced thingies, you'll find that Gnus gets
12298 quite slow.  This can be helped enormously by running @kbd{M-x
12299 gnus-compile} when you are satisfied with the look of your lines.
12300 @xref{Compilation}. 
12301
12302
12303 @node User-Defined Specs
12304 @subsection User-Defined Specs
12305
12306 All the specs allow for inserting user defined specifiers---@samp{u}.
12307 The next character in the format string should be a letter.  Gnus
12308 will call the function @code{gnus-user-format-function-}@samp{X}, where
12309 @samp{X} is the letter following @samp{%u}.  The function will be passed
12310 a single parameter---what the parameter means depends on what buffer
12311 it's being called from.  The function should return a string, which will
12312 be inserted into the buffer just like information from any other
12313 specifier.  This function may also be called with dummy values, so it
12314 should protect against that.
12315
12316 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12317 much the same without defining new functions.  Here's an example:
12318 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12319 given here will be evaluated to yield the current line number, and then
12320 inserted.
12321
12322
12323 @node Formatting Fonts
12324 @subsection Formatting Fonts
12325
12326 There are specs for highlighting, and these are shared by all the format
12327 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12328 the special @code{mouse-face} property set, which means that it will be
12329 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12330 over it.
12331
12332 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12333 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12334 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12335 instead, and so on.  Create as many faces as you wish.  The same goes
12336 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12337 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12338
12339 Here's an alternative recipe for the group buffer:
12340
12341 @lisp
12342 ;; Create three face types.
12343 (setq gnus-face-1 'bold)
12344 (setq gnus-face-3 'italic)
12345
12346 ;; We want the article count to be in 
12347 ;; a bold and green face.  So we create 
12348 ;; a new face called `my-green-bold'.
12349 (copy-face 'bold 'my-green-bold)
12350 ;; Set the color.
12351 (set-face-foreground 'my-green-bold "ForestGreen")
12352 (setq gnus-face-2 'my-green-bold)
12353
12354 ;; Set the new & fancy format.
12355 (setq gnus-group-line-format 
12356       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12357 @end lisp
12358
12359 I'm sure you'll be able to use this scheme to create totally unreadable
12360 and extremely vulgar displays.  Have fun!
12361
12362 Note that the @samp{%(} specs (and friends) do not make any sense on the
12363 mode-line variables.
12364
12365
12366 @node Windows Configuration
12367 @section Windows Configuration
12368 @cindex windows configuration
12369
12370 No, there's nothing here about X, so be quiet.
12371
12372 @vindex gnus-use-full-window
12373 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12374 other windows and occupy the entire Emacs screen by itself.  It is
12375 @code{t} by default.
12376
12377 @vindex gnus-buffer-configuration
12378 @code{gnus-buffer-configuration} describes how much space each Gnus
12379 buffer should be given.  Here's an excerpt of this variable:
12380
12381 @lisp
12382 ((group (vertical 1.0 (group 1.0 point)
12383                       (if gnus-carpal (group-carpal 4))))
12384  (article (vertical 1.0 (summary 0.25 point) 
12385                         (article 1.0))))
12386 @end lisp
12387
12388 This is an alist.  The @dfn{key} is a symbol that names some action or
12389 other.  For instance, when displaying the group buffer, the window
12390 configuration function will use @code{group} as the key.  A full list of
12391 possible names is listed below.
12392
12393 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12394 should occupy.  To take the @code{article} split as an example -
12395
12396 @lisp
12397 (article (vertical 1.0 (summary 0.25 point)
12398                        (article 1.0)))
12399 @end lisp
12400
12401 This @dfn{split} says that the summary buffer should occupy 25% of upper
12402 half of the screen, and that it is placed over the article buffer.  As
12403 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12404 reaching for that calculator there).  However, the special number
12405 @code{1.0} is used to signal that this buffer should soak up all the
12406 rest of the space available after the rest of the buffers have taken
12407 whatever they need.  There should be only one buffer with the @code{1.0}
12408 size spec per split.
12409
12410 Point will be put in the buffer that has the optional third element
12411 @code{point}. 
12412
12413 Here's a more complicated example:
12414
12415 @lisp
12416 (article (vertical 1.0 (group 4)
12417                        (summary 0.25 point)
12418                        (if gnus-carpal (summary-carpal 4))
12419                        (article 1.0)))
12420 @end lisp
12421
12422 If the size spec is an integer instead of a floating point number, 
12423 then that number will be used to say how many lines a buffer should
12424 occupy, not a percentage.
12425
12426 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12427 precise---if the @code{car} of the split is a function or a subr), this
12428 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12429 be used as a split.  This means that there will be three buffers if
12430 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12431 is non-@code{nil}.
12432
12433 Not complicated enough for you?  Well, try this on for size:
12434
12435 @lisp
12436 (article (horizontal 1.0 
12437              (vertical 0.5
12438                  (group 1.0)
12439                  (gnus-carpal 4))
12440              (vertical 1.0
12441                  (summary 0.25 point)
12442                  (summary-carpal 4)
12443                  (article 1.0))))
12444 @end lisp
12445
12446 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12447 @code{horizontal} thingie?  
12448
12449 If the first element in one of the split is @code{horizontal}, Gnus will
12450 split the window horizontally, giving you two windows side-by-side.
12451 Inside each of these strips you may carry on all you like in the normal
12452 fashion.  The number following @code{horizontal} says what percentage of
12453 the screen is to be given to this strip.
12454
12455 For each split, there @emph{must} be one element that has the 100% tag.
12456 The splitting is never accurate, and this buffer will eat any leftover
12457 lines from the splits.
12458
12459 To be slightly more formal, here's a definition of what a legal split
12460 may look like:
12461
12462 @example
12463 split       = frame | horizontal | vertical | buffer | form
12464 frame       = "(frame " size *split ")"
12465 horizontal  = "(horizontal " size *split ")"
12466 vertical    = "(vertical " size *split ")"
12467 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12468 size        = number | frame-params
12469 buffer-name = group | article | summary ...
12470 @end example
12471
12472 The limitations are that the @code{frame} split can only appear as the
12473 top-level split.  @var{form} should be an Emacs Lisp form that should
12474 return a valid split.  We see that each split is fully recursive, and
12475 may contain any number of @code{vertical} and @code{horizontal} splits. 
12476
12477 @vindex gnus-window-min-width
12478 @vindex gnus-window-min-height
12479 @cindex window height
12480 @cindex window width
12481 Finding the right sizes can be a bit complicated.  No window may be less
12482 than @code{gnus-window-min-height} (default 1) characters high, and all
12483 windows must be at least @code{gnus-window-min-width} (default 1)
12484 characters wide.  Gnus will try to enforce this before applying the
12485 splits.  If you want to use the normal Emacs window width/height limit,
12486 you can just set these two variables to @code{nil}.
12487
12488 If you're not familiar with Emacs terminology, @code{horizontal} and
12489 @code{vertical} splits may work the opposite way of what you'd expect.
12490 Windows inside a @code{horizontal} split are shown side-by-side, and
12491 windows within a @code{vertical} split are shown above each other.
12492
12493 @findex gnus-configure-frame
12494 If you want to experiment with window placement, a good tip is to call
12495 @code{gnus-configure-frame} directly with a split.  This is the function
12496 that does all the real work when splitting buffers.  Below is a pretty
12497 nonsensical configuration with 5 windows; two for the group buffer and
12498 three for the article buffer.  (I said it was nonsensical.)  If you
12499 @code{eval} the statement below, you can get an idea of how that would
12500 look straight away, without going through the normal Gnus channels.
12501 Play with it until you're satisfied, and then use
12502 @code{gnus-add-configuration} to add your new creation to the buffer
12503 configuration list. 
12504
12505 @lisp
12506 (gnus-configure-frame
12507  '(horizontal 1.0
12508     (vertical 10
12509       (group 1.0)
12510       (article 0.3 point))
12511     (vertical 1.0
12512       (article 1.0)
12513       (horizontal 4
12514         (group 1.0)
12515         (article 10)))))
12516 @end lisp
12517
12518 You might want to have several frames as well.  No prob---just use the
12519 @code{frame} split:
12520
12521 @lisp
12522 (gnus-configure-frame
12523  '(frame 1.0
12524          (vertical 1.0
12525                    (summary 0.25 point)
12526                    (article 1.0))
12527          (vertical ((height . 5) (width . 15)
12528                     (user-position . t)
12529                     (left . -1) (top . 1))
12530                    (picon 1.0))))
12531
12532 @end lisp
12533
12534 This split will result in the familiar summary/article window
12535 configuration in the first (or ``main'') frame, while a small additional
12536 frame will be created where picons will be shown.  As you can see,
12537 instead of the normal @code{1.0} top-level spec, each additional split
12538 should have a frame parameter alist as the size spec.
12539 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12540 Reference Manual}.
12541
12542 Here's a list of all possible keys for
12543 @code{gnus-buffer-configuration}:
12544
12545 @code{group}, @code{summary}, @code{article}, @code{server},
12546 @code{browse}, @code{message}, @code{pick}, @code{info},
12547 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12548 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12549 @code{reply-yank}, @code{mail-bounce}, @code{draft},
12550 @code{pipe}, @code{bug}, @code{compose-bounce}.  
12551
12552 Note that the @code{message} key is used for both
12553 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12554 it is desirable to distinguish between the two, something like this
12555 might be used:
12556
12557 @lisp
12558 (message (horizontal 1.0
12559                      (vertical 1.0 (message 1.0 point))
12560                      (vertical 0.24
12561                                (if (buffer-live-p gnus-summary-buffer)
12562                                    '(summary 0.5))
12563                                (group 1.0)))))
12564 @end lisp
12565
12566 @findex gnus-add-configuration
12567 Since the @code{gnus-buffer-configuration} variable is so long and
12568 complicated, there's a function you can use to ease changing the config
12569 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12570 you want to change the @code{article} setting, you could say:
12571
12572 @lisp
12573 (gnus-add-configuration
12574  '(article (vertical 1.0
12575                (group 4)
12576                (summary .25 point)
12577                (article 1.0))))
12578 @end lisp
12579
12580 You'd typically stick these @code{gnus-add-configuration} calls in your
12581 @file{.gnus.el} file or in some startup hook---they should be run after
12582 Gnus has been loaded.
12583
12584 @vindex gnus-always-force-window-configuration
12585 If all windows mentioned in the configuration are already visible, Gnus
12586 won't change the window configuration.  If you always want to force the
12587 ``right'' window configuration, you can set
12588 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12589
12590
12591 @node Compilation
12592 @section Compilation
12593 @cindex compilation
12594 @cindex byte-compilation
12595
12596 @findex gnus-compile
12597
12598 Remember all those line format specification variables?
12599 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12600 on.  Now, Gnus will of course heed whatever these variables are, but,
12601 unfortunately, changing them will mean a quite significant slow-down.
12602 (The default values of these variables have byte-compiled functions
12603 associated with them, while the user-generated versions do not, of
12604 course.) 
12605
12606 To help with this, you can run @kbd{M-x gnus-compile} after you've
12607 fiddled around with the variables and feel that you're (kind of)
12608 satisfied.  This will result in the new specs being byte-compiled, and
12609 you'll get top speed again.  Gnus will save these compiled specs in the
12610 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12611 this function, though---you should compile them yourself by sticking
12612 them into the @code{.gnus.el} file and byte-compiling that file.)
12613
12614
12615 @node Mode Lines
12616 @section Mode Lines
12617 @cindex mode lines
12618
12619 @vindex gnus-updated-mode-lines
12620 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12621 lines updated.  It is a list of symbols.  Supported symbols include
12622 @code{group}, @code{article}, @code{summary}, @code{server},
12623 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12624 Gnus will keep that mode line updated with information that may be
12625 pertinent.  If this variable is @code{nil}, screen refresh may be
12626 quicker.
12627
12628 @cindex display-time
12629
12630 @vindex gnus-mode-non-string-length
12631 By default, Gnus displays information on the current article in the mode
12632 lines of the summary and article buffers.  The information Gnus wishes
12633 to display (e.g. the subject of the article) is often longer than the
12634 mode lines, and therefore have to be cut off at some point.  The
12635 @code{gnus-mode-non-string-length} variable says how long the other
12636 elements on the line is (i.e., the non-info part).  If you put
12637 additional elements on the mode line (e.g. a clock), you should modify
12638 this variable:
12639
12640 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12641 @lisp
12642 (add-hook 'display-time-hook
12643           (lambda () (setq gnus-mode-non-string-length
12644                            (+ 21
12645                               (if line-number-mode 5 0)
12646                               (if column-number-mode 4 0)
12647                               (length display-time-string)))))
12648 @end lisp
12649
12650 If this variable is @code{nil} (which is the default), the mode line
12651 strings won't be chopped off, and they won't be padded either.
12652 Note that the default is unlikely to be desirable, as even the
12653 percentage complete in the buffer may be crowded off the mode line;
12654 the user should configure this variable appropriately for their
12655 configuration.
12656
12657
12658 @node Highlighting and Menus
12659 @section Highlighting and Menus
12660 @cindex visual
12661 @cindex highlighting
12662 @cindex menus
12663
12664 @vindex gnus-visual
12665 The @code{gnus-visual} variable controls most of the prettifying Gnus
12666 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12667 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12668 file.
12669
12670 This variable can be a list of visual properties that are enabled.  The
12671 following elements are legal, and are all included by default:
12672
12673 @table @code
12674 @item group-highlight
12675 Do highlights in the group buffer.
12676 @item summary-highlight
12677 Do highlights in the summary buffer.
12678 @item article-highlight
12679 Do highlights in the article buffer.
12680 @item highlight
12681 Turn on highlighting in all buffers.
12682 @item group-menu
12683 Create menus in the group buffer.
12684 @item summary-menu
12685 Create menus in the summary buffers.
12686 @item article-menu
12687 Create menus in the article buffer.
12688 @item browse-menu
12689 Create menus in the browse buffer.
12690 @item server-menu
12691 Create menus in the server buffer.
12692 @item score-menu
12693 Create menus in the score buffers.
12694 @item menu
12695 Create menus in all buffers.
12696 @end table
12697
12698 So if you only want highlighting in the article buffer and menus in all
12699 buffers, you could say something like:
12700
12701 @lisp
12702 (setq gnus-visual '(article-highlight menu))
12703 @end lisp
12704
12705 If you want only highlighting and no menus whatsoever, you'd say:
12706
12707 @lisp
12708 (setq gnus-visual '(highlight))
12709 @end lisp
12710
12711 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12712 in all Gnus buffers.
12713
12714 Other general variables that influence the look of all buffers include:
12715
12716 @table @code
12717 @item gnus-mouse-face
12718 @vindex gnus-mouse-face
12719 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12720 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12721
12722 @end table
12723
12724 There are hooks associated with the creation of all the different menus:
12725
12726 @table @code
12727
12728 @item gnus-article-menu-hook
12729 @vindex gnus-article-menu-hook
12730 Hook called after creating the article mode menu.
12731
12732 @item gnus-group-menu-hook
12733 @vindex gnus-group-menu-hook
12734 Hook called after creating the group mode menu.
12735
12736 @item gnus-summary-menu-hook
12737 @vindex gnus-summary-menu-hook
12738 Hook called after creating the summary mode menu.
12739
12740 @item gnus-server-menu-hook
12741 @vindex gnus-server-menu-hook
12742 Hook called after creating the server mode menu.
12743
12744 @item gnus-browse-menu-hook
12745 @vindex gnus-browse-menu-hook
12746 Hook called after creating the browse mode menu.
12747
12748 @item gnus-score-menu-hook
12749 @vindex gnus-score-menu-hook
12750 Hook called after creating the score mode menu.
12751
12752 @end table
12753
12754
12755 @node Buttons
12756 @section Buttons
12757 @cindex buttons
12758 @cindex mouse
12759 @cindex click
12760
12761 Those new-fangled @dfn{mouse} contraptions is very popular with the
12762 young, hep kids who don't want to learn the proper way to do things
12763 these days.  Why, I remember way back in the summer of '89, when I was
12764 using Emacs on a Tops 20 system.  Three hundred users on one single
12765 machine, and every user was running Simula compilers.  Bah!
12766
12767 Right.
12768
12769 @vindex gnus-carpal
12770 Well, you can make Gnus display bufferfuls of buttons you can click to
12771 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12772 really.  Tell the chiropractor I sent you.
12773
12774
12775 @table @code
12776
12777 @item gnus-carpal-mode-hook
12778 @vindex gnus-carpal-mode-hook
12779 Hook run in all carpal mode buffers.
12780
12781 @item gnus-carpal-button-face
12782 @vindex gnus-carpal-button-face
12783 Face used on buttons.
12784
12785 @item gnus-carpal-header-face
12786 @vindex gnus-carpal-header-face
12787 Face used on carpal buffer headers.
12788
12789 @item gnus-carpal-group-buffer-buttons
12790 @vindex gnus-carpal-group-buffer-buttons
12791 Buttons in the group buffer.
12792
12793 @item gnus-carpal-summary-buffer-buttons
12794 @vindex gnus-carpal-summary-buffer-buttons
12795 Buttons in the summary buffer.
12796
12797 @item gnus-carpal-server-buffer-buttons
12798 @vindex gnus-carpal-server-buffer-buttons
12799 Buttons in the server buffer.
12800
12801 @item gnus-carpal-browse-buffer-buttons
12802 @vindex gnus-carpal-browse-buffer-buttons
12803 Buttons in the browse buffer.
12804 @end table
12805
12806 All the @code{buttons} variables are lists.  The elements in these list
12807 is either a cons cell where the car contains a text to be displayed and
12808 the cdr contains a function symbol, or a simple string.
12809
12810
12811 @node Daemons
12812 @section Daemons
12813 @cindex demons
12814 @cindex daemons
12815
12816 Gnus, being larger than any program ever written (allegedly), does lots
12817 of strange stuff that you may wish to have done while you're not
12818 present.  For instance, you may want it to check for new mail once in a
12819 while.  Or you may want it to close down all connections to all servers
12820 when you leave Emacs idle.  And stuff like that.
12821
12822 Gnus will let you do stuff like that by defining various
12823 @dfn{handlers}.  Each handler consists of three elements:  A
12824 @var{function}, a @var{time}, and an @var{idle} parameter.
12825
12826 Here's an example of a handler that closes connections when Emacs has
12827 been idle for thirty minutes:
12828
12829 @lisp
12830 (gnus-demon-close-connections nil 30)
12831 @end lisp
12832
12833 Here's a handler that scans for PGP headers every hour when Emacs is
12834 idle: 
12835
12836 @lisp
12837 (gnus-demon-scan-pgp 60 t)
12838 @end lisp
12839
12840 This @var{time} parameter and than @var{idle} parameter works together
12841 in a strange, but wonderful fashion.  Basically, if @var{idle} is
12842 @code{nil}, then the function will be called every @var{time} minutes.
12843
12844 If @var{idle} is @code{t}, then the function will be called after
12845 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
12846 the function will never be called.  But once Emacs goes idle, the
12847 function will be called every @var{time} minutes.
12848
12849 If @var{idle} is a number and @var{time} is a number, the function will
12850 be called every @var{time} minutes only when Emacs has been idle for
12851 @var{idle} minutes.
12852
12853 If @var{idle} is a number and @var{time} is @code{nil}, the function
12854 will be called once every time Emacs has been idle for @var{idle}
12855 minutes.  
12856
12857 And if @var{time} is a string, it should look like @samp{07:31}, and
12858 the function will then be called once every day somewhere near that
12859 time.  Modified by the @var{idle} parameter, of course.
12860
12861 @vindex gnus-demon-timestep
12862 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12863 seconds.  This is 60 by default.  If you change that variable,
12864 all the timings in the handlers will be affected.)
12865
12866 @vindex gnus-use-demon
12867 To set the whole thing in motion, though, you have to set
12868 @code{gnus-use-demon} to @code{t}.
12869
12870 So, if you want to add a handler, you could put something like this in
12871 your @file{.gnus} file:
12872
12873 @findex gnus-demon-add-handler
12874 @lisp
12875 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12876 @end lisp
12877
12878 @findex gnus-demon-add-nocem
12879 @findex gnus-demon-add-scanmail
12880 @findex gnus-demon-add-rescan
12881 @findex gnus-demon-add-disconnection
12882 Some ready-made functions to do this has been created:
12883 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12884 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}.  Just
12885 put those functions in your @file{.gnus} if you want those abilities.
12886
12887 @findex gnus-demon-init
12888 @findex gnus-demon-cancel
12889 @vindex gnus-demon-handlers
12890 If you add handlers to @code{gnus-demon-handlers} directly, you should
12891 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
12892 daemons, you can use the @code{gnus-demon-cancel} function.
12893
12894 Note that adding daemons can be pretty naughty if you overdo it.  Adding
12895 functions that scan all news and mail from all servers every two seconds
12896 is a sure-fire way of getting booted off any respectable system.  So
12897 behave. 
12898
12899
12900 @node NoCeM
12901 @section NoCeM
12902 @cindex nocem
12903 @cindex spam
12904
12905 @dfn{Spamming} is posting the same article lots and lots of times.
12906 Spamming is bad.  Spamming is evil.  
12907
12908 Spamming is usually canceled within a day or so by various anti-spamming
12909 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
12910 NoCeM is pronounced ``no see-'em'', and means what the name
12911 implies---these are messages that make the offending articles, like, go
12912 away.  
12913
12914 What use are these NoCeM messages if the articles are canceled anyway?
12915 Some sites do not honor cancel messages and some sites just honor cancels
12916 from a select few people.  Then you may wish to make use of the NoCeM
12917 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12918
12919 Gnus can read and parse the messages in this group automatically, and
12920 this will make spam disappear.  
12921
12922 There are some variables to customize, of course:
12923
12924 @table @code
12925 @item gnus-use-nocem
12926 @vindex gnus-use-nocem
12927 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
12928 by default. 
12929
12930 @item gnus-nocem-groups
12931 @vindex gnus-nocem-groups
12932 Gnus will look for NoCeM messages in the groups in this list.  The
12933 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
12934 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
12935
12936 @item gnus-nocem-issuers
12937 @vindex gnus-nocem-issuers
12938 There are many people issuing NoCeM messages.  This list says what
12939 people you want to listen to.  The default is @code{("Automoose-1"
12940 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
12941 (Richard E. Depew)")}; fine, upstanding citizens all of them.
12942
12943 Known despammers that you can put in this list include:
12944
12945 @table @samp
12946 @item clewis@@ferret.ocunix.on.ca;
12947 @cindex Chris Lewis
12948 Chris Lewis---Major Canadian despammer who has probably canceled more
12949 usenet abuse than anybody else.
12950
12951 @item Automoose-1
12952 @cindex CancelMoose[tm]
12953 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
12954 Norwegian, and was the person(s) who invented NoCeM.  
12955
12956 @item jem@@xpat.com;
12957 @cindex Jem
12958 John Milburn---despammer located in Korea who is getting very busy these
12959 days.
12960
12961 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
12962 Richard E. Depew---lone American despammer.  He mostly cancels binary
12963 postings to non-binary groups and removes spews (regurgitated articles).
12964 @end table
12965
12966 You do not have to heed NoCeM messages from all these people---just the
12967 ones you want to listen to.
12968
12969 @item gnus-nocem-verifyer
12970 @vindex gnus-nocem-verifyer
12971 @findex mc-verify
12972 This should be a function for verifying that the NoCeM issuer is who she
12973 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
12974 function.  If this is too slow and you don't care for verification
12975 (which may be dangerous), you can set this variable to @code{nil}.
12976
12977 @item gnus-nocem-directory
12978 @vindex gnus-nocem-directory
12979 This is where Gnus will store its NoCeM cache files.  The default is
12980 @file{~/News/NoCeM/}. 
12981
12982 @item gnus-nocem-expiry-wait
12983 @vindex gnus-nocem-expiry-wait
12984 The number of days before removing old NoCeM entries from the cache.
12985 The default is 15.  If you make it shorter Gnus will be faster, but you
12986 might then see old spam.
12987
12988 @end table
12989
12990
12991 @node Picons
12992 @section Picons
12993
12994 So...  You want to slow down your news reader even more!  This is a
12995 good way to do so.  Its also a great way to impress people staring
12996 over your shoulder as you read news.
12997
12998 @menu
12999 * Picon Basics::           What are picons and How do I get them.
13000 * Picon Requirements::     Don't go further if you aren't using XEmacs.
13001 * Easy Picons::            Displaying Picons---the easy way.
13002 * Hard Picons::            The way you should do it.  You'll learn something.
13003 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
13004 @end menu
13005
13006
13007 @node Picon Basics
13008 @subsection Picon Basics
13009
13010 What are Picons?  To quote directly from the Picons Web site:
13011
13012 @quotation 
13013 @dfn{Picons} is short for ``personal icons''.  They're small,
13014 constrained images used to represent users and domains on the net,
13015 organized into databases so that the appropriate image for a given
13016 e-mail address can be found.  Besides users and domains, there are picon
13017 databases for Usenet newsgroups and weather forecasts.  The picons are
13018 in either monochrome @code{XBM} format or color @code{XPM} and
13019 @code{GIF} formats.
13020 @end quotation
13021
13022 For instructions on obtaining and installing the picons databases, point
13023 your Web browser at
13024 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13025
13026 @vindex gnus-picons-database
13027 Gnus expects picons to be installed into a location pointed to by
13028 @code{gnus-picons-database}.
13029
13030
13031 @node Picon Requirements
13032 @subsection Picon Requirements
13033
13034 To use have Gnus display Picons for you, you must be running XEmacs
13035 19.13 or greater since all other versions of Emacs aren't yet able to
13036 display images.
13037
13038 Additionally, you must have @code{xpm} support compiled into XEmacs.
13039
13040 @vindex gnus-picons-convert-x-face
13041 If you want to display faces from @code{X-Face} headers, you must have
13042 the @code{netpbm} utilities installed, or munge the
13043 @code{gnus-picons-convert-x-face} variable to use something else.
13044
13045
13046 @node Easy Picons
13047 @subsection Easy Picons
13048
13049 To enable displaying picons, simply put the following line in your
13050 @file{~/.gnus} file and start Gnus.
13051
13052 @lisp
13053 (setq gnus-use-picons t)
13054 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13055 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13056 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13057 @end lisp
13058
13059
13060 @node Hard Picons
13061 @subsection Hard Picons 
13062
13063 Gnus can display picons for you as you enter and leave groups and
13064 articles.  It knows how to interact with three sections of the picons
13065 database.  Namely, it can display the picons newsgroup pictures,
13066 author's face picture(s), and the authors domain.  To enable this
13067 feature, you need to first decide where to display them.
13068
13069 @table @code 
13070
13071 @item gnus-picons-display-where 
13072 @vindex gnus-picons-display-where 
13073 Where the picon images should be displayed.  It is @code{picons} by
13074 default (which by default maps to the buffer @samp{*Picons*}).  Other
13075 valid places could be @code{article}, @code{summary}, or
13076 @samp{*scratch*} for all I care.  Just make sure that you've made the
13077 buffer visible using the standard Gnus window configuration
13078 routines---@pxref{Windows Configuration}.
13079
13080 @end table
13081
13082 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13083 window configuration for you to include the @code{picons} buffer.
13084
13085 Now that you've made that decision, you need to add the following
13086 functions to the appropriate hooks so these pictures will get
13087 displayed at the right time.
13088
13089 @vindex gnus-article-display-hook
13090 @vindex gnus-picons-display-where
13091 @table @code
13092 @item gnus-article-display-picons
13093 @findex gnus-article-display-picons
13094 Looks up and display the picons for the author and the author's domain
13095 in the @code{gnus-picons-display-where} buffer.  Should be added to
13096 the @code{gnus-article-display-hook}.
13097
13098 @item gnus-group-display-picons
13099 @findex gnus-article-display-picons
13100 Displays picons representing the current group.  This function should
13101 be added to the @code{gnus-summary-prepare-hook} or to the
13102 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13103 is set to @code{article}.
13104
13105 @item gnus-picons-article-display-x-face
13106 @findex gnus-article-display-picons
13107 Decodes and displays the X-Face header if present.  This function
13108 should be added to @code{gnus-article-display-hook}.
13109
13110 @end table
13111
13112 Note:  You must append them to the hook, so make sure to specify 't'
13113 to the append flag of @code{add-hook}:
13114
13115 @lisp
13116 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13117 @end lisp
13118
13119
13120 @node Picon Configuration
13121 @subsection Picon Configuration
13122
13123 The following variables offer further control over how things are
13124 done, where things are located, and other useless stuff you really
13125 don't need to worry about.
13126
13127 @table @code
13128 @item gnus-picons-database
13129 @vindex gnus-picons-database
13130 The location of the picons database.  Should point to a directory
13131 containing the @file{news}, @file{domains}, @file{users} (and so on)
13132 subdirectories.  Defaults to @file{/usr/local/faces}.
13133
13134 @item gnus-picons-news-directory
13135 @vindex gnus-picons-news-directory
13136 Sub-directory of the faces database containing the icons for
13137 newsgroups.
13138
13139 @item gnus-picons-user-directories
13140 @vindex gnus-picons-user-directories
13141 List of subdirectories to search in @code{gnus-picons-database} for user
13142 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13143
13144 @item gnus-picons-domain-directories
13145 @vindex gnus-picons-domain-directories
13146 List of subdirectories to search in @code{gnus-picons-database} for
13147 domain name faces.  Defaults to @code{("domains")}.  Some people may
13148 want to add @samp{unknown} to this list.
13149
13150 @item gnus-picons-convert-x-face
13151 @vindex gnus-picons-convert-x-face
13152 The command to use to convert the @code{X-Face} header to an X bitmap
13153 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13154 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13155 gnus-picons-x-face-file-name)}
13156
13157 @item gnus-picons-x-face-file-name
13158 @vindex gnus-picons-x-face-file-name
13159 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13160 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13161
13162 @item gnus-picons-buffer
13163 @vindex gnus-picons-buffer
13164 The name of the buffer that @code{picons} points to.  Defaults to
13165 @samp{*Icon Buffer*}.
13166
13167 @end table
13168
13169
13170 @node Undo
13171 @section Undo
13172 @cindex undo
13173
13174 It is very useful to be able to undo actions one has done.  In normal
13175 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13176 In Gnus buffers, however, it isn't that simple.
13177
13178 The things Gnus displays in its buffer is of no value whatsoever to
13179 Gnus---it's all just data that is designed to look nice to the user.
13180 Killing a group in the group buffer with @kbd{C-k} makes the line
13181 disappear, but that's just a side-effect of the real action---the
13182 removal of the group in question from the internal Gnus structures.
13183 Undoing something like that can't be done by the normal Emacs
13184 @code{undo} function.
13185
13186 Gnus tries to remedy this somewhat by keeping track of what the user
13187 does and coming up with actions that would reverse the actions the user
13188 takes.  When the user then presses the @code{undo} key, Gnus will run
13189 the code to reverse the previous action, or the previous actions.
13190 However, not all actions are easily reversible, so Gnus currently offers
13191 a few key functions to be undoable.  These include killing groups,
13192 yanking groups, and changing the list of read articles of groups.
13193 That's it, really.  More functions may be added in the future, but each
13194 added function means an increase in data to be stored, so Gnus will
13195 never be totally undoable.
13196
13197 @findex gnus-undo-mode
13198 @vindex gnus-use-undo
13199 @findex gnus-undo
13200 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13201 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13202 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13203 command, which should feel kinda like the normal Emacs @code{undo}
13204 command. 
13205
13206
13207 @node Moderation
13208 @section Moderation
13209 @cindex moderation
13210
13211 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13212 It is not included in the standard Gnus package.  Write a mail to
13213 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13214 get a copy.
13215
13216 The moderation package is implemented as a minor mode for summary
13217 buffers.  Put
13218
13219 @lisp
13220 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13221 @end lisp
13222
13223 in your @file{.gnus.el} file.
13224
13225 If you are the moderation of @samp{rec.zoofle}, this is how it's
13226 supposed to work:
13227
13228 @enumerate
13229 @item 
13230 You split your incoming mail by matching on
13231 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13232 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13233
13234 @item
13235 You enter that group once in a while and post articles using the @kbd{e}
13236 (edit-and-post) or @kbd{s} (just send unedited) commands.
13237
13238 @item
13239 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13240 articles that weren't approved by you, you can cancel them with the
13241 @kbd{c} command.
13242 @end enumerate
13243
13244 To use moderation mode in these two groups, say:
13245
13246 @lisp
13247 (setq gnus-moderated-list
13248       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13249 @end lisp
13250
13251
13252 @node XEmacs Enhancements
13253 @section XEmacs Enhancements
13254 @cindex XEmacs
13255
13256 XEmacs is able to display pictures and stuff, so Gnus has taken
13257 advantage of that.  Relevant variables include:
13258
13259 @table @code
13260 @item gnus-xmas-glyph-directory
13261 @vindex gnus-xmas-glyph-directory
13262 This is where Gnus will look for pictures.  Gnus will normally
13263 auto-detect this directory, but you may set it manually if you have an
13264 unusual directory structure.
13265
13266 @item gnus-xmas-logo-color-alist
13267 @vindex gnus-xmas-logo-color-alist
13268 This is an alist where the key is a type symbol and the values are the
13269 foreground and background color of the splash page glyph.
13270
13271 @item gnus-xmas-logo-color-style
13272 @vindex gnus-xmas-logo-color-style
13273 This is the key used to look up the color in the alist described above.
13274 Legal values include @code{flame}, @code{pine}, @code{moss},
13275 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13276 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13277
13278 @item gnus-use-toolbar
13279 @vindex gnus-use-toolbar
13280 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13281 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13282 @code{right-toolbar}, or @code{left-toolbar}.
13283
13284 @item gnus-group-toolbar
13285 @vindex gnus-group-toolbar
13286 The toolbar in the group buffer.
13287
13288 @item gnus-summary-toolbar
13289 @vindex gnus-summary-toolbar
13290 The toolbar in the summary buffer.
13291
13292 @item gnus-summary-mail-toolbar
13293 @vindex gnus-summary-mail-toolbar
13294 The toolbar in the summary buffer of mail groups.
13295
13296 @item gnus-xmas-modeline-glyph
13297 @vindex gnus-xmas-modeline-glyph
13298 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13299 default. 
13300
13301 @end table
13302
13303
13304 @node Various Various
13305 @section Various Various
13306 @cindex mode lines
13307 @cindex highlights
13308
13309 @table @code
13310
13311 @item gnus-directory
13312 @vindex gnus-directory
13313 All Gnus directories will be initialized from this variable, which
13314 defaults to the @samp{SAVEDIR} environment variable, or @file{~/News/}
13315 if that variable isn't set.
13316
13317 @item gnus-default-directory
13318 @vindex gnus-default-directory
13319 Not related to the above variable at all---this variable says what the
13320 default directory of all Gnus buffers should be.  If you issue commands
13321 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13322 default directory.  If this variable is @code{nil} (which is the
13323 default), the default directory will be the default directory of the
13324 buffer you were in when you started Gnus.
13325
13326 @item gnus-verbose
13327 @vindex gnus-verbose
13328 This variable is an integer between zero and ten.  The higher the value,
13329 the more messages will be displayed.  If this variable is zero, Gnus
13330 will never flash any messages, if it is seven (which is the default),
13331 most important messages will be shown, and if it is ten, Gnus won't ever
13332 shut up, but will flash so many messages it will make your head swim.
13333
13334 @item gnus-verbose-backends
13335 @vindex gnus-verbose-backends
13336 This variable works the same way as @code{gnus-verbose}, but it applies
13337 to the Gnus backends instead of Gnus proper.
13338
13339 @item nnheader-max-head-length
13340 @vindex nnheader-max-head-length
13341 When the backends read straight heads of articles, they all try to read
13342 as little as possible.  This variable (default 4096) specifies
13343 the absolute max length the backends will try to read before giving up
13344 on finding a separator line between the head and the body.  If this
13345 variable is @code{nil}, there is no upper read bound.  If it is
13346 @code{t}, the backends won't try to read the articles piece by piece,
13347 but read the entire articles.  This makes sense with some versions of
13348 @code{ange-ftp}. 
13349
13350 @item nnheader-head-chop-length
13351 @vindex nnheader-head-chop-length
13352 This variable says how big a piece of each article to read when doing
13353 the operation described above.
13354
13355 @item nnheader-file-name-translation-alist 
13356 @vindex nnheader-file-name-translation-alist 
13357 @cindex file names
13358 @cindex illegal characters in file names
13359 @cindex characters in file names
13360 This is an alist that says how to translate characters in file names.
13361 For instance, if @samp{:} is illegal as a file character in file names
13362 on your system (you OS/2 user you), you could say something like:
13363
13364 @lisp
13365 (setq nnheader-file-name-translation-alist 
13366       '((?: . ?_)))
13367 @end lisp
13368
13369 In fact, this is the default value for this variable on OS/2 and MS
13370 Windows (phooey) systems.
13371
13372 @item gnus-hidden-properties
13373 @vindex gnus-hidden-properties
13374 This is a list of properties to use to hide ``invisible'' text.  It is
13375 @code{(invisible t intangible t)} by default on most systems, which
13376 makes invisible text invisible and intangible.
13377
13378 @item gnus-parse-headers-hook
13379 @vindex gnus-parse-headers-hook
13380 A hook called before parsing headers.  It can be used, for instance, to
13381 gather statistics on the headers fetched, or perhaps you'd like to prune
13382 some headers.  I don't see why you'd want that, though.
13383
13384 @item gnus-shell-command-separator
13385 @vindex gnus-shell-command-separator
13386 String used to separate to shell commands.  The default is @samp{;}. 
13387
13388
13389 @end table
13390
13391
13392 @node The End
13393 @chapter The End
13394
13395 Well, that's the manual---you can get on with your life now.  Keep in
13396 touch.  Say hello to your cats from me.  
13397
13398 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13399
13400 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13401
13402 @quotation
13403 @strong{Te Deum}
13404
13405 @sp 1
13406 Not because of victories @*
13407 I sing,@*
13408 having none,@*
13409 but for the common sunshine,@*
13410 the breeze,@*
13411 the largess of the spring.
13412
13413 @sp 1
13414 Not for victory@*
13415 but for the day's work done@*
13416 as well as I was able;@*
13417 not for a seat upon the dais@*
13418 but at the common table.@*
13419 @end quotation
13420
13421
13422 @node Appendices
13423 @chapter Appendices
13424
13425 @menu
13426 * History::                        How Gnus got where it is today.
13427 * Terminology::                    We use really difficult, like, words here.
13428 * Customization::                  Tailoring Gnus to your needs.
13429 * Troubleshooting::                What you might try if things do not work.
13430 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13431 * Emacs for Heathens::             A short introduction to Emacsian terms.
13432 * Frequently Asked Questions::     A question-and-answer session.
13433 @end menu
13434
13435
13436 @node History
13437 @section History
13438
13439 @cindex history
13440 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13441 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13442
13443 If you want to investigate the person responsible for this outrage, you
13444 can point your (feh!) web browser to
13445 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13446 distribution point for the new and spiffy versions of Gnus, and is known
13447 as The Site That Destroys Newsrcs And Drives People Mad.
13448
13449 During the first extended alpha period of development, the new Gnus was
13450 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13451 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13452 (Besides, the ``Gnus'' in this abbreviation should probably be
13453 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13454 appropriate name, don't you think?)
13455
13456 In any case, after spending all that energy on coming up with a new and
13457 spunky name, we decided that the name was @emph{too} spunky, so we
13458 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13459 ``@sc{gnus}''.  New vs. old.
13460
13461 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13462 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13463 plus 15 Gnus 5.0 releases).
13464
13465 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13466 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13467
13468 On July 28th 1996 work on Red Gnus was begun, and it was released on
13469 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13470
13471 If you happen upon a version of Gnus that has a name that is prefixed --
13472 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13473 don't panic.  Don't let it know that you're frightened.  Back away.
13474 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13475 out of its reach.  Find a proper released version of Gnus and snuggle up
13476 to that instead.
13477
13478 @menu
13479 * Why?::                What's the point of Gnus?
13480 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13481 * Conformity::          Gnus tries to conform to all standards.
13482 * Emacsen::             Gnus can be run on a few modern Emacsen.
13483 * Contributors::        Oodles of people.  
13484 * New Features::        Pointers to some of the new stuff in Gnus.
13485 * Newest Features::     Features so new that they haven't been written yet.
13486 @end menu
13487
13488
13489 @node Why?
13490 @subsection Why?
13491
13492 What's the point of Gnus?  
13493
13494 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13495 newsreader, that lets you do anything you can think of.  That was my
13496 original motivation, but while working on Gnus, it has become clear to
13497 me that this generation of newsreaders really belong in the stone age.
13498 Newsreaders haven't developed much since the infancy of the net.  If the
13499 volume continues to rise with the current rate of increase, all current
13500 newsreaders will be pretty much useless.  How do you deal with
13501 newsgroups that have thousands of new articles each day?  How do you
13502 keep track of millions of people who post?
13503
13504 Gnus offers no real solutions to these questions, but I would very much
13505 like to see Gnus being used as a testing ground for new methods of
13506 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13507 to separate the newsreader from the backends, Gnus now offers a simple
13508 interface for anybody who wants to write new backends for fetching mail
13509 and news from different sources.  I have added hooks for customizations
13510 everywhere I could imagine useful.  By doing so, I'm inviting every one
13511 of you to explore and invent.
13512
13513 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13514
13515
13516 @node Compatibility
13517 @subsection Compatibility
13518
13519 @cindex compatibility
13520 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13521 bindings have been kept.  More key bindings have been added, of course,
13522 but only in one or two obscure cases have old bindings been changed.
13523
13524 Our motto is:
13525 @quotation
13526 @cartouche
13527 @center In a cloud bones of steel.
13528 @end cartouche
13529 @end quotation
13530
13531 All commands have kept their names.  Some internal functions have changed
13532 their names.
13533
13534 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13535 Articles}. 
13536
13537 One major compatibility question is the presence of several summary
13538 buffers.  All variables that are relevant while reading a group are
13539 buffer-local to the summary buffer they belong in.  Although many
13540 important variables have their values copied into their global
13541 counterparts whenever a command is executed in the summary buffer, this
13542 change might lead to incorrect values being used unless you are careful.
13543
13544 All code that relies on knowledge of @sc{gnus} internals will probably
13545 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13546 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13547 maintains a hash table that points to the entries in this alist (which
13548 speeds up many functions), and changing the alist directly will lead to
13549 peculiar results.
13550
13551 @cindex hilit19
13552 @cindex highlighting
13553 Old hilit19 code does not work at all.  In fact, you should probably
13554 remove all hilit code from all Gnus hooks
13555 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13556 Gnus provides various integrated functions for highlighting.  These are
13557 faster and more accurate.  To make life easier for everybody, Gnus will
13558 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13559 Away!
13560
13561 Packages like @code{expire-kill} will no longer work.  As a matter of
13562 fact, you should probably remove all old @sc{gnus} packages (and other
13563 code) when you start using Gnus.  More likely than not, Gnus already
13564 does what you have written code to make @sc{gnus} do.  (Snicker.)
13565
13566 Even though old methods of doing things are still supported, only the
13567 new methods are documented in this manual.  If you detect a new method of
13568 doing something while reading this manual, that does not mean you have
13569 to stop doing it the old way.
13570
13571 Gnus understands all @sc{gnus} startup files.
13572
13573 @kindex M-x gnus-bug
13574 @findex gnus-bug
13575 @cindex reporting bugs
13576 @cindex bugs
13577 Overall, a casual user who hasn't written much code that depends on
13578 @sc{gnus} internals should suffer no problems.  If problems occur,
13579 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13580
13581
13582 @node Conformity
13583 @subsection Conformity
13584
13585 No rebels without a clue here, ma'am.  We conform to all standards known
13586 to (wo)man.  Except for those standards and/or conventions we disagree
13587 with, of course.
13588
13589 @table @strong
13590
13591 @item RFC 822
13592 @cindex RFC 822
13593 There are no known breaches of this standard.
13594
13595 @item RFC 1036
13596 @cindex RFC 1036
13597 There are no known breaches of this standard, either.
13598
13599 @item Good Net-Keeping Seal of Approval
13600 @cindex Good Net-Keeping Seal of Approval
13601 Gnus has been through the Seal process and failed.  I think it'll pass
13602 the next inspection.
13603
13604 @item Son-of-RFC 1036
13605 @cindex Son-of-RFC 1036
13606 We do have some breaches to this one.
13607
13608 @table @emph
13609
13610 @item MIME
13611 Gnus does no MIME handling, and this standard-to-be seems to think that
13612 MIME is the bees' knees, so we have major breakage here.
13613
13614 @item X-Newsreader
13615 This is considered to be a ``vanity header'', while I consider it to be
13616 consumer information.  After seeing so many badly formatted articles
13617 coming from @code{tin} and @code{Netscape} I know not to use either of
13618 those for posting articles.  I would not have known that if it wasn't
13619 for the @code{X-Newsreader} header.
13620 @end table
13621
13622 @end table
13623
13624 If you ever notice Gnus acting non-compliantly with regards to the texts
13625 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13626 know.
13627
13628
13629 @node Emacsen
13630 @subsection Emacsen
13631 @cindex Emacsen
13632 @cindex XEmacs
13633 @cindex Mule
13634 @cindex Emacs
13635
13636 Gnus should work on :
13637
13638 @itemize @bullet 
13639
13640 @item
13641 Emacs 19.32 and up.
13642
13643 @item
13644 XEmacs 19.14 and up.
13645
13646 @item 
13647 Mule versions based on Emacs 19.32 and up.
13648
13649 @end itemize
13650
13651 Gnus will absolutely not work on any Emacsen older than that.  Not
13652 reliably, at least. 
13653
13654 There are some vague differences between Gnus on the various
13655 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13656 other than that, things should look pretty much the same under all
13657 Emacsen. 
13658
13659
13660 @node Contributors
13661 @subsection Contributors
13662 @cindex contributors
13663
13664 The new Gnus version couldn't have been done without the help of all the
13665 people on the (ding) mailing list.  Every day for over a year I have
13666 gotten billions of nice bug reports from them, filling me with joy,
13667 every single one of them.  Smooches.  The people on the list have been
13668 tried beyond endurance, what with my ``oh, that's a neat idea <type
13669 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13670 work at all <type type>, yup, I'll ship that one off right away <ship
13671 off> no, wait, that absolutely does not work'' policy for releases.
13672 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
13673 ``worser''? ``much worser''?  ``worsest''?)
13674
13675 I would like to take this opportunity to thank the Academy for...  oops,
13676 wrong show.
13677
13678 @itemize @bullet
13679
13680 @item 
13681 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13682
13683 @item 
13684 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13685 well as numerous other things).
13686
13687 @item 
13688 Luis Fernandes---design and graphics.
13689
13690 @item
13691 Erik Naggum---help, ideas, support, code and stuff.
13692
13693 @item 
13694 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13695 @dfn{picons} (@pxref{Picons}).
13696
13697 @item 
13698 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13699 (@pxref{GroupLens}).
13700
13701 @item 
13702 Sudish Joseph---innumerable bug fixes.
13703
13704 @item 
13705 Ilja Weis---@file{gnus-topic.el}.
13706
13707 @item 
13708 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13709
13710 @item 
13711 Vladimir Alexiev---the refcard and reference booklets.
13712
13713 @item 
13714 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13715 distribution by Felix Lee and JWZ.
13716
13717 @item 
13718 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13719
13720 @item 
13721 Peter Mutsaers---orphan article scoring code.
13722
13723 @item 
13724 Ken Raeburn---POP mail support.
13725
13726 @item 
13727 Hallvard B Furuseth---various bits and pieces, especially dealing with
13728 .newsrc files.
13729
13730 @item 
13731 Brian Edmonds---@file{gnus-bbdb.el}.
13732
13733 @item
13734 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
13735
13736 @item 
13737 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13738
13739 @item 
13740 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13741
13742 @item
13743 François Pinard---many, many interesting and thorough bug reports.
13744
13745 @end itemize
13746
13747 The following people have contributed many patches and suggestions: 
13748
13749 Christopher Davis,
13750 Andrew Eskilsson,
13751 Kai Grossjohann,
13752 David KÃ¥gedal,
13753 Richard Pieri,
13754 Fabrice Popineau, 
13755 Daniel Quinlan, 
13756 Jason L. Tibbitts, III,
13757 and
13758 Jack Vinson.
13759
13760 Also thanks to the following for patches and stuff:
13761
13762 Peter Arius, 
13763 Marc Auslander,
13764 Chris Bone,
13765 Mark Borges,
13766 Lance A. Brown,
13767 Kees de Bruin,
13768 Martin Buchholz,
13769 Kevin Buhr,
13770 Alastair Burt,
13771 Joao Cachopo,
13772 Massimo Campostrini,
13773 Michael R. Cook,
13774 Glenn Coombs, 
13775 Frank D. Cringle, 
13776 Geoffrey T. Dairiki,
13777 Andre Deparade,
13778 Ulrik Dickow,
13779 Dave Disser,
13780 Joev Dubach,
13781 Paul Eggert,
13782 Michael Ernst,
13783 Luc Van Eycken,
13784 Sam Falkner,
13785 Paul Franklin, 
13786 David S. Goldberg,
13787 D. Hall, 
13788 Magnus Hammerin,
13789 Raja R. Harinath,
13790 Marc Horowitz,
13791 Ishikawa Ichiro, @c Ishikawa
13792 Francois Felix Ingrand,
13793 Lee Iverson, 
13794 Rajappa Iyer,
13795 Randell Jesup,
13796 Fred Johansen, 
13797 Greg Klanderman,
13798 Peter Skov Knudsen,
13799 Shuhei Kobayashi, @c Kobayashi
13800 Thor Kristoffersen,
13801 Jens Lautenbacher,
13802 Carsten Leonhardt,
13803 Christian Limpach,
13804 Markus Linnala,
13805 Dave Love,
13806 Tonny Madsen,
13807 Shlomo Mahlab,
13808 Nat Makarevitch,
13809 Timo Metzemakers,
13810 Richard Mlynarik,
13811 Lantz Moore,
13812 Morioka Tomohiko, @c Morioka
13813 Erik Toubro Nielsen,
13814 Hrvoje Niksic,
13815 Andy Norman,
13816 C. R. Oldham,
13817 Alexandre Oliva,
13818 Ken Olstad,
13819 Masaharu Onishi, @c Onishi
13820 Hideki Ono, @c Ono
13821 William Perry,
13822 Stephen Peters,
13823 Ulrich Pfeifer,
13824 John McClary Prevost,
13825 Colin Rafferty,
13826 Bart Robinson,
13827 Jason Rumney,
13828 Loren Schall,
13829 Dan Schmidt,
13830 Ralph Schleicher,
13831 Randal L. Schwartz,
13832 Danny Siu, 
13833 Paul D. Smith,
13834 Jeff Sparkes,
13835 Michael Sperber,
13836 Richard Stallman,
13837 Greg Stark, 
13838 Paul Stodghill,
13839 Kurt Swanson,
13840 Samuel Tardieu, 
13841 Teddy,
13842 Chuck Thompson,
13843 Philippe Troin,
13844 Jan Vroonhof,
13845 Barry A. Warsaw,
13846 Christoph Wedler,
13847 Joe Wells,
13848 and
13849 Katsumi Yamaoka. @c Yamaoka
13850
13851 For a full overview of what each person has done, the ChangeLogs
13852 included in the Gnus alpha distributions should give ample reading
13853 (550kB and counting).
13854
13855 Apologies to everybody that I've forgotten, of which there are many, I'm
13856 sure.  
13857
13858 Gee, that's quite a list of people.  I guess that must mean that there
13859 actually are people who are using Gnus.  Who'd'a thunk it!
13860
13861
13862 @node New Features
13863 @subsection New Features
13864 @cindex new features
13865
13866 @menu
13867 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
13868 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
13869 * Red Gnus::           Third time best---Gnus 5.4/5.5.
13870 @end menu
13871
13872 These lists are, of course, just @emph{short} overviews of the
13873 @emph{most} important new features.  No, really.  There are tons more.
13874 Yes, we have feeping creaturism in full effect.
13875
13876
13877 @node ding Gnus
13878 @subsubsection (ding) Gnus
13879
13880 New features in Gnus 5.0/5.1:
13881
13882 @itemize @bullet
13883
13884 @item
13885 The look of all buffers can be changed by setting format-like variables
13886 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
13887  
13888 @item 
13889 Local spool and several @sc{nntp} servers can be used at once
13890 (@pxref{Select Methods}).  
13891
13892 @item 
13893 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13894
13895 @item 
13896 You can read a number of different mail formats (@pxref{Getting Mail}).
13897 All the mail backends implement a convenient mail expiry scheme
13898 (@pxref{Expiring Mail}). 
13899
13900 @item
13901 Gnus can use various strategies for gathering threads that have lost
13902 their roots (thereby gathering loose sub-threads into one thread) or it
13903 can go back and retrieve enough headers to build a complete thread
13904 (@pxref{Customizing Threading}).
13905
13906 @item 
13907 Killed groups can be displayed in the group buffer, and you can read
13908 them as well (@pxref{Listing Groups}).
13909
13910 @item 
13911 Gnus can do partial group updates---you do not have to retrieve the
13912 entire active file just to check for new articles in a few groups
13913 (@pxref{The Active File}).
13914
13915 @item 
13916 Gnus implements a sliding scale of subscribedness to groups
13917 (@pxref{Group Levels}).
13918
13919 @item 
13920 You can score articles according to any number of criteria
13921 (@pxref{Scoring}).  You can even get Gnus to find out how to score
13922 articles for you (@pxref{Adaptive Scoring}).
13923
13924 @item 
13925 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
13926 manner, so it should be difficult to lose much data on what you have
13927 read if your machine should go down (@pxref{Auto Save}). 
13928
13929 @item 
13930 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
13931 the @file{.emacs} file.
13932
13933 @item 
13934 You can set the process mark on both groups and articles and perform
13935 operations on all the marked items (@pxref{Process/Prefix}).
13936
13937 @item 
13938 You can grep through a subset of groups and create a group from the
13939 results (@pxref{Kibozed Groups}). 
13940
13941 @item 
13942 You can list subsets of groups according to, well, anything
13943 (@pxref{Listing Groups}). 
13944
13945 @item 
13946 You can browse foreign servers and subscribe to groups from those
13947 servers (@pxref{Browse Foreign Server}). 
13948
13949 @item 
13950 Gnus can fetch articles asynchronously on a second connection to the
13951 server (@pxref{Asynchronous Fetching}).
13952
13953 @item 
13954 You can cache articles locally (@pxref{Article Caching}). 
13955
13956 @item 
13957 The uudecode functions have been expanded and generalized
13958 (@pxref{Decoding Articles}). 
13959
13960 @item
13961 You can still post uuencoded articles, which was a little-known feature
13962 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
13963
13964 @item
13965 Fetching parents (and other articles) now actually works without
13966 glitches (@pxref{Finding the Parent}). 
13967
13968 @item
13969 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
13970
13971 @item
13972 Digests (and other files) can be used as the basis for groups
13973 (@pxref{Document Groups}).
13974
13975 @item 
13976 Articles can be highlighted and customized (@pxref{Customizing
13977 Articles}). 
13978
13979 @item 
13980 URLs and other external references can be buttonized (@pxref{Article
13981 Buttons}). 
13982
13983 @item
13984 You can do lots of strange stuff with the Gnus window & frame
13985 configuration (@pxref{Windows Configuration}).
13986
13987 @item
13988 You can click on buttons instead of using the keyboard
13989 (@pxref{Buttons}). 
13990
13991 @end itemize
13992
13993
13994 @node September Gnus
13995 @subsubsection September Gnus
13996
13997 New features in Gnus 5.2/5.3:
13998
13999 @itemize @bullet
14000
14001 @item
14002 A new message composition mode is used.  All old customization variables
14003 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14004 now obsolete.
14005
14006 @item
14007 Gnus is now able to generate @dfn{sparse} threads---threads where
14008 missing articles are represented by empty nodes (@pxref{Customizing
14009 Threading}). 
14010
14011 @lisp
14012 (setq gnus-build-sparse-threads 'some)
14013 @end lisp
14014
14015 @item
14016 Outgoing articles are stored on a special archive server
14017 (@pxref{Archived Messages}). 
14018
14019 @item
14020 Partial thread regeneration now happens when articles are
14021 referred. 
14022
14023 @item
14024 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14025
14026 @item
14027 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
14028
14029 @item
14030 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14031
14032 @lisp
14033 (setq gnus-use-trees t)
14034 @end lisp
14035
14036 @item
14037 An @code{nn}-like pick-and-read minor mode is available for the summary
14038 buffers (@pxref{Pick and Read}).
14039
14040 @lisp
14041 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14042 @end lisp
14043
14044 @item
14045 In binary groups you can use a special binary minor mode (@pxref{Binary
14046 Groups}). 
14047
14048 @item
14049 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14050 Topics}).
14051
14052 @lisp
14053 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14054 @end lisp
14055
14056 @item
14057 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14058
14059 @item
14060 Groups can now have a score, and bubbling based on entry frequency
14061 is possible (@pxref{Group Score}).
14062
14063 @lisp
14064 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14065 @end lisp
14066
14067 @item
14068 Groups can be process-marked, and commands can be performed on
14069 groups of groups (@pxref{Marking Groups}).
14070
14071 @item
14072 Caching is possible in virtual groups.
14073
14074 @item
14075 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14076 news batches, ClariNet briefs collections, and just about everything
14077 else (@pxref{Document Groups}).
14078
14079 @item
14080 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14081 (@pxref{SOUP}).
14082
14083 @item
14084 The Gnus cache is much faster.
14085
14086 @item
14087 Groups can be sorted according to many criteria (@pxref{Sorting
14088 Groups}).
14089
14090 @item
14091 New group parameters have been introduced to set list-address and
14092 expiry times (@pxref{Group Parameters}).
14093
14094 @item
14095 All formatting specs allow specifying faces to be used
14096 (@pxref{Formatting Fonts}).
14097
14098 @item
14099 There are several more commands for setting/removing/acting on process
14100 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14101
14102 @item
14103 The summary buffer can be limited to show parts of the available
14104 articles based on a wide range of criteria.  These commands have been
14105 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14106
14107 @item
14108 Articles can be made persistent with the @kbd{*} command
14109 (@pxref{Persistent Articles}).
14110
14111 @item
14112 All functions for hiding article elements are now toggles.
14113
14114 @item
14115 Article headers can be buttonized (@pxref{Article Washing}).
14116
14117 @lisp
14118 (add-hook 'gnus-article-display-hook 
14119           'gnus-article-add-buttons-to-head)
14120 @end lisp
14121
14122 @item
14123 All mail backends support fetching articles by @code{Message-ID}.
14124
14125 @item
14126 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14127
14128 @item
14129 All summary mode commands are available directly from the article
14130 buffer (@pxref{Article Keymap}). 
14131
14132 @item
14133 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14134 Configuration}).
14135
14136 @item
14137 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14138
14139 @item
14140 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14141
14142 @lisp
14143 (setq gnus-use-nocem t)
14144 @end lisp
14145
14146 @item
14147 Groups can be made permanently visible (@pxref{Listing Groups}).
14148
14149 @lisp
14150 (setq gnus-permanently-visible-groups "^nnml:")
14151 @end lisp
14152
14153 @item
14154 Many new hooks have been introduced to make customizing easier. 
14155
14156 @item
14157 Gnus respects the @code{Mail-Copies-To} header.
14158
14159 @item
14160 Threads can be gathered by looking at the @code{References} header
14161 (@pxref{Customizing Threading}).
14162
14163 @lisp
14164 (setq gnus-summary-thread-gathering-function 
14165       'gnus-gather-threads-by-references)
14166 @end lisp
14167
14168 @item
14169 Read articles can be stored in a special backlog buffer to avoid
14170 refetching (@pxref{Article Backlog}).  
14171
14172 @lisp
14173 (setq gnus-keep-backlog 50)
14174 @end lisp
14175
14176 @item
14177 A clean copy of the current article is always stored in a separate
14178 buffer to allow easier treatment.
14179
14180 @item
14181 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14182
14183 @item
14184 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14185 Articles}). 
14186
14187 @lisp
14188 (setq gnus-prompt-before-saving t)
14189 @end lisp
14190
14191 @item
14192 @code{gnus-uu} can view decoded files asynchronously while fetching
14193 articles (@pxref{Other Decode Variables}). 
14194
14195 @lisp
14196 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14197 @end lisp
14198
14199 @item
14200 Filling in the article buffer now works properly on cited text
14201 (@pxref{Article Washing}).
14202
14203 @item
14204 Hiding cited text adds buttons to toggle hiding, and how much
14205 cited text to hide is now customizable (@pxref{Article Hiding}).
14206
14207 @lisp
14208 (setq gnus-cited-lines-visible 2)
14209 @end lisp
14210
14211 @item
14212 Boring headers can be hidden (@pxref{Article Hiding}).
14213
14214 @lisp
14215 (add-hook 'gnus-article-display-hook 
14216           'gnus-article-hide-boring-headers t)
14217 @end lisp
14218
14219 @item
14220 Default scoring values can now be set from the menu bar.
14221
14222 @item
14223 Further syntax checking of outgoing articles have been added.
14224
14225 @end itemize
14226
14227
14228 @node Red Gnus
14229 @subsubsection Red Gnus
14230
14231 New features in Gnus 5.4/5.5:
14232
14233 @itemize @bullet
14234
14235 @item
14236 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14237
14238 @item
14239 Article prefetching functionality has been moved up into 
14240 Gnus (@pxref{Asynchronous Fetching}).  
14241
14242 @item
14243 Scoring can now be performed with logical operators like @code{and},
14244 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14245 Scoring}).
14246
14247 @item
14248 Article washing status can be displayed in the
14249 article mode line (@pxref{Misc Article}).
14250
14251 @item
14252 @file{gnus.el} has been split into many smaller files.
14253
14254 @item
14255 Suppression of duplicate articles based on Message-ID can be done
14256 (@pxref{Duplicate Suppression}).
14257
14258 @lisp
14259 (setq gnus-suppress-duplicates t)
14260 @end lisp
14261
14262 @item
14263 New variables for specifying what score and adapt files are to be
14264 considered home score and adapt files (@pxref{Home Score File}).
14265
14266 @item
14267 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14268 Server Internals}). 
14269
14270 @item
14271 Groups can inherit group parameters from parent topics (@pxref{Topic
14272 Parameters}).
14273
14274 @item
14275 Article editing has been revamped and is now actually usable.
14276
14277 @item
14278 Signatures can be recognized in more intelligent fashions
14279 (@pxref{Article Signature}).
14280
14281 @item
14282 Summary pick mode has been made to look more @code{nn}-like.  Line
14283 numbers are displayed and the @kbd{.} command can be used to pick
14284 articles (@code{Pick and Read}).
14285
14286 @item
14287 Commands for moving the @file{.newsrc.eld} from one server to
14288 another have been added (@pxref{Changing Servers}).
14289
14290 @item
14291 A way to specify that ``uninteresting'' fields be suppressed when
14292 generating lines in buffers (@pxref{Advanced Formatting}).
14293
14294 @item
14295 Several commands in the group buffer can be undone with @kbd{M-C-_}
14296 (@pxref{Undo}).
14297
14298 @item
14299 Scoring can be done on words using the new score type @code{w}
14300 (@pxref{Score File Format}).
14301
14302 @item
14303 Adaptive scoring can be done on a Subject word-by-word basis
14304 (@pxref{Adaptive Scoring}). 
14305
14306 @lisp
14307 (setq gnus-use-adaptive-scoring '(word))
14308 @end lisp
14309
14310 @item
14311 Scores can be decayed (@pxref{Score Decays}).
14312  
14313 @lisp
14314 (setq gnus-decay-scores t)
14315 @end lisp
14316
14317 @item
14318 Scoring can be performed using a regexp on the Date header.  The Date is
14319 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14320
14321 @item
14322 A new command has been added to remove all data on articles from
14323 the native server (@pxref{Changing Servers}).
14324
14325 @item
14326 A new command for reading collections of documents
14327 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14328 (@pxref{Really Various Summary Commands}). 
14329
14330 @item
14331 Process mark sets can be pushed and popped (@pxref{Setting Process
14332 Marks}).
14333
14334 @item
14335 A new mail-to-news backend makes it possible to post even when the NNTP
14336 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14337
14338 @item
14339 A new backend for reading searches from Web search engines
14340 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14341 (@pxref{Web Searches}).
14342
14343 @item
14344 Groups inside topics can now be sorted using the standard sorting
14345 functions, and each topic can be sorted independently (@pxref{Topic
14346 Sorting}).
14347
14348 @item
14349 Subsets of the groups can be sorted independently (@code{Sorting
14350 Groups}).
14351
14352 @item
14353 Cached articles can be pulled into the groups (@pxref{Summary Generation
14354 Commands}).
14355   
14356 @item
14357 Score files are now applied in a more reliable order (@pxref{Score
14358 Variables}).
14359
14360 @item
14361 Reports on where mail messages end up can be generated (@pxref{Splitting
14362 Mail}).
14363
14364 @item
14365 More hooks and functions have been added to remove junk from incoming
14366 mail before saving the mail (@pxref{Washing Mail}).
14367
14368 @item
14369 Emphasized text can be properly fontisized:
14370
14371 @lisp
14372 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14373 @end lisp
14374  
14375 @end itemize
14376
14377
14378 @node Newest Features
14379 @subsection Newest Features
14380 @cindex todo
14381
14382 Also known as the @dfn{todo list}.  Sure to be implemented before the
14383 next millennium. 
14384
14385 Be afraid.  Be very afraid.
14386
14387 @itemize @bullet
14388 @item
14389 Native @sc{mime} support is something that should be done.  
14390 @item
14391 Really do unbinhexing.
14392 @end itemize
14393
14394 And much, much, much more.  There is more to come than has already been
14395 implemented.  (But that's always true, isn't it?)
14396
14397 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14398 up-to-the-second todo list is located, so if you're really curious, you
14399 could point your Web browser over that-a-way.
14400
14401 @iftex
14402
14403 @node The Manual
14404 @section The Manual
14405 @cindex colophon
14406 @cindex manual
14407
14408 This manual was generated from a TeXinfo file and then run through
14409 either @code{texi2dvi}
14410 @iflatex
14411 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14412 and then run through @code{latex} and @code{dvips} 
14413 @end iflatex
14414 to get what you hold in your hands now.
14415
14416 The following conventions have been used:
14417
14418 @enumerate
14419
14420 @item
14421 This is a @samp{string}
14422
14423 @item
14424 This is a @kbd{keystroke}
14425
14426 @item
14427 This is a @file{file}
14428
14429 @item 
14430 This is a @code{symbol}
14431
14432 @end enumerate
14433
14434 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14435 mean:
14436
14437 @lisp
14438 (setq flargnoze "yes")
14439 @end lisp
14440
14441 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14442
14443 @lisp
14444 (setq flumphel 'yes)
14445 @end lisp
14446
14447 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14448 ever get them confused.
14449
14450 @iflatex
14451 @c @head
14452 Of course, everything in this manual is of vital interest, so you should
14453 read it all.  Several times.  However, if you feel like skimming the
14454 manual, look for that gnu head you should see in the margin over
14455 there---it means that what's being discussed is of more importance than
14456 the rest of the stuff.  (On the other hand, if everything is infinitely
14457 important, how can anything be more important than that?  Just one more
14458 of the mysteries of this world, I guess.)
14459 @end iflatex
14460
14461 @end iftex
14462
14463
14464 @node Terminology
14465 @section Terminology
14466
14467 @cindex terminology
14468 @table @dfn
14469
14470 @item news
14471 @cindex news
14472 This is what you are supposed to use this thing for---reading news.
14473 News is generally fetched from a nearby @sc{nntp} server, and is
14474 generally publicly available to everybody.  If you post news, the entire
14475 world is likely to read just what you have written, and they'll all
14476 snigger mischievously.  Behind your back.
14477
14478 @item mail
14479 @cindex mail
14480 Everything that's delivered to you personally is mail.  Some news/mail
14481 readers (like Gnus) blur the distinction between mail and news, but
14482 there is a difference.  Mail is private.  News is public.  Mailing is
14483 not posting, and replying is not following up.
14484
14485 @item reply
14486 @cindex reply
14487 Send a mail to the person who has written what you are reading.
14488
14489 @item follow up
14490 @cindex follow up
14491 Post an article to the current newsgroup responding to the article you
14492 are reading.
14493
14494 @item backend
14495 @cindex backend
14496 Gnus gets fed articles from a number of backends, both news and mail
14497 backends.  Gnus does not handle the underlying media, so to speak---this
14498 is all done by the backends.
14499
14500 @item native
14501 @cindex native
14502 Gnus will always use one method (and backend) as the @dfn{native}, or
14503 default, way of getting news.
14504
14505 @item foreign
14506 @cindex foreign
14507 You can also have any number of foreign groups active at the same time.
14508 These are groups that use different backends for getting news.
14509
14510 @item secondary
14511 @cindex secondary
14512 Secondary backends are somewhere half-way between being native and being
14513 foreign, but they mostly act like they are native.
14514
14515 @item article
14516 @cindex article
14517 A message that has been posted as news.
14518
14519 @item mail message
14520 @cindex mail message
14521 A message that has been mailed.
14522
14523 @item message 
14524 @cindex message
14525 A mail message or news article
14526
14527 @item head
14528 @cindex head
14529 The top part of a message, where administrative information (etc.) is
14530 put.
14531
14532 @item body
14533 @cindex body
14534 The rest of an article.  Everything that is not in the head is in the
14535 body. 
14536
14537 @item header
14538 @cindex header
14539 A line from the head of an article. 
14540
14541 @item headers
14542 @cindex headers
14543 A collection of such lines, or a collection of heads.  Or even a
14544 collection of @sc{nov} lines.
14545
14546 @item @sc{nov}
14547 @cindex nov
14548 When Gnus enters a group, it asks the backend for the headers of all
14549 unread articles in the group.  Most servers support the News OverView
14550 format, which is more compact and much faster to read and parse than the
14551 normal @sc{head} format.
14552
14553 @item level
14554 @cindex levels
14555 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14556 that have a lower level are ``more'' subscribed than the groups with a
14557 higher level.  In fact, groups on levels 1-5 are considered
14558 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14559 are @dfn{killed}.  Commands for listing groups and scanning for new
14560 articles will all use the numeric prefix as @dfn{working level}.
14561
14562 @item killed groups
14563 @cindex killed groups
14564 No information on killed groups is stored or updated, which makes killed
14565 groups much easier to handle than subscribed groups.
14566
14567 @item zombie groups
14568 @cindex zombie groups
14569 Just like killed groups, only slightly less dead.
14570
14571 @item active file
14572 @cindex active file
14573 The news server has to keep track of what articles it carries, and what
14574 groups exist.  All this information in stored in the active file, which
14575 is rather large, as you might surmise.
14576
14577 @item bogus groups
14578 @cindex bogus groups
14579 A group that exists in the @file{.newsrc} file, but isn't known to the
14580 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14581 This means that the group probably doesn't exist (any more).
14582
14583 @item server 
14584 @cindex server
14585 A machine than one can connect to and get news (or mail) from.
14586
14587 @item select method
14588 @cindex select method
14589 A structure that specifies the backend, the server and the virtual
14590 server parameters.
14591
14592 @item virtual server
14593 @cindex virtual server
14594 A named select method.  Since a select methods defines all there is to
14595 know about connecting to a (physical) server, taking the things as a
14596 whole is a virtual server.
14597
14598 @item washing
14599 @cindex washing
14600 Taking a buffer and running it through a filter of some sort.  The
14601 result will (more often than not) be cleaner and more pleasing than the
14602 original. 
14603
14604 @item ephemeral groups
14605 @cindex ephemeral groups
14606 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14607 groups are groups that will have no data stored---when you exit the
14608 group, it'll disappear into the aether.  
14609
14610 @item solid groups
14611 @cindex solid groups
14612 This is the opposite of ephemeral groups.  All groups listed in the
14613 group buffer are solid groups.
14614
14615 @item sparse articles
14616 @cindex sparse articles
14617 These are article placeholders shown in the summary buffer when
14618 @code{gnus-build-sparse-threads} has been switched on.
14619
14620 @end table
14621
14622
14623 @node Customization
14624 @section Customization
14625 @cindex general customization
14626
14627 All variables are properly documented elsewhere in this manual.  This
14628 section is designed to give general pointers on how to customize Gnus
14629 for some quite common situations.
14630
14631 @menu
14632 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14633 * Slow Terminal Connection::  You run a remote Emacs.
14634 * Little Disk Space::         You feel that having large setup files is icky.
14635 * Slow Machine::              You feel like buying a faster machine.
14636 @end menu
14637
14638
14639 @node Slow/Expensive Connection
14640 @subsection Slow/Expensive @sc{nntp} Connection
14641
14642 If you run Emacs on a machine locally, and get your news from a machine
14643 over some very thin strings, you want to cut down on the amount of data
14644 Gnus has to get from the @sc{nntp} server.
14645
14646 @table @code
14647
14648 @item gnus-read-active-file
14649 Set this to @code{nil}, which will inhibit Gnus from requesting the
14650 entire active file from the server.  This file is often v.  large.  You
14651 also have to set @code{gnus-check-new-newsgroups} and
14652 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14653 doesn't suddenly decide to fetch the active file anyway.
14654
14655 @item gnus-nov-is-evil
14656 This one has to be @code{nil}.  If not, grabbing article headers from
14657 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
14658 support @sc{xover}; Gnus will detect this by itself.
14659 @end table
14660
14661
14662 @node Slow Terminal Connection
14663 @subsection Slow Terminal Connection
14664
14665 Let's say you use your home computer for dialing up the system that
14666 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
14667 amount of data that is sent over the wires as much as possible.
14668
14669 @table @code
14670
14671 @item gnus-auto-center-summary
14672 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14673 buffer all the time.  If it is @code{vertical}, do only vertical
14674 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
14675 horizontal and vertical recentering.
14676
14677 @item gnus-visible-headers
14678 Cut down on the headers that are included in the articles to the
14679 minimum.  You can, in fact, make do without them altogether---most of the
14680 useful data is in the summary buffer, anyway.  Set this variable to
14681 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14682
14683 @item gnus-article-display-hook
14684 Set this hook to all the available hiding commands:
14685 @lisp
14686 (setq gnus-article-display-hook 
14687       '(gnus-article-hide-headers gnus-article-hide-signature
14688         gnus-article-hide-citation))
14689 @end lisp
14690
14691 @item gnus-use-full-window
14692 By setting this to @code{nil}, you can make all the windows smaller.
14693 While this doesn't really cut down much generally, it means that you
14694 have to see smaller portions of articles before deciding that you didn't
14695 want to read them anyway.
14696
14697 @item gnus-thread-hide-subtree
14698 If this is non-@code{nil}, all threads in the summary buffer will be
14699 hidden initially.
14700
14701 @item gnus-updated-mode-lines
14702 If this is @code{nil}, Gnus will not put information in the buffer mode
14703 lines, which might save some time.
14704 @end table
14705
14706
14707 @node Little Disk Space
14708 @subsection Little Disk Space
14709 @cindex disk space
14710
14711 The startup files can get rather large, so you may want to cut their
14712 sizes a bit if you are running out of space.
14713
14714 @table @code
14715
14716 @item gnus-save-newsrc-file
14717 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14718 only save @file{.newsrc.eld}.  This means that you will not be able to
14719 use any other newsreaders than Gnus.  This variable is @code{t} by
14720 default. 
14721
14722 @item gnus-save-killed-list
14723 If this is @code{nil}, Gnus will not save the list of dead groups.  You
14724 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14725 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14726 variable to @code{nil}.  This variable is @code{t} by default.
14727
14728 @end table
14729
14730
14731 @node Slow Machine
14732 @subsection Slow Machine
14733 @cindex slow machine
14734
14735 If you have a slow machine, or are just really impatient, there are a
14736 few things you can do to make Gnus run faster.
14737
14738 Set@code{gnus-check-new-newsgroups} and
14739 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14740
14741 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14742 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14743 summary buffer faster.
14744
14745 Set @code{gnus-article-display-hook} to @code{nil} to make article
14746 processing a bit faster.
14747
14748
14749 @node Troubleshooting
14750 @section Troubleshooting
14751 @cindex troubleshooting
14752
14753 Gnus works @emph{so} well straight out of the box---I can't imagine any
14754 problems, really.
14755
14756 Ahem.
14757
14758 @enumerate
14759
14760 @item
14761 Make sure your computer is switched on.
14762
14763 @item
14764 Make sure that you really load the current Gnus version.  If you have
14765 been running @sc{gnus}, you need to exit Emacs and start it up again before
14766 Gnus will work.
14767
14768 @item
14769 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
14770 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
14771 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14772 flee}, you have some old @file{.el} files lying around.  Delete these.
14773
14774 @item
14775 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14776 how-to. 
14777
14778 @item
14779 @vindex max-lisp-eval-depth
14780 Gnus works on many recursive structures, and in some extreme (and very
14781 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14782 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14783 something like that.
14784 @end enumerate
14785
14786 If all else fails, report the problem as a bug.
14787
14788 @cindex bugs
14789 @cindex reporting bugs
14790
14791 @kindex M-x gnus-bug
14792 @findex gnus-bug
14793 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14794 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14795 me the backtrace.  I will fix bugs, but I can only fix them if you send
14796 me a precise description as to how to reproduce the bug.
14797
14798 You really can never be too detailed in a bug report.  Always use the
14799 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14800 a 10Kb mail each time you use it, and even if you have sent me your
14801 environment 500 times before.  I don't care.  I want the full info each
14802 time.  
14803
14804 It is also important to remember that I have no memory whatsoever.  If
14805 you send a bug report, and I send you a reply, and then you send back
14806 just ``No, it's not! Moron!'', I will have no idea what you are
14807 insulting me about.  Always over-explain everything.  It's much easier
14808 for all of us---if I don't have all the information I need, I will just
14809 mail you and ask for more info, and everything takes more time.
14810
14811 If the problem you're seeing is very visual, and you can't quite explain
14812 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14813 it somewhere it can be reached, and include the URL of the picture in
14814 the bug report.
14815
14816 If you just need help, you are better off asking on
14817 @samp{gnu.emacs.gnus}.  I'm not very helpful.
14818
14819 @cindex gnu.emacs.gnus
14820 @cindex ding mailing list
14821 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14822 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14823
14824
14825 @node A Programmers Guide to Gnus
14826 @section A Programmer@'s Guide to Gnus
14827
14828 It is my hope that other people will figure out smart stuff that Gnus
14829 can do, and that other people will write those smart things as well.  To
14830 facilitate that I thought it would be a good idea to describe the inner
14831 workings of Gnus.  And some of the not-so-inner workings, while I'm at
14832 it.
14833
14834 You can never expect the internals of a program not to change, but I
14835 will be defining (in some details) the interface between Gnus and its
14836 backends (this is written in stone), the format of the score files
14837 (ditto), data structures (some are less likely to change than others)
14838 and general method of operations.
14839
14840 @menu 
14841 * Backend Interface::        How Gnus communicates with the servers.
14842 * Score File Syntax::        A BNF definition of the score file standard.
14843 * Headers::                  How Gnus stores headers internally.
14844 * Ranges::                   A handy format for storing mucho numbers.
14845 * Group Info::               The group info format.
14846 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
14847 * Various File Formats::     Formats of files that Gnus use.
14848 @end menu
14849
14850
14851 @node Backend Interface
14852 @subsection Backend Interface
14853
14854 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14855 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
14856 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
14857 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
14858 examples of the latter we have @code{nntp-port-number} and
14859 @code{nnmbox-directory}.
14860
14861 When Gnus asks for information from a backend---say @code{nntp}---on
14862 something, it will normally include a virtual server name in the
14863 function parameters.  (If not, the backend should use the ``current''
14864 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
14865 server as its only (optional) parameter.  If this virtual server hasn't
14866 been opened, the function should fail.
14867
14868 Note that a virtual server name has no relation to some physical server
14869 name.  Take this example:
14870
14871 @lisp
14872 (nntp "odd-one" 
14873       (nntp-address "ifi.uio.no") 
14874       (nntp-port-number 4324))
14875 @end lisp
14876
14877 Here the virtual server name is @samp{odd-one} while the name of
14878 the physical server is @samp{ifi.uio.no}. 
14879
14880 The backends should be able to switch between several virtual servers.
14881 The standard backends implement this by keeping an alist of virtual
14882 server environments that it pulls down/pushes up when needed.  
14883
14884 There are two groups of interface functions: @dfn{required functions},
14885 which must be present, and @dfn{optional functions}, which Gnus will
14886 always check whether are present before attempting to call.
14887
14888 All these functions are expected to return data in the buffer
14889 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14890 unfortunately named, but we'll have to live with it.  When I talk about
14891 @dfn{resulting data}, I always refer to the data in that buffer.  When I
14892 talk about @dfn{return value}, I talk about the function value returned by
14893 the function call.  Functions that fail should return @code{nil} as the
14894 return value.
14895
14896 Some backends could be said to be @dfn{server-forming} backends, and
14897 some might be said to not be.  The latter are backends that generally
14898 only operate on one group at a time, and have no concept of ``server''
14899 -- they have a group, and they deliver info on that group and nothing
14900 more.
14901
14902 In the examples and definitions I will refer to the imaginary backend
14903 @code{nnchoke}. 
14904
14905 @cindex @code{nnchoke}
14906
14907 @menu
14908 * Required Backend Functions::        Functions that must be implemented.
14909 * Optional Backend Functions::        Functions that need not be implemented.
14910 * Error Messaging::                   How to get messages and report errors.
14911 * Writing New Backends::              Extending old backends.
14912 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
14913 * Mail-like Backends::                Some tips on mail backends.
14914 @end menu
14915
14916
14917 @node Required Backend Functions
14918 @subsubsection Required Backend Functions
14919
14920 @table @code
14921
14922 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
14923
14924 @var{articles} is either a range of article numbers or a list of
14925 @code{Message-ID}s.  Current backends do not fully support either---only
14926 sequences (lists) of article numbers, and most backends do not support
14927 retrieval of @code{Message-ID}s.  But they should try for both. 
14928
14929 The result data should either be HEADs or NOV lines, and the result
14930 value should either be @code{headers} or @code{nov} to reflect this.
14931 This might later be expanded to @code{various}, which will be a mixture
14932 of HEADs and NOV lines, but this is currently not supported by Gnus.  
14933
14934 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
14935 headers, in some meaning of the word.  This is generally done by
14936 fetching (at most) @var{fetch-old} extra headers less than the smallest
14937 article number in @code{articles}, and fill in the gaps as well.  The
14938 presence of this parameter can be ignored if the backend finds it
14939 cumbersome to follow the request.  If this is non-@code{nil} and not a
14940 number, do maximum fetches.
14941
14942 Here's an example HEAD:
14943
14944 @example
14945 221 1056 Article retrieved.
14946 Path: ifi.uio.no!sturles
14947 From: sturles@@ifi.uio.no (Sturle Sunde)
14948 Newsgroups: ifi.discussion
14949 Subject: Re: Something very droll
14950 Date: 27 Oct 1994 14:02:57 +0100
14951 Organization: Dept. of Informatics, University of Oslo, Norway
14952 Lines: 26
14953 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
14954 References: <38jdmq$4qu@@visbur.ifi.uio.no>
14955 NNTP-Posting-Host: holmenkollen.ifi.uio.no
14956 .
14957 @end example
14958
14959 So a @code{headers} return value would imply that there's a number of
14960 these in the data buffer.
14961
14962 Here's a BNF definition of such a buffer:
14963
14964 @example
14965 headers        = *head
14966 head           = error / valid-head
14967 error-message  = [ "4" / "5" ] 2number " " <error message> eol
14968 valid-head     = valid-message *header "." eol
14969 valid-message  = "221 " <number> " Article retrieved." eol
14970 header         = <text> eol
14971 @end example
14972
14973 If the return value is @code{nov}, the data buffer should contain
14974 @dfn{network overview database} lines.  These are basically fields
14975 separated by tabs. 
14976
14977 @example
14978 nov-buffer = *nov-line
14979 nov-line   = 8*9 [ field <TAB> ] eol
14980 field      = <text except TAB>
14981 @end example
14982
14983 For a closer explanation what should be in those fields,
14984 @pxref{Headers}. 
14985
14986
14987 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
14988
14989 @var{server} is here the virtual server name.  @var{definitions} is a
14990 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
14991
14992 If the server can't be opened, no error should be signaled.  The backend
14993 may then choose to refuse further attempts at connecting to this
14994 server.  In fact, it should do so. 
14995
14996 If the server is opened already, this function should return a
14997 non-@code{nil} value.  There should be no data returned.
14998
14999
15000 @item (nnchoke-close-server &optional SERVER)
15001
15002 Close connection to @var{server} and free all resources connected
15003 to it.  Return @code{nil} if the server couldn't be closed for some
15004 reason.
15005
15006 There should be no data returned.
15007
15008
15009 @item (nnchoke-request-close)
15010
15011 Close connection to all servers and free all resources that the backend
15012 have reserved.  All buffers that have been created by that backend
15013 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
15014 function is generally only called when Gnus is shutting down.
15015
15016 There should be no data returned. 
15017
15018
15019 @item (nnchoke-server-opened &optional SERVER)
15020
15021 If @var{server} is the current virtual server, and the connection to the
15022 physical server is alive, then this function should return a
15023 non-@code{nil} vlue.  This function should under no circumstances
15024 attempt to reconnect to a server that is has lost connection to.
15025
15026 There should be no data returned.
15027
15028
15029 @item (nnchoke-status-message &optional SERVER)
15030
15031 This function should return the last error message from @var{server}. 
15032
15033 There should be no data returned.
15034
15035
15036 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15037
15038 The result data from this function should be the article specified by
15039 @var{article}.  This might either be a @code{Message-ID} or a number.
15040 It is optional whether to implement retrieval by @code{Message-ID}, but
15041 it would be nice if that were possible.
15042
15043 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15044 in this buffer instead of the normal data buffer.  This is to make it
15045 possible to avoid copying large amounts of data from one buffer to
15046 another, and Gnus mainly request articles to be inserted directly into
15047 its article buffer.
15048
15049 If it is at all possible, this function should return a cons cell where
15050 the car is the group name the article was fetched from, and the cdr is
15051 the article number.  This will enable Gnus to find out what the real
15052 group and article numbers are when fetching articles by
15053 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
15054 on successful article retrievement.
15055
15056
15057 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15058
15059 Get data on @var{group}.  This function also has the side effect of
15060 making @var{group} the current group. 
15061
15062 If @var{FAST}, don't bother to return useful data, just make @var{group}
15063 the current group.
15064
15065 Here's an example of some result data and a definition of the same:
15066
15067 @example
15068 211 56 1000 1059 ifi.discussion
15069 @end example
15070
15071 The first number is the status, which should be 211.  Next is the
15072 total number of articles in the group, the lowest article number, the
15073 highest article number, and finally the group name.  Note that the total
15074 number of articles may be less than one might think while just
15075 considering the highest and lowest article numbers, but some articles
15076 may have been canceled.  Gnus just discards the total-number, so
15077 whether one should take the bother to generate it properly (if that is a
15078 problem) is left as an exercise to the reader.
15079
15080 @example
15081 group-status = [ error / info ] eol
15082 error        = [ "4" / "5" ] 2<number> " " <Error message>
15083 info         = "211 " 3* [ <number> " " ] <string>
15084 @end example
15085
15086
15087 @item (nnchoke-close-group GROUP &optional SERVER)
15088
15089 Close @var{group} and free any resources connected to it.  This will be
15090 a no-op on most backends. 
15091
15092 There should be no data returned.
15093
15094
15095 @item (nnchoke-request-list &optional SERVER)
15096
15097 Return a list of all groups available on @var{server}.  And that means
15098 @emph{all}. 
15099
15100 Here's an example from a server that only carries two groups:
15101
15102 @example
15103 ifi.test 0000002200 0000002000 y
15104 ifi.discussion 3324 3300 n
15105 @end example
15106
15107 On each line we have a group name, then the highest article number in
15108 that group, the lowest article number, and finally a flag.
15109
15110 @example
15111 active-file = *active-line
15112 active-line = name " " <number> " " <number> " " flags eol
15113 name        = <string>
15114 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
15115 @end example
15116
15117 The flag says whether the group is read-only (@samp{n}), is moderated
15118 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15119 (@samp{=other-group} or none of the above (@samp{y}). 
15120
15121
15122 @item (nnchoke-request-post &optional SERVER)
15123
15124 This function should post the current buffer.  It might return whether
15125 the posting was successful or not, but that's not required.  If, for
15126 instance, the posting is done asynchronously, it has generally not been
15127 completed by the time this function concludes.  In that case, this
15128 function should set up some kind of sentinel to beep the user loud and
15129 clear if the posting could not be completed.
15130
15131 There should be no result data from this function. 
15132
15133 @end table
15134
15135
15136 @node Optional Backend Functions
15137 @subsubsection Optional Backend Functions
15138
15139 @table @code
15140
15141 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15142
15143 @var{groups} is a list of groups, and this function should request data
15144 on all those groups.  How it does it is of no concern to Gnus, but it
15145 should attempt to do this in a speedy fashion.
15146
15147 The return value of this function can be either @code{active} or
15148 @code{group}, which says what the format of the result data is.  The
15149 former is in the same format as the data from
15150 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15151 in the same format as @code{nnchoke-request-group} gives.
15152
15153 @example
15154 group-buffer = *active-line / *group-status
15155 @end example
15156
15157
15158 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15159
15160 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15161 alterations.  This comes in handy if the backend really carries all the
15162 information (as is the case with virtual an imap groups).  This function
15163 should destructively alter the info to suit its needs, and should return
15164 the (altered) group info.  
15165
15166 There should be no result data from this function.
15167
15168
15169 @item (nnchoke-request-type GROUP &optional ARTICLE)
15170
15171 When the user issues commands for ``sending news'' (@kbd{F} in the
15172 summary buffer, for instance), Gnus has to know whether the article the
15173 user is following up is news or mail.  This function should return
15174 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15175 is mail and @code{unknown} if the type can't be decided.  (The
15176 @var{article} parameter is necessary in @code{nnvirtual} groups which
15177 might very well combine mail groups and news groups.)  Both @var{group}
15178 and @var{article} may be @code{nil}.
15179
15180 There should be no result data from this function.
15181
15182
15183 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15184
15185 If the user tries to set a mark that the backend doesn't like, this
15186 function may change the mark.  Gnus will use whatever this function
15187 returns as the mark for @var{article} instead of the original
15188 @var{mark}.  If the backend doesn't care, it must return the original
15189 @var{mark}, and not @code{nil} or any other type of garbage.  
15190
15191 The only use for this that I can see is what @code{nnvirtual} does with
15192 it---if a component group is auto-expirable, marking an article as read
15193 in the virtual group should result in the article being marked as
15194 expirable. 
15195
15196 There should be no result data from this function.
15197
15198
15199 @item (nnchoke-request-scan &optional GROUP SERVER)
15200
15201 This function may be called at any time (by Gnus or anything else) to
15202 request that the backend check for incoming articles, in one way or
15203 another.  A mail backend will typically read the spool file or query the
15204 POP server when this function is invoked.  The @var{group} doesn't have
15205 to be heeded---if the backend decides that it is too much work just
15206 scanning for a single group, it may do a total scan of all groups.  It
15207 would be nice, however, to keep things local if that's practical.
15208
15209 There should be no result data from this function.
15210
15211
15212 @item (nnchoke-request-group-description GROUP &optional SERVER)
15213
15214 The result data from this function should be a description of
15215 @var{group}. 
15216
15217 @example
15218 description-line = name <TAB> description eol
15219 name             = <string>
15220 description      = <text>
15221 @end example
15222
15223 @item (nnchoke-request-list-newsgroups &optional SERVER)
15224
15225 The result data from this function should be the description of all
15226 groups available on the server.
15227
15228 @example
15229 description-buffer = *description-line
15230 @end example
15231
15232
15233 @item (nnchoke-request-newgroups DATE &optional SERVER)
15234
15235 The result data from this function should be all groups that were
15236 created after @samp{date}, which is in normal human-readable date
15237 format.  The data should be in the active buffer format.
15238
15239
15240 @item (nnchoke-request-create-group GROUP &optional SERVER)
15241
15242 This function should create an empty group with name @var{group}.  
15243
15244 There should be no return data.
15245
15246
15247 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15248
15249 This function should run the expiry process on all articles in the
15250 @var{articles} range (which is currently a simple list of article
15251 numbers.)  It is left up to the backend to decide how old articles
15252 should be before they are removed by this function.  If @var{force} is
15253 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15254 they are. 
15255
15256 This function should return a list of articles that it did not/was not
15257 able to delete.
15258
15259 There should be no result data returned.
15260
15261
15262 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15263 &optional LAST)
15264
15265 This function should move @var{article} (which is a number) from
15266 @var{group} by calling @var{accept-form}.  
15267
15268 This function should ready the article in question for moving by
15269 removing any header lines it has added to the article, and generally
15270 should ``tidy up'' the article.  Then it should @code{eval}
15271 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15272 will do the actual copying.  If this @code{eval} returns a
15273 non-@code{nil} value, the article should be removed.
15274
15275 If @var{last} is @code{nil}, that means that there is a high likelihood
15276 that there will be more requests issued shortly, so that allows some
15277 optimizations. 
15278
15279 The function should return a cons where the car is the group name and
15280 the cdr is the article number that the article was entered as.
15281
15282 There should be no data returned. 
15283
15284
15285 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15286
15287 This function takes the current buffer and inserts it into @var{group}.
15288 If @var{last} in @code{nil}, that means that there will be more calls to
15289 this function in short order.
15290
15291 The function should return a cons where the car is the group name and
15292 the cdr is the article number that the article was entered as.
15293
15294 There should be no data returned.
15295
15296
15297 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15298
15299 This function should remove @var{article} (which is a number) from
15300 @var{group} and insert @var{buffer} there instead.
15301
15302 There should be no data returned.
15303
15304
15305 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15306
15307 This function should delete @var{group}.  If @var{force}, it should
15308 really delete all the articles in the group, and then delete the group
15309 itself.  (If there is such a thing as ``the group itself''.)
15310
15311 There should be no data returned.
15312
15313
15314 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15315
15316 This function should rename @var{group} into @var{new-name}.  All
15317 articles that are in @var{group} should move to @var{new-name}.
15318
15319 There should be no data returned.
15320
15321 @end table
15322
15323
15324 @node Error Messaging
15325 @subsubsection Error Messaging
15326
15327 @findex nnheader-report
15328 @findex nnheader-get-report
15329 The backends should use the function @code{nnheader-report} to report
15330 error conditions---they should not raise errors when they aren't able to
15331 perform a request.  The first argument to this function is the backend
15332 symbol, and the rest are interpreted as arguments to @code{format} if
15333 there are many of them, or just a string if there is one of them.
15334 This function always returns @code{nil}.
15335
15336 @lisp
15337 (nnheader-report 'nnchoke "You did something totally bogus")
15338
15339 (nnheader-report 'nnchoke "Could not request group %s" group)
15340 @end lisp
15341
15342 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15343 @code{nil} back from a server, and this function returns the most
15344 recently reported message for the backend in question.  This function
15345 takes one argument---the server symbol.
15346
15347 Internally, these function access @var{backend}@code{-status-string}, so
15348 the @code{nnchoke} backend will have its error message stored in
15349 @code{nnchoke-status-string}. 
15350
15351
15352 @node Writing New Backends
15353 @subsubsection Writing New Backends
15354
15355 Many backends are quite similar.  @code{nnml} is just like
15356 @code{nnspool}, but it allows you to edit the articles on the server.
15357 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15358 and it doesn't maintain overview databases.  @code{nndir} is just like
15359 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15360 editing articles.
15361
15362 It would make sense if it were possible to ``inherit'' functions from
15363 backends when writing new backends.  And, indeed, you can do that if you
15364 want to.  (You don't have to if you don't want to, of course.)  
15365
15366 All the backends declare their public variables and functions by using a
15367 package called @code{nnoo}.  
15368
15369 To inherit functions from other backends (and allow other backends to
15370 inherit functions from the current backend), you should use the
15371 following macros:
15372 following. 
15373
15374 @table @code
15375
15376 @item nnoo-declare
15377 This macro declares the first parameter to be a child of the subsequent
15378 parameters.  For instance:
15379
15380 @lisp
15381 (nnoo-declare nndir
15382   nnml nnmh)
15383 @end lisp
15384
15385 @code{nndir} has here declared that it intends to inherit functions from
15386 both @code{nnml} and @code{nnmh}.
15387
15388 @item defvoo
15389 This macro is equivalent to @code{defvar}, but registers the variable as
15390 a public server variable.  Most state-oriented variables should be
15391 declared with @code{defvoo} instead of @code{defvar}.  
15392
15393 In addition to the normal @code{defvar} parameters, it takes a list of
15394 variables in the parent backends to map the variable to when executing
15395 a function in those backends.
15396
15397 @lisp
15398 (defvoo nndir-directory nil
15399   "Where nndir will look for groups."
15400   nnml-current-directory nnmh-current-directory)
15401 @end lisp
15402
15403 This means that @code{nnml-current-directory} will be set to
15404 @code{nndir-directory} when an @code{nnml} function is called on behalf
15405 of @code{nndir}.  (The same with @code{nnmh}.)  
15406
15407 @item nnoo-define-basics
15408 This macro defines some common functions that almost all backends should
15409 have.
15410
15411 @example
15412 (nnoo-define-basics nndir)
15413 @end example
15414
15415 @item deffoo
15416 This macro is just like @code{defun} and takes the same parameters.  In
15417 addition to doing the normal @code{defun} things, it registers the
15418 function as being public so that other backends can inherit it.
15419
15420 @item nnoo-map-functions
15421 This macro allows mapping of functions from the current backend to
15422 functions from the parent backends.
15423
15424 @example
15425 (nnoo-map-functions nndir
15426   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15427   (nnmh-request-article 0 nndir-current-group 0 0))
15428 @end example
15429
15430 This means that when @code{nndir-retrieve-headers} is called, the first,
15431 third, and fourth parameters will be passed on to
15432 @code{nnml-retrieve-headers}, while the second parameter is set to the
15433 value of @code{nndir-current-group}.
15434
15435 @item nnoo-import
15436 This macro allows importing functions from backends.  It should be the
15437 last thing in the source file, since it will only define functions that
15438 haven't already been defined.
15439
15440 @example
15441 (nnoo-import nndir
15442   (nnmh
15443    nnmh-request-list
15444    nnmh-request-newgroups)
15445   (nnml))
15446 @end example
15447
15448 This means that calls to @code{nndir-request-list} should just be passed
15449 on to @code{nnmh-request-list}, while all public functions from
15450 @code{nnml} that haven't been defined in @code{nndir} yet should be
15451 defined now.
15452
15453 @end table
15454
15455 Below is a slightly shortened version of the @code{nndir} backend.
15456
15457 @lisp
15458 ;;; nndir.el --- single directory newsgroup access for Gnus
15459 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15460
15461 ;;; Code:
15462
15463 (require 'nnheader)
15464 (require 'nnmh)
15465 (require 'nnml)
15466 (require 'nnoo)
15467 (eval-when-compile (require 'cl))
15468
15469 (nnoo-declare nndir
15470   nnml nnmh)
15471
15472 (defvoo nndir-directory nil
15473   "Where nndir will look for groups."
15474   nnml-current-directory nnmh-current-directory)
15475
15476 (defvoo nndir-nov-is-evil nil
15477   "*Non-nil means that nndir will never retrieve NOV headers."
15478   nnml-nov-is-evil)
15479
15480 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15481 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15482 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15483
15484 (defvoo nndir-status-string "" nil nnmh-status-string)
15485 (defconst nndir-version "nndir 1.0")
15486
15487 ;;; Interface functions.
15488
15489 (nnoo-define-basics nndir)
15490
15491 (deffoo nndir-open-server (server &optional defs)
15492   (setq nndir-directory
15493         (or (cadr (assq 'nndir-directory defs))
15494             server))
15495   (unless (assq 'nndir-directory defs)
15496     (push `(nndir-directory ,server) defs))
15497   (push `(nndir-current-group
15498           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15499         defs)
15500   (push `(nndir-top-directory
15501           ,(file-name-directory (directory-file-name nndir-directory)))
15502         defs)
15503   (nnoo-change-server 'nndir server defs))
15504
15505 (nnoo-map-functions nndir
15506   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15507   (nnmh-request-article 0 nndir-current-group 0 0)
15508   (nnmh-request-group nndir-current-group 0 0)
15509   (nnmh-close-group nndir-current-group 0))
15510
15511 (nnoo-import nndir
15512   (nnmh
15513    nnmh-status-message
15514    nnmh-request-list
15515    nnmh-request-newgroups))
15516
15517 (provide 'nndir)
15518 @end lisp
15519
15520
15521 @node Hooking New Backends Into Gnus
15522 @subsubsection Hooking New Backends Into Gnus
15523
15524 @vindex gnus-valid-select-methods
15525 Having Gnus start using your new backend is rather easy---you just
15526 declare it with the @code{gnus-declare-backend} functions.  This will
15527 enter the backend into the @code{gnus-valid-select-methods} variable.
15528
15529 @code{gnus-declare-backend} takes two parameters---the backend name and
15530 an arbitrary number of @dfn{abilities}.
15531
15532 Here's an example:
15533
15534 @lisp
15535 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15536 @end lisp
15537
15538 The abilities can be:
15539
15540 @table @code
15541 @item mail
15542 This is a mailish backend---followups should (probably) go via mail.
15543 @item post
15544 This is a newsish backend---followups should (probably) go via news. 
15545 @item post-mail
15546 This backend supports both mail and news.
15547 @item none
15548 This is neither a post or mail backend---it's something completely
15549 different. 
15550 @item respool
15551 It supports respooling---or rather, it is able to modify its source
15552 articles and groups.
15553 @item address
15554 The name of the server should be in the virtual server name.  This is
15555 true for almost all backends.
15556 @item prompt-address
15557 The user should be prompted for an address when doing commands like
15558 @kbd{B} in the group buffer.  This is true for backends like
15559 @code{nntp}, but not @code{nnmbox}, for instance. 
15560 @end table
15561
15562
15563 @node Mail-like Backends
15564 @subsubsection Mail-like Backends
15565
15566 One of the things that separate the mail backends from the rest of the
15567 backends is the heavy dependence by the mail backends on common
15568 functions in @file{nnmail.el}.  For instance, here's the definition of
15569 @code{nnml-request-scan}: 
15570
15571 @lisp
15572 (deffoo nnml-request-scan (&optional group server)
15573   (setq nnml-article-file-alist nil)
15574   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15575 @end lisp
15576
15577 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15578 and @code{nnmail} takes care of all the moving and splitting of the
15579 mail.  
15580
15581 This function takes four parameters.
15582
15583 @table @var
15584 @item method
15585 This should be a symbol to designate which backend is responsible for
15586 the call.
15587
15588 @item exit-function
15589 This function should be called after the splitting has been performed.
15590
15591 @item temp-directory
15592 Where the temporary files should be stored.
15593
15594 @item group
15595 This optional argument should be a group name if the splitting is to be
15596 performed for one group only.
15597 @end table
15598
15599 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15600 save each article.  @var{backend}@code{-active-number} will be called to
15601 find the article number assigned to this article.  
15602
15603 The function also uses the following variables:
15604 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15605 this backend); and @var{backend}@code{-group-alist} and
15606 @var{backend}@code{-active-file} to generate the new active file.
15607 @var{backend}@code{-group-alist} should be a group-active alist, like
15608 this:
15609
15610 @example
15611 (("a-group" (1 . 10))
15612  ("some-group" (34 . 39)))
15613 @end example
15614
15615
15616 @node Score File Syntax
15617 @subsection Score File Syntax
15618
15619 Score files are meant to be easily parsable, but yet extremely
15620 mallable.   It was decided that something that had the same read syntax
15621 as an Emacs Lisp list would fit that spec.
15622
15623 Here's a typical score file:
15624
15625 @lisp
15626 (("summary"
15627   ("win95" -10000 nil s)
15628   ("Gnus"))
15629  ("from"
15630   ("Lars" -1000))
15631  (mark -100))
15632 @end lisp
15633
15634 BNF definition of a score file:
15635
15636 @example
15637 score-file       = "" / "(" *element ")"
15638 element          = rule / atom
15639 rule             = string-rule / number-rule / date-rule
15640 string-rule      = "(" quote string-header quote space *string-match ")"
15641 number-rule      = "(" quote number-header quote space *number-match ")"
15642 date-rule        = "(" quote date-header quote space *date-match ")"
15643 quote            = <ascii 34>
15644 string-header    = "subject" / "from" / "references" / "message-id" / 
15645                    "xref" / "body" / "head" / "all" / "followup"
15646 number-header    = "lines" / "chars"
15647 date-header      = "date"
15648 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
15649                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15650 score            = "nil" / <integer>
15651 date             = "nil" / <natural number>
15652 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
15653                    "r" / "regex" / "R" / "Regex" /
15654                    "e" / "exact" / "E" / "Exact" /
15655                    "f" / "fuzzy" / "F" / "Fuzzy"
15656 number-match     = "(" <integer> [ "" / [ space score [ "" / 
15657                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15658 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
15659 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
15660                    space date [ "" / [ space date-match-t ] ] ] ] ")"
15661 date-match-t     = "nil" / "at" / "before" / "after"
15662 atom             = "(" [ required-atom / optional-atom ] ")"
15663 required-atom    = mark / expunge / mark-and-expunge / files /
15664                    exclude-files / read-only / touched
15665 optional-atom    = adapt / local / eval 
15666 mark             = "mark" space nil-or-number
15667 nil-or-number    = "nil" / <integer>
15668 expunge          = "expunge" space nil-or-number
15669 mark-and-expunge = "mark-and-expunge" space nil-or-number
15670 files            = "files" *[ space <string> ]
15671 exclude-files    = "exclude-files" *[ space <string> ]
15672 read-only        = "read-only" [ space "nil" / space "t" ]
15673 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15674 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15675 local            = "local" *[ space "(" <string> space <form> ")" ]
15676 eval             = "eval" space <form>
15677 space            = *[ " " / <TAB> / <NEWLINE> ]
15678 @end example
15679
15680 Any unrecognized elements in a score file should be ignored, but not
15681 discarded.  
15682
15683 As you can see, white space is needed, but the type and amount of white
15684 space is irrelevant.  This means that formatting of the score file is
15685 left up to the programmer---if it's simpler to just spew it all out on
15686 one looong line, then that's ok.
15687
15688 The meaning of the various atoms are explained elsewhere in this
15689 manual. 
15690
15691
15692 @node Headers
15693 @subsection Headers
15694
15695 Gnus uses internally a format for storing article headers that
15696 corresponds to the @sc{nov} format in a mysterious fashion.  One could
15697 almost suspect that the author looked at the @sc{nov} specification and
15698 just shamelessly @emph{stole} the entire thing, and one would be right.
15699
15700 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
15701 RFC1036 to talk about lines in the head of an article (e.g.,
15702 @code{From}).  It is used by many people as a synonym for
15703 ``head''---``the header and the body''.  (That should be avoided, in my
15704 opinion.)  And Gnus uses a format internally that it calls ``header'',
15705 which is what I'm talking about here.  This is a 9-element vector,
15706 basically, with each header (ouch) having one slot.
15707
15708 These slots are, in order: @code{number}, @code{subject}, @code{from},
15709 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15710 @code{xref}.  There are macros for accessing and setting these
15711 slots---they all have predictable names beginning with
15712 @code{mail-header-} and @code{mail-header-set-}, respectively.
15713
15714 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
15715 be put in there.
15716
15717
15718 @node Ranges
15719 @subsection Ranges
15720
15721 @sc{gnus} introduced a concept that I found so useful that I've started
15722 using it a lot and have elaborated on it greatly. 
15723
15724 The question is simple: If you have a large amount of objects that are
15725 identified by numbers (say, articles, to take a @emph{wild} example)
15726 that you want to qualify as being ``included'', a normal sequence isn't
15727 very useful.  (A 200,000 length sequence is a bit long-winded.)
15728
15729 The solution is as simple as the question: You just collapse the
15730 sequence. 
15731
15732 @example
15733 (1 2 3 4 5 6 10 11 12)
15734 @end example
15735
15736 is transformed into
15737
15738 @example
15739 ((1 . 6) (10 . 12))
15740 @end example
15741
15742 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15743 lonesome object, a @samp{13} is a valid element:
15744
15745 @example
15746 ((1 . 6) 7 (10 . 12))
15747 @end example
15748
15749 This means that comparing two ranges to find out whether they are equal
15750 is slightly tricky:
15751
15752 @example
15753 ((1 . 5) 7 8 (10 . 12))
15754 @end example
15755
15756 and
15757
15758 @example
15759 ((1 . 5) (7 . 8) (10 . 12))
15760 @end example
15761
15762 are equal.  In fact, any non-descending list is a range:
15763
15764 @example
15765 (1 2 3 4 5)
15766 @end example
15767
15768 is a perfectly valid range, although a pretty long-winded one.  This is
15769 also legal:
15770
15771 @example
15772 (1 . 5)
15773 @end example
15774
15775 and is equal to the previous range.
15776
15777 Here's a BNF definition of ranges.  Of course, one must remember the
15778 semantic requirement that the numbers are non-descending.  (Any number
15779 of repetition of the same number is allowed, but apt to disappear in
15780 range handling.)
15781
15782 @example
15783 range           = simple-range / normal-range
15784 simple-range    = "(" number " . " number ")"
15785 normal-range    = "(" start-contents ")"
15786 contents        = "" / simple-range *[ " " contents ] / 
15787                   number *[ " " contents ]
15788 @end example
15789
15790 Gnus currently uses ranges to keep track of read articles and article
15791 marks.  I plan on implementing a number of range operators in C if The
15792 Powers That Be are willing to let me.  (I haven't asked yet, because I
15793 need to do some more thinking on what operators I need to make life
15794 totally range-based without ever having to convert back to normal
15795 sequences.) 
15796
15797
15798 @node Group Info
15799 @subsection Group Info
15800
15801 Gnus stores all permanent info on groups in a @dfn{group info} list.
15802 This list is from three to six elements (or more) long and exhaustively
15803 describes the group.
15804
15805 Here are two example group infos; one is a very simple group while the
15806 second is a more complex one:
15807
15808 @example
15809 ("no.group" 5 (1 . 54324))
15810
15811 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15812                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15813                 (nnml "")
15814                 (auto-expire (to-address "ding@@ifi.uio.no")))
15815 @end example
15816
15817 The first element is the @dfn{group name}---as Gnus knows the group,
15818 anyway.  The second element is the @dfn{subscription level}, which
15819 normally is a small integer.  The third element is a list of ranges of
15820 read articles.  The fourth element is a list of lists of article marks
15821 of various kinds.  The fifth element is the select method (or virtual
15822 server, if you like).  The sixth element is a list of @dfn{group
15823 parameters}, which is what this section is about.
15824
15825 Any of the last three elements may be missing if they are not required.
15826 In fact, the vast majority of groups will normally only have the first
15827 three elements, which saves quite a lot of cons cells.
15828
15829 Here's a BNF definition of the group info format:
15830
15831 @example
15832 info          = "(" group space level space read 
15833                 [ "" / [ space marks-list [ "" / [ space method [ "" /
15834                 space parameters ] ] ] ] ] ")" 
15835 group         = quote <string> quote
15836 level         = <integer in the range of 1 to inf>
15837 read          = range
15838 marks-lists   = nil / "(" *marks ")"
15839 marks         = "(" <string> range ")"
15840 method        = "(" <string> *elisp-forms ")"
15841 parameters    = "(" *elisp-forms ")"
15842 @end example
15843
15844 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
15845 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15846 in pseudo-BNF.
15847
15848
15849 @node Emacs/XEmacs Code
15850 @subsection Emacs/XEmacs Code
15851 @cindex XEmacs
15852 @cindex Emacsen
15853
15854 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15855 platforms must be the primary one.  I chose Emacs.  Not because I don't
15856 like XEmacs or Mule, but because it comes first alphabetically.
15857
15858 This means that Gnus will byte-compile under Emacs with nary a warning,
15859 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15860 As I use byte-compilation warnings to help me root out trivial errors in
15861 Gnus, that's very useful.  
15862
15863 I've also consistently used Emacs function interfaces, but have used
15864 Gnusey aliases for the functions.  To take an example:  Emacs defines a
15865 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15866 function.  I then define a function called @code{gnus-run-at-time} that
15867 takes the same parameters as the Emacs @code{run-at-time}.  When running
15868 Gnus under Emacs, the former function is just an alias for the latter.
15869 However, when running under XEmacs, the former is an alias for the
15870 following function:
15871
15872 @lisp
15873 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15874   (start-itimer
15875    "gnus-run-at-time"
15876    `(lambda ()
15877       (,function ,@@args))
15878    time repeat))
15879 @end lisp
15880
15881 This sort of thing has been done for bunches of functions.  Gnus does
15882 not redefine any native Emacs functions while running under XEmacs---it
15883 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
15884 all over.
15885
15886 Of course, I could have chosen XEmacs as my native platform and done
15887 mapping functions the other way around.  But I didn't.  The performance
15888 hit these indirections impose on Gnus under XEmacs should be slight.
15889
15890
15891 @node Various File Formats
15892 @subsection Various File Formats
15893
15894 @menu
15895 * Active File Format::      Information on articles and groups available.
15896 * Newsgroups File Format::  Group descriptions.
15897 @end menu
15898
15899
15900 @node Active File Format
15901 @subsubsection Active File Format
15902
15903 The active file lists all groups that are available on the server in
15904 question.  It also lists the highest and lowest current article numbers
15905 in each group.  
15906
15907 Here's an excerpt from a typical active file:
15908
15909 @example
15910 soc.motss 296030 293865 y
15911 alt.binaries.pictures.fractals 3922 3913 n
15912 comp.sources.unix 1605 1593 m
15913 comp.binaries.ibm.pc 5097 5089 y
15914 no.general 1000 900 y
15915 @end example
15916
15917 Here's a pseudo-BNF definition of this file:
15918
15919 @example
15920 active      = *group-line
15921 group-line  = group space high-number space low-number space flag <NEWLINE>
15922 group       = <non-white-space string>
15923 space       = " "
15924 high-number = <non-negative integer>
15925 low-number  = <positive integer>
15926 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
15927 @end example
15928
15929
15930 @node Newsgroups File Format
15931 @subsubsection Newsgroups File Format
15932
15933 The newsgroups file lists groups along with their descriptions.  Not all
15934 groups on the server have to be listed,  and not all groups in the file
15935 have to exist on the server.  The file is meant purely as information to
15936 the user.
15937
15938 The format is quite simple; a group name, a tab, and the description.
15939 Here's the definition:
15940
15941 @example
15942 newsgroups    = *line
15943 line          = group tab description <NEWLINE>
15944 group         = <non-white-space string>
15945 tab           = <TAB>
15946 description   = <string>
15947 @end example
15948
15949
15950 @node Emacs for Heathens
15951 @section Emacs for Heathens
15952
15953 Believe it or not, but some people who use Gnus haven't really used
15954 Emacs much before they embarked on their journey on the Gnus Love Boat.
15955 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
15956 region'', and ``set @code{gnus-flargblossen} to an alist where the key
15957 is a regexp that is used for matching on the group name'' are magical
15958 phrases with little or no meaning, then this appendix is for you.  If
15959 you are already familiar with Emacs, just ignore this and go fondle your
15960 cat instead.
15961
15962 @menu
15963 * Keystrokes::      Entering text and executing commands.
15964 * Emacs Lisp::      The built-in Emacs programming language.
15965 @end menu
15966
15967
15968 @node Keystrokes
15969 @subsection Keystrokes
15970
15971 @itemize @bullet
15972 @item
15973 Q: What is an experienced Emacs user?
15974
15975 @item 
15976 A: A person who wishes that the terminal had pedals.
15977 @end itemize
15978
15979 Yes, when you use Emacs, you are apt to use the control key, the shift
15980 key and the meta key a lot.  This is very annoying to some people
15981 (notably @code{vi}le users), and the rest of us just love the hell out
15982 of it.  Just give up and submit.  Emacs really does stand for
15983 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
15984 may have heard from other disreputable sources (like the Emacs author).
15985
15986 The shift key is normally located near your pinky fingers, and are
15987 normally used to get capital letters and stuff.  You probably use it all
15988 the time.  The control key is normally marked ``CTRL'' or something like
15989 that.  The meta key is, funnily enough, never marked as such on any
15990 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
15991 which is the meta key on this keyboard.  It's usually located somewhere
15992 to the left hand side of the keyboard, usually on the bottom row.
15993
15994 Now, us Emacs people doesn't say ``press the meta-control-m key'',
15995 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
15996 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
15997 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
15998 down the control key, and hold it down while you press @kbd{k}''.
15999 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16000 the control key and then press @kbd{k}''.  Simple, ay?
16001
16002 This is somewhat complicated by the fact that not all keyboards have a
16003 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
16004 means ``press escape, release escape, press @kbd{k}''.  That's much more
16005 work than if you have a meta key, so if that's the case, I respectfully
16006 suggest you get a real keyboard with a meta key.  You can't live without
16007 it.
16008
16009
16010
16011 @node Emacs Lisp
16012 @subsection Emacs Lisp
16013
16014 Emacs is the King of Editors because it's really a Lisp interpreter.
16015 Each and every key you tap runs some Emacs Lisp code snippet, and since
16016 Emacs Lisp is an interpreted language, that means that you can configure
16017 any key to run any arbitrary code.  You just, like, do it.
16018
16019 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16020 functions.  (These are byte-compiled for speed, but it's still
16021 interpreted.)  If you decide that you don't like the way Gnus does
16022 certain things, it's trivial to have it do something a different way.
16023 (Well, at least if you know how to write Lisp code.)  However, that's
16024 beyond the scope of this manual, so we are simply going to talk about
16025 some common constructs that you normally use in your @file{.emacs} file
16026 to customize Gnus.
16027
16028 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16029 write the following:
16030
16031 @lisp
16032 (setq gnus-florgbnize 4)
16033 @end lisp
16034
16035 This function (really ``special form'') @code{setq} is the one that can
16036 set a variable to some value.  This is really all you need to know.  Now
16037 you can go and fill your @code{.emacs} file with lots of these to change
16038 how Gnus works.
16039
16040 If you have put that thing in your @code{.emacs} file, it will be read
16041 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16042 start Emacs.  If you want to change the variable right away, simply say
16043 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
16044 previous ``form'', which here is a simple @code{setq} statement.
16045
16046 Go ahead---just try it, if you're located at your Emacs.  After you
16047 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16048 is the return value of the form you @code{eval}ed.
16049
16050 Some pitfalls:
16051
16052 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16053 that means:
16054
16055 @lisp
16056 (setq gnus-read-active-file 'some)
16057 @end lisp
16058
16059 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16060 @samp{nntp.ifi.uio.no}'', that means:
16061
16062 @lisp
16063 (setq gnus-nntp-server "nntp.ifi.uio.no")
16064 @end lisp
16065
16066 So be careful not to mix up strings (the latter) with symbols (the
16067 former).  The manual is unambiguous, but it can be confusing.
16068
16069
16070 @include gnus-faq.texi
16071
16072 @node Index
16073 @chapter Index
16074 @printindex cp
16075
16076 @node Key Index
16077 @chapter Key Index
16078 @printindex ky
16079
16080 @summarycontents
16081 @contents
16082 @bye
16083
16084 @iftex
16085 @iflatex
16086 \end{document}
16087 @end iflatex
16088 @end iftex
16089
16090 @c End:
16091