*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.4.55 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.55 Manual
291
292 @author by Lars Magne Ingebrigtsen
293 @page
294
295 @vskip 0pt plus 1filll
296 Copyright @copyright{} 1995,96,97 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.55.
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.  This function will be called
645 with the name of the new group as the only parameter.
646
647 Some handy pre-fab functions are:
648
649 @table @code
650
651 @item gnus-subscribe-zombies
652 @vindex gnus-subscribe-zombies
653 Make all new groups zombies.  This is the default.  You can browse the
654 zombies later (with @kbd{A z}) and either kill them all off properly
655 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
656
657 @item gnus-subscribe-randomly
658 @vindex gnus-subscribe-randomly
659 Subscribe all new groups randomly.
660
661 @item gnus-subscribe-alphabetically
662 @vindex gnus-subscribe-alphabetically
663 Subscribe all new groups alphabetically.
664
665 @item gnus-subscribe-hierarchically
666 @vindex gnus-subscribe-hierarchically
667 Subscribe all new groups hierarchically.  The difference between this
668 function and @code{gnus-subscribe-alphabetically} is slight.
669 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
670 alphabetical fashion, while this function will enter groups into it's
671 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
672 @samp{comp} hierarchy, this function will not mess that configuration
673 up.  Or something like that.
674
675 @item gnus-subscribe-interactively
676 @vindex gnus-subscribe-interactively
677 Subscribe new groups interactively.  This means that Gnus will ask
678 you about @strong{all} new groups.
679
680 @item gnus-subscribe-killed
681 @vindex gnus-subscribe-killed
682 Kill all new groups.
683
684 @end table
685
686 @vindex gnus-subscribe-hierarchical-interactive
687 A closely related variable is
688 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
689 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
690 hierarchical fashion whether to subscribe to new groups or not.  Gnus
691 will ask you for each sub-hierarchy whether you want to descend the
692 hierarchy or not.  
693
694 One common mistake is to set the variable a few paragraphs above to
695 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
696 will not work.  This is ga-ga.  So don't do it.
697
698
699 @node Filtering New Groups
700 @subsection Filtering New Groups
701
702 A nice and portable way to control which new newsgroups should be
703 subscribed (or ignored) is to put an @dfn{options} line at the start of
704 the @file{.newsrc} file.  Here's an example:
705
706 @example
707 options -n !alt.all !rec.all sci.all
708 @end example
709
710 @vindex gnus-subscribe-options-newsgroup-method
711 This line obviously belongs to a serious-minded intellectual scientific
712 person (or she may just be plain old boring), because it says that all
713 groups that have names beginning with @samp{alt} and @samp{rec} should
714 be ignored, and all groups with names beginning with @samp{sci} should
715 be subscribed.  Gnus will not use the normal subscription method for
716 subscribing these groups.
717 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
718 variable defaults to @code{gnus-subscribe-alphabetically}.
719
720 @vindex gnus-options-not-subscribe
721 @vindex gnus-options-subscribe
722 If you don't want to mess with your @file{.newsrc} file, you can just
723 set the two variables @code{gnus-options-subscribe} and
724 @code{gnus-options-not-subscribe}.  These two variables do exactly the
725 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
726 and if the the new group matches the former, it will be unconditionally
727 subscribed, and if it matches the latter, it will be ignored.
728
729 @vindex gnus-auto-subscribed-groups
730 Yet another variable that meddles here is
731 @code{gnus-auto-subscribed-groups}.  It works exactly like
732 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
733 thought it would be nice to have two of these.  This variable is more
734 meant for setting some ground rules, while the other variable is used
735 more for user fiddling.  By default this variable makes all new groups
736 that come from mail backends (@code{nnml}, @code{nnbabyl},
737 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
738 don't like that, just set this variable to @code{nil}.
739
740 New groups that match this regexp are subscribed using
741 @code{gnus-subscribe-options-newsgroup-method}.
742
743
744 @node Changing Servers
745 @section Changing Servers
746 @cindex changing servers
747
748 Sometimes it is necessary to move from one @sc{nntp} server to another.
749 This happens very rarely, but perhaps you change jobs, or one server is
750 very flaky and you want to use another.  
751
752 Changing the server is pretty easy, right?  You just change
753 @code{gnus-select-method} to point to the new server?  
754
755 @emph{Wrong!}
756
757 Article numbers are not (in any way) kept synchronized between different
758 @sc{nntp} servers, and the only way Gnus keeps track of what articles
759 you have read is by keeping track of article numbers.  So when you
760 change @code{gnus-select-method}, your @file{.newsrc} file becomes
761 worthless.  
762
763 Gnus provides a few functions to attempt to translate a @file{.newsrc}
764 file from one server to another.  They all have one thing in
765 common---they take a looong time to run.  You don't want to use these
766 functions more than absolutely necessary.
767
768 @kindex M-x gnus-change-server
769 @findex gnus-change-server
770 If you have access to both servers, Gnus can request the headers for all
771 the articles you have read and compare @code{Message-ID}s and map the
772 article numbers of the read articles and article marks.  The @kbd{M-x
773 gnus-change-server} command will do this for all your native groups.  It
774 will prompt for the method you want to move to.
775
776 @kindex M-x gnus-group-move-group-to-server
777 @findex gnus-group-move-group-to-server
778 You can also move individual groups with the @kbd{M-x
779 gnus-group-move-group-to-server} command.  This is useful if you want to
780 move a (foreign) group from one server to another.
781
782 @kindex M-x gnus-group-clear-data-on-native-groups
783 @findex gnus-group-clear-data-on-native-groups
784 If you don't have access to both the old and new server, all your marks
785 and read ranges have become worthless.  You can use the @kbd{M-x
786 gnus-group-clear-data-on-native-groups} command to clear out all data
787 that you have on your native groups.  Use with caution.
788
789
790 @node Startup Files
791 @section Startup Files
792 @cindex startup files
793 @cindex .newsrc
794 @cindex .newsrc.el
795 @cindex .newsrc.eld
796
797 Now, you all know about the @file{.newsrc} file.  All subscription
798 information is traditionally stored in this file.
799
800 Things got a bit more complicated with @sc{gnus}.  In addition to
801 keeping the @file{.newsrc} file updated, it also used a file called
802 @file{.newsrc.el} for storing all the information that didn't fit into
803 the @file{.newsrc} file.  (Actually, it also duplicated everything in
804 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
805 files was the most recently saved, which enabled people to swap between
806 @sc{gnus} and other newsreaders.
807
808 That was kinda silly, so Gnus went one better: In addition to the
809 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
810 @file{.newsrc.eld}.  It will read whichever of these files that are most
811 recent, but it will never write a @file{.newsrc.el} file.
812
813 @vindex gnus-save-newsrc-file
814 You can turn off writing the @file{.newsrc} file by setting
815 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
816 the file and save some space, as well as making exit from Gnus faster.
817 However, this will make it impossible to use other newsreaders than
818 Gnus.  But hey, who would want to, right?
819
820 @vindex gnus-save-killed-list
821 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
822 will not save the list of killed groups to the startup file.  This will
823 save both time (when starting and quitting) and space (on disk).  It
824 will also mean that Gnus has no record of what groups are new or old,
825 so the automatic new groups subscription methods become meaningless.
826 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
827 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
828 Groups}).  This variable can also be a regular expression.  If that's
829 the case, remove all groups that do not match this regexp before
830 saving.  This can be useful in certain obscure situations that involve
831 several servers where not all servers support @code{ask-server}.
832
833 @vindex gnus-startup-file
834 The @code{gnus-startup-file} variable says where the startup files are.
835 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
836 file being whatever that one is with a @samp{.eld} appended.
837
838 @vindex gnus-save-newsrc-hook
839 @vindex gnus-save-quick-newsrc-hook
840 @vindex gnus-save-standard-newsrc-hook
841 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
842 files, while @code{gnus-save-quick-newsrc-hook} is called just before
843 saving the @file{.newsrc.eld} file, and
844 @code{gnus-save-standard-newsrc-hook} is called just before saving the
845 @file{.newsrc} file.  The latter two are commonly used to turn version
846 control on or off.  Version control is on by default when saving the
847 startup files.  If you want to turn backup creation off, say something like: 
848
849 @lisp
850 (defun turn-off-backup ()
851   (set (make-local-variable 'backup-inhibited) t))
852
853 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
854 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
855 @end lisp
856
857 @vindex gnus-init-file
858 When Gnus starts, it will read the @code{gnus-site-init-file}
859 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
860 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
861 and can be used to avoid cluttering your @file{~/.emacs} and
862 @file{site-init} files with Gnus stuff.  Gnus will also check for files
863 with the same names as these, but with @file{.elc} and @file{.el}
864 suffixes.  In other words, if you have set @code{gnus-init-file} to
865 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
866 and finally @file{~/.gnus} (in this order).
867
868
869
870 @node Auto Save
871 @section Auto Save
872 @cindex dribble file
873 @cindex auto-save
874
875 Whenever you do something that changes the Gnus data (reading articles,
876 catching up, killing/subscribing groups), the change is added to a
877 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
878 Emacs way.  If your Emacs should crash before you have saved the
879 @file{.newsrc} files, all changes you have made can be recovered from
880 this file.
881
882 If Gnus detects this file at startup, it will ask the user whether to
883 read it.  The auto save file is deleted whenever the real startup file is
884 saved.
885
886 @vindex gnus-use-dribble-file
887 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
888 maintain a dribble buffer.  The default is @code{t}.
889
890 @vindex gnus-dribble-directory
891 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
892 this variable is @code{nil}, which it is by default, Gnus will dribble
893 into the directory where the @file{.newsrc} file is located.  (This is
894 normally the user's home directory.)  The dribble file will get the same
895 file permissions as the @code{.newsrc} file.
896
897
898 @node The Active File
899 @section The Active File
900 @cindex active file
901 @cindex ignored groups
902
903 When Gnus starts, or indeed whenever it tries to determine whether new
904 articles have arrived, it reads the active file.  This is a very large
905 file that lists all the active groups and articles on the server.
906
907 @vindex gnus-ignored-newsgroups
908 Before examining the active file, Gnus deletes all lines that match the
909 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
910 any groups with bogus names, but you can use this variable to make Gnus
911 ignore hierarchies you aren't ever interested in.  However, this is not
912 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
913 Groups} for an overview of other variables that can be used instead.
914
915 @c This variable is
916 @c @code{nil} by default, and will slow down active file handling somewhat
917 @c if you set it to anything else.
918
919 @vindex gnus-read-active-file
920 @c @head
921 The active file can be rather Huge, so if you have a slow network, you
922 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
923 reading the active file.  This variable is @code{t} by default.
924
925 Gnus will try to make do by getting information just on the groups that
926 you actually subscribe to.
927
928 Note that if you subscribe to lots and lots of groups, setting this
929 variable to @code{nil} will probably make Gnus slower, not faster.  At
930 present, having this variable @code{nil} will slow Gnus down
931 considerably, unless you read news over a 2400 baud modem.  
932
933 This variable can also have the value @code{some}.  Gnus will then
934 attempt to read active info only on the subscribed groups.  On some
935 servers this is quite fast (on sparkling, brand new INN servers that
936 support the @code{LIST ACTIVE group} command), on others this isn't fast
937 at all.  In any case, @code{some} should be faster than @code{nil}, and
938 is certainly faster than @code{t} over slow lines.
939
940 If this variable is @code{nil}, Gnus will ask for group info in total
941 lock-step, which isn't very fast.  If it is @code{some} and you use an
942 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
943 read all the replies in one swoop.  This will normally result in better
944 performance, but if the server does not support the aforementioned
945 @code{LIST ACTIVE group} command, this isn't very nice to the server.
946
947 In any case, if you use @code{some} or @code{nil}, you should definitely
948 kill all groups that you aren't interested in to speed things up.
949
950 Note that this variable also affects active file retrieval from
951 secondary select methods.
952
953
954 @node Startup Variables
955 @section Startup Variables
956
957 @table @code
958
959 @item gnus-load-hook
960 @vindex gnus-load-hook
961 A hook that is run while Gnus is being loaded.  Note that this hook will
962 normally be run just once in each Emacs session, no matter how many
963 times you start Gnus.
964
965 @item gnus-startup-hook
966 @vindex gnus-startup-hook
967 A hook that is run after starting up Gnus successfully.
968
969 @item gnus-started-hook
970 @vindex gnus-started-hook
971 A hook that is run as the very last thing after starting up Gnus
972 successfully.
973
974 @item gnus-check-bogus-newsgroups
975 @vindex gnus-check-bogus-newsgroups
976 If non-@code{nil}, Gnus will check for and delete all bogus groups at
977 startup.  A @dfn{bogus group} is a group that you have in your
978 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
979 bogus groups can take quite a while, so to save time and resources it's
980 best to leave this option off, and do the checking for bogus groups once
981 in a while from the group buffer instead (@pxref{Group Maintenance}).
982
983 @item gnus-inhibit-startup-message
984 @vindex gnus-inhibit-startup-message
985 If non-@code{nil}, the startup message won't be displayed.  That way,
986 your boss might not notice as easily that you are reading news instead
987 of doing your job.  Note that this variable is used before
988 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
989
990 @item gnus-no-groups-message
991 @vindex gnus-no-groups-message
992 Message displayed by Gnus when no groups are available.
993
994 @item gnus-play-startup-jingle
995 @vindex gnus-play-startup-jingle
996 If non-@code{nil}, play the Gnus jingle at startup.
997
998 @item gnus-startup-jingle
999 @vindex gnus-startup-jingle
1000 Jingle to be played if the above variable is non-@code{nil}.  The
1001 default is @samp{Tuxedomoon.Jingle4.au}.
1002
1003 @end table
1004
1005
1006 @node The Group Buffer
1007 @chapter The Group Buffer
1008 @cindex group buffer
1009
1010 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1011 is the first buffer shown when Gnus starts, and will never be killed as
1012 long as Gnus is active.
1013
1014 @menu
1015 * Group Buffer Format::    Information listed and how you can change it.
1016 * Group Maneuvering::      Commands for moving in the group buffer.
1017 * Selecting a Group::      Actually reading news.
1018 * Group Data::             Changing the info for a group.
1019 * Subscription Commands::  Unsubscribing, killing, subscribing.
1020 * Group Levels::           Levels? What are those, then?
1021 * Group Score::            A mechanism for finding out what groups you like.
1022 * Marking Groups::         You can mark groups for later processing.
1023 * Foreign Groups::         Creating and editing groups.
1024 * Group Parameters::       Each group may have different parameters set.
1025 * Listing Groups::         Gnus can list various subsets of the groups.
1026 * Sorting Groups::         Re-arrange the group order.
1027 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1028 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1029 * Exiting Gnus::           Stop reading news and get some work done.
1030 * Group Topics::           A folding group mode divided into topics.
1031 * Misc Group Stuff::       Other stuff that you can to do.
1032 @end menu
1033
1034
1035 @node Group Buffer Format
1036 @section Group Buffer Format
1037
1038 @menu 
1039 * Group Line Specification::       Deciding how the group buffer is to look.
1040 * Group Modeline Specification::   The group buffer modeline.
1041 * Group Highlighting::             Having nice colors in the group buffer.
1042 @end menu
1043
1044
1045 @node Group Line Specification
1046 @subsection Group Line Specification
1047 @cindex group buffer format
1048
1049 The default format of the group buffer is nice and dull, but you can
1050 make it as exciting and ugly as you feel like.
1051
1052 Here's a couple of example group lines:
1053
1054 @example
1055      25: news.announce.newusers
1056  *    0: alt.fan.andrea-dworkin
1057 @end example
1058
1059 Quite simple, huh?
1060
1061 You can see that there are 25 unread articles in
1062 @samp{news.announce.newusers}.  There are no unread articles, but some
1063 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1064 asterisk at the beginning of the line?)
1065
1066 @vindex gnus-group-line-format
1067 You can change that format to whatever you want by fiddling with the
1068 @code{gnus-group-line-format} variable.  This variable works along the
1069 lines of a @code{format} specification, which is pretty much the same as
1070 a @code{printf} specifications, for those of you who use (feh!) C.
1071 @xref{Formatting Variables}. 
1072
1073 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1074
1075 There should always be a colon on the line; the cursor always moves to
1076 the colon after performing an operation.  Nothing else is required---not
1077 even the group name.  All displayed text is just window dressing, and is
1078 never examined by Gnus.  Gnus stores all real information it needs using
1079 text properties.
1080
1081 (Note that if you make a really strange, wonderful, spreadsheet-like
1082 layout, everybody will believe you are hard at work with the accounting
1083 instead of wasting time reading news.)
1084
1085 Here's a list of all available format characters:
1086
1087 @table @samp
1088
1089 @item M    
1090 An asterisk if the group only has marked articles.
1091
1092 @item S
1093 Whether the group is subscribed.
1094
1095 @item L    
1096 Level of subscribedness.
1097
1098 @item N
1099 Number of unread articles.
1100
1101 @item I
1102 Number of dormant articles.
1103
1104 @item T
1105 Number of ticked articles.
1106
1107 @item R
1108 Number of read articles.
1109
1110 @item t
1111 Estimated total number of articles.  (This is really @var{max-number}
1112 minus @var{min-number} plus 1.)
1113
1114 @item y
1115 Number of unread, unticked, non-dormant articles.
1116
1117 @item i
1118 Number of ticked and dormant articles.
1119
1120 @item g
1121 Full group name.
1122
1123 @item G
1124 Group name.
1125
1126 @item D
1127 Newsgroup description.
1128
1129 @item o
1130 @samp{m} if moderated.
1131
1132 @item O
1133 @samp{(m)} if moderated.
1134
1135 @item s
1136 Select method.
1137
1138 @item n
1139 Select from where.
1140
1141 @item z
1142 A string that looks like @samp{<%s:%n>} if a foreign select method is
1143 used.
1144
1145 @item P
1146 Indentation based on the level of the topic (@pxref{Group Topics}). 
1147
1148 @item c
1149 @vindex gnus-group-uncollapsed-levels
1150 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1151 variable says how many levels to leave at the end of the group name.
1152 The default is 1---this will mean that group names like
1153 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1154
1155 @item m
1156 @vindex gnus-new-mail-mark
1157 @cindex %
1158 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1159 the group lately.
1160
1161 @item d
1162 A string that says when you last read the group (@pxref{Group
1163 Timestamp}). 
1164
1165 @item u
1166 User defined specifier.  The next character in the format string should
1167 be a letter.  @sc{gnus} will call the function
1168 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1169 following @samp{%u}.  The function will be passed a single dummy
1170 parameter as argument.  The function should return a string, which will
1171 be inserted into the buffer just like information from any other
1172 specifier.
1173 @end table
1174
1175 @cindex *
1176 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1177 if no info is available---for instance, if it is a non-activated foreign
1178 group, or a bogus native group.
1179
1180
1181 @node Group Modeline Specification
1182 @subsection Group Modeline Specification
1183 @cindex group modeline
1184
1185 @vindex gnus-group-mode-line-format
1186 The mode line can be changed by setting
1187 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1188 doesn't understand that many format specifiers:
1189
1190 @table @samp
1191 @item S
1192 The native news server.
1193 @item M
1194 The native select method.
1195 @end table
1196
1197
1198 @node Group Highlighting
1199 @subsection Group Highlighting
1200 @cindex highlighting
1201 @cindex group highlighting
1202
1203 @vindex gnus-group-highlight
1204 Highlighting in the group buffer is controlled by the
1205 @code{gnus-group-highlight} variable.  This is an alist with elements
1206 that look like @var{(form . face)}.  If @var{form} evaluates to
1207 something non-@code{nil}, the @var{face} will be used on the line.
1208
1209 Here's an example value for this variable that might look nice if the
1210 background is dark:
1211
1212 @lisp
1213 (setq gnus-group-highlight
1214       `(((> unread 200) . 
1215          ,(custom-face-lookup "Red" nil nil t nil nil))
1216         ((and (< level 3) (zerop unread)) . 
1217          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1218         ((< level 3) . 
1219          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1220         ((zerop unread) . 
1221          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1222         (t . 
1223          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1224 @end lisp
1225
1226 Variables that are dynamically bound when the forms are evaluated
1227 include:
1228
1229 @table @code
1230 @item group
1231 The group name.
1232 @item unread
1233 The number of unread articles in the group.
1234 @item method
1235 The select method.
1236 @item mailp
1237 Whether the group is a mail group.
1238 @item level
1239 The level of the group.
1240 @item score
1241 The score of the group.
1242 @item ticked 
1243 The number of ticked articles in the group.
1244 @item total
1245 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1246 MIN-NUMBER.
1247 @item topic
1248 When using the topic minor mode, this variable is bound to the current
1249 topic being inserted.
1250 @end table
1251
1252 When the forms are @code{eval}ed, point is at the beginning of the line
1253 of the group in question, so you can use many of the normal Gnus
1254 functions for snarfing info on the group.
1255
1256 @vindex gnus-group-update-hook
1257 @findex gnus-group-highlight-line
1258 @code{gnus-group-update-hook} is called when a group line is changed.
1259 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1260 calls @code{gnus-group-highlight-line} by default.
1261
1262
1263 @node Group Maneuvering
1264 @section Group Maneuvering
1265 @cindex group movement
1266
1267 All movement commands understand the numeric prefix and will behave as
1268 expected, hopefully. 
1269
1270 @table @kbd
1271
1272 @item n
1273 @kindex n (Group)
1274 @findex gnus-group-next-unread-group
1275 Go to the next group that has unread articles
1276 (@code{gnus-group-next-unread-group}).
1277
1278 @item p
1279 @itemx DEL
1280 @kindex DEL (Group)
1281 @kindex p (Group)
1282 @findex gnus-group-prev-unread-group
1283 Go to the previous group that has unread articles
1284 (@code{gnus-group-prev-unread-group}).
1285
1286 @item N
1287 @kindex N (Group)
1288 @findex gnus-group-next-group
1289 Go to the next group (@code{gnus-group-next-group}).
1290
1291 @item P
1292 @kindex P (Group)
1293 @findex gnus-group-prev-group
1294 Go to the previous group (@code{gnus-group-prev-group}).
1295
1296 @item M-p
1297 @kindex M-p (Group)
1298 @findex gnus-group-next-unread-group-same-level
1299 Go to the next unread group on the same (or lower) level
1300 (@code{gnus-group-next-unread-group-same-level}). 
1301
1302 @item M-n
1303 @kindex M-n (Group)
1304 @findex gnus-group-prev-unread-group-same-level
1305 Go to the previous unread group on the same (or lower) level
1306 (@code{gnus-group-prev-unread-group-same-level}). 
1307 @end table
1308
1309 Three commands for jumping to groups:
1310
1311 @table @kbd
1312
1313 @item j
1314 @kindex j (Group)
1315 @findex gnus-group-jump-to-group
1316 Jump to a group (and make it visible if it isn't already)
1317 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1318 like living groups.
1319
1320 @item ,
1321 @kindex , (Group)
1322 @findex gnus-group-best-unread-group
1323 Jump to the unread group with the lowest level
1324 (@code{gnus-group-best-unread-group}). 
1325
1326 @item .
1327 @kindex . (Group)
1328 @findex gnus-group-first-unread-group
1329 Jump to the first group with unread articles
1330 (@code{gnus-group-first-unread-group}).  
1331 @end table
1332
1333 @vindex gnus-group-goto-unread
1334 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1335 commands will move to the next group, not the next unread group.  Even
1336 the commands that say they move to the next unread group.  The default
1337 is @code{t}.
1338
1339
1340 @node Selecting a Group
1341 @section Selecting a Group
1342 @cindex group selection
1343
1344 @table @kbd
1345
1346 @item SPACE
1347 @kindex SPACE (Group)
1348 @findex gnus-group-read-group
1349 Select the current group, switch to the summary buffer and display the
1350 first unread article (@code{gnus-group-read-group}).  If there are no
1351 unread articles in the group, or if you give a non-numerical prefix to
1352 this command, Gnus will offer to fetch all the old articles in this
1353 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1354 determines the number of articles Gnus will fetch.  If @var{N} is
1355 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1356 negative, Gnus fetches the @var{abs(N)} oldest articles.
1357
1358 @item RET
1359 @kindex RET (Group)
1360 @findex gnus-group-select-group
1361 Select the current group and switch to the summary buffer
1362 (@code{gnus-group-select-group}).  Takes the same arguments as
1363 @code{gnus-group-read-group}---the only difference is that this command
1364 does not display the first unread article automatically upon group
1365 entry. 
1366
1367 @item M-RET
1368 @kindex M-RET (Group)
1369 @findex gnus-group-quick-select-group
1370 This does the same as the command above, but tries to do it with the
1371 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1372 scoring/killing will be performed, there will be no highlights and no
1373 expunging.  This might be useful if you're in a real hurry and have to
1374 enter some humongous group.  If you give a 0 prefix to this command
1375 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1376 This might be useful if you want to toggle threading before entering the
1377 group.
1378
1379 @item M-SPACE
1380 @kindex M-SPACE (Group)
1381 @findex gnus-group-visible-select-group
1382 This is yet one more command that does the same as the @kbd{RET}
1383 command, but this one does it without expunging and hiding dormants
1384 (@code{gnus-group-visible-select-group}).
1385
1386 @item M-C-RET
1387 @kindex M-C-RET (Group)
1388 @findex gnus-group-select-group-ephemerally
1389 Finally, this command selects the current group ephemerally without
1390 doing any processing of its contents
1391 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1392 turned off.  Everything you do in the group after selecting it in this
1393 manner will have no permanent effects.
1394
1395 @end table
1396
1397 @vindex gnus-large-newsgroup
1398 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1399 to be a big group.  This is 200 by default.  If the group has more
1400 (unread and/or ticked) articles than this, Gnus will query the user
1401 before entering the group.  The user can then specify how many articles
1402 should be fetched from the server.  If the user specifies a negative
1403 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1404 is positive, the @code{n} articles that have arrived most recently will
1405 be fetched.
1406
1407 @vindex gnus-select-group-hook
1408 @vindex gnus-auto-select-first
1409 @code{gnus-auto-select-first} control whether any articles are selected
1410 automatically when entering a group with the @kbd{SPACE} command.
1411
1412 @table @code
1413
1414 @item nil
1415 Don't select any articles when entering the group.  Just display the
1416 full summary buffer.
1417
1418 @item t
1419 Select the first unread article when entering the group.  
1420
1421 @item best
1422 Select the most high-scored article in the group when entering the
1423 group. 
1424 @end table
1425         
1426 If you want to prevent automatic selection in some group (say, in a
1427 binary group with Huge articles) you can set this variable to @code{nil}
1428 in @code{gnus-select-group-hook}, which is called when a group is
1429 selected.
1430
1431
1432 @node Subscription Commands
1433 @section Subscription Commands
1434 @cindex subscription
1435
1436 @table @kbd
1437
1438 @item S t
1439 @itemx u
1440 @kindex S t (Group)
1441 @kindex u (Group)
1442 @findex gnus-group-unsubscribe-current-group
1443 Toggle subscription to the current group
1444 (@code{gnus-group-unsubscribe-current-group}).  
1445
1446 @item S s
1447 @itemx U
1448 @kindex S s (Group)
1449 @kindex U (Group)
1450 @findex gnus-group-unsubscribe-group
1451 Prompt for a group to subscribe, and then subscribe it.  If it was
1452 subscribed already, unsubscribe it instead
1453 (@code{gnus-group-unsubscribe-group}).
1454
1455 @item S k
1456 @itemx C-k
1457 @kindex S k (Group)
1458 @kindex C-k (Group)
1459 @findex gnus-group-kill-group
1460 Kill the current group (@code{gnus-group-kill-group}).
1461
1462 @item S y
1463 @itemx C-y
1464 @kindex S y (Group)
1465 @kindex C-y (Group)
1466 @findex gnus-group-yank-group
1467 Yank the last killed group (@code{gnus-group-yank-group}).
1468
1469 @item C-x C-t
1470 @kindex C-x C-t (Group)
1471 @findex gnus-group-transpose-groups
1472 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1473 really a subscription command, but you can use it instead of a
1474 kill-and-yank sequence sometimes.
1475
1476 @item S w
1477 @itemx C-w
1478 @kindex S w (Group)
1479 @kindex C-w (Group)
1480 @findex gnus-group-kill-region
1481 Kill all groups in the region (@code{gnus-group-kill-region}). 
1482
1483 @item S z
1484 @kindex S z (Group)
1485 @findex gnus-group-kill-all-zombies
1486 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1487
1488 @item S C-k
1489 @kindex S C-k (Group)
1490 @findex gnus-group-kill-level
1491 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1492 These groups can't be yanked back after killing, so this command should
1493 be used with some caution.  The only time where this command comes in
1494 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1495 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1496 kill off all unsubscribed groups that do not have message numbers in the
1497 @file{.newsrc} file.  
1498
1499 @end table
1500
1501 Also @pxref{Group Levels}.
1502
1503
1504 @node Group Data
1505 @section Group Data
1506
1507 @table @kbd
1508
1509 @item c
1510 @kindex c (Group)
1511 @findex gnus-group-catchup-current
1512 @vindex gnus-group-catchup-group-hook
1513 Mark all unticked articles in this group as read
1514 (@code{gnus-group-catchup-current}).
1515 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1516 the group buffer.
1517
1518 @item C
1519 @kindex C (Group)
1520 @findex gnus-group-catchup-current-all
1521 Mark all articles in this group, even the ticked ones, as read
1522 (@code{gnus-group-catchup-current-all}).   
1523
1524 @item M-c
1525 @kindex M-c (Group)
1526 @findex gnus-group-clear-data
1527 Clear the data from the current group---nix out marks and the list of
1528 read articles (@code{gnus-group-clear-data}).
1529
1530 @item M-x gnus-group-clear-data-on-native-groups
1531 @kindex M-x gnus-group-clear-data-on-native-groups
1532 @findex gnus-group-clear-data-on-native-groups
1533 If you have switched from one @sc{nntp} server to another, all your marks
1534 and read ranges have become worthless.  You can use this command to
1535 clear out all data that you have on your native groups.  Use with
1536 caution. 
1537
1538 @end table
1539
1540
1541 @node Group Levels
1542 @section Group Levels
1543 @cindex group level
1544 @cindex level
1545
1546 All groups have a level of @dfn{subscribedness}.  For instance, if a
1547 group is on level 2, it is more subscribed than a group on level 5.  You
1548 can ask Gnus to just list groups on a given level or lower
1549 (@pxref{Listing Groups}), or to just check for new articles in groups on
1550 a given level or lower (@pxref{Scanning New Messages}).
1551
1552 Remember:  The higher the level of the group, the less important it is. 
1553
1554 @table @kbd
1555
1556 @item S l
1557 @kindex S l (Group)
1558 @findex gnus-group-set-current-level
1559 Set the level of the current group.  If a numeric prefix is given, the
1560 next @var{n} groups will have their levels set.  The user will be
1561 prompted for a level.
1562 @end table
1563
1564 @vindex gnus-level-killed
1565 @vindex gnus-level-zombie
1566 @vindex gnus-level-unsubscribed
1567 @vindex gnus-level-subscribed
1568 Gnus considers groups on between levels 1 and
1569 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1570 @code{gnus-level-subscribed} (exclusive) and
1571 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1572 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1573 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1574 completely dead.  Gnus treats subscribed and unsubscribed groups exactly
1575 the same, but zombie and killed groups have no information on what
1576 articles you have read, etc, stored.  This distinction between dead and
1577 living groups isn't done because it is nice or clever, it is done purely
1578 for reasons of efficiency.
1579
1580 It is recommended that you keep all your mail groups (if any) on quite
1581 low levels (e.g. 1 or 2).
1582
1583 If you want to play with the level variables, you should show some care.
1584 Set them once, and don't touch them ever again.  Better yet, don't touch
1585 them at all unless you know exactly what you're doing.
1586
1587 @vindex gnus-level-default-unsubscribed
1588 @vindex gnus-level-default-subscribed
1589 Two closely related variables are @code{gnus-level-default-subscribed}
1590 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1591 which are the levels that new groups will be put on if they are
1592 (un)subscribed.  These two variables should, of course, be inside the
1593 relevant legal ranges.
1594
1595 @vindex gnus-keep-same-level
1596 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1597 will only move to groups that are of the same level (or lower).  In
1598 particular, going from the last article in one group to the next group
1599 will go to the next group of the same level (or lower).  This might be
1600 handy if you want to read the most important groups before you read the
1601 rest.
1602
1603 @vindex gnus-group-default-list-level
1604 All groups with a level less than or equal to
1605 @code{gnus-group-default-list-level} will be listed in the group buffer
1606 by default.
1607
1608 @vindex gnus-group-list-inactive-groups
1609 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1610 groups will be listed along with the unread groups.  This variable is
1611 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1612 listed. 
1613
1614 @vindex gnus-group-use-permanent-levels
1615 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1616 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1617 use this level as the ``work'' level.
1618
1619 @vindex gnus-activate-level
1620 Gnus will normally just activate groups that are on level
1621 @code{gnus-activate-level} or less.  If you don't want to activate
1622 unsubscribed groups, for instance, you might set this variable to
1623 5.  The default is 6.
1624
1625
1626 @node Group Score
1627 @section Group Score
1628 @cindex group score
1629
1630 You would normally keep important groups on high levels, but that scheme
1631 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1632 group buffer according to how often you read groups, perhaps?  Within
1633 reason?  
1634
1635 This is what @dfn{group score} is for.  You can assign a score to each
1636 group.  You can then sort the group buffer based on this score.
1637 Alternatively, you can sort on score and then level.  (Taken together,
1638 the level and the score is called the @dfn{rank} of the group.  A group
1639 that is on level 4 and has a score of 1 has a higher rank than a group
1640 on level 5 that has a score of 300.  (The level is the most significant
1641 part and the score is the least significant part.))
1642
1643 @findex gnus-summary-bubble-group
1644 If you want groups you read often to get higher scores than groups you
1645 read seldom you can add the @code{gnus-summary-bubble-group} function to
1646 the @code{gnus-summary-exit-hook} hook.  This will result (after
1647 sorting) in a bubbling sort of action.  If you want to see that in
1648 action after each summary exit, you can add
1649 @code{gnus-group-sort-groups-by-rank} or
1650 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1651 slow things down somewhat.
1652
1653
1654 @node Marking Groups
1655 @section Marking Groups
1656 @cindex marking groups
1657
1658 If you want to perform some command on several groups, and they appear
1659 subsequently in the group buffer, you would normally just give a
1660 numerical prefix to the command.  Most group commands will then do your
1661 bidding on those groups.
1662
1663 However, if the groups are not in sequential order, you can still
1664 perform a command on several groups.  You simply mark the groups first
1665 with the process mark and then execute the command.
1666
1667 @table @kbd
1668
1669 @item #
1670 @kindex # (Group)
1671 @itemx M m
1672 @kindex M m (Group)
1673 @findex gnus-group-mark-group
1674 Set the mark on the current group (@code{gnus-group-mark-group}). 
1675
1676 @item M-#
1677 @kindex M-# (Group)
1678 @itemx M u
1679 @kindex M u (Group)
1680 @findex gnus-group-unmark-group
1681 Remove the mark from the current group
1682 (@code{gnus-group-unmark-group}). 
1683
1684 @item M U
1685 @kindex M U (Group)
1686 @findex gnus-group-unmark-all-groups
1687 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1688
1689 @item M w
1690 @kindex M w (Group)
1691 @findex gnus-group-mark-region
1692 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1693
1694 @item M b
1695 @kindex M b (Group)
1696 @findex gnus-group-mark-buffer
1697 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1698
1699 @item M r
1700 @kindex M r (Group)
1701 @findex gnus-group-mark-regexp
1702 Mark all groups that match some regular expression
1703 (@code{gnus-group-mark-regexp}).  
1704 @end table
1705
1706 Also @pxref{Process/Prefix}.
1707
1708 @findex gnus-group-universal-argument
1709 If you want to execute some command on all groups that have been marked
1710 with the process mark, you can use the @kbd{M-&}
1711 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1712 the command to be executed.
1713
1714
1715 @node Foreign Groups
1716 @section Foreign Groups
1717 @cindex foreign groups
1718
1719 Below are some group mode commands for making and editing general foreign
1720 groups, as well as commands to ease the creation of a few
1721 special-purpose groups.  All these commands insert the newly created
1722 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1723 consulted.
1724
1725 @table @kbd
1726
1727 @item G m
1728 @kindex G m (Group)
1729 @findex gnus-group-make-group
1730 @cindex making groups
1731 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1732 for a name, a method and possibly an @dfn{address}.  For an easier way
1733 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1734
1735 @item G r
1736 @kindex G r (Group)
1737 @findex gnus-group-rename-group
1738 @cindex renaming groups
1739 Rename the current group to something else
1740 (@code{gnus-group-rename-group}).  This is legal only on some
1741 groups---mail groups mostly.  This command might very well be quite slow
1742 on some backends.
1743
1744 @item G c
1745 @kindex G c (Group)
1746 @cindex customizing
1747 @findex gnus-group-customize
1748 Customize the group parameters (@code{gnus-group-customize}).
1749
1750 @item G e
1751 @kindex G e (Group)
1752 @findex gnus-group-edit-group-method
1753 @cindex renaming groups
1754 Enter a buffer where you can edit the select method of the current
1755 group (@code{gnus-group-edit-group-method}).
1756
1757 @item G p
1758 @kindex G p (Group)
1759 @findex gnus-group-edit-group-parameters
1760 Enter a buffer where you can edit the group parameters
1761 (@code{gnus-group-edit-group-parameters}). 
1762
1763 @item G E
1764 @kindex G E (Group)
1765 @findex gnus-group-edit-group
1766 Enter a buffer where you can edit the group info
1767 (@code{gnus-group-edit-group}).
1768
1769 @item G d
1770 @kindex G d (Group)
1771 @findex gnus-group-make-directory-group
1772 @cindex nndir
1773 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1774 for a directory name (@code{gnus-group-make-directory-group}).
1775
1776 @item G h 
1777 @kindex G h (Group)
1778 @cindex help group
1779 @findex gnus-group-make-help-group
1780 Make the Gnus help group (@code{gnus-group-make-help-group}).
1781
1782 @item G a
1783 @kindex G a (Group)
1784 @cindex (ding) archive
1785 @cindex archive group
1786 @findex gnus-group-make-archive-group
1787 @vindex gnus-group-archive-directory
1788 @vindex gnus-group-recent-archive-directory
1789 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1790 default a group pointing to the most recent articles will be created
1791 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1792 group will be created from @code{gnus-group-archive-directory}.
1793
1794 @item G k
1795 @kindex G k (Group)
1796 @findex gnus-group-make-kiboze-group
1797 @cindex nnkiboze
1798 Make a kiboze group.  You will be prompted for a name, for a regexp to
1799 match groups to be ``included'' in the kiboze group, and a series of
1800 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1801 @xref{Kibozed Groups}.
1802
1803 @item G D
1804 @kindex G D (Group)
1805 @findex gnus-group-enter-directory
1806 @cindex nneething
1807 Read an arbitrary directory as if with were a newsgroup with the
1808 @code{nneething} backend (@code{gnus-group-enter-directory}).
1809 @xref{Anything Groups}. 
1810
1811 @item G f
1812 @kindex G f (Group)
1813 @findex gnus-group-make-doc-group
1814 @cindex ClariNet Briefs
1815 @cindex nndoc
1816 Make a group based on some file or other
1817 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1818 command, you will be prompted for a file name and a file type.
1819 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1820 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1821 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1822 this command without a prefix, Gnus will guess at the file type.
1823 @xref{Document Groups}.
1824
1825 @item G w
1826 @kindex G w (Group)
1827 @findex gnus-group-make-web-group
1828 @cindex DejaNews
1829 @cindex Alta Vista
1830 @cindex InReference
1831 @cindex nnweb
1832 Make an ephemeral group based on a web search
1833 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1834 command, make a solid group instead.  You will be prompted for the
1835 search engine type and the search string.  Legal search engine types
1836 include @code{dejanews}, @code{altavista} and @code{reference}.
1837 @xref{Web Searches}.
1838
1839 @item G DEL
1840 @kindex G DEL (Group)
1841 @findex gnus-group-delete-group
1842 This function will delete the current group
1843 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1844 actually delete all the articles in the group, and forcibly remove the
1845 group itself from the face of the Earth.  Use a prefix only if you are
1846 absolutely sure of what you are doing.
1847
1848 @item G V
1849 @kindex G V (Group)
1850 @findex gnus-group-make-empty-virtual
1851 Make a new, fresh, empty @code{nnvirtual} group
1852 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1853
1854 @item G v
1855 @kindex G v (Group)
1856 @findex gnus-group-add-to-virtual
1857 Add the current group to an @code{nnvirtual} group
1858 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1859 @end table
1860
1861 @xref{Select Methods} for more information on the various select
1862 methods. 
1863
1864 @vindex gnus-activate-foreign-newsgroups
1865 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1866 Gnus will check all foreign groups with this level or lower at startup.
1867 This might take quite a while, especially if you subscribe to lots of
1868 groups from different @sc{nntp} servers.
1869
1870
1871 @node Group Parameters
1872 @section Group Parameters
1873 @cindex group parameters
1874
1875 The group parameters store information local to a particular group:
1876
1877 @table @code
1878 @item to-address
1879 @cindex to-address
1880 If the group parameter list contains an element that looks like
1881 @code{(to-address .  "some@@where.com")}, that address will be used by
1882 the backend when doing followups and posts.  This is primarily useful in
1883 mail groups that represent closed mailing lists---mailing lists where
1884 it's expected that everybody that writes to the mailing list is
1885 subscribed to it.  Since using this parameter ensures that the mail only
1886 goes to the mailing list itself, it means that members won't receive two
1887 copies of your followups.
1888
1889 Using @code{to-address} will actually work whether the group is foreign
1890 or not.  Let's say there's a group on the server that is called
1891 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1892 the articles from a mail-to-news gateway.  Posting directly to this
1893 group is therefore impossible---you have to send mail to the mailing
1894 list address instead. 
1895
1896 @item to-list
1897 @cindex to-list
1898 If the group parameter list has an element that looks like
1899 @code{(to-list . "some@@where.com")}, that address will be used when
1900 doing a @kbd{a} in any group.  It is totally ignored when doing a
1901 followup---except that if it is present in a news group, you'll get mail
1902 group semantics when doing @kbd{f}.
1903
1904 If you do an @kbd{a} command in a mail group and you don't have a
1905 @code{to-list} group parameter, one will be added automatically upon
1906 sending the message.
1907
1908 @item broken-reply-to
1909 @cindex broken-reply-to
1910 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1911 headers in this group are to be ignored.  This can be useful if you're
1912 reading a mailing list group where the listserv has inserted
1913 @code{Reply-To} headers that point back to the listserv itself.  This is
1914 broken behavior.  So there!
1915
1916 @item to-group
1917 @cindex to-group
1918 Elements like @code{(to-group . "some.group.name")} means that all
1919 posts in that group will be sent to @code{some.group.name}.  
1920
1921 @item newsgroup
1922 @cindex newsgroup
1923 If this symbol is present in the group parameter list, Gnus will treat
1924 all responses as if they were responses to news articles.  This can be
1925 useful if you have a mail group that's really a mirror of a news group. 
1926
1927 @item gcc-self
1928 @cindex gcc-self
1929 If this symbol is present in the group parameter list and set to
1930 @code{t}, new composed messages will be @code{Gcc}'d to the current
1931 group. If it is present and set to @code{none}, no @code{Gcc:} header
1932 will be generated, if it is present and a string, this string will be
1933 inserted literally as a @code{gcc} header (this symbol takes precedence over
1934 any default @code{Gcc} rules as described later).
1935
1936 @item auto-expire
1937 @cindex auto-expire
1938 If the group parameter has an element that looks like @code{(auto-expire
1939 . t)}, , all articles that are read will be marked as expirable.  For an
1940 alternative approach, @pxref{Expiring Mail}.
1941
1942 @item total-expire
1943 @cindex total-expire
1944 If the group parameter has an element that looks like
1945 @code{(total-expire . t)}, all read articles will be put through the
1946 expiry process, even if they are not marked as expirable.  Use with
1947 caution.  Unread, ticked and dormant articles are not eligible for
1948 expiry.
1949
1950 @item expiry-wait
1951 @cindex expiry-wait
1952 @vindex nnmail-expiry-wait-function
1953 If the group parameter has an element that looks like @code{(expiry-wait
1954 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1955 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1956 The value can either be a number of days (not necessarily an integer) or
1957 the symbols @code{never} or @code{immediate}.
1958
1959 @item score-file
1960 @cindex score file group parameter
1961 Elements that look like @code{(score-file . "file")} will make
1962 @file{file} into the current score file for the group in question.  This
1963 means that all score commands you issue will end up in that file. 
1964
1965 @item adapt-file
1966 @cindex adapt file group parameter
1967 Elements that look like @code{(adapt-file . "file")} will make
1968 @file{file} into the current adaptive file for the group in question.
1969 All adaptive score entries will be put into this file.
1970
1971 @item admin-address
1972 When unsubscribing to a mailing list you should never send the
1973 unsubscription notice to the mailing list itself.  Instead, you'd send
1974 messages to the administrative address.  This parameter allows you to
1975 put the admin address somewhere convenient.
1976
1977 @item display
1978 Elements that look like @code{(display . MODE)} says which articles to
1979 display on entering the group.  Legal values are:
1980
1981 @table @code
1982 @item all
1983 Display all articles, both read and unread.
1984
1985 @item default
1986 Display the default visible articles, which normally includes unread and
1987 ticked articles.
1988 @end table
1989
1990 @item comment
1991 Elements that look like @code{(comment . "This is a comment")}
1992 are arbitrary comments on the group.  They are currently ignored by
1993 Gnus, but provide a place for you to store information on particular
1994 groups. 
1995
1996 @item @var{(variable form)}
1997 You can use the group parameters to set variables local to the group you
1998 are entering.  If you want to turn threading off in @samp{news.answers},
1999 you could put @code{(gnus-show-threads nil)} in the group parameters of
2000 that group.  @code{gnus-show-threads} will be made into a local variable
2001 in the summary buffer you enter, and the form @code{nil} will be
2002 @code{eval}ed there.
2003
2004 This can also be used as a group-specific hook function, if you'd like.
2005 If you want to hear a beep when you enter a group, you could put
2006 something like @code{(dummy-variable (ding))} in the parameters of that
2007 group.  @code{dummy-variable} will be set to the result of the
2008 @code{(ding)} form, but who cares?
2009
2010 @end table
2011
2012 Use the @kbd{G p} command to edit group parameters of a group.
2013
2014 Also @pxref{Topic Parameters}.
2015
2016 Here's an example group parameter list:
2017
2018 @example
2019 ((to-address . "ding@@gnus.org")
2020  (auto-expiry . t))
2021 @end example
2022
2023
2024 @node Listing Groups
2025 @section Listing Groups
2026 @cindex group listing
2027
2028 These commands all list various slices of the groups that are available.
2029
2030 @table @kbd
2031
2032 @item l
2033 @itemx A s
2034 @kindex A s (Group)
2035 @kindex l (Group)
2036 @findex gnus-group-list-groups
2037 List all groups that have unread articles
2038 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2039 command will list only groups of level ARG and lower.  By default, it
2040 only lists groups of level five (i. e.,
2041 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2042 groups).
2043
2044 @item L
2045 @itemx A u
2046 @kindex A u (Group)
2047 @kindex L (Group)
2048 @findex gnus-group-list-all-groups
2049 List all groups, whether they have unread articles or not
2050 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2051 this command will list only groups of level ARG and lower.  By default,
2052 it lists groups of level seven or lower (i.e., just subscribed and
2053 unsubscribed groups).
2054
2055 @item A l
2056 @kindex A l (Group)
2057 @findex gnus-group-list-level
2058 List all unread groups on a specific level
2059 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2060 with no unread articles.
2061
2062 @item A k
2063 @kindex A k (Group)
2064 @findex gnus-group-list-killed
2065 List all killed groups (@code{gnus-group-list-killed}).  If given a
2066 prefix argument, really list all groups that are available, but aren't
2067 currently (un)subscribed.  This could entail reading the active file
2068 from the server.
2069
2070 @item A z
2071 @kindex A z (Group)
2072 @findex gnus-group-list-zombies
2073 List all zombie groups (@code{gnus-group-list-zombies}).
2074
2075 @item A m
2076 @kindex A m (Group)
2077 @findex gnus-group-list-matching
2078 List all unread, subscribed groups with names that match a regexp
2079 (@code{gnus-group-list-matching}). 
2080
2081 @item A M
2082 @kindex A M (Group)
2083 @findex gnus-group-list-all-matching
2084 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2085
2086 @item A A
2087 @kindex A A (Group)
2088 @findex gnus-group-list-active
2089 List absolutely all groups that are in the active file(s) of the
2090 server(s) you are connected to (@code{gnus-group-list-active}).  This
2091 might very well take quite a while.  It might actually be a better idea
2092 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2093 thing to match on.  Also note that this command may list group that
2094 don't exist (yet)---these will be listed as if they are killed groups.
2095 Take the output with some grains of salt.
2096
2097 @item A a
2098 @kindex A a (Group)
2099 @findex gnus-group-apropos
2100 List all groups that have names that match a regexp
2101 (@code{gnus-group-apropos}).
2102
2103 @item A d
2104 @kindex A d (Group)
2105 @findex gnus-group-description-apropos
2106 List all groups that have names or descriptions that match a regexp
2107 (@code{gnus-group-description-apropos}).
2108
2109 @end table
2110
2111 @vindex gnus-permanently-visible-groups
2112 @cindex visible group parameter
2113 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2114 always be shown, whether they have unread articles or not.  You can also
2115 add the @code{visible} element to the group parameters in question to
2116 get the same effect.
2117
2118 @vindex gnus-list-groups-with-ticked-articles
2119 Groups that have just ticked articles in it are normally listed in the
2120 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2121 @code{nil}, these groups will be treated just like totally empty
2122 groups.  It is @code{t} by default.
2123
2124
2125 @node Sorting Groups
2126 @section Sorting Groups
2127 @cindex sorting groups
2128
2129 @kindex C-c C-s (Group)
2130 @findex gnus-group-sort-groups
2131 @vindex gnus-group-sort-function
2132 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2133 group buffer according to the function(s) given by the
2134 @code{gnus-group-sort-function} variable.  Available sorting functions
2135 include: 
2136
2137 @table @code
2138
2139 @item gnus-group-sort-by-alphabet
2140 @findex gnus-group-sort-by-alphabet
2141 Sort the group names alphabetically.  This is the default.
2142
2143 @item gnus-group-sort-by-real-name
2144 @findex gnus-group-sort-by-real-name
2145 Sort the group alphabetically on the real (unprefixed) group names.
2146
2147 @item gnus-group-sort-by-level
2148 @findex gnus-group-sort-by-level
2149 Sort by group level.
2150
2151 @item gnus-group-sort-by-score
2152 @findex gnus-group-sort-by-score
2153 Sort by group score.
2154
2155 @item gnus-group-sort-by-rank
2156 @findex gnus-group-sort-by-rank
2157 Sort by group score and then the group level.  The level and the score
2158 are, when taken together, the group's @dfn{rank}. 
2159
2160 @item gnus-group-sort-by-unread
2161 @findex gnus-group-sort-by-unread
2162 Sort by number of unread articles.
2163
2164 @item gnus-group-sort-by-method
2165 @findex gnus-group-sort-by-method
2166 Sort alphabetically on the select method.
2167
2168
2169 @end table
2170
2171 @code{gnus-group-sort-function} can also be a list of sorting
2172 functions.  In that case, the most significant sort key function must be
2173 the last one.
2174
2175
2176 There are also a number of commands for sorting directly according to
2177 some sorting criteria:
2178
2179 @table @kbd
2180 @item G S a
2181 @kindex G S a (Group)
2182 @findex gnus-group-sort-groups-by-alphabet
2183 Sort the group buffer alphabetically by group name
2184 (@code{gnus-group-sort-groups-by-alphabet}). 
2185
2186 @item G S u
2187 @kindex G S u (Group)
2188 @findex gnus-group-sort-groups-by-unread
2189 Sort the group buffer by the number of unread articles
2190 (@code{gnus-group-sort-groups-by-unread}).
2191
2192 @item G S l
2193 @kindex G S l (Group)
2194 @findex gnus-group-sort-groups-by-level
2195 Sort the group buffer by group level
2196 (@code{gnus-group-sort-groups-by-level}). 
2197
2198 @item G S v
2199 @kindex G S v (Group)
2200 @findex gnus-group-sort-groups-by-score
2201 Sort the group buffer by group score
2202 (@code{gnus-group-sort-groups-by-score}). 
2203
2204 @item G S r
2205 @kindex G S r (Group)
2206 @findex gnus-group-sort-groups-by-rank
2207 Sort the group buffer by group rank
2208 (@code{gnus-group-sort-groups-by-rank}). 
2209
2210 @item G S m
2211 @kindex G S m (Group)
2212 @findex gnus-group-sort-groups-by-method
2213 Sort the group buffer alphabetically by backend name
2214 (@code{gnus-group-sort-groups-by-method}). 
2215
2216 @end table
2217
2218 When given a prefix, all these commands will sort in reverse order. 
2219
2220 You can also sort a subset of the groups:
2221
2222 @table @kbd
2223 @item G P a
2224 @kindex G P a (Group)
2225 @findex gnus-group-sort-selected-groups-by-alphabet
2226 Sort the process/prefixed groups in the group buffer alphabetically by
2227 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2228
2229 @item G P u
2230 @kindex G P u (Group)
2231 @findex gnus-group-sort-selected-groups-by-unread
2232 Sort the process/prefixed groups in the group buffer by the number of
2233 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2234
2235 @item G P l
2236 @kindex G P l (Group)
2237 @findex gnus-group-sort-selected-groups-by-level
2238 Sort the process/prefixed groups in the group buffer by group level
2239 (@code{gnus-group-sort-selected-groups-by-level}).
2240
2241 @item G P v
2242 @kindex G P v (Group)
2243 @findex gnus-group-sort-selected-groups-by-score
2244 Sort the process/prefixed groups in the group buffer by group score
2245 (@code{gnus-group-sort-selected-groups-by-score}).
2246
2247 @item G P r
2248 @kindex G P r (Group)
2249 @findex gnus-group-sort-selected-groups-by-rank
2250 Sort the process/prefixed groups in the group buffer by group rank
2251 (@code{gnus-group-sort-selected-groups-by-rank}).
2252
2253 @item G P m
2254 @kindex G P m (Group)
2255 @findex gnus-group-sort-selected-groups-by-method
2256 Sort the process/prefixed groups in the group buffer alphabetically by
2257 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2258
2259 @end table
2260
2261
2262
2263 @node Group Maintenance
2264 @section Group Maintenance
2265 @cindex bogus groups
2266
2267 @table @kbd
2268 @item b
2269 @kindex b (Group)
2270 @findex gnus-group-check-bogus-groups
2271 Find bogus groups and delete them
2272 (@code{gnus-group-check-bogus-groups}).
2273
2274 @item F
2275 @kindex F (Group)
2276 @findex gnus-group-find-new-groups
2277 Find new groups and process them (@code{gnus-group-find-new-groups}).
2278 If given a prefix, use the @code{ask-server} method to query the server
2279 for new groups.
2280
2281 @item C-c C-x
2282 @kindex C-c C-x (Group)
2283 @findex gnus-group-expire-articles
2284 Run all expirable articles in the current group through the expiry
2285 process (if any) (@code{gnus-group-expire-articles}).
2286
2287 @item C-c M-C-x
2288 @kindex C-c M-C-x (Group)
2289 @findex gnus-group-expire-all-groups
2290 Run all articles in all groups through the expiry process
2291 (@code{gnus-group-expire-all-groups}).
2292
2293 @end table
2294
2295
2296 @node Browse Foreign Server
2297 @section Browse Foreign Server
2298 @cindex foreign servers
2299 @cindex browsing servers
2300
2301 @table @kbd
2302 @item B
2303 @kindex B (Group)
2304 @findex gnus-group-browse-foreign-server
2305 You will be queried for a select method and a server name.  Gnus will
2306 then attempt to contact this server and let you browse the groups there
2307 (@code{gnus-group-browse-foreign-server}).
2308 @end table
2309
2310 @findex gnus-browse-mode
2311 A new buffer with a list of available groups will appear.  This buffer
2312 will be use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2313 a lot) like a normal group buffer.
2314
2315 Here's a list of keystrokes available in the browse mode:
2316
2317 @table @kbd
2318 @item n
2319 @kindex n (Browse)
2320 @findex gnus-group-next-group
2321 Go to the next group (@code{gnus-group-next-group}).
2322
2323 @item p
2324 @kindex p (Browse)
2325 @findex gnus-group-prev-group
2326 Go to the previous group (@code{gnus-group-prev-group}).
2327
2328 @item SPACE
2329 @kindex SPACE (Browse)
2330 @findex gnus-browse-read-group
2331 Enter the current group and display the first article
2332 (@code{gnus-browse-read-group}). 
2333
2334 @item RET
2335 @kindex RET (Browse)
2336 @findex gnus-browse-select-group
2337 Enter the current group (@code{gnus-browse-select-group}). 
2338
2339 @item u
2340 @kindex u (Browse)
2341 @findex gnus-browse-unsubscribe-current-group
2342 Unsubscribe to the current group, or, as will be the case here,
2343 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2344
2345 @item l
2346 @itemx q
2347 @kindex q (Browse)
2348 @kindex l (Browse)
2349 @findex gnus-browse-exit
2350 Exit browse mode (@code{gnus-browse-exit}).
2351
2352 @item ?
2353 @kindex ? (Browse)
2354 @findex gnus-browse-describe-briefly
2355 Describe browse mode briefly (well, there's not much to describe, is
2356 there) (@code{gnus-browse-describe-briefly}).
2357 @end table
2358
2359
2360 @node Exiting Gnus
2361 @section Exiting Gnus
2362 @cindex exiting Gnus
2363
2364 Yes, Gnus is ex(c)iting.
2365
2366 @table @kbd
2367 @item z
2368 @kindex z (Group)
2369 @findex gnus-group-suspend
2370 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2371 but it kills all buffers except the Group buffer.  I'm not sure why this
2372 is a gain, but then who am I to judge?
2373
2374 @item q
2375 @kindex q (Group)
2376 @findex gnus-group-exit
2377 Quit Gnus (@code{gnus-group-exit}).
2378
2379 @item Q
2380 @kindex Q (Group)
2381 @findex gnus-group-quit
2382 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2383 The dribble file will be saved, though (@pxref{Auto Save}).
2384 @end table
2385
2386 @vindex gnus-exit-gnus-hook
2387 @vindex gnus-suspend-gnus-hook
2388 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2389 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2390 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2391 exiting Gnus.
2392
2393 @findex gnus-unload
2394 @cindex unloading
2395 If you wish to completely unload Gnus and all its adherents, you can use
2396 the @code{gnus-unload} command.  This command is also very handy when
2397 trying to customize meta-variables.
2398
2399 Note:
2400
2401 @quotation
2402 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2403 numbly heavy and herself fall into a hazy trance as the boy sitting
2404 behind her drew repeated lines with his pencil across the back of her
2405 plastic chair.
2406 @end quotation
2407
2408
2409 @node Group Topics
2410 @section Group Topics
2411 @cindex topics
2412
2413 If you read lots and lots of groups, it might be convenient to group
2414 them hierarchically according to topics.  You put your Emacs groups over
2415 here, your sex groups over there, and the rest (what, two groups or so?)
2416 you put in some misc section that you never bother with anyway.  You can
2417 even group the Emacs sex groups as a sub-topic to either the Emacs
2418 groups or the sex groups---or both!  Go wild!
2419
2420 Here's an example:
2421
2422 @example
2423 Gnus
2424   Emacs -- I wuw it!
2425      3: comp.emacs
2426      2: alt.religion.emacs
2427     Naughty Emacs
2428      452: alt.sex.emacs
2429        0: comp.talk.emacs.recovery
2430   Misc
2431      8: comp.binaries.fractals
2432     13: comp.sources.unix
2433 @end example
2434
2435 @findex gnus-topic-mode
2436 @kindex t (Group)
2437 To get this @emph{fab} functionality you simply turn on (ooh!) the
2438 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2439 is a toggling command.)
2440
2441 Go ahead, just try it.  I'll still be here when you get back.  La de
2442 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2443 press @kbd{l}.  There.  All your groups are now listed under
2444 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2445 bothered?
2446
2447 If you want this permanently enabled, you should add that minor mode to
2448 the hook for the group mode:
2449
2450 @lisp
2451 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2452 @end lisp
2453
2454 @menu 
2455 * Topic Variables::    How to customize the topics the Lisp Way.
2456 * Topic Commands::     Interactive E-Z commands.
2457 * Topic Sorting::      Sorting each topic individually.
2458 * Topic Topology::     A map of the world.
2459 * Topic Parameters::   Parameters that apply to all groups in a topic.
2460 @end menu
2461
2462
2463 @node Topic Variables
2464 @subsection Topic Variables
2465 @cindex topic variables
2466
2467 Now, if you select a topic, if will fold/unfold that topic, which is
2468 really neat, I think.
2469
2470 @vindex gnus-topic-line-format
2471 The topic lines themselves are created according to the
2472 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2473 Legal elements are:
2474
2475 @table @samp
2476 @item i
2477 Indentation.
2478 @item n
2479 Topic name.
2480 @item v
2481 Visibility.
2482 @item l
2483 Level.
2484 @item g
2485 Number of groups in the topic.
2486 @item a
2487 Number of unread articles in the topic.
2488 @item A 
2489 Number of unread articles in the topic and all its subtopics. 
2490 @end table
2491
2492 @vindex gnus-topic-indent-level
2493 Each sub-topic (and the groups in the sub-topics) will be indented with
2494 @code{gnus-topic-indent-level} times the topic level number of spaces.
2495 The default is 2.
2496
2497 @vindex gnus-topic-mode-hook
2498 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2499
2500 @vindex gnus-topic-display-empty-topics
2501 The @code{gnus-topic-display-empty-topics} says whether to display even
2502 topics that have no unread articles in them.  The default is @code{t}.
2503
2504
2505 @node Topic Commands
2506 @subsection Topic Commands
2507 @cindex topic commands
2508
2509 When the topic minor mode is turned on, a new @kbd{T} submap will be
2510 available.  In addition, a few of the standard keys change their
2511 definitions slightly.
2512
2513 @table @kbd
2514
2515 @item T n
2516 @kindex T n (Topic)
2517 @findex gnus-topic-create-topic
2518 Prompt for a new topic name and create it 
2519 (@code{gnus-topic-create-topic}). 
2520
2521 @item T m
2522 @kindex T m (Topic)
2523 @findex gnus-topic-move-group
2524 Move the current group to some other topic
2525 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2526 convention (@pxref{Process/Prefix}).
2527
2528 @item T c
2529 @kindex T c (Topic)
2530 @findex gnus-topic-copy-group
2531 Copy the current group to some other topic
2532 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2533 convention (@pxref{Process/Prefix}).
2534
2535 @item T D
2536 @kindex T D (Topic)
2537 @findex gnus-topic-remove-group
2538 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2539 This command uses the process/prefix convention
2540 (@pxref{Process/Prefix}).
2541
2542 @item T M
2543 @kindex T M (Topic)
2544 @findex gnus-topic-move-matching
2545 Move all groups that match some regular expression to a topic
2546 (@code{gnus-topic-move-matching}). 
2547
2548 @item T C
2549 @kindex T C (Topic)
2550 @findex gnus-topic-copy-matching
2551 Copy all groups that match some regular expression to a topic
2552 (@code{gnus-topic-copy-matching}). 
2553
2554 @item T h
2555 @kindex T h (Topic)
2556 @findex gnus-topic-toggle-display-empty-topics
2557 Toggle hiding empty topics
2558 (@code{gnus-topic-toggle-display-empty-topics}). 
2559
2560 @item T #
2561 @kindex T # (Topic)
2562 @findex gnus-topic-mark-topic
2563 Mark all groups in the current topic with the process mark
2564 (@code{gnus-topic-mark-topic}). 
2565
2566 @item T M-#
2567 @kindex T M-# (Topic)
2568 @findex gnus-topic-unmark-topic
2569 Remove the process mark from all groups in the current topic
2570 (@code{gnus-topic-unmark-topic}). 
2571
2572 @item RET
2573 @kindex RET (Topic)
2574 @findex gnus-topic-select-group
2575 @itemx SPACE
2576 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2577 When you perform this command on a group, you'll enter the group, as
2578 usual.  When done on a topic line, the topic will be folded (if it was
2579 visible) or unfolded (if it was folded already).  So it's basically a
2580 toggling command on topics.  In addition, if you give a numerical
2581 prefix, group on that level (and lower) will be displayed.
2582
2583 @item T TAB
2584 @kindex T TAB (Topic)
2585 @findex gnus-topic-indent
2586 ``Indent'' the current topic so that it becomes a sub-topic of the
2587 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2588 ``un-indent'' the topic instead.
2589
2590 @item C-k
2591 @kindex C-k (Topic)
2592 @findex gnus-topic-kill-group
2593 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2594 topic will be removed along with the topic.
2595
2596 @item C-y
2597 @kindex C-y (Topic)
2598 @findex gnus-topic-yank-group
2599 Yank the previously killed group or topic
2600 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2601 before all groups. 
2602
2603 @item T r
2604 @kindex T r (Topic)
2605 @findex gnus-topic-rename
2606 Rename a topic (@code{gnus-topic-rename}). 
2607
2608 @item T DEL
2609 @kindex T DEL (Topic)
2610 @findex gnus-topic-delete
2611 Delete an empty topic (@code{gnus-topic-delete}). 
2612
2613 @item A T
2614 @kindex A T (Topic)
2615 @findex gnus-topic-list-active
2616 List all groups that Gnus knows about in a topics-ified way
2617 (@code{gnus-topic-list-active}).
2618
2619 @item G p
2620 @kindex G p (Topic)
2621 @findex gnus-topic-edit-parameters
2622 @cindex group parameters
2623 @cindex topic parameters
2624 @cindex parameters
2625 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2626 @xref{Topic Parameters}.
2627
2628 @end table
2629
2630
2631 @node Topic Sorting
2632 @subsection Topic Sorting
2633 @cindex topic sorting
2634
2635 You can sort the groups in each topic individually with the following
2636 commands: 
2637
2638
2639 @table @kbd
2640 @item T S a
2641 @kindex T S a (Topic)
2642 @findex gnus-topic-sort-groups-by-alphabet
2643 Sort the current topic alphabetically by group name
2644 (@code{gnus-topic-sort-groups-by-alphabet}). 
2645
2646 @item T S u
2647 @kindex T S u (Topic)
2648 @findex gnus-topic-sort-groups-by-unread
2649 Sort the current topic by the number of unread articles
2650 (@code{gnus-topic-sort-groups-by-unread}).
2651
2652 @item T S l
2653 @kindex T S l (Topic)
2654 @findex gnus-topic-sort-groups-by-level
2655 Sort the current topic by group level
2656 (@code{gnus-topic-sort-groups-by-level}). 
2657
2658 @item T S v
2659 @kindex T S v (Topic)
2660 @findex gnus-topic-sort-groups-by-score
2661 Sort the current topic by group score
2662 (@code{gnus-topic-sort-groups-by-score}). 
2663
2664 @item T S r
2665 @kindex T S r (Topic)
2666 @findex gnus-topic-sort-groups-by-rank
2667 Sort the current topic by group rank
2668 (@code{gnus-topic-sort-groups-by-rank}). 
2669
2670 @item T S m
2671 @kindex T S m (Topic)
2672 @findex gnus-topic-sort-groups-by-method
2673 Sort the current topic alphabetically by backend name
2674 (@code{gnus-topic-sort-groups-by-method}). 
2675
2676 @end table
2677
2678 @xref{Sorting Groups} for more information about group sorting. 
2679
2680
2681 @node Topic Topology
2682 @subsection Topic Topology
2683 @cindex topic topology
2684 @cindex topology
2685
2686 So, let's have a look at an example group buffer:
2687
2688 @example
2689 Gnus
2690   Emacs -- I wuw it!
2691      3: comp.emacs
2692      2: alt.religion.emacs
2693     Naughty Emacs
2694      452: alt.sex.emacs
2695        0: comp.talk.emacs.recovery
2696   Misc
2697      8: comp.binaries.fractals
2698     13: comp.sources.unix
2699 @end example
2700
2701 So, here we have one top-level topic (@samp{Gnus}), two topics under
2702 that, and one sub-topic under one of the sub-topics.  (There is always
2703 just one (1) top-level topic).  This topology can be expressed as
2704 follows:
2705
2706 @lisp
2707 (("Gnus" visible)
2708  (("Emacs -- I wuw it!" visible) 
2709   (("Naughty Emacs" visible)))
2710  (("Misc" visible)))
2711 @end lisp
2712
2713 @vindex gnus-topic-topology
2714 This is in fact how the variable @code{gnus-topic-topology} would look
2715 for the display above.  That variable is saved in the @file{.newsrc.eld}
2716 file, and shouldn't be messed with manually---unless you really want
2717 to.  Since this variable is read from the @file{.newsrc.eld} file,
2718 setting it in any other startup files will have no effect.  
2719
2720 This topology shows what topics are sub-topics of what topics (right),
2721 and which topics are visible.  Two settings are currently
2722 allowed---@code{visible} and @code{invisible}.
2723
2724
2725 @node Topic Parameters
2726 @subsection Topic Parameters
2727 @cindex topic parameters
2728
2729 All groups in a topic will inherit group parameters from the parent (and
2730 ancestor) topic parameters.  All legal group parameters are legal topic
2731 parameters (@pxref{Group Parameters}).  
2732
2733 Group parameters (of course) override topic parameters, and topic
2734 parameters in sub-topics override topic parameters in super-topics.  You
2735 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2736 verb, although you may feel free to disagree with me here.)
2737
2738 @example
2739 Gnus
2740   Emacs
2741      3: comp.emacs
2742      2: alt.religion.emacs
2743    452: alt.sex.emacs
2744     Relief
2745      452: alt.sex.emacs
2746        0: comp.talk.emacs.recovery
2747   Misc
2748      8: comp.binaries.fractals
2749     13: comp.sources.unix
2750    452: alt.sex.emacs
2751 @end example
2752
2753 The @samp{Emacs} topic has the topic parameter @code{(score-file
2754 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2755 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2756 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2757 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2758 . "religion.SCORE")}.
2759
2760 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2761 will get the @file{relief.SCORE} home score file.  If you enter the same
2762 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2763 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2764 get the @file{religion.SCORE} home score file.
2765
2766 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2767 there are some problems, especially with the @code{total-expiry}
2768 parameter.  Say you have a mail group in two topics; one with
2769 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2770 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2771 of these topics you mean to expire articles from, so anything may
2772 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2773 happens.  You just have to be careful if you do stuff like that.
2774
2775
2776 @node Misc Group Stuff
2777 @section Misc Group Stuff
2778
2779 @menu
2780 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2781 * Group Information::     Information and help on groups and Gnus.
2782 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2783 * File Commands::         Reading and writing the Gnus files.
2784 @end menu
2785
2786 @table @kbd
2787
2788 @item ^
2789 @kindex ^ (Group)
2790 @findex gnus-group-enter-server-mode
2791 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2792 @xref{The Server Buffer}.
2793
2794 @item a
2795 @kindex a (Group)
2796 @findex gnus-group-post-news
2797 Post an article to a group (@code{gnus-group-post-news}).  The current
2798 group name will be used as the default.
2799
2800 @item m
2801 @kindex m (Group)
2802 @findex gnus-group-mail
2803 Mail a message somewhere (@code{gnus-group-mail}).
2804
2805 @end table
2806
2807 Variables for the group buffer:
2808
2809 @table @code
2810
2811 @item gnus-group-mode-hook
2812 @vindex gnus-group-mode-hook
2813 @code{gnus-group-mode-hook} is called after the group buffer has been
2814 created. 
2815
2816 @item gnus-group-prepare-hook
2817 @vindex gnus-group-prepare-hook
2818 @code{gnus-group-prepare-hook} is called after the group buffer is
2819 generated.  It may be used to modify the buffer in some strange,
2820 unnatural way.
2821
2822 @item gnus-permanently-visible-groups
2823 @vindex gnus-permanently-visible-groups
2824 Groups matching this regexp will always be listed in the group buffer,
2825 whether they are empty or not.
2826
2827 @end table
2828
2829
2830 @node Scanning New Messages
2831 @subsection Scanning New Messages
2832 @cindex new messages
2833 @cindex scanning new news
2834
2835 @table @kbd
2836
2837 @item g
2838 @kindex g (Group)
2839 @findex gnus-group-get-new-news
2840 Check the server(s) for new articles.  If the numerical prefix is used,
2841 this command will check only groups of level @var{arg} and lower
2842 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2843 command will force a total rereading of the active file(s) from the
2844 backend(s).
2845
2846 @item M-g
2847 @kindex M-g (Group)
2848 @findex gnus-group-get-new-news-this-group
2849 @vindex gnus-goto-next-group-when-activating
2850 Check whether new articles have arrived in the current group
2851 (@code{gnus-group-get-new-news-this-group}).
2852 @code{gnus-goto-next-group-when-activating} says whether this command is
2853 to move point to the next group or not.  It is @code{t} by default.
2854
2855 @findex gnus-activate-all-groups
2856 @cindex activating groups
2857 @item C-c M-g
2858 @kindex C-c M-g (Group)
2859 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2860
2861 @item R
2862 @kindex R (Group)
2863 @cindex restarting
2864 @findex gnus-group-restart
2865 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2866 file(s), closes the connection to all servers, clears up all run-time
2867 Gnus variables, and then starts Gnus all over again.
2868
2869 @end table
2870
2871 @vindex gnus-get-new-news-hook
2872 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2873
2874 @vindex gnus-after-getting-new-news-hook
2875 @code{gnus-after-getting-new-news-hook} is run after checking for new
2876 news.
2877
2878
2879 @node Group Information
2880 @subsection Group Information
2881 @cindex group information
2882 @cindex information on groups
2883
2884 @table @kbd
2885
2886
2887 @item H f
2888 @kindex H f (Group)
2889 @findex gnus-group-fetch-faq
2890 @vindex gnus-group-faq-directory
2891 @cindex FAQ
2892 @cindex ange-ftp
2893 Try to fetch the FAQ for the current group
2894 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2895 @code{gnus-group-faq-directory}, which is usually a directory on a
2896 remote machine.  This variable can also be a list of directories.  In
2897 that case, giving a prefix to this command will allow you to choose
2898 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2899 for fetching the file.
2900
2901 If fetching from the first site is unsuccessful, Gnus will attempt to go
2902 through @code{gnus-group-faq-directory} and try to open them one by one.
2903
2904 @item H d
2905 @itemx C-c C-d
2906 @kindex H d (Group)
2907 @kindex C-c C-d (Group)
2908 @cindex describing groups
2909 @cindex group description
2910 @findex gnus-group-describe-group
2911 Describe the current group (@code{gnus-group-describe-group}).  If given
2912 a prefix, force Gnus to re-read the description from the server.
2913
2914 @item M-d
2915 @kindex M-d (Group)
2916 @findex gnus-group-describe-all-groups
2917 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2918 prefix, force Gnus to re-read the description file from the server.
2919
2920 @item H v
2921 @itemx V
2922 @kindex V (Group)
2923 @kindex H v (Group)
2924 @cindex version
2925 @findex gnus-version
2926 Display current Gnus version numbers (@code{gnus-version}).
2927
2928 @item ?
2929 @kindex ? (Group)
2930 @findex gnus-group-describe-briefly
2931 Give a very short help message (@code{gnus-group-describe-briefly}).
2932
2933 @item C-c C-i
2934 @kindex C-c C-i (Group)
2935 @cindex info
2936 @cindex manual
2937 @findex gnus-info-find-node
2938 Go to the Gnus info node (@code{gnus-info-find-node}).
2939 @end table
2940
2941
2942 @node Group Timestamp
2943 @subsection Group Timestamp
2944 @cindex timestamps
2945 @cindex group timestamps
2946
2947 It can be convenient to let Gnus keep track of when you last read a
2948 group.  To set the ball rolling, you should add
2949 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2950
2951 @lisp
2952 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2953 @end lisp
2954
2955 After doing this, each time you enter a group, it'll be recorded.
2956
2957 This information can be displayed in various ways---the easiest is to
2958 use the @samp{%d} spec in the group line format:
2959
2960 @lisp
2961 (setq gnus-group-line-format 
2962       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2963 @end lisp
2964
2965 This will result in lines looking like:
2966
2967 @example
2968 *        0: mail.ding                                19961002T012943
2969          0: custom                                   19961002T012713
2970 @end example
2971
2972 As you can see, the date is displayed in compact ISO 8601 format.  This
2973 may be a bit too much, so to just display the date, you could say
2974 something like:
2975
2976 @lisp
2977 (setq gnus-group-line-format 
2978       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2979 @end lisp
2980
2981
2982 @node File Commands
2983 @subsection File Commands
2984 @cindex file commands
2985
2986 @table @kbd
2987
2988 @item r
2989 @kindex r (Group)
2990 @findex gnus-group-read-init-file
2991 @vindex gnus-init-file
2992 @cindex reading init file
2993 Re-read the init file (@code{gnus-init-file}, which defaults to
2994 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2995
2996 @item s
2997 @kindex s (Group)
2998 @findex gnus-group-save-newsrc
2999 @cindex saving .newsrc
3000 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3001 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
3002 file(s) whether Gnus thinks it is necessary or not.
3003
3004 @c @item Z
3005 @c @kindex Z (Group)
3006 @c @findex gnus-group-clear-dribble
3007 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3008
3009 @end table
3010
3011
3012 @node The Summary Buffer
3013 @chapter The Summary Buffer
3014 @cindex summary buffer
3015
3016 A line for each article is displayed in the summary buffer.  You can
3017 move around, read articles, post articles and reply to articles.
3018
3019 The most common way to a summary buffer is to select a group from the
3020 group buffer (@pxref{Selecting a Group}).  
3021
3022 You can have as many summary buffers open as you wish.
3023
3024 @menu
3025 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3026 * Summary Maneuvering::         Moving around the summary buffer.
3027 * Choosing Articles::           Reading articles.
3028 * Paging the Article::          Scrolling the current article.
3029 * Reply Followup and Post::     Posting articles.
3030 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3031 * Marking Articles::            Marking articles as read, expirable, etc.
3032 * Limiting::                    You can limit the summary buffer.
3033 * Threading::                   How threads are made.
3034 * Sorting::                     How articles and threads are sorted.
3035 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3036 * Article Caching::             You may store articles in a cache.
3037 * Persistent Articles::         Making articles expiry-resistant.
3038 * Article Backlog::             Having already read articles hang around.
3039 * Saving Articles::             Ways of customizing article saving.
3040 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3041 * Article Treatment::           The article buffer can be mangled at will.
3042 * Article Commands::            Doing various things with the article buffer.
3043 * Summary Sorting::             Sorting the summary buffer in various ways.
3044 * Finding the Parent::          No child support? Get the parent.
3045 * Alternative Approaches::      Reading using non-default summaries.
3046 * Tree Display::                A more visual display of threads.
3047 * Mail Group Commands::         Some commands can only be used in mail groups.
3048 * Various Summary Stuff::       What didn't fit anywhere else.
3049 * Exiting the Summary Buffer::  Returning to the Group buffer.
3050 * Crosspost Handling::          How crossposted articles are dealt with.
3051 * Duplicate Suppression::       An alternative when crosspost handling fails.
3052 @end menu
3053
3054
3055 @node Summary Buffer Format
3056 @section Summary Buffer Format
3057 @cindex summary buffer format
3058
3059 @menu
3060 * Summary Buffer Lines::     You can specify how summary lines should look.
3061 * Summary Buffer Mode Line:: You can say how the mode line should look.
3062 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3063 @end menu
3064
3065 @findex mail-extract-address-components
3066 @findex gnus-extract-address-components
3067 @vindex gnus-extract-address-components
3068 Gnus will use the value of the @code{gnus-extract-address-components}
3069 variable as a function for getting the name and address parts of a
3070 @code{From} header.  Two pre-defined function exist:
3071 @code{gnus-extract-address-components}, which is the default, quite
3072 fast, and too simplistic solution; and
3073 @code{mail-extract-address-components}, which works very nicely, but is
3074 slower.  The default function will return the wrong answer in 5% of the
3075 cases.  If this is unacceptable to you, use the other function instead.
3076
3077 @vindex gnus-summary-same-subject
3078 @code{gnus-summary-same-subject} is a string indicating that the current
3079 article has the same subject as the previous.  This string will be used
3080 with those specs that require it.  The default is @samp{}.
3081
3082
3083 @node Summary Buffer Lines
3084 @subsection Summary Buffer Lines
3085
3086 @vindex gnus-summary-line-format
3087 You can change the format of the lines in the summary buffer by changing
3088 the @code{gnus-summary-line-format} variable.  It works along the same
3089 lines a a normal @code{format} string, with some extensions
3090 (@pxref{Formatting Variables}).
3091
3092 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3093
3094 The following format specification characters are understood:
3095
3096 @table @samp
3097 @item N 
3098 Article number.
3099 @item S
3100 Subject string.
3101 @item s
3102 Subject if the article is the root or the previous article had a
3103 different subject, @code{gnus-summary-same-subject} otherwise.
3104 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3105 @item F
3106 Full @code{From} header.
3107 @item n
3108 The name (from the @code{From} header).
3109 @item a
3110 The name (from the @code{From} header).  This differs from the @code{n}
3111 spec in that it uses the function designated by the
3112 @code{gnus-extract-address-components} variable, which is slower, but
3113 may be more thorough.
3114 @item A
3115 The address (from the @code{From} header).  This works the same way as
3116 the @code{a} spec.
3117 @item L
3118 Number of lines in the article.
3119 @item c
3120 Number of characters in the article.
3121 @item I
3122 Indentation based on thread level (@pxref{Customizing Threading}).
3123 @item T
3124 Nothing if the article is a root and lots of spaces if it isn't (it
3125 pushes everything after it off the screen).
3126 @item [
3127 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3128 for adopted articles (@pxref{Customizing Threading}).
3129 @item ]
3130 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3131 for adopted articles.
3132 @item >
3133 One space for each thread level.
3134 @item <
3135 Twenty minus thread level spaces.
3136 @item U
3137 Unread.
3138 @item R
3139 Replied.
3140 @item i
3141 Score as a number.
3142 @item z
3143 @vindex gnus-summary-zcore-fuzz
3144 Zcore, @samp{+} if above the default level and @samp{-} if below the
3145 default level.  If the difference between
3146 @code{gnus-summary-default-level} and the score is less than
3147 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3148 @item V
3149 Total thread score.
3150 @item x
3151 @code{Xref}.
3152 @item D
3153 @code{Date}.
3154 @item d
3155 The @code{Date} in @code{DD-MMM} format.
3156 @item o
3157 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3158 @item M
3159 @code{Message-ID}.
3160 @item r
3161 @code{References}.
3162 @item t
3163 Number of articles in the current sub-thread.  Using this spec will slow
3164 down summary buffer generation somewhat.
3165 @item e
3166 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3167 article has any children.
3168 @item P
3169 The line number.
3170 @item u
3171 User defined specifier.  The next character in the format string should
3172 be a letter.  @sc{gnus} will call the function
3173 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3174 following @samp{%u}.  The function will be passed the current header as
3175 argument.  The function should return a string, which will be inserted
3176 into the summary just like information from any other summary specifier.
3177 @end table
3178
3179 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3180 have to be handled with care.  For reasons of efficiency, Gnus will
3181 compute what column these characters will end up in, and ``hard-code''
3182 that.  This means that it is illegal to have these specs after a
3183 variable-length spec.  Well, you might not be arrested, but your summary
3184 buffer will look strange, which is bad enough.
3185
3186 The smart choice is to have these specs as far to the left as possible.
3187 (Isn't that the case with everything, though?  But I digress.)
3188
3189 This restriction may disappear in later versions of Gnus.
3190
3191
3192 @node Summary Buffer Mode Line
3193 @subsection Summary Buffer Mode Line
3194
3195 @vindex gnus-summary-mode-line-format
3196 You can also change the format of the summary mode bar.  Set
3197 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3198 is @samp{Gnus: %%b [%A] %Z}.  
3199
3200 Here are the elements you can play with:
3201
3202 @table @samp
3203 @item G
3204 Group name.
3205 @item p
3206 Unprefixed group name.
3207 @item A
3208 Current article number.
3209 @item V
3210 Gnus version.
3211 @item U
3212 Number of unread articles in this group.
3213 @item e
3214 Number of unselected articles in this group.
3215 @item Z
3216 A string with the number of unread and unselected articles represented
3217 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3218 articles, and just as @samp{<%U more>} if there are just unread articles
3219 and no unselected ones.
3220 @item g
3221 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3222 shortened to @samp{r.a.anime}. 
3223 @item S
3224 Subject of the current article.
3225 @item u
3226 User-defined spec.
3227 @item s
3228 Name of the current score file.
3229 @item d
3230 Number of dormant articles.
3231 @item t
3232 Number of ticked articles.
3233 @item r
3234 Number of articles that have been marked as read in this session. 
3235 @item E
3236 Number of articles expunged by the score files.
3237 @end table
3238
3239
3240 @node Summary Highlighting
3241 @subsection Summary Highlighting
3242
3243 @table @code
3244
3245 @item gnus-visual-mark-article-hook
3246 @vindex gnus-visual-mark-article-hook
3247 This hook is run after selecting an article.  It is meant to be used for
3248 highlighting the article in some way.  It is not run if
3249 @code{gnus-visual} is @code{nil}.
3250
3251 @item gnus-summary-update-hook
3252 @vindex gnus-summary-update-hook
3253 This hook is called when a summary line is changed.  It is not run if
3254 @code{gnus-visual} is @code{nil}.
3255
3256 @item gnus-summary-selected-face
3257 @vindex gnus-summary-selected-face
3258 This is the face (or @dfn{font} as some people call it) that is used to
3259 highlight the current article in the summary buffer.
3260
3261 @item gnus-summary-highlight
3262 @vindex gnus-summary-highlight
3263 Summary lines are highlighted according to this variable, which is a
3264 list where the elements are on the format @var{(FORM . FACE)}.  If you
3265 would, for instance, like ticked articles to be italic and high-scored
3266 articles to be bold, you could set this variable to something like
3267 @lisp
3268 (((eq mark gnus-ticked-mark) . italic)
3269  ((> score default) . bold))
3270 @end lisp
3271 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3272 @var{FACE} will be applied to the line.
3273 @end table
3274
3275
3276 @node Summary Maneuvering
3277 @section Summary Maneuvering
3278 @cindex summary movement
3279
3280 All the straight movement commands understand the numeric prefix and
3281 behave pretty much as you'd expect. 
3282
3283 None of these commands select articles.
3284
3285 @table @kbd
3286 @item G M-n
3287 @itemx M-n
3288 @kindex M-n (Summary)
3289 @kindex G M-n (Summary)
3290 @findex gnus-summary-next-unread-subject
3291 Go to the next summary line of an unread article
3292 (@code{gnus-summary-next-unread-subject}). 
3293
3294 @item G M-p
3295 @itemx M-p
3296 @kindex M-p (Summary)
3297 @kindex G M-p (Summary)
3298 @findex gnus-summary-prev-unread-subject
3299 Go to the previous summary line of an unread article
3300 (@code{gnus-summary-prev-unread-subject}). 
3301
3302 @item G j
3303 @itemx j
3304 @kindex j (Summary)
3305 @kindex G j (Summary)
3306 @findex gnus-summary-goto-article
3307 Ask for an article number and then go to that article
3308 (@code{gnus-summary-goto-article}). 
3309
3310 @item G g
3311 @kindex G g (Summary)
3312 @findex gnus-summary-goto-subject
3313 Ask for an article number and then go the summary line of that article
3314 without displaying the article (@code{gnus-summary-goto-subject}).
3315 @end table
3316
3317 If Gnus asks you to press a key to confirm going to the next group, you
3318 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3319 buffer, searching for the next group to read without actually returning
3320 to the group buffer.
3321
3322 Variables related to summary movement:
3323
3324 @table @code
3325
3326 @vindex gnus-auto-select-next
3327 @item gnus-auto-select-next
3328 If you issue one of the movement commands (like @kbd{n}) and there are
3329 no more unread articles after the current one, Gnus will offer to go to
3330 the next group.  If this variable is @code{t} and the next group is
3331 empty, Gnus will exit summary mode and return to the group buffer.  If
3332 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3333 next group, no matter whether it has any unread articles or not.  As a
3334 special case, if this variable is @code{quietly}, Gnus will select the
3335 next group without asking for confirmation.  If this variable is
3336 @code{almost-quietly}, the same will happen only if you are located on
3337 the last article in the group.  Finally, if this variable is
3338 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3339 without confirmation.  Also @pxref{Group Levels}.
3340
3341 @item gnus-auto-select-same
3342 @vindex gnus-auto-select-same
3343 If non-@code{nil}, all the movement commands will try to go to the next
3344 article with the same subject as the current.  (@dfn{Same} here might
3345 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3346 for details (@pxref{Customizing Threading}).)  This variable is not
3347 particularly useful if you use a threaded display.
3348
3349 @item gnus-summary-check-current
3350 @vindex gnus-summary-check-current
3351 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3352 to the next (or previous) article if the current article is unread.
3353 Instead, they will choose the current article.
3354
3355 @item gnus-auto-center-summary
3356 @vindex gnus-auto-center-summary
3357 If non-@code{nil}, Gnus will keep the point in the summary buffer
3358 centered at all times.  This makes things quite tidy, but if you have a
3359 slow network connection, or simply do not like this un-Emacsism, you can
3360 set this variable to @code{nil} to get the normal Emacs scrolling
3361 action.  This will also inhibit horizontal re-centering of the summary
3362 buffer, which might make it more inconvenient to read extremely long
3363 threads.
3364
3365 @end table
3366
3367
3368 @node Choosing Articles
3369 @section Choosing Articles
3370 @cindex selecting articles
3371
3372 @menu
3373 * Choosing Commands::        Commands for choosing articles.
3374 * Choosing Variables::       Variables that influence these commands.
3375 @end menu
3376
3377
3378 @node Choosing Commands
3379 @subsection Choosing Commands
3380
3381 None of the following movement commands understand the numeric prefix,
3382 and they all select and display an article.
3383
3384 @table @kbd
3385 @item SPACE
3386 @kindex SPACE (Summary)
3387 @findex gnus-summary-next-page
3388 Select the current article, or, if that one's read already, the next
3389 unread article (@code{gnus-summary-next-page}).
3390
3391 @item G n
3392 @itemx n
3393 @kindex n (Summary)
3394 @kindex G n (Summary)
3395 @findex gnus-summary-next-unread-article
3396 Go to next unread article (@code{gnus-summary-next-unread-article}).
3397
3398 @item G p
3399 @itemx p
3400 @kindex p (Summary)
3401 @findex gnus-summary-prev-unread-article
3402 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3403
3404 @item G N
3405 @itemx N
3406 @kindex N (Summary)
3407 @kindex G N (Summary)
3408 @findex gnus-summary-next-article
3409 Go to the next article (@code{gnus-summary-next-article}).
3410
3411 @item G P
3412 @itemx P
3413 @kindex P (Summary)
3414 @kindex G P (Summary)
3415 @findex gnus-summary-prev-article
3416 Go to the previous article (@code{gnus-summary-prev-article}).
3417
3418 @item G C-n
3419 @kindex G C-n (Summary)
3420 @findex gnus-summary-next-same-subject
3421 Go to the next article with the same subject
3422 (@code{gnus-summary-next-same-subject}). 
3423
3424 @item G C-p
3425 @kindex G C-p (Summary)
3426 @findex gnus-summary-prev-same-subject
3427 Go to the previous article with the same subject
3428 (@code{gnus-summary-prev-same-subject}). 
3429
3430 @item G f
3431 @itemx .
3432 @kindex G f  (Summary)
3433 @kindex .  (Summary)
3434 @findex gnus-summary-first-unread-article
3435 Go to the first unread article
3436 (@code{gnus-summary-first-unread-article}).
3437
3438 @item G b
3439 @itemx ,
3440 @kindex G b (Summary)
3441 @kindex , (Summary)
3442 @findex gnus-summary-best-unread-article
3443 Go to the article with the highest score
3444 (@code{gnus-summary-best-unread-article}). 
3445
3446 @item G l
3447 @itemx l
3448 @kindex l (Summary)
3449 @kindex G l (Summary)
3450 @findex gnus-summary-goto-last-article
3451 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3452
3453 @item G p
3454 @kindex G p (Summary)
3455 @findex gnus-summary-pop-article
3456 Pop an article off the summary history and go to this article
3457 (@code{gnus-summary-pop-article}).  This command differs from the
3458 command above in that you can pop as many previous articles off the
3459 history as you like.
3460 @end table
3461
3462
3463 @node Choosing Variables
3464 @subsection Choosing Variables
3465
3466 Some variables that are relevant for moving and selecting articles:
3467
3468 @table @code
3469 @item gnus-auto-extend-newsgroup
3470 @vindex gnus-auto-extend-newsgroup
3471 All the movement commands will try to go to the previous (or next)
3472 article, even if that article isn't displayed in the Summary buffer if
3473 this variable is non-@code{nil}.  Gnus will then fetch the article from
3474 the server and display it in the article buffer.
3475
3476 @item gnus-select-article-hook
3477 @vindex gnus-select-article-hook
3478 This hook is called whenever an article is selected.  By default it
3479 exposes any threads hidden under the selected article.
3480
3481 @item gnus-mark-article-hook
3482 @vindex gnus-mark-article-hook
3483 @findex gnus-summary-mark-unread-as-read
3484 @findex gnus-summary-mark-read-and-unread-as-read
3485 @findex gnus-unread-mark
3486 This hook is called whenever an article is selected.  It is intended to
3487 be used for marking articles as read.  The default value is
3488 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3489 mark of almost any article you read to @code{gnus-unread-mark}.  The
3490 only articles not affected by this function are ticked, dormant, and
3491 expirable articles.  If you'd instead like to just have unread articles
3492 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3493 instead.  It will leave marks like @code{gnus-low-score-mark},
3494 @code{gnus-del-mark} (and so on) alone.
3495
3496 @end table
3497
3498
3499 @node Paging the Article
3500 @section Scrolling the Article
3501 @cindex article scrolling
3502
3503 @table @kbd
3504
3505 @item SPACE
3506 @kindex SPACE (Summary)
3507 @findex gnus-summary-next-page
3508 Pressing @kbd{SPACE} will scroll the current article forward one page,
3509 or, if you have come to the end of the current article, will choose the
3510 next article (@code{gnus-summary-next-page}).
3511
3512 @item DEL
3513 @kindex DEL (Summary)
3514 @findex gnus-summary-prev-page
3515 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3516
3517 @item RET
3518 @kindex RET (Summary)
3519 @findex gnus-summary-scroll-up
3520 Scroll the current article one line forward
3521 (@code{gnus-summary-scroll-up}).
3522
3523 @item A g
3524 @itemx g
3525 @kindex A g (Summary)
3526 @kindex g (Summary)
3527 @findex gnus-summary-show-article
3528 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3529 given a prefix, fetch the current article, but don't run any of the
3530 article treatment functions.  This will give you a ``raw'' article, just
3531 the way it came from the server.
3532
3533 @item A <
3534 @itemx <
3535 @kindex < (Summary)
3536 @kindex A < (Summary)
3537 @findex gnus-summary-beginning-of-article
3538 Scroll to the beginning of the article
3539 (@code{gnus-summary-beginning-of-article}).
3540
3541 @item A >
3542 @itemx >
3543 @kindex > (Summary)
3544 @kindex A > (Summary)
3545 @findex gnus-summary-end-of-article
3546 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3547
3548 @item A s 
3549 @itemx s
3550 @kindex A s (Summary)
3551 @kindex s (Summary)
3552 @findex gnus-summary-isearch-article
3553 Perform an isearch in the article buffer
3554 (@code{gnus-summary-isearch-article}). 
3555
3556 @end table
3557
3558
3559 @node Reply Followup and Post
3560 @section Reply, Followup and Post
3561
3562 @menu
3563 * Summary Mail Commands::            Sending mail.
3564 * Summary Post Commands::            Sending news.
3565 @end menu
3566
3567
3568 @node Summary Mail Commands
3569 @subsection Summary Mail Commands
3570 @cindex mail
3571 @cindex composing mail
3572
3573 Commands for composing a mail message:
3574
3575 @table @kbd
3576
3577 @item S r
3578 @itemx r
3579 @kindex S r (Summary)
3580 @kindex r (Summary)
3581 @findex gnus-summary-reply
3582 Mail a reply to the author of the current article
3583 (@code{gnus-summary-reply}). 
3584
3585 @item S R
3586 @itemx R
3587 @kindex R (Summary)
3588 @kindex S R (Summary)
3589 @findex gnus-summary-reply-with-original
3590 Mail a reply to the author of the current article and include the
3591 original message (@code{gnus-summary-reply-with-original}).  This
3592 command uses the process/prefix convention.
3593
3594 @item S w
3595 @kindex S w (Summary)
3596 @findex gnus-summary-wide-reply
3597 Mail a wide reply to the author of the current article
3598 (@code{gnus-summary-wide-reply}). 
3599
3600 @item S W
3601 @kindex S W (Summary)
3602 @findex gnus-summary-wide-reply-with-original
3603 Mail a wide reply to the current article and include the original
3604 message (@code{gnus-summary-reply-with-original}).  This command uses
3605 the process/prefix convention.
3606
3607 @item S o m
3608 @kindex S o m (Summary)
3609 @findex gnus-summary-mail-forward
3610 Forward the current article to some other person
3611 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3612 headers of the forwarded article.
3613
3614 @item S m
3615 @itemx m
3616 @kindex m (Summary)
3617 @kindex S m (Summary)
3618 @findex gnus-summary-mail-other-window
3619 Send a mail to some other person
3620 (@code{gnus-summary-mail-other-window}).
3621
3622 @item S D b
3623 @kindex S D b (Summary)
3624 @findex gnus-summary-resend-bounced-mail
3625 @cindex bouncing mail
3626 If you have sent a mail, but the mail was bounced back to you for some
3627 reason (wrong address, transient failure), you can use this command to
3628 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3629 will be popped into a mail buffer where you can edit the headers before
3630 sending the mail off again.  If you give a prefix to this command, and
3631 the bounced mail is a reply to some other mail, Gnus will try to fetch
3632 that mail and display it for easy perusal of its headers.  This might
3633 very well fail, though.
3634
3635 @item S D r
3636 @kindex S D r (Summary)
3637 @findex gnus-summary-resend-message
3638 Not to be confused with the previous command,
3639 @code{gnus-summary-resend-message} will prompt you for an address to
3640 send the current message off to, and then send it to that place.  The
3641 headers of the message won't be altered---but lots of headers that say
3642 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3643 means that you actually send a mail to someone that has a @code{To}
3644 header that (probably) points to yourself.  This will confuse people.
3645 So, natcherly you'll only do that if you're really eVIl.  
3646
3647 This command is mainly used if you have several accounts and want to
3648 ship a mail to a different account of yours.  (If you're both
3649 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3650 to the @code{root} account, you may want to resend it to
3651 @code{postmaster}.  Ordnung muß sein!
3652
3653 This command understands the process/prefix convention
3654 (@pxref{Process/Prefix}). 
3655
3656 @item S O m
3657 @kindex S O m (Summary)
3658 @findex gnus-uu-digest-mail-forward
3659 Digest the current series and forward the result using mail
3660 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3661 process/prefix convention (@pxref{Process/Prefix}). 
3662
3663 @item S M-c
3664 @kindex S M-c (Summary)
3665 @findex gnus-summary-mail-crosspost-complaint
3666 @cindex crossposting
3667 @cindex excessive crossposting
3668 Send a complaint about excessive crossposting to the author of the
3669 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3670
3671 @findex gnus-crosspost-complaint
3672 This command is provided as a way to fight back agains the current
3673 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3674 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3675 command understands the process/prefix convention
3676 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3677
3678 @end table
3679
3680
3681 @node Summary Post Commands
3682 @subsection Summary Post Commands
3683 @cindex post
3684 @cindex composing news
3685
3686 Commands for posting a news article:
3687
3688 @table @kbd
3689 @item S p
3690 @itemx a
3691 @kindex a (Summary)
3692 @kindex S p (Summary)
3693 @findex gnus-summary-post-news
3694 Post an article to the current group
3695 (@code{gnus-summary-post-news}).
3696
3697 @item S f
3698 @itemx f
3699 @kindex f (Summary)
3700 @kindex S f (Summary)
3701 @findex gnus-summary-followup
3702 Post a followup to the current article (@code{gnus-summary-followup}).
3703
3704 @item S F
3705 @itemx F
3706 @kindex S F (Summary)
3707 @kindex F (Summary)
3708 @findex gnus-summary-followup-with-original
3709 Post a followup to the current article and include the original message
3710 (@code{gnus-summary-followup-with-original}).   This command uses the
3711 process/prefix convention.
3712
3713 @item S n
3714 @kindex S n (Summary)
3715 @findex gnus-summary-followup-to-mail
3716 Post a followup to the current article via news, even if you got the
3717 message through mail (@code{gnus-summary-followup-to-mail}).
3718
3719 @item S n
3720 @kindex S n (Summary)
3721 @findex gnus-summary-followup-to-mail
3722 Post a followup to the current article via news, even if you got the
3723 message through mail and include the original message
3724 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3725 the process/prefix convention.
3726
3727 @item S o p
3728 @kindex S o p (Summary)
3729 @findex gnus-summary-post-forward
3730 Forward the current article to a newsgroup
3731 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3732 headers of the forwarded article.
3733
3734 @item S O p
3735 @kindex S O p (Summary)
3736 @findex gnus-uu-digest-post-forward
3737 @cindex digests
3738 @cindex making digests
3739 Digest the current series and forward the result to a newsgroup
3740 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3741 process/prefix convention.
3742
3743 @item S u
3744 @kindex S u (Summary)
3745 @findex gnus-uu-post-news
3746 Uuencode a file, split it into parts, and post it as a series
3747 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3748 @end table
3749
3750
3751 @node Canceling and Superseding
3752 @section Canceling Articles
3753 @cindex canceling articles
3754 @cindex superseding articles
3755
3756 Have you ever written something, and then decided that you really,
3757 really, really wish you hadn't posted that?
3758
3759 Well, you can't cancel mail, but you can cancel posts.
3760
3761 @findex gnus-summary-cancel-article
3762 @kindex C (Summary)
3763 Find the article you wish to cancel (you can only cancel your own
3764 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3765 c} (@code{gnus-summary-cancel-article}).  Your article will be
3766 canceled---machines all over the world will be deleting your article. 
3767
3768 Be aware, however, that not all sites honor cancels, so your article may
3769 live on here and there, while most sites will delete the article in
3770 question.
3771
3772 If you discover that you have made some mistakes and want to do some
3773 corrections, you can post a @dfn{superseding} article that will replace
3774 your original article.
3775
3776 @findex gnus-summary-supersede-article
3777 @kindex S (Summary)
3778 Go to the original article and press @kbd{S s}
3779 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3780 where you can edit the article all you want before sending it off the
3781 usual way.
3782
3783 The same goes for superseding as for canceling, only more so: Some
3784 sites do not honor superseding.  On those sites, it will appear that you
3785 have posted almost the same article twice.
3786
3787 If you have just posted the article, and change your mind right away,
3788 there is a trick you can use to cancel/supersede the article without
3789 waiting for the article to appear on your site first.  You simply return
3790 to the post buffer (which is called @code{*sent ...*}).  There you will
3791 find the article you just posted, with all the headers intact.  Change
3792 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3793 header by substituting one of those words for the word
3794 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3795 you would do normally.  The previous article will be
3796 canceled/superseded.
3797
3798 Just remember, kids: There is no 'c' in 'supersede'.
3799
3800
3801 @node Marking Articles
3802 @section Marking Articles
3803 @cindex article marking
3804 @cindex article ticking
3805 @cindex marks
3806
3807 There are several marks you can set on an article. 
3808
3809 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3810 neologism ohoy!) of the article.  Alphabetic marks generally mean
3811 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3812
3813 In addition, you also have marks that do not affect readedness.
3814
3815 @menu
3816 * Unread Articles::      Marks for unread articles.
3817 * Read Articles::        Marks for read articles.
3818 * Other Marks::          Marks that do not affect readedness.
3819 @end menu
3820
3821 @ifinfo
3822 There's a plethora of commands for manipulating these marks:
3823 @end ifinfo
3824
3825 @menu
3826 * Setting Marks::           How to set and remove marks.
3827 * Setting Process Marks::   How to mark articles for later processing.
3828 @end menu
3829
3830
3831 @node Unread Articles
3832 @subsection Unread Articles
3833
3834 The following marks mark articles as (kinda) unread, in one form or
3835 other.
3836
3837 @table @samp
3838 @item !
3839 @vindex gnus-ticked-mark
3840 Marked as ticked (@code{gnus-ticked-mark}).
3841
3842 @dfn{Ticked articles} are articles that will remain visible always.  If
3843 you see an article that you find interesting, or you want to put off
3844 reading it, or replying to it, until sometime later, you'd typically
3845 tick it.  However, articles can be expired, so if you want to keep an
3846 article forever, you'll have to make it persistent (@pxref{Persistent
3847 Articles}).  
3848
3849 @item ?
3850 @vindex gnus-dormant-mark
3851 Marked as dormant (@code{gnus-dormant-mark}).  
3852
3853 @dfn{Dormant articles} will only appear in the summary buffer if there
3854 are followups to it.
3855
3856 @item SPACE
3857 @vindex gnus-unread-mark
3858 Markes as unread (@code{gnus-unread-mark}).
3859
3860 @dfn{Unread articles} are articles that haven't been read at all yet.
3861 @end table
3862
3863
3864 @node Read Articles
3865 @subsection Read Articles
3866 @cindex expirable mark
3867
3868 All the following marks mark articles as read.
3869
3870 @table @samp
3871
3872 @item r
3873 @vindex gnus-del-mark
3874 These are articles that the user has marked as read with the @kbd{d}
3875 command manually, more or less (@code{gnus-del-mark}).
3876
3877 @item R
3878 @vindex gnus-read-mark
3879 Articles that have actually been read (@code{gnus-read-mark}).
3880
3881 @item O
3882 @vindex gnus-ancient-mark
3883 Articles that were marked as read in previous sessions and are now
3884 @dfn{old} (@code{gnus-ancient-mark}).
3885
3886 @item K
3887 @vindex gnus-killed-mark
3888 Marked as killed (@code{gnus-killed-mark}).
3889
3890 @item X
3891 @vindex gnus-kill-file-mark
3892 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3893
3894 @item Y
3895 @vindex gnus-low-score-mark
3896 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3897
3898 @item C
3899 @vindex gnus-catchup-mark
3900 Marked as read by a catchup (@code{gnus-catchup-mark}).
3901
3902 @item G
3903 @vindex gnus-canceled-mark
3904 Canceled article (@code{gnus-canceled-mark})
3905
3906 @item F
3907 @vindex gnus-souped-mark
3908 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3909
3910 @item Q
3911 @vindex gnus-sparse-mark
3912 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3913 Threading}.
3914
3915 @item M
3916 @vindex gnus-duplicate-mark
3917 Article marked as read by duplicate suppression
3918 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3919
3920 @end table
3921
3922 All these marks just mean that the article is marked as read, really.
3923 They are interpreted differently when doing adaptive scoring, though.
3924
3925 One more special mark, though:
3926
3927 @table @samp
3928 @item E
3929 @vindex gnus-expirable-mark
3930 Marked as expirable (@code{gnus-expirable-mark}).
3931
3932 Marking articles as @dfn{expirable} (or have them marked as such
3933 automatically) doesn't make much sense in normal groups---a user doesn't
3934 control the expiring of news articles, but in mail groups, for instance,
3935 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3936 any time.
3937 @end table
3938
3939
3940 @node Other Marks
3941 @subsection Other Marks
3942 @cindex process mark
3943 @cindex bookmarks
3944
3945 There are some marks that have nothing to do with whether the article is
3946 read or not.
3947
3948 @itemize @bullet
3949
3950 @item 
3951 You can set a bookmark in the current article.  Say you are reading a
3952 long thesis on cats' urinary tracts, and have to go home for dinner
3953 before you've finished reading the thesis.  You can then set a bookmark
3954 in the article, and Gnus will jump to this bookmark the next time it
3955 encounters the article.  @xref{Setting Marks}
3956
3957 @item
3958 @vindex gnus-replied-mark
3959 All articles that you have replied to or made a followup to (i.e., have
3960 answered) will be marked with an @samp{A} in the second column
3961 (@code{gnus-replied-mark}).
3962
3963 @item 
3964 @vindex gnus-cached-mark
3965 Articles that are stored in the article cache will be marked with an
3966 @samp{*} in the second column (@code{gnus-cached-mark}).
3967
3968 @item 
3969 @vindex gnus-saved-mark
3970 Articles that are ``saved'' (in some manner or other; not necessarily
3971 religiously) are marked with an @samp{S} in the second column
3972 (@code{gnus-saved-mark}.
3973
3974 @item 
3975 @vindex gnus-not-empty-thread-mark
3976 @vindex gnus-empty-thread-mark
3977 It the @samp{%e} spec is used, the presence of threads or not will be
3978 marked with @code{gnus-not-empty-thread-mark} and
3979 @code{gnus-empty-thread-mark} in the third column, respectively.
3980
3981 @item 
3982 @vindex gnus-process-mark
3983 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3984 variety of commands react to the presence of the process mark.  For
3985 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3986 all articles that have been marked with the process mark.  Articles
3987 marked with the process mark have a @samp{#} in the second column.
3988
3989 @end itemize
3990
3991 You might have noticed that most of these ``non-readedness'' marks
3992 appear in the second column by default.  So if you have a cached, saved,
3993 replied article that you have process-marked, what will that look like?
3994
3995 Nothing much.  The precedence rules go as follows: process -> cache ->
3996 replied -> saved.  So if the article is in the cache and is replied,
3997 you'll only see the cache mark and not the replied mark.
3998
3999
4000 @node Setting Marks
4001 @subsection Setting Marks
4002 @cindex setting marks
4003
4004 All the marking commands understand the numeric prefix.
4005
4006 @table @kbd
4007 @item M t
4008 @itemx !
4009 @kindex ! (Summary)
4010 @kindex M t (Summary)
4011 @findex gnus-summary-tick-article-forward
4012 Tick the current article (@code{gnus-summary-tick-article-forward}).
4013
4014 @item M ?
4015 @itemx ?
4016 @kindex ? (Summary)
4017 @kindex M ? (Summary)
4018 @findex gnus-summary-mark-as-dormant
4019 Mark the current article as dormant
4020 (@code{gnus-summary-mark-as-dormant}).
4021
4022 @item M d
4023 @itemx d
4024 @kindex M d (Summary)
4025 @kindex d (Summary)
4026 @findex gnus-summary-mark-as-read-forward
4027 Mark the current article as read
4028 (@code{gnus-summary-mark-as-read-forward}).
4029
4030 @item D
4031 @kindex D (Summary)
4032 @findex gnus-summary-mark-as-read-backward
4033 Mark the current article as read and move point to the previous line
4034 (@code{gnus-summary-mark-as-read-backward}).
4035
4036 @item M k
4037 @itemx k
4038 @kindex k (Summary)
4039 @kindex M k (Summary)
4040 @findex gnus-summary-kill-same-subject-and-select
4041 Mark all articles that have the same subject as the current one as read,
4042 and then select the next unread article
4043 (@code{gnus-summary-kill-same-subject-and-select}).
4044
4045 @item M K
4046 @itemx C-k
4047 @kindex M K (Summary)
4048 @kindex C-k (Summary)
4049 @findex gnus-summary-kill-same-subject
4050 Mark all articles that have the same subject as the current one as read
4051 (@code{gnus-summary-kill-same-subject}).  
4052
4053 @item M C
4054 @kindex M C (Summary)
4055 @findex gnus-summary-catchup
4056 Mark all unread articles as read (@code{gnus-summary-catchup}).
4057
4058 @item M C-c
4059 @kindex M C-c (Summary)
4060 @findex gnus-summary-catchup-all
4061 Mark all articles in the group as read---even the ticked and dormant
4062 articles (@code{gnus-summary-catchup-all}).
4063
4064 @item M H
4065 @kindex M H (Summary)
4066 @findex gnus-summary-catchup-to-here
4067 Catchup the current group to point
4068 (@code{gnus-summary-catchup-to-here}). 
4069
4070 @item C-w
4071 @kindex C-w (Summary)
4072 @findex gnus-summary-mark-region-as-read
4073 Mark all articles between point and mark as read
4074 (@code{gnus-summary-mark-region-as-read}). 
4075
4076 @item M V k
4077 @kindex M V k (Summary)
4078 @findex gnus-summary-kill-below
4079 Kill all articles with scores below the default score (or below the
4080 numeric prefix) (@code{gnus-summary-kill-below}).
4081
4082 @item M c
4083 @itemx M-u
4084 @kindex M c (Summary)
4085 @kindex M-u (Summary)
4086 @findex gnus-summary-clear-mark-forward
4087 Clear all readedness-marks from the current article
4088 (@code{gnus-summary-clear-mark-forward}).
4089
4090 @item M e
4091 @itemx E
4092 @kindex M e (Summary)
4093 @kindex E (Summary)
4094 @findex gnus-summary-mark-as-expirable
4095 Mark the current article as expirable
4096 (@code{gnus-summary-mark-as-expirable}).
4097
4098 @item M b
4099 @kindex M b (Summary)
4100 @findex gnus-summary-set-bookmark
4101 Set a bookmark in the current article
4102 (@code{gnus-summary-set-bookmark}).
4103
4104 @item M B
4105 @kindex M B (Summary)
4106 @findex gnus-summary-remove-bookmark
4107 Remove the bookmark from the current article
4108 (@code{gnus-summary-remove-bookmark}).
4109
4110 @item M V c
4111 @kindex M V c (Summary)
4112 @findex gnus-summary-clear-above
4113 Clear all marks from articles with scores over the default score (or
4114 over the numeric prefix) (@code{gnus-summary-clear-above}).
4115
4116 @item M V u
4117 @kindex M V u (Summary)
4118 @findex gnus-summary-tick-above
4119 Tick all articles with scores over the default score (or over the
4120 numeric prefix) (@code{gnus-summary-tick-above}).
4121
4122 @item M V m
4123 @kindex M V m (Summary)
4124 @findex gnus-summary-mark-above
4125 Prompt for a mark, and mark all articles with scores over the default
4126 score (or over the numeric prefix) with this mark
4127 (@code{gnus-summary-clear-above}).
4128 @end table
4129
4130 @vindex gnus-summary-goto-unread
4131 The @code{gnus-summary-goto-unread} variable controls what action should
4132 be taken after setting a mark.  If non-@code{nil}, point will move to
4133 the next/previous unread article.  If @code{nil}, point will just move
4134 one line up or down.  As a special case, if this variable is
4135 @code{never}, all the marking commands as well as other commands (like
4136 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4137 The default is @code{t}.
4138
4139
4140 @node Setting Process Marks
4141 @subsection Setting Process Marks
4142 @cindex setting process marks
4143
4144 @table @kbd
4145
4146 @item M P p
4147 @itemx #
4148 @kindex # (Summary)
4149 @kindex M P p (Summary)
4150 @findex gnus-summary-mark-as-processable
4151 Mark the current article with the process mark
4152 (@code{gnus-summary-mark-as-processable}). 
4153 @findex gnus-summary-unmark-as-processable
4154
4155 @item M P u 
4156 @itemx M-#
4157 @kindex M P u (Summary)
4158 @kindex M-# (Summary)
4159 Remove the process mark, if any, from the current article
4160 (@code{gnus-summary-unmark-as-processable}).
4161
4162 @item M P U
4163 @kindex M P U (Summary)
4164 @findex gnus-summary-unmark-all-processable
4165 Remove the process mark from all articles
4166 (@code{gnus-summary-unmark-all-processable}). 
4167
4168 @item M P i
4169 @kindex M P i (Summary)
4170 @findex gnus-uu-invert-processable
4171 Invert the list of process marked articles
4172 (@code{gnus-uu-invert-processable}). 
4173
4174 @item M P R
4175 @kindex M P R (Summary)
4176 @findex gnus-uu-mark-by-regexp
4177 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4178
4179 @item M P r
4180 @kindex M P r (Summary)
4181 @findex gnus-uu-mark-region
4182 Mark articles in region (@code{gnus-uu-mark-region}).
4183
4184 @item M P t
4185 @kindex M P t (Summary)
4186 @findex gnus-uu-mark-thread
4187 Mark all articles in the current (sub)thread
4188 (@code{gnus-uu-mark-thread}).
4189
4190 @item M P T
4191 @kindex M P T (Summary)
4192 @findex gnus-uu-unmark-thread
4193 Unmark all articles in the current (sub)thread
4194 (@code{gnus-uu-unmark-thread}).
4195
4196 @item M P v
4197 @kindex M P v (Summary)
4198 @findex gnus-uu-mark-over
4199 Mark all articles that have a score above the prefix argument
4200 (@code{gnus-uu-mark-over}).
4201
4202 @item M P s
4203 @kindex M P s (Summary)
4204 @findex gnus-uu-mark-series
4205 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4206
4207 @item M P S
4208 @kindex M P S (Summary)
4209 @findex gnus-uu-mark-sparse
4210 Mark all series that have already had some articles marked
4211 (@code{gnus-uu-mark-sparse}).
4212
4213 @item M P a
4214 @kindex M P a (Summary)
4215 @findex gnus-uu-mark-all
4216 Mark all articles in series order (@code{gnus-uu-mark-series}).
4217
4218 @item M P b
4219 @kindex M P b (Summary)
4220 @findex gnus-uu-mark-buffer
4221 Mark all articles in the buffer in the order they appear
4222 (@code{gnus-uu-mark-buffer}). 
4223
4224 @item M P k
4225 @kindex M P k (Summary)
4226 @findex gnus-summary-kill-process-mark
4227 Push the current process mark set onto the stack and unmark all articles
4228 (@code{gnus-summary-kill-process-mark}).
4229
4230 @item M P y
4231 @kindex M P y (Summary)
4232 @findex gnus-summary-yank-process-mark
4233 Pop the previous process mark set from the stack and restore it
4234 (@code{gnus-summary-yank-process-mark}).
4235
4236 @item M P w
4237 @kindex M P w (Summary)
4238 @findex gnus-summary-save-process-mark
4239 Push the current process mark set onto the stack
4240 (@code{gnus-summary-save-process-mark}).
4241
4242 @end table
4243
4244
4245 @node Limiting
4246 @section Limiting
4247 @cindex limiting
4248
4249 It can be convenient to limit the summary buffer to just show some
4250 subset of the articles currently in the group.  The effect most limit
4251 commands have is to remove a few (or many) articles from the summary
4252 buffer. 
4253
4254 @table @kbd
4255
4256 @item / /
4257 @itemx / s
4258 @kindex / / (Summary)
4259 @findex gnus-summary-limit-to-subject
4260 Limit the summary buffer to articles that match some subject
4261 (@code{gnus-summary-limit-to-subject}). 
4262
4263 @item / a
4264 @kindex / a (Summary)
4265 @findex gnus-summary-limit-to-author
4266 Limit the summary buffer to articles that match some author
4267 (@code{gnus-summary-limit-to-author}).
4268
4269 @item / u
4270 @itemx x
4271 @kindex / u (Summary)
4272 @kindex x (Summary)
4273 @findex gnus-summary-limit-to-unread
4274 Limit the summary buffer to articles that are not marked as read
4275 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4276 buffer to articles that are strictly unread.  This means that ticked and
4277 dormant articles will also be excluded.
4278
4279 @item / m
4280 @kindex / m (Summary)
4281 @findex gnus-summary-limit-to-marks
4282 Ask for a mark and then limit to all articles that have not been marked
4283 with that mark (@code{gnus-summary-limit-to-marks}).
4284
4285 @item / t
4286 @kindex / t (Summary)
4287 @findex gnus-summary-limit-to-age
4288 Ask for a number and then limit the summary buffer to articles that are
4289 older than (or equal to) that number of days
4290 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4291 articles that are younger than that number of days.
4292
4293 @item / n
4294 @kindex / n (Summary)
4295 @findex gnus-summary-limit-to-articles
4296 Limit the summary buffer to the current article
4297 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4298 convention (@pxref{Process/Prefix}).
4299
4300 @item / w
4301 @kindex / w (Summary)
4302 @findex gnus-summary-pop-limit
4303 Pop the previous limit off the stack and restore it
4304 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4305 the stack.
4306
4307 @item / v
4308 @kindex / v (Summary)
4309 @findex gnus-summary-limit-to-score
4310 Limit the summary buffer to articles that have a score at or above some
4311 score (@code{gnus-summary-limit-to-score}).
4312
4313 @item / E
4314 @itemx M S
4315 @kindex M S (Summary)
4316 @kindex / E (Summary)
4317 @findex gnus-summary-limit-include-expunged
4318 Display all expunged articles
4319 (@code{gnus-summary-limit-include-expunged}). 
4320
4321 @item / D
4322 @kindex / D (Summary)
4323 @findex gnus-summary-limit-include-dormant
4324 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4325
4326 @item / d
4327 @kindex / d (Summary)
4328 @findex gnus-summary-limit-exclude-dormant
4329 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4330
4331 @item / c
4332 @kindex / c (Summary)
4333 @findex gnus-summary-limit-exclude-childless-dormant
4334 Hide all dormant articles that have no children
4335 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4336
4337 @item / C
4338 @kindex / C (Summary)
4339 @findex gnus-summary-limit-mark-excluded-as-read
4340 Mark all excluded unread articles as read
4341 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4342 also mark excluded ticked and dormant articles as read.
4343
4344 @end table
4345
4346
4347 @node Threading
4348 @section Threading
4349 @cindex threading
4350 @cindex article threading
4351
4352 Gnus threads articles by default.  @dfn{To thread} is to put responses
4353 to articles directly after the articles they respond to---in a
4354 hierarchical fashion.
4355
4356 @menu
4357 * Customizing Threading::     Variables you can change to affect the threading.
4358 * Thread Commands::           Thread based commands in the summary buffer.
4359 @end menu
4360
4361
4362 @node Customizing Threading
4363 @subsection Customizing Threading
4364 @cindex customizing threading
4365 @cindex <
4366 @cindex >
4367
4368 @table @code
4369
4370 @item gnus-show-threads
4371 @vindex gnus-show-threads
4372 If this variable is @code{nil}, no threading will be done, and all of
4373 the rest of the variables here will have no effect.  Turning threading
4374 off will speed group selection up a bit, but it is sure to make reading
4375 slower and more awkward.
4376
4377 @item gnus-fetch-old-headers
4378 @vindex gnus-fetch-old-headers
4379 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4380 more old headers---headers to articles that are marked as read.  If you
4381 would like to display as few summary lines as possible, but still
4382 connect as many loose threads as possible, you should set this variable
4383 to @code{some} or a number.  If you set it to a number, no more than
4384 that number of extra old headers will be fetched.  In either case,
4385 fetching old headers only works if the backend you are using carries
4386 overview files---this would normally be @code{nntp}, @code{nnspool} and
4387 @code{nnml}.  Also remember that if the root of the thread has been
4388 expired by the server, there's not much Gnus can do about that.
4389
4390 @item gnus-build-sparse-threads
4391 @vindex gnus-build-sparse-threads
4392 Fetching old headers can be slow.  A low-rent similar effect can be
4393 gotten by setting this variable to @code{some}.  Gnus will then look at
4394 the complete @code{References} headers of all articles and try to string
4395 articles that belong in the same thread together.  This will leave
4396 @dfn{gaps} in the threading display where Gnus guesses that an article
4397 is missing from the thread.  (These gaps appear like normal summary
4398 lines.  If you select a gap, Gnus will try to fetch the article in
4399 question.)  If this variable is @code{t}, Gnus will display all these
4400 ``gaps'' without regard for whether they are useful for completing the
4401 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4402 off sparse leaf nodes that don't lead anywhere.  This variable is
4403 @code{nil} by default.
4404
4405 @item gnus-summary-gather-subject-limit
4406 @vindex gnus-summary-gather-subject-limit
4407 Loose threads are gathered by comparing subjects of articles.  If this
4408 variable is @code{nil}, Gnus requires an exact match between the
4409 subjects of the loose threads before gathering them into one big
4410 super-thread.  This might be too strict a requirement, what with the
4411 presence of stupid newsreaders that chop off long subjects lines.  If
4412 you think so, set this variable to, say, 20 to require that only the
4413 first 20 characters of the subjects have to match.  If you set this
4414 variable to a really low number, you'll find that Gnus will gather
4415 everything in sight into one thread, which isn't very helpful.
4416
4417 @cindex fuzzy article gathering
4418 If you set this variable to the special value @code{fuzzy}, Gnus will
4419 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4420 Matching}). 
4421
4422 @item gnus-simplify-subject-fuzzy-regexp
4423 @vindex gnus-simplify-subject-fuzzy-regexp
4424 This can either be a regular expression or list of regular expressions
4425 that match strings that will be removed from subjects if fuzzy subject
4426 simplification is used.
4427
4428 @item gnus-simplify-ignored-prefixes
4429 @vindex gnus-simplify-ignored-prefixes
4430 If you set @code{gnus-summary-gather-subject-limit} to something as low
4431 as 10, you might consider setting this variable to something sensible:
4432
4433 @c Written by Michael Ernst <mernst@cs.rice.edu>
4434 @lisp
4435 (setq gnus-simplify-ignored-prefixes
4436       (concat 
4437        "\\`\\[?\\("
4438        (mapconcat 
4439         'identity
4440         '("looking"
4441           "wanted" "followup" "summary\\( of\\)?"
4442           "help" "query" "problem" "question" 
4443           "answer" "reference" "announce"
4444           "How can I" "How to" "Comparison of"
4445           ;; ...
4446           )
4447         "\\|")
4448        "\\)\\s *\\("
4449        (mapconcat 'identity
4450                   '("for" "for reference" "with" "about")
4451                   "\\|")
4452        "\\)?\\]?:?[ \t]*"))
4453 @end lisp
4454
4455 All words that match this regexp will be removed before comparing two
4456 subjects. 
4457
4458 @item gnus-summary-gather-exclude-subject
4459 @vindex gnus-summary-gather-exclude-subject
4460 Since loose thread gathering is done on subjects only, that might lead
4461 to many false hits, especially with certain common subjects like
4462 @samp{} and @samp{(none)}.  To make the situation slightly better,
4463 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4464 what subjects should be excluded from the gathering process.  The
4465 default is @samp{^ *$\\|^(none)$}.  
4466
4467 @item gnus-summary-thread-gathering-function
4468 @vindex gnus-summary-thread-gathering-function
4469 Gnus gathers threads by looking at @code{Subject} headers.  This means
4470 that totally unrelated articles may end up in the same ``thread'', which
4471 is confusing.  An alternate approach is to look at all the
4472 @code{Message-ID}s in all the @code{References} headers to find matches.
4473 This will ensure that no gathered threads ever includes unrelated
4474 articles, but it's also means that people who have posted with broken
4475 newsreaders won't be gathered properly.  The choice is yours---plague or
4476 cholera:
4477
4478 @table @code
4479 @item gnus-gather-threads-by-subject
4480 @findex gnus-gather-threads-by-subject
4481 This function is the default gathering function and looks at
4482 @code{Subject}s exclusively.
4483
4484 @item gnus-gather-threads-by-references
4485 @findex gnus-gather-threads-by-references
4486 This function looks at @code{References} headers exclusively.
4487 @end table
4488
4489 If you want to test gathering by @code{References}, you could say
4490 something like:
4491
4492 @lisp
4493 (setq gnus-summary-thread-gathering-function
4494       'gnus-gather-threads-by-references)
4495 @end lisp
4496
4497 @item gnus-summary-make-false-root
4498 @vindex gnus-summary-make-false-root
4499 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4500 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4501 Yup.)  Loose subtrees occur when the real root has expired, or you've
4502 read or killed the root in a previous session.
4503
4504 When there is no real root of a thread, Gnus will have to fudge
4505 something.  This variable says what fudging method Gnus should use.
4506 There are four possible values:
4507
4508 @cindex adopting articles
4509
4510 @table @code
4511
4512 @item adopt
4513 Gnus will make the first of the orphaned articles the parent.  This
4514 parent will adopt all the other articles.  The adopted articles will be
4515 marked as such by pointy brackets (@samp{<>}) instead of the standard
4516 square brackets (@samp{[]}).  This is the default method.
4517
4518 @item dummy
4519 @vindex gnus-summary-dummy-line-format
4520 Gnus will create a dummy summary line that will pretend to be the
4521 parent.  This dummy line does not correspond to any real article, so
4522 selecting it will just select the first real article after the dummy
4523 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4524 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4525 which is the subject of the article.  @xref{Formatting Variables}.
4526
4527 @item empty
4528 Gnus won't actually make any article the parent, but simply leave the
4529 subject field of all orphans except the first empty.  (Actually, it will
4530 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4531 Buffer Format}).)
4532
4533 @item none
4534 Don't make any article parent at all.  Just gather the threads and
4535 display them after one another.
4536
4537 @item nil
4538 Don't gather loose threads.
4539 @end table
4540
4541 @item gnus-thread-hide-subtree
4542 @vindex gnus-thread-hide-subtree
4543 If non-@code{nil}, all threads will be hidden when the summary buffer is
4544 generated.
4545
4546 @item gnus-thread-expunge-below
4547 @vindex gnus-thread-expunge-below
4548 All threads that have a total score (as defined by
4549 @code{gnus-thread-score-function}) less than this number will be
4550 expunged.  This variable is @code{nil} by default, which means that no
4551 threads are expunged.
4552
4553 @item gnus-thread-hide-killed
4554 @vindex gnus-thread-hide-killed
4555 if you kill a thread and this variable is non-@code{nil}, the subtree
4556 will be hidden.
4557
4558 @item gnus-thread-ignore-subject
4559 @vindex gnus-thread-ignore-subject
4560 Sometimes somebody changes the subject in the middle of a thread.  If
4561 this variable is non-@code{nil}, the subject change is ignored.  If it
4562 is @code{nil}, which is the default, a change in the subject will result
4563 in a new thread.
4564
4565 @item gnus-thread-indent-level
4566 @vindex gnus-thread-indent-level
4567 This is a number that says how much each sub-thread should be indented.
4568 The default is 4.
4569
4570 @item gnus-parse-headers-hook
4571 @vindex gnus-parse-headers-hook
4572 Hook run before parsing any headers.  The default value is
4573 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4574 slightly decoded in a hackish way.  This is likely to change in the
4575 future when Gnus becomes @sc{MIME}ified.
4576
4577 @end table
4578
4579
4580 @node Thread Commands
4581 @subsection Thread Commands
4582 @cindex thread commands
4583
4584 @table @kbd
4585
4586 @item T k
4587 @itemx M-C-k
4588 @kindex T k (Summary)
4589 @kindex M-C-k (Summary)
4590 @findex gnus-summary-kill-thread
4591 Mark all articles in the current (sub-)thread as read
4592 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4593 remove all marks instead.  If the prefix argument is negative, tick
4594 articles instead.
4595
4596 @item T l
4597 @itemx M-C-l
4598 @kindex T l (Summary)
4599 @kindex M-C-l (Summary)
4600 @findex gnus-summary-lower-thread
4601 Lower the score of the current (sub-)thread
4602 (@code{gnus-summary-lower-thread}). 
4603
4604 @item T i
4605 @kindex T i (Summary)
4606 @findex gnus-summary-raise-thread
4607 Increase the score of the current (sub-)thread
4608 (@code{gnus-summary-raise-thread}).
4609
4610 @item T #
4611 @kindex T # (Summary)
4612 @findex gnus-uu-mark-thread
4613 Set the process mark on the current (sub-)thread
4614 (@code{gnus-uu-mark-thread}).
4615
4616 @item T M-#
4617 @kindex T M-# (Summary)
4618 @findex gnus-uu-unmark-thread
4619 Remove the process mark from the current (sub-)thread
4620 (@code{gnus-uu-unmark-thread}).
4621
4622 @item T T
4623 @kindex T T (Summary)
4624 @findex gnus-summary-toggle-threads
4625 Toggle threading (@code{gnus-summary-toggle-threads}).
4626
4627 @item T s
4628 @kindex T s (Summary)
4629 @findex gnus-summary-show-thread
4630 Expose the (sub-)thread hidden under the current article, if any
4631 (@code{gnus-summary-show-thread}).
4632
4633 @item T h
4634 @kindex T h (Summary)
4635 @findex gnus-summary-hide-thread
4636 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4637
4638 @item T S
4639 @kindex T S (Summary)
4640 @findex gnus-summary-show-all-threads
4641 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4642
4643 @item T H
4644 @kindex T H (Summary)
4645 @findex gnus-summary-hide-all-threads
4646 Hide all threads (@code{gnus-summary-hide-all-threads}).
4647
4648 @item T t
4649 @kindex T t (Summary)
4650 @findex gnus-summary-rethread-current
4651 Re-thread the thread the current article is part of
4652 (@code{gnus-summary-rethread-current}).  This works even when the
4653 summary buffer is otherwise unthreaded.
4654
4655 @item T ^
4656 @kindex T ^ (Summary)
4657 @findex gnus-summary-reparent-thread
4658 Make the current article the child of the marked (or previous) article
4659 (@code{gnus-summary-reparent-thread}.
4660
4661 @end table
4662
4663 The following commands are thread movement commands.  They all
4664 understand the numeric prefix.
4665
4666 @table @kbd
4667
4668 @item T n
4669 @kindex T n (Summary)
4670 @findex gnus-summary-next-thread
4671 Go to the next thread (@code{gnus-summary-next-thread}).
4672
4673 @item T p
4674 @kindex T p (Summary)
4675 @findex gnus-summary-prev-thread
4676 Go to the previous thread (@code{gnus-summary-prev-thread}).
4677
4678 @item T d
4679 @kindex T d (Summary)
4680 @findex gnus-summary-down-thread
4681 Descend the thread (@code{gnus-summary-down-thread}).
4682
4683 @item T u
4684 @kindex T u (Summary)
4685 @findex gnus-summary-up-thread
4686 Ascend the thread (@code{gnus-summary-up-thread}).
4687
4688 @item T o
4689 @kindex T o (Summary)
4690 @findex gnus-summary-top-thread
4691 Go to the top of the thread (@code{gnus-summary-top-thread}).
4692 @end table
4693
4694 @vindex gnus-thread-operation-ignore-subject 
4695 If you ignore subject while threading, you'll naturally end up with
4696 threads that have several different subjects in them.  If you then issue
4697 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4698 wish to kill the entire thread, but just those parts of the thread that
4699 have the same subject as the current article.  If you like this idea,
4700 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4701 is non-@code{nil} (which it is by default), subjects will be ignored
4702 when doing thread commands.  If this variable is @code{nil}, articles in
4703 the same thread with different subjects will not be included in the
4704 operation in question.  If this variable is @code{fuzzy}, only articles
4705 that have subjects that are fuzzily equal will be included (@pxref{Fuzzy
4706 Matching}).
4707
4708
4709 @node Sorting
4710 @section Sorting
4711
4712 @findex gnus-thread-sort-by-total-score
4713 @findex gnus-thread-sort-by-date
4714 @findex gnus-thread-sort-by-score
4715 @findex gnus-thread-sort-by-subject
4716 @findex gnus-thread-sort-by-author
4717 @findex gnus-thread-sort-by-number
4718 @vindex gnus-thread-sort-functions
4719 If you are using a threaded summary display, you can sort the threads by
4720 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4721 By default, sorting is done on article numbers.  Ready-made sorting
4722 predicate functions include @code{gnus-thread-sort-by-number},
4723 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4724 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4725 @code{gnus-thread-sort-by-total-score}.
4726
4727 Each function takes two threads and return non-@code{nil} if the first
4728 thread should be sorted before the other.  Note that sorting really is
4729 normally done by looking only at the roots of each thread.  If you use
4730 more than one function, the primary sort key should be the last function
4731 in the list.  You should probably always include
4732 @code{gnus-thread-sort-by-number} in the list of sorting
4733 functions---preferably first.  This will ensure that threads that are
4734 equal with respect to the other sort criteria will be displayed in
4735 ascending article order.
4736
4737 If you would like to sort by score, then by subject, and finally by
4738 number, you could do something like:
4739
4740 @lisp
4741 (setq gnus-thread-sort-functions 
4742       '(gnus-thread-sort-by-number
4743         gnus-thread-sort-by-subject
4744         gnus-thread-sort-by-total-score))
4745 @end lisp
4746
4747 The threads that have highest score will be displayed first in the
4748 summary buffer.  When threads have the same score, they will be sorted
4749 alphabetically.  The threads that have the same score and the same
4750 subject will be sorted by number, which is (normally) the sequence in
4751 which the articles arrived.
4752
4753 If you want to sort by score and then reverse arrival order, you could
4754 say something like:
4755
4756 @lisp
4757 (setq gnus-thread-sort-functions
4758       '((lambda (t1 t2) 
4759           (not (gnus-thread-sort-by-number t1 t2)))
4760         gnus-thread-sort-by-score))
4761 @end lisp
4762
4763 @vindex gnus-thread-score-function
4764 The function in the @code{gnus-thread-score-function} variable (default
4765 @code{+}) is used for calculating the total score of a thread.  Useful
4766 functions might be @code{max}, @code{min}, or squared means, or whatever
4767 tickles your fancy.
4768
4769 @findex gnus-article-sort-functions
4770 @findex gnus-article-sort-by-date
4771 @findex gnus-article-sort-by-score
4772 @findex gnus-article-sort-by-subject
4773 @findex gnus-article-sort-by-author
4774 @findex gnus-article-sort-by-number
4775 If you are using an unthreaded display for some strange reason or other,
4776 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4777 It is very similar to the @code{gnus-thread-sort-functions}, except that
4778 is uses slightly different functions for article comparison.  Available
4779 sorting predicate functions are @code{gnus-article-sort-by-number},
4780 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4781 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4782
4783 If you want to sort an unthreaded summary display by subject, you could
4784 say something like:
4785
4786 @lisp
4787 (setq gnus-article-sort-functions 
4788       '(gnus-article-sort-by-number
4789         gnus-article-sort-by-subject))
4790 @end lisp
4791
4792
4793
4794 @node Asynchronous Fetching
4795 @section Asynchronous Article Fetching
4796 @cindex asynchronous article fetching
4797 @cindex article pre-fetch
4798 @cindex pre-fetch
4799
4800 If you read your news from an @sc{nntp} server that's far away, the
4801 network latencies may make reading articles a chore.  You have to wait
4802 for a while after pressing @kbd{n} to go to the next article before the
4803 article appears.  Why can't Gnus just go ahead and fetch the article
4804 while you are reading the previous one?  Why not, indeed.
4805
4806 First, some caveats.  There are some pitfalls to using asynchronous
4807 article fetching, especially the way Gnus does it.  
4808
4809 Let's say you are reading article 1, which is short, and article 2 is
4810 quite long, and you are not interested in reading that.  Gnus does not
4811 know this, so it goes ahead and fetches article 2.  You decide to read
4812 article 3, but since Gnus is in the process of fetching article 2, the
4813 connection is blocked.
4814
4815 To avoid these situations, Gnus will open two (count 'em two)
4816 connections to the server.  Some people may think this isn't a very nice
4817 thing to do, but I don't see any real alternatives.  Setting up that
4818 extra connection takes some time, so Gnus startup will be slower.
4819
4820 Gnus will fetch more articles than you will read.  This will mean that
4821 the link between your machine and the @sc{nntp} server will become more
4822 loaded than if you didn't use article pre-fetch.  The server itself will
4823 also become more loaded---both with the extra article requests, and the
4824 extra connection.
4825
4826 Ok, so now you know that you shouldn't really use this thing...  unless
4827 you really want to.
4828
4829 @vindex gnus-asynchronous
4830 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4831 happen automatically.
4832
4833 @vindex gnus-use-article-prefetch
4834 You can control how many articles that are to be pre-fetched by setting
4835 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4836 that when you read an article in the group, the backend will pre-fetch
4837 the next 30 articles.  If this variable is @code{t}, the backend will
4838 pre-fetch all the articles that it can without bound.  If it is
4839 @code{nil}, no pre-fetching will be made.
4840
4841 @vindex gnus-async-prefetch-article-p
4842 @findex gnus-async-read-p
4843 There are probably some articles that you don't want to pre-fetch---read
4844 articles, for instance.  Which articles to pre-fetch is controlled by
4845 the @code{gnus-async-prefetch-article-p} variable.  This function should
4846 return non-@code{nil} when the article in question is to be
4847 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4848 @code{nil} on read articles.  The function is called with an article
4849 data structure as the only parameter.
4850
4851 If, for instance, you wish to pre-fetch only unread articles that are
4852 shorter than 100 lines, you could say something like:
4853
4854 @lisp
4855 (defun my-async-short-unread-p (data)
4856   "Return non-nil for short, unread articles."
4857   (and (gnus-data-unread-p data)
4858        (< (mail-header-lines (gnus-data-header data))
4859           100)))
4860
4861 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4862 @end lisp
4863
4864 These functions will be called many, many times, so they should
4865 preferrably be short and sweet to avoid slowing down Gnus too much.
4866 It's also probably a good idea to byte-compile things like this.
4867
4868 @vindex gnus-prefetched-article-deletion-strategy
4869 Articles have to be removed from the asynch buffer sooner or later.  The
4870 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4871 articles.  This is a list that may contain the following elements:
4872
4873 @table @code
4874 @item read
4875 Remove articles when they are read.
4876
4877 @item exit
4878 Remove articles when exiting the group.
4879 @end table
4880
4881 The default value is @code{(read exit)}.
4882
4883 @vindex gnus-use-header-prefetch
4884 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4885 from the next group.
4886
4887
4888 @node Article Caching
4889 @section Article Caching
4890 @cindex article caching
4891 @cindex caching
4892
4893 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4894 consider turning article caching on.  Each article will then be stored
4895 locally under your home directory.  As you may surmise, this could
4896 potentially use @emph{huge} amounts of disk space, as well as eat up all
4897 your inodes so fast it will make your head swim.  In vodka.
4898
4899 Used carefully, though, it could be just an easier way to save articles.
4900
4901 @vindex gnus-use-long-file-name
4902 @vindex gnus-cache-directory
4903 @vindex gnus-use-cache
4904 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4905 all articles that are ticked or marked as dormant will then be copied
4906 over to your local cache (@code{gnus-cache-directory}).  Whether this
4907 cache is flat or hierarchal is controlled by the
4908 @code{gnus-use-long-file-name} variable, as usual.
4909
4910 When re-select a ticked or dormant article, it will be fetched from the
4911 cache instead of from the server.  As articles in your cache will never
4912 expire, this might serve as a method of saving articles while still
4913 keeping them where they belong.  Just mark all articles you want to save
4914 as dormant, and don't worry.
4915
4916 When an article is marked as read, is it removed from the cache.
4917
4918 @vindex gnus-cache-remove-articles
4919 @vindex gnus-cache-enter-articles
4920 The entering/removal of articles from the cache is controlled by the
4921 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4922 variables.  Both are lists of symbols.  The first is @code{(ticked
4923 dormant)} by default, meaning that ticked and dormant articles will be
4924 put in the cache.  The latter is @code{(read)} by default, meaning that
4925 articles that are marked as read are removed from the cache.  Possibly
4926 symbols in these two lists are @code{ticked}, @code{dormant},
4927 @code{unread} and @code{read}.
4928
4929 @findex gnus-jog-cache
4930 So where does the massive article-fetching and storing come into the
4931 picture?  The @code{gnus-jog-cache} command will go through all
4932 subscribed newsgroups, request all unread articles, and store them in
4933 the cache.  You should only ever, ever ever ever, use this command if 1)
4934 your connection to the @sc{nntp} server is really, really, really slow
4935 and 2) you have a really, really, really huge disk.  Seriously.
4936
4937 @vindex gnus-uncacheable-groups
4938 It is likely that you do not want caching on some groups.  For instance,
4939 if your @code{nnml} mail is located under your home directory, it makes no
4940 sense to cache it somewhere else under your home directory.  Unless you
4941 feel that it's neat to use twice as much space.  To limit the caching,
4942 you could set the @code{gnus-uncacheable-groups} regexp to
4943 @samp{^nnml}, for instance.  This variable is @code{nil} by
4944 default.
4945
4946 @findex gnus-cache-generate-nov-databases
4947 @findex gnus-cache-generate-active
4948 @vindex gnus-cache-active-file
4949 The cache stores information on what articles it contains in its active
4950 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4951 of the cache) becomes all messed up for some reason or other, Gnus
4952 offers two functions that will try to set things right.  @kbd{M-x
4953 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4954 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4955 file.
4956
4957
4958 @node Persistent Articles
4959 @section Persistent Articles
4960 @cindex persistent articles
4961
4962 Closely related to article caching, we have @dfn{persistent articles}.
4963 In fact, it's just a different way of looking at caching, and much more
4964 useful in my opinion.
4965
4966 Say you're reading a newsgroup, and you happen on to some valuable gem
4967 that you want to keep and treasure forever.  You'd normally just save it
4968 (using one of the many saving commands) in some file.  The problem with
4969 that is that it's just, well, yucky.  Ideally you'd prefer just having
4970 the article remain in the group where you found it forever; untouched by
4971 the expiry going on at the news server.
4972
4973 This is what a @dfn{persistent article} is---an article that just won't
4974 be deleted.  It's implemented using the normal cache functions, but
4975 you use two explicit commands for managing persistent articles:
4976
4977 @table @kbd
4978
4979 @item *
4980 @kindex * (Summary)
4981 @findex gnus-cache-enter-article
4982 Make the current article persistent (@code{gnus-cache-enter-article}). 
4983
4984 @item M-*
4985 @kindex M-* (Summary)
4986 @findex gnus-cache-remove-article
4987 Remove the current article from the persistent articles
4988 (@code{gnus-cache-remove-article}).  This will normally delete the
4989 article. 
4990 @end table
4991
4992 Both these commands understand the process/prefix convention. 
4993
4994 To avoid having all ticked articles (and stuff) entered into the cache,
4995 you should set @code{gnus-use-cache} to @code{passive} if you're just
4996 interested in persistent articles:
4997
4998 @lisp
4999 (setq gnus-use-cache 'passive)
5000 @end lisp
5001
5002
5003 @node Article Backlog
5004 @section Article Backlog
5005 @cindex backlog
5006 @cindex article backlog
5007
5008 If you have a slow connection, but the idea of using caching seems
5009 unappealing to you (and it is, really), you can help the situation some
5010 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5011 already read articles so that it doesn't have to re-fetch articles
5012 you've already read.  This only helps if you are in the habit of
5013 re-selecting articles you've recently read, of course.  If you never do
5014 that, turning the backlog on will slow Gnus down a little bit, and
5015 increase memory usage some.
5016
5017 @vindex gnus-keep-backlog
5018 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5019 at most @var{n} old articles in a buffer for later re-fetching.  If this
5020 variable is non-@code{nil} and is not a number, Gnus will store
5021 @emph{all} read articles, which means that your Emacs will grow without
5022 bound before exploding and taking your machine down with you.  I put
5023 that in there just to keep y'all on your toes.  
5024
5025 This variable is @code{nil} by default.
5026
5027
5028 @node Saving Articles
5029 @section Saving Articles
5030 @cindex saving articles
5031
5032 Gnus can save articles in a number of ways.  Below is the documentation
5033 for saving articles in a fairly straight-forward fashion (i.e., little
5034 processing of the article is done before it is saved).  For a different
5035 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5036 (@pxref{Decoding Articles}).
5037
5038 @vindex gnus-save-all-headers
5039 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5040 unwanted headers before saving the article.
5041
5042 @vindex gnus-saved-headers
5043 If the preceding variable is @code{nil}, all headers that match the
5044 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5045 deleted before saving.
5046
5047 @table @kbd
5048
5049 @item O o
5050 @itemx o
5051 @kindex O o (Summary)
5052 @kindex o (Summary)
5053 @findex gnus-summary-save-article
5054 Save the current article using the default article saver
5055 (@code{gnus-summary-save-article}). 
5056
5057 @item O m
5058 @kindex O m (Summary)
5059 @findex gnus-summary-save-article-mail
5060 Save the current article in mail format
5061 (@code{gnus-summary-save-article-mail}). 
5062
5063 @item O r
5064 @kindex O r (Summary)
5065 @findex gnus-summary-save-article-rmail
5066 Save the current article in rmail format
5067 (@code{gnus-summary-save-article-rmail}). 
5068
5069 @item O f
5070 @kindex O f (Summary)
5071 @findex gnus-summary-save-article-file
5072 Save the current article in plain file format
5073 (@code{gnus-summary-save-article-file}). 
5074
5075 @item O F
5076 @kindex O F (Summary)
5077 @findex gnus-summary-write-article-file
5078 Write the current article in plain file format, overwriting any previous
5079 file contents (@code{gnus-summary-write-article-file}). 
5080
5081 @item O b
5082 @kindex O b (Summary)
5083 @findex gnus-summary-save-article-body-file
5084 Save the current article body in plain file format
5085 (@code{gnus-summary-save-article-body-file}). 
5086
5087 @item O h
5088 @kindex O h (Summary)
5089 @findex gnus-summary-save-article-folder
5090 Save the current article in mh folder format
5091 (@code{gnus-summary-save-article-folder}). 
5092
5093 @item O v
5094 @kindex O v (Summary)
5095 @findex gnus-summary-save-article-vm
5096 Save the current article in a VM folder
5097 (@code{gnus-summary-save-article-vm}).
5098
5099 @item O p
5100 @kindex O p (Summary)
5101 @findex gnus-summary-pipe-output
5102 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5103 the current article to a process (@code{gnus-summary-pipe-output}).
5104 @end table
5105
5106 @vindex gnus-prompt-before-saving
5107 All these commands use the process/prefix convention
5108 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5109 functions, you might get tired of being prompted for files to save each
5110 and every article in.  The prompting action is controlled by
5111 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5112 default, giving you that excessive prompting action you know and
5113 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5114 just once for each series of articles you save.  If you like to really
5115 have Gnus do all your thinking for you, you can even set this variable
5116 to @code{nil}, which means that you will never be prompted for files to
5117 save articles in.  Gnus will simply save all the articles in the default
5118 files. 
5119
5120
5121 @vindex gnus-default-article-saver
5122 You can customize the @code{gnus-default-article-saver} variable to make
5123 Gnus do what you want it to.  You can use any of the four ready-made
5124 functions below, or you can create your own.
5125
5126 @table @code
5127
5128 @item gnus-summary-save-in-rmail
5129 @findex gnus-summary-save-in-rmail
5130 @vindex gnus-rmail-save-name
5131 @findex gnus-plain-save-name
5132 This is the default format, @dfn{babyl}.  Uses the function in the
5133 @code{gnus-rmail-save-name} variable to get a file name to save the
5134 article in.  The default is @code{gnus-plain-save-name}.
5135
5136 @item gnus-summary-save-in-mail
5137 @findex gnus-summary-save-in-mail
5138 @vindex gnus-mail-save-name
5139 Save in a Unix mail (mbox) file.  Uses the function in the
5140 @code{gnus-mail-save-name} variable to get a file name to save the
5141 article in.  The default is @code{gnus-plain-save-name}.
5142
5143 @item gnus-summary-save-in-file
5144 @findex gnus-summary-save-in-file
5145 @vindex gnus-file-save-name
5146 @findex gnus-numeric-save-name
5147 Append the article straight to an ordinary file.  Uses the function in
5148 the @code{gnus-file-save-name} variable to get a file name to save the
5149 article in.  The default is @code{gnus-numeric-save-name}.
5150
5151 @item gnus-summary-save-body-in-file
5152 @findex gnus-summary-save-body-in-file
5153 Append the article body to an ordinary file.  Uses the function in the
5154 @code{gnus-file-save-name} variable to get a file name to save the
5155 article in.  The default is @code{gnus-numeric-save-name}.
5156
5157 @item gnus-summary-save-in-folder
5158 @findex gnus-summary-save-in-folder
5159 @findex gnus-folder-save-name
5160 @findex gnus-Folder-save-name
5161 @vindex gnus-folder-save-name
5162 @cindex rcvstore
5163 @cindex MH folders
5164 Save the article to an MH folder using @code{rcvstore} from the MH
5165 library.  Uses the function in the @code{gnus-folder-save-name} variable
5166 to get a file name to save the article in.  The default is
5167 @code{gnus-folder-save-name}, but you can also use
5168 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5169 the latter does not.
5170
5171 @item gnus-summary-save-in-vm
5172 @findex gnus-summary-save-in-vm
5173 Save the article in a VM folder.  You have to have the VM mail
5174 reader to use this setting.
5175 @end table
5176
5177 @vindex gnus-article-save-directory
5178 All of these functions, except for the last one, will save the article
5179 in the @code{gnus-article-save-directory}, which is initialized from the
5180 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5181 default. 
5182
5183 As you can see above, the functions use different functions to find a
5184 suitable name of a file to save the article in.  Below is a list of
5185 available functions that generate names:
5186
5187 @table @code
5188
5189 @item gnus-Numeric-save-name
5190 @findex gnus-Numeric-save-name
5191 File names like @file{~/News/Alt.andrea-dworkin/45}.
5192
5193 @item gnus-numeric-save-name
5194 @findex gnus-numeric-save-name
5195 File names like @file{~/News/alt.andrea-dworkin/45}.
5196
5197 @item gnus-Plain-save-name
5198 @findex gnus-Plain-save-name
5199 File names like @file{~/News/Alt.andrea-dworkin}.
5200
5201 @item gnus-plain-save-name
5202 @findex gnus-plain-save-name
5203 File names like @file{~/News/alt.andrea-dworkin}.
5204 @end table
5205
5206 @vindex gnus-split-methods
5207 You can have Gnus suggest where to save articles by plonking a regexp into
5208 the @code{gnus-split-methods} alist.  For instance, if you would like to
5209 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5210 related to VM in @code{vm-stuff}, you could set this variable to something
5211 like:
5212
5213 @lisp
5214 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5215  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5216  (my-choosing-function "../other-dir/my-stuff")
5217  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5218 @end lisp
5219
5220 We see that this is a list where each element is a list that has two
5221 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5222 a string (in which case it is used as a regexp to match on the article
5223 head); it can be a symbol (which will be called as a function with the
5224 group name as a parameter); or it can be a list (which will be
5225 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5226 the @dfn{file} will be used as a default prompt.  In addition, the
5227 result of the operation itself will be used if the function or form
5228 called returns a string or a list of strings.
5229
5230 You basically end up with a list of file names that might be used when
5231 saving the current article.  (All ``matches'' will be used.)  You will
5232 then be prompted for what you really want to use as a name, with file
5233 name completion over the results from applying this variable.
5234
5235 This variable is @code{((gnus-article-archive-name))} by default, which
5236 means that Gnus will look at the articles it saves for an
5237 @code{Archive-name} line and use that as a suggestion for the file
5238 name. 
5239
5240 Here's an example function to clean up file names somewhat.  If you have
5241 lots of mail groups that are called things like
5242 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5243 these group names before creating the file name to save to.  The
5244 following will do just that:
5245
5246 @lisp
5247 (defun my-save-name (group)
5248   (when (string-match "^nnml:mail." group)
5249     (substring group (match-end 0))))
5250
5251 (setq gnus-split-methods
5252       '((gnus-article-archive-name)
5253         (my-save-name)))
5254 @end lisp
5255
5256
5257 @vindex gnus-use-long-file-name
5258 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5259 @code{nil}, all the preceding functions will replace all periods
5260 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5261 the functions will generate hierarchies of directories instead of having
5262 all the files in the toplevel directory
5263 (@file{~/News/alt/andrea-dworkin} instead of
5264 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5265 on most systems.  However, for historical reasons, this is @code{nil} on
5266 Xenix and usg-unix-v machines by default.
5267
5268 This function also affects kill and score file names.  If this variable
5269 is a list, and the list contains the element @code{not-score}, long file
5270 names will not be used for score files, if it contains the element
5271 @code{not-save}, long file names will not be used for saving, and if it
5272 contains the element @code{not-kill}, long file names will not be used
5273 for kill files.
5274
5275 If you'd like to save articles in a hierarchy that looks something like
5276 a spool, you could
5277
5278 @lisp
5279 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5280 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5281 @end lisp
5282
5283 Then just save with @kbd{o}.  You'd then read this hierarchy with
5284 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5285 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5286 around to the groups/directories with @code{nneething}.
5287
5288
5289 @node Decoding Articles
5290 @section Decoding Articles
5291 @cindex decoding articles
5292
5293 Sometime users post articles (or series of articles) that have been
5294 encoded in some way or other.  Gnus can decode them for you.
5295
5296 @menu 
5297 * Uuencoded Articles::    Uudecode articles.
5298 * Shared Articles::       Unshar articles.
5299 * PostScript Files::      Split PostScript.
5300 * Decoding Variables::    Variables for a happy decoding.
5301 * Viewing Files::         You want to look at the result of the decoding?
5302 @end menu
5303
5304 All these functions use the process/prefix convention
5305 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5306 the extension that a ``single article'' means ``a single series''.  Gnus
5307 can find out by itself what articles belong to a series, decode all the
5308 articles and unpack/view/save the resulting file(s).
5309
5310 Gnus guesses what articles are in the series according to the following
5311 simplish rule: The subjects must be (nearly) identical, except for the
5312 last two numbers of the line.  (Spaces are largely ignored, however.)
5313
5314 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5315 will find all the articles that match the regexp @samp{^cat.gif
5316 ([0-9]+/[0-9]+).*$}.  
5317
5318 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5319 series}, will not be properly recognized by any of the automatic viewing
5320 commands, and you have to mark the articles manually with @kbd{#}.
5321
5322
5323 @node Uuencoded Articles
5324 @subsection Uuencoded Articles
5325 @cindex uudecode
5326 @cindex uuencoded articles
5327
5328 @table @kbd
5329
5330 @item X u
5331 @kindex X u (Summary)
5332 @findex gnus-uu-decode-uu
5333 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5334
5335 @item X U
5336 @kindex X U (Summary)
5337 @findex gnus-uu-decode-uu-and-save
5338 Uudecodes and saves the current series
5339 (@code{gnus-uu-decode-uu-and-save}).
5340
5341 @item X v u
5342 @kindex X v u (Summary)
5343 @findex gnus-uu-decode-uu-view
5344 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5345
5346 @item X v U
5347 @kindex X v U (Summary)
5348 @findex gnus-uu-decode-uu-and-save-view
5349 Uudecodes, views and saves the current series
5350 (@code{gnus-uu-decode-uu-and-save-view}). 
5351 @end table
5352
5353 Remember that these all react to the presence of articles marked with
5354 the process mark.  If, for instance, you'd like to decode and save an
5355 entire newsgroup, you'd typically do @kbd{M P a}
5356 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5357 (@code{gnus-uu-decode-uu-and-save}).
5358
5359 All this is very much different from how @code{gnus-uu} worked with
5360 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5361 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5362 articles in some way (@pxref{Setting Process Marks}) and then press
5363 @kbd{X u}.
5364
5365 @vindex gnus-uu-notify-files
5366 Note: When trying to decode articles that have names matching
5367 @code{gnus-uu-notify-files}, which is hard-coded to
5368 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5369 automatically post an article on @samp{comp.unix.wizards} saying that
5370 you have just viewed the file in question.  This feature can't be turned
5371 off.
5372
5373
5374 @node Shared Articles
5375 @subsection Shared Articles
5376 @cindex unshar
5377 @cindex shared articles
5378
5379 @table @kbd
5380
5381 @item X s
5382 @kindex X s (Summary)
5383 @findex gnus-uu-decode-unshar
5384 Unshars the current series (@code{gnus-uu-decode-unshar}).
5385
5386 @item X S
5387 @kindex X S (Summary)
5388 @findex gnus-uu-decode-unshar-and-save
5389 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5390
5391 @item X v s
5392 @kindex X v s (Summary)
5393 @findex gnus-uu-decode-unshar-view
5394 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5395
5396 @item X v S
5397 @kindex X v S (Summary)
5398 @findex gnus-uu-decode-unshar-and-save-view
5399 Unshars, views and saves the current series
5400 (@code{gnus-uu-decode-unshar-and-save-view}). 
5401 @end table
5402
5403
5404 @node PostScript Files
5405 @subsection PostScript Files
5406 @cindex PostScript
5407
5408 @table @kbd
5409
5410 @item X p
5411 @kindex X p (Summary)
5412 @findex gnus-uu-decode-postscript
5413 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5414
5415 @item X P
5416 @kindex X P (Summary)
5417 @findex gnus-uu-decode-postscript-and-save
5418 Unpack and save the current PostScript series
5419 (@code{gnus-uu-decode-postscript-and-save}).
5420
5421 @item X v p
5422 @kindex X v p (Summary)
5423 @findex gnus-uu-decode-postscript-view
5424 View the current PostScript series
5425 (@code{gnus-uu-decode-postscript-view}).
5426
5427 @item X v P
5428 @kindex X v P (Summary)
5429 @findex gnus-uu-decode-postscript-and-save-view
5430 View and save the current PostScript series
5431 (@code{gnus-uu-decode-postscript-and-save-view}). 
5432 @end table
5433
5434
5435 @node Decoding Variables
5436 @subsection Decoding Variables
5437
5438 Adjective, not verb.
5439
5440 @menu 
5441 * Rule Variables::          Variables that say how a file is to be viewed.
5442 * Other Decode Variables::  Other decode variables.
5443 * Uuencoding and Posting::  Variables for customizing uuencoding.
5444 @end menu
5445
5446
5447 @node Rule Variables
5448 @subsubsection Rule Variables
5449 @cindex rule variables
5450
5451 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5452 variables are on the form
5453   
5454 @lisp
5455       (list '(regexp1 command2)
5456             '(regexp2 command2)
5457             ...)
5458 @end lisp
5459
5460 @table @code
5461
5462 @item gnus-uu-user-view-rules
5463 @vindex gnus-uu-user-view-rules
5464 @cindex sox
5465 This variable is consulted first when viewing files.  If you wish to use,
5466 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5467 say something like:
5468 @lisp
5469 (setq gnus-uu-user-view-rules
5470       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5471 @end lisp
5472
5473 @item gnus-uu-user-view-rules-end
5474 @vindex gnus-uu-user-view-rules-end
5475 This variable is consulted if Gnus couldn't make any matches from the
5476 user and default view rules.
5477
5478 @item gnus-uu-user-archive-rules
5479 @vindex gnus-uu-user-archive-rules
5480 This variable can be used to say what commands should be used to unpack
5481 archives.
5482 @end table
5483
5484
5485 @node Other Decode Variables
5486 @subsubsection Other Decode Variables
5487
5488 @table @code
5489 @vindex gnus-uu-grabbed-file-functions
5490
5491 @item gnus-uu-grabbed-file-functions
5492 All functions in this list will be called right each file has been
5493 successfully decoded---so that you can move or view files right away,
5494 and don't have to wait for all files to be decoded before you can do
5495 anything.  Ready-made functions you can put in this list are:
5496
5497 @table @code
5498
5499 @item gnus-uu-grab-view
5500 @findex gnus-uu-grab-view
5501 View the file.
5502
5503 @item gnus-uu-grab-move
5504 @findex gnus-uu-grab-move
5505 Move the file (if you're using a saving function.)
5506 @end table
5507
5508 @item gnus-uu-be-dangerous
5509 @vindex gnus-uu-be-dangerous
5510 Specifies what to do if unusual situations arise during decoding.  If
5511 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5512 that didn't work, and overwrite existing files.  Otherwise, ask each
5513 time.
5514
5515 @item gnus-uu-ignore-files-by-name
5516 @vindex gnus-uu-ignore-files-by-name
5517 Files with name matching this regular expression won't be viewed.
5518
5519 @item gnus-uu-ignore-files-by-type
5520 @vindex gnus-uu-ignore-files-by-type
5521 Files with a @sc{mime} type matching this variable won't be viewed.
5522 Note that Gnus tries to guess what type the file is based on the name.
5523 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5524 kludgey.
5525
5526 @item gnus-uu-tmp-dir
5527 @vindex gnus-uu-tmp-dir
5528 Where @code{gnus-uu} does its work.
5529
5530 @item gnus-uu-do-not-unpack-archives
5531 @vindex gnus-uu-do-not-unpack-archives
5532 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5533 looking for files to display.
5534
5535 @item gnus-uu-view-and-save
5536 @vindex gnus-uu-view-and-save
5537 Non-@code{nil} means that the user will always be asked to save a file
5538 after viewing it.
5539
5540 @item gnus-uu-ignore-default-view-rules
5541 @vindex gnus-uu-ignore-default-view-rules
5542 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5543 rules.
5544
5545 @item gnus-uu-ignore-default-archive-rules
5546 @vindex gnus-uu-ignore-default-archive-rules
5547 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5548 unpacking commands.
5549
5550 @item gnus-uu-kill-carriage-return
5551 @vindex gnus-uu-kill-carriage-return
5552 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5553 from articles.
5554
5555 @item gnus-uu-unmark-articles-not-decoded
5556 @vindex gnus-uu-unmark-articles-not-decoded
5557 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5558 unsuccessfully decoded as unread.
5559
5560 @item gnus-uu-correct-stripped-uucode
5561 @vindex gnus-uu-correct-stripped-uucode
5562 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5563 uuencoded files that have had trailing spaces deleted.
5564
5565 @item gnus-uu-view-with-metamail
5566 @vindex gnus-uu-view-with-metamail
5567 @cindex metamail
5568 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5569 commands defined by the rule variables and just fudge a @sc{mime}
5570 content type based on the file name.  The result will be fed to
5571 @code{metamail} for viewing.
5572
5573 @item gnus-uu-save-in-digest
5574 @vindex gnus-uu-save-in-digest
5575 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5576 decoding, will save in digests.  If this variable is @code{nil},
5577 @code{gnus-uu} will just save everything in a file without any
5578 embellishments.  The digesting almost conforms to RFC1153---no easy way
5579 to specify any meaningful volume and issue numbers were found, so I
5580 simply dropped them.
5581
5582 @end table
5583
5584
5585 @node Uuencoding and Posting
5586 @subsubsection Uuencoding and Posting
5587
5588 @table @code
5589
5590 @item gnus-uu-post-include-before-composing
5591 @vindex gnus-uu-post-include-before-composing
5592 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5593 before you compose the article.  If this variable is @code{t}, you can
5594 either include an encoded file with @kbd{C-c C-i} or have one included
5595 for you when you post the article.
5596
5597 @item gnus-uu-post-length
5598 @vindex gnus-uu-post-length
5599 Maximum length of an article.  The encoded file will be split into how
5600 many articles it takes to post the entire file.
5601
5602 @item gnus-uu-post-threaded
5603 @vindex gnus-uu-post-threaded
5604 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5605 thread.  This may not be smart, as no other decoder I have seen are able
5606 to follow threads when collecting uuencoded articles.  (Well, I have
5607 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5608 think that counts...) Default is @code{nil}.
5609
5610 @item gnus-uu-post-separate-description
5611 @vindex gnus-uu-post-separate-description
5612 Non-@code{nil} means that the description will be posted in a separate
5613 article.  The first article will typically be numbered (0/x).  If this
5614 variable is @code{nil}, the description the user enters will be included
5615 at the beginning of the first article, which will be numbered (1/x).
5616 Default is @code{t}.
5617
5618 @end table
5619
5620
5621 @node Viewing Files
5622 @subsection Viewing Files
5623 @cindex viewing files
5624 @cindex pseudo-articles
5625
5626 After decoding, if the file is some sort of archive, Gnus will attempt
5627 to unpack the archive and see if any of the files in the archive can be
5628 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5629 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5630 uncompress and de-tar the main file, and then view the two pictures.
5631 This unpacking process is recursive, so if the archive contains archives
5632 of archives, it'll all be unpacked.
5633
5634 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5635 extracted file into the summary buffer.  If you go to these
5636 ``articles'', you will be prompted for a command to run (usually Gnus
5637 will make a suggestion), and then the command will be run.
5638
5639 @vindex gnus-view-pseudo-asynchronously
5640 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5641 until the viewing is done before proceeding.
5642
5643 @vindex gnus-view-pseudos
5644 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5645 the pseudo-articles into the summary buffer, but view them
5646 immediately.  If this variable is @code{not-confirm}, the user won't even
5647 be asked for a confirmation before viewing is done.
5648
5649 @vindex gnus-view-pseudos-separately 
5650 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5651 pseudo-article will be created for each file to be viewed.  If
5652 @code{nil}, all files that use the same viewing command will be given as
5653 a list of parameters to that command.
5654
5655 @vindex gnus-insert-pseudo-articles
5656 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5657 pseudo-articles when decoding.  It is @code{t} by default.
5658
5659 So; there you are, reading your @emph{pseudo-articles} in your
5660 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5661 Why isn't anything real anymore? How did we get here?
5662
5663
5664 @node Article Treatment
5665 @section Article Treatment
5666
5667 Reading through this huge manual, you may have quite forgotten that the
5668 object of newsreaders are to actually, like, read what people have
5669 written.  Reading articles.  Unfortunately, people are quite bad at
5670 writing, so there are tons of functions and variables to make reading
5671 these articles easier.
5672
5673 @menu
5674 * Article Highlighting::    You want to make the article look like fruit salad.
5675 * Article Fontisizing::     Making emphasized text look niced.
5676 * Article Hiding::          You also want to make certain info go away.
5677 * Article Washing::         Lots of way-neat functions to make life better.
5678 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5679 * Article Date::            Grumble, UT!
5680 * Article Signature::       What is a signature?
5681 @end menu
5682
5683
5684 @node Article Highlighting
5685 @subsection Article Highlighting
5686 @cindex highlight
5687
5688 Not only do you want your article buffer to look like fruit salad, but
5689 you want it to look like technicolor fruit salad.
5690
5691 @table @kbd
5692
5693 @item W H a
5694 @kindex W H a (Summary)
5695 @findex gnus-article-highlight
5696 Highlight the current article (@code{gnus-article-highlight}).
5697
5698 @item W H h
5699 @kindex W H h (Summary)
5700 @findex gnus-article-highlight-headers
5701 @vindex gnus-header-face-alist
5702 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5703 highlighting will be done according to the @code{gnus-header-face-alist}
5704 variable, which is a list where each element has the form @var{(regexp
5705 name content)}.  @var{regexp} is a regular expression for matching the
5706 header, @var{name} is the face used for highlighting the header name and
5707 @var{content} is the face for highlighting the header value.  The first
5708 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5709 prepended---Gnus will add one.
5710
5711 @item W H c
5712 @kindex W H c (Summary)
5713 @findex gnus-article-highlight-citation
5714 Highlight cited text (@code{gnus-article-highlight-citation}). 
5715
5716 Some variables to customize the citation highlights:
5717
5718 @table @code
5719 @vindex gnus-cite-parse-max-size
5720
5721 @item gnus-cite-parse-max-size
5722 If the article size if bigger than this variable (which is 25000 by
5723 default), no citation highlighting will be performed.  
5724
5725 @item gnus-cite-prefix-regexp
5726 @vindex gnus-cite-prefix-regexp
5727 Regexp matching the longest possible citation prefix on a line. 
5728
5729 @item gnus-cite-max-prefix
5730 @vindex gnus-cite-max-prefix
5731 Maximum possible length for a citation prefix (default 20).
5732
5733 @item gnus-cite-face-list
5734 @vindex gnus-cite-face-list
5735 List of faces used for highlighting citations.  When there are citations
5736 from multiple articles in the same message, Gnus will try to give each
5737 citation from each article its own face.  This should make it easier to
5738 see who wrote what.
5739
5740 @item gnus-supercite-regexp
5741 @vindex gnus-supercite-regexp
5742 Regexp matching normal Supercite attribution lines.  
5743
5744 @item gnus-supercite-secondary-regexp
5745 @vindex gnus-supercite-secondary-regexp
5746 Regexp matching mangled Supercite attribution lines.
5747
5748 @item gnus-cite-minimum-match-count
5749 @vindex gnus-cite-minimum-match-count
5750 Minimum number of identical prefixes we have to see before we believe
5751 that it's a citation.
5752
5753 @item gnus-cite-attribution-prefix
5754 @vindex gnus-cite-attribution-prefix
5755 Regexp matching the beginning of an attribution line.
5756
5757 @item gnus-cite-attribution-suffix
5758 @vindex gnus-cite-attribution-suffix
5759 Regexp matching the end of an attribution line.
5760
5761 @item gnus-cite-attribution-face
5762 @vindex gnus-cite-attribution-face
5763 Face used for attribution lines.  It is merged with the face for the
5764 cited text belonging to the attribution.
5765
5766 @end table
5767
5768
5769 @item W H s
5770 @kindex W H s (Summary)
5771 @vindex gnus-signature-separator
5772 @vindex gnus-signature-face
5773 @findex gnus-article-highlight-signature
5774 Highlight the signature (@code{gnus-article-highlight-signature}).
5775 Everything after @code{gnus-signature-separator} (@pxref{Article
5776 Signature}) in an article will be considered a signature and will be
5777 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5778 default.
5779
5780 @end table
5781
5782
5783 @node Article Fontisizing
5784 @subsection Article Fontisizing
5785 @cindex emphasis
5786 @cindex article emphasis
5787
5788 @findex gnus-article-emphasize
5789 @kindex W e (Summary)
5790 People commonly add emphasis to words in news articles by writing things
5791 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5792 running the article through the @kbd{W e}
5793 (@code{gnus-article-emphasize}) command.
5794
5795 @vindex gnus-article-emphasis
5796 How the emphasis is computed is controlled by the
5797 @code{gnus-article-emphasis} variable.  This is an alist where the first
5798 element is a regular expression to be matched.  The second is a number
5799 that says what regular expression grouping used to find the entire
5800 emphasized word.  The third is a number that says what regexp grouping
5801 should be displayed and highlighted.  (The text between these two
5802 groupings will be hidden.)  The fourth is the face used for
5803 highlighting.
5804
5805 @lisp
5806 (setq gnus-article-emphasis
5807       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5808         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5809 @end lisp
5810
5811 @vindex gnus-emphasis-underline
5812 @vindex gnus-emphasis-bold
5813 @vindex gnus-emphasis-italic
5814 @vindex gnus-emphasis-underline-bold
5815 @vindex gnus-emphasis-underline-italic
5816 @vindex gnus-emphasis-bold-italic
5817 @vindex gnus-emphasis-underline-bold-italic
5818 By default, there are seven rules, and they use the following faces:
5819 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5820 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5821 @code{gnus-emphasis-underline-italic},
5822 @code{gnus-emphasis-undeline-bold}, and
5823 @code{gnus-emphasis-underline-bold-italic}.  
5824
5825 If you want to change these faces, you can either use @kbd{M-x
5826 customize}, or you can use @code{copy-face}.  For instance, if you want
5827 to make @code{gnus-emphasis-italic} use a red face instead, you could
5828 say something like:
5829
5830 @lisp
5831 (copy-face 'red 'gnus-emphasis-italic)
5832 @end lisp
5833
5834
5835 @node Article Hiding
5836 @subsection Article Hiding
5837 @cindex article hiding
5838
5839 Or rather, hiding certain things in each article.  There usually is much
5840 too much cruft in most articles.  
5841
5842 @table @kbd
5843
5844 @item W W a
5845 @kindex W W a (Summary)
5846 @findex gnus-article-hide
5847 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5848
5849 @item W W h
5850 @kindex W W h (Summary)
5851 @findex gnus-article-hide-headers
5852 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5853 Headers}. 
5854
5855 @item W W b
5856 @kindex W W b (Summary)
5857 @findex gnus-article-hide-boring-headers
5858 Hide headers that aren't particularly interesting
5859 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5860
5861 @item W W s
5862 @kindex W W s (Summary)
5863 @findex gnus-article-hide-signature
5864 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5865 Signature}. 
5866
5867 @item W W p
5868 @kindex W W p (Summary)
5869 @findex gnus-article-hide-pgp
5870 @vindex gnus-article-hide-pgp-hook
5871 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
5872 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
5873 signature has been hidden.
5874
5875 @item W W P
5876 @kindex W W P (Summary)
5877 @findex gnus-article-hide-pem
5878 Hide @sc{pem} (privacy enhanced messages) gruft
5879 (@code{gnus-article-hide-pem}).
5880
5881 @item W W c
5882 @kindex W W c (Summary)
5883 @findex gnus-article-hide-citation
5884 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5885 customizing the hiding:
5886
5887 @table @code
5888
5889 @item gnus-cite-hide-percentage
5890 @vindex gnus-cite-hide-percentage
5891 If the cited text is of a bigger percentage than this variable (default
5892 50), hide the cited text.
5893
5894 @item gnus-cite-hide-absolute
5895 @vindex gnus-cite-hide-absolute
5896 The cited text must be have at least this length (default 10) before it
5897 is hidden.
5898
5899 @item gnus-cited-text-button-line-format
5900 @vindex gnus-cited-text-button-line-format
5901 Gnus adds buttons show where the cited text has been hidden, and to
5902 allow toggle hiding the text.  The format of the variable is specified
5903 by this format-like variable (@pxref{Formatting Variables}).  These
5904 specs are legal:
5905
5906 @table @samp
5907 @item b
5908 Start point of the hidden text.
5909 @item e
5910 End point of the hidden text.
5911 @item l
5912 Length of the hidden text.
5913 @end table
5914
5915 @item gnus-cited-lines-visible
5916 @vindex gnus-cited-lines-visible
5917 The number of lines at the beginning of the cited text to leave shown. 
5918
5919 @end table
5920
5921 @item W W C
5922 @kindex W W C (Summary)
5923 @findex gnus-article-hide-citation-in-followups
5924 Hide cited text in articles that aren't roots
5925 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5926 useful as an interactive command, but might be a handy function to stick
5927 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5928
5929 @end table
5930
5931 All these ``hiding'' commands are toggles, but if you give a negative
5932 prefix to these commands, they will show what they have previously
5933 hidden.  If you give a positive prefix, they will always hide.
5934
5935 Also @pxref{Article Highlighting} for further variables for
5936 citation customization.
5937
5938
5939 @node Article Washing
5940 @subsection Article Washing
5941 @cindex washing
5942 @cindex article washing
5943
5944 We call this ``article washing'' for a really good reason.  Namely, the
5945 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5946
5947 @dfn{Washing} is defined by us as ``changing something from something to
5948 something else'', but normally results in something looking better.
5949 Cleaner, perhaps.
5950
5951 @table @kbd
5952
5953 @item W l
5954 @kindex W l (Summary)
5955 @findex gnus-summary-stop-page-breaking
5956 Remove page breaks from the current article
5957 (@code{gnus-summary-stop-page-breaking}).
5958
5959 @item W r
5960 @kindex W r (Summary)
5961 @findex gnus-summary-caesar-message
5962 Do a Caesar rotate (rot13) on the article buffer
5963 (@code{gnus-summary-caesar-message}). 
5964
5965 @item W t
5966 @kindex W t (Summary)
5967 @findex gnus-summary-toggle-header
5968 Toggle whether to display all headers in the article buffer
5969 (@code{gnus-summary-toggle-header}). 
5970
5971 @item W v
5972 @kindex W v (Summary)
5973 @findex gnus-summary-verbose-header
5974 Toggle whether to display all headers in the article buffer permanently
5975 (@code{gnus-summary-verbose-header}).
5976
5977 @item W m
5978 @kindex W m (Summary)
5979 @findex gnus-summary-toggle-mime
5980 Toggle whether to run the article through @sc{mime} before displaying
5981 (@code{gnus-summary-toggle-mime}).
5982
5983 @item W o
5984 @kindex W o (Summary)
5985 @findex gnus-article-treat-overstrike
5986 Treat overstrike (@code{gnus-article-treat-overstrike}).
5987
5988 @item W w
5989 @kindex W w (Summary)
5990 @findex gnus-article-fill-cited-article
5991 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5992 function in @code{gnus-article-display-hook}, it should be run fairly
5993 late and certainly after any highlighting.
5994
5995 You can give the command a numerical prefix to specify the width to use
5996 when filling.
5997
5998 @item W c
5999 @kindex W c (Summary)
6000 @findex gnus-article-remove-cr
6001 Remove CR (@code{gnus-article-remove-cr}).
6002
6003 @item W q
6004 @kindex W q (Summary)
6005 @findex gnus-article-de-quoted-unreadable
6006 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6007
6008 @item W f
6009 @kindex W f (Summary)
6010 @cindex x-face
6011 @findex gnus-article-display-x-face
6012 @findex gnus-article-x-face-command
6013 @vindex gnus-article-x-face-command
6014 @vindex gnus-article-x-face-too-ugly
6015 Look for and display any X-Face headers
6016 (@code{gnus-article-display-x-face}).  The command executed by this
6017 function is given by the @code{gnus-article-x-face-command} variable.
6018 If this variable is a string, this string will be executed in a
6019 sub-shell.  If it is a function, this function will be called with the
6020 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6021 is a regexp) matches the @code{From} header, the face will not be shown.
6022 The default action under Emacs is to fork off an @code{xv} to view the
6023 face; under XEmacs the default action is to display the face before the
6024 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6025 support---that will make display somewhat faster.  If there's no native
6026 X-Face support, Gnus will try to convert the @code{X-Face} header using
6027 external programs from the @code{pbmplus} package and friends.)  If you
6028 want to have this function in the display hook, it should probably come
6029 last.
6030
6031 @item W b
6032 @kindex W b (Summary)
6033 @findex gnus-article-add-buttons
6034 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
6035
6036 @item W B
6037 @kindex W B (Summary)
6038 @findex gnus-article-add-buttons-to-head
6039 Add clickable buttons to the article headers
6040 (@code{gnus-article-add-buttons-to-head}).  
6041
6042 @item W E l
6043 @kindex W E l (Summary)
6044 @findex gnus-article-strip-leading-blank-lines
6045 Remove all blank lines from the beginning of the article
6046 (@code{gnus-article-strip-leading-blank-lines}).
6047
6048 @item W E m
6049 @kindex W E m (Summary)
6050 @findex gnus-article-strip-multiple-blank-lines
6051 Replace all blank lines with empty lines and then all multiple empty
6052 lines with a single empty line.
6053 (@code{gnus-article-strip-multiple-blank-lines}).
6054
6055 @item W E t
6056 @kindex W E t (Summary)
6057 @findex gnus-article-remove-trailing-blank-lines
6058 Remove all blank lines at the end of the article
6059 (@code{gnus-article-remove-trailing-blank-lines}).
6060
6061 @item W E a
6062 @kindex W E a (Summary)
6063 @findex gnus-article-strip-blank-lines
6064 Do all the three commands above
6065 (@code{gnus-article-strip-blank-lines}).
6066
6067 @item W E s
6068 @kindex W E s (Summary)
6069 @findex gnus-article-strip-leading-space
6070 Remove all white space from the beginning of all lines of the article
6071 body (@code{gnus-article-strip-leading-space}).
6072
6073 @end table
6074
6075
6076 @node Article Buttons
6077 @subsection Article Buttons
6078 @cindex buttons
6079
6080 People often include references to other stuff in articles, and it would
6081 be nice if Gnus could just fetch whatever it is that people talk about
6082 with the minimum of fuzz.
6083
6084 Gnus adds @dfn{buttons} to certain standard references by default:
6085 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6086 two variables, one that handles article bodies and one that handles
6087 article heads:
6088
6089 @table @code
6090
6091 @item gnus-button-alist
6092 @vindex gnus-button-alist
6093 This is an alist where each entry has this form:
6094
6095 @lisp
6096 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6097 @end lisp
6098
6099 @table @var
6100
6101 @item regexp
6102 All text that match this regular expression will be considered an
6103 external reference.  Here's a typical regexp that match embedded URLs:
6104 @samp{<URL:\\([^\n\r>]*\\)>}. 
6105
6106 @item button-par
6107 Gnus has to know which parts of the match is to be highlighted.  This is
6108 a number that says what sub-expression of the regexp that is to be
6109 highlighted.  If you want it all highlighted, you use 0 here.
6110
6111 @item use-p
6112 This form will be @code{eval}ed, and if the result is non-@code{nil},
6113 this is considered a match.  This is useful if you want extra sifting to
6114 avoid false matches.
6115
6116 @item function
6117 This function will be called when you click on this button.
6118
6119 @item data-par
6120 As with @var{button-par}, this is a sub-expression number, but this one
6121 says which part of the match is to be sent as data to @var{function}. 
6122
6123 @end table
6124
6125 So the full entry for buttonizing URLs is then
6126
6127 @lisp
6128 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6129 @end lisp
6130
6131 @item gnus-header-button-alist
6132 @vindex gnus-header-button-alist
6133 This is just like the other alist, except that it is applied to the
6134 article head only, and that each entry has an additional element that is
6135 used to say what headers to apply the buttonize coding to:
6136
6137 @lisp
6138 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6139 @end lisp
6140
6141 @var{header} is a regular expression.
6142
6143 @item gnus-button-url-regexp
6144 @vindex gnus-button-url-regexp
6145 A regular expression that matches embedded URLs.  It is used in the
6146 default values of the variables above.
6147
6148 @item gnus-article-button-face
6149 @vindex gnus-article-button-face
6150 Face used on buttons.
6151
6152 @item gnus-article-mouse-face
6153 @vindex gnus-article-mouse-face
6154 Face is used when the mouse cursor is over a button.
6155
6156 @end table
6157
6158
6159 @node Article Date
6160 @subsection Article Date
6161
6162 The date is most likely generated in some obscure timezone you've never
6163 heard of, so it's quite nice to be able to find out what the time was
6164 when the article was sent.
6165
6166 @table @kbd
6167
6168 @item W T u
6169 @kindex W T u (Summary)
6170 @findex gnus-article-date-ut
6171 Display the date in UT (aka. GMT, aka ZULU)
6172 (@code{gnus-article-date-ut}). 
6173
6174 @item W T l
6175 @kindex W T l (Summary)
6176 @findex gnus-article-date-local
6177 Display the date in the local timezone (@code{gnus-article-date-local}).
6178
6179 @item W T s
6180 @kindex W T s (Summary)
6181 @vindex gnus-article-time-format
6182 @findex gnus-article-date-user
6183 @findex format-time-string
6184 Display the date using a user-defined format
6185 (@code{gnus-article-date-user}).  The format is specified by the
6186 @code{gnus-article-time-format} variable, and is a string that's passed
6187 to @code{format-time-string}.  See the documentation of that variable
6188 for a list possible format specs.
6189
6190 @item W T e
6191 @kindex W T e (Summary)
6192 @findex gnus-article-date-lapsed
6193 Say how much time has (e)lapsed between the article was posted and now
6194 (@code{gnus-article-date-lapsed}).
6195
6196 @item W T o
6197 @kindex W T o (Summary)
6198 @findex gnus-article-date-original
6199 Display the original date (@code{gnus-article-date-original}).  This can
6200 be useful if you normally use some other conversion function and is
6201 worried that it might be doing something totally wrong.  Say, claiming
6202 that the article was posted in 1854.  Although something like that is
6203 @emph{totally} impossible.  Don't you trust me? *titter*
6204
6205 @end table
6206
6207
6208 @node Article Signature
6209 @subsection Article Signature
6210 @cindex signatures
6211 @cindex article signature
6212
6213 @vindex gnus-signature-separator
6214 Each article is divided into two parts---the head and the body.  The
6215 body can be divided into a signature part and a text part.  The variable
6216 that says what is to be considered a signature is
6217 @code{gnus-signature-separator}.  This is normally the standard
6218 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6219 non-standard signature separators, so this variable can also be a list
6220 of regular expressions to be tested, one by one.  (Searches are done
6221 from the end of the body towards the beginning.)  One likely value is:
6222
6223 @lisp
6224 (setq gnus-signature-separator
6225       '("^-- $"         ; The standard
6226         "^-- *$"        ; A common mangling
6227         "^-------*$"    ; Many people just use a looong 
6228                         ; line of dashes.  Shame!
6229         "^ *--------*$" ; Double-shame!
6230         "^________*$"   ; Underscores are also popular
6231         "^========*$")) ; Pervert!
6232 @end lisp
6233
6234 The more permissive you are, the more likely it is that you'll get false
6235 positives.
6236
6237 @vindex gnus-signature-limit
6238 @code{gnus-signature-limit} provides a limit to what is considered a
6239 signature. 
6240
6241 @enumerate
6242 @item 
6243 If it is an integer, no signature may be longer (in characters) than
6244 that integer.
6245 @item 
6246 If it is a floating point number, no signature may be longer (in lines)
6247 than that number.
6248 @item 
6249 If it is a function, the function will be called without any parameters,
6250 and if it returns @code{nil}, there is no signature in the buffer.
6251 @item
6252 If it is a string, it will be used as a regexp.  If it matches, the text
6253 in question is not a signature.
6254 @end enumerate
6255
6256 This variable can also be a list where the elements may be of the types
6257 listed above.  
6258
6259
6260 @node Article Commands
6261 @section Article Commands
6262
6263 @table @kbd
6264
6265 @item A P
6266 @cindex PostScript
6267 @cindex printing
6268 @kindex A P (Summary)
6269 @vindex gnus-ps-print-hook
6270 @findex gnus-summary-print-article 
6271 Generate and print a PostScript image of the article buffer
6272 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6273 run just before printing the buffer.
6274
6275 @end table
6276
6277
6278 @node Summary Sorting
6279 @section Summary Sorting
6280 @cindex summary sorting
6281
6282 You can have the summary buffer sorted in various ways, even though I
6283 can't really see why you'd want that.
6284
6285 @table @kbd
6286
6287 @item C-c C-s C-n
6288 @kindex C-c C-s C-n (Summary)
6289 @findex gnus-summary-sort-by-number
6290 Sort by article number (@code{gnus-summary-sort-by-number}).
6291
6292 @item C-c C-s C-a
6293 @kindex C-c C-s C-a (Summary)
6294 @findex gnus-summary-sort-by-author
6295 Sort by author (@code{gnus-summary-sort-by-author}).
6296
6297 @item C-c C-s C-s
6298 @kindex C-c C-s C-s (Summary)
6299 @findex gnus-summary-sort-by-subject
6300 Sort by subject (@code{gnus-summary-sort-by-subject}).
6301
6302 @item C-c C-s C-d
6303 @kindex C-c C-s C-d (Summary)
6304 @findex gnus-summary-sort-by-date
6305 Sort by date (@code{gnus-summary-sort-by-date}).
6306
6307 @item C-c C-s C-l
6308 @kindex C-c C-s C-l (Summary)
6309 @findex gnus-summary-sort-by-lines
6310 Sort by lines (@code{gnus-summary-sort-by-lines}).
6311
6312 @item C-c C-s C-i
6313 @kindex C-c C-s C-i (Summary)
6314 @findex gnus-summary-sort-by-score
6315 Sort by score (@code{gnus-summary-sort-by-score}).
6316 @end table
6317
6318 These functions will work both when you use threading and when you don't
6319 use threading.  In the latter case, all summary lines will be sorted,
6320 line by line.  In the former case, sorting will be done on a
6321 root-by-root basis, which might not be what you were looking for.  To
6322 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6323 Commands}).
6324
6325
6326 @node Finding the Parent
6327 @section Finding the Parent
6328 @cindex parent articles
6329 @cindex referring articles
6330
6331 @findex gnus-summary-refer-parent-article
6332 @kindex ^ (Summary)
6333 If you'd like to read the parent of the current article, and it is not
6334 displayed in the summary buffer, you might still be able to.  That is,
6335 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6336 and the @code{References} in the current article are not mangled, you
6337 can just press @kbd{^} or @kbd{A r}
6338 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6339 you'll get the parent.  If the parent is already displayed in the
6340 summary buffer, point will just move to this article.
6341
6342 If given a positive numerical prefix, fetch that many articles back into
6343 the ancestry.  If given a negative numerical prefix, fetch just that
6344 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6345 grandparent and the grandgrandparent of the current article.  If you say
6346 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6347 article. 
6348
6349 @findex gnus-summary-refer-references
6350 @kindex A R (Summary)
6351 You can have Gnus fetch all articles mentioned in the @code{References}
6352 header of the article by pushing @kbd{A R}
6353 (@code{gnus-summary-refer-references}). 
6354
6355 @findex gnus-summary-refer-article
6356 @kindex M-^ (Summary)
6357 @cindex Message-ID
6358 @cindex fetching by Message-ID
6359 You can also ask the @sc{nntp} server for an arbitrary article, no
6360 matter what group it belongs to.  @kbd{M-^}
6361 (@code{gnus-summary-refer-article}) will ask you for a
6362 @code{Message-ID}, which is one of those long, hard-to-read thingies
6363 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6364 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6365
6366 The current select method will be used when fetching by
6367 @code{Message-ID} from non-news select method, but you can override this
6368 by giving this command a prefix.
6369
6370 @vindex gnus-refer-article-method
6371 If the group you are reading is located on a backend that does not
6372 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6373 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6374 would, perhaps, be best if the @sc{nntp} server you consult is the same
6375 as the one that keeps the spool you are reading from updated, but that's
6376 not really necessary.
6377
6378 Most of the mail backends support fetching by @code{Message-ID}, but do
6379 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6380 @code{nnbabyl} are able to locate articles from any groups, while
6381 @code{nnml} and @code{nnfolder} are only able to locate articles that
6382 have been posted to the current group.  (Anything else would be too time
6383 consuming.)  @code{nnmh} does not support this at all.
6384
6385
6386 @node Alternative Approaches
6387 @section Alternative Approaches
6388
6389 Different people like to read news using different methods.  This being
6390 Gnus, we offer a small selection of minor modes for the summary buffers.
6391
6392 @menu
6393 * Pick and Read::               First mark articles and then read them.
6394 * Binary Groups::               Auto-decode all articles.
6395 @end menu
6396
6397
6398 @node Pick and Read
6399 @subsection Pick and Read
6400 @cindex pick and read
6401
6402 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6403 a two-phased reading interface.  The user first marks the articles she
6404 wants to read from a summary buffer.  Then she starts reading the
6405 articles with just an article buffer displayed.
6406
6407 @findex gnus-pick-mode
6408 @kindex M-x gnus-pick-mode
6409 Gnus provides a summary buffer minor mode that allows
6410 this---@code{gnus-pick-mode}.  This basically means that a few process
6411 mark commands become one-keystroke commands to allow easy marking, and
6412 it makes one additional command for switching to the summary buffer
6413 available. 
6414
6415 Here are the available keystrokes when using pick mode:
6416
6417 @table @kbd
6418 @item .
6419 @kindex . (Pick)
6420 @findex gnus-summary-mark-as-processable
6421 Pick the article on the current line
6422 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6423 go to the article on that line and pick that article.  (The line number
6424 is normally displayed on the beginning of the summary pick lines.)
6425
6426 @item SPACE
6427 @kindex SPACE (Pick)
6428 @findex gnus-pick-next-page
6429 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6430 at the end of the buffer, start reading the picked articles.
6431
6432 @item u
6433 @kindex u (Pick)
6434 @findex gnus-summary-unmark-as-processable
6435 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6436
6437 @item U
6438 @kindex U (Pick)
6439 @findex gnus-summary-unmark-all-processable
6440 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6441
6442 @item t
6443 @kindex t (Pick)
6444 @findex gnus-uu-mark-thread
6445 Pick the thread (@code{gnus-uu-mark-thread}). 
6446
6447 @item T
6448 @kindex T (Pick)
6449 @findex gnus-uu-unmark-thread
6450 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6451
6452 @item r
6453 @kindex r (Pick)
6454 @findex gnus-uu-mark-region
6455 Pick the region (@code{gnus-uu-mark-region}). 
6456
6457 @item R
6458 @kindex R (Pick)
6459 @findex gnus-uu-unmark-region
6460 Unpick the region (@code{gnus-uu-unmark-region}). 
6461
6462 @item e
6463 @kindex e (Pick)
6464 @findex gnus-uu-mark-by-regexp
6465 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6466
6467 @item E
6468 @kindex E (Pick)
6469 @findex gnus-uu-unmark-by-regexp
6470 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6471
6472 @item b
6473 @kindex b (Pick)
6474 @findex gnus-uu-mark-buffer
6475 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6476
6477 @item B
6478 @kindex B (Pick)
6479 @findex gnus-uu-unmark-buffer
6480 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6481
6482 @item RET
6483 @kindex RET (Pick)
6484 @findex gnus-pick-start-reading
6485 @vindex gnus-pick-display-summary
6486 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6487 given a prefix, mark all unpicked articles as read first.  If
6488 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6489 will still be visible when you are reading.
6490
6491 @end table
6492
6493 If this sounds like a good idea to you, you could say:
6494
6495 @lisp
6496 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6497 @end lisp
6498
6499 @vindex gnus-pick-mode-hook
6500 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6501
6502 @vindex gnus-mark-unpicked-articles-as-read
6503 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6504 all unpicked articles as read.  The default is @code{nil}.
6505
6506 @vindex gnus-summary-pick-line-format
6507 The summary line format in pick mode is slightly different than the
6508 standard format.  At the beginning of each line the line number is
6509 displayed.  The pick mode line format is controlled by the
6510 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6511 Variables}).  It accepts the same format specs that
6512 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6513
6514
6515 @node Binary Groups
6516 @subsection Binary Groups
6517 @cindex binary groups
6518
6519 @findex gnus-binary-mode
6520 @kindex M-x gnus-binary-mode
6521 If you spend much time in binary groups, you may grow tired of hitting
6522 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6523 is a minor mode for summary buffers that makes all ordinary Gnus article
6524 selection functions uudecode series of articles and display the result
6525 instead of just displaying the articles the normal way.  
6526
6527 @kindex g (Binary)
6528 @findex gnus-binary-show-article
6529 In fact, the only way to see the actual articles if you have turned this
6530 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6531
6532 @vindex gnus-binary-mode-hook
6533 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6534
6535
6536 @node Tree Display
6537 @section Tree Display
6538 @cindex trees
6539
6540 @vindex gnus-use-trees
6541 If you don't like the normal Gnus summary display, you might try setting
6542 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6543 additional @dfn{tree buffer}.  You can execute all summary mode commands
6544 in the tree buffer.  
6545
6546 There are a few variables to customize the tree display, of course:
6547
6548 @table @code
6549 @item gnus-tree-mode-hook
6550 @vindex gnus-tree-mode-hook
6551 A hook called in all tree mode buffers.
6552
6553 @item gnus-tree-mode-line-format
6554 @vindex gnus-tree-mode-line-format
6555 A format string for the mode bar in the tree mode buffers.  The default
6556 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6557 Buffer Mode Line}. 
6558
6559 @item gnus-selected-tree-face
6560 @vindex gnus-selected-tree-face
6561 Face used for highlighting the selected article in the tree buffer.  The
6562 default is @code{modeline}.
6563
6564 @item gnus-tree-line-format
6565 @vindex gnus-tree-line-format
6566 A format string for the tree nodes.  The name is a bit of a misnomer,
6567 though---it doesn't define a line, but just the node.  The default value
6568 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6569 the name of the poster.  It is vital that all nodes are of the same
6570 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6571
6572 Legal specs are:
6573
6574 @table @samp
6575 @item n
6576 The name of the poster.
6577 @item f
6578 The @code{From} header.
6579 @item N
6580 The number of the article.
6581 @item [
6582 The opening bracket.
6583 @item ] 
6584 The closing bracket.
6585 @item s
6586 The subject.
6587 @end table
6588
6589 @xref{Formatting Variables}.
6590
6591 Variables related to the display are:
6592
6593 @table @code
6594 @item gnus-tree-brackets
6595 @vindex gnus-tree-brackets
6596 This is used for differentiating between ``real'' articles and
6597 ``sparse'' articles.  The format is @var{((real-open . real-close)
6598 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6599 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6600
6601 @item gnus-tree-parent-child-edges
6602 @vindex gnus-tree-parent-child-edges
6603 This is a list that contains the characters used for connecting parent
6604 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6605
6606 @end table
6607
6608 @item gnus-tree-minimize-window
6609 @vindex gnus-tree-minimize-window
6610 If this variable is non-@code{nil}, Gnus will try to keep the tree
6611 buffer as small as possible to allow more room for the other Gnus
6612 windows.  If this variable is a number, the tree buffer will never be
6613 higher than that number.  The default is @code{t}.  Note that if you
6614 have several windows displayed side-by-side in a frame and the tree
6615 buffer is one of these, minimizing the tree window will also resize all
6616 other windows that are displayed next to it.
6617
6618 @item gnus-generate-tree-function
6619 @vindex gnus-generate-tree-function
6620 @findex gnus-generate-horizontal-tree
6621 @findex gnus-generate-vertical-tree
6622 The function that actually generates the thread tree.  Two predefined
6623 functions are available: @code{gnus-generate-horizontal-tree} and
6624 @code{gnus-generate-vertical-tree} (which is the default).
6625
6626 @end table
6627
6628 Here's and example from a horizontal tree buffer:
6629
6630 @example
6631 @{***@}-(***)-[odd]-[Gun]
6632      |      \[Jan]
6633      |      \[odd]-[Eri]
6634      |      \(***)-[Eri]
6635      |            \[odd]-[Paa]
6636      \[Bjo]
6637      \[Gun]
6638      \[Gun]-[Jor]
6639 @end example
6640
6641 Here's the same thread displayed in a vertical tree buffer:
6642
6643 @example
6644 @{***@}
6645   |--------------------------\-----\-----\
6646 (***)                         [Bjo] [Gun] [Gun]
6647   |--\-----\-----\                          |
6648 [odd] [Jan] [odd] (***)                   [Jor]
6649   |           |     |--\
6650 [Gun]       [Eri] [Eri] [odd]
6651                           |
6652                         [Paa]
6653 @end example
6654
6655
6656 @node Mail Group Commands
6657 @section Mail Group Commands
6658 @cindex mail group commands
6659
6660 Some commands only make sense in mail groups.  If these commands are
6661 illegal in the current group, they will raise a hell and let you know.
6662
6663 All these commands (except the expiry and edit commands) use the
6664 process/prefix convention (@pxref{Process/Prefix}).
6665
6666 @table @kbd
6667
6668 @item B e
6669 @kindex B e (Summary)
6670 @findex gnus-summary-expire-articles
6671 Expire all expirable articles in the group
6672 (@code{gnus-summary-expire-articles}).
6673
6674 @item B M-C-e
6675 @kindex B M-C-e (Summary)
6676 @findex gnus-summary-expire-articles-now
6677 Delete all the expirable articles in the group
6678 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6679 articles that are eligible for expiry in the current group will
6680 disappear forever into that big @file{/dev/null} in the sky.
6681
6682 @item B DEL
6683 @kindex B DEL (Summary)
6684 @findex gnus-summary-delete-article
6685 Delete the mail article.  This is ``delete'' as in ``delete it from your
6686 disk forever and ever, never to return again.'' Use with caution.
6687 (@code{gnus-summary-delete-article}).
6688
6689 @item B m
6690 @kindex B m (Summary)
6691 @cindex move mail
6692 @findex gnus-summary-move-article
6693 Move the article from one mail group to another
6694 (@code{gnus-summary-move-article}). 
6695
6696 @item B c
6697 @kindex B c (Summary)
6698 @cindex copy mail
6699 @findex gnus-summary-copy-article
6700 Copy the article from one group (mail group or not) to a mail group
6701 (@code{gnus-summary-copy-article}).
6702
6703 @item B C
6704 @kindex B C (Summary)
6705 @cindex crosspost mail
6706 @findex gnus-summary-crosspost-article
6707 Crosspost the current article to some other group
6708 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6709 the article in the other group, and the Xref headers of the article will
6710 be properly updated.
6711
6712 @item B i
6713 @kindex B i (Summary)
6714 @findex gnus-summary-import-article
6715 Import an arbitrary file into the current mail newsgroup
6716 (@code{gnus-summary-import-article}).  You will be prompted for a file
6717 name, a @code{From} header and a @code{Subject} header.
6718
6719 @item B r
6720 @kindex B r (Summary)
6721 @findex gnus-summary-respool-article
6722 Respool the mail article (@code{gnus-summary-move-article}).
6723 @code{gnus-summary-respool-default-method} will be used as the default
6724 select method when respooling.  This variable is @code{nil} by default,
6725 which means that the current group select method will be used instead.
6726
6727 @item B w
6728 @itemx e
6729 @kindex B w (Summary)
6730 @kindex e (Summary)
6731 @findex gnus-summary-edit-article
6732 @kindex C-c C-c (Article)
6733 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6734 editing and make the changes permanent, type @kbd{C-c C-c}
6735 (@kbd{gnus-summary-edit-article-done}).
6736
6737 @item B q
6738 @kindex B q (Summary)
6739 @findex gnus-summary-respool-query
6740 If you want to re-spool an article, you might be curious as to what group
6741 the article will end up in before you do the re-spooling.  This command
6742 will tell you (@code{gnus-summary-respool-query}). 
6743
6744 @item B p
6745 @kindex B p (Summary)
6746 @findex gnus-summary-article-posted-p
6747 Some people have a tendency to send you "courtesy" copies when they
6748 follow up to articles you have posted.  These usually have a
6749 @code{Newsgroups} header in them, but not always.  This command
6750 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6751 article from your news server (or rather, from
6752 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6753 report back whether it found the article or not.  Even if it says that
6754 it didn't find the article, it may have been posted anyway---mail
6755 propagation is much faster than news propagation, and the news copy may
6756 just not have arrived yet.
6757
6758 @end table
6759
6760 @vindex gnus-move-split-methods
6761 @cindex moving articles
6762 If you move (or copy) articles regularly, you might wish to have Gnus
6763 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6764 variable that uses the same syntax as @code{gnus-split-methods}
6765 (@pxref{Saving Articles}).  You may customize that variable to create
6766 suggestions you find reasonable.
6767
6768 @lisp
6769 (setq gnus-move-split-methods
6770       '(("^From:.*Lars Magne" "nnml:junk")
6771         ("^Subject:.*gnus" "nnfolder:important")
6772         (".*" "nnml:misc")))
6773 @end lisp
6774
6775
6776 @node Various Summary Stuff
6777 @section Various Summary Stuff
6778
6779 @menu
6780 * Summary Group Information::         Information oriented commands.
6781 * Searching for Articles::            Multiple article commands.
6782 * Summary Generation Commands::       (Re)generating the summary buffer.
6783 * Really Various Summary Commands::   Those pesky non-conformant commands.
6784 @end menu
6785
6786 @table @code
6787 @vindex gnus-summary-mode-hook
6788 @item gnus-summary-mode-hook
6789 This hook is called when creating a summary mode buffer.
6790
6791 @vindex gnus-summary-generate-hook
6792 @item gnus-summary-generate-hook
6793 This is called as the last thing before doing the threading and the
6794 generation of the summary buffer.  It's quite convenient for customizing
6795 the threading variables based on what data the newsgroup has.  This hook
6796 is called from the summary buffer after most summary buffer variables
6797 has been set.
6798
6799 @vindex gnus-summary-prepare-hook
6800 @item gnus-summary-prepare-hook
6801 Is is called after the summary buffer has been generated.  You might use
6802 it to, for instance, highlight lines or modify the look of the buffer in
6803 some other ungodly manner.  I don't care.
6804
6805 @vindex gnus-summary-ignore-duplicates
6806 @item gnus-summary-ignore-duplicates
6807 When Gnus discovers two articles that have the same @code{Message-ID},
6808 it has to do something drastic.  No articles are allowed to have the
6809 same @code{Message-ID}, but this may happen when reading mail from some
6810 sources.  Gnus allows you to customize what happens with this variable.
6811 If it is @code{nil} (which is the default), Gnus will rename the
6812 @code{Message-ID} (for display purposes only) and display the article as
6813 any other article.  If this variable is @code{t}, it won't display the
6814 article---it'll be as if it never existed.
6815
6816 @end table
6817
6818
6819 @node Summary Group Information
6820 @subsection Summary Group Information
6821
6822 @table @kbd
6823
6824 @item H f
6825 @kindex H f (Summary)
6826 @findex gnus-summary-fetch-faq
6827 @vindex gnus-group-faq-directory
6828 Try to fetch the FAQ (list of frequently asked questions) for the
6829 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6830 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6831 on a remote machine.  This variable can also be a list of directories.
6832 In that case, giving a prefix to this command will allow you to choose
6833 between the various sites.  @code{ange-ftp} probably will be used for
6834 fetching the file.
6835
6836 @item H d
6837 @kindex H d (Summary)
6838 @findex gnus-summary-describe-group
6839 Give a brief description of the current group
6840 (@code{gnus-summary-describe-group}).  If given a prefix, force
6841 rereading the description from the server.
6842
6843 @item H h
6844 @kindex H h (Summary)
6845 @findex gnus-summary-describe-briefly
6846 Give an extremely brief description of the most important summary
6847 keystrokes (@code{gnus-summary-describe-briefly}).
6848
6849 @item H i
6850 @kindex H i (Summary)
6851 @findex gnus-info-find-node
6852 Go to the Gnus info node (@code{gnus-info-find-node}).
6853 @end table
6854
6855
6856 @node Searching for Articles
6857 @subsection Searching for Articles
6858
6859 @table @kbd
6860
6861 @item M-s
6862 @kindex M-s (Summary)
6863 @findex gnus-summary-search-article-forward
6864 Search through all subsequent articles for a regexp
6865 (@code{gnus-summary-search-article-forward}). 
6866
6867 @item M-r
6868 @kindex M-r (Summary)
6869 @findex gnus-summary-search-article-backward
6870 Search through all previous articles for a regexp
6871 (@code{gnus-summary-search-article-backward}). 
6872
6873 @item &
6874 @kindex & (Summary)
6875 @findex gnus-summary-execute-command
6876 This command will prompt you for a header field, a regular expression to
6877 match on this field, and a command to be executed if the match is made
6878 (@code{gnus-summary-execute-command}).
6879
6880 @item M-&
6881 @kindex M-& (Summary)
6882 @findex gnus-summary-universal-argument
6883 Perform any operation on all articles that have been marked with
6884 the process mark (@code{gnus-summary-universal-argument}).
6885 @end table
6886
6887 @node Summary Generation Commands
6888 @subsection Summary Generation Commands
6889
6890 @table @kbd
6891
6892 @item Y g
6893 @kindex Y g (Summary)
6894 @findex gnus-summary-prepare
6895 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6896
6897 @item Y c 
6898 @kindex Y c (Summary)
6899 @findex gnus-summary-insert-cached-articles
6900 Pull all cached articles (for the current group) into the summary buffer
6901 (@code{gnus-summary-insert-cached-articles}).
6902
6903 @end table
6904
6905
6906 @node Really Various Summary Commands
6907 @subsection Really Various Summary Commands
6908
6909 @table @kbd
6910
6911 @item C-d
6912 @kindex C-d (Summary)
6913 @findex gnus-summary-enter-digest-group
6914 If the current article is a collection of other articles (for instance,
6915 a digest), you might use this command to enter a group based on the that
6916 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6917 guess what article type is currently displayed unless you give a prefix
6918 to this command, which forces a ``digest'' interpretation.  Basically,
6919 whenever you see a message that is a collection of other messages on
6920 some format, you @kbd{C-d} and read these messages in a more convenient
6921 fashion.
6922
6923 @item M-C-d
6924 @kindex M-C-d (Summary)
6925 @findex gnus-summary-read-document
6926 This command is very similar to the one above, but lets you gather
6927 several documents into one biiig group
6928 (@code{gnus-summary-read-document}).  It does this by opening several
6929 @code{nndoc} groups for each document, and then opening an
6930 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6931 command understands the process/prefix convention
6932 (@pxref{Process/Prefix}). 
6933
6934 @item C-t
6935 @kindex C-t (Summary)
6936 @findex gnus-summary-toggle-truncation
6937 Toggle truncation of summary lines
6938 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6939 line centering function in the summary buffer, so it's not a good idea
6940 to have truncation switched off while reading articles.
6941
6942 @item =
6943 @kindex = (Summary)
6944 @findex gnus-summary-expand-window
6945 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6946 If given a prefix, force an @code{article} window configuration. 
6947
6948 @end table
6949
6950
6951 @node Exiting the Summary Buffer
6952 @section Exiting the Summary Buffer
6953 @cindex summary exit
6954 @cindex exiting groups
6955
6956 Exiting from the summary buffer will normally update all info on the
6957 group and return you to the group buffer. 
6958
6959 @table @kbd
6960
6961 @item Z Z
6962 @itemx q
6963 @kindex Z Z (Summary)
6964 @kindex q (Summary)
6965 @findex gnus-summary-exit
6966 @vindex gnus-summary-exit-hook
6967 @vindex gnus-summary-prepare-exit-hook
6968 Exit the current group and update all information on the group
6969 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6970 called before doing much of the exiting, and calls
6971 @code{gnus-summary-expire-articles} by default.
6972 @code{gnus-summary-exit-hook} is called after finishing the exiting
6973 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
6974 group mode having no more (unread) groups.
6975
6976 @item Z E
6977 @itemx Q
6978 @kindex Z E (Summary)
6979 @kindex Q (Summary)
6980 @findex gnus-summary-exit-no-update
6981 Exit the current group without updating any information on the group
6982 (@code{gnus-summary-exit-no-update}).
6983
6984 @item Z c
6985 @itemx c
6986 @kindex Z c (Summary)
6987 @kindex c (Summary)
6988 @findex gnus-summary-catchup-and-exit
6989 Mark all unticked articles in the group as read and then exit
6990 (@code{gnus-summary-catchup-and-exit}).
6991
6992 @item Z C
6993 @kindex Z C (Summary)
6994 @findex gnus-summary-catchup-all-and-exit
6995 Mark all articles, even the ticked ones, as read and then exit
6996 (@code{gnus-summary-catchup-all-and-exit}).
6997
6998 @item Z n
6999 @kindex Z n (Summary)
7000 @findex gnus-summary-catchup-and-goto-next-group
7001 Mark all articles as read and go to the next group
7002 (@code{gnus-summary-catchup-and-goto-next-group}). 
7003
7004 @item Z R
7005 @kindex Z R (Summary)
7006 @findex gnus-summary-reselect-current-group
7007 Exit this group, and then enter it again
7008 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7009 all articles, both read and unread.
7010
7011 @item Z G
7012 @itemx M-g
7013 @kindex Z G (Summary)
7014 @kindex M-g (Summary)
7015 @findex gnus-summary-rescan-group
7016 Exit the group, check for new articles in the group, and select the
7017 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7018 articles, both read and unread.
7019
7020 @item Z N
7021 @kindex Z N (Summary)
7022 @findex gnus-summary-next-group
7023 Exit the group and go to the next group
7024 (@code{gnus-summary-next-group}). 
7025
7026 @item Z P
7027 @kindex Z P (Summary)
7028 @findex gnus-summary-prev-group
7029 Exit the group and go to the previous group
7030 (@code{gnus-summary-prev-group}). 
7031
7032 @item Z s
7033 @kindex Z s (Summary)
7034 @findex gnus-summary-save-newsrc
7035 Save the current number of read/marked articles in the dribble buffer
7036 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7037 given a prefix, also save the @file{.newsrc} file(s).  Using this
7038 command will make exit without updating (the @kbd{Q} command) worthless.
7039 @end table
7040
7041 @vindex gnus-exit-group-hook
7042 @code{gnus-exit-group-hook} is called when you exit the current
7043 group.  
7044
7045 @findex gnus-summary-wake-up-the-dead
7046 @findex gnus-dead-summary-mode
7047 @vindex gnus-kill-summary-on-exit
7048 If you're in the habit of exiting groups, and then changing your mind
7049 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7050 If you do that, Gnus won't kill the summary buffer when you exit it.
7051 (Quelle surprise!)  Instead it will change the name of the buffer to
7052 something like @samp{*Dead Summary ... *} and install a minor mode
7053 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7054 buffer, you'll find that all keys are mapped to a function called
7055 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7056 summary buffer will result in a live, normal summary buffer.  
7057
7058 There will never be more than one dead summary buffer at any one time. 
7059
7060 @vindex gnus-use-cross-reference
7061 The data on the current group will be updated (which articles you have
7062 read, which articles you have replied to, etc.) when you exit the
7063 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7064 @code{t} (which is the default), articles that are cross-referenced to
7065 this group and are marked as read, will also be marked as read in the
7066 other subscribed groups they were cross-posted to.  If this variable is
7067 neither @code{nil} nor @code{t}, the article will be marked as read in
7068 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7069
7070
7071 @node Crosspost Handling
7072 @section Crosspost Handling
7073
7074 @cindex velveeta
7075 @cindex spamming
7076 Marking cross-posted articles as read ensures that you'll never have to
7077 read the same article more than once.  Unless, of course, somebody has
7078 posted it to several groups separately.  Posting the same article to
7079 several groups (not cross-posting) is called @dfn{spamming}, and you are
7080 by law required to send nasty-grams to anyone who perpetrates such a
7081 heinous crime.  You may want to try NoCeM handling to filter out spam
7082 (@pxref{NoCeM}). 
7083
7084 Remember: Cross-posting is kinda ok, but posting the same article
7085 separately to several groups is not.  Massive cross-posting (aka.
7086 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7087 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7088 excessive crossposting (@pxref{Summary Mail Commands}).
7089
7090 @cindex cross-posting
7091 @cindex Xref
7092 @cindex @sc{nov}
7093 One thing that may cause Gnus to not do the cross-posting thing
7094 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7095 (which is very nice, because it speeds things up considerably) which
7096 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7097 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7098 even with @sc{xover} by registering the @code{Xref} lines of all
7099 articles you actually read, but if you kill the articles, or just mark
7100 them as read without reading them, Gnus will not get a chance to snoop
7101 the @code{Xref} lines out of these articles, and will be unable to use
7102 the cross reference mechanism.
7103
7104 @cindex LIST overview.fmt
7105 @cindex overview.fmt
7106 To check whether your @sc{nntp} server includes the @code{Xref} header
7107 in its overview files, try @samp{telnet your.nntp.server nntp},
7108 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7109 overview.fmt}.  This may not work, but if it does, and the last line you
7110 get does not read @samp{Xref:full}, then you should shout and whine at
7111 your news admin until she includes the @code{Xref} header in the
7112 overview files.
7113
7114 @vindex gnus-nov-is-evil
7115 If you want Gnus to get the @code{Xref}s right all the time, you have to
7116 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7117 considerably.
7118
7119 C'est la vie.
7120
7121 For an alternative approach, @pxref{Duplicate Suppression}.
7122
7123
7124 @node Duplicate Suppression
7125 @section Duplicate Suppression
7126
7127 By default, Gnus tries to make sure that you don't have to read the same
7128 article more than once by utilizing the crossposting mechanism
7129 (@pxref{Crosspost Handling}).  However, that simple and efficient
7130 approach may not work satisfactorily for some users for various
7131 reasons.  
7132
7133 @enumerate
7134 @item 
7135 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7136 is evil and not very common.
7137
7138 @item 
7139 The @sc{nntp} server may fail to include the @code{Xref} header in the
7140 @file{.overview} data bases.  This is evil and all too common, alas.
7141
7142 @item
7143 You may be reading the same group (or several related groups) from
7144 different @sc{nntp} servers.
7145
7146 @item
7147 You may be getting mail that duplicates articles posted to groups.
7148 @end enumerate
7149
7150 I'm sure there are other situations that @code{Xref} handling fails as
7151 well, but these four are the most common situations.
7152
7153 If, and only if, @code{Xref} handling fails for you, then you may
7154 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7155 will remember the @code{Message-ID}s of all articles you have read or
7156 otherwise marked as read, and then, as if by magic, mark them as read
7157 all subsequent times you see them---in @emph{all} groups.  Using this
7158 mechanism is quite likely to be somewhat inefficient, but not overly
7159 so.  It's certainly preferable to reading the same articles more than
7160 once.
7161
7162 Duplicate suppression is not a very subtle instrument.  It's more like a
7163 sledge hammer than anything else.  It works in a very simple
7164 fashion---if you have marked an article as read, it adds this Message-ID
7165 to a cache.  The next time it sees this Message-ID, it will mark the
7166 article as read the the @samp{M} mark.  It doesn't care what group it
7167 saw the article in.
7168
7169 @table @code
7170 @item gnus-suppress-duplicates
7171 @vindex gnus-suppress-duplicates
7172 If non-@code{nil}, suppress duplicates.
7173
7174 @item gnus-save-duplicate-list
7175 @vindex gnus-save-duplicate-list
7176 If non-@code{nil}, save the list of duplicates to a file.  This will
7177 make startup and shutdown take longer, so the default is @code{nil}.
7178 However, this means that only duplicate articles that is read in a
7179 single Gnus session are suppressed.  
7180
7181 @item gnus-duplicate-list-length
7182 @vindex gnus-duplicate-list-length
7183 This variables says how many @code{Message-ID}s to keep in the duplicate
7184 suppression list.  The default is 10000.  
7185
7186 @item gnus-duplicate-file
7187 @vindex gnus-duplicate-file
7188 The name of the file to store the duplicate suppression list.  The
7189 default is @file{~/News/suppression}.
7190 @end table
7191
7192 If you have a tendency to stop and start Gnus often, setting
7193 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7194 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7195 the other hand, saving the list makes startup and shutdown much slower,
7196 so that means that if you stop and start Gnus often, you should set
7197 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7198 to you to figure out, I think.
7199
7200
7201 @node The Article Buffer
7202 @chapter The Article Buffer
7203 @cindex article buffer
7204
7205 The articles are displayed in the article buffer, of which there is only
7206 one.  All the summary buffers share the same article buffer unless you
7207 tell Gnus otherwise.
7208
7209 @menu
7210 * Hiding Headers::        Deciding what headers should be displayed.
7211 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7212 * Customizing Articles::  Tailoring the look of the articles.
7213 * Article Keymap::        Keystrokes available in the article buffer.
7214 * Misc Article::          Other stuff.
7215 @end menu
7216
7217
7218 @node Hiding Headers
7219 @section Hiding Headers
7220 @cindex hiding headers
7221 @cindex deleting headers
7222
7223 The top section of each article is the @dfn{head}.  (The rest is the
7224 @dfn{body}, but you may have guessed that already.)
7225
7226 @vindex gnus-show-all-headers
7227 There is a lot of useful information in the head: the name of the person
7228 who wrote the article, the date it was written and the subject of the
7229 article.  That's well and nice, but there's also lots of information
7230 most people do not want to see---what systems the article has passed
7231 through before reaching you, the @code{Message-ID}, the
7232 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7233 of some of those lines.  If you want to keep all those lines in the
7234 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7235
7236 Gnus provides you with two variables for sifting headers:
7237
7238 @table @code
7239
7240 @item gnus-visible-headers
7241 @vindex gnus-visible-headers
7242 If this variable is non-@code{nil}, it should be a regular expression
7243 that says what headers you wish to keep in the article buffer.  All
7244 headers that do not match this variable will be hidden.
7245
7246 For instance, if you only want to see the name of the person who wrote
7247 the article and the subject, you'd say:
7248
7249 @lisp
7250 (setq gnus-visible-headers "^From:\\|^Subject:")
7251 @end lisp
7252
7253 This variable can also be a list of regexps to match headers that are to
7254 remain visible.
7255
7256 @item gnus-ignored-headers
7257 @vindex gnus-ignored-headers
7258 This variable is the reverse of @code{gnus-visible-headers}.  If this
7259 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7260 should be a regular expression that matches all lines that you want to
7261 hide.  All lines that do not match this variable will remain visible.
7262
7263 For instance, if you just want to get rid of the @code{References} line
7264 and the @code{Xref} line, you might say:
7265
7266 @lisp
7267 (setq gnus-ignored-headers "^References:\\|^Xref:")
7268 @end lisp
7269
7270 This variable can also be a list of regexps to match headers that are to
7271 be removed.
7272
7273 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7274 variable will have no effect.
7275
7276 @end table
7277
7278 @vindex gnus-sorted-header-list
7279 Gnus can also sort the headers for you.  (It does this by default.)  You
7280 can control the sorting by setting the @code{gnus-sorted-header-list}
7281 variable.  It is a list of regular expressions that says in what order
7282 the headers are to be displayed.
7283
7284 For instance, if you want the name of the author of the article first,
7285 and then the subject, you might say something like:
7286
7287 @lisp
7288 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7289 @end lisp
7290
7291 Any headers that are to remain visible, but are not listed in this
7292 variable, will be displayed in random order after all the headers that
7293 are listed in this variable.
7294
7295 @findex gnus-article-hide-boring-headers
7296 @vindex gnus-article-display-hook
7297 @vindex gnus-boring-article-headers
7298 You can hide further boring headers by entering
7299 @code{gnus-article-hide-boring-headers} into
7300 @code{gnus-article-display-hook}.  What this function does depends on
7301 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7302 list doesn't actually contain header names.  Instead is lists various
7303 @dfn{boring conditions} that Gnus can check and remove from sight.
7304
7305 These conditions are:
7306 @table @code
7307 @item empty
7308 Remove all empty headers.
7309 @item newsgroups
7310 Remove the @code{Newsgroups} header if it only contains the current group
7311 name. 
7312 @item followup-to
7313 Remove the @code{Followup-To} header if it is identical to the
7314 @code{Newsgroups} header.
7315 @item reply-to
7316 Remove the @code{Reply-To} header if it lists the same address as the
7317 @code{From} header.
7318 @item date
7319 Remove the @code{Date} header if the article is less than three days
7320 old. 
7321 @end table
7322
7323 To include the four first elements, you could say something like;
7324
7325 @lisp
7326 (setq gnus-boring-article-headers 
7327       '(empty newsgroups followup-to reply-to))
7328 @end lisp
7329
7330 This is also the default value for this variable.
7331
7332
7333 @node Using MIME
7334 @section Using @sc{mime}
7335 @cindex @sc{mime}
7336
7337 Mime is a standard for waving your hands through the air, aimlessly,
7338 while people stand around yawning.
7339
7340 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7341 while all newsreaders die of fear.
7342
7343 @sc{mime} may specify what character set the article uses, the encoding
7344 of the characters, and it also makes it possible to embed pictures and
7345 other naughty stuff in innocent-looking articles.
7346
7347 @vindex gnus-show-mime
7348 @vindex gnus-show-mime-method
7349 @vindex gnus-strict-mime
7350 @findex metamail-buffer
7351 Gnus handles @sc{mime} by pushing the articles through
7352 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7353 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7354 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7355 non-@code{nil}, the @sc{mime} method will only be used if there are
7356 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7357 set, then you'll see some unfortunate display glitches in the article
7358 buffer.  These can't be avoided.
7359
7360 It might be best to just use the toggling functions from the summary
7361 buffer to avoid getting nasty surprises. (For instance, you enter the
7362 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7363 decoded the sound file in the article and some horrible sing-a-long song
7364 comes streaming out out your speakers, and you can't find the volume
7365 button, because there isn't one, and people are starting to look at you,
7366 and you try to stop the program, but you can't, and you can't find the
7367 program to control the volume, and everybody else in the room suddenly
7368 decides to look at you disdainfully, and you'll feel rather stupid.)
7369
7370 Any similarity to real events and people is purely coincidental.  Ahem.
7371
7372
7373 @node Customizing Articles
7374 @section Customizing Articles
7375 @cindex article customization
7376
7377 @vindex gnus-article-display-hook
7378 The @code{gnus-article-display-hook} is called after the article has
7379 been inserted into the article buffer.  It is meant to handle all
7380 treatment of the article before it is displayed. 
7381
7382 @findex gnus-article-maybe-highlight
7383 By default this hook just contains @code{gnus-article-hide-headers},
7384 @code{gnus-article-treat-overstrike}, and
7385 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7386 millions, of functions you can put in this hook.  For an overview of
7387 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7388 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7389 Date}.  Note that the order of functions in this hook might affect
7390 things, so you may have to fiddle a bit to get the desired results. 
7391
7392 You can, of course, write your own functions.  The functions are called
7393 from the article buffer, and you can do anything you like, pretty much.
7394 There is no information that you have to keep in the buffer---you can
7395 change everything.  However, you shouldn't delete any headers.  Instead
7396 make them invisible if you want to make them go away.
7397
7398
7399 @node Article Keymap
7400 @section Article Keymap
7401
7402 Most of the keystrokes in the summary buffer can also be used in the
7403 article buffer.  They should behave as if you typed them in the summary
7404 buffer, which means that you don't actually have to have a summary
7405 buffer displayed while reading.  You can do it all from the article
7406 buffer.
7407
7408 A few additional keystrokes are available:
7409
7410 @table @kbd
7411
7412 @item SPACE
7413 @kindex SPACE (Article)
7414 @findex gnus-article-next-page
7415 Scroll forwards one page (@code{gnus-article-next-page}).
7416
7417 @item DEL
7418 @kindex DEL (Article)
7419 @findex gnus-article-prev-page
7420 Scroll backwards one page (@code{gnus-article-prev-page}).
7421
7422 @item C-c ^
7423 @kindex C-c ^ (Article)
7424 @findex gnus-article-refer-article
7425 If point is in the neighborhood of a @code{Message-ID} and you press
7426 @kbd{r}, Gnus will try to get that article from the server
7427 (@code{gnus-article-refer-article}).
7428
7429 @item C-c C-m
7430 @kindex C-c C-m (Article)
7431 @findex gnus-article-mail
7432 Send a reply to the address near point (@code{gnus-article-mail}).  If
7433 given a prefix, include the mail.
7434
7435 @item s
7436 @kindex s (Article)
7437 @findex gnus-article-show-summary
7438 Reconfigure the buffers so that the summary buffer becomes visible
7439 (@code{gnus-article-show-summary}).
7440
7441 @item ?
7442 @kindex ? (Article)
7443 @findex gnus-article-describe-briefly
7444 Give a very brief description of the available keystrokes
7445 (@code{gnus-article-describe-briefly}). 
7446
7447 @item TAB
7448 @kindex TAB (Article)
7449 @findex gnus-article-next-button
7450 Go to the next button, if any (@code{gnus-article-next-button}.  This
7451 only makes sense if you have buttonizing turned on.
7452
7453 @item M-TAB
7454 @kindex M-TAB (Article)
7455 @findex gnus-article-prev-button
7456 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7457
7458 @end table
7459
7460
7461 @node Misc Article
7462 @section Misc Article
7463
7464 @table @code
7465
7466 @item gnus-single-article-buffer
7467 @vindex gnus-single-article-buffer
7468 If non-@code{nil}, use the same article buffer for all the groups.
7469 (This is the default.)  If @code{nil}, each group will have its own
7470 article buffer.
7471
7472 @vindex gnus-article-prepare-hook
7473 @item gnus-article-prepare-hook
7474 This hook is called right after the article has been inserted into the
7475 article buffer.  It is mainly intended for functions that do something
7476 depending on the contents; it should probably not be used for changing
7477 the contents of the article buffer.
7478
7479 @vindex gnus-article-display-hook
7480 @item gnus-article-display-hook
7481 This hook is called as the last thing when displaying an article, and is
7482 intended for modifying the contents of the buffer, doing highlights,
7483 hiding headers, and the like.
7484
7485 @item gnus-article-mode-hook
7486 @vindex gnus-article-mode-hook
7487 Hook called in article mode buffers.
7488
7489 @item gnus-article-mode-syntax-table
7490 @vindex gnus-article-mode-syntax-table
7491 Syntax table used in article buffers.  It is initialized from
7492 @code{text-mode-syntax-table}. 
7493
7494 @vindex gnus-article-mode-line-format
7495 @item gnus-article-mode-line-format
7496 This variable is a format string along the same lines as
7497 @code{gnus-summary-mode-line-format}.  It accepts the same
7498 format specifications as that variable, with one extension:
7499
7500 @table @samp
7501 @item w
7502 The @dfn{wash status} of the article.  This is a short string with one
7503 character for each possible article wash operation that may have been
7504 performed. 
7505 @end table
7506
7507 @vindex gnus-break-pages
7508
7509 @item gnus-break-pages
7510 Controls whether @dfn{page breaking} is to take place.  If this variable
7511 is non-@code{nil}, the articles will be divided into pages whenever a
7512 page delimiter appears in the article.  If this variable is @code{nil},
7513 paging will not be done.
7514
7515 @item gnus-page-delimiter
7516 @vindex gnus-page-delimiter
7517 This is the delimiter mentioned above.  By default, it is @samp{^L}
7518 (form linefeed).
7519 @end table
7520
7521
7522 @node Composing Messages
7523 @chapter Composing Messages
7524 @cindex reply
7525 @cindex followup
7526 @cindex post
7527
7528 @kindex C-c C-c (Post)
7529 All commands for posting and mailing will put you in a message buffer
7530 where you can edit the article all you like, before you send the article
7531 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7532 Manual}.  If you are in a foreign news group, and you wish to post the
7533 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7534 to make Gnus try to post using the foreign server.
7535
7536 @menu 
7537 * Mail::                 Mailing and replying.
7538 * Post::                 Posting and following up.
7539 * Posting Server::       What server should you post via?
7540 * Mail and Post::        Mailing and posting at the same time.
7541 * Archived Messages::    Where Gnus stores the messages you've sent.
7542 @c * Posting Styles::       An easier way to configure some key elements.
7543 @c * Drafts::               Postponing messages and rejected messages.
7544 @c * Rejected Articles::    What happens if the server doesn't like your article?
7545 @end menu
7546
7547 Also see @pxref{Canceling and Superseding} for information on how to
7548 remove articles you shouldn't have posted.
7549
7550
7551 @node Mail
7552 @section Mail
7553
7554 Variables for customizing outgoing mail:
7555
7556 @table @code
7557 @item gnus-uu-digest-headers
7558 @vindex gnus-uu-digest-headers
7559 List of regexps to match headers included in digested messages.  The
7560 headers will be included in the sequence they are matched.
7561
7562 @item gnus-add-to-list
7563 @vindex gnus-add-to-list
7564 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
7565 that have none when you do a @kbd{a}.
7566
7567 @end table
7568
7569
7570 @node Post
7571 @section Post
7572
7573 Variables for composing news articles:
7574
7575 @table @code
7576 @item gnus-sent-message-ids-file
7577 @vindex gnus-sent-message-ids-file
7578 Gnus will keep a @code{Message-ID} history file of all the mails it has
7579 sent.  If it discovers that it has already sent a mail, it will ask the
7580 user whether to re-send the mail.  (This is primarily useful when
7581 dealing with @sc{soup} packets and the like where one is apt to sent the
7582 same packet multiple times.)  This variable says what the name of this
7583 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7584 this variable to @code{nil} if you don't want Gnus to keep a history
7585 file.
7586
7587 @item gnus-sent-message-ids-length
7588 @vindex gnus-sent-message-ids-length
7589 This variable says how many @code{Message-ID}s to keep in the history
7590 file.  It is 1000 by default.
7591
7592 @end table
7593
7594
7595 @node Posting Server
7596 @section Posting Server
7597
7598 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7599 (extremely intelligent, of course) article, where does it go?
7600
7601 Thank you for asking.  I hate you.
7602
7603 @vindex gnus-post-method
7604
7605 It can be quite complicated.  Normally, Gnus will use the same native
7606 server.  However.  If your native server doesn't allow posting, just
7607 reading, you probably want to use some other server to post your
7608 (extremely intelligent and fabulously interesting) articles.  You can
7609 then set the @code{gnus-post-method} to some other method:
7610
7611 @lisp
7612 (setq gnus-post-method '(nnspool ""))
7613 @end lisp
7614
7615 Now, if you've done this, and then this server rejects your article, or
7616 this server is down, what do you do then?  To override this variable you
7617 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7618 the ``current'' server for posting.
7619
7620 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7621 Gnus will prompt you for what method to use for posting.  
7622
7623 You can also set @code{gnus-post-method} to a list of select methods.
7624 If that's the case, Gnus will always prompt you for what method to use
7625 for posting. 
7626
7627
7628 @node Mail and Post
7629 @section Mail and Post
7630
7631 Here's a list of variables that are relevant to both mailing and
7632 posting:
7633
7634 @table @code
7635 @item gnus-mailing-list-groups
7636 @findex gnus-mailing-list-groups
7637 @cindex mailing lists
7638
7639 If your news server offers groups that are really mailing lists that are
7640 gatewayed to the @sc{nntp} server, you can read those groups without
7641 problems, but you can't post/followup to them without some difficulty.
7642 One solution is to add a @code{to-address} to the group parameters
7643 (@pxref{Group Parameters}).  An easier thing to do is set the
7644 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7645 really are mailing lists.  Then, at least, followups to the mailing
7646 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7647 still a pain, though.
7648
7649 @end table
7650
7651 You may want to do spell-checking on messages that you send out.  Or, if
7652 you don't want to spell-check by hand, you could add automatic
7653 spell-checking via the @code{ispell} package:
7654
7655 @cindex ispell
7656 @findex ispell-message
7657 @lisp
7658 (add-hook 'message-send-hook 'ispell-message) 
7659 @end lisp
7660
7661
7662 @node Archived Messages
7663 @section Archived Messages
7664 @cindex archived messages
7665 @cindex sent messages
7666
7667 Gnus provides a few different methods for storing the mail and news you
7668 send.  The default method is to use the @dfn{archive virtual server} to
7669 store the messages.  If you want to disable this completely, the
7670 @code{gnus-message-archive-group} variable should be @code{nil}, which
7671 is the default.
7672
7673 @vindex gnus-message-archive-method
7674 @code{gnus-message-archive-method} says what virtual server Gnus is to
7675 use to store sent messages.  The default is:
7676
7677 @lisp
7678 (nnfolder "archive"
7679           (nnfolder-directory "~/Mail/archive/"))
7680 @end lisp
7681
7682 You can, however, use any mail select method (@code{nnml},
7683 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7684 for doing this sort of thing, though.  If you don't like the default
7685 directory chosen, you could say something like:
7686
7687 @lisp
7688 (setq gnus-message-archive-method
7689       '(nnfolder "archive" 
7690                  (nnfolder-inhibit-expiry t)
7691                  (nnfolder-active-file "~/News/sent-mail/active")
7692                  (nnfolder-directory "~/News/sent-mail/")))
7693 @end lisp
7694
7695 @vindex gnus-message-archive-group
7696 @cindex Gcc
7697 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7698 to one or more group(s) on that server.  Which group to use is
7699 determined by the @code{gnus-message-archive-group} variable.  
7700
7701 This variable can be:
7702
7703 @itemize @bullet
7704 @item a string
7705 Messages will be saved in that group.
7706 @item a list of strings
7707 Messages will be saved in all those groups.
7708 @item an alist of regexps, functions and forms
7709 When a key ``matches'', the result is used.
7710 @item @code{nil}
7711 No message archiving will take place.  This is the default.
7712 @end itemize
7713
7714 Let's illustrate:
7715
7716 Just saving to a single group called @samp{MisK}:
7717 @lisp
7718 (setq gnus-message-archive-group "MisK")
7719 @end lisp
7720
7721 Saving to two groups, @samp{MisK} and @samp{safe}:
7722 @lisp
7723 (setq gnus-message-archive-group '("MisK" "safe"))
7724 @end lisp
7725
7726 Save to different groups based on what group you are in:
7727 @lisp
7728 (setq gnus-message-archive-group 
7729       '(("^alt" "sent-to-alt")
7730         ("mail" "sent-to-mail")
7731         (".*" "sent-to-misc")))
7732 @end lisp
7733
7734 More complex stuff:
7735 @lisp
7736 (setq gnus-message-archive-group 
7737       '((if (message-news-p)
7738             "misc-news" 
7739           "misc-mail")))
7740 @end lisp       
7741
7742 How about storing all news messages in one file, but storing all mail
7743 messages in one file per month:
7744
7745 @lisp
7746 (setq gnus-message-archive-group
7747       '((if (message-news-p)
7748             "misc-news" 
7749           (concat "mail." (format-time-string 
7750                            "%Y-%m" (current-time))))))
7751 @end lisp
7752
7753 Now, when you send a message off, it will be stored in the appropriate
7754 group.  (If you want to disable storing for just one particular message,
7755 you can just remove the @code{Gcc} header that has been inserted.)  The
7756 archive group will appear in the group buffer the next time you start
7757 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7758 enter it and read the articles in it just like you'd read any other
7759 group.  If the group gets really big and annoying, you can simply rename
7760 if (using @kbd{G r} in the group buffer) to something
7761 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7762 continue to be stored in the old (now empty) group.
7763
7764 That's the default method of archiving sent messages.  Gnus also a
7765 different way for the people who don't like the default method.  In that
7766 case you should set @code{gnus-message-archive-group} to @code{nil};
7767 this will disable archiving.
7768
7769 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7770 use a different value for @code{gnus-message-archive-group} there.
7771
7772 @table @code
7773 @item gnus-outgoing-message-group 
7774 @vindex gnus-outgoing-message-group 
7775 All outgoing messages will be put in this group.  If you want to store
7776 all your outgoing mail and articles in the group @samp{nnml:archive},
7777 you set this variable to that value.  This variable can also be a list of
7778 group names.
7779
7780 If you want to have greater control over what group to put each
7781 message in, you can set this variable to a function that checks the
7782 current newsgroup name and then returns a suitable group name (or list
7783 of names).
7784
7785 This variable can be used instead of @code{gnus-message-archive-group},
7786 but the latter is the preferred method.
7787 @end table
7788
7789
7790 @c @node Posting Styles
7791 @c @section Posting Styles
7792 @c @cindex posting styles
7793 @c @cindex styles
7794 @c 
7795 @c All them variables, they make my head swim.  
7796 @c 
7797 @c So what if you want a different @code{Organization} and signature based
7798 @c on what groups you post to?  And you post both from your home machine
7799 @c and your work machine, and you want different @code{From} lines, and so
7800 @c on? 
7801 @c 
7802 @c @vindex gnus-posting-styles
7803 @c One way to do stuff like that is to write clever hooks that change the
7804 @c variables you need to have changed.  That's a bit boring, so somebody
7805 @c came up with the bright idea of letting the user specify these things in
7806 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7807 @c variable: 
7808 @c 
7809 @c @lisp
7810 @c ((".*" 
7811 @c   (signature . "Peace and happiness")
7812 @c   (organization . "What me?"))
7813 @c  ("^comp" 
7814 @c   (signature . "Death to everybody"))
7815 @c  ("comp.emacs.i-love-it" 
7816 @c   (organization . "Emacs is it")))
7817 @c @end lisp
7818 @c 
7819 @c As you might surmise from this example, this alist consists of several
7820 @c @dfn{styles}.  Each style will be applicable if the first element
7821 @c ``matches'', in some form or other.  The entire alist will be iterated
7822 @c over, from the beginning towards the end, and each match will be
7823 @c applied, which means that attributes in later styles that match override
7824 @c the same attributes in earlier matching styles.  So
7825 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7826 @c signature and the @samp{What me?} @code{Organization} header.
7827 @c 
7828 @c The first element in each style is called the @code{match}.  If it's a
7829 @c string, then Gnus will try to regexp match it against the group name.
7830 @c If it's a function symbol, that function will be called with no
7831 @c arguments.  If it's a variable symbol, then the variable will be
7832 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7833 @c any case, if this returns a non-@code{nil} value, then the style is said
7834 @c to @dfn{match}.
7835 @c 
7836 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7837 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7838 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7839 @c attribute name can also be a string.  In that case, this will be used as
7840 @c a header name, and the value will be inserted in the headers of the
7841 @c article.
7842 @c 
7843 @c The attribute value can be a string (used verbatim), a function (the
7844 @c return value will be used), a variable (its value will be used) or a
7845 @c list (it will be @code{eval}ed and the return value will be used).
7846 @c 
7847 @c So here's a new example:
7848 @c 
7849 @c @lisp
7850 @c (setq gnus-posting-styles
7851 @c       '((".*" 
7852 @c           (signature . "~/.signature") 
7853 @c           (from . "user@@foo (user)")
7854 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7855 @c           (organization . "People's Front Against MWM"))
7856 @c         ("^rec.humor" 
7857 @c           (signature . my-funny-signature-randomizer))
7858 @c         ((equal (system-name) "gnarly")
7859 @c           (signature . my-quote-randomizer))
7860 @c         (posting-from-work-p
7861 @c           (signature . "~/.work-signature")
7862 @c           (from . "user@@bar.foo (user)")
7863 @c           (organization . "Important Work, Inc"))
7864 @c         ("^nn.+:" 
7865 @c           (signature . "~/.mail-signature"))))
7866 @c @end lisp
7867
7868 @c @node Drafts
7869 @c @section Drafts
7870 @c @cindex drafts
7871 @c 
7872 @c If you are writing a message (mail or news) and suddenly remember that
7873 @c you have a steak in the oven (or some pesto in the food processor, you
7874 @c craazy vegetarians), you'll probably wish there was a method to save the
7875 @c message you are writing so that you can continue editing it some other
7876 @c day, and send it when you feel its finished.
7877 @c 
7878 @c Well, don't worry about it.  Whenever you start composing a message of
7879 @c some sort using the Gnus mail and post commands, the buffer you get will
7880 @c automatically associate to an article in a special @dfn{draft} group.
7881 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7882 @c article will be saved there.  (Auto-save files also go to the draft
7883 @c group.) 
7884 @c 
7885 @c @cindex nndraft
7886 @c @vindex gnus-draft-group-directory
7887 @c The draft group is a special group (which is implemented as an
7888 @c @code{nndraft} group, if you absolutely have to know) called
7889 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7890 @c controls both the name of the group and the location---the leaf element
7891 @c in the path will be used as the name of the group.  What makes this
7892 @c group special is that you can't tick any articles in it or mark any
7893 @c articles as read---all articles in the group are permanently unread.
7894 @c 
7895 @c If the group doesn't exist, it will be created and you'll be subscribed
7896 @c to it.
7897 @c 
7898 @c @findex gnus-dissociate-buffer-from-draft
7899 @c @kindex C-c M-d (Mail)
7900 @c @kindex C-c M-d (Post)
7901 @c @findex gnus-associate-buffer-with-draft
7902 @c @kindex C-c C-d (Mail)
7903 @c @kindex C-c C-d (Post)
7904 @c If you're writing some super-secret message that you later want to
7905 @c encode with PGP before sending, you may wish to turn the auto-saving
7906 @c (and association with the draft group) off.  You never know who might be
7907 @c interested in reading all your extremely valuable and terribly horrible
7908 @c and interesting secrets.  The @kbd{C-c M-d}
7909 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7910 @c If you change your mind and want to turn the auto-saving back on again,
7911 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7912 @c 
7913 @c @vindex gnus-use-draft
7914 @c To leave association with the draft group off by default, set
7915 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7916 @c 
7917 @c @findex gnus-summary-send-draft
7918 @c @kindex S D c (Summary)
7919 @c When you want to continue editing the article, you simply enter the
7920 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7921 @c that.  You will be placed in a buffer where you left off.
7922 @c 
7923 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7924 @c Articles}).
7925 @c 
7926 @c @findex gnus-summary-send-all-drafts
7927 @c If you have lots of rejected messages you want to post (or mail) without
7928 @c doing further editing, you can use the @kbd{S D a} command
7929 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7930 @c process/prefix convention (@pxref{Process/Prefix}).  
7931 @c 
7932 @c 
7933 @c @node Rejected Articles
7934 @c @section Rejected Articles
7935 @c @cindex rejected articles
7936 @c 
7937 @c Sometimes a news server will reject an article.  Perhaps the server
7938 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7939 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7940 @c Perhaps the disk is full.  Perhaps the server is down.
7941 @c 
7942 @c These situations are, of course, totally beyond the control of Gnus.
7943 @c (Gnus, of course, loves the way you look, always feels great, has angels
7944 @c fluttering around inside of it, doesn't care about how much cited text
7945 @c you include, never runs full and never goes down.)  So Gnus saves these
7946 @c articles until some later time when the server feels better.
7947 @c 
7948 @c The rejected articles will automatically be put in a special draft group
7949 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7950 @c typically enter that group and send all the articles off.
7951 @c 
7952
7953 @node Select Methods
7954 @chapter Select Methods
7955 @cindex foreign groups
7956 @cindex select methods
7957
7958 A @dfn{foreign group} is a group that is not read by the usual (or
7959 default) means.  It could be, for instance, a group from a different
7960 @sc{nntp} server, it could be a virtual group, or it could be your own
7961 personal mail group.
7962
7963 A foreign group (or any group, really) is specified by a @dfn{name} and
7964 a @dfn{select method}.  To take the latter first, a select method is a
7965 list where the first element says what backend to use (e.g. @code{nntp},
7966 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7967 name}.  There may be additional elements in the select method, where the
7968 value may have special meaning for the backend in question.
7969
7970 One could say that a select method defines a @dfn{virtual server}---so
7971 we do just that (@pxref{The Server Buffer}).
7972
7973 The @dfn{name} of the group is the name the backend will recognize the
7974 group as.
7975
7976 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7977 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7978 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7979 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7980 backend just knows this group as @samp{soc.motss}.
7981
7982 The different methods all have their peculiarities, of course.
7983
7984 @menu
7985 * The Server Buffer::     Making and editing virtual servers.
7986 * Getting News::          Reading USENET news with Gnus.
7987 * Getting Mail::          Reading your personal mail with Gnus.
7988 * Other Sources::         Reading directories, files, SOUP packets.
7989 * Combined Groups::       Combining groups into one group.
7990 @end menu
7991
7992
7993 @node The Server Buffer
7994 @section The Server Buffer
7995
7996 Traditionally, a @dfn{server} is a machine or a piece of software that
7997 one connects to, and then requests information from.  Gnus does not
7998 connect directly to any real servers, but does all transactions through
7999 one backend or other.  But that's just putting one layer more between
8000 the actual media and Gnus, so we might just as well say that each
8001 backend represents a virtual server.
8002
8003 For instance, the @code{nntp} backend may be used to connect to several
8004 different actual @sc{nntp} servers, or, perhaps, to many different ports
8005 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8006 use, and what parameters to set by specifying a @dfn{select method}.
8007
8008 These select methods specifications can sometimes become quite
8009 complicated---say, for instance, that you want to read from the
8010 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8011 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8012 Anyways, if you had to specify that for each group that used this
8013 server, that would be too much work, so Gnus offers a way of naming
8014 select methods, which is what you do in the server buffer.
8015
8016 To enter the server buffer, user the @kbd{^}
8017 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8018
8019 @menu
8020 * Server Buffer Format::      You can customize the look of this buffer.
8021 * Server Commands::           Commands to manipulate servers.
8022 * Example Methods::           Examples server specifications.
8023 * Creating a Virtual Server:: An example session.
8024 * Server Variables::          Which variables to set.
8025 * Servers and Methods::       You can use server names as select methods.
8026 * Unavailable Servers::       Some servers you try to contact may be down.
8027 @end menu
8028
8029 @vindex gnus-server-mode-hook
8030 @code{gnus-server-mode-hook} is run when creating the server buffer.
8031
8032
8033 @node Server Buffer Format
8034 @subsection Server Buffer Format
8035 @cindex server buffer format
8036
8037 @vindex gnus-server-line-format
8038 You can change the look of the server buffer lines by changing the
8039 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8040 variable, with some simple extensions:
8041
8042 @table @samp
8043
8044 @item h 
8045 How the news is fetched---the backend name.
8046
8047 @item n
8048 The name of this server.
8049
8050 @item w
8051 Where the news is to be fetched from---the address.
8052
8053 @item s
8054 The opened/closed/denied status of the server.
8055 @end table
8056
8057 @vindex gnus-server-mode-line-format
8058 The mode line can also be customized by using the
8059 @code{gnus-server-mode-line-format} variable.  The following specs are
8060 understood: 
8061
8062 @table @samp
8063 @item S
8064 Server name.
8065
8066 @item M
8067 Server method.
8068 @end table
8069
8070 Also @pxref{Formatting Variables}.
8071
8072
8073 @node Server Commands
8074 @subsection Server Commands
8075 @cindex server commands
8076
8077 @table @kbd
8078
8079 @item a
8080 @kindex a (Server)
8081 @findex gnus-server-add-server
8082 Add a new server (@code{gnus-server-add-server}).
8083
8084 @item e
8085 @kindex e (Server)
8086 @findex gnus-server-edit-server
8087 Edit a server (@code{gnus-server-edit-server}).
8088
8089 @item SPACE
8090 @kindex SPACE (Server)
8091 @findex gnus-server-read-server
8092 Browse the current server (@code{gnus-server-read-server}).
8093
8094 @item q
8095 @kindex q (Server)
8096 @findex gnus-server-exit
8097 Return to the group buffer (@code{gnus-server-exit}).
8098
8099 @item k
8100 @kindex k (Server)
8101 @findex gnus-server-kill-server
8102 Kill the current server (@code{gnus-server-kill-server}).
8103
8104 @item y
8105 @kindex y (Server)
8106 @findex gnus-server-yank-server
8107 Yank the previously killed server (@code{gnus-server-yank-server}).
8108
8109 @item c
8110 @kindex c (Server)
8111 @findex gnus-server-copy-server
8112 Copy the current server (@code{gnus-server-copy-server}).
8113
8114 @item l
8115 @kindex l (Server)
8116 @findex gnus-server-list-servers
8117 List all servers (@code{gnus-server-list-servers}).
8118
8119 @item s
8120 @kindex s (Server)
8121 @findex gnus-server-scan-server
8122 Request that the server scan its sources for new articles
8123 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8124 servers. 
8125
8126 @item g
8127 @kindex g (Server)
8128 @findex gnus-server-regenerate-server
8129 Request that the server regenerate all its data structures
8130 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8131 a mail backend that has gotten out of synch.
8132
8133 @end table
8134
8135
8136 @node Example Methods
8137 @subsection Example Methods
8138
8139 Most select methods are pretty simple and self-explanatory: 
8140
8141 @lisp
8142 (nntp "news.funet.fi")
8143 @end lisp
8144
8145 Reading directly from the spool is even simpler:
8146
8147 @lisp
8148 (nnspool "")
8149 @end lisp
8150
8151 As you can see, the first element in a select method is the name of the
8152 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8153 will. 
8154
8155 After these two elements, there may be a arbitrary number of
8156 @var{(variable form)} pairs.
8157
8158 To go back to the first example---imagine that you want to read from
8159 port 15 from that machine.  This is what the select method should
8160 look like then:
8161
8162 @lisp
8163 (nntp "news.funet.fi" (nntp-port-number 15))
8164 @end lisp
8165
8166 You should read the documentation to each backend to find out what
8167 variables are relevant, but here's an @code{nnmh} example. 
8168
8169 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8170 you have two structures that you wish to access: One is your private
8171 mail spool, and the other is a public one.  Here's the possible spec for
8172 you private mail:
8173
8174 @lisp
8175 (nnmh "private" (nnmh-directory "~/private/mail/"))
8176 @end lisp
8177
8178 (This server is then called @samp{private}, but you may have guessed
8179 that.)
8180
8181 Here's the method for a public spool:
8182
8183 @lisp
8184 (nnmh "public" 
8185       (nnmh-directory "/usr/information/spool/") 
8186       (nnmh-get-new-mail nil))
8187 @end lisp
8188
8189 If you are behind a firewall and only have access to the @sc{nntp}
8190 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8191 on the firewall machine and telnet from there to the @sc{nntp} server.
8192 Doing this can be rather fiddly, but your virtual server definition
8193 should probably look something like this:
8194
8195 @lisp
8196 (nntp "firewall"
8197       (nntp-address "the.firewall.machine")
8198       (nntp-open-connection-function nntp-open-rlogin)
8199       (nntp-end-of-line "\n")
8200       (nntp-rlogin-parameters
8201        ("telnet" "the.real.nntp.host" "nntp")))
8202 @end lisp
8203
8204
8205
8206 @node Creating a Virtual Server
8207 @subsection Creating a Virtual Server
8208
8209 If you're saving lots of articles in the cache by using persistent
8210 articles, you may want to create a virtual server to read the cache.
8211
8212 First you need to add a new server.  The @kbd{a} command does that.  It
8213 would probably be best to use @code{nnspool} to read the cache.  You
8214 could also use @code{nnml} or @code{nnmh}, though.
8215
8216 Type @kbd{a nnspool RET cache RET}.
8217
8218 You should now have a brand new @code{nnspool} virtual server called
8219 @samp{cache}.  You now need to edit it to have the right definitions.
8220 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8221 will contain the following:
8222
8223 @lisp
8224 (nnspool "cache")
8225 @end lisp
8226
8227 Change that to:
8228
8229 @lisp
8230 (nnspool "cache"
8231          (nnspool-spool-directory "~/News/cache/")
8232          (nnspool-nov-directory "~/News/cache/")
8233          (nnspool-active-file "~/News/cache/active"))
8234 @end lisp
8235
8236 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8237 @kbd{RET} over this virtual server, you should be entered into a browse
8238 buffer, and you should be able to enter any of the groups displayed.
8239
8240
8241 @node Server Variables
8242 @subsection Server Variables
8243
8244 One sticky point when defining variables (both on backends and in Emacs
8245 in general) is that some variables are typically initialized from other
8246 variables when the definition of the variables is being loaded.  If you
8247 change the "base" variable after the variables have been loaded, you
8248 won't change the "derived" variables.
8249
8250 This typically affects directory and file variables.  For instance,
8251 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8252 directory variables are initialized from that variable, so
8253 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8254 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8255 @code{nnml-directory}---you have to explicitly set all the file
8256 variables to be what you want them to be.  For a complete list of
8257 variables for each backend, see each backend's section later in this
8258 manual, but here's an example @code{nnml} definition:
8259
8260 @lisp
8261 (nnml "public" 
8262       (nnml-directory "~/my-mail/")
8263       (nnml-active-file "~/my-mail/active")
8264       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8265 @end lisp
8266
8267
8268 @node Servers and Methods
8269 @subsection Servers and Methods
8270
8271 Wherever you would normally use a select method
8272 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8273 when browsing a foreign server) you can use a virtual server name
8274 instead.  This could potentially save lots of typing.  And it's nice all
8275 over.
8276
8277
8278 @node Unavailable Servers
8279 @subsection Unavailable Servers
8280
8281 If a server seems to be unreachable, Gnus will mark that server as
8282 @code{denied}.  That means that any subsequent attempt to make contact
8283 with that server will just be ignored.  ``It can't be opened,'' Gnus
8284 will tell you, without making the least effort to see whether that is
8285 actually the case or not.
8286
8287 That might seem quite naughty, but it does make sense most of the time.
8288 Let's say you have 10 groups subscribed to the server
8289 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8290 away from you and the machine is quite slow, so it takes 1 minute just
8291 to find out that it refuses connection from you today.  If Gnus were to
8292 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8293 attempt to do that.  Once it has gotten a single ``connection refused'',
8294 it will regard that server as ``down''.
8295
8296 So, what happens if the machine was only feeling unwell temporarily?
8297 How do you test to see whether the machine has come up again?
8298
8299 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8300 with the following commands:
8301
8302 @table @kbd
8303
8304 @item O
8305 @kindex O (Server)
8306 @findex gnus-server-open-server
8307 Try to establish connection to the server on the current line
8308 (@code{gnus-server-open-server}).
8309
8310 @item C
8311 @kindex C (Server)
8312 @findex gnus-server-close-server
8313 Close the connection (if any) to the server
8314 (@code{gnus-server-close-server}).
8315
8316 @item D
8317 @kindex D (Server)
8318 @findex gnus-server-deny-server
8319 Mark the current server as unreachable
8320 (@code{gnus-server-deny-server}). 
8321
8322 @item M-o
8323 @kindex M-o (Server)
8324 @findex gnus-server-open-all-servers
8325 Open the connections to all servers in the buffer
8326 (@code{gnus-server-open-all-servers}). 
8327
8328 @item M-c
8329 @kindex M-c (Server)
8330 @findex gnus-server-close-all-servers
8331 Close the connections to all servers in the buffer
8332 (@code{gnus-server-close-all-servers}). 
8333
8334 @item R
8335 @kindex R (Server)
8336 @findex gnus-server-remove-denials
8337 Remove all marks to whether Gnus was denied connection from all servers
8338 (@code{gnus-server-remove-denials}). 
8339
8340 @end table
8341
8342
8343 @node Getting News
8344 @section Getting News
8345 @cindex reading news
8346 @cindex news backends
8347
8348 A newsreader is normally used for reading news.  Gnus currently provides
8349 only two methods of getting news---it can read from an @sc{nntp} server,
8350 or it can read from a local spool.
8351
8352 @menu
8353 * NNTP::               Reading news from an @sc{nntp} server.
8354 * News Spool::         Reading news from the local spool.
8355 @end menu
8356
8357
8358 @node NNTP
8359 @subsection @sc{nntp}
8360 @cindex nntp
8361
8362 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8363 You just specify @code{nntp} as method and the address of the @sc{nntp}
8364 server as the, uhm, address.
8365
8366 If the @sc{nntp} server is located at a non-standard port, setting the
8367 third element of the select method to this port number should allow you
8368 to connect to the right port.  You'll have to edit the group info for
8369 that (@pxref{Foreign Groups}).
8370
8371 The name of the foreign group can be the same as a native group.  In
8372 fact, you can subscribe to the same group from as many different servers
8373 you feel like.  There will be no name collisions.
8374
8375 The following variables can be used to create a virtual @code{nntp}
8376 server: 
8377
8378 @table @code
8379
8380 @item nntp-server-opened-hook
8381 @vindex nntp-server-opened-hook
8382 @cindex @sc{mode reader}
8383 @cindex authinfo
8384 @cindex authentification
8385 @cindex nntp authentification
8386 @findex nntp-send-authinfo
8387 @findex nntp-send-mode-reader
8388 @code{nntp-server-opened-hook} is run after a connection has been made.
8389 It can be used to send commands to the @sc{nntp} server after it has
8390 been contacted.  By default is sends the command @code{MODE READER} to
8391 the server with the @code{nntp-send-mode-reader} function. 
8392
8393 @item nntp-authinfo-function 
8394 @vindex nntp-authinfo-function 
8395 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8396 server.  Available functions include:
8397
8398 @table @code
8399 @item nntp-send-authinfo
8400 @findex nntp-send-authinfo
8401 This function will used you current login name as the user name and will
8402 prompt you for the password.  This is the default.
8403
8404 @item nntp-send-nosy-authinfo
8405 @findex nntp-send-nosy-authinfo
8406 This function will prompt you for both user name and password.
8407
8408 @item nntp-send-authinfo-from-file
8409 @findex nntp-send-authinfo-from-file
8410 This function will use your current login name as the user name and will
8411 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8412 @end table
8413
8414 @item nntp-server-action-alist 
8415 @vindex nntp-server-action-alist 
8416 This is an list of regexps to match on server types and actions to be
8417 taken when matches are made.  For instance, if you want Gnus to beep
8418 every time you connect to innd, you could say something like:
8419
8420 @lisp
8421 (setq nntp-server-action-alist
8422       '(("innd" (ding))))
8423 @end lisp
8424
8425 You probably don't want to do that, though.
8426
8427 The default value is
8428
8429 @lisp
8430   '(("nntpd 1\\.5\\.11t" 
8431      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8432 @end lisp
8433
8434 This ensures that Gnus doesn't send the @code{MODE READER} command to
8435 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8436
8437 @item nntp-maximum-request
8438 @vindex nntp-maximum-request
8439 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8440 will collect headers by sending a series of @code{head} commands.  To
8441 speed things up, the backend sends lots of these commands without
8442 waiting for reply, and then reads all the replies.  This is controlled
8443 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8444 your network is buggy, you should set this to 1.
8445
8446 @item nntp-connection-timeout
8447 @vindex nntp-connection-timeout
8448 If you have lots of foreign @code{nntp} groups that you connect to
8449 regularly, you're sure to have problems with @sc{nntp} servers not
8450 responding properly, or being too loaded to reply within reasonable
8451 time.  This is can lead to awkward problems, which can be helped
8452 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8453 that says how many seconds the @code{nntp} backend should wait for a
8454 connection before giving up.  If it is @code{nil}, which is the default,
8455 no timeouts are done.
8456
8457 @item nntp-command-timeout
8458 @vindex nntp-command-timeout
8459 @cindex PPP connections
8460 @cindex dynamic IP addresses
8461 If you're running Gnus on a machine that has a dynamically assigned
8462 address, Gnus may become confused.  If the address of your machine
8463 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8464 waiting forever for replies from the server.  To help with this
8465 unfortunate problem, you can set this command to a number.  Gnus will
8466 then, if it sits waiting longer than that number of seconds for a reply
8467 from the server, shut down the connection, start a new one, and resend
8468 the command.  This should hopefully be transparent to the user.  A
8469 likely number is 30 seconds. 
8470
8471 @item nntp-retry-on-break
8472 @vindex nntp-retry-on-break
8473 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8474 hangs.  This will have much the same effect as the command timeout
8475 described above.
8476
8477 @item nntp-server-hook
8478 @vindex nntp-server-hook
8479 This hook is run as the last step when connecting to an @sc{nntp}
8480 server.
8481
8482 @findex nntp-open-rlogin
8483 @findex nntp-open-telnet
8484 @findex nntp-open-network-stream
8485 @item nntp-open-connection-function
8486 @vindex nntp-open-connection-function
8487 This function is used to connect to the remote system.  Three pre-made
8488 functions are @code{nntp-open-network-stream}, which is the default, and
8489 simply connects to some port or other on the remote system.  The other
8490 two are @code{nntp-open-rlogin}, which does an @samp{rlogin} on the
8491 remote system, and then does a @samp{telnet} to the @sc{nntp} server
8492 available there, and @code{nntp-open-telnet}, which does a @samp{telnet}
8493 to the remote system and then another @samp{telnet} to get to the
8494 @sc{nntp} server.
8495
8496 @code{nntp-open-rlogin}-related variables:
8497
8498 @table @code
8499
8500 @item nntp-rlogin-parameters
8501 @vindex nntp-rlogin-parameters
8502 This list will be used as the parameter list given to @code{rsh}.
8503
8504 @item nntp-rlogin-user-name
8505 @vindex nntp-rlogin-user-name
8506 User name on the remote system.
8507
8508 @end table
8509
8510 @code{nntp-open-telnet}-related variables:
8511
8512 @table @code
8513 @item nntp-telnet-command
8514 @vindex nntp-telnet-command
8515 Command used to start @samp{telnet}.
8516
8517 @item nntp-telnet-switches
8518 @vindex nntp-telnet-switches
8519 List of strings to be used as the switches to the telnet command.
8520
8521 @item nntp-telnet-user-name
8522 @vindex nntp-telnet-user-name
8523 User name to log in on the remote system as.
8524
8525 @item nntp-telnet-passwd
8526 @vindex nntp-telnet-passwd
8527 Password to use when logging in.
8528
8529 @item nntp-telnet-parameters
8530 @vindex nntp-telnet-parameters
8531 A list of strings that will be executed as a command after logging in
8532 via telnet.
8533
8534 @end table
8535
8536 @item nntp-end-of-line
8537 @vindex nntp-end-of-line
8538 String to use as end-of-line markers when talking to the @sc{nntp}
8539 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8540 using @code{rlogin} to talk to the server.
8541
8542 @item nntp-rlogin-user-name
8543 @vindex nntp-rlogin-user-name
8544 User name on the remote system when using the @code{rlogin} connect
8545 function. 
8546
8547 @item nntp-address
8548 @vindex nntp-address
8549 The address of the remote system running the @sc{nntp} server.
8550
8551 @item nntp-port-number
8552 @vindex nntp-port-number
8553 Port number to connect to when using the @code{nntp-open-network-stream}
8554 connect function.
8555
8556 @item nntp-buggy-select
8557 @vindex nntp-buggy-select
8558 Set this to non-@code{nil} if your select routine is buggy.
8559
8560 @item nntp-nov-is-evil 
8561 @vindex nntp-nov-is-evil 
8562 If the @sc{nntp} server does not support @sc{nov}, you could set this
8563 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8564 can be used automatically.
8565
8566 @item nntp-xover-commands
8567 @vindex nntp-xover-commands
8568 @cindex nov
8569 @cindex XOVER
8570 List of strings that are used as commands to fetch @sc{nov} lines from a
8571 server.  The default value of this variable is @code{("XOVER"
8572 "XOVERVIEW")}. 
8573
8574 @item nntp-nov-gap
8575 @vindex nntp-nov-gap
8576 @code{nntp} normally sends just one big request for @sc{nov} lines to
8577 the server.  The server responds with one huge list of lines.  However,
8578 if you have read articles 2-5000 in the group, and only want to read
8579 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8580 lines that you do not want, and will not use.  This variable says how
8581 big a gap between two consecutive articles is allowed to be before the
8582 @code{XOVER} request is split into several request.  Note that if your
8583 network is fast, setting this variable to a really small number means
8584 that fetching will probably be slower.  If this variable is @code{nil},
8585 @code{nntp} will never split requests.
8586
8587 @item nntp-prepare-server-hook
8588 @vindex nntp-prepare-server-hook
8589 A hook run before attempting to connect to an @sc{nntp} server.
8590
8591 @item nntp-warn-about-losing-connection
8592 @vindex nntp-warn-about-losing-connection
8593 If this variable is non-@code{nil}, some noise will be made when a
8594 server closes connection.
8595
8596 @end table
8597
8598
8599 @node News Spool
8600 @subsection News Spool
8601 @cindex nnspool
8602 @cindex news spool
8603
8604 Subscribing to a foreign group from the local spool is extremely easy,
8605 and might be useful, for instance, to speed up reading groups that
8606 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8607 instance. 
8608
8609 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8610 anything else) as the address.
8611
8612 If you have access to a local spool, you should probably use that as the
8613 native select method (@pxref{Finding the News}).  It is normally faster
8614 than using an @code{nntp} select method, but might not be.  It depends.
8615 You just have to try to find out what's best at your site.
8616
8617 @table @code
8618
8619 @item nnspool-inews-program
8620 @vindex nnspool-inews-program
8621 Program used to post an article.
8622
8623 @item nnspool-inews-switches
8624 @vindex nnspool-inews-switches
8625 Parameters given to the inews program when posting an article. 
8626
8627 @item nnspool-spool-directory
8628 @vindex nnspool-spool-directory
8629 Where @code{nnspool} looks for the articles.  This is normally
8630 @file{/usr/spool/news/}.
8631
8632 @item nnspool-nov-directory 
8633 @vindex nnspool-nov-directory 
8634 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8635 @file{/usr/spool/news/over.view/}.
8636
8637 @item nnspool-lib-dir
8638 @vindex nnspool-lib-dir
8639 Where the news lib dir is (@file{/usr/lib/news/} by default).
8640
8641 @item nnspool-active-file
8642 @vindex nnspool-active-file
8643 The path of the active file.
8644
8645 @item nnspool-newsgroups-file
8646 @vindex nnspool-newsgroups-file
8647 The path of the group descriptions file.
8648
8649 @item nnspool-history-file
8650 @vindex nnspool-history-file
8651 The path of the news history file.
8652
8653 @item nnspool-active-times-file
8654 @vindex nnspool-active-times-file
8655 The path of the active date file.
8656
8657 @item nnspool-nov-is-evil
8658 @vindex nnspool-nov-is-evil
8659 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8660 that it finds.
8661
8662 @item nnspool-sift-nov-with-sed
8663 @vindex nnspool-sift-nov-with-sed
8664 @cindex sed
8665 If non-@code{nil}, which is the default, use @code{sed} to get the
8666 relevant portion from the overview file.  If nil, @code{nnspool} will
8667 load the entire file into a buffer and process it there.
8668
8669 @end table
8670
8671
8672 @node Getting Mail
8673 @section Getting Mail
8674 @cindex reading mail
8675 @cindex mail
8676
8677 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8678 course.
8679
8680 @menu
8681 * Getting Started Reading Mail:: A simple cookbook example.
8682 * Splitting Mail::               How to create mail groups.
8683 * Mail Backend Variables::       Variables for customizing mail handling.
8684 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8685 * Mail and Procmail::            Reading mail groups that procmail create.
8686 * Incorporating Old Mail::       What about the old mail you have?
8687 * Expiring Mail::                Getting rid of unwanted mail.
8688 * Washing Mail::                 Removing gruft from the mail you get.
8689 * Duplicates::                   Dealing with duplicated mail.
8690 * Not Reading Mail::             Using mail backends for reading other files.
8691 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8692 @end menu
8693
8694
8695 @node Getting Started Reading Mail
8696 @subsection Getting Started Reading Mail
8697
8698 It's quite easy to use Gnus to read your new mail.  You just plonk the
8699 mail backend of your choice into @code{gnus-secondary-select-methods},
8700 and things will happen automatically.
8701
8702 For instance, if you want to use @code{nnml} (which is a one file per
8703 mail backend), you could put the following in your @file{.gnus} file:
8704
8705 @lisp
8706 (setq gnus-secondary-select-methods
8707       '((nnml "private")))
8708 @end lisp
8709
8710 Now, the next time you start Gnus, this backend will be queried for new
8711 articles, and it will move all the messages in your spool file to its
8712 directory, which is @code{~/Mail/} by default.  The new group that will
8713 be created (@samp{mail.misc}) will be subscribed, and you can read it
8714 like any other group.
8715
8716 You will probably want to split the mail into several groups, though:
8717
8718 @lisp
8719 (setq nnmail-split-methods
8720       '(("junk" "^From:.*Lars Ingebrigtsen")
8721        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8722        ("other" "")))
8723 @end lisp
8724
8725 This will result in three new @code{nnml} mail groups being created:
8726 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8727 mail that doesn't fit into the first two groups will be placed in the
8728 latter group.
8729
8730 This should be sufficient for reading mail with Gnus.  You might want to
8731 give the other sections in this part of the manual a perusal, though,
8732 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8733
8734
8735 @node Splitting Mail
8736 @subsection Splitting Mail
8737 @cindex splitting mail
8738 @cindex mail splitting
8739
8740 @vindex nnmail-split-methods
8741 The @code{nnmail-split-methods} variable says how the incoming mail is
8742 to be split into groups.
8743
8744 @lisp
8745 (setq nnmail-split-methods
8746   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8747     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8748     ("mail.other" "")))
8749 @end lisp
8750
8751 This variable is a list of lists, where the first element of each of
8752 these lists is the name of the mail group (they do not have to be called
8753 something beginning with @samp{mail}, by the way), and the second
8754 element is a regular expression used on the header of each mail to
8755 determine if it belongs in this mail group.
8756
8757 If the first element is the special symbol @code{junk}, then messages
8758 that match the regexp will disappear into the aether.  Use with
8759 extreme caution. 
8760
8761 The second element can also be a function.  In that case, it will be
8762 called narrowed to the headers with the first element of the rule as the
8763 argument.  It should return a non-@code{nil} value if it thinks that the
8764 mail belongs in that group.
8765
8766 The last of these groups should always be a general one, and the regular
8767 expression should @emph{always} be @samp{} so that it matches any mails
8768 that haven't been matched by any of the other regexps.  (These rules are
8769 processed from the beginning of the alist toward the end.  The first
8770 rule to make a match will "win", unless you have crossposting enabled.
8771 In that case, all matching rules will "win".)
8772
8773 If you like to tinker with this yourself, you can set this variable to a
8774 function of your choice.  This function will be called without any
8775 arguments in a buffer narrowed to the headers of an incoming mail
8776 message.  The function should return a list of groups names that it
8777 thinks should carry this mail message.
8778
8779 Note that the mail backends are free to maul the poor, innocent
8780 incoming headers all they want to.  They all add @code{Lines} headers;
8781 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8782 @code{From<SPACE>} line to something else.
8783
8784 @vindex nnmail-crosspost
8785 The mail backends all support cross-posting.  If several regexps match,
8786 the mail will be ``cross-posted'' to all those groups.
8787 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8788 that no articles are crossposted to the general (@samp{}) group.
8789
8790 @vindex nnmail-crosspost-link-function
8791 @cindex crosspost
8792 @cindex links
8793 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8794 the crossposted articles.  However, not all files systems support hard
8795 links.  If that's the case for you, set
8796 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8797 variable is @code{add-name-to-file} by default.)  
8798
8799 @kindex M-x nnmail-split-history
8800 @kindex nnmail-split-history
8801 If you wish to see where the previous mail split put the messages, you
8802 can use the @kbd{M-x nnmail-split-history} command.
8803
8804 Gnus gives you all the opportunity you could possibly want for shooting
8805 yourself in the foot.  Let's say you create a group that will contain
8806 all the mail you get from your boss.  And then you accidentally
8807 unsubscribe from the group.  Gnus will still put all the mail from your
8808 boss in the unsubscribed group, and so, when your boss mails you ``Have
8809 that report ready by Monday or you're fired!'', you'll never see it and,
8810 come Tuesday, you'll still believe that you're gainfully employed while
8811 you really should be out collecting empty bottles to save up for next
8812 month's rent money.
8813
8814
8815 @node Mail Backend Variables
8816 @subsection Mail Backend Variables
8817
8818 These variables are (for the most part) pertinent to all the various
8819 mail backends.
8820
8821 @table @code
8822 @vindex nnmail-read-incoming-hook
8823 @item nnmail-read-incoming-hook
8824 The mail backends all call this hook after reading new mail.  You can
8825 use this hook to notify any mail watch programs, if you want to.
8826
8827 @vindex nnmail-spool-file
8828 @item nnmail-spool-file
8829 @cindex POP mail
8830 @cindex MAILHOST
8831 @cindex movemail
8832 @vindex nnmail-pop-password
8833 @vindex nnmail-pop-password-required
8834 The backends will look for new mail in this file.  If this variable is
8835 @code{nil}, the mail backends will never attempt to fetch mail by
8836 themselves.  If you are using a POP mail server and your name is
8837 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8838 your name is not @samp{larsi}, you should probably modify that
8839 slightly, but you may have guessed that already, you smart & handsome
8840 devil!  You can also set this variable to @code{pop}, and Gnus will try
8841 to figure out the POP mail string by itself.  In any case, Gnus will
8842 call @code{movemail} which will contact the POP server named in the
8843 @code{MAILHOST} environment variable.  If the POP server needs a
8844 password, you can either set @code{nnmail-pop-password-required} to
8845 @code{t} and be prompted for the password, or set
8846 @code{nnmail-pop-password} to the password itself.
8847
8848 @code{nnmail-spool-file} can also be a list of mailboxes.
8849
8850 Your Emacs has to have been configured with @samp{--with-pop} before
8851 compilation.  This is the default, but some installations have it
8852 switched off.
8853
8854 When you use a mail backend, Gnus will slurp all your mail from your
8855 inbox and plonk it down in your home directory.  Gnus doesn't move any
8856 mail if you're not using a mail backend---you have to do a lot of magic
8857 invocations first.  At the time when you have finished drawing the
8858 pentagram, lightened the candles, and sacrificed the goat, you really
8859 shouldn't be too surprised when Gnus moves your mail.
8860
8861 @vindex nnmail-use-procmail
8862 @vindex nnmail-procmail-suffix
8863 @item nnmail-use-procmail
8864 If non-@code{nil}, the mail backends will look in
8865 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8866 that directory that have names ending in @code{nnmail-procmail-suffix}
8867 will be considered incoming mailboxes, and will be searched for new
8868 mail.
8869
8870 @vindex nnmail-crash-box
8871 @item nnmail-crash-box
8872 When the mail backends read a spool file, it is first moved to this
8873 file, which is @file{~/.gnus-crash-box} by default.  If this file
8874 already exists, it will always be read (and incorporated) before any
8875 other spool files.
8876
8877 @vindex nnmail-prepare-incoming-hook
8878 @item nnmail-prepare-incoming-hook
8879 This is run in a buffer that holds all the new incoming mail, and can be
8880 used for, well, anything, really.
8881
8882 @vindex nnmail-split-hook
8883 @item nnmail-split-hook
8884 @findex article-decode-rfc1522
8885 @findex RFC1522 decoding
8886 Hook run in the buffer where the mail headers of each message is kept
8887 just before the splitting based on these headers is done.  The hook is
8888 free to modify the buffer contents in any way it sees fit---the buffer
8889 is discarded after the splitting has been done, and no changes performed
8890 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
8891 is one likely function to add to this hook.
8892
8893 @vindex nnmail-pre-get-new-mail-hook
8894 @vindex nnmail-post-get-new-mail-hook
8895 @item nnmail-pre-get-new-mail-hook
8896 @itemx nnmail-post-get-new-mail-hook
8897 These are two useful hooks executed when treating new incoming
8898 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8899 starting to handle the new mail) and
8900 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8901 is done).  Here's and example of using these two hooks to change the
8902 default file modes the new mail files get:
8903
8904 @lisp
8905 (add-hook 'gnus-pre-get-new-mail-hook 
8906           (lambda () (set-default-file-modes 511)))
8907
8908 (add-hook 'gnus-post-get-new-mail-hook 
8909           (lambda () (set-default-file-modes 551)))
8910 @end lisp
8911
8912 @item nnmail-tmp-directory
8913 @vindex nnmail-tmp-directory
8914 This variable says where to move the incoming mail to while processing
8915 it.  This is usually done in the same directory that the mail backend
8916 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8917 it will be used instead.
8918
8919 @item nnmail-movemail-program
8920 @vindex nnmail-movemail-program
8921 This program is executed to move mail from the user's inbox to her home
8922 directory.  The default is @samp{movemail}.
8923
8924 This can also be a function.  In that case, the function will be called
8925 with two parameters -- the name of the inbox, and the file to be moved
8926 to.
8927
8928 @item nnmail-delete-incoming
8929 @vindex nnmail-delete-incoming
8930 @cindex incoming mail files
8931 @cindex deleting incoming files
8932 If non-@code{nil}, the mail backends will delete the temporary incoming
8933 file after splitting mail into the proper groups.  This is @code{t} by
8934 default.
8935
8936 @c This is @code{nil} by
8937 @c default for reasons of security.
8938
8939 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8940 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8941 lost mail, I think, but that's not the point.  (Except certain versions
8942 of Red Gnus.))  By not deleting the Incoming* files, one can be sure to
8943 not lose mail -- if Gnus totally whacks out, one can always recover what
8944 was lost.
8945
8946 Delete the @file{Incoming*} files at will.
8947
8948 @item nnmail-use-long-file-names
8949 @vindex nnmail-use-long-file-names
8950 If non-@code{nil}, the mail backends will use long file and directory
8951 names.  Groups like @samp{mail.misc} will end up in directories like
8952 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8953 @file{mail/misc/}.
8954
8955 @item nnmail-delete-file-function
8956 @vindex nnmail-delete-file-function
8957 @findex delete-file
8958 Function called to delete files.  It is @code{delete-file} by default. 
8959
8960 @item nnmail-cache-accepted-message-ids
8961 @vindex nnmail-cache-accepted-message-ids
8962 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
8963 the backend (via @code{Gcc}, for instance) into the mail duplication
8964 discovery cache.  The default is @code{nil}.
8965
8966 @end table
8967
8968
8969 @node Fancy Mail Splitting
8970 @subsection Fancy Mail Splitting
8971 @cindex mail splitting
8972 @cindex fancy mail splitting
8973
8974 @vindex nnmail-split-fancy
8975 @findex nnmail-split-fancy
8976 If the rather simple, standard method for specifying how to split mail
8977 doesn't allow you to do what you want, you can set
8978 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8979 play with the @code{nnmail-split-fancy} variable.
8980
8981 Let's look at an example value of this variable first:
8982
8983 @lisp
8984 ;; Messages from the mailer daemon are not crossposted to any of
8985 ;; the ordinary groups.  Warnings are put in a separate group
8986 ;; from real errors.
8987 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8988                    "mail.misc"))
8989    ;; Non-error messages are crossposted to all relevant
8990    ;; groups, but we don't crosspost between the group for the
8991    ;; (ding) list and the group for other (ding) related mail.
8992    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8993          ("subject" "ding" "ding.misc"))
8994       ;; Other mailing lists...
8995       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8996       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8997       ;; People...
8998       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
8999    ;; Unmatched mail goes to the catch all group.
9000    "misc.misc")
9001 @end lisp
9002
9003 This variable has the format of a @dfn{split}.  A split is a (possibly)
9004 recursive structure where each split may contain other splits.  Here are
9005 the five possible split syntaxes:
9006
9007 @enumerate
9008
9009 @item 
9010 @samp{group}: If the split is a string, that will be taken as a group name. 
9011
9012 @item
9013 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
9014 element is a string, then that means that if header FIELD (a regexp)
9015 contains VALUE (also a regexp), then store the message as specified by
9016 SPLIT.
9017
9018 @item
9019 @var{(| SPLIT...)}: If the split is a list, and the first element is
9020 @code{|} (vertical bar), then process each SPLIT until one of them
9021 matches.  A SPLIT is said to match if it will cause the mail message to
9022 be stored in one or more groups.
9023
9024 @item
9025 @var{(& SPLIT...)}: If the split is a list, and the first element is
9026 @code{&}, then process all SPLITs in the list.
9027
9028 @item 
9029 @code{junk}: If the split is the symbol @code{junk}, then don't save
9030 this message anywhere.
9031
9032 @item
9033 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
9034 element is @code{:}, then the second element will be called as a
9035 function with @var{args} given as arguments.  The function should return
9036 a SPLIT.
9037
9038 @end enumerate
9039
9040 In these splits, @var{FIELD} must match a complete field name.
9041 @var{VALUE} must match a complete word according to the fundamental mode
9042 syntax table.  You can use @code{.*} in the regexps to match partial
9043 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9044 @samp{\<} and @samp{\>} pairs.
9045
9046 @vindex nnmail-split-abbrev-alist
9047 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9048 are expanded as specified by the variable
9049 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9050 the car of the cells contains the key, and the cdr contains a string.
9051
9052 @vindex nnmail-split-fancy-syntax-table
9053 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9054 when all this splitting is performed.
9055
9056 If you want to have Gnus create groups dynamically based on some
9057 information in the headers, you can say things like:
9058
9059 @example
9060 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
9061 @end example
9062
9063 That is, do @code{replace-match}-like substitions in the group names. 
9064
9065
9066 @node Mail and Procmail
9067 @subsection Mail and Procmail
9068 @cindex procmail
9069
9070 @cindex slocal
9071 @cindex elm
9072 Many people use @code{procmail} (or some other mail filter program or
9073 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9074 incoming mail into groups.  If you do that, you should set
9075 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9076 backends never ever try to fetch mail by themselves.
9077
9078 This also means that you probably don't want to set
9079 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9080 side effects.
9081
9082 When a mail backend is queried for what groups it carries, it replies
9083 with the contents of that variable, along with any groups it has figured
9084 out that it carries by other means.  None of the backends (except
9085 @code{nnmh}) actually go out to the disk and check what groups actually
9086 exist.  (It's not trivial to distinguish between what the user thinks is
9087 a basis for a newsgroup and what is just a plain old file or directory.)
9088
9089 This means that you have to tell Gnus (and the backends) what groups
9090 exist by hand.
9091
9092 Let's take the @code{nnmh} backend as an example. 
9093
9094 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9095 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9096
9097 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9098 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9099 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9100 to include all your mail groups.
9101
9102 That's it.  You are now set to read your mail.  An active file for this
9103 method will be created automatically.
9104
9105 @vindex nnmail-procmail-suffix
9106 @vindex nnmail-procmail-directory
9107 If you use @code{nnfolder} or any other backend that store more than a
9108 single article in each file, you should never have procmail add mails to
9109 the file that Gnus sees.  Instead, procmail should put all incoming mail
9110 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9111 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9112 name.  The mail backends will read the mail from these files.
9113
9114 @vindex nnmail-resplit-incoming
9115 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9116 put in the @code{mail.misc}, as one would expect.  However, if you want
9117 Gnus to split the mail the normal way, you could set
9118 @code{nnmail-resplit-incoming} to @code{t}.
9119
9120 @vindex nnmail-keep-last-article
9121 If you use @code{procmail} to split things directory into an @code{nnmh}
9122 directory (which you shouldn't do), you should set
9123 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9124 ever expiring the final article (i. e., the article with the highest
9125 article number) in a mail newsgroup.  This is quite, quite important.
9126
9127 Here's an example setup:  The incoming spools are located in
9128 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
9129 spool files have the same names as the equivalent groups).  The
9130 @code{nnfolder} backend is to be used as the mail interface, and the
9131 @code{nnfolder} directory is @file{~/fMail/}.
9132
9133 @lisp
9134 (setq nnfolder-directory "~/fMail/")
9135 (setq nnmail-spool-file 'procmail)
9136 (setq nnmail-procmail-directory "~/incoming/")
9137 (setq gnus-secondary-select-methods '((nnfolder "")))
9138 (setq nnmail-procmail-suffix "")
9139 @end lisp
9140
9141
9142 @node Incorporating Old Mail
9143 @subsection Incorporating Old Mail
9144
9145 Most people have lots of old mail stored in various file formats.  If
9146 you have set up Gnus to read mail using one of the spiffy Gnus mail
9147 backends, you'll probably wish to have that old mail incorporated into
9148 your mail groups.
9149
9150 Doing so can be quite easy.
9151
9152 To take an example: You're reading mail using @code{nnml}
9153 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9154 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9155 file filled with important, but old, mail.  You want to move it into
9156 your @code{nnml} groups.
9157
9158 Here's how:
9159
9160 @enumerate
9161 @item
9162 Go to the group buffer.
9163
9164 @item 
9165 Type `G f' and give the path of the mbox file when prompted to create an
9166 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9167
9168 @item 
9169 Type `SPACE' to enter the newly created group.
9170
9171 @item
9172 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9173 Process Marks}).
9174
9175 @item 
9176 Type `B r' to respool all the process-marked articles, and answer
9177 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9178 @end enumerate
9179
9180 All the mail messages in the mbox file will now also be spread out over
9181 all your @code{nnml} groups.  Try entering them and check whether things
9182 have gone without a glitch.  If things look ok, you may consider
9183 deleting the mbox file, but I wouldn't do that unless I was absolutely
9184 sure that all the mail has ended up where it should be.
9185
9186 Respooling is also a handy thing to do if you're switching from one mail
9187 backend to another.  Just respool all the mail in the old mail groups
9188 using the new mail backend.
9189
9190
9191 @node Expiring Mail
9192 @subsection Expiring Mail
9193 @cindex article expiry
9194
9195 Traditional mail readers have a tendency to remove mail articles when
9196 you mark them as read, in some way.  Gnus takes a fundamentally
9197 different approach to mail reading.
9198
9199 Gnus basically considers mail just to be news that has been received in
9200 a rather peculiar manner.  It does not think that it has the power to
9201 actually change the mail, or delete any mail messages.  If you enter a
9202 mail group, and mark articles as ``read'', or kill them in some other
9203 fashion, the mail articles will still exist on the system.  I repeat:
9204 Gnus will not delete your old, read mail.  Unless you ask it to, of
9205 course.
9206
9207 To make Gnus get rid of your unwanted mail, you have to mark the
9208 articles as @dfn{expirable}.  This does not mean that the articles will
9209 disappear right away, however.  In general, a mail article will be
9210 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9211 more than one week old.  If you do not mark an article as expirable, it
9212 will remain on your system until hell freezes over.  This bears
9213 repeating one more time, with some spurious capitalizations: IF you do
9214 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9215
9216 @vindex gnus-auto-expirable-newsgroups
9217 You do not have to mark articles as expirable by hand.  Groups that
9218 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9219 have all articles that you read marked as expirable automatically.  All
9220 articles that are marked as expirable have an @samp{E} in the first
9221 column in the summary buffer.
9222
9223 By default, if you have auto expiry switched on, Gnus will mark all the
9224 articles you read as expirable, no matter if they were read or unread
9225 before.  To avoid having articles marked as read marked as expirable
9226 automatically, you can put something like the following in your
9227 @file{.gnus} file:
9228
9229 @vindex gnus-mark-article-hook
9230 @lisp
9231 (remove-hook 'gnus-mark-article-hook                                
9232              'gnus-summary-mark-read-and-unread-as-read)            
9233 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9234 @end lisp
9235
9236 Note that making a group auto-expirable don't mean that all read
9237 articles are expired---only the articles that are marked as expirable
9238 will be expired.  Also note the using the @kbd{d} command won't make
9239 groups expirable---only semi-automatic marking of articles as read will
9240 mark the articles as expirable in auto-expirable groups.
9241
9242 Let's say you subscribe to a couple of mailing lists, and you want the
9243 articles you have read to disappear after a while:
9244
9245 @lisp
9246 (setq gnus-auto-expirable-newsgroups 
9247       "mail.nonsense-list\\|mail.nice-list")
9248 @end lisp
9249
9250 Another way to have auto-expiry happen is to have the element
9251 @code{auto-expire} in the group parameters of the group. 
9252
9253 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9254 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9255 doesn't really mix very well.  
9256
9257 @vindex nnmail-expiry-wait
9258 The @code{nnmail-expiry-wait} variable supplies the default time an
9259 expirable article has to live.  Gnus starts counting days from when the
9260 message @emph{arrived}, not from when it was sent.  The default is seven
9261 days.
9262
9263 Gnus also supplies a function that lets you fine-tune how long articles
9264 are to live, based on what group they are in.  Let's say you want to
9265 have one month expiry period in the @samp{mail.private} group, a one day
9266 expiry period in the @samp{mail.junk} group, and a six day expiry period
9267 everywhere else:
9268
9269 @vindex nnmail-expiry-wait-function
9270 @lisp
9271 (setq nnmail-expiry-wait-function
9272       (lambda (group)
9273        (cond ((string= group "mail.private")
9274                31)
9275              ((string= group "mail.junk")
9276                1)
9277              ((string= group "important")
9278                'never)
9279              (t
9280                6))))
9281 @end lisp
9282
9283 The group names that this function is fed are ``unadorned'' group
9284 names---no @samp{nnml:} prefixes and the like.
9285
9286 The @code{nnmail-expiry-wait} variable and
9287 @code{nnmail-expiry-wait-function} function can be either a number (not
9288 necessarily an integer) or the symbols @code{immediate} or
9289 @code{never}.  
9290
9291 You can also use the @code{expiry-wait} group parameter to selectively
9292 change the expiry period (@pxref{Group Parameters}).
9293
9294 @vindex nnmail-keep-last-article
9295 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9296 expire the final article in a mail newsgroup.  This is to make life
9297 easier for procmail users.
9298
9299 @vindex gnus-total-expirable-newsgroups
9300 By the way, that line up there about Gnus never expiring non-expirable
9301 articles is a lie.  If you put @code{total-expire} in the group
9302 parameters, articles will not be marked as expirable, but all read
9303 articles will be put through the expiry process.  Use with extreme
9304 caution.  Even more dangerous is the
9305 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9306 this regexp will have all read articles put through the expiry process,
9307 which means that @emph{all} old mail articles in the groups in question
9308 will be deleted after a while.  Use with extreme caution, and don't come
9309 crying to me when you discover that the regexp you used matched the
9310 wrong group and all your important mail has disappeared.  Be a
9311 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9312 with!  So there!
9313
9314 Most people make most of their mail groups total-expirable, though. 
9315
9316
9317 @node Washing Mail
9318 @subsection Washing Mail
9319 @cindex mail washing
9320 @cindex list server brain damage
9321 @cindex incoming mail treatment
9322
9323 Mailers and list servers are notorious for doing all sorts of really,
9324 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9325 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9326 end of all lines passing through our server, so let's do that!!!!1!''
9327 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9328 considered to be self-evident were not discussed.  So.  Here we are.
9329
9330 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9331 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9332 be shocked and dismayed by this, but I haven't got the energy.  It is to
9333 laugh.
9334
9335 Gnus provides a plethora of functions for washing articles while
9336 displaying them, but it might be nicer to do the filtering before
9337 storing the mail to disc.  For that purpose, we have three hooks and
9338 various functions that can be put in these hooks.
9339
9340 @table @code
9341 @item nnmail-prepare-incoming-hook
9342 @vindex nnmail-prepare-incoming-hook
9343 This hook is called before doing anything with the mail and is meant for
9344 grand, sweeping gestures.  Functions to be used include:
9345
9346 @table @code
9347 @item nnheader-ms-strip-cr
9348 @findex nnheader-ms-strip-cr
9349 Remove trailing carriage returns from each line.  This is default on
9350 Emacs running on MS machines.
9351
9352 @end table
9353
9354 @item nnmail-prepare-incoming-header-hook
9355 @vindex nnmail-prepare-incoming-header-hook
9356 This hook is called narrowed to each header.  It can be used when
9357 cleaning up the headers.  Functions that can be used include:
9358
9359 @table @code
9360 @item nnmail-remove-leading-whitespace
9361 @findex nnmail-remove-leading-whitespace
9362 Clear leading white space that ``helpful'' listservs have added to the
9363 headers too make them look nice.  Aaah.  
9364
9365 @item nnmail-remove-list-identifiers
9366 @findex nnmail-remove-list-identifiers
9367 Some list servers add an identifier---for example, @samp{(idm)}---to the
9368 beginning of all @code{Subject} headers.  I'm sure that's nice for
9369 people who use stone age mail readers.  This function will remove
9370 strings that match the @code{nnmail-list-identifiers} regexp, which can
9371 also be a list of regexp.
9372
9373 For instance, if you want to remove the @samp{(idm)} and the
9374 @samp{nagnagnag} identifiers:
9375
9376 @lisp
9377 (setq nnmail-list-identifiers
9378       '("(idm)" "nagnagnag"))
9379 @end lisp
9380
9381 @item nnmail-remove-tabs
9382 @findex nnmail-remove-tabs
9383 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9384
9385 @end table
9386
9387 @item nnmail-prepare-incoming-message-hook
9388 @vindex nnmail-prepare-incoming-message-hook
9389 This hook is called narrowed to each message.  Functions to be used
9390 include: 
9391
9392 @table @code
9393 @item article-de-quoted-unreadable
9394 @findex article-de-quoted-unreadable
9395 Decode Quoted Readable encoding.
9396
9397 @end table
9398 @end table
9399
9400
9401 @node Duplicates
9402 @subsection Duplicates
9403
9404 @vindex nnmail-treat-duplicates
9405 @vindex nnmail-message-id-cache-length
9406 @vindex nnmail-message-id-cache-file
9407 @cindex duplicate mails
9408 If you are a member of a couple of mailing list, you will sometime
9409 receive two copies of the same mail.  This can be quite annoying, so
9410 @code{nnmail} checks for and treats any duplicates it might find.  To do
9411 this, it keeps a cache of old @code{Message-ID}s---
9412 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9413 default.  The approximate maximum number of @code{Message-ID}s stored
9414 there is controlled by the @code{nnmail-message-id-cache-length}
9415 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9416 stored.) If all this sounds scary to you, you can set
9417 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9418 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9419 will insert a warning into the head of the mail saying that it thinks
9420 that this is a duplicate of a different message.
9421
9422 This variable can also be a function.  If that's the case, the function
9423 will be called from a buffer narrowed to the message in question with
9424 the @code{Message-ID} as a parameter.  The function must return either
9425 @code{nil}, @code{warn}, or @code{delete}.
9426
9427 You can turn this feature off completely by setting the variable to
9428 @code{nil}.
9429
9430 If you want all the duplicate mails to be put into a special
9431 @dfn{duplicates} group, you could do that using the normal mail split
9432 methods:
9433
9434 @lisp
9435 (setq nnmail-split-fancy
9436       '(| ;; Messages duplicates go to a separate group.
9437           ("gnus-warning" "duplication of message" "duplicate")
9438           ;; Message from daemons, postmaster, and the like to another.
9439           (any mail "mail.misc")
9440           ;; Other rules.
9441           [ ... ] ))
9442 @end lisp
9443
9444 Or something like:
9445 @lisp
9446 (setq nnmail-split-methods 
9447       '(("duplicates" "^Gnus-Warning:")
9448         ;; Other rules.
9449         [...]))
9450 @end lisp
9451
9452 Here's a neat feature: If you know that the recipient reads her mail
9453 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9454 @code{delete}, you can send her as many insults as you like, just by
9455 using a @code{Message-ID} of a mail that you know that she's already
9456 received.  Think of all the fun!  She'll never see any of it!  Whee!
9457
9458
9459 @node Not Reading Mail
9460 @subsection Not Reading Mail
9461
9462 If you start using any of the mail backends, they have the annoying
9463 habit of assuming that you want to read mail with them.  This might not
9464 be unreasonable, but it might not be what you want.
9465
9466 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9467 will ever attempt to read incoming mail, which should help.
9468
9469 @vindex nnbabyl-get-new-mail
9470 @vindex nnmbox-get-new-mail
9471 @vindex nnml-get-new-mail
9472 @vindex nnmh-get-new-mail
9473 @vindex nnfolder-get-new-mail
9474 This might be too much, if, for instance, you are reading mail quite
9475 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9476 file you have stashed away with @code{nnbabyl}.  All backends have
9477 variables called backend-@code{get-new-mail}.  If you want to disable
9478 the @code{nnbabyl} mail reading, you edit the virtual server for the
9479 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9480
9481 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9482 narrowed to the article to be saved before saving it when reading
9483 incoming mail.
9484
9485
9486 @node Choosing a Mail Backend
9487 @subsection Choosing a Mail Backend
9488
9489 Gnus will read the mail spool when you activate a mail group.  The mail
9490 file is first copied to your home directory.  What happens after that
9491 depends on what format you want to store your mail in.
9492
9493 @menu
9494 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9495 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9496 * Mail Spool::                  Store your mail in a private spool?
9497 * MH Spool::                    An mhspool-like backend.
9498 * Mail Folders::                Having one file for each group.
9499 @end menu
9500
9501
9502 @node Unix Mail Box
9503 @subsubsection Unix Mail Box
9504 @cindex nnmbox
9505 @cindex unix mail box
9506
9507 @vindex nnmbox-active-file
9508 @vindex nnmbox-mbox-file
9509 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9510 mail.  @code{nnmbox} will add extra headers to each mail article to say
9511 which group it belongs in.
9512
9513 Virtual server settings:
9514
9515 @table @code
9516 @item nnmbox-mbox-file
9517 @vindex nnmbox-mbox-file
9518 The name of the mail box in the user's home directory. 
9519
9520 @item nnmbox-active-file
9521 @vindex nnmbox-active-file
9522 The name of the active file for the mail box.
9523
9524 @item nnmbox-get-new-mail
9525 @vindex nnmbox-get-new-mail
9526 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9527 into groups.
9528 @end table
9529
9530
9531 @node Rmail Babyl
9532 @subsubsection Rmail Babyl
9533 @cindex nnbabyl
9534 @cindex rmail mbox
9535
9536 @vindex nnbabyl-active-file
9537 @vindex nnbabyl-mbox-file
9538 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9539 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9540 article to say which group it belongs in.
9541
9542 Virtual server settings:
9543
9544 @table @code
9545 @item nnbabyl-mbox-file
9546 @vindex nnbabyl-mbox-file
9547 The name of the rmail mbox file.
9548
9549 @item nnbabyl-active-file
9550 @vindex nnbabyl-active-file
9551 The name of the active file for the rmail box.
9552
9553 @item nnbabyl-get-new-mail
9554 @vindex nnbabyl-get-new-mail
9555 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9556 @end table
9557
9558
9559 @node Mail Spool
9560 @subsubsection Mail Spool
9561 @cindex nnml
9562 @cindex mail @sc{nov} spool
9563
9564 The @dfn{nnml} spool mail format isn't compatible with any other known
9565 format.  It should be used with some caution.
9566
9567 @vindex nnml-directory
9568 If you use this backend, Gnus will split all incoming mail into files;
9569 one file for each mail, and put the articles into the correct
9570 directories under the directory specified by the @code{nnml-directory}
9571 variable.  The default value is @file{~/Mail/}.
9572
9573 You do not have to create any directories beforehand; Gnus will take
9574 care of all that.
9575
9576 If you have a strict limit as to how many files you are allowed to store
9577 in your account, you should not use this backend.  As each mail gets its
9578 own file, you might very well occupy thousands of inodes within a few
9579 weeks.  If this is no problem for you, and it isn't a problem for you
9580 having your friendly systems administrator walking around, madly,
9581 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9582 know that this is probably the fastest format to use.  You do not have
9583 to trudge through a big mbox file just to read your new mail.
9584
9585 @code{nnml} is probably the slowest backend when it comes to article
9586 splitting.  It has to create lots of files, and it also generates
9587 @sc{nov} databases for the incoming mails.  This makes is the fastest
9588 backend when it comes to reading mail.
9589
9590 Virtual server settings:
9591
9592 @table @code
9593 @item nnml-directory
9594 @vindex nnml-directory
9595 All @code{nnml} directories will be placed under this directory. 
9596
9597 @item nnml-active-file
9598 @vindex nnml-active-file
9599 The active file for the @code{nnml} server.
9600
9601 @item nnml-newsgroups-file
9602 @vindex nnml-newsgroups-file
9603 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9604 Format}. 
9605
9606 @item nnml-get-new-mail
9607 @vindex nnml-get-new-mail
9608 If non-@code{nil}, @code{nnml} will read incoming mail.
9609
9610 @item nnml-nov-is-evil
9611 @vindex nnml-nov-is-evil
9612 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9613
9614 @item nnml-nov-file-name
9615 @vindex nnml-nov-file-name
9616 The name of the @sc{nov} files.  The default is @file{.overview}. 
9617
9618 @item nnml-prepare-save-mail-hook
9619 @vindex nnml-prepare-save-mail-hook
9620 Hook run narrowed to an article before saving.
9621
9622 @end table
9623
9624 @findex nnml-generate-nov-databases
9625 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9626 you can do a complete update by typing @kbd{M-x
9627 nnml-generate-nov-databases}.  This command will trawl through the
9628 entire @code{nnml} hierarchy, looking at each and every article, so it
9629 might take a while to complete.  A better interface to this
9630 functionality can be found in the server buffer (@pxref{Server
9631 Commands}). 
9632
9633
9634 @node MH Spool
9635 @subsubsection MH Spool
9636 @cindex nnmh
9637 @cindex mh-e mail spool
9638
9639 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9640 @sc{nov} databases and it doesn't keep an active file.  This makes
9641 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9642 makes it easier to write procmail scripts for.
9643
9644 Virtual server settings:
9645
9646 @table @code
9647 @item nnmh-directory
9648 @vindex nnmh-directory
9649 All @code{nnmh} directories will be located under this directory.
9650
9651 @item nnmh-get-new-mail
9652 @vindex nnmh-get-new-mail
9653 If non-@code{nil}, @code{nnmh} will read incoming mail.
9654
9655 @item nnmh-be-safe
9656 @vindex nnmh-be-safe
9657 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9658 sure that the articles in the folder are actually what Gnus thinks they
9659 are.  It will check date stamps and stat everything in sight, so
9660 setting this to @code{t} will mean a serious slow-down.  If you never
9661 use anything but Gnus to read the @code{nnmh} articles, you do not have
9662 to set this variable to @code{t}.
9663 @end table
9664
9665
9666 @node Mail Folders
9667 @subsubsection Mail Folders
9668 @cindex nnfolder
9669 @cindex mbox folders
9670 @cindex mail folders
9671
9672 @code{nnfolder} is a backend for storing each mail group in a separate
9673 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9674 will add extra headers to keep track of article numbers and arrival
9675 dates.
9676
9677 Virtual server settings:
9678
9679 @table @code
9680 @item nnfolder-directory
9681 @vindex nnfolder-directory
9682 All the @code{nnfolder} mail boxes will be stored under this directory. 
9683
9684 @item nnfolder-active-file
9685 @vindex nnfolder-active-file
9686 The name of the active file.
9687
9688 @item nnfolder-newsgroups-file
9689 @vindex nnfolder-newsgroups-file
9690 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9691
9692 @item nnfolder-get-new-mail
9693 @vindex nnfolder-get-new-mail
9694 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9695 @end table
9696
9697 @findex nnfolder-generate-active-file
9698 @kindex M-x nnfolder-generate-active-file
9699 If you have lots of @code{nnfolder}-like files you'd like to read with
9700 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9701 command to make @code{nnfolder} aware of all likely files in
9702 @code{nnfolder-directory}.
9703
9704
9705 @node Other Sources
9706 @section Other Sources
9707
9708 Gnus can do more than just read news or mail.  The methods described
9709 below allow Gnus to view directories and files as if they were
9710 newsgroups.
9711
9712 @menu
9713 * Directory Groups::      You can read a directory as if it was a newsgroup.
9714 * Anything Groups::       Dired?  Who needs dired?
9715 * Document Groups::       Single files can be the basis of a group.
9716 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9717 * Web Searches::          Creating groups from articles that match a string.
9718 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9719 @end menu
9720
9721
9722 @node Directory Groups
9723 @subsection Directory Groups
9724 @cindex nndir
9725 @cindex directory groups
9726
9727 If you have a directory that has lots of articles in separate files in
9728 it, you might treat it as a newsgroup.  The files have to have numerical
9729 names, of course.
9730
9731 This might be an opportune moment to mention @code{ange-ftp}, that most
9732 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9733 didn't think much about it---a backend to read directories.  Big deal.
9734
9735 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9736 enter the @code{ange-ftp} file name
9737 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9738 @code{ange-ftp} will actually allow you to read this directory over at
9739 @samp{sina} as a newsgroup.  Distributed news ahoy!
9740
9741 @code{nndir} will use @sc{nov} files if they are present.
9742
9743 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9744 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9745 whatever you use @code{nndir} for, so you could switch to any of those
9746 methods if you feel the need to have a non-read-only @code{nndir}.
9747
9748
9749 @node Anything Groups
9750 @subsection Anything Groups
9751 @cindex nneething
9752
9753 From the @code{nndir} backend (which reads a single spool-like
9754 directory), it's just a hop and a skip to @code{nneething}, which
9755 pretends that any arbitrary directory is a newsgroup.  Strange, but
9756 true.
9757
9758 When @code{nneething} is presented with a directory, it will scan this
9759 directory and assign article numbers to each file.  When you enter such
9760 a group, @code{nneething} must create ``headers'' that Gnus can use.
9761 After all, Gnus is a newsreader, in case you're
9762 forgetting. @code{nneething} does this in a two-step process.  First, it
9763 snoops each file in question.  If the file looks like an article (i.e.,
9764 the first few lines look like headers), it will use this as the head.
9765 If this is just some arbitrary file without a head (e.g. a C source
9766 file), @code{nneething} will cobble up a header out of thin air.  It
9767 will use file ownership, name and date and do whatever it can with these
9768 elements.
9769
9770 All this should happen automatically for you, and you will be presented
9771 with something that looks very much like a newsgroup.  Totally like a
9772 newsgroup, to be precise.  If you select an article, it will be displayed
9773 in the article buffer, just as usual.
9774
9775 If you select a line that represents a directory, Gnus will pop you into
9776 a new summary buffer for this @code{nneething} group.  And so on.  You can
9777 traverse the entire disk this way, if you feel like, but remember that
9778 Gnus is not dired, really, and does not intend to be, either.
9779
9780 There are two overall modes to this action---ephemeral or solid.  When
9781 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9782 will not store information on what files you have read, and what files
9783 are new, and so on.  If you create a solid @code{nneething} group the
9784 normal way with @kbd{G m}, Gnus will store a mapping table between
9785 article numbers and file names, and you can treat this group like any
9786 other groups.  When you activate a solid @code{nneething} group, you will
9787 be told how many unread articles it contains, etc., etc.
9788
9789 Some variables:
9790
9791 @table @code
9792 @item nneething-map-file-directory
9793 @vindex nneething-map-file-directory
9794 All the mapping files for solid @code{nneething} groups will be stored
9795 in this directory, which defaults to @file{~/.nneething/}.
9796
9797 @item nneething-exclude-files
9798 @vindex nneething-exclude-files
9799 All files that match this regexp will be ignored.  Nice to use to exclude
9800 auto-save files and the like, which is what it does by default.
9801
9802 @item nneething-map-file
9803 @vindex nneething-map-file
9804 Name of the map files.
9805 @end table
9806
9807
9808 @node Document Groups
9809 @subsection Document Groups
9810 @cindex nndoc
9811 @cindex documentation group
9812 @cindex help group
9813
9814 @code{nndoc} is a cute little thing that will let you read a single file
9815 as a newsgroup.  Several files types are supported:
9816
9817 @table @code
9818 @cindex babyl
9819 @cindex rmail mbox
9820
9821 @item babyl
9822 The babyl (rmail) mail box.
9823 @cindex mbox
9824 @cindex Unix mbox
9825
9826 @item mbox
9827 The standard Unix mbox file.
9828
9829 @cindex MMDF mail box
9830 @item mmdf
9831 The MMDF mail box format.
9832
9833 @item news
9834 Several news articles appended into a file.
9835
9836 @item rnews
9837 @cindex rnews batch files
9838 The rnews batch transport format.
9839 @cindex forwarded messages
9840
9841 @item forward
9842 Forwarded articles.
9843
9844 @item mime-digest
9845 @cindex digest
9846 @cindex MIME digest
9847 @cindex 1153 digest
9848 @cindex RFC 1153 digest
9849 @cindex RFC 341 digest
9850 MIME (RFC 1341) digest format.
9851
9852 @item standard-digest
9853 The standard (RFC 1153) digest format.
9854
9855 @item slack-digest
9856 Non-standard digest format---matches most things, but does it badly. 
9857 @end table
9858
9859 You can also use the special ``file type'' @code{guess}, which means
9860 that @code{nndoc} will try to guess what file type it is looking at.
9861 @code{digest} means that @code{nndoc} should guess what digest type the
9862 file is.
9863
9864 @code{nndoc} will not try to change the file or insert any extra headers into
9865 it---it will simply, like, let you use the file as the basis for a
9866 group.  And that's it.
9867
9868 If you have some old archived articles that you want to insert into your
9869 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9870 that.  Say you have an old @file{RMAIL} file with mail that you now want
9871 to split into your new @code{nnml} groups.  You look at that file using
9872 @code{nndoc} (using the @kbd{G f} command in the group buffer
9873 (@pxref{Foreign Groups})), set the process mark on all the articles in
9874 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9875 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9876 file is now also stored in lots of @code{nnml} directories, and you can
9877 delete that pesky @file{RMAIL} file.  If you have the guts!
9878
9879 Virtual server variables:
9880
9881 @table @code
9882 @item nndoc-article-type
9883 @vindex nndoc-article-type
9884 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9885 @code{mmdf}, @code{forward}, @code{rfc934}, @code{rfc822-forward},
9886 @code{news}, @code{rnews}, @code{mime-digest}, @code{clari-briefs}, or
9887 @code{guess}.
9888
9889 @item nndoc-post-type
9890 @vindex nndoc-post-type
9891 This variable says whether Gnus is to consider the group a news group or
9892 a mail group.  There are two legal values:  @code{mail} (the default)
9893 and @code{news}.
9894 @end table
9895
9896 @menu
9897 * Document Server Internals::   How to add your own document types.
9898 @end menu
9899
9900
9901 @node Document Server Internals
9902 @subsubsection Document Server Internals
9903
9904 Adding new document types to be recognized by @code{nndoc} isn't
9905 difficult.  You just have to whip up a definition of what the document
9906 looks like, write a predicate function to recognize that document type,
9907 and then hook into @code{nndoc}.
9908
9909 First, here's an example document type definition:
9910
9911 @example
9912 (mmdf 
9913  (article-begin .  "^\^A\^A\^A\^A\n")
9914  (body-end .  "^\^A\^A\^A\^A\n"))
9915 @end example
9916
9917 The definition is simply a unique @dfn{name} followed by a series of
9918 regexp pseudo-variable settings.  Below are the possible
9919 variables---don't be daunted by the number of variables; most document
9920 types can be defined with very few settings:
9921
9922 @table @code
9923 @item first-article
9924 If present, @code{nndoc} will skip past all text until it finds
9925 something that match this regexp.  All text before this will be
9926 totally ignored. 
9927
9928 @item article-begin
9929 This setting has to be present in all document type definitions.  It
9930 says what the beginning of each article looks like.
9931
9932 @item head-begin-function
9933 If present, this should be a function that moves point to the head of
9934 the article.
9935
9936 @item nndoc-head-begin
9937 If present, this should be a regexp that matches the head of the
9938 article. 
9939
9940 @item nndoc-head-end
9941 This should match the end of the head of the article.  It defaults to
9942 @samp{^$}---the empty line.
9943
9944 @item body-begin-function
9945 If present, this function should move point to the beginning of the body
9946 of the article.
9947
9948 @item body-begin
9949 This should match the beginning of the body of the article.  It defaults
9950 to @samp{^\n}.
9951
9952 @item body-end-function
9953 If present, this function should move point to the end of the body of
9954 the article.
9955
9956 @item body-end
9957 If present, this should match the end of the body of the article.
9958
9959 @item file-end
9960 If present, this should match the end of the file.  All text after this
9961 regexp will be totally ignored. 
9962
9963 @end table
9964
9965 So, using these variables @code{nndoc} is able to dissect a document
9966 file into a series of articles, each with a head and a body.  However, a
9967 few more variables are needed since not all document types are all that
9968 news-like---variables needed to transform the head or the body into
9969 something that's palatable for Gnus:
9970
9971 @table @code
9972 @item prepare-body-function
9973 If present, this function will be called when requesting an article.  It
9974 will be called with point at the start of the body, and is useful if the
9975 document has encoded some parts of its contents. 
9976
9977 @item article-transform-function
9978 If present, this function is called when requesting an article.  It's
9979 meant to be used how more wide-ranging transformation of both head and
9980 body of the article.
9981
9982 @item generate-head-function
9983 If present, this function is called to generate a head that Gnus can
9984 understand.  It is called with the article number as a parameter, and is
9985 expected to generate a nice head for the article in question.  It is
9986 called when requesting the headers of all articles.
9987
9988 @end table
9989
9990 Let's look at the most complicated example I can come up with---standard
9991 digests:
9992
9993 @example
9994 (standard-digest
9995  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9996  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9997  (prepare-body-function . nndoc-unquote-dashes)
9998  (body-end-function . nndoc-digest-body-end)
9999  (head-end . "^ ?$")
10000  (body-begin . "^ ?\n")
10001  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10002  (subtype digest guess))
10003 @end example
10004
10005 We see that all text before a 70-width line of dashes is ignored; all
10006 text after a line that starts with that @samp{^End of} is also ignored;
10007 each article begins with a 30-width line of dashes; the line separating
10008 the head from the body may contain a single space; and that the body is
10009 run through @code{nndoc-unquote-dashes} before being delivered.
10010
10011 To hook your own document definition into @code{nndoc}, use the
10012 @code{nndoc-add-type} function.  It takes two parameters---the first is
10013 the definition itself and the second (optional) parameter says where in
10014 the document type definition alist to put this definition.  The alist is
10015 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
10016 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
10017 is of @code{mmdf} type, and so on.  These type predicates should return
10018 @code{nil} if the document is not of the correct type; @code{t} if it is
10019 of the correct type; and a number if the document might be of the
10020 correct type.  A high number means high probability; a low number means
10021 low probability with @samp{0} being the lowest legal number.
10022
10023
10024 @node SOUP
10025 @subsection SOUP
10026 @cindex SOUP
10027 @cindex offline
10028
10029 In the PC world people often talk about ``offline'' newsreaders.  These
10030 are thingies that are combined reader/news transport monstrosities.
10031 With built-in modem programs.  Yecchh!
10032
10033 Of course, us Unix Weenie types of human beans use things like
10034 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10035 transport things like Ghod intended.  And then we just use normal
10036 newsreaders.  
10037
10038 However, it can sometimes be convenient to do something a that's a bit
10039 easier on the brain if you have a very slow modem, and you're not really
10040 that interested in doing things properly.  
10041
10042 A file format called @sc{soup} has been developed for transporting news
10043 and mail from servers to home machines and back again.  It can be a bit
10044 fiddly.
10045
10046 First some terminology:
10047
10048 @table @dfn
10049
10050 @item server
10051 This is the machine that is connected to the outside world and where you
10052 get news and/or mail from.
10053
10054 @item home machine
10055 This is the machine that you want to do the actual reading and responding
10056 on.  It is typically not connected to the rest of the world in any way.
10057
10058 @item packet
10059 Something that contains messages and/or commands.  There are two kinds
10060 of packets:
10061
10062 @table @dfn
10063 @item message packets
10064 These are packets made at the server, and typically contains lots of
10065 messages for you to read.  These are called @file{SoupoutX.tgz} by
10066 default, where @var{X} is a number.
10067
10068 @item response packets
10069 These are packets made at the home machine, and typically contains
10070 replies that you've written.  These are called @file{SoupinX.tgz} by
10071 default, where @var{X} is a number.
10072
10073 @end table
10074
10075 @end table
10076
10077
10078 @enumerate
10079
10080 @item
10081 You log in on the server and create a @sc{soup} packet.  You can either
10082 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10083 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10084 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10085
10086 @item 
10087 You transfer the packet home.  Rail, boat, car or modem will do fine.
10088
10089 @item
10090 You put the packet in your home directory.
10091
10092 @item
10093 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10094 the native or secondary server.
10095
10096 @item
10097 You read articles and mail and answer and followup to the things you
10098 want (@pxref{SOUP Replies}).
10099
10100 @item 
10101 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10102 packet.
10103
10104 @item 
10105 You transfer this packet to the server.  
10106
10107 @item
10108 You use Gnus to mail this packet out with the @kbd{G s s} command.
10109
10110 @item
10111 You then repeat until you die.
10112
10113 @end enumerate
10114
10115 So you basically have a bipartite system---you use @code{nnsoup} for
10116 reading and Gnus for packing/sending these @sc{soup} packets.
10117
10118 @menu
10119 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10120 * SOUP Groups::       A backend for reading @sc{soup} packets.
10121 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10122 @end menu
10123
10124
10125 @node SOUP Commands
10126 @subsubsection SOUP Commands
10127
10128 These are commands for creating and manipulating @sc{soup} packets.
10129
10130 @table @kbd
10131 @item G s b
10132 @kindex G s b (Group)
10133 @findex gnus-group-brew-soup
10134 Pack all unread articles in the current group
10135 (@code{gnus-group-brew-soup}).  This command understands the
10136 process/prefix convention.
10137
10138 @item G s w
10139 @kindex G s w (Group)
10140 @findex gnus-soup-save-areas
10141 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10142
10143 @item G s s
10144 @kindex G s s (Group)
10145 @findex gnus-soup-send-replies
10146 Send all replies from the replies packet
10147 (@code{gnus-soup-send-replies}). 
10148
10149 @item G s p
10150 @kindex G s p (Group)
10151 @findex gnus-soup-pack-packet
10152 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
10153
10154 @item G s r
10155 @kindex G s r (Group)
10156 @findex nnsoup-pack-replies
10157 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
10158
10159 @item O s
10160 @kindex O s (Summary)
10161 @findex gnus-soup-add-article
10162 This summary-mode command adds the current article to a @sc{soup} packet
10163 (@code{gnus-soup-add-article}).  It understands the process/prefix
10164 convention (@pxref{Process/Prefix}). 
10165
10166 @end table
10167
10168
10169 There are a few variables to customize where Gnus will put all these
10170 thingies:  
10171
10172 @table @code
10173
10174 @item gnus-soup-directory
10175 @vindex gnus-soup-directory
10176 Directory where Gnus will save intermediate files while composing
10177 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
10178
10179 @item gnus-soup-replies-directory
10180 @vindex gnus-soup-replies-directory
10181 This is what Gnus will use as a temporary directory while sending our
10182 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10183
10184 @item gnus-soup-prefix-file
10185 @vindex gnus-soup-prefix-file
10186 Name of the file where Gnus stores the last used prefix.  The default is
10187 @samp{gnus-prefix}. 
10188
10189 @item gnus-soup-packer
10190 @vindex gnus-soup-packer
10191 A format string command for packing a @sc{soup} packet.  The default is
10192 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10193
10194 @item gnus-soup-unpacker
10195 @vindex gnus-soup-unpacker
10196 Format string command for unpacking a @sc{soup} packet.  The default is
10197 @samp{gunzip -c %s | tar xvf -}.
10198
10199 @item gnus-soup-packet-directory
10200 @vindex gnus-soup-packet-directory
10201 Where Gnus will look for reply packets.  The default is @file{~/}. 
10202
10203 @item gnus-soup-packet-regexp
10204 @vindex gnus-soup-packet-regexp
10205 Regular expression matching @sc{soup} reply packets in
10206 @code{gnus-soup-packet-directory}. 
10207
10208 @end table
10209  
10210
10211 @node SOUP Groups
10212 @subsubsection @sc{soup} Groups
10213 @cindex nnsoup
10214
10215 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10216 read incoming packets, unpack them, and put them in a directory where
10217 you can read them at leisure.
10218
10219 These are the variables you can use to customize its behavior:
10220
10221 @table @code
10222
10223 @item nnsoup-tmp-directory
10224 @vindex nnsoup-tmp-directory
10225 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10226 directory.  (@file{/tmp/} by default.)  
10227
10228 @item nnsoup-directory
10229 @vindex nnsoup-directory
10230 @code{nnsoup} then moves each message and index file to this directory.
10231 The default is @file{~/SOUP/}.
10232
10233 @item nnsoup-replies-directory 
10234 @vindex nnsoup-replies-directory 
10235 All replies will stored in this directory before being packed into a
10236 reply packet.  The default is @file{~/SOUP/replies/"}.
10237
10238 @item nnsoup-replies-format-type
10239 @vindex nnsoup-replies-format-type
10240 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10241 (rnews), and I don't think you should touch that variable.  I probably
10242 shouldn't even have documented it.  Drats!  Too late!
10243
10244 @item nnsoup-replies-index-type
10245 @vindex nnsoup-replies-index-type
10246 The index type of the replies packet.  The is @samp{?n}, which means
10247 ``none''.  Don't fiddle with this one either!
10248
10249 @item nnsoup-active-file
10250 @vindex nnsoup-active-file
10251 Where @code{nnsoup} stores lots of information.  This is not an ``active
10252 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10253 this file or mess it up in any way, you're dead.  The default is
10254 @file{~/SOUP/active}.
10255
10256 @item nnsoup-packer
10257 @vindex nnsoup-packer
10258 Format string command for packing a reply @sc{soup} packet.  The default
10259 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10260
10261 @item nnsoup-unpacker
10262 @vindex nnsoup-unpacker
10263 Format string command for unpacking incoming @sc{soup} packets.  The
10264 default is @samp{gunzip -c %s | tar xvf -}. 
10265
10266 @item nnsoup-packet-directory
10267 @vindex nnsoup-packet-directory
10268 Where @code{nnsoup} will look for incoming packets.  The default is
10269 @file{~/}.  
10270
10271 @item nnsoup-packet-regexp
10272 @vindex nnsoup-packet-regexp
10273 Regular expression matching incoming @sc{soup} packets.  The default is
10274 @samp{Soupout}. 
10275
10276 @end table
10277
10278
10279 @node SOUP Replies
10280 @subsubsection SOUP Replies
10281
10282 Just using @code{nnsoup} won't mean that your postings and mailings end
10283 up in @sc{soup} reply packets automagically.  You have to work a bit
10284 more for that to happen.
10285
10286 @findex nnsoup-set-variables
10287 The @code{nnsoup-set-variables} command will set the appropriate
10288 variables to ensure that all your followups and replies end up in the
10289 @sc{soup} system.
10290
10291 In specific, this is what it does:
10292
10293 @lisp
10294 (setq message-send-news-function 'nnsoup-request-post)
10295 (setq message-send-mail-function 'nnsoup-request-mail)
10296 @end lisp
10297
10298 And that's it, really.  If you only want news to go into the @sc{soup}
10299 system you just use the first line.  If you only want mail to be
10300 @sc{soup}ed you use the second.
10301
10302
10303 @node Web Searches
10304 @subsection Web Searches
10305 @cindex nnweb
10306 @cindex DejaNews
10307 @cindex Alta Vista
10308 @cindex InReference
10309 @cindex Usenet searches
10310 @cindex searching the Usenet
10311
10312 It's, like, too neat to search the Usenet for articles that match a
10313 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10314 those, like, Web browsers, and you, like, have to, rilly, like, look at
10315 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10316 searches without having to use a browser.
10317
10318 The @code{nnweb} backend allows an easy interface to the mighty search
10319 engine.  You create an @code{nnweb} group, enter a search pattern, and
10320 then enter the group and read the articles like you would any normal
10321 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10322 Groups}) will do this in an easy-to-use fashion.
10323
10324 @code{nnweb} groups don't really lend themselves to being solid
10325 groups---they have a very fleeting idea of article numbers.  In fact,
10326 each time you enter an @code{nnweb} group (not even changing the search
10327 pattern), you are likely to get the articles ordered in a different
10328 manner.  Not even using duplicate suppression (@code{Duplicate
10329 Suppression}) will help, since @code{nnweb} doesn't even know the
10330 @code{Message-ID} of the articles before reading them using some search
10331 engines (DejaNews, for instance).  The only possible way to keep track
10332 of which articles you've read is by scoring on the @code{Date}
10333 header---mark all articles that were posted before the last date you
10334 read the group as read.
10335
10336 If the search engine changes its output substantially, @code{nnweb}
10337 won't be able to parse it and will fail.  One could hardly fault the Web
10338 providers if they were to do this---their @emph{raison d'être} is to
10339 make money off of advertisements, not to provide services to the
10340 community.  Since @code{nnweb} washes the ads off all the articles, one
10341 might think that the providers might be somewhat miffed.  We'll see.
10342
10343 You must have the @code{url} and @code{w3} package installed to be able
10344 to use @code{nnweb}.
10345
10346 Virtual server variables:
10347
10348 @table @code
10349 @item nnweb-type
10350 @vindex nnweb-type
10351 What search engine type is being used.  The currently supported types
10352 are @code{dejanews}, @code{altavista} and @code{reference}.
10353
10354 @item nnweb-search
10355 @vindex nnweb-search
10356 The search string to feed to the search engine.
10357
10358 @item nnweb-max-hits
10359 @vindex nnweb-max-hits
10360 Advisory maximum number of hits per search to display.  The default is
10361 100.
10362
10363 @item nnweb-type-definition
10364 @vindex nnweb-type-definition
10365 Type-to-definition alist.  This alist says what @code{nnweb} should do
10366 with the various search engine types.  The following elements must be
10367 present: 
10368
10369 @table @code
10370 @item article
10371 Function to decode the article and provide something that Gnus
10372 understands. 
10373
10374 @item map
10375 Function to create an article number to message header and URL alist. 
10376
10377 @item search
10378 Function to send the search string to the search engine.
10379
10380 @item address
10381 The address the aforementioned function should send the search string
10382 to. 
10383
10384 @item id
10385 Format string URL to fetch an article by @code{Message-ID}.
10386 @end table
10387
10388 @end table
10389
10390
10391
10392 @node Mail-To-News Gateways
10393 @subsection Mail-To-News Gateways
10394 @cindex mail-to-news gateways
10395 @cindex gateways
10396
10397 If your local @code{nntp} server doesn't allow posting, for some reason
10398 or other, you can post using one of the numerous mail-to-news gateways.
10399 The @code{nngateway} backend provides the interface.
10400
10401 Note that you can't read anything from this backend---it can only be
10402 used to post with.
10403
10404 Server variables:
10405
10406 @table @code
10407 @item nngateway-address 
10408 @vindex nngateway-address 
10409 This is the address of the mail-to-news gateway.
10410
10411 @item nngateway-header-transformation
10412 @vindex nngateway-header-transformation
10413 News headers have often have to be transformed in some odd way or other
10414 for the mail-to-news gateway to accept it.  This variable says what 
10415 transformation should be called, and defaults to
10416 @code{nngateway-simple-header-transformation}.  The function is called
10417 narrowed to the headers to be transformed and with one parameter---the
10418 gateway address.
10419
10420 This default function just inserts a new @code{To} header based on the
10421 @code{Newsgroups} header and the gateway address---an article with this
10422 @code{Newsgroups} header:
10423
10424 @example
10425 Newsgroups: alt.religion.emacs
10426 @end example
10427
10428 will get this @code{From} header inserted:
10429
10430 @example
10431 To: alt-religion-emacs@@GATEWAY
10432 @end example
10433
10434 @end table
10435
10436 So, to use this, simply say something like:
10437
10438 @lisp
10439 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10440 @end lisp
10441
10442
10443 @node Combined Groups
10444 @section Combined Groups
10445
10446 Gnus allows combining a mixture of all the other group types into bigger
10447 groups.
10448
10449 @menu
10450 * Virtual Groups::     Combining articles from many groups.
10451 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10452 @end menu
10453
10454
10455 @node Virtual Groups
10456 @subsection Virtual Groups
10457 @cindex nnvirtual
10458 @cindex virtual groups
10459
10460 An @dfn{nnvirtual group} is really nothing more than a collection of
10461 other groups.
10462
10463 For instance, if you are tired of reading many small group, you can
10464 put them all in one big group, and then grow tired of reading one
10465 big, unwieldy group.  The joys of computing!
10466
10467 You specify @code{nnvirtual} as the method.  The address should be a
10468 regexp to match component groups.
10469
10470 All marks in the virtual group will stick to the articles in the
10471 component groups.  So if you tick an article in a virtual group, the
10472 article will also be ticked in the component group from whence it came.
10473 (And vice versa---marks from the component groups will also be shown in
10474 the virtual group.)
10475
10476 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10477 newsgroups into one, big, happy newsgroup:
10478
10479 @lisp
10480 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10481 @end lisp
10482
10483 The component groups can be native or foreign; everything should work
10484 smoothly, but if your computer explodes, it was probably my fault.
10485
10486 Collecting the same group from several servers might actually be a good
10487 idea if users have set the Distribution header to limit distribution.
10488 If you would like to read @samp{soc.motss} both from a server in Japan
10489 and a server in Norway, you could use the following as the group regexp:
10490
10491 @example
10492 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10493 @end example
10494
10495 This should work kinda smoothly---all articles from both groups should
10496 end up in this one, and there should be no duplicates.  Threading (and
10497 the rest) will still work as usual, but there might be problems with the
10498 sequence of articles.  Sorting on date might be an option here
10499 (@pxref{Selecting a Group}.
10500
10501 One limitation, however---all groups that are included in a virtual
10502 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10503 zombie groups can't be component groups for @code{nnvirtual} groups.
10504
10505 @vindex nnvirtual-always-rescan
10506 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10507 @code{nnvirtual} will always scan groups for unread articles when
10508 entering a virtual group.  If this variable is @code{nil} (which is the
10509 default) and you read articles in a component group after the virtual
10510 group has been activated, the read articles from the component group
10511 will show up when you enter the virtual group.  You'll also see this
10512 effect if you have two virtual groups that contain the same component
10513 group.  If that's the case, you should set this variable to @code{t}.
10514 Or you can just tap @code{M-g} on the virtual group every time before
10515 you enter it---it'll have much the same effect.
10516
10517
10518 @node Kibozed Groups
10519 @subsection Kibozed Groups
10520 @cindex nnkiboze
10521 @cindex kibozing
10522
10523 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10524 the news feed''.  @code{nnkiboze} is a backend that will do this for
10525 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10526 with useless requests!  Oh happiness!
10527
10528 @kindex G k (Group)
10529 To create a kibozed group, use the @kbd{G k} command in the group
10530 buffer. 
10531
10532 The address field of the @code{nnkiboze} method is, as with
10533 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10534 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10535 and @code{nnvirtual} ends.
10536
10537 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10538 must have a score file to say what articles that are to be included in
10539 the group (@pxref{Scoring}).
10540
10541 @kindex M-x nnkiboze-generate-groups
10542 @findex nnkiboze-generate-groups
10543 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10544 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10545 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10546 all the articles in all the components groups and run them through the
10547 scoring process to determine if there are any articles in the groups
10548 that are to be part of the @code{nnkiboze} groups.
10549
10550 Please limit the number of component groups by using restrictive
10551 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10552 @sc{nntp} site may throw you off and never let you back in again.
10553 Stranger things have happened.
10554
10555 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10556 and they can be foreign.  No restrictions.
10557
10558 @vindex nnkiboze-directory
10559 The generation of an @code{nnkiboze} group means writing two files in
10560 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10561 contains the @sc{nov} header lines for all the articles in the group,
10562 and the other is an additional @file{.newsrc} file to store information
10563 on what groups that have been searched through to find component
10564 articles.
10565
10566 Articles that are marked as read in the @code{nnkiboze} group will have their
10567 @sc{nov} lines removed from the @sc{nov} file.
10568
10569
10570 @node Scoring
10571 @chapter Scoring
10572 @cindex scoring
10573
10574 Other people use @dfn{kill files}, but we here at Gnus Towers like
10575 scoring better than killing, so we'd rather switch than fight.  They do
10576 something completely different as well, so sit up straight and pay
10577 attention!
10578
10579 @vindex gnus-summary-mark-below
10580 All articles have a default score (@code{gnus-summary-default-score}),
10581 which is 0 by default.  This score may be raised or lowered either
10582 interactively or by score files.  Articles that have a score lower than
10583 @code{gnus-summary-mark-below} are marked as read.
10584
10585 Gnus will read any @dfn{score files} that apply to the current group
10586 before generating the summary buffer.
10587
10588 There are several commands in the summary buffer that insert score
10589 entries based on the current article.  You can, for instance, ask Gnus to
10590 lower or increase the score of all articles with a certain subject.
10591
10592 There are two sorts of scoring entries: Permanent and temporary.
10593 Temporary score entries are self-expiring entries.  Any entries that are
10594 temporary and have not been used for, say, a week, will be removed
10595 silently to help keep the sizes of the score files down.
10596
10597 @menu 
10598 * Summary Score Commands::   Adding score entries for the current group.
10599 * Group Score Commands::     General score commands.
10600 * Score Variables::          Customize your scoring.  (My, what terminology).
10601 * Score File Format::        What a score file may contain.
10602 * Score File Editing::       You can edit score files by hand as well.
10603 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10604 * Home Score File::          How to say where new score entries are to go.
10605 * Followups To Yourself::    Having Gnus notice when people answer you.
10606 * Scoring Tips::             How to score effectively.
10607 * Reverse Scoring::          That problem child of old is not problem.
10608 * Global Score Files::       Earth-spanning, ear-splitting score files.
10609 * Kill Files::               They are still here, but they can be ignored.
10610 * Converting Kill Files::    Translating kill files to score files.
10611 * GroupLens::                Getting predictions on what you like to read.
10612 * Advanced Scoring::         Using logical expressions to build score rules.
10613 * Score Decays::             It can be useful to let scores wither away.
10614 @end menu
10615
10616
10617 @node Summary Score Commands
10618 @section Summary Score Commands
10619 @cindex score commands
10620
10621 The score commands that alter score entries do not actually modify real
10622 score files.  That would be too inefficient.  Gnus maintains a cache of
10623 previously loaded score files, one of which is considered the
10624 @dfn{current score file alist}.  The score commands simply insert
10625 entries into this list, and upon group exit, this list is saved.
10626
10627 The current score file is by default the group's local score file, even
10628 if no such score file actually exists.  To insert score commands into
10629 some other score file (e.g. @file{all.SCORE}), you must first make this
10630 score file the current one.
10631
10632 General score commands that don't actually change the score file:
10633
10634 @table @kbd
10635
10636 @item V s
10637 @kindex V s (Summary)
10638 @findex gnus-summary-set-score
10639 Set the score of the current article (@code{gnus-summary-set-score}).  
10640
10641 @item V S
10642 @kindex V S (Summary)
10643 @findex gnus-summary-current-score
10644 Display the score of the current article
10645 (@code{gnus-summary-current-score}).   
10646
10647 @item V t
10648 @kindex V t (Summary)
10649 @findex gnus-score-find-trace
10650 Display all score rules that have been used on the current article
10651 (@code{gnus-score-find-trace}).   
10652
10653 @item V R
10654 @kindex V R (Summary)
10655 @findex gnus-summary-rescore
10656 Run the current summary through the scoring process
10657 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10658 around with your score files behind Gnus' back and want to see the
10659 effect you're having.
10660
10661 @item V a
10662 @kindex V a (Summary)
10663 @findex gnus-summary-score-entry
10664 Add a new score entry, and allow specifying all elements 
10665 (@code{gnus-summary-score-entry}).
10666
10667 @item V c
10668 @kindex V c (Summary)
10669 @findex gnus-score-change-score-file
10670 Make a different score file the current
10671 (@code{gnus-score-change-score-file}). 
10672
10673 @item V e
10674 @kindex V e (Summary)
10675 @findex gnus-score-edit-current-scores
10676 Edit the current score file (@code{gnus-score-edit-current-scores}).
10677 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10678 File Editing}).
10679
10680 @item V f
10681 @kindex V f (Summary)
10682 @findex gnus-score-edit-file
10683 Edit a score file and make this score file the current one
10684 (@code{gnus-score-edit-file}).
10685
10686 @item V F
10687 @kindex V F (Summary)
10688 @findex gnus-score-flush-cache
10689 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10690 after editing score files.
10691
10692 @item V C
10693 @kindex V C (Summary)
10694 @findex gnus-score-customize
10695 Customize a score file in a visually pleasing manner
10696 (@code{gnus-score-customize}). 
10697
10698 @item I C-i
10699 @kindex I C-i (Summary)
10700 @findex gnus-summary-raise-score
10701 Increase the score of the current article
10702 (@code{gnus-summary-raise-score}).
10703
10704 @item L C-l
10705 @kindex L C-l (Summary)
10706 @findex gnus-summary-lower-score
10707 Lower the score of the current article
10708 (@code{gnus-summary-lower-score}). 
10709 @end table
10710
10711 The rest of these commands modify the local score file.
10712
10713 @table @kbd
10714
10715 @item V m
10716 @kindex V m (Summary)
10717 @findex gnus-score-set-mark-below
10718 Prompt for a score, and mark all articles with a score below this as
10719 read (@code{gnus-score-set-mark-below}).
10720
10721 @item V x
10722 @kindex V x (Summary)
10723 @findex gnus-score-set-expunge-below
10724 Prompt for a score, and add a score rule to the current score file to
10725 expunge all articles below this score
10726 (@code{gnus-score-set-expunge-below}).
10727 @end table
10728
10729 The keystrokes for actually making score entries follow a very regular
10730 pattern, so there's no need to list all the commands.  (Hundreds of
10731 them.)  
10732
10733 @enumerate
10734 @item
10735 The first key is either @kbd{I} (upper case i) for increasing the score
10736 or @kbd{L} for lowering the score. 
10737 @item
10738 The second key says what header you want to score on.  The following
10739 keys are available:
10740 @table @kbd
10741
10742 @item a
10743 Score on the author name.
10744
10745 @item s
10746 Score on the subject line.
10747
10748 @item x
10749 Score on the Xref line---i.e., the cross-posting line.
10750
10751 @item t
10752 Score on thread---the References line.
10753
10754 @item d
10755 Score on the date.
10756
10757 @item l
10758 Score on the number of lines.
10759
10760 @item i
10761 Score on the Message-ID.
10762
10763 @item f
10764 Score on followups.
10765
10766 @item b
10767 Score on the body.
10768
10769 @item h
10770 Score on the head.
10771 @end table
10772
10773 @item
10774 The third key is the match type.  Which match types are legal depends on
10775 what headers you are scoring on.
10776
10777 @table @code
10778
10779 @item strings 
10780
10781 @table @kbd
10782
10783 @item e
10784 Exact matching.
10785
10786 @item s
10787 Substring matching.
10788
10789 @item f
10790 Fuzzy matching (@pxref{Fuzzy Matching}).
10791
10792 @item r
10793 Regexp matching
10794 @end table
10795
10796 @item date
10797 @table @kbd
10798
10799 @item b
10800 Before date.
10801
10802 @item a
10803 At date.
10804
10805 @item n
10806 This date.
10807 @end table
10808
10809 @item number
10810 @table @kbd
10811
10812 @item <
10813 Less than number.
10814
10815 @item =
10816 Equal to number.
10817
10818 @item >
10819 Greater than number.
10820 @end table
10821 @end table
10822
10823 @item 
10824 The fourth and final key says whether this is a temporary (i.e., expiring)
10825 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10826 it is to be done immediately, without adding to the score file.
10827 @table @kbd
10828
10829 @item t
10830 Temporary score entry.
10831
10832 @item p
10833 Permanent score entry.
10834
10835 @item i
10836 Immediately scoring.
10837 @end table
10838
10839 @end enumerate
10840
10841 So, let's say you want to increase the score on the current author with
10842 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10843 score based on the subject line, using substring matching, and make a
10844 temporary score entry: @kbd{L s s t}.  Pretty easy.
10845
10846 To make things a bit more complicated, there are shortcuts.  If you use
10847 a capital letter on either the second or third keys, Gnus will use
10848 defaults for the remaining one or two keystrokes.  The defaults are
10849 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10850 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10851
10852 @vindex gnus-score-mimic-keymap
10853 The @code{gnus-score-mimic-keymap} says whether these commands will
10854 pretend they are keymaps or not.
10855
10856
10857 @node Group Score Commands
10858 @section Group Score Commands
10859 @cindex group score commands
10860
10861 There aren't many of these as yet, I'm afraid.
10862
10863 @table @kbd
10864
10865 @item W f
10866 @kindex W f (Group)
10867 @findex gnus-score-flush-cache
10868 Gnus maintains a cache of score alists to avoid having to reload them
10869 all the time.  This command will flush the cache
10870 (@code{gnus-score-flush-cache}). 
10871
10872 @end table
10873
10874
10875 @node Score Variables
10876 @section Score Variables
10877 @cindex score variables
10878
10879 @table @code
10880
10881 @item gnus-use-scoring
10882 @vindex gnus-use-scoring
10883 If @code{nil}, Gnus will not check for score files, and will not, in
10884 general, do any score-related work.  This is @code{t} by default.
10885
10886 @item gnus-kill-killed
10887 @vindex gnus-kill-killed
10888 If this variable is @code{nil}, Gnus will never apply score files to
10889 articles that have already been through the kill process.  While this
10890 may save you lots of time, it also means that if you apply a kill file
10891 to a group, and then change the kill file and want to run it over you
10892 group again to kill more articles, it won't work.  You have to set this
10893 variable to @code{t} to do that.  (It is @code{t} by default.)
10894
10895 @item gnus-kill-files-directory
10896 @vindex gnus-kill-files-directory
10897 All kill and score files will be stored in this directory, which is
10898 initialized from the @code{SAVEDIR} environment variable by default.
10899 This is @file{~/News/} by default.
10900
10901 @item gnus-score-file-suffix
10902 @vindex gnus-score-file-suffix
10903 Suffix to add to the group name to arrive at the score file name
10904 (@samp{SCORE} by default.)
10905
10906 @item gnus-score-uncacheable-files
10907 @vindex gnus-score-uncacheable-files
10908 @cindex score cache
10909 All score files are normally cached to avoid excessive re-loading of
10910 score files.  However, if this might make you Emacs grow big and
10911 bloated, so this regexp can be used to weed out score files that are
10912 unlikely to be needed again.  It would be a bad idea to deny caching of
10913 @file{all.SCORE}, while it might be a good idea to not cache
10914 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10915 variable is @samp{ADAPT$} by default, so no adaptive score files will
10916 be cached.
10917
10918 @item gnus-save-score
10919 @vindex gnus-save-score
10920 If you have really complicated score files, and do lots of batch
10921 scoring, then you might set this variable to @code{t}.  This will make
10922 Gnus save the scores into the @file{.newsrc.eld} file.
10923
10924 @item gnus-score-interactive-default-score
10925 @vindex gnus-score-interactive-default-score
10926 Score used by all the interactive raise/lower commands to raise/lower
10927 score with.  Default is 1000, which may seem excessive, but this is to
10928 ensure that the adaptive scoring scheme gets enough room to play with.
10929 We don't want the small changes from the adaptive scoring to overwrite
10930 manually entered data.
10931
10932 @item gnus-summary-default-score
10933 @vindex gnus-summary-default-score
10934 Default score of an article, which is 0 by default.
10935
10936 @item gnus-summary-expunge-below
10937 @vindex gnus-summary-expunge-below
10938 Don't display the summary lines of articles that have scores lower than
10939 this variable.  This is @code{nil} by default, which means that no
10940 articles will be hidden.
10941
10942 @item gnus-score-over-mark
10943 @vindex gnus-score-over-mark
10944 Mark (in the third column) used for articles with a score over the
10945 default.  Default is @samp{+}.
10946
10947 @item gnus-score-below-mark
10948 @vindex gnus-score-below-mark
10949 Mark (in the third column) used for articles with a score below the
10950 default.  Default is @samp{-}.
10951
10952 @item gnus-score-find-score-files-function
10953 @vindex gnus-score-find-score-files-function
10954 Function used to find score files for the current group.  This function
10955 is called with the name of the group as the argument. 
10956
10957 Predefined functions available are:
10958 @table @code
10959
10960 @item gnus-score-find-single
10961 @findex gnus-score-find-single
10962 Only apply the group's own score file.
10963
10964 @item gnus-score-find-bnews
10965 @findex gnus-score-find-bnews
10966 Apply all score files that match, using bnews syntax.  This is the
10967 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10968 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10969 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10970 @samp{all} in the score file names are translated into @samp{.*}, and
10971 then a regexp match is done.
10972
10973 This means that if you have some score entries that you want to apply to
10974 all groups, then you put those entries in the @file{all.SCORE} file. 
10975
10976 The score files are applied in a semi-random order, although Gnus will
10977 try to apply the more general score files before the more specific score
10978 files.  It does this by looking at the number of elements in the score
10979 file names---discarding the @samp{all} elements.
10980
10981 @item gnus-score-find-hierarchical
10982 @findex gnus-score-find-hierarchical
10983 Apply all score files from all the parent groups.  This means that you
10984 can't have score files like @file{all.SCORE}, but you can have
10985 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10986
10987 @end table
10988 This variable can also be a list of functions.  In that case, all these
10989 functions will be called, and all the returned lists of score files will
10990 be applied.  These functions can also return lists of score alists
10991 directly.  In that case, the functions that return these non-file score
10992 alists should probably be placed before the ``real'' score file
10993 functions, to ensure that the last score file returned is the local
10994 score file.  Phu.
10995
10996 @item gnus-score-expiry-days
10997 @vindex gnus-score-expiry-days
10998 This variable says how many days should pass before an unused score file
10999 entry is expired.  If this variable is @code{nil}, no score file entries
11000 are expired.  It's 7 by default.
11001
11002 @item gnus-update-score-entry-dates
11003 @vindex gnus-update-score-entry-dates
11004 If this variable is non-@code{nil}, matching score entries will have
11005 their dates updated.  (This is how Gnus controls expiry---all
11006 non-matching entries will become too old while matching entries will
11007 stay fresh and young.)  However, if you set this variable to @code{nil},
11008 even matching entries will grow old and will have to face that oh-so
11009 grim reaper.  
11010
11011 @item gnus-score-after-write-file-function
11012 @vindex gnus-score-after-write-file-function
11013 Function called with the name of the score file just written.
11014
11015 @end table
11016
11017
11018 @node Score File Format
11019 @section Score File Format
11020 @cindex score file format
11021
11022 A score file is an @code{emacs-lisp} file that normally contains just a
11023 single form.  Casual users are not expected to edit these files;
11024 everything can be changed from the summary buffer.
11025
11026 Anyway, if you'd like to dig into it yourself, here's an example:
11027
11028 @lisp
11029 (("from"
11030   ("Lars Ingebrigtsen" -10000)
11031   ("Per Abrahamsen")
11032   ("larsi\\|lmi" -50000 nil R))
11033  ("subject"
11034   ("Ding is Badd" nil 728373))
11035  ("xref"
11036   ("alt.politics" -1000 728372 s))
11037  ("lines"
11038   (2 -100 nil <))
11039  (mark 0)
11040  (expunge -1000)
11041  (mark-and-expunge -10)
11042  (read-only nil)
11043  (orphan -10)
11044  (adapt t)
11045  (files "/hom/larsi/News/gnu.SCORE")
11046  (exclude-files "all.SCORE")
11047  (local (gnus-newsgroup-auto-expire t)
11048         (gnus-summary-make-false-root 'empty))
11049  (eval (ding)))
11050 @end lisp
11051
11052 This example demonstrates most score file elements.  For a different
11053 approach, see @pxref{Advanced Scoring}.
11054
11055 Even though this looks much like lisp code, nothing here is actually
11056 @code{eval}ed.  The lisp reader is used to read this form, though, so it
11057 has to be legal syntactically, if not semantically.
11058
11059 Six keys are supported by this alist:
11060
11061 @table @code
11062
11063 @item STRING
11064 If the key is a string, it is the name of the header to perform the
11065 match on.  Scoring can only be performed on these eight headers:
11066 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
11067 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
11068 these headers, there are three strings to tell Gnus to fetch the entire
11069 article and do the match on larger parts of the article: @code{Body}
11070 will perform the match on the body of the article, @code{Head} will
11071 perform the match on the head of the article, and @code{All} will
11072 perform the match on the entire article.  Note that using any of these
11073 last three keys will slow down group entry @emph{considerably}.  The
11074 final ``header'' you can score on is @code{Followup}.  These score
11075 entries will result in new score entries being added for all follow-ups
11076 to articles that matches these score entries.
11077
11078 Following this key is a arbitrary number of score entries, where each
11079 score entry has one to four elements.
11080 @enumerate
11081
11082 @item 
11083 The first element is the @dfn{match element}.  On most headers this will
11084 be a string, but on the Lines and Chars headers, this must be an
11085 integer. 
11086
11087 @item 
11088 If the second element is present, it should be a number---the @dfn{score
11089 element}.  This number should be an integer in the neginf to posinf
11090 interval.  This number is added to the score of the article if the match
11091 is successful.  If this element is not present, the
11092 @code{gnus-score-interactive-default-score} number will be used
11093 instead.  This is 1000 by default.
11094
11095 @item 
11096 If the third element is present, it should be a number---the @dfn{date
11097 element}.  This date says when the last time this score entry matched,
11098 which provides a mechanism for expiring the score entries.  It this
11099 element is not present, the score entry is permanent.  The date is
11100 represented by the number of days since December 31, 1 BCE.
11101
11102 @item 
11103 If the fourth element is present, it should be a symbol---the @dfn{type
11104 element}.  This element specifies what function should be used to see
11105 whether this score entry matches the article.  What match types that can
11106 be used depends on what header you wish to perform the match on.
11107 @table @dfn
11108
11109 @item From, Subject, References, Xref, Message-ID
11110 For most header types, there are the @code{r} and @code{R} (regexp), as
11111 well as @code{s} and @code{S} (substring) types, and @code{e} and
11112 @code{E} (exact match), and @code{w} (word match) types.  If this
11113 element is not present, Gnus will assume that substring matching should
11114 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
11115 that the matches will be done in a case-sensitive manner.  All these
11116 one-letter types are really just abbreviations for the @code{regexp},
11117 @code{string}, @code{exact}, and @code{word} types, which you can use
11118 instead, if you feel like.
11119
11120 @item Lines, Chars
11121 These two headers use different match types: @code{<}, @code{>},
11122 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
11123 careful because some backends (like @code{nndir}) do not generate
11124 @code{Lines} header, so every article ends up being marked as having 0
11125 lines.  This can lead to strange results if you happen to lower score of
11126 the articles with few lines.
11127
11128 @item Date
11129 For the Date header we have three kinda silly match types:
11130 @code{before}, @code{at} and @code{after}.  I can't really imagine this
11131 ever being useful, but, like, it would feel kinda silly not to provide
11132 this function.  Just in case.  You never know.  Better safe than sorry.
11133 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
11134 sex on a first date.  (I have been told that at least one person, and I
11135 quote, ``found this function indispensable'', however.)
11136
11137 @cindex ISO8601
11138 @cindex date
11139 A more useful match type is @code{regexp}.  With it, you can match the
11140 date string using a regular expression.  The date is normalized to
11141 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
11142 match all articles that have been posted on April 1st in every year, you
11143 could use @samp{....0401.........} as a match string, for instance.
11144 (Note that the date is kept in its original time zone, so this will
11145 match articles that were posted when it was April 1st where the article
11146 was posted from.  Time zones are such wholesome fun for the whole
11147 family, eh?)
11148
11149 @item Head, Body, All
11150 These three match keys use the same match types as the @code{From} (etc)
11151 header uses.
11152
11153 @item Followup
11154 This match key is somewhat special, in that it will match the
11155 @code{From} header, and affect the score of not only the matching
11156 articles, but also all followups to the matching articles.  This allows
11157 you e.g. increase the score of followups to your own articles, or
11158 decrease the score of followups to the articles of some known
11159 trouble-maker.  Uses the same match types as the @code{From} header
11160 uses.  (Using this match key will lead to creation of @file{ADAPT}
11161 files.) 
11162
11163 @item Thread
11164 This match key works along the same lines as the @code{Followup} match
11165 key.  If you say that you want to score on a (sub-)thread that is
11166 started by an article with a @code{Message-ID} @var{X}, then you add a
11167 @samp{thread} match.  This will add a new @samp{thread} match for each
11168 article that has @var{X} in its @code{References} header.  (These new
11169 @samp{thread} matches will use the @code{Message-ID}s of these matching
11170 articles.)  This will ensure that you can raise/lower the score of an
11171 entire thread, even though some articles in the thread may not have
11172 complete @code{References} headers.  Note that using this may lead to
11173 undeterministic scores of the articles in the thread.  (Using this match
11174 key will lead to creation of @file{ADAPT} files.)
11175 @end table
11176 @end enumerate
11177
11178 @item mark
11179 The value of this entry should be a number.  Any articles with a score
11180 lower than this number will be marked as read.
11181
11182 @item expunge
11183 The value of this entry should be a number.  Any articles with a score
11184 lower than this number will be removed from the summary buffer.
11185
11186 @item mark-and-expunge
11187 The value of this entry should be a number.  Any articles with a score
11188 lower than this number will be marked as read and removed from the
11189 summary buffer.
11190
11191 @item thread-mark-and-expunge
11192 The value of this entry should be a number.  All articles that belong to
11193 a thread that has a total score below this number will be marked as read
11194 and removed from the summary buffer.  @code{gnus-thread-score-function}
11195 says how to compute the total score for a thread.
11196
11197 @item files
11198 The value of this entry should be any number of file names.  These files
11199 are assumed to be score files as well, and will be loaded the same way
11200 this one was.
11201
11202 @item exclude-files
11203 The clue of this entry should be any number of files.  These files will
11204 not be loaded, even though they would normally be so, for some reason or
11205 other. 
11206
11207 @item eval
11208 The value of this entry will be @code{eval}el.  This element will be
11209 ignored when handling global score files. 
11210
11211 @item read-only
11212 Read-only score files will not be updated or saved.  Global score files
11213 should feature this atom (@pxref{Global Score Files}).
11214
11215 @item orphan
11216 The value of this entry should be a number.  Articles that do not have
11217 parents will get this number added to their scores.  Imagine you follow
11218 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
11219 will only follow a few of the threads, also want to see any new threads.
11220
11221 You can do this with the following two score file entries:
11222
11223 @example
11224         (orphan -500)
11225         (mark-and-expunge -100)
11226 @end example
11227
11228 When you enter the group the first time, you will only see the new
11229 threads.  You then raise the score of the threads that you find
11230 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11231 rest.  Next time you enter the group, you will see new articles in the
11232 interesting threads, plus any new threads.
11233
11234 I.e.---the orphan score atom is for high-volume groups where there
11235 exist a few interesting threads which can't be found automatically by
11236 ordinary scoring rules.
11237
11238 @item adapt
11239 This entry controls the adaptive scoring.  If it is @code{t}, the
11240 default adaptive scoring rules will be used.  If it is @code{ignore}, no
11241 adaptive scoring will be performed on this group.  If it is a list, this
11242 list will be used as the adaptive scoring rules.  If it isn't present,
11243 or is something other than @code{t} or @code{ignore}, the default
11244 adaptive scoring rules will be used.  If you want to use adaptive
11245 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11246 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11247 not want adaptive scoring.  If you only want adaptive scoring in a few
11248 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11249 insert @code{(adapt t)} in the score files of the groups where you want
11250 it. 
11251
11252 @item adapt-file
11253 All adaptive score entries will go to the file named by this entry.  It
11254 will also be applied when entering the group.  This atom might be handy
11255 if you want to adapt on several groups at once, using the same adaptive
11256 file for a number of groups.
11257
11258 @item local
11259 @cindex local variables
11260 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11261 Each @var{var} will be made buffer-local to the current summary buffer,
11262 and set to the value specified.  This is a convenient, if somewhat
11263 strange, way of setting variables in some groups if you don't like hooks
11264 much.
11265 @end table
11266
11267
11268 @node Score File Editing
11269 @section Score File Editing
11270
11271 You normally enter all scoring commands from the summary buffer, but you
11272 might feel the urge to edit them by hand as well, so we've supplied you
11273 with a mode for that.  
11274
11275 It's simply a slightly customized @code{emacs-lisp} mode, with these
11276 additional commands:
11277
11278 @table @kbd
11279
11280 @item C-c C-c
11281 @kindex C-c C-c (Score)
11282 @findex gnus-score-edit-done
11283 Save the changes you have made and return to the summary buffer
11284 (@code{gnus-score-edit-done}). 
11285
11286 @item C-c C-d
11287 @kindex C-c C-d (Score)
11288 @findex gnus-score-edit-insert-date
11289 Insert the current date in numerical format
11290 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
11291 you were wondering.
11292
11293 @item C-c C-p
11294 @kindex C-c C-p (Score)
11295 @findex gnus-score-pretty-print
11296 The adaptive score files are saved in an unformatted fashion.  If you
11297 intend to read one of these files, you want to @dfn{pretty print} it
11298 first.  This command (@code{gnus-score-pretty-print}) does that for
11299 you. 
11300
11301 @end table
11302
11303 Type @kbd{M-x gnus-score-mode} to use this mode.
11304
11305 @vindex gnus-score-mode-hook
11306 @code{gnus-score-menu-hook} is run in score mode buffers.
11307
11308 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11309 e} to begin editing score files.
11310
11311
11312 @node Adaptive Scoring
11313 @section Adaptive Scoring
11314 @cindex adaptive scoring
11315
11316 If all this scoring is getting you down, Gnus has a way of making it all
11317 happen automatically---as if by magic.  Or rather, as if by artificial
11318 stupidity, to be precise.
11319
11320 @vindex gnus-use-adaptive-scoring
11321 When you read an article, or mark an article as read, or kill an
11322 article, you leave marks behind.  On exit from the group, Gnus can sniff
11323 these marks and add score elements depending on what marks it finds.
11324 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11325 @code{t} or @code{(line)}.  If you want score adaptively on separate
11326 words appearing in the subjects, you should set this variable to
11327 @code{(word)}.  If you want to use both adaptive methods, set this
11328 variable to @code{(word line)}.
11329
11330 @vindex gnus-default-adaptive-score-alist
11331 To give you complete control over the scoring process, you can customize
11332 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11333 might look something like this:
11334
11335 @lisp
11336 (defvar gnus-default-adaptive-score-alist
11337   '((gnus-unread-mark)
11338     (gnus-ticked-mark (from 4))
11339     (gnus-dormant-mark (from 5))
11340     (gnus-del-mark (from -4) (subject -1))
11341     (gnus-read-mark (from 4) (subject 2))
11342     (gnus-expirable-mark (from -1) (subject -1))
11343     (gnus-killed-mark (from -1) (subject -3))
11344     (gnus-kill-file-mark)
11345     (gnus-ancient-mark)
11346     (gnus-low-score-mark)
11347     (gnus-catchup-mark (from -1) (subject -1))))
11348 @end lisp
11349
11350 As you see, each element in this alist has a mark as a key (either a
11351 variable name or a ``real'' mark---a character).  Following this key is
11352 a arbitrary number of header/score pairs.  If there are no header/score
11353 pairs following the key, no adaptive scoring will be done on articles
11354 that have that key as the article mark.  For instance, articles with
11355 @code{gnus-unread-mark} in the example above will not get adaptive score
11356 entries.
11357
11358 Each article can have only one mark, so just a single of these rules
11359 will be applied to each article.
11360
11361 To take @code{gnus-del-mark} as an example---this alist says that all
11362 articles that have that mark (i.e., are marked with @samp{D}) will have a
11363 score entry added to lower based on the @code{From} header by -4, and
11364 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11365
11366 If you have marked 10 articles with the same subject with
11367 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11368 That means that that subject will get a score of ten times -1, which
11369 should be, unless I'm much mistaken, -10.
11370
11371 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11372 the read articles will be marked with the @samp{E} mark.  This'll
11373 probably make adaptive scoring slightly impossible, so auto-expiring and
11374 adaptive scoring doesn't really mix very well.
11375
11376 The headers you can score on are @code{from}, @code{subject},
11377 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11378 @code{chars} and @code{date}.  In addition, you can score on
11379 @code{followup}, which will create an adaptive score entry that matches
11380 on the @code{References} header using the @code{Message-ID} of the
11381 current article, thereby matching the following thread.  
11382
11383 You can also score on @code{thread}, which will try to score all
11384 articles that appear in a thread.  @code{thread} matches uses a
11385 @code{Message-ID} to match on the @code{References} header of the
11386 article.  If the match is made, the @code{Message-ID} of the article is
11387 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11388 aspirins afterwards.)
11389
11390 If you use this scheme, you should set the score file atom @code{mark}
11391 to something small---like -300, perhaps, to avoid having small random
11392 changes result in articles getting marked as read.
11393
11394 After using adaptive scoring for a week or so, Gnus should start to
11395 become properly trained and enhance the authors you like best, and kill
11396 the authors you like least, without you having to say so explicitly. 
11397
11398 You can control what groups the adaptive scoring is to be performed on
11399 by using the score files (@pxref{Score File Format}).  This will also
11400 let you use different rules in different groups.
11401
11402 @vindex gnus-adaptive-file-suffix
11403 The adaptive score entries will be put into a file where the name is the
11404 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11405 is @samp{ADAPT}.
11406
11407 @vindex gnus-score-exact-adapt-limit
11408 When doing adaptive scoring, substring or fuzzy matching would probably
11409 give you the best results in most cases.  However, if the header one
11410 matches is short, the possibility for false positives is great, so if
11411 the length of the match is less than
11412 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11413 this variable is @code{nil}, exact matching will always be used to avoid
11414 this problem.
11415
11416 @vindex gnus-default-adaptive-word-score-alist
11417 As mentioned above, you can adapt either on individual words or entire
11418 headers.  If you adapt on words, the
11419 @code{gnus-default-adaptive-word-score-alist} variable says what score
11420 each instance of a word should add given a mark.
11421
11422 @lisp
11423 (setq gnus-default-adaptive-word-score-alist  
11424       `((,gnus-read-mark . 30)
11425         (,gnus-catchup-mark . -10)
11426         (,gnus-killed-mark . -20)
11427         (,gnus-del-mark . -15)))
11428 @end lisp
11429
11430 This is the default value.  If you have adaption on words enabled, every
11431 word that appears in subjects of articles that are marked with
11432 @code{gnus-read-mark} will result in a score rule that increase the
11433 score with 30 points.
11434
11435 @vindex gnus-default-ignored-adaptive-words
11436 @vindex gnus-ignored-adaptive-words
11437 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11438 will be ignored.  If you wish to add more words to be ignored, use the
11439 @code{gnus-ignored-adaptive-words} list instead.
11440
11441 @vindex gnus-adaptive-word-syntax-table
11442 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11443 syntax table in effect.  It is similar to the standard syntax table, but
11444 it considers numbers to be non-word-constituent characters.
11445
11446 After using this scheme for a while, it might be nice to write a
11447 @code{gnus-psychoanalyze-user} command to go through the rules and see
11448 what words you like and what words you don't like.  Or perhaps not.
11449
11450 Note that the adaptive word scoring thing is highly experimental and is
11451 likely to change in the future.  Initial impressions seem to indicate
11452 that it's totally useless as it stands.  Some more work (involving more
11453 rigorous statistical methods) will have to be done to make this useful. 
11454
11455
11456 @node Home Score File
11457 @section Home Score File
11458
11459 The score file where new score file entries will go is called the
11460 @dfn{home score file}.  This is normally (and by default) the score file
11461 for the group itself.  For instance, the home score file for
11462 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11463
11464 However, this may not be what you want.  It is often convenient to share
11465 a common home score file among many groups---all @samp{emacs} groups
11466 could perhaps use the same home score file.
11467
11468 @vindex gnus-home-score-file
11469 The variable that controls this is @code{gnus-home-score-file}.  It can
11470 be:
11471
11472 @enumerate
11473 @item
11474 A string.  Then this file will be used as the home score file for all
11475 groups. 
11476
11477 @item
11478 A function. The result of this function will be used as the home score
11479 file.  The function will be called with the name of the group as the
11480 parameter. 
11481
11482 @item
11483 A list.  The elements in this list can be:
11484
11485 @enumerate
11486 @item 
11487 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11488 the @var{file-name} will will be used as the home score file.
11489
11490 @item 
11491 A function. If the function returns non-nil, the result will be used as
11492 the home score file.
11493
11494 @item 
11495 A string.  Use the string as the home score file.
11496 @end enumerate
11497
11498 The list will be traversed from the beginning towards the end looking
11499 for matches.
11500
11501 @end enumerate
11502
11503 So, if you want to use just a single score file, you could say:
11504
11505 @lisp
11506 (setq gnus-home-score-file
11507       "my-total-score-file.SCORE")
11508 @end lisp
11509
11510 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11511 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11512
11513 @lisp
11514 (setq gnus-home-score-file
11515       'gnus-hierarchial-home-score-file)
11516 @end lisp
11517
11518 This is a ready-made function provided for your convenience.
11519
11520 If you want to have one score file for the @samp{emacs} groups and
11521 another for the @samp{comp} groups, while letting all other groups use
11522 their own home score files:
11523
11524 @lisp
11525 (setq gnus-home-score-file
11526       ;; All groups that match the regexp "\\.emacs"
11527       '("\\.emacs" "emacs.SCORE")
11528       ;; All the comp groups in one score file
11529        ("^comp" "comp.SCORE"))
11530 @end lisp
11531    
11532 @vindex gnus-home-adapt-file
11533 @code{gnus-home-adapt-file} works exactly the same way as
11534 @code{gnus-home-score-file}, but says what the home adaptive score file
11535 is instead.  All new adaptive file entries will go into the file
11536 specified by this variable, and the same syntax is allowed.
11537
11538 In addition to using @code{gnus-home-score-file} and
11539 @code{gnus-home-adapt-file}, you can also use group parameters
11540 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11541 Parameters}) to achieve much the same.  Group and topic parameters take
11542 precedence over this variable.
11543
11544
11545 @node Followups To Yourself
11546 @section Followups To Yourself
11547
11548 Gnus offers two commands for picking out the @code{Message-ID} header in
11549 the current buffer.  Gnus will then add a score rule that scores using
11550 this @code{Message-ID} on the @code{References} header of other
11551 articles.  This will, in effect, increase the score of all articles that
11552 respond to the article in the current buffer.  Quite useful if you want
11553 to easily note when people answer what you've said.
11554
11555 @table @code
11556
11557 @item gnus-score-followup-article
11558 @findex gnus-score-followup-article
11559 This will add a score to articles that directly follow up your own
11560 article. 
11561
11562 @item gnus-score-followup-thread
11563 @findex gnus-score-followup-thread
11564 This will add a score to all articles that appear in a thread ``below''
11565 your own article.
11566 @end table
11567
11568 @vindex message-sent-hook
11569 These two functions are both primarily meant to be used in hooks like
11570 @code{message-sent-hook}.  
11571
11572 If you look closely at your own @code{Message-ID}, you'll notice that
11573 the first two or three characters are always the same.  Here's two of
11574 mine:  
11575
11576 @example
11577 <x6u3u47icf.fsf@@eyesore.no>
11578 <x6sp9o7ibw.fsf@@eyesore.no>
11579 @end example
11580
11581 So ``my'' ident on this machine is @samp{x6}.  This can be
11582 exploited---the following rule will raise the score on all followups to
11583 myself: 
11584
11585 @lisp
11586 ("references"
11587  ("<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r))
11588 @end lisp
11589
11590 Whether it's the first two or first three characters that are ``yours''
11591 is system-dependent.
11592
11593
11594 @node Scoring Tips
11595 @section Scoring Tips
11596 @cindex scoring tips
11597
11598 @table @dfn
11599
11600 @item Crossposts
11601 @cindex crossposts
11602 @cindex scoring crossposts
11603 If you want to lower the score of crossposts, the line to match on is
11604 the @code{Xref} header.
11605 @lisp
11606 ("xref" (" talk.politics.misc:" -1000))
11607 @end lisp
11608
11609 @item Multiple crossposts
11610 If you want to lower the score of articles that have been crossposted to
11611 more than, say, 3 groups:
11612 @lisp
11613 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11614 @end lisp
11615
11616 @item Matching on the body
11617 This is generally not a very good idea---it takes a very long time.
11618 Gnus actually has to fetch each individual article from the server.  But
11619 you might want to anyway, I guess.  Even though there are three match
11620 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11621 and stick with it in each score file.  If you use any two, each article
11622 will be fetched @emph{twice}.  If you want to match a bit on the
11623 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11624 the matches.  
11625
11626 @item Marking as read
11627 You will probably want to mark articles that has a score below a certain
11628 number as read.  This is most easily achieved by putting the following
11629 in your @file{all.SCORE} file:
11630 @lisp
11631 ((mark -100))
11632 @end lisp
11633 You may also consider doing something similar with @code{expunge}.  
11634
11635 @item Negated character classes
11636 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11637 That will match newlines, which might lead to, well, The Unknown.  Say
11638 @code{[^abcd\n]*} instead.
11639 @end table
11640
11641
11642 @node Reverse Scoring
11643 @section Reverse Scoring
11644 @cindex reverse scoring
11645
11646 If you want to keep just articles that have @samp{Sex with Emacs} in the
11647 subject header, and expunge all other articles, you could put something
11648 like this in your score file:
11649
11650 @lisp
11651 (("subject"
11652   ("Sex with Emacs" 2))
11653  (mark 1)
11654  (expunge 1))
11655 @end lisp
11656
11657 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11658 rest as read, and expunge them to boot.
11659
11660
11661 @node Global Score Files
11662 @section Global Score Files
11663 @cindex global score files
11664
11665 Sure, other newsreaders have ``global kill files''.  These are usually
11666 nothing more than a single kill file that applies to all groups, stored
11667 in the user's home directory.  Bah!  Puny, weak newsreaders!
11668
11669 What I'm talking about here are Global Score Files.  Score files from
11670 all over the world, from users everywhere, uniting all nations in one
11671 big, happy score file union!  Ange-score!  New and untested!
11672
11673 @vindex gnus-global-score-files
11674 All you have to do to use other people's score files is to set the
11675 @code{gnus-global-score-files} variable.  One entry for each score file,
11676 or each score file directory.  Gnus will decide by itself what score
11677 files are applicable to which group.
11678
11679 Say you want to use the score file
11680 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
11681 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11682
11683 @lisp
11684 (setq gnus-global-score-files
11685       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
11686         "/ftp@@ftp.some-where:/pub/score/"))
11687 @end lisp
11688
11689 @findex gnus-score-search-global-directories
11690 Simple, eh?  Directory names must end with a @samp{/}.  These
11691 directories are typically scanned only once during each Gnus session.
11692 If you feel the need to manually re-scan the remote directories, you can
11693 use the @code{gnus-score-search-global-directories} command.
11694
11695 Note that, at present, using this option will slow down group entry
11696 somewhat.  (That is---a lot.)
11697
11698 If you want to start maintaining score files for other people to use,
11699 just put your score file up for anonymous ftp and announce it to the
11700 world.  Become a retro-moderator!  Participate in the retro-moderator
11701 wars sure to ensue, where retro-moderators battle it out for the
11702 sympathy of the people, luring them to use their score files on false
11703 premises!  Yay!  The net is saved!
11704
11705 Here are some tips for the would-be retro-moderator, off the top of my
11706 head: 
11707
11708 @itemize @bullet
11709
11710 @item 
11711 Articles that are heavily crossposted are probably junk. 
11712 @item
11713 To lower a single inappropriate article, lower by @code{Message-ID}.
11714 @item
11715 Particularly brilliant authors can be raised on a permanent basis. 
11716 @item
11717 Authors that repeatedly post off-charter for the group can safely be
11718 lowered out of existence.
11719 @item
11720 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11721 articles completely.
11722
11723 @item 
11724 Use expiring score entries to keep the size of the file down.  You
11725 should probably have a long expiry period, though, as some sites keep
11726 old articles for a long time.
11727 @end itemize
11728
11729 ... I wonder whether other newsreaders will support global score files
11730 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11731 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11732 holding our breath yet?
11733
11734
11735 @node Kill Files
11736 @section Kill Files
11737 @cindex kill files
11738
11739 Gnus still supports those pesky old kill files.  In fact, the kill file
11740 entries can now be expiring, which is something I wrote before Daniel
11741 Quinlan thought of doing score files, so I've left the code in there.
11742
11743 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11744 than score processing, so it might be a good idea to rewrite your kill
11745 files into score files.
11746
11747 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11748 forms into this file, which means that you can use kill files as some
11749 sort of primitive hook function to be run on group entry, even though
11750 that isn't a very good idea.
11751
11752 Normal kill files look like this:
11753
11754 @lisp
11755 (gnus-kill "From" "Lars Ingebrigtsen")
11756 (gnus-kill "Subject" "ding")
11757 (gnus-expunge "X")
11758 @end lisp
11759
11760 This will mark every article written by me as read, and remove them from
11761 the summary buffer.  Very useful, you'll agree.
11762
11763 Other programs use a totally different kill file syntax.  If Gnus
11764 encounters what looks like a @code{rn} kill file, it will take a stab at
11765 interpreting it. 
11766
11767 Two summary functions for editing a GNUS kill file:
11768
11769 @table @kbd
11770
11771 @item M-k
11772 @kindex M-k (Summary)
11773 @findex gnus-summary-edit-local-kill
11774 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11775
11776 @item M-K
11777 @kindex M-K (Summary)
11778 @findex gnus-summary-edit-global-kill
11779 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11780 @end table
11781
11782 Two group mode functions for editing the kill files:
11783
11784 @table @kbd
11785
11786 @item M-k
11787 @kindex M-k (Group)
11788 @findex gnus-group-edit-local-kill
11789 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11790
11791 @item M-K
11792 @kindex M-K (Group)
11793 @findex gnus-group-edit-global-kill
11794 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11795 @end table
11796
11797 Kill file variables:
11798
11799 @table @code
11800 @item gnus-kill-file-name
11801 @vindex gnus-kill-file-name
11802 A kill file for the group @samp{soc.motss} is normally called
11803 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11804 this file name is detailed by the @code{gnus-kill-file-name} variable.
11805 The ``global'' kill file (not in the score file sense of ``global'', of
11806 course) is called just @file{KILL}.
11807
11808 @vindex gnus-kill-save-kill-file
11809 @item gnus-kill-save-kill-file
11810 If this variable is non-@code{nil}, Gnus will save the
11811 kill file after processing, which is necessary if you use expiring
11812 kills. 
11813
11814 @item gnus-apply-kill-hook
11815 @vindex gnus-apply-kill-hook
11816 @findex gnus-apply-kill-file-unless-scored
11817 @findex gnus-apply-kill-file
11818 A hook called to apply kill files to a group.  It is
11819 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11820 kill file if you have a score file for the same group, you can set this
11821 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11822 kill files to be processed, you should set this variable to @code{nil}.
11823
11824 @item gnus-kill-file-mode-hook
11825 @vindex gnus-kill-file-mode-hook
11826 A hook called in kill-file mode buffers.
11827
11828 @end table
11829
11830
11831 @node Converting Kill Files
11832 @section Converting Kill Files
11833 @cindex kill files
11834 @cindex converting kill files
11835
11836 If you have loads of old kill files, you may want to convert them into
11837 score files.  If they are ``regular'', you can use
11838 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11839 by hand.
11840
11841 The kill to score conversion package isn't included in Gnus by default.
11842 You can fetch it from
11843 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11844
11845 If your old kill files are very complex---if they contain more
11846 non-@code{gnus-kill} forms than not, you'll have to convert them by
11847 hand.  Or just let them be as they are.  Gnus will still use them as
11848 before. 
11849
11850
11851 @node GroupLens
11852 @section GroupLens
11853 @cindex GroupLens
11854
11855 GroupLens is a collaborative filtering system that helps you work
11856 together with other people to find the quality news articles out of the
11857 huge volume of news articles generated every day.
11858
11859 To accomplish this the GroupLens system combines your opinions about
11860 articles you have already read with the opinions of others who have done
11861 likewise and gives you a personalized prediction for each unread news
11862 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11863 rate articles, and finds other people that rate articles the same way.
11864 Once it has found for you some people you agree with it tells you, in
11865 the form of a prediction, what they thought of the article.  You can use
11866 this prediction to help you decide whether or not you want to read the
11867 article.
11868
11869 @menu
11870 * Using GroupLens::          How to make Gnus use GroupLens.
11871 * Rating Articles::          Letting GroupLens know how you rate articles.
11872 * Displaying Predictions::   Displaying predictions given by GroupLens.
11873 * GroupLens Variables::      Customizing GroupLens.
11874 @end menu
11875
11876
11877 @node Using GroupLens
11878 @subsection Using GroupLens
11879
11880 To use GroupLens you must register a pseudonym with your local Better
11881 Bit Bureau (BBB).
11882 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11883 better bit in town is at the moment.
11884
11885 Once you have registered you'll need to set a couple of variables.
11886
11887 @table @code
11888
11889 @item gnus-use-grouplens
11890 @vindex gnus-use-grouplens
11891 Setting this variable to a non-@code{nil} value will make Gnus hook into
11892 all the relevant GroupLens functions.
11893
11894 @item grouplens-pseudonym
11895 @vindex grouplens-pseudonym
11896 This variable should be set to the pseudonym you got when registering
11897 with the Better Bit Bureau.
11898
11899 @item grouplens-newsgroups
11900 @vindex grouplens-newsgroups
11901 A list of groups that you want to get GroupLens predictions for. 
11902
11903 @end table
11904
11905 Thats the minimum of what you need to get up and running with GroupLens.
11906 Once you've registered, GroupLens will start giving you scores for
11907 articles based on the average of what other people think.  But, to get
11908 the real benefit of GroupLens you need to start rating articles
11909 yourself.  Then the scores GroupLens gives you will be personalized for
11910 you, based on how the people you usually agree with have already rated.
11911
11912
11913 @node Rating Articles
11914 @subsection Rating Articles
11915
11916 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11917 Where 1 means something like this article is a waste of bandwidth and 5
11918 means that the article was really good.  The basic question to ask
11919 yourself is, "on a scale from 1 to 5 would I like to see more articles
11920 like this one?"
11921
11922 There are four ways to enter a rating for an article in GroupLens.
11923
11924 @table @kbd
11925
11926 @item r
11927 @kindex r (GroupLens)
11928 @findex bbb-summary-rate-article
11929 This function will prompt you for a rating on a scale of one to five.
11930
11931 @item k
11932 @kindex k (GroupLens)
11933 @findex grouplens-score-thread
11934 This function will prompt you for a rating, and rate all the articles in
11935 the thread.  This is really useful for some of those long running giant
11936 threads in rec.humor.
11937
11938 @end table
11939
11940 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11941 the score of the article you're reading.
11942
11943 @table @kbd
11944
11945 @item 1-5 n
11946 @kindex n (GroupLens)
11947 @findex grouplens-next-unread-article
11948 Rate the article and go to the next unread article.
11949
11950 @item 1-5 ,
11951 @kindex , (GroupLens)
11952 @findex grouplens-best-unread-article
11953 Rate the article and go to the next unread article with the highest score.
11954
11955 @end table
11956
11957 If you want to give the current article a score of 4 and then go to the
11958 next article, just type @kbd{4 n}.
11959
11960
11961 @node Displaying Predictions
11962 @subsection Displaying Predictions
11963
11964 GroupLens makes a prediction for you about how much you will like a
11965 news article.  The predictions from GroupLens are on a scale from 1 to
11966 5, where 1 is the worst and 5 is the best.  You can use the predictions
11967 from GroupLens in one of three ways controlled by the variable
11968 @code{gnus-grouplens-override-scoring}.
11969
11970 @vindex gnus-grouplens-override-scoring
11971 There are three ways to display predictions in grouplens.  You may
11972 choose to have the GroupLens scores contribute to, or override the
11973 regular gnus scoring mechanism. override is the default; however, some
11974 people prefer to see the Gnus scores plus the grouplens scores.  To get
11975 the separate scoring behavior you need to set
11976 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11977 GroupLens predictions combined with the grouplens scores set it to
11978 @code{'override} and to combine the scores set
11979 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11980 the combine option you will also want to set the values for
11981 @code{grouplens-prediction-offset} and
11982 @code{grouplens-score-scale-factor}.
11983
11984 @vindex grouplens-prediction-display
11985 In either case, GroupLens gives you a few choices for how you would like
11986 to see your predictions displayed.  The display of predictions is
11987 controlled by the @code{grouplens-prediction-display} variable.
11988
11989 The following are legal values for that variable.
11990
11991 @table @code
11992 @item prediction-spot
11993 The higher the prediction, the further to the right an @samp{*} is
11994 displayed. 
11995
11996 @item confidence-interval
11997 A numeric confidence interval.
11998
11999 @item prediction-bar
12000 The higher the prediction, the longer the bar.
12001
12002 @item confidence-bar
12003 Numerical confidence.
12004
12005 @item confidence-spot
12006 The spot gets bigger with more confidence.
12007
12008 @item prediction-num
12009 Plain-old numeric value.
12010
12011 @item confidence-plus-minus
12012 Prediction +/i confidence.
12013
12014 @end table
12015
12016
12017 @node GroupLens Variables
12018 @subsection GroupLens Variables
12019
12020 @table @code
12021
12022 @item gnus-summary-grouplens-line-format
12023 The summary line format used in summary buffers that are GroupLens
12024 enhanced.  It accepts the same specs as the normal summary line format
12025 (@pxref{Summary Buffer Lines}).  The default is
12026 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
12027
12028 @item grouplens-bbb-host
12029 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
12030 default.
12031
12032 @item grouplens-bbb-port
12033 Port of the host running the bbbd server.  The default is 9000.
12034
12035 @item grouplens-score-offset
12036 Offset the prediction by this value.  In other words, subtract the
12037 prediction value by this number to arrive at the effective score.  The
12038 default is 0.
12039
12040 @item grouplens-score-scale-factor 
12041 This variable allows the user to magnify the effect of GroupLens scores.
12042 The scale factor is applied after the offset.  The default is 1.
12043
12044 @end table
12045
12046
12047 @node Advanced Scoring
12048 @section Advanced Scoring
12049
12050 Scoring on Subjects and From headers is nice enough, but what if you're
12051 really interested in what a person has to say only when she's talking
12052 about a particular subject?  Or what about if you really don't want to
12053 read what person A has to say when she's following up to person B, but
12054 want to read what she says when she's following up to person C?
12055
12056 By using advanced scoring rules you may create arbitrarily complex
12057 scoring patterns.
12058
12059 @menu
12060 * Advanced Scoring Syntax::     A definition.
12061 * Advanced Scoring Examples::   What they look like.
12062 * Advanced Scoring Tips::       Getting the most out of it.
12063 @end menu
12064
12065
12066 @node Advanced Scoring Syntax
12067 @subsection Advanced Scoring Syntax
12068
12069 Ordinary scoring rules have a string as the first element in the rule.
12070 Advanced scoring rules have a list as the first element.  The second
12071 element is the score to be applied if the first element evaluated to a
12072 non-@code{nil} value.
12073
12074 These lists may consist of three logical operators, one redirection
12075 operator, and various match operators.
12076
12077 Logical operators:
12078
12079 @table @code
12080 @item &
12081 @itemx and
12082 This logical operator will evaluate each of its arguments until it finds
12083 one that evaluates to @code{false}, and then it'll stop.  If all arguments
12084 evaluate to @code{true} values, then this operator will return
12085 @code{true}. 
12086
12087 @item |
12088 @itemx or
12089 This logical operator will evaluate each of its arguments until it finds
12090 one that evaluates to @code{true}.  If no arguments are @code{true},
12091 then this operator will return @code{false}.
12092
12093 @item !
12094 @itemx not
12095 @itemx Â¬
12096 This logical operator only takes a single argument.  It returns the
12097 inverse of the value of its argument.
12098
12099 @end table
12100
12101 There is an @dfn{indirection operator} that will make its arguments
12102 apply to the ancestors of the current article being scored.  For
12103 instance, @code{1-} will make score rules apply to the parent of the
12104 current article.  @code{2-} will make score fules apply to the
12105 grandparent of the current article.  Alternatively, you can write
12106 @code{^^}, where the number of @code{^}s (carets) say how far back into
12107 the ancestry you want to go.
12108
12109 Finally, we have the match operators.  These are the ones that do the
12110 real work.  Match operators are header name strings followed by a match
12111 and a match type.  A typical match operator looks like @samp{("from"
12112 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
12113 simple scoring, and the match types are also the same.
12114
12115
12116 @node Advanced Scoring Examples
12117 @subsection Advanced Scoring Examples
12118
12119 Let's say you want to increase the score of articles written by Lars
12120 when he's talking about Gnus:
12121
12122 @example
12123 ((& 
12124   ("from" "Lars Ingebrigtsen")
12125   ("subject" "Gnus"))
12126  1000)
12127 @end example
12128
12129 Quite simple, huh?
12130
12131 When he writes long articles, he sometimes has something nice to say: 
12132
12133 @example
12134 ((& 
12135   ("from" "Lars Ingebrigtsen")
12136   (|
12137    ("subject" "Gnus")
12138    ("lines" 100 >)))
12139  1000)
12140 @end example
12141
12142 However, when he responds to things written by Reig Eigil Logge, you
12143 really don't want to read what he's written:
12144
12145 @example
12146 ((&
12147   ("from" "Lars Ingebrigtsen")
12148   (1- ("from" "Reig Eigir Logge")))
12149  -100000)
12150 @end example
12151
12152 Everybody that follows up Redmondo when he writes about disappearing
12153 socks should have their scores raised, but only when they talk about
12154 white socks.  However, when Lars talks about socks, it's usually not
12155 very interesting:
12156
12157 @example
12158 ((&
12159   (1-
12160    (&
12161     ("from" "redmondo@@.*no" r)
12162     ("body" "disappearing.*socks" t)))
12163   (! ("from" "Lars Ingebrigtsen"))
12164   ("body" "white.*socks"))
12165  1000)
12166 @end example
12167
12168 The possibilities are endless.
12169
12170
12171 @node Advanced Scoring Tips
12172 @subsection Advanced Scoring Tips
12173
12174 The @code{&} and @code{|} logical operators do short-circuit logic.
12175 That is, they stop processing their arguments when it's clear what the
12176 result of the operation will be.  For instance, if one of the arguments
12177 of an @code{&} evaluates to @code{false}, there's no point in evaluating
12178 the rest of the arguments.  This means that you should put slow matches
12179 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12180 @samp{subject}) first.
12181
12182 The indirection arguments (@code{1-} and so on) will make their
12183 arguments work on previous generations of the thread.  If you say
12184 something like:
12185
12186 @example
12187 ...
12188 (1-
12189  (1-
12190   ("from" "lars")))
12191 ...
12192 @end example
12193
12194 Then that means "score on the from header of the grandparent of the
12195 current article".  An indirection is quite fast, but it's better to say:
12196
12197 @example
12198 (1-
12199  (& 
12200   ("from" "Lars")
12201   ("subject" "Gnus")))
12202 @end example
12203
12204 than it is to say:
12205
12206 @example
12207 (&
12208  (1- ("from" "Lars"))
12209  (1- ("subject" "Gnus")))
12210 @end example
12211
12212
12213 @node Score Decays
12214 @section Score Decays
12215 @cindex score decays
12216 @cindex decays
12217
12218 You may find that your scores have a tendency to grow without
12219 bounds, especially if you're using adaptive scoring.  If scores get too
12220 big, they lose all meaning---they simply max out and it's difficult to
12221 use them in any sensible way.
12222
12223 @vindex gnus-decay-scores
12224 @findex gnus-decay-score
12225 @vindex gnus-score-decay-function
12226 Gnus provides a mechanism for decaying scores to help with this problem.
12227 When score files are loaded and @code{gnus-decay-scores} is
12228 non-@code{nil}, Gnus will run the score files through the decaying
12229 mechanism thereby lowering the scores of all non-permanent score rules.
12230 The decay itself if performed by the @code{gnus-score-decay-function}
12231 function, which is @code{gnus-decay-score} by default.  Here's the
12232 definition of that function:
12233
12234 @lisp
12235 (defun gnus-decay-score (score)
12236   (floor
12237    (- score
12238       (* (if (< score 0) 1 -1)
12239          (min score
12240               (max gnus-score-decay-constant
12241                    (* (abs score)
12242                       gnus-score-decay-scale)))))))
12243 @end lisp
12244
12245 @vindex gnus-score-decay-scale
12246 @vindex gnus-score-decay-constant
12247 @code{gnus-score-decay-constant} is 3 by default and
12248 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
12249
12250 @enumerate
12251 @item
12252 Scores between -3 and 3 will be set to 0 when this function is called.
12253
12254 @item
12255 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12256
12257 @item
12258 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12259 score.
12260 @end enumerate
12261
12262 If you don't like this decay function, write your own.  It is called
12263 with the score to be decayed as its only parameter, and it should return
12264 the new score, which should be an integer.
12265
12266 Gnus will try to decay scores once a day.  If you haven't run Gnus for
12267 four days, Gnus will decay the scores four times, for instance.
12268
12269
12270 @node Various
12271 @chapter Various
12272
12273 @menu
12274 * Process/Prefix::             A convention used by many treatment commands.
12275 * Interactive::                Making Gnus ask you many questions.
12276 * Formatting Variables::       You can specify what buffers should look like.
12277 * Windows Configuration::      Configuring the Gnus buffer windows.
12278 * Compilation::                How to speed Gnus up.
12279 * Mode Lines::                 Displaying information in the mode lines.
12280 * Highlighting and Menus::     Making buffers look all nice and cozy.
12281 * Buttons::                    Get tendonitis in ten easy steps!
12282 * Daemons::                    Gnus can do things behind your back.
12283 * NoCeM::                      How to avoid spam and other fatty foods.
12284 * Picons::                     How to display pictures of what your reading.
12285 * Undo::                       Some actions can be undone.
12286 * Moderation::                 What to do if you're a moderator.
12287 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
12288 * Fuzzy Matching::             What's the big fuzz?
12289 * Thwarting Email Spam::       A how-to on avoiding unsolited commercial email.
12290 * Various Various::            Things that are really various.
12291 @end menu
12292
12293
12294 @node Process/Prefix
12295 @section Process/Prefix
12296 @cindex process/prefix convention
12297
12298 Many functions, among them functions for moving, decoding and saving
12299 articles, use what is known as the @dfn{Process/Prefix convention}.
12300
12301 This is a method for figuring out what articles that the user wants the
12302 command to be performed on.
12303
12304 It goes like this:
12305
12306 If the numeric prefix is N, perform the operation on the next N
12307 articles, starting with the current one.  If the numeric prefix is
12308 negative, perform the operation on the previous N articles, starting
12309 with the current one.
12310
12311 @vindex transient-mark-mode
12312 If @code{transient-mark-mode} in non-@code{nil} and the region is
12313 active, all articles in the region will be worked upon.
12314
12315 If there is no numeric prefix, but some articles are marked with the
12316 process mark, perform the operation on the articles that are marked with
12317 the process mark.
12318
12319 If there is neither a numeric prefix nor any articles marked with the
12320 process mark, just perform the operation on the current article.
12321
12322 Quite simple, really, but it needs to be made clear so that surprises
12323 are avoided.
12324
12325 Commands that react to the process mark will push the current list of
12326 process marked articles onto a stack and will then clear all process
12327 marked articles.  You can restore the previous configuration with the
12328 @kbd{M P y} command (@pxref{Setting Process Marks}).
12329
12330 @vindex gnus-summary-goto-unread
12331 One thing that seems to shock & horrify lots of people is that, for
12332 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12333 Since each @kbd{d} (which marks the current article as read) by default
12334 goes to the next unread article after marking, this means that @kbd{3 d}
12335 will mark the next three unread articles as read, no matter what the
12336 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12337 @code{nil} for a more straightforward action.
12338
12339
12340 @node Interactive
12341 @section Interactive
12342 @cindex interaction
12343
12344 @table @code
12345
12346 @item gnus-novice-user
12347 @vindex gnus-novice-user
12348 If this variable is non-@code{nil}, you are either a newcomer to the
12349 World of Usenet, or you are very cautious, which is a nice thing to be,
12350 really.  You will be given questions of the type ``Are you sure you want
12351 to do this?'' before doing anything dangerous.  This is @code{t} by
12352 default.
12353
12354 @item gnus-expert-user
12355 @vindex gnus-expert-user
12356 If this variable is non-@code{nil}, you will never ever be asked any
12357 questions by Gnus.  It will simply assume you know what you're doing, no
12358 matter how strange.
12359
12360 @item gnus-interactive-catchup
12361 @vindex gnus-interactive-catchup
12362 Require confirmation before catching up a group if non-@code{nil}.  It
12363 is @code{t} by default.
12364
12365 @item gnus-interactive-exit
12366 @vindex gnus-interactive-exit
12367 Require confirmation before exiting Gnus.  This variable is @code{t} by
12368 default. 
12369 @end table
12370
12371
12372 @node Formatting Variables
12373 @section Formatting Variables
12374 @cindex formatting variables
12375
12376 Throughout this manual you've probably noticed lots of variables that
12377 are called things like @code{gnus-group-line-format} and
12378 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12379 output lines in the various buffers.  There's quite a lot of them.
12380 Fortunately, they all use the same syntax, so there's not that much to
12381 be annoyed by.
12382
12383 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12384 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12385 lots of percentages everywhere.  
12386
12387 @menu 
12388 * Formatting Basics::     A formatting variable is basically a format string.
12389 * Advanced Formatting::   Modifying output in various ways.
12390 * User-Defined Specs::    Having Gnus call your own functions.
12391 * Formatting Fonts::      Making the formatting look colorful and nice.
12392 @end menu
12393
12394 Currently Gnus uses the following formatting variables:
12395 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12396 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12397 @code{gnus-group-mode-line-format},
12398 @code{gnus-summary-mode-line-format},
12399 @code{gnus-article-mode-line-format},
12400 @code{gnus-server-mode-line-format}, and
12401 @code{gnus-summary-pick-line-format}.
12402
12403 All these format variables can also be arbitrary elisp forms.  In that
12404 case, they will be @code{eval}ed to insert the required lines.
12405
12406 @kindex M-x gnus-update-format
12407 @findex gnus-update-format
12408 Gnus includes a command to help you while creating your own format
12409 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12410 update the spec in question and pop you to a buffer where you can
12411 examine the resulting lisp code to be run to generate the line.  
12412
12413
12414
12415 @node Formatting Basics
12416 @subsection Formatting Basics
12417
12418 Each @samp{%} element will be replaced by some string or other when the
12419 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12420 spec, and pad with spaces to get a 5-character field''.
12421
12422 As with normal C and Emacs Lisp formatting strings, the numerical
12423 modifier between the @samp{%} and the formatting type character will
12424 @dfn{pad} the output so that it is always at least that long.
12425 @samp{%5y} will make the field always (at least) five characters wide by
12426 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12427 the right instead.
12428
12429 You may also wish to limit the length of the field to protect against
12430 particularly wide values.  For that you can say @samp{%4,6y}, which
12431 means that the field will never be more than 6 characters wide and never
12432 less than 4 characters wide.
12433
12434
12435 @node Advanced Formatting
12436 @subsection Advanced Formatting
12437
12438 It is frequently useful to post-process the fields in some way.
12439 Padding, limiting, cutting off parts and suppressing certain values can
12440 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12441 look like @samp{%~(cut 3)~(ignore "0")y}.
12442
12443 These are the legal modifiers:
12444
12445 @table @code
12446 @item pad
12447 @itemx pad-left
12448 Pad the field to the left with spaces until it reaches the required
12449 length.
12450
12451 @item pad-right
12452 Pad the field to the right with spaces until it reaches the required
12453 length.
12454
12455 @item max
12456 @itemx max-left
12457 Cut off characters from the left until it reaches the specified length.
12458
12459 @item max-right
12460 Cut off characters from the right until it reaches the specified
12461 length. 
12462
12463 @item cut
12464 @itemx cut-left
12465 Cut off the specified number of characters from the left.
12466
12467 @item cut-right
12468 Cut off the specified number of characters from the right.
12469
12470 @item ignore
12471 Return an empty string if the field is equal to the specified value. 
12472
12473 @item form
12474 Use the specified form as the field value when the @samp{@@} spec is
12475 used. 
12476 @end table
12477
12478 Let's take an example.  The @samp{%o} spec in the summary mode lines
12479 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12480 This is quite a mouthful, so we want to shave off the century number and
12481 the time, leaving us with a six-character date.  That would be
12482 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12483 maxing, and we need the padding to ensure that the date is never less
12484 than 6 characters to make it look nice in columns.)
12485
12486 Ignoring is done first; then cutting; then maxing; and then as the very
12487 last operation, padding.  
12488
12489 If you use lots of these advanced thingies, you'll find that Gnus gets
12490 quite slow.  This can be helped enormously by running @kbd{M-x
12491 gnus-compile} when you are satisfied with the look of your lines.
12492 @xref{Compilation}. 
12493
12494
12495 @node User-Defined Specs
12496 @subsection User-Defined Specs
12497
12498 All the specs allow for inserting user defined specifiers---@samp{u}.
12499 The next character in the format string should be a letter.  Gnus
12500 will call the function @code{gnus-user-format-function-}@samp{X}, where
12501 @samp{X} is the letter following @samp{%u}.  The function will be passed
12502 a single parameter---what the parameter means depends on what buffer
12503 it's being called from.  The function should return a string, which will
12504 be inserted into the buffer just like information from any other
12505 specifier.  This function may also be called with dummy values, so it
12506 should protect against that.
12507
12508 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12509 much the same without defining new functions.  Here's an example:
12510 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12511 given here will be evaluated to yield the current line number, and then
12512 inserted.
12513
12514
12515 @node Formatting Fonts
12516 @subsection Formatting Fonts
12517
12518 There are specs for highlighting, and these are shared by all the format
12519 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12520 the special @code{mouse-face} property set, which means that it will be
12521 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12522 over it.
12523
12524 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12525 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12526 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12527 instead, and so on.  Create as many faces as you wish.  The same goes
12528 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12529 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12530
12531 Here's an alternative recipe for the group buffer:
12532
12533 @lisp
12534 ;; Create three face types.
12535 (setq gnus-face-1 'bold)
12536 (setq gnus-face-3 'italic)
12537
12538 ;; We want the article count to be in 
12539 ;; a bold and green face.  So we create 
12540 ;; a new face called `my-green-bold'.
12541 (copy-face 'bold 'my-green-bold)
12542 ;; Set the color.
12543 (set-face-foreground 'my-green-bold "ForestGreen")
12544 (setq gnus-face-2 'my-green-bold)
12545
12546 ;; Set the new & fancy format.
12547 (setq gnus-group-line-format 
12548       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12549 @end lisp
12550
12551 I'm sure you'll be able to use this scheme to create totally unreadable
12552 and extremely vulgar displays.  Have fun!
12553
12554 Note that the @samp{%(} specs (and friends) do not make any sense on the
12555 mode-line variables.
12556
12557
12558 @node Windows Configuration
12559 @section Windows Configuration
12560 @cindex windows configuration
12561
12562 No, there's nothing here about X, so be quiet.
12563
12564 @vindex gnus-use-full-window
12565 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12566 other windows and occupy the entire Emacs screen by itself.  It is
12567 @code{t} by default.
12568
12569 @vindex gnus-buffer-configuration
12570 @code{gnus-buffer-configuration} describes how much space each Gnus
12571 buffer should be given.  Here's an excerpt of this variable:
12572
12573 @lisp
12574 ((group (vertical 1.0 (group 1.0 point)
12575                       (if gnus-carpal (group-carpal 4))))
12576  (article (vertical 1.0 (summary 0.25 point) 
12577                         (article 1.0))))
12578 @end lisp
12579
12580 This is an alist.  The @dfn{key} is a symbol that names some action or
12581 other.  For instance, when displaying the group buffer, the window
12582 configuration function will use @code{group} as the key.  A full list of
12583 possible names is listed below.
12584
12585 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12586 should occupy.  To take the @code{article} split as an example -
12587
12588 @lisp
12589 (article (vertical 1.0 (summary 0.25 point)
12590                        (article 1.0)))
12591 @end lisp
12592
12593 This @dfn{split} says that the summary buffer should occupy 25% of upper
12594 half of the screen, and that it is placed over the article buffer.  As
12595 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12596 reaching for that calculator there).  However, the special number
12597 @code{1.0} is used to signal that this buffer should soak up all the
12598 rest of the space available after the rest of the buffers have taken
12599 whatever they need.  There should be only one buffer with the @code{1.0}
12600 size spec per split.
12601
12602 Point will be put in the buffer that has the optional third element
12603 @code{point}. 
12604
12605 Here's a more complicated example:
12606
12607 @lisp
12608 (article (vertical 1.0 (group 4)
12609                        (summary 0.25 point)
12610                        (if gnus-carpal (summary-carpal 4))
12611                        (article 1.0)))
12612 @end lisp
12613
12614 If the size spec is an integer instead of a floating point number, 
12615 then that number will be used to say how many lines a buffer should
12616 occupy, not a percentage.
12617
12618 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12619 precise---if the @code{car} of the split is a function or a subr), this
12620 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12621 be used as a split.  This means that there will be three buffers if
12622 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12623 is non-@code{nil}.
12624
12625 Not complicated enough for you?  Well, try this on for size:
12626
12627 @lisp
12628 (article (horizontal 1.0 
12629              (vertical 0.5
12630                  (group 1.0)
12631                  (gnus-carpal 4))
12632              (vertical 1.0
12633                  (summary 0.25 point)
12634                  (summary-carpal 4)
12635                  (article 1.0))))
12636 @end lisp
12637
12638 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12639 @code{horizontal} thingie?  
12640
12641 If the first element in one of the split is @code{horizontal}, Gnus will
12642 split the window horizontally, giving you two windows side-by-side.
12643 Inside each of these strips you may carry on all you like in the normal
12644 fashion.  The number following @code{horizontal} says what percentage of
12645 the screen is to be given to this strip.
12646
12647 For each split, there @emph{must} be one element that has the 100% tag.
12648 The splitting is never accurate, and this buffer will eat any leftover
12649 lines from the splits.
12650
12651 To be slightly more formal, here's a definition of what a legal split
12652 may look like:
12653
12654 @example
12655 split       = frame | horizontal | vertical | buffer | form
12656 frame       = "(frame " size *split ")"
12657 horizontal  = "(horizontal " size *split ")"
12658 vertical    = "(vertical " size *split ")"
12659 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12660 size        = number | frame-params
12661 buffer-name = group | article | summary ...
12662 @end example
12663
12664 The limitations are that the @code{frame} split can only appear as the
12665 top-level split.  @var{form} should be an Emacs Lisp form that should
12666 return a valid split.  We see that each split is fully recursive, and
12667 may contain any number of @code{vertical} and @code{horizontal} splits. 
12668
12669 @vindex gnus-window-min-width
12670 @vindex gnus-window-min-height
12671 @cindex window height
12672 @cindex window width
12673 Finding the right sizes can be a bit complicated.  No window may be less
12674 than @code{gnus-window-min-height} (default 1) characters high, and all
12675 windows must be at least @code{gnus-window-min-width} (default 1)
12676 characters wide.  Gnus will try to enforce this before applying the
12677 splits.  If you want to use the normal Emacs window width/height limit,
12678 you can just set these two variables to @code{nil}.
12679
12680 If you're not familiar with Emacs terminology, @code{horizontal} and
12681 @code{vertical} splits may work the opposite way of what you'd expect.
12682 Windows inside a @code{horizontal} split are shown side-by-side, and
12683 windows within a @code{vertical} split are shown above each other.
12684
12685 @findex gnus-configure-frame
12686 If you want to experiment with window placement, a good tip is to call
12687 @code{gnus-configure-frame} directly with a split.  This is the function
12688 that does all the real work when splitting buffers.  Below is a pretty
12689 nonsensical configuration with 5 windows; two for the group buffer and
12690 three for the article buffer.  (I said it was nonsensical.)  If you
12691 @code{eval} the statement below, you can get an idea of how that would
12692 look straight away, without going through the normal Gnus channels.
12693 Play with it until you're satisfied, and then use
12694 @code{gnus-add-configuration} to add your new creation to the buffer
12695 configuration list. 
12696
12697 @lisp
12698 (gnus-configure-frame
12699  '(horizontal 1.0
12700     (vertical 10
12701       (group 1.0)
12702       (article 0.3 point))
12703     (vertical 1.0
12704       (article 1.0)
12705       (horizontal 4
12706         (group 1.0)
12707         (article 10)))))
12708 @end lisp
12709
12710 You might want to have several frames as well.  No prob---just use the
12711 @code{frame} split:
12712
12713 @lisp
12714 (gnus-configure-frame
12715  '(frame 1.0
12716          (vertical 1.0
12717                    (summary 0.25 point)
12718                    (article 1.0))
12719          (vertical ((height . 5) (width . 15)
12720                     (user-position . t)
12721                     (left . -1) (top . 1))
12722                    (picon 1.0))))
12723
12724 @end lisp
12725
12726 This split will result in the familiar summary/article window
12727 configuration in the first (or ``main'') frame, while a small additional
12728 frame will be created where picons will be shown.  As you can see,
12729 instead of the normal @code{1.0} top-level spec, each additional split
12730 should have a frame parameter alist as the size spec.
12731 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12732 Reference Manual}.
12733
12734 Here's a list of all possible keys for
12735 @code{gnus-buffer-configuration}:
12736
12737 @code{group}, @code{summary}, @code{article}, @code{server},
12738 @code{browse}, @code{message}, @code{pick}, @code{info},
12739 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12740 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12741 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
12742 @code{bug}, @code{compose-bounce}.
12743
12744 Note that the @code{message} key is used for both
12745 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12746 it is desirable to distinguish between the two, something like this
12747 might be used:
12748
12749 @lisp
12750 (message (horizontal 1.0
12751                      (vertical 1.0 (message 1.0 point))
12752                      (vertical 0.24
12753                                (if (buffer-live-p gnus-summary-buffer)
12754                                    '(summary 0.5))
12755                                (group 1.0)))))
12756 @end lisp
12757
12758 @findex gnus-add-configuration
12759 Since the @code{gnus-buffer-configuration} variable is so long and
12760 complicated, there's a function you can use to ease changing the config
12761 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12762 you want to change the @code{article} setting, you could say:
12763
12764 @lisp
12765 (gnus-add-configuration
12766  '(article (vertical 1.0
12767                (group 4)
12768                (summary .25 point)
12769                (article 1.0))))
12770 @end lisp
12771
12772 You'd typically stick these @code{gnus-add-configuration} calls in your
12773 @file{.gnus.el} file or in some startup hook---they should be run after
12774 Gnus has been loaded.
12775
12776 @vindex gnus-always-force-window-configuration
12777 If all windows mentioned in the configuration are already visible, Gnus
12778 won't change the window configuration.  If you always want to force the
12779 ``right'' window configuration, you can set
12780 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12781
12782
12783 @node Compilation
12784 @section Compilation
12785 @cindex compilation
12786 @cindex byte-compilation
12787
12788 @findex gnus-compile
12789
12790 Remember all those line format specification variables?
12791 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12792 on.  Now, Gnus will of course heed whatever these variables are, but,
12793 unfortunately, changing them will mean a quite significant slow-down.
12794 (The default values of these variables have byte-compiled functions
12795 associated with them, while the user-generated versions do not, of
12796 course.) 
12797
12798 To help with this, you can run @kbd{M-x gnus-compile} after you've
12799 fiddled around with the variables and feel that you're (kind of)
12800 satisfied.  This will result in the new specs being byte-compiled, and
12801 you'll get top speed again.  Gnus will save these compiled specs in the
12802 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12803 this function, though---you should compile them yourself by sticking
12804 them into the @code{.gnus.el} file and byte-compiling that file.)
12805
12806
12807 @node Mode Lines
12808 @section Mode Lines
12809 @cindex mode lines
12810
12811 @vindex gnus-updated-mode-lines
12812 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12813 lines updated.  It is a list of symbols.  Supported symbols include
12814 @code{group}, @code{article}, @code{summary}, @code{server},
12815 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12816 Gnus will keep that mode line updated with information that may be
12817 pertinent.  If this variable is @code{nil}, screen refresh may be
12818 quicker.
12819
12820 @cindex display-time
12821
12822 @vindex gnus-mode-non-string-length
12823 By default, Gnus displays information on the current article in the mode
12824 lines of the summary and article buffers.  The information Gnus wishes
12825 to display (e.g. the subject of the article) is often longer than the
12826 mode lines, and therefore have to be cut off at some point.  The
12827 @code{gnus-mode-non-string-length} variable says how long the other
12828 elements on the line is (i.e., the non-info part).  If you put
12829 additional elements on the mode line (e.g. a clock), you should modify
12830 this variable:
12831
12832 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12833 @lisp
12834 (add-hook 'display-time-hook
12835           (lambda () (setq gnus-mode-non-string-length
12836                            (+ 21
12837                               (if line-number-mode 5 0)
12838                               (if column-number-mode 4 0)
12839                               (length display-time-string)))))
12840 @end lisp
12841
12842 If this variable is @code{nil} (which is the default), the mode line
12843 strings won't be chopped off, and they won't be padded either.
12844 Note that the default is unlikely to be desirable, as even the
12845 percentage complete in the buffer may be crowded off the mode line;
12846 the user should configure this variable appropriately for their
12847 configuration.
12848
12849
12850 @node Highlighting and Menus
12851 @section Highlighting and Menus
12852 @cindex visual
12853 @cindex highlighting
12854 @cindex menus
12855
12856 @vindex gnus-visual
12857 The @code{gnus-visual} variable controls most of the prettifying Gnus
12858 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12859 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12860 file.
12861
12862 This variable can be a list of visual properties that are enabled.  The
12863 following elements are legal, and are all included by default:
12864
12865 @table @code
12866 @item group-highlight
12867 Do highlights in the group buffer.
12868 @item summary-highlight
12869 Do highlights in the summary buffer.
12870 @item article-highlight
12871 Do highlights in the article buffer.
12872 @item highlight
12873 Turn on highlighting in all buffers.
12874 @item group-menu
12875 Create menus in the group buffer.
12876 @item summary-menu
12877 Create menus in the summary buffers.
12878 @item article-menu
12879 Create menus in the article buffer.
12880 @item browse-menu
12881 Create menus in the browse buffer.
12882 @item server-menu
12883 Create menus in the server buffer.
12884 @item score-menu
12885 Create menus in the score buffers.
12886 @item menu
12887 Create menus in all buffers.
12888 @end table
12889
12890 So if you only want highlighting in the article buffer and menus in all
12891 buffers, you could say something like:
12892
12893 @lisp
12894 (setq gnus-visual '(article-highlight menu))
12895 @end lisp
12896
12897 If you want only highlighting and no menus whatsoever, you'd say:
12898
12899 @lisp
12900 (setq gnus-visual '(highlight))
12901 @end lisp
12902
12903 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12904 in all Gnus buffers.
12905
12906 Other general variables that influence the look of all buffers include:
12907
12908 @table @code
12909 @item gnus-mouse-face
12910 @vindex gnus-mouse-face
12911 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12912 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12913
12914 @end table
12915
12916 There are hooks associated with the creation of all the different menus:
12917
12918 @table @code
12919
12920 @item gnus-article-menu-hook
12921 @vindex gnus-article-menu-hook
12922 Hook called after creating the article mode menu.
12923
12924 @item gnus-group-menu-hook
12925 @vindex gnus-group-menu-hook
12926 Hook called after creating the group mode menu.
12927
12928 @item gnus-summary-menu-hook
12929 @vindex gnus-summary-menu-hook
12930 Hook called after creating the summary mode menu.
12931
12932 @item gnus-server-menu-hook
12933 @vindex gnus-server-menu-hook
12934 Hook called after creating the server mode menu.
12935
12936 @item gnus-browse-menu-hook
12937 @vindex gnus-browse-menu-hook
12938 Hook called after creating the browse mode menu.
12939
12940 @item gnus-score-menu-hook
12941 @vindex gnus-score-menu-hook
12942 Hook called after creating the score mode menu.
12943
12944 @end table
12945
12946
12947 @node Buttons
12948 @section Buttons
12949 @cindex buttons
12950 @cindex mouse
12951 @cindex click
12952
12953 Those new-fangled @dfn{mouse} contraptions is very popular with the
12954 young, hep kids who don't want to learn the proper way to do things
12955 these days.  Why, I remember way back in the summer of '89, when I was
12956 using Emacs on a Tops 20 system.  Three hundred users on one single
12957 machine, and every user was running Simula compilers.  Bah!
12958
12959 Right.
12960
12961 @vindex gnus-carpal
12962 Well, you can make Gnus display bufferfuls of buttons you can click to
12963 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12964 really.  Tell the chiropractor I sent you.
12965
12966
12967 @table @code
12968
12969 @item gnus-carpal-mode-hook
12970 @vindex gnus-carpal-mode-hook
12971 Hook run in all carpal mode buffers.
12972
12973 @item gnus-carpal-button-face
12974 @vindex gnus-carpal-button-face
12975 Face used on buttons.
12976
12977 @item gnus-carpal-header-face
12978 @vindex gnus-carpal-header-face
12979 Face used on carpal buffer headers.
12980
12981 @item gnus-carpal-group-buffer-buttons
12982 @vindex gnus-carpal-group-buffer-buttons
12983 Buttons in the group buffer.
12984
12985 @item gnus-carpal-summary-buffer-buttons
12986 @vindex gnus-carpal-summary-buffer-buttons
12987 Buttons in the summary buffer.
12988
12989 @item gnus-carpal-server-buffer-buttons
12990 @vindex gnus-carpal-server-buffer-buttons
12991 Buttons in the server buffer.
12992
12993 @item gnus-carpal-browse-buffer-buttons
12994 @vindex gnus-carpal-browse-buffer-buttons
12995 Buttons in the browse buffer.
12996 @end table
12997
12998 All the @code{buttons} variables are lists.  The elements in these list
12999 is either a cons cell where the car contains a text to be displayed and
13000 the cdr contains a function symbol, or a simple string.
13001
13002
13003 @node Daemons
13004 @section Daemons
13005 @cindex demons
13006 @cindex daemons
13007
13008 Gnus, being larger than any program ever written (allegedly), does lots
13009 of strange stuff that you may wish to have done while you're not
13010 present.  For instance, you may want it to check for new mail once in a
13011 while.  Or you may want it to close down all connections to all servers
13012 when you leave Emacs idle.  And stuff like that.
13013
13014 Gnus will let you do stuff like that by defining various
13015 @dfn{handlers}.  Each handler consists of three elements:  A
13016 @var{function}, a @var{time}, and an @var{idle} parameter.
13017
13018 Here's an example of a handler that closes connections when Emacs has
13019 been idle for thirty minutes:
13020
13021 @lisp
13022 (gnus-demon-close-connections nil 30)
13023 @end lisp
13024
13025 Here's a handler that scans for PGP headers every hour when Emacs is
13026 idle: 
13027
13028 @lisp
13029 (gnus-demon-scan-pgp 60 t)
13030 @end lisp
13031
13032 This @var{time} parameter and than @var{idle} parameter works together
13033 in a strange, but wonderful fashion.  Basically, if @var{idle} is
13034 @code{nil}, then the function will be called every @var{time} minutes.
13035
13036 If @var{idle} is @code{t}, then the function will be called after
13037 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
13038 the function will never be called.  But once Emacs goes idle, the
13039 function will be called every @var{time} minutes.
13040
13041 If @var{idle} is a number and @var{time} is a number, the function will
13042 be called every @var{time} minutes only when Emacs has been idle for
13043 @var{idle} minutes.
13044
13045 If @var{idle} is a number and @var{time} is @code{nil}, the function
13046 will be called once every time Emacs has been idle for @var{idle}
13047 minutes.  
13048
13049 And if @var{time} is a string, it should look like @samp{07:31}, and
13050 the function will then be called once every day somewhere near that
13051 time.  Modified by the @var{idle} parameter, of course.
13052
13053 @vindex gnus-demon-timestep
13054 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
13055 seconds.  This is 60 by default.  If you change that variable,
13056 all the timings in the handlers will be affected.)
13057
13058 @vindex gnus-use-demon
13059 To set the whole thing in motion, though, you have to set
13060 @code{gnus-use-demon} to @code{t}.
13061
13062 So, if you want to add a handler, you could put something like this in
13063 your @file{.gnus} file:
13064
13065 @findex gnus-demon-add-handler
13066 @lisp
13067 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
13068 @end lisp
13069
13070 @findex gnus-demon-add-nocem
13071 @findex gnus-demon-add-scanmail
13072 @findex gnus-demon-add-rescan
13073 @findex gnus-demon-add-scan-timestamps
13074 @findex gnus-demon-add-disconnection
13075 Some ready-made functions to do this has been created:
13076 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
13077 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
13078 @code{gnus-demon-add-scanmail}.  Just put those functions in your
13079 @file{.gnus} if you want those abilities.
13080
13081 @findex gnus-demon-init
13082 @findex gnus-demon-cancel
13083 @vindex gnus-demon-handlers
13084 If you add handlers to @code{gnus-demon-handlers} directly, you should
13085 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
13086 daemons, you can use the @code{gnus-demon-cancel} function.
13087
13088 Note that adding daemons can be pretty naughty if you overdo it.  Adding
13089 functions that scan all news and mail from all servers every two seconds
13090 is a sure-fire way of getting booted off any respectable system.  So
13091 behave.
13092
13093
13094 @node NoCeM
13095 @section NoCeM
13096 @cindex nocem
13097 @cindex spam
13098
13099 @dfn{Spamming} is posting the same article lots and lots of times.
13100 Spamming is bad.  Spamming is evil.  
13101
13102 Spamming is usually canceled within a day or so by various anti-spamming
13103 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
13104 NoCeM is pronounced ``no see-'em'', and means what the name
13105 implies---these are messages that make the offending articles, like, go
13106 away.  
13107
13108 What use are these NoCeM messages if the articles are canceled anyway?
13109 Some sites do not honor cancel messages and some sites just honor cancels
13110 from a select few people.  Then you may wish to make use of the NoCeM
13111 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
13112
13113 Gnus can read and parse the messages in this group automatically, and
13114 this will make spam disappear.  
13115
13116 There are some variables to customize, of course:
13117
13118 @table @code
13119 @item gnus-use-nocem
13120 @vindex gnus-use-nocem
13121 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
13122 by default. 
13123
13124 @item gnus-nocem-groups
13125 @vindex gnus-nocem-groups
13126 Gnus will look for NoCeM messages in the groups in this list.  The
13127 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
13128 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
13129
13130 @item gnus-nocem-issuers
13131 @vindex gnus-nocem-issuers
13132 There are many people issuing NoCeM messages.  This list says what
13133 people you want to listen to.  The default is @code{("Automoose-1"
13134 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
13135 (Richard E. Depew)")}; fine, upstanding citizens all of them.
13136
13137 Known despammers that you can put in this list include:
13138
13139 @table @samp
13140 @item clewis@@ferret.ocunix.on.ca;
13141 @cindex Chris Lewis
13142 Chris Lewis---Major Canadian despammer who has probably canceled more
13143 usenet abuse than anybody else.
13144
13145 @item Automoose-1
13146 @cindex CancelMoose[tm]
13147 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
13148 Norwegian, and was the person(s) who invented NoCeM.  
13149
13150 @item jem@@xpat.com;
13151 @cindex Jem
13152 John Milburn---despammer located in Korea who is getting very busy these
13153 days.
13154
13155 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
13156 Richard E. Depew---lone American despammer.  He mostly cancels binary
13157 postings to non-binary groups and removes spews (regurgitated articles).
13158 @end table
13159
13160 You do not have to heed NoCeM messages from all these people---just the
13161 ones you want to listen to.
13162
13163 @item gnus-nocem-verifyer
13164 @vindex gnus-nocem-verifyer
13165 @findex mc-verify
13166 This should be a function for verifying that the NoCeM issuer is who she
13167 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
13168 function.  If this is too slow and you don't care for verification
13169 (which may be dangerous), you can set this variable to @code{nil}.
13170
13171 If you want signed NoCeM messages to be verified and unsigned messages
13172 not to be verified (but used anyway), you could do something like:
13173
13174 @lisp
13175 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
13176
13177 (defun my-gnus-mc-verify ()
13178   (not (eq 'forged
13179            (ignore-errors
13180              (if (mc-verify)
13181                  t
13182                'forged)))))
13183 @end lisp
13184
13185 This might be dangerous, though.
13186
13187 @item gnus-nocem-directory
13188 @vindex gnus-nocem-directory
13189 This is where Gnus will store its NoCeM cache files.  The default is
13190 @file{~/News/NoCeM/}. 
13191
13192 @item gnus-nocem-expiry-wait
13193 @vindex gnus-nocem-expiry-wait
13194 The number of days before removing old NoCeM entries from the cache.
13195 The default is 15.  If you make it shorter Gnus will be faster, but you
13196 might then see old spam.
13197
13198 @end table
13199
13200 Using NoCeM could potentially be a memory hog.  If you have many living
13201 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
13202 big.  If this is a problem, you should kill off all (or most) of your
13203 unsubscribed groups (@pxref{Subscription Commands}).
13204
13205
13206 @node Picons
13207 @section Picons
13208
13209 So...  You want to slow down your news reader even more!  This is a
13210 good way to do so.  Its also a great way to impress people staring
13211 over your shoulder as you read news.
13212
13213 @menu
13214 * Picon Basics::           What are picons and How do I get them.
13215 * Picon Requirements::     Don't go further if you aren't using XEmacs.
13216 * Easy Picons::            Displaying Picons---the easy way.
13217 * Hard Picons::            The way you should do it.  You'll learn something.
13218 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
13219 @end menu
13220
13221
13222 @node Picon Basics
13223 @subsection Picon Basics
13224
13225 What are Picons?  To quote directly from the Picons Web site:
13226
13227 @quotation 
13228 @dfn{Picons} is short for ``personal icons''.  They're small,
13229 constrained images used to represent users and domains on the net,
13230 organized into databases so that the appropriate image for a given
13231 e-mail address can be found.  Besides users and domains, there are picon
13232 databases for Usenet newsgroups and weather forecasts.  The picons are
13233 in either monochrome @code{XBM} format or color @code{XPM} and
13234 @code{GIF} formats.
13235 @end quotation
13236
13237 For instructions on obtaining and installing the picons databases, point
13238 your Web browser at
13239 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13240
13241 @vindex gnus-picons-database
13242 Gnus expects picons to be installed into a location pointed to by
13243 @code{gnus-picons-database}.
13244
13245
13246 @node Picon Requirements
13247 @subsection Picon Requirements
13248
13249 To use have Gnus display Picons for you, you must be running XEmacs
13250 19.13 or greater since all other versions of Emacs aren't yet able to
13251 display images.
13252
13253 Additionally, you must have @code{xpm} support compiled into XEmacs.
13254
13255 @vindex gnus-picons-convert-x-face
13256 If you want to display faces from @code{X-Face} headers, you must have
13257 the @code{netpbm} utilities installed, or munge the
13258 @code{gnus-picons-convert-x-face} variable to use something else.
13259
13260
13261 @node Easy Picons
13262 @subsection Easy Picons
13263
13264 To enable displaying picons, simply put the following line in your
13265 @file{~/.gnus} file and start Gnus.
13266
13267 @lisp
13268 (setq gnus-use-picons t)
13269 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13270 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13271 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13272 @end lisp
13273
13274
13275 @node Hard Picons
13276 @subsection Hard Picons 
13277
13278 Gnus can display picons for you as you enter and leave groups and
13279 articles.  It knows how to interact with three sections of the picons
13280 database.  Namely, it can display the picons newsgroup pictures,
13281 author's face picture(s), and the authors domain.  To enable this
13282 feature, you need to first decide where to display them.
13283
13284 @table @code 
13285
13286 @item gnus-picons-display-where 
13287 @vindex gnus-picons-display-where 
13288 Where the picon images should be displayed.  It is @code{picons} by
13289 default (which by default maps to the buffer @samp{*Picons*}).  Other
13290 valid places could be @code{article}, @code{summary}, or
13291 @samp{*scratch*} for all I care.  Just make sure that you've made the
13292 buffer visible using the standard Gnus window configuration
13293 routines---@pxref{Windows Configuration}.
13294
13295 @end table
13296
13297 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13298 window configuration for you to include the @code{picons} buffer.
13299
13300 Now that you've made that decision, you need to add the following
13301 functions to the appropriate hooks so these pictures will get
13302 displayed at the right time.
13303
13304 @vindex gnus-article-display-hook
13305 @vindex gnus-picons-display-where
13306 @table @code
13307 @item gnus-article-display-picons
13308 @findex gnus-article-display-picons
13309 Looks up and display the picons for the author and the author's domain
13310 in the @code{gnus-picons-display-where} buffer.  Should be added to
13311 the @code{gnus-article-display-hook}.
13312
13313 @item gnus-group-display-picons
13314 @findex gnus-article-display-picons
13315 Displays picons representing the current group.  This function should
13316 be added to the @code{gnus-summary-prepare-hook} or to the
13317 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13318 is set to @code{article}.
13319
13320 @item gnus-picons-article-display-x-face
13321 @findex gnus-article-display-picons
13322 Decodes and displays the X-Face header if present.  This function
13323 should be added to @code{gnus-article-display-hook}.
13324
13325 @end table
13326
13327 Note:  You must append them to the hook, so make sure to specify 't'
13328 to the append flag of @code{add-hook}:
13329
13330 @lisp
13331 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13332 @end lisp
13333
13334
13335 @node Picon Configuration
13336 @subsection Picon Configuration
13337
13338 The following variables offer further control over how things are
13339 done, where things are located, and other useless stuff you really
13340 don't need to worry about.
13341
13342 @table @code
13343 @item gnus-picons-database
13344 @vindex gnus-picons-database
13345 The location of the picons database.  Should point to a directory
13346 containing the @file{news}, @file{domains}, @file{users} (and so on)
13347 subdirectories.  Defaults to @file{/usr/local/faces}.
13348
13349 @item gnus-picons-news-directory
13350 @vindex gnus-picons-news-directory
13351 Sub-directory of the faces database containing the icons for
13352 newsgroups.
13353
13354 @item gnus-picons-user-directories
13355 @vindex gnus-picons-user-directories
13356 List of subdirectories to search in @code{gnus-picons-database} for user
13357 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13358
13359 @item gnus-picons-domain-directories
13360 @vindex gnus-picons-domain-directories
13361 List of subdirectories to search in @code{gnus-picons-database} for
13362 domain name faces.  Defaults to @code{("domains")}.  Some people may
13363 want to add @samp{unknown} to this list.
13364
13365 @item gnus-picons-convert-x-face
13366 @vindex gnus-picons-convert-x-face
13367 The command to use to convert the @code{X-Face} header to an X bitmap
13368 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13369 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13370 gnus-picons-x-face-file-name)}
13371
13372 @item gnus-picons-x-face-file-name
13373 @vindex gnus-picons-x-face-file-name
13374 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13375 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13376
13377 @item gnus-picons-buffer
13378 @vindex gnus-picons-buffer
13379 The name of the buffer that @code{picons} points to.  Defaults to
13380 @samp{*Icon Buffer*}.
13381
13382 @end table
13383
13384
13385 @node Undo
13386 @section Undo
13387 @cindex undo
13388
13389 It is very useful to be able to undo actions one has done.  In normal
13390 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13391 In Gnus buffers, however, it isn't that simple.
13392
13393 The things Gnus displays in its buffer is of no value whatsoever to
13394 Gnus---it's all just data that is designed to look nice to the user.
13395 Killing a group in the group buffer with @kbd{C-k} makes the line
13396 disappear, but that's just a side-effect of the real action---the
13397 removal of the group in question from the internal Gnus structures.
13398 Undoing something like that can't be done by the normal Emacs
13399 @code{undo} function.
13400
13401 Gnus tries to remedy this somewhat by keeping track of what the user
13402 does and coming up with actions that would reverse the actions the user
13403 takes.  When the user then presses the @code{undo} key, Gnus will run
13404 the code to reverse the previous action, or the previous actions.
13405 However, not all actions are easily reversible, so Gnus currently offers
13406 a few key functions to be undoable.  These include killing groups,
13407 yanking groups, and changing the list of read articles of groups.
13408 That's it, really.  More functions may be added in the future, but each
13409 added function means an increase in data to be stored, so Gnus will
13410 never be totally undoable.
13411
13412 @findex gnus-undo-mode
13413 @vindex gnus-use-undo
13414 @findex gnus-undo
13415 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13416 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13417 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13418 command, which should feel kinda like the normal Emacs @code{undo}
13419 command. 
13420
13421
13422 @node Moderation
13423 @section Moderation
13424 @cindex moderation
13425
13426 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13427 It is not included in the standard Gnus package.  Write a mail to
13428 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
13429 get a copy.
13430
13431 The moderation package is implemented as a minor mode for summary
13432 buffers.  Put
13433
13434 @lisp
13435 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13436 @end lisp
13437
13438 in your @file{.gnus.el} file.
13439
13440 If you are the moderation of @samp{rec.zoofle}, this is how it's
13441 supposed to work:
13442
13443 @enumerate
13444 @item 
13445 You split your incoming mail by matching on
13446 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13447 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13448
13449 @item
13450 You enter that group once in a while and post articles using the @kbd{e}
13451 (edit-and-post) or @kbd{s} (just send unedited) commands.
13452
13453 @item
13454 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13455 articles that weren't approved by you, you can cancel them with the
13456 @kbd{c} command.
13457 @end enumerate
13458
13459 To use moderation mode in these two groups, say:
13460
13461 @lisp
13462 (setq gnus-moderated-list
13463       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13464 @end lisp
13465
13466
13467 @node XEmacs Enhancements
13468 @section XEmacs Enhancements
13469 @cindex XEmacs
13470
13471 XEmacs is able to display pictures and stuff, so Gnus has taken
13472 advantage of that.  Relevant variables include:
13473
13474 @table @code
13475 @item gnus-xmas-glyph-directory
13476 @vindex gnus-xmas-glyph-directory
13477 This is where Gnus will look for pictures.  Gnus will normally
13478 auto-detect this directory, but you may set it manually if you have an
13479 unusual directory structure.
13480
13481 @item gnus-xmas-logo-color-alist
13482 @vindex gnus-xmas-logo-color-alist
13483 This is an alist where the key is a type symbol and the values are the
13484 foreground and background color of the splash page glyph.
13485
13486 @item gnus-xmas-logo-color-style
13487 @vindex gnus-xmas-logo-color-style
13488 This is the key used to look up the color in the alist described above.
13489 Legal values include @code{flame}, @code{pine}, @code{moss},
13490 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13491 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13492
13493 @item gnus-use-toolbar
13494 @vindex gnus-use-toolbar
13495 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13496 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13497 @code{right-toolbar}, or @code{left-toolbar}.
13498
13499 @item gnus-group-toolbar
13500 @vindex gnus-group-toolbar
13501 The toolbar in the group buffer.
13502
13503 @item gnus-summary-toolbar
13504 @vindex gnus-summary-toolbar
13505 The toolbar in the summary buffer.
13506
13507 @item gnus-summary-mail-toolbar
13508 @vindex gnus-summary-mail-toolbar
13509 The toolbar in the summary buffer of mail groups.
13510
13511 @item gnus-xmas-modeline-glyph
13512 @vindex gnus-xmas-modeline-glyph
13513 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13514 default. 
13515
13516 @end table
13517
13518
13519 @node Fuzzy Matching
13520 @section Fuzzy Matching
13521 @cindex fuzzy matching
13522
13523 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
13524 things like scoring, thread gathering and thread comparison.  
13525
13526 As opposed to regular expression matching, fuzzy matching is very fuzzy.
13527 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
13528 means, and the implementation has changed over time.
13529
13530 Basically, it tries to remove all noise from lines before comparing.
13531 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
13532 out of the strings before comparing the results.  This often leads to
13533 adequate results---even when faced with strings generated by text
13534 manglers masquerading as newsreaders.
13535
13536
13537 @node Thwarting Email Spam
13538 @section Thwarting Email Spam
13539 @cindex email spam
13540 @cindex spam
13541 @cindex UCE
13542 @cindex unsolicited commercial email
13543
13544 In these last days of the Usenet, commercial vultures are hanging about
13545 and grepping through news like crazy to find email addresses they can
13546 foist off their scams and products to.  As a reaction to this, many
13547 people have started putting nonsense addresses into their @code{From}
13548 lines.  I think this is counterproductive---it makes it difficult for
13549 people to send you legitimate mail in response to things you write, as
13550 well as making it difficult to see who wrote what.  This rewriting may
13551 perhaps be a bigger menace than the unsolicited commercial email itself
13552 in the end.
13553
13554 The biggest problem I have with email spam is that it comes in under
13555 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
13556 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and selects the
13557 mail group, only to find two pyramid schemes, seven advertisements
13558 (``New!  Miracle tonic for growing full, lustrouos hair on your toes!'')
13559 and one mail asking me to repent and find some god.
13560
13561 This is annoying.
13562
13563 The way to deal with this is having Gnus split out all spam into a
13564 @samp{spam} mail group (@pxref{Splitting Mail}).
13565
13566 First, pick one (1) legal mail address that you can be reached at, and
13567 put it in your @code{From} header of all your news articles.  (I've
13568 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
13569 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
13570 sysadm whether your sendmail installation accepts keywords in the local
13571 part of the mail address.)
13572
13573 @lisp
13574 (setq message-default-news-headers
13575       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
13576 @end lisp
13577
13578 Then put the following split rule in @code{nnmail-split-fancy}
13579 (@pxref{Fancy Mail Splitting}):
13580
13581 @lisp
13582 (
13583  ...
13584  (to "larsi@@trym.ifi.uio.no"
13585       (| ("subject" "re:.*" "misc")
13586          ("references" ".*@@.*" "misc")
13587          "spam"))
13588  ...
13589 )
13590 @end lisp
13591
13592 This says that all mail to this address is suspect, but if it has a
13593 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
13594 header, it's probably ok.  All the rest goes to the @samp{spam} group.
13595 (This idea probably comes from Tim Pierce.)
13596
13597 In addition, many mail spammers talk directly to your @code{smtp} server
13598 and do not include your email address explicitly in the @code{To}
13599 header.  Why they do this is unknown---perhaps it's to thwart this
13600 twarting scheme?  In any case, this is trivial to deal with---you just
13601 put anything not addressed to you in the @samp{spam} group by ending
13602 your fancy split rule in this way:
13603
13604 @lisp
13605 (
13606  ...
13607  (to "larsi" "misc")
13608  "spam")
13609 @end lisp
13610
13611 In my experience, this will sort virtually everything into the right
13612 group.  You still have to check the @samp{spam} group from time to time to
13613 check for legitimate mail, though.  If you feel like being a good net
13614 citizen, you can even send off complaints to the proper authorities on
13615 each unsolicited commercial email---at your leisure.
13616
13617 If you are also a lazy net citizen, you will probably prefer complaining
13618 automatically with the @file{gnus-junk.el} package, availiable FOR FREE
13619 at @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
13620 Since most e-mail spam is sent automatically, this may reconcile the
13621 cosmic balance somewhat.
13622
13623 This works for me.  It allows people an easy way to contact me (they can
13624 just press @kbd{r} in the usual way), and I'm not bothered at all with
13625 spam.  It's a win-win situation.  Forging @code{From} headers to point
13626 to non-existant domains is yucky, in my opinion.
13627
13628
13629 @node Various Various
13630 @section Various Various
13631 @cindex mode lines
13632 @cindex highlights
13633
13634 @table @code
13635
13636 @item gnus-home-directory
13637 All Gnus path variables will be initialized from this variable, which
13638 defaults to @file{~/}.
13639
13640 @item gnus-directory
13641 @vindex gnus-directory
13642 Most Gnus storage path variables will be initialized from this variable,
13643 which defaults to the @samp{SAVEDIR} environment variable, or
13644 @file{~/News/} if that variable isn't set.
13645
13646 @item gnus-default-directory
13647 @vindex gnus-default-directory
13648 Not related to the above variable at all---this variable says what the
13649 default directory of all Gnus buffers should be.  If you issue commands
13650 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13651 default directory.  If this variable is @code{nil} (which is the
13652 default), the default directory will be the default directory of the
13653 buffer you were in when you started Gnus.
13654
13655 @item gnus-verbose
13656 @vindex gnus-verbose
13657 This variable is an integer between zero and ten.  The higher the value,
13658 the more messages will be displayed.  If this variable is zero, Gnus
13659 will never flash any messages, if it is seven (which is the default),
13660 most important messages will be shown, and if it is ten, Gnus won't ever
13661 shut up, but will flash so many messages it will make your head swim.
13662
13663 @item gnus-verbose-backends
13664 @vindex gnus-verbose-backends
13665 This variable works the same way as @code{gnus-verbose}, but it applies
13666 to the Gnus backends instead of Gnus proper.
13667
13668 @item nnheader-max-head-length
13669 @vindex nnheader-max-head-length
13670 When the backends read straight heads of articles, they all try to read
13671 as little as possible.  This variable (default 4096) specifies
13672 the absolute max length the backends will try to read before giving up
13673 on finding a separator line between the head and the body.  If this
13674 variable is @code{nil}, there is no upper read bound.  If it is
13675 @code{t}, the backends won't try to read the articles piece by piece,
13676 but read the entire articles.  This makes sense with some versions of
13677 @code{ange-ftp}. 
13678
13679 @item nnheader-head-chop-length
13680 @vindex nnheader-head-chop-length
13681 This variable says how big a piece of each article to read when doing
13682 the operation described above.
13683
13684 @item nnheader-file-name-translation-alist 
13685 @vindex nnheader-file-name-translation-alist 
13686 @cindex file names
13687 @cindex illegal characters in file names
13688 @cindex characters in file names
13689 This is an alist that says how to translate characters in file names.
13690 For instance, if @samp{:} is illegal as a file character in file names
13691 on your system (you OS/2 user you), you could say something like:
13692
13693 @lisp
13694 (setq nnheader-file-name-translation-alist 
13695       '((?: . ?_)))
13696 @end lisp
13697
13698 In fact, this is the default value for this variable on OS/2 and MS
13699 Windows (phooey) systems.
13700
13701 @item gnus-hidden-properties
13702 @vindex gnus-hidden-properties
13703 This is a list of properties to use to hide ``invisible'' text.  It is
13704 @code{(invisible t intangible t)} by default on most systems, which
13705 makes invisible text invisible and intangible.
13706
13707 @item gnus-parse-headers-hook
13708 @vindex gnus-parse-headers-hook
13709 A hook called before parsing headers.  It can be used, for instance, to
13710 gather statistics on the headers fetched, or perhaps you'd like to prune
13711 some headers.  I don't see why you'd want that, though.
13712
13713 @item gnus-shell-command-separator
13714 @vindex gnus-shell-command-separator
13715 String used to separate to shell commands.  The default is @samp{;}. 
13716
13717
13718 @end table
13719
13720
13721 @node The End
13722 @chapter The End
13723
13724 Well, that's the manual---you can get on with your life now.  Keep in
13725 touch.  Say hello to your cats from me.  
13726
13727 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13728
13729 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13730
13731 @quotation
13732 @strong{Te Deum}
13733
13734 @sp 1
13735 Not because of victories @*
13736 I sing,@*
13737 having none,@*
13738 but for the common sunshine,@*
13739 the breeze,@*
13740 the largess of the spring.
13741
13742 @sp 1
13743 Not for victory@*
13744 but for the day's work done@*
13745 as well as I was able;@*
13746 not for a seat upon the dais@*
13747 but at the common table.@*
13748 @end quotation
13749
13750
13751 @node Appendices
13752 @chapter Appendices
13753
13754 @menu
13755 * History::                        How Gnus got where it is today.
13756 * Terminology::                    We use really difficult, like, words here.
13757 * Customization::                  Tailoring Gnus to your needs.
13758 * Troubleshooting::                What you might try if things do not work.
13759 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13760 * Emacs for Heathens::             A short introduction to Emacsian terms.
13761 * Frequently Asked Questions::     A question-and-answer session.
13762 @end menu
13763
13764
13765 @node History
13766 @section History
13767
13768 @cindex history
13769 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13770 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13771
13772 If you want to investigate the person responsible for this outrage, you
13773 can point your (feh!) web browser to
13774 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13775 distribution point for the new and spiffy versions of Gnus, and is known
13776 as The Site That Destroys Newsrcs And Drives People Mad.
13777
13778 During the first extended alpha period of development, the new Gnus was
13779 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13780 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13781 (Besides, the ``Gnus'' in this abbreviation should probably be
13782 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13783 appropriate name, don't you think?)
13784
13785 In any case, after spending all that energy on coming up with a new and
13786 spunky name, we decided that the name was @emph{too} spunky, so we
13787 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13788 ``@sc{gnus}''.  New vs. old.
13789
13790 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13791 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13792 plus 15 Gnus 5.0 releases).
13793
13794 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13795 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13796
13797 On July 28th 1996 work on Red Gnus was begun, and it was released on
13798 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13799
13800 If you happen upon a version of Gnus that has a name that is prefixed --
13801 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13802 don't panic.  Don't let it know that you're frightened.  Back away.
13803 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13804 out of its reach.  Find a proper released version of Gnus and snuggle up
13805 to that instead.
13806
13807 @menu
13808 * Why?::                What's the point of Gnus?
13809 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13810 * Conformity::          Gnus tries to conform to all standards.
13811 * Emacsen::             Gnus can be run on a few modern Emacsen.
13812 * Contributors::        Oodles of people.  
13813 * New Features::        Pointers to some of the new stuff in Gnus.
13814 * Newest Features::     Features so new that they haven't been written yet.
13815 @end menu
13816
13817
13818 @node Why?
13819 @subsection Why?
13820
13821 What's the point of Gnus?  
13822
13823 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13824 newsreader, that lets you do anything you can think of.  That was my
13825 original motivation, but while working on Gnus, it has become clear to
13826 me that this generation of newsreaders really belong in the stone age.
13827 Newsreaders haven't developed much since the infancy of the net.  If the
13828 volume continues to rise with the current rate of increase, all current
13829 newsreaders will be pretty much useless.  How do you deal with
13830 newsgroups that have thousands of new articles each day?  How do you
13831 keep track of millions of people who post?
13832
13833 Gnus offers no real solutions to these questions, but I would very much
13834 like to see Gnus being used as a testing ground for new methods of
13835 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13836 to separate the newsreader from the backends, Gnus now offers a simple
13837 interface for anybody who wants to write new backends for fetching mail
13838 and news from different sources.  I have added hooks for customizations
13839 everywhere I could imagine useful.  By doing so, I'm inviting every one
13840 of you to explore and invent.
13841
13842 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13843
13844
13845 @node Compatibility
13846 @subsection Compatibility
13847
13848 @cindex compatibility
13849 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13850 bindings have been kept.  More key bindings have been added, of course,
13851 but only in one or two obscure cases have old bindings been changed.
13852
13853 Our motto is:
13854 @quotation
13855 @cartouche
13856 @center In a cloud bones of steel.
13857 @end cartouche
13858 @end quotation
13859
13860 All commands have kept their names.  Some internal functions have changed
13861 their names.
13862
13863 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13864 Articles}. 
13865
13866 One major compatibility question is the presence of several summary
13867 buffers.  All variables that are relevant while reading a group are
13868 buffer-local to the summary buffer they belong in.  Although many
13869 important variables have their values copied into their global
13870 counterparts whenever a command is executed in the summary buffer, this
13871 change might lead to incorrect values being used unless you are careful.
13872
13873 All code that relies on knowledge of @sc{gnus} internals will probably
13874 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13875 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13876 maintains a hash table that points to the entries in this alist (which
13877 speeds up many functions), and changing the alist directly will lead to
13878 peculiar results.
13879
13880 @cindex hilit19
13881 @cindex highlighting
13882 Old hilit19 code does not work at all.  In fact, you should probably
13883 remove all hilit code from all Gnus hooks
13884 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13885 Gnus provides various integrated functions for highlighting.  These are
13886 faster and more accurate.  To make life easier for everybody, Gnus will
13887 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13888 Away!
13889
13890 Packages like @code{expire-kill} will no longer work.  As a matter of
13891 fact, you should probably remove all old @sc{gnus} packages (and other
13892 code) when you start using Gnus.  More likely than not, Gnus already
13893 does what you have written code to make @sc{gnus} do.  (Snicker.)
13894
13895 Even though old methods of doing things are still supported, only the
13896 new methods are documented in this manual.  If you detect a new method of
13897 doing something while reading this manual, that does not mean you have
13898 to stop doing it the old way.
13899
13900 Gnus understands all @sc{gnus} startup files.
13901
13902 @kindex M-x gnus-bug
13903 @findex gnus-bug
13904 @cindex reporting bugs
13905 @cindex bugs
13906 Overall, a casual user who hasn't written much code that depends on
13907 @sc{gnus} internals should suffer no problems.  If problems occur,
13908 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13909
13910
13911 @node Conformity
13912 @subsection Conformity
13913
13914 No rebels without a clue here, ma'am.  We conform to all standards known
13915 to (wo)man.  Except for those standards and/or conventions we disagree
13916 with, of course.
13917
13918 @table @strong
13919
13920 @item RFC 822
13921 @cindex RFC 822
13922 There are no known breaches of this standard.
13923
13924 @item RFC 1036
13925 @cindex RFC 1036
13926 There are no known breaches of this standard, either.
13927
13928 @item Good Net-Keeping Seal of Approval
13929 @cindex Good Net-Keeping Seal of Approval
13930 Gnus has been through the Seal process and failed.  I think it'll pass
13931 the next inspection.
13932
13933 @item Son-of-RFC 1036
13934 @cindex Son-of-RFC 1036
13935 We do have some breaches to this one.
13936
13937 @table @emph
13938
13939 @item MIME
13940 Gnus does no MIME handling, and this standard-to-be seems to think that
13941 MIME is the bees' knees, so we have major breakage here.
13942
13943 @item X-Newsreader
13944 This is considered to be a ``vanity header'', while I consider it to be
13945 consumer information.  After seeing so many badly formatted articles
13946 coming from @code{tin} and @code{Netscape} I know not to use either of
13947 those for posting articles.  I would not have known that if it wasn't
13948 for the @code{X-Newsreader} header.
13949 @end table
13950
13951 @end table
13952
13953 If you ever notice Gnus acting non-compliantly with regards to the texts
13954 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13955 know.
13956
13957
13958 @node Emacsen
13959 @subsection Emacsen
13960 @cindex Emacsen
13961 @cindex XEmacs
13962 @cindex Mule
13963 @cindex Emacs
13964
13965 Gnus should work on :
13966
13967 @itemize @bullet 
13968
13969 @item
13970 Emacs 19.32 and up.
13971
13972 @item
13973 XEmacs 19.14 and up.
13974
13975 @item 
13976 Mule versions based on Emacs 19.32 and up.
13977
13978 @end itemize
13979
13980 Gnus will absolutely not work on any Emacsen older than that.  Not
13981 reliably, at least. 
13982
13983 There are some vague differences between Gnus on the various
13984 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13985 other than that, things should look pretty much the same under all
13986 Emacsen. 
13987
13988
13989 @node Contributors
13990 @subsection Contributors
13991 @cindex contributors
13992
13993 The new Gnus version couldn't have been done without the help of all the
13994 people on the (ding) mailing list.  Every day for over a year I have
13995 gotten billions of nice bug reports from them, filling me with joy,
13996 every single one of them.  Smooches.  The people on the list have been
13997 tried beyond endurance, what with my ``oh, that's a neat idea <type
13998 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13999 work at all <type type>, yup, I'll ship that one off right away <ship
14000 off> no, wait, that absolutely does not work'' policy for releases.
14001 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
14002 ``worser''? ``much worser''?  ``worsest''?)
14003
14004 I would like to take this opportunity to thank the Academy for...  oops,
14005 wrong show.
14006
14007 @itemize @bullet
14008
14009 @item 
14010 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
14011
14012 @item 
14013 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
14014 well as numerous other things).
14015
14016 @item 
14017 Luis Fernandes---design and graphics.
14018
14019 @item
14020 Erik Naggum---help, ideas, support, code and stuff.
14021
14022 @item 
14023 Wes Hardaker---@file{gnus-picon.el} and the manual section on
14024 @dfn{picons} (@pxref{Picons}).
14025
14026 @item
14027 Kim-Minh Kaplan---further work on the picon code.
14028
14029 @item 
14030 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
14031 (@pxref{GroupLens}).
14032
14033 @item 
14034 Sudish Joseph---innumerable bug fixes.
14035
14036 @item 
14037 Ilja Weis---@file{gnus-topic.el}.
14038
14039 @item 
14040 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
14041
14042 @item 
14043 Vladimir Alexiev---the refcard and reference booklets.
14044
14045 @item 
14046 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
14047 distribution by Felix Lee and JWZ.
14048
14049 @item 
14050 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
14051
14052 @item 
14053 Peter Mutsaers---orphan article scoring code.
14054
14055 @item 
14056 Ken Raeburn---POP mail support.
14057
14058 @item 
14059 Hallvard B Furuseth---various bits and pieces, especially dealing with
14060 .newsrc files.
14061
14062 @item 
14063 Brian Edmonds---@file{gnus-bbdb.el}.
14064
14065 @item
14066 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
14067
14068 @item 
14069 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
14070
14071 @item 
14072 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
14073
14074 @item
14075 François Pinard---many, many interesting and thorough bug reports.
14076
14077 @end itemize
14078
14079 The following people have contributed many patches and suggestions: 
14080
14081 Christopher Davis,
14082 Andrew Eskilsson,
14083 Kai Grossjohann,
14084 David KÃ¥gedal,
14085 Richard Pieri,
14086 Fabrice Popineau, 
14087 Daniel Quinlan, 
14088 Jason L. Tibbitts, III,
14089 and
14090 Jack Vinson.
14091
14092 Also thanks to the following for patches and stuff:
14093
14094 Adrian Aichner,
14095 Peter Arius, 
14096 Matt Armstrong,
14097 Marc Auslander,
14098 Chris Bone,
14099 Mark Borges,
14100 Lance A. Brown,
14101 Kees de Bruin,
14102 Martin Buchholz,
14103 Kevin Buhr,
14104 Alastair Burt,
14105 Joao Cachopo,
14106 Zlatko Calusic,
14107 Massimo Campostrini,
14108 Dan Christensen,
14109 Michael R. Cook,
14110 Glenn Coombs, 
14111 Frank D. Cringle, 
14112 Geoffrey T. Dairiki,
14113 Andre Deparade,
14114 Ulrik Dickow,
14115 Dave Disser,
14116 Joev Dubach,
14117 Michael Welsh Duggan,
14118 Paul Eggert,
14119 Michael Ernst,
14120 Luc Van Eycken,
14121 Sam Falkner,
14122 Paul Franklin, 
14123 Arne Georg Gleditsch,
14124 David S. Goldberg,
14125 D. Hall, 
14126 Magnus Hammerin,
14127 Raja R. Harinath,
14128 Hisashige Kenji, @c Hisashige
14129 Marc Horowitz,
14130 Gunnar Horrigmo,
14131 Brad Howes,
14132 François Felix Ingrand,
14133 Ishikawa Ichiro, @c Ishikawa
14134 Lee Iverson, 
14135 Rajappa Iyer,
14136 Randell Jesup,
14137 Fred Johansen, 
14138 Greg Klanderman,
14139 Karl Kleinpaste,
14140 Peter Skov Knudsen,
14141 Shuhei Kobayashi, @c Kobayashi
14142 Thor Kristoffersen,
14143 Jens Lautenbacher,
14144 Carsten Leonhardt,
14145 James LewisMoss,
14146 Christian Limpach,
14147 Markus Linnala,
14148 Dave Love,
14149 Tonny Madsen,
14150 Shlomo Mahlab,
14151 Nat Makarevitch,
14152 David Martin,
14153 Gordon Matzigkeit,
14154 Timo Metzemakers,
14155 Richard Mlynarik,
14156 Lantz Moore,
14157 Morioka Tomohiko, @c Morioka
14158 Erik Toubro Nielsen,
14159 Hrvoje Niksic,
14160 Andy Norman,
14161 C. R. Oldham,
14162 Alexandre Oliva,
14163 Ken Olstad,
14164 Masaharu Onishi, @c Onishi
14165 Hideki Ono, @c Ono
14166 William Perry,
14167 Stephen Peters,
14168 Ulrich Pfeifer,
14169 John McClary Prevost,
14170 Colin Rafferty,
14171 Bart Robinson,
14172 Jason Rumney,
14173 Dewey M. Sasser,
14174 Loren Schall,
14175 Dan Schmidt,
14176 Ralph Schleicher,
14177 Philippe Schnoebelen,
14178 Randal L. Schwartz,
14179 Danny Siu, 
14180 Paul D. Smith,
14181 Jeff Sparkes,
14182 Toby Speight,
14183 Michael Sperber,
14184 Richard Stallman,
14185 Greg Stark, 
14186 Paul Stodghill,
14187 Kurt Swanson,
14188 Samuel Tardieu, 
14189 Teddy,
14190 Chuck Thompson,
14191 Philippe Troin,
14192 Aaron M. Ucko,
14193 Jan Vroonhof,
14194 Barry A. Warsaw,
14195 Christoph Wedler,
14196 Joe Wells,
14197 and
14198 Katsumi Yamaoka. @c Yamaoka
14199
14200 For a full overview of what each person has done, the ChangeLogs
14201 included in the Gnus alpha distributions should give ample reading
14202 (550kB and counting).
14203
14204 Apologies to everybody that I've forgotten, of which there are many, I'm
14205 sure.  
14206
14207 Gee, that's quite a list of people.  I guess that must mean that there
14208 actually are people who are using Gnus.  Who'd'a thunk it!
14209
14210
14211 @node New Features
14212 @subsection New Features
14213 @cindex new features
14214
14215 @menu
14216 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
14217 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
14218 * Red Gnus::           Third time best---Gnus 5.4/5.5.
14219 @end menu
14220
14221 These lists are, of course, just @emph{short} overviews of the
14222 @emph{most} important new features.  No, really.  There are tons more.
14223 Yes, we have feeping creaturism in full effect.
14224
14225
14226 @node ding Gnus
14227 @subsubsection (ding) Gnus
14228
14229 New features in Gnus 5.0/5.1:
14230
14231 @itemize @bullet
14232
14233 @item
14234 The look of all buffers can be changed by setting format-like variables
14235 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
14236  
14237 @item 
14238 Local spool and several @sc{nntp} servers can be used at once
14239 (@pxref{Select Methods}).  
14240
14241 @item 
14242 You can combine groups into virtual groups (@pxref{Virtual Groups}).
14243
14244 @item 
14245 You can read a number of different mail formats (@pxref{Getting Mail}).
14246 All the mail backends implement a convenient mail expiry scheme
14247 (@pxref{Expiring Mail}). 
14248
14249 @item
14250 Gnus can use various strategies for gathering threads that have lost
14251 their roots (thereby gathering loose sub-threads into one thread) or it
14252 can go back and retrieve enough headers to build a complete thread
14253 (@pxref{Customizing Threading}).
14254
14255 @item 
14256 Killed groups can be displayed in the group buffer, and you can read
14257 them as well (@pxref{Listing Groups}).
14258
14259 @item 
14260 Gnus can do partial group updates---you do not have to retrieve the
14261 entire active file just to check for new articles in a few groups
14262 (@pxref{The Active File}).
14263
14264 @item 
14265 Gnus implements a sliding scale of subscribedness to groups
14266 (@pxref{Group Levels}).
14267
14268 @item 
14269 You can score articles according to any number of criteria
14270 (@pxref{Scoring}).  You can even get Gnus to find out how to score
14271 articles for you (@pxref{Adaptive Scoring}).
14272
14273 @item 
14274 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
14275 manner, so it should be difficult to lose much data on what you have
14276 read if your machine should go down (@pxref{Auto Save}). 
14277
14278 @item 
14279 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
14280 the @file{.emacs} file.
14281
14282 @item 
14283 You can set the process mark on both groups and articles and perform
14284 operations on all the marked items (@pxref{Process/Prefix}).
14285
14286 @item 
14287 You can grep through a subset of groups and create a group from the
14288 results (@pxref{Kibozed Groups}). 
14289
14290 @item 
14291 You can list subsets of groups according to, well, anything
14292 (@pxref{Listing Groups}). 
14293
14294 @item 
14295 You can browse foreign servers and subscribe to groups from those
14296 servers (@pxref{Browse Foreign Server}). 
14297
14298 @item 
14299 Gnus can fetch articles asynchronously on a second connection to the
14300 server (@pxref{Asynchronous Fetching}).
14301
14302 @item 
14303 You can cache articles locally (@pxref{Article Caching}). 
14304
14305 @item 
14306 The uudecode functions have been expanded and generalized
14307 (@pxref{Decoding Articles}). 
14308
14309 @item
14310 You can still post uuencoded articles, which was a little-known feature
14311 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
14312
14313 @item
14314 Fetching parents (and other articles) now actually works without
14315 glitches (@pxref{Finding the Parent}). 
14316
14317 @item
14318 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
14319
14320 @item
14321 Digests (and other files) can be used as the basis for groups
14322 (@pxref{Document Groups}).
14323
14324 @item 
14325 Articles can be highlighted and customized (@pxref{Customizing
14326 Articles}). 
14327
14328 @item 
14329 URLs and other external references can be buttonized (@pxref{Article
14330 Buttons}). 
14331
14332 @item
14333 You can do lots of strange stuff with the Gnus window & frame
14334 configuration (@pxref{Windows Configuration}).
14335
14336 @item
14337 You can click on buttons instead of using the keyboard
14338 (@pxref{Buttons}). 
14339
14340 @end itemize
14341
14342
14343 @node September Gnus
14344 @subsubsection September Gnus
14345
14346 New features in Gnus 5.2/5.3:
14347
14348 @itemize @bullet
14349
14350 @item
14351 A new message composition mode is used.  All old customization variables
14352 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14353 now obsolete.
14354
14355 @item
14356 Gnus is now able to generate @dfn{sparse} threads---threads where
14357 missing articles are represented by empty nodes (@pxref{Customizing
14358 Threading}). 
14359
14360 @lisp
14361 (setq gnus-build-sparse-threads 'some)
14362 @end lisp
14363
14364 @item
14365 Outgoing articles are stored on a special archive server
14366 (@pxref{Archived Messages}). 
14367
14368 @item
14369 Partial thread regeneration now happens when articles are
14370 referred. 
14371
14372 @item
14373 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14374
14375 @item
14376 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
14377
14378 @item
14379 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14380
14381 @lisp
14382 (setq gnus-use-trees t)
14383 @end lisp
14384
14385 @item
14386 An @code{nn}-like pick-and-read minor mode is available for the summary
14387 buffers (@pxref{Pick and Read}).
14388
14389 @lisp
14390 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14391 @end lisp
14392
14393 @item
14394 In binary groups you can use a special binary minor mode (@pxref{Binary
14395 Groups}). 
14396
14397 @item
14398 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14399 Topics}).
14400
14401 @lisp
14402 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14403 @end lisp
14404
14405 @item
14406 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14407
14408 @item
14409 Groups can now have a score, and bubbling based on entry frequency
14410 is possible (@pxref{Group Score}).
14411
14412 @lisp
14413 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14414 @end lisp
14415
14416 @item
14417 Groups can be process-marked, and commands can be performed on
14418 groups of groups (@pxref{Marking Groups}).
14419
14420 @item
14421 Caching is possible in virtual groups.
14422
14423 @item
14424 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14425 news batches, ClariNet briefs collections, and just about everything
14426 else (@pxref{Document Groups}).
14427
14428 @item
14429 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14430 (@pxref{SOUP}).
14431
14432 @item
14433 The Gnus cache is much faster.
14434
14435 @item
14436 Groups can be sorted according to many criteria (@pxref{Sorting
14437 Groups}).
14438
14439 @item
14440 New group parameters have been introduced to set list-address and
14441 expiry times (@pxref{Group Parameters}).
14442
14443 @item
14444 All formatting specs allow specifying faces to be used
14445 (@pxref{Formatting Fonts}).
14446
14447 @item
14448 There are several more commands for setting/removing/acting on process
14449 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14450
14451 @item
14452 The summary buffer can be limited to show parts of the available
14453 articles based on a wide range of criteria.  These commands have been
14454 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14455
14456 @item
14457 Articles can be made persistent with the @kbd{*} command
14458 (@pxref{Persistent Articles}).
14459
14460 @item
14461 All functions for hiding article elements are now toggles.
14462
14463 @item
14464 Article headers can be buttonized (@pxref{Article Washing}).
14465
14466 @lisp
14467 (add-hook 'gnus-article-display-hook 
14468           'gnus-article-add-buttons-to-head)
14469 @end lisp
14470
14471 @item
14472 All mail backends support fetching articles by @code{Message-ID}.
14473
14474 @item
14475 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14476
14477 @item
14478 All summary mode commands are available directly from the article
14479 buffer (@pxref{Article Keymap}). 
14480
14481 @item
14482 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14483 Configuration}).
14484
14485 @item
14486 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14487
14488 @item
14489 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14490
14491 @lisp
14492 (setq gnus-use-nocem t)
14493 @end lisp
14494
14495 @item
14496 Groups can be made permanently visible (@pxref{Listing Groups}).
14497
14498 @lisp
14499 (setq gnus-permanently-visible-groups "^nnml:")
14500 @end lisp
14501
14502 @item
14503 Many new hooks have been introduced to make customizing easier. 
14504
14505 @item
14506 Gnus respects the @code{Mail-Copies-To} header.
14507
14508 @item
14509 Threads can be gathered by looking at the @code{References} header
14510 (@pxref{Customizing Threading}).
14511
14512 @lisp
14513 (setq gnus-summary-thread-gathering-function 
14514       'gnus-gather-threads-by-references)
14515 @end lisp
14516
14517 @item
14518 Read articles can be stored in a special backlog buffer to avoid
14519 refetching (@pxref{Article Backlog}).  
14520
14521 @lisp
14522 (setq gnus-keep-backlog 50)
14523 @end lisp
14524
14525 @item
14526 A clean copy of the current article is always stored in a separate
14527 buffer to allow easier treatment.
14528
14529 @item
14530 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14531
14532 @item
14533 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14534 Articles}). 
14535
14536 @lisp
14537 (setq gnus-prompt-before-saving t)
14538 @end lisp
14539
14540 @item
14541 @code{gnus-uu} can view decoded files asynchronously while fetching
14542 articles (@pxref{Other Decode Variables}). 
14543
14544 @lisp
14545 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14546 @end lisp
14547
14548 @item
14549 Filling in the article buffer now works properly on cited text
14550 (@pxref{Article Washing}).
14551
14552 @item
14553 Hiding cited text adds buttons to toggle hiding, and how much
14554 cited text to hide is now customizable (@pxref{Article Hiding}).
14555
14556 @lisp
14557 (setq gnus-cited-lines-visible 2)
14558 @end lisp
14559
14560 @item
14561 Boring headers can be hidden (@pxref{Article Hiding}).
14562
14563 @lisp
14564 (add-hook 'gnus-article-display-hook 
14565           'gnus-article-hide-boring-headers t)
14566 @end lisp
14567
14568 @item
14569 Default scoring values can now be set from the menu bar.
14570
14571 @item
14572 Further syntax checking of outgoing articles have been added.
14573
14574 @end itemize
14575
14576
14577 @node Red Gnus
14578 @subsubsection Red Gnus
14579
14580 New features in Gnus 5.4/5.5:
14581
14582 @itemize @bullet
14583
14584 @item
14585 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14586
14587 @item
14588 Article prefetching functionality has been moved up into 
14589 Gnus (@pxref{Asynchronous Fetching}).  
14590
14591 @item
14592 Scoring can now be performed with logical operators like @code{and},
14593 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14594 Scoring}).
14595
14596 @item
14597 Article washing status can be displayed in the
14598 article mode line (@pxref{Misc Article}).
14599
14600 @item
14601 @file{gnus.el} has been split into many smaller files.
14602
14603 @item
14604 Suppression of duplicate articles based on Message-ID can be done
14605 (@pxref{Duplicate Suppression}).
14606
14607 @lisp
14608 (setq gnus-suppress-duplicates t)
14609 @end lisp
14610
14611 @item
14612 New variables for specifying what score and adapt files are to be
14613 considered home score and adapt files (@pxref{Home Score File}).
14614
14615 @item
14616 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14617 Server Internals}). 
14618
14619 @item
14620 Groups can inherit group parameters from parent topics (@pxref{Topic
14621 Parameters}).
14622
14623 @item
14624 Article editing has been revamped and is now actually usable.
14625
14626 @item
14627 Signatures can be recognized in more intelligent fashions
14628 (@pxref{Article Signature}).
14629
14630 @item
14631 Summary pick mode has been made to look more @code{nn}-like.  Line
14632 numbers are displayed and the @kbd{.} command can be used to pick
14633 articles (@code{Pick and Read}).
14634
14635 @item
14636 Commands for moving the @file{.newsrc.eld} from one server to
14637 another have been added (@pxref{Changing Servers}).
14638
14639 @item
14640 A way to specify that ``uninteresting'' fields be suppressed when
14641 generating lines in buffers (@pxref{Advanced Formatting}).
14642
14643 @item
14644 Several commands in the group buffer can be undone with @kbd{M-C-_}
14645 (@pxref{Undo}).
14646
14647 @item
14648 Scoring can be done on words using the new score type @code{w}
14649 (@pxref{Score File Format}).
14650
14651 @item
14652 Adaptive scoring can be done on a Subject word-by-word basis
14653 (@pxref{Adaptive Scoring}). 
14654
14655 @lisp
14656 (setq gnus-use-adaptive-scoring '(word))
14657 @end lisp
14658
14659 @item
14660 Scores can be decayed (@pxref{Score Decays}).
14661  
14662 @lisp
14663 (setq gnus-decay-scores t)
14664 @end lisp
14665
14666 @item
14667 Scoring can be performed using a regexp on the Date header.  The Date is
14668 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14669
14670 @item
14671 A new command has been added to remove all data on articles from
14672 the native server (@pxref{Changing Servers}).
14673
14674 @item
14675 A new command for reading collections of documents
14676 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14677 (@pxref{Really Various Summary Commands}). 
14678
14679 @item
14680 Process mark sets can be pushed and popped (@pxref{Setting Process
14681 Marks}).
14682
14683 @item
14684 A new mail-to-news backend makes it possible to post even when the NNTP
14685 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14686
14687 @item
14688 A new backend for reading searches from Web search engines
14689 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14690 (@pxref{Web Searches}).
14691
14692 @item
14693 Groups inside topics can now be sorted using the standard sorting
14694 functions, and each topic can be sorted independently (@pxref{Topic
14695 Sorting}).
14696
14697 @item
14698 Subsets of the groups can be sorted independently (@code{Sorting
14699 Groups}).
14700
14701 @item
14702 Cached articles can be pulled into the groups (@pxref{Summary Generation
14703 Commands}).
14704   
14705 @item
14706 Score files are now applied in a more reliable order (@pxref{Score
14707 Variables}).
14708
14709 @item
14710 Reports on where mail messages end up can be generated (@pxref{Splitting
14711 Mail}).
14712
14713 @item
14714 More hooks and functions have been added to remove junk from incoming
14715 mail before saving the mail (@pxref{Washing Mail}).
14716
14717 @item
14718 Emphasized text can be properly fontisized:
14719
14720 @lisp
14721 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14722 @end lisp
14723  
14724 @end itemize
14725
14726
14727 @node Newest Features
14728 @subsection Newest Features
14729 @cindex todo
14730
14731 Also known as the @dfn{todo list}.  Sure to be implemented before the
14732 next millennium. 
14733
14734 Be afraid.  Be very afraid.
14735
14736 @itemize @bullet
14737 @item
14738 Native @sc{mime} support is something that should be done.  
14739 @item
14740 Really do unbinhexing.
14741 @end itemize
14742
14743 And much, much, much more.  There is more to come than has already been
14744 implemented.  (But that's always true, isn't it?)
14745
14746 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14747 up-to-the-second todo list is located, so if you're really curious, you
14748 could point your Web browser over that-a-way.
14749
14750 @iftex
14751
14752 @node The Manual
14753 @section The Manual
14754 @cindex colophon
14755 @cindex manual
14756
14757 This manual was generated from a TeXinfo file and then run through
14758 either @code{texi2dvi}
14759 @iflatex
14760 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14761 and then run through @code{latex} and @code{dvips} 
14762 @end iflatex
14763 to get what you hold in your hands now.
14764
14765 The following conventions have been used:
14766
14767 @enumerate
14768
14769 @item
14770 This is a @samp{string}
14771
14772 @item
14773 This is a @kbd{keystroke}
14774
14775 @item
14776 This is a @file{file}
14777
14778 @item 
14779 This is a @code{symbol}
14780
14781 @end enumerate
14782
14783 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14784 mean:
14785
14786 @lisp
14787 (setq flargnoze "yes")
14788 @end lisp
14789
14790 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14791
14792 @lisp
14793 (setq flumphel 'yes)
14794 @end lisp
14795
14796 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14797 ever get them confused.
14798
14799 @iflatex
14800 @c @head
14801 Of course, everything in this manual is of vital interest, so you should
14802 read it all.  Several times.  However, if you feel like skimming the
14803 manual, look for that gnu head you should see in the margin over
14804 there---it means that what's being discussed is of more importance than
14805 the rest of the stuff.  (On the other hand, if everything is infinitely
14806 important, how can anything be more important than that?  Just one more
14807 of the mysteries of this world, I guess.)
14808 @end iflatex
14809
14810 @end iftex
14811
14812
14813 @node Terminology
14814 @section Terminology
14815
14816 @cindex terminology
14817 @table @dfn
14818
14819 @item news
14820 @cindex news
14821 This is what you are supposed to use this thing for---reading news.
14822 News is generally fetched from a nearby @sc{nntp} server, and is
14823 generally publicly available to everybody.  If you post news, the entire
14824 world is likely to read just what you have written, and they'll all
14825 snigger mischievously.  Behind your back.
14826
14827 @item mail
14828 @cindex mail
14829 Everything that's delivered to you personally is mail.  Some news/mail
14830 readers (like Gnus) blur the distinction between mail and news, but
14831 there is a difference.  Mail is private.  News is public.  Mailing is
14832 not posting, and replying is not following up.
14833
14834 @item reply
14835 @cindex reply
14836 Send a mail to the person who has written what you are reading.
14837
14838 @item follow up
14839 @cindex follow up
14840 Post an article to the current newsgroup responding to the article you
14841 are reading.
14842
14843 @item backend
14844 @cindex backend
14845 Gnus gets fed articles from a number of backends, both news and mail
14846 backends.  Gnus does not handle the underlying media, so to speak---this
14847 is all done by the backends.
14848
14849 @item native
14850 @cindex native
14851 Gnus will always use one method (and backend) as the @dfn{native}, or
14852 default, way of getting news.
14853
14854 @item foreign
14855 @cindex foreign
14856 You can also have any number of foreign groups active at the same time.
14857 These are groups that use non-native non-secondary backends for getting
14858 news.
14859
14860 @item secondary
14861 @cindex secondary
14862 Secondary backends are somewhere half-way between being native and being
14863 foreign, but they mostly act like they are native.
14864
14865 @item article
14866 @cindex article
14867 A message that has been posted as news.
14868
14869 @item mail message
14870 @cindex mail message
14871 A message that has been mailed.
14872
14873 @item message 
14874 @cindex message
14875 A mail message or news article
14876
14877 @item head
14878 @cindex head
14879 The top part of a message, where administrative information (etc.) is
14880 put.
14881
14882 @item body
14883 @cindex body
14884 The rest of an article.  Everything that is not in the head is in the
14885 body. 
14886
14887 @item header
14888 @cindex header
14889 A line from the head of an article. 
14890
14891 @item headers
14892 @cindex headers
14893 A collection of such lines, or a collection of heads.  Or even a
14894 collection of @sc{nov} lines.
14895
14896 @item @sc{nov}
14897 @cindex nov
14898 When Gnus enters a group, it asks the backend for the headers of all
14899 unread articles in the group.  Most servers support the News OverView
14900 format, which is more compact and much faster to read and parse than the
14901 normal @sc{head} format.
14902
14903 @item level
14904 @cindex levels
14905 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14906 that have a lower level are ``more'' subscribed than the groups with a
14907 higher level.  In fact, groups on levels 1-5 are considered
14908 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14909 are @dfn{killed}.  Commands for listing groups and scanning for new
14910 articles will all use the numeric prefix as @dfn{working level}.
14911
14912 @item killed groups
14913 @cindex killed groups
14914 No information on killed groups is stored or updated, which makes killed
14915 groups much easier to handle than subscribed groups.
14916
14917 @item zombie groups
14918 @cindex zombie groups
14919 Just like killed groups, only slightly less dead.
14920
14921 @item active file
14922 @cindex active file
14923 The news server has to keep track of what articles it carries, and what
14924 groups exist.  All this information in stored in the active file, which
14925 is rather large, as you might surmise.
14926
14927 @item bogus groups
14928 @cindex bogus groups
14929 A group that exists in the @file{.newsrc} file, but isn't known to the
14930 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14931 This means that the group probably doesn't exist (any more).
14932
14933 @item server 
14934 @cindex server
14935 A machine than one can connect to and get news (or mail) from.
14936
14937 @item select method
14938 @cindex select method
14939 A structure that specifies the backend, the server and the virtual
14940 server parameters.
14941
14942 @item virtual server
14943 @cindex virtual server
14944 A named select method.  Since a select methods defines all there is to
14945 know about connecting to a (physical) server, taking the things as a
14946 whole is a virtual server.
14947
14948 @item washing
14949 @cindex washing
14950 Taking a buffer and running it through a filter of some sort.  The
14951 result will (more often than not) be cleaner and more pleasing than the
14952 original. 
14953
14954 @item ephemeral groups
14955 @cindex ephemeral groups
14956 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14957 groups are groups that will have no data stored---when you exit the
14958 group, it'll disappear into the aether.  
14959
14960 @item solid groups
14961 @cindex solid groups
14962 This is the opposite of ephemeral groups.  All groups listed in the
14963 group buffer are solid groups.
14964
14965 @item sparse articles
14966 @cindex sparse articles
14967 These are article placeholders shown in the summary buffer when
14968 @code{gnus-build-sparse-threads} has been switched on.
14969
14970 @end table
14971
14972
14973 @node Customization
14974 @section Customization
14975 @cindex general customization
14976
14977 All variables are properly documented elsewhere in this manual.  This
14978 section is designed to give general pointers on how to customize Gnus
14979 for some quite common situations.
14980
14981 @menu
14982 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14983 * Slow Terminal Connection::  You run a remote Emacs.
14984 * Little Disk Space::         You feel that having large setup files is icky.
14985 * Slow Machine::              You feel like buying a faster machine.
14986 @end menu
14987
14988
14989 @node Slow/Expensive Connection
14990 @subsection Slow/Expensive @sc{nntp} Connection
14991
14992 If you run Emacs on a machine locally, and get your news from a machine
14993 over some very thin strings, you want to cut down on the amount of data
14994 Gnus has to get from the @sc{nntp} server.
14995
14996 @table @code
14997
14998 @item gnus-read-active-file
14999 Set this to @code{nil}, which will inhibit Gnus from requesting the
15000 entire active file from the server.  This file is often v.  large.  You
15001 also have to set @code{gnus-check-new-newsgroups} and
15002 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
15003 doesn't suddenly decide to fetch the active file anyway.
15004
15005 @item gnus-nov-is-evil
15006 This one has to be @code{nil}.  If not, grabbing article headers from
15007 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
15008 support @sc{xover}; Gnus will detect this by itself.
15009 @end table
15010
15011
15012 @node Slow Terminal Connection
15013 @subsection Slow Terminal Connection
15014
15015 Let's say you use your home computer for dialing up the system that
15016 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
15017 amount of data that is sent over the wires as much as possible.
15018
15019 @table @code
15020
15021 @item gnus-auto-center-summary
15022 Set this to @code{nil} to inhibit Gnus from re-centering the summary
15023 buffer all the time.  If it is @code{vertical}, do only vertical
15024 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
15025 horizontal and vertical recentering.
15026
15027 @item gnus-visible-headers
15028 Cut down on the headers that are included in the articles to the
15029 minimum.  You can, in fact, make do without them altogether---most of the
15030 useful data is in the summary buffer, anyway.  Set this variable to
15031 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
15032
15033 @item gnus-article-display-hook
15034 Set this hook to all the available hiding commands:
15035 @lisp
15036 (setq gnus-article-display-hook 
15037       '(gnus-article-hide-headers gnus-article-hide-signature
15038         gnus-article-hide-citation))
15039 @end lisp
15040
15041 @item gnus-use-full-window
15042 By setting this to @code{nil}, you can make all the windows smaller.
15043 While this doesn't really cut down much generally, it means that you
15044 have to see smaller portions of articles before deciding that you didn't
15045 want to read them anyway.
15046
15047 @item gnus-thread-hide-subtree
15048 If this is non-@code{nil}, all threads in the summary buffer will be
15049 hidden initially.
15050
15051 @item gnus-updated-mode-lines
15052 If this is @code{nil}, Gnus will not put information in the buffer mode
15053 lines, which might save some time.
15054 @end table
15055
15056
15057 @node Little Disk Space
15058 @subsection Little Disk Space
15059 @cindex disk space
15060
15061 The startup files can get rather large, so you may want to cut their
15062 sizes a bit if you are running out of space.
15063
15064 @table @code
15065
15066 @item gnus-save-newsrc-file
15067 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
15068 only save @file{.newsrc.eld}.  This means that you will not be able to
15069 use any other newsreaders than Gnus.  This variable is @code{t} by
15070 default. 
15071
15072 @item gnus-save-killed-list
15073 If this is @code{nil}, Gnus will not save the list of dead groups.  You
15074 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
15075 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
15076 variable to @code{nil}.  This variable is @code{t} by default.
15077
15078 @end table
15079
15080
15081 @node Slow Machine
15082 @subsection Slow Machine
15083 @cindex slow machine
15084
15085 If you have a slow machine, or are just really impatient, there are a
15086 few things you can do to make Gnus run faster.
15087
15088 Set@code{gnus-check-new-newsgroups} and
15089 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
15090
15091 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
15092 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
15093 summary buffer faster.
15094
15095 Set @code{gnus-article-display-hook} to @code{nil} to make article
15096 processing a bit faster.
15097
15098
15099 @node Troubleshooting
15100 @section Troubleshooting
15101 @cindex troubleshooting
15102
15103 Gnus works @emph{so} well straight out of the box---I can't imagine any
15104 problems, really.
15105
15106 Ahem.
15107
15108 @enumerate
15109
15110 @item
15111 Make sure your computer is switched on.
15112
15113 @item
15114 Make sure that you really load the current Gnus version.  If you have
15115 been running @sc{gnus}, you need to exit Emacs and start it up again before
15116 Gnus will work.
15117
15118 @item
15119 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
15120 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
15121 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
15122 flee}, you have some old @file{.el} files lying around.  Delete these.
15123
15124 @item
15125 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
15126 how-to. 
15127
15128 @item
15129 @vindex max-lisp-eval-depth
15130 Gnus works on many recursive structures, and in some extreme (and very
15131 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
15132 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
15133 something like that.
15134 @end enumerate
15135
15136 If all else fails, report the problem as a bug.
15137
15138 @cindex bugs
15139 @cindex reporting bugs
15140
15141 @kindex M-x gnus-bug
15142 @findex gnus-bug
15143 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
15144 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
15145 me the backtrace.  I will fix bugs, but I can only fix them if you send
15146 me a precise description as to how to reproduce the bug.
15147
15148 You really can never be too detailed in a bug report.  Always use the
15149 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
15150 a 10Kb mail each time you use it, and even if you have sent me your
15151 environment 500 times before.  I don't care.  I want the full info each
15152 time.  
15153
15154 It is also important to remember that I have no memory whatsoever.  If
15155 you send a bug report, and I send you a reply, and then you send back
15156 just ``No, it's not! Moron!'', I will have no idea what you are
15157 insulting me about.  Always over-explain everything.  It's much easier
15158 for all of us---if I don't have all the information I need, I will just
15159 mail you and ask for more info, and everything takes more time.
15160
15161 If the problem you're seeing is very visual, and you can't quite explain
15162 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
15163 it somewhere it can be reached, and include the URL of the picture in
15164 the bug report.
15165
15166 If you just need help, you are better off asking on
15167 @samp{gnu.emacs.gnus}.  I'm not very helpful.
15168
15169 @cindex gnu.emacs.gnus
15170 @cindex ding mailing list
15171 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
15172 Write to @samp{ding-request@@gnus.org} to subscribe.
15173
15174
15175 @node A Programmers Guide to Gnus
15176 @section A Programmer@'s Guide to Gnus
15177
15178 It is my hope that other people will figure out smart stuff that Gnus
15179 can do, and that other people will write those smart things as well.  To
15180 facilitate that I thought it would be a good idea to describe the inner
15181 workings of Gnus.  And some of the not-so-inner workings, while I'm at
15182 it.
15183
15184 You can never expect the internals of a program not to change, but I
15185 will be defining (in some details) the interface between Gnus and its
15186 backends (this is written in stone), the format of the score files
15187 (ditto), data structures (some are less likely to change than others)
15188 and general method of operations.
15189
15190 @menu 
15191 * Gnus Utility Functions::   Common functions and variable to use.
15192 * Backend Interface::        How Gnus communicates with the servers.
15193 * Score File Syntax::        A BNF definition of the score file standard.
15194 * Headers::                  How Gnus stores headers internally.
15195 * Ranges::                   A handy format for storing mucho numbers.
15196 * Group Info::               The group info format.
15197 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
15198 * Various File Formats::     Formats of files that Gnus use.
15199 @end menu
15200
15201
15202 @node Gnus Utility Functions
15203 @subsection Gnus Utility Functions
15204 @cindex Gnus utility functions
15205 @cindex utility functions
15206 @cindex functions
15207 @cindex internal variables
15208
15209 When writing small functions to be run from hooks (and stuff), it's
15210 vital to have access to the Gnus internal functions and variables.
15211 Below is a list of the most common ones.
15212
15213 @table @code
15214
15215 @item gnus-newsgroup-name
15216 @vindex gnus-newsgroup-name
15217 This variable holds the name of the current newsgroup.
15218
15219 @item gnus-find-method-for-group
15220 @findex gnus-find-method-for-group
15221 A function that returns the select method for @var{group}.
15222
15223 @item gnus-group-real-name
15224 @findex gnus-group-real-name
15225 Takes a full (prefixed) Gnus group name, and returns the unprefixed
15226 name.
15227
15228 @item gnus-group-prefixed-name
15229 @findex gnus-group-prefixed-name
15230 Takes an unprefixed group name and a select method, and returns the full
15231 (prefixed) Gnus group name.
15232
15233 @item gnus-get-info
15234 @findex gnus-get-info
15235 Return the group info list for @var{group}.
15236
15237 @item gnus-add-current-to-buffer-list
15238 @findex gnus-add-current-to-buffer-list
15239 Add the current buffer to the list of buffers to be killed on Gnus
15240 exit.
15241
15242 @item gnus-continuum-version
15243 @findex gnus-continuum-version
15244 Take a Gnus version string as a parameter and returns a floating point
15245 number.  Earlier versions will always get a lower number than later
15246 versions.
15247
15248 @item gnus-group-read-only-p
15249 @findex gnus-group-read-only-p
15250 Say whether @var{group} is read-only or not.
15251
15252 @item gnus-news-group-p
15253 @findex gnus-news-group-p
15254 Say whether @var{group} came from a news backend.
15255
15256 @item gnus-ephemeral-group-p
15257 @findex gnus-ephemeral-group-p
15258 Say whether @var{group} is ephemeral or not.
15259
15260 @item gnus-server-to-method
15261 @findex gnus-server-to-method
15262 Return the select method corresponding to @var{server}.
15263
15264 @item gnus-server-equal
15265 @findex gnus-server-equal
15266 Say whether two virtual servers are equal.
15267
15268 @item gnus-group-native-p
15269 @findex gnus-group-native-p
15270 Say whether @var{group} is native or not.
15271
15272 @item gnus-group-secondary-p
15273 @findex gnus-group-secondary-p
15274 Say whether @var{group} is secondary or not.
15275
15276 @item gnus-group-foreign-p
15277 @findex gnus-group-foreign-p
15278 Say whether @var{group} is foreign or not.
15279
15280 @item group-group-find-parameter
15281 @findex group-group-find-parameter
15282 Return the parameter list of @var{group}.  If given a second parameter,
15283 return the value of that parameter for @var{group}.
15284
15285 @item gnus-group-set-parameter
15286 @findex gnus-group-set-parameter
15287 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
15288
15289 @item gnus-narrow-to-body
15290 @findex gnus-narrow-to-body
15291 Narrow the current buffer to the body of the article.
15292
15293 @item gnus-check-backend-function
15294 @findex gnus-check-backend-function
15295 Takes two parameters, @var{function} and @var{group}.  If the backend
15296 @var{group} comes from supports @var{function}, return non-@code{nil}.
15297
15298 @lisp
15299 (gnus-check-backend-function "request-scan" "nnml:misc")
15300 => t
15301 @end lisp
15302
15303 @item gnus-read-method
15304 @findex gnus-read-method
15305 Prompt the user for a select method.
15306
15307 @end table
15308
15309
15310 @node Backend Interface
15311 @subsection Backend Interface
15312
15313 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
15314 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
15315 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
15316 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
15317 examples of the latter we have @code{nntp-port-number} and
15318 @code{nnmbox-directory}.
15319
15320 When Gnus asks for information from a backend---say @code{nntp}---on
15321 something, it will normally include a virtual server name in the
15322 function parameters.  (If not, the backend should use the ``current''
15323 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
15324 server as its only (optional) parameter.  If this virtual server hasn't
15325 been opened, the function should fail.
15326
15327 Note that a virtual server name has no relation to some physical server
15328 name.  Take this example:
15329
15330 @lisp
15331 (nntp "odd-one" 
15332       (nntp-address "ifi.uio.no") 
15333       (nntp-port-number 4324))
15334 @end lisp
15335
15336 Here the virtual server name is @samp{odd-one} while the name of
15337 the physical server is @samp{ifi.uio.no}. 
15338
15339 The backends should be able to switch between several virtual servers.
15340 The standard backends implement this by keeping an alist of virtual
15341 server environments that it pulls down/pushes up when needed.  
15342
15343 There are two groups of interface functions: @dfn{required functions},
15344 which must be present, and @dfn{optional functions}, which Gnus will
15345 always check whether are present before attempting to call.
15346
15347 All these functions are expected to return data in the buffer
15348 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
15349 unfortunately named, but we'll have to live with it.  When I talk about
15350 @dfn{resulting data}, I always refer to the data in that buffer.  When I
15351 talk about @dfn{return value}, I talk about the function value returned by
15352 the function call.  Functions that fail should return @code{nil} as the
15353 return value.
15354
15355 Some backends could be said to be @dfn{server-forming} backends, and
15356 some might be said to not be.  The latter are backends that generally
15357 only operate on one group at a time, and have no concept of ``server''
15358 -- they have a group, and they deliver info on that group and nothing
15359 more.
15360
15361 In the examples and definitions I will refer to the imaginary backend
15362 @code{nnchoke}. 
15363
15364 @cindex @code{nnchoke}
15365
15366 @menu
15367 * Required Backend Functions::        Functions that must be implemented.
15368 * Optional Backend Functions::        Functions that need not be implemented.
15369 * Error Messaging::                   How to get messages and report errors.
15370 * Writing New Backends::              Extending old backends.
15371 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
15372 * Mail-like Backends::                Some tips on mail backends.
15373 @end menu
15374
15375
15376 @node Required Backend Functions
15377 @subsubsection Required Backend Functions
15378
15379 @table @code
15380
15381 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
15382
15383 @var{articles} is either a range of article numbers or a list of
15384 @code{Message-ID}s.  Current backends do not fully support either---only
15385 sequences (lists) of article numbers, and most backends do not support
15386 retrieval of @code{Message-ID}s.  But they should try for both. 
15387
15388 The result data should either be HEADs or NOV lines, and the result
15389 value should either be @code{headers} or @code{nov} to reflect this.
15390 This might later be expanded to @code{various}, which will be a mixture
15391 of HEADs and NOV lines, but this is currently not supported by Gnus.  
15392
15393 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
15394 headers, in some meaning of the word.  This is generally done by
15395 fetching (at most) @var{fetch-old} extra headers less than the smallest
15396 article number in @code{articles}, and fill in the gaps as well.  The
15397 presence of this parameter can be ignored if the backend finds it
15398 cumbersome to follow the request.  If this is non-@code{nil} and not a
15399 number, do maximum fetches.
15400
15401 Here's an example HEAD:
15402
15403 @example
15404 221 1056 Article retrieved.
15405 Path: ifi.uio.no!sturles
15406 From: sturles@@ifi.uio.no (Sturle Sunde)
15407 Newsgroups: ifi.discussion
15408 Subject: Re: Something very droll
15409 Date: 27 Oct 1994 14:02:57 +0100
15410 Organization: Dept. of Informatics, University of Oslo, Norway
15411 Lines: 26
15412 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
15413 References: <38jdmq$4qu@@visbur.ifi.uio.no>
15414 NNTP-Posting-Host: holmenkollen.ifi.uio.no
15415 .
15416 @end example
15417
15418 So a @code{headers} return value would imply that there's a number of
15419 these in the data buffer.
15420
15421 Here's a BNF definition of such a buffer:
15422
15423 @example
15424 headers        = *head
15425 head           = error / valid-head
15426 error-message  = [ "4" / "5" ] 2number " " <error message> eol
15427 valid-head     = valid-message *header "." eol
15428 valid-message  = "221 " <number> " Article retrieved." eol
15429 header         = <text> eol
15430 @end example
15431
15432 If the return value is @code{nov}, the data buffer should contain
15433 @dfn{network overview database} lines.  These are basically fields
15434 separated by tabs. 
15435
15436 @example
15437 nov-buffer = *nov-line
15438 nov-line   = 8*9 [ field <TAB> ] eol
15439 field      = <text except TAB>
15440 @end example
15441
15442 For a closer explanation what should be in those fields,
15443 @pxref{Headers}. 
15444
15445
15446 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15447
15448 @var{server} is here the virtual server name.  @var{definitions} is a
15449 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
15450
15451 If the server can't be opened, no error should be signaled.  The backend
15452 may then choose to refuse further attempts at connecting to this
15453 server.  In fact, it should do so. 
15454
15455 If the server is opened already, this function should return a
15456 non-@code{nil} value.  There should be no data returned.
15457
15458
15459 @item (nnchoke-close-server &optional SERVER)
15460
15461 Close connection to @var{server} and free all resources connected
15462 to it.  Return @code{nil} if the server couldn't be closed for some
15463 reason.
15464
15465 There should be no data returned.
15466
15467
15468 @item (nnchoke-request-close)
15469
15470 Close connection to all servers and free all resources that the backend
15471 have reserved.  All buffers that have been created by that backend
15472 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
15473 function is generally only called when Gnus is shutting down.
15474
15475 There should be no data returned. 
15476
15477
15478 @item (nnchoke-server-opened &optional SERVER)
15479
15480 If @var{server} is the current virtual server, and the connection to the
15481 physical server is alive, then this function should return a
15482 non-@code{nil} vlue.  This function should under no circumstances
15483 attempt to reconnect to a server that is has lost connection to.
15484
15485 There should be no data returned.
15486
15487
15488 @item (nnchoke-status-message &optional SERVER)
15489
15490 This function should return the last error message from @var{server}. 
15491
15492 There should be no data returned.
15493
15494
15495 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15496
15497 The result data from this function should be the article specified by
15498 @var{article}.  This might either be a @code{Message-ID} or a number.
15499 It is optional whether to implement retrieval by @code{Message-ID}, but
15500 it would be nice if that were possible.
15501
15502 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15503 in this buffer instead of the normal data buffer.  This is to make it
15504 possible to avoid copying large amounts of data from one buffer to
15505 another, and Gnus mainly request articles to be inserted directly into
15506 its article buffer.
15507
15508 If it is at all possible, this function should return a cons cell where
15509 the car is the group name the article was fetched from, and the cdr is
15510 the article number.  This will enable Gnus to find out what the real
15511 group and article numbers are when fetching articles by
15512 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
15513 on successful article retrievement.
15514
15515
15516 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15517
15518 Get data on @var{group}.  This function also has the side effect of
15519 making @var{group} the current group. 
15520
15521 If @var{FAST}, don't bother to return useful data, just make @var{group}
15522 the current group.
15523
15524 Here's an example of some result data and a definition of the same:
15525
15526 @example
15527 211 56 1000 1059 ifi.discussion
15528 @end example
15529
15530 The first number is the status, which should be 211.  Next is the
15531 total number of articles in the group, the lowest article number, the
15532 highest article number, and finally the group name.  Note that the total
15533 number of articles may be less than one might think while just
15534 considering the highest and lowest article numbers, but some articles
15535 may have been canceled.  Gnus just discards the total-number, so
15536 whether one should take the bother to generate it properly (if that is a
15537 problem) is left as an exercise to the reader.
15538
15539 @example
15540 group-status = [ error / info ] eol
15541 error        = [ "4" / "5" ] 2<number> " " <Error message>
15542 info         = "211 " 3* [ <number> " " ] <string>
15543 @end example
15544
15545
15546 @item (nnchoke-close-group GROUP &optional SERVER)
15547
15548 Close @var{group} and free any resources connected to it.  This will be
15549 a no-op on most backends. 
15550
15551 There should be no data returned.
15552
15553
15554 @item (nnchoke-request-list &optional SERVER)
15555
15556 Return a list of all groups available on @var{server}.  And that means
15557 @emph{all}. 
15558
15559 Here's an example from a server that only carries two groups:
15560
15561 @example
15562 ifi.test 0000002200 0000002000 y
15563 ifi.discussion 3324 3300 n
15564 @end example
15565
15566 On each line we have a group name, then the highest article number in
15567 that group, the lowest article number, and finally a flag.
15568
15569 @example
15570 active-file = *active-line
15571 active-line = name " " <number> " " <number> " " flags eol
15572 name        = <string>
15573 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
15574 @end example
15575
15576 The flag says whether the group is read-only (@samp{n}), is moderated
15577 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15578 (@samp{=other-group} or none of the above (@samp{y}). 
15579
15580
15581 @item (nnchoke-request-post &optional SERVER)
15582
15583 This function should post the current buffer.  It might return whether
15584 the posting was successful or not, but that's not required.  If, for
15585 instance, the posting is done asynchronously, it has generally not been
15586 completed by the time this function concludes.  In that case, this
15587 function should set up some kind of sentinel to beep the user loud and
15588 clear if the posting could not be completed.
15589
15590 There should be no result data from this function. 
15591
15592 @end table
15593
15594
15595 @node Optional Backend Functions
15596 @subsubsection Optional Backend Functions
15597
15598 @table @code
15599
15600 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15601
15602 @var{groups} is a list of groups, and this function should request data
15603 on all those groups.  How it does it is of no concern to Gnus, but it
15604 should attempt to do this in a speedy fashion.
15605
15606 The return value of this function can be either @code{active} or
15607 @code{group}, which says what the format of the result data is.  The
15608 former is in the same format as the data from
15609 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15610 in the same format as @code{nnchoke-request-group} gives.
15611
15612 @example
15613 group-buffer = *active-line / *group-status
15614 @end example
15615
15616
15617 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15618
15619 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15620 alterations.  This comes in handy if the backend really carries all the
15621 information (as is the case with virtual and imap groups).  This
15622 function should destructively alter the info to suit its needs, and
15623 should return the (altered) group info.
15624
15625 There should be no result data from this function.
15626
15627
15628 @item (nnchoke-request-type GROUP &optional ARTICLE)
15629
15630 When the user issues commands for ``sending news'' (@kbd{F} in the
15631 summary buffer, for instance), Gnus has to know whether the article the
15632 user is following up is news or mail.  This function should return
15633 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15634 is mail and @code{unknown} if the type can't be decided.  (The
15635 @var{article} parameter is necessary in @code{nnvirtual} groups which
15636 might very well combine mail groups and news groups.)  Both @var{group}
15637 and @var{article} may be @code{nil}.
15638
15639 There should be no result data from this function.
15640
15641
15642 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15643
15644 If the user tries to set a mark that the backend doesn't like, this
15645 function may change the mark.  Gnus will use whatever this function
15646 returns as the mark for @var{article} instead of the original
15647 @var{mark}.  If the backend doesn't care, it must return the original
15648 @var{mark}, and not @code{nil} or any other type of garbage.  
15649
15650 The only use for this that I can see is what @code{nnvirtual} does with
15651 it---if a component group is auto-expirable, marking an article as read
15652 in the virtual group should result in the article being marked as
15653 expirable. 
15654
15655 There should be no result data from this function.
15656
15657
15658 @item (nnchoke-request-scan &optional GROUP SERVER)
15659
15660 This function may be called at any time (by Gnus or anything else) to
15661 request that the backend check for incoming articles, in one way or
15662 another.  A mail backend will typically read the spool file or query the
15663 POP server when this function is invoked.  The @var{group} doesn't have
15664 to be heeded---if the backend decides that it is too much work just
15665 scanning for a single group, it may do a total scan of all groups.  It
15666 would be nice, however, to keep things local if that's practical.
15667
15668 There should be no result data from this function.
15669
15670
15671 @item (nnchoke-request-group-description GROUP &optional SERVER)
15672
15673 The result data from this function should be a description of
15674 @var{group}. 
15675
15676 @example
15677 description-line = name <TAB> description eol
15678 name             = <string>
15679 description      = <text>
15680 @end example
15681
15682 @item (nnchoke-request-list-newsgroups &optional SERVER)
15683
15684 The result data from this function should be the description of all
15685 groups available on the server.
15686
15687 @example
15688 description-buffer = *description-line
15689 @end example
15690
15691
15692 @item (nnchoke-request-newgroups DATE &optional SERVER)
15693
15694 The result data from this function should be all groups that were
15695 created after @samp{date}, which is in normal human-readable date
15696 format.  The data should be in the active buffer format.
15697
15698
15699 @item (nnchoke-request-create-group GROUP &optional SERVER)
15700
15701 This function should create an empty group with name @var{group}.  
15702
15703 There should be no return data.
15704
15705
15706 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15707
15708 This function should run the expiry process on all articles in the
15709 @var{articles} range (which is currently a simple list of article
15710 numbers.)  It is left up to the backend to decide how old articles
15711 should be before they are removed by this function.  If @var{force} is
15712 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15713 they are. 
15714
15715 This function should return a list of articles that it did not/was not
15716 able to delete.
15717
15718 There should be no result data returned.
15719
15720
15721 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15722 &optional LAST)
15723
15724 This function should move @var{article} (which is a number) from
15725 @var{group} by calling @var{accept-form}.  
15726
15727 This function should ready the article in question for moving by
15728 removing any header lines it has added to the article, and generally
15729 should ``tidy up'' the article.  Then it should @code{eval}
15730 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15731 will do the actual copying.  If this @code{eval} returns a
15732 non-@code{nil} value, the article should be removed.
15733
15734 If @var{last} is @code{nil}, that means that there is a high likelihood
15735 that there will be more requests issued shortly, so that allows some
15736 optimizations. 
15737
15738 The function should return a cons where the car is the group name and
15739 the cdr is the article number that the article was entered as.
15740
15741 There should be no data returned. 
15742
15743
15744 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15745
15746 This function takes the current buffer and inserts it into @var{group}.
15747 If @var{last} in @code{nil}, that means that there will be more calls to
15748 this function in short order.
15749
15750 The function should return a cons where the car is the group name and
15751 the cdr is the article number that the article was entered as.
15752
15753 There should be no data returned.
15754
15755
15756 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15757
15758 This function should remove @var{article} (which is a number) from
15759 @var{group} and insert @var{buffer} there instead.
15760
15761 There should be no data returned.
15762
15763
15764 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15765
15766 This function should delete @var{group}.  If @var{force}, it should
15767 really delete all the articles in the group, and then delete the group
15768 itself.  (If there is such a thing as ``the group itself''.)
15769
15770 There should be no data returned.
15771
15772
15773 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15774
15775 This function should rename @var{group} into @var{new-name}.  All
15776 articles that are in @var{group} should move to @var{new-name}.
15777
15778 There should be no data returned.
15779
15780 @end table
15781
15782
15783 @node Error Messaging
15784 @subsubsection Error Messaging
15785
15786 @findex nnheader-report
15787 @findex nnheader-get-report
15788 The backends should use the function @code{nnheader-report} to report
15789 error conditions---they should not raise errors when they aren't able to
15790 perform a request.  The first argument to this function is the backend
15791 symbol, and the rest are interpreted as arguments to @code{format} if
15792 there are many of them, or just a string if there is one of them.
15793 This function always returns @code{nil}.
15794
15795 @lisp
15796 (nnheader-report 'nnchoke "You did something totally bogus")
15797
15798 (nnheader-report 'nnchoke "Could not request group %s" group)
15799 @end lisp
15800
15801 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15802 @code{nil} back from a server, and this function returns the most
15803 recently reported message for the backend in question.  This function
15804 takes one argument---the server symbol.
15805
15806 Internally, these function access @var{backend}@code{-status-string}, so
15807 the @code{nnchoke} backend will have its error message stored in
15808 @code{nnchoke-status-string}. 
15809
15810
15811 @node Writing New Backends
15812 @subsubsection Writing New Backends
15813
15814 Many backends are quite similar.  @code{nnml} is just like
15815 @code{nnspool}, but it allows you to edit the articles on the server.
15816 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15817 and it doesn't maintain overview databases.  @code{nndir} is just like
15818 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15819 editing articles.
15820
15821 It would make sense if it were possible to ``inherit'' functions from
15822 backends when writing new backends.  And, indeed, you can do that if you
15823 want to.  (You don't have to if you don't want to, of course.)  
15824
15825 All the backends declare their public variables and functions by using a
15826 package called @code{nnoo}.  
15827
15828 To inherit functions from other backends (and allow other backends to
15829 inherit functions from the current backend), you should use the
15830 following macros:
15831 following. 
15832
15833 @table @code
15834
15835 @item nnoo-declare
15836 This macro declares the first parameter to be a child of the subsequent
15837 parameters.  For instance:
15838
15839 @lisp
15840 (nnoo-declare nndir
15841   nnml nnmh)
15842 @end lisp
15843
15844 @code{nndir} has here declared that it intends to inherit functions from
15845 both @code{nnml} and @code{nnmh}.
15846
15847 @item defvoo
15848 This macro is equivalent to @code{defvar}, but registers the variable as
15849 a public server variable.  Most state-oriented variables should be
15850 declared with @code{defvoo} instead of @code{defvar}.  
15851
15852 In addition to the normal @code{defvar} parameters, it takes a list of
15853 variables in the parent backends to map the variable to when executing
15854 a function in those backends.
15855
15856 @lisp
15857 (defvoo nndir-directory nil
15858   "Where nndir will look for groups."
15859   nnml-current-directory nnmh-current-directory)
15860 @end lisp
15861
15862 This means that @code{nnml-current-directory} will be set to
15863 @code{nndir-directory} when an @code{nnml} function is called on behalf
15864 of @code{nndir}.  (The same with @code{nnmh}.)  
15865
15866 @item nnoo-define-basics
15867 This macro defines some common functions that almost all backends should
15868 have.
15869
15870 @example
15871 (nnoo-define-basics nndir)
15872 @end example
15873
15874 @item deffoo
15875 This macro is just like @code{defun} and takes the same parameters.  In
15876 addition to doing the normal @code{defun} things, it registers the
15877 function as being public so that other backends can inherit it.
15878
15879 @item nnoo-map-functions
15880 This macro allows mapping of functions from the current backend to
15881 functions from the parent backends.
15882
15883 @example
15884 (nnoo-map-functions nndir
15885   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15886   (nnmh-request-article 0 nndir-current-group 0 0))
15887 @end example
15888
15889 This means that when @code{nndir-retrieve-headers} is called, the first,
15890 third, and fourth parameters will be passed on to
15891 @code{nnml-retrieve-headers}, while the second parameter is set to the
15892 value of @code{nndir-current-group}.
15893
15894 @item nnoo-import
15895 This macro allows importing functions from backends.  It should be the
15896 last thing in the source file, since it will only define functions that
15897 haven't already been defined.
15898
15899 @example
15900 (nnoo-import nndir
15901   (nnmh
15902    nnmh-request-list
15903    nnmh-request-newgroups)
15904   (nnml))
15905 @end example
15906
15907 This means that calls to @code{nndir-request-list} should just be passed
15908 on to @code{nnmh-request-list}, while all public functions from
15909 @code{nnml} that haven't been defined in @code{nndir} yet should be
15910 defined now.
15911
15912 @end table
15913
15914 Below is a slightly shortened version of the @code{nndir} backend.
15915
15916 @lisp
15917 ;;; nndir.el --- single directory newsgroup access for Gnus
15918 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15919
15920 ;;; Code:
15921
15922 (require 'nnheader)
15923 (require 'nnmh)
15924 (require 'nnml)
15925 (require 'nnoo)
15926 (eval-when-compile (require 'cl))
15927
15928 (nnoo-declare nndir
15929   nnml nnmh)
15930
15931 (defvoo nndir-directory nil
15932   "Where nndir will look for groups."
15933   nnml-current-directory nnmh-current-directory)
15934
15935 (defvoo nndir-nov-is-evil nil
15936   "*Non-nil means that nndir will never retrieve NOV headers."
15937   nnml-nov-is-evil)
15938
15939 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15940 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15941 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15942
15943 (defvoo nndir-status-string "" nil nnmh-status-string)
15944 (defconst nndir-version "nndir 1.0")
15945
15946 ;;; Interface functions.
15947
15948 (nnoo-define-basics nndir)
15949
15950 (deffoo nndir-open-server (server &optional defs)
15951   (setq nndir-directory
15952         (or (cadr (assq 'nndir-directory defs))
15953             server))
15954   (unless (assq 'nndir-directory defs)
15955     (push `(nndir-directory ,server) defs))
15956   (push `(nndir-current-group
15957           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15958         defs)
15959   (push `(nndir-top-directory
15960           ,(file-name-directory (directory-file-name nndir-directory)))
15961         defs)
15962   (nnoo-change-server 'nndir server defs))
15963
15964 (nnoo-map-functions nndir
15965   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15966   (nnmh-request-article 0 nndir-current-group 0 0)
15967   (nnmh-request-group nndir-current-group 0 0)
15968   (nnmh-close-group nndir-current-group 0))
15969
15970 (nnoo-import nndir
15971   (nnmh
15972    nnmh-status-message
15973    nnmh-request-list
15974    nnmh-request-newgroups))
15975
15976 (provide 'nndir)
15977 @end lisp
15978
15979
15980 @node Hooking New Backends Into Gnus
15981 @subsubsection Hooking New Backends Into Gnus
15982
15983 @vindex gnus-valid-select-methods
15984 Having Gnus start using your new backend is rather easy---you just
15985 declare it with the @code{gnus-declare-backend} functions.  This will
15986 enter the backend into the @code{gnus-valid-select-methods} variable.
15987
15988 @code{gnus-declare-backend} takes two parameters---the backend name and
15989 an arbitrary number of @dfn{abilities}.
15990
15991 Here's an example:
15992
15993 @lisp
15994 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15995 @end lisp
15996
15997 The abilities can be:
15998
15999 @table @code
16000 @item mail
16001 This is a mailish backend---followups should (probably) go via mail.
16002 @item post
16003 This is a newsish backend---followups should (probably) go via news. 
16004 @item post-mail
16005 This backend supports both mail and news.
16006 @item none
16007 This is neither a post or mail backend---it's something completely
16008 different. 
16009 @item respool
16010 It supports respooling---or rather, it is able to modify its source
16011 articles and groups.
16012 @item address
16013 The name of the server should be in the virtual server name.  This is
16014 true for almost all backends.
16015 @item prompt-address
16016 The user should be prompted for an address when doing commands like
16017 @kbd{B} in the group buffer.  This is true for backends like
16018 @code{nntp}, but not @code{nnmbox}, for instance. 
16019 @end table
16020
16021
16022 @node Mail-like Backends
16023 @subsubsection Mail-like Backends
16024
16025 One of the things that separate the mail backends from the rest of the
16026 backends is the heavy dependence by the mail backends on common
16027 functions in @file{nnmail.el}.  For instance, here's the definition of
16028 @code{nnml-request-scan}: 
16029
16030 @lisp
16031 (deffoo nnml-request-scan (&optional group server)
16032   (setq nnml-article-file-alist nil)
16033   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
16034 @end lisp
16035
16036 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
16037 and @code{nnmail} takes care of all the moving and splitting of the
16038 mail.  
16039
16040 This function takes four parameters.
16041
16042 @table @var
16043 @item method
16044 This should be a symbol to designate which backend is responsible for
16045 the call.
16046
16047 @item exit-function
16048 This function should be called after the splitting has been performed.
16049
16050 @item temp-directory
16051 Where the temporary files should be stored.
16052
16053 @item group
16054 This optional argument should be a group name if the splitting is to be
16055 performed for one group only.
16056 @end table
16057
16058 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
16059 save each article.  @var{backend}@code{-active-number} will be called to
16060 find the article number assigned to this article.  
16061
16062 The function also uses the following variables:
16063 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
16064 this backend); and @var{backend}@code{-group-alist} and
16065 @var{backend}@code{-active-file} to generate the new active file.
16066 @var{backend}@code{-group-alist} should be a group-active alist, like
16067 this:
16068
16069 @example
16070 (("a-group" (1 . 10))
16071  ("some-group" (34 . 39)))
16072 @end example
16073
16074
16075 @node Score File Syntax
16076 @subsection Score File Syntax
16077
16078 Score files are meant to be easily parsable, but yet extremely
16079 mallable.   It was decided that something that had the same read syntax
16080 as an Emacs Lisp list would fit that spec.
16081
16082 Here's a typical score file:
16083
16084 @lisp
16085 (("summary"
16086   ("win95" -10000 nil s)
16087   ("Gnus"))
16088  ("from"
16089   ("Lars" -1000))
16090  (mark -100))
16091 @end lisp
16092
16093 BNF definition of a score file:
16094
16095 @example
16096 score-file       = "" / "(" *element ")"
16097 element          = rule / atom
16098 rule             = string-rule / number-rule / date-rule
16099 string-rule      = "(" quote string-header quote space *string-match ")"
16100 number-rule      = "(" quote number-header quote space *number-match ")"
16101 date-rule        = "(" quote date-header quote space *date-match ")"
16102 quote            = <ascii 34>
16103 string-header    = "subject" / "from" / "references" / "message-id" / 
16104                    "xref" / "body" / "head" / "all" / "followup"
16105 number-header    = "lines" / "chars"
16106 date-header      = "date"
16107 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
16108                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
16109 score            = "nil" / <integer>
16110 date             = "nil" / <natural number>
16111 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
16112                    "r" / "regex" / "R" / "Regex" /
16113                    "e" / "exact" / "E" / "Exact" /
16114                    "f" / "fuzzy" / "F" / "Fuzzy"
16115 number-match     = "(" <integer> [ "" / [ space score [ "" / 
16116                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
16117 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
16118 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
16119                    space date [ "" / [ space date-match-t ] ] ] ] ")"
16120 date-match-t     = "nil" / "at" / "before" / "after"
16121 atom             = "(" [ required-atom / optional-atom ] ")"
16122 required-atom    = mark / expunge / mark-and-expunge / files /
16123                    exclude-files / read-only / touched
16124 optional-atom    = adapt / local / eval 
16125 mark             = "mark" space nil-or-number
16126 nil-or-number    = "nil" / <integer>
16127 expunge          = "expunge" space nil-or-number
16128 mark-and-expunge = "mark-and-expunge" space nil-or-number
16129 files            = "files" *[ space <string> ]
16130 exclude-files    = "exclude-files" *[ space <string> ]
16131 read-only        = "read-only" [ space "nil" / space "t" ]
16132 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
16133 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
16134 local            = "local" *[ space "(" <string> space <form> ")" ]
16135 eval             = "eval" space <form>
16136 space            = *[ " " / <TAB> / <NEWLINE> ]
16137 @end example
16138
16139 Any unrecognized elements in a score file should be ignored, but not
16140 discarded.  
16141
16142 As you can see, white space is needed, but the type and amount of white
16143 space is irrelevant.  This means that formatting of the score file is
16144 left up to the programmer---if it's simpler to just spew it all out on
16145 one looong line, then that's ok.
16146
16147 The meaning of the various atoms are explained elsewhere in this
16148 manual. 
16149
16150
16151 @node Headers
16152 @subsection Headers
16153
16154 Gnus uses internally a format for storing article headers that
16155 corresponds to the @sc{nov} format in a mysterious fashion.  One could
16156 almost suspect that the author looked at the @sc{nov} specification and
16157 just shamelessly @emph{stole} the entire thing, and one would be right.
16158
16159 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
16160 RFC1036 to talk about lines in the head of an article (e.g.,
16161 @code{From}).  It is used by many people as a synonym for
16162 ``head''---``the header and the body''.  (That should be avoided, in my
16163 opinion.)  And Gnus uses a format internally that it calls ``header'',
16164 which is what I'm talking about here.  This is a 9-element vector,
16165 basically, with each header (ouch) having one slot.
16166
16167 These slots are, in order: @code{number}, @code{subject}, @code{from},
16168 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
16169 @code{xref}.  There are macros for accessing and setting these
16170 slots---they all have predictable names beginning with
16171 @code{mail-header-} and @code{mail-header-set-}, respectively.
16172
16173 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
16174 be put in there.
16175
16176
16177 @node Ranges
16178 @subsection Ranges
16179
16180 @sc{gnus} introduced a concept that I found so useful that I've started
16181 using it a lot and have elaborated on it greatly. 
16182
16183 The question is simple: If you have a large amount of objects that are
16184 identified by numbers (say, articles, to take a @emph{wild} example)
16185 that you want to qualify as being ``included'', a normal sequence isn't
16186 very useful.  (A 200,000 length sequence is a bit long-winded.)
16187
16188 The solution is as simple as the question: You just collapse the
16189 sequence. 
16190
16191 @example
16192 (1 2 3 4 5 6 10 11 12)
16193 @end example
16194
16195 is transformed into
16196
16197 @example
16198 ((1 . 6) (10 . 12))
16199 @end example
16200
16201 To avoid having those nasty @samp{(13 . 13)} elements to denote a
16202 lonesome object, a @samp{13} is a valid element:
16203
16204 @example
16205 ((1 . 6) 7 (10 . 12))
16206 @end example
16207
16208 This means that comparing two ranges to find out whether they are equal
16209 is slightly tricky:
16210
16211 @example
16212 ((1 . 5) 7 8 (10 . 12))
16213 @end example
16214
16215 and
16216
16217 @example
16218 ((1 . 5) (7 . 8) (10 . 12))
16219 @end example
16220
16221 are equal.  In fact, any non-descending list is a range:
16222
16223 @example
16224 (1 2 3 4 5)
16225 @end example
16226
16227 is a perfectly valid range, although a pretty long-winded one.  This is
16228 also legal:
16229
16230 @example
16231 (1 . 5)
16232 @end example
16233
16234 and is equal to the previous range.
16235
16236 Here's a BNF definition of ranges.  Of course, one must remember the
16237 semantic requirement that the numbers are non-descending.  (Any number
16238 of repetition of the same number is allowed, but apt to disappear in
16239 range handling.)
16240
16241 @example
16242 range           = simple-range / normal-range
16243 simple-range    = "(" number " . " number ")"
16244 normal-range    = "(" start-contents ")"
16245 contents        = "" / simple-range *[ " " contents ] / 
16246                   number *[ " " contents ]
16247 @end example
16248
16249 Gnus currently uses ranges to keep track of read articles and article
16250 marks.  I plan on implementing a number of range operators in C if The
16251 Powers That Be are willing to let me.  (I haven't asked yet, because I
16252 need to do some more thinking on what operators I need to make life
16253 totally range-based without ever having to convert back to normal
16254 sequences.) 
16255
16256
16257 @node Group Info
16258 @subsection Group Info
16259
16260 Gnus stores all permanent info on groups in a @dfn{group info} list.
16261 This list is from three to six elements (or more) long and exhaustively
16262 describes the group.
16263
16264 Here are two example group infos; one is a very simple group while the
16265 second is a more complex one:
16266
16267 @example
16268 ("no.group" 5 (1 . 54324))
16269
16270 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
16271                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
16272                 (nnml "")
16273                 (auto-expire (to-address "ding@@gnus.org")))
16274 @end example
16275
16276 The first element is the @dfn{group name}---as Gnus knows the group,
16277 anyway.  The second element is the @dfn{subscription level}, which
16278 normally is a small integer.  The third element is a list of ranges of
16279 read articles.  The fourth element is a list of lists of article marks
16280 of various kinds.  The fifth element is the select method (or virtual
16281 server, if you like).  The sixth element is a list of @dfn{group
16282 parameters}, which is what this section is about.
16283
16284 Any of the last three elements may be missing if they are not required.
16285 In fact, the vast majority of groups will normally only have the first
16286 three elements, which saves quite a lot of cons cells.
16287
16288 Here's a BNF definition of the group info format:
16289
16290 @example
16291 info          = "(" group space level space read 
16292                 [ "" / [ space marks-list [ "" / [ space method [ "" /
16293                 space parameters ] ] ] ] ] ")" 
16294 group         = quote <string> quote
16295 level         = <integer in the range of 1 to inf>
16296 read          = range
16297 marks-lists   = nil / "(" *marks ")"
16298 marks         = "(" <string> range ")"
16299 method        = "(" <string> *elisp-forms ")"
16300 parameters    = "(" *elisp-forms ")"
16301 @end example
16302
16303 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
16304 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
16305 in pseudo-BNF.
16306
16307 If you have a Gnus info and want to access the elements, Gnus offers a
16308 series of macros for getting/setting these elements.
16309
16310 @table @code
16311 @item gnus-info-group
16312 @itemx gnus-info-set-group
16313 @findex gnus-info-group
16314 @findex gnus-info-set-group
16315 Get/set the group name.
16316
16317 @item gnus-info-rank
16318 @itemx gnus-info-set-rank
16319 @findex gnus-info-rank
16320 @findex gnus-info-set-rank
16321 Get/set the group rank.
16322
16323 @item gnus-info-level
16324 @itemx gnus-info-set-level
16325 @findex gnus-info-level
16326 @findex gnus-info-set-level
16327 Get/set the group level.
16328
16329 @item gnus-info-score
16330 @itemx gnus-info-set-score
16331 @findex gnus-info-score
16332 @findex gnus-info-set-score
16333 Get/set the group score.
16334
16335 @item gnus-info-read
16336 @itemx gnus-info-set-read
16337 @findex gnus-info-read
16338 @findex gnus-info-set-read
16339 Get/set the ranges of read articles.
16340
16341 @item gnus-info-marks
16342 @itemx gnus-info-set-marks
16343 @findex gnus-info-marks
16344 @findex gnus-info-set-marks
16345 Get/set the lists of ranges of marked articles.
16346
16347 @item gnus-info-method
16348 @itemx gnus-info-set-method
16349 @findex gnus-info-method
16350 @findex gnus-info-set-method
16351 Get/set the group select method.
16352
16353 @item gnus-info-params
16354 @itemx gnus-info-set-params
16355 @findex gnus-info-params
16356 @findex gnus-info-set-params
16357 Get/set the group parameters.
16358 @end table
16359
16360 All the getter functions take one parameter---the info list.  The setter
16361 functions take two parameters---the info list and the new value.
16362
16363 The last three elements in the group info aren't mandatory, so it may be
16364 necessary to extend the group info before setting the element.  If this
16365 is necessary, you can just pass on a non-@code{nil} third parameter to
16366 the three final setter functions to have this happen automatically.
16367
16368
16369 @node Emacs/XEmacs Code
16370 @subsection Emacs/XEmacs Code
16371 @cindex XEmacs
16372 @cindex Emacsen
16373
16374 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
16375 platforms must be the primary one.  I chose Emacs.  Not because I don't
16376 like XEmacs or Mule, but because it comes first alphabetically.
16377
16378 This means that Gnus will byte-compile under Emacs with nary a warning,
16379 while XEmacs will pump out gigabytes of warnings while byte-compiling.
16380 As I use byte-compilation warnings to help me root out trivial errors in
16381 Gnus, that's very useful.  
16382
16383 I've also consistently used Emacs function interfaces, but have used
16384 Gnusey aliases for the functions.  To take an example:  Emacs defines a
16385 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
16386 function.  I then define a function called @code{gnus-run-at-time} that
16387 takes the same parameters as the Emacs @code{run-at-time}.  When running
16388 Gnus under Emacs, the former function is just an alias for the latter.
16389 However, when running under XEmacs, the former is an alias for the
16390 following function:
16391
16392 @lisp
16393 (defun gnus-xmas-run-at-time (time repeat function &rest args)
16394   (start-itimer
16395    "gnus-run-at-time"
16396    `(lambda ()
16397       (,function ,@@args))
16398    time repeat))
16399 @end lisp
16400
16401 This sort of thing has been done for bunches of functions.  Gnus does
16402 not redefine any native Emacs functions while running under XEmacs---it
16403 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
16404 all over.
16405
16406 In the cases when the XEmacs function interface was obviously
16407 cleaner, I used it instead.  For example @code{gnus-region-active-p}
16408 is an alias for @code{region-active-p} in XEmacs, whereas in Emacs
16409 it is a function.
16410
16411 Of course, I could have chosen XEmacs as my native platform and done
16412 mapping functions the other way around.  But I didn't.  The performance
16413 hit these indirections impose on Gnus under XEmacs should be slight.
16414
16415
16416 @node Various File Formats
16417 @subsection Various File Formats
16418
16419 @menu
16420 * Active File Format::      Information on articles and groups available.
16421 * Newsgroups File Format::  Group descriptions.
16422 @end menu
16423
16424
16425 @node Active File Format
16426 @subsubsection Active File Format
16427
16428 The active file lists all groups that are available on the server in
16429 question.  It also lists the highest and lowest current article numbers
16430 in each group.  
16431
16432 Here's an excerpt from a typical active file:
16433
16434 @example
16435 soc.motss 296030 293865 y
16436 alt.binaries.pictures.fractals 3922 3913 n
16437 comp.sources.unix 1605 1593 m
16438 comp.binaries.ibm.pc 5097 5089 y
16439 no.general 1000 900 y
16440 @end example
16441
16442 Here's a pseudo-BNF definition of this file:
16443
16444 @example
16445 active      = *group-line
16446 group-line  = group space high-number space low-number space flag <NEWLINE>
16447 group       = <non-white-space string>
16448 space       = " "
16449 high-number = <non-negative integer>
16450 low-number  = <positive integer>
16451 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
16452 @end example
16453
16454
16455 @node Newsgroups File Format
16456 @subsubsection Newsgroups File Format
16457
16458 The newsgroups file lists groups along with their descriptions.  Not all
16459 groups on the server have to be listed,  and not all groups in the file
16460 have to exist on the server.  The file is meant purely as information to
16461 the user.
16462
16463 The format is quite simple; a group name, a tab, and the description.
16464 Here's the definition:
16465
16466 @example
16467 newsgroups    = *line
16468 line          = group tab description <NEWLINE>
16469 group         = <non-white-space string>
16470 tab           = <TAB>
16471 description   = <string>
16472 @end example
16473
16474
16475 @node Emacs for Heathens
16476 @section Emacs for Heathens
16477
16478 Believe it or not, but some people who use Gnus haven't really used
16479 Emacs much before they embarked on their journey on the Gnus Love Boat.
16480 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
16481 region'', and ``set @code{gnus-flargblossen} to an alist where the key
16482 is a regexp that is used for matching on the group name'' are magical
16483 phrases with little or no meaning, then this appendix is for you.  If
16484 you are already familiar with Emacs, just ignore this and go fondle your
16485 cat instead.
16486
16487 @menu
16488 * Keystrokes::      Entering text and executing commands.
16489 * Emacs Lisp::      The built-in Emacs programming language.
16490 @end menu
16491
16492
16493 @node Keystrokes
16494 @subsection Keystrokes
16495
16496 @itemize @bullet
16497 @item
16498 Q: What is an experienced Emacs user?
16499
16500 @item 
16501 A: A person who wishes that the terminal had pedals.
16502 @end itemize
16503
16504 Yes, when you use Emacs, you are apt to use the control key, the shift
16505 key and the meta key a lot.  This is very annoying to some people
16506 (notably @code{vi}le users), and the rest of us just love the hell out
16507 of it.  Just give up and submit.  Emacs really does stand for
16508 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
16509 may have heard from other disreputable sources (like the Emacs author).
16510
16511 The shift key is normally located near your pinky fingers, and are
16512 normally used to get capital letters and stuff.  You probably use it all
16513 the time.  The control key is normally marked ``CTRL'' or something like
16514 that.  The meta key is, funnily enough, never marked as such on any
16515 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
16516 which is the meta key on this keyboard.  It's usually located somewhere
16517 to the left hand side of the keyboard, usually on the bottom row.
16518
16519 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16520 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
16521 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16522 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
16523 down the control key, and hold it down while you press @kbd{k}''.
16524 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16525 the control key and then press @kbd{k}''.  Simple, ay?
16526
16527 This is somewhat complicated by the fact that not all keyboards have a
16528 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
16529 means ``press escape, release escape, press @kbd{k}''.  That's much more
16530 work than if you have a meta key, so if that's the case, I respectfully
16531 suggest you get a real keyboard with a meta key.  You can't live without
16532 it.
16533
16534
16535
16536 @node Emacs Lisp
16537 @subsection Emacs Lisp
16538
16539 Emacs is the King of Editors because it's really a Lisp interpreter.
16540 Each and every key you tap runs some Emacs Lisp code snippet, and since
16541 Emacs Lisp is an interpreted language, that means that you can configure
16542 any key to run any arbitrary code.  You just, like, do it.
16543
16544 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16545 functions.  (These are byte-compiled for speed, but it's still
16546 interpreted.)  If you decide that you don't like the way Gnus does
16547 certain things, it's trivial to have it do something a different way.
16548 (Well, at least if you know how to write Lisp code.)  However, that's
16549 beyond the scope of this manual, so we are simply going to talk about
16550 some common constructs that you normally use in your @file{.emacs} file
16551 to customize Gnus.
16552
16553 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16554 write the following:
16555
16556 @lisp
16557 (setq gnus-florgbnize 4)
16558 @end lisp
16559
16560 This function (really ``special form'') @code{setq} is the one that can
16561 set a variable to some value.  This is really all you need to know.  Now
16562 you can go and fill your @code{.emacs} file with lots of these to change
16563 how Gnus works.
16564
16565 If you have put that thing in your @code{.emacs} file, it will be read
16566 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16567 start Emacs.  If you want to change the variable right away, simply say
16568 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
16569 previous ``form'', which here is a simple @code{setq} statement.
16570
16571 Go ahead---just try it, if you're located at your Emacs.  After you
16572 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16573 is the return value of the form you @code{eval}ed.
16574
16575 Some pitfalls:
16576
16577 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16578 that means:
16579
16580 @lisp
16581 (setq gnus-read-active-file 'some)
16582 @end lisp
16583
16584 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16585 @samp{nntp.ifi.uio.no}'', that means:
16586
16587 @lisp
16588 (setq gnus-nntp-server "nntp.ifi.uio.no")
16589 @end lisp
16590
16591 So be careful not to mix up strings (the latter) with symbols (the
16592 former).  The manual is unambiguous, but it can be confusing.
16593
16594
16595 @include gnus-faq.texi
16596
16597 @node Index
16598 @chapter Index
16599 @printindex cp
16600
16601 @node Key Index
16602 @chapter Key Index
16603 @printindex ky
16604
16605 @summarycontents
16606 @contents
16607 @bye
16608
16609 @iftex
16610 @iflatex
16611 \end{document}
16612 @end iflatex
16613 @end iftex
16614
16615 @c End:
16616