*** 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 @findex gnus-group-fetch-faq
2859 @vindex gnus-group-faq-directory
2860 @cindex FAQ
2861 @cindex ange-ftp
2862 Try to fetch the FAQ for the current group
2863 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2864 @code{gnus-group-faq-directory}, which is usually a directory on a
2865 remote machine.  This variable can also be a list of directories.  In
2866 that case, giving a prefix to this command will allow you to choose
2867 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2868 for fetching the file.
2869
2870 If fetching from the first site is unsuccessful, Gnus will attempt to go
2871 through @code{gnus-group-faq-directory} and try to open them one by one.
2872
2873 @item H d
2874 @itemx C-c C-d
2875 @kindex H d (Group)
2876 @kindex C-c C-d (Group)
2877 @cindex describing groups
2878 @cindex group description
2879 @findex gnus-group-describe-group
2880 Describe the current group (@code{gnus-group-describe-group}).  If given
2881 a prefix, force Gnus to re-read the description from the server.
2882
2883 @item M-d
2884 @kindex M-d (Group)
2885 @findex gnus-group-describe-all-groups
2886 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2887 prefix, force Gnus to re-read the description file from the server.
2888
2889 @item V
2890 @kindex V (Group)
2891 @cindex version
2892 @findex gnus-version
2893 Display current Gnus version numbers (@code{gnus-version}).
2894
2895 @item ?
2896 @kindex ? (Group)
2897 @findex gnus-group-describe-briefly
2898 Give a very short help message (@code{gnus-group-describe-briefly}).
2899
2900 @item C-c C-i
2901 @kindex C-c C-i (Group)
2902 @cindex info
2903 @cindex manual
2904 @findex gnus-info-find-node
2905 Go to the Gnus info node (@code{gnus-info-find-node}).
2906 @end table
2907
2908
2909 @node Group Timestamp
2910 @subsection Group Timestamp
2911 @cindex timestamps
2912 @cindex group timestamps
2913
2914 It can be convenient to let Gnus keep track of when you last read a
2915 group.  To set the ball rolling, you should add
2916 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2917
2918 @lisp
2919 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2920 @end lisp
2921
2922 After doing this, each time you enter a group, it'll be recorded.
2923
2924 This information can be displayed in various ways---the easiest is to
2925 use the @samp{%d} spec in the group line format:
2926
2927 @lisp
2928 (setq gnus-group-line-format 
2929       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2930 @end lisp
2931
2932 This will result in lines looking like:
2933
2934 @example
2935 *        0: mail.ding                                19961002T012943
2936          0: custom                                   19961002T012713
2937 @end example
2938
2939 As you can see, the date is displayed in compact ISO 8601 format.  This
2940 may be a bit too much, so to just display the date, you could say
2941 something like:
2942
2943 @lisp
2944 (setq gnus-group-line-format 
2945       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2946 @end lisp
2947
2948
2949 @node File Commands
2950 @subsection File Commands
2951 @cindex file commands
2952
2953 @table @kbd
2954
2955 @item r
2956 @kindex r (Group)
2957 @findex gnus-group-read-init-file
2958 @vindex gnus-init-file
2959 @cindex reading init file
2960 Re-read the init file (@code{gnus-init-file}, which defaults to
2961 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2962
2963 @item s
2964 @kindex s (Group)
2965 @findex gnus-group-save-newsrc
2966 @cindex saving .newsrc
2967 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2968 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2969 file(s) whether Gnus thinks it is necessary or not.
2970
2971 @c @item Z
2972 @c @kindex Z (Group)
2973 @c @findex gnus-group-clear-dribble
2974 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2975
2976 @end table
2977
2978
2979 @node The Summary Buffer
2980 @chapter The Summary Buffer
2981 @cindex summary buffer
2982
2983 A line for each article is displayed in the summary buffer.  You can
2984 move around, read articles, post articles and reply to articles.
2985
2986 The most common way to a summary buffer is to select a group from the
2987 group buffer (@pxref{Selecting a Group}).  
2988
2989 You can have as many summary buffers open as you wish.
2990
2991 @menu
2992 * Summary Buffer Format::       Deciding how the summary buffer is to look.
2993 * Summary Maneuvering::         Moving around the summary buffer.
2994 * Choosing Articles::           Reading articles.
2995 * Paging the Article::          Scrolling the current article.
2996 * Reply Followup and Post::     Posting articles.
2997 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
2998 * Marking Articles::            Marking articles as read, expirable, etc.
2999 * Limiting::                    You can limit the summary buffer.
3000 * Threading::                   How threads are made.
3001 * Sorting::                     How articles and threads are sorted.
3002 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3003 * Article Caching::             You may store articles in a cache.
3004 * Persistent Articles::         Making articles expiry-resistant.
3005 * Article Backlog::             Having already read articles hang around.
3006 * Saving Articles::             Ways of customizing article saving.
3007 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3008 * Article Treatment::           The article buffer can be mangled at will.
3009 * Article Commands::            Doing various things with the article buffer.
3010 * Summary Sorting::             Sorting the summary buffer in various ways.
3011 * Finding the Parent::          No child support? Get the parent.
3012 * Alternative Approaches::      Reading using non-default summaries.
3013 * Tree Display::                A more visual display of threads.
3014 * Mail Group Commands::         Some commands can only be used in mail groups.
3015 * Various Summary Stuff::       What didn't fit anywhere else.
3016 * Exiting the Summary Buffer::  Returning to the Group buffer.
3017 * Crosspost Handling::          How crossposted articles are dealt with.
3018 * Duplicate Suppression::       An alternative when crosspost handling fails.
3019 @end menu
3020
3021
3022 @node Summary Buffer Format
3023 @section Summary Buffer Format
3024 @cindex summary buffer format
3025
3026 @menu
3027 * Summary Buffer Lines::     You can specify how summary lines should look.
3028 * Summary Buffer Mode Line:: You can say how the mode line should look.
3029 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3030 @end menu
3031
3032 @findex mail-extract-address-components
3033 @findex gnus-extract-address-components
3034 @vindex gnus-extract-address-components
3035 Gnus will use the value of the @code{gnus-extract-address-components}
3036 variable as a function for getting the name and address parts of a
3037 @code{From} header.  Two pre-defined function exist:
3038 @code{gnus-extract-address-components}, which is the default, quite
3039 fast, and too simplistic solution; and
3040 @code{mail-extract-address-components}, which works very nicely, but is
3041 slower.  The default function will return the wrong answer in 5% of the
3042 cases.  If this is unacceptable to you, use the other function instead.
3043
3044 @vindex gnus-summary-same-subject
3045 @code{gnus-summary-same-subject} is a string indicating that the current
3046 article has the same subject as the previous.  This string will be used
3047 with those specs that require it.  The default is @samp{}.
3048
3049
3050 @node Summary Buffer Lines
3051 @subsection Summary Buffer Lines
3052
3053 @vindex gnus-summary-line-format
3054 You can change the format of the lines in the summary buffer by changing
3055 the @code{gnus-summary-line-format} variable.  It works along the same
3056 lines a a normal @code{format} string, with some extensions
3057 (@pxref{Formatting Variables}).
3058
3059 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3060
3061 The following format specification characters are understood:
3062
3063 @table @samp
3064 @item N 
3065 Article number.
3066 @item S
3067 Subject string.
3068 @item s
3069 Subject if the article is the root or the previous article had a
3070 different subject, @code{gnus-summary-same-subject} otherwise.
3071 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3072 @item F
3073 Full @code{From} header.
3074 @item n
3075 The name (from the @code{From} header).
3076 @item a
3077 The name (from the @code{From} header).  This differs from the @code{n}
3078 spec in that it uses the function designated by the
3079 @code{gnus-extract-address-components} variable, which is slower, but
3080 may be more thorough.
3081 @item A
3082 The address (from the @code{From} header).  This works the same way as
3083 the @code{a} spec.
3084 @item L
3085 Number of lines in the article.
3086 @item c
3087 Number of characters in the article.
3088 @item I
3089 Indentation based on thread level (@pxref{Customizing Threading}).
3090 @item T
3091 Nothing if the article is a root and lots of spaces if it isn't (it
3092 pushes everything after it off the screen).
3093 @item [
3094 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3095 for adopted articles (@pxref{Customizing Threading}).
3096 @item ]
3097 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3098 for adopted articles.
3099 @item >
3100 One space for each thread level.
3101 @item <
3102 Twenty minus thread level spaces.
3103 @item U
3104 Unread.
3105 @item R
3106 Replied.
3107 @item i
3108 Score as a number.
3109 @item z
3110 @vindex gnus-summary-zcore-fuzz
3111 Zcore, @samp{+} if above the default level and @samp{-} if below the
3112 default level.  If the difference between
3113 @code{gnus-summary-default-level} and the score is less than
3114 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3115 @item V
3116 Total thread score.
3117 @item x
3118 @code{Xref}.
3119 @item D
3120 @code{Date}.
3121 @item d
3122 The @code{Date} in @code{DD-MMM} format.
3123 @item o
3124 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3125 @item M
3126 @code{Message-ID}.
3127 @item r
3128 @code{References}.
3129 @item t
3130 Number of articles in the current sub-thread.  Using this spec will slow
3131 down summary buffer generation somewhat.
3132 @item e
3133 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3134 article has any children.
3135 @item P
3136 The line number.
3137 @item u
3138 User defined specifier.  The next character in the format string should
3139 be a letter.  @sc{gnus} will call the function
3140 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3141 following @samp{%u}.  The function will be passed the current header as
3142 argument.  The function should return a string, which will be inserted
3143 into the summary just like information from any other summary specifier.
3144 @end table
3145
3146 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3147 have to be handled with care.  For reasons of efficiency, Gnus will
3148 compute what column these characters will end up in, and ``hard-code''
3149 that.  This means that it is illegal to have these specs after a
3150 variable-length spec.  Well, you might not be arrested, but your summary
3151 buffer will look strange, which is bad enough.
3152
3153 The smart choice is to have these specs as far to the left as possible.
3154 (Isn't that the case with everything, though?  But I digress.)
3155
3156 This restriction may disappear in later versions of Gnus.
3157
3158
3159 @node Summary Buffer Mode Line
3160 @subsection Summary Buffer Mode Line
3161
3162 @vindex gnus-summary-mode-line-format
3163 You can also change the format of the summary mode bar.  Set
3164 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3165 is @samp{Gnus: %%b [%A] %Z}.  
3166
3167 Here are the elements you can play with:
3168
3169 @table @samp
3170 @item G
3171 Group name.
3172 @item p
3173 Unprefixed group name.
3174 @item A
3175 Current article number.
3176 @item V
3177 Gnus version.
3178 @item U
3179 Number of unread articles in this group.
3180 @item e
3181 Number of unselected articles in this group.
3182 @item Z
3183 A string with the number of unread and unselected articles represented
3184 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3185 articles, and just as @samp{<%U more>} if there are just unread articles
3186 and no unselected ones.
3187 @item g
3188 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3189 shortened to @samp{r.a.anime}. 
3190 @item S
3191 Subject of the current article.
3192 @item u
3193 User-defined spec.
3194 @item s
3195 Name of the current score file.
3196 @item d
3197 Number of dormant articles.
3198 @item t
3199 Number of ticked articles.
3200 @item r
3201 Number of articles that have been marked as read in this session. 
3202 @item E
3203 Number of articles expunged by the score files.
3204 @end table
3205
3206
3207 @node Summary Highlighting
3208 @subsection Summary Highlighting
3209
3210 @table @code
3211
3212 @item gnus-visual-mark-article-hook
3213 @vindex gnus-visual-mark-article-hook
3214 This hook is run after selecting an article.  It is meant to be used for
3215 highlighting the article in some way.  It is not run if
3216 @code{gnus-visual} is @code{nil}.
3217
3218 @item gnus-summary-update-hook
3219 @vindex gnus-summary-update-hook
3220 This hook is called when a summary line is changed.  It is not run if
3221 @code{gnus-visual} is @code{nil}.
3222
3223 @item gnus-summary-selected-face
3224 @vindex gnus-summary-selected-face
3225 This is the face (or @dfn{font} as some people call it) that is used to
3226 highlight the current article in the summary buffer.
3227
3228 @item gnus-summary-highlight
3229 @vindex gnus-summary-highlight
3230 Summary lines are highlighted according to this variable, which is a
3231 list where the elements are on the format @var{(FORM . FACE)}.  If you
3232 would, for instance, like ticked articles to be italic and high-scored
3233 articles to be bold, you could set this variable to something like
3234 @lisp
3235 (((eq mark gnus-ticked-mark) . italic)
3236  ((> score default) . bold))
3237 @end lisp
3238 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3239 @var{FACE} will be applied to the line.
3240 @end table
3241
3242
3243 @node Summary Maneuvering
3244 @section Summary Maneuvering
3245 @cindex summary movement
3246
3247 All the straight movement commands understand the numeric prefix and
3248 behave pretty much as you'd expect. 
3249
3250 None of these commands select articles.
3251
3252 @table @kbd
3253 @item G M-n
3254 @itemx M-n
3255 @kindex M-n (Summary)
3256 @kindex G M-n (Summary)
3257 @findex gnus-summary-next-unread-subject
3258 Go to the next summary line of an unread article
3259 (@code{gnus-summary-next-unread-subject}). 
3260
3261 @item G M-p
3262 @itemx M-p
3263 @kindex M-p (Summary)
3264 @kindex G M-p (Summary)
3265 @findex gnus-summary-prev-unread-subject
3266 Go to the previous summary line of an unread article
3267 (@code{gnus-summary-prev-unread-subject}). 
3268
3269 @item G j
3270 @itemx j
3271 @kindex j (Summary)
3272 @kindex G j (Summary)
3273 @findex gnus-summary-goto-article
3274 Ask for an article number and then go to that article
3275 (@code{gnus-summary-goto-article}). 
3276
3277 @item G g
3278 @kindex G g (Summary)
3279 @findex gnus-summary-goto-subject
3280 Ask for an article number and then go the summary line of that article
3281 without displaying the article (@code{gnus-summary-goto-subject}).
3282 @end table
3283
3284 If Gnus asks you to press a key to confirm going to the next group, you
3285 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3286 buffer, searching for the next group to read without actually returning
3287 to the group buffer.
3288
3289 Variables related to summary movement:
3290
3291 @table @code
3292
3293 @vindex gnus-auto-select-next
3294 @item gnus-auto-select-next
3295 If you issue one of the movement commands (like @kbd{n}) and there are
3296 no more unread articles after the current one, Gnus will offer to go to
3297 the next group.  If this variable is @code{t} and the next group is
3298 empty, Gnus will exit summary mode and return to the group buffer.  If
3299 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3300 next group, no matter whether it has any unread articles or not.  As a
3301 special case, if this variable is @code{quietly}, Gnus will select the
3302 next group without asking for confirmation.  If this variable is
3303 @code{almost-quietly}, the same will happen only if you are located on
3304 the last article in the group.  Finally, if this variable is
3305 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3306 without confirmation.  Also @pxref{Group Levels}.
3307
3308 @item gnus-auto-select-same
3309 @vindex gnus-auto-select-same
3310 If non-@code{nil}, all the movement commands will try to go to the next
3311 article with the same subject as the current.  (@dfn{Same} here might
3312 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3313 for details (@pxref{Customizing Threading}).)  This variable is not
3314 particularly useful if you use a threaded display.
3315
3316 @item gnus-summary-check-current
3317 @vindex gnus-summary-check-current
3318 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3319 to the next (or previous) article if the current article is unread.
3320 Instead, they will choose the current article.
3321
3322 @item gnus-auto-center-summary
3323 @vindex gnus-auto-center-summary
3324 If non-@code{nil}, Gnus will keep the point in the summary buffer
3325 centered at all times.  This makes things quite tidy, but if you have a
3326 slow network connection, or simply do not like this un-Emacsism, you can
3327 set this variable to @code{nil} to get the normal Emacs scrolling
3328 action.  This will also inhibit horizontal re-centering of the summary
3329 buffer, which might make it more inconvenient to read extremely long
3330 threads.
3331
3332 @end table
3333
3334
3335 @node Choosing Articles
3336 @section Choosing Articles
3337 @cindex selecting articles
3338
3339 @menu
3340 * Choosing Commands::        Commands for choosing articles.
3341 * Choosing Variables::       Variables that influence these commands.
3342 @end menu
3343
3344
3345 @node Choosing Commands
3346 @subsection Choosing Commands
3347
3348 None of the following movement commands understand the numeric prefix,
3349 and they all select and display an article.
3350
3351 @table @kbd
3352 @item SPACE
3353 @kindex SPACE (Summary)
3354 @findex gnus-summary-next-page
3355 Select the current article, or, if that one's read already, the next
3356 unread article (@code{gnus-summary-next-page}).
3357
3358 @item G n
3359 @itemx n
3360 @kindex n (Summary)
3361 @kindex G n (Summary)
3362 @findex gnus-summary-next-unread-article
3363 Go to next unread article (@code{gnus-summary-next-unread-article}).
3364
3365 @item G p
3366 @itemx p
3367 @kindex p (Summary)
3368 @findex gnus-summary-prev-unread-article
3369 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3370
3371 @item G N
3372 @itemx N
3373 @kindex N (Summary)
3374 @kindex G N (Summary)
3375 @findex gnus-summary-next-article
3376 Go to the next article (@code{gnus-summary-next-article}).
3377
3378 @item G P
3379 @itemx P
3380 @kindex P (Summary)
3381 @kindex G P (Summary)
3382 @findex gnus-summary-prev-article
3383 Go to the previous article (@code{gnus-summary-prev-article}).
3384
3385 @item G C-n
3386 @kindex G C-n (Summary)
3387 @findex gnus-summary-next-same-subject
3388 Go to the next article with the same subject
3389 (@code{gnus-summary-next-same-subject}). 
3390
3391 @item G C-p
3392 @kindex G C-p (Summary)
3393 @findex gnus-summary-prev-same-subject
3394 Go to the previous article with the same subject
3395 (@code{gnus-summary-prev-same-subject}). 
3396
3397 @item G f
3398 @itemx .
3399 @kindex G f  (Summary)
3400 @kindex .  (Summary)
3401 @findex gnus-summary-first-unread-article
3402 Go to the first unread article
3403 (@code{gnus-summary-first-unread-article}).
3404
3405 @item G b
3406 @itemx ,
3407 @kindex G b (Summary)
3408 @kindex , (Summary)
3409 @findex gnus-summary-best-unread-article
3410 Go to the article with the highest score
3411 (@code{gnus-summary-best-unread-article}). 
3412
3413 @item G l
3414 @itemx l
3415 @kindex l (Summary)
3416 @kindex G l (Summary)
3417 @findex gnus-summary-goto-last-article
3418 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3419
3420 @item G p
3421 @kindex G p (Summary)
3422 @findex gnus-summary-pop-article
3423 Pop an article off the summary history and go to this article
3424 (@code{gnus-summary-pop-article}).  This command differs from the
3425 command above in that you can pop as many previous articles off the
3426 history as you like.
3427 @end table
3428
3429
3430 @node Choosing Variables
3431 @subsection Choosing Variables
3432
3433 Some variables that are relevant for moving and selecting articles:
3434
3435 @table @code
3436 @item gnus-auto-extend-newsgroup
3437 @vindex gnus-auto-extend-newsgroup
3438 All the movement commands will try to go to the previous (or next)
3439 article, even if that article isn't displayed in the Summary buffer if
3440 this variable is non-@code{nil}.  Gnus will then fetch the article from
3441 the server and display it in the article buffer.
3442
3443 @item gnus-select-article-hook
3444 @vindex gnus-select-article-hook
3445 This hook is called whenever an article is selected.  By default it
3446 exposes any threads hidden under the selected article.
3447
3448 @item gnus-mark-article-hook
3449 @vindex gnus-mark-article-hook
3450 @findex gnus-summary-mark-unread-as-read
3451 @findex gnus-summary-mark-read-and-unread-as-read
3452 @findex gnus-unread-mark
3453 This hook is called whenever an article is selected.  It is intended to
3454 be used for marking articles as read.  The default value is
3455 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3456 mark of almost any article you read to @code{gnus-unread-mark}.  The
3457 only articles not affected by this function are ticked, dormant, and
3458 expirable articles.  If you'd instead like to just have unread articles
3459 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3460 instead.  It will leave marks like @code{gnus-low-score-mark},
3461 @code{gnus-del-mark} (and so on) alone.
3462
3463 @end table
3464
3465
3466 @node Paging the Article
3467 @section Scrolling the Article
3468 @cindex article scrolling
3469
3470 @table @kbd
3471
3472 @item SPACE
3473 @kindex SPACE (Summary)
3474 @findex gnus-summary-next-page
3475 Pressing @kbd{SPACE} will scroll the current article forward one page,
3476 or, if you have come to the end of the current article, will choose the
3477 next article (@code{gnus-summary-next-page}).
3478
3479 @item DEL
3480 @kindex DEL (Summary)
3481 @findex gnus-summary-prev-page
3482 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3483
3484 @item RET
3485 @kindex RET (Summary)
3486 @findex gnus-summary-scroll-up
3487 Scroll the current article one line forward
3488 (@code{gnus-summary-scroll-up}).
3489
3490 @item A g
3491 @itemx g
3492 @kindex A g (Summary)
3493 @kindex g (Summary)
3494 @findex gnus-summary-show-article
3495 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3496 given a prefix, fetch the current article, but don't run any of the
3497 article treatment functions.  This will give you a ``raw'' article, just
3498 the way it came from the server.
3499
3500 @item A <
3501 @itemx <
3502 @kindex < (Summary)
3503 @kindex A < (Summary)
3504 @findex gnus-summary-beginning-of-article
3505 Scroll to the beginning of the article
3506 (@code{gnus-summary-beginning-of-article}).
3507
3508 @item A >
3509 @itemx >
3510 @kindex > (Summary)
3511 @kindex A > (Summary)
3512 @findex gnus-summary-end-of-article
3513 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3514
3515 @item A s 
3516 @itemx s
3517 @kindex A s (Summary)
3518 @kindex s (Summary)
3519 @findex gnus-summary-isearch-article
3520 Perform an isearch in the article buffer
3521 (@code{gnus-summary-isearch-article}). 
3522
3523 @end table
3524
3525
3526 @node Reply Followup and Post
3527 @section Reply, Followup and Post
3528
3529 @menu
3530 * Summary Mail Commands::            Sending mail.
3531 * Summary Post Commands::            Sending news.
3532 @end menu
3533
3534
3535 @node Summary Mail Commands
3536 @subsection Summary Mail Commands
3537 @cindex mail
3538 @cindex composing mail
3539
3540 Commands for composing a mail message:
3541
3542 @table @kbd
3543
3544 @item S r
3545 @itemx r
3546 @kindex S r (Summary)
3547 @kindex r (Summary)
3548 @findex gnus-summary-reply
3549 Mail a reply to the author of the current article
3550 (@code{gnus-summary-reply}). 
3551
3552 @item S R
3553 @itemx R
3554 @kindex R (Summary)
3555 @kindex S R (Summary)
3556 @findex gnus-summary-reply-with-original
3557 Mail a reply to the author of the current article and include the
3558 original message (@code{gnus-summary-reply-with-original}).  This
3559 command uses the process/prefix convention.
3560
3561 @item S w
3562 @kindex S w (Summary)
3563 @findex gnus-summary-wide-reply
3564 Mail a wide reply to the author of the current article
3565 (@code{gnus-summary-wide-reply}). 
3566
3567 @item S W
3568 @kindex S W (Summary)
3569 @findex gnus-summary-wide-reply-with-original
3570 Mail a wide reply to the current article and include the original
3571 message (@code{gnus-summary-reply-with-original}).  This command uses
3572 the process/prefix convention.
3573
3574 @item S o m
3575 @kindex S o m (Summary)
3576 @findex gnus-summary-mail-forward
3577 Forward the current article to some other person
3578 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3579 headers of the forwarded article.
3580
3581 @item S m
3582 @itemx m
3583 @kindex m (Summary)
3584 @kindex S m (Summary)
3585 @findex gnus-summary-mail-other-window
3586 Send a mail to some other person
3587 (@code{gnus-summary-mail-other-window}).
3588
3589 @item S D b
3590 @kindex S D b (Summary)
3591 @findex gnus-summary-resend-bounced-mail
3592 @cindex bouncing mail
3593 If you have sent a mail, but the mail was bounced back to you for some
3594 reason (wrong address, transient failure), you can use this command to
3595 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3596 will be popped into a mail buffer where you can edit the headers before
3597 sending the mail off again.  If you give a prefix to this command, and
3598 the bounced mail is a reply to some other mail, Gnus will try to fetch
3599 that mail and display it for easy perusal of its headers.  This might
3600 very well fail, though.
3601
3602 @item S D r
3603 @kindex S D r (Summary)
3604 @findex gnus-summary-resend-message
3605 Not to be confused with the previous command,
3606 @code{gnus-summary-resend-message} will prompt you for an address to
3607 send the current message off to, and then send it to that place.  The
3608 headers of the message won't be altered---but lots of headers that say
3609 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3610 means that you actually send a mail to someone that has a @code{To}
3611 header that (probably) points to yourself.  This will confuse people.
3612 So, natcherly you'll only do that if you're really eVIl.  
3613
3614 This command is mainly used if you have several accounts and want to
3615 ship a mail to a different account of yours.  (If you're both
3616 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3617 to the @code{root} account, you may want to resend it to
3618 @code{postmaster}.  Ordnung muß sein!
3619
3620 This command understands the process/prefix convention
3621 (@pxref{Process/Prefix}). 
3622
3623 @item S O m
3624 @kindex S O m (Summary)
3625 @findex gnus-uu-digest-mail-forward
3626 Digest the current series and forward the result using mail
3627 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3628 process/prefix convention (@pxref{Process/Prefix}). 
3629
3630 @item S M-c
3631 @kindex S M-c (Summary)
3632 @findex gnus-summary-mail-crosspost-complaint
3633 @cindex crossposting
3634 @cindex excessive crossposting
3635 Send a complaint about excessive crossposting to the author of the
3636 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3637
3638 @findex gnus-crosspost-complaint
3639 This command is provided as a way to fight back agains the current
3640 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3641 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3642 command understands the process/prefix convention
3643 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3644
3645 @end table
3646
3647
3648 @node Summary Post Commands
3649 @subsection Summary Post Commands
3650 @cindex post
3651 @cindex composing news
3652
3653 Commands for posting a news article:
3654
3655 @table @kbd
3656 @item S p
3657 @itemx a
3658 @kindex a (Summary)
3659 @kindex S p (Summary)
3660 @findex gnus-summary-post-news
3661 Post an article to the current group
3662 (@code{gnus-summary-post-news}).
3663
3664 @item S f
3665 @itemx f
3666 @kindex f (Summary)
3667 @kindex S f (Summary)
3668 @findex gnus-summary-followup
3669 Post a followup to the current article (@code{gnus-summary-followup}).
3670
3671 @item S F
3672 @itemx F
3673 @kindex S F (Summary)
3674 @kindex F (Summary)
3675 @findex gnus-summary-followup-with-original
3676 Post a followup to the current article and include the original message
3677 (@code{gnus-summary-followup-with-original}).   This command uses the
3678 process/prefix convention.
3679
3680 @item S n
3681 @kindex S n (Summary)
3682 @findex gnus-summary-followup-to-mail
3683 Post a followup to the current article via news, even if you got the
3684 message through mail (@code{gnus-summary-followup-to-mail}).
3685
3686 @item S n
3687 @kindex S n (Summary)
3688 @findex gnus-summary-followup-to-mail
3689 Post a followup to the current article via news, even if you got the
3690 message through mail and include the original message
3691 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3692 the process/prefix convention.
3693
3694 @item S o p
3695 @kindex S o p (Summary)
3696 @findex gnus-summary-post-forward
3697 Forward the current article to a newsgroup
3698 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3699 headers of the forwarded article.
3700
3701 @item S O p
3702 @kindex S O p (Summary)
3703 @findex gnus-uu-digest-post-forward
3704 Digest the current series and forward the result to a newsgroup
3705 (@code{gnus-uu-digest-mail-forward}).  
3706
3707 @item S u
3708 @kindex S u (Summary)
3709 @findex gnus-uu-post-news
3710 Uuencode a file, split it into parts, and post it as a series
3711 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3712 @end table
3713
3714
3715 @node Canceling and Superseding
3716 @section Canceling Articles
3717 @cindex canceling articles
3718 @cindex superseding articles
3719
3720 Have you ever written something, and then decided that you really,
3721 really, really wish you hadn't posted that?
3722
3723 Well, you can't cancel mail, but you can cancel posts.
3724
3725 @findex gnus-summary-cancel-article
3726 @kindex C (Summary)
3727 Find the article you wish to cancel (you can only cancel your own
3728 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3729 c} (@code{gnus-summary-cancel-article}).  Your article will be
3730 canceled---machines all over the world will be deleting your article. 
3731
3732 Be aware, however, that not all sites honor cancels, so your article may
3733 live on here and there, while most sites will delete the article in
3734 question.
3735
3736 If you discover that you have made some mistakes and want to do some
3737 corrections, you can post a @dfn{superseding} article that will replace
3738 your original article.
3739
3740 @findex gnus-summary-supersede-article
3741 @kindex S (Summary)
3742 Go to the original article and press @kbd{S s}
3743 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3744 where you can edit the article all you want before sending it off the
3745 usual way.
3746
3747 The same goes for superseding as for canceling, only more so: Some
3748 sites do not honor superseding.  On those sites, it will appear that you
3749 have posted almost the same article twice.
3750
3751 If you have just posted the article, and change your mind right away,
3752 there is a trick you can use to cancel/supersede the article without
3753 waiting for the article to appear on your site first.  You simply return
3754 to the post buffer (which is called @code{*sent ...*}).  There you will
3755 find the article you just posted, with all the headers intact.  Change
3756 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3757 header by substituting one of those words for the word
3758 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3759 you would do normally.  The previous article will be
3760 canceled/superseded.
3761
3762 Just remember, kids: There is no 'c' in 'supersede'.
3763
3764
3765 @node Marking Articles
3766 @section Marking Articles
3767 @cindex article marking
3768 @cindex article ticking
3769 @cindex marks
3770
3771 There are several marks you can set on an article. 
3772
3773 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3774 neologism ohoy!) of the article.  Alphabetic marks generally mean
3775 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3776
3777 In addition, you also have marks that do not affect readedness.
3778
3779 @menu
3780 * Unread Articles::      Marks for unread articles.
3781 * Read Articles::        Marks for read articles.
3782 * Other Marks::          Marks that do not affect readedness.
3783 @end menu
3784
3785 @ifinfo
3786 There's a plethora of commands for manipulating these marks:
3787 @end ifinfo
3788
3789 @menu
3790 * Setting Marks::           How to set and remove marks.
3791 * Setting Process Marks::   How to mark articles for later processing.
3792 @end menu
3793
3794
3795 @node Unread Articles
3796 @subsection Unread Articles
3797
3798 The following marks mark articles as (kinda) unread, in one form or
3799 other.
3800
3801 @table @samp
3802 @item !
3803 @vindex gnus-ticked-mark
3804 Marked as ticked (@code{gnus-ticked-mark}).
3805
3806 @dfn{Ticked articles} are articles that will remain visible always.  If
3807 you see an article that you find interesting, or you want to put off
3808 reading it, or replying to it, until sometime later, you'd typically
3809 tick it.  However, articles can be expired, so if you want to keep an
3810 article forever, you'll have to make it persistent (@pxref{Persistent
3811 Articles}).  
3812
3813 @item ?
3814 @vindex gnus-dormant-mark
3815 Marked as dormant (@code{gnus-dormant-mark}).  
3816
3817 @dfn{Dormant articles} will only appear in the summary buffer if there
3818 are followups to it.
3819
3820 @item SPACE
3821 @vindex gnus-unread-mark
3822 Markes as unread (@code{gnus-unread-mark}).
3823
3824 @dfn{Unread articles} are articles that haven't been read at all yet.
3825 @end table
3826
3827
3828 @node Read Articles
3829 @subsection Read Articles
3830 @cindex expirable mark
3831
3832 All the following marks mark articles as read.
3833
3834 @table @samp
3835
3836 @item r
3837 @vindex gnus-del-mark
3838 These are articles that the user has marked as read with the @kbd{d}
3839 command manually, more or less (@code{gnus-del-mark}).
3840
3841 @item R
3842 @vindex gnus-read-mark
3843 Articles that have actually been read (@code{gnus-read-mark}).
3844
3845 @item O
3846 @vindex gnus-ancient-mark
3847 Articles that were marked as read in previous sessions and are now
3848 @dfn{old} (@code{gnus-ancient-mark}).
3849
3850 @item K
3851 @vindex gnus-killed-mark
3852 Marked as killed (@code{gnus-killed-mark}).
3853
3854 @item X
3855 @vindex gnus-kill-file-mark
3856 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3857
3858 @item Y
3859 @vindex gnus-low-score-mark
3860 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3861
3862 @item C
3863 @vindex gnus-catchup-mark
3864 Marked as read by a catchup (@code{gnus-catchup-mark}).
3865
3866 @item G
3867 @vindex gnus-canceled-mark
3868 Canceled article (@code{gnus-canceled-mark})
3869
3870 @item F
3871 @vindex gnus-souped-mark
3872 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3873
3874 @item Q
3875 @vindex gnus-sparse-mark
3876 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3877 Threading}.
3878
3879 @item M
3880 @vindex gnus-duplicate-mark
3881 Article marked as read by duplicate suppression
3882 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3883
3884 @end table
3885
3886 All these marks just mean that the article is marked as read, really.
3887 They are interpreted differently when doing adaptive scoring, though.
3888
3889 One more special mark, though:
3890
3891 @table @samp
3892 @item E
3893 @vindex gnus-expirable-mark
3894 Marked as expirable (@code{gnus-expirable-mark}).
3895
3896 Marking articles as @dfn{expirable} (or have them marked as such
3897 automatically) doesn't make much sense in normal groups---a user doesn't
3898 control the expiring of news articles, but in mail groups, for instance,
3899 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3900 any time.
3901 @end table
3902
3903
3904 @node Other Marks
3905 @subsection Other Marks
3906 @cindex process mark
3907 @cindex bookmarks
3908
3909 There are some marks that have nothing to do with whether the article is
3910 read or not.
3911
3912 @itemize @bullet
3913
3914 @item 
3915 You can set a bookmark in the current article.  Say you are reading a
3916 long thesis on cats' urinary tracts, and have to go home for dinner
3917 before you've finished reading the thesis.  You can then set a bookmark
3918 in the article, and Gnus will jump to this bookmark the next time it
3919 encounters the article.  @xref{Setting Marks}
3920
3921 @item
3922 @vindex gnus-replied-mark
3923 All articles that you have replied to or made a followup to (i.e., have
3924 answered) will be marked with an @samp{A} in the second column
3925 (@code{gnus-replied-mark}).
3926
3927 @item 
3928 @vindex gnus-cached-mark
3929 Articles that are stored in the article cache will be marked with an
3930 @samp{*} in the second column (@code{gnus-cached-mark}).
3931
3932 @item 
3933 @vindex gnus-saved-mark
3934 Articles that are ``saved'' (in some manner or other; not necessarily
3935 religiously) are marked with an @samp{S} in the second column
3936 (@code{gnus-saved-mark}.
3937
3938 @item 
3939 @vindex gnus-not-empty-thread-mark
3940 @vindex gnus-empty-thread-mark
3941 It the @samp{%e} spec is used, the presence of threads or not will be
3942 marked with @code{gnus-not-empty-thread-mark} and
3943 @code{gnus-empty-thread-mark} in the third column, respectively.
3944
3945 @item 
3946 @vindex gnus-process-mark
3947 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3948 variety of commands react to the presence of the process mark.  For
3949 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3950 all articles that have been marked with the process mark.  Articles
3951 marked with the process mark have a @samp{#} in the second column.
3952
3953 @end itemize
3954
3955 You might have noticed that most of these ``non-readedness'' marks
3956 appear in the second column by default.  So if you have a cached, saved,
3957 replied article that you have process-marked, what will that look like?
3958
3959 Nothing much.  The precedence rules go as follows: process -> cache ->
3960 replied -> saved.  So if the article is in the cache and is replied,
3961 you'll only see the cache mark and not the replied mark.
3962
3963
3964 @node Setting Marks
3965 @subsection Setting Marks
3966 @cindex setting marks
3967
3968 All the marking commands understand the numeric prefix.
3969
3970 @table @kbd
3971 @item M t
3972 @itemx !
3973 @kindex ! (Summary)
3974 @kindex M t (Summary)
3975 @findex gnus-summary-tick-article-forward
3976 Tick the current article (@code{gnus-summary-tick-article-forward}).
3977
3978 @item M ?
3979 @itemx ?
3980 @kindex ? (Summary)
3981 @kindex M ? (Summary)
3982 @findex gnus-summary-mark-as-dormant
3983 Mark the current article as dormant
3984 (@code{gnus-summary-mark-as-dormant}).
3985
3986 @item M d
3987 @itemx d
3988 @kindex M d (Summary)
3989 @kindex d (Summary)
3990 @findex gnus-summary-mark-as-read-forward
3991 Mark the current article as read
3992 (@code{gnus-summary-mark-as-read-forward}).
3993
3994 @item D
3995 @kindex D (Summary)
3996 @findex gnus-summary-mark-as-read-backward
3997 Mark the current article as read and move point to the previous line
3998 (@code{gnus-summary-mark-as-read-backward}).
3999
4000 @item M k
4001 @itemx k
4002 @kindex k (Summary)
4003 @kindex M k (Summary)
4004 @findex gnus-summary-kill-same-subject-and-select
4005 Mark all articles that have the same subject as the current one as read,
4006 and then select the next unread article
4007 (@code{gnus-summary-kill-same-subject-and-select}).
4008
4009 @item M K
4010 @itemx C-k
4011 @kindex M K (Summary)
4012 @kindex C-k (Summary)
4013 @findex gnus-summary-kill-same-subject
4014 Mark all articles that have the same subject as the current one as read
4015 (@code{gnus-summary-kill-same-subject}).  
4016
4017 @item M C
4018 @kindex M C (Summary)
4019 @findex gnus-summary-catchup
4020 Mark all unread articles as read (@code{gnus-summary-catchup}).
4021
4022 @item M C-c
4023 @kindex M C-c (Summary)
4024 @findex gnus-summary-catchup-all
4025 Mark all articles in the group as read---even the ticked and dormant
4026 articles (@code{gnus-summary-catchup-all}).
4027
4028 @item M H
4029 @kindex M H (Summary)
4030 @findex gnus-summary-catchup-to-here
4031 Catchup the current group to point
4032 (@code{gnus-summary-catchup-to-here}). 
4033
4034 @item C-w
4035 @kindex C-w (Summary)
4036 @findex gnus-summary-mark-region-as-read
4037 Mark all articles between point and mark as read
4038 (@code{gnus-summary-mark-region-as-read}). 
4039
4040 @item M V k
4041 @kindex M V k (Summary)
4042 @findex gnus-summary-kill-below
4043 Kill all articles with scores below the default score (or below the
4044 numeric prefix) (@code{gnus-summary-kill-below}).
4045
4046 @item M c
4047 @itemx M-u
4048 @kindex M c (Summary)
4049 @kindex M-u (Summary)
4050 @findex gnus-summary-clear-mark-forward
4051 Clear all readedness-marks from the current article
4052 (@code{gnus-summary-clear-mark-forward}).
4053
4054 @item M e
4055 @itemx E
4056 @kindex M e (Summary)
4057 @kindex E (Summary)
4058 @findex gnus-summary-mark-as-expirable
4059 Mark the current article as expirable
4060 (@code{gnus-summary-mark-as-expirable}).
4061
4062 @item M b
4063 @kindex M b (Summary)
4064 @findex gnus-summary-set-bookmark
4065 Set a bookmark in the current article
4066 (@code{gnus-summary-set-bookmark}).
4067
4068 @item M B
4069 @kindex M B (Summary)
4070 @findex gnus-summary-remove-bookmark
4071 Remove the bookmark from the current article
4072 (@code{gnus-summary-remove-bookmark}).
4073
4074 @item M V c
4075 @kindex M V c (Summary)
4076 @findex gnus-summary-clear-above
4077 Clear all marks from articles with scores over the default score (or
4078 over the numeric prefix) (@code{gnus-summary-clear-above}).
4079
4080 @item M V u
4081 @kindex M V u (Summary)
4082 @findex gnus-summary-tick-above
4083 Tick all articles with scores over the default score (or over the
4084 numeric prefix) (@code{gnus-summary-tick-above}).
4085
4086 @item M V m
4087 @kindex M V m (Summary)
4088 @findex gnus-summary-mark-above
4089 Prompt for a mark, and mark all articles with scores over the default
4090 score (or over the numeric prefix) with this mark
4091 (@code{gnus-summary-clear-above}).
4092 @end table
4093
4094 @vindex gnus-summary-goto-unread
4095 The @code{gnus-summary-goto-unread} variable controls what action should
4096 be taken after setting a mark.  If non-@code{nil}, point will move to
4097 the next/previous unread article.  If @code{nil}, point will just move
4098 one line up or down.  As a special case, if this variable is
4099 @code{never}, all the marking commands as well as other commands (like
4100 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4101 The default is @code{t}.
4102
4103
4104 @node Setting Process Marks
4105 @subsection Setting Process Marks
4106 @cindex setting process marks
4107
4108 @table @kbd
4109
4110 @item M P p
4111 @itemx #
4112 @kindex # (Summary)
4113 @kindex M P p (Summary)
4114 @findex gnus-summary-mark-as-processable
4115 Mark the current article with the process mark
4116 (@code{gnus-summary-mark-as-processable}). 
4117 @findex gnus-summary-unmark-as-processable
4118
4119 @item M P u 
4120 @itemx M-#
4121 @kindex M P u (Summary)
4122 @kindex M-# (Summary)
4123 Remove the process mark, if any, from the current article
4124 (@code{gnus-summary-unmark-as-processable}).
4125
4126 @item M P U
4127 @kindex M P U (Summary)
4128 @findex gnus-summary-unmark-all-processable
4129 Remove the process mark from all articles
4130 (@code{gnus-summary-unmark-all-processable}). 
4131
4132 @item M P i
4133 @kindex M P i (Summary)
4134 @findex gnus-uu-invert-processable
4135 Invert the list of process marked articles
4136 (@code{gnus-uu-invert-processable}). 
4137
4138 @item M P R
4139 @kindex M P R (Summary)
4140 @findex gnus-uu-mark-by-regexp
4141 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4142
4143 @item M P r
4144 @kindex M P r (Summary)
4145 @findex gnus-uu-mark-region
4146 Mark articles in region (@code{gnus-uu-mark-region}).
4147
4148 @item M P t
4149 @kindex M P t (Summary)
4150 @findex gnus-uu-mark-thread
4151 Mark all articles in the current (sub)thread
4152 (@code{gnus-uu-mark-thread}).
4153
4154 @item M P T
4155 @kindex M P T (Summary)
4156 @findex gnus-uu-unmark-thread
4157 Unmark all articles in the current (sub)thread
4158 (@code{gnus-uu-unmark-thread}).
4159
4160 @item M P v
4161 @kindex M P v (Summary)
4162 @findex gnus-uu-mark-over
4163 Mark all articles that have a score above the prefix argument
4164 (@code{gnus-uu-mark-over}).
4165
4166 @item M P s
4167 @kindex M P s (Summary)
4168 @findex gnus-uu-mark-series
4169 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4170
4171 @item M P S
4172 @kindex M P S (Summary)
4173 @findex gnus-uu-mark-sparse
4174 Mark all series that have already had some articles marked
4175 (@code{gnus-uu-mark-sparse}).
4176
4177 @item M P a
4178 @kindex M P a (Summary)
4179 @findex gnus-uu-mark-all
4180 Mark all articles in series order (@code{gnus-uu-mark-series}).
4181
4182 @item M P b
4183 @kindex M P b (Summary)
4184 @findex gnus-uu-mark-buffer
4185 Mark all articles in the buffer in the order they appear
4186 (@code{gnus-uu-mark-buffer}). 
4187
4188 @item M P k
4189 @kindex M P k (Summary)
4190 @findex gnus-summary-kill-process-mark
4191 Push the current process mark set onto the stack and unmark all articles
4192 (@code{gnus-summary-kill-process-mark}).
4193
4194 @item M P y
4195 @kindex M P y (Summary)
4196 @findex gnus-summary-yank-process-mark
4197 Pop the previous process mark set from the stack and restore it
4198 (@code{gnus-summary-yank-process-mark}).
4199
4200 @item M P w
4201 @kindex M P w (Summary)
4202 @findex gnus-summary-save-process-mark
4203 Push the current process mark set onto the stack
4204 (@code{gnus-summary-save-process-mark}).
4205
4206 @end table
4207
4208
4209 @node Limiting
4210 @section Limiting
4211 @cindex limiting
4212
4213 It can be convenient to limit the summary buffer to just show some
4214 subset of the articles currently in the group.  The effect most limit
4215 commands have is to remove a few (or many) articles from the summary
4216 buffer. 
4217
4218 @table @kbd
4219
4220 @item / /
4221 @itemx / s
4222 @kindex / / (Summary)
4223 @findex gnus-summary-limit-to-subject
4224 Limit the summary buffer to articles that match some subject
4225 (@code{gnus-summary-limit-to-subject}). 
4226
4227 @item / a
4228 @kindex / a (Summary)
4229 @findex gnus-summary-limit-to-author
4230 Limit the summary buffer to articles that match some author
4231 (@code{gnus-summary-limit-to-author}).
4232
4233 @item / u
4234 @itemx x
4235 @kindex / u (Summary)
4236 @kindex x (Summary)
4237 @findex gnus-summary-limit-to-unread
4238 Limit the summary buffer to articles that are not marked as read
4239 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4240 buffer to articles that are strictly unread.  This means that ticked and
4241 dormant articles will also be excluded.
4242
4243 @item / m
4244 @kindex / m (Summary)
4245 @findex gnus-summary-limit-to-marks
4246 Ask for a mark and then limit to all articles that have not been marked
4247 with that mark (@code{gnus-summary-limit-to-marks}).
4248
4249 @item / t
4250 @kindex / t (Summary)
4251 @findex gnus-summary-limit-to-age
4252 Ask for a number and then limit the summary buffer to articles that are
4253 older than (or equal to) that number of days
4254 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4255 articles that are younger than that number of days.
4256
4257 @item / n
4258 @kindex / n (Summary)
4259 @findex gnus-summary-limit-to-articles
4260 Limit the summary buffer to the current article
4261 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4262 convention (@pxref{Process/Prefix}).
4263
4264 @item / w
4265 @kindex / w (Summary)
4266 @findex gnus-summary-pop-limit
4267 Pop the previous limit off the stack and restore it
4268 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4269 the stack.
4270
4271 @item / v
4272 @kindex / v (Summary)
4273 @findex gnus-summary-limit-to-score
4274 Limit the summary buffer to articles that have a score at or above some
4275 score (@code{gnus-summary-limit-to-score}).
4276
4277 @item / E
4278 @itemx M S
4279 @kindex M S (Summary)
4280 @kindex / E (Summary)
4281 @findex gnus-summary-limit-include-expunged
4282 Display all expunged articles
4283 (@code{gnus-summary-limit-include-expunged}). 
4284
4285 @item / D
4286 @kindex / D (Summary)
4287 @findex gnus-summary-limit-include-dormant
4288 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4289
4290 @item / d
4291 @kindex / d (Summary)
4292 @findex gnus-summary-limit-exclude-dormant
4293 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4294
4295 @item / c
4296 @kindex / c (Summary)
4297 @findex gnus-summary-limit-exclude-childless-dormant
4298 Hide all dormant articles that have no children
4299 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4300
4301 @item / C
4302 @kindex / C (Summary)
4303 @findex gnus-summary-limit-mark-excluded-as-read
4304 Mark all excluded unread articles as read
4305 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4306 also mark excluded ticked and dormant articles as read.
4307
4308 @end table
4309
4310
4311 @node Threading
4312 @section Threading
4313 @cindex threading
4314 @cindex article threading
4315
4316 Gnus threads articles by default.  @dfn{To thread} is to put replies to
4317 articles directly after the articles they reply to---in a hierarchical
4318 fashion.
4319
4320 @menu
4321 * Customizing Threading::     Variables you can change to affect the threading.
4322 * Thread Commands::           Thread based commands in the summary buffer.
4323 @end menu
4324
4325
4326 @node Customizing Threading
4327 @subsection Customizing Threading
4328 @cindex customizing threading
4329 @cindex <
4330 @cindex >
4331
4332 @table @code
4333
4334 @item gnus-show-threads
4335 @vindex gnus-show-threads
4336 If this variable is @code{nil}, no threading will be done, and all of
4337 the rest of the variables here will have no effect.  Turning threading
4338 off will speed group selection up a bit, but it is sure to make reading
4339 slower and more awkward.
4340
4341 @item gnus-fetch-old-headers
4342 @vindex gnus-fetch-old-headers
4343 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4344 more old headers---headers to articles that are marked as read.  If you
4345 would like to display as few summary lines as possible, but still
4346 connect as many loose threads as possible, you should set this variable
4347 to @code{some} or a number.  If you set it to a number, no more than
4348 that number of extra old headers will be fetched.  In either case,
4349 fetching old headers only works if the backend you are using carries
4350 overview files---this would normally be @code{nntp}, @code{nnspool} and
4351 @code{nnml}.  Also remember that if the root of the thread has been
4352 expired by the server, there's not much Gnus can do about that.
4353
4354 @item gnus-build-sparse-threads
4355 @vindex gnus-build-sparse-threads
4356 Fetching old headers can be slow.  A low-rent similar effect can be
4357 gotten by setting this variable to @code{some}.  Gnus will then look at
4358 the complete @code{References} headers of all articles and try to string
4359 articles that belong in the same thread together.  This will leave
4360 @dfn{gaps} in the threading display where Gnus guesses that an article
4361 is missing from the thread.  (These gaps appear like normal summary
4362 lines.  If you select a gap, Gnus will try to fetch the article in
4363 question.)  If this variable is @code{t}, Gnus will display all these
4364 ``gaps'' without regard for whether they are useful for completing the
4365 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4366 off sparse leaf nodes that don't lead anywhere.  This variable is
4367 @code{nil} by default.
4368
4369 @item gnus-summary-gather-subject-limit
4370 @vindex gnus-summary-gather-subject-limit
4371 Loose threads are gathered by comparing subjects of articles.  If this
4372 variable is @code{nil}, Gnus requires an exact match between the
4373 subjects of the loose threads before gathering them into one big
4374 super-thread.  This might be too strict a requirement, what with the
4375 presence of stupid newsreaders that chop off long subjects lines.  If
4376 you think so, set this variable to, say, 20 to require that only the
4377 first 20 characters of the subjects have to match.  If you set this
4378 variable to a really low number, you'll find that Gnus will gather
4379 everything in sight into one thread, which isn't very helpful.
4380
4381 @cindex fuzzy article gathering
4382 If you set this variable to the special value @code{fuzzy}, Gnus will
4383 use a fuzzy string comparison algorithm on the subjects.
4384
4385 @item gnus-simplify-subject-fuzzy-regexp
4386 @vindex gnus-simplify-subject-fuzzy-regexp
4387 This can either be a regular expression or list of regular expressions
4388 that match strings that will be removed from subjects if fuzzy subject
4389 simplification is used.
4390
4391 @item gnus-simplify-ignored-prefixes
4392 @vindex gnus-simplify-ignored-prefixes
4393 If you set @code{gnus-summary-gather-subject-limit} to something as low
4394 as 10, you might consider setting this variable to something sensible:
4395
4396 @c Written by Michael Ernst <mernst@cs.rice.edu>
4397 @lisp
4398 (setq gnus-simplify-ignored-prefixes
4399       (concat 
4400        "\\`\\[?\\("
4401        (mapconcat 
4402         'identity
4403         '("looking"
4404           "wanted" "followup" "summary\\( of\\)?"
4405           "help" "query" "problem" "question" 
4406           "answer" "reference" "announce"
4407           "How can I" "How to" "Comparison of"
4408           ;; ...
4409           )
4410         "\\|")
4411        "\\)\\s *\\("
4412        (mapconcat 'identity
4413                   '("for" "for reference" "with" "about")
4414                   "\\|")
4415        "\\)?\\]?:?[ \t]*"))
4416 @end lisp
4417
4418 All words that match this regexp will be removed before comparing two
4419 subjects. 
4420
4421 @item gnus-summary-gather-exclude-subject
4422 @vindex gnus-summary-gather-exclude-subject
4423 Since loose thread gathering is done on subjects only, that might lead
4424 to many false hits, especially with certain common subjects like
4425 @samp{} and @samp{(none)}.  To make the situation slightly better,
4426 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4427 what subjects should be excluded from the gathering process.  The
4428 default is @samp{^ *$\\|^(none)$}.  
4429
4430 @item gnus-summary-thread-gathering-function
4431 @vindex gnus-summary-thread-gathering-function
4432 Gnus gathers threads by looking at @code{Subject} headers.  This means
4433 that totally unrelated articles may end up in the same ``thread'', which
4434 is confusing.  An alternate approach is to look at all the
4435 @code{Message-ID}s in all the @code{References} headers to find matches.
4436 This will ensure that no gathered threads ever includes unrelated
4437 articles, but it's also means that people who have posted with broken
4438 newsreaders won't be gathered properly.  The choice is yours---plague or
4439 cholera:
4440
4441 @table @code
4442 @item gnus-gather-threads-by-subject
4443 @findex gnus-gather-threads-by-subject
4444 This function is the default gathering function and looks at
4445 @code{Subject}s exclusively.
4446
4447 @item gnus-gather-threads-by-references
4448 @findex gnus-gather-threads-by-references
4449 This function looks at @code{References} headers exclusively.
4450 @end table
4451
4452 If you want to test gathering by @code{References}, you could say
4453 something like:
4454
4455 @lisp
4456 (setq gnus-summary-thread-gathering-function
4457       'gnus-gather-threads-by-references)
4458 @end lisp
4459
4460 @item gnus-summary-make-false-root
4461 @vindex gnus-summary-make-false-root
4462 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4463 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4464 Yup.)  Loose subtrees occur when the real root has expired, or you've
4465 read or killed the root in a previous session.
4466
4467 When there is no real root of a thread, Gnus will have to fudge
4468 something.  This variable says what fudging method Gnus should use.
4469 There are four possible values:
4470
4471 @cindex adopting articles
4472
4473 @table @code
4474
4475 @item adopt
4476 Gnus will make the first of the orphaned articles the parent.  This
4477 parent will adopt all the other articles.  The adopted articles will be
4478 marked as such by pointy brackets (@samp{<>}) instead of the standard
4479 square brackets (@samp{[]}).  This is the default method.
4480
4481 @item dummy
4482 @vindex gnus-summary-dummy-line-format
4483 Gnus will create a dummy summary line that will pretend to be the
4484 parent.  This dummy line does not correspond to any real article, so
4485 selecting it will just select the first real article after the dummy
4486 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4487 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4488 which is the subject of the article.  @xref{Formatting Variables}.
4489
4490 @item empty
4491 Gnus won't actually make any article the parent, but simply leave the
4492 subject field of all orphans except the first empty.  (Actually, it will
4493 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4494 Buffer Format}).)
4495
4496 @item none
4497 Don't make any article parent at all.  Just gather the threads and
4498 display them after one another.
4499
4500 @item nil
4501 Don't gather loose threads.
4502 @end table
4503
4504 @item gnus-thread-hide-subtree
4505 @vindex gnus-thread-hide-subtree
4506 If non-@code{nil}, all threads will be hidden when the summary buffer is
4507 generated.
4508
4509 @item gnus-thread-expunge-below
4510 @vindex gnus-thread-expunge-below
4511 All threads that have a total score (as defined by
4512 @code{gnus-thread-score-function}) less than this number will be
4513 expunged.  This variable is @code{nil} by default, which means that no
4514 threads are expunged.
4515
4516 @item gnus-thread-hide-killed
4517 @vindex gnus-thread-hide-killed
4518 if you kill a thread and this variable is non-@code{nil}, the subtree
4519 will be hidden.
4520
4521 @item gnus-thread-ignore-subject
4522 @vindex gnus-thread-ignore-subject
4523 Sometimes somebody changes the subject in the middle of a thread.  If
4524 this variable is non-@code{nil}, the subject change is ignored.  If it
4525 is @code{nil}, which is the default, a change in the subject will result
4526 in a new thread.
4527
4528 @item gnus-thread-indent-level
4529 @vindex gnus-thread-indent-level
4530 This is a number that says how much each sub-thread should be indented.
4531 The default is 4.
4532
4533 @item gnus-parse-headers-hook
4534 @vindex gnus-parse-headers-hook
4535 Hook run before parsing any headers.  The default value is
4536 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4537 slightly decoded in a hackish way.  This is likely to change in the
4538 future when Gnus becomes @sc{MIME}ified.
4539
4540 @end table
4541
4542
4543 @node Thread Commands
4544 @subsection Thread Commands
4545 @cindex thread commands
4546
4547 @table @kbd
4548
4549 @item T k
4550 @itemx M-C-k
4551 @kindex T k (Summary)
4552 @kindex M-C-k (Summary)
4553 @findex gnus-summary-kill-thread
4554 Mark all articles in the current (sub-)thread as read
4555 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4556 remove all marks instead.  If the prefix argument is negative, tick
4557 articles instead.
4558
4559 @item T l
4560 @itemx M-C-l
4561 @kindex T l (Summary)
4562 @kindex M-C-l (Summary)
4563 @findex gnus-summary-lower-thread
4564 Lower the score of the current (sub-)thread
4565 (@code{gnus-summary-lower-thread}). 
4566
4567 @item T i
4568 @kindex T i (Summary)
4569 @findex gnus-summary-raise-thread
4570 Increase the score of the current (sub-)thread
4571 (@code{gnus-summary-raise-thread}).
4572
4573 @item T #
4574 @kindex T # (Summary)
4575 @findex gnus-uu-mark-thread
4576 Set the process mark on the current (sub-)thread
4577 (@code{gnus-uu-mark-thread}).
4578
4579 @item T M-#
4580 @kindex T M-# (Summary)
4581 @findex gnus-uu-unmark-thread
4582 Remove the process mark from the current (sub-)thread
4583 (@code{gnus-uu-unmark-thread}).
4584
4585 @item T T
4586 @kindex T T (Summary)
4587 @findex gnus-summary-toggle-threads
4588 Toggle threading (@code{gnus-summary-toggle-threads}).
4589
4590 @item T s
4591 @kindex T s (Summary)
4592 @findex gnus-summary-show-thread
4593 Expose the (sub-)thread hidden under the current article, if any
4594 (@code{gnus-summary-show-thread}).
4595
4596 @item T h
4597 @kindex T h (Summary)
4598 @findex gnus-summary-hide-thread
4599 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4600
4601 @item T S
4602 @kindex T S (Summary)
4603 @findex gnus-summary-show-all-threads
4604 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4605
4606 @item T H
4607 @kindex T H (Summary)
4608 @findex gnus-summary-hide-all-threads
4609 Hide all threads (@code{gnus-summary-hide-all-threads}).
4610
4611 @item T t
4612 @kindex T t (Summary)
4613 @findex gnus-summary-rethread-current
4614 Re-thread the thread the current article is part of
4615 (@code{gnus-summary-rethread-current}).  This works even when the
4616 summary buffer is otherwise unthreaded.
4617
4618 @item T ^
4619 @kindex T ^ (Summary)
4620 @findex gnus-summary-reparent-thread
4621 Make the current article the child of the marked (or previous) article
4622 (@code{gnus-summary-reparent-thread}.
4623
4624 @end table
4625
4626 The following commands are thread movement commands.  They all
4627 understand the numeric prefix.
4628
4629 @table @kbd
4630
4631 @item T n
4632 @kindex T n (Summary)
4633 @findex gnus-summary-next-thread
4634 Go to the next thread (@code{gnus-summary-next-thread}).
4635
4636 @item T p
4637 @kindex T p (Summary)
4638 @findex gnus-summary-prev-thread
4639 Go to the previous thread (@code{gnus-summary-prev-thread}).
4640
4641 @item T d
4642 @kindex T d (Summary)
4643 @findex gnus-summary-down-thread
4644 Descend the thread (@code{gnus-summary-down-thread}).
4645
4646 @item T u
4647 @kindex T u (Summary)
4648 @findex gnus-summary-up-thread
4649 Ascend the thread (@code{gnus-summary-up-thread}).
4650
4651 @item T o
4652 @kindex T o (Summary)
4653 @findex gnus-summary-top-thread
4654 Go to the top of the thread (@code{gnus-summary-top-thread}).
4655 @end table
4656
4657 @vindex gnus-thread-operation-ignore-subject 
4658 If you ignore subject while threading, you'll naturally end up with
4659 threads that have several different subjects in them.  If you then issue
4660 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4661 wish to kill the entire thread, but just those parts of the thread that
4662 have the same subject as the current article.  If you like this idea,
4663 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4664 is non-@code{nil} (which it is by default), subjects will be ignored
4665 when doing thread commands.  If this variable is @code{nil}, articles in
4666 the same thread with different subjects will not be included in the
4667 operation in question.  If this variable is @code{fuzzy}, only articles
4668 that have subjects that are fuzzily equal will be included.
4669
4670
4671 @node Sorting
4672 @section Sorting
4673
4674 @findex gnus-thread-sort-by-total-score
4675 @findex gnus-thread-sort-by-date
4676 @findex gnus-thread-sort-by-score
4677 @findex gnus-thread-sort-by-subject
4678 @findex gnus-thread-sort-by-author
4679 @findex gnus-thread-sort-by-number
4680 @vindex gnus-thread-sort-functions
4681 If you are using a threaded summary display, you can sort the threads by
4682 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4683 By default, sorting is done on article numbers.  Ready-made sorting
4684 predicate functions include @code{gnus-thread-sort-by-number},
4685 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4686 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4687 @code{gnus-thread-sort-by-total-score}.
4688
4689 Each function takes two threads and return non-@code{nil} if the first
4690 thread should be sorted before the other.  Note that sorting really is
4691 normally done by looking only at the roots of each thread.  If you use
4692 more than one function, the primary sort key should be the last function
4693 in the list.  You should probably always include
4694 @code{gnus-thread-sort-by-number} in the list of sorting
4695 functions---preferably first.  This will ensure that threads that are
4696 equal with respect to the other sort criteria will be displayed in
4697 ascending article order.
4698
4699 If you would like to sort by score, then by subject, and finally by
4700 number, you could do something like:
4701
4702 @lisp
4703 (setq gnus-thread-sort-functions 
4704       '(gnus-thread-sort-by-number
4705         gnus-thread-sort-by-subject
4706         gnus-thread-sort-by-score))
4707 @end lisp
4708
4709 The threads that have highest score will be displayed first in the
4710 summary buffer.  When threads have the same score, they will be sorted
4711 alphabetically.  The threads that have the same score and the same
4712 subject will be sorted by number, which is (normally) the sequence in
4713 which the articles arrived.
4714
4715 If you want to sort by score and then reverse arrival order, you could
4716 say something like:
4717
4718 @lisp
4719 (setq gnus-thread-sort-functions
4720       '((lambda (t1 t2) 
4721           (not (gnus-thread-sort-by-number t1 t2)))
4722         gnus-thread-sort-by-score))
4723 @end lisp
4724
4725 @vindex gnus-thread-score-function
4726 The function in the @code{gnus-thread-score-function} variable (default
4727 @code{+}) is used for calculating the total score of a thread.  Useful
4728 functions might be @code{max}, @code{min}, or squared means, or whatever
4729 tickles your fancy.
4730
4731 @findex gnus-article-sort-functions
4732 @findex gnus-article-sort-by-date
4733 @findex gnus-article-sort-by-score
4734 @findex gnus-article-sort-by-subject
4735 @findex gnus-article-sort-by-author
4736 @findex gnus-article-sort-by-number
4737 If you are using an unthreaded display for some strange reason or other,
4738 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4739 It is very similar to the @code{gnus-thread-sort-functions}, except that
4740 is uses slightly different functions for article comparison.  Available
4741 sorting predicate functions are @code{gnus-article-sort-by-number},
4742 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4743 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4744
4745 If you want to sort an unthreaded summary display by subject, you could
4746 say something like:
4747
4748 @lisp
4749 (setq gnus-article-sort-functions 
4750       '(gnus-article-sort-by-number
4751         gnus-article-sort-by-subject))
4752 @end lisp
4753
4754
4755
4756 @node Asynchronous Fetching
4757 @section Asynchronous Article Fetching
4758 @cindex asynchronous article fetching
4759 @cindex article pre-fetch
4760 @cindex pre-fetch
4761
4762 If you read your news from an @sc{nntp} server that's far away, the
4763 network latencies may make reading articles a chore.  You have to wait
4764 for a while after pressing @kbd{n} to go to the next article before the
4765 article appears.  Why can't Gnus just go ahead and fetch the article
4766 while you are reading the previous one?  Why not, indeed.
4767
4768 First, some caveats.  There are some pitfalls to using asynchronous
4769 article fetching, especially the way Gnus does it.  
4770
4771 Let's say you are reading article 1, which is short, and article 2 is
4772 quite long, and you are not interested in reading that.  Gnus does not
4773 know this, so it goes ahead and fetches article 2.  You decide to read
4774 article 3, but since Gnus is in the process of fetching article 2, the
4775 connection is blocked.
4776
4777 To avoid these situations, Gnus will open two (count 'em two)
4778 connections to the server.  Some people may think this isn't a very nice
4779 thing to do, but I don't see any real alternatives.  Setting up that
4780 extra connection takes some time, so Gnus startup will be slower.
4781
4782 Gnus will fetch more articles than you will read.  This will mean that
4783 the link between your machine and the @sc{nntp} server will become more
4784 loaded than if you didn't use article pre-fetch.  The server itself will
4785 also become more loaded---both with the extra article requests, and the
4786 extra connection.
4787
4788 Ok, so now you know that you shouldn't really use this thing...  unless
4789 you really want to.
4790
4791 @vindex gnus-asynchronous
4792 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4793 happen automatically.
4794
4795 @vindex gnus-use-article-prefetch
4796 You can control how many articles that are to be pre-fetched by setting
4797 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4798 that when you read an article in the group, the backend will pre-fetch
4799 the next 30 articles.  If this variable is @code{t}, the backend will
4800 pre-fetch all the articles that it can without bound.  If it is
4801 @code{nil}, no pre-fetching will be made.
4802
4803 @vindex gnus-async-prefetch-article-p
4804 @findex gnus-async-read-p
4805 There are probably some articles that you don't want to pre-fetch---read
4806 articles, for instance.  Which articles to pre-fetch is controlled by
4807 the @code{gnus-async-prefetch-article-p} variable.  This function should
4808 return non-@code{nil} when the article in question is to be
4809 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4810 @code{nil} on read articles.  The function is called with an article
4811 data structure as the only parameter.
4812
4813 If, for instance, you wish to pre-fetch only unread articles that are
4814 shorter than 100 lines, you could say something like:
4815
4816 @lisp
4817 (defun my-async-short-unread-p (data)
4818   "Return non-nil for short, unread articles."
4819   (and (gnus-data-unread-p data)
4820        (< (mail-header-lines (gnus-data-header data))
4821           100)))
4822
4823 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4824 @end lisp
4825
4826 These functions will be called many, many times, so they should
4827 preferrably be short and sweet to avoid slowing down Gnus too much.
4828 It's also probably a good idea to byte-compile things like this.
4829
4830 @vindex gnus-prefetched-article-deletion-strategy
4831 Articles have to be removed from the asynch buffer sooner or later.  The
4832 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4833 articles.  This is a list that may contain the following elements:
4834
4835 @table @code
4836 @item read
4837 Remove articles when they are read.
4838
4839 @item exit
4840 Remove articles when exiting the group.
4841 @end table
4842
4843 The default value is @code{(read exit)}.
4844
4845 @vindex gnus-use-header-prefetch
4846 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4847 from the next group.
4848
4849
4850 @node Article Caching
4851 @section Article Caching
4852 @cindex article caching
4853 @cindex caching
4854
4855 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4856 consider turning article caching on.  Each article will then be stored
4857 locally under your home directory.  As you may surmise, this could
4858 potentially use @emph{huge} amounts of disk space, as well as eat up all
4859 your inodes so fast it will make your head swim.  In vodka.
4860
4861 Used carefully, though, it could be just an easier way to save articles.
4862
4863 @vindex gnus-use-long-file-name
4864 @vindex gnus-cache-directory
4865 @vindex gnus-use-cache
4866 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4867 all articles that are ticked or marked as dormant will then be copied
4868 over to your local cache (@code{gnus-cache-directory}).  Whether this
4869 cache is flat or hierarchal is controlled by the
4870 @code{gnus-use-long-file-name} variable, as usual.
4871
4872 When re-select a ticked or dormant article, it will be fetched from the
4873 cache instead of from the server.  As articles in your cache will never
4874 expire, this might serve as a method of saving articles while still
4875 keeping them where they belong.  Just mark all articles you want to save
4876 as dormant, and don't worry.
4877
4878 When an article is marked as read, is it removed from the cache.
4879
4880 @vindex gnus-cache-remove-articles
4881 @vindex gnus-cache-enter-articles
4882 The entering/removal of articles from the cache is controlled by the
4883 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4884 variables.  Both are lists of symbols.  The first is @code{(ticked
4885 dormant)} by default, meaning that ticked and dormant articles will be
4886 put in the cache.  The latter is @code{(read)} by default, meaning that
4887 articles that are marked as read are removed from the cache.  Possibly
4888 symbols in these two lists are @code{ticked}, @code{dormant},
4889 @code{unread} and @code{read}.
4890
4891 @findex gnus-jog-cache
4892 So where does the massive article-fetching and storing come into the
4893 picture?  The @code{gnus-jog-cache} command will go through all
4894 subscribed newsgroups, request all unread articles, and store them in
4895 the cache.  You should only ever, ever ever ever, use this command if 1)
4896 your connection to the @sc{nntp} server is really, really, really slow
4897 and 2) you have a really, really, really huge disk.  Seriously.
4898
4899 @vindex gnus-uncacheable-groups
4900 It is likely that you do not want caching on some groups.  For instance,
4901 if your @code{nnml} mail is located under your home directory, it makes no
4902 sense to cache it somewhere else under your home directory.  Unless you
4903 feel that it's neat to use twice as much space.  To limit the caching,
4904 you could set the @code{gnus-uncacheable-groups} regexp to
4905 @samp{^nnml}, for instance.  This variable is @code{nil} by
4906 default.
4907
4908 @findex gnus-cache-generate-nov-databases
4909 @findex gnus-cache-generate-active
4910 @vindex gnus-cache-active-file
4911 The cache stores information on what articles it contains in its active
4912 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4913 of the cache) becomes all messed up for some reason or other, Gnus
4914 offers two functions that will try to set things right.  @kbd{M-x
4915 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4916 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4917 file.
4918
4919
4920 @node Persistent Articles
4921 @section Persistent Articles
4922 @cindex persistent articles
4923
4924 Closely related to article caching, we have @dfn{persistent articles}.
4925 In fact, it's just a different way of looking at caching, and much more
4926 useful in my opinion.
4927
4928 Say you're reading a newsgroup, and you happen on to some valuable gem
4929 that you want to keep and treasure forever.  You'd normally just save it
4930 (using one of the many saving commands) in some file.  The problem with
4931 that is that it's just, well, yucky.  Ideally you'd prefer just having
4932 the article remain in the group where you found it forever; untouched by
4933 the expiry going on at the news server.
4934
4935 This is what a @dfn{persistent article} is---an article that just won't
4936 be deleted.  It's implemented using the normal cache functions, but
4937 you use two explicit commands for managing persistent articles:
4938
4939 @table @kbd
4940
4941 @item *
4942 @kindex * (Summary)
4943 @findex gnus-cache-enter-article
4944 Make the current article persistent (@code{gnus-cache-enter-article}). 
4945
4946 @item M-*
4947 @kindex M-* (Summary)
4948 @findex gnus-cache-remove-article
4949 Remove the current article from the persistent articles
4950 (@code{gnus-cache-remove-article}).  This will normally delete the
4951 article. 
4952 @end table
4953
4954 Both these commands understand the process/prefix convention. 
4955
4956 To avoid having all ticked articles (and stuff) entered into the cache,
4957 you should set @code{gnus-use-cache} to @code{passive} if you're just
4958 interested in persistent articles:
4959
4960 @lisp
4961 (setq gnus-use-cache 'passive)
4962 @end lisp
4963
4964
4965 @node Article Backlog
4966 @section Article Backlog
4967 @cindex backlog
4968 @cindex article backlog
4969
4970 If you have a slow connection, but the idea of using caching seems
4971 unappealing to you (and it is, really), you can help the situation some
4972 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4973 already read articles so that it doesn't have to re-fetch articles
4974 you've already read.  This only helps if you are in the habit of
4975 re-selecting articles you've recently read, of course.  If you never do
4976 that, turning the backlog on will slow Gnus down a little bit, and
4977 increase memory usage some.
4978
4979 @vindex gnus-keep-backlog
4980 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
4981 at most @var{n} old articles in a buffer for later re-fetching.  If this
4982 variable is non-@code{nil} and is not a number, Gnus will store
4983 @emph{all} read articles, which means that your Emacs will grow without
4984 bound before exploding and taking your machine down with you.  I put
4985 that in there just to keep y'all on your toes.  
4986
4987 This variable is @code{nil} by default.
4988
4989
4990 @node Saving Articles
4991 @section Saving Articles
4992 @cindex saving articles
4993
4994 Gnus can save articles in a number of ways.  Below is the documentation
4995 for saving articles in a fairly straight-forward fashion (i.e., little
4996 processing of the article is done before it is saved).  For a different
4997 approach (uudecoding, unsharing) you should use @code{gnus-uu}
4998 (@pxref{Decoding Articles}).
4999
5000 @vindex gnus-save-all-headers
5001 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5002 unwanted headers before saving the article.
5003
5004 @vindex gnus-saved-headers
5005 If the preceding variable is @code{nil}, all headers that match the
5006 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5007 deleted before saving.
5008
5009 @table @kbd
5010
5011 @item O o
5012 @itemx o
5013 @kindex O o (Summary)
5014 @kindex o (Summary)
5015 @findex gnus-summary-save-article
5016 Save the current article using the default article saver
5017 (@code{gnus-summary-save-article}). 
5018
5019 @item O m
5020 @kindex O m (Summary)
5021 @findex gnus-summary-save-article-mail
5022 Save the current article in mail format
5023 (@code{gnus-summary-save-article-mail}). 
5024
5025 @item O r
5026 @kindex O r (Summary)
5027 @findex gnus-summary-save-article-rmail
5028 Save the current article in rmail format
5029 (@code{gnus-summary-save-article-rmail}). 
5030
5031 @item O f
5032 @kindex O f (Summary)
5033 @findex gnus-summary-save-article-file
5034 Save the current article in plain file format
5035 (@code{gnus-summary-save-article-file}). 
5036
5037 @item O F
5038 @kindex O F (Summary)
5039 @findex gnus-summary-write-article-file
5040 Write the current article in plain file format, overwriting any previous
5041 file contents (@code{gnus-summary-write-article-file}). 
5042
5043 @item O b
5044 @kindex O b (Summary)
5045 @findex gnus-summary-save-article-body-file
5046 Save the current article body in plain file format
5047 (@code{gnus-summary-save-article-body-file}). 
5048
5049 @item O h
5050 @kindex O h (Summary)
5051 @findex gnus-summary-save-article-folder
5052 Save the current article in mh folder format
5053 (@code{gnus-summary-save-article-folder}). 
5054
5055 @item O v
5056 @kindex O v (Summary)
5057 @findex gnus-summary-save-article-vm
5058 Save the current article in a VM folder
5059 (@code{gnus-summary-save-article-vm}).
5060
5061 @item O p
5062 @kindex O p (Summary)
5063 @findex gnus-summary-pipe-output
5064 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5065 the current article to a process (@code{gnus-summary-pipe-output}).
5066 @end table
5067
5068 @vindex gnus-prompt-before-saving
5069 All these commands use the process/prefix convention
5070 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5071 functions, you might get tired of being prompted for files to save each
5072 and every article in.  The prompting action is controlled by
5073 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5074 default, giving you that excessive prompting action you know and
5075 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5076 just once for each series of articles you save.  If you like to really
5077 have Gnus do all your thinking for you, you can even set this variable
5078 to @code{nil}, which means that you will never be prompted for files to
5079 save articles in.  Gnus will simply save all the articles in the default
5080 files. 
5081
5082
5083 @vindex gnus-default-article-saver
5084 You can customize the @code{gnus-default-article-saver} variable to make
5085 Gnus do what you want it to.  You can use any of the four ready-made
5086 functions below, or you can create your own.
5087
5088 @table @code
5089
5090 @item gnus-summary-save-in-rmail
5091 @findex gnus-summary-save-in-rmail
5092 @vindex gnus-rmail-save-name
5093 @findex gnus-plain-save-name
5094 This is the default format, @dfn{babyl}.  Uses the function in the
5095 @code{gnus-rmail-save-name} variable to get a file name to save the
5096 article in.  The default is @code{gnus-plain-save-name}.
5097
5098 @item gnus-summary-save-in-mail
5099 @findex gnus-summary-save-in-mail
5100 @vindex gnus-mail-save-name
5101 Save in a Unix mail (mbox) file.  Uses the function in the
5102 @code{gnus-mail-save-name} variable to get a file name to save the
5103 article in.  The default is @code{gnus-plain-save-name}.
5104
5105 @item gnus-summary-save-in-file
5106 @findex gnus-summary-save-in-file
5107 @vindex gnus-file-save-name
5108 @findex gnus-numeric-save-name
5109 Append the article straight to an ordinary file.  Uses the function in
5110 the @code{gnus-file-save-name} variable to get a file name to save the
5111 article in.  The default is @code{gnus-numeric-save-name}.
5112
5113 @item gnus-summary-save-body-in-file
5114 @findex gnus-summary-save-body-in-file
5115 Append the article body to an ordinary file.  Uses the function in the
5116 @code{gnus-file-save-name} variable to get a file name to save the
5117 article in.  The default is @code{gnus-numeric-save-name}.
5118
5119 @item gnus-summary-save-in-folder
5120 @findex gnus-summary-save-in-folder
5121 @findex gnus-folder-save-name
5122 @findex gnus-Folder-save-name
5123 @vindex gnus-folder-save-name
5124 @cindex rcvstore
5125 @cindex MH folders
5126 Save the article to an MH folder using @code{rcvstore} from the MH
5127 library.  Uses the function in the @code{gnus-folder-save-name} variable
5128 to get a file name to save the article in.  The default is
5129 @code{gnus-folder-save-name}, but you can also use
5130 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5131 the latter does not.
5132
5133 @item gnus-summary-save-in-vm
5134 @findex gnus-summary-save-in-vm
5135 Save the article in a VM folder.  You have to have the VM mail
5136 reader to use this setting.
5137 @end table
5138
5139 @vindex gnus-article-save-directory
5140 All of these functions, except for the last one, will save the article
5141 in the @code{gnus-article-save-directory}, which is initialized from the
5142 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5143 default. 
5144
5145 As you can see above, the functions use different functions to find a
5146 suitable name of a file to save the article in.  Below is a list of
5147 available functions that generate names:
5148
5149 @table @code
5150
5151 @item gnus-Numeric-save-name
5152 @findex gnus-Numeric-save-name
5153 File names like @file{~/News/Alt.andrea-dworkin/45}.
5154
5155 @item gnus-numeric-save-name
5156 @findex gnus-numeric-save-name
5157 File names like @file{~/News/alt.andrea-dworkin/45}.
5158
5159 @item gnus-Plain-save-name
5160 @findex gnus-Plain-save-name
5161 File names like @file{~/News/Alt.andrea-dworkin}.
5162
5163 @item gnus-plain-save-name
5164 @findex gnus-plain-save-name
5165 File names like @file{~/News/alt.andrea-dworkin}.
5166 @end table
5167
5168 @vindex gnus-split-methods
5169 You can have Gnus suggest where to save articles by plonking a regexp into
5170 the @code{gnus-split-methods} alist.  For instance, if you would like to
5171 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5172 related to VM in @code{vm-stuff}, you could set this variable to something
5173 like:
5174
5175 @lisp
5176 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5177  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5178  (my-choosing-function "../other-dir/my-stuff")
5179  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5180 @end lisp
5181
5182 We see that this is a list where each element is a list that has two
5183 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5184 a string (in which case it is used as a regexp to match on the article
5185 head); it can be a symbol (which will be called as a function with the
5186 group name as a parameter); or it can be a list (which will be
5187 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5188 the @dfn{file} will be used as a default prompt.  In addition, the
5189 result of the operation itself will be used if the function or form
5190 called returns a string or a list of strings.
5191
5192 You basically end up with a list of file names that might be used when
5193 saving the current article.  (All ``matches'' will be used.)  You will
5194 then be prompted for what you really want to use as a name, with file
5195 name completion over the results from applying this variable.
5196
5197 This variable is @code{((gnus-article-archive-name))} by default, which
5198 means that Gnus will look at the articles it saves for an
5199 @code{Archive-name} line and use that as a suggestion for the file
5200 name. 
5201
5202 @vindex gnus-use-long-file-name
5203 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5204 @code{nil}, all the preceding functions will replace all periods
5205 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5206 the functions will generate hierarchies of directories instead of having
5207 all the files in the toplevel directory
5208 (@file{~/News/alt/andrea-dworkin} instead of
5209 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5210 on most systems.  However, for historical reasons, this is @code{nil} on
5211 Xenix and usg-unix-v machines by default.
5212
5213 This function also affects kill and score file names.  If this variable
5214 is a list, and the list contains the element @code{not-score}, long file
5215 names will not be used for score files, if it contains the element
5216 @code{not-save}, long file names will not be used for saving, and if it
5217 contains the element @code{not-kill}, long file names will not be used
5218 for kill files.
5219
5220 If you'd like to save articles in a hierarchy that looks something like
5221 a spool, you could
5222
5223 @lisp
5224 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5225 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5226 @end lisp
5227
5228 Then just save with @kbd{o}.  You'd then read this hierarchy with
5229 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5230 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5231 around to the groups/directories with @code{nneething}.
5232
5233
5234 @node Decoding Articles
5235 @section Decoding Articles
5236 @cindex decoding articles
5237
5238 Sometime users post articles (or series of articles) that have been
5239 encoded in some way or other.  Gnus can decode them for you.
5240
5241 @menu 
5242 * Uuencoded Articles::    Uudecode articles.
5243 * Shared Articles::       Unshar articles.
5244 * PostScript Files::      Split PostScript.
5245 * Decoding Variables::    Variables for a happy decoding.
5246 * Viewing Files::         You want to look at the result of the decoding?
5247 @end menu
5248
5249 All these functions use the process/prefix convention
5250 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5251 the extension that a ``single article'' means ``a single series''.  Gnus
5252 can find out by itself what articles belong to a series, decode all the
5253 articles and unpack/view/save the resulting file(s).
5254
5255 Gnus guesses what articles are in the series according to the following
5256 simplish rule: The subjects must be (nearly) identical, except for the
5257 last two numbers of the line.  (Spaces are largely ignored, however.)
5258
5259 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5260 will find all the articles that match the regexp @samp{^cat.gif
5261 ([0-9]+/[0-9]+).*$}.  
5262
5263 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5264 series}, will not be properly recognized by any of the automatic viewing
5265 commands, and you have to mark the articles manually with @kbd{#}.
5266
5267
5268 @node Uuencoded Articles
5269 @subsection Uuencoded Articles
5270 @cindex uudecode
5271 @cindex uuencoded articles
5272
5273 @table @kbd
5274
5275 @item X u
5276 @kindex X u (Summary)
5277 @findex gnus-uu-decode-uu
5278 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5279
5280 @item X U
5281 @kindex X U (Summary)
5282 @findex gnus-uu-decode-uu-and-save
5283 Uudecodes and saves the current series
5284 (@code{gnus-uu-decode-uu-and-save}).
5285
5286 @item X v u
5287 @kindex X v u (Summary)
5288 @findex gnus-uu-decode-uu-view
5289 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5290
5291 @item X v U
5292 @kindex X v U (Summary)
5293 @findex gnus-uu-decode-uu-and-save-view
5294 Uudecodes, views and saves the current series
5295 (@code{gnus-uu-decode-uu-and-save-view}). 
5296 @end table
5297
5298 Remember that these all react to the presence of articles marked with
5299 the process mark.  If, for instance, you'd like to decode and save an
5300 entire newsgroup, you'd typically do @kbd{M P a}
5301 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5302 (@code{gnus-uu-decode-uu-and-save}).
5303
5304 All this is very much different from how @code{gnus-uu} worked with
5305 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5306 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5307 articles in some way (@pxref{Setting Process Marks}) and then press
5308 @kbd{X u}.
5309
5310 @vindex gnus-uu-notify-files
5311 Note: When trying to decode articles that have names matching
5312 @code{gnus-uu-notify-files}, which is hard-coded to
5313 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5314 automatically post an article on @samp{comp.unix.wizards} saying that
5315 you have just viewed the file in question.  This feature can't be turned
5316 off.
5317
5318
5319 @node Shared Articles
5320 @subsection Shared Articles
5321 @cindex unshar
5322 @cindex shared articles
5323
5324 @table @kbd
5325
5326 @item X s
5327 @kindex X s (Summary)
5328 @findex gnus-uu-decode-unshar
5329 Unshars the current series (@code{gnus-uu-decode-unshar}).
5330
5331 @item X S
5332 @kindex X S (Summary)
5333 @findex gnus-uu-decode-unshar-and-save
5334 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5335
5336 @item X v s
5337 @kindex X v s (Summary)
5338 @findex gnus-uu-decode-unshar-view
5339 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5340
5341 @item X v S
5342 @kindex X v S (Summary)
5343 @findex gnus-uu-decode-unshar-and-save-view
5344 Unshars, views and saves the current series
5345 (@code{gnus-uu-decode-unshar-and-save-view}). 
5346 @end table
5347
5348
5349 @node PostScript Files
5350 @subsection PostScript Files
5351 @cindex PostScript
5352
5353 @table @kbd
5354
5355 @item X p
5356 @kindex X p (Summary)
5357 @findex gnus-uu-decode-postscript
5358 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5359
5360 @item X P
5361 @kindex X P (Summary)
5362 @findex gnus-uu-decode-postscript-and-save
5363 Unpack and save the current PostScript series
5364 (@code{gnus-uu-decode-postscript-and-save}).
5365
5366 @item X v p
5367 @kindex X v p (Summary)
5368 @findex gnus-uu-decode-postscript-view
5369 View the current PostScript series
5370 (@code{gnus-uu-decode-postscript-view}).
5371
5372 @item X v P
5373 @kindex X v P (Summary)
5374 @findex gnus-uu-decode-postscript-and-save-view
5375 View and save the current PostScript series
5376 (@code{gnus-uu-decode-postscript-and-save-view}). 
5377 @end table
5378
5379
5380 @node Decoding Variables
5381 @subsection Decoding Variables
5382
5383 Adjective, not verb.
5384
5385 @menu 
5386 * Rule Variables::          Variables that say how a file is to be viewed.
5387 * Other Decode Variables::  Other decode variables.
5388 * Uuencoding and Posting::  Variables for customizing uuencoding.
5389 @end menu
5390
5391
5392 @node Rule Variables
5393 @subsubsection Rule Variables
5394 @cindex rule variables
5395
5396 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5397 variables are on the form
5398   
5399 @lisp
5400       (list '(regexp1 command2)
5401             '(regexp2 command2)
5402             ...)
5403 @end lisp
5404
5405 @table @code
5406
5407 @item gnus-uu-user-view-rules
5408 @vindex gnus-uu-user-view-rules
5409 @cindex sox
5410 This variable is consulted first when viewing files.  If you wish to use,
5411 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5412 say something like:
5413 @lisp
5414 (setq gnus-uu-user-view-rules
5415       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5416 @end lisp
5417
5418 @item gnus-uu-user-view-rules-end
5419 @vindex gnus-uu-user-view-rules-end
5420 This variable is consulted if Gnus couldn't make any matches from the
5421 user and default view rules.
5422
5423 @item gnus-uu-user-archive-rules
5424 @vindex gnus-uu-user-archive-rules
5425 This variable can be used to say what commands should be used to unpack
5426 archives.
5427 @end table
5428
5429
5430 @node Other Decode Variables
5431 @subsubsection Other Decode Variables
5432
5433 @table @code
5434 @vindex gnus-uu-grabbed-file-functions
5435
5436 @item gnus-uu-grabbed-file-functions
5437 All functions in this list will be called right each file has been
5438 successfully decoded---so that you can move or view files right away,
5439 and don't have to wait for all files to be decoded before you can do
5440 anything.  Ready-made functions you can put in this list are:
5441
5442 @table @code
5443
5444 @item gnus-uu-grab-view
5445 @findex gnus-uu-grab-view
5446 View the file.
5447
5448 @item gnus-uu-grab-move
5449 @findex gnus-uu-grab-move
5450 Move the file (if you're using a saving function.)
5451 @end table
5452
5453 @item gnus-uu-be-dangerous
5454 @vindex gnus-uu-be-dangerous
5455 Specifies what to do if unusual situations arise during decoding.  If
5456 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5457 that didn't work, and overwrite existing files.  Otherwise, ask each
5458 time.
5459
5460 @item gnus-uu-ignore-files-by-name
5461 @vindex gnus-uu-ignore-files-by-name
5462 Files with name matching this regular expression won't be viewed.
5463
5464 @item gnus-uu-ignore-files-by-type
5465 @vindex gnus-uu-ignore-files-by-type
5466 Files with a @sc{mime} type matching this variable won't be viewed.
5467 Note that Gnus tries to guess what type the file is based on the name.
5468 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5469 kludgey.
5470
5471 @item gnus-uu-tmp-dir
5472 @vindex gnus-uu-tmp-dir
5473 Where @code{gnus-uu} does its work.
5474
5475 @item gnus-uu-do-not-unpack-archives
5476 @vindex gnus-uu-do-not-unpack-archives
5477 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5478 looking for files to display.
5479
5480 @item gnus-uu-view-and-save
5481 @vindex gnus-uu-view-and-save
5482 Non-@code{nil} means that the user will always be asked to save a file
5483 after viewing it.
5484
5485 @item gnus-uu-ignore-default-view-rules
5486 @vindex gnus-uu-ignore-default-view-rules
5487 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5488 rules.
5489
5490 @item gnus-uu-ignore-default-archive-rules
5491 @vindex gnus-uu-ignore-default-archive-rules
5492 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5493 unpacking commands.
5494
5495 @item gnus-uu-kill-carriage-return
5496 @vindex gnus-uu-kill-carriage-return
5497 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5498 from articles.
5499
5500 @item gnus-uu-unmark-articles-not-decoded
5501 @vindex gnus-uu-unmark-articles-not-decoded
5502 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5503 unsuccessfully decoded as unread.
5504
5505 @item gnus-uu-correct-stripped-uucode
5506 @vindex gnus-uu-correct-stripped-uucode
5507 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5508 uuencoded files that have had trailing spaces deleted.
5509
5510 @item gnus-uu-view-with-metamail
5511 @vindex gnus-uu-view-with-metamail
5512 @cindex metamail
5513 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5514 commands defined by the rule variables and just fudge a @sc{mime}
5515 content type based on the file name.  The result will be fed to
5516 @code{metamail} for viewing.
5517
5518 @item gnus-uu-save-in-digest
5519 @vindex gnus-uu-save-in-digest
5520 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5521 decoding, will save in digests.  If this variable is @code{nil},
5522 @code{gnus-uu} will just save everything in a file without any
5523 embellishments.  The digesting almost conforms to RFC1153---no easy way
5524 to specify any meaningful volume and issue numbers were found, so I
5525 simply dropped them.
5526
5527 @end table
5528
5529
5530 @node Uuencoding and Posting
5531 @subsubsection Uuencoding and Posting
5532
5533 @table @code
5534
5535 @item gnus-uu-post-include-before-composing
5536 @vindex gnus-uu-post-include-before-composing
5537 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5538 before you compose the article.  If this variable is @code{t}, you can
5539 either include an encoded file with @kbd{C-c C-i} or have one included
5540 for you when you post the article.
5541
5542 @item gnus-uu-post-length
5543 @vindex gnus-uu-post-length
5544 Maximum length of an article.  The encoded file will be split into how
5545 many articles it takes to post the entire file.
5546
5547 @item gnus-uu-post-threaded
5548 @vindex gnus-uu-post-threaded
5549 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5550 thread.  This may not be smart, as no other decoder I have seen are able
5551 to follow threads when collecting uuencoded articles.  (Well, I have
5552 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5553 think that counts...) Default is @code{nil}.
5554
5555 @item gnus-uu-post-separate-description
5556 @vindex gnus-uu-post-separate-description
5557 Non-@code{nil} means that the description will be posted in a separate
5558 article.  The first article will typically be numbered (0/x).  If this
5559 variable is @code{nil}, the description the user enters will be included
5560 at the beginning of the first article, which will be numbered (1/x).
5561 Default is @code{t}.
5562
5563 @end table
5564
5565
5566 @node Viewing Files
5567 @subsection Viewing Files
5568 @cindex viewing files
5569 @cindex pseudo-articles
5570
5571 After decoding, if the file is some sort of archive, Gnus will attempt
5572 to unpack the archive and see if any of the files in the archive can be
5573 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5574 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5575 uncompress and de-tar the main file, and then view the two pictures.
5576 This unpacking process is recursive, so if the archive contains archives
5577 of archives, it'll all be unpacked.
5578
5579 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5580 extracted file into the summary buffer.  If you go to these
5581 ``articles'', you will be prompted for a command to run (usually Gnus
5582 will make a suggestion), and then the command will be run.
5583
5584 @vindex gnus-view-pseudo-asynchronously
5585 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5586 until the viewing is done before proceeding.
5587
5588 @vindex gnus-view-pseudos
5589 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5590 the pseudo-articles into the summary buffer, but view them
5591 immediately.  If this variable is @code{not-confirm}, the user won't even
5592 be asked for a confirmation before viewing is done.
5593
5594 @vindex gnus-view-pseudos-separately 
5595 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5596 pseudo-article will be created for each file to be viewed.  If
5597 @code{nil}, all files that use the same viewing command will be given as
5598 a list of parameters to that command.
5599
5600 @vindex gnus-insert-pseudo-articles
5601 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5602 pseudo-articles when decoding.  It is @code{t} by default.
5603
5604 So; there you are, reading your @emph{pseudo-articles} in your
5605 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5606 Why isn't anything real anymore? How did we get here?
5607
5608
5609 @node Article Treatment
5610 @section Article Treatment
5611
5612 Reading through this huge manual, you may have quite forgotten that the
5613 object of newsreaders are to actually, like, read what people have
5614 written.  Reading articles.  Unfortunately, people are quite bad at
5615 writing, so there are tons of functions and variables to make reading
5616 these articles easier.
5617
5618 @menu
5619 * Article Highlighting::    You want to make the article look like fruit salad.
5620 * Article Fontisizing::     Making emphasized text look niced.
5621 * Article Hiding::          You also want to make certain info go away.
5622 * Article Washing::         Lots of way-neat functions to make life better.
5623 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5624 * Article Date::            Grumble, UT!
5625 * Article Signature::       What is a signature?
5626 @end menu
5627
5628
5629 @node Article Highlighting
5630 @subsection Article Highlighting
5631 @cindex highlight
5632
5633 Not only do you want your article buffer to look like fruit salad, but
5634 you want it to look like technicolor fruit salad.
5635
5636 @table @kbd
5637
5638 @item W H a
5639 @kindex W H a (Summary)
5640 @findex gnus-article-highlight
5641 Highlight the current article (@code{gnus-article-highlight}).
5642
5643 @item W H h
5644 @kindex W H h (Summary)
5645 @findex gnus-article-highlight-headers
5646 @vindex gnus-header-face-alist
5647 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5648 highlighting will be done according to the @code{gnus-header-face-alist}
5649 variable, which is a list where each element has the form @var{(regexp
5650 name content)}.  @var{regexp} is a regular expression for matching the
5651 header, @var{name} is the face used for highlighting the header name and
5652 @var{content} is the face for highlighting the header value.  The first
5653 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5654 prepended---Gnus will add one.
5655
5656 @item W H c
5657 @kindex W H c (Summary)
5658 @findex gnus-article-highlight-citation
5659 Highlight cited text (@code{gnus-article-highlight-citation}). 
5660
5661 Some variables to customize the citation highlights:
5662
5663 @table @code
5664 @vindex gnus-cite-parse-max-size
5665
5666 @item gnus-cite-parse-max-size
5667 If the article size if bigger than this variable (which is 25000 by
5668 default), no citation highlighting will be performed.  
5669
5670 @item gnus-cite-prefix-regexp
5671 @vindex gnus-cite-prefix-regexp
5672 Regexp matching the longest possible citation prefix on a line. 
5673
5674 @item gnus-cite-max-prefix
5675 @vindex gnus-cite-max-prefix
5676 Maximum possible length for a citation prefix (default 20).
5677
5678 @item gnus-cite-face-list
5679 @vindex gnus-cite-face-list
5680 List of faces used for highlighting citations.  When there are citations
5681 from multiple articles in the same message, Gnus will try to give each
5682 citation from each article its own face.  This should make it easier to
5683 see who wrote what.
5684
5685 @item gnus-supercite-regexp
5686 @vindex gnus-supercite-regexp
5687 Regexp matching normal Supercite attribution lines.  
5688
5689 @item gnus-supercite-secondary-regexp
5690 @vindex gnus-supercite-secondary-regexp
5691 Regexp matching mangled Supercite attribution lines.
5692
5693 @item gnus-cite-minimum-match-count
5694 @vindex gnus-cite-minimum-match-count
5695 Minimum number of identical prefixes we have to see before we believe
5696 that it's a citation.
5697
5698 @item gnus-cite-attribution-prefix
5699 @vindex gnus-cite-attribution-prefix
5700 Regexp matching the beginning of an attribution line.
5701
5702 @item gnus-cite-attribution-suffix
5703 @vindex gnus-cite-attribution-suffix
5704 Regexp matching the end of an attribution line.
5705
5706 @item gnus-cite-attribution-face
5707 @vindex gnus-cite-attribution-face
5708 Face used for attribution lines.  It is merged with the face for the
5709 cited text belonging to the attribution.
5710
5711 @end table
5712
5713
5714 @item W H s
5715 @kindex W H s (Summary)
5716 @vindex gnus-signature-separator
5717 @vindex gnus-signature-face
5718 @findex gnus-article-highlight-signature
5719 Highlight the signature (@code{gnus-article-highlight-signature}).
5720 Everything after @code{gnus-signature-separator} (@pxref{Article
5721 Signature}) in an article will be considered a signature and will be
5722 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5723 default.
5724
5725 @end table
5726
5727
5728 @node Article Fontisizing
5729 @subsection Article Fontisizing
5730 @cindex emphasis
5731 @cindex article emphasis
5732
5733 @findex gnus-article-emphasize
5734 @kindex W e (Summary)
5735 People commonly add emphasis to words in news articles by writing things
5736 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5737 running the article through the @kbd{W e}
5738 (@code{gnus-article-emphasize}) command.
5739
5740 @vindex gnus-article-emphasis
5741 How the emphasis is computed is controlled by the
5742 @code{gnus-article-emphasis} variable.  This is an alist where the first
5743 element is a regular expression to be matched.  The second is a number
5744 that says what regular expression grouping used to find the entire
5745 emphasized word.  The third is a number that says what regexp grouping
5746 should be displayed and highlighted.  (The text between these two
5747 groupings will be hidden.)  The fourth is the face used for
5748 highlighting.
5749
5750 @lisp
5751 (setq gnus-article-emphasis
5752       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5753         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5754 @end lisp
5755
5756 @vindex gnus-emphasis-underline
5757 @vindex gnus-emphasis-bold
5758 @vindex gnus-emphasis-italic
5759 @vindex gnus-emphasis-underline-bold
5760 @vindex gnus-emphasis-underline-italic
5761 @vindex gnus-emphasis-bold-italic
5762 @vindex gnus-emphasis-underline-bold-italic
5763 By default, there are seven rules, and they use the following faces:
5764 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5765 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5766 @code{gnus-emphasis-underline-italic},
5767 @code{gnus-emphasis-undeline-bold}, and
5768 @code{gnus-emphasis-underline-bold-italic}.  
5769
5770 If you want to change these faces, you can either use @kbd{M-x
5771 customize}, or you can use @code{copy-face}.  For instance, if you want
5772 to make @code{gnus-emphasis-italic} use a red face instead, you could
5773 say something like:
5774
5775 @lisp
5776 (copy-face 'red 'gnus-emphasis-italic)
5777 @end lisp
5778
5779
5780 @node Article Hiding
5781 @subsection Article Hiding
5782 @cindex article hiding
5783
5784 Or rather, hiding certain things in each article.  There usually is much
5785 too much cruft in most articles.  
5786
5787 @table @kbd
5788
5789 @item W W a
5790 @kindex W W a (Summary)
5791 @findex gnus-article-hide
5792 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5793
5794 @item W W h
5795 @kindex W W h (Summary)
5796 @findex gnus-article-hide-headers
5797 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5798 Headers}. 
5799
5800 @item W W b
5801 @kindex W W b (Summary)
5802 @findex gnus-article-hide-boring-headers
5803 Hide headers that aren't particularly interesting
5804 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5805
5806 @item W W s
5807 @kindex W W s (Summary)
5808 @findex gnus-article-hide-signature
5809 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5810 Signature}. 
5811
5812 @item W W p
5813 @kindex W W p (Summary)
5814 @findex gnus-article-hide-pgp
5815 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5816
5817 @item W W P
5818 @kindex W W P (Summary)
5819 @findex gnus-article-hide-pem
5820 Hide @sc{pem} (privacy enhanced messages) gruft
5821 (@code{gnus-article-hide-pem}).
5822
5823 @item W W c
5824 @kindex W W c (Summary)
5825 @findex gnus-article-hide-citation
5826 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5827 customizing the hiding:
5828
5829 @table @code
5830
5831 @item gnus-cite-hide-percentage
5832 @vindex gnus-cite-hide-percentage
5833 If the cited text is of a bigger percentage than this variable (default
5834 50), hide the cited text.
5835
5836 @item gnus-cite-hide-absolute
5837 @vindex gnus-cite-hide-absolute
5838 The cited text must be have at least this length (default 10) before it
5839 is hidden.
5840
5841 @item gnus-cited-text-button-line-format
5842 @vindex gnus-cited-text-button-line-format
5843 Gnus adds buttons show where the cited text has been hidden, and to
5844 allow toggle hiding the text.  The format of the variable is specified
5845 by this format-like variable (@pxref{Formatting Variables}).  These
5846 specs are legal:
5847
5848 @table @samp
5849 @item b
5850 Start point of the hidden text.
5851 @item e
5852 End point of the hidden text.
5853 @item l
5854 Length of the hidden text.
5855 @end table
5856
5857 @item gnus-cited-lines-visible
5858 @vindex gnus-cited-lines-visible
5859 The number of lines at the beginning of the cited text to leave shown. 
5860
5861 @end table
5862
5863 @item W W C
5864 @kindex W W C (Summary)
5865 @findex gnus-article-hide-citation-in-followups
5866 Hide cited text in articles that aren't roots
5867 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5868 useful as an interactive command, but might be a handy function to stick
5869 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5870
5871 @end table
5872
5873 All these ``hiding'' commands are toggles, but if you give a negative
5874 prefix to these commands, they will show what they have previously
5875 hidden.  If you give a positive prefix, they will always hide.
5876
5877 Also @pxref{Article Highlighting} for further variables for
5878 citation customization.
5879
5880
5881 @node Article Washing
5882 @subsection Article Washing
5883 @cindex washing
5884 @cindex article washing
5885
5886 We call this ``article washing'' for a really good reason.  Namely, the
5887 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5888
5889 @dfn{Washing} is defined by us as ``changing something from something to
5890 something else'', but normally results in something looking better.
5891 Cleaner, perhaps.
5892
5893 @table @kbd
5894
5895 @item W l
5896 @kindex W l (Summary)
5897 @findex gnus-summary-stop-page-breaking
5898 Remove page breaks from the current article
5899 (@code{gnus-summary-stop-page-breaking}).
5900
5901 @item W r
5902 @kindex W r (Summary)
5903 @findex gnus-summary-caesar-message
5904 Do a Caesar rotate (rot13) on the article buffer
5905 (@code{gnus-summary-caesar-message}). 
5906
5907 @item W t
5908 @kindex W t (Summary)
5909 @findex gnus-summary-toggle-header
5910 Toggle whether to display all headers in the article buffer
5911 (@code{gnus-summary-toggle-header}). 
5912
5913 @item W v
5914 @kindex W v (Summary)
5915 @findex gnus-summary-verbose-header
5916 Toggle whether to display all headers in the article buffer permanently
5917 (@code{gnus-summary-verbose-header}).
5918
5919 @item W m
5920 @kindex W m (Summary)
5921 @findex gnus-summary-toggle-mime
5922 Toggle whether to run the article through @sc{mime} before displaying
5923 (@code{gnus-summary-toggle-mime}).
5924
5925 @item W o
5926 @kindex W o (Summary)
5927 @findex gnus-article-treat-overstrike
5928 Treat overstrike (@code{gnus-article-treat-overstrike}).
5929
5930 @item W w
5931 @kindex W w (Summary)
5932 @findex gnus-article-fill-cited-article
5933 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5934 function in @code{gnus-article-display-hook}, it should be run fairly
5935 late and certainly after any highlighting.
5936
5937 You can give the command a numerical prefix to specify the width to use
5938 when filling.
5939
5940 @item W c
5941 @kindex W c (Summary)
5942 @findex gnus-article-remove-cr
5943 Remove CR (@code{gnus-article-remove-cr}).
5944
5945 @item W q
5946 @kindex W q (Summary)
5947 @findex gnus-article-de-quoted-unreadable
5948 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5949
5950 @item W f
5951 @kindex W f (Summary)
5952 @cindex x-face
5953 @findex gnus-article-display-x-face
5954 @findex gnus-article-x-face-command
5955 @vindex gnus-article-x-face-command
5956 @vindex gnus-article-x-face-too-ugly
5957 Look for and display any X-Face headers
5958 (@code{gnus-article-display-x-face}).  The command executed by this
5959 function is given by the @code{gnus-article-x-face-command} variable.
5960 If this variable is a string, this string will be executed in a
5961 sub-shell.  If it is a function, this function will be called with the
5962 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
5963 is a regexp) matches the @code{From} header, the face will not be shown.
5964 The default action under Emacs is to fork off an @code{xv} to view the
5965 face; under XEmacs the default action is to display the face before the
5966 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
5967 support---that will make display somewhat faster.  If there's no native
5968 X-Face support, Gnus will try to convert the @code{X-Face} header using
5969 external programs from the @code{pbmplus} package and friends.)  If you
5970 want to have this function in the display hook, it should probably come
5971 last.
5972
5973 @item W b
5974 @kindex W b (Summary)
5975 @findex gnus-article-add-buttons
5976 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
5977
5978 @item W B
5979 @kindex W B (Summary)
5980 @findex gnus-article-add-buttons-to-head
5981 Add clickable buttons to the article headers
5982 (@code{gnus-article-add-buttons-to-head}).  
5983
5984 @item W E l
5985 @kindex W E l (Summary)
5986 @findex gnus-article-strip-leading-blank-lines
5987 Remove all blank lines from the beginning of the article
5988 (@code{gnus-article-strip-leading-blank-lines}).
5989
5990 @item W E m
5991 @kindex W E m (Summary)
5992 @findex gnus-article-strip-multiple-blank-lines
5993 Replace all blank lines with empty lines and then all multiple empty
5994 lines with a single empty line.
5995 (@code{gnus-article-strip-multiple-blank-lines}).
5996
5997 @item W E t
5998 @kindex W E t (Summary)
5999 @findex gnus-article-remove-trailing-blank-lines
6000 Remove all blank lines at the end of the article
6001 (@code{gnus-article-remove-trailing-blank-lines}).
6002
6003 @item W E a
6004 @kindex W E a (Summary)
6005 @findex gnus-article-strip-blank-lines
6006 Do all the three commands above
6007 (@code{gnus-article-strip-blank-lines}).
6008
6009 @end table
6010
6011
6012 @node Article Buttons
6013 @subsection Article Buttons
6014 @cindex buttons
6015
6016 People often include references to other stuff in articles, and it would
6017 be nice if Gnus could just fetch whatever it is that people talk about
6018 with the minimum of fuzz.
6019
6020 Gnus adds @dfn{buttons} to certain standard references by default:
6021 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6022 two variables, one that handles article bodies and one that handles
6023 article heads:
6024
6025 @table @code
6026
6027 @item gnus-button-alist
6028 @vindex gnus-button-alist
6029 This is an alist where each entry has this form:
6030
6031 @lisp
6032 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6033 @end lisp
6034
6035 @table @var
6036
6037 @item regexp
6038 All text that match this regular expression will be considered an
6039 external reference.  Here's a typical regexp that match embedded URLs:
6040 @samp{<URL:\\([^\n\r>]*\\)>}. 
6041
6042 @item button-par
6043 Gnus has to know which parts of the match is to be highlighted.  This is
6044 a number that says what sub-expression of the regexp that is to be
6045 highlighted.  If you want it all highlighted, you use 0 here.
6046
6047 @item use-p
6048 This form will be @code{eval}ed, and if the result is non-@code{nil},
6049 this is considered a match.  This is useful if you want extra sifting to
6050 avoid false matches.
6051
6052 @item function
6053 This function will be called when you click on this button.
6054
6055 @item data-par
6056 As with @var{button-par}, this is a sub-expression number, but this one
6057 says which part of the match is to be sent as data to @var{function}. 
6058
6059 @end table
6060
6061 So the full entry for buttonizing URLs is then
6062
6063 @lisp
6064 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6065 @end lisp
6066
6067 @item gnus-header-button-alist
6068 @vindex gnus-header-button-alist
6069 This is just like the other alist, except that it is applied to the
6070 article head only, and that each entry has an additional element that is
6071 used to say what headers to apply the buttonize coding to:
6072
6073 @lisp
6074 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6075 @end lisp
6076
6077 @var{header} is a regular expression.
6078
6079 @item gnus-button-url-regexp
6080 @vindex gnus-button-url-regexp
6081 A regular expression that matches embedded URLs.  It is used in the
6082 default values of the variables above.
6083
6084 @item gnus-article-button-face
6085 @vindex gnus-article-button-face
6086 Face used on buttons.
6087
6088 @item gnus-article-mouse-face
6089 @vindex gnus-article-mouse-face
6090 Face is used when the mouse cursor is over a button.
6091
6092 @end table
6093
6094
6095 @node Article Date
6096 @subsection Article Date
6097
6098 The date is most likely generated in some obscure timezone you've never
6099 heard of, so it's quite nice to be able to find out what the time was
6100 when the article was sent.
6101
6102 @table @kbd
6103
6104 @item W T u
6105 @kindex W T u (Summary)
6106 @findex gnus-article-date-ut
6107 Display the date in UT (aka. GMT, aka ZULU)
6108 (@code{gnus-article-date-ut}). 
6109
6110 @item W T l
6111 @kindex W T l (Summary)
6112 @findex gnus-article-date-local
6113 Display the date in the local timezone (@code{gnus-article-date-local}).
6114
6115 @item W T s
6116 @kindex W T s (Summary)
6117 @vindex gnus-article-time-format
6118 @findex gnus-article-date-user
6119 @findex format-time-string
6120 Display the date using a user-defined format
6121 (@code{gnus-article-date-user}).  The format is specified by the
6122 @code{gnus-article-time-format} variable, and is a string that's passed
6123 to @code{format-time-string}.  See the documentation of that variable
6124 for a list possible format specs.
6125
6126 @item W T e
6127 @kindex W T e (Summary)
6128 @findex gnus-article-date-lapsed
6129 Say how much time has (e)lapsed between the article was posted and now
6130 (@code{gnus-article-date-lapsed}).
6131
6132 @item W T o
6133 @kindex W T o (Summary)
6134 @findex gnus-article-date-original
6135 Display the original date (@code{gnus-article-date-original}).  This can
6136 be useful if you normally use some other conversion function and is
6137 worried that it might be doing something totally wrong.  Say, claiming
6138 that the article was posted in 1854.  Although something like that is
6139 @emph{totally} impossible.  Don't you trust me? *titter*
6140
6141 @end table
6142
6143
6144 @node Article Signature
6145 @subsection Article Signature
6146 @cindex signatures
6147 @cindex article signature
6148
6149 @vindex gnus-signature-separator
6150 Each article is divided into two parts---the head and the body.  The
6151 body can be divided into a signature part and a text part.  The variable
6152 that says what is to be considered a signature is
6153 @code{gnus-signature-separator}.  This is normally the standard
6154 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6155 non-standard signature separators, so this variable can also be a list
6156 of regular expressions to be tested, one by one.  (Searches are done
6157 from the end of the body towards the beginning.)  One likely value is:
6158
6159 @lisp
6160 (setq gnus-signature-separator
6161       '("^-- $"         ; The standard
6162         "^-- *$"        ; A common mangling
6163         "^-------*$"    ; Many people just use a looong 
6164                         ; line of dashes.  Shame!
6165         "^ *--------*$" ; Double-shame!
6166         "^________*$"   ; Underscores are also popular
6167         "^========*$")) ; Pervert!
6168 @end lisp
6169
6170 The more permissive you are, the more likely it is that you'll get false
6171 positives.
6172
6173 @vindex gnus-signature-limit
6174 @code{gnus-signature-limit} provides a limit to what is considered a
6175 signature. 
6176
6177 @enumerate
6178 @item 
6179 If it is an integer, no signature may be longer (in characters) than
6180 that integer.
6181 @item 
6182 If it is a floating point number, no signature may be longer (in lines)
6183 than that number.
6184 @item 
6185 If it is a function, the function will be called without any parameters,
6186 and if it returns @code{nil}, there is no signature in the buffer.
6187 @item
6188 If it is a string, it will be used as a regexp.  If it matches, the text
6189 in question is not a signature.
6190 @end enumerate
6191
6192 This variable can also be a list where the elements may be of the types
6193 listed above.  
6194
6195
6196 @node Article Commands
6197 @section Article Commands
6198
6199 @table @kbd
6200
6201 @item A P
6202 @cindex PostScript
6203 @cindex printing
6204 @kindex A P (Summary)
6205 @vindex gnus-ps-print-hook
6206 @findex gnus-summary-print-article 
6207 Generate and print a PostScript image of the article buffer
6208 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6209 run just before printing the buffer.
6210
6211 @end table
6212
6213
6214 @node Summary Sorting
6215 @section Summary Sorting
6216 @cindex summary sorting
6217
6218 You can have the summary buffer sorted in various ways, even though I
6219 can't really see why you'd want that.
6220
6221 @table @kbd
6222
6223 @item C-c C-s C-n
6224 @kindex C-c C-s C-n (Summary)
6225 @findex gnus-summary-sort-by-number
6226 Sort by article number (@code{gnus-summary-sort-by-number}).
6227
6228 @item C-c C-s C-a
6229 @kindex C-c C-s C-a (Summary)
6230 @findex gnus-summary-sort-by-author
6231 Sort by author (@code{gnus-summary-sort-by-author}).
6232
6233 @item C-c C-s C-s
6234 @kindex C-c C-s C-s (Summary)
6235 @findex gnus-summary-sort-by-subject
6236 Sort by subject (@code{gnus-summary-sort-by-subject}).
6237
6238 @item C-c C-s C-d
6239 @kindex C-c C-s C-d (Summary)
6240 @findex gnus-summary-sort-by-date
6241 Sort by date (@code{gnus-summary-sort-by-date}).
6242
6243 @item C-c C-s C-l
6244 @kindex C-c C-s C-l (Summary)
6245 @findex gnus-summary-sort-by-lines
6246 Sort by lines (@code{gnus-summary-sort-by-lines}).
6247
6248 @item C-c C-s C-i
6249 @kindex C-c C-s C-i (Summary)
6250 @findex gnus-summary-sort-by-score
6251 Sort by score (@code{gnus-summary-sort-by-score}).
6252 @end table
6253
6254 These functions will work both when you use threading and when you don't
6255 use threading.  In the latter case, all summary lines will be sorted,
6256 line by line.  In the former case, sorting will be done on a
6257 root-by-root basis, which might not be what you were looking for.  To
6258 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6259 Commands}).
6260
6261
6262 @node Finding the Parent
6263 @section Finding the Parent
6264 @cindex parent articles
6265 @cindex referring articles
6266
6267 @findex gnus-summary-refer-parent-article
6268 @kindex ^ (Summary)
6269 If you'd like to read the parent of the current article, and it is not
6270 displayed in the summary buffer, you might still be able to.  That is,
6271 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6272 and the @code{References} in the current article are not mangled, you
6273 can just press @kbd{^} or @kbd{A r}
6274 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6275 you'll get the parent.  If the parent is already displayed in the
6276 summary buffer, point will just move to this article.
6277
6278 If given a positive numerical prefix, fetch that many articles back into
6279 the ancestry.  If given a negative numerical prefix, fetch just that
6280 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6281 grandparent and the grandgrandparent of the current article.  If you say
6282 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6283 article. 
6284
6285 @findex gnus-summary-refer-references
6286 @kindex A R (Summary)
6287 You can have Gnus fetch all articles mentioned in the @code{References}
6288 header of the article by pushing @kbd{A R}
6289 (@code{gnus-summary-refer-references}). 
6290
6291 @findex gnus-summary-refer-article
6292 @kindex M-^ (Summary)
6293 @cindex Message-ID
6294 @cindex fetching by Message-ID
6295 You can also ask the @sc{nntp} server for an arbitrary article, no
6296 matter what group it belongs to.  @kbd{M-^}
6297 (@code{gnus-summary-refer-article}) will ask you for a
6298 @code{Message-ID}, which is one of those long, hard-to-read thingies
6299 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6300 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6301
6302 @vindex gnus-refer-article-method
6303 If the group you are reading is located on a backend that does not
6304 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6305 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6306 would, perhaps, be best if the @sc{nntp} server you consult is the same
6307 as the one that keeps the spool you are reading from updated, but that's
6308 not really necessary.
6309
6310 Most of the mail backends support fetching by @code{Message-ID}, but do
6311 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6312 @code{nnbabyl} are able to locate articles from any groups, while
6313 @code{nnml} and @code{nnfolder} are only able to locate articles that
6314 have been posted to the current group.  (Anything else would be too time
6315 consuming.)  @code{nnmh} does not support this at all.
6316
6317
6318 @node Alternative Approaches
6319 @section Alternative Approaches
6320
6321 Different people like to read news using different methods.  This being
6322 Gnus, we offer a small selection of minor modes for the summary buffers.
6323
6324 @menu
6325 * Pick and Read::               First mark articles and then read them.
6326 * Binary Groups::               Auto-decode all articles.
6327 @end menu
6328
6329
6330 @node Pick and Read
6331 @subsection Pick and Read
6332 @cindex pick and read
6333
6334 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6335 reading interface.  The user first marks the articles she wants to read
6336 from a summary buffer.  Then she starts reading the articles with just
6337 an article buffer displayed.
6338
6339 @findex gnus-pick-mode
6340 @kindex M-x gnus-pick-mode
6341 Gnus provides a summary buffer minor mode that allows
6342 this---@code{gnus-pick-mode}.  This basically means that a few process
6343 mark commands become one-keystroke commands to allow easy marking, and
6344 it makes one additional command for switching to the summary buffer
6345 available. 
6346
6347 Here are the available keystrokes when using pick mode:
6348
6349 @table @kbd
6350 @item .
6351 @kindex . (Pick)
6352 @findex gnus-summary-mark-as-processable
6353 Pick the article on the current line
6354 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6355 go to the article on that line and pick that article.  (The line number
6356 is normally displayed on the beginning of the summary pick lines.)
6357
6358 @item SPACE
6359 @kindex SPACE (Pick)
6360 @findex gnus-pick-next-page
6361 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6362 at the end of the buffer, start reading the picked articles.
6363
6364 @item u
6365 @kindex u (Pick)
6366 @findex gnus-summary-unmark-as-processable
6367 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6368
6369 @item U
6370 @kindex U (Pick)
6371 @findex gnus-summary-unmark-all-processable
6372 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6373
6374 @item t
6375 @kindex t (Pick)
6376 @findex gnus-uu-mark-thread
6377 Pick the thread (@code{gnus-uu-mark-thread}). 
6378
6379 @item T
6380 @kindex T (Pick)
6381 @findex gnus-uu-unmark-thread
6382 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6383
6384 @item r
6385 @kindex r (Pick)
6386 @findex gnus-uu-mark-region
6387 Pick the region (@code{gnus-uu-mark-region}). 
6388
6389 @item R
6390 @kindex R (Pick)
6391 @findex gnus-uu-unmark-region
6392 Unpick the region (@code{gnus-uu-unmark-region}). 
6393
6394 @item e
6395 @kindex e (Pick)
6396 @findex gnus-uu-mark-by-regexp
6397 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6398
6399 @item E
6400 @kindex E (Pick)
6401 @findex gnus-uu-unmark-by-regexp
6402 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6403
6404 @item b
6405 @kindex b (Pick)
6406 @findex gnus-uu-mark-buffer
6407 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6408
6409 @item B
6410 @kindex B (Pick)
6411 @findex gnus-uu-unmark-buffer
6412 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6413
6414 @item RET
6415 @kindex RET (Pick)
6416 @findex gnus-pick-start-reading
6417 @vindex gnus-pick-display-summary
6418 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6419 given a prefix, mark all unpicked articles as read first.  If
6420 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6421 will still be visible when you are reading.
6422
6423 @end table
6424
6425 If this sounds like a good idea to you, you could say:
6426
6427 @lisp
6428 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6429 @end lisp
6430
6431 @vindex gnus-pick-mode-hook
6432 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6433
6434 @vindex gnus-mark-unpicked-articles-as-read
6435 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6436 all unpicked articles as read.  The default is @code{nil}.
6437
6438 @vindex gnus-summary-pick-line-format
6439 The summary line format in pick mode is slightly different than the
6440 standard format.  At the beginning of each line the line number is
6441 displayed.  The pick mode line format is controlled by the
6442 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6443 Variables}).  It accepts the same format specs that
6444 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6445
6446
6447 @node Binary Groups
6448 @subsection Binary Groups
6449 @cindex binary groups
6450
6451 @findex gnus-binary-mode
6452 @kindex M-x gnus-binary-mode
6453 If you spend much time in binary groups, you may grow tired of hitting
6454 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6455 is a minor mode for summary buffers that makes all ordinary Gnus article
6456 selection functions uudecode series of articles and display the result
6457 instead of just displaying the articles the normal way.  
6458
6459 @kindex g (Binary)
6460 @findex gnus-binary-show-article
6461 In fact, the only way to see the actual articles if you have turned this
6462 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6463
6464 @vindex gnus-binary-mode-hook
6465 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6466
6467
6468 @node Tree Display
6469 @section Tree Display
6470 @cindex trees
6471
6472 @vindex gnus-use-trees
6473 If you don't like the normal Gnus summary display, you might try setting
6474 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6475 additional @dfn{tree buffer}.  You can execute all summary mode commands
6476 in the tree buffer.  
6477
6478 There are a few variables to customize the tree display, of course:
6479
6480 @table @code
6481 @item gnus-tree-mode-hook
6482 @vindex gnus-tree-mode-hook
6483 A hook called in all tree mode buffers.
6484
6485 @item gnus-tree-mode-line-format
6486 @vindex gnus-tree-mode-line-format
6487 A format string for the mode bar in the tree mode buffers.  The default
6488 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6489 Buffer Mode Line}. 
6490
6491 @item gnus-selected-tree-face
6492 @vindex gnus-selected-tree-face
6493 Face used for highlighting the selected article in the tree buffer.  The
6494 default is @code{modeline}.
6495
6496 @item gnus-tree-line-format
6497 @vindex gnus-tree-line-format
6498 A format string for the tree nodes.  The name is a bit of a misnomer,
6499 though---it doesn't define a line, but just the node.  The default value
6500 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6501 the name of the poster.  It is vital that all nodes are of the same
6502 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6503
6504 Legal specs are:
6505
6506 @table @samp
6507 @item n
6508 The name of the poster.
6509 @item f
6510 The @code{From} header.
6511 @item N
6512 The number of the article.
6513 @item [
6514 The opening bracket.
6515 @item ] 
6516 The closing bracket.
6517 @item s
6518 The subject.
6519 @end table
6520
6521 @xref{Formatting Variables}.
6522
6523 Variables related to the display are:
6524
6525 @table @code
6526 @item gnus-tree-brackets
6527 @vindex gnus-tree-brackets
6528 This is used for differentiating between ``real'' articles and
6529 ``sparse'' articles.  The format is @var{((real-open . real-close)
6530 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6531 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6532
6533 @item gnus-tree-parent-child-edges
6534 @vindex gnus-tree-parent-child-edges
6535 This is a list that contains the characters used for connecting parent
6536 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6537
6538 @end table
6539
6540 @item gnus-tree-minimize-window
6541 @vindex gnus-tree-minimize-window
6542 If this variable is non-@code{nil}, Gnus will try to keep the tree
6543 buffer as small as possible to allow more room for the other Gnus
6544 windows.  If this variable is a number, the tree buffer will never be
6545 higher than that number.  The default is @code{t}.
6546
6547 @item gnus-generate-tree-function
6548 @vindex gnus-generate-tree-function
6549 @findex gnus-generate-horizontal-tree
6550 @findex gnus-generate-vertical-tree
6551 The function that actually generates the thread tree.  Two predefined
6552 functions are available: @code{gnus-generate-horizontal-tree} and
6553 @code{gnus-generate-vertical-tree} (which is the default).
6554
6555 @end table
6556
6557 Here's and example from a horizontal tree buffer:
6558
6559 @example
6560 @{***@}-(***)-[odd]-[Gun]
6561      |      \[Jan]
6562      |      \[odd]-[Eri]
6563      |      \(***)-[Eri]
6564      |            \[odd]-[Paa]
6565      \[Bjo]
6566      \[Gun]
6567      \[Gun]-[Jor]
6568 @end example
6569
6570 Here's the same thread displayed in a vertical tree buffer:
6571
6572 @example
6573 @{***@}
6574   |--------------------------\-----\-----\
6575 (***)                         [Bjo] [Gun] [Gun]
6576   |--\-----\-----\                          |
6577 [odd] [Jan] [odd] (***)                   [Jor]
6578   |           |     |--\
6579 [Gun]       [Eri] [Eri] [odd]
6580                           |
6581                         [Paa]
6582 @end example
6583
6584
6585 @node Mail Group Commands
6586 @section Mail Group Commands
6587 @cindex mail group commands
6588
6589 Some commands only make sense in mail groups.  If these commands are
6590 illegal in the current group, they will raise a hell and let you know.
6591
6592 All these commands (except the expiry and edit commands) use the
6593 process/prefix convention (@pxref{Process/Prefix}).
6594
6595 @table @kbd
6596
6597 @item B e
6598 @kindex B e (Summary)
6599 @findex gnus-summary-expire-articles
6600 Expire all expirable articles in the group
6601 (@code{gnus-summary-expire-articles}).
6602
6603 @item B M-C-e
6604 @kindex B M-C-e (Summary)
6605 @findex gnus-summary-expire-articles-now
6606 Delete all the expirable articles in the group
6607 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6608 articles that are eligible for expiry in the current group will
6609 disappear forever into that big @file{/dev/null} in the sky.
6610
6611 @item B DEL
6612 @kindex B DEL (Summary)
6613 @findex gnus-summary-delete-article
6614 Delete the mail article.  This is ``delete'' as in ``delete it from your
6615 disk forever and ever, never to return again.'' Use with caution.
6616 (@code{gnus-summary-delete-article}).
6617
6618 @item B m
6619 @kindex B m (Summary)
6620 @cindex move mail
6621 @findex gnus-summary-move-article
6622 Move the article from one mail group to another
6623 (@code{gnus-summary-move-article}). 
6624
6625 @item B c
6626 @kindex B c (Summary)
6627 @cindex copy mail
6628 @findex gnus-summary-copy-article
6629 Copy the article from one group (mail group or not) to a mail group
6630 (@code{gnus-summary-copy-article}).
6631
6632 @item B C
6633 @kindex B C (Summary)
6634 @cindex crosspost mail
6635 @findex gnus-summary-crosspost-article
6636 Crosspost the current article to some other group
6637 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6638 the article in the other group, and the Xref headers of the article will
6639 be properly updated.
6640
6641 @item B i
6642 @kindex B i (Summary)
6643 @findex gnus-summary-import-article
6644 Import an arbitrary file into the current mail newsgroup
6645 (@code{gnus-summary-import-article}).  You will be prompted for a file
6646 name, a @code{From} header and a @code{Subject} header.
6647
6648 @item B r
6649 @kindex B r (Summary)
6650 @findex gnus-summary-respool-article
6651 Respool the mail article (@code{gnus-summary-move-article}).
6652 @code{gnus-summary-respool-default-method} will be used as the default
6653 select method when respooling.  This variable is @code{nil} by default,
6654 which means that the current group select method will be used instead.
6655
6656 @item B w
6657 @itemx e
6658 @kindex B w (Summary)
6659 @kindex e (Summary)
6660 @findex gnus-summary-edit-article
6661 @kindex C-c C-c (Article)
6662 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6663 editing and make the changes permanent, type @kbd{C-c C-c}
6664 (@kbd{gnus-summary-edit-article-done}).
6665
6666 @item B q
6667 @kindex B q (Summary)
6668 @findex gnus-summary-respool-query
6669 If you want to re-spool an article, you might be curious as to what group
6670 the article will end up in before you do the re-spooling.  This command
6671 will tell you (@code{gnus-summary-respool-query}). 
6672
6673 @item B p
6674 @kindex B p (Summary)
6675 @findex gnus-summary-article-posted-p
6676 Some people have a tendency to send you "courtesy" copies when they
6677 follow up to articles you have posted.  These usually have a
6678 @code{Newsgroups} header in them, but not always.  This command
6679 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6680 article from your news server (or rather, from
6681 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6682 report back whether it found the article or not.  Even if it says that
6683 it didn't find the article, it may have been posted anyway---mail
6684 propagation is much faster than news propagation, and the news copy may
6685 just not have arrived yet.
6686
6687 @end table
6688
6689 @vindex gnus-move-split-methods
6690 @cindex moving articles
6691 If you move (or copy) articles regularly, you might wish to have Gnus
6692 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6693 variable that uses the same syntax as @code{gnus-split-methods}
6694 (@pxref{Saving Articles}).  You may customize that variable to create
6695 suggestions you find reasonable.
6696
6697 @lisp
6698 (setq gnus-move-split-methods
6699       '(("^From:.*Lars Magne" "nnml:junk")
6700         ("^Subject:.*gnus" "nnfolder:important")
6701         (".*" "nnml:misc")))
6702 @end lisp
6703
6704
6705 @node Various Summary Stuff
6706 @section Various Summary Stuff
6707
6708 @menu
6709 * Summary Group Information::         Information oriented commands.
6710 * Searching for Articles::            Multiple article commands.
6711 * Summary Generation Commands::       (Re)generating the summary buffer.
6712 * Really Various Summary Commands::   Those pesky non-conformant commands.
6713 @end menu
6714
6715 @table @code
6716 @vindex gnus-summary-mode-hook
6717 @item gnus-summary-mode-hook
6718 This hook is called when creating a summary mode buffer.
6719
6720 @vindex gnus-summary-generate-hook
6721 @item gnus-summary-generate-hook
6722 This is called as the last thing before doing the threading and the
6723 generation of the summary buffer.  It's quite convenient for customizing
6724 the threading variables based on what data the newsgroup has.  This hook
6725 is called from the summary buffer after most summary buffer variables
6726 has been set.
6727
6728 @vindex gnus-summary-prepare-hook
6729 @item gnus-summary-prepare-hook
6730 Is is called after the summary buffer has been generated.  You might use
6731 it to, for instance, highlight lines or modify the look of the buffer in
6732 some other ungodly manner.  I don't care.
6733
6734 @end table
6735
6736
6737 @node Summary Group Information
6738 @subsection Summary Group Information
6739
6740 @table @kbd
6741
6742 @item H f
6743 @kindex H f (Summary)
6744 @findex gnus-summary-fetch-faq
6745 @vindex gnus-group-faq-directory
6746 Try to fetch the FAQ (list of frequently asked questions) for the
6747 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6748 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6749 on a remote machine.  This variable can also be a list of directories.
6750 In that case, giving a prefix to this command will allow you to choose
6751 between the various sites.  @code{ange-ftp} probably will be used for
6752 fetching the file.
6753
6754 @item H d
6755 @kindex H d (Summary)
6756 @findex gnus-summary-describe-group
6757 Give a brief description of the current group
6758 (@code{gnus-summary-describe-group}).  If given a prefix, force
6759 rereading the description from the server.
6760
6761 @item H h
6762 @kindex H h (Summary)
6763 @findex gnus-summary-describe-briefly
6764 Give an extremely brief description of the most important summary
6765 keystrokes (@code{gnus-summary-describe-briefly}).
6766
6767 @item H i
6768 @kindex H i (Summary)
6769 @findex gnus-info-find-node
6770 Go to the Gnus info node (@code{gnus-info-find-node}).
6771 @end table
6772
6773
6774 @node Searching for Articles
6775 @subsection Searching for Articles
6776
6777 @table @kbd
6778
6779 @item M-s
6780 @kindex M-s (Summary)
6781 @findex gnus-summary-search-article-forward
6782 Search through all subsequent articles for a regexp
6783 (@code{gnus-summary-search-article-forward}). 
6784
6785 @item M-r
6786 @kindex M-r (Summary)
6787 @findex gnus-summary-search-article-backward
6788 Search through all previous articles for a regexp
6789 (@code{gnus-summary-search-article-backward}). 
6790
6791 @item &
6792 @kindex & (Summary)
6793 @findex gnus-summary-execute-command
6794 This command will prompt you for a header field, a regular expression to
6795 match on this field, and a command to be executed if the match is made
6796 (@code{gnus-summary-execute-command}).
6797
6798 @item M-&
6799 @kindex M-& (Summary)
6800 @findex gnus-summary-universal-argument
6801 Perform any operation on all articles that have been marked with
6802 the process mark (@code{gnus-summary-universal-argument}).
6803 @end table
6804
6805 @node Summary Generation Commands
6806 @subsection Summary Generation Commands
6807
6808 @table @kbd
6809
6810 @item Y g
6811 @kindex Y g (Summary)
6812 @findex gnus-summary-prepare
6813 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6814
6815 @item Y c 
6816 @kindex Y c (Summary)
6817 @findex gnus-summary-insert-cached-articles
6818 Pull all cached articles (for the current group) into the summary buffer
6819 (@code{gnus-summary-insert-cached-articles}).
6820
6821 @end table
6822
6823
6824 @node Really Various Summary Commands
6825 @subsection Really Various Summary Commands
6826
6827 @table @kbd
6828
6829 @item C-d
6830 @kindex C-d (Summary)
6831 @findex gnus-summary-enter-digest-group
6832 If the current article is a collection of other articles (for instance,
6833 a digest), you might use this command to enter a group based on the that
6834 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6835 guess what article type is currently displayed unless you give a prefix
6836 to this command, which forces a ``digest'' interpretation.  Basically,
6837 whenever you see a message that is a collection of other messages on
6838 some format, you @kbd{C-d} and read these messages in a more convenient
6839 fashion.
6840
6841 @item M-C-d
6842 @kindex M-C-d (Summary)
6843 @findex gnus-summary-read-document
6844 This command is very similar to the one above, but lets you gather
6845 several documents into one biiig group
6846 (@code{gnus-summary-read-document}).  It does this by opening several
6847 @code{nndoc} groups for each document, and then opening an
6848 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6849 command understands the process/prefix convention
6850 (@pxref{Process/Prefix}). 
6851
6852 @item C-t
6853 @kindex C-t (Summary)
6854 @findex gnus-summary-toggle-truncation
6855 Toggle truncation of summary lines
6856 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6857 line centering function in the summary buffer, so it's not a good idea
6858 to have truncation switched off while reading articles.
6859
6860 @item =
6861 @kindex = (Summary)
6862 @findex gnus-summary-expand-window
6863 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6864 If given a prefix, force an @code{article} window configuration. 
6865
6866 @end table
6867
6868
6869 @node Exiting the Summary Buffer
6870 @section Exiting the Summary Buffer
6871 @cindex summary exit
6872 @cindex exiting groups
6873
6874 Exiting from the summary buffer will normally update all info on the
6875 group and return you to the group buffer. 
6876
6877 @table @kbd
6878
6879 @item Z Z
6880 @itemx q
6881 @kindex Z Z (Summary)
6882 @kindex q (Summary)
6883 @findex gnus-summary-exit
6884 @vindex gnus-summary-exit-hook
6885 @vindex gnus-summary-prepare-exit-hook
6886 Exit the current group and update all information on the group
6887 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6888 called before doing much of the exiting, and calls
6889 @code{gnus-summary-expire-articles} by default.
6890 @code{gnus-summary-exit-hook} is called after finishing the exiting
6891 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
6892 group mode having no more (unread) groups.
6893
6894 @item Z E
6895 @itemx Q
6896 @kindex Z E (Summary)
6897 @kindex Q (Summary)
6898 @findex gnus-summary-exit-no-update
6899 Exit the current group without updating any information on the group
6900 (@code{gnus-summary-exit-no-update}).
6901
6902 @item Z c
6903 @itemx c
6904 @kindex Z c (Summary)
6905 @kindex c (Summary)
6906 @findex gnus-summary-catchup-and-exit
6907 Mark all unticked articles in the group as read and then exit
6908 (@code{gnus-summary-catchup-and-exit}).
6909
6910 @item Z C
6911 @kindex Z C (Summary)
6912 @findex gnus-summary-catchup-all-and-exit
6913 Mark all articles, even the ticked ones, as read and then exit
6914 (@code{gnus-summary-catchup-all-and-exit}).
6915
6916 @item Z n
6917 @kindex Z n (Summary)
6918 @findex gnus-summary-catchup-and-goto-next-group
6919 Mark all articles as read and go to the next group
6920 (@code{gnus-summary-catchup-and-goto-next-group}). 
6921
6922 @item Z R
6923 @kindex Z R (Summary)
6924 @findex gnus-summary-reselect-current-group
6925 Exit this group, and then enter it again
6926 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
6927 all articles, both read and unread.
6928
6929 @item Z G
6930 @itemx M-g
6931 @kindex Z G (Summary)
6932 @kindex M-g (Summary)
6933 @findex gnus-summary-rescan-group
6934 Exit the group, check for new articles in the group, and select the
6935 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
6936 articles, both read and unread.
6937
6938 @item Z N
6939 @kindex Z N (Summary)
6940 @findex gnus-summary-next-group
6941 Exit the group and go to the next group
6942 (@code{gnus-summary-next-group}). 
6943
6944 @item Z P
6945 @kindex Z P (Summary)
6946 @findex gnus-summary-prev-group
6947 Exit the group and go to the previous group
6948 (@code{gnus-summary-prev-group}). 
6949
6950 @item Z s
6951 @kindex Z s (Summary)
6952 @findex gnus-summary-save-newsrc
6953 Save the current number of read/marked articles in the dribble buffer
6954 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
6955 given a prefix, also save the @file{.newsrc} file(s).  Using this
6956 command will make exit without updating (the @kbd{Q} command) worthless.
6957 @end table
6958
6959 @vindex gnus-exit-group-hook
6960 @code{gnus-exit-group-hook} is called when you exit the current
6961 group.  
6962
6963 @findex gnus-summary-wake-up-the-dead
6964 @findex gnus-dead-summary-mode
6965 @vindex gnus-kill-summary-on-exit
6966 If you're in the habit of exiting groups, and then changing your mind
6967 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6968 If you do that, Gnus won't kill the summary buffer when you exit it.
6969 (Quelle surprise!)  Instead it will change the name of the buffer to
6970 something like @samp{*Dead Summary ... *} and install a minor mode
6971 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
6972 buffer, you'll find that all keys are mapped to a function called
6973 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
6974 summary buffer will result in a live, normal summary buffer.  
6975
6976 There will never be more than one dead summary buffer at any one time. 
6977
6978 @vindex gnus-use-cross-reference
6979 The data on the current group will be updated (which articles you have
6980 read, which articles you have replied to, etc.) when you exit the
6981 summary buffer.  If the @code{gnus-use-cross-reference} variable is
6982 @code{t} (which is the default), articles that are cross-referenced to
6983 this group and are marked as read, will also be marked as read in the
6984 other subscribed groups they were cross-posted to.  If this variable is
6985 neither @code{nil} nor @code{t}, the article will be marked as read in
6986 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
6987
6988
6989 @node Crosspost Handling
6990 @section Crosspost Handling
6991
6992 @cindex velveeta
6993 @cindex spamming
6994 Marking cross-posted articles as read ensures that you'll never have to
6995 read the same article more than once.  Unless, of course, somebody has
6996 posted it to several groups separately.  Posting the same article to
6997 several groups (not cross-posting) is called @dfn{spamming}, and you are
6998 by law required to send nasty-grams to anyone who perpetrates such a
6999 heinous crime.  You may want to try NoCeM handling to filter out spam
7000 (@pxref{NoCeM}). 
7001
7002 Remember: Cross-posting is kinda ok, but posting the same article
7003 separately to several groups is not.  Massive cross-posting (aka.
7004 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7005 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7006 excessive crossposting (@pxref{Summary Mail Commands}).
7007
7008 @cindex cross-posting
7009 @cindex Xref
7010 @cindex @sc{nov}
7011 One thing that may cause Gnus to not do the cross-posting thing
7012 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7013 (which is very nice, because it speeds things up considerably) which
7014 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7015 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7016 even with @sc{xover} by registering the @code{Xref} lines of all
7017 articles you actually read, but if you kill the articles, or just mark
7018 them as read without reading them, Gnus will not get a chance to snoop
7019 the @code{Xref} lines out of these articles, and will be unable to use
7020 the cross reference mechanism.
7021
7022 @cindex LIST overview.fmt
7023 @cindex overview.fmt
7024 To check whether your @sc{nntp} server includes the @code{Xref} header
7025 in its overview files, try @samp{telnet your.nntp.server nntp},
7026 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7027 overview.fmt}.  This may not work, but if it does, and the last line you
7028 get does not read @samp{Xref:full}, then you should shout and whine at
7029 your news admin until she includes the @code{Xref} header in the
7030 overview files.
7031
7032 @vindex gnus-nov-is-evil
7033 If you want Gnus to get the @code{Xref}s right all the time, you have to
7034 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7035 considerably.
7036
7037 C'est la vie.
7038
7039 For an alternative approach, @pxref{Duplicate Suppression}.
7040
7041
7042 @node Duplicate Suppression
7043 @section Duplicate Suppression
7044
7045 By default, Gnus tries to make sure that you don't have to read the same
7046 article more than once by utilizing the crossposting mechanism
7047 (@pxref{Crosspost Handling}).  However, that simple and efficient
7048 approach may not work satisfactorily for some users for various
7049 reasons.  
7050
7051 @enumerate
7052 @item 
7053 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7054 is evil and not very common.
7055
7056 @item 
7057 The @sc{nntp} server may fail to include the @code{Xref} header in the
7058 @file{.overview} data bases.  This is evil and all too common, alas.
7059
7060 @item
7061 You may be reading the same group (or several related groups) from
7062 different @sc{nntp} servers.
7063
7064 @item
7065 You may be getting mail that duplicates articles posted to groups.
7066 @end enumerate
7067
7068 I'm sure there are other situations that @code{Xref} handling fails as
7069 well, but these four are the most common situations.
7070
7071 If, and only if, @code{Xref} handling fails for you, then you may
7072 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7073 will remember the @code{Message-ID}s of all articles you have read or
7074 otherwise marked as read, and then, as if by magic, mark them as read
7075 all subsequent times you see them---in @emph{all} groups.  Using this
7076 mechanism is quite likely to be somewhat inefficient, but not overly
7077 so.  It's certainly preferable to reading the same articles more than
7078 once.
7079
7080 Duplicate suppression is not a very subtle instrument.  It's more like a
7081 sledge hammer than anything else.  It works in a very simple
7082 fashion---if you have marked an article as read, it adds this Message-ID
7083 to a cache.  The next time it sees this Message-ID, it will mark the
7084 article as read the the @samp{M} mark.  It doesn't care what group it
7085 saw the article in.
7086
7087 @table @code
7088 @item gnus-suppress-duplicates
7089 @vindex gnus-suppress-duplicates
7090 If non-@code{nil}, suppress duplicates.
7091
7092 @item gnus-save-duplicate-list
7093 @vindex gnus-save-duplicate-list
7094 If non-@code{nil}, save the list of duplicates to a file.  This will
7095 make startup and shutdown take longer, so the default is @code{nil}.
7096 However, this means that only duplicate articles that is read in a
7097 single Gnus session are suppressed.  
7098
7099 @item gnus-duplicate-list-length
7100 @vindex gnus-duplicate-list-length
7101 This variables says how many @code{Message-ID}s to keep in the duplicate
7102 suppression list.  The default is 10000.  
7103
7104 @item gnus-duplicate-file
7105 @vindex gnus-duplicate-file
7106 The name of the file to store the duplicate suppression list.  The
7107 default is @file{~/News/suppression}.
7108 @end table
7109
7110 If you have a tendency to stop and start Gnus often, setting
7111 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7112 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7113 the other hand, saving the list makes startup and shutdown much slower,
7114 so that means that if you stop and start Gnus often, you should set
7115 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7116 to you to figure out, I think.
7117
7118
7119 @node The Article Buffer
7120 @chapter The Article Buffer
7121 @cindex article buffer
7122
7123 The articles are displayed in the article buffer, of which there is only
7124 one.  All the summary buffers share the same article buffer unless you
7125 tell Gnus otherwise.
7126
7127 @menu
7128 * Hiding Headers::        Deciding what headers should be displayed.
7129 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7130 * Customizing Articles::  Tailoring the look of the articles.
7131 * Article Keymap::        Keystrokes available in the article buffer.
7132 * Misc Article::          Other stuff.
7133 @end menu
7134
7135
7136 @node Hiding Headers
7137 @section Hiding Headers
7138 @cindex hiding headers
7139 @cindex deleting headers
7140
7141 The top section of each article is the @dfn{head}.  (The rest is the
7142 @dfn{body}, but you may have guessed that already.)
7143
7144 @vindex gnus-show-all-headers
7145 There is a lot of useful information in the head: the name of the person
7146 who wrote the article, the date it was written and the subject of the
7147 article.  That's well and nice, but there's also lots of information
7148 most people do not want to see---what systems the article has passed
7149 through before reaching you, the @code{Message-ID}, the
7150 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7151 of some of those lines.  If you want to keep all those lines in the
7152 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7153
7154 Gnus provides you with two variables for sifting headers:
7155
7156 @table @code
7157
7158 @item gnus-visible-headers
7159 @vindex gnus-visible-headers
7160 If this variable is non-@code{nil}, it should be a regular expression
7161 that says what headers you wish to keep in the article buffer.  All
7162 headers that do not match this variable will be hidden.
7163
7164 For instance, if you only want to see the name of the person who wrote
7165 the article and the subject, you'd say:
7166
7167 @lisp
7168 (setq gnus-visible-headers "^From:\\|^Subject:")
7169 @end lisp
7170
7171 This variable can also be a list of regexps to match headers that are to
7172 remain visible.
7173
7174 @item gnus-ignored-headers
7175 @vindex gnus-ignored-headers
7176 This variable is the reverse of @code{gnus-visible-headers}.  If this
7177 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7178 should be a regular expression that matches all lines that you want to
7179 hide.  All lines that do not match this variable will remain visible.
7180
7181 For instance, if you just want to get rid of the @code{References} line
7182 and the @code{Xref} line, you might say:
7183
7184 @lisp
7185 (setq gnus-ignored-headers "^References:\\|^Xref:")
7186 @end lisp
7187
7188 This variable can also be a list of regexps to match headers that are to
7189 be removed.
7190
7191 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7192 variable will have no effect.
7193
7194 @end table
7195
7196 @vindex gnus-sorted-header-list
7197 Gnus can also sort the headers for you.  (It does this by default.)  You
7198 can control the sorting by setting the @code{gnus-sorted-header-list}
7199 variable.  It is a list of regular expressions that says in what order
7200 the headers are to be displayed.
7201
7202 For instance, if you want the name of the author of the article first,
7203 and then the subject, you might say something like:
7204
7205 @lisp
7206 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7207 @end lisp
7208
7209 Any headers that are to remain visible, but are not listed in this
7210 variable, will be displayed in random order after all the headers that
7211 are listed in this variable.
7212
7213 @findex gnus-article-hide-boring-headers
7214 @vindex gnus-article-display-hook
7215 @vindex gnus-boring-article-headers
7216 You can hide further boring headers by entering
7217 @code{gnus-article-hide-boring-headers} into
7218 @code{gnus-article-display-hook}.  What this function does depends on
7219 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7220 list doesn't actually contain header names.  Instead is lists various
7221 @dfn{boring conditions} that Gnus can check and remove from sight.
7222
7223 These conditions are:
7224 @table @code
7225 @item empty
7226 Remove all empty headers.
7227 @item newsgroups
7228 Remove the @code{Newsgroups} header if it only contains the current group
7229 name. 
7230 @item followup-to
7231 Remove the @code{Followup-To} header if it is identical to the
7232 @code{Newsgroups} header.
7233 @item reply-to
7234 Remove the @code{Reply-To} header if it lists the same address as the
7235 @code{From} header.
7236 @item date
7237 Remove the @code{Date} header if the article is less than three days
7238 old. 
7239 @end table
7240
7241 To include the four first elements, you could say something like;
7242
7243 @lisp
7244 (setq gnus-boring-article-headers 
7245       '(empty newsgroups followup-to reply-to))
7246 @end lisp
7247
7248 This is also the default value for this variable.
7249
7250
7251 @node Using MIME
7252 @section Using @sc{mime}
7253 @cindex @sc{mime}
7254
7255 Mime is a standard for waving your hands through the air, aimlessly,
7256 while people stand around yawning.
7257
7258 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7259 while all newsreaders die of fear.
7260
7261 @sc{mime} may specify what character set the article uses, the encoding
7262 of the characters, and it also makes it possible to embed pictures and
7263 other naughty stuff in innocent-looking articles.
7264
7265 @vindex gnus-show-mime
7266 @vindex gnus-show-mime-method
7267 @vindex gnus-strict-mime
7268 @findex metamail-buffer
7269 Gnus handles @sc{mime} by pushing the articles through
7270 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7271 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7272 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7273 non-@code{nil}, the @sc{mime} method will only be used if there are
7274 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7275 set, then you'll see some unfortunate display glitches in the article
7276 buffer.  These can't be avoided.
7277
7278 It might be best to just use the toggling functions from the summary
7279 buffer to avoid getting nasty surprises. (For instance, you enter the
7280 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7281 decoded the sound file in the article and some horrible sing-a-long song
7282 comes streaming out out your speakers, and you can't find the volume
7283 button, because there isn't one, and people are starting to look at you,
7284 and you try to stop the program, but you can't, and you can't find the
7285 program to control the volume, and everybody else in the room suddenly
7286 decides to look at you disdainfully, and you'll feel rather stupid.)
7287
7288 Any similarity to real events and people is purely coincidental.  Ahem.
7289
7290
7291 @node Customizing Articles
7292 @section Customizing Articles
7293 @cindex article customization
7294
7295 @vindex gnus-article-display-hook
7296 The @code{gnus-article-display-hook} is called after the article has
7297 been inserted into the article buffer.  It is meant to handle all
7298 treatment of the article before it is displayed. 
7299
7300 @findex gnus-article-maybe-highlight
7301 By default this hook just contains @code{gnus-article-hide-headers},
7302 @code{gnus-article-treat-overstrike}, and
7303 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7304 millions, of functions you can put in this hook.  For an overview of
7305 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7306 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7307 Date}.  Note that the order of functions in this hook might affect
7308 things, so you may have to fiddle a bit to get the desired results. 
7309
7310 You can, of course, write your own functions.  The functions are called
7311 from the article buffer, and you can do anything you like, pretty much.
7312 There is no information that you have to keep in the buffer---you can
7313 change everything.  However, you shouldn't delete any headers.  Instead
7314 make them invisible if you want to make them go away.
7315
7316
7317 @node Article Keymap
7318 @section Article Keymap
7319
7320 Most of the keystrokes in the summary buffer can also be used in the
7321 article buffer.  They should behave as if you typed them in the summary
7322 buffer, which means that you don't actually have to have a summary
7323 buffer displayed while reading.  You can do it all from the article
7324 buffer.
7325
7326 A few additional keystrokes are available:
7327
7328 @table @kbd
7329
7330 @item SPACE
7331 @kindex SPACE (Article)
7332 @findex gnus-article-next-page
7333 Scroll forwards one page (@code{gnus-article-next-page}).
7334
7335 @item DEL
7336 @kindex DEL (Article)
7337 @findex gnus-article-prev-page
7338 Scroll backwards one page (@code{gnus-article-prev-page}).
7339
7340 @item C-c ^
7341 @kindex C-c ^ (Article)
7342 @findex gnus-article-refer-article
7343 If point is in the neighborhood of a @code{Message-ID} and you press
7344 @kbd{r}, Gnus will try to get that article from the server
7345 (@code{gnus-article-refer-article}).
7346
7347 @item C-c C-m
7348 @kindex C-c C-m (Article)
7349 @findex gnus-article-mail
7350 Send a reply to the address near point (@code{gnus-article-mail}).  If
7351 given a prefix, include the mail.
7352
7353 @item s
7354 @kindex s (Article)
7355 @findex gnus-article-show-summary
7356 Reconfigure the buffers so that the summary buffer becomes visible
7357 (@code{gnus-article-show-summary}).
7358
7359 @item ?
7360 @kindex ? (Article)
7361 @findex gnus-article-describe-briefly
7362 Give a very brief description of the available keystrokes
7363 (@code{gnus-article-describe-briefly}). 
7364
7365 @item TAB
7366 @kindex TAB (Article)
7367 @findex gnus-article-next-button
7368 Go to the next button, if any (@code{gnus-article-next-button}.  This
7369 only makes sense if you have buttonizing turned on.
7370
7371 @item M-TAB
7372 @kindex M-TAB (Article)
7373 @findex gnus-article-prev-button
7374 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7375
7376 @end table
7377
7378
7379 @node Misc Article
7380 @section Misc Article
7381
7382 @table @code
7383
7384 @item gnus-single-article-buffer
7385 @vindex gnus-single-article-buffer
7386 If non-@code{nil}, use the same article buffer for all the groups.
7387 (This is the default.)  If @code{nil}, each group will have its own
7388 article buffer.
7389
7390 @vindex gnus-article-prepare-hook
7391 @item gnus-article-prepare-hook
7392 This hook is called right after the article has been inserted into the
7393 article buffer.  It is mainly intended for functions that do something
7394 depending on the contents; it should probably not be used for changing
7395 the contents of the article buffer.
7396
7397 @vindex gnus-article-display-hook
7398 @item gnus-article-display-hook
7399 This hook is called as the last thing when displaying an article, and is
7400 intended for modifying the contents of the buffer, doing highlights,
7401 hiding headers, and the like.
7402
7403 @item gnus-article-mode-hook
7404 @vindex gnus-article-mode-hook
7405 Hook called in article mode buffers.
7406
7407 @item gnus-article-mode-syntax-table
7408 @vindex gnus-article-mode-syntax-table
7409 Syntax table used in article buffers.  It is initialized from
7410 @code{text-mode-syntax-table}. 
7411
7412 @vindex gnus-article-mode-line-format
7413 @item gnus-article-mode-line-format
7414 This variable is a format string along the same lines as
7415 @code{gnus-summary-mode-line-format}.  It accepts the same
7416 format specifications as that variable, with one extension:
7417
7418 @table @samp
7419 @item w
7420 The @dfn{wash status} of the article.  This is a short string with one
7421 character for each possible article wash operation that may have been
7422 performed. 
7423 @end table
7424
7425 @vindex gnus-break-pages
7426
7427 @item gnus-break-pages
7428 Controls whether @dfn{page breaking} is to take place.  If this variable
7429 is non-@code{nil}, the articles will be divided into pages whenever a
7430 page delimiter appears in the article.  If this variable is @code{nil},
7431 paging will not be done.
7432
7433 @item gnus-page-delimiter
7434 @vindex gnus-page-delimiter
7435 This is the delimiter mentioned above.  By default, it is @samp{^L}
7436 (form linefeed).
7437 @end table
7438
7439
7440 @node Composing Messages
7441 @chapter Composing Messages
7442 @cindex reply
7443 @cindex followup
7444 @cindex post
7445
7446 @kindex C-c C-c (Post)
7447 All commands for posting and mailing will put you in a message buffer
7448 where you can edit the article all you like, before you send the article
7449 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7450 Manual}.  If you are in a foreign news group, and you wish to post the
7451 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7452 to make Gnus try to post using the foreign server.
7453
7454 @menu 
7455 * Mail::                 Mailing and replying.
7456 * Post::                 Posting and following up.
7457 * Posting Server::       What server should you post via?
7458 * Mail and Post::        Mailing and posting at the same time.
7459 * Archived Messages::    Where Gnus stores the messages you've sent.
7460 @c * Posting Styles::       An easier way to configure some key elements.
7461 @c * Drafts::               Postponing messages and rejected messages.
7462 @c * Rejected Articles::    What happens if the server doesn't like your article?
7463 @end menu
7464
7465 Also see @pxref{Canceling and Superseding} for information on how to
7466 remove articles you shouldn't have posted.
7467
7468
7469 @node Mail
7470 @section Mail
7471
7472 Variables for customizing outgoing mail:
7473
7474 @table @code
7475 @item gnus-uu-digest-headers
7476 @vindex gnus-uu-digest-headers
7477 List of regexps to match headers included in digested messages.  The
7478 headers will be included in the sequence they are matched.
7479
7480 @end table
7481
7482
7483 @node Post
7484 @section Post
7485
7486 Variables for composing news articles:
7487
7488 @table @code
7489 @item gnus-sent-message-ids-file
7490 @vindex gnus-sent-message-ids-file
7491 Gnus will keep a @code{Message-ID} history file of all the mails it has
7492 sent.  If it discovers that it has already sent a mail, it will ask the
7493 user whether to re-send the mail.  (This is primarily useful when
7494 dealing with @sc{soup} packets and the like where one is apt to sent the
7495 same packet multiple times.)  This variable says what the name of this
7496 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7497 this variable to @code{nil} if you don't want Gnus to keep a history
7498 file.
7499
7500 @item gnus-sent-message-ids-length
7501 @vindex gnus-sent-message-ids-length
7502 This variable says how many @code{Message-ID}s to keep in the history
7503 file.  It is 1000 by default.
7504
7505 @end table
7506
7507
7508 @node Posting Server
7509 @section Posting Server
7510
7511 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7512 (extremely intelligent, of course) article, where does it go?
7513
7514 Thank you for asking.  I hate you.
7515
7516 @vindex gnus-post-method
7517
7518 It can be quite complicated.  Normally, Gnus will use the same native
7519 server.  However.  If your native server doesn't allow posting, just
7520 reading, you probably want to use some other server to post your
7521 (extremely intelligent and fabulously interesting) articles.  You can
7522 then set the @code{gnus-post-method} to some other method:
7523
7524 @lisp
7525 (setq gnus-post-method '(nnspool ""))
7526 @end lisp
7527
7528 Now, if you've done this, and then this server rejects your article, or
7529 this server is down, what do you do then?  To override this variable you
7530 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7531 the ``current'' server for posting.
7532
7533 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7534 Gnus will prompt you for what method to use for posting.  
7535
7536 You can also set @code{gnus-post-method} to a list of select methods.
7537 If that's the case, Gnus will always prompt you for what method to use
7538 for posting. 
7539
7540
7541 @node Mail and Post
7542 @section Mail and Post
7543
7544 Here's a list of variables that are relevant to both mailing and
7545 posting:
7546
7547 @table @code
7548 @item gnus-mailing-list-groups
7549 @findex gnus-mailing-list-groups
7550 @cindex mailing lists
7551
7552 If your news server offers groups that are really mailing lists that are
7553 gatewayed to the @sc{nntp} server, you can read those groups without
7554 problems, but you can't post/followup to them without some difficulty.
7555 One solution is to add a @code{to-address} to the group parameters
7556 (@pxref{Group Parameters}).  An easier thing to do is set the
7557 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7558 really are mailing lists.  Then, at least, followups to the mailing
7559 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7560 still a pain, though.
7561
7562 @end table
7563
7564 You may want to do spell-checking on messages that you send out.  Or, if
7565 you don't want to spell-check by hand, you could add automatic
7566 spell-checking via the @code{ispell} package:
7567
7568 @cindex ispell
7569 @findex ispell-message
7570 @lisp
7571 (add-hook 'message-send-hook 'ispell-message) 
7572 @end lisp
7573
7574
7575 @node Archived Messages
7576 @section Archived Messages
7577 @cindex archived messages
7578 @cindex sent messages
7579
7580 Gnus provides a few different methods for storing the mail you send.
7581 The default method is to use the @dfn{archive virtual server} to store
7582 the mail.  If you want to disable this completely, the
7583 @code{gnus-message-archive-group} variable should be @code{nil}, which
7584 is the default.
7585
7586 @vindex gnus-message-archive-method
7587 @code{gnus-message-archive-method} says what virtual server Gnus is to
7588 use to store sent messages.  The default is:
7589
7590 @lisp
7591 (nnfolder "archive"
7592           (nnfolder-directory "~/Mail/archive/"))
7593 @end lisp
7594
7595 You can, however, use any mail select method (@code{nnml},
7596 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7597 for doing this sort of thing, though.  If you don't like the default
7598 directory chosen, you could say something like:
7599
7600 @lisp
7601 (setq gnus-message-archive-method
7602       '(nnfolder "archive" 
7603                  (nnfolder-inhibit-expiry t)
7604                  (nnfolder-active-file "~/News/sent-mail/active")
7605                  (nnfolder-directory "~/News/sent-mail/")))
7606 @end lisp
7607
7608 @vindex gnus-message-archive-group
7609 @cindex Gcc
7610 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7611 to one or more group(s) on that server.  Which group to use is
7612 determined by the @code{gnus-message-archive-group} variable.  
7613
7614 This variable can be:
7615
7616 @itemize @bullet
7617 @item a string
7618 Messages will be saved in that group.
7619 @item a list of strings
7620 Messages will be saved in all those groups.
7621 @item an alist of regexps, functions and forms
7622 When a key ``matches'', the result is used.
7623 @item @code{nil}
7624 No message archiving will take place.  This is the default.
7625 @end itemize
7626
7627 Let's illustrate:
7628
7629 Just saving to a single group called @samp{MisK}:
7630 @lisp
7631 (setq gnus-message-archive-group "MisK")
7632 @end lisp
7633
7634 Saving to two groups, @samp{MisK} and @samp{safe}:
7635 @lisp
7636 (setq gnus-message-archive-group '("MisK" "safe"))
7637 @end lisp
7638
7639 Save to different groups based on what group you are in:
7640 @lisp
7641 (setq gnus-message-archive-group 
7642       '(("^alt" "sent-to-alt")
7643         ("mail" "sent-to-mail")
7644         (".*" "sent-to-misc")))
7645 @end lisp
7646
7647 More complex stuff:
7648 @lisp
7649 (setq gnus-message-archive-group 
7650       '((if (message-news-p)
7651             "misc-news" 
7652           "misc-mail")))
7653 @end lisp       
7654
7655 How about storing all news messages in one file, but storing all mail
7656 messages in one file per month:
7657
7658 @lisp
7659 (setq gnus-message-archive-group
7660       '((if (message-news-p)
7661             "misc-news" 
7662           (concat "mail." (format-time-string 
7663                            "%Y-%m" (current-time))))))
7664 @end lisp
7665
7666 Now, when you send a message off, it will be stored in the appropriate
7667 group.  (If you want to disable storing for just one particular message,
7668 you can just remove the @code{Gcc} header that has been inserted.)  The
7669 archive group will appear in the group buffer the next time you start
7670 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7671 enter it and read the articles in it just like you'd read any other
7672 group.  If the group gets really big and annoying, you can simply rename
7673 if (using @kbd{G r} in the group buffer) to something
7674 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7675 continue to be stored in the old (now empty) group.
7676
7677 That's the default method of archiving sent mail.  Gnus also a different
7678 way for the people who don't like the default method.  In that case you
7679 should set @code{gnus-message-archive-group} to @code{nil}; this will
7680 disable archiving.
7681
7682 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7683 use a different value for @code{gnus-message-archive-group} there.
7684
7685 @table @code
7686 @item gnus-outgoing-message-group 
7687 @vindex gnus-outgoing-message-group 
7688 All outgoing messages will be put in this group.  If you want to store
7689 all your outgoing mail and articles in the group @samp{nnml:archive},
7690 you set this variable to that value.  This variable can also be a list of
7691 group names.
7692
7693 If you want to have greater control over what group to put each
7694 message in, you can set this variable to a function that checks the
7695 current newsgroup name and then returns a suitable group name (or list
7696 of names).
7697 @end table
7698
7699
7700 @c @node Posting Styles
7701 @c @section Posting Styles
7702 @c @cindex posting styles
7703 @c @cindex styles
7704 @c 
7705 @c All them variables, they make my head swim.  
7706 @c 
7707 @c So what if you want a different @code{Organization} and signature based
7708 @c on what groups you post to?  And you post both from your home machine
7709 @c and your work machine, and you want different @code{From} lines, and so
7710 @c on? 
7711 @c 
7712 @c @vindex gnus-posting-styles
7713 @c One way to do stuff like that is to write clever hooks that change the
7714 @c variables you need to have changed.  That's a bit boring, so somebody
7715 @c came up with the bright idea of letting the user specify these things in
7716 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7717 @c variable: 
7718 @c 
7719 @c @lisp
7720 @c ((".*" 
7721 @c   (signature . "Peace and happiness")
7722 @c   (organization . "What me?"))
7723 @c  ("^comp" 
7724 @c   (signature . "Death to everybody"))
7725 @c  ("comp.emacs.i-love-it" 
7726 @c   (organization . "Emacs is it")))
7727 @c @end lisp
7728 @c 
7729 @c As you might surmise from this example, this alist consists of several
7730 @c @dfn{styles}.  Each style will be applicable if the first element
7731 @c ``matches'', in some form or other.  The entire alist will be iterated
7732 @c over, from the beginning towards the end, and each match will be
7733 @c applied, which means that attributes in later styles that match override
7734 @c the same attributes in earlier matching styles.  So
7735 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7736 @c signature and the @samp{What me?} @code{Organization} header.
7737 @c 
7738 @c The first element in each style is called the @code{match}.  If it's a
7739 @c string, then Gnus will try to regexp match it against the group name.
7740 @c If it's a function symbol, that function will be called with no
7741 @c arguments.  If it's a variable symbol, then the variable will be
7742 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7743 @c any case, if this returns a non-@code{nil} value, then the style is said
7744 @c to @dfn{match}.
7745 @c 
7746 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7747 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7748 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7749 @c attribute name can also be a string.  In that case, this will be used as
7750 @c a header name, and the value will be inserted in the headers of the
7751 @c article.
7752 @c 
7753 @c The attribute value can be a string (used verbatim), a function (the
7754 @c return value will be used), a variable (its value will be used) or a
7755 @c list (it will be @code{eval}ed and the return value will be used).
7756 @c 
7757 @c So here's a new example:
7758 @c 
7759 @c @lisp
7760 @c (setq gnus-posting-styles
7761 @c       '((".*" 
7762 @c           (signature . "~/.signature") 
7763 @c           (from . "user@@foo (user)")
7764 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7765 @c           (organization . "People's Front Against MWM"))
7766 @c         ("^rec.humor" 
7767 @c           (signature . my-funny-signature-randomizer))
7768 @c         ((equal (system-name) "gnarly")
7769 @c           (signature . my-quote-randomizer))
7770 @c         (posting-from-work-p
7771 @c           (signature . "~/.work-signature")
7772 @c           (from . "user@@bar.foo (user)")
7773 @c           (organization . "Important Work, Inc"))
7774 @c         ("^nn.+:" 
7775 @c           (signature . "~/.mail-signature"))))
7776 @c @end lisp
7777
7778 @c @node Drafts
7779 @c @section Drafts
7780 @c @cindex drafts
7781 @c 
7782 @c If you are writing a message (mail or news) and suddenly remember that
7783 @c you have a steak in the oven (or some pesto in the food processor, you
7784 @c craazy vegetarians), you'll probably wish there was a method to save the
7785 @c message you are writing so that you can continue editing it some other
7786 @c day, and send it when you feel its finished.
7787 @c 
7788 @c Well, don't worry about it.  Whenever you start composing a message of
7789 @c some sort using the Gnus mail and post commands, the buffer you get will
7790 @c automatically associate to an article in a special @dfn{draft} group.
7791 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7792 @c article will be saved there.  (Auto-save files also go to the draft
7793 @c group.) 
7794 @c 
7795 @c @cindex nndraft
7796 @c @vindex gnus-draft-group-directory
7797 @c The draft group is a special group (which is implemented as an
7798 @c @code{nndraft} group, if you absolutely have to know) called
7799 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7800 @c controls both the name of the group and the location---the leaf element
7801 @c in the path will be used as the name of the group.  What makes this
7802 @c group special is that you can't tick any articles in it or mark any
7803 @c articles as read---all articles in the group are permanently unread.
7804 @c 
7805 @c If the group doesn't exist, it will be created and you'll be subscribed
7806 @c to it.
7807 @c 
7808 @c @findex gnus-dissociate-buffer-from-draft
7809 @c @kindex C-c M-d (Mail)
7810 @c @kindex C-c M-d (Post)
7811 @c @findex gnus-associate-buffer-with-draft
7812 @c @kindex C-c C-d (Mail)
7813 @c @kindex C-c C-d (Post)
7814 @c If you're writing some super-secret message that you later want to
7815 @c encode with PGP before sending, you may wish to turn the auto-saving
7816 @c (and association with the draft group) off.  You never know who might be
7817 @c interested in reading all your extremely valuable and terribly horrible
7818 @c and interesting secrets.  The @kbd{C-c M-d}
7819 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7820 @c If you change your mind and want to turn the auto-saving back on again,
7821 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7822 @c 
7823 @c @vindex gnus-use-draft
7824 @c To leave association with the draft group off by default, set
7825 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7826 @c 
7827 @c @findex gnus-summary-send-draft
7828 @c @kindex S D c (Summary)
7829 @c When you want to continue editing the article, you simply enter the
7830 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7831 @c that.  You will be placed in a buffer where you left off.
7832 @c 
7833 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7834 @c Articles}).
7835 @c 
7836 @c @findex gnus-summary-send-all-drafts
7837 @c If you have lots of rejected messages you want to post (or mail) without
7838 @c doing further editing, you can use the @kbd{S D a} command
7839 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7840 @c process/prefix convention (@pxref{Process/Prefix}).  
7841 @c 
7842 @c 
7843 @c @node Rejected Articles
7844 @c @section Rejected Articles
7845 @c @cindex rejected articles
7846 @c 
7847 @c Sometimes a news server will reject an article.  Perhaps the server
7848 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7849 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7850 @c Perhaps the disk is full.  Perhaps the server is down.
7851 @c 
7852 @c These situations are, of course, totally beyond the control of Gnus.
7853 @c (Gnus, of course, loves the way you look, always feels great, has angels
7854 @c fluttering around inside of it, doesn't care about how much cited text
7855 @c you include, never runs full and never goes down.)  So Gnus saves these
7856 @c articles until some later time when the server feels better.
7857 @c 
7858 @c The rejected articles will automatically be put in a special draft group
7859 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7860 @c typically enter that group and send all the articles off.
7861 @c 
7862
7863 @node Select Methods
7864 @chapter Select Methods
7865 @cindex foreign groups
7866 @cindex select methods
7867
7868 A @dfn{foreign group} is a group that is not read by the usual (or
7869 default) means.  It could be, for instance, a group from a different
7870 @sc{nntp} server, it could be a virtual group, or it could be your own
7871 personal mail group.
7872
7873 A foreign group (or any group, really) is specified by a @dfn{name} and
7874 a @dfn{select method}.  To take the latter first, a select method is a
7875 list where the first element says what backend to use (e.g. @code{nntp},
7876 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7877 name}.  There may be additional elements in the select method, where the
7878 value may have special meaning for the backend in question.
7879
7880 One could say that a select method defines a @dfn{virtual server}---so
7881 we do just that (@pxref{The Server Buffer}).
7882
7883 The @dfn{name} of the group is the name the backend will recognize the
7884 group as.
7885
7886 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7887 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7888 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7889 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7890 backend just knows this group as @samp{soc.motss}.
7891
7892 The different methods all have their peculiarities, of course.
7893
7894 @menu
7895 * The Server Buffer::     Making and editing virtual servers.
7896 * Getting News::          Reading USENET news with Gnus.
7897 * Getting Mail::          Reading your personal mail with Gnus.
7898 * Other Sources::         Reading directories, files, SOUP packets.
7899 * Combined Groups::       Combining groups into one group.
7900 @end menu
7901
7902
7903 @node The Server Buffer
7904 @section The Server Buffer
7905
7906 Traditionally, a @dfn{server} is a machine or a piece of software that
7907 one connects to, and then requests information from.  Gnus does not
7908 connect directly to any real servers, but does all transactions through
7909 one backend or other.  But that's just putting one layer more between
7910 the actual media and Gnus, so we might just as well say that each
7911 backend represents a virtual server.
7912
7913 For instance, the @code{nntp} backend may be used to connect to several
7914 different actual @sc{nntp} servers, or, perhaps, to many different ports
7915 on the same actual @sc{nntp} server.  You tell Gnus which backend to
7916 use, and what parameters to set by specifying a @dfn{select method}.
7917
7918 These select methods specifications can sometimes become quite
7919 complicated---say, for instance, that you want to read from the
7920 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7921 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
7922 Anyways, if you had to specify that for each group that used this
7923 server, that would be too much work, so Gnus offers a way of naming
7924 select methods, which is what you do in the server buffer.
7925
7926 To enter the server buffer, user the @kbd{^}
7927 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7928
7929 @menu
7930 * Server Buffer Format::      You can customize the look of this buffer.
7931 * Server Commands::           Commands to manipulate servers.
7932 * Example Methods::           Examples server specifications.
7933 * Creating a Virtual Server:: An example session.
7934 * Servers and Methods::       You can use server names as select methods.
7935 * Unavailable Servers::       Some servers you try to contact may be down.
7936 @end menu
7937
7938 @vindex gnus-server-mode-hook
7939 @code{gnus-server-mode-hook} is run when creating the server buffer.
7940
7941
7942 @node Server Buffer Format
7943 @subsection Server Buffer Format
7944 @cindex server buffer format
7945
7946 @vindex gnus-server-line-format
7947 You can change the look of the server buffer lines by changing the
7948 @code{gnus-server-line-format} variable.  This is a @code{format}-like
7949 variable, with some simple extensions:
7950
7951 @table @samp
7952
7953 @item h 
7954 How the news is fetched---the backend name.
7955
7956 @item n
7957 The name of this server.
7958
7959 @item w
7960 Where the news is to be fetched from---the address.
7961
7962 @item s
7963 The opened/closed/denied status of the server.
7964 @end table
7965
7966 @vindex gnus-server-mode-line-format
7967 The mode line can also be customized by using the
7968 @code{gnus-server-mode-line-format} variable.  The following specs are
7969 understood: 
7970
7971 @table @samp
7972 @item S
7973 Server name.
7974
7975 @item M
7976 Server method.
7977 @end table
7978
7979 Also @pxref{Formatting Variables}.
7980
7981
7982 @node Server Commands
7983 @subsection Server Commands
7984 @cindex server commands
7985
7986 @table @kbd
7987
7988 @item a
7989 @kindex a (Server)
7990 @findex gnus-server-add-server
7991 Add a new server (@code{gnus-server-add-server}).
7992
7993 @item e
7994 @kindex e (Server)
7995 @findex gnus-server-edit-server
7996 Edit a server (@code{gnus-server-edit-server}).
7997
7998 @item SPACE
7999 @kindex SPACE (Server)
8000 @findex gnus-server-read-server
8001 Browse the current server (@code{gnus-server-read-server}).
8002
8003 @item q
8004 @kindex q (Server)
8005 @findex gnus-server-exit
8006 Return to the group buffer (@code{gnus-server-exit}).
8007
8008 @item k
8009 @kindex k (Server)
8010 @findex gnus-server-kill-server
8011 Kill the current server (@code{gnus-server-kill-server}).
8012
8013 @item y
8014 @kindex y (Server)
8015 @findex gnus-server-yank-server
8016 Yank the previously killed server (@code{gnus-server-yank-server}).
8017
8018 @item c
8019 @kindex c (Server)
8020 @findex gnus-server-copy-server
8021 Copy the current server (@code{gnus-server-copy-server}).
8022
8023 @item l
8024 @kindex l (Server)
8025 @findex gnus-server-list-servers
8026 List all servers (@code{gnus-server-list-servers}).
8027
8028 @item s
8029 @kindex s (Server)
8030 @findex gnus-server-scan-server
8031 Request that the server scan its sources for new articles
8032 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8033 servers. 
8034
8035 @item g
8036 @kindex g (Server)
8037 @findex gnus-server-regenerate-server
8038 Request that the server regenerate all its data structures
8039 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8040 a mail backend that has gotten out of synch.
8041
8042 @end table
8043
8044
8045 @node Example Methods
8046 @subsection Example Methods
8047
8048 Most select methods are pretty simple and self-explanatory: 
8049
8050 @lisp
8051 (nntp "news.funet.fi")
8052 @end lisp
8053
8054 Reading directly from the spool is even simpler:
8055
8056 @lisp
8057 (nnspool "")
8058 @end lisp
8059
8060 As you can see, the first element in a select method is the name of the
8061 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8062 will. 
8063
8064 After these two elements, there may be a arbitrary number of
8065 @var{(variable form)} pairs.
8066
8067 To go back to the first example---imagine that you want to read from
8068 port 15 from that machine.  This is what the select method should
8069 look like then:
8070
8071 @lisp
8072 (nntp "news.funet.fi" (nntp-port-number 15))
8073 @end lisp
8074
8075 You should read the documentation to each backend to find out what
8076 variables are relevant, but here's an @code{nnmh} example. 
8077
8078 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8079 you have two structures that you wish to access: One is your private
8080 mail spool, and the other is a public one.  Here's the possible spec for
8081 you private mail:
8082
8083 @lisp
8084 (nnmh "private" (nnmh-directory "~/private/mail/"))
8085 @end lisp
8086
8087 (This server is then called @samp{private}, but you may have guessed
8088 that.)
8089
8090 Here's the method for a public spool:
8091
8092 @lisp
8093 (nnmh "public" 
8094       (nnmh-directory "/usr/information/spool/") 
8095       (nnmh-get-new-mail nil))
8096 @end lisp
8097
8098 If you are behind a firewall and only have access to the @sc{nntp}
8099 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8100 on the firewall machine and telnet from there to the @sc{nntp} server.
8101 Doing this can be rather fiddly, but your virtual server definition
8102 should probably look something like this:
8103
8104 @lisp
8105 (nntp "firewall"
8106       (nntp-address "the.firewall.machine")
8107       (nntp-open-connection-function nntp-open-rlogin)
8108       (nntp-end-of-line "\n")
8109       (nntp-rlogin-parameters
8110        ("telnet" "the.real.nntp.host" "nntp")))
8111 @end lisp
8112
8113
8114
8115 @node Creating a Virtual Server
8116 @subsection Creating a Virtual Server
8117
8118 If you're saving lots of articles in the cache by using persistent
8119 articles, you may want to create a virtual server to read the cache.
8120
8121 First you need to add a new server.  The @kbd{a} command does that.  It
8122 would probably be best to use @code{nnspool} to read the cache.  You
8123 could also use @code{nnml} or @code{nnmh}, though.
8124
8125 Type @kbd{a nnspool RET cache RET}.
8126
8127 You should now have a brand new @code{nnspool} virtual server called
8128 @samp{cache}.  You now need to edit it to have the right definitions.
8129 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8130 will contain the following:
8131
8132 @lisp
8133 (nnspool "cache")
8134 @end lisp
8135
8136 Change that to:
8137
8138 @lisp
8139 (nnspool "cache"
8140          (nnspool-spool-directory "~/News/cache/")
8141          (nnspool-nov-directory "~/News/cache/")
8142          (nnspool-active-file "~/News/cache/active"))
8143 @end lisp
8144
8145 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8146 @kbd{RET} over this virtual server, you should be entered into a browse
8147 buffer, and you should be able to enter any of the groups displayed.
8148
8149
8150 @node Servers and Methods
8151 @subsection Servers and Methods
8152
8153 Wherever you would normally use a select method
8154 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8155 when browsing a foreign server) you can use a virtual server name
8156 instead.  This could potentially save lots of typing.  And it's nice all
8157 over.
8158
8159
8160 @node Unavailable Servers
8161 @subsection Unavailable Servers
8162
8163 If a server seems to be unreachable, Gnus will mark that server as
8164 @code{denied}.  That means that any subsequent attempt to make contact
8165 with that server will just be ignored.  ``It can't be opened,'' Gnus
8166 will tell you, without making the least effort to see whether that is
8167 actually the case or not.
8168
8169 That might seem quite naughty, but it does make sense most of the time.
8170 Let's say you have 10 groups subscribed to the server
8171 @samp{nepholococcygia.com}.  This server is located somewhere quite far
8172 away from you, the machine is quite, so it takes 1 minute just to find
8173 out that it refuses connection from you today.  If Gnus were to attempt
8174 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8175 that.  Once it has gotten a single ``connection refused'', it will
8176 regard that server as ``down''.
8177
8178 So, what happens if the machine was only feeling unwell temporarily?
8179 How do you test to see whether the machine has come up again?
8180
8181 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8182 with the following commands:
8183
8184 @table @kbd
8185
8186 @item O
8187 @kindex O (Server)
8188 @findex gnus-server-open-server
8189 Try to establish connection to the server on the current line
8190 (@code{gnus-server-open-server}).
8191
8192 @item C
8193 @kindex C (Server)
8194 @findex gnus-server-close-server
8195 Close the connection (if any) to the server
8196 (@code{gnus-server-close-server}).
8197
8198 @item D
8199 @kindex D (Server)
8200 @findex gnus-server-deny-server
8201 Mark the current server as unreachable
8202 (@code{gnus-server-deny-server}). 
8203
8204 @item M-o
8205 @kindex M-o (Server)
8206 @findex gnus-server-open-all-servers
8207 Open the connections to all servers in the buffer
8208 (@code{gnus-server-open-all-servers}). 
8209
8210 @item M-c
8211 @kindex M-c (Server)
8212 @findex gnus-server-close-all-servers
8213 Close the connections to all servers in the buffer
8214 (@code{gnus-server-close-all-servers}). 
8215
8216 @item R
8217 @kindex R (Server)
8218 @findex gnus-server-remove-denials
8219 Remove all marks to whether Gnus was denied connection from all servers
8220 (@code{gnus-server-remove-denials}). 
8221
8222 @end table
8223
8224
8225 @node Getting News
8226 @section Getting News
8227 @cindex reading news
8228 @cindex news backends
8229
8230 A newsreader is normally used for reading news.  Gnus currently provides
8231 only two methods of getting news---it can read from an @sc{nntp} server,
8232 or it can read from a local spool.
8233
8234 @menu
8235 * NNTP::               Reading news from an @sc{nntp} server.
8236 * News Spool::         Reading news from the local spool.
8237 @end menu
8238
8239
8240 @node NNTP
8241 @subsection @sc{nntp}
8242 @cindex nntp
8243
8244 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8245 You just specify @code{nntp} as method and the address of the @sc{nntp}
8246 server as the, uhm, address.
8247
8248 If the @sc{nntp} server is located at a non-standard port, setting the
8249 third element of the select method to this port number should allow you
8250 to connect to the right port.  You'll have to edit the group info for
8251 that (@pxref{Foreign Groups}).
8252
8253 The name of the foreign group can be the same as a native group.  In
8254 fact, you can subscribe to the same group from as many different servers
8255 you feel like.  There will be no name collisions.
8256
8257 The following variables can be used to create a virtual @code{nntp}
8258 server: 
8259
8260 @table @code
8261
8262 @item nntp-server-opened-hook
8263 @vindex nntp-server-opened-hook
8264 @cindex @sc{mode reader}
8265 @cindex authinfo
8266 @cindex authentification
8267 @cindex nntp authentification
8268 @findex nntp-send-authinfo
8269 @findex nntp-send-mode-reader
8270 @code{nntp-server-opened-hook} is run after a connection has been made.
8271 It can be used to send commands to the @sc{nntp} server after it has
8272 been contacted.  By default is sends the command @code{MODE READER} to
8273 the server with the @code{nntp-send-mode-reader} function. 
8274
8275 @item nntp-authinfo-function 
8276 @vindex nntp-authinfo-function 
8277 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8278 server.  Available functions include:
8279
8280 @table @code
8281 @item nntp-send-authinfo
8282 @findex nntp-send-authinfo
8283 This function will used you current login name as the user name and will
8284 prompt you for the password.  This is the default.
8285
8286 @item nntp-send-nosy-authinfo
8287 @findex nntp-send-nosy-authinfo
8288 This function will prompt you for both user name and password.
8289
8290 @item nntp-send-authinfo-from-file
8291 @findex nntp-send-authinfo-from-file
8292 This function will use your current login name as the user name and will
8293 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8294 @end table
8295
8296 @item nntp-server-action-alist 
8297 @vindex nntp-server-action-alist 
8298 This is an list of regexps to match on server types and actions to be
8299 taken when matches are made.  For instance, if you want Gnus to beep
8300 every time you connect to innd, you could say something like:
8301
8302 @lisp
8303 (setq nntp-server-action-alist
8304       '(("innd" (ding))))
8305 @end lisp
8306
8307 You probably don't want to do that, though.
8308
8309 The default value is
8310
8311 @lisp
8312   '(("nntpd 1\\.5\\.11t" 
8313      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8314 @end lisp
8315
8316 This ensures that Gnus doesn't send the @code{MODE READER} command to
8317 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8318
8319 @item nntp-maximum-request
8320 @vindex nntp-maximum-request
8321 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8322 will collect headers by sending a series of @code{head} commands.  To
8323 speed things up, the backend sends lots of these commands without
8324 waiting for reply, and then reads all the replies.  This is controlled
8325 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8326 your network is buggy, you should set this to 1.
8327
8328 @item nntp-connection-timeout
8329 @vindex nntp-connection-timeout
8330 If you have lots of foreign @code{nntp} groups that you connect to
8331 regularly, you're sure to have problems with @sc{nntp} servers not
8332 responding properly, or being too loaded to reply within reasonable
8333 time.  This is can lead to awkward problems, which can be helped
8334 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8335 that says how many seconds the @code{nntp} backend should wait for a
8336 connection before giving up.  If it is @code{nil}, which is the default,
8337 no timeouts are done.
8338
8339 @item nntp-command-timeout
8340 @vindex nntp-command-timeout
8341 @cindex PPP connections
8342 @cindex dynamic IP addresses
8343 If you're running Gnus on a machine that has a dynamically assigned
8344 address, Gnus may become confused.  If the address of your machine
8345 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8346 waiting forever for replies from the server.  To help with this
8347 unfortunate problem, you can set this command to a number.  Gnus will
8348 then, if it sits waiting longer than that number of seconds for a reply
8349 from the server, shut down the connection, start a new one, and resend
8350 the command.  This should hopefully be transparent to the user.  A
8351 likely number is 30 seconds. 
8352
8353 @item nntp-retry-on-break
8354 @vindex nntp-retry-on-break
8355 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8356 hangs.  This will have much the same effect as the command timeout
8357 described above.
8358
8359 @item nntp-server-hook
8360 @vindex nntp-server-hook
8361 This hook is run as the last step when connecting to an @sc{nntp}
8362 server.
8363
8364 @findex nntp-open-rlogin
8365 @findex nntp-open-network-stream
8366 @item nntp-open-connection-function
8367 @vindex nntp-open-connection-function
8368 This function is used to connect to the remote system.  Two pre-made
8369 functions are @code{nntp-open-network-stream}, which is the default, and
8370 simply connects to some port or other on the remote system.  The other
8371 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8372 and then does a telnet to the @sc{nntp} server available there.
8373
8374 @item nntp-rlogin-parameters
8375 @vindex nntp-rlogin-parameters
8376 If you use @code{nntp-open-rlogin} as the
8377 @code{nntp-open-connection-function}, this list will be used as the
8378 parameter list given to @code{rsh}.
8379
8380 @item nntp-end-of-line
8381 @vindex nntp-end-of-line
8382 String to use as end-of-line markers when talking to the @sc{nntp}
8383 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8384 using @code{rlogin} to talk to the server.
8385
8386 @item nntp-rlogin-user-name
8387 @vindex nntp-rlogin-user-name
8388 User name on the remote system when using the @code{rlogin} connect
8389 function. 
8390
8391 @item nntp-address
8392 @vindex nntp-address
8393 The address of the remote system running the @sc{nntp} server.
8394
8395 @item nntp-port-number
8396 @vindex nntp-port-number
8397 Port number to connect to when using the @code{nntp-open-network-stream}
8398 connect function.
8399
8400 @item nntp-buggy-select
8401 @vindex nntp-buggy-select
8402 Set this to non-@code{nil} if your select routine is buggy.
8403
8404 @item nntp-nov-is-evil 
8405 @vindex nntp-nov-is-evil 
8406 If the @sc{nntp} server does not support @sc{nov}, you could set this
8407 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8408 can be used automatically.
8409
8410 @item nntp-xover-commands
8411 @vindex nntp-xover-commands
8412 @cindex nov
8413 @cindex XOVER
8414 List of strings that are used as commands to fetch @sc{nov} lines from a
8415 server.  The default value of this variable is @code{("XOVER"
8416 "XOVERVIEW")}. 
8417
8418 @item nntp-nov-gap
8419 @vindex nntp-nov-gap
8420 @code{nntp} normally sends just one big request for @sc{nov} lines to
8421 the server.  The server responds with one huge list of lines.  However,
8422 if you have read articles 2-5000 in the group, and only want to read
8423 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8424 lines that you do not want, and will not use.  This variable says how
8425 big a gap between two consecutive articles is allowed to be before the
8426 @code{XOVER} request is split into several request.  Note that if your
8427 network is fast, setting this variable to a really small number means
8428 that fetching will probably be slower.  If this variable is @code{nil},
8429 @code{nntp} will never split requests.
8430
8431 @item nntp-prepare-server-hook
8432 @vindex nntp-prepare-server-hook
8433 A hook run before attempting to connect to an @sc{nntp} server.
8434
8435 @item nntp-warn-about-losing-connection
8436 @vindex nntp-warn-about-losing-connection
8437 If this variable is non-@code{nil}, some noise will be made when a
8438 server closes connection.
8439
8440 @end table
8441
8442
8443 @node News Spool
8444 @subsection News Spool
8445 @cindex nnspool
8446 @cindex news spool
8447
8448 Subscribing to a foreign group from the local spool is extremely easy,
8449 and might be useful, for instance, to speed up reading groups that
8450 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8451 instance. 
8452
8453 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8454 anything else) as the address.
8455
8456 If you have access to a local spool, you should probably use that as the
8457 native select method (@pxref{Finding the News}).  It is normally faster
8458 than using an @code{nntp} select method, but might not be.  It depends.
8459 You just have to try to find out what's best at your site.
8460
8461 @table @code
8462
8463 @item nnspool-inews-program
8464 @vindex nnspool-inews-program
8465 Program used to post an article.
8466
8467 @item nnspool-inews-switches
8468 @vindex nnspool-inews-switches
8469 Parameters given to the inews program when posting an article. 
8470
8471 @item nnspool-spool-directory
8472 @vindex nnspool-spool-directory
8473 Where @code{nnspool} looks for the articles.  This is normally
8474 @file{/usr/spool/news/}.
8475
8476 @item nnspool-nov-directory 
8477 @vindex nnspool-nov-directory 
8478 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8479 @file{/usr/spool/news/over.view/}.
8480
8481 @item nnspool-lib-dir
8482 @vindex nnspool-lib-dir
8483 Where the news lib dir is (@file{/usr/lib/news/} by default).
8484
8485 @item nnspool-active-file
8486 @vindex nnspool-active-file
8487 The path of the active file.
8488
8489 @item nnspool-newsgroups-file
8490 @vindex nnspool-newsgroups-file
8491 The path of the group descriptions file.
8492
8493 @item nnspool-history-file
8494 @vindex nnspool-history-file
8495 The path of the news history file.
8496
8497 @item nnspool-active-times-file
8498 @vindex nnspool-active-times-file
8499 The path of the active date file.
8500
8501 @item nnspool-nov-is-evil
8502 @vindex nnspool-nov-is-evil
8503 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8504 that it finds.
8505
8506 @item nnspool-sift-nov-with-sed
8507 @vindex nnspool-sift-nov-with-sed
8508 @cindex sed
8509 If non-@code{nil}, which is the default, use @code{sed} to get the
8510 relevant portion from the overview file.  If nil, @code{nnspool} will
8511 load the entire file into a buffer and process it there.
8512
8513 @end table
8514
8515
8516 @node Getting Mail
8517 @section Getting Mail
8518 @cindex reading mail
8519 @cindex mail
8520
8521 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8522 course.
8523
8524 @menu
8525 * Getting Started Reading Mail:: A simple cookbook example.
8526 * Splitting Mail::               How to create mail groups.
8527 * Mail Backend Variables::       Variables for customizing mail handling.
8528 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8529 * Mail and Procmail::            Reading mail groups that procmail create.
8530 * Incorporating Old Mail::       What about the old mail you have?
8531 * Expiring Mail::                Getting rid of unwanted mail.
8532 * Washing Mail::                 Removing gruft from the mail you get.
8533 * Duplicates::                   Dealing with duplicated mail.
8534 * Not Reading Mail::             Using mail backends for reading other files.
8535 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8536 @end menu
8537
8538
8539 @node Getting Started Reading Mail
8540 @subsection Getting Started Reading Mail
8541
8542 It's quite easy to use Gnus to read your new mail.  You just plonk the
8543 mail backend of your choice into @code{gnus-secondary-select-methods},
8544 and things will happen automatically.
8545
8546 For instance, if you want to use @code{nnml} (which is a one file per
8547 mail backend), you could put the following in your @file{.gnus} file:
8548
8549 @lisp
8550 (setq gnus-secondary-select-methods
8551       '((nnml "private")))
8552 @end lisp
8553
8554 Now, the next time you start Gnus, this backend will be queried for new
8555 articles, and it will move all the messages in your spool file to its
8556 directory, which is @code{~/Mail/} by default.  The new group that will
8557 be created (@samp{mail.misc}) will be subscribed, and you can read it
8558 like any other group.
8559
8560 You will probably want to split the mail into several groups, though:
8561
8562 @lisp
8563 (setq nnmail-split-methods
8564       '(("junk" "^From:.*Lars Ingebrigtsen")
8565        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8566        ("other" "")))
8567 @end lisp
8568
8569 This will result in three new @code{nnml} mail groups being created:
8570 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8571 mail that doesn't fit into the first two groups will be placed in the
8572 latter group.
8573
8574 This should be sufficient for reading mail with Gnus.  You might want to
8575 give the other sections in this part of the manual a perusal, though,
8576 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8577
8578
8579 @node Splitting Mail
8580 @subsection Splitting Mail
8581 @cindex splitting mail
8582 @cindex mail splitting
8583
8584 @vindex nnmail-split-methods
8585 The @code{nnmail-split-methods} variable says how the incoming mail is
8586 to be split into groups.
8587
8588 @lisp
8589 (setq nnmail-split-methods
8590   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8591     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8592     ("mail.other" "")))
8593 @end lisp
8594
8595 This variable is a list of lists, where the first element of each of
8596 these lists is the name of the mail group (they do not have to be called
8597 something beginning with @samp{mail}, by the way), and the second
8598 element is a regular expression used on the header of each mail to
8599 determine if it belongs in this mail group.
8600
8601 If the first element is the special symbol @code{junk}, then messages
8602 that match the regexp will disappear into the aether.  Use with
8603 extreme caution. 
8604
8605 The second element can also be a function.  In that case, it will be
8606 called narrowed to the headers with the first element of the rule as the
8607 argument.  It should return a non-@code{nil} value if it thinks that the
8608 mail belongs in that group.
8609
8610 The last of these groups should always be a general one, and the regular
8611 expression should @emph{always} be @samp{} so that it matches any mails
8612 that haven't been matched by any of the other regexps.  (These rules are
8613 processed from the beginning of the alist toward the end.  The first
8614 rule to make a match will "win", unless you have crossposting enabled.
8615 In that case, all matching rules will "win".)
8616
8617 If you like to tinker with this yourself, you can set this variable to a
8618 function of your choice.  This function will be called without any
8619 arguments in a buffer narrowed to the headers of an incoming mail
8620 message.  The function should return a list of groups names that it
8621 thinks should carry this mail message.
8622
8623 Note that the mail backends are free to maul the poor, innocent
8624 incoming headers all they want to.  They all add @code{Lines} headers;
8625 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8626 @code{From<SPACE>} line to something else.
8627
8628 @vindex nnmail-crosspost
8629 The mail backends all support cross-posting.  If several regexps match,
8630 the mail will be ``cross-posted'' to all those groups.
8631 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8632 that no articles are crossposted to the general (@samp{}) group.
8633
8634 @vindex nnmail-crosspost-link-function
8635 @cindex crosspost
8636 @cindex links
8637 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8638 the crossposted articles.  However, not all files systems support hard
8639 links.  If that's the case for you, set
8640 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8641 variable is @code{add-name-to-file} by default.)  
8642
8643 @kindex M-x nnmail-split-history
8644 @kindex nnmail-split-history
8645 If you wish to see where the previous mail split put the messages, you
8646 can use the @kbd{M-x nnmail-split-history} command.
8647
8648 Gnus gives you all the opportunity you could possibly want for shooting
8649 yourself in the foot.  Let's say you create a group that will contain
8650 all the mail you get from your boss.  And then you accidentally
8651 unsubscribe from the group.  Gnus will still put all the mail from your
8652 boss in the unsubscribed group, and so, when your boss mails you ``Have
8653 that report ready by Monday or you're fired!'', you'll never see it and,
8654 come Tuesday, you'll still believe that you're gainfully employed while
8655 you really should be out collecting empty bottles to save up for next
8656 month's rent money.
8657
8658
8659 @node Mail Backend Variables
8660 @subsection Mail Backend Variables
8661
8662 These variables are (for the most part) pertinent to all the various
8663 mail backends.
8664
8665 @table @code
8666 @vindex nnmail-read-incoming-hook
8667 @item nnmail-read-incoming-hook
8668 The mail backends all call this hook after reading new mail.  You can
8669 use this hook to notify any mail watch programs, if you want to.
8670
8671 @vindex nnmail-spool-file
8672 @item nnmail-spool-file
8673 @cindex POP mail
8674 @cindex MAILHOST
8675 @cindex movemail
8676 @vindex nnmail-pop-password
8677 @vindex nnmail-pop-password-required
8678 The backends will look for new mail in this file.  If this variable is
8679 @code{nil}, the mail backends will never attempt to fetch mail by
8680 themselves.  If you are using a POP mail server and your name is
8681 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8682 your name is not @samp{larsi}, you should probably modify that
8683 slightly, but you may have guessed that already, you smart & handsome
8684 devil!  You can also set this variable to @code{pop}, and Gnus will try
8685 to figure out the POP mail string by itself.  In any case, Gnus will
8686 call @code{movemail} which will contact the POP server named in the
8687 @code{MAILHOST} environment variable.  If the POP server needs a
8688 password, you can either set @code{nnmail-pop-password-required} to
8689 @code{t} and be prompted for the password, or set
8690 @code{nnmail-pop-password} to the password itself.
8691
8692 @code{nnmail-spool-file} can also be a list of mailboxes.
8693
8694 Your Emacs has to have been configured with @samp{--with-pop} before
8695 compilation.  This is the default, but some installations have it
8696 switched off.
8697
8698 When you use a mail backend, Gnus will slurp all your mail from your
8699 inbox and plonk it down in your home directory.  Gnus doesn't move any
8700 mail if you're not using a mail backend---you have to do a lot of magic
8701 invocations first.  At the time when you have finished drawing the
8702 pentagram, lightened the candles, and sacrificed the goat, you really
8703 shouldn't be too surprised when Gnus moves your mail.
8704
8705 @vindex nnmail-use-procmail
8706 @vindex nnmail-procmail-suffix
8707 @item nnmail-use-procmail
8708 If non-@code{nil}, the mail backends will look in
8709 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8710 that directory that have names ending in @code{nnmail-procmail-suffix}
8711 will be considered incoming mailboxes, and will be searched for new
8712 mail.
8713
8714 @vindex nnmail-crash-box
8715 @item nnmail-crash-box
8716 When the mail backends read a spool file, it is first moved to this
8717 file, which is @file{~/.gnus-crash-box} by default.  If this file
8718 already exists, it will always be read (and incorporated) before any
8719 other spool files.
8720
8721 @vindex nnmail-prepare-incoming-hook
8722 @item nnmail-prepare-incoming-hook
8723 This is run in a buffer that holds all the new incoming mail, and can be
8724 used for, well, anything, really.
8725
8726 @vindex nnmail-split-hook
8727 @item nnmail-split-hook
8728 @findex article-decode-rfc1522
8729 @findex RFC1522 decoding
8730 Hook run in the buffer where the mail headers of each message is kept
8731 just before the splitting based on these headers is done.  The hook is
8732 free to modify the buffer contents in any way it sees fit---the buffer
8733 is discarded after the splitting has been done, and no changes performed
8734 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
8735 is one likely function to add to this hook.
8736
8737 @vindex nnmail-pre-get-new-mail-hook
8738 @vindex nnmail-post-get-new-mail-hook
8739 @item nnmail-pre-get-new-mail-hook
8740 @itemx nnmail-post-get-new-mail-hook
8741 These are two useful hooks executed when treating new incoming
8742 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8743 starting to handle the new mail) and
8744 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8745 is done).  Here's and example of using these two hooks to change the
8746 default file modes the new mail files get:
8747
8748 @lisp
8749 (add-hook 'gnus-pre-get-new-mail-hook 
8750           (lambda () (set-default-file-modes 511)))
8751
8752 (add-hook 'gnus-post-get-new-mail-hook 
8753           (lambda () (set-default-file-modes 551)))
8754 @end lisp
8755
8756 @item nnmail-tmp-directory
8757 @vindex nnmail-tmp-directory
8758 This variable says where to move the incoming mail to while processing
8759 it.  This is usually done in the same directory that the mail backend
8760 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8761 it will be used instead.
8762
8763 @item nnmail-movemail-program
8764 @vindex nnmail-movemail-program
8765 This program is executed to move mail from the user's inbox to her home
8766 directory.  The default is @samp{movemail}.
8767
8768 This can also be a function.  In that case, the function will be called
8769 with two parameters -- the name of the inbox, and the file to be moved
8770 to.
8771
8772 @item nnmail-delete-incoming
8773 @vindex nnmail-delete-incoming
8774 @cindex incoming mail files
8775 @cindex deleting incoming files
8776 If non-@code{nil}, the mail backends will delete the temporary incoming
8777 file after splitting mail into the proper groups.  This is @code{nil} by
8778 default for reasons of security.
8779
8780 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8781 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8782 lost mail, I think, but that's not the point.  (Except certain versions
8783 of Red Gnus.))  By not deleting the Incoming* files, one can be sure to
8784 not lose mail -- if Gnus totally whacks out, one can always recover what
8785 was lost.
8786
8787 Delete the @file{Incoming*} files at will.
8788
8789 @item nnmail-use-long-file-names
8790 @vindex nnmail-use-long-file-names
8791 If non-@code{nil}, the mail backends will use long file and directory
8792 names.  Groups like @samp{mail.misc} will end up in directories like
8793 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8794 @file{mail/misc/}.
8795
8796 @item nnmail-delete-file-function
8797 @vindex nnmail-delete-file-function
8798 @findex delete-file
8799 Function called to delete files.  It is @code{delete-file} by default. 
8800
8801 @end table
8802
8803
8804 @node Fancy Mail Splitting
8805 @subsection Fancy Mail Splitting
8806 @cindex mail splitting
8807 @cindex fancy mail splitting
8808
8809 @vindex nnmail-split-fancy
8810 @findex nnmail-split-fancy
8811 If the rather simple, standard method for specifying how to split mail
8812 doesn't allow you to do what you want, you can set
8813 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8814 play with the @code{nnmail-split-fancy} variable.
8815
8816 Let's look at an example value of this variable first:
8817
8818 @lisp
8819 ;; Messages from the mailer daemon are not crossposted to any of
8820 ;; the ordinary groups.  Warnings are put in a separate group
8821 ;; from real errors.
8822 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8823                    "mail.misc"))
8824    ;; Non-error messages are crossposted to all relevant
8825    ;; groups, but we don't crosspost between the group for the
8826    ;; (ding) list and the group for other (ding) related mail.
8827    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8828          ("subject" "ding" "ding.misc"))
8829       ;; Other mailing lists...
8830       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8831       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8832       ;; People...
8833       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8834    ;; Unmatched mail goes to the catch all group.
8835    "misc.misc")
8836 @end lisp
8837
8838 This variable has the format of a @dfn{split}.  A split is a (possibly)
8839 recursive structure where each split may contain other splits.  Here are
8840 the five possible split syntaxes:
8841
8842 @enumerate
8843
8844 @item 
8845 @samp{group}: If the split is a string, that will be taken as a group name. 
8846
8847 @item
8848 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8849 element is a string, then that means that if header FIELD (a regexp)
8850 contains VALUE (also a regexp), then store the message as specified by
8851 SPLIT.
8852
8853 @item
8854 @var{(| SPLIT...)}: If the split is a list, and the first element is
8855 @code{|} (vertical bar), then process each SPLIT until one of them
8856 matches.  A SPLIT is said to match if it will cause the mail message to
8857 be stored in one or more groups.
8858
8859 @item
8860 @var{(& SPLIT...)}: If the split is a list, and the first element is
8861 @code{&}, then process all SPLITs in the list.
8862
8863 @item 
8864 @code{junk}: If the split is the symbol @code{junk}, then don't save
8865 this message anywhere.
8866
8867 @item
8868 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
8869 element is @code{:}, then the second element will be called as a
8870 function with @var{args} given as arguments.  The function should return
8871 a SPLIT.
8872
8873 @end enumerate
8874
8875 In these splits, @var{FIELD} must match a complete field name.
8876 @var{VALUE} must match a complete word according to the fundamental mode
8877 syntax table.  You can use @code{.*} in the regexps to match partial
8878 field names or words.  In other words, all @var{VALUE}'s are wrapped in
8879 @samp{\<} and @samp{\>} pairs.
8880
8881 @vindex nnmail-split-abbrev-alist
8882 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8883 are expanded as specified by the variable
8884 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
8885 the car of the cells contains the key, and the cdr contains a string.
8886
8887 @vindex nnmail-split-fancy-syntax-table
8888 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8889 when all this splitting is performed.
8890
8891 If you want to have Gnus create groups dynamically based on some
8892 information in the headers, you can say things like:
8893
8894 @example
8895 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8896 @end example
8897
8898 That is, do @code{replace-match}-like substitions in the group names. 
8899
8900
8901 @node Mail and Procmail
8902 @subsection Mail and Procmail
8903 @cindex procmail
8904
8905 @cindex slocal
8906 @cindex elm
8907 Many people use @code{procmail} (or some other mail filter program or
8908 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8909 incoming mail into groups.  If you do that, you should set
8910 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8911 backends never ever try to fetch mail by themselves.
8912
8913 This also means that you probably don't want to set
8914 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8915 side effects.
8916
8917 When a mail backend is queried for what groups it carries, it replies
8918 with the contents of that variable, along with any groups it has figured
8919 out that it carries by other means.  None of the backends (except
8920 @code{nnmh}) actually go out to the disk and check what groups actually
8921 exist.  (It's not trivial to distinguish between what the user thinks is
8922 a basis for a newsgroup and what is just a plain old file or directory.)
8923
8924 This means that you have to tell Gnus (and the backends) what groups
8925 exist by hand.
8926
8927 Let's take the @code{nnmh} backend as an example. 
8928
8929 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8930 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8931
8932 Go to the group buffer and type @kbd{G m}.  When prompted, answer
8933 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
8934 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
8935 to include all your mail groups.
8936
8937 That's it.  You are now set to read your mail.  An active file for this
8938 method will be created automatically.
8939
8940 @vindex nnmail-procmail-suffix
8941 @vindex nnmail-procmail-directory
8942 If you use @code{nnfolder} or any other backend that store more than a
8943 single article in each file, you should never have procmail add mails to
8944 the file that Gnus sees.  Instead, procmail should put all incoming mail
8945 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
8946 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
8947 name.  The mail backends will read the mail from these files.
8948
8949 @vindex nnmail-resplit-incoming
8950 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
8951 put in the @code{mail.misc}, as one would expect.  However, if you want
8952 Gnus to split the mail the normal way, you could set
8953 @code{nnmail-resplit-incoming} to @code{t}.
8954
8955 @vindex nnmail-keep-last-article
8956 If you use @code{procmail} to split things directory into an @code{nnmh}
8957 directory (which you shouldn't do), you should set
8958 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
8959 ever expiring the final article in a mail newsgroup.  This is quite,
8960 quite important.
8961
8962 Here's an example setup:  The incoming spools are located in
8963 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
8964 spool files have the same names as the equivalent groups).  The
8965 @code{nnfolder} backend is to be used as the mail interface, and the
8966 @code{nnfolder} directory is @file{~/fMail/}.
8967
8968 @lisp
8969 (setq nnfolder-directory "~/fMail/")
8970 (setq nnmail-spool-file 'procmail)
8971 (setq nnmail-procmail-directory "~/incoming/")
8972 (setq gnus-secondary-select-methods '((nnfolder "")))
8973 (setq nnmail-procmail-suffix "")
8974 @end lisp
8975
8976
8977 @node Incorporating Old Mail
8978 @subsection Incorporating Old Mail
8979
8980 Most people have lots of old mail stored in various file formats.  If
8981 you have set up Gnus to read mail using one of the spiffy Gnus mail
8982 backends, you'll probably wish to have that old mail incorporated into
8983 your mail groups.
8984
8985 Doing so can be quite easy.
8986
8987 To take an example: You're reading mail using @code{nnml}
8988 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
8989 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
8990 file filled with important, but old, mail.  You want to move it into
8991 your @code{nnml} groups.
8992
8993 Here's how:
8994
8995 @enumerate
8996 @item
8997 Go to the group buffer.
8998
8999 @item 
9000 Type `G f' and give the path of the mbox file when prompted to create an
9001 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9002
9003 @item 
9004 Type `SPACE' to enter the newly created group.
9005
9006 @item
9007 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9008 Process Marks}).
9009
9010 @item 
9011 Type `B r' to respool all the process-marked articles, and answer
9012 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9013 @end enumerate
9014
9015 All the mail messages in the mbox file will now also be spread out over
9016 all your @code{nnml} groups.  Try entering them and check whether things
9017 have gone without a glitch.  If things look ok, you may consider
9018 deleting the mbox file, but I wouldn't do that unless I was absolutely
9019 sure that all the mail has ended up where it should be.
9020
9021 Respooling is also a handy thing to do if you're switching from one mail
9022 backend to another.  Just respool all the mail in the old mail groups
9023 using the new mail backend.
9024
9025
9026 @node Expiring Mail
9027 @subsection Expiring Mail
9028 @cindex article expiry
9029
9030 Traditional mail readers have a tendency to remove mail articles when
9031 you mark them as read, in some way.  Gnus takes a fundamentally
9032 different approach to mail reading.
9033
9034 Gnus basically considers mail just to be news that has been received in
9035 a rather peculiar manner.  It does not think that it has the power to
9036 actually change the mail, or delete any mail messages.  If you enter a
9037 mail group, and mark articles as ``read'', or kill them in some other
9038 fashion, the mail articles will still exist on the system.  I repeat:
9039 Gnus will not delete your old, read mail.  Unless you ask it to, of
9040 course.
9041
9042 To make Gnus get rid of your unwanted mail, you have to mark the
9043 articles as @dfn{expirable}.  This does not mean that the articles will
9044 disappear right away, however.  In general, a mail article will be
9045 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9046 more than one week old.  If you do not mark an article as expirable, it
9047 will remain on your system until hell freezes over.  This bears
9048 repeating one more time, with some spurious capitalizations: IF you do
9049 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9050
9051 @vindex gnus-auto-expirable-newsgroups
9052 You do not have to mark articles as expirable by hand.  Groups that
9053 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9054 have all articles that you read marked as expirable automatically.  All
9055 articles that are marked as expirable have an @samp{E} in the first
9056 column in the summary buffer.
9057
9058 Note that making a group auto-expirable don't mean that all read
9059 articles are expired---only the articles that are marked as expirable
9060 will be expired.  Also note the using the @kbd{d} command won't make
9061 groups expirable---only semi-automatic marking of articles as read will
9062 mark the articles as expirable in auto-expirable groups.
9063
9064 Let's say you subscribe to a couple of mailing lists, and you want the
9065 articles you have read to disappear after a while:
9066
9067 @lisp
9068 (setq gnus-auto-expirable-newsgroups 
9069       "mail.nonsense-list\\|mail.nice-list")
9070 @end lisp
9071
9072 Another way to have auto-expiry happen is to have the element
9073 @code{auto-expire} in the group parameters of the group. 
9074
9075 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9076 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9077 doesn't really mix very well.  
9078
9079 @vindex nnmail-expiry-wait
9080 The @code{nnmail-expiry-wait} variable supplies the default time an
9081 expirable article has to live.  The default is seven days.  
9082
9083 Gnus also supplies a function that lets you fine-tune how long articles
9084 are to live, based on what group they are in.  Let's say you want to
9085 have one month expiry period in the @samp{mail.private} group, a one day
9086 expiry period in the @samp{mail.junk} group, and a six day expiry period
9087 everywhere else:
9088
9089 @vindex nnmail-expiry-wait-function
9090 @lisp
9091 (setq nnmail-expiry-wait-function
9092       (lambda (group)
9093        (cond ((string= group "mail.private")
9094                31)
9095              ((string= group "mail.junk")
9096                1)
9097              ((string= group "important")
9098                'never)
9099              (t
9100                6))))
9101 @end lisp
9102
9103 The group names that this function is fed are ``unadorned'' group
9104 names---no @samp{nnml:} prefixes and the like.
9105
9106 The @code{nnmail-expiry-wait} variable and
9107 @code{nnmail-expiry-wait-function} function can be either a number (not
9108 necessarily an integer) or the symbols @code{immediate} or
9109 @code{never}.  
9110
9111 You can also use the @code{expiry-wait} group parameter to selectively
9112 change the expiry period (@pxref{Group Parameters}).
9113
9114 @vindex nnmail-keep-last-article
9115 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9116 expire the final article in a mail newsgroup.  This is to make life
9117 easier for procmail users.
9118
9119 @vindex gnus-total-expirable-newsgroups
9120 By the way, that line up there about Gnus never expiring non-expirable
9121 articles is a lie.  If you put @code{total-expire} in the group
9122 parameters, articles will not be marked as expirable, but all read
9123 articles will be put through the expiry process.  Use with extreme
9124 caution.  Even more dangerous is the
9125 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9126 this regexp will have all read articles put through the expiry process,
9127 which means that @emph{all} old mail articles in the groups in question
9128 will be deleted after a while.  Use with extreme caution, and don't come
9129 crying to me when you discover that the regexp you used matched the
9130 wrong group and all your important mail has disappeared.  Be a
9131 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9132 with!  So there!
9133
9134 Most people make most of their mail groups total-expirable, though. 
9135
9136
9137 @node Washing Mail
9138 @subsection Washing Mail
9139 @cindex mail washing
9140 @cindex list server brain damage
9141 @cindex incoming mail treatment
9142
9143 Mailers and list servers are notorious for doing all sorts of really,
9144 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9145 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9146 end of all lines passing through our server, so let's do that!!!!1!''
9147 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9148 considered to be self-evident were not discussed.  So.  Here we are.
9149
9150 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9151 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9152 be shocked and dismayed by this, but I haven't got the energy.  It is to
9153 laugh.
9154
9155 Gnus provides a plethora of functions for washing articles while
9156 displaying them, but it might be nicer to do the filtering before
9157 storing the mail to disc.  For that purpose, we have three hooks and
9158 various functions that can be put in these hooks.
9159
9160 @table @code
9161 @item nnmail-prepare-incoming-hook
9162 @vindex nnmail-prepare-incoming-hook
9163 This hook is called before doing anything with the mail and is meant for
9164 grand, sweeping gestures.  Functions to be used include:
9165
9166 @table @code
9167 @item nnheader-ms-strip-cr
9168 @findex nnheader-ms-strip-cr
9169 Remove trailing carriage returns from each line.  This is default on
9170 Emacs running on MS machines.
9171
9172 @end table
9173
9174 @item nnmail-prepare-incoming-header-hook
9175 @vindex nnmail-prepare-incoming-header-hook
9176 This hook is called narrowed to each header.  It can be used when
9177 cleaning up the headers.  Functions that can be used include:
9178
9179 @table @code
9180 @item nnmail-remove-leading-whitespace
9181 @findex nnmail-remove-leading-whitespace
9182 Clear leading white space that ``helpful'' listservs have added to the
9183 headers too make them look nice.  Aaah.  
9184
9185 @item nnmail-remove-list-identifiers
9186 @findex nnmail-remove-list-identifiers
9187 Some list servers add an identifier---for example, @samp{(idm)}---to the
9188 beginning of all @code{Subject} headers.  I'm sure that's nice for
9189 people who use stone age mail readers.  This function will remove
9190 strings that match the @code{nnmail-list-identifiers} regexp, which can
9191 also be a list of regexp.
9192
9193 For instance, if you want to remove the @samp{(idm)} and the
9194 @samp{nagnagnag} identifiers:
9195
9196 @lisp
9197 (setq nnmail-list-identifiers
9198       '("(idm)" "nagnagnag"))
9199 @end lisp
9200
9201 @item nnmail-remove-tabs
9202 @findex nnmail-remove-tabs
9203 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9204
9205 @end table
9206
9207 @item nnmail-prepare-incoming-message-hook
9208 @vindex nnmail-prepare-incoming-message-hook
9209 This hook is called narrowed to each message.  Functions to be used
9210 include: 
9211
9212 @table @code
9213 @item article-de-quoted-unreadable
9214 @findex article-de-quoted-unreadable
9215 Decode Quoted Readable encoding.
9216
9217 @end table
9218 @end table
9219
9220
9221 @node Duplicates
9222 @subsection Duplicates
9223
9224 @vindex nnmail-treat-duplicates
9225 @vindex nnmail-message-id-cache-length
9226 @vindex nnmail-message-id-cache-file
9227 @cindex duplicate mails
9228 If you are a member of a couple of mailing list, you will sometime
9229 receive two copies of the same mail.  This can be quite annoying, so
9230 @code{nnmail} checks for and treats any duplicates it might find.  To do
9231 this, it keeps a cache of old @code{Message-ID}s---
9232 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9233 default.  The approximate maximum number of @code{Message-ID}s stored
9234 there is controlled by the @code{nnmail-message-id-cache-length}
9235 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9236 stored.) If all this sounds scary to you, you can set
9237 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9238 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9239 will generate a brand new @code{Message-ID} for the mail and insert a
9240 warning into the head of the mail saying that it thinks that this is a
9241 duplicate of a different message.  
9242
9243 This variable can also be a function.  If that's the case, the function
9244 will be called from a buffer narrowed to the message in question with
9245 the @code{Message-ID} as a parameter.  The function must return either
9246 @code{nil}, @code{warn}, or @code{delete}.
9247
9248 You can turn this feature off completely by setting the variable to
9249 @code{nil}.
9250
9251 If you want all the duplicate mails to be put into a special
9252 @dfn{duplicates} group, you could do that using the normal mail split
9253 methods:
9254
9255 @lisp
9256 (setq nnmail-split-fancy
9257       '(| ;; Messages duplicates go to a separate group.
9258           ("gnus-warning" "duplication of message" "duplicate")
9259           ;; Message from daemons, postmaster, and the like to another.
9260           (any mail "mail.misc")
9261           ;; Other rules.
9262           [ ... ] ))
9263 @end lisp
9264
9265 Or something like:
9266 @lisp
9267 (setq nnmail-split-methods 
9268       '(("duplicates" "^Gnus-Warning:")
9269         ;; Other rules.
9270         [...]))
9271 @end lisp
9272
9273 Here's a neat feature: If you know that the recipient reads her mail
9274 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9275 @code{delete}, you can send her as many insults as you like, just by
9276 using a @code{Message-ID} of a mail that you know that she's already
9277 received.  Think of all the fun!  She'll never see any of it!  Whee!
9278
9279
9280 @node Not Reading Mail
9281 @subsection Not Reading Mail
9282
9283 If you start using any of the mail backends, they have the annoying
9284 habit of assuming that you want to read mail with them.  This might not
9285 be unreasonable, but it might not be what you want.
9286
9287 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9288 will ever attempt to read incoming mail, which should help.
9289
9290 @vindex nnbabyl-get-new-mail
9291 @vindex nnmbox-get-new-mail
9292 @vindex nnml-get-new-mail
9293 @vindex nnmh-get-new-mail
9294 @vindex nnfolder-get-new-mail
9295 This might be too much, if, for instance, you are reading mail quite
9296 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9297 file you have stashed away with @code{nnbabyl}.  All backends have
9298 variables called backend-@code{get-new-mail}.  If you want to disable
9299 the @code{nnbabyl} mail reading, you edit the virtual server for the
9300 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9301
9302 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9303 narrowed to the article to be saved before saving it when reading
9304 incoming mail.
9305
9306
9307 @node Choosing a Mail Backend
9308 @subsection Choosing a Mail Backend
9309
9310 Gnus will read the mail spool when you activate a mail group.  The mail
9311 file is first copied to your home directory.  What happens after that
9312 depends on what format you want to store your mail in.
9313
9314 @menu
9315 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9316 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9317 * Mail Spool::                  Store your mail in a private spool?
9318 * MH Spool::                    An mhspool-like backend.
9319 * Mail Folders::                Having one file for each group.
9320 @end menu
9321
9322
9323 @node Unix Mail Box
9324 @subsubsection Unix Mail Box
9325 @cindex nnmbox
9326 @cindex unix mail box
9327
9328 @vindex nnmbox-active-file
9329 @vindex nnmbox-mbox-file
9330 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9331 mail.  @code{nnmbox} will add extra headers to each mail article to say
9332 which group it belongs in.
9333
9334 Virtual server settings:
9335
9336 @table @code
9337 @item nnmbox-mbox-file
9338 @vindex nnmbox-mbox-file
9339 The name of the mail box in the user's home directory. 
9340
9341 @item nnmbox-active-file
9342 @vindex nnmbox-active-file
9343 The name of the active file for the mail box.
9344
9345 @item nnmbox-get-new-mail
9346 @vindex nnmbox-get-new-mail
9347 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9348 into groups.
9349 @end table
9350
9351
9352 @node Rmail Babyl
9353 @subsubsection Rmail Babyl
9354 @cindex nnbabyl
9355 @cindex rmail mbox
9356
9357 @vindex nnbabyl-active-file
9358 @vindex nnbabyl-mbox-file
9359 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9360 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9361 article to say which group it belongs in.
9362
9363 Virtual server settings:
9364
9365 @table @code
9366 @item nnbabyl-mbox-file
9367 @vindex nnbabyl-mbox-file
9368 The name of the rmail mbox file.
9369
9370 @item nnbabyl-active-file
9371 @vindex nnbabyl-active-file
9372 The name of the active file for the rmail box.
9373
9374 @item nnbabyl-get-new-mail
9375 @vindex nnbabyl-get-new-mail
9376 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9377 @end table
9378
9379
9380 @node Mail Spool
9381 @subsubsection Mail Spool
9382 @cindex nnml
9383 @cindex mail @sc{nov} spool
9384
9385 The @dfn{nnml} spool mail format isn't compatible with any other known
9386 format.  It should be used with some caution.
9387
9388 @vindex nnml-directory
9389 If you use this backend, Gnus will split all incoming mail into files;
9390 one file for each mail, and put the articles into the correct
9391 directories under the directory specified by the @code{nnml-directory}
9392 variable.  The default value is @file{~/Mail/}.
9393
9394 You do not have to create any directories beforehand; Gnus will take
9395 care of all that.
9396
9397 If you have a strict limit as to how many files you are allowed to store
9398 in your account, you should not use this backend.  As each mail gets its
9399 own file, you might very well occupy thousands of inodes within a few
9400 weeks.  If this is no problem for you, and it isn't a problem for you
9401 having your friendly systems administrator walking around, madly,
9402 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9403 know that this is probably the fastest format to use.  You do not have
9404 to trudge through a big mbox file just to read your new mail.
9405
9406 @code{nnml} is probably the slowest backend when it comes to article
9407 splitting.  It has to create lots of files, and it also generates
9408 @sc{nov} databases for the incoming mails.  This makes is the fastest
9409 backend when it comes to reading mail.
9410
9411 Virtual server settings:
9412
9413 @table @code
9414 @item nnml-directory
9415 @vindex nnml-directory
9416 All @code{nnml} directories will be placed under this directory. 
9417
9418 @item nnml-active-file
9419 @vindex nnml-active-file
9420 The active file for the @code{nnml} server.
9421
9422 @item nnml-newsgroups-file
9423 @vindex nnml-newsgroups-file
9424 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9425 Format}. 
9426
9427 @item nnml-get-new-mail
9428 @vindex nnml-get-new-mail
9429 If non-@code{nil}, @code{nnml} will read incoming mail.
9430
9431 @item nnml-nov-is-evil
9432 @vindex nnml-nov-is-evil
9433 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9434
9435 @item nnml-nov-file-name
9436 @vindex nnml-nov-file-name
9437 The name of the @sc{nov} files.  The default is @file{.overview}. 
9438
9439 @item nnml-prepare-save-mail-hook
9440 @vindex nnml-prepare-save-mail-hook
9441 Hook run narrowed to an article before saving.
9442
9443 @end table
9444
9445 @findex nnml-generate-nov-databases
9446 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9447 you can do a complete update by typing @kbd{M-x
9448 nnml-generate-nov-databases}.  This command will trawl through the
9449 entire @code{nnml} hierarchy, looking at each and every article, so it
9450 might take a while to complete.  A better interface to this
9451 functionality can be found in the server buffer (@pxref{Server
9452 Commands}). 
9453
9454
9455 @node MH Spool
9456 @subsubsection MH Spool
9457 @cindex nnmh
9458 @cindex mh-e mail spool
9459
9460 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9461 @sc{nov} databases and it doesn't keep an active file.  This makes
9462 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9463 makes it easier to write procmail scripts for.
9464
9465 Virtual server settings:
9466
9467 @table @code
9468 @item nnmh-directory
9469 @vindex nnmh-directory
9470 All @code{nnmh} directories will be located under this directory.
9471
9472 @item nnmh-get-new-mail
9473 @vindex nnmh-get-new-mail
9474 If non-@code{nil}, @code{nnmh} will read incoming mail.
9475
9476 @item nnmh-be-safe
9477 @vindex nnmh-be-safe
9478 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9479 sure that the articles in the folder are actually what Gnus thinks they
9480 are.  It will check date stamps and stat everything in sight, so
9481 setting this to @code{t} will mean a serious slow-down.  If you never
9482 use anything but Gnus to read the @code{nnmh} articles, you do not have
9483 to set this variable to @code{t}.
9484 @end table
9485
9486
9487 @node Mail Folders
9488 @subsubsection Mail Folders
9489 @cindex nnfolder
9490 @cindex mbox folders
9491 @cindex mail folders
9492
9493 @code{nnfolder} is a backend for storing each mail group in a separate
9494 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9495 will add extra headers to keep track of article numbers and arrival
9496 dates.
9497
9498 Virtual server settings:
9499
9500 @table @code
9501 @item nnfolder-directory
9502 @vindex nnfolder-directory
9503 All the @code{nnfolder} mail boxes will be stored under this directory. 
9504
9505 @item nnfolder-active-file
9506 @vindex nnfolder-active-file
9507 The name of the active file.
9508
9509 @item nnfolder-newsgroups-file
9510 @vindex nnfolder-newsgroups-file
9511 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9512
9513 @item nnfolder-get-new-mail
9514 @vindex nnfolder-get-new-mail
9515 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9516 @end table
9517
9518 @findex nnfolder-generate-active-file
9519 @kindex M-x nnfolder-generate-active-file
9520 If you have lots of @code{nnfolder}-like files you'd like to read with
9521 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9522 command to make @code{nnfolder} aware of all likely files in
9523 @code{nnfolder-directory}.
9524
9525
9526 @node Other Sources
9527 @section Other Sources
9528
9529 Gnus can do more than just read news or mail.  The methods described
9530 below allow Gnus to view directories and files as if they were
9531 newsgroups.
9532
9533 @menu
9534 * Directory Groups::      You can read a directory as if it was a newsgroup.
9535 * Anything Groups::       Dired?  Who needs dired?
9536 * Document Groups::       Single files can be the basis of a group.
9537 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9538 * Web Searches::          Creating groups from articles that match a string.
9539 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9540 @end menu
9541
9542
9543 @node Directory Groups
9544 @subsection Directory Groups
9545 @cindex nndir
9546 @cindex directory groups
9547
9548 If you have a directory that has lots of articles in separate files in
9549 it, you might treat it as a newsgroup.  The files have to have numerical
9550 names, of course.
9551
9552 This might be an opportune moment to mention @code{ange-ftp}, that most
9553 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9554 didn't think much about it---a backend to read directories.  Big deal.
9555
9556 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9557 enter the @code{ange-ftp} file name
9558 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9559 @code{ange-ftp} will actually allow you to read this directory over at
9560 @samp{sina} as a newsgroup.  Distributed news ahoy!
9561
9562 @code{nndir} will use @sc{nov} files if they are present.
9563
9564 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9565 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9566 whatever you use @code{nndir} for, so you could switch to any of those
9567 methods if you feel the need to have a non-read-only @code{nndir}.
9568
9569
9570 @node Anything Groups
9571 @subsection Anything Groups
9572 @cindex nneething
9573
9574 From the @code{nndir} backend (which reads a single spool-like
9575 directory), it's just a hop and a skip to @code{nneething}, which
9576 pretends that any arbitrary directory is a newsgroup.  Strange, but
9577 true.
9578
9579 When @code{nneething} is presented with a directory, it will scan this
9580 directory and assign article numbers to each file.  When you enter such
9581 a group, @code{nneething} must create ``headers'' that Gnus can use.
9582 After all, Gnus is a newsreader, in case you're
9583 forgetting. @code{nneething} does this in a two-step process.  First, it
9584 snoops each file in question.  If the file looks like an article (i.e.,
9585 the first few lines look like headers), it will use this as the head.
9586 If this is just some arbitrary file without a head (e.g. a C source
9587 file), @code{nneething} will cobble up a header out of thin air.  It
9588 will use file ownership, name and date and do whatever it can with these
9589 elements.
9590
9591 All this should happen automatically for you, and you will be presented
9592 with something that looks very much like a newsgroup.  Totally like a
9593 newsgroup, to be precise.  If you select an article, it will be displayed
9594 in the article buffer, just as usual.
9595
9596 If you select a line that represents a directory, Gnus will pop you into
9597 a new summary buffer for this @code{nneething} group.  And so on.  You can
9598 traverse the entire disk this way, if you feel like, but remember that
9599 Gnus is not dired, really, and does not intend to be, either.
9600
9601 There are two overall modes to this action---ephemeral or solid.  When
9602 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9603 will not store information on what files you have read, and what files
9604 are new, and so on.  If you create a solid @code{nneething} group the
9605 normal way with @kbd{G m}, Gnus will store a mapping table between
9606 article numbers and file names, and you can treat this group like any
9607 other groups.  When you activate a solid @code{nneething} group, you will
9608 be told how many unread articles it contains, etc., etc.
9609
9610 Some variables:
9611
9612 @table @code
9613 @item nneething-map-file-directory
9614 @vindex nneething-map-file-directory
9615 All the mapping files for solid @code{nneething} groups will be stored
9616 in this directory, which defaults to @file{~/.nneething/}.
9617
9618 @item nneething-exclude-files
9619 @vindex nneething-exclude-files
9620 All files that match this regexp will be ignored.  Nice to use to exclude
9621 auto-save files and the like, which is what it does by default.
9622
9623 @item nneething-map-file
9624 @vindex nneething-map-file
9625 Name of the map files.
9626 @end table
9627
9628
9629 @node Document Groups
9630 @subsection Document Groups
9631 @cindex nndoc
9632 @cindex documentation group
9633 @cindex help group
9634
9635 @code{nndoc} is a cute little thing that will let you read a single file
9636 as a newsgroup.  Several files types are supported:
9637
9638 @table @code
9639 @cindex babyl
9640 @cindex rmail mbox
9641
9642 @item babyl
9643 The babyl (rmail) mail box.
9644 @cindex mbox
9645 @cindex Unix mbox
9646
9647 @item mbox
9648 The standard Unix mbox file.
9649
9650 @cindex MMDF mail box
9651 @item mmdf
9652 The MMDF mail box format.
9653
9654 @item news
9655 Several news articles appended into a file.
9656
9657 @item rnews
9658 @cindex rnews batch files
9659 The rnews batch transport format.
9660 @cindex forwarded messages
9661
9662 @item forward
9663 Forwarded articles.
9664
9665 @item mime-digest
9666 @cindex digest
9667 @cindex MIME digest
9668 @cindex 1153 digest
9669 @cindex RFC 1153 digest
9670 @cindex RFC 341 digest
9671 MIME (RFC 1341) digest format.
9672
9673 @item standard-digest
9674 The standard (RFC 1153) digest format.
9675
9676 @item slack-digest
9677 Non-standard digest format---matches most things, but does it badly. 
9678 @end table
9679
9680 You can also use the special ``file type'' @code{guess}, which means
9681 that @code{nndoc} will try to guess what file type it is looking at.
9682 @code{digest} means that @code{nndoc} should guess what digest type the
9683 file is.
9684
9685 @code{nndoc} will not try to change the file or insert any extra headers into
9686 it---it will simply, like, let you use the file as the basis for a
9687 group.  And that's it.
9688
9689 If you have some old archived articles that you want to insert into your
9690 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9691 that.  Say you have an old @file{RMAIL} file with mail that you now want
9692 to split into your new @code{nnml} groups.  You look at that file using
9693 @code{nndoc} (using the @kbd{G f} command in the group buffer
9694 (@pxref{Foreign Groups})), set the process mark on all the articles in
9695 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9696 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9697 file is now also stored in lots of @code{nnml} directories, and you can
9698 delete that pesky @file{RMAIL} file.  If you have the guts!
9699
9700 Virtual server variables:
9701
9702 @table @code
9703 @item nndoc-article-type
9704 @vindex nndoc-article-type
9705 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9706 @code{mmdf}, @code{forward}, @code{news}, @code{rnews},
9707 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
9708
9709 @item nndoc-post-type
9710 @vindex nndoc-post-type
9711 This variable says whether Gnus is to consider the group a news group or
9712 a mail group.  There are two legal values:  @code{mail} (the default)
9713 and @code{news}.
9714 @end table
9715
9716 @menu
9717 * Document Server Internals::   How to add your own document types.
9718 @end menu
9719
9720
9721 @node Document Server Internals
9722 @subsubsection Document Server Internals
9723
9724 Adding new document types to be recognized by @code{nndoc} isn't
9725 difficult.  You just have to whip up a definition of what the document
9726 looks like, write a predicate function to recognize that document type,
9727 and then hook into @code{nndoc}.
9728
9729 First, here's an example document type definition:
9730
9731 @example
9732 (mmdf 
9733  (article-begin .  "^\^A\^A\^A\^A\n")
9734  (body-end .  "^\^A\^A\^A\^A\n"))
9735 @end example
9736
9737 The definition is simply a unique @dfn{name} followed by a series of
9738 regexp pseudo-variable settings.  Below are the possible
9739 variables---don't be daunted by the number of variables; most document
9740 types can be defined with very few settings:
9741
9742 @table @code
9743 @item first-article
9744 If present, @code{nndoc} will skip past all text until it finds
9745 something that match this regexp.  All text before this will be
9746 totally ignored. 
9747
9748 @item article-begin
9749 This setting has to be present in all document type definitions.  It
9750 says what the beginning of each article looks like.
9751
9752 @item head-begin-function
9753 If present, this should be a function that moves point to the head of
9754 the article.
9755
9756 @item nndoc-head-begin
9757 If present, this should be a regexp that matches the head of the
9758 article. 
9759
9760 @item nndoc-head-end
9761 This should match the end of the head of the article.  It defaults to
9762 @samp{^$}---the empty line.
9763
9764 @item body-begin-function
9765 If present, this function should move point to the beginning of the body
9766 of the article.
9767
9768 @item body-begin
9769 This should match the beginning of the body of the article.  It defaults
9770 to @samp{^\n}.
9771
9772 @item body-end-function
9773 If present, this function should move point to the end of the body of
9774 the article.
9775
9776 @item body-end
9777 If present, this should match the end of the body of the article.
9778
9779 @item nndoc-file-end
9780 If present, this should match the end of the file.  All text after this
9781 regexp will be totally ignored. 
9782
9783 @end table
9784
9785 So, using these variables @code{nndoc} is able to dissect a document
9786 file into a series of articles, each with a head and a body.  However, a
9787 few more variables are needed since not all document types are all that
9788 news-like---variables needed to transform the head or the body into
9789 something that's palatable for Gnus:
9790
9791 @table @code
9792 @item prepare-body-function
9793 If present, this function will be called when requesting an article.  It
9794 will be called with point at the start of the body, and is useful if the
9795 document has encoded some parts of its contents. 
9796
9797 @item article-transform-function
9798 If present, this function is called when requesting an article.  It's
9799 meant to be used how more wide-ranging transformation of both head and
9800 body of the article.
9801
9802 @item generate-head-function
9803 If present, this function is called to generate a head that Gnus can
9804 understand.  It is called with the article number as a parameter, and is
9805 expected to generate a nice head for the article in question.  It is
9806 called when requesting the headers of all articles.
9807
9808 @end table
9809
9810 Let's look at the most complicated example I can come up with---standard
9811 digests:
9812
9813 @example
9814 (standard-digest
9815  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9816  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9817  (prepare-body-function . nndoc-unquote-dashes)
9818  (body-end-function . nndoc-digest-body-end)
9819  (head-end . "^ ?$")
9820  (body-begin . "^ ?\n")
9821  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9822  (subtype digest guess))
9823 @end example
9824
9825 We see that all text before a 70-width line of dashes is ignored; all
9826 text after a line that starts with that @samp{^End of} is also ignored;
9827 each article begins with a 30-width line of dashes; the line separating
9828 the head from the body may contain a single space; and that the body is
9829 run through @code{nndoc-unquote-dashes} before being delivered.
9830
9831 To hook your own document definition into @code{nndoc}, use the
9832 @code{nndoc-add-type} function.  It takes two parameters---the first is
9833 the definition itself and the second (optional) parameter says where in
9834 the document type definition alist to put this definition.  The alist is
9835 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9836 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
9837 is of @code{mmdf} type, and so on.  These type predicates should return
9838 @code{nil} if the document is not of the correct type; @code{t} if it is
9839 of the correct type; and a number if the document might be of the
9840 correct type.  A high number means high probability; a low number means
9841 low probability with @samp{0} being the lowest legal number.
9842
9843
9844 @node SOUP
9845 @subsection SOUP
9846 @cindex SOUP
9847 @cindex offline
9848
9849 In the PC world people often talk about ``offline'' newsreaders.  These
9850 are thingies that are combined reader/news transport monstrosities.
9851 With built-in modem programs.  Yecchh!
9852
9853 Of course, us Unix Weenie types of human beans use things like
9854 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9855 transport things like Ghod intended.  And then we just use normal
9856 newsreaders.  
9857
9858 However, it can sometimes be convenient to do something a that's a bit
9859 easier on the brain if you have a very slow modem, and you're not really
9860 that interested in doing things properly.  
9861
9862 A file format called @sc{soup} has been developed for transporting news
9863 and mail from servers to home machines and back again.  It can be a bit
9864 fiddly.
9865
9866 First some terminology:
9867
9868 @table @dfn
9869
9870 @item server
9871 This is the machine that is connected to the outside world and where you
9872 get news and/or mail from.
9873
9874 @item home machine
9875 This is the machine that you want to do the actual reading and responding
9876 on.  It is typically not connected to the rest of the world in any way.
9877
9878 @item packet
9879 Something that contains messages and/or commands.  There are two kinds
9880 of packets:
9881
9882 @table @dfn
9883 @item message packets
9884 These are packets made at the server, and typically contains lots of
9885 messages for you to read.  These are called @file{SoupoutX.tgz} by
9886 default, where @var{X} is a number.
9887
9888 @item response packets
9889 These are packets made at the home machine, and typically contains
9890 replies that you've written.  These are called @file{SoupinX.tgz} by
9891 default, where @var{X} is a number.
9892
9893 @end table
9894
9895 @end table
9896
9897
9898 @enumerate
9899
9900 @item
9901 You log in on the server and create a @sc{soup} packet.  You can either
9902 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9903 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9904 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9905
9906 @item 
9907 You transfer the packet home.  Rail, boat, car or modem will do fine.
9908
9909 @item
9910 You put the packet in your home directory.
9911
9912 @item
9913 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9914 the native or secondary server.
9915
9916 @item
9917 You read articles and mail and answer and followup to the things you
9918 want (@pxref{SOUP Replies}).
9919
9920 @item 
9921 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9922 packet.
9923
9924 @item 
9925 You transfer this packet to the server.  
9926
9927 @item
9928 You use Gnus to mail this packet out with the @kbd{G s s} command.
9929
9930 @item
9931 You then repeat until you die.
9932
9933 @end enumerate
9934
9935 So you basically have a bipartite system---you use @code{nnsoup} for
9936 reading and Gnus for packing/sending these @sc{soup} packets.
9937
9938 @menu
9939 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
9940 * SOUP Groups::       A backend for reading @sc{soup} packets.
9941 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
9942 @end menu
9943
9944
9945 @node SOUP Commands
9946 @subsubsection SOUP Commands
9947
9948 These are commands for creating and manipulating @sc{soup} packets.
9949
9950 @table @kbd
9951 @item G s b
9952 @kindex G s b (Group)
9953 @findex gnus-group-brew-soup
9954 Pack all unread articles in the current group
9955 (@code{gnus-group-brew-soup}).  This command understands the
9956 process/prefix convention.
9957
9958 @item G s w
9959 @kindex G s w (Group)
9960 @findex gnus-soup-save-areas
9961 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
9962
9963 @item G s s
9964 @kindex G s s (Group)
9965 @findex gnus-soup-send-replies
9966 Send all replies from the replies packet
9967 (@code{gnus-soup-send-replies}). 
9968
9969 @item G s p
9970 @kindex G s p (Group)
9971 @findex gnus-soup-pack-packet
9972 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
9973
9974 @item G s r
9975 @kindex G s r (Group)
9976 @findex nnsoup-pack-replies
9977 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
9978
9979 @item O s
9980 @kindex O s (Summary)
9981 @findex gnus-soup-add-article
9982 This summary-mode command adds the current article to a @sc{soup} packet
9983 (@code{gnus-soup-add-article}).  It understands the process/prefix
9984 convention (@pxref{Process/Prefix}). 
9985
9986 @end table
9987
9988
9989 There are a few variables to customize where Gnus will put all these
9990 thingies:  
9991
9992 @table @code
9993
9994 @item gnus-soup-directory
9995 @vindex gnus-soup-directory
9996 Directory where Gnus will save intermediate files while composing
9997 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
9998
9999 @item gnus-soup-replies-directory
10000 @vindex gnus-soup-replies-directory
10001 This is what Gnus will use as a temporary directory while sending our
10002 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10003
10004 @item gnus-soup-prefix-file
10005 @vindex gnus-soup-prefix-file
10006 Name of the file where Gnus stores the last used prefix.  The default is
10007 @samp{gnus-prefix}. 
10008
10009 @item gnus-soup-packer
10010 @vindex gnus-soup-packer
10011 A format string command for packing a @sc{soup} packet.  The default is
10012 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10013
10014 @item gnus-soup-unpacker
10015 @vindex gnus-soup-unpacker
10016 Format string command for unpacking a @sc{soup} packet.  The default is
10017 @samp{gunzip -c %s | tar xvf -}.
10018
10019 @item gnus-soup-packet-directory
10020 @vindex gnus-soup-packet-directory
10021 Where Gnus will look for reply packets.  The default is @file{~/}. 
10022
10023 @item gnus-soup-packet-regexp
10024 @vindex gnus-soup-packet-regexp
10025 Regular expression matching @sc{soup} reply packets in
10026 @code{gnus-soup-packet-directory}. 
10027
10028 @end table
10029  
10030
10031 @node SOUP Groups
10032 @subsubsection @sc{soup} Groups
10033 @cindex nnsoup
10034
10035 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10036 read incoming packets, unpack them, and put them in a directory where
10037 you can read them at leisure.
10038
10039 These are the variables you can use to customize its behavior:
10040
10041 @table @code
10042
10043 @item nnsoup-tmp-directory
10044 @vindex nnsoup-tmp-directory
10045 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10046 directory.  (@file{/tmp/} by default.)  
10047
10048 @item nnsoup-directory
10049 @vindex nnsoup-directory
10050 @code{nnsoup} then moves each message and index file to this directory.
10051 The default is @file{~/SOUP/}.
10052
10053 @item nnsoup-replies-directory 
10054 @vindex nnsoup-replies-directory 
10055 All replies will stored in this directory before being packed into a
10056 reply packet.  The default is @file{~/SOUP/replies/"}.
10057
10058 @item nnsoup-replies-format-type
10059 @vindex nnsoup-replies-format-type
10060 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10061 (rnews), and I don't think you should touch that variable.  I probably
10062 shouldn't even have documented it.  Drats!  Too late!
10063
10064 @item nnsoup-replies-index-type
10065 @vindex nnsoup-replies-index-type
10066 The index type of the replies packet.  The is @samp{?n}, which means
10067 ``none''.  Don't fiddle with this one either!
10068
10069 @item nnsoup-active-file
10070 @vindex nnsoup-active-file
10071 Where @code{nnsoup} stores lots of information.  This is not an ``active
10072 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10073 this file or mess it up in any way, you're dead.  The default is
10074 @file{~/SOUP/active}.
10075
10076 @item nnsoup-packer
10077 @vindex nnsoup-packer
10078 Format string command for packing a reply @sc{soup} packet.  The default
10079 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10080
10081 @item nnsoup-unpacker
10082 @vindex nnsoup-unpacker
10083 Format string command for unpacking incoming @sc{soup} packets.  The
10084 default is @samp{gunzip -c %s | tar xvf -}. 
10085
10086 @item nnsoup-packet-directory
10087 @vindex nnsoup-packet-directory
10088 Where @code{nnsoup} will look for incoming packets.  The default is
10089 @file{~/}.  
10090
10091 @item nnsoup-packet-regexp
10092 @vindex nnsoup-packet-regexp
10093 Regular expression matching incoming @sc{soup} packets.  The default is
10094 @samp{Soupout}. 
10095
10096 @end table
10097
10098
10099 @node SOUP Replies
10100 @subsubsection SOUP Replies
10101
10102 Just using @code{nnsoup} won't mean that your postings and mailings end
10103 up in @sc{soup} reply packets automagically.  You have to work a bit
10104 more for that to happen.
10105
10106 @findex nnsoup-set-variables
10107 The @code{nnsoup-set-variables} command will set the appropriate
10108 variables to ensure that all your followups and replies end up in the
10109 @sc{soup} system.
10110
10111 In specific, this is what it does:
10112
10113 @lisp
10114 (setq message-send-news-function 'nnsoup-request-post)
10115 (setq message-send-mail-function 'nnsoup-request-mail)
10116 @end lisp
10117
10118 And that's it, really.  If you only want news to go into the @sc{soup}
10119 system you just use the first line.  If you only want mail to be
10120 @sc{soup}ed you use the second.
10121
10122
10123 @node Web Searches
10124 @subsection Web Searches
10125 @cindex nnweb
10126 @cindex DejaNews
10127 @cindex Alta Vista
10128 @cindex InReference
10129 @cindex Usenet searches
10130 @cindex searching the Usenet
10131
10132 It's, like, too neat to search the Usenet for articles that match a
10133 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10134 those, like, Web browsers, and you, like, have to, rilly, like, look at
10135 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10136 searches without having to use a browser.
10137
10138 The @code{nnweb} backend allows an easy interface to the mighty search
10139 engine.  You create an @code{nnweb} group, enter a search pattern, and
10140 then enter the group and read the articles like you would any normal
10141 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10142 Groups}) will do this in an easy-to-use fashion.
10143
10144 @code{nnweb} groups don't really lend themselves to being solid
10145 groups---they have a very fleeting idea of article numbers.  In fact,
10146 each time you enter an @code{nnweb} group (not even changing the search
10147 pattern), you are likely to get the articles ordered in a different
10148 manner.  Not even using duplicate suppression (@code{Duplicate
10149 Suppression}) will help, since @code{nnweb} doesn't even know the
10150 @code{Message-ID} of the articles before reading them using some search
10151 engines (DejaNews, for instance).  The only possible way to keep track
10152 of which articles you've read is by scoring on the @code{Date}
10153 header---mark all articles that were posted before the last date you
10154 read the group as read.
10155
10156 If the search engine changes its output substantially, @code{nnweb}
10157 won't be able to parse it and will fail.  One could hardly fault the Web
10158 providers if they were to do this---their @emph{raison d'être} is to
10159 make money off of advertisements, not to provide services to the
10160 community.  Since @code{nnweb} washes the ads off all the articles, one
10161 might think that the providers might be somewhat miffed.  We'll see.
10162
10163 You must have the @code{url} and @code{w3} package installed to be able
10164 to use @code{nnweb}.
10165
10166 Virtual server variables:
10167
10168 @table @code
10169 @item nnweb-type
10170 @vindex nnweb-type
10171 What search engine type is being used.  The currently supported types
10172 are @code{dejanews}, @code{altavista} and @code{reference}.
10173
10174 @item nnweb-search
10175 @vindex nnweb-search
10176 The search string to feed to the search engine.
10177
10178 @item nnweb-max-hits
10179 @vindex nnweb-max-hits
10180 Advisory maximum number of hits per search to display.  The default is
10181 100.
10182
10183 @item nnweb-type-definition
10184 @vindex nnweb-type-definition
10185 Type-to-definition alist.  This alist says what @code{nnweb} should do
10186 with the various search engine types.  The following elements must be
10187 present: 
10188
10189 @table @code
10190 @item article
10191 Function to decode the article and provide something that Gnus
10192 understands. 
10193
10194 @item map
10195 Function to create an article number to message header and URL alist. 
10196
10197 @item search
10198 Function to send the search string to the search engine.
10199
10200 @item address
10201 The address the aforementioned function should send the search string
10202 to. 
10203
10204 @item id
10205 Format string URL to fetch an article by @code{Message-ID}.
10206 @end table
10207
10208 @end table
10209
10210
10211
10212 @node Mail-To-News Gateways
10213 @subsection Mail-To-News Gateways
10214 @cindex mail-to-news gateways
10215 @cindex gateways
10216
10217 If your local @code{nntp} server doesn't allow posting, for some reason
10218 or other, you can post using one of the numerous mail-to-news gateways.
10219 The @code{nngateway} backend provides the interface.
10220
10221 Note that you can't read anything from this backend---it can only be
10222 used to post with.
10223
10224 Server variables:
10225
10226 @table @code
10227 @item nngateway-address 
10228 @vindex nngateway-address 
10229 This is the address of the mail-to-news gateway.
10230
10231 @item nngateway-header-transformation
10232 @vindex nngateway-header-transformation
10233 News headers have often have to be transformed in some odd way or other
10234 for the mail-to-news gateway to accept it.  This variable says what 
10235 transformation should be called, and defaults to
10236 @code{nngateway-simple-header-transformation}.  The function is called
10237 narrowed to the headers to be transformed and with one parameter---the
10238 gateway address.
10239
10240 This default function just inserts a new @code{To} header based on the
10241 @code{Newsgroups} header and the gateway address---an article with this
10242 @code{Newsgroups} header:
10243
10244 @example
10245 Newsgroups: alt.religion.emacs
10246 @end example
10247
10248 will get this @code{From} header inserted:
10249
10250 @example
10251 To: alt-religion-emacs@@GATEWAY
10252 @end example
10253
10254 @end table
10255
10256 So, to use this, simply say something like:
10257
10258 @lisp
10259 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10260 @end lisp
10261
10262
10263 @node Combined Groups
10264 @section Combined Groups
10265
10266 Gnus allows combining a mixture of all the other group types into bigger
10267 groups.
10268
10269 @menu
10270 * Virtual Groups::     Combining articles from many groups.
10271 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10272 @end menu
10273
10274
10275 @node Virtual Groups
10276 @subsection Virtual Groups
10277 @cindex nnvirtual
10278 @cindex virtual groups
10279
10280 An @dfn{nnvirtual group} is really nothing more than a collection of
10281 other groups.
10282
10283 For instance, if you are tired of reading many small group, you can
10284 put them all in one big group, and then grow tired of reading one
10285 big, unwieldy group.  The joys of computing!
10286
10287 You specify @code{nnvirtual} as the method.  The address should be a
10288 regexp to match component groups.
10289
10290 All marks in the virtual group will stick to the articles in the
10291 component groups.  So if you tick an article in a virtual group, the
10292 article will also be ticked in the component group from whence it came.
10293 (And vice versa---marks from the component groups will also be shown in
10294 the virtual group.)
10295
10296 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10297 newsgroups into one, big, happy newsgroup:
10298
10299 @lisp
10300 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10301 @end lisp
10302
10303 The component groups can be native or foreign; everything should work
10304 smoothly, but if your computer explodes, it was probably my fault.
10305
10306 Collecting the same group from several servers might actually be a good
10307 idea if users have set the Distribution header to limit distribution.
10308 If you would like to read @samp{soc.motss} both from a server in Japan
10309 and a server in Norway, you could use the following as the group regexp:
10310
10311 @example
10312 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10313 @end example
10314
10315 This should work kinda smoothly---all articles from both groups should
10316 end up in this one, and there should be no duplicates.  Threading (and
10317 the rest) will still work as usual, but there might be problems with the
10318 sequence of articles.  Sorting on date might be an option here
10319 (@pxref{Selecting a Group}.
10320
10321 One limitation, however---all groups that are included in a virtual
10322 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10323 zombie groups can't be component groups for @code{nnvirtual} groups.
10324
10325 @vindex nnvirtual-always-rescan
10326 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10327 @code{nnvirtual} will always scan groups for unread articles when
10328 entering a virtual group.  If this variable is @code{nil} (which is the
10329 default) and you read articles in a component group after the virtual
10330 group has been activated, the read articles from the component group
10331 will show up when you enter the virtual group.  You'll also see this
10332 effect if you have two virtual groups that contain the same component
10333 group.  If that's the case, you should set this variable to @code{t}.
10334 Or you can just tap @code{M-g} on the virtual group every time before
10335 you enter it---it'll have much the same effect.
10336
10337
10338 @node Kibozed Groups
10339 @subsection Kibozed Groups
10340 @cindex nnkiboze
10341 @cindex kibozing
10342
10343 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10344 the news feed''.  @code{nnkiboze} is a backend that will do this for
10345 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10346 with useless requests!  Oh happiness!
10347
10348 @kindex G k (Group)
10349 To create a kibozed group, use the @kbd{G k} command in the group
10350 buffer. 
10351
10352 The address field of the @code{nnkiboze} method is, as with
10353 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10354 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10355 and @code{nnvirtual} ends.
10356
10357 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10358 must have a score file to say what articles that are to be included in
10359 the group (@pxref{Scoring}).
10360
10361 @kindex M-x nnkiboze-generate-groups
10362 @findex nnkiboze-generate-groups
10363 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10364 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10365 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10366 all the articles in all the components groups and run them through the
10367 scoring process to determine if there are any articles in the groups
10368 that are to be part of the @code{nnkiboze} groups.
10369
10370 Please limit the number of component groups by using restrictive
10371 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10372 @sc{nntp} site may throw you off and never let you back in again.
10373 Stranger things have happened.
10374
10375 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10376 and they can be foreign.  No restrictions.
10377
10378 @vindex nnkiboze-directory
10379 The generation of an @code{nnkiboze} group means writing two files in
10380 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10381 contains the @sc{nov} header lines for all the articles in the group,
10382 and the other is an additional @file{.newsrc} file to store information
10383 on what groups that have been searched through to find component
10384 articles.
10385
10386 Articles that are marked as read in the @code{nnkiboze} group will have their
10387 @sc{nov} lines removed from the @sc{nov} file.
10388
10389
10390 @node Scoring
10391 @chapter Scoring
10392 @cindex scoring
10393
10394 Other people use @dfn{kill files}, but we here at Gnus Towers like
10395 scoring better than killing, so we'd rather switch than fight.  They do
10396 something completely different as well, so sit up straight and pay
10397 attention!
10398
10399 @vindex gnus-summary-mark-below
10400 All articles have a default score (@code{gnus-summary-default-score}),
10401 which is 0 by default.  This score may be raised or lowered either
10402 interactively or by score files.  Articles that have a score lower than
10403 @code{gnus-summary-mark-below} are marked as read.
10404
10405 Gnus will read any @dfn{score files} that apply to the current group
10406 before generating the summary buffer.
10407
10408 There are several commands in the summary buffer that insert score
10409 entries based on the current article.  You can, for instance, ask Gnus to
10410 lower or increase the score of all articles with a certain subject.
10411
10412 There are two sorts of scoring entries: Permanent and temporary.
10413 Temporary score entries are self-expiring entries.  Any entries that are
10414 temporary and have not been used for, say, a week, will be removed
10415 silently to help keep the sizes of the score files down.
10416
10417 @menu 
10418 * Summary Score Commands::   Adding score entries for the current group.
10419 * Group Score Commands::     General score commands.
10420 * Score Variables::          Customize your scoring.  (My, what terminology).
10421 * Score File Format::        What a score file may contain.
10422 * Score File Editing::       You can edit score files by hand as well.
10423 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10424 * Home Score File::          How to say where new score entries are to go.
10425 * Followups To Yourself::    Having Gnus notice when people answer you.
10426 * Scoring Tips::             How to score effectively.
10427 * Reverse Scoring::          That problem child of old is not problem.
10428 * Global Score Files::       Earth-spanning, ear-splitting score files.
10429 * Kill Files::               They are still here, but they can be ignored.
10430 * Converting Kill Files::    Translating kill files to score files.
10431 * GroupLens::                Getting predictions on what you like to read.
10432 * Advanced Scoring::         Using logical expressions to build score rules.
10433 * Score Decays::             It can be useful to let scores wither away.
10434 @end menu
10435
10436
10437 @node Summary Score Commands
10438 @section Summary Score Commands
10439 @cindex score commands
10440
10441 The score commands that alter score entries do not actually modify real
10442 score files.  That would be too inefficient.  Gnus maintains a cache of
10443 previously loaded score files, one of which is considered the
10444 @dfn{current score file alist}.  The score commands simply insert
10445 entries into this list, and upon group exit, this list is saved.
10446
10447 The current score file is by default the group's local score file, even
10448 if no such score file actually exists.  To insert score commands into
10449 some other score file (e.g. @file{all.SCORE}), you must first make this
10450 score file the current one.
10451
10452 General score commands that don't actually change the score file:
10453
10454 @table @kbd
10455
10456 @item V s
10457 @kindex V s (Summary)
10458 @findex gnus-summary-set-score
10459 Set the score of the current article (@code{gnus-summary-set-score}).  
10460
10461 @item V S
10462 @kindex V S (Summary)
10463 @findex gnus-summary-current-score
10464 Display the score of the current article
10465 (@code{gnus-summary-current-score}).   
10466
10467 @item V t
10468 @kindex V t (Summary)
10469 @findex gnus-score-find-trace
10470 Display all score rules that have been used on the current article
10471 (@code{gnus-score-find-trace}).   
10472
10473 @item V R
10474 @kindex V R (Summary)
10475 @findex gnus-summary-rescore
10476 Run the current summary through the scoring process
10477 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10478 around with your score files behind Gnus' back and want to see the
10479 effect you're having.
10480
10481 @item V a
10482 @kindex V a (Summary)
10483 @findex gnus-summary-score-entry
10484 Add a new score entry, and allow specifying all elements 
10485 (@code{gnus-summary-score-entry}).
10486
10487 @item V c
10488 @kindex V c (Summary)
10489 @findex gnus-score-change-score-file
10490 Make a different score file the current
10491 (@code{gnus-score-change-score-file}). 
10492
10493 @item V e
10494 @kindex V e (Summary)
10495 @findex gnus-score-edit-current-scores
10496 Edit the current score file (@code{gnus-score-edit-current-scores}).
10497 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10498 File Editing}).
10499
10500 @item V f
10501 @kindex V f (Summary)
10502 @findex gnus-score-edit-file
10503 Edit a score file and make this score file the current one
10504 (@code{gnus-score-edit-file}).
10505
10506 @item V F
10507 @kindex V F (Summary)
10508 @findex gnus-score-flush-cache
10509 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10510 after editing score files.
10511
10512 @item V C
10513 @kindex V C (Summary)
10514 @findex gnus-score-customize
10515 Customize a score file in a visually pleasing manner
10516 (@code{gnus-score-customize}). 
10517
10518 @item I C-i
10519 @kindex I C-i (Summary)
10520 @findex gnus-summary-raise-score
10521 Increase the score of the current article
10522 (@code{gnus-summary-raise-score}).
10523
10524 @item L C-l
10525 @kindex L C-l (Summary)
10526 @findex gnus-summary-lower-score
10527 Lower the score of the current article
10528 (@code{gnus-summary-lower-score}). 
10529 @end table
10530
10531 The rest of these commands modify the local score file.
10532
10533 @table @kbd
10534
10535 @item V m
10536 @kindex V m (Summary)
10537 @findex gnus-score-set-mark-below
10538 Prompt for a score, and mark all articles with a score below this as
10539 read (@code{gnus-score-set-mark-below}).
10540
10541 @item V x
10542 @kindex V x (Summary)
10543 @findex gnus-score-set-expunge-below
10544 Prompt for a score, and add a score rule to the current score file to
10545 expunge all articles below this score
10546 (@code{gnus-score-set-expunge-below}).
10547 @end table
10548
10549 The keystrokes for actually making score entries follow a very regular
10550 pattern, so there's no need to list all the commands.  (Hundreds of
10551 them.)  
10552
10553 @enumerate
10554 @item
10555 The first key is either @kbd{I} (upper case i) for increasing the score
10556 or @kbd{L} for lowering the score. 
10557 @item
10558 The second key says what header you want to score on.  The following
10559 keys are available:
10560 @table @kbd
10561
10562 @item a
10563 Score on the author name.
10564
10565 @item s
10566 Score on the subject line.
10567
10568 @item x
10569 Score on the Xref line---i.e., the cross-posting line.
10570
10571 @item t
10572 Score on thread---the References line.
10573
10574 @item d
10575 Score on the date.
10576
10577 @item l
10578 Score on the number of lines.
10579
10580 @item i
10581 Score on the Message-ID.
10582
10583 @item f
10584 Score on followups.
10585
10586 @item b
10587 Score on the body.
10588
10589 @item h
10590 Score on the head.
10591 @end table
10592
10593 @item
10594 The third key is the match type.  Which match types are legal depends on
10595 what headers you are scoring on.
10596
10597 @table @code
10598
10599 @item strings 
10600
10601 @table @kbd
10602
10603 @item e
10604 Exact matching.
10605
10606 @item s
10607 Substring matching.
10608
10609 @item f
10610 Fuzzy matching.
10611
10612 @item r
10613 Regexp matching
10614 @end table
10615
10616 @item date
10617 @table @kbd
10618
10619 @item b
10620 Before date.
10621
10622 @item a
10623 At date.
10624
10625 @item n
10626 This date.
10627 @end table
10628
10629 @item number
10630 @table @kbd
10631
10632 @item <
10633 Less than number.
10634
10635 @item =
10636 Equal to number.
10637
10638 @item >
10639 Greater than number.
10640 @end table
10641 @end table
10642
10643 @item 
10644 The fourth and final key says whether this is a temporary (i.e., expiring)
10645 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10646 it is to be done immediately, without adding to the score file.
10647 @table @kbd
10648
10649 @item t
10650 Temporary score entry.
10651
10652 @item p
10653 Permanent score entry.
10654
10655 @item i
10656 Immediately scoring.
10657 @end table
10658
10659 @end enumerate
10660
10661 So, let's say you want to increase the score on the current author with
10662 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10663 score based on the subject line, using substring matching, and make a
10664 temporary score entry: @kbd{L s s t}.  Pretty easy.
10665
10666 To make things a bit more complicated, there are shortcuts.  If you use
10667 a capital letter on either the second or third keys, Gnus will use
10668 defaults for the remaining one or two keystrokes.  The defaults are
10669 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10670 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10671
10672 @vindex gnus-score-mimic-keymap
10673 The @code{gnus-score-mimic-keymap} says whether these commands will
10674 pretend they are keymaps or not.
10675
10676
10677 @node Group Score Commands
10678 @section Group Score Commands
10679 @cindex group score commands
10680
10681 There aren't many of these as yet, I'm afraid.
10682
10683 @table @kbd
10684
10685 @item W f
10686 @kindex W f (Group)
10687 @findex gnus-score-flush-cache
10688 Gnus maintains a cache of score alists to avoid having to reload them
10689 all the time.  This command will flush the cache
10690 (@code{gnus-score-flush-cache}). 
10691
10692 @end table
10693
10694
10695 @node Score Variables
10696 @section Score Variables
10697 @cindex score variables
10698
10699 @table @code
10700
10701 @item gnus-use-scoring
10702 @vindex gnus-use-scoring
10703 If @code{nil}, Gnus will not check for score files, and will not, in
10704 general, do any score-related work.  This is @code{t} by default.
10705
10706 @item gnus-kill-killed
10707 @vindex gnus-kill-killed
10708 If this variable is @code{nil}, Gnus will never apply score files to
10709 articles that have already been through the kill process.  While this
10710 may save you lots of time, it also means that if you apply a kill file
10711 to a group, and then change the kill file and want to run it over you
10712 group again to kill more articles, it won't work.  You have to set this
10713 variable to @code{t} to do that.  (It is @code{t} by default.)
10714
10715 @item gnus-kill-files-directory
10716 @vindex gnus-kill-files-directory
10717 All kill and score files will be stored in this directory, which is
10718 initialized from the @code{SAVEDIR} environment variable by default.
10719 This is @file{~/News/} by default.
10720
10721 @item gnus-score-file-suffix
10722 @vindex gnus-score-file-suffix
10723 Suffix to add to the group name to arrive at the score file name
10724 (@samp{SCORE} by default.)
10725
10726 @item gnus-score-uncacheable-files
10727 @vindex gnus-score-uncacheable-files
10728 @cindex score cache
10729 All score files are normally cached to avoid excessive re-loading of
10730 score files.  However, if this might make you Emacs grow big and
10731 bloated, so this regexp can be used to weed out score files that are
10732 unlikely to be needed again.  It would be a bad idea to deny caching of
10733 @file{all.SCORE}, while it might be a good idea to not cache
10734 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10735 variable is @samp{ADAPT$} by default, so no adaptive score files will
10736 be cached.
10737
10738 @item gnus-save-score
10739 @vindex gnus-save-score
10740 If you have really complicated score files, and do lots of batch
10741 scoring, then you might set this variable to @code{t}.  This will make
10742 Gnus save the scores into the @file{.newsrc.eld} file.
10743
10744 @item gnus-score-interactive-default-score
10745 @vindex gnus-score-interactive-default-score
10746 Score used by all the interactive raise/lower commands to raise/lower
10747 score with.  Default is 1000, which may seem excessive, but this is to
10748 ensure that the adaptive scoring scheme gets enough room to play with.
10749 We don't want the small changes from the adaptive scoring to overwrite
10750 manually entered data.
10751
10752 @item gnus-summary-default-score
10753 @vindex gnus-summary-default-score
10754 Default score of an article, which is 0 by default.
10755
10756 @item gnus-summary-expunge-below
10757 @vindex gnus-summary-expunge-below
10758 Don't display the summary lines of articles that have scores lower than
10759 this variable.  This is @code{nil} by default, which means that no
10760 articles will be hidden.
10761
10762 @item gnus-score-over-mark
10763 @vindex gnus-score-over-mark
10764 Mark (in the third column) used for articles with a score over the
10765 default.  Default is @samp{+}.
10766
10767 @item gnus-score-below-mark
10768 @vindex gnus-score-below-mark
10769 Mark (in the third column) used for articles with a score below the
10770 default.  Default is @samp{-}.
10771
10772 @item gnus-score-find-score-files-function
10773 @vindex gnus-score-find-score-files-function
10774 Function used to find score files for the current group.  This function
10775 is called with the name of the group as the argument. 
10776
10777 Predefined functions available are:
10778 @table @code
10779
10780 @item gnus-score-find-single
10781 @findex gnus-score-find-single
10782 Only apply the group's own score file.
10783
10784 @item gnus-score-find-bnews
10785 @findex gnus-score-find-bnews
10786 Apply all score files that match, using bnews syntax.  This is the
10787 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10788 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10789 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10790 @samp{all} in the score file names are translated into @samp{.*}, and
10791 then a regexp match is done.
10792
10793 This means that if you have some score entries that you want to apply to
10794 all groups, then you put those entries in the @file{all.SCORE} file. 
10795
10796 The score files are applied in a semi-random order, although Gnus will
10797 try to apply the more general score files before the more specific score
10798 files.  It does this by looking at the number of elements in the score
10799 file names---discarding the @samp{all} elements.
10800
10801 @item gnus-score-find-hierarchical
10802 @findex gnus-score-find-hierarchical
10803 Apply all score files from all the parent groups.  This means that you
10804 can't have score files like @file{all.SCORE}, but you can have
10805 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10806
10807 @end table
10808 This variable can also be a list of functions.  In that case, all these
10809 functions will be called, and all the returned lists of score files will
10810 be applied.  These functions can also return lists of score alists
10811 directly.  In that case, the functions that return these non-file score
10812 alists should probably be placed before the ``real'' score file
10813 functions, to ensure that the last score file returned is the local
10814 score file.  Phu.
10815
10816 @item gnus-score-expiry-days
10817 @vindex gnus-score-expiry-days
10818 This variable says how many days should pass before an unused score file
10819 entry is expired.  If this variable is @code{nil}, no score file entries
10820 are expired.  It's 7 by default.
10821
10822 @item gnus-update-score-entry-dates
10823 @vindex gnus-update-score-entry-dates
10824 If this variable is non-@code{nil}, matching score entries will have
10825 their dates updated.  (This is how Gnus controls expiry---all
10826 non-matching entries will become too old while matching entries will
10827 stay fresh and young.)  However, if you set this variable to @code{nil},
10828 even matching entries will grow old and will have to face that oh-so
10829 grim reaper.  
10830
10831 @item gnus-score-after-write-file-function
10832 @vindex gnus-score-after-write-file-function
10833 Function called with the name of the score file just written.
10834
10835 @end table
10836
10837
10838 @node Score File Format
10839 @section Score File Format
10840 @cindex score file format
10841
10842 A score file is an @code{emacs-lisp} file that normally contains just a
10843 single form.  Casual users are not expected to edit these files;
10844 everything can be changed from the summary buffer.
10845
10846 Anyway, if you'd like to dig into it yourself, here's an example:
10847
10848 @lisp
10849 (("from"
10850   ("Lars Ingebrigtsen" -10000)
10851   ("Per Abrahamsen")
10852   ("larsi\\|lmi" -50000 nil R))
10853  ("subject"
10854   ("Ding is Badd" nil 728373))
10855  ("xref"
10856   ("alt.politics" -1000 728372 s))
10857  ("lines"
10858   (2 -100 nil <))
10859  (mark 0)
10860  (expunge -1000)
10861  (mark-and-expunge -10)
10862  (read-only nil)
10863  (orphan -10)
10864  (adapt t)
10865  (files "/hom/larsi/News/gnu.SCORE")
10866  (exclude-files "all.SCORE")
10867  (local (gnus-newsgroup-auto-expire t)
10868         (gnus-summary-make-false-root 'empty))
10869  (eval (ding)))
10870 @end lisp
10871
10872 This example demonstrates absolutely everything about a score file. 
10873
10874 Even though this looks much like lisp code, nothing here is actually
10875 @code{eval}ed.  The lisp reader is used to read this form, though, so it
10876 has to be legal syntactically, if not semantically.
10877
10878 Six keys are supported by this alist:
10879
10880 @table @code
10881
10882 @item STRING
10883 If the key is a string, it is the name of the header to perform the
10884 match on.  Scoring can only be performed on these eight headers:
10885 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10886 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
10887 these headers, there are three strings to tell Gnus to fetch the entire
10888 article and do the match on larger parts of the article: @code{Body}
10889 will perform the match on the body of the article, @code{Head} will
10890 perform the match on the head of the article, and @code{All} will
10891 perform the match on the entire article.  Note that using any of these
10892 last three keys will slow down group entry @emph{considerably}.  The
10893 final ``header'' you can score on is @code{Followup}.  These score
10894 entries will result in new score entries being added for all follow-ups
10895 to articles that matches these score entries.
10896
10897 Following this key is a arbitrary number of score entries, where each
10898 score entry has one to four elements.
10899 @enumerate
10900
10901 @item 
10902 The first element is the @dfn{match element}.  On most headers this will
10903 be a string, but on the Lines and Chars headers, this must be an
10904 integer. 
10905
10906 @item 
10907 If the second element is present, it should be a number---the @dfn{score
10908 element}.  This number should be an integer in the neginf to posinf
10909 interval.  This number is added to the score of the article if the match
10910 is successful.  If this element is not present, the
10911 @code{gnus-score-interactive-default-score} number will be used
10912 instead.  This is 1000 by default.
10913
10914 @item 
10915 If the third element is present, it should be a number---the @dfn{date
10916 element}.  This date says when the last time this score entry matched,
10917 which provides a mechanism for expiring the score entries.  It this
10918 element is not present, the score entry is permanent.  The date is
10919 represented by the number of days since December 31, 1 ce.
10920
10921 @item 
10922 If the fourth element is present, it should be a symbol---the @dfn{type
10923 element}.  This element specifies what function should be used to see
10924 whether this score entry matches the article.  What match types that can
10925 be used depends on what header you wish to perform the match on.
10926 @table @dfn
10927
10928 @item From, Subject, References, Xref, Message-ID
10929 For most header types, there are the @code{r} and @code{R} (regexp), as
10930 well as @code{s} and @code{S} (substring) types, and @code{e} and
10931 @code{E} (exact match), and @code{w} (word match) types.  If this
10932 element is not present, Gnus will assume that substring matching should
10933 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
10934 that the matches will be done in a case-sensitive manner.  All these
10935 one-letter types are really just abbreviations for the @code{regexp},
10936 @code{string}, @code{exact}, and @code{word} types, which you can use
10937 instead, if you feel like.
10938
10939 @item Lines, Chars
10940 These two headers use different match types: @code{<}, @code{>},
10941 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
10942 careful because some backends (like @code{nndir}) do not generate
10943 @code{Lines} header, so every article ends up being marked as having 0
10944 lines.  This can lead to strange results if you happen to lower score of
10945 the articles with few lines.
10946
10947 @item Date
10948 For the Date header we have three kinda silly match types:
10949 @code{before}, @code{at} and @code{after}.  I can't really imagine this
10950 ever being useful, but, like, it would feel kinda silly not to provide
10951 this function.  Just in case.  You never know.  Better safe than sorry.
10952 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
10953 sex on a first date.  (I have been told that at least one person, and I
10954 quote, ``found this function indispensable'', however.)
10955
10956 @cindex ISO8601
10957 @cindex date
10958 A more useful match type is @code{regexp}.  With it, you can match the
10959 date string using a regular expression.  The date is normalized to
10960 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
10961 match all articles that have been posted on April 1st in every year, you
10962 could use @samp{....0401.........} as a match string, for instance.
10963 (Note that the date is kept in its original time zone, so this will
10964 match articles that were posted when it was April 1st where the article
10965 was posted from.  Time zones are such wholesome fun for the whole
10966 family, eh?)
10967
10968 @item Head, Body, All
10969 These three match keys use the same match types as the @code{From} (etc)
10970 header uses.
10971
10972 @item Followup
10973 This match key is somewhat special, in that it will match the
10974 @code{From} header, and affect the score of not only the matching
10975 articles, but also all followups to the matching articles.  This allows
10976 you e.g. increase the score of followups to your own articles, or
10977 decrease the score of followups to the articles of some known
10978 trouble-maker.  Uses the same match types as the @code{From} header
10979 uses.
10980
10981 @item Thread
10982 This match key works along the same lines as the @code{Followup} match
10983 key.  If you say that you want to score on a (sub-)thread that is
10984 started by an article with a @code{Message-ID} @var{X}, then you add a
10985 @samp{thread} match.  This will add a new @samp{thread} match for each
10986 article that has @var{X} in its @code{References} header.  (These new
10987 @samp{thread} matches will use the @code{Message-ID}s of these matching
10988 articles.)  This will ensure that you can raise/lower the score of an
10989 entire thread, even though some articles in the thread may not have
10990 complete @code{References} headers.  Note that using this may lead to
10991 undeterministic scores of the articles in the thread.
10992 @end table
10993 @end enumerate
10994
10995 @item mark
10996 The value of this entry should be a number.  Any articles with a score
10997 lower than this number will be marked as read.
10998
10999 @item expunge
11000 The value of this entry should be a number.  Any articles with a score
11001 lower than this number will be removed from the summary buffer.
11002
11003 @item mark-and-expunge
11004 The value of this entry should be a number.  Any articles with a score
11005 lower than this number will be marked as read and removed from the
11006 summary buffer.
11007
11008 @item thread-mark-and-expunge
11009 The value of this entry should be a number.  All articles that belong to
11010 a thread that has a total score below this number will be marked as read
11011 and removed from the summary buffer.  @code{gnus-thread-score-function}
11012 says how to compute the total score for a thread.
11013
11014 @item files
11015 The value of this entry should be any number of file names.  These files
11016 are assumed to be score files as well, and will be loaded the same way
11017 this one was.
11018
11019 @item exclude-files
11020 The clue of this entry should be any number of files.  These files will
11021 not be loaded, even though they would normally be so, for some reason or
11022 other. 
11023
11024 @item eval
11025 The value of this entry will be @code{eval}el.  This element will be
11026 ignored when handling global score files. 
11027
11028 @item read-only
11029 Read-only score files will not be updated or saved.  Global score files
11030 should feature this atom (@pxref{Global Score Files}).
11031
11032 @item orphan
11033 The value of this entry should be a number.  Articles that do not have
11034 parents will get this number added to their scores.  Imagine you follow
11035 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
11036 will only follow a few of the threads, also want to see any new threads.
11037
11038 You can do this with the following two score file entries:
11039
11040 @example
11041         (orphan -500)
11042         (mark-and-expunge -100)
11043 @end example
11044
11045 When you enter the group the first time, you will only see the new
11046 threads.  You then raise the score of the threads that you find
11047 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11048 rest.  Next time you enter the group, you will see new articles in the
11049 interesting threads, plus any new threads.
11050
11051 I.e.---the orphan score atom is for high-volume groups where there
11052 exist a few interesting threads which can't be found automatically by
11053 ordinary scoring rules.
11054
11055 @item adapt
11056 This entry controls the adaptive scoring.  If it is @code{t}, the
11057 default adaptive scoring rules will be used.  If it is @code{ignore}, no
11058 adaptive scoring will be performed on this group.  If it is a list, this
11059 list will be used as the adaptive scoring rules.  If it isn't present,
11060 or is something other than @code{t} or @code{ignore}, the default
11061 adaptive scoring rules will be used.  If you want to use adaptive
11062 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11063 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11064 not want adaptive scoring.  If you only want adaptive scoring in a few
11065 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11066 insert @code{(adapt t)} in the score files of the groups where you want
11067 it. 
11068
11069 @item adapt-file
11070 All adaptive score entries will go to the file named by this entry.  It
11071 will also be applied when entering the group.  This atom might be handy
11072 if you want to adapt on several groups at once, using the same adaptive
11073 file for a number of groups.
11074
11075 @item local
11076 @cindex local variables
11077 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11078 Each @var{var} will be made buffer-local to the current summary buffer,
11079 and set to the value specified.  This is a convenient, if somewhat
11080 strange, way of setting variables in some groups if you don't like hooks
11081 much.
11082 @end table
11083
11084
11085 @node Score File Editing
11086 @section Score File Editing
11087
11088 You normally enter all scoring commands from the summary buffer, but you
11089 might feel the urge to edit them by hand as well, so we've supplied you
11090 with a mode for that.  
11091
11092 It's simply a slightly customized @code{emacs-lisp} mode, with these
11093 additional commands:
11094
11095 @table @kbd
11096
11097 @item C-c C-c
11098 @kindex C-c C-c (Score)
11099 @findex gnus-score-edit-done
11100 Save the changes you have made and return to the summary buffer
11101 (@code{gnus-score-edit-done}). 
11102
11103 @item C-c C-d
11104 @kindex C-c C-d (Score)
11105 @findex gnus-score-edit-insert-date
11106 Insert the current date in numerical format
11107 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
11108 you were wondering.
11109
11110 @item C-c C-p
11111 @kindex C-c C-p (Score)
11112 @findex gnus-score-pretty-print
11113 The adaptive score files are saved in an unformatted fashion.  If you
11114 intend to read one of these files, you want to @dfn{pretty print} it
11115 first.  This command (@code{gnus-score-pretty-print}) does that for
11116 you. 
11117
11118 @end table
11119
11120 Type @kbd{M-x gnus-score-mode} to use this mode.
11121
11122 @vindex gnus-score-mode-hook
11123 @code{gnus-score-menu-hook} is run in score mode buffers.
11124
11125 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11126 e} to begin editing score files.
11127
11128
11129 @node Adaptive Scoring
11130 @section Adaptive Scoring
11131 @cindex adaptive scoring
11132
11133 If all this scoring is getting you down, Gnus has a way of making it all
11134 happen automatically---as if by magic.  Or rather, as if by artificial
11135 stupidity, to be precise.
11136
11137 @vindex gnus-use-adaptive-scoring
11138 When you read an article, or mark an article as read, or kill an
11139 article, you leave marks behind.  On exit from the group, Gnus can sniff
11140 these marks and add score elements depending on what marks it finds.
11141 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11142 @code{t} or @code{(line)}.  If you want score adaptively on separate
11143 words appearing in the subjects, you should set this variable to
11144 @code{(word)}.  If you want to use both adaptive methods, set this
11145 variable to @code{(word line)}.
11146
11147 @vindex gnus-default-adaptive-score-alist
11148 To give you complete control over the scoring process, you can customize
11149 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11150 might look something like this:
11151
11152 @lisp
11153 (defvar gnus-default-adaptive-score-alist
11154   '((gnus-unread-mark)
11155     (gnus-ticked-mark (from 4))
11156     (gnus-dormant-mark (from 5))
11157     (gnus-del-mark (from -4) (subject -1))
11158     (gnus-read-mark (from 4) (subject 2))
11159     (gnus-expirable-mark (from -1) (subject -1))
11160     (gnus-killed-mark (from -1) (subject -3))
11161     (gnus-kill-file-mark)
11162     (gnus-ancient-mark)
11163     (gnus-low-score-mark)
11164     (gnus-catchup-mark (from -1) (subject -1))))
11165 @end lisp
11166
11167 As you see, each element in this alist has a mark as a key (either a
11168 variable name or a ``real'' mark---a character).  Following this key is
11169 a arbitrary number of header/score pairs.  If there are no header/score
11170 pairs following the key, no adaptive scoring will be done on articles
11171 that have that key as the article mark.  For instance, articles with
11172 @code{gnus-unread-mark} in the example above will not get adaptive score
11173 entries.
11174
11175 Each article can have only one mark, so just a single of these rules
11176 will be applied to each article.
11177
11178 To take @code{gnus-del-mark} as an example---this alist says that all
11179 articles that have that mark (i.e., are marked with @samp{D}) will have a
11180 score entry added to lower based on the @code{From} header by -4, and
11181 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11182
11183 If you have marked 10 articles with the same subject with
11184 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11185 That means that that subject will get a score of ten times -1, which
11186 should be, unless I'm much mistaken, -10.
11187
11188 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11189 the read articles will be marked with the @samp{E} mark.  This'll
11190 probably make adaptive scoring slightly impossible, so auto-expiring and
11191 adaptive scoring doesn't really mix very well.
11192
11193 The headers you can score on are @code{from}, @code{subject},
11194 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11195 @code{chars} and @code{date}.  In addition, you can score on
11196 @code{followup}, which will create an adaptive score entry that matches
11197 on the @code{References} header using the @code{Message-ID} of the
11198 current article, thereby matching the following thread.  
11199
11200 You can also score on @code{thread}, which will try to score all
11201 articles that appear in a thread.  @code{thread} matches uses a
11202 @code{Message-ID} to match on the @code{References} header of the
11203 article.  If the match is made, the @code{Message-ID} of the article is
11204 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11205 aspirins afterwards.)
11206
11207 If you use this scheme, you should set the score file atom @code{mark}
11208 to something small---like -300, perhaps, to avoid having small random
11209 changes result in articles getting marked as read.
11210
11211 After using adaptive scoring for a week or so, Gnus should start to
11212 become properly trained and enhance the authors you like best, and kill
11213 the authors you like least, without you having to say so explicitly. 
11214
11215 You can control what groups the adaptive scoring is to be performed on
11216 by using the score files (@pxref{Score File Format}).  This will also
11217 let you use different rules in different groups.
11218
11219 @vindex gnus-adaptive-file-suffix
11220 The adaptive score entries will be put into a file where the name is the
11221 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11222 is @samp{ADAPT}.
11223
11224 @vindex gnus-score-exact-adapt-limit
11225 When doing adaptive scoring, substring or fuzzy matching would probably
11226 give you the best results in most cases.  However, if the header one
11227 matches is short, the possibility for false positives is great, so if
11228 the length of the match is less than
11229 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11230 this variable is @code{nil}, exact matching will always be used to avoid
11231 this problem.
11232
11233 @vindex gnus-default-adaptive-word-score-alist
11234 As mentioned above, you can adapt either on individual words or entire
11235 headers.  If you adapt on words, the
11236 @code{gnus-default-adaptive-word-score-alist} variable says what score
11237 each instance of a word should add given a mark.
11238
11239 @lisp
11240 (setq gnus-default-adaptive-word-score-alist  
11241       `((,gnus-read-mark . 30)
11242         (,gnus-catchup-mark . -10)
11243         (,gnus-killed-mark . -20)
11244         (,gnus-del-mark . -15)))
11245 @end lisp
11246
11247 This is the default value.  If you have adaption on words enabled, every
11248 word that appears in subjects of articles that are marked with
11249 @code{gnus-read-mark} will result in a score rule that increase the
11250 score with 30 points.
11251
11252 @vindex gnus-default-ignored-adaptive-words
11253 @vindex gnus-ignored-adaptive-words
11254 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11255 will be ignored.  If you wish to add more words to be ignored, use the
11256 @code{gnus-ignored-adaptive-words} list instead.
11257
11258 @vindex gnus-adaptive-word-syntax-table
11259 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11260 syntax table in effect.  It is similar to the standard syntax table, but
11261 it considers numbers to be non-word-constituent characters.
11262
11263 After using this scheme for a while, it might be nice to write a
11264 @code{gnus-psychoanalyze-user} command to go through the rules and see
11265 what words you like and what words you don't like.  Or perhaps not.
11266
11267 Note that the adaptive word scoring thing is highly experimental and is
11268 likely to change in the future.  Initial impressions seem to indicate
11269 that it's totally useless as it stands.  Some more work (involving more
11270 rigorous statistical methods) will have to be done to make this useful. 
11271
11272
11273 @node Home Score File
11274 @section Home Score File
11275
11276 The score file where new score file entries will go is called the
11277 @dfn{home score file}.  This is normally (and by default) the score file
11278 for the group itself.  For instance, the home score file for
11279 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11280
11281 However, this may not be what you want.  It is often convenient to share
11282 a common home score file among many groups---all @samp{emacs} groups
11283 could perhaps use the same home score file.
11284
11285 @vindex gnus-home-score-file
11286 The variable that controls this is @code{gnus-home-score-file}.  It can
11287 be:
11288
11289 @enumerate
11290 @item
11291 A string.  Then this file will be used as the home score file for all
11292 groups. 
11293
11294 @item
11295 A function. The result of this function will be used as the home score
11296 file.  The function will be called with the name of the group as the
11297 parameter. 
11298
11299 @item
11300 A list.  The elements in this list can be:
11301
11302 @enumerate
11303 @item 
11304 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11305 the @var{file-name} will will be used as the home score file.
11306
11307 @item 
11308 A function. If the function returns non-nil, the result will be used as
11309 the home score file.
11310
11311 @item 
11312 A string.  Use the string as the home score file.
11313 @end enumerate
11314
11315 The list will be traversed from the beginning towards the end looking
11316 for matches.
11317
11318 @end enumerate
11319
11320 So, if you want to use just a single score file, you could say:
11321
11322 @lisp
11323 (setq gnus-home-score-file
11324       "my-total-score-file.SCORE")
11325 @end lisp
11326
11327 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11328 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11329
11330 @lisp
11331 (setq gnus-home-score-file
11332       'gnus-hierarchial-home-score-file)
11333 @end lisp
11334
11335 This is a ready-made function provided for your convenience.
11336
11337 If you want to have one score file for the @samp{emacs} groups and
11338 another for the @samp{comp} groups, while letting all other groups use
11339 their own home score files:
11340
11341 @lisp
11342 (setq gnus-home-score-file
11343       ;; All groups that match the regexp "\\.emacs"
11344       '("\\.emacs" "emacs.SCORE")
11345       ;; All the comp groups in one score file
11346        ("^comp" "comp.SCORE"))
11347 @end lisp
11348    
11349 @vindex gnus-home-adapt-file
11350 @code{gnus-home-adapt-file} works exactly the same way as
11351 @code{gnus-home-score-file}, but says what the home adaptive score file
11352 is instead.  All new adaptive file entries will go into the file
11353 specified by this variable, and the same syntax is allowed.
11354
11355 In addition to using @code{gnus-home-score-file} and
11356 @code{gnus-home-adapt-file}, you can also use group parameters
11357 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11358 Parameters}) to achieve much the same.  Group and topic parameters take
11359 precedence over this variable.
11360
11361
11362 @node Followups To Yourself
11363 @section Followups To Yourself
11364
11365 Gnus offers two commands for picking out the @code{Message-ID} header in
11366 the current buffer.  Gnus will then add a score rule that scores using
11367 this @code{Message-ID} on the @code{References} header of other
11368 articles.  This will, in effect, increase the score of all articles that
11369 respond to the article in the current buffer.  Quite useful if you want
11370 to easily note when people answer what you've said.
11371
11372 @table @code
11373
11374 @item gnus-score-followup-article
11375 @findex gnus-score-followup-article
11376 This will add a score to articles that directly follow up your own
11377 article. 
11378
11379 @item gnus-score-followup-thread
11380 @findex gnus-score-followup-thread
11381 This will add a score to all articles that appear in a thread ``below''
11382 your own article.
11383 @end table
11384
11385 @vindex message-sent-hook
11386 These two functions are both primarily meant to be used in hooks like
11387 @code{message-sent-hook}.  
11388
11389 If you look closely at your own @code{Message-ID}, you'll notice that
11390 the first two or three characters are always the same.  Here's two of
11391 mine:  
11392
11393 @example
11394 <x6u3u47icf.fsf@@eyesore.no>
11395 <x6sp9o7ibw.fsf@@eyesore.no>
11396 @end example
11397
11398 So ``my'' ident on this machine is @samp{x6}.  This can be
11399 exploited---the following rule will raise the score on all followups to
11400 myself: 
11401
11402 @lisp
11403 ("references"
11404  ("<x6[0-9a-z]+\\.fsf@.*eyesore.no>" 1000 nil r))
11405 @end lisp
11406
11407 Whether it's the first two or first three characters that are ``yours''
11408 is system-dependent.
11409
11410
11411 @node Scoring Tips
11412 @section Scoring Tips
11413 @cindex scoring tips
11414
11415 @table @dfn
11416
11417 @item Crossposts
11418 @cindex crossposts
11419 @cindex scoring crossposts
11420 If you want to lower the score of crossposts, the line to match on is
11421 the @code{Xref} header.
11422 @lisp
11423 ("xref" (" talk.politics.misc:" -1000))
11424 @end lisp
11425
11426 @item Multiple crossposts
11427 If you want to lower the score of articles that have been crossposted to
11428 more than, say, 3 groups:
11429 @lisp
11430 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11431 @end lisp
11432
11433 @item Matching on the body
11434 This is generally not a very good idea---it takes a very long time.
11435 Gnus actually has to fetch each individual article from the server.  But
11436 you might want to anyway, I guess.  Even though there are three match
11437 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11438 and stick with it in each score file.  If you use any two, each article
11439 will be fetched @emph{twice}.  If you want to match a bit on the
11440 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11441 the matches.  
11442
11443 @item Marking as read
11444 You will probably want to mark articles that has a score below a certain
11445 number as read.  This is most easily achieved by putting the following
11446 in your @file{all.SCORE} file:
11447 @lisp
11448 ((mark -100))
11449 @end lisp
11450 You may also consider doing something similar with @code{expunge}.  
11451
11452 @item Negated character classes
11453 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11454 That will match newlines, which might lead to, well, The Unknown.  Say
11455 @code{[^abcd\n]*} instead.
11456 @end table
11457
11458
11459 @node Reverse Scoring
11460 @section Reverse Scoring
11461 @cindex reverse scoring
11462
11463 If you want to keep just articles that have @samp{Sex with Emacs} in the
11464 subject header, and expunge all other articles, you could put something
11465 like this in your score file:
11466
11467 @lisp
11468 (("subject"
11469   ("Sex with Emacs" 2))
11470  (mark 1)
11471  (expunge 1))
11472 @end lisp
11473
11474 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11475 rest as read, and expunge them to boot.
11476
11477
11478 @node Global Score Files
11479 @section Global Score Files
11480 @cindex global score files
11481
11482 Sure, other newsreaders have ``global kill files''.  These are usually
11483 nothing more than a single kill file that applies to all groups, stored
11484 in the user's home directory.  Bah!  Puny, weak newsreaders!
11485
11486 What I'm talking about here are Global Score Files.  Score files from
11487 all over the world, from users everywhere, uniting all nations in one
11488 big, happy score file union!  Ange-score!  New and untested!
11489
11490 @vindex gnus-global-score-files
11491 All you have to do to use other people's score files is to set the
11492 @code{gnus-global-score-files} variable.  One entry for each score file,
11493 or each score file directory.  Gnus will decide by itself what score
11494 files are applicable to which group.
11495
11496 Say you want to use the score file
11497 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11498 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11499
11500 @lisp
11501 (setq gnus-global-score-files
11502       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11503         "/ftp@@ftp.some-where:/pub/score/"))
11504 @end lisp
11505
11506 @findex gnus-score-search-global-directories
11507 Simple, eh?  Directory names must end with a @samp{/}.  These
11508 directories are typically scanned only once during each Gnus session.
11509 If you feel the need to manually re-scan the remote directories, you can
11510 use the @code{gnus-score-search-global-directories} command.
11511
11512 Note that, at present, using this option will slow down group entry
11513 somewhat.  (That is---a lot.)
11514
11515 If you want to start maintaining score files for other people to use,
11516 just put your score file up for anonymous ftp and announce it to the
11517 world.  Become a retro-moderator!  Participate in the retro-moderator
11518 wars sure to ensue, where retro-moderators battle it out for the
11519 sympathy of the people, luring them to use their score files on false
11520 premises!  Yay!  The net is saved!
11521
11522 Here are some tips for the would-be retro-moderator, off the top of my
11523 head: 
11524
11525 @itemize @bullet
11526
11527 @item 
11528 Articles that are heavily crossposted are probably junk. 
11529 @item
11530 To lower a single inappropriate article, lower by @code{Message-ID}.
11531 @item
11532 Particularly brilliant authors can be raised on a permanent basis. 
11533 @item
11534 Authors that repeatedly post off-charter for the group can safely be
11535 lowered out of existence.
11536 @item
11537 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11538 articles completely.
11539
11540 @item 
11541 Use expiring score entries to keep the size of the file down.  You
11542 should probably have a long expiry period, though, as some sites keep
11543 old articles for a long time.
11544 @end itemize
11545
11546 ... I wonder whether other newsreaders will support global score files
11547 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11548 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11549 holding our breath yet?
11550
11551
11552 @node Kill Files
11553 @section Kill Files
11554 @cindex kill files
11555
11556 Gnus still supports those pesky old kill files.  In fact, the kill file
11557 entries can now be expiring, which is something I wrote before Daniel
11558 Quinlan thought of doing score files, so I've left the code in there.
11559
11560 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11561 than score processing, so it might be a good idea to rewrite your kill
11562 files into score files.
11563
11564 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11565 forms into this file, which means that you can use kill files as some
11566 sort of primitive hook function to be run on group entry, even though
11567 that isn't a very good idea.
11568
11569 Normal kill files look like this:
11570
11571 @lisp
11572 (gnus-kill "From" "Lars Ingebrigtsen")
11573 (gnus-kill "Subject" "ding")
11574 (gnus-expunge "X")
11575 @end lisp
11576
11577 This will mark every article written by me as read, and remove them from
11578 the summary buffer.  Very useful, you'll agree.
11579
11580 Other programs use a totally different kill file syntax.  If Gnus
11581 encounters what looks like a @code{rn} kill file, it will take a stab at
11582 interpreting it. 
11583
11584 Two summary functions for editing a GNUS kill file:
11585
11586 @table @kbd
11587
11588 @item M-k
11589 @kindex M-k (Summary)
11590 @findex gnus-summary-edit-local-kill
11591 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11592
11593 @item M-K
11594 @kindex M-K (Summary)
11595 @findex gnus-summary-edit-global-kill
11596 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11597 @end table
11598
11599 Two group mode functions for editing the kill files:
11600
11601 @table @kbd
11602
11603 @item M-k
11604 @kindex M-k (Group)
11605 @findex gnus-group-edit-local-kill
11606 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11607
11608 @item M-K
11609 @kindex M-K (Group)
11610 @findex gnus-group-edit-global-kill
11611 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11612 @end table
11613
11614 Kill file variables:
11615
11616 @table @code
11617 @item gnus-kill-file-name
11618 @vindex gnus-kill-file-name
11619 A kill file for the group @samp{soc.motss} is normally called
11620 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11621 this file name is detailed by the @code{gnus-kill-file-name} variable.
11622 The ``global'' kill file (not in the score file sense of ``global'', of
11623 course) is called just @file{KILL}.
11624
11625 @vindex gnus-kill-save-kill-file
11626 @item gnus-kill-save-kill-file
11627 If this variable is non-@code{nil}, Gnus will save the
11628 kill file after processing, which is necessary if you use expiring
11629 kills. 
11630
11631 @item gnus-apply-kill-hook
11632 @vindex gnus-apply-kill-hook
11633 @findex gnus-apply-kill-file-unless-scored
11634 @findex gnus-apply-kill-file
11635 A hook called to apply kill files to a group.  It is
11636 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11637 kill file if you have a score file for the same group, you can set this
11638 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11639 kill files to be processed, you should set this variable to @code{nil}.
11640
11641 @item gnus-kill-file-mode-hook
11642 @vindex gnus-kill-file-mode-hook
11643 A hook called in kill-file mode buffers.
11644
11645 @end table
11646
11647
11648 @node Converting Kill Files
11649 @section Converting Kill Files
11650 @cindex kill files
11651 @cindex converting kill files
11652
11653 If you have loads of old kill files, you may want to convert them into
11654 score files.  If they are ``regular'', you can use
11655 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11656 by hand.
11657
11658 The kill to score conversion package isn't included in Gnus by default.
11659 You can fetch it from
11660 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11661
11662 If your old kill files are very complex---if they contain more
11663 non-@code{gnus-kill} forms than not, you'll have to convert them by
11664 hand.  Or just let them be as they are.  Gnus will still use them as
11665 before. 
11666
11667
11668 @node GroupLens
11669 @section GroupLens
11670 @cindex GroupLens
11671
11672 GroupLens is a collaborative filtering system that helps you work
11673 together with other people to find the quality news articles out of the
11674 huge volume of news articles generated every day.
11675
11676 To accomplish this the GroupLens system combines your opinions about
11677 articles you have already read with the opinions of others who have done
11678 likewise and gives you a personalized prediction for each unread news
11679 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11680 rate articles, and finds other people that rate articles the same way.
11681 Once it has found for you some people you agree with it tells you, in
11682 the form of a prediction, what they thought of the article.  You can use
11683 this prediction to help you decide whether or not you want to read the
11684 article.
11685
11686 @menu
11687 * Using GroupLens::          How to make Gnus use GroupLens.
11688 * Rating Articles::          Letting GroupLens know how you rate articles.
11689 * Displaying Predictions::   Displaying predictions given by GroupLens.
11690 * GroupLens Variables::      Customizing GroupLens.
11691 @end menu
11692
11693
11694 @node Using GroupLens
11695 @subsection Using GroupLens
11696
11697 To use GroupLens you must register a pseudonym with your local Better
11698 Bit Bureau (BBB).
11699 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11700 better bit in town is at the moment.
11701
11702 Once you have registered you'll need to set a couple of variables.
11703
11704 @table @code
11705
11706 @item gnus-use-grouplens
11707 @vindex gnus-use-grouplens
11708 Setting this variable to a non-@code{nil} value will make Gnus hook into
11709 all the relevant GroupLens functions.
11710
11711 @item grouplens-pseudonym
11712 @vindex grouplens-pseudonym
11713 This variable should be set to the pseudonym you got when registering
11714 with the Better Bit Bureau.
11715
11716 @item grouplens-newsgroups
11717 @vindex grouplens-newsgroups
11718 A list of groups that you want to get GroupLens predictions for. 
11719
11720 @end table
11721
11722 Thats the minimum of what you need to get up and running with GroupLens.
11723 Once you've registered, GroupLens will start giving you scores for
11724 articles based on the average of what other people think.  But, to get
11725 the real benefit of GroupLens you need to start rating articles
11726 yourself.  Then the scores GroupLens gives you will be personalized for
11727 you, based on how the people you usually agree with have already rated.
11728
11729
11730 @node Rating Articles
11731 @subsection Rating Articles
11732
11733 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11734 Where 1 means something like this article is a waste of bandwidth and 5
11735 means that the article was really good.  The basic question to ask
11736 yourself is, "on a scale from 1 to 5 would I like to see more articles
11737 like this one?"
11738
11739 There are four ways to enter a rating for an article in GroupLens.
11740
11741 @table @kbd
11742
11743 @item r
11744 @kindex r (GroupLens)
11745 @findex bbb-summary-rate-article
11746 This function will prompt you for a rating on a scale of one to five.
11747
11748 @item k
11749 @kindex k (GroupLens)
11750 @findex grouplens-score-thread
11751 This function will prompt you for a rating, and rate all the articles in
11752 the thread.  This is really useful for some of those long running giant
11753 threads in rec.humor.
11754
11755 @end table
11756
11757 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11758 the score of the article you're reading.
11759
11760 @table @kbd
11761
11762 @item 1-5 n
11763 @kindex n (GroupLens)
11764 @findex grouplens-next-unread-article
11765 Rate the article and go to the next unread article.
11766
11767 @item 1-5 ,
11768 @kindex , (GroupLens)
11769 @findex grouplens-best-unread-article
11770 Rate the article and go to the next unread article with the highest score.
11771
11772 @end table
11773
11774 If you want to give the current article a score of 4 and then go to the
11775 next article, just type @kbd{4 n}.
11776
11777
11778 @node Displaying Predictions
11779 @subsection Displaying Predictions
11780
11781 GroupLens makes a prediction for you about how much you will like a
11782 news article.  The predictions from GroupLens are on a scale from 1 to
11783 5, where 1 is the worst and 5 is the best.  You can use the predictions
11784 from GroupLens in one of three ways controlled by the variable
11785 @code{gnus-grouplens-override-scoring}.
11786
11787 @vindex gnus-grouplens-override-scoring
11788 There are three ways to display predictions in grouplens.  You may
11789 choose to have the GroupLens scores contribute to, or override the
11790 regular gnus scoring mechanism. override is the default; however, some
11791 people prefer to see the Gnus scores plus the grouplens scores.  To get
11792 the separate scoring behavior you need to set
11793 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11794 GroupLens predictions combined with the grouplens scores set it to
11795 @code{'override} and to combine the scores set
11796 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11797 the combine option you will also want to set the values for
11798 @code{grouplens-prediction-offset} and
11799 @code{grouplens-score-scale-factor}.
11800
11801 @vindex grouplens-prediction-display
11802 In either case, GroupLens gives you a few choices for how you would like
11803 to see your predictions displayed.  The display of predictions is
11804 controlled by the @code{grouplens-prediction-display} variable.
11805
11806 The following are legal values for that variable.
11807
11808 @table @code
11809 @item prediction-spot
11810 The higher the prediction, the further to the right an @samp{*} is
11811 displayed. 
11812
11813 @item confidence-interval
11814 A numeric confidence interval.
11815
11816 @item prediction-bar
11817 The higher the prediction, the longer the bar.
11818
11819 @item confidence-bar
11820 Numerical confidence.
11821
11822 @item confidence-spot
11823 The spot gets bigger with more confidence.
11824
11825 @item prediction-num
11826 Plain-old numeric value.
11827
11828 @item confidence-plus-minus
11829 Prediction +/i confidence.
11830
11831 @end table
11832
11833
11834 @node GroupLens Variables
11835 @subsection GroupLens Variables
11836
11837 @table @code
11838
11839 @item gnus-summary-grouplens-line-format
11840 The summary line format used in summary buffers that are GroupLens
11841 enhanced.  It accepts the same specs as the normal summary line format
11842 (@pxref{Summary Buffer Lines}).  The default is
11843 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11844
11845 @item grouplens-bbb-host
11846 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
11847 default.
11848
11849 @item grouplens-bbb-port
11850 Port of the host running the bbbd server.  The default is 9000.
11851
11852 @item grouplens-score-offset
11853 Offset the prediction by this value.  In other words, subtract the
11854 prediction value by this number to arrive at the effective score.  The
11855 default is 0.
11856
11857 @item grouplens-score-scale-factor 
11858 This variable allows the user to magnify the effect of GroupLens scores.
11859 The scale factor is applied after the offset.  The default is 1.
11860
11861 @end table
11862
11863
11864 @node Advanced Scoring
11865 @section Advanced Scoring
11866
11867 Scoring on Subjects and From headers is nice enough, but what if you're
11868 really interested in what a person has to say only when she's talking
11869 about a particular subject?  Or what about if you really don't want to
11870 read what person A has to say when she's following up to person B, but
11871 want to read what she says when she's following up to person C?
11872
11873 By using advanced scoring rules you may create arbitrarily complex
11874 scoring patterns.
11875
11876 @menu
11877 * Advanced Scoring Syntax::     A definition.
11878 * Advanced Scoring Examples::   What they look like.
11879 * Advanced Scoring Tips::       Getting the most out of it.
11880 @end menu
11881
11882
11883 @node Advanced Scoring Syntax
11884 @subsection Advanced Scoring Syntax
11885
11886 Ordinary scoring rules have a string as the first element in the rule.
11887 Advanced scoring rules have a list as the first element.  The second
11888 element is the score to be applied if the first element evaluated to a
11889 non-@code{nil} value.
11890
11891 These lists may consist of three logical operators, one redirection
11892 operator, and various match operators.
11893
11894 Logical operators:
11895
11896 @table @code
11897 @item &
11898 @itemx and
11899 This logical operator will evaluate each of its arguments until it finds
11900 one that evaluates to @code{false}, and then it'll stop.  If all arguments
11901 evaluate to @code{true} values, then this operator will return
11902 @code{true}. 
11903
11904 @item |
11905 @itemx or
11906 This logical operator will evaluate each of its arguments until it finds
11907 one that evaluates to @code{true}.  If no arguments are @code{true},
11908 then this operator will return @code{false}.
11909
11910 @item !
11911 @itemx not
11912 @itemx Â¬
11913 This logical operator only takes a single argument.  It returns the
11914 inverse of the value of its argument.
11915
11916 @end table
11917
11918 There is an @dfn{indirection operator} that will make its arguments
11919 apply to the ancestors of the current article being scored.  For
11920 instance, @code{1-} will make score rules apply to the parent of the
11921 current article.  @code{2-} will make score fules apply to the
11922 grandparent of the current article.  Alternatively, you can write
11923 @code{^^}, where the number of @code{^}s (carets) say how far back into
11924 the ancestry you want to go.
11925
11926 Finally, we have the match operators.  These are the ones that do the
11927 real work.  Match operators are header name strings followed by a match
11928 and a match type.  A typical match operator looks like @samp{("from"
11929 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
11930 simple scoring, and the match types are also the same.
11931
11932
11933 @node Advanced Scoring Examples
11934 @subsection Advanced Scoring Examples
11935
11936 Let's say you want to increase the score of articles written by Lars
11937 when he's talking about Gnus:
11938
11939 @example
11940 ((& 
11941   ("from" "Lars Ingebrigtsen")
11942   ("subject" "Gnus"))
11943  1000)
11944 @end example
11945
11946 Quite simple, huh?
11947
11948 When he writes long articles, he sometimes has something nice to say: 
11949
11950 @example
11951 ((& 
11952   ("from" "Lars Ingebrigtsen")
11953   (|
11954    ("subject" "Gnus")
11955    ("lines" 100 >)))
11956  1000)
11957 @end example
11958
11959 However, when he responds to things written by Reig Eigil Logge, you
11960 really don't want to read what he's written:
11961
11962 @example
11963 ((&
11964   ("from" "Lars Ingebrigtsen")
11965   (1- ("from" "Reig Eigir Logge")))
11966  -100000)
11967 @end example
11968
11969 Everybody that follows up Redmondo when he writes about disappearing
11970 socks should have their scores raised, but only when they talk about
11971 white socks.  However, when Lars talks about socks, it's usually not
11972 very interesting:
11973
11974 @example
11975 ((&
11976   (1-
11977    (&
11978     ("from" "redmondo@@.*no" r)
11979     ("body" "disappearing.*socks" t)))
11980   (! ("from" "Lars Ingebrigtsen"))
11981   ("body" "white.*socks"))
11982  1000)
11983 @end example
11984
11985 The possibilities are endless.
11986
11987
11988 @node Advanced Scoring Tips
11989 @subsection Advanced Scoring Tips
11990
11991 The @code{&} and @code{|} logical operators do short-circuit logic.
11992 That is, they stop processing their arguments when it's clear what the
11993 result of the operation will be.  For instance, if one of the arguments
11994 of an @code{&} evaluates to @code{false}, there's no point in evaluating
11995 the rest of the arguments.  This means that you should put slow matches
11996 (@samp{body}, @code{header}) last and quick matches (@samp{from},
11997 @samp{subject}) first.
11998
11999 The indirection arguments (@code{1-} and so on) will make their
12000 arguments work on previous generations of the thread.  If you say
12001 something like:
12002
12003 @example
12004 ...
12005 (1-
12006  (1-
12007   ("from" "lars")))
12008 ...
12009 @end example
12010
12011 Then that means "score on the from header of the grandparent of the
12012 current article".  An indirection is quite fast, but it's better to say:
12013
12014 @example
12015 (1-
12016  (& 
12017   ("from" "Lars")
12018   ("subject" "Gnus")))
12019 @end example
12020
12021 than it is to say:
12022
12023 @example
12024 (&
12025  (1- ("from" "Lars"))
12026  (1- ("subject" "Gnus")))
12027 @end example
12028
12029
12030 @node Score Decays
12031 @section Score Decays
12032 @cindex score decays
12033 @cindex decays
12034
12035 You may find that your scores have a tendency to grow without
12036 bounds, especially if you're using adaptive scoring.  If scores get too
12037 big, they lose all meaning---they simply max out and it's difficult to
12038 use them in any sensible way.
12039
12040 @vindex gnus-decay-scores
12041 @findex gnus-decay-score
12042 @vindex gnus-score-decay-function
12043 Gnus provides a mechanism for decaying scores to help with this problem.
12044 When score files are loaded and @code{gnus-decay-scores} is
12045 non-@code{nil}, Gnus will run the score files through the decaying
12046 mechanism thereby lowering the scores of all non-permanent score rules.
12047 The decay itself if performed by the @code{gnus-score-decay-function}
12048 function, which is @code{gnus-decay-score} by default.  Here's the
12049 definition of that function:
12050
12051 @lisp
12052 (defun gnus-decay-score (score)
12053   (floor
12054    (- score
12055       (* (if (< score 0) 1 -1)
12056          (min score
12057               (max gnus-score-decay-constant
12058                    (* (abs score)
12059                       gnus-score-decay-scale)))))))
12060 @end lisp
12061
12062 @vindex gnus-score-decay-scale
12063 @vindex gnus-score-decay-constant
12064 @code{gnus-score-decay-constant} is 3 by default and
12065 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
12066
12067 @enumerate
12068 @item
12069 Scores between -3 and 3 will be set to 0 when this function is called.
12070
12071 @item
12072 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12073
12074 @item
12075 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12076 score.
12077 @end enumerate
12078
12079 If you don't like this decay function, write your own.  It is called
12080 with the score to be decayed as its only parameter, and it should return
12081 the new score, which should be an integer.
12082
12083 Gnus will try to decay scores once a day.  If you haven't run Gnus for
12084 four days, Gnus will decay the scores four times, for instance.
12085
12086
12087 @node Various
12088 @chapter Various
12089
12090 @menu
12091 * Process/Prefix::             A convention used by many treatment commands.
12092 * Interactive::                Making Gnus ask you many questions.
12093 * Formatting Variables::       You can specify what buffers should look like.
12094 * Windows Configuration::      Configuring the Gnus buffer windows.
12095 * Compilation::                How to speed Gnus up.
12096 * Mode Lines::                 Displaying information in the mode lines.
12097 * Highlighting and Menus::     Making buffers look all nice and cozy.
12098 * Buttons::                    Get tendonitis in ten easy steps!
12099 * Daemons::                    Gnus can do things behind your back.
12100 * NoCeM::                      How to avoid spam and other fatty foods.
12101 * Picons::                     How to display pictures of what your reading.
12102 * Undo::                       Some actions can be undone.
12103 * Moderation::                 What to do if you're a moderator.
12104 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
12105 * Various Various::            Things that are really various.
12106 @end menu
12107
12108
12109 @node Process/Prefix
12110 @section Process/Prefix
12111 @cindex process/prefix convention
12112
12113 Many functions, among them functions for moving, decoding and saving
12114 articles, use what is known as the @dfn{Process/Prefix convention}.
12115
12116 This is a method for figuring out what articles that the user wants the
12117 command to be performed on.
12118
12119 It goes like this:
12120
12121 If the numeric prefix is N, perform the operation on the next N
12122 articles, starting with the current one.  If the numeric prefix is
12123 negative, perform the operation on the previous N articles, starting
12124 with the current one.
12125
12126 @vindex transient-mark-mode
12127 If @code{transient-mark-mode} in non-@code{nil} and the region is
12128 active, all articles in the region will be worked upon.
12129
12130 If there is no numeric prefix, but some articles are marked with the
12131 process mark, perform the operation on the articles that are marked with
12132 the process mark.
12133
12134 If there is neither a numeric prefix nor any articles marked with the
12135 process mark, just perform the operation on the current article.
12136
12137 Quite simple, really, but it needs to be made clear so that surprises
12138 are avoided.
12139
12140 Commands that react to the process mark will push the current list of
12141 process marked articles onto a stack and will then clear all process
12142 marked articles.  You can restore the previous configuration with the
12143 @kbd{M P y} command (@pxref{Setting Process Marks}).
12144
12145 @vindex gnus-summary-goto-unread
12146 One thing that seems to shock & horrify lots of people is that, for
12147 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12148 Since each @kbd{d} (which marks the current article as read) by default
12149 goes to the next unread article after marking, this means that @kbd{3 d}
12150 will mark the next three unread articles as read, no matter what the
12151 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12152 @code{nil} for a more straightforward action.
12153
12154
12155 @node Interactive
12156 @section Interactive
12157 @cindex interaction
12158
12159 @table @code
12160
12161 @item gnus-novice-user
12162 @vindex gnus-novice-user
12163 If this variable is non-@code{nil}, you are either a newcomer to the
12164 World of Usenet, or you are very cautious, which is a nice thing to be,
12165 really.  You will be given questions of the type ``Are you sure you want
12166 to do this?'' before doing anything dangerous.  This is @code{t} by
12167 default.
12168
12169 @item gnus-expert-user
12170 @vindex gnus-expert-user
12171 If this variable is non-@code{nil}, you will never ever be asked any
12172 questions by Gnus.  It will simply assume you know what you're doing, no
12173 matter how strange.
12174
12175 @item gnus-interactive-catchup
12176 @vindex gnus-interactive-catchup
12177 Require confirmation before catching up a group if non-@code{nil}.  It
12178 is @code{t} by default.
12179
12180 @item gnus-interactive-exit
12181 @vindex gnus-interactive-exit
12182 Require confirmation before exiting Gnus.  This variable is @code{t} by
12183 default. 
12184 @end table
12185
12186
12187 @node Formatting Variables
12188 @section Formatting Variables
12189 @cindex formatting variables
12190
12191 Throughout this manual you've probably noticed lots of variables that
12192 are called things like @code{gnus-group-line-format} and
12193 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12194 output lines in the various buffers.  There's quite a lot of them.
12195 Fortunately, they all use the same syntax, so there's not that much to
12196 be annoyed by.
12197
12198 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12199 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12200 lots of percentages everywhere.  
12201
12202 @menu 
12203 * Formatting Basics::     A formatting variable is basically a format string.
12204 * Advanced Formatting::   Modifying output in various ways.
12205 * User-Defined Specs::    Having Gnus call your own functions.
12206 * Formatting Fonts::      Making the formatting look colorful and nice.
12207 @end menu
12208
12209 Currently Gnus uses the following formatting variables:
12210 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12211 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12212 @code{gnus-group-mode-line-format},
12213 @code{gnus-summary-mode-line-format},
12214 @code{gnus-article-mode-line-format},
12215 @code{gnus-server-mode-line-format}, and
12216 @code{gnus-summary-pick-line-format}.
12217
12218 All these format variables can also be arbitrary elisp forms.  In that
12219 case, they will be @code{eval}ed to insert the required lines.
12220
12221 @kindex M-x gnus-update-format
12222 @findex gnus-update-format
12223 Gnus includes a command to help you while creating your own format
12224 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12225 update the spec in question and pop you to a buffer where you can
12226 examine the resulting lisp code to be run to generate the line.  
12227
12228
12229
12230 @node Formatting Basics
12231 @subsection Formatting Basics
12232
12233 Each @samp{%} element will be replaced by some string or other when the
12234 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12235 spec, and pad with spaces to get a 5-character field''.
12236
12237 As with normal C and Emacs Lisp formatting strings, the numerical
12238 modifier between the @samp{%} and the formatting type character will
12239 @dfn{pad} the output so that it is always at least that long.
12240 @samp{%5y} will make the field always (at least) five characters wide by
12241 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12242 the right instead.
12243
12244 You may also wish to limit the length of the field to protect against
12245 particularly wide values.  For that you can say @samp{%4,6y}, which
12246 means that the field will never be more than 6 characters wide and never
12247 less than 4 characters wide.
12248
12249
12250 @node Advanced Formatting
12251 @subsection Advanced Formatting
12252
12253 It is frequently useful to post-process the fields in some way.
12254 Padding, limiting, cutting off parts and suppressing certain values can
12255 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12256 look like @samp{%~(cut 3)~(ignore "0")y}.
12257
12258 These are the legal modifiers:
12259
12260 @table @code
12261 @item pad
12262 @itemx pad-left
12263 Pad the field to the left with spaces until it reaches the required
12264 length.
12265
12266 @item pad-right
12267 Pad the field to the right with spaces until it reaches the required
12268 length.
12269
12270 @item max
12271 @itemx max-left
12272 Cut off characters from the left until it reaches the specified length.
12273
12274 @item max-right
12275 Cut off characters from the right until it reaches the specified
12276 length. 
12277
12278 @item cut
12279 @itemx cut-left
12280 Cut off the specified number of characters from the left.
12281
12282 @item cut-right
12283 Cut off the specified number of characters from the right.
12284
12285 @item ignore
12286 Return an empty string if the field is equal to the specified value. 
12287
12288 @item form
12289 Use the specified form as the field value when the @samp{@@} spec is
12290 used. 
12291 @end table
12292
12293 Let's take an example.  The @samp{%o} spec in the summary mode lines
12294 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12295 This is quite a mouthful, so we want to shave off the century number and
12296 the time, leaving us with a six-character date.  That would be
12297 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12298 maxing, and we need the padding to ensure that the date is never less
12299 than 6 characters to make it look nice in columns.)
12300
12301 Ignoring is done first; then cutting; then maxing; and then as the very
12302 last operation, padding.  
12303
12304 If you use lots of these advanced thingies, you'll find that Gnus gets
12305 quite slow.  This can be helped enormously by running @kbd{M-x
12306 gnus-compile} when you are satisfied with the look of your lines.
12307 @xref{Compilation}. 
12308
12309
12310 @node User-Defined Specs
12311 @subsection User-Defined Specs
12312
12313 All the specs allow for inserting user defined specifiers---@samp{u}.
12314 The next character in the format string should be a letter.  Gnus
12315 will call the function @code{gnus-user-format-function-}@samp{X}, where
12316 @samp{X} is the letter following @samp{%u}.  The function will be passed
12317 a single parameter---what the parameter means depends on what buffer
12318 it's being called from.  The function should return a string, which will
12319 be inserted into the buffer just like information from any other
12320 specifier.  This function may also be called with dummy values, so it
12321 should protect against that.
12322
12323 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12324 much the same without defining new functions.  Here's an example:
12325 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12326 given here will be evaluated to yield the current line number, and then
12327 inserted.
12328
12329
12330 @node Formatting Fonts
12331 @subsection Formatting Fonts
12332
12333 There are specs for highlighting, and these are shared by all the format
12334 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12335 the special @code{mouse-face} property set, which means that it will be
12336 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12337 over it.
12338
12339 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12340 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12341 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12342 instead, and so on.  Create as many faces as you wish.  The same goes
12343 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12344 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12345
12346 Here's an alternative recipe for the group buffer:
12347
12348 @lisp
12349 ;; Create three face types.
12350 (setq gnus-face-1 'bold)
12351 (setq gnus-face-3 'italic)
12352
12353 ;; We want the article count to be in 
12354 ;; a bold and green face.  So we create 
12355 ;; a new face called `my-green-bold'.
12356 (copy-face 'bold 'my-green-bold)
12357 ;; Set the color.
12358 (set-face-foreground 'my-green-bold "ForestGreen")
12359 (setq gnus-face-2 'my-green-bold)
12360
12361 ;; Set the new & fancy format.
12362 (setq gnus-group-line-format 
12363       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12364 @end lisp
12365
12366 I'm sure you'll be able to use this scheme to create totally unreadable
12367 and extremely vulgar displays.  Have fun!
12368
12369 Note that the @samp{%(} specs (and friends) do not make any sense on the
12370 mode-line variables.
12371
12372
12373 @node Windows Configuration
12374 @section Windows Configuration
12375 @cindex windows configuration
12376
12377 No, there's nothing here about X, so be quiet.
12378
12379 @vindex gnus-use-full-window
12380 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12381 other windows and occupy the entire Emacs screen by itself.  It is
12382 @code{t} by default.
12383
12384 @vindex gnus-buffer-configuration
12385 @code{gnus-buffer-configuration} describes how much space each Gnus
12386 buffer should be given.  Here's an excerpt of this variable:
12387
12388 @lisp
12389 ((group (vertical 1.0 (group 1.0 point)
12390                       (if gnus-carpal (group-carpal 4))))
12391  (article (vertical 1.0 (summary 0.25 point) 
12392                         (article 1.0))))
12393 @end lisp
12394
12395 This is an alist.  The @dfn{key} is a symbol that names some action or
12396 other.  For instance, when displaying the group buffer, the window
12397 configuration function will use @code{group} as the key.  A full list of
12398 possible names is listed below.
12399
12400 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12401 should occupy.  To take the @code{article} split as an example -
12402
12403 @lisp
12404 (article (vertical 1.0 (summary 0.25 point)
12405                        (article 1.0)))
12406 @end lisp
12407
12408 This @dfn{split} says that the summary buffer should occupy 25% of upper
12409 half of the screen, and that it is placed over the article buffer.  As
12410 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12411 reaching for that calculator there).  However, the special number
12412 @code{1.0} is used to signal that this buffer should soak up all the
12413 rest of the space available after the rest of the buffers have taken
12414 whatever they need.  There should be only one buffer with the @code{1.0}
12415 size spec per split.
12416
12417 Point will be put in the buffer that has the optional third element
12418 @code{point}. 
12419
12420 Here's a more complicated example:
12421
12422 @lisp
12423 (article (vertical 1.0 (group 4)
12424                        (summary 0.25 point)
12425                        (if gnus-carpal (summary-carpal 4))
12426                        (article 1.0)))
12427 @end lisp
12428
12429 If the size spec is an integer instead of a floating point number, 
12430 then that number will be used to say how many lines a buffer should
12431 occupy, not a percentage.
12432
12433 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12434 precise---if the @code{car} of the split is a function or a subr), this
12435 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12436 be used as a split.  This means that there will be three buffers if
12437 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12438 is non-@code{nil}.
12439
12440 Not complicated enough for you?  Well, try this on for size:
12441
12442 @lisp
12443 (article (horizontal 1.0 
12444              (vertical 0.5
12445                  (group 1.0)
12446                  (gnus-carpal 4))
12447              (vertical 1.0
12448                  (summary 0.25 point)
12449                  (summary-carpal 4)
12450                  (article 1.0))))
12451 @end lisp
12452
12453 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12454 @code{horizontal} thingie?  
12455
12456 If the first element in one of the split is @code{horizontal}, Gnus will
12457 split the window horizontally, giving you two windows side-by-side.
12458 Inside each of these strips you may carry on all you like in the normal
12459 fashion.  The number following @code{horizontal} says what percentage of
12460 the screen is to be given to this strip.
12461
12462 For each split, there @emph{must} be one element that has the 100% tag.
12463 The splitting is never accurate, and this buffer will eat any leftover
12464 lines from the splits.
12465
12466 To be slightly more formal, here's a definition of what a legal split
12467 may look like:
12468
12469 @example
12470 split       = frame | horizontal | vertical | buffer | form
12471 frame       = "(frame " size *split ")"
12472 horizontal  = "(horizontal " size *split ")"
12473 vertical    = "(vertical " size *split ")"
12474 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12475 size        = number | frame-params
12476 buffer-name = group | article | summary ...
12477 @end example
12478
12479 The limitations are that the @code{frame} split can only appear as the
12480 top-level split.  @var{form} should be an Emacs Lisp form that should
12481 return a valid split.  We see that each split is fully recursive, and
12482 may contain any number of @code{vertical} and @code{horizontal} splits. 
12483
12484 @vindex gnus-window-min-width
12485 @vindex gnus-window-min-height
12486 @cindex window height
12487 @cindex window width
12488 Finding the right sizes can be a bit complicated.  No window may be less
12489 than @code{gnus-window-min-height} (default 1) characters high, and all
12490 windows must be at least @code{gnus-window-min-width} (default 1)
12491 characters wide.  Gnus will try to enforce this before applying the
12492 splits.  If you want to use the normal Emacs window width/height limit,
12493 you can just set these two variables to @code{nil}.
12494
12495 If you're not familiar with Emacs terminology, @code{horizontal} and
12496 @code{vertical} splits may work the opposite way of what you'd expect.
12497 Windows inside a @code{horizontal} split are shown side-by-side, and
12498 windows within a @code{vertical} split are shown above each other.
12499
12500 @findex gnus-configure-frame
12501 If you want to experiment with window placement, a good tip is to call
12502 @code{gnus-configure-frame} directly with a split.  This is the function
12503 that does all the real work when splitting buffers.  Below is a pretty
12504 nonsensical configuration with 5 windows; two for the group buffer and
12505 three for the article buffer.  (I said it was nonsensical.)  If you
12506 @code{eval} the statement below, you can get an idea of how that would
12507 look straight away, without going through the normal Gnus channels.
12508 Play with it until you're satisfied, and then use
12509 @code{gnus-add-configuration} to add your new creation to the buffer
12510 configuration list. 
12511
12512 @lisp
12513 (gnus-configure-frame
12514  '(horizontal 1.0
12515     (vertical 10
12516       (group 1.0)
12517       (article 0.3 point))
12518     (vertical 1.0
12519       (article 1.0)
12520       (horizontal 4
12521         (group 1.0)
12522         (article 10)))))
12523 @end lisp
12524
12525 You might want to have several frames as well.  No prob---just use the
12526 @code{frame} split:
12527
12528 @lisp
12529 (gnus-configure-frame
12530  '(frame 1.0
12531          (vertical 1.0
12532                    (summary 0.25 point)
12533                    (article 1.0))
12534          (vertical ((height . 5) (width . 15)
12535                     (user-position . t)
12536                     (left . -1) (top . 1))
12537                    (picon 1.0))))
12538
12539 @end lisp
12540
12541 This split will result in the familiar summary/article window
12542 configuration in the first (or ``main'') frame, while a small additional
12543 frame will be created where picons will be shown.  As you can see,
12544 instead of the normal @code{1.0} top-level spec, each additional split
12545 should have a frame parameter alist as the size spec.
12546 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12547 Reference Manual}.
12548
12549 Here's a list of all possible keys for
12550 @code{gnus-buffer-configuration}:
12551
12552 @code{group}, @code{summary}, @code{article}, @code{server},
12553 @code{browse}, @code{message}, @code{pick}, @code{info},
12554 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12555 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12556 @code{reply-yank}, @code{mail-bounce}, @code{draft},
12557 @code{pipe}, @code{bug}, @code{compose-bounce}.  
12558
12559 Note that the @code{message} key is used for both
12560 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12561 it is desirable to distinguish between the two, something like this
12562 might be used:
12563
12564 @lisp
12565 (message (horizontal 1.0
12566                      (vertical 1.0 (message 1.0 point))
12567                      (vertical 0.24
12568                                (if (buffer-live-p gnus-summary-buffer)
12569                                    '(summary 0.5))
12570                                (group 1.0)))))
12571 @end lisp
12572
12573 @findex gnus-add-configuration
12574 Since the @code{gnus-buffer-configuration} variable is so long and
12575 complicated, there's a function you can use to ease changing the config
12576 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12577 you want to change the @code{article} setting, you could say:
12578
12579 @lisp
12580 (gnus-add-configuration
12581  '(article (vertical 1.0
12582                (group 4)
12583                (summary .25 point)
12584                (article 1.0))))
12585 @end lisp
12586
12587 You'd typically stick these @code{gnus-add-configuration} calls in your
12588 @file{.gnus.el} file or in some startup hook---they should be run after
12589 Gnus has been loaded.
12590
12591 @vindex gnus-always-force-window-configuration
12592 If all windows mentioned in the configuration are already visible, Gnus
12593 won't change the window configuration.  If you always want to force the
12594 ``right'' window configuration, you can set
12595 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12596
12597
12598 @node Compilation
12599 @section Compilation
12600 @cindex compilation
12601 @cindex byte-compilation
12602
12603 @findex gnus-compile
12604
12605 Remember all those line format specification variables?
12606 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12607 on.  Now, Gnus will of course heed whatever these variables are, but,
12608 unfortunately, changing them will mean a quite significant slow-down.
12609 (The default values of these variables have byte-compiled functions
12610 associated with them, while the user-generated versions do not, of
12611 course.) 
12612
12613 To help with this, you can run @kbd{M-x gnus-compile} after you've
12614 fiddled around with the variables and feel that you're (kind of)
12615 satisfied.  This will result in the new specs being byte-compiled, and
12616 you'll get top speed again.  Gnus will save these compiled specs in the
12617 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12618 this function, though---you should compile them yourself by sticking
12619 them into the @code{.gnus.el} file and byte-compiling that file.)
12620
12621
12622 @node Mode Lines
12623 @section Mode Lines
12624 @cindex mode lines
12625
12626 @vindex gnus-updated-mode-lines
12627 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12628 lines updated.  It is a list of symbols.  Supported symbols include
12629 @code{group}, @code{article}, @code{summary}, @code{server},
12630 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12631 Gnus will keep that mode line updated with information that may be
12632 pertinent.  If this variable is @code{nil}, screen refresh may be
12633 quicker.
12634
12635 @cindex display-time
12636
12637 @vindex gnus-mode-non-string-length
12638 By default, Gnus displays information on the current article in the mode
12639 lines of the summary and article buffers.  The information Gnus wishes
12640 to display (e.g. the subject of the article) is often longer than the
12641 mode lines, and therefore have to be cut off at some point.  The
12642 @code{gnus-mode-non-string-length} variable says how long the other
12643 elements on the line is (i.e., the non-info part).  If you put
12644 additional elements on the mode line (e.g. a clock), you should modify
12645 this variable:
12646
12647 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12648 @lisp
12649 (add-hook 'display-time-hook
12650           (lambda () (setq gnus-mode-non-string-length
12651                            (+ 21
12652                               (if line-number-mode 5 0)
12653                               (if column-number-mode 4 0)
12654                               (length display-time-string)))))
12655 @end lisp
12656
12657 If this variable is @code{nil} (which is the default), the mode line
12658 strings won't be chopped off, and they won't be padded either.
12659 Note that the default is unlikely to be desirable, as even the
12660 percentage complete in the buffer may be crowded off the mode line;
12661 the user should configure this variable appropriately for their
12662 configuration.
12663
12664
12665 @node Highlighting and Menus
12666 @section Highlighting and Menus
12667 @cindex visual
12668 @cindex highlighting
12669 @cindex menus
12670
12671 @vindex gnus-visual
12672 The @code{gnus-visual} variable controls most of the prettifying Gnus
12673 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12674 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12675 file.
12676
12677 This variable can be a list of visual properties that are enabled.  The
12678 following elements are legal, and are all included by default:
12679
12680 @table @code
12681 @item group-highlight
12682 Do highlights in the group buffer.
12683 @item summary-highlight
12684 Do highlights in the summary buffer.
12685 @item article-highlight
12686 Do highlights in the article buffer.
12687 @item highlight
12688 Turn on highlighting in all buffers.
12689 @item group-menu
12690 Create menus in the group buffer.
12691 @item summary-menu
12692 Create menus in the summary buffers.
12693 @item article-menu
12694 Create menus in the article buffer.
12695 @item browse-menu
12696 Create menus in the browse buffer.
12697 @item server-menu
12698 Create menus in the server buffer.
12699 @item score-menu
12700 Create menus in the score buffers.
12701 @item menu
12702 Create menus in all buffers.
12703 @end table
12704
12705 So if you only want highlighting in the article buffer and menus in all
12706 buffers, you could say something like:
12707
12708 @lisp
12709 (setq gnus-visual '(article-highlight menu))
12710 @end lisp
12711
12712 If you want only highlighting and no menus whatsoever, you'd say:
12713
12714 @lisp
12715 (setq gnus-visual '(highlight))
12716 @end lisp
12717
12718 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12719 in all Gnus buffers.
12720
12721 Other general variables that influence the look of all buffers include:
12722
12723 @table @code
12724 @item gnus-mouse-face
12725 @vindex gnus-mouse-face
12726 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12727 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12728
12729 @end table
12730
12731 There are hooks associated with the creation of all the different menus:
12732
12733 @table @code
12734
12735 @item gnus-article-menu-hook
12736 @vindex gnus-article-menu-hook
12737 Hook called after creating the article mode menu.
12738
12739 @item gnus-group-menu-hook
12740 @vindex gnus-group-menu-hook
12741 Hook called after creating the group mode menu.
12742
12743 @item gnus-summary-menu-hook
12744 @vindex gnus-summary-menu-hook
12745 Hook called after creating the summary mode menu.
12746
12747 @item gnus-server-menu-hook
12748 @vindex gnus-server-menu-hook
12749 Hook called after creating the server mode menu.
12750
12751 @item gnus-browse-menu-hook
12752 @vindex gnus-browse-menu-hook
12753 Hook called after creating the browse mode menu.
12754
12755 @item gnus-score-menu-hook
12756 @vindex gnus-score-menu-hook
12757 Hook called after creating the score mode menu.
12758
12759 @end table
12760
12761
12762 @node Buttons
12763 @section Buttons
12764 @cindex buttons
12765 @cindex mouse
12766 @cindex click
12767
12768 Those new-fangled @dfn{mouse} contraptions is very popular with the
12769 young, hep kids who don't want to learn the proper way to do things
12770 these days.  Why, I remember way back in the summer of '89, when I was
12771 using Emacs on a Tops 20 system.  Three hundred users on one single
12772 machine, and every user was running Simula compilers.  Bah!
12773
12774 Right.
12775
12776 @vindex gnus-carpal
12777 Well, you can make Gnus display bufferfuls of buttons you can click to
12778 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12779 really.  Tell the chiropractor I sent you.
12780
12781
12782 @table @code
12783
12784 @item gnus-carpal-mode-hook
12785 @vindex gnus-carpal-mode-hook
12786 Hook run in all carpal mode buffers.
12787
12788 @item gnus-carpal-button-face
12789 @vindex gnus-carpal-button-face
12790 Face used on buttons.
12791
12792 @item gnus-carpal-header-face
12793 @vindex gnus-carpal-header-face
12794 Face used on carpal buffer headers.
12795
12796 @item gnus-carpal-group-buffer-buttons
12797 @vindex gnus-carpal-group-buffer-buttons
12798 Buttons in the group buffer.
12799
12800 @item gnus-carpal-summary-buffer-buttons
12801 @vindex gnus-carpal-summary-buffer-buttons
12802 Buttons in the summary buffer.
12803
12804 @item gnus-carpal-server-buffer-buttons
12805 @vindex gnus-carpal-server-buffer-buttons
12806 Buttons in the server buffer.
12807
12808 @item gnus-carpal-browse-buffer-buttons
12809 @vindex gnus-carpal-browse-buffer-buttons
12810 Buttons in the browse buffer.
12811 @end table
12812
12813 All the @code{buttons} variables are lists.  The elements in these list
12814 is either a cons cell where the car contains a text to be displayed and
12815 the cdr contains a function symbol, or a simple string.
12816
12817
12818 @node Daemons
12819 @section Daemons
12820 @cindex demons
12821 @cindex daemons
12822
12823 Gnus, being larger than any program ever written (allegedly), does lots
12824 of strange stuff that you may wish to have done while you're not
12825 present.  For instance, you may want it to check for new mail once in a
12826 while.  Or you may want it to close down all connections to all servers
12827 when you leave Emacs idle.  And stuff like that.
12828
12829 Gnus will let you do stuff like that by defining various
12830 @dfn{handlers}.  Each handler consists of three elements:  A
12831 @var{function}, a @var{time}, and an @var{idle} parameter.
12832
12833 Here's an example of a handler that closes connections when Emacs has
12834 been idle for thirty minutes:
12835
12836 @lisp
12837 (gnus-demon-close-connections nil 30)
12838 @end lisp
12839
12840 Here's a handler that scans for PGP headers every hour when Emacs is
12841 idle: 
12842
12843 @lisp
12844 (gnus-demon-scan-pgp 60 t)
12845 @end lisp
12846
12847 This @var{time} parameter and than @var{idle} parameter works together
12848 in a strange, but wonderful fashion.  Basically, if @var{idle} is
12849 @code{nil}, then the function will be called every @var{time} minutes.
12850
12851 If @var{idle} is @code{t}, then the function will be called after
12852 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
12853 the function will never be called.  But once Emacs goes idle, the
12854 function will be called every @var{time} minutes.
12855
12856 If @var{idle} is a number and @var{time} is a number, the function will
12857 be called every @var{time} minutes only when Emacs has been idle for
12858 @var{idle} minutes.
12859
12860 If @var{idle} is a number and @var{time} is @code{nil}, the function
12861 will be called once every time Emacs has been idle for @var{idle}
12862 minutes.  
12863
12864 And if @var{time} is a string, it should look like @samp{07:31}, and
12865 the function will then be called once every day somewhere near that
12866 time.  Modified by the @var{idle} parameter, of course.
12867
12868 @vindex gnus-demon-timestep
12869 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12870 seconds.  This is 60 by default.  If you change that variable,
12871 all the timings in the handlers will be affected.)
12872
12873 @vindex gnus-use-demon
12874 To set the whole thing in motion, though, you have to set
12875 @code{gnus-use-demon} to @code{t}.
12876
12877 So, if you want to add a handler, you could put something like this in
12878 your @file{.gnus} file:
12879
12880 @findex gnus-demon-add-handler
12881 @lisp
12882 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12883 @end lisp
12884
12885 @findex gnus-demon-add-nocem
12886 @findex gnus-demon-add-scanmail
12887 @findex gnus-demon-add-rescan
12888 @findex gnus-demon-add-disconnection
12889 Some ready-made functions to do this has been created:
12890 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12891 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}.  Just
12892 put those functions in your @file{.gnus} if you want those abilities.
12893
12894 @findex gnus-demon-init
12895 @findex gnus-demon-cancel
12896 @vindex gnus-demon-handlers
12897 If you add handlers to @code{gnus-demon-handlers} directly, you should
12898 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
12899 daemons, you can use the @code{gnus-demon-cancel} function.
12900
12901 Note that adding daemons can be pretty naughty if you overdo it.  Adding
12902 functions that scan all news and mail from all servers every two seconds
12903 is a sure-fire way of getting booted off any respectable system.  So
12904 behave. 
12905
12906
12907 @node NoCeM
12908 @section NoCeM
12909 @cindex nocem
12910 @cindex spam
12911
12912 @dfn{Spamming} is posting the same article lots and lots of times.
12913 Spamming is bad.  Spamming is evil.  
12914
12915 Spamming is usually canceled within a day or so by various anti-spamming
12916 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
12917 NoCeM is pronounced ``no see-'em'', and means what the name
12918 implies---these are messages that make the offending articles, like, go
12919 away.  
12920
12921 What use are these NoCeM messages if the articles are canceled anyway?
12922 Some sites do not honor cancel messages and some sites just honor cancels
12923 from a select few people.  Then you may wish to make use of the NoCeM
12924 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12925
12926 Gnus can read and parse the messages in this group automatically, and
12927 this will make spam disappear.  
12928
12929 There are some variables to customize, of course:
12930
12931 @table @code
12932 @item gnus-use-nocem
12933 @vindex gnus-use-nocem
12934 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
12935 by default. 
12936
12937 @item gnus-nocem-groups
12938 @vindex gnus-nocem-groups
12939 Gnus will look for NoCeM messages in the groups in this list.  The
12940 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
12941 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
12942
12943 @item gnus-nocem-issuers
12944 @vindex gnus-nocem-issuers
12945 There are many people issuing NoCeM messages.  This list says what
12946 people you want to listen to.  The default is @code{("Automoose-1"
12947 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
12948 (Richard E. Depew)")}; fine, upstanding citizens all of them.
12949
12950 Known despammers that you can put in this list include:
12951
12952 @table @samp
12953 @item clewis@@ferret.ocunix.on.ca;
12954 @cindex Chris Lewis
12955 Chris Lewis---Major Canadian despammer who has probably canceled more
12956 usenet abuse than anybody else.
12957
12958 @item Automoose-1
12959 @cindex CancelMoose[tm]
12960 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
12961 Norwegian, and was the person(s) who invented NoCeM.  
12962
12963 @item jem@@xpat.com;
12964 @cindex Jem
12965 John Milburn---despammer located in Korea who is getting very busy these
12966 days.
12967
12968 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
12969 Richard E. Depew---lone American despammer.  He mostly cancels binary
12970 postings to non-binary groups and removes spews (regurgitated articles).
12971 @end table
12972
12973 You do not have to heed NoCeM messages from all these people---just the
12974 ones you want to listen to.
12975
12976 @item gnus-nocem-verifyer
12977 @vindex gnus-nocem-verifyer
12978 @findex mc-verify
12979 This should be a function for verifying that the NoCeM issuer is who she
12980 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
12981 function.  If this is too slow and you don't care for verification
12982 (which may be dangerous), you can set this variable to @code{nil}.
12983
12984 @item gnus-nocem-directory
12985 @vindex gnus-nocem-directory
12986 This is where Gnus will store its NoCeM cache files.  The default is
12987 @file{~/News/NoCeM/}. 
12988
12989 @item gnus-nocem-expiry-wait
12990 @vindex gnus-nocem-expiry-wait
12991 The number of days before removing old NoCeM entries from the cache.
12992 The default is 15.  If you make it shorter Gnus will be faster, but you
12993 might then see old spam.
12994
12995 @end table
12996
12997
12998 @node Picons
12999 @section Picons
13000
13001 So...  You want to slow down your news reader even more!  This is a
13002 good way to do so.  Its also a great way to impress people staring
13003 over your shoulder as you read news.
13004
13005 @menu
13006 * Picon Basics::           What are picons and How do I get them.
13007 * Picon Requirements::     Don't go further if you aren't using XEmacs.
13008 * Easy Picons::            Displaying Picons---the easy way.
13009 * Hard Picons::            The way you should do it.  You'll learn something.
13010 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
13011 @end menu
13012
13013
13014 @node Picon Basics
13015 @subsection Picon Basics
13016
13017 What are Picons?  To quote directly from the Picons Web site:
13018
13019 @quotation 
13020 @dfn{Picons} is short for ``personal icons''.  They're small,
13021 constrained images used to represent users and domains on the net,
13022 organized into databases so that the appropriate image for a given
13023 e-mail address can be found.  Besides users and domains, there are picon
13024 databases for Usenet newsgroups and weather forecasts.  The picons are
13025 in either monochrome @code{XBM} format or color @code{XPM} and
13026 @code{GIF} formats.
13027 @end quotation
13028
13029 For instructions on obtaining and installing the picons databases, point
13030 your Web browser at
13031 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13032
13033 @vindex gnus-picons-database
13034 Gnus expects picons to be installed into a location pointed to by
13035 @code{gnus-picons-database}.
13036
13037
13038 @node Picon Requirements
13039 @subsection Picon Requirements
13040
13041 To use have Gnus display Picons for you, you must be running XEmacs
13042 19.13 or greater since all other versions of Emacs aren't yet able to
13043 display images.
13044
13045 Additionally, you must have @code{xpm} support compiled into XEmacs.
13046
13047 @vindex gnus-picons-convert-x-face
13048 If you want to display faces from @code{X-Face} headers, you must have
13049 the @code{netpbm} utilities installed, or munge the
13050 @code{gnus-picons-convert-x-face} variable to use something else.
13051
13052
13053 @node Easy Picons
13054 @subsection Easy Picons
13055
13056 To enable displaying picons, simply put the following line in your
13057 @file{~/.gnus} file and start Gnus.
13058
13059 @lisp
13060 (setq gnus-use-picons t)
13061 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13062 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13063 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13064 @end lisp
13065
13066
13067 @node Hard Picons
13068 @subsection Hard Picons 
13069
13070 Gnus can display picons for you as you enter and leave groups and
13071 articles.  It knows how to interact with three sections of the picons
13072 database.  Namely, it can display the picons newsgroup pictures,
13073 author's face picture(s), and the authors domain.  To enable this
13074 feature, you need to first decide where to display them.
13075
13076 @table @code 
13077
13078 @item gnus-picons-display-where 
13079 @vindex gnus-picons-display-where 
13080 Where the picon images should be displayed.  It is @code{picons} by
13081 default (which by default maps to the buffer @samp{*Picons*}).  Other
13082 valid places could be @code{article}, @code{summary}, or
13083 @samp{*scratch*} for all I care.  Just make sure that you've made the
13084 buffer visible using the standard Gnus window configuration
13085 routines---@pxref{Windows Configuration}.
13086
13087 @end table
13088
13089 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13090 window configuration for you to include the @code{picons} buffer.
13091
13092 Now that you've made that decision, you need to add the following
13093 functions to the appropriate hooks so these pictures will get
13094 displayed at the right time.
13095
13096 @vindex gnus-article-display-hook
13097 @vindex gnus-picons-display-where
13098 @table @code
13099 @item gnus-article-display-picons
13100 @findex gnus-article-display-picons
13101 Looks up and display the picons for the author and the author's domain
13102 in the @code{gnus-picons-display-where} buffer.  Should be added to
13103 the @code{gnus-article-display-hook}.
13104
13105 @item gnus-group-display-picons
13106 @findex gnus-article-display-picons
13107 Displays picons representing the current group.  This function should
13108 be added to the @code{gnus-summary-prepare-hook} or to the
13109 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13110 is set to @code{article}.
13111
13112 @item gnus-picons-article-display-x-face
13113 @findex gnus-article-display-picons
13114 Decodes and displays the X-Face header if present.  This function
13115 should be added to @code{gnus-article-display-hook}.
13116
13117 @end table
13118
13119 Note:  You must append them to the hook, so make sure to specify 't'
13120 to the append flag of @code{add-hook}:
13121
13122 @lisp
13123 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13124 @end lisp
13125
13126
13127 @node Picon Configuration
13128 @subsection Picon Configuration
13129
13130 The following variables offer further control over how things are
13131 done, where things are located, and other useless stuff you really
13132 don't need to worry about.
13133
13134 @table @code
13135 @item gnus-picons-database
13136 @vindex gnus-picons-database
13137 The location of the picons database.  Should point to a directory
13138 containing the @file{news}, @file{domains}, @file{users} (and so on)
13139 subdirectories.  Defaults to @file{/usr/local/faces}.
13140
13141 @item gnus-picons-news-directory
13142 @vindex gnus-picons-news-directory
13143 Sub-directory of the faces database containing the icons for
13144 newsgroups.
13145
13146 @item gnus-picons-user-directories
13147 @vindex gnus-picons-user-directories
13148 List of subdirectories to search in @code{gnus-picons-database} for user
13149 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13150
13151 @item gnus-picons-domain-directories
13152 @vindex gnus-picons-domain-directories
13153 List of subdirectories to search in @code{gnus-picons-database} for
13154 domain name faces.  Defaults to @code{("domains")}.  Some people may
13155 want to add @samp{unknown} to this list.
13156
13157 @item gnus-picons-convert-x-face
13158 @vindex gnus-picons-convert-x-face
13159 The command to use to convert the @code{X-Face} header to an X bitmap
13160 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13161 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13162 gnus-picons-x-face-file-name)}
13163
13164 @item gnus-picons-x-face-file-name
13165 @vindex gnus-picons-x-face-file-name
13166 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13167 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13168
13169 @item gnus-picons-buffer
13170 @vindex gnus-picons-buffer
13171 The name of the buffer that @code{picons} points to.  Defaults to
13172 @samp{*Icon Buffer*}.
13173
13174 @end table
13175
13176
13177 @node Undo
13178 @section Undo
13179 @cindex undo
13180
13181 It is very useful to be able to undo actions one has done.  In normal
13182 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13183 In Gnus buffers, however, it isn't that simple.
13184
13185 The things Gnus displays in its buffer is of no value whatsoever to
13186 Gnus---it's all just data that is designed to look nice to the user.
13187 Killing a group in the group buffer with @kbd{C-k} makes the line
13188 disappear, but that's just a side-effect of the real action---the
13189 removal of the group in question from the internal Gnus structures.
13190 Undoing something like that can't be done by the normal Emacs
13191 @code{undo} function.
13192
13193 Gnus tries to remedy this somewhat by keeping track of what the user
13194 does and coming up with actions that would reverse the actions the user
13195 takes.  When the user then presses the @code{undo} key, Gnus will run
13196 the code to reverse the previous action, or the previous actions.
13197 However, not all actions are easily reversible, so Gnus currently offers
13198 a few key functions to be undoable.  These include killing groups,
13199 yanking groups, and changing the list of read articles of groups.
13200 That's it, really.  More functions may be added in the future, but each
13201 added function means an increase in data to be stored, so Gnus will
13202 never be totally undoable.
13203
13204 @findex gnus-undo-mode
13205 @vindex gnus-use-undo
13206 @findex gnus-undo
13207 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13208 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13209 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13210 command, which should feel kinda like the normal Emacs @code{undo}
13211 command. 
13212
13213
13214 @node Moderation
13215 @section Moderation
13216 @cindex moderation
13217
13218 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13219 It is not included in the standard Gnus package.  Write a mail to
13220 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13221 get a copy.
13222
13223 The moderation package is implemented as a minor mode for summary
13224 buffers.  Put
13225
13226 @lisp
13227 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13228 @end lisp
13229
13230 in your @file{.gnus.el} file.
13231
13232 If you are the moderation of @samp{rec.zoofle}, this is how it's
13233 supposed to work:
13234
13235 @enumerate
13236 @item 
13237 You split your incoming mail by matching on
13238 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13239 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13240
13241 @item
13242 You enter that group once in a while and post articles using the @kbd{e}
13243 (edit-and-post) or @kbd{s} (just send unedited) commands.
13244
13245 @item
13246 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13247 articles that weren't approved by you, you can cancel them with the
13248 @kbd{c} command.
13249 @end enumerate
13250
13251 To use moderation mode in these two groups, say:
13252
13253 @lisp
13254 (setq gnus-moderated-list
13255       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13256 @end lisp
13257
13258
13259 @node XEmacs Enhancements
13260 @section XEmacs Enhancements
13261 @cindex XEmacs
13262
13263 XEmacs is able to display pictures and stuff, so Gnus has taken
13264 advantage of that.  Relevant variables include:
13265
13266 @table @code
13267 @item gnus-xmas-glyph-directory
13268 @vindex gnus-xmas-glyph-directory
13269 This is where Gnus will look for pictures.  Gnus will normally
13270 auto-detect this directory, but you may set it manually if you have an
13271 unusual directory structure.
13272
13273 @item gnus-xmas-logo-color-alist
13274 @vindex gnus-xmas-logo-color-alist
13275 This is an alist where the key is a type symbol and the values are the
13276 foreground and background color of the splash page glyph.
13277
13278 @item gnus-xmas-logo-color-style
13279 @vindex gnus-xmas-logo-color-style
13280 This is the key used to look up the color in the alist described above.
13281 Legal values include @code{flame}, @code{pine}, @code{moss},
13282 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13283 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13284
13285 @item gnus-use-toolbar
13286 @vindex gnus-use-toolbar
13287 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13288 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13289 @code{right-toolbar}, or @code{left-toolbar}.
13290
13291 @item gnus-group-toolbar
13292 @vindex gnus-group-toolbar
13293 The toolbar in the group buffer.
13294
13295 @item gnus-summary-toolbar
13296 @vindex gnus-summary-toolbar
13297 The toolbar in the summary buffer.
13298
13299 @item gnus-summary-mail-toolbar
13300 @vindex gnus-summary-mail-toolbar
13301 The toolbar in the summary buffer of mail groups.
13302
13303 @item gnus-xmas-modeline-glyph
13304 @vindex gnus-xmas-modeline-glyph
13305 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13306 default. 
13307
13308 @end table
13309
13310
13311 @node Various Various
13312 @section Various Various
13313 @cindex mode lines
13314 @cindex highlights
13315
13316 @table @code
13317
13318 @item gnus-directory
13319 @vindex gnus-directory
13320 All Gnus directories will be initialized from this variable, which
13321 defaults to the @samp{SAVEDIR} environment variable, or @file{~/News/}
13322 if that variable isn't set.
13323
13324 @item gnus-default-directory
13325 @vindex gnus-default-directory
13326 Not related to the above variable at all---this variable says what the
13327 default directory of all Gnus buffers should be.  If you issue commands
13328 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13329 default directory.  If this variable is @code{nil} (which is the
13330 default), the default directory will be the default directory of the
13331 buffer you were in when you started Gnus.
13332
13333 @item gnus-verbose
13334 @vindex gnus-verbose
13335 This variable is an integer between zero and ten.  The higher the value,
13336 the more messages will be displayed.  If this variable is zero, Gnus
13337 will never flash any messages, if it is seven (which is the default),
13338 most important messages will be shown, and if it is ten, Gnus won't ever
13339 shut up, but will flash so many messages it will make your head swim.
13340
13341 @item gnus-verbose-backends
13342 @vindex gnus-verbose-backends
13343 This variable works the same way as @code{gnus-verbose}, but it applies
13344 to the Gnus backends instead of Gnus proper.
13345
13346 @item nnheader-max-head-length
13347 @vindex nnheader-max-head-length
13348 When the backends read straight heads of articles, they all try to read
13349 as little as possible.  This variable (default 4096) specifies
13350 the absolute max length the backends will try to read before giving up
13351 on finding a separator line between the head and the body.  If this
13352 variable is @code{nil}, there is no upper read bound.  If it is
13353 @code{t}, the backends won't try to read the articles piece by piece,
13354 but read the entire articles.  This makes sense with some versions of
13355 @code{ange-ftp}. 
13356
13357 @item nnheader-head-chop-length
13358 @vindex nnheader-head-chop-length
13359 This variable says how big a piece of each article to read when doing
13360 the operation described above.
13361
13362 @item nnheader-file-name-translation-alist 
13363 @vindex nnheader-file-name-translation-alist 
13364 @cindex file names
13365 @cindex illegal characters in file names
13366 @cindex characters in file names
13367 This is an alist that says how to translate characters in file names.
13368 For instance, if @samp{:} is illegal as a file character in file names
13369 on your system (you OS/2 user you), you could say something like:
13370
13371 @lisp
13372 (setq nnheader-file-name-translation-alist 
13373       '((?: . ?_)))
13374 @end lisp
13375
13376 In fact, this is the default value for this variable on OS/2 and MS
13377 Windows (phooey) systems.
13378
13379 @item gnus-hidden-properties
13380 @vindex gnus-hidden-properties
13381 This is a list of properties to use to hide ``invisible'' text.  It is
13382 @code{(invisible t intangible t)} by default on most systems, which
13383 makes invisible text invisible and intangible.
13384
13385 @item gnus-parse-headers-hook
13386 @vindex gnus-parse-headers-hook
13387 A hook called before parsing headers.  It can be used, for instance, to
13388 gather statistics on the headers fetched, or perhaps you'd like to prune
13389 some headers.  I don't see why you'd want that, though.
13390
13391 @item gnus-shell-command-separator
13392 @vindex gnus-shell-command-separator
13393 String used to separate to shell commands.  The default is @samp{;}. 
13394
13395
13396 @end table
13397
13398
13399 @node The End
13400 @chapter The End
13401
13402 Well, that's the manual---you can get on with your life now.  Keep in
13403 touch.  Say hello to your cats from me.  
13404
13405 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13406
13407 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13408
13409 @quotation
13410 @strong{Te Deum}
13411
13412 @sp 1
13413 Not because of victories @*
13414 I sing,@*
13415 having none,@*
13416 but for the common sunshine,@*
13417 the breeze,@*
13418 the largess of the spring.
13419
13420 @sp 1
13421 Not for victory@*
13422 but for the day's work done@*
13423 as well as I was able;@*
13424 not for a seat upon the dais@*
13425 but at the common table.@*
13426 @end quotation
13427
13428
13429 @node Appendices
13430 @chapter Appendices
13431
13432 @menu
13433 * History::                        How Gnus got where it is today.
13434 * Terminology::                    We use really difficult, like, words here.
13435 * Customization::                  Tailoring Gnus to your needs.
13436 * Troubleshooting::                What you might try if things do not work.
13437 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13438 * Emacs for Heathens::             A short introduction to Emacsian terms.
13439 * Frequently Asked Questions::     A question-and-answer session.
13440 @end menu
13441
13442
13443 @node History
13444 @section History
13445
13446 @cindex history
13447 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13448 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13449
13450 If you want to investigate the person responsible for this outrage, you
13451 can point your (feh!) web browser to
13452 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13453 distribution point for the new and spiffy versions of Gnus, and is known
13454 as The Site That Destroys Newsrcs And Drives People Mad.
13455
13456 During the first extended alpha period of development, the new Gnus was
13457 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13458 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13459 (Besides, the ``Gnus'' in this abbreviation should probably be
13460 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13461 appropriate name, don't you think?)
13462
13463 In any case, after spending all that energy on coming up with a new and
13464 spunky name, we decided that the name was @emph{too} spunky, so we
13465 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13466 ``@sc{gnus}''.  New vs. old.
13467
13468 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13469 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13470 plus 15 Gnus 5.0 releases).
13471
13472 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13473 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13474
13475 On July 28th 1996 work on Red Gnus was begun, and it was released on
13476 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13477
13478 If you happen upon a version of Gnus that has a name that is prefixed --
13479 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13480 don't panic.  Don't let it know that you're frightened.  Back away.
13481 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13482 out of its reach.  Find a proper released version of Gnus and snuggle up
13483 to that instead.
13484
13485 @menu
13486 * Why?::                What's the point of Gnus?
13487 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13488 * Conformity::          Gnus tries to conform to all standards.
13489 * Emacsen::             Gnus can be run on a few modern Emacsen.
13490 * Contributors::        Oodles of people.  
13491 * New Features::        Pointers to some of the new stuff in Gnus.
13492 * Newest Features::     Features so new that they haven't been written yet.
13493 @end menu
13494
13495
13496 @node Why?
13497 @subsection Why?
13498
13499 What's the point of Gnus?  
13500
13501 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13502 newsreader, that lets you do anything you can think of.  That was my
13503 original motivation, but while working on Gnus, it has become clear to
13504 me that this generation of newsreaders really belong in the stone age.
13505 Newsreaders haven't developed much since the infancy of the net.  If the
13506 volume continues to rise with the current rate of increase, all current
13507 newsreaders will be pretty much useless.  How do you deal with
13508 newsgroups that have thousands of new articles each day?  How do you
13509 keep track of millions of people who post?
13510
13511 Gnus offers no real solutions to these questions, but I would very much
13512 like to see Gnus being used as a testing ground for new methods of
13513 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13514 to separate the newsreader from the backends, Gnus now offers a simple
13515 interface for anybody who wants to write new backends for fetching mail
13516 and news from different sources.  I have added hooks for customizations
13517 everywhere I could imagine useful.  By doing so, I'm inviting every one
13518 of you to explore and invent.
13519
13520 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13521
13522
13523 @node Compatibility
13524 @subsection Compatibility
13525
13526 @cindex compatibility
13527 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13528 bindings have been kept.  More key bindings have been added, of course,
13529 but only in one or two obscure cases have old bindings been changed.
13530
13531 Our motto is:
13532 @quotation
13533 @cartouche
13534 @center In a cloud bones of steel.
13535 @end cartouche
13536 @end quotation
13537
13538 All commands have kept their names.  Some internal functions have changed
13539 their names.
13540
13541 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13542 Articles}. 
13543
13544 One major compatibility question is the presence of several summary
13545 buffers.  All variables that are relevant while reading a group are
13546 buffer-local to the summary buffer they belong in.  Although many
13547 important variables have their values copied into their global
13548 counterparts whenever a command is executed in the summary buffer, this
13549 change might lead to incorrect values being used unless you are careful.
13550
13551 All code that relies on knowledge of @sc{gnus} internals will probably
13552 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13553 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13554 maintains a hash table that points to the entries in this alist (which
13555 speeds up many functions), and changing the alist directly will lead to
13556 peculiar results.
13557
13558 @cindex hilit19
13559 @cindex highlighting
13560 Old hilit19 code does not work at all.  In fact, you should probably
13561 remove all hilit code from all Gnus hooks
13562 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13563 Gnus provides various integrated functions for highlighting.  These are
13564 faster and more accurate.  To make life easier for everybody, Gnus will
13565 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13566 Away!
13567
13568 Packages like @code{expire-kill} will no longer work.  As a matter of
13569 fact, you should probably remove all old @sc{gnus} packages (and other
13570 code) when you start using Gnus.  More likely than not, Gnus already
13571 does what you have written code to make @sc{gnus} do.  (Snicker.)
13572
13573 Even though old methods of doing things are still supported, only the
13574 new methods are documented in this manual.  If you detect a new method of
13575 doing something while reading this manual, that does not mean you have
13576 to stop doing it the old way.
13577
13578 Gnus understands all @sc{gnus} startup files.
13579
13580 @kindex M-x gnus-bug
13581 @findex gnus-bug
13582 @cindex reporting bugs
13583 @cindex bugs
13584 Overall, a casual user who hasn't written much code that depends on
13585 @sc{gnus} internals should suffer no problems.  If problems occur,
13586 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13587
13588
13589 @node Conformity
13590 @subsection Conformity
13591
13592 No rebels without a clue here, ma'am.  We conform to all standards known
13593 to (wo)man.  Except for those standards and/or conventions we disagree
13594 with, of course.
13595
13596 @table @strong
13597
13598 @item RFC 822
13599 @cindex RFC 822
13600 There are no known breaches of this standard.
13601
13602 @item RFC 1036
13603 @cindex RFC 1036
13604 There are no known breaches of this standard, either.
13605
13606 @item Good Net-Keeping Seal of Approval
13607 @cindex Good Net-Keeping Seal of Approval
13608 Gnus has been through the Seal process and failed.  I think it'll pass
13609 the next inspection.
13610
13611 @item Son-of-RFC 1036
13612 @cindex Son-of-RFC 1036
13613 We do have some breaches to this one.
13614
13615 @table @emph
13616
13617 @item MIME
13618 Gnus does no MIME handling, and this standard-to-be seems to think that
13619 MIME is the bees' knees, so we have major breakage here.
13620
13621 @item X-Newsreader
13622 This is considered to be a ``vanity header'', while I consider it to be
13623 consumer information.  After seeing so many badly formatted articles
13624 coming from @code{tin} and @code{Netscape} I know not to use either of
13625 those for posting articles.  I would not have known that if it wasn't
13626 for the @code{X-Newsreader} header.
13627 @end table
13628
13629 @end table
13630
13631 If you ever notice Gnus acting non-compliantly with regards to the texts
13632 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13633 know.
13634
13635
13636 @node Emacsen
13637 @subsection Emacsen
13638 @cindex Emacsen
13639 @cindex XEmacs
13640 @cindex Mule
13641 @cindex Emacs
13642
13643 Gnus should work on :
13644
13645 @itemize @bullet 
13646
13647 @item
13648 Emacs 19.32 and up.
13649
13650 @item
13651 XEmacs 19.14 and up.
13652
13653 @item 
13654 Mule versions based on Emacs 19.32 and up.
13655
13656 @end itemize
13657
13658 Gnus will absolutely not work on any Emacsen older than that.  Not
13659 reliably, at least. 
13660
13661 There are some vague differences between Gnus on the various
13662 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13663 other than that, things should look pretty much the same under all
13664 Emacsen. 
13665
13666
13667 @node Contributors
13668 @subsection Contributors
13669 @cindex contributors
13670
13671 The new Gnus version couldn't have been done without the help of all the
13672 people on the (ding) mailing list.  Every day for over a year I have
13673 gotten billions of nice bug reports from them, filling me with joy,
13674 every single one of them.  Smooches.  The people on the list have been
13675 tried beyond endurance, what with my ``oh, that's a neat idea <type
13676 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13677 work at all <type type>, yup, I'll ship that one off right away <ship
13678 off> no, wait, that absolutely does not work'' policy for releases.
13679 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
13680 ``worser''? ``much worser''?  ``worsest''?)
13681
13682 I would like to take this opportunity to thank the Academy for...  oops,
13683 wrong show.
13684
13685 @itemize @bullet
13686
13687 @item 
13688 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13689
13690 @item 
13691 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13692 well as numerous other things).
13693
13694 @item 
13695 Luis Fernandes---design and graphics.
13696
13697 @item
13698 Erik Naggum---help, ideas, support, code and stuff.
13699
13700 @item 
13701 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13702 @dfn{picons} (@pxref{Picons}).
13703
13704 @item 
13705 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13706 (@pxref{GroupLens}).
13707
13708 @item 
13709 Sudish Joseph---innumerable bug fixes.
13710
13711 @item 
13712 Ilja Weis---@file{gnus-topic.el}.
13713
13714 @item 
13715 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13716
13717 @item 
13718 Vladimir Alexiev---the refcard and reference booklets.
13719
13720 @item 
13721 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13722 distribution by Felix Lee and JWZ.
13723
13724 @item 
13725 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13726
13727 @item 
13728 Peter Mutsaers---orphan article scoring code.
13729
13730 @item 
13731 Ken Raeburn---POP mail support.
13732
13733 @item 
13734 Hallvard B Furuseth---various bits and pieces, especially dealing with
13735 .newsrc files.
13736
13737 @item 
13738 Brian Edmonds---@file{gnus-bbdb.el}.
13739
13740 @item
13741 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
13742
13743 @item 
13744 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13745
13746 @item 
13747 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13748
13749 @item
13750 François Pinard---many, many interesting and thorough bug reports.
13751
13752 @end itemize
13753
13754 The following people have contributed many patches and suggestions: 
13755
13756 Christopher Davis,
13757 Andrew Eskilsson,
13758 Kai Grossjohann,
13759 David KÃ¥gedal,
13760 Richard Pieri,
13761 Fabrice Popineau, 
13762 Daniel Quinlan, 
13763 Jason L. Tibbitts, III,
13764 and
13765 Jack Vinson.
13766
13767 Also thanks to the following for patches and stuff:
13768
13769 Peter Arius, 
13770 Marc Auslander,
13771 Chris Bone,
13772 Mark Borges,
13773 Lance A. Brown,
13774 Kees de Bruin,
13775 Martin Buchholz,
13776 Kevin Buhr,
13777 Alastair Burt,
13778 Joao Cachopo,
13779 Massimo Campostrini,
13780 Michael R. Cook,
13781 Glenn Coombs, 
13782 Frank D. Cringle, 
13783 Geoffrey T. Dairiki,
13784 Andre Deparade,
13785 Ulrik Dickow,
13786 Dave Disser,
13787 Joev Dubach,
13788 Paul Eggert,
13789 Michael Ernst,
13790 Luc Van Eycken,
13791 Sam Falkner,
13792 Paul Franklin, 
13793 David S. Goldberg,
13794 D. Hall, 
13795 Magnus Hammerin,
13796 Raja R. Harinath,
13797 Hisashige Kenji, @c Hisashige
13798 Marc Horowitz,
13799 François Felix Ingrand,
13800 Ishikawa Ichiro, @c Ishikawa
13801 Lee Iverson, 
13802 Rajappa Iyer,
13803 Randell Jesup,
13804 Fred Johansen, 
13805 Greg Klanderman,
13806 Peter Skov Knudsen,
13807 Shuhei Kobayashi, @c Kobayashi
13808 Thor Kristoffersen,
13809 Jens Lautenbacher,
13810 Carsten Leonhardt,
13811 Christian Limpach,
13812 Markus Linnala,
13813 Dave Love,
13814 Tonny Madsen,
13815 Shlomo Mahlab,
13816 Nat Makarevitch,
13817 Timo Metzemakers,
13818 Richard Mlynarik,
13819 Lantz Moore,
13820 Morioka Tomohiko, @c Morioka
13821 Erik Toubro Nielsen,
13822 Hrvoje Niksic,
13823 Andy Norman,
13824 C. R. Oldham,
13825 Alexandre Oliva,
13826 Ken Olstad,
13827 Masaharu Onishi, @c Onishi
13828 Hideki Ono, @c Ono
13829 William Perry,
13830 Stephen Peters,
13831 Ulrich Pfeifer,
13832 John McClary Prevost,
13833 Colin Rafferty,
13834 Bart Robinson,
13835 Jason Rumney,
13836 Loren Schall,
13837 Dan Schmidt,
13838 Ralph Schleicher,
13839 Randal L. Schwartz,
13840 Danny Siu, 
13841 Paul D. Smith,
13842 Jeff Sparkes,
13843 Michael Sperber,
13844 Richard Stallman,
13845 Greg Stark, 
13846 Paul Stodghill,
13847 Kurt Swanson,
13848 Samuel Tardieu, 
13849 Teddy,
13850 Chuck Thompson,
13851 Philippe Troin,
13852 Jan Vroonhof,
13853 Barry A. Warsaw,
13854 Christoph Wedler,
13855 Joe Wells,
13856 and
13857 Katsumi Yamaoka. @c Yamaoka
13858
13859 For a full overview of what each person has done, the ChangeLogs
13860 included in the Gnus alpha distributions should give ample reading
13861 (550kB and counting).
13862
13863 Apologies to everybody that I've forgotten, of which there are many, I'm
13864 sure.  
13865
13866 Gee, that's quite a list of people.  I guess that must mean that there
13867 actually are people who are using Gnus.  Who'd'a thunk it!
13868
13869
13870 @node New Features
13871 @subsection New Features
13872 @cindex new features
13873
13874 @menu
13875 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
13876 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
13877 * Red Gnus::           Third time best---Gnus 5.4/5.5.
13878 @end menu
13879
13880 These lists are, of course, just @emph{short} overviews of the
13881 @emph{most} important new features.  No, really.  There are tons more.
13882 Yes, we have feeping creaturism in full effect.
13883
13884
13885 @node ding Gnus
13886 @subsubsection (ding) Gnus
13887
13888 New features in Gnus 5.0/5.1:
13889
13890 @itemize @bullet
13891
13892 @item
13893 The look of all buffers can be changed by setting format-like variables
13894 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
13895  
13896 @item 
13897 Local spool and several @sc{nntp} servers can be used at once
13898 (@pxref{Select Methods}).  
13899
13900 @item 
13901 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13902
13903 @item 
13904 You can read a number of different mail formats (@pxref{Getting Mail}).
13905 All the mail backends implement a convenient mail expiry scheme
13906 (@pxref{Expiring Mail}). 
13907
13908 @item
13909 Gnus can use various strategies for gathering threads that have lost
13910 their roots (thereby gathering loose sub-threads into one thread) or it
13911 can go back and retrieve enough headers to build a complete thread
13912 (@pxref{Customizing Threading}).
13913
13914 @item 
13915 Killed groups can be displayed in the group buffer, and you can read
13916 them as well (@pxref{Listing Groups}).
13917
13918 @item 
13919 Gnus can do partial group updates---you do not have to retrieve the
13920 entire active file just to check for new articles in a few groups
13921 (@pxref{The Active File}).
13922
13923 @item 
13924 Gnus implements a sliding scale of subscribedness to groups
13925 (@pxref{Group Levels}).
13926
13927 @item 
13928 You can score articles according to any number of criteria
13929 (@pxref{Scoring}).  You can even get Gnus to find out how to score
13930 articles for you (@pxref{Adaptive Scoring}).
13931
13932 @item 
13933 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
13934 manner, so it should be difficult to lose much data on what you have
13935 read if your machine should go down (@pxref{Auto Save}). 
13936
13937 @item 
13938 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
13939 the @file{.emacs} file.
13940
13941 @item 
13942 You can set the process mark on both groups and articles and perform
13943 operations on all the marked items (@pxref{Process/Prefix}).
13944
13945 @item 
13946 You can grep through a subset of groups and create a group from the
13947 results (@pxref{Kibozed Groups}). 
13948
13949 @item 
13950 You can list subsets of groups according to, well, anything
13951 (@pxref{Listing Groups}). 
13952
13953 @item 
13954 You can browse foreign servers and subscribe to groups from those
13955 servers (@pxref{Browse Foreign Server}). 
13956
13957 @item 
13958 Gnus can fetch articles asynchronously on a second connection to the
13959 server (@pxref{Asynchronous Fetching}).
13960
13961 @item 
13962 You can cache articles locally (@pxref{Article Caching}). 
13963
13964 @item 
13965 The uudecode functions have been expanded and generalized
13966 (@pxref{Decoding Articles}). 
13967
13968 @item
13969 You can still post uuencoded articles, which was a little-known feature
13970 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
13971
13972 @item
13973 Fetching parents (and other articles) now actually works without
13974 glitches (@pxref{Finding the Parent}). 
13975
13976 @item
13977 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
13978
13979 @item
13980 Digests (and other files) can be used as the basis for groups
13981 (@pxref{Document Groups}).
13982
13983 @item 
13984 Articles can be highlighted and customized (@pxref{Customizing
13985 Articles}). 
13986
13987 @item 
13988 URLs and other external references can be buttonized (@pxref{Article
13989 Buttons}). 
13990
13991 @item
13992 You can do lots of strange stuff with the Gnus window & frame
13993 configuration (@pxref{Windows Configuration}).
13994
13995 @item
13996 You can click on buttons instead of using the keyboard
13997 (@pxref{Buttons}). 
13998
13999 @end itemize
14000
14001
14002 @node September Gnus
14003 @subsubsection September Gnus
14004
14005 New features in Gnus 5.2/5.3:
14006
14007 @itemize @bullet
14008
14009 @item
14010 A new message composition mode is used.  All old customization variables
14011 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14012 now obsolete.
14013
14014 @item
14015 Gnus is now able to generate @dfn{sparse} threads---threads where
14016 missing articles are represented by empty nodes (@pxref{Customizing
14017 Threading}). 
14018
14019 @lisp
14020 (setq gnus-build-sparse-threads 'some)
14021 @end lisp
14022
14023 @item
14024 Outgoing articles are stored on a special archive server
14025 (@pxref{Archived Messages}). 
14026
14027 @item
14028 Partial thread regeneration now happens when articles are
14029 referred. 
14030
14031 @item
14032 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14033
14034 @item
14035 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
14036
14037 @item
14038 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14039
14040 @lisp
14041 (setq gnus-use-trees t)
14042 @end lisp
14043
14044 @item
14045 An @code{nn}-like pick-and-read minor mode is available for the summary
14046 buffers (@pxref{Pick and Read}).
14047
14048 @lisp
14049 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14050 @end lisp
14051
14052 @item
14053 In binary groups you can use a special binary minor mode (@pxref{Binary
14054 Groups}). 
14055
14056 @item
14057 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14058 Topics}).
14059
14060 @lisp
14061 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14062 @end lisp
14063
14064 @item
14065 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14066
14067 @item
14068 Groups can now have a score, and bubbling based on entry frequency
14069 is possible (@pxref{Group Score}).
14070
14071 @lisp
14072 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14073 @end lisp
14074
14075 @item
14076 Groups can be process-marked, and commands can be performed on
14077 groups of groups (@pxref{Marking Groups}).
14078
14079 @item
14080 Caching is possible in virtual groups.
14081
14082 @item
14083 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14084 news batches, ClariNet briefs collections, and just about everything
14085 else (@pxref{Document Groups}).
14086
14087 @item
14088 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14089 (@pxref{SOUP}).
14090
14091 @item
14092 The Gnus cache is much faster.
14093
14094 @item
14095 Groups can be sorted according to many criteria (@pxref{Sorting
14096 Groups}).
14097
14098 @item
14099 New group parameters have been introduced to set list-address and
14100 expiry times (@pxref{Group Parameters}).
14101
14102 @item
14103 All formatting specs allow specifying faces to be used
14104 (@pxref{Formatting Fonts}).
14105
14106 @item
14107 There are several more commands for setting/removing/acting on process
14108 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14109
14110 @item
14111 The summary buffer can be limited to show parts of the available
14112 articles based on a wide range of criteria.  These commands have been
14113 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14114
14115 @item
14116 Articles can be made persistent with the @kbd{*} command
14117 (@pxref{Persistent Articles}).
14118
14119 @item
14120 All functions for hiding article elements are now toggles.
14121
14122 @item
14123 Article headers can be buttonized (@pxref{Article Washing}).
14124
14125 @lisp
14126 (add-hook 'gnus-article-display-hook 
14127           'gnus-article-add-buttons-to-head)
14128 @end lisp
14129
14130 @item
14131 All mail backends support fetching articles by @code{Message-ID}.
14132
14133 @item
14134 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14135
14136 @item
14137 All summary mode commands are available directly from the article
14138 buffer (@pxref{Article Keymap}). 
14139
14140 @item
14141 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14142 Configuration}).
14143
14144 @item
14145 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14146
14147 @item
14148 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14149
14150 @lisp
14151 (setq gnus-use-nocem t)
14152 @end lisp
14153
14154 @item
14155 Groups can be made permanently visible (@pxref{Listing Groups}).
14156
14157 @lisp
14158 (setq gnus-permanently-visible-groups "^nnml:")
14159 @end lisp
14160
14161 @item
14162 Many new hooks have been introduced to make customizing easier. 
14163
14164 @item
14165 Gnus respects the @code{Mail-Copies-To} header.
14166
14167 @item
14168 Threads can be gathered by looking at the @code{References} header
14169 (@pxref{Customizing Threading}).
14170
14171 @lisp
14172 (setq gnus-summary-thread-gathering-function 
14173       'gnus-gather-threads-by-references)
14174 @end lisp
14175
14176 @item
14177 Read articles can be stored in a special backlog buffer to avoid
14178 refetching (@pxref{Article Backlog}).  
14179
14180 @lisp
14181 (setq gnus-keep-backlog 50)
14182 @end lisp
14183
14184 @item
14185 A clean copy of the current article is always stored in a separate
14186 buffer to allow easier treatment.
14187
14188 @item
14189 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14190
14191 @item
14192 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14193 Articles}). 
14194
14195 @lisp
14196 (setq gnus-prompt-before-saving t)
14197 @end lisp
14198
14199 @item
14200 @code{gnus-uu} can view decoded files asynchronously while fetching
14201 articles (@pxref{Other Decode Variables}). 
14202
14203 @lisp
14204 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14205 @end lisp
14206
14207 @item
14208 Filling in the article buffer now works properly on cited text
14209 (@pxref{Article Washing}).
14210
14211 @item
14212 Hiding cited text adds buttons to toggle hiding, and how much
14213 cited text to hide is now customizable (@pxref{Article Hiding}).
14214
14215 @lisp
14216 (setq gnus-cited-lines-visible 2)
14217 @end lisp
14218
14219 @item
14220 Boring headers can be hidden (@pxref{Article Hiding}).
14221
14222 @lisp
14223 (add-hook 'gnus-article-display-hook 
14224           'gnus-article-hide-boring-headers t)
14225 @end lisp
14226
14227 @item
14228 Default scoring values can now be set from the menu bar.
14229
14230 @item
14231 Further syntax checking of outgoing articles have been added.
14232
14233 @end itemize
14234
14235
14236 @node Red Gnus
14237 @subsubsection Red Gnus
14238
14239 New features in Gnus 5.4/5.5:
14240
14241 @itemize @bullet
14242
14243 @item
14244 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14245
14246 @item
14247 Article prefetching functionality has been moved up into 
14248 Gnus (@pxref{Asynchronous Fetching}).  
14249
14250 @item
14251 Scoring can now be performed with logical operators like @code{and},
14252 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14253 Scoring}).
14254
14255 @item
14256 Article washing status can be displayed in the
14257 article mode line (@pxref{Misc Article}).
14258
14259 @item
14260 @file{gnus.el} has been split into many smaller files.
14261
14262 @item
14263 Suppression of duplicate articles based on Message-ID can be done
14264 (@pxref{Duplicate Suppression}).
14265
14266 @lisp
14267 (setq gnus-suppress-duplicates t)
14268 @end lisp
14269
14270 @item
14271 New variables for specifying what score and adapt files are to be
14272 considered home score and adapt files (@pxref{Home Score File}).
14273
14274 @item
14275 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14276 Server Internals}). 
14277
14278 @item
14279 Groups can inherit group parameters from parent topics (@pxref{Topic
14280 Parameters}).
14281
14282 @item
14283 Article editing has been revamped and is now actually usable.
14284
14285 @item
14286 Signatures can be recognized in more intelligent fashions
14287 (@pxref{Article Signature}).
14288
14289 @item
14290 Summary pick mode has been made to look more @code{nn}-like.  Line
14291 numbers are displayed and the @kbd{.} command can be used to pick
14292 articles (@code{Pick and Read}).
14293
14294 @item
14295 Commands for moving the @file{.newsrc.eld} from one server to
14296 another have been added (@pxref{Changing Servers}).
14297
14298 @item
14299 A way to specify that ``uninteresting'' fields be suppressed when
14300 generating lines in buffers (@pxref{Advanced Formatting}).
14301
14302 @item
14303 Several commands in the group buffer can be undone with @kbd{M-C-_}
14304 (@pxref{Undo}).
14305
14306 @item
14307 Scoring can be done on words using the new score type @code{w}
14308 (@pxref{Score File Format}).
14309
14310 @item
14311 Adaptive scoring can be done on a Subject word-by-word basis
14312 (@pxref{Adaptive Scoring}). 
14313
14314 @lisp
14315 (setq gnus-use-adaptive-scoring '(word))
14316 @end lisp
14317
14318 @item
14319 Scores can be decayed (@pxref{Score Decays}).
14320  
14321 @lisp
14322 (setq gnus-decay-scores t)
14323 @end lisp
14324
14325 @item
14326 Scoring can be performed using a regexp on the Date header.  The Date is
14327 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14328
14329 @item
14330 A new command has been added to remove all data on articles from
14331 the native server (@pxref{Changing Servers}).
14332
14333 @item
14334 A new command for reading collections of documents
14335 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14336 (@pxref{Really Various Summary Commands}). 
14337
14338 @item
14339 Process mark sets can be pushed and popped (@pxref{Setting Process
14340 Marks}).
14341
14342 @item
14343 A new mail-to-news backend makes it possible to post even when the NNTP
14344 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14345
14346 @item
14347 A new backend for reading searches from Web search engines
14348 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14349 (@pxref{Web Searches}).
14350
14351 @item
14352 Groups inside topics can now be sorted using the standard sorting
14353 functions, and each topic can be sorted independently (@pxref{Topic
14354 Sorting}).
14355
14356 @item
14357 Subsets of the groups can be sorted independently (@code{Sorting
14358 Groups}).
14359
14360 @item
14361 Cached articles can be pulled into the groups (@pxref{Summary Generation
14362 Commands}).
14363   
14364 @item
14365 Score files are now applied in a more reliable order (@pxref{Score
14366 Variables}).
14367
14368 @item
14369 Reports on where mail messages end up can be generated (@pxref{Splitting
14370 Mail}).
14371
14372 @item
14373 More hooks and functions have been added to remove junk from incoming
14374 mail before saving the mail (@pxref{Washing Mail}).
14375
14376 @item
14377 Emphasized text can be properly fontisized:
14378
14379 @lisp
14380 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14381 @end lisp
14382  
14383 @end itemize
14384
14385
14386 @node Newest Features
14387 @subsection Newest Features
14388 @cindex todo
14389
14390 Also known as the @dfn{todo list}.  Sure to be implemented before the
14391 next millennium. 
14392
14393 Be afraid.  Be very afraid.
14394
14395 @itemize @bullet
14396 @item
14397 Native @sc{mime} support is something that should be done.  
14398 @item
14399 Really do unbinhexing.
14400 @end itemize
14401
14402 And much, much, much more.  There is more to come than has already been
14403 implemented.  (But that's always true, isn't it?)
14404
14405 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14406 up-to-the-second todo list is located, so if you're really curious, you
14407 could point your Web browser over that-a-way.
14408
14409 @iftex
14410
14411 @node The Manual
14412 @section The Manual
14413 @cindex colophon
14414 @cindex manual
14415
14416 This manual was generated from a TeXinfo file and then run through
14417 either @code{texi2dvi}
14418 @iflatex
14419 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14420 and then run through @code{latex} and @code{dvips} 
14421 @end iflatex
14422 to get what you hold in your hands now.
14423
14424 The following conventions have been used:
14425
14426 @enumerate
14427
14428 @item
14429 This is a @samp{string}
14430
14431 @item
14432 This is a @kbd{keystroke}
14433
14434 @item
14435 This is a @file{file}
14436
14437 @item 
14438 This is a @code{symbol}
14439
14440 @end enumerate
14441
14442 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14443 mean:
14444
14445 @lisp
14446 (setq flargnoze "yes")
14447 @end lisp
14448
14449 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14450
14451 @lisp
14452 (setq flumphel 'yes)
14453 @end lisp
14454
14455 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14456 ever get them confused.
14457
14458 @iflatex
14459 @c @head
14460 Of course, everything in this manual is of vital interest, so you should
14461 read it all.  Several times.  However, if you feel like skimming the
14462 manual, look for that gnu head you should see in the margin over
14463 there---it means that what's being discussed is of more importance than
14464 the rest of the stuff.  (On the other hand, if everything is infinitely
14465 important, how can anything be more important than that?  Just one more
14466 of the mysteries of this world, I guess.)
14467 @end iflatex
14468
14469 @end iftex
14470
14471
14472 @node Terminology
14473 @section Terminology
14474
14475 @cindex terminology
14476 @table @dfn
14477
14478 @item news
14479 @cindex news
14480 This is what you are supposed to use this thing for---reading news.
14481 News is generally fetched from a nearby @sc{nntp} server, and is
14482 generally publicly available to everybody.  If you post news, the entire
14483 world is likely to read just what you have written, and they'll all
14484 snigger mischievously.  Behind your back.
14485
14486 @item mail
14487 @cindex mail
14488 Everything that's delivered to you personally is mail.  Some news/mail
14489 readers (like Gnus) blur the distinction between mail and news, but
14490 there is a difference.  Mail is private.  News is public.  Mailing is
14491 not posting, and replying is not following up.
14492
14493 @item reply
14494 @cindex reply
14495 Send a mail to the person who has written what you are reading.
14496
14497 @item follow up
14498 @cindex follow up
14499 Post an article to the current newsgroup responding to the article you
14500 are reading.
14501
14502 @item backend
14503 @cindex backend
14504 Gnus gets fed articles from a number of backends, both news and mail
14505 backends.  Gnus does not handle the underlying media, so to speak---this
14506 is all done by the backends.
14507
14508 @item native
14509 @cindex native
14510 Gnus will always use one method (and backend) as the @dfn{native}, or
14511 default, way of getting news.
14512
14513 @item foreign
14514 @cindex foreign
14515 You can also have any number of foreign groups active at the same time.
14516 These are groups that use different backends for getting news.
14517
14518 @item secondary
14519 @cindex secondary
14520 Secondary backends are somewhere half-way between being native and being
14521 foreign, but they mostly act like they are native.
14522
14523 @item article
14524 @cindex article
14525 A message that has been posted as news.
14526
14527 @item mail message
14528 @cindex mail message
14529 A message that has been mailed.
14530
14531 @item message 
14532 @cindex message
14533 A mail message or news article
14534
14535 @item head
14536 @cindex head
14537 The top part of a message, where administrative information (etc.) is
14538 put.
14539
14540 @item body
14541 @cindex body
14542 The rest of an article.  Everything that is not in the head is in the
14543 body. 
14544
14545 @item header
14546 @cindex header
14547 A line from the head of an article. 
14548
14549 @item headers
14550 @cindex headers
14551 A collection of such lines, or a collection of heads.  Or even a
14552 collection of @sc{nov} lines.
14553
14554 @item @sc{nov}
14555 @cindex nov
14556 When Gnus enters a group, it asks the backend for the headers of all
14557 unread articles in the group.  Most servers support the News OverView
14558 format, which is more compact and much faster to read and parse than the
14559 normal @sc{head} format.
14560
14561 @item level
14562 @cindex levels
14563 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14564 that have a lower level are ``more'' subscribed than the groups with a
14565 higher level.  In fact, groups on levels 1-5 are considered
14566 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14567 are @dfn{killed}.  Commands for listing groups and scanning for new
14568 articles will all use the numeric prefix as @dfn{working level}.
14569
14570 @item killed groups
14571 @cindex killed groups
14572 No information on killed groups is stored or updated, which makes killed
14573 groups much easier to handle than subscribed groups.
14574
14575 @item zombie groups
14576 @cindex zombie groups
14577 Just like killed groups, only slightly less dead.
14578
14579 @item active file
14580 @cindex active file
14581 The news server has to keep track of what articles it carries, and what
14582 groups exist.  All this information in stored in the active file, which
14583 is rather large, as you might surmise.
14584
14585 @item bogus groups
14586 @cindex bogus groups
14587 A group that exists in the @file{.newsrc} file, but isn't known to the
14588 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14589 This means that the group probably doesn't exist (any more).
14590
14591 @item server 
14592 @cindex server
14593 A machine than one can connect to and get news (or mail) from.
14594
14595 @item select method
14596 @cindex select method
14597 A structure that specifies the backend, the server and the virtual
14598 server parameters.
14599
14600 @item virtual server
14601 @cindex virtual server
14602 A named select method.  Since a select methods defines all there is to
14603 know about connecting to a (physical) server, taking the things as a
14604 whole is a virtual server.
14605
14606 @item washing
14607 @cindex washing
14608 Taking a buffer and running it through a filter of some sort.  The
14609 result will (more often than not) be cleaner and more pleasing than the
14610 original. 
14611
14612 @item ephemeral groups
14613 @cindex ephemeral groups
14614 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14615 groups are groups that will have no data stored---when you exit the
14616 group, it'll disappear into the aether.  
14617
14618 @item solid groups
14619 @cindex solid groups
14620 This is the opposite of ephemeral groups.  All groups listed in the
14621 group buffer are solid groups.
14622
14623 @item sparse articles
14624 @cindex sparse articles
14625 These are article placeholders shown in the summary buffer when
14626 @code{gnus-build-sparse-threads} has been switched on.
14627
14628 @end table
14629
14630
14631 @node Customization
14632 @section Customization
14633 @cindex general customization
14634
14635 All variables are properly documented elsewhere in this manual.  This
14636 section is designed to give general pointers on how to customize Gnus
14637 for some quite common situations.
14638
14639 @menu
14640 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14641 * Slow Terminal Connection::  You run a remote Emacs.
14642 * Little Disk Space::         You feel that having large setup files is icky.
14643 * Slow Machine::              You feel like buying a faster machine.
14644 @end menu
14645
14646
14647 @node Slow/Expensive Connection
14648 @subsection Slow/Expensive @sc{nntp} Connection
14649
14650 If you run Emacs on a machine locally, and get your news from a machine
14651 over some very thin strings, you want to cut down on the amount of data
14652 Gnus has to get from the @sc{nntp} server.
14653
14654 @table @code
14655
14656 @item gnus-read-active-file
14657 Set this to @code{nil}, which will inhibit Gnus from requesting the
14658 entire active file from the server.  This file is often v.  large.  You
14659 also have to set @code{gnus-check-new-newsgroups} and
14660 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14661 doesn't suddenly decide to fetch the active file anyway.
14662
14663 @item gnus-nov-is-evil
14664 This one has to be @code{nil}.  If not, grabbing article headers from
14665 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
14666 support @sc{xover}; Gnus will detect this by itself.
14667 @end table
14668
14669
14670 @node Slow Terminal Connection
14671 @subsection Slow Terminal Connection
14672
14673 Let's say you use your home computer for dialing up the system that
14674 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
14675 amount of data that is sent over the wires as much as possible.
14676
14677 @table @code
14678
14679 @item gnus-auto-center-summary
14680 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14681 buffer all the time.  If it is @code{vertical}, do only vertical
14682 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
14683 horizontal and vertical recentering.
14684
14685 @item gnus-visible-headers
14686 Cut down on the headers that are included in the articles to the
14687 minimum.  You can, in fact, make do without them altogether---most of the
14688 useful data is in the summary buffer, anyway.  Set this variable to
14689 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14690
14691 @item gnus-article-display-hook
14692 Set this hook to all the available hiding commands:
14693 @lisp
14694 (setq gnus-article-display-hook 
14695       '(gnus-article-hide-headers gnus-article-hide-signature
14696         gnus-article-hide-citation))
14697 @end lisp
14698
14699 @item gnus-use-full-window
14700 By setting this to @code{nil}, you can make all the windows smaller.
14701 While this doesn't really cut down much generally, it means that you
14702 have to see smaller portions of articles before deciding that you didn't
14703 want to read them anyway.
14704
14705 @item gnus-thread-hide-subtree
14706 If this is non-@code{nil}, all threads in the summary buffer will be
14707 hidden initially.
14708
14709 @item gnus-updated-mode-lines
14710 If this is @code{nil}, Gnus will not put information in the buffer mode
14711 lines, which might save some time.
14712 @end table
14713
14714
14715 @node Little Disk Space
14716 @subsection Little Disk Space
14717 @cindex disk space
14718
14719 The startup files can get rather large, so you may want to cut their
14720 sizes a bit if you are running out of space.
14721
14722 @table @code
14723
14724 @item gnus-save-newsrc-file
14725 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14726 only save @file{.newsrc.eld}.  This means that you will not be able to
14727 use any other newsreaders than Gnus.  This variable is @code{t} by
14728 default. 
14729
14730 @item gnus-save-killed-list
14731 If this is @code{nil}, Gnus will not save the list of dead groups.  You
14732 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14733 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14734 variable to @code{nil}.  This variable is @code{t} by default.
14735
14736 @end table
14737
14738
14739 @node Slow Machine
14740 @subsection Slow Machine
14741 @cindex slow machine
14742
14743 If you have a slow machine, or are just really impatient, there are a
14744 few things you can do to make Gnus run faster.
14745
14746 Set@code{gnus-check-new-newsgroups} and
14747 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14748
14749 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14750 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14751 summary buffer faster.
14752
14753 Set @code{gnus-article-display-hook} to @code{nil} to make article
14754 processing a bit faster.
14755
14756
14757 @node Troubleshooting
14758 @section Troubleshooting
14759 @cindex troubleshooting
14760
14761 Gnus works @emph{so} well straight out of the box---I can't imagine any
14762 problems, really.
14763
14764 Ahem.
14765
14766 @enumerate
14767
14768 @item
14769 Make sure your computer is switched on.
14770
14771 @item
14772 Make sure that you really load the current Gnus version.  If you have
14773 been running @sc{gnus}, you need to exit Emacs and start it up again before
14774 Gnus will work.
14775
14776 @item
14777 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
14778 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
14779 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14780 flee}, you have some old @file{.el} files lying around.  Delete these.
14781
14782 @item
14783 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14784 how-to. 
14785
14786 @item
14787 @vindex max-lisp-eval-depth
14788 Gnus works on many recursive structures, and in some extreme (and very
14789 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14790 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14791 something like that.
14792 @end enumerate
14793
14794 If all else fails, report the problem as a bug.
14795
14796 @cindex bugs
14797 @cindex reporting bugs
14798
14799 @kindex M-x gnus-bug
14800 @findex gnus-bug
14801 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14802 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14803 me the backtrace.  I will fix bugs, but I can only fix them if you send
14804 me a precise description as to how to reproduce the bug.
14805
14806 You really can never be too detailed in a bug report.  Always use the
14807 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14808 a 10Kb mail each time you use it, and even if you have sent me your
14809 environment 500 times before.  I don't care.  I want the full info each
14810 time.  
14811
14812 It is also important to remember that I have no memory whatsoever.  If
14813 you send a bug report, and I send you a reply, and then you send back
14814 just ``No, it's not! Moron!'', I will have no idea what you are
14815 insulting me about.  Always over-explain everything.  It's much easier
14816 for all of us---if I don't have all the information I need, I will just
14817 mail you and ask for more info, and everything takes more time.
14818
14819 If the problem you're seeing is very visual, and you can't quite explain
14820 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14821 it somewhere it can be reached, and include the URL of the picture in
14822 the bug report.
14823
14824 If you just need help, you are better off asking on
14825 @samp{gnu.emacs.gnus}.  I'm not very helpful.
14826
14827 @cindex gnu.emacs.gnus
14828 @cindex ding mailing list
14829 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14830 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14831
14832
14833 @node A Programmers Guide to Gnus
14834 @section A Programmer@'s Guide to Gnus
14835
14836 It is my hope that other people will figure out smart stuff that Gnus
14837 can do, and that other people will write those smart things as well.  To
14838 facilitate that I thought it would be a good idea to describe the inner
14839 workings of Gnus.  And some of the not-so-inner workings, while I'm at
14840 it.
14841
14842 You can never expect the internals of a program not to change, but I
14843 will be defining (in some details) the interface between Gnus and its
14844 backends (this is written in stone), the format of the score files
14845 (ditto), data structures (some are less likely to change than others)
14846 and general method of operations.
14847
14848 @menu 
14849 * Backend Interface::        How Gnus communicates with the servers.
14850 * Score File Syntax::        A BNF definition of the score file standard.
14851 * Headers::                  How Gnus stores headers internally.
14852 * Ranges::                   A handy format for storing mucho numbers.
14853 * Group Info::               The group info format.
14854 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
14855 * Various File Formats::     Formats of files that Gnus use.
14856 @end menu
14857
14858
14859 @node Backend Interface
14860 @subsection Backend Interface
14861
14862 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14863 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
14864 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
14865 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
14866 examples of the latter we have @code{nntp-port-number} and
14867 @code{nnmbox-directory}.
14868
14869 When Gnus asks for information from a backend---say @code{nntp}---on
14870 something, it will normally include a virtual server name in the
14871 function parameters.  (If not, the backend should use the ``current''
14872 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
14873 server as its only (optional) parameter.  If this virtual server hasn't
14874 been opened, the function should fail.
14875
14876 Note that a virtual server name has no relation to some physical server
14877 name.  Take this example:
14878
14879 @lisp
14880 (nntp "odd-one" 
14881       (nntp-address "ifi.uio.no") 
14882       (nntp-port-number 4324))
14883 @end lisp
14884
14885 Here the virtual server name is @samp{odd-one} while the name of
14886 the physical server is @samp{ifi.uio.no}. 
14887
14888 The backends should be able to switch between several virtual servers.
14889 The standard backends implement this by keeping an alist of virtual
14890 server environments that it pulls down/pushes up when needed.  
14891
14892 There are two groups of interface functions: @dfn{required functions},
14893 which must be present, and @dfn{optional functions}, which Gnus will
14894 always check whether are present before attempting to call.
14895
14896 All these functions are expected to return data in the buffer
14897 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14898 unfortunately named, but we'll have to live with it.  When I talk about
14899 @dfn{resulting data}, I always refer to the data in that buffer.  When I
14900 talk about @dfn{return value}, I talk about the function value returned by
14901 the function call.  Functions that fail should return @code{nil} as the
14902 return value.
14903
14904 Some backends could be said to be @dfn{server-forming} backends, and
14905 some might be said to not be.  The latter are backends that generally
14906 only operate on one group at a time, and have no concept of ``server''
14907 -- they have a group, and they deliver info on that group and nothing
14908 more.
14909
14910 In the examples and definitions I will refer to the imaginary backend
14911 @code{nnchoke}. 
14912
14913 @cindex @code{nnchoke}
14914
14915 @menu
14916 * Required Backend Functions::        Functions that must be implemented.
14917 * Optional Backend Functions::        Functions that need not be implemented.
14918 * Error Messaging::                   How to get messages and report errors.
14919 * Writing New Backends::              Extending old backends.
14920 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
14921 * Mail-like Backends::                Some tips on mail backends.
14922 @end menu
14923
14924
14925 @node Required Backend Functions
14926 @subsubsection Required Backend Functions
14927
14928 @table @code
14929
14930 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
14931
14932 @var{articles} is either a range of article numbers or a list of
14933 @code{Message-ID}s.  Current backends do not fully support either---only
14934 sequences (lists) of article numbers, and most backends do not support
14935 retrieval of @code{Message-ID}s.  But they should try for both. 
14936
14937 The result data should either be HEADs or NOV lines, and the result
14938 value should either be @code{headers} or @code{nov} to reflect this.
14939 This might later be expanded to @code{various}, which will be a mixture
14940 of HEADs and NOV lines, but this is currently not supported by Gnus.  
14941
14942 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
14943 headers, in some meaning of the word.  This is generally done by
14944 fetching (at most) @var{fetch-old} extra headers less than the smallest
14945 article number in @code{articles}, and fill in the gaps as well.  The
14946 presence of this parameter can be ignored if the backend finds it
14947 cumbersome to follow the request.  If this is non-@code{nil} and not a
14948 number, do maximum fetches.
14949
14950 Here's an example HEAD:
14951
14952 @example
14953 221 1056 Article retrieved.
14954 Path: ifi.uio.no!sturles
14955 From: sturles@@ifi.uio.no (Sturle Sunde)
14956 Newsgroups: ifi.discussion
14957 Subject: Re: Something very droll
14958 Date: 27 Oct 1994 14:02:57 +0100
14959 Organization: Dept. of Informatics, University of Oslo, Norway
14960 Lines: 26
14961 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
14962 References: <38jdmq$4qu@@visbur.ifi.uio.no>
14963 NNTP-Posting-Host: holmenkollen.ifi.uio.no
14964 .
14965 @end example
14966
14967 So a @code{headers} return value would imply that there's a number of
14968 these in the data buffer.
14969
14970 Here's a BNF definition of such a buffer:
14971
14972 @example
14973 headers        = *head
14974 head           = error / valid-head
14975 error-message  = [ "4" / "5" ] 2number " " <error message> eol
14976 valid-head     = valid-message *header "." eol
14977 valid-message  = "221 " <number> " Article retrieved." eol
14978 header         = <text> eol
14979 @end example
14980
14981 If the return value is @code{nov}, the data buffer should contain
14982 @dfn{network overview database} lines.  These are basically fields
14983 separated by tabs. 
14984
14985 @example
14986 nov-buffer = *nov-line
14987 nov-line   = 8*9 [ field <TAB> ] eol
14988 field      = <text except TAB>
14989 @end example
14990
14991 For a closer explanation what should be in those fields,
14992 @pxref{Headers}. 
14993
14994
14995 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
14996
14997 @var{server} is here the virtual server name.  @var{definitions} is a
14998 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
14999
15000 If the server can't be opened, no error should be signaled.  The backend
15001 may then choose to refuse further attempts at connecting to this
15002 server.  In fact, it should do so. 
15003
15004 If the server is opened already, this function should return a
15005 non-@code{nil} value.  There should be no data returned.
15006
15007
15008 @item (nnchoke-close-server &optional SERVER)
15009
15010 Close connection to @var{server} and free all resources connected
15011 to it.  Return @code{nil} if the server couldn't be closed for some
15012 reason.
15013
15014 There should be no data returned.
15015
15016
15017 @item (nnchoke-request-close)
15018
15019 Close connection to all servers and free all resources that the backend
15020 have reserved.  All buffers that have been created by that backend
15021 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
15022 function is generally only called when Gnus is shutting down.
15023
15024 There should be no data returned. 
15025
15026
15027 @item (nnchoke-server-opened &optional SERVER)
15028
15029 If @var{server} is the current virtual server, and the connection to the
15030 physical server is alive, then this function should return a
15031 non-@code{nil} vlue.  This function should under no circumstances
15032 attempt to reconnect to a server that is has lost connection to.
15033
15034 There should be no data returned.
15035
15036
15037 @item (nnchoke-status-message &optional SERVER)
15038
15039 This function should return the last error message from @var{server}. 
15040
15041 There should be no data returned.
15042
15043
15044 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15045
15046 The result data from this function should be the article specified by
15047 @var{article}.  This might either be a @code{Message-ID} or a number.
15048 It is optional whether to implement retrieval by @code{Message-ID}, but
15049 it would be nice if that were possible.
15050
15051 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15052 in this buffer instead of the normal data buffer.  This is to make it
15053 possible to avoid copying large amounts of data from one buffer to
15054 another, and Gnus mainly request articles to be inserted directly into
15055 its article buffer.
15056
15057 If it is at all possible, this function should return a cons cell where
15058 the car is the group name the article was fetched from, and the cdr is
15059 the article number.  This will enable Gnus to find out what the real
15060 group and article numbers are when fetching articles by
15061 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
15062 on successful article retrievement.
15063
15064
15065 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15066
15067 Get data on @var{group}.  This function also has the side effect of
15068 making @var{group} the current group. 
15069
15070 If @var{FAST}, don't bother to return useful data, just make @var{group}
15071 the current group.
15072
15073 Here's an example of some result data and a definition of the same:
15074
15075 @example
15076 211 56 1000 1059 ifi.discussion
15077 @end example
15078
15079 The first number is the status, which should be 211.  Next is the
15080 total number of articles in the group, the lowest article number, the
15081 highest article number, and finally the group name.  Note that the total
15082 number of articles may be less than one might think while just
15083 considering the highest and lowest article numbers, but some articles
15084 may have been canceled.  Gnus just discards the total-number, so
15085 whether one should take the bother to generate it properly (if that is a
15086 problem) is left as an exercise to the reader.
15087
15088 @example
15089 group-status = [ error / info ] eol
15090 error        = [ "4" / "5" ] 2<number> " " <Error message>
15091 info         = "211 " 3* [ <number> " " ] <string>
15092 @end example
15093
15094
15095 @item (nnchoke-close-group GROUP &optional SERVER)
15096
15097 Close @var{group} and free any resources connected to it.  This will be
15098 a no-op on most backends. 
15099
15100 There should be no data returned.
15101
15102
15103 @item (nnchoke-request-list &optional SERVER)
15104
15105 Return a list of all groups available on @var{server}.  And that means
15106 @emph{all}. 
15107
15108 Here's an example from a server that only carries two groups:
15109
15110 @example
15111 ifi.test 0000002200 0000002000 y
15112 ifi.discussion 3324 3300 n
15113 @end example
15114
15115 On each line we have a group name, then the highest article number in
15116 that group, the lowest article number, and finally a flag.
15117
15118 @example
15119 active-file = *active-line
15120 active-line = name " " <number> " " <number> " " flags eol
15121 name        = <string>
15122 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
15123 @end example
15124
15125 The flag says whether the group is read-only (@samp{n}), is moderated
15126 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15127 (@samp{=other-group} or none of the above (@samp{y}). 
15128
15129
15130 @item (nnchoke-request-post &optional SERVER)
15131
15132 This function should post the current buffer.  It might return whether
15133 the posting was successful or not, but that's not required.  If, for
15134 instance, the posting is done asynchronously, it has generally not been
15135 completed by the time this function concludes.  In that case, this
15136 function should set up some kind of sentinel to beep the user loud and
15137 clear if the posting could not be completed.
15138
15139 There should be no result data from this function. 
15140
15141 @end table
15142
15143
15144 @node Optional Backend Functions
15145 @subsubsection Optional Backend Functions
15146
15147 @table @code
15148
15149 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15150
15151 @var{groups} is a list of groups, and this function should request data
15152 on all those groups.  How it does it is of no concern to Gnus, but it
15153 should attempt to do this in a speedy fashion.
15154
15155 The return value of this function can be either @code{active} or
15156 @code{group}, which says what the format of the result data is.  The
15157 former is in the same format as the data from
15158 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15159 in the same format as @code{nnchoke-request-group} gives.
15160
15161 @example
15162 group-buffer = *active-line / *group-status
15163 @end example
15164
15165
15166 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15167
15168 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15169 alterations.  This comes in handy if the backend really carries all the
15170 information (as is the case with virtual an imap groups).  This function
15171 should destructively alter the info to suit its needs, and should return
15172 the (altered) group info.  
15173
15174 There should be no result data from this function.
15175
15176
15177 @item (nnchoke-request-type GROUP &optional ARTICLE)
15178
15179 When the user issues commands for ``sending news'' (@kbd{F} in the
15180 summary buffer, for instance), Gnus has to know whether the article the
15181 user is following up is news or mail.  This function should return
15182 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15183 is mail and @code{unknown} if the type can't be decided.  (The
15184 @var{article} parameter is necessary in @code{nnvirtual} groups which
15185 might very well combine mail groups and news groups.)  Both @var{group}
15186 and @var{article} may be @code{nil}.
15187
15188 There should be no result data from this function.
15189
15190
15191 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15192
15193 If the user tries to set a mark that the backend doesn't like, this
15194 function may change the mark.  Gnus will use whatever this function
15195 returns as the mark for @var{article} instead of the original
15196 @var{mark}.  If the backend doesn't care, it must return the original
15197 @var{mark}, and not @code{nil} or any other type of garbage.  
15198
15199 The only use for this that I can see is what @code{nnvirtual} does with
15200 it---if a component group is auto-expirable, marking an article as read
15201 in the virtual group should result in the article being marked as
15202 expirable. 
15203
15204 There should be no result data from this function.
15205
15206
15207 @item (nnchoke-request-scan &optional GROUP SERVER)
15208
15209 This function may be called at any time (by Gnus or anything else) to
15210 request that the backend check for incoming articles, in one way or
15211 another.  A mail backend will typically read the spool file or query the
15212 POP server when this function is invoked.  The @var{group} doesn't have
15213 to be heeded---if the backend decides that it is too much work just
15214 scanning for a single group, it may do a total scan of all groups.  It
15215 would be nice, however, to keep things local if that's practical.
15216
15217 There should be no result data from this function.
15218
15219
15220 @item (nnchoke-request-group-description GROUP &optional SERVER)
15221
15222 The result data from this function should be a description of
15223 @var{group}. 
15224
15225 @example
15226 description-line = name <TAB> description eol
15227 name             = <string>
15228 description      = <text>
15229 @end example
15230
15231 @item (nnchoke-request-list-newsgroups &optional SERVER)
15232
15233 The result data from this function should be the description of all
15234 groups available on the server.
15235
15236 @example
15237 description-buffer = *description-line
15238 @end example
15239
15240
15241 @item (nnchoke-request-newgroups DATE &optional SERVER)
15242
15243 The result data from this function should be all groups that were
15244 created after @samp{date}, which is in normal human-readable date
15245 format.  The data should be in the active buffer format.
15246
15247
15248 @item (nnchoke-request-create-group GROUP &optional SERVER)
15249
15250 This function should create an empty group with name @var{group}.  
15251
15252 There should be no return data.
15253
15254
15255 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15256
15257 This function should run the expiry process on all articles in the
15258 @var{articles} range (which is currently a simple list of article
15259 numbers.)  It is left up to the backend to decide how old articles
15260 should be before they are removed by this function.  If @var{force} is
15261 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15262 they are. 
15263
15264 This function should return a list of articles that it did not/was not
15265 able to delete.
15266
15267 There should be no result data returned.
15268
15269
15270 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15271 &optional LAST)
15272
15273 This function should move @var{article} (which is a number) from
15274 @var{group} by calling @var{accept-form}.  
15275
15276 This function should ready the article in question for moving by
15277 removing any header lines it has added to the article, and generally
15278 should ``tidy up'' the article.  Then it should @code{eval}
15279 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15280 will do the actual copying.  If this @code{eval} returns a
15281 non-@code{nil} value, the article should be removed.
15282
15283 If @var{last} is @code{nil}, that means that there is a high likelihood
15284 that there will be more requests issued shortly, so that allows some
15285 optimizations. 
15286
15287 The function should return a cons where the car is the group name and
15288 the cdr is the article number that the article was entered as.
15289
15290 There should be no data returned. 
15291
15292
15293 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15294
15295 This function takes the current buffer and inserts it into @var{group}.
15296 If @var{last} in @code{nil}, that means that there will be more calls to
15297 this function in short order.
15298
15299 The function should return a cons where the car is the group name and
15300 the cdr is the article number that the article was entered as.
15301
15302 There should be no data returned.
15303
15304
15305 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15306
15307 This function should remove @var{article} (which is a number) from
15308 @var{group} and insert @var{buffer} there instead.
15309
15310 There should be no data returned.
15311
15312
15313 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15314
15315 This function should delete @var{group}.  If @var{force}, it should
15316 really delete all the articles in the group, and then delete the group
15317 itself.  (If there is such a thing as ``the group itself''.)
15318
15319 There should be no data returned.
15320
15321
15322 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15323
15324 This function should rename @var{group} into @var{new-name}.  All
15325 articles that are in @var{group} should move to @var{new-name}.
15326
15327 There should be no data returned.
15328
15329 @end table
15330
15331
15332 @node Error Messaging
15333 @subsubsection Error Messaging
15334
15335 @findex nnheader-report
15336 @findex nnheader-get-report
15337 The backends should use the function @code{nnheader-report} to report
15338 error conditions---they should not raise errors when they aren't able to
15339 perform a request.  The first argument to this function is the backend
15340 symbol, and the rest are interpreted as arguments to @code{format} if
15341 there are many of them, or just a string if there is one of them.
15342 This function always returns @code{nil}.
15343
15344 @lisp
15345 (nnheader-report 'nnchoke "You did something totally bogus")
15346
15347 (nnheader-report 'nnchoke "Could not request group %s" group)
15348 @end lisp
15349
15350 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15351 @code{nil} back from a server, and this function returns the most
15352 recently reported message for the backend in question.  This function
15353 takes one argument---the server symbol.
15354
15355 Internally, these function access @var{backend}@code{-status-string}, so
15356 the @code{nnchoke} backend will have its error message stored in
15357 @code{nnchoke-status-string}. 
15358
15359
15360 @node Writing New Backends
15361 @subsubsection Writing New Backends
15362
15363 Many backends are quite similar.  @code{nnml} is just like
15364 @code{nnspool}, but it allows you to edit the articles on the server.
15365 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15366 and it doesn't maintain overview databases.  @code{nndir} is just like
15367 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15368 editing articles.
15369
15370 It would make sense if it were possible to ``inherit'' functions from
15371 backends when writing new backends.  And, indeed, you can do that if you
15372 want to.  (You don't have to if you don't want to, of course.)  
15373
15374 All the backends declare their public variables and functions by using a
15375 package called @code{nnoo}.  
15376
15377 To inherit functions from other backends (and allow other backends to
15378 inherit functions from the current backend), you should use the
15379 following macros:
15380 following. 
15381
15382 @table @code
15383
15384 @item nnoo-declare
15385 This macro declares the first parameter to be a child of the subsequent
15386 parameters.  For instance:
15387
15388 @lisp
15389 (nnoo-declare nndir
15390   nnml nnmh)
15391 @end lisp
15392
15393 @code{nndir} has here declared that it intends to inherit functions from
15394 both @code{nnml} and @code{nnmh}.
15395
15396 @item defvoo
15397 This macro is equivalent to @code{defvar}, but registers the variable as
15398 a public server variable.  Most state-oriented variables should be
15399 declared with @code{defvoo} instead of @code{defvar}.  
15400
15401 In addition to the normal @code{defvar} parameters, it takes a list of
15402 variables in the parent backends to map the variable to when executing
15403 a function in those backends.
15404
15405 @lisp
15406 (defvoo nndir-directory nil
15407   "Where nndir will look for groups."
15408   nnml-current-directory nnmh-current-directory)
15409 @end lisp
15410
15411 This means that @code{nnml-current-directory} will be set to
15412 @code{nndir-directory} when an @code{nnml} function is called on behalf
15413 of @code{nndir}.  (The same with @code{nnmh}.)  
15414
15415 @item nnoo-define-basics
15416 This macro defines some common functions that almost all backends should
15417 have.
15418
15419 @example
15420 (nnoo-define-basics nndir)
15421 @end example
15422
15423 @item deffoo
15424 This macro is just like @code{defun} and takes the same parameters.  In
15425 addition to doing the normal @code{defun} things, it registers the
15426 function as being public so that other backends can inherit it.
15427
15428 @item nnoo-map-functions
15429 This macro allows mapping of functions from the current backend to
15430 functions from the parent backends.
15431
15432 @example
15433 (nnoo-map-functions nndir
15434   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15435   (nnmh-request-article 0 nndir-current-group 0 0))
15436 @end example
15437
15438 This means that when @code{nndir-retrieve-headers} is called, the first,
15439 third, and fourth parameters will be passed on to
15440 @code{nnml-retrieve-headers}, while the second parameter is set to the
15441 value of @code{nndir-current-group}.
15442
15443 @item nnoo-import
15444 This macro allows importing functions from backends.  It should be the
15445 last thing in the source file, since it will only define functions that
15446 haven't already been defined.
15447
15448 @example
15449 (nnoo-import nndir
15450   (nnmh
15451    nnmh-request-list
15452    nnmh-request-newgroups)
15453   (nnml))
15454 @end example
15455
15456 This means that calls to @code{nndir-request-list} should just be passed
15457 on to @code{nnmh-request-list}, while all public functions from
15458 @code{nnml} that haven't been defined in @code{nndir} yet should be
15459 defined now.
15460
15461 @end table
15462
15463 Below is a slightly shortened version of the @code{nndir} backend.
15464
15465 @lisp
15466 ;;; nndir.el --- single directory newsgroup access for Gnus
15467 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15468
15469 ;;; Code:
15470
15471 (require 'nnheader)
15472 (require 'nnmh)
15473 (require 'nnml)
15474 (require 'nnoo)
15475 (eval-when-compile (require 'cl))
15476
15477 (nnoo-declare nndir
15478   nnml nnmh)
15479
15480 (defvoo nndir-directory nil
15481   "Where nndir will look for groups."
15482   nnml-current-directory nnmh-current-directory)
15483
15484 (defvoo nndir-nov-is-evil nil
15485   "*Non-nil means that nndir will never retrieve NOV headers."
15486   nnml-nov-is-evil)
15487
15488 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15489 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15490 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15491
15492 (defvoo nndir-status-string "" nil nnmh-status-string)
15493 (defconst nndir-version "nndir 1.0")
15494
15495 ;;; Interface functions.
15496
15497 (nnoo-define-basics nndir)
15498
15499 (deffoo nndir-open-server (server &optional defs)
15500   (setq nndir-directory
15501         (or (cadr (assq 'nndir-directory defs))
15502             server))
15503   (unless (assq 'nndir-directory defs)
15504     (push `(nndir-directory ,server) defs))
15505   (push `(nndir-current-group
15506           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15507         defs)
15508   (push `(nndir-top-directory
15509           ,(file-name-directory (directory-file-name nndir-directory)))
15510         defs)
15511   (nnoo-change-server 'nndir server defs))
15512
15513 (nnoo-map-functions nndir
15514   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15515   (nnmh-request-article 0 nndir-current-group 0 0)
15516   (nnmh-request-group nndir-current-group 0 0)
15517   (nnmh-close-group nndir-current-group 0))
15518
15519 (nnoo-import nndir
15520   (nnmh
15521    nnmh-status-message
15522    nnmh-request-list
15523    nnmh-request-newgroups))
15524
15525 (provide 'nndir)
15526 @end lisp
15527
15528
15529 @node Hooking New Backends Into Gnus
15530 @subsubsection Hooking New Backends Into Gnus
15531
15532 @vindex gnus-valid-select-methods
15533 Having Gnus start using your new backend is rather easy---you just
15534 declare it with the @code{gnus-declare-backend} functions.  This will
15535 enter the backend into the @code{gnus-valid-select-methods} variable.
15536
15537 @code{gnus-declare-backend} takes two parameters---the backend name and
15538 an arbitrary number of @dfn{abilities}.
15539
15540 Here's an example:
15541
15542 @lisp
15543 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15544 @end lisp
15545
15546 The abilities can be:
15547
15548 @table @code
15549 @item mail
15550 This is a mailish backend---followups should (probably) go via mail.
15551 @item post
15552 This is a newsish backend---followups should (probably) go via news. 
15553 @item post-mail
15554 This backend supports both mail and news.
15555 @item none
15556 This is neither a post or mail backend---it's something completely
15557 different. 
15558 @item respool
15559 It supports respooling---or rather, it is able to modify its source
15560 articles and groups.
15561 @item address
15562 The name of the server should be in the virtual server name.  This is
15563 true for almost all backends.
15564 @item prompt-address
15565 The user should be prompted for an address when doing commands like
15566 @kbd{B} in the group buffer.  This is true for backends like
15567 @code{nntp}, but not @code{nnmbox}, for instance. 
15568 @end table
15569
15570
15571 @node Mail-like Backends
15572 @subsubsection Mail-like Backends
15573
15574 One of the things that separate the mail backends from the rest of the
15575 backends is the heavy dependence by the mail backends on common
15576 functions in @file{nnmail.el}.  For instance, here's the definition of
15577 @code{nnml-request-scan}: 
15578
15579 @lisp
15580 (deffoo nnml-request-scan (&optional group server)
15581   (setq nnml-article-file-alist nil)
15582   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15583 @end lisp
15584
15585 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15586 and @code{nnmail} takes care of all the moving and splitting of the
15587 mail.  
15588
15589 This function takes four parameters.
15590
15591 @table @var
15592 @item method
15593 This should be a symbol to designate which backend is responsible for
15594 the call.
15595
15596 @item exit-function
15597 This function should be called after the splitting has been performed.
15598
15599 @item temp-directory
15600 Where the temporary files should be stored.
15601
15602 @item group
15603 This optional argument should be a group name if the splitting is to be
15604 performed for one group only.
15605 @end table
15606
15607 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15608 save each article.  @var{backend}@code{-active-number} will be called to
15609 find the article number assigned to this article.  
15610
15611 The function also uses the following variables:
15612 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15613 this backend); and @var{backend}@code{-group-alist} and
15614 @var{backend}@code{-active-file} to generate the new active file.
15615 @var{backend}@code{-group-alist} should be a group-active alist, like
15616 this:
15617
15618 @example
15619 (("a-group" (1 . 10))
15620  ("some-group" (34 . 39)))
15621 @end example
15622
15623
15624 @node Score File Syntax
15625 @subsection Score File Syntax
15626
15627 Score files are meant to be easily parsable, but yet extremely
15628 mallable.   It was decided that something that had the same read syntax
15629 as an Emacs Lisp list would fit that spec.
15630
15631 Here's a typical score file:
15632
15633 @lisp
15634 (("summary"
15635   ("win95" -10000 nil s)
15636   ("Gnus"))
15637  ("from"
15638   ("Lars" -1000))
15639  (mark -100))
15640 @end lisp
15641
15642 BNF definition of a score file:
15643
15644 @example
15645 score-file       = "" / "(" *element ")"
15646 element          = rule / atom
15647 rule             = string-rule / number-rule / date-rule
15648 string-rule      = "(" quote string-header quote space *string-match ")"
15649 number-rule      = "(" quote number-header quote space *number-match ")"
15650 date-rule        = "(" quote date-header quote space *date-match ")"
15651 quote            = <ascii 34>
15652 string-header    = "subject" / "from" / "references" / "message-id" / 
15653                    "xref" / "body" / "head" / "all" / "followup"
15654 number-header    = "lines" / "chars"
15655 date-header      = "date"
15656 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
15657                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15658 score            = "nil" / <integer>
15659 date             = "nil" / <natural number>
15660 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
15661                    "r" / "regex" / "R" / "Regex" /
15662                    "e" / "exact" / "E" / "Exact" /
15663                    "f" / "fuzzy" / "F" / "Fuzzy"
15664 number-match     = "(" <integer> [ "" / [ space score [ "" / 
15665                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15666 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
15667 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
15668                    space date [ "" / [ space date-match-t ] ] ] ] ")"
15669 date-match-t     = "nil" / "at" / "before" / "after"
15670 atom             = "(" [ required-atom / optional-atom ] ")"
15671 required-atom    = mark / expunge / mark-and-expunge / files /
15672                    exclude-files / read-only / touched
15673 optional-atom    = adapt / local / eval 
15674 mark             = "mark" space nil-or-number
15675 nil-or-number    = "nil" / <integer>
15676 expunge          = "expunge" space nil-or-number
15677 mark-and-expunge = "mark-and-expunge" space nil-or-number
15678 files            = "files" *[ space <string> ]
15679 exclude-files    = "exclude-files" *[ space <string> ]
15680 read-only        = "read-only" [ space "nil" / space "t" ]
15681 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15682 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15683 local            = "local" *[ space "(" <string> space <form> ")" ]
15684 eval             = "eval" space <form>
15685 space            = *[ " " / <TAB> / <NEWLINE> ]
15686 @end example
15687
15688 Any unrecognized elements in a score file should be ignored, but not
15689 discarded.  
15690
15691 As you can see, white space is needed, but the type and amount of white
15692 space is irrelevant.  This means that formatting of the score file is
15693 left up to the programmer---if it's simpler to just spew it all out on
15694 one looong line, then that's ok.
15695
15696 The meaning of the various atoms are explained elsewhere in this
15697 manual. 
15698
15699
15700 @node Headers
15701 @subsection Headers
15702
15703 Gnus uses internally a format for storing article headers that
15704 corresponds to the @sc{nov} format in a mysterious fashion.  One could
15705 almost suspect that the author looked at the @sc{nov} specification and
15706 just shamelessly @emph{stole} the entire thing, and one would be right.
15707
15708 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
15709 RFC1036 to talk about lines in the head of an article (e.g.,
15710 @code{From}).  It is used by many people as a synonym for
15711 ``head''---``the header and the body''.  (That should be avoided, in my
15712 opinion.)  And Gnus uses a format internally that it calls ``header'',
15713 which is what I'm talking about here.  This is a 9-element vector,
15714 basically, with each header (ouch) having one slot.
15715
15716 These slots are, in order: @code{number}, @code{subject}, @code{from},
15717 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15718 @code{xref}.  There are macros for accessing and setting these
15719 slots---they all have predictable names beginning with
15720 @code{mail-header-} and @code{mail-header-set-}, respectively.
15721
15722 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
15723 be put in there.
15724
15725
15726 @node Ranges
15727 @subsection Ranges
15728
15729 @sc{gnus} introduced a concept that I found so useful that I've started
15730 using it a lot and have elaborated on it greatly. 
15731
15732 The question is simple: If you have a large amount of objects that are
15733 identified by numbers (say, articles, to take a @emph{wild} example)
15734 that you want to qualify as being ``included'', a normal sequence isn't
15735 very useful.  (A 200,000 length sequence is a bit long-winded.)
15736
15737 The solution is as simple as the question: You just collapse the
15738 sequence. 
15739
15740 @example
15741 (1 2 3 4 5 6 10 11 12)
15742 @end example
15743
15744 is transformed into
15745
15746 @example
15747 ((1 . 6) (10 . 12))
15748 @end example
15749
15750 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15751 lonesome object, a @samp{13} is a valid element:
15752
15753 @example
15754 ((1 . 6) 7 (10 . 12))
15755 @end example
15756
15757 This means that comparing two ranges to find out whether they are equal
15758 is slightly tricky:
15759
15760 @example
15761 ((1 . 5) 7 8 (10 . 12))
15762 @end example
15763
15764 and
15765
15766 @example
15767 ((1 . 5) (7 . 8) (10 . 12))
15768 @end example
15769
15770 are equal.  In fact, any non-descending list is a range:
15771
15772 @example
15773 (1 2 3 4 5)
15774 @end example
15775
15776 is a perfectly valid range, although a pretty long-winded one.  This is
15777 also legal:
15778
15779 @example
15780 (1 . 5)
15781 @end example
15782
15783 and is equal to the previous range.
15784
15785 Here's a BNF definition of ranges.  Of course, one must remember the
15786 semantic requirement that the numbers are non-descending.  (Any number
15787 of repetition of the same number is allowed, but apt to disappear in
15788 range handling.)
15789
15790 @example
15791 range           = simple-range / normal-range
15792 simple-range    = "(" number " . " number ")"
15793 normal-range    = "(" start-contents ")"
15794 contents        = "" / simple-range *[ " " contents ] / 
15795                   number *[ " " contents ]
15796 @end example
15797
15798 Gnus currently uses ranges to keep track of read articles and article
15799 marks.  I plan on implementing a number of range operators in C if The
15800 Powers That Be are willing to let me.  (I haven't asked yet, because I
15801 need to do some more thinking on what operators I need to make life
15802 totally range-based without ever having to convert back to normal
15803 sequences.) 
15804
15805
15806 @node Group Info
15807 @subsection Group Info
15808
15809 Gnus stores all permanent info on groups in a @dfn{group info} list.
15810 This list is from three to six elements (or more) long and exhaustively
15811 describes the group.
15812
15813 Here are two example group infos; one is a very simple group while the
15814 second is a more complex one:
15815
15816 @example
15817 ("no.group" 5 (1 . 54324))
15818
15819 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15820                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15821                 (nnml "")
15822                 (auto-expire (to-address "ding@@ifi.uio.no")))
15823 @end example
15824
15825 The first element is the @dfn{group name}---as Gnus knows the group,
15826 anyway.  The second element is the @dfn{subscription level}, which
15827 normally is a small integer.  The third element is a list of ranges of
15828 read articles.  The fourth element is a list of lists of article marks
15829 of various kinds.  The fifth element is the select method (or virtual
15830 server, if you like).  The sixth element is a list of @dfn{group
15831 parameters}, which is what this section is about.
15832
15833 Any of the last three elements may be missing if they are not required.
15834 In fact, the vast majority of groups will normally only have the first
15835 three elements, which saves quite a lot of cons cells.
15836
15837 Here's a BNF definition of the group info format:
15838
15839 @example
15840 info          = "(" group space level space read 
15841                 [ "" / [ space marks-list [ "" / [ space method [ "" /
15842                 space parameters ] ] ] ] ] ")" 
15843 group         = quote <string> quote
15844 level         = <integer in the range of 1 to inf>
15845 read          = range
15846 marks-lists   = nil / "(" *marks ")"
15847 marks         = "(" <string> range ")"
15848 method        = "(" <string> *elisp-forms ")"
15849 parameters    = "(" *elisp-forms ")"
15850 @end example
15851
15852 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
15853 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15854 in pseudo-BNF.
15855
15856
15857 @node Emacs/XEmacs Code
15858 @subsection Emacs/XEmacs Code
15859 @cindex XEmacs
15860 @cindex Emacsen
15861
15862 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15863 platforms must be the primary one.  I chose Emacs.  Not because I don't
15864 like XEmacs or Mule, but because it comes first alphabetically.
15865
15866 This means that Gnus will byte-compile under Emacs with nary a warning,
15867 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15868 As I use byte-compilation warnings to help me root out trivial errors in
15869 Gnus, that's very useful.  
15870
15871 I've also consistently used Emacs function interfaces, but have used
15872 Gnusey aliases for the functions.  To take an example:  Emacs defines a
15873 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15874 function.  I then define a function called @code{gnus-run-at-time} that
15875 takes the same parameters as the Emacs @code{run-at-time}.  When running
15876 Gnus under Emacs, the former function is just an alias for the latter.
15877 However, when running under XEmacs, the former is an alias for the
15878 following function:
15879
15880 @lisp
15881 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15882   (start-itimer
15883    "gnus-run-at-time"
15884    `(lambda ()
15885       (,function ,@@args))
15886    time repeat))
15887 @end lisp
15888
15889 This sort of thing has been done for bunches of functions.  Gnus does
15890 not redefine any native Emacs functions while running under XEmacs---it
15891 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
15892 all over.
15893
15894 Of course, I could have chosen XEmacs as my native platform and done
15895 mapping functions the other way around.  But I didn't.  The performance
15896 hit these indirections impose on Gnus under XEmacs should be slight.
15897
15898
15899 @node Various File Formats
15900 @subsection Various File Formats
15901
15902 @menu
15903 * Active File Format::      Information on articles and groups available.
15904 * Newsgroups File Format::  Group descriptions.
15905 @end menu
15906
15907
15908 @node Active File Format
15909 @subsubsection Active File Format
15910
15911 The active file lists all groups that are available on the server in
15912 question.  It also lists the highest and lowest current article numbers
15913 in each group.  
15914
15915 Here's an excerpt from a typical active file:
15916
15917 @example
15918 soc.motss 296030 293865 y
15919 alt.binaries.pictures.fractals 3922 3913 n
15920 comp.sources.unix 1605 1593 m
15921 comp.binaries.ibm.pc 5097 5089 y
15922 no.general 1000 900 y
15923 @end example
15924
15925 Here's a pseudo-BNF definition of this file:
15926
15927 @example
15928 active      = *group-line
15929 group-line  = group space high-number space low-number space flag <NEWLINE>
15930 group       = <non-white-space string>
15931 space       = " "
15932 high-number = <non-negative integer>
15933 low-number  = <positive integer>
15934 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
15935 @end example
15936
15937
15938 @node Newsgroups File Format
15939 @subsubsection Newsgroups File Format
15940
15941 The newsgroups file lists groups along with their descriptions.  Not all
15942 groups on the server have to be listed,  and not all groups in the file
15943 have to exist on the server.  The file is meant purely as information to
15944 the user.
15945
15946 The format is quite simple; a group name, a tab, and the description.
15947 Here's the definition:
15948
15949 @example
15950 newsgroups    = *line
15951 line          = group tab description <NEWLINE>
15952 group         = <non-white-space string>
15953 tab           = <TAB>
15954 description   = <string>
15955 @end example
15956
15957
15958 @node Emacs for Heathens
15959 @section Emacs for Heathens
15960
15961 Believe it or not, but some people who use Gnus haven't really used
15962 Emacs much before they embarked on their journey on the Gnus Love Boat.
15963 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
15964 region'', and ``set @code{gnus-flargblossen} to an alist where the key
15965 is a regexp that is used for matching on the group name'' are magical
15966 phrases with little or no meaning, then this appendix is for you.  If
15967 you are already familiar with Emacs, just ignore this and go fondle your
15968 cat instead.
15969
15970 @menu
15971 * Keystrokes::      Entering text and executing commands.
15972 * Emacs Lisp::      The built-in Emacs programming language.
15973 @end menu
15974
15975
15976 @node Keystrokes
15977 @subsection Keystrokes
15978
15979 @itemize @bullet
15980 @item
15981 Q: What is an experienced Emacs user?
15982
15983 @item 
15984 A: A person who wishes that the terminal had pedals.
15985 @end itemize
15986
15987 Yes, when you use Emacs, you are apt to use the control key, the shift
15988 key and the meta key a lot.  This is very annoying to some people
15989 (notably @code{vi}le users), and the rest of us just love the hell out
15990 of it.  Just give up and submit.  Emacs really does stand for
15991 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
15992 may have heard from other disreputable sources (like the Emacs author).
15993
15994 The shift key is normally located near your pinky fingers, and are
15995 normally used to get capital letters and stuff.  You probably use it all
15996 the time.  The control key is normally marked ``CTRL'' or something like
15997 that.  The meta key is, funnily enough, never marked as such on any
15998 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
15999 which is the meta key on this keyboard.  It's usually located somewhere
16000 to the left hand side of the keyboard, usually on the bottom row.
16001
16002 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16003 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
16004 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16005 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
16006 down the control key, and hold it down while you press @kbd{k}''.
16007 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16008 the control key and then press @kbd{k}''.  Simple, ay?
16009
16010 This is somewhat complicated by the fact that not all keyboards have a
16011 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
16012 means ``press escape, release escape, press @kbd{k}''.  That's much more
16013 work than if you have a meta key, so if that's the case, I respectfully
16014 suggest you get a real keyboard with a meta key.  You can't live without
16015 it.
16016
16017
16018
16019 @node Emacs Lisp
16020 @subsection Emacs Lisp
16021
16022 Emacs is the King of Editors because it's really a Lisp interpreter.
16023 Each and every key you tap runs some Emacs Lisp code snippet, and since
16024 Emacs Lisp is an interpreted language, that means that you can configure
16025 any key to run any arbitrary code.  You just, like, do it.
16026
16027 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16028 functions.  (These are byte-compiled for speed, but it's still
16029 interpreted.)  If you decide that you don't like the way Gnus does
16030 certain things, it's trivial to have it do something a different way.
16031 (Well, at least if you know how to write Lisp code.)  However, that's
16032 beyond the scope of this manual, so we are simply going to talk about
16033 some common constructs that you normally use in your @file{.emacs} file
16034 to customize Gnus.
16035
16036 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16037 write the following:
16038
16039 @lisp
16040 (setq gnus-florgbnize 4)
16041 @end lisp
16042
16043 This function (really ``special form'') @code{setq} is the one that can
16044 set a variable to some value.  This is really all you need to know.  Now
16045 you can go and fill your @code{.emacs} file with lots of these to change
16046 how Gnus works.
16047
16048 If you have put that thing in your @code{.emacs} file, it will be read
16049 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16050 start Emacs.  If you want to change the variable right away, simply say
16051 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
16052 previous ``form'', which here is a simple @code{setq} statement.
16053
16054 Go ahead---just try it, if you're located at your Emacs.  After you
16055 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16056 is the return value of the form you @code{eval}ed.
16057
16058 Some pitfalls:
16059
16060 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16061 that means:
16062
16063 @lisp
16064 (setq gnus-read-active-file 'some)
16065 @end lisp
16066
16067 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16068 @samp{nntp.ifi.uio.no}'', that means:
16069
16070 @lisp
16071 (setq gnus-nntp-server "nntp.ifi.uio.no")
16072 @end lisp
16073
16074 So be careful not to mix up strings (the latter) with symbols (the
16075 former).  The manual is unambiguous, but it can be confusing.
16076
16077
16078 @include gnus-faq.texi
16079
16080 @node Index
16081 @chapter Index
16082 @printindex cp
16083
16084 @node Key Index
16085 @chapter Key Index
16086 @printindex ky
16087
16088 @summarycontents
16089 @contents
16090 @bye
16091
16092 @iftex
16093 @iflatex
16094 \end{document}
16095 @end iflatex
16096 @end iftex
16097
16098 @c End:
16099