*** empty log message ***
[gnus] / texi / gnus.texi
1 \input texinfo                  @c -*-texinfo-*-
2
3 @setfilename gnus
4 @settitle Gnus 5.4.29 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.29 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.29
327
328 @end ifinfo
329
330 @iftex
331
332 @iflatex
333 \tableofcontents
334 \gnuscleardoublepage
335 @end iflatex
336
337 Gnus is the advanced, self-documenting, customizable, extensible
338 unreal-time newsreader for GNU Emacs.  
339
340 Oops.  That sounds oddly familiar, so let's start over again to avoid
341 being accused of plagiarism:
342
343 Gnus is a message-reading laboratory.  It will let you look at just
344 about anything as if it were a newsgroup.  You can read mail with it,
345 you can browse directories with it, you can @code{ftp} with it---you can
346 even read news with it!
347
348 Gnus tries to empower people who read news the same way Emacs empowers
349 people who edit text.  Gnus sets no limits to what the user should be
350 allowed to do.  Users are encouraged to extend Gnus to make it behave
351 like they want it to behave.  A program should not control people;
352 people should be empowered to do what they want by using (or abusing)
353 the program.
354
355 @end iftex
356
357
358 @menu
359 * Starting Up::           Finding news can be a pain.
360 * The Group Buffer::      Selecting, subscribing and killing groups.
361 * The Summary Buffer::    Reading, saving and posting articles.
362 * The Article Buffer::    Displaying and handling articles.
363 * Composing Messages::    Information on sending mail and news.
364 * Select Methods::        Gnus reads all messages from various select methods.
365 * Scoring::               Assigning values to articles.
366 * Various::               General purpose settings.
367 * The End::               Farewell and goodbye.
368 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
369 * Index::                 Variable, function and concept index.
370 * Key Index::             Key Index.
371 @end menu
372
373 @node Starting Up
374 @chapter Starting Gnus
375 @cindex starting up
376
377 @kindex M-x gnus
378 @findex gnus
379 If your system administrator has set things up properly, starting Gnus
380 and reading news is extremely easy---you just type @kbd{M-x gnus} in
381 your Emacs. 
382
383 @findex gnus-other-frame
384 @kindex M-x gnus-other-frame
385 If you want to start Gnus in a different frame, you can use the command
386 @kbd{M-x gnus-other-frame} instead.
387
388 If things do not go smoothly at startup, you have to twiddle some
389 variables. 
390
391 @menu
392 * Finding the News::    Choosing a method for getting news.
393 * The First Time::      What does Gnus do the first time you start it?
394 * The Server is Down::  How can I read my mail then?
395 * Slave Gnusae::        You can have more than one Gnus active at a time.
396 * Fetching a Group::    Starting Gnus just to read a group.
397 * New Groups::          What is Gnus supposed to do with new groups?
398 * Startup Files::       Those pesky startup files---@file{.newsrc}.
399 * Auto Save::           Recovering from a crash.
400 * The Active File::     Reading the active file over a slow line Takes Time.
401 * Changing Servers::    You may want to move from one server to another.
402 * Startup Variables::   Other variables you might change.
403 @end menu
404
405
406 @node Finding the News
407 @section Finding the News
408 @cindex finding news
409
410 @vindex gnus-select-method
411 @c @head
412 The @code{gnus-select-method} variable says where Gnus should look for
413 news.  This variable should be a list where the first element says
414 @dfn{how} and the second element says @dfn{where}.  This method is your
415 native method.  All groups that are not fetched with this method are
416 foreign groups.
417
418 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
419 you want to get your daily dosage of news from, you'd say:
420
421 @lisp
422 (setq gnus-select-method '(nntp "news.somewhere.edu"))
423 @end lisp
424
425 If you want to read directly from the local spool, say:
426
427 @lisp
428 (setq gnus-select-method '(nnspool ""))
429 @end lisp
430
431 If you can use a local spool, you probably should, as it will almost
432 certainly be much faster.
433
434 @vindex gnus-nntpserver-file
435 @cindex NNTPSERVER
436 @cindex @sc{nntp} server
437 If this variable is not set, Gnus will take a look at the
438 @code{NNTPSERVER} environment variable.  If that variable isn't set,
439 Gnus will see whether @code{gnus-nntpserver-file}
440 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
441 that fails as well, Gnus will will try to use the machine that is
442 running Emacs as an @sc{nntp} server.  That's a long shot, though.
443
444 @vindex gnus-nntp-server
445 If @code{gnus-nntp-server} is set, this variable will override
446 @code{gnus-select-method}.  You should therefore set
447 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
448
449 @vindex gnus-secondary-servers
450 You can also make Gnus prompt you interactively for the name of an
451 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
452 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
453 in the @code{gnus-secondary-servers} list (if any).  You can also just
454 type in the name of any server you feel like visiting.
455
456 @findex gnus-group-browse-foreign-server
457 @kindex B (Group)
458 However, if you use one @sc{nntp} server regularly and are just
459 interested in a couple of groups from a different server, you would be
460 better served by using the @kbd{B} command in the group buffer.  It will
461 let you have a look at what groups are available, and you can subscribe
462 to any of the groups you want to.  This also makes @file{.newsrc}
463 maintenance much tidier.  @xref{Foreign Groups}.
464
465 @vindex gnus-secondary-select-methods
466 @c @head
467 A slightly different approach to foreign groups is to set the
468 @code{gnus-secondary-select-methods} variable.  The select methods
469 listed in this variable are in many ways just as native as the
470 @code{gnus-select-method} server.  They will also be queried for active
471 files during startup (if that's required), and new newsgroups that
472 appear on these servers will be subscribed (or not) just as native
473 groups are.
474
475 For instance, if you use the @code{nnmbox} backend to read your mail, you
476 would typically set this variable to
477
478 @lisp
479 (setq gnus-secondary-select-methods '((nnmbox "")))
480 @end lisp
481
482
483 @node The First Time
484 @section The First Time
485 @cindex first time usage
486
487 If no startup files exist, Gnus will try to determine what groups should
488 be subscribed by default.
489
490 @vindex gnus-default-subscribed-newsgroups
491 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
492 will subscribe you to just those groups in that list, leaving the rest
493 killed.  Your system administrator should have set this variable to
494 something useful.
495
496 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
497 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is here
498 defined as @dfn{whatever Lars thinks you should read}.)
499
500 You'll also be subscribed to the Gnus documentation group, which should
501 help you with most common problems.  
502
503 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
504 use the normal functions for handling new groups, and not do anything
505 special.
506
507
508 @node The Server is Down
509 @section The Server is Down
510 @cindex server errors
511
512 If the default server is down, Gnus will understandably have some
513 problems starting.  However, if you have some mail groups in addition to
514 the news groups, you may want to start Gnus anyway.
515
516 Gnus, being the trusting sort of program, will ask whether to proceed
517 without a native select method if that server can't be contacted.  This
518 will happen whether the server doesn't actually exist (i.e., you have
519 given the wrong address) or the server has just momentarily taken ill
520 for some reason or other.  If you decide to continue and have no foreign
521 groups, you'll find it difficult to actually do anything in the group
522 buffer.  But, hey, that's your problem.  Blllrph!
523
524 @findex gnus-no-server
525 @kindex M-x gnus-no-server
526 @c @head
527 If you know that the server is definitely down, or you just want to read
528 your mail without bothering with the server at all, you can use the
529 @code{gnus-no-server} command to start Gnus.  That might come in handy
530 if you're in a hurry as well.  This command will not attempt to contact
531 your primary server---instead, it will just activate all groups on level
532 1 and 2.  (You should preferably keep no native groups on those two
533 levels.)
534
535
536 @node Slave Gnusae
537 @section Slave Gnusae
538 @cindex slave
539
540 You might want to run more than one Emacs with more than one Gnus at the
541 same time.  If you are using different @file{.newsrc} files (e.g., if you
542 are using the two different Gnusae to read from two different servers),
543 that is no problem whatsoever.  You just do it.
544
545 The problem appears when you want to run two Gnusae that use the same
546 @code{.newsrc} file.
547
548 To work around that problem some, we here at the Think-Tank at the Gnus
549 Towers have come up with a new concept: @dfn{Masters} and
550 @dfn{slaves}.  (We have applied for a patent on this concept, and have
551 taken out a copyright on those words.  If you wish to use those words in
552 conjunction with each other, you have to send $1 per usage instance to
553 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
554 Applications}) will be much more expensive, of course.)
555
556 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
557 however you do it).  Each subsequent slave Gnusae should be started with
558 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
559 files, but instead save @dfn{slave files} that contain information only
560 on what groups have been read in the slave session.  When a master Gnus
561 starts, it will read (and delete) these slave files, incorporating all
562 information from them.  (The slave files will be read in the sequence
563 they were created, so the latest changes will have precedence.)
564
565 Information from the slave files has, of course, precedence over the
566 information in the normal (i.e., master) @code{.newsrc} file.
567
568
569 @node Fetching a Group
570 @section Fetching a Group
571 @cindex fetching a group
572
573 @findex gnus-fetch-group
574 It it sometimes convenient to be able to just say ``I want to read this
575 group and I don't care whether Gnus has been started or not''.  This is
576 perhaps more useful for people who write code than for users, but the
577 command @code{gnus-fetch-group} provides this functionality in any case.
578 It takes the group name as a parameter.
579
580
581 @node New Groups
582 @section New Groups
583 @cindex new groups
584 @cindex subscription
585
586 @vindex gnus-check-new-newsgroups
587 If you are satisfied that you really never want to see any new groups,
588 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
589 also save you some time at startup.  Even if this variable is
590 @code{nil}, you can always subscribe to the new groups just by pressing
591 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
592 is @code{t} by default.  If you set this variable to @code{always}, then
593 Gnus will query the backends for new groups even when you do the @kbd{g}
594 command (@pxref{Scanning New Messages}).
595
596 @menu
597 * Checking New Groups::      Determining what groups are new.
598 * Subscription Methods::     What Gnus should do with new groups.
599 * Filtering New Groups::     Making Gnus ignore certain new groups.
600 @end menu
601
602
603 @node Checking New Groups
604 @subsection Checking New Groups
605
606 Gnus normally determines whether a group is new or not by comparing the
607 list of groups from the active file(s) with the lists of subscribed and
608 dead groups.  This isn't a particularly fast method.  If
609 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
610 server for new groups since the last time.  This is both faster and
611 cheaper.  This also means that you can get rid of the list of killed
612 groups altogether, so you may set @code{gnus-save-killed-list} to
613 @code{nil}, which will save time both at startup, at exit, and all over.
614 Saves disk space, too.  Why isn't this the default, then?
615 Unfortunately, not all servers support this command. 
616
617 I bet I know what you're thinking now: How do I find out whether my
618 server supports @code{ask-server}?  No?  Good, because I don't have a
619 fail-safe answer.  I would suggest just setting this variable to
620 @code{ask-server} and see whether any new groups appear within the next
621 few days.  If any do, then it works.  If none do, then it doesn't
622 work.  I could write a function to make Gnus guess whether the server
623 supports @code{ask-server}, but it would just be a guess.  So I won't.
624 You could @code{telnet} to the server and say @code{HELP} and see
625 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
626 it does, then it might work.  (But there are servers that lists
627 @samp{NEWGROUPS} without supporting the function properly.)
628
629 This variable can also be a list of select methods.  If so, Gnus will
630 issue an @code{ask-server} command to each of the select methods, and
631 subscribe them (or not) using the normal methods.  This might be handy
632 if you are monitoring a few servers for new groups.  A side effect is
633 that startup will take much longer, so you can meditate while waiting.
634 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
635
636
637 @node Subscription Methods
638 @subsection Subscription Methods
639
640 @vindex gnus-subscribe-newsgroup-method
641 What Gnus does when it encounters a new group is determined by the
642 @code{gnus-subscribe-newsgroup-method} variable.
643
644 This variable should contain a function.  Some handy pre-fab values
645 are:
646
647 @table @code
648
649 @item gnus-subscribe-zombies
650 @vindex gnus-subscribe-zombies
651 Make all new groups zombies.  This is the default.  You can browse the
652 zombies later (with @kbd{A z}) and either kill them all off properly
653 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
654
655 @item gnus-subscribe-randomly
656 @vindex gnus-subscribe-randomly
657 Subscribe all new groups randomly.
658
659 @item gnus-subscribe-alphabetically
660 @vindex gnus-subscribe-alphabetically
661 Subscribe all new groups alphabetically.
662
663 @item gnus-subscribe-hierarchically
664 @vindex gnus-subscribe-hierarchically
665 Subscribe all new groups hierarchically.  The difference between this
666 function and @code{gnus-subscribe-alphabetically} is slight.
667 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
668 alphabetical fashion, while this function will enter groups into it's
669 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
670 @samp{comp} hierarchy, this function will not mess that configuration
671 up.  Or something like that.
672
673 @item gnus-subscribe-interactively
674 @vindex gnus-subscribe-interactively
675 Subscribe new groups interactively.  This means that Gnus will ask
676 you about @strong{all} new groups.
677
678 @item gnus-subscribe-killed
679 @vindex gnus-subscribe-killed
680 Kill all new groups.
681
682 @end table
683
684 @vindex gnus-subscribe-hierarchical-interactive
685 A closely related variable is
686 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
687 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
688 hierarchical fashion whether to subscribe to new groups or not.  Gnus
689 will ask you for each sub-hierarchy whether you want to descend the
690 hierarchy or not.  
691
692 One common mistake is to set the variable a few paragraphs above to
693 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
694 will not work.  This is ga-ga.  So don't do it.
695
696
697 @node Filtering New Groups
698 @subsection Filtering New Groups
699
700 A nice and portable way to control which new newsgroups should be
701 subscribed (or ignored) is to put an @dfn{options} line at the start of
702 the @file{.newsrc} file.  Here's an example:
703
704 @example
705 options -n !alt.all !rec.all sci.all
706 @end example
707
708 @vindex gnus-subscribe-options-newsgroup-method
709 This line obviously belongs to a serious-minded intellectual scientific
710 person (or she may just be plain old boring), because it says that all
711 groups that have names beginning with @samp{alt} and @samp{rec} should
712 be ignored, and all groups with names beginning with @samp{sci} should
713 be subscribed.  Gnus will not use the normal subscription method for
714 subscribing these groups.
715 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
716 variable defaults to @code{gnus-subscribe-alphabetically}.
717
718 @vindex gnus-options-not-subscribe
719 @vindex gnus-options-subscribe
720 If you don't want to mess with your @file{.newsrc} file, you can just
721 set the two variables @code{gnus-options-subscribe} and
722 @code{gnus-options-not-subscribe}.  These two variables do exactly the
723 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
724 and if the the new group matches the former, it will be unconditionally
725 subscribed, and if it matches the latter, it will be ignored.
726
727 @vindex gnus-auto-subscribed-groups
728 Yet another variable that meddles here is
729 @code{gnus-auto-subscribed-groups}.  It works exactly like
730 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
731 thought it would be nice to have two of these.  This variable is more
732 meant for setting some ground rules, while the other variable is used
733 more for user fiddling.  By default this variable makes all new groups
734 that come from mail backends (@code{nnml}, @code{nnbabyl},
735 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
736 don't like that, just set this variable to @code{nil}.
737
738 New groups that match this regexp are subscribed using
739 @code{gnus-subscribe-options-newsgroup-method}.
740
741
742 @node Changing Servers
743 @section Changing Servers
744 @cindex changing servers
745
746 Sometimes it is necessary to move from one @sc{nntp} server to another.
747 This happens very rarely, but perhaps you change jobs, or one server is
748 very flaky and you want to use another.  
749
750 Changing the server is pretty easy, right?  You just change
751 @code{gnus-select-method} to point to the new server?  
752
753 @emph{Wrong!}
754
755 Article numbers are not (in any way) kept synchronized between different
756 @sc{nntp} servers, and the only way Gnus keeps track of what articles
757 you have read is by keeping track of article numbers.  So when you
758 change @code{gnus-select-method}, your @file{.newsrc} file becomes
759 worthless.  
760
761 Gnus provides a few functions to attempt to translate a @file{.newsrc}
762 file from one server to another.  They all have one thing in
763 common---they take a looong time to run.  You don't want to use these
764 functions more than absolutely necessary.
765
766 @kindex M-x gnus-change-server
767 @findex gnus-change-server
768 If you have access to both servers, Gnus can request the headers for all
769 the articles you have read and compare @code{Message-ID}s and map the
770 article numbers of the read articles and article marks.  The @kbd{M-x
771 gnus-change-server} command will do this for all your native groups.  It
772 will prompt for the method you want to move to.
773
774 @kindex M-x gnus-group-move-group-to-server
775 @findex gnus-group-move-group-to-server
776 You can also move individual groups with the @kbd{M-x
777 gnus-group-move-group-to-server} command.  This is useful if you want to
778 move a (foreign) group from one server to another.
779
780 @kindex M-x gnus-group-clear-data-on-native-groups
781 @findex gnus-group-clear-data-on-native-groups
782 If you don't have access to both the old and new server, all your marks
783 and read ranges have become worthless.  You can use the @kbd{M-x
784 gnus-group-clear-data-on-native-groups} command to clear out all data
785 that you have on your native groups.  Use with caution.
786
787
788 @node Startup Files
789 @section Startup Files
790 @cindex startup files
791 @cindex .newsrc
792 @cindex .newsrc.el
793 @cindex .newsrc.eld
794
795 Now, you all know about the @file{.newsrc} file.  All subscription
796 information is traditionally stored in this file.
797
798 Things got a bit more complicated with @sc{gnus}.  In addition to
799 keeping the @file{.newsrc} file updated, it also used a file called
800 @file{.newsrc.el} for storing all the information that didn't fit into
801 the @file{.newsrc} file.  (Actually, it also duplicated everything in
802 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
803 files was the most recently saved, which enabled people to swap between
804 @sc{gnus} and other newsreaders.
805
806 That was kinda silly, so Gnus went one better: In addition to the
807 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
808 @file{.newsrc.eld}.  It will read whichever of these files that are most
809 recent, but it will never write a @file{.newsrc.el} file.
810
811 @vindex gnus-save-newsrc-file
812 You can turn off writing the @file{.newsrc} file by setting
813 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
814 the file and save some space, as well as making exit from Gnus faster.
815 However, this will make it impossible to use other newsreaders than
816 Gnus.  But hey, who would want to, right?
817
818 @vindex gnus-save-killed-list
819 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
820 will not save the list of killed groups to the startup file.  This will
821 save both time (when starting and quitting) and space (on disk).  It
822 will also mean that Gnus has no record of what groups are new or old,
823 so the automatic new groups subscription methods become meaningless.
824 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
825 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
826 Groups}).  This variable can also be a regular expression.  If that's
827 the case, remove all groups that do not match this regexp before
828 saving.  This can be useful in certain obscure situations that involve
829 several servers where not all servers support @code{ask-server}.
830
831 @vindex gnus-startup-file
832 The @code{gnus-startup-file} variable says where the startup files are.
833 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
834 file being whatever that one is with a @samp{.eld} appended.
835
836 @vindex gnus-save-newsrc-hook
837 @vindex gnus-save-quick-newsrc-hook
838 @vindex gnus-save-standard-newsrc-hook
839 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
840 files, while @code{gnus-save-quick-newsrc-hook} is called just before
841 saving the @file{.newsrc.eld} file, and
842 @code{gnus-save-standard-newsrc-hook} is called just before saving the
843 @file{.newsrc} file.  The latter two are commonly used to turn version
844 control on or off.  Version control is on by default when saving the
845 startup files.  If you want to turn backup creation off, say something like: 
846
847 @lisp
848 (defun turn-off-backup ()
849   (set (make-local-variable 'backup-inhibited) t))
850
851 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
852 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
853 @end lisp
854
855 @vindex gnus-init-file
856 When Gnus starts, it will read the @code{gnus-site-init-file}
857 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
858 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
859 and can be used to avoid cluttering your @file{~/.emacs} and
860 @file{site-init} files with Gnus stuff.  Gnus will also check for files
861 with the same names as these, but with @file{.elc} and @file{.el}
862 suffixes.  In other words, if you have set @code{gnus-init-file} to
863 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
864 and finally @file{~/.gnus} (in this order).
865
866
867
868 @node Auto Save
869 @section Auto Save
870 @cindex dribble file
871 @cindex auto-save
872
873 Whenever you do something that changes the Gnus data (reading articles,
874 catching up, killing/subscribing groups), the change is added to a
875 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
876 Emacs way.  If your Emacs should crash before you have saved the
877 @file{.newsrc} files, all changes you have made can be recovered from
878 this file.
879
880 If Gnus detects this file at startup, it will ask the user whether to
881 read it.  The auto save file is deleted whenever the real startup file is
882 saved.
883
884 @vindex gnus-use-dribble-file
885 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
886 maintain a dribble buffer.  The default is @code{t}.
887
888 @vindex gnus-dribble-directory
889 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
890 this variable is @code{nil}, which it is by default, Gnus will dribble
891 into the directory where the @file{.newsrc} file is located.  (This is
892 normally the user's home directory.)  The dribble file will get the same
893 file permissions as the @code{.newsrc} file.
894
895
896 @node The Active File
897 @section The Active File
898 @cindex active file
899 @cindex ignored groups
900
901 When Gnus starts, or indeed whenever it tries to determine whether new
902 articles have arrived, it reads the active file.  This is a very large
903 file that lists all the active groups and articles on the server.
904
905 @vindex gnus-ignored-newsgroups
906 Before examining the active file, Gnus deletes all lines that match the
907 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
908 any groups with bogus names, but you can use this variable to make Gnus
909 ignore hierarchies you aren't ever interested in.  However, this is not
910 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
911 Groups} for an overview of other variables that can be used instead.
912
913 @c This variable is
914 @c @code{nil} by default, and will slow down active file handling somewhat
915 @c if you set it to anything else.
916
917 @vindex gnus-read-active-file
918 @c @head
919 The active file can be rather Huge, so if you have a slow network, you
920 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
921 reading the active file.  This variable is @code{t} by default.
922
923 Gnus will try to make do by getting information just on the groups that
924 you actually subscribe to.
925
926 Note that if you subscribe to lots and lots of groups, setting this
927 variable to @code{nil} will probably make Gnus slower, not faster.  At
928 present, having this variable @code{nil} will slow Gnus down
929 considerably, unless you read news over a 2400 baud modem.  
930
931 This variable can also have the value @code{some}.  Gnus will then
932 attempt to read active info only on the subscribed groups.  On some
933 servers this is quite fast (on sparkling, brand new INN servers that
934 support the @code{LIST ACTIVE group} command), on others this isn't fast
935 at all.  In any case, @code{some} should be faster than @code{nil}, and
936 is certainly faster than @code{t} over slow lines.
937
938 If this variable is @code{nil}, Gnus will ask for group info in total
939 lock-step, which isn't very fast.  If it is @code{some} and you use an
940 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
941 read all the replies in one swoop.  This will normally result in better
942 performance, but if the server does not support the aforementioned
943 @code{LIST ACTIVE group} command, this isn't very nice to the server.
944
945 In any case, if you use @code{some} or @code{nil}, you should definitely
946 kill all groups that you aren't interested in to speed things up.
947
948 Note that this variable also affects active file retrieval from
949 secondary select methods.
950
951
952 @node Startup Variables
953 @section Startup Variables
954
955 @table @code
956
957 @item gnus-load-hook
958 @vindex gnus-load-hook
959 A hook that is run while Gnus is being loaded.  Note that this hook will
960 normally be run just once in each Emacs session, no matter how many
961 times you start Gnus.
962
963 @item gnus-startup-hook
964 @vindex gnus-startup-hook
965 A hook that is run after starting up Gnus successfully.
966
967 @item gnus-started-hook
968 @vindex gnus-started-hook
969 A hook that is run as the very last thing after starting up Gnus
970 successfully.
971
972 @item gnus-check-bogus-newsgroups
973 @vindex gnus-check-bogus-newsgroups
974 If non-@code{nil}, Gnus will check for and delete all bogus groups at
975 startup.  A @dfn{bogus group} is a group that you have in your
976 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
977 bogus groups can take quite a while, so to save time and resources it's
978 best to leave this option off, and do the checking for bogus groups once
979 in a while from the group buffer instead (@pxref{Group Maintenance}).
980
981 @item gnus-inhibit-startup-message
982 @vindex gnus-inhibit-startup-message
983 If non-@code{nil}, the startup message won't be displayed.  That way,
984 your boss might not notice as easily that you are reading news instead
985 of doing your job.  Note that this variable is used before
986 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
987
988 @item gnus-no-groups-message
989 @vindex gnus-no-groups-message
990 Message displayed by Gnus when no groups are available.
991
992 @item gnus-play-startup-jingle
993 @vindex gnus-play-startup-jingle
994 If non-@code{nil}, play the Gnus jingle at startup.
995
996 @item gnus-startup-jingle
997 @vindex gnus-startup-jingle
998 Jingle to be played if the above variable is non-@code{nil}.  The
999 default is @samp{Tuxedomoon.Jingle4.au}.
1000
1001 @end table
1002
1003
1004 @node The Group Buffer
1005 @chapter The Group Buffer
1006 @cindex group buffer
1007
1008 The @dfn{group buffer} lists all (or parts) of the available groups.  It
1009 is the first buffer shown when Gnus starts, and will never be killed as
1010 long as Gnus is active.
1011
1012 @menu
1013 * Group Buffer Format::    Information listed and how you can change it.
1014 * Group Maneuvering::      Commands for moving in the group buffer.
1015 * Selecting a Group::      Actually reading news.
1016 * Group Data::             Changing the info for a group.
1017 * Subscription Commands::  Unsubscribing, killing, subscribing.
1018 * Group Levels::           Levels? What are those, then?
1019 * Group Score::            A mechanism for finding out what groups you like.
1020 * Marking Groups::         You can mark groups for later processing.
1021 * Foreign Groups::         Creating and editing groups.
1022 * Group Parameters::       Each group may have different parameters set.
1023 * Listing Groups::         Gnus can list various subsets of the groups.
1024 * Sorting Groups::         Re-arrange the group order.
1025 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
1026 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
1027 * Exiting Gnus::           Stop reading news and get some work done.
1028 * Group Topics::           A folding group mode divided into topics.
1029 * Misc Group Stuff::       Other stuff that you can to do.
1030 @end menu
1031
1032
1033 @node Group Buffer Format
1034 @section Group Buffer Format
1035
1036 @menu 
1037 * Group Line Specification::       Deciding how the group buffer is to look.
1038 * Group Modeline Specification::   The group buffer modeline.
1039 * Group Highlighting::             Having nice colors in the group buffer.
1040 @end menu
1041
1042
1043 @node Group Line Specification
1044 @subsection Group Line Specification
1045 @cindex group buffer format
1046
1047 The default format of the group buffer is nice and dull, but you can
1048 make it as exciting and ugly as you feel like.
1049
1050 Here's a couple of example group lines:
1051
1052 @example
1053      25: news.announce.newusers
1054  *    0: alt.fan.andrea-dworkin
1055 @end example
1056
1057 Quite simple, huh?
1058
1059 You can see that there are 25 unread articles in
1060 @samp{news.announce.newusers}.  There are no unread articles, but some
1061 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1062 asterisk at the beginning of the line?)
1063
1064 @vindex gnus-group-line-format
1065 You can change that format to whatever you want by fiddling with the
1066 @code{gnus-group-line-format} variable.  This variable works along the
1067 lines of a @code{format} specification, which is pretty much the same as
1068 a @code{printf} specifications, for those of you who use (feh!) C.
1069 @xref{Formatting Variables}. 
1070
1071 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1072
1073 There should always be a colon on the line; the cursor always moves to
1074 the colon after performing an operation.  Nothing else is required---not
1075 even the group name.  All displayed text is just window dressing, and is
1076 never examined by Gnus.  Gnus stores all real information it needs using
1077 text properties.
1078
1079 (Note that if you make a really strange, wonderful, spreadsheet-like
1080 layout, everybody will believe you are hard at work with the accounting
1081 instead of wasting time reading news.)
1082
1083 Here's a list of all available format characters:
1084
1085 @table @samp
1086
1087 @item M    
1088 An asterisk if the group only has marked articles.
1089
1090 @item S
1091 Whether the group is subscribed.
1092
1093 @item L    
1094 Level of subscribedness.
1095
1096 @item N
1097 Number of unread articles.
1098
1099 @item I
1100 Number of dormant articles.
1101
1102 @item T
1103 Number of ticked articles.
1104
1105 @item R
1106 Number of read articles.
1107
1108 @item t
1109 Estimated total number of articles.  (This is really @var{max-number}
1110 minus @var{min-number} plus 1.)
1111
1112 @item y
1113 Number of unread, unticked, non-dormant articles.
1114
1115 @item i
1116 Number of ticked and dormant articles.
1117
1118 @item g
1119 Full group name.
1120
1121 @item G
1122 Group name.
1123
1124 @item D
1125 Newsgroup description.
1126
1127 @item o
1128 @samp{m} if moderated.
1129
1130 @item O
1131 @samp{(m)} if moderated.
1132
1133 @item s
1134 Select method.
1135
1136 @item n
1137 Select from where.
1138
1139 @item z
1140 A string that looks like @samp{<%s:%n>} if a foreign select method is
1141 used.
1142
1143 @item P
1144 Indentation based on the level of the topic (@pxref{Group Topics}). 
1145
1146 @item c
1147 @vindex gnus-group-uncollapsed-levels
1148 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
1149 variable says how many levels to leave at the end of the group name.
1150 The default is 1---this will mean that group names like
1151 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1152
1153 @item m
1154 @vindex gnus-new-mail-mark
1155 @cindex %
1156 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1157 the group lately.
1158
1159 @item d
1160 A string that says when you last read the group (@pxref{Group
1161 Timestamp}). 
1162
1163 @item u
1164 User defined specifier.  The next character in the format string should
1165 be a letter.  @sc{gnus} will call the function
1166 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1167 following @samp{%u}.  The function will be passed a single dummy
1168 parameter as argument.  The function should return a string, which will
1169 be inserted into the buffer just like information from any other
1170 specifier.
1171 @end table
1172
1173 @cindex *
1174 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1175 if no info is available---for instance, if it is a non-activated foreign
1176 group, or a bogus native group.
1177
1178
1179 @node Group Modeline Specification
1180 @subsection Group Modeline Specification
1181 @cindex group modeline
1182
1183 @vindex gnus-group-mode-line-format
1184 The mode line can be changed by setting
1185 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}).  It
1186 doesn't understand that many format specifiers:
1187
1188 @table @samp
1189 @item S
1190 The native news server.
1191 @item M
1192 The native select method.
1193 @end table
1194
1195
1196 @node Group Highlighting
1197 @subsection Group Highlighting
1198 @cindex highlighting
1199 @cindex group highlighting
1200
1201 @vindex gnus-group-highlight
1202 Highlighting in the group buffer is controlled by the
1203 @code{gnus-group-highlight} variable.  This is an alist with elements
1204 that look like @var{(form . face)}.  If @var{form} evaluates to
1205 something non-@code{nil}, the @var{face} will be used on the line.
1206
1207 Here's an example value for this variable that might look nice if the
1208 background is dark:
1209
1210 @lisp
1211 (setq gnus-group-highlight
1212       `(((> unread 200) . 
1213          ,(custom-face-lookup "Red" nil nil t nil nil))
1214         ((and (< level 3) (zerop unread)) . 
1215          ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1216         ((< level 3) . 
1217          ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1218         ((zerop unread) . 
1219          ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1220         (t . 
1221          ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1222 @end lisp
1223
1224 Variables that are dynamically bound when the forms are evaluated
1225 include:
1226
1227 @table @code
1228 @item group
1229 The group name.
1230 @item unread
1231 The number of unread articles in the group.
1232 @item method
1233 The select method.
1234 @item mailp
1235 Whether the group is a mail group.
1236 @item level
1237 The level of the group.
1238 @item score
1239 The score of the group.
1240 @item ticked 
1241 The number of ticked articles in the group.
1242 @item total
1243 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1244 MIN-NUMBER.
1245 @item topic
1246 When using the topic minor mode, this variable is bound to the current
1247 topic being inserted.
1248 @end table
1249
1250 When the forms are @code{eval}ed, point is at the beginning of the line
1251 of the group in question, so you can use many of the normal Gnus
1252 functions for snarfing info on the group.
1253
1254 @vindex gnus-group-update-hook
1255 @findex gnus-group-highlight-line
1256 @code{gnus-group-update-hook} is called when a group line is changed.
1257 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1258 calls @code{gnus-group-highlight-line} by default.
1259
1260
1261 @node Group Maneuvering
1262 @section Group Maneuvering
1263 @cindex group movement
1264
1265 All movement commands understand the numeric prefix and will behave as
1266 expected, hopefully. 
1267
1268 @table @kbd
1269
1270 @item n
1271 @kindex n (Group)
1272 @findex gnus-group-next-unread-group
1273 Go to the next group that has unread articles
1274 (@code{gnus-group-next-unread-group}).
1275
1276 @item p
1277 @itemx DEL
1278 @kindex DEL (Group)
1279 @kindex p (Group)
1280 @findex gnus-group-prev-unread-group
1281 Go to the previous group that has unread articles
1282 (@code{gnus-group-prev-unread-group}).
1283
1284 @item N
1285 @kindex N (Group)
1286 @findex gnus-group-next-group
1287 Go to the next group (@code{gnus-group-next-group}).
1288
1289 @item P
1290 @kindex P (Group)
1291 @findex gnus-group-prev-group
1292 Go to the previous group (@code{gnus-group-prev-group}).
1293
1294 @item M-p
1295 @kindex M-p (Group)
1296 @findex gnus-group-next-unread-group-same-level
1297 Go to the next unread group on the same (or lower) level
1298 (@code{gnus-group-next-unread-group-same-level}). 
1299
1300 @item M-n
1301 @kindex M-n (Group)
1302 @findex gnus-group-prev-unread-group-same-level
1303 Go to the previous unread group on the same (or lower) level
1304 (@code{gnus-group-prev-unread-group-same-level}). 
1305 @end table
1306
1307 Three commands for jumping to groups:
1308
1309 @table @kbd
1310
1311 @item j
1312 @kindex j (Group)
1313 @findex gnus-group-jump-to-group
1314 Jump to a group (and make it visible if it isn't already)
1315 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1316 like living groups.
1317
1318 @item ,
1319 @kindex , (Group)
1320 @findex gnus-group-best-unread-group
1321 Jump to the unread group with the lowest level
1322 (@code{gnus-group-best-unread-group}). 
1323
1324 @item .
1325 @kindex . (Group)
1326 @findex gnus-group-first-unread-group
1327 Jump to the first group with unread articles
1328 (@code{gnus-group-first-unread-group}).  
1329 @end table
1330
1331 @vindex gnus-group-goto-unread
1332 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1333 commands will move to the next group, not the next unread group.  Even
1334 the commands that say they move to the next unread group.  The default
1335 is @code{t}.
1336
1337
1338 @node Selecting a Group
1339 @section Selecting a Group
1340 @cindex group selection
1341
1342 @table @kbd
1343
1344 @item SPACE
1345 @kindex SPACE (Group)
1346 @findex gnus-group-read-group
1347 Select the current group, switch to the summary buffer and display the
1348 first unread article (@code{gnus-group-read-group}).  If there are no
1349 unread articles in the group, or if you give a non-numerical prefix to
1350 this command, Gnus will offer to fetch all the old articles in this
1351 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1352 determines the number of articles Gnus will fetch.  If @var{N} is
1353 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1354 negative, Gnus fetches the @var{abs(N)} oldest articles.
1355
1356 @item RET
1357 @kindex RET (Group)
1358 @findex gnus-group-select-group
1359 Select the current group and switch to the summary buffer
1360 (@code{gnus-group-select-group}).  Takes the same arguments as
1361 @code{gnus-group-read-group}---the only difference is that this command
1362 does not display the first unread article automatically upon group
1363 entry. 
1364
1365 @item M-RET
1366 @kindex M-RET (Group)
1367 @findex gnus-group-quick-select-group
1368 This does the same as the command above, but tries to do it with the
1369 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1370 scoring/killing will be performed, there will be no highlights and no
1371 expunging.  This might be useful if you're in a real hurry and have to
1372 enter some humongous group.  If you give a 0 prefix to this command
1373 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1374 This might be useful if you want to toggle threading before entering the
1375 group.
1376
1377 @item M-SPACE
1378 @kindex M-SPACE (Group)
1379 @findex gnus-group-visible-select-group
1380 This is yet one more command that does the same as the @kbd{RET}
1381 command, but this one does it without expunging and hiding dormants
1382 (@code{gnus-group-visible-select-group}).
1383
1384 @item M-C-RET
1385 @kindex M-C-RET (Group)
1386 @findex gnus-group-select-group-ephemerally
1387 Finally, this command selects the current group ephemerally without
1388 doing any processing of its contents
1389 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1390 turned off.  Everything you do in the group after selecting it in this
1391 manner will have no permanent effects.
1392
1393 @end table
1394
1395 @vindex gnus-large-newsgroup
1396 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1397 to be a big group.  This is 200 by default.  If the group has more
1398 (unread and/or ticked) articles than this, Gnus will query the user
1399 before entering the group.  The user can then specify how many articles
1400 should be fetched from the server.  If the user specifies a negative
1401 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1402 is positive, the @code{n} articles that have arrived most recently will
1403 be fetched.
1404
1405 @vindex gnus-select-group-hook
1406 @vindex gnus-auto-select-first
1407 @code{gnus-auto-select-first} control whether any articles are selected
1408 automatically when entering a group with the @kbd{SPACE} command.
1409
1410 @table @code
1411
1412 @item nil
1413 Don't select any articles when entering the group.  Just display the
1414 full summary buffer.
1415
1416 @item t
1417 Select the first unread article when entering the group.  
1418
1419 @item best
1420 Select the most high-scored article in the group when entering the
1421 group. 
1422 @end table
1423         
1424 If you want to prevent automatic selection in some group (say, in a
1425 binary group with Huge articles) you can set this variable to @code{nil}
1426 in @code{gnus-select-group-hook}, which is called when a group is
1427 selected.
1428
1429
1430 @node Subscription Commands
1431 @section Subscription Commands
1432 @cindex subscription
1433
1434 @table @kbd
1435
1436 @item S t
1437 @itemx u
1438 @kindex S t (Group)
1439 @kindex u (Group)
1440 @findex gnus-group-unsubscribe-current-group
1441 Toggle subscription to the current group
1442 (@code{gnus-group-unsubscribe-current-group}).  
1443
1444 @item S s
1445 @itemx U
1446 @kindex S s (Group)
1447 @kindex U (Group)
1448 @findex gnus-group-unsubscribe-group
1449 Prompt for a group to subscribe, and then subscribe it.  If it was
1450 subscribed already, unsubscribe it instead
1451 (@code{gnus-group-unsubscribe-group}).
1452
1453 @item S k
1454 @itemx C-k
1455 @kindex S k (Group)
1456 @kindex C-k (Group)
1457 @findex gnus-group-kill-group
1458 Kill the current group (@code{gnus-group-kill-group}).
1459
1460 @item S y
1461 @itemx C-y
1462 @kindex S y (Group)
1463 @kindex C-y (Group)
1464 @findex gnus-group-yank-group
1465 Yank the last killed group (@code{gnus-group-yank-group}).
1466
1467 @item C-x C-t
1468 @kindex C-x C-t (Group)
1469 @findex gnus-group-transpose-groups
1470 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1471 really a subscription command, but you can use it instead of a
1472 kill-and-yank sequence sometimes.
1473
1474 @item S w
1475 @itemx C-w
1476 @kindex S w (Group)
1477 @kindex C-w (Group)
1478 @findex gnus-group-kill-region
1479 Kill all groups in the region (@code{gnus-group-kill-region}). 
1480
1481 @item S z
1482 @kindex S z (Group)
1483 @findex gnus-group-kill-all-zombies
1484 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1485
1486 @item S C-k
1487 @kindex S C-k (Group)
1488 @findex gnus-group-kill-level
1489 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1490 These groups can't be yanked back after killing, so this command should
1491 be used with some caution.  The only time where this command comes in
1492 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1493 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1494 kill off all unsubscribed groups that do not have message numbers in the
1495 @file{.newsrc} file.  
1496
1497 @end table
1498
1499 Also @pxref{Group Levels}.
1500
1501
1502 @node Group Data
1503 @section Group Data
1504
1505 @table @kbd
1506
1507 @item c
1508 @kindex c (Group)
1509 @findex gnus-group-catchup-current
1510 @vindex gnus-group-catchup-group-hook
1511 Mark all unticked articles in this group as read
1512 (@code{gnus-group-catchup-current}).
1513 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1514 the group buffer.
1515
1516 @item C
1517 @kindex C (Group)
1518 @findex gnus-group-catchup-current-all
1519 Mark all articles in this group, even the ticked ones, as read
1520 (@code{gnus-group-catchup-current-all}).   
1521
1522 @item M-c
1523 @kindex M-c (Group)
1524 @findex gnus-group-clear-data
1525 Clear the data from the current group---nix out marks and the list of
1526 read articles (@code{gnus-group-clear-data}).
1527
1528 @item M-x gnus-group-clear-data-on-native-groups
1529 @kindex M-x gnus-group-clear-data-on-native-groups
1530 @findex gnus-group-clear-data-on-native-groups
1531 If you have switched from one @sc{nntp} server to another, all your marks
1532 and read ranges have become worthless.  You can use this command to
1533 clear out all data that you have on your native groups.  Use with
1534 caution. 
1535
1536 @end table
1537
1538
1539 @node Group Levels
1540 @section Group Levels
1541 @cindex group level
1542 @cindex level
1543
1544 All groups have a level of @dfn{subscribedness}.  For instance, if a
1545 group is on level 2, it is more subscribed than a group on level 5.  You
1546 can ask Gnus to just list groups on a given level or lower
1547 (@pxref{Listing Groups}), or to just check for new articles in groups on
1548 a given level or lower (@pxref{Scanning New Messages}).
1549
1550 Remember:  The higher the level of the group, the less important it is. 
1551
1552 @table @kbd
1553
1554 @item S l
1555 @kindex S l (Group)
1556 @findex gnus-group-set-current-level
1557 Set the level of the current group.  If a numeric prefix is given, the
1558 next @var{n} groups will have their levels set.  The user will be
1559 prompted for a level.
1560 @end table
1561
1562 @vindex gnus-level-killed
1563 @vindex gnus-level-zombie
1564 @vindex gnus-level-unsubscribed
1565 @vindex gnus-level-subscribed
1566 Gnus considers groups on between levels 1 and
1567 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1568 @code{gnus-level-subscribed} (exclusive) and
1569 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1570 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1571 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1572 completely dead.  Gnus treats subscribed and unsubscribed groups exactly
1573 the same, but zombie and killed groups have no information on what
1574 articles you have read, etc, stored.  This distinction between dead and
1575 living groups isn't done because it is nice or clever, it is done purely
1576 for reasons of efficiency.
1577
1578 It is recommended that you keep all your mail groups (if any) on quite
1579 low levels (e.g. 1 or 2).
1580
1581 If you want to play with the level variables, you should show some care.
1582 Set them once, and don't touch them ever again.  Better yet, don't touch
1583 them at all unless you know exactly what you're doing.
1584
1585 @vindex gnus-level-default-unsubscribed
1586 @vindex gnus-level-default-subscribed
1587 Two closely related variables are @code{gnus-level-default-subscribed}
1588 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1589 which are the levels that new groups will be put on if they are
1590 (un)subscribed.  These two variables should, of course, be inside the
1591 relevant legal ranges.
1592
1593 @vindex gnus-keep-same-level
1594 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1595 will only move to groups that are of the same level (or lower).  In
1596 particular, going from the last article in one group to the next group
1597 will go to the next group of the same level (or lower).  This might be
1598 handy if you want to read the most important groups before you read the
1599 rest.
1600
1601 @vindex gnus-group-default-list-level
1602 All groups with a level less than or equal to
1603 @code{gnus-group-default-list-level} will be listed in the group buffer
1604 by default.
1605
1606 @vindex gnus-group-list-inactive-groups
1607 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1608 groups will be listed along with the unread groups.  This variable is
1609 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1610 listed. 
1611
1612 @vindex gnus-group-use-permanent-levels
1613 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1614 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1615 use this level as the ``work'' level.
1616
1617 @vindex gnus-activate-level
1618 Gnus will normally just activate groups that are on level
1619 @code{gnus-activate-level} or less.  If you don't want to activate
1620 unsubscribed groups, for instance, you might set this variable to
1621 5.  The default is 6.
1622
1623
1624 @node Group Score
1625 @section Group Score
1626 @cindex group score
1627
1628 You would normally keep important groups on high levels, but that scheme
1629 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1630 group buffer according to how often you read groups, perhaps?  Within
1631 reason?  
1632
1633 This is what @dfn{group score} is for.  You can assign a score to each
1634 group.  You can then sort the group buffer based on this score.
1635 Alternatively, you can sort on score and then level.  (Taken together,
1636 the level and the score is called the @dfn{rank} of the group.  A group
1637 that is on level 4 and has a score of 1 has a higher rank than a group
1638 on level 5 that has a score of 300.  (The level is the most significant
1639 part and the score is the least significant part.))
1640
1641 @findex gnus-summary-bubble-group
1642 If you want groups you read often to get higher scores than groups you
1643 read seldom you can add the @code{gnus-summary-bubble-group} function to
1644 the @code{gnus-summary-exit-hook} hook.  This will result (after
1645 sorting) in a bubbling sort of action.  If you want to see that in
1646 action after each summary exit, you can add
1647 @code{gnus-group-sort-groups-by-rank} or
1648 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1649 slow things down somewhat.
1650
1651
1652 @node Marking Groups
1653 @section Marking Groups
1654 @cindex marking groups
1655
1656 If you want to perform some command on several groups, and they appear
1657 subsequently in the group buffer, you would normally just give a
1658 numerical prefix to the command.  Most group commands will then do your
1659 bidding on those groups.
1660
1661 However, if the groups are not in sequential order, you can still
1662 perform a command on several groups.  You simply mark the groups first
1663 with the process mark and then execute the command.
1664
1665 @table @kbd
1666
1667 @item #
1668 @kindex # (Group)
1669 @itemx M m
1670 @kindex M m (Group)
1671 @findex gnus-group-mark-group
1672 Set the mark on the current group (@code{gnus-group-mark-group}). 
1673
1674 @item M-#
1675 @kindex M-# (Group)
1676 @itemx M u
1677 @kindex M u (Group)
1678 @findex gnus-group-unmark-group
1679 Remove the mark from the current group
1680 (@code{gnus-group-unmark-group}). 
1681
1682 @item M U
1683 @kindex M U (Group)
1684 @findex gnus-group-unmark-all-groups
1685 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}). 
1686
1687 @item M w
1688 @kindex M w (Group)
1689 @findex gnus-group-mark-region
1690 Mark all groups between point and mark (@code{gnus-group-mark-region}). 
1691
1692 @item M b
1693 @kindex M b (Group)
1694 @findex gnus-group-mark-buffer
1695 Mark all groups in the buffer (@code{gnus-group-mark-buffer}). 
1696
1697 @item M r
1698 @kindex M r (Group)
1699 @findex gnus-group-mark-regexp
1700 Mark all groups that match some regular expression
1701 (@code{gnus-group-mark-regexp}).  
1702 @end table
1703
1704 Also @pxref{Process/Prefix}.
1705
1706 @findex gnus-group-universal-argument
1707 If you want to execute some command on all groups that have been marked
1708 with the process mark, you can use the @kbd{M-&}
1709 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1710 the command to be executed.
1711
1712
1713 @node Foreign Groups
1714 @section Foreign Groups
1715 @cindex foreign groups
1716
1717 Below are some group mode commands for making and editing general foreign
1718 groups, as well as commands to ease the creation of a few
1719 special-purpose groups.  All these commands insert the newly created
1720 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1721 consulted.
1722
1723 @table @kbd
1724
1725 @item G m
1726 @kindex G m (Group)
1727 @findex gnus-group-make-group
1728 @cindex making groups
1729 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1730 for a name, a method and possibly an @dfn{address}.  For an easier way
1731 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1732
1733 @item G r
1734 @kindex G r (Group)
1735 @findex gnus-group-rename-group
1736 @cindex renaming groups
1737 Rename the current group to something else
1738 (@code{gnus-group-rename-group}).  This is legal only on some
1739 groups---mail groups mostly.  This command might very well be quite slow
1740 on some backends.
1741
1742 @item G c
1743 @kindex G c (Group)
1744 @cindex customizing
1745 @findex gnus-group-customize
1746 Customize the group parameters (@code{gnus-group-customize}).
1747
1748 @item G e
1749 @kindex G e (Group)
1750 @findex gnus-group-edit-group-method
1751 @cindex renaming groups
1752 Enter a buffer where you can edit the select method of the current
1753 group (@code{gnus-group-edit-group-method}).
1754
1755 @item G p
1756 @kindex G p (Group)
1757 @findex gnus-group-edit-group-parameters
1758 Enter a buffer where you can edit the group parameters
1759 (@code{gnus-group-edit-group-parameters}). 
1760
1761 @item G E
1762 @kindex G E (Group)
1763 @findex gnus-group-edit-group
1764 Enter a buffer where you can edit the group info
1765 (@code{gnus-group-edit-group}).
1766
1767 @item G d
1768 @kindex G d (Group)
1769 @findex gnus-group-make-directory-group
1770 @cindex nndir
1771 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1772 for a directory name (@code{gnus-group-make-directory-group}).
1773
1774 @item G h 
1775 @kindex G h (Group)
1776 @cindex help group
1777 @findex gnus-group-make-help-group
1778 Make the Gnus help group (@code{gnus-group-make-help-group}).
1779
1780 @item G a
1781 @kindex G a (Group)
1782 @cindex (ding) archive
1783 @cindex archive group
1784 @findex gnus-group-make-archive-group
1785 @vindex gnus-group-archive-directory
1786 @vindex gnus-group-recent-archive-directory
1787 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1788 default a group pointing to the most recent articles will be created
1789 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1790 group will be created from @code{gnus-group-archive-directory}.
1791
1792 @item G k
1793 @kindex G k (Group)
1794 @findex gnus-group-make-kiboze-group
1795 @cindex nnkiboze
1796 Make a kiboze group.  You will be prompted for a name, for a regexp to
1797 match groups to be ``included'' in the kiboze group, and a series of
1798 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1799 @xref{Kibozed Groups}.
1800
1801 @item G D
1802 @kindex G D (Group)
1803 @findex gnus-group-enter-directory
1804 @cindex nneething
1805 Read an arbitrary directory as if with were a newsgroup with the
1806 @code{nneething} backend (@code{gnus-group-enter-directory}).
1807 @xref{Anything Groups}. 
1808
1809 @item G f
1810 @kindex G f (Group)
1811 @findex gnus-group-make-doc-group
1812 @cindex ClariNet Briefs
1813 @cindex nndoc
1814 Make a group based on some file or other
1815 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1816 command, you will be prompted for a file name and a file type.
1817 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1818 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1819 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1820 this command without a prefix, Gnus will guess at the file type.
1821 @xref{Document Groups}.
1822
1823 @item G w
1824 @kindex G w (Group)
1825 @findex gnus-group-make-web-group
1826 @cindex DejaNews
1827 @cindex Alta Vista
1828 @cindex InReference
1829 @cindex nnweb
1830 Make an ephemeral group based on a web search
1831 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1832 command, make a solid group instead.  You will be prompted for the
1833 search engine type and the search string.  Legal search engine types
1834 include @code{dejanews}, @code{altavista} and @code{reference}.
1835 @xref{Web Searches}.
1836
1837 @item G DEL
1838 @kindex G DEL (Group)
1839 @findex gnus-group-delete-group
1840 This function will delete the current group
1841 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1842 actually delete all the articles in the group, and forcibly remove the
1843 group itself from the face of the Earth.  Use a prefix only if you are
1844 absolutely sure of what you are doing.
1845
1846 @item G V
1847 @kindex G V (Group)
1848 @findex gnus-group-make-empty-virtual
1849 Make a new, fresh, empty @code{nnvirtual} group
1850 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1851
1852 @item G v
1853 @kindex G v (Group)
1854 @findex gnus-group-add-to-virtual
1855 Add the current group to an @code{nnvirtual} group
1856 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1857 @end table
1858
1859 @xref{Select Methods} for more information on the various select
1860 methods. 
1861
1862 @vindex gnus-activate-foreign-newsgroups
1863 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1864 Gnus will check all foreign groups with this level or lower at startup.
1865 This might take quite a while, especially if you subscribe to lots of
1866 groups from different @sc{nntp} servers.
1867
1868
1869 @node Group Parameters
1870 @section Group Parameters
1871 @cindex group parameters
1872
1873 The group parameters store information local to a particular group:
1874
1875 @table @code
1876 @item to-address
1877 @cindex to-address
1878 If the group parameter list contains an element that looks like
1879 @code{(to-address .  "some@@where.com")}, that address will be used by
1880 the backend when doing followups and posts.  This is primarily useful in
1881 mail groups that represent closed mailing lists---mailing lists where
1882 it's expected that everybody that writes to the mailing list is
1883 subscribed to it.  Since using this parameter ensures that the mail only
1884 goes to the mailing list itself, it means that members won't receive two
1885 copies of your followups.
1886
1887 Using @code{to-address} will actually work whether the group is foreign
1888 or not.  Let's say there's a group on the server that is called
1889 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1890 the articles from a mail-to-news gateway.  Posting directly to this
1891 group is therefore impossible---you have to send mail to the mailing
1892 list address instead. 
1893
1894 @item to-list
1895 @cindex to-list
1896 If the group parameter list has an element that looks like
1897 @code{(to-list . "some@@where.com")}, that address will be used when
1898 doing a @kbd{a} in any group.  It is totally ignored when doing a
1899 followup---except that if it is present in a news group, you'll get mail
1900 group semantics when doing @kbd{f}.
1901
1902 If you do an @kbd{a} command in a mail group and you don't have a
1903 @code{to-list} group parameter, one will be added automatically upon
1904 sending the message.
1905
1906 @item broken-reply-to
1907 @cindex broken-reply-to
1908 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1909 headers in this group are to be ignored.  This can be useful if you're
1910 reading a mailing list group where the listserv has inserted
1911 @code{Reply-To} headers that point back to the listserv itself.  This is
1912 broken behavior.  So there!
1913
1914 @item to-group
1915 @cindex to-group
1916 Elements like @code{(to-group . "some.group.name")} means that all
1917 posts in that group will be sent to @code{some.group.name}.  
1918
1919 @item newsgroup
1920 @cindex newsgroup
1921 If this symbol is present in the group parameter list, Gnus will treat
1922 all responses as if they were responses to news articles.  This can be
1923 useful if you have a mail group that's really a mirror of a news group. 
1924
1925 @item gcc-self
1926 @cindex gcc-self
1927 If this symbol is present in the group parameter list and set to
1928 @code{t}, new composed messages will be @code{Gcc}'d to the current
1929 group. If it is present and set to @code{none}, no @code{Gcc:} header
1930 will be generated, if it is present and a string, this string will be
1931 inserted literally as a @code{gcc} header (this symbol takes precedence over
1932 any default @code{Gcc} rules as described later).
1933
1934 @item auto-expire
1935 @cindex auto-expire
1936 If the group parameter has an element that looks like @code{(auto-expire
1937 . t)}, , all articles that are read will be marked as expirable.  For an
1938 alternative approach, @pxref{Expiring Mail}.
1939
1940 @item total-expire
1941 @cindex total-expire
1942 If the group parameter has an element that looks like
1943 @code{(total-expire . t)}, all read articles will be put through the
1944 expiry process, even if they are not marked as expirable.  Use with
1945 caution.
1946
1947 @item expiry-wait
1948 @cindex expiry-wait
1949 @vindex nnmail-expiry-wait-function
1950 If the group parameter has an element that looks like @code{(expiry-wait
1951 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1952 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1953 The value can either be a number of days (not necessarily an integer) or
1954 the symbols @code{never} or @code{immediate}.
1955
1956 @item score-file
1957 @cindex score file group parameter
1958 Elements that look like @code{(score-file . "file")} will make
1959 @file{file} into the current score file for the group in question.  This
1960 means that all score commands you issue will end up in that file. 
1961
1962 @item adapt-file
1963 @cindex adapt file group parameter
1964 Elements that look like @code{(adapt-file . "file")} will make
1965 @file{file} into the current adaptive file for the group in question.
1966 All adaptive score entries will be put into this file.
1967
1968 @item admin-address
1969 When unsubscribing to a mailing list you should never send the
1970 unsubscription notice to the mailing list itself.  Instead, you'd send
1971 messages to the administrative address.  This parameter allows you to
1972 put the admin address somewhere convenient.
1973
1974 @item display
1975 Elements that look like @code{(display . MODE)} says which articles to
1976 display on entering the group.  Legal values are:
1977
1978 @table @code
1979 @item all
1980 Display all articles, both read and unread.
1981
1982 @item default
1983 Display the default visible articles, which normally includes unread and
1984 ticked articles.
1985 @end table
1986
1987 @item comment
1988 Elements that look like @code{(comment . "This is a comment")}
1989 are arbitrary comments on the group.  They are currently ignored by
1990 Gnus, but provide a place for you to store information on particular
1991 groups. 
1992
1993 @item @var{(variable form)}
1994 You can use the group parameters to set variables local to the group you
1995 are entering.  If you want to turn threading off in @samp{news.answers},
1996 you could put @code{(gnus-show-threads nil)} in the group parameters of
1997 that group.  @code{gnus-show-threads} will be made into a local variable
1998 in the summary buffer you enter, and the form @code{nil} will be
1999 @code{eval}ed there.
2000
2001 This can also be used as a group-specific hook function, if you'd like.
2002 If you want to hear a beep when you enter a group, you could put
2003 something like @code{(dummy-variable (ding))} in the parameters of that
2004 group.  @code{dummy-variable} will be set to the result of the
2005 @code{(ding)} form, but who cares?
2006
2007 @end table
2008
2009 Use the @kbd{G p} command to edit group parameters of a group.
2010
2011 Also @pxref{Topic Parameters}.
2012
2013 Here's an example group parameter list:
2014
2015 @example
2016 ((to-address . "ding@@ifi.uio.no")
2017  (auto-expiry . t))
2018 @end example
2019
2020
2021 @node Listing Groups
2022 @section Listing Groups
2023 @cindex group listing
2024
2025 These commands all list various slices of the groups that are available.
2026
2027 @table @kbd
2028
2029 @item l
2030 @itemx A s
2031 @kindex A s (Group)
2032 @kindex l (Group)
2033 @findex gnus-group-list-groups
2034 List all groups that have unread articles
2035 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
2036 command will list only groups of level ARG and lower.  By default, it
2037 only lists groups of level five (i. e.,
2038 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2039 groups).
2040
2041 @item L
2042 @itemx A u
2043 @kindex A u (Group)
2044 @kindex L (Group)
2045 @findex gnus-group-list-all-groups
2046 List all groups, whether they have unread articles or not
2047 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
2048 this command will list only groups of level ARG and lower.  By default,
2049 it lists groups of level seven or lower (i.e., just subscribed and
2050 unsubscribed groups).
2051
2052 @item A l
2053 @kindex A l (Group)
2054 @findex gnus-group-list-level
2055 List all unread groups on a specific level
2056 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
2057 with no unread articles.
2058
2059 @item A k
2060 @kindex A k (Group)
2061 @findex gnus-group-list-killed
2062 List all killed groups (@code{gnus-group-list-killed}).  If given a
2063 prefix argument, really list all groups that are available, but aren't
2064 currently (un)subscribed.  This could entail reading the active file
2065 from the server.
2066
2067 @item A z
2068 @kindex A z (Group)
2069 @findex gnus-group-list-zombies
2070 List all zombie groups (@code{gnus-group-list-zombies}).
2071
2072 @item A m
2073 @kindex A m (Group)
2074 @findex gnus-group-list-matching
2075 List all unread, subscribed groups with names that match a regexp
2076 (@code{gnus-group-list-matching}). 
2077
2078 @item A M
2079 @kindex A M (Group)
2080 @findex gnus-group-list-all-matching
2081 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2082
2083 @item A A
2084 @kindex A A (Group)
2085 @findex gnus-group-list-active
2086 List absolutely all groups that are in the active file(s) of the
2087 server(s) you are connected to (@code{gnus-group-list-active}).  This
2088 might very well take quite a while.  It might actually be a better idea
2089 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2090 thing to match on.  Also note that this command may list group that
2091 don't exist (yet)---these will be listed as if they are killed groups.
2092 Take the output with some grains of salt.
2093
2094 @item A a
2095 @kindex A a (Group)
2096 @findex gnus-group-apropos
2097 List all groups that have names that match a regexp
2098 (@code{gnus-group-apropos}).
2099
2100 @item A d
2101 @kindex A d (Group)
2102 @findex gnus-group-description-apropos
2103 List all groups that have names or descriptions that match a regexp
2104 (@code{gnus-group-description-apropos}).
2105
2106 @end table
2107
2108 @vindex gnus-permanently-visible-groups
2109 @cindex visible group parameter
2110 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2111 always be shown, whether they have unread articles or not.  You can also
2112 add the @code{visible} element to the group parameters in question to
2113 get the same effect.
2114
2115 @vindex gnus-list-groups-with-ticked-articles
2116 Groups that have just ticked articles in it are normally listed in the
2117 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
2118 @code{nil}, these groups will be treated just like totally empty
2119 groups.  It is @code{t} by default.
2120
2121
2122 @node Sorting Groups
2123 @section Sorting Groups
2124 @cindex sorting groups
2125
2126 @kindex C-c C-s (Group)
2127 @findex gnus-group-sort-groups
2128 @vindex gnus-group-sort-function
2129 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2130 group buffer according to the function(s) given by the
2131 @code{gnus-group-sort-function} variable.  Available sorting functions
2132 include: 
2133
2134 @table @code
2135
2136 @item gnus-group-sort-by-alphabet
2137 @findex gnus-group-sort-by-alphabet
2138 Sort the group names alphabetically.  This is the default.
2139
2140 @item gnus-group-sort-by-real-name
2141 @findex gnus-group-sort-by-real-name
2142 Sort the group alphabetically on the real (unprefixed) group names.
2143
2144 @item gnus-group-sort-by-level
2145 @findex gnus-group-sort-by-level
2146 Sort by group level.
2147
2148 @item gnus-group-sort-by-score
2149 @findex gnus-group-sort-by-score
2150 Sort by group score.
2151
2152 @item gnus-group-sort-by-rank
2153 @findex gnus-group-sort-by-rank
2154 Sort by group score and then the group level.  The level and the score
2155 are, when taken together, the group's @dfn{rank}. 
2156
2157 @item gnus-group-sort-by-unread
2158 @findex gnus-group-sort-by-unread
2159 Sort by number of unread articles.
2160
2161 @item gnus-group-sort-by-method
2162 @findex gnus-group-sort-by-method
2163 Sort alphabetically on the select method.
2164
2165
2166 @end table
2167
2168 @code{gnus-group-sort-function} can also be a list of sorting
2169 functions.  In that case, the most significant sort key function must be
2170 the last one.
2171
2172
2173 There are also a number of commands for sorting directly according to
2174 some sorting criteria:
2175
2176 @table @kbd
2177 @item G S a
2178 @kindex G S a (Group)
2179 @findex gnus-group-sort-groups-by-alphabet
2180 Sort the group buffer alphabetically by group name
2181 (@code{gnus-group-sort-groups-by-alphabet}). 
2182
2183 @item G S u
2184 @kindex G S u (Group)
2185 @findex gnus-group-sort-groups-by-unread
2186 Sort the group buffer by the number of unread articles
2187 (@code{gnus-group-sort-groups-by-unread}).
2188
2189 @item G S l
2190 @kindex G S l (Group)
2191 @findex gnus-group-sort-groups-by-level
2192 Sort the group buffer by group level
2193 (@code{gnus-group-sort-groups-by-level}). 
2194
2195 @item G S v
2196 @kindex G S v (Group)
2197 @findex gnus-group-sort-groups-by-score
2198 Sort the group buffer by group score
2199 (@code{gnus-group-sort-groups-by-score}). 
2200
2201 @item G S r
2202 @kindex G S r (Group)
2203 @findex gnus-group-sort-groups-by-rank
2204 Sort the group buffer by group rank
2205 (@code{gnus-group-sort-groups-by-rank}). 
2206
2207 @item G S m
2208 @kindex G S m (Group)
2209 @findex gnus-group-sort-groups-by-method
2210 Sort the group buffer alphabetically by backend name
2211 (@code{gnus-group-sort-groups-by-method}). 
2212
2213 @end table
2214
2215 When given a prefix, all these commands will sort in reverse order. 
2216
2217 You can also sort a subset of the groups:
2218
2219 @table @kbd
2220 @item G P a
2221 @kindex G P a (Group)
2222 @findex gnus-group-sort-selected-groups-by-alphabet
2223 Sort the process/prefixed groups in the group buffer alphabetically by
2224 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2225
2226 @item G P u
2227 @kindex G P u (Group)
2228 @findex gnus-group-sort-selected-groups-by-unread
2229 Sort the process/prefixed groups in the group buffer by the number of
2230 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2231
2232 @item G P l
2233 @kindex G P l (Group)
2234 @findex gnus-group-sort-selected-groups-by-level
2235 Sort the process/prefixed groups in the group buffer by group level
2236 (@code{gnus-group-sort-selected-groups-by-level}).
2237
2238 @item G P v
2239 @kindex G P v (Group)
2240 @findex gnus-group-sort-selected-groups-by-score
2241 Sort the process/prefixed groups in the group buffer by group score
2242 (@code{gnus-group-sort-selected-groups-by-score}).
2243
2244 @item G P r
2245 @kindex G P r (Group)
2246 @findex gnus-group-sort-selected-groups-by-rank
2247 Sort the process/prefixed groups in the group buffer by group rank
2248 (@code{gnus-group-sort-selected-groups-by-rank}).
2249
2250 @item G P m
2251 @kindex G P m (Group)
2252 @findex gnus-group-sort-selected-groups-by-method
2253 Sort the process/prefixed groups in the group buffer alphabetically by
2254 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2255
2256 @end table
2257
2258
2259
2260 @node Group Maintenance
2261 @section Group Maintenance
2262 @cindex bogus groups
2263
2264 @table @kbd
2265 @item b
2266 @kindex b (Group)
2267 @findex gnus-group-check-bogus-groups
2268 Find bogus groups and delete them
2269 (@code{gnus-group-check-bogus-groups}).
2270
2271 @item F
2272 @kindex F (Group)
2273 @findex gnus-find-new-newsgroups
2274 Find new groups and process them (@code{gnus-find-new-newsgroups}).  If
2275 given a prefix, use the @code{ask-server} method to query the server for
2276 new groups.
2277
2278 @item C-c C-x
2279 @kindex C-c C-x (Group)
2280 @findex gnus-group-expire-articles
2281 Run all expirable articles in the current group through the expiry
2282 process (if any) (@code{gnus-group-expire-articles}).
2283
2284 @item C-c M-C-x
2285 @kindex C-c M-C-x (Group)
2286 @findex gnus-group-expire-all-groups
2287 Run all articles in all groups through the expiry process
2288 (@code{gnus-group-expire-all-groups}).
2289
2290 @end table
2291
2292
2293 @node Browse Foreign Server
2294 @section Browse Foreign Server
2295 @cindex foreign servers
2296 @cindex browsing servers
2297
2298 @table @kbd
2299 @item B
2300 @kindex B (Group)
2301 @findex gnus-group-browse-foreign-server
2302 You will be queried for a select method and a server name.  Gnus will
2303 then attempt to contact this server and let you browse the groups there
2304 (@code{gnus-group-browse-foreign-server}).
2305 @end table
2306
2307 @findex gnus-browse-mode
2308 A new buffer with a list of available groups will appear.  This buffer
2309 will be use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2310 a lot) like a normal group buffer.
2311
2312 Here's a list of keystrokes available in the browse mode:
2313
2314 @table @kbd
2315 @item n
2316 @kindex n (Browse)
2317 @findex gnus-group-next-group
2318 Go to the next group (@code{gnus-group-next-group}).
2319
2320 @item p
2321 @kindex p (Browse)
2322 @findex gnus-group-prev-group
2323 Go to the previous group (@code{gnus-group-prev-group}).
2324
2325 @item SPACE
2326 @kindex SPACE (Browse)
2327 @findex gnus-browse-read-group
2328 Enter the current group and display the first article
2329 (@code{gnus-browse-read-group}). 
2330
2331 @item RET
2332 @kindex RET (Browse)
2333 @findex gnus-browse-select-group
2334 Enter the current group (@code{gnus-browse-select-group}). 
2335
2336 @item u
2337 @kindex u (Browse)
2338 @findex gnus-browse-unsubscribe-current-group
2339 Unsubscribe to the current group, or, as will be the case here,
2340 subscribe to it (@code{gnus-browse-unsubscribe-current-group}). 
2341
2342 @item l
2343 @itemx q
2344 @kindex q (Browse)
2345 @kindex l (Browse)
2346 @findex gnus-browse-exit
2347 Exit browse mode (@code{gnus-browse-exit}).
2348
2349 @item ?
2350 @kindex ? (Browse)
2351 @findex gnus-browse-describe-briefly
2352 Describe browse mode briefly (well, there's not much to describe, is
2353 there) (@code{gnus-browse-describe-briefly}).
2354 @end table
2355
2356
2357 @node Exiting Gnus
2358 @section Exiting Gnus
2359 @cindex exiting Gnus
2360
2361 Yes, Gnus is ex(c)iting.
2362
2363 @table @kbd
2364 @item z
2365 @kindex z (Group)
2366 @findex gnus-group-suspend
2367 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2368 but it kills all buffers except the Group buffer.  I'm not sure why this
2369 is a gain, but then who am I to judge?
2370
2371 @item q
2372 @kindex q (Group)
2373 @findex gnus-group-exit
2374 Quit Gnus (@code{gnus-group-exit}).
2375
2376 @item Q
2377 @kindex Q (Group)
2378 @findex gnus-group-quit
2379 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2380 The dribble file will be saved, though (@pxref{Auto Save}).
2381 @end table
2382
2383 @vindex gnus-exit-gnus-hook
2384 @vindex gnus-suspend-gnus-hook
2385 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2386 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2387 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2388 exiting Gnus.
2389
2390 @findex gnus-unload
2391 @cindex unloading
2392 If you wish to completely unload Gnus and all its adherents, you can use
2393 the @code{gnus-unload} command.  This command is also very handy when
2394 trying to customize meta-variables.
2395
2396 Note:
2397
2398 @quotation
2399 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2400 numbly heavy and herself fall into a hazy trance as the boy sitting
2401 behind her drew repeated lines with his pencil across the back of her
2402 plastic chair.
2403 @end quotation
2404
2405
2406 @node Group Topics
2407 @section Group Topics
2408 @cindex topics
2409
2410 If you read lots and lots of groups, it might be convenient to group
2411 them hierarchically according to topics.  You put your Emacs groups over
2412 here, your sex groups over there, and the rest (what, two groups or so?)
2413 you put in some misc section that you never bother with anyway.  You can
2414 even group the Emacs sex groups as a sub-topic to either the Emacs
2415 groups or the sex groups---or both!  Go wild!
2416
2417 Here's an example:
2418
2419 @example
2420 Gnus
2421   Emacs -- I wuw it!
2422      3: comp.emacs
2423      2: alt.religion.emacs
2424     Naughty Emacs
2425      452: alt.sex.emacs
2426        0: comp.talk.emacs.recovery
2427   Misc
2428      8: comp.binaries.fractals
2429     13: comp.sources.unix
2430 @end example
2431
2432 @findex gnus-topic-mode
2433 @kindex t (Group)
2434 To get this @emph{fab} functionality you simply turn on (ooh!) the
2435 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2436 is a toggling command.)
2437
2438 Go ahead, just try it.  I'll still be here when you get back.  La de
2439 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2440 press @kbd{l}.  There.  All your groups are now listed under
2441 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2442 bothered?
2443
2444 If you want this permanently enabled, you should add that minor mode to
2445 the hook for the group mode:
2446
2447 @lisp
2448 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2449 @end lisp
2450
2451 @menu 
2452 * Topic Variables::    How to customize the topics the Lisp Way.
2453 * Topic Commands::     Interactive E-Z commands.
2454 * Topic Sorting::      Sorting each topic individually.
2455 * Topic Topology::     A map of the world.
2456 * Topic Parameters::   Parameters that apply to all groups in a topic.
2457 @end menu
2458
2459
2460 @node Topic Variables
2461 @subsection Topic Variables
2462 @cindex topic variables
2463
2464 Now, if you select a topic, if will fold/unfold that topic, which is
2465 really neat, I think.
2466
2467 @vindex gnus-topic-line-format
2468 The topic lines themselves are created according to the
2469 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2470 Legal elements are:
2471
2472 @table @samp
2473 @item i
2474 Indentation.
2475 @item n
2476 Topic name.
2477 @item v
2478 Visibility.
2479 @item l
2480 Level.
2481 @item g
2482 Number of groups in the topic.
2483 @item a
2484 Number of unread articles in the topic.
2485 @item A 
2486 Number of unread articles in the topic and all its subtopics. 
2487 @end table
2488
2489 @vindex gnus-topic-indent-level
2490 Each sub-topic (and the groups in the sub-topics) will be indented with
2491 @code{gnus-topic-indent-level} times the topic level number of spaces.
2492 The default is 2.
2493
2494 @vindex gnus-topic-mode-hook
2495 @code{gnus-topic-mode-hook} is called in topic minor mode buffers. 
2496
2497 @vindex gnus-topic-display-empty-topics
2498 The @code{gnus-topic-display-empty-topics} says whether to display even
2499 topics that have no unread articles in them.  The default is @code{t}.
2500
2501
2502 @node Topic Commands
2503 @subsection Topic Commands
2504 @cindex topic commands
2505
2506 When the topic minor mode is turned on, a new @kbd{T} submap will be
2507 available.  In addition, a few of the standard keys change their
2508 definitions slightly.
2509
2510 @table @kbd
2511
2512 @item T n
2513 @kindex T n (Topic)
2514 @findex gnus-topic-create-topic
2515 Prompt for a new topic name and create it 
2516 (@code{gnus-topic-create-topic}). 
2517
2518 @item T m
2519 @kindex T m (Topic)
2520 @findex gnus-topic-move-group
2521 Move the current group to some other topic
2522 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2523 convention (@pxref{Process/Prefix}).
2524
2525 @item T c
2526 @kindex T c (Topic)
2527 @findex gnus-topic-copy-group
2528 Copy the current group to some other topic
2529 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2530 convention (@pxref{Process/Prefix}).
2531
2532 @item T D
2533 @kindex T D (Topic)
2534 @findex gnus-topic-remove-group
2535 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2536 This command uses the process/prefix convention
2537 (@pxref{Process/Prefix}).
2538
2539 @item T M
2540 @kindex T M (Topic)
2541 @findex gnus-topic-move-matching
2542 Move all groups that match some regular expression to a topic
2543 (@code{gnus-topic-move-matching}). 
2544
2545 @item T C
2546 @kindex T C (Topic)
2547 @findex gnus-topic-copy-matching
2548 Copy all groups that match some regular expression to a topic
2549 (@code{gnus-topic-copy-matching}). 
2550
2551 @item T #
2552 @kindex T # (Topic)
2553 @findex gnus-topic-mark-topic
2554 Mark all groups in the current topic with the process mark
2555 (@code{gnus-topic-mark-topic}). 
2556
2557 @item T M-#
2558 @kindex T M-# (Topic)
2559 @findex gnus-topic-unmark-topic
2560 Remove the process mark from all groups in the current topic
2561 (@code{gnus-topic-unmark-topic}). 
2562
2563 @item RET
2564 @kindex RET (Topic)
2565 @findex gnus-topic-select-group
2566 @itemx SPACE
2567 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2568 When you perform this command on a group, you'll enter the group, as
2569 usual.  When done on a topic line, the topic will be folded (if it was
2570 visible) or unfolded (if it was folded already).  So it's basically a
2571 toggling command on topics.  In addition, if you give a numerical
2572 prefix, group on that level (and lower) will be displayed.
2573
2574 @item T TAB
2575 @kindex T TAB (Topic)
2576 @findex gnus-topic-indent
2577 ``Indent'' the current topic so that it becomes a sub-topic of the
2578 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2579 ``un-indent'' the topic instead.
2580
2581 @item C-k
2582 @kindex C-k (Topic)
2583 @findex gnus-topic-kill-group
2584 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2585 topic will be removed along with the topic.
2586
2587 @item C-y
2588 @kindex C-y (Topic)
2589 @findex gnus-topic-yank-group
2590 Yank the previously killed group or topic
2591 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2592 before all groups. 
2593
2594 @item T r
2595 @kindex T r (Topic)
2596 @findex gnus-topic-rename
2597 Rename a topic (@code{gnus-topic-rename}). 
2598
2599 @item T DEL
2600 @kindex T DEL (Topic)
2601 @findex gnus-topic-delete
2602 Delete an empty topic (@code{gnus-topic-delete}). 
2603
2604 @item A T
2605 @kindex A T (Topic)
2606 @findex gnus-topic-list-active
2607 List all groups that Gnus knows about in a topics-ified way
2608 (@code{gnus-topic-list-active}).
2609
2610 @item G p
2611 @kindex G p (Topic)
2612 @findex gnus-topic-edit-parameters
2613 @cindex group parameters
2614 @cindex topic parameters
2615 @cindex parameters
2616 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2617 @xref{Topic Parameters}.
2618
2619 @end table
2620
2621
2622 @node Topic Sorting
2623 @subsection Topic Sorting
2624 @cindex topic sorting
2625
2626 You can sort the groups in each topic individually with the following
2627 commands: 
2628
2629
2630 @table @kbd
2631 @item T S a
2632 @kindex T S a (Topic)
2633 @findex gnus-topic-sort-groups-by-alphabet
2634 Sort the current topic alphabetically by group name
2635 (@code{gnus-topic-sort-groups-by-alphabet}). 
2636
2637 @item T S u
2638 @kindex T S u (Topic)
2639 @findex gnus-topic-sort-groups-by-unread
2640 Sort the current topic by the number of unread articles
2641 (@code{gnus-topic-sort-groups-by-unread}).
2642
2643 @item T S l
2644 @kindex T S l (Topic)
2645 @findex gnus-topic-sort-groups-by-level
2646 Sort the current topic by group level
2647 (@code{gnus-topic-sort-groups-by-level}). 
2648
2649 @item T S v
2650 @kindex T S v (Topic)
2651 @findex gnus-topic-sort-groups-by-score
2652 Sort the current topic by group score
2653 (@code{gnus-topic-sort-groups-by-score}). 
2654
2655 @item T S r
2656 @kindex T S r (Topic)
2657 @findex gnus-topic-sort-groups-by-rank
2658 Sort the current topic by group rank
2659 (@code{gnus-topic-sort-groups-by-rank}). 
2660
2661 @item T S m
2662 @kindex T S m (Topic)
2663 @findex gnus-topic-sort-groups-by-method
2664 Sort the current topic alphabetically by backend name
2665 (@code{gnus-topic-sort-groups-by-method}). 
2666
2667 @end table
2668
2669 @xref{Sorting Groups} for more information about group sorting. 
2670
2671
2672 @node Topic Topology
2673 @subsection Topic Topology
2674 @cindex topic topology
2675 @cindex topology
2676
2677 So, let's have a look at an example group buffer:
2678
2679 @example
2680 Gnus
2681   Emacs -- I wuw it!
2682      3: comp.emacs
2683      2: alt.religion.emacs
2684     Naughty Emacs
2685      452: alt.sex.emacs
2686        0: comp.talk.emacs.recovery
2687   Misc
2688      8: comp.binaries.fractals
2689     13: comp.sources.unix
2690 @end example
2691
2692 So, here we have one top-level topic (@samp{Gnus}), two topics under
2693 that, and one sub-topic under one of the sub-topics.  (There is always
2694 just one (1) top-level topic).  This topology can be expressed as
2695 follows:
2696
2697 @lisp
2698 (("Gnus" visible)
2699  (("Emacs -- I wuw it!" visible) 
2700   (("Naughty Emacs" visible)))
2701  (("Misc" visible)))
2702 @end lisp
2703
2704 @vindex gnus-topic-topology
2705 This is in fact how the variable @code{gnus-topic-topology} would look
2706 for the display above.  That variable is saved in the @file{.newsrc.eld}
2707 file, and shouldn't be messed with manually---unless you really want
2708 to.  Since this variable is read from the @file{.newsrc.eld} file,
2709 setting it in any other startup files will have no effect.  
2710
2711 This topology shows what topics are sub-topics of what topics (right),
2712 and which topics are visible.  Two settings are currently
2713 allowed---@code{visible} and @code{invisible}.
2714
2715
2716 @node Topic Parameters
2717 @subsection Topic Parameters
2718 @cindex topic parameters
2719
2720 All groups in a topic will inherit group parameters from the parent (and
2721 ancestor) topic parameters.  All legal group parameters are legal topic
2722 parameters (@pxref{Group Parameters}).  
2723
2724 Group parameters (of course) override topic parameters, and topic
2725 parameters in sub-topics override topic parameters in super-topics.  You
2726 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2727 verb, although you may feel free to disagree with me here.)
2728
2729 @example
2730 Gnus
2731   Emacs
2732      3: comp.emacs
2733      2: alt.religion.emacs
2734    452: alt.sex.emacs
2735     Relief
2736      452: alt.sex.emacs
2737        0: comp.talk.emacs.recovery
2738   Misc
2739      8: comp.binaries.fractals
2740     13: comp.sources.unix
2741    452: alt.sex.emacs
2742 @end example
2743
2744 The @samp{Emacs} topic has the topic parameter @code{(score-file
2745 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2746 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2747 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2748 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2749 . "religion.SCORE")}.
2750
2751 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2752 will get the @file{relief.SCORE} home score file.  If you enter the same
2753 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2754 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2755 get the @file{religion.SCORE} home score file.
2756
2757 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2758 there are some problems, especially with the @code{total-expiry}
2759 parameter.  Say you have a mail group in two topics; one with
2760 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2761 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2762 of these topics you mean to expire articles from, so anything may
2763 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2764 happens.  You just have to be careful if you do stuff like that.
2765
2766
2767 @node Misc Group Stuff
2768 @section Misc Group Stuff
2769
2770 @menu
2771 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2772 * Group Information::     Information and help on groups and Gnus.
2773 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2774 * File Commands::         Reading and writing the Gnus files.
2775 @end menu
2776
2777 @table @kbd
2778
2779 @item ^
2780 @kindex ^ (Group)
2781 @findex gnus-group-enter-server-mode
2782 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2783 @xref{The Server Buffer}.
2784
2785 @item a
2786 @kindex a (Group)
2787 @findex gnus-group-post-news
2788 Post an article to a group (@code{gnus-group-post-news}).  The current
2789 group name will be used as the default.
2790
2791 @item m
2792 @kindex m (Group)
2793 @findex gnus-group-mail
2794 Mail a message somewhere (@code{gnus-group-mail}).
2795
2796 @end table
2797
2798 Variables for the group buffer:
2799
2800 @table @code
2801
2802 @item gnus-group-mode-hook
2803 @vindex gnus-group-mode-hook
2804 @code{gnus-group-mode-hook} is called after the group buffer has been
2805 created. 
2806
2807 @item gnus-group-prepare-hook
2808 @vindex gnus-group-prepare-hook
2809 @code{gnus-group-prepare-hook} is called after the group buffer is
2810 generated.  It may be used to modify the buffer in some strange,
2811 unnatural way.
2812
2813 @item gnus-permanently-visible-groups
2814 @vindex gnus-permanently-visible-groups
2815 Groups matching this regexp will always be listed in the group buffer,
2816 whether they are empty or not.
2817
2818 @end table
2819
2820
2821 @node Scanning New Messages
2822 @subsection Scanning New Messages
2823 @cindex new messages
2824 @cindex scanning new news
2825
2826 @table @kbd
2827
2828 @item g
2829 @kindex g (Group)
2830 @findex gnus-group-get-new-news
2831 Check the server(s) for new articles.  If the numerical prefix is used,
2832 this command will check only groups of level @var{arg} and lower
2833 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2834 command will force a total rereading of the active file(s) from the
2835 backend(s).
2836
2837 @item M-g
2838 @kindex M-g (Group)
2839 @findex gnus-group-get-new-news-this-group
2840 @vindex gnus-goto-next-group-when-activating
2841 Check whether new articles have arrived in the current group
2842 (@code{gnus-group-get-new-news-this-group}).
2843 @code{gnus-goto-next-group-when-activating} says whether this command is
2844 to move point to the next group or not.  It is @code{t} by default.
2845
2846 @findex gnus-activate-all-groups
2847 @cindex activating groups
2848 @item C-c M-g
2849 @kindex C-c M-g (Group)
2850 Activate absolutely all groups (@code{gnus-activate-all-groups}). 
2851
2852 @item R
2853 @kindex R (Group)
2854 @cindex restarting
2855 @findex gnus-group-restart
2856 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2857 file(s), closes the connection to all servers, clears up all run-time
2858 Gnus variables, and then starts Gnus all over again.
2859
2860 @end table
2861
2862 @vindex gnus-get-new-news-hook
2863 @code{gnus-get-new-news-hook} is run just before checking for new news. 
2864
2865 @vindex gnus-after-getting-new-news-hook
2866 @code{gnus-after-getting-new-news-hook} is run after checking for new
2867 news.
2868
2869
2870 @node Group Information
2871 @subsection Group Information
2872 @cindex group information
2873 @cindex information on groups
2874
2875 @table @kbd
2876
2877
2878 @item H f
2879 @kindex H f (Group)
2880 @findex gnus-group-fetch-faq
2881 @vindex gnus-group-faq-directory
2882 @cindex FAQ
2883 @cindex ange-ftp
2884 Try to fetch the FAQ for the current group
2885 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2886 @code{gnus-group-faq-directory}, which is usually a directory on a
2887 remote machine.  This variable can also be a list of directories.  In
2888 that case, giving a prefix to this command will allow you to choose
2889 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2890 for fetching the file.
2891
2892 If fetching from the first site is unsuccessful, Gnus will attempt to go
2893 through @code{gnus-group-faq-directory} and try to open them one by one.
2894
2895 @item H d
2896 @itemx C-c C-d
2897 @kindex H d (Group)
2898 @kindex C-c C-d (Group)
2899 @cindex describing groups
2900 @cindex group description
2901 @findex gnus-group-describe-group
2902 Describe the current group (@code{gnus-group-describe-group}).  If given
2903 a prefix, force Gnus to re-read the description from the server.
2904
2905 @item M-d
2906 @kindex M-d (Group)
2907 @findex gnus-group-describe-all-groups
2908 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2909 prefix, force Gnus to re-read the description file from the server.
2910
2911 @item V
2912 @kindex V (Group)
2913 @cindex version
2914 @findex gnus-version
2915 Display current Gnus version numbers (@code{gnus-version}).
2916
2917 @item ?
2918 @kindex ? (Group)
2919 @findex gnus-group-describe-briefly
2920 Give a very short help message (@code{gnus-group-describe-briefly}).
2921
2922 @item C-c C-i
2923 @kindex C-c C-i (Group)
2924 @cindex info
2925 @cindex manual
2926 @findex gnus-info-find-node
2927 Go to the Gnus info node (@code{gnus-info-find-node}).
2928 @end table
2929
2930
2931 @node Group Timestamp
2932 @subsection Group Timestamp
2933 @cindex timestamps
2934 @cindex group timestamps
2935
2936 It can be convenient to let Gnus keep track of when you last read a
2937 group.  To set the ball rolling, you should add
2938 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2939
2940 @lisp
2941 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2942 @end lisp
2943
2944 After doing this, each time you enter a group, it'll be recorded.
2945
2946 This information can be displayed in various ways---the easiest is to
2947 use the @samp{%d} spec in the group line format:
2948
2949 @lisp
2950 (setq gnus-group-line-format 
2951       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2952 @end lisp
2953
2954 This will result in lines looking like:
2955
2956 @example
2957 *        0: mail.ding                                19961002T012943
2958          0: custom                                   19961002T012713
2959 @end example
2960
2961 As you can see, the date is displayed in compact ISO 8601 format.  This
2962 may be a bit too much, so to just display the date, you could say
2963 something like:
2964
2965 @lisp
2966 (setq gnus-group-line-format 
2967       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2968 @end lisp
2969
2970
2971 @node File Commands
2972 @subsection File Commands
2973 @cindex file commands
2974
2975 @table @kbd
2976
2977 @item r
2978 @kindex r (Group)
2979 @findex gnus-group-read-init-file
2980 @vindex gnus-init-file
2981 @cindex reading init file
2982 Re-read the init file (@code{gnus-init-file}, which defaults to
2983 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2984
2985 @item s
2986 @kindex s (Group)
2987 @findex gnus-group-save-newsrc
2988 @cindex saving .newsrc
2989 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2990 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2991 file(s) whether Gnus thinks it is necessary or not.
2992
2993 @c @item Z
2994 @c @kindex Z (Group)
2995 @c @findex gnus-group-clear-dribble
2996 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2997
2998 @end table
2999
3000
3001 @node The Summary Buffer
3002 @chapter The Summary Buffer
3003 @cindex summary buffer
3004
3005 A line for each article is displayed in the summary buffer.  You can
3006 move around, read articles, post articles and reply to articles.
3007
3008 The most common way to a summary buffer is to select a group from the
3009 group buffer (@pxref{Selecting a Group}).  
3010
3011 You can have as many summary buffers open as you wish.
3012
3013 @menu
3014 * Summary Buffer Format::       Deciding how the summary buffer is to look.
3015 * Summary Maneuvering::         Moving around the summary buffer.
3016 * Choosing Articles::           Reading articles.
3017 * Paging the Article::          Scrolling the current article.
3018 * Reply Followup and Post::     Posting articles.
3019 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
3020 * Marking Articles::            Marking articles as read, expirable, etc.
3021 * Limiting::                    You can limit the summary buffer.
3022 * Threading::                   How threads are made.
3023 * Sorting::                     How articles and threads are sorted.
3024 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
3025 * Article Caching::             You may store articles in a cache.
3026 * Persistent Articles::         Making articles expiry-resistant.
3027 * Article Backlog::             Having already read articles hang around.
3028 * Saving Articles::             Ways of customizing article saving.
3029 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
3030 * Article Treatment::           The article buffer can be mangled at will.
3031 * Article Commands::            Doing various things with the article buffer.
3032 * Summary Sorting::             Sorting the summary buffer in various ways.
3033 * Finding the Parent::          No child support? Get the parent.
3034 * Alternative Approaches::      Reading using non-default summaries.
3035 * Tree Display::                A more visual display of threads.
3036 * Mail Group Commands::         Some commands can only be used in mail groups.
3037 * Various Summary Stuff::       What didn't fit anywhere else.
3038 * Exiting the Summary Buffer::  Returning to the Group buffer.
3039 * Crosspost Handling::          How crossposted articles are dealt with.
3040 * Duplicate Suppression::       An alternative when crosspost handling fails.
3041 @end menu
3042
3043
3044 @node Summary Buffer Format
3045 @section Summary Buffer Format
3046 @cindex summary buffer format
3047
3048 @menu
3049 * Summary Buffer Lines::     You can specify how summary lines should look.
3050 * Summary Buffer Mode Line:: You can say how the mode line should look.
3051 * Summary Highlighting::     Making the summary buffer all pretty and nice.
3052 @end menu
3053
3054 @findex mail-extract-address-components
3055 @findex gnus-extract-address-components
3056 @vindex gnus-extract-address-components
3057 Gnus will use the value of the @code{gnus-extract-address-components}
3058 variable as a function for getting the name and address parts of a
3059 @code{From} header.  Two pre-defined function exist:
3060 @code{gnus-extract-address-components}, which is the default, quite
3061 fast, and too simplistic solution; and
3062 @code{mail-extract-address-components}, which works very nicely, but is
3063 slower.  The default function will return the wrong answer in 5% of the
3064 cases.  If this is unacceptable to you, use the other function instead.
3065
3066 @vindex gnus-summary-same-subject
3067 @code{gnus-summary-same-subject} is a string indicating that the current
3068 article has the same subject as the previous.  This string will be used
3069 with those specs that require it.  The default is @samp{}.
3070
3071
3072 @node Summary Buffer Lines
3073 @subsection Summary Buffer Lines
3074
3075 @vindex gnus-summary-line-format
3076 You can change the format of the lines in the summary buffer by changing
3077 the @code{gnus-summary-line-format} variable.  It works along the same
3078 lines a a normal @code{format} string, with some extensions
3079 (@pxref{Formatting Variables}).
3080
3081 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3082
3083 The following format specification characters are understood:
3084
3085 @table @samp
3086 @item N 
3087 Article number.
3088 @item S
3089 Subject string.
3090 @item s
3091 Subject if the article is the root or the previous article had a
3092 different subject, @code{gnus-summary-same-subject} otherwise.
3093 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3094 @item F
3095 Full @code{From} header.
3096 @item n
3097 The name (from the @code{From} header).
3098 @item a
3099 The name (from the @code{From} header).  This differs from the @code{n}
3100 spec in that it uses the function designated by the
3101 @code{gnus-extract-address-components} variable, which is slower, but
3102 may be more thorough.
3103 @item A
3104 The address (from the @code{From} header).  This works the same way as
3105 the @code{a} spec.
3106 @item L
3107 Number of lines in the article.
3108 @item c
3109 Number of characters in the article.
3110 @item I
3111 Indentation based on thread level (@pxref{Customizing Threading}).
3112 @item T
3113 Nothing if the article is a root and lots of spaces if it isn't (it
3114 pushes everything after it off the screen).
3115 @item [
3116 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3117 for adopted articles (@pxref{Customizing Threading}).
3118 @item ]
3119 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3120 for adopted articles.
3121 @item >
3122 One space for each thread level.
3123 @item <
3124 Twenty minus thread level spaces.
3125 @item U
3126 Unread.
3127 @item R
3128 Replied.
3129 @item i
3130 Score as a number.
3131 @item z
3132 @vindex gnus-summary-zcore-fuzz
3133 Zcore, @samp{+} if above the default level and @samp{-} if below the
3134 default level.  If the difference between
3135 @code{gnus-summary-default-level} and the score is less than
3136 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3137 @item V
3138 Total thread score.
3139 @item x
3140 @code{Xref}.
3141 @item D
3142 @code{Date}.
3143 @item d
3144 The @code{Date} in @code{DD-MMM} format.
3145 @item o
3146 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3147 @item M
3148 @code{Message-ID}.
3149 @item r
3150 @code{References}.
3151 @item t
3152 Number of articles in the current sub-thread.  Using this spec will slow
3153 down summary buffer generation somewhat.
3154 @item e
3155 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3156 article has any children.
3157 @item P
3158 The line number.
3159 @item u
3160 User defined specifier.  The next character in the format string should
3161 be a letter.  @sc{gnus} will call the function
3162 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3163 following @samp{%u}.  The function will be passed the current header as
3164 argument.  The function should return a string, which will be inserted
3165 into the summary just like information from any other summary specifier.
3166 @end table
3167
3168 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3169 have to be handled with care.  For reasons of efficiency, Gnus will
3170 compute what column these characters will end up in, and ``hard-code''
3171 that.  This means that it is illegal to have these specs after a
3172 variable-length spec.  Well, you might not be arrested, but your summary
3173 buffer will look strange, which is bad enough.
3174
3175 The smart choice is to have these specs as far to the left as possible.
3176 (Isn't that the case with everything, though?  But I digress.)
3177
3178 This restriction may disappear in later versions of Gnus.
3179
3180
3181 @node Summary Buffer Mode Line
3182 @subsection Summary Buffer Mode Line
3183
3184 @vindex gnus-summary-mode-line-format
3185 You can also change the format of the summary mode bar.  Set
3186 @code{gnus-summary-mode-line-format} to whatever you like.  The default
3187 is @samp{Gnus: %%b [%A] %Z}.  
3188
3189 Here are the elements you can play with:
3190
3191 @table @samp
3192 @item G
3193 Group name.
3194 @item p
3195 Unprefixed group name.
3196 @item A
3197 Current article number.
3198 @item V
3199 Gnus version.
3200 @item U
3201 Number of unread articles in this group.
3202 @item e
3203 Number of unselected articles in this group.
3204 @item Z
3205 A string with the number of unread and unselected articles represented
3206 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3207 articles, and just as @samp{<%U more>} if there are just unread articles
3208 and no unselected ones.
3209 @item g
3210 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3211 shortened to @samp{r.a.anime}. 
3212 @item S
3213 Subject of the current article.
3214 @item u
3215 User-defined spec.
3216 @item s
3217 Name of the current score file.
3218 @item d
3219 Number of dormant articles.
3220 @item t
3221 Number of ticked articles.
3222 @item r
3223 Number of articles that have been marked as read in this session. 
3224 @item E
3225 Number of articles expunged by the score files.
3226 @end table
3227
3228
3229 @node Summary Highlighting
3230 @subsection Summary Highlighting
3231
3232 @table @code
3233
3234 @item gnus-visual-mark-article-hook
3235 @vindex gnus-visual-mark-article-hook
3236 This hook is run after selecting an article.  It is meant to be used for
3237 highlighting the article in some way.  It is not run if
3238 @code{gnus-visual} is @code{nil}.
3239
3240 @item gnus-summary-update-hook
3241 @vindex gnus-summary-update-hook
3242 This hook is called when a summary line is changed.  It is not run if
3243 @code{gnus-visual} is @code{nil}.
3244
3245 @item gnus-summary-selected-face
3246 @vindex gnus-summary-selected-face
3247 This is the face (or @dfn{font} as some people call it) that is used to
3248 highlight the current article in the summary buffer.
3249
3250 @item gnus-summary-highlight
3251 @vindex gnus-summary-highlight
3252 Summary lines are highlighted according to this variable, which is a
3253 list where the elements are on the format @var{(FORM . FACE)}.  If you
3254 would, for instance, like ticked articles to be italic and high-scored
3255 articles to be bold, you could set this variable to something like
3256 @lisp
3257 (((eq mark gnus-ticked-mark) . italic)
3258  ((> score default) . bold))
3259 @end lisp
3260 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3261 @var{FACE} will be applied to the line.
3262 @end table
3263
3264
3265 @node Summary Maneuvering
3266 @section Summary Maneuvering
3267 @cindex summary movement
3268
3269 All the straight movement commands understand the numeric prefix and
3270 behave pretty much as you'd expect. 
3271
3272 None of these commands select articles.
3273
3274 @table @kbd
3275 @item G M-n
3276 @itemx M-n
3277 @kindex M-n (Summary)
3278 @kindex G M-n (Summary)
3279 @findex gnus-summary-next-unread-subject
3280 Go to the next summary line of an unread article
3281 (@code{gnus-summary-next-unread-subject}). 
3282
3283 @item G M-p
3284 @itemx M-p
3285 @kindex M-p (Summary)
3286 @kindex G M-p (Summary)
3287 @findex gnus-summary-prev-unread-subject
3288 Go to the previous summary line of an unread article
3289 (@code{gnus-summary-prev-unread-subject}). 
3290
3291 @item G j
3292 @itemx j
3293 @kindex j (Summary)
3294 @kindex G j (Summary)
3295 @findex gnus-summary-goto-article
3296 Ask for an article number and then go to that article
3297 (@code{gnus-summary-goto-article}). 
3298
3299 @item G g
3300 @kindex G g (Summary)
3301 @findex gnus-summary-goto-subject
3302 Ask for an article number and then go the summary line of that article
3303 without displaying the article (@code{gnus-summary-goto-subject}).
3304 @end table
3305
3306 If Gnus asks you to press a key to confirm going to the next group, you
3307 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3308 buffer, searching for the next group to read without actually returning
3309 to the group buffer.
3310
3311 Variables related to summary movement:
3312
3313 @table @code
3314
3315 @vindex gnus-auto-select-next
3316 @item gnus-auto-select-next
3317 If you issue one of the movement commands (like @kbd{n}) and there are
3318 no more unread articles after the current one, Gnus will offer to go to
3319 the next group.  If this variable is @code{t} and the next group is
3320 empty, Gnus will exit summary mode and return to the group buffer.  If
3321 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3322 next group, no matter whether it has any unread articles or not.  As a
3323 special case, if this variable is @code{quietly}, Gnus will select the
3324 next group without asking for confirmation.  If this variable is
3325 @code{almost-quietly}, the same will happen only if you are located on
3326 the last article in the group.  Finally, if this variable is
3327 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3328 without confirmation.  Also @pxref{Group Levels}.
3329
3330 @item gnus-auto-select-same
3331 @vindex gnus-auto-select-same
3332 If non-@code{nil}, all the movement commands will try to go to the next
3333 article with the same subject as the current.  (@dfn{Same} here might
3334 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3335 for details (@pxref{Customizing Threading}).)  This variable is not
3336 particularly useful if you use a threaded display.
3337
3338 @item gnus-summary-check-current
3339 @vindex gnus-summary-check-current
3340 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3341 to the next (or previous) article if the current article is unread.
3342 Instead, they will choose the current article.
3343
3344 @item gnus-auto-center-summary
3345 @vindex gnus-auto-center-summary
3346 If non-@code{nil}, Gnus will keep the point in the summary buffer
3347 centered at all times.  This makes things quite tidy, but if you have a
3348 slow network connection, or simply do not like this un-Emacsism, you can
3349 set this variable to @code{nil} to get the normal Emacs scrolling
3350 action.  This will also inhibit horizontal re-centering of the summary
3351 buffer, which might make it more inconvenient to read extremely long
3352 threads.
3353
3354 @end table
3355
3356
3357 @node Choosing Articles
3358 @section Choosing Articles
3359 @cindex selecting articles
3360
3361 @menu
3362 * Choosing Commands::        Commands for choosing articles.
3363 * Choosing Variables::       Variables that influence these commands.
3364 @end menu
3365
3366
3367 @node Choosing Commands
3368 @subsection Choosing Commands
3369
3370 None of the following movement commands understand the numeric prefix,
3371 and they all select and display an article.
3372
3373 @table @kbd
3374 @item SPACE
3375 @kindex SPACE (Summary)
3376 @findex gnus-summary-next-page
3377 Select the current article, or, if that one's read already, the next
3378 unread article (@code{gnus-summary-next-page}).
3379
3380 @item G n
3381 @itemx n
3382 @kindex n (Summary)
3383 @kindex G n (Summary)
3384 @findex gnus-summary-next-unread-article
3385 Go to next unread article (@code{gnus-summary-next-unread-article}).
3386
3387 @item G p
3388 @itemx p
3389 @kindex p (Summary)
3390 @findex gnus-summary-prev-unread-article
3391 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3392
3393 @item G N
3394 @itemx N
3395 @kindex N (Summary)
3396 @kindex G N (Summary)
3397 @findex gnus-summary-next-article
3398 Go to the next article (@code{gnus-summary-next-article}).
3399
3400 @item G P
3401 @itemx P
3402 @kindex P (Summary)
3403 @kindex G P (Summary)
3404 @findex gnus-summary-prev-article
3405 Go to the previous article (@code{gnus-summary-prev-article}).
3406
3407 @item G C-n
3408 @kindex G C-n (Summary)
3409 @findex gnus-summary-next-same-subject
3410 Go to the next article with the same subject
3411 (@code{gnus-summary-next-same-subject}). 
3412
3413 @item G C-p
3414 @kindex G C-p (Summary)
3415 @findex gnus-summary-prev-same-subject
3416 Go to the previous article with the same subject
3417 (@code{gnus-summary-prev-same-subject}). 
3418
3419 @item G f
3420 @itemx .
3421 @kindex G f  (Summary)
3422 @kindex .  (Summary)
3423 @findex gnus-summary-first-unread-article
3424 Go to the first unread article
3425 (@code{gnus-summary-first-unread-article}).
3426
3427 @item G b
3428 @itemx ,
3429 @kindex G b (Summary)
3430 @kindex , (Summary)
3431 @findex gnus-summary-best-unread-article
3432 Go to the article with the highest score
3433 (@code{gnus-summary-best-unread-article}). 
3434
3435 @item G l
3436 @itemx l
3437 @kindex l (Summary)
3438 @kindex G l (Summary)
3439 @findex gnus-summary-goto-last-article
3440 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3441
3442 @item G p
3443 @kindex G p (Summary)
3444 @findex gnus-summary-pop-article
3445 Pop an article off the summary history and go to this article
3446 (@code{gnus-summary-pop-article}).  This command differs from the
3447 command above in that you can pop as many previous articles off the
3448 history as you like.
3449 @end table
3450
3451
3452 @node Choosing Variables
3453 @subsection Choosing Variables
3454
3455 Some variables that are relevant for moving and selecting articles:
3456
3457 @table @code
3458 @item gnus-auto-extend-newsgroup
3459 @vindex gnus-auto-extend-newsgroup
3460 All the movement commands will try to go to the previous (or next)
3461 article, even if that article isn't displayed in the Summary buffer if
3462 this variable is non-@code{nil}.  Gnus will then fetch the article from
3463 the server and display it in the article buffer.
3464
3465 @item gnus-select-article-hook
3466 @vindex gnus-select-article-hook
3467 This hook is called whenever an article is selected.  By default it
3468 exposes any threads hidden under the selected article.
3469
3470 @item gnus-mark-article-hook
3471 @vindex gnus-mark-article-hook
3472 @findex gnus-summary-mark-unread-as-read
3473 @findex gnus-summary-mark-read-and-unread-as-read
3474 @findex gnus-unread-mark
3475 This hook is called whenever an article is selected.  It is intended to
3476 be used for marking articles as read.  The default value is
3477 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3478 mark of almost any article you read to @code{gnus-unread-mark}.  The
3479 only articles not affected by this function are ticked, dormant, and
3480 expirable articles.  If you'd instead like to just have unread articles
3481 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3482 instead.  It will leave marks like @code{gnus-low-score-mark},
3483 @code{gnus-del-mark} (and so on) alone.
3484
3485 @end table
3486
3487
3488 @node Paging the Article
3489 @section Scrolling the Article
3490 @cindex article scrolling
3491
3492 @table @kbd
3493
3494 @item SPACE
3495 @kindex SPACE (Summary)
3496 @findex gnus-summary-next-page
3497 Pressing @kbd{SPACE} will scroll the current article forward one page,
3498 or, if you have come to the end of the current article, will choose the
3499 next article (@code{gnus-summary-next-page}).
3500
3501 @item DEL
3502 @kindex DEL (Summary)
3503 @findex gnus-summary-prev-page
3504 Scroll the current article back one page (@code{gnus-summary-prev-page}). 
3505
3506 @item RET
3507 @kindex RET (Summary)
3508 @findex gnus-summary-scroll-up
3509 Scroll the current article one line forward
3510 (@code{gnus-summary-scroll-up}).
3511
3512 @item A g
3513 @itemx g
3514 @kindex A g (Summary)
3515 @kindex g (Summary)
3516 @findex gnus-summary-show-article
3517 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3518 given a prefix, fetch the current article, but don't run any of the
3519 article treatment functions.  This will give you a ``raw'' article, just
3520 the way it came from the server.
3521
3522 @item A <
3523 @itemx <
3524 @kindex < (Summary)
3525 @kindex A < (Summary)
3526 @findex gnus-summary-beginning-of-article
3527 Scroll to the beginning of the article
3528 (@code{gnus-summary-beginning-of-article}).
3529
3530 @item A >
3531 @itemx >
3532 @kindex > (Summary)
3533 @kindex A > (Summary)
3534 @findex gnus-summary-end-of-article
3535 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3536
3537 @item A s 
3538 @itemx s
3539 @kindex A s (Summary)
3540 @kindex s (Summary)
3541 @findex gnus-summary-isearch-article
3542 Perform an isearch in the article buffer
3543 (@code{gnus-summary-isearch-article}). 
3544
3545 @end table
3546
3547
3548 @node Reply Followup and Post
3549 @section Reply, Followup and Post
3550
3551 @menu
3552 * Summary Mail Commands::            Sending mail.
3553 * Summary Post Commands::            Sending news.
3554 @end menu
3555
3556
3557 @node Summary Mail Commands
3558 @subsection Summary Mail Commands
3559 @cindex mail
3560 @cindex composing mail
3561
3562 Commands for composing a mail message:
3563
3564 @table @kbd
3565
3566 @item S r
3567 @itemx r
3568 @kindex S r (Summary)
3569 @kindex r (Summary)
3570 @findex gnus-summary-reply
3571 Mail a reply to the author of the current article
3572 (@code{gnus-summary-reply}). 
3573
3574 @item S R
3575 @itemx R
3576 @kindex R (Summary)
3577 @kindex S R (Summary)
3578 @findex gnus-summary-reply-with-original
3579 Mail a reply to the author of the current article and include the
3580 original message (@code{gnus-summary-reply-with-original}).  This
3581 command uses the process/prefix convention.
3582
3583 @item S w
3584 @kindex S w (Summary)
3585 @findex gnus-summary-wide-reply
3586 Mail a wide reply to the author of the current article
3587 (@code{gnus-summary-wide-reply}). 
3588
3589 @item S W
3590 @kindex S W (Summary)
3591 @findex gnus-summary-wide-reply-with-original
3592 Mail a wide reply to the current article and include the original
3593 message (@code{gnus-summary-reply-with-original}).  This command uses
3594 the process/prefix convention.
3595
3596 @item S o m
3597 @kindex S o m (Summary)
3598 @findex gnus-summary-mail-forward
3599 Forward the current article to some other person
3600 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3601 headers of the forwarded article.
3602
3603 @item S m
3604 @itemx m
3605 @kindex m (Summary)
3606 @kindex S m (Summary)
3607 @findex gnus-summary-mail-other-window
3608 Send a mail to some other person
3609 (@code{gnus-summary-mail-other-window}).
3610
3611 @item S D b
3612 @kindex S D b (Summary)
3613 @findex gnus-summary-resend-bounced-mail
3614 @cindex bouncing mail
3615 If you have sent a mail, but the mail was bounced back to you for some
3616 reason (wrong address, transient failure), you can use this command to
3617 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3618 will be popped into a mail buffer where you can edit the headers before
3619 sending the mail off again.  If you give a prefix to this command, and
3620 the bounced mail is a reply to some other mail, Gnus will try to fetch
3621 that mail and display it for easy perusal of its headers.  This might
3622 very well fail, though.
3623
3624 @item S D r
3625 @kindex S D r (Summary)
3626 @findex gnus-summary-resend-message
3627 Not to be confused with the previous command,
3628 @code{gnus-summary-resend-message} will prompt you for an address to
3629 send the current message off to, and then send it to that place.  The
3630 headers of the message won't be altered---but lots of headers that say
3631 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3632 means that you actually send a mail to someone that has a @code{To}
3633 header that (probably) points to yourself.  This will confuse people.
3634 So, natcherly you'll only do that if you're really eVIl.  
3635
3636 This command is mainly used if you have several accounts and want to
3637 ship a mail to a different account of yours.  (If you're both
3638 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3639 to the @code{root} account, you may want to resend it to
3640 @code{postmaster}.  Ordnung muß sein!
3641
3642 This command understands the process/prefix convention
3643 (@pxref{Process/Prefix}). 
3644
3645 @item S O m
3646 @kindex S O m (Summary)
3647 @findex gnus-uu-digest-mail-forward
3648 Digest the current series and forward the result using mail
3649 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3650 process/prefix convention (@pxref{Process/Prefix}). 
3651
3652 @item S M-c
3653 @kindex S M-c (Summary)
3654 @findex gnus-summary-mail-crosspost-complaint
3655 @cindex crossposting
3656 @cindex excessive crossposting
3657 Send a complaint about excessive crossposting to the author of the
3658 current article (@code{gnus-summary-mail-crosspost-complaint}).  
3659
3660 @findex gnus-crosspost-complaint
3661 This command is provided as a way to fight back agains the current
3662 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3663 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3664 command understands the process/prefix convention
3665 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3666
3667 @end table
3668
3669
3670 @node Summary Post Commands
3671 @subsection Summary Post Commands
3672 @cindex post
3673 @cindex composing news
3674
3675 Commands for posting a news article:
3676
3677 @table @kbd
3678 @item S p
3679 @itemx a
3680 @kindex a (Summary)
3681 @kindex S p (Summary)
3682 @findex gnus-summary-post-news
3683 Post an article to the current group
3684 (@code{gnus-summary-post-news}).
3685
3686 @item S f
3687 @itemx f
3688 @kindex f (Summary)
3689 @kindex S f (Summary)
3690 @findex gnus-summary-followup
3691 Post a followup to the current article (@code{gnus-summary-followup}).
3692
3693 @item S F
3694 @itemx F
3695 @kindex S F (Summary)
3696 @kindex F (Summary)
3697 @findex gnus-summary-followup-with-original
3698 Post a followup to the current article and include the original message
3699 (@code{gnus-summary-followup-with-original}).   This command uses the
3700 process/prefix convention.
3701
3702 @item S n
3703 @kindex S n (Summary)
3704 @findex gnus-summary-followup-to-mail
3705 Post a followup to the current article via news, even if you got the
3706 message through mail (@code{gnus-summary-followup-to-mail}).
3707
3708 @item S n
3709 @kindex S n (Summary)
3710 @findex gnus-summary-followup-to-mail
3711 Post a followup to the current article via news, even if you got the
3712 message through mail and include the original message
3713 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3714 the process/prefix convention.
3715
3716 @item S o p
3717 @kindex S o p (Summary)
3718 @findex gnus-summary-post-forward
3719 Forward the current article to a newsgroup
3720 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3721 headers of the forwarded article.
3722
3723 @item S O p
3724 @kindex S O p (Summary)
3725 @findex gnus-uu-digest-post-forward
3726 Digest the current series and forward the result to a newsgroup
3727 (@code{gnus-uu-digest-mail-forward}).  
3728
3729 @item S u
3730 @kindex S u (Summary)
3731 @findex gnus-uu-post-news
3732 Uuencode a file, split it into parts, and post it as a series
3733 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}). 
3734 @end table
3735
3736
3737 @node Canceling and Superseding
3738 @section Canceling Articles
3739 @cindex canceling articles
3740 @cindex superseding articles
3741
3742 Have you ever written something, and then decided that you really,
3743 really, really wish you hadn't posted that?
3744
3745 Well, you can't cancel mail, but you can cancel posts.
3746
3747 @findex gnus-summary-cancel-article
3748 @kindex C (Summary)
3749 Find the article you wish to cancel (you can only cancel your own
3750 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3751 c} (@code{gnus-summary-cancel-article}).  Your article will be
3752 canceled---machines all over the world will be deleting your article. 
3753
3754 Be aware, however, that not all sites honor cancels, so your article may
3755 live on here and there, while most sites will delete the article in
3756 question.
3757
3758 If you discover that you have made some mistakes and want to do some
3759 corrections, you can post a @dfn{superseding} article that will replace
3760 your original article.
3761
3762 @findex gnus-summary-supersede-article
3763 @kindex S (Summary)
3764 Go to the original article and press @kbd{S s}
3765 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3766 where you can edit the article all you want before sending it off the
3767 usual way.
3768
3769 The same goes for superseding as for canceling, only more so: Some
3770 sites do not honor superseding.  On those sites, it will appear that you
3771 have posted almost the same article twice.
3772
3773 If you have just posted the article, and change your mind right away,
3774 there is a trick you can use to cancel/supersede the article without
3775 waiting for the article to appear on your site first.  You simply return
3776 to the post buffer (which is called @code{*sent ...*}).  There you will
3777 find the article you just posted, with all the headers intact.  Change
3778 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3779 header by substituting one of those words for the word
3780 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3781 you would do normally.  The previous article will be
3782 canceled/superseded.
3783
3784 Just remember, kids: There is no 'c' in 'supersede'.
3785
3786
3787 @node Marking Articles
3788 @section Marking Articles
3789 @cindex article marking
3790 @cindex article ticking
3791 @cindex marks
3792
3793 There are several marks you can set on an article. 
3794
3795 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3796 neologism ohoy!) of the article.  Alphabetic marks generally mean
3797 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3798
3799 In addition, you also have marks that do not affect readedness.
3800
3801 @menu
3802 * Unread Articles::      Marks for unread articles.
3803 * Read Articles::        Marks for read articles.
3804 * Other Marks::          Marks that do not affect readedness.
3805 @end menu
3806
3807 @ifinfo
3808 There's a plethora of commands for manipulating these marks:
3809 @end ifinfo
3810
3811 @menu
3812 * Setting Marks::           How to set and remove marks.
3813 * Setting Process Marks::   How to mark articles for later processing.
3814 @end menu
3815
3816
3817 @node Unread Articles
3818 @subsection Unread Articles
3819
3820 The following marks mark articles as (kinda) unread, in one form or
3821 other.
3822
3823 @table @samp
3824 @item !
3825 @vindex gnus-ticked-mark
3826 Marked as ticked (@code{gnus-ticked-mark}).
3827
3828 @dfn{Ticked articles} are articles that will remain visible always.  If
3829 you see an article that you find interesting, or you want to put off
3830 reading it, or replying to it, until sometime later, you'd typically
3831 tick it.  However, articles can be expired, so if you want to keep an
3832 article forever, you'll have to make it persistent (@pxref{Persistent
3833 Articles}).  
3834
3835 @item ?
3836 @vindex gnus-dormant-mark
3837 Marked as dormant (@code{gnus-dormant-mark}).  
3838
3839 @dfn{Dormant articles} will only appear in the summary buffer if there
3840 are followups to it.
3841
3842 @item SPACE
3843 @vindex gnus-unread-mark
3844 Markes as unread (@code{gnus-unread-mark}).
3845
3846 @dfn{Unread articles} are articles that haven't been read at all yet.
3847 @end table
3848
3849
3850 @node Read Articles
3851 @subsection Read Articles
3852 @cindex expirable mark
3853
3854 All the following marks mark articles as read.
3855
3856 @table @samp
3857
3858 @item r
3859 @vindex gnus-del-mark
3860 These are articles that the user has marked as read with the @kbd{d}
3861 command manually, more or less (@code{gnus-del-mark}).
3862
3863 @item R
3864 @vindex gnus-read-mark
3865 Articles that have actually been read (@code{gnus-read-mark}).
3866
3867 @item O
3868 @vindex gnus-ancient-mark
3869 Articles that were marked as read in previous sessions and are now
3870 @dfn{old} (@code{gnus-ancient-mark}).
3871
3872 @item K
3873 @vindex gnus-killed-mark
3874 Marked as killed (@code{gnus-killed-mark}).
3875
3876 @item X
3877 @vindex gnus-kill-file-mark
3878 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3879
3880 @item Y
3881 @vindex gnus-low-score-mark
3882 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3883
3884 @item C
3885 @vindex gnus-catchup-mark
3886 Marked as read by a catchup (@code{gnus-catchup-mark}).
3887
3888 @item G
3889 @vindex gnus-canceled-mark
3890 Canceled article (@code{gnus-canceled-mark})
3891
3892 @item F
3893 @vindex gnus-souped-mark
3894 @sc{SOUP}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3895
3896 @item Q
3897 @vindex gnus-sparse-mark
3898 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3899 Threading}.
3900
3901 @item M
3902 @vindex gnus-duplicate-mark
3903 Article marked as read by duplicate suppression
3904 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3905
3906 @end table
3907
3908 All these marks just mean that the article is marked as read, really.
3909 They are interpreted differently when doing adaptive scoring, though.
3910
3911 One more special mark, though:
3912
3913 @table @samp
3914 @item E
3915 @vindex gnus-expirable-mark
3916 Marked as expirable (@code{gnus-expirable-mark}).
3917
3918 Marking articles as @dfn{expirable} (or have them marked as such
3919 automatically) doesn't make much sense in normal groups---a user doesn't
3920 control the expiring of news articles, but in mail groups, for instance,
3921 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3922 any time.
3923 @end table
3924
3925
3926 @node Other Marks
3927 @subsection Other Marks
3928 @cindex process mark
3929 @cindex bookmarks
3930
3931 There are some marks that have nothing to do with whether the article is
3932 read or not.
3933
3934 @itemize @bullet
3935
3936 @item 
3937 You can set a bookmark in the current article.  Say you are reading a
3938 long thesis on cats' urinary tracts, and have to go home for dinner
3939 before you've finished reading the thesis.  You can then set a bookmark
3940 in the article, and Gnus will jump to this bookmark the next time it
3941 encounters the article.  @xref{Setting Marks}
3942
3943 @item
3944 @vindex gnus-replied-mark
3945 All articles that you have replied to or made a followup to (i.e., have
3946 answered) will be marked with an @samp{A} in the second column
3947 (@code{gnus-replied-mark}).
3948
3949 @item 
3950 @vindex gnus-cached-mark
3951 Articles that are stored in the article cache will be marked with an
3952 @samp{*} in the second column (@code{gnus-cached-mark}).
3953
3954 @item 
3955 @vindex gnus-saved-mark
3956 Articles that are ``saved'' (in some manner or other; not necessarily
3957 religiously) are marked with an @samp{S} in the second column
3958 (@code{gnus-saved-mark}.
3959
3960 @item 
3961 @vindex gnus-not-empty-thread-mark
3962 @vindex gnus-empty-thread-mark
3963 It the @samp{%e} spec is used, the presence of threads or not will be
3964 marked with @code{gnus-not-empty-thread-mark} and
3965 @code{gnus-empty-thread-mark} in the third column, respectively.
3966
3967 @item 
3968 @vindex gnus-process-mark
3969 Finally we have the @dfn{process mark} (@code{gnus-process-mark}.  A
3970 variety of commands react to the presence of the process mark.  For
3971 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3972 all articles that have been marked with the process mark.  Articles
3973 marked with the process mark have a @samp{#} in the second column.
3974
3975 @end itemize
3976
3977 You might have noticed that most of these ``non-readedness'' marks
3978 appear in the second column by default.  So if you have a cached, saved,
3979 replied article that you have process-marked, what will that look like?
3980
3981 Nothing much.  The precedence rules go as follows: process -> cache ->
3982 replied -> saved.  So if the article is in the cache and is replied,
3983 you'll only see the cache mark and not the replied mark.
3984
3985
3986 @node Setting Marks
3987 @subsection Setting Marks
3988 @cindex setting marks
3989
3990 All the marking commands understand the numeric prefix.
3991
3992 @table @kbd
3993 @item M t
3994 @itemx !
3995 @kindex ! (Summary)
3996 @kindex M t (Summary)
3997 @findex gnus-summary-tick-article-forward
3998 Tick the current article (@code{gnus-summary-tick-article-forward}).
3999
4000 @item M ?
4001 @itemx ?
4002 @kindex ? (Summary)
4003 @kindex M ? (Summary)
4004 @findex gnus-summary-mark-as-dormant
4005 Mark the current article as dormant
4006 (@code{gnus-summary-mark-as-dormant}).
4007
4008 @item M d
4009 @itemx d
4010 @kindex M d (Summary)
4011 @kindex d (Summary)
4012 @findex gnus-summary-mark-as-read-forward
4013 Mark the current article as read
4014 (@code{gnus-summary-mark-as-read-forward}).
4015
4016 @item D
4017 @kindex D (Summary)
4018 @findex gnus-summary-mark-as-read-backward
4019 Mark the current article as read and move point to the previous line
4020 (@code{gnus-summary-mark-as-read-backward}).
4021
4022 @item M k
4023 @itemx k
4024 @kindex k (Summary)
4025 @kindex M k (Summary)
4026 @findex gnus-summary-kill-same-subject-and-select
4027 Mark all articles that have the same subject as the current one as read,
4028 and then select the next unread article
4029 (@code{gnus-summary-kill-same-subject-and-select}).
4030
4031 @item M K
4032 @itemx C-k
4033 @kindex M K (Summary)
4034 @kindex C-k (Summary)
4035 @findex gnus-summary-kill-same-subject
4036 Mark all articles that have the same subject as the current one as read
4037 (@code{gnus-summary-kill-same-subject}).  
4038
4039 @item M C
4040 @kindex M C (Summary)
4041 @findex gnus-summary-catchup
4042 Mark all unread articles as read (@code{gnus-summary-catchup}).
4043
4044 @item M C-c
4045 @kindex M C-c (Summary)
4046 @findex gnus-summary-catchup-all
4047 Mark all articles in the group as read---even the ticked and dormant
4048 articles (@code{gnus-summary-catchup-all}).
4049
4050 @item M H
4051 @kindex M H (Summary)
4052 @findex gnus-summary-catchup-to-here
4053 Catchup the current group to point
4054 (@code{gnus-summary-catchup-to-here}). 
4055
4056 @item C-w
4057 @kindex C-w (Summary)
4058 @findex gnus-summary-mark-region-as-read
4059 Mark all articles between point and mark as read
4060 (@code{gnus-summary-mark-region-as-read}). 
4061
4062 @item M V k
4063 @kindex M V k (Summary)
4064 @findex gnus-summary-kill-below
4065 Kill all articles with scores below the default score (or below the
4066 numeric prefix) (@code{gnus-summary-kill-below}).
4067
4068 @item M c
4069 @itemx M-u
4070 @kindex M c (Summary)
4071 @kindex M-u (Summary)
4072 @findex gnus-summary-clear-mark-forward
4073 Clear all readedness-marks from the current article
4074 (@code{gnus-summary-clear-mark-forward}).
4075
4076 @item M e
4077 @itemx E
4078 @kindex M e (Summary)
4079 @kindex E (Summary)
4080 @findex gnus-summary-mark-as-expirable
4081 Mark the current article as expirable
4082 (@code{gnus-summary-mark-as-expirable}).
4083
4084 @item M b
4085 @kindex M b (Summary)
4086 @findex gnus-summary-set-bookmark
4087 Set a bookmark in the current article
4088 (@code{gnus-summary-set-bookmark}).
4089
4090 @item M B
4091 @kindex M B (Summary)
4092 @findex gnus-summary-remove-bookmark
4093 Remove the bookmark from the current article
4094 (@code{gnus-summary-remove-bookmark}).
4095
4096 @item M V c
4097 @kindex M V c (Summary)
4098 @findex gnus-summary-clear-above
4099 Clear all marks from articles with scores over the default score (or
4100 over the numeric prefix) (@code{gnus-summary-clear-above}).
4101
4102 @item M V u
4103 @kindex M V u (Summary)
4104 @findex gnus-summary-tick-above
4105 Tick all articles with scores over the default score (or over the
4106 numeric prefix) (@code{gnus-summary-tick-above}).
4107
4108 @item M V m
4109 @kindex M V m (Summary)
4110 @findex gnus-summary-mark-above
4111 Prompt for a mark, and mark all articles with scores over the default
4112 score (or over the numeric prefix) with this mark
4113 (@code{gnus-summary-clear-above}).
4114 @end table
4115
4116 @vindex gnus-summary-goto-unread
4117 The @code{gnus-summary-goto-unread} variable controls what action should
4118 be taken after setting a mark.  If non-@code{nil}, point will move to
4119 the next/previous unread article.  If @code{nil}, point will just move
4120 one line up or down.  As a special case, if this variable is
4121 @code{never}, all the marking commands as well as other commands (like
4122 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4123 The default is @code{t}.
4124
4125
4126 @node Setting Process Marks
4127 @subsection Setting Process Marks
4128 @cindex setting process marks
4129
4130 @table @kbd
4131
4132 @item M P p
4133 @itemx #
4134 @kindex # (Summary)
4135 @kindex M P p (Summary)
4136 @findex gnus-summary-mark-as-processable
4137 Mark the current article with the process mark
4138 (@code{gnus-summary-mark-as-processable}). 
4139 @findex gnus-summary-unmark-as-processable
4140
4141 @item M P u 
4142 @itemx M-#
4143 @kindex M P u (Summary)
4144 @kindex M-# (Summary)
4145 Remove the process mark, if any, from the current article
4146 (@code{gnus-summary-unmark-as-processable}).
4147
4148 @item M P U
4149 @kindex M P U (Summary)
4150 @findex gnus-summary-unmark-all-processable
4151 Remove the process mark from all articles
4152 (@code{gnus-summary-unmark-all-processable}). 
4153
4154 @item M P i
4155 @kindex M P i (Summary)
4156 @findex gnus-uu-invert-processable
4157 Invert the list of process marked articles
4158 (@code{gnus-uu-invert-processable}). 
4159
4160 @item M P R
4161 @kindex M P R (Summary)
4162 @findex gnus-uu-mark-by-regexp
4163 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}). 
4164
4165 @item M P r
4166 @kindex M P r (Summary)
4167 @findex gnus-uu-mark-region
4168 Mark articles in region (@code{gnus-uu-mark-region}).
4169
4170 @item M P t
4171 @kindex M P t (Summary)
4172 @findex gnus-uu-mark-thread
4173 Mark all articles in the current (sub)thread
4174 (@code{gnus-uu-mark-thread}).
4175
4176 @item M P T
4177 @kindex M P T (Summary)
4178 @findex gnus-uu-unmark-thread
4179 Unmark all articles in the current (sub)thread
4180 (@code{gnus-uu-unmark-thread}).
4181
4182 @item M P v
4183 @kindex M P v (Summary)
4184 @findex gnus-uu-mark-over
4185 Mark all articles that have a score above the prefix argument
4186 (@code{gnus-uu-mark-over}).
4187
4188 @item M P s
4189 @kindex M P s (Summary)
4190 @findex gnus-uu-mark-series
4191 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4192
4193 @item M P S
4194 @kindex M P S (Summary)
4195 @findex gnus-uu-mark-sparse
4196 Mark all series that have already had some articles marked
4197 (@code{gnus-uu-mark-sparse}).
4198
4199 @item M P a
4200 @kindex M P a (Summary)
4201 @findex gnus-uu-mark-all
4202 Mark all articles in series order (@code{gnus-uu-mark-series}).
4203
4204 @item M P b
4205 @kindex M P b (Summary)
4206 @findex gnus-uu-mark-buffer
4207 Mark all articles in the buffer in the order they appear
4208 (@code{gnus-uu-mark-buffer}). 
4209
4210 @item M P k
4211 @kindex M P k (Summary)
4212 @findex gnus-summary-kill-process-mark
4213 Push the current process mark set onto the stack and unmark all articles
4214 (@code{gnus-summary-kill-process-mark}).
4215
4216 @item M P y
4217 @kindex M P y (Summary)
4218 @findex gnus-summary-yank-process-mark
4219 Pop the previous process mark set from the stack and restore it
4220 (@code{gnus-summary-yank-process-mark}).
4221
4222 @item M P w
4223 @kindex M P w (Summary)
4224 @findex gnus-summary-save-process-mark
4225 Push the current process mark set onto the stack
4226 (@code{gnus-summary-save-process-mark}).
4227
4228 @end table
4229
4230
4231 @node Limiting
4232 @section Limiting
4233 @cindex limiting
4234
4235 It can be convenient to limit the summary buffer to just show some
4236 subset of the articles currently in the group.  The effect most limit
4237 commands have is to remove a few (or many) articles from the summary
4238 buffer. 
4239
4240 @table @kbd
4241
4242 @item / /
4243 @itemx / s
4244 @kindex / / (Summary)
4245 @findex gnus-summary-limit-to-subject
4246 Limit the summary buffer to articles that match some subject
4247 (@code{gnus-summary-limit-to-subject}). 
4248
4249 @item / a
4250 @kindex / a (Summary)
4251 @findex gnus-summary-limit-to-author
4252 Limit the summary buffer to articles that match some author
4253 (@code{gnus-summary-limit-to-author}).
4254
4255 @item / u
4256 @itemx x
4257 @kindex / u (Summary)
4258 @kindex x (Summary)
4259 @findex gnus-summary-limit-to-unread
4260 Limit the summary buffer to articles that are not marked as read
4261 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4262 buffer to articles that are strictly unread.  This means that ticked and
4263 dormant articles will also be excluded.
4264
4265 @item / m
4266 @kindex / m (Summary)
4267 @findex gnus-summary-limit-to-marks
4268 Ask for a mark and then limit to all articles that have not been marked
4269 with that mark (@code{gnus-summary-limit-to-marks}).
4270
4271 @item / t
4272 @kindex / t (Summary)
4273 @findex gnus-summary-limit-to-age
4274 Ask for a number and then limit the summary buffer to articles that are
4275 older than (or equal to) that number of days
4276 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4277 articles that are younger than that number of days.
4278
4279 @item / n
4280 @kindex / n (Summary)
4281 @findex gnus-summary-limit-to-articles
4282 Limit the summary buffer to the current article
4283 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4284 convention (@pxref{Process/Prefix}).
4285
4286 @item / w
4287 @kindex / w (Summary)
4288 @findex gnus-summary-pop-limit
4289 Pop the previous limit off the stack and restore it
4290 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4291 the stack.
4292
4293 @item / v
4294 @kindex / v (Summary)
4295 @findex gnus-summary-limit-to-score
4296 Limit the summary buffer to articles that have a score at or above some
4297 score (@code{gnus-summary-limit-to-score}).
4298
4299 @item / E
4300 @itemx M S
4301 @kindex M S (Summary)
4302 @kindex / E (Summary)
4303 @findex gnus-summary-limit-include-expunged
4304 Display all expunged articles
4305 (@code{gnus-summary-limit-include-expunged}). 
4306
4307 @item / D
4308 @kindex / D (Summary)
4309 @findex gnus-summary-limit-include-dormant
4310 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4311
4312 @item / d
4313 @kindex / d (Summary)
4314 @findex gnus-summary-limit-exclude-dormant
4315 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4316
4317 @item / c
4318 @kindex / c (Summary)
4319 @findex gnus-summary-limit-exclude-childless-dormant
4320 Hide all dormant articles that have no children
4321 (@code{gnus-summary-limit-exclude-childless-dormant}). 
4322
4323 @item / C
4324 @kindex / C (Summary)
4325 @findex gnus-summary-limit-mark-excluded-as-read
4326 Mark all excluded unread articles as read
4327 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4328 also mark excluded ticked and dormant articles as read.
4329
4330 @end table
4331
4332
4333 @node Threading
4334 @section Threading
4335 @cindex threading
4336 @cindex article threading
4337
4338 Gnus threads articles by default.  @dfn{To thread} is to put responses
4339 to articles directly after the articles they respond to---in a
4340 hierarchical fashion.
4341
4342 @menu
4343 * Customizing Threading::     Variables you can change to affect the threading.
4344 * Thread Commands::           Thread based commands in the summary buffer.
4345 @end menu
4346
4347
4348 @node Customizing Threading
4349 @subsection Customizing Threading
4350 @cindex customizing threading
4351 @cindex <
4352 @cindex >
4353
4354 @table @code
4355
4356 @item gnus-show-threads
4357 @vindex gnus-show-threads
4358 If this variable is @code{nil}, no threading will be done, and all of
4359 the rest of the variables here will have no effect.  Turning threading
4360 off will speed group selection up a bit, but it is sure to make reading
4361 slower and more awkward.
4362
4363 @item gnus-fetch-old-headers
4364 @vindex gnus-fetch-old-headers
4365 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4366 more old headers---headers to articles that are marked as read.  If you
4367 would like to display as few summary lines as possible, but still
4368 connect as many loose threads as possible, you should set this variable
4369 to @code{some} or a number.  If you set it to a number, no more than
4370 that number of extra old headers will be fetched.  In either case,
4371 fetching old headers only works if the backend you are using carries
4372 overview files---this would normally be @code{nntp}, @code{nnspool} and
4373 @code{nnml}.  Also remember that if the root of the thread has been
4374 expired by the server, there's not much Gnus can do about that.
4375
4376 @item gnus-build-sparse-threads
4377 @vindex gnus-build-sparse-threads
4378 Fetching old headers can be slow.  A low-rent similar effect can be
4379 gotten by setting this variable to @code{some}.  Gnus will then look at
4380 the complete @code{References} headers of all articles and try to string
4381 articles that belong in the same thread together.  This will leave
4382 @dfn{gaps} in the threading display where Gnus guesses that an article
4383 is missing from the thread.  (These gaps appear like normal summary
4384 lines.  If you select a gap, Gnus will try to fetch the article in
4385 question.)  If this variable is @code{t}, Gnus will display all these
4386 ``gaps'' without regard for whether they are useful for completing the
4387 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4388 off sparse leaf nodes that don't lead anywhere.  This variable is
4389 @code{nil} by default.
4390
4391 @item gnus-summary-gather-subject-limit
4392 @vindex gnus-summary-gather-subject-limit
4393 Loose threads are gathered by comparing subjects of articles.  If this
4394 variable is @code{nil}, Gnus requires an exact match between the
4395 subjects of the loose threads before gathering them into one big
4396 super-thread.  This might be too strict a requirement, what with the
4397 presence of stupid newsreaders that chop off long subjects lines.  If
4398 you think so, set this variable to, say, 20 to require that only the
4399 first 20 characters of the subjects have to match.  If you set this
4400 variable to a really low number, you'll find that Gnus will gather
4401 everything in sight into one thread, which isn't very helpful.
4402
4403 @cindex fuzzy article gathering
4404 If you set this variable to the special value @code{fuzzy}, Gnus will
4405 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4406 Matching}). 
4407
4408 @item gnus-simplify-subject-fuzzy-regexp
4409 @vindex gnus-simplify-subject-fuzzy-regexp
4410 This can either be a regular expression or list of regular expressions
4411 that match strings that will be removed from subjects if fuzzy subject
4412 simplification is used.
4413
4414 @item gnus-simplify-ignored-prefixes
4415 @vindex gnus-simplify-ignored-prefixes
4416 If you set @code{gnus-summary-gather-subject-limit} to something as low
4417 as 10, you might consider setting this variable to something sensible:
4418
4419 @c Written by Michael Ernst <mernst@cs.rice.edu>
4420 @lisp
4421 (setq gnus-simplify-ignored-prefixes
4422       (concat 
4423        "\\`\\[?\\("
4424        (mapconcat 
4425         'identity
4426         '("looking"
4427           "wanted" "followup" "summary\\( of\\)?"
4428           "help" "query" "problem" "question" 
4429           "answer" "reference" "announce"
4430           "How can I" "How to" "Comparison of"
4431           ;; ...
4432           )
4433         "\\|")
4434        "\\)\\s *\\("
4435        (mapconcat 'identity
4436                   '("for" "for reference" "with" "about")
4437                   "\\|")
4438        "\\)?\\]?:?[ \t]*"))
4439 @end lisp
4440
4441 All words that match this regexp will be removed before comparing two
4442 subjects. 
4443
4444 @item gnus-summary-gather-exclude-subject
4445 @vindex gnus-summary-gather-exclude-subject
4446 Since loose thread gathering is done on subjects only, that might lead
4447 to many false hits, especially with certain common subjects like
4448 @samp{} and @samp{(none)}.  To make the situation slightly better,
4449 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4450 what subjects should be excluded from the gathering process.  The
4451 default is @samp{^ *$\\|^(none)$}.  
4452
4453 @item gnus-summary-thread-gathering-function
4454 @vindex gnus-summary-thread-gathering-function
4455 Gnus gathers threads by looking at @code{Subject} headers.  This means
4456 that totally unrelated articles may end up in the same ``thread'', which
4457 is confusing.  An alternate approach is to look at all the
4458 @code{Message-ID}s in all the @code{References} headers to find matches.
4459 This will ensure that no gathered threads ever includes unrelated
4460 articles, but it's also means that people who have posted with broken
4461 newsreaders won't be gathered properly.  The choice is yours---plague or
4462 cholera:
4463
4464 @table @code
4465 @item gnus-gather-threads-by-subject
4466 @findex gnus-gather-threads-by-subject
4467 This function is the default gathering function and looks at
4468 @code{Subject}s exclusively.
4469
4470 @item gnus-gather-threads-by-references
4471 @findex gnus-gather-threads-by-references
4472 This function looks at @code{References} headers exclusively.
4473 @end table
4474
4475 If you want to test gathering by @code{References}, you could say
4476 something like:
4477
4478 @lisp
4479 (setq gnus-summary-thread-gathering-function
4480       'gnus-gather-threads-by-references)
4481 @end lisp
4482
4483 @item gnus-summary-make-false-root
4484 @vindex gnus-summary-make-false-root
4485 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4486 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4487 Yup.)  Loose subtrees occur when the real root has expired, or you've
4488 read or killed the root in a previous session.
4489
4490 When there is no real root of a thread, Gnus will have to fudge
4491 something.  This variable says what fudging method Gnus should use.
4492 There are four possible values:
4493
4494 @cindex adopting articles
4495
4496 @table @code
4497
4498 @item adopt
4499 Gnus will make the first of the orphaned articles the parent.  This
4500 parent will adopt all the other articles.  The adopted articles will be
4501 marked as such by pointy brackets (@samp{<>}) instead of the standard
4502 square brackets (@samp{[]}).  This is the default method.
4503
4504 @item dummy
4505 @vindex gnus-summary-dummy-line-format
4506 Gnus will create a dummy summary line that will pretend to be the
4507 parent.  This dummy line does not correspond to any real article, so
4508 selecting it will just select the first real article after the dummy
4509 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4510 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4511 which is the subject of the article.  @xref{Formatting Variables}.
4512
4513 @item empty
4514 Gnus won't actually make any article the parent, but simply leave the
4515 subject field of all orphans except the first empty.  (Actually, it will
4516 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4517 Buffer Format}).)
4518
4519 @item none
4520 Don't make any article parent at all.  Just gather the threads and
4521 display them after one another.
4522
4523 @item nil
4524 Don't gather loose threads.
4525 @end table
4526
4527 @item gnus-thread-hide-subtree
4528 @vindex gnus-thread-hide-subtree
4529 If non-@code{nil}, all threads will be hidden when the summary buffer is
4530 generated.
4531
4532 @item gnus-thread-expunge-below
4533 @vindex gnus-thread-expunge-below
4534 All threads that have a total score (as defined by
4535 @code{gnus-thread-score-function}) less than this number will be
4536 expunged.  This variable is @code{nil} by default, which means that no
4537 threads are expunged.
4538
4539 @item gnus-thread-hide-killed
4540 @vindex gnus-thread-hide-killed
4541 if you kill a thread and this variable is non-@code{nil}, the subtree
4542 will be hidden.
4543
4544 @item gnus-thread-ignore-subject
4545 @vindex gnus-thread-ignore-subject
4546 Sometimes somebody changes the subject in the middle of a thread.  If
4547 this variable is non-@code{nil}, the subject change is ignored.  If it
4548 is @code{nil}, which is the default, a change in the subject will result
4549 in a new thread.
4550
4551 @item gnus-thread-indent-level
4552 @vindex gnus-thread-indent-level
4553 This is a number that says how much each sub-thread should be indented.
4554 The default is 4.
4555
4556 @item gnus-parse-headers-hook
4557 @vindex gnus-parse-headers-hook
4558 Hook run before parsing any headers.  The default value is
4559 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4560 slightly decoded in a hackish way.  This is likely to change in the
4561 future when Gnus becomes @sc{MIME}ified.
4562
4563 @end table
4564
4565
4566 @node Thread Commands
4567 @subsection Thread Commands
4568 @cindex thread commands
4569
4570 @table @kbd
4571
4572 @item T k
4573 @itemx M-C-k
4574 @kindex T k (Summary)
4575 @kindex M-C-k (Summary)
4576 @findex gnus-summary-kill-thread
4577 Mark all articles in the current (sub-)thread as read
4578 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4579 remove all marks instead.  If the prefix argument is negative, tick
4580 articles instead.
4581
4582 @item T l
4583 @itemx M-C-l
4584 @kindex T l (Summary)
4585 @kindex M-C-l (Summary)
4586 @findex gnus-summary-lower-thread
4587 Lower the score of the current (sub-)thread
4588 (@code{gnus-summary-lower-thread}). 
4589
4590 @item T i
4591 @kindex T i (Summary)
4592 @findex gnus-summary-raise-thread
4593 Increase the score of the current (sub-)thread
4594 (@code{gnus-summary-raise-thread}).
4595
4596 @item T #
4597 @kindex T # (Summary)
4598 @findex gnus-uu-mark-thread
4599 Set the process mark on the current (sub-)thread
4600 (@code{gnus-uu-mark-thread}).
4601
4602 @item T M-#
4603 @kindex T M-# (Summary)
4604 @findex gnus-uu-unmark-thread
4605 Remove the process mark from the current (sub-)thread
4606 (@code{gnus-uu-unmark-thread}).
4607
4608 @item T T
4609 @kindex T T (Summary)
4610 @findex gnus-summary-toggle-threads
4611 Toggle threading (@code{gnus-summary-toggle-threads}).
4612
4613 @item T s
4614 @kindex T s (Summary)
4615 @findex gnus-summary-show-thread
4616 Expose the (sub-)thread hidden under the current article, if any
4617 (@code{gnus-summary-show-thread}).
4618
4619 @item T h
4620 @kindex T h (Summary)
4621 @findex gnus-summary-hide-thread
4622 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4623
4624 @item T S
4625 @kindex T S (Summary)
4626 @findex gnus-summary-show-all-threads
4627 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4628
4629 @item T H
4630 @kindex T H (Summary)
4631 @findex gnus-summary-hide-all-threads
4632 Hide all threads (@code{gnus-summary-hide-all-threads}).
4633
4634 @item T t
4635 @kindex T t (Summary)
4636 @findex gnus-summary-rethread-current
4637 Re-thread the thread the current article is part of
4638 (@code{gnus-summary-rethread-current}).  This works even when the
4639 summary buffer is otherwise unthreaded.
4640
4641 @item T ^
4642 @kindex T ^ (Summary)
4643 @findex gnus-summary-reparent-thread
4644 Make the current article the child of the marked (or previous) article
4645 (@code{gnus-summary-reparent-thread}.
4646
4647 @end table
4648
4649 The following commands are thread movement commands.  They all
4650 understand the numeric prefix.
4651
4652 @table @kbd
4653
4654 @item T n
4655 @kindex T n (Summary)
4656 @findex gnus-summary-next-thread
4657 Go to the next thread (@code{gnus-summary-next-thread}).
4658
4659 @item T p
4660 @kindex T p (Summary)
4661 @findex gnus-summary-prev-thread
4662 Go to the previous thread (@code{gnus-summary-prev-thread}).
4663
4664 @item T d
4665 @kindex T d (Summary)
4666 @findex gnus-summary-down-thread
4667 Descend the thread (@code{gnus-summary-down-thread}).
4668
4669 @item T u
4670 @kindex T u (Summary)
4671 @findex gnus-summary-up-thread
4672 Ascend the thread (@code{gnus-summary-up-thread}).
4673
4674 @item T o
4675 @kindex T o (Summary)
4676 @findex gnus-summary-top-thread
4677 Go to the top of the thread (@code{gnus-summary-top-thread}).
4678 @end table
4679
4680 @vindex gnus-thread-operation-ignore-subject 
4681 If you ignore subject while threading, you'll naturally end up with
4682 threads that have several different subjects in them.  If you then issue
4683 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4684 wish to kill the entire thread, but just those parts of the thread that
4685 have the same subject as the current article.  If you like this idea,
4686 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If is
4687 is non-@code{nil} (which it is by default), subjects will be ignored
4688 when doing thread commands.  If this variable is @code{nil}, articles in
4689 the same thread with different subjects will not be included in the
4690 operation in question.  If this variable is @code{fuzzy}, only articles
4691 that have subjects that are fuzzily equal will be included (@pxref{Fuzzy
4692 Matching}).
4693
4694
4695 @node Sorting
4696 @section Sorting
4697
4698 @findex gnus-thread-sort-by-total-score
4699 @findex gnus-thread-sort-by-date
4700 @findex gnus-thread-sort-by-score
4701 @findex gnus-thread-sort-by-subject
4702 @findex gnus-thread-sort-by-author
4703 @findex gnus-thread-sort-by-number
4704 @vindex gnus-thread-sort-functions
4705 If you are using a threaded summary display, you can sort the threads by
4706 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4707 By default, sorting is done on article numbers.  Ready-made sorting
4708 predicate functions include @code{gnus-thread-sort-by-number},
4709 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4710 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4711 @code{gnus-thread-sort-by-total-score}.
4712
4713 Each function takes two threads and return non-@code{nil} if the first
4714 thread should be sorted before the other.  Note that sorting really is
4715 normally done by looking only at the roots of each thread.  If you use
4716 more than one function, the primary sort key should be the last function
4717 in the list.  You should probably always include
4718 @code{gnus-thread-sort-by-number} in the list of sorting
4719 functions---preferably first.  This will ensure that threads that are
4720 equal with respect to the other sort criteria will be displayed in
4721 ascending article order.
4722
4723 If you would like to sort by score, then by subject, and finally by
4724 number, you could do something like:
4725
4726 @lisp
4727 (setq gnus-thread-sort-functions 
4728       '(gnus-thread-sort-by-number
4729         gnus-thread-sort-by-subject
4730         gnus-thread-sort-by-score))
4731 @end lisp
4732
4733 The threads that have highest score will be displayed first in the
4734 summary buffer.  When threads have the same score, they will be sorted
4735 alphabetically.  The threads that have the same score and the same
4736 subject will be sorted by number, which is (normally) the sequence in
4737 which the articles arrived.
4738
4739 If you want to sort by score and then reverse arrival order, you could
4740 say something like:
4741
4742 @lisp
4743 (setq gnus-thread-sort-functions
4744       '((lambda (t1 t2) 
4745           (not (gnus-thread-sort-by-number t1 t2)))
4746         gnus-thread-sort-by-score))
4747 @end lisp
4748
4749 @vindex gnus-thread-score-function
4750 The function in the @code{gnus-thread-score-function} variable (default
4751 @code{+}) is used for calculating the total score of a thread.  Useful
4752 functions might be @code{max}, @code{min}, or squared means, or whatever
4753 tickles your fancy.
4754
4755 @findex gnus-article-sort-functions
4756 @findex gnus-article-sort-by-date
4757 @findex gnus-article-sort-by-score
4758 @findex gnus-article-sort-by-subject
4759 @findex gnus-article-sort-by-author
4760 @findex gnus-article-sort-by-number
4761 If you are using an unthreaded display for some strange reason or other,
4762 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4763 It is very similar to the @code{gnus-thread-sort-functions}, except that
4764 is uses slightly different functions for article comparison.  Available
4765 sorting predicate functions are @code{gnus-article-sort-by-number},
4766 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4767 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4768
4769 If you want to sort an unthreaded summary display by subject, you could
4770 say something like:
4771
4772 @lisp
4773 (setq gnus-article-sort-functions 
4774       '(gnus-article-sort-by-number
4775         gnus-article-sort-by-subject))
4776 @end lisp
4777
4778
4779
4780 @node Asynchronous Fetching
4781 @section Asynchronous Article Fetching
4782 @cindex asynchronous article fetching
4783 @cindex article pre-fetch
4784 @cindex pre-fetch
4785
4786 If you read your news from an @sc{nntp} server that's far away, the
4787 network latencies may make reading articles a chore.  You have to wait
4788 for a while after pressing @kbd{n} to go to the next article before the
4789 article appears.  Why can't Gnus just go ahead and fetch the article
4790 while you are reading the previous one?  Why not, indeed.
4791
4792 First, some caveats.  There are some pitfalls to using asynchronous
4793 article fetching, especially the way Gnus does it.  
4794
4795 Let's say you are reading article 1, which is short, and article 2 is
4796 quite long, and you are not interested in reading that.  Gnus does not
4797 know this, so it goes ahead and fetches article 2.  You decide to read
4798 article 3, but since Gnus is in the process of fetching article 2, the
4799 connection is blocked.
4800
4801 To avoid these situations, Gnus will open two (count 'em two)
4802 connections to the server.  Some people may think this isn't a very nice
4803 thing to do, but I don't see any real alternatives.  Setting up that
4804 extra connection takes some time, so Gnus startup will be slower.
4805
4806 Gnus will fetch more articles than you will read.  This will mean that
4807 the link between your machine and the @sc{nntp} server will become more
4808 loaded than if you didn't use article pre-fetch.  The server itself will
4809 also become more loaded---both with the extra article requests, and the
4810 extra connection.
4811
4812 Ok, so now you know that you shouldn't really use this thing...  unless
4813 you really want to.
4814
4815 @vindex gnus-asynchronous
4816 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4817 happen automatically.
4818
4819 @vindex gnus-use-article-prefetch
4820 You can control how many articles that are to be pre-fetched by setting
4821 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4822 that when you read an article in the group, the backend will pre-fetch
4823 the next 30 articles.  If this variable is @code{t}, the backend will
4824 pre-fetch all the articles that it can without bound.  If it is
4825 @code{nil}, no pre-fetching will be made.
4826
4827 @vindex gnus-async-prefetch-article-p
4828 @findex gnus-async-read-p
4829 There are probably some articles that you don't want to pre-fetch---read
4830 articles, for instance.  Which articles to pre-fetch is controlled by
4831 the @code{gnus-async-prefetch-article-p} variable.  This function should
4832 return non-@code{nil} when the article in question is to be
4833 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4834 @code{nil} on read articles.  The function is called with an article
4835 data structure as the only parameter.
4836
4837 If, for instance, you wish to pre-fetch only unread articles that are
4838 shorter than 100 lines, you could say something like:
4839
4840 @lisp
4841 (defun my-async-short-unread-p (data)
4842   "Return non-nil for short, unread articles."
4843   (and (gnus-data-unread-p data)
4844        (< (mail-header-lines (gnus-data-header data))
4845           100)))
4846
4847 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4848 @end lisp
4849
4850 These functions will be called many, many times, so they should
4851 preferrably be short and sweet to avoid slowing down Gnus too much.
4852 It's also probably a good idea to byte-compile things like this.
4853
4854 @vindex gnus-prefetched-article-deletion-strategy
4855 Articles have to be removed from the asynch buffer sooner or later.  The
4856 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4857 articles.  This is a list that may contain the following elements:
4858
4859 @table @code
4860 @item read
4861 Remove articles when they are read.
4862
4863 @item exit
4864 Remove articles when exiting the group.
4865 @end table
4866
4867 The default value is @code{(read exit)}.
4868
4869 @vindex gnus-use-header-prefetch
4870 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4871 from the next group.
4872
4873
4874 @node Article Caching
4875 @section Article Caching
4876 @cindex article caching
4877 @cindex caching
4878
4879 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4880 consider turning article caching on.  Each article will then be stored
4881 locally under your home directory.  As you may surmise, this could
4882 potentially use @emph{huge} amounts of disk space, as well as eat up all
4883 your inodes so fast it will make your head swim.  In vodka.
4884
4885 Used carefully, though, it could be just an easier way to save articles.
4886
4887 @vindex gnus-use-long-file-name
4888 @vindex gnus-cache-directory
4889 @vindex gnus-use-cache
4890 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4891 all articles that are ticked or marked as dormant will then be copied
4892 over to your local cache (@code{gnus-cache-directory}).  Whether this
4893 cache is flat or hierarchal is controlled by the
4894 @code{gnus-use-long-file-name} variable, as usual.
4895
4896 When re-select a ticked or dormant article, it will be fetched from the
4897 cache instead of from the server.  As articles in your cache will never
4898 expire, this might serve as a method of saving articles while still
4899 keeping them where they belong.  Just mark all articles you want to save
4900 as dormant, and don't worry.
4901
4902 When an article is marked as read, is it removed from the cache.
4903
4904 @vindex gnus-cache-remove-articles
4905 @vindex gnus-cache-enter-articles
4906 The entering/removal of articles from the cache is controlled by the
4907 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4908 variables.  Both are lists of symbols.  The first is @code{(ticked
4909 dormant)} by default, meaning that ticked and dormant articles will be
4910 put in the cache.  The latter is @code{(read)} by default, meaning that
4911 articles that are marked as read are removed from the cache.  Possibly
4912 symbols in these two lists are @code{ticked}, @code{dormant},
4913 @code{unread} and @code{read}.
4914
4915 @findex gnus-jog-cache
4916 So where does the massive article-fetching and storing come into the
4917 picture?  The @code{gnus-jog-cache} command will go through all
4918 subscribed newsgroups, request all unread articles, and store them in
4919 the cache.  You should only ever, ever ever ever, use this command if 1)
4920 your connection to the @sc{nntp} server is really, really, really slow
4921 and 2) you have a really, really, really huge disk.  Seriously.
4922
4923 @vindex gnus-uncacheable-groups
4924 It is likely that you do not want caching on some groups.  For instance,
4925 if your @code{nnml} mail is located under your home directory, it makes no
4926 sense to cache it somewhere else under your home directory.  Unless you
4927 feel that it's neat to use twice as much space.  To limit the caching,
4928 you could set the @code{gnus-uncacheable-groups} regexp to
4929 @samp{^nnml}, for instance.  This variable is @code{nil} by
4930 default.
4931
4932 @findex gnus-cache-generate-nov-databases
4933 @findex gnus-cache-generate-active
4934 @vindex gnus-cache-active-file
4935 The cache stores information on what articles it contains in its active
4936 file (@code{gnus-cache-active-file}).  If this file (or any other parts
4937 of the cache) becomes all messed up for some reason or other, Gnus
4938 offers two functions that will try to set things right.  @kbd{M-x
4939 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4940 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4941 file.
4942
4943
4944 @node Persistent Articles
4945 @section Persistent Articles
4946 @cindex persistent articles
4947
4948 Closely related to article caching, we have @dfn{persistent articles}.
4949 In fact, it's just a different way of looking at caching, and much more
4950 useful in my opinion.
4951
4952 Say you're reading a newsgroup, and you happen on to some valuable gem
4953 that you want to keep and treasure forever.  You'd normally just save it
4954 (using one of the many saving commands) in some file.  The problem with
4955 that is that it's just, well, yucky.  Ideally you'd prefer just having
4956 the article remain in the group where you found it forever; untouched by
4957 the expiry going on at the news server.
4958
4959 This is what a @dfn{persistent article} is---an article that just won't
4960 be deleted.  It's implemented using the normal cache functions, but
4961 you use two explicit commands for managing persistent articles:
4962
4963 @table @kbd
4964
4965 @item *
4966 @kindex * (Summary)
4967 @findex gnus-cache-enter-article
4968 Make the current article persistent (@code{gnus-cache-enter-article}). 
4969
4970 @item M-*
4971 @kindex M-* (Summary)
4972 @findex gnus-cache-remove-article
4973 Remove the current article from the persistent articles
4974 (@code{gnus-cache-remove-article}).  This will normally delete the
4975 article. 
4976 @end table
4977
4978 Both these commands understand the process/prefix convention. 
4979
4980 To avoid having all ticked articles (and stuff) entered into the cache,
4981 you should set @code{gnus-use-cache} to @code{passive} if you're just
4982 interested in persistent articles:
4983
4984 @lisp
4985 (setq gnus-use-cache 'passive)
4986 @end lisp
4987
4988
4989 @node Article Backlog
4990 @section Article Backlog
4991 @cindex backlog
4992 @cindex article backlog
4993
4994 If you have a slow connection, but the idea of using caching seems
4995 unappealing to you (and it is, really), you can help the situation some
4996 by switching on the @dfn{backlog}.  This is where Gnus will buffer
4997 already read articles so that it doesn't have to re-fetch articles
4998 you've already read.  This only helps if you are in the habit of
4999 re-selecting articles you've recently read, of course.  If you never do
5000 that, turning the backlog on will slow Gnus down a little bit, and
5001 increase memory usage some.
5002
5003 @vindex gnus-keep-backlog
5004 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5005 at most @var{n} old articles in a buffer for later re-fetching.  If this
5006 variable is non-@code{nil} and is not a number, Gnus will store
5007 @emph{all} read articles, which means that your Emacs will grow without
5008 bound before exploding and taking your machine down with you.  I put
5009 that in there just to keep y'all on your toes.  
5010
5011 This variable is @code{nil} by default.
5012
5013
5014 @node Saving Articles
5015 @section Saving Articles
5016 @cindex saving articles
5017
5018 Gnus can save articles in a number of ways.  Below is the documentation
5019 for saving articles in a fairly straight-forward fashion (i.e., little
5020 processing of the article is done before it is saved).  For a different
5021 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5022 (@pxref{Decoding Articles}).
5023
5024 @vindex gnus-save-all-headers
5025 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5026 unwanted headers before saving the article.
5027
5028 @vindex gnus-saved-headers
5029 If the preceding variable is @code{nil}, all headers that match the
5030 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5031 deleted before saving.
5032
5033 @table @kbd
5034
5035 @item O o
5036 @itemx o
5037 @kindex O o (Summary)
5038 @kindex o (Summary)
5039 @findex gnus-summary-save-article
5040 Save the current article using the default article saver
5041 (@code{gnus-summary-save-article}). 
5042
5043 @item O m
5044 @kindex O m (Summary)
5045 @findex gnus-summary-save-article-mail
5046 Save the current article in mail format
5047 (@code{gnus-summary-save-article-mail}). 
5048
5049 @item O r
5050 @kindex O r (Summary)
5051 @findex gnus-summary-save-article-rmail
5052 Save the current article in rmail format
5053 (@code{gnus-summary-save-article-rmail}). 
5054
5055 @item O f
5056 @kindex O f (Summary)
5057 @findex gnus-summary-save-article-file
5058 Save the current article in plain file format
5059 (@code{gnus-summary-save-article-file}). 
5060
5061 @item O F
5062 @kindex O F (Summary)
5063 @findex gnus-summary-write-article-file
5064 Write the current article in plain file format, overwriting any previous
5065 file contents (@code{gnus-summary-write-article-file}). 
5066
5067 @item O b
5068 @kindex O b (Summary)
5069 @findex gnus-summary-save-article-body-file
5070 Save the current article body in plain file format
5071 (@code{gnus-summary-save-article-body-file}). 
5072
5073 @item O h
5074 @kindex O h (Summary)
5075 @findex gnus-summary-save-article-folder
5076 Save the current article in mh folder format
5077 (@code{gnus-summary-save-article-folder}). 
5078
5079 @item O v
5080 @kindex O v (Summary)
5081 @findex gnus-summary-save-article-vm
5082 Save the current article in a VM folder
5083 (@code{gnus-summary-save-article-vm}).
5084
5085 @item O p
5086 @kindex O p (Summary)
5087 @findex gnus-summary-pipe-output
5088 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5089 the current article to a process (@code{gnus-summary-pipe-output}).
5090 @end table
5091
5092 @vindex gnus-prompt-before-saving
5093 All these commands use the process/prefix convention
5094 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5095 functions, you might get tired of being prompted for files to save each
5096 and every article in.  The prompting action is controlled by
5097 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5098 default, giving you that excessive prompting action you know and
5099 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5100 just once for each series of articles you save.  If you like to really
5101 have Gnus do all your thinking for you, you can even set this variable
5102 to @code{nil}, which means that you will never be prompted for files to
5103 save articles in.  Gnus will simply save all the articles in the default
5104 files. 
5105
5106
5107 @vindex gnus-default-article-saver
5108 You can customize the @code{gnus-default-article-saver} variable to make
5109 Gnus do what you want it to.  You can use any of the four ready-made
5110 functions below, or you can create your own.
5111
5112 @table @code
5113
5114 @item gnus-summary-save-in-rmail
5115 @findex gnus-summary-save-in-rmail
5116 @vindex gnus-rmail-save-name
5117 @findex gnus-plain-save-name
5118 This is the default format, @dfn{babyl}.  Uses the function in the
5119 @code{gnus-rmail-save-name} variable to get a file name to save the
5120 article in.  The default is @code{gnus-plain-save-name}.
5121
5122 @item gnus-summary-save-in-mail
5123 @findex gnus-summary-save-in-mail
5124 @vindex gnus-mail-save-name
5125 Save in a Unix mail (mbox) file.  Uses the function in the
5126 @code{gnus-mail-save-name} variable to get a file name to save the
5127 article in.  The default is @code{gnus-plain-save-name}.
5128
5129 @item gnus-summary-save-in-file
5130 @findex gnus-summary-save-in-file
5131 @vindex gnus-file-save-name
5132 @findex gnus-numeric-save-name
5133 Append the article straight to an ordinary file.  Uses the function in
5134 the @code{gnus-file-save-name} variable to get a file name to save the
5135 article in.  The default is @code{gnus-numeric-save-name}.
5136
5137 @item gnus-summary-save-body-in-file
5138 @findex gnus-summary-save-body-in-file
5139 Append the article body to an ordinary file.  Uses the function in the
5140 @code{gnus-file-save-name} variable to get a file name to save the
5141 article in.  The default is @code{gnus-numeric-save-name}.
5142
5143 @item gnus-summary-save-in-folder
5144 @findex gnus-summary-save-in-folder
5145 @findex gnus-folder-save-name
5146 @findex gnus-Folder-save-name
5147 @vindex gnus-folder-save-name
5148 @cindex rcvstore
5149 @cindex MH folders
5150 Save the article to an MH folder using @code{rcvstore} from the MH
5151 library.  Uses the function in the @code{gnus-folder-save-name} variable
5152 to get a file name to save the article in.  The default is
5153 @code{gnus-folder-save-name}, but you can also use
5154 @code{gnus-Folder-save-name}.  The former creates capitalized names, and
5155 the latter does not.
5156
5157 @item gnus-summary-save-in-vm
5158 @findex gnus-summary-save-in-vm
5159 Save the article in a VM folder.  You have to have the VM mail
5160 reader to use this setting.
5161 @end table
5162
5163 @vindex gnus-article-save-directory
5164 All of these functions, except for the last one, will save the article
5165 in the @code{gnus-article-save-directory}, which is initialized from the
5166 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5167 default. 
5168
5169 As you can see above, the functions use different functions to find a
5170 suitable name of a file to save the article in.  Below is a list of
5171 available functions that generate names:
5172
5173 @table @code
5174
5175 @item gnus-Numeric-save-name
5176 @findex gnus-Numeric-save-name
5177 File names like @file{~/News/Alt.andrea-dworkin/45}.
5178
5179 @item gnus-numeric-save-name
5180 @findex gnus-numeric-save-name
5181 File names like @file{~/News/alt.andrea-dworkin/45}.
5182
5183 @item gnus-Plain-save-name
5184 @findex gnus-Plain-save-name
5185 File names like @file{~/News/Alt.andrea-dworkin}.
5186
5187 @item gnus-plain-save-name
5188 @findex gnus-plain-save-name
5189 File names like @file{~/News/alt.andrea-dworkin}.
5190 @end table
5191
5192 @vindex gnus-split-methods
5193 You can have Gnus suggest where to save articles by plonking a regexp into
5194 the @code{gnus-split-methods} alist.  For instance, if you would like to
5195 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5196 related to VM in @code{vm-stuff}, you could set this variable to something
5197 like:
5198
5199 @lisp
5200 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5201  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5202  (my-choosing-function "../other-dir/my-stuff")
5203  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5204 @end lisp
5205
5206 We see that this is a list where each element is a list that has two
5207 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5208 a string (in which case it is used as a regexp to match on the article
5209 head); it can be a symbol (which will be called as a function with the
5210 group name as a parameter); or it can be a list (which will be
5211 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5212 the @dfn{file} will be used as a default prompt.  In addition, the
5213 result of the operation itself will be used if the function or form
5214 called returns a string or a list of strings.
5215
5216 You basically end up with a list of file names that might be used when
5217 saving the current article.  (All ``matches'' will be used.)  You will
5218 then be prompted for what you really want to use as a name, with file
5219 name completion over the results from applying this variable.
5220
5221 This variable is @code{((gnus-article-archive-name))} by default, which
5222 means that Gnus will look at the articles it saves for an
5223 @code{Archive-name} line and use that as a suggestion for the file
5224 name. 
5225
5226 @vindex gnus-use-long-file-name
5227 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5228 @code{nil}, all the preceding functions will replace all periods
5229 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5230 the functions will generate hierarchies of directories instead of having
5231 all the files in the toplevel directory
5232 (@file{~/News/alt/andrea-dworkin} instead of
5233 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5234 on most systems.  However, for historical reasons, this is @code{nil} on
5235 Xenix and usg-unix-v machines by default.
5236
5237 This function also affects kill and score file names.  If this variable
5238 is a list, and the list contains the element @code{not-score}, long file
5239 names will not be used for score files, if it contains the element
5240 @code{not-save}, long file names will not be used for saving, and if it
5241 contains the element @code{not-kill}, long file names will not be used
5242 for kill files.
5243
5244 If you'd like to save articles in a hierarchy that looks something like
5245 a spool, you could
5246
5247 @lisp
5248 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5249 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5250 @end lisp
5251
5252 Then just save with @kbd{o}.  You'd then read this hierarchy with
5253 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5254 the toplevel directory as the argument (@file{~/News/}).  Then just walk
5255 around to the groups/directories with @code{nneething}.
5256
5257
5258 @node Decoding Articles
5259 @section Decoding Articles
5260 @cindex decoding articles
5261
5262 Sometime users post articles (or series of articles) that have been
5263 encoded in some way or other.  Gnus can decode them for you.
5264
5265 @menu 
5266 * Uuencoded Articles::    Uudecode articles.
5267 * Shared Articles::       Unshar articles.
5268 * PostScript Files::      Split PostScript.
5269 * Decoding Variables::    Variables for a happy decoding.
5270 * Viewing Files::         You want to look at the result of the decoding?
5271 @end menu
5272
5273 All these functions use the process/prefix convention
5274 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5275 the extension that a ``single article'' means ``a single series''.  Gnus
5276 can find out by itself what articles belong to a series, decode all the
5277 articles and unpack/view/save the resulting file(s).
5278
5279 Gnus guesses what articles are in the series according to the following
5280 simplish rule: The subjects must be (nearly) identical, except for the
5281 last two numbers of the line.  (Spaces are largely ignored, however.)
5282
5283 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5284 will find all the articles that match the regexp @samp{^cat.gif
5285 ([0-9]+/[0-9]+).*$}.  
5286
5287 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5288 series}, will not be properly recognized by any of the automatic viewing
5289 commands, and you have to mark the articles manually with @kbd{#}.
5290
5291
5292 @node Uuencoded Articles
5293 @subsection Uuencoded Articles
5294 @cindex uudecode
5295 @cindex uuencoded articles
5296
5297 @table @kbd
5298
5299 @item X u
5300 @kindex X u (Summary)
5301 @findex gnus-uu-decode-uu
5302 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5303
5304 @item X U
5305 @kindex X U (Summary)
5306 @findex gnus-uu-decode-uu-and-save
5307 Uudecodes and saves the current series
5308 (@code{gnus-uu-decode-uu-and-save}).
5309
5310 @item X v u
5311 @kindex X v u (Summary)
5312 @findex gnus-uu-decode-uu-view
5313 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5314
5315 @item X v U
5316 @kindex X v U (Summary)
5317 @findex gnus-uu-decode-uu-and-save-view
5318 Uudecodes, views and saves the current series
5319 (@code{gnus-uu-decode-uu-and-save-view}). 
5320 @end table
5321
5322 Remember that these all react to the presence of articles marked with
5323 the process mark.  If, for instance, you'd like to decode and save an
5324 entire newsgroup, you'd typically do @kbd{M P a}
5325 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5326 (@code{gnus-uu-decode-uu-and-save}).
5327
5328 All this is very much different from how @code{gnus-uu} worked with
5329 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5330 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5331 articles in some way (@pxref{Setting Process Marks}) and then press
5332 @kbd{X u}.
5333
5334 @vindex gnus-uu-notify-files
5335 Note: When trying to decode articles that have names matching
5336 @code{gnus-uu-notify-files}, which is hard-coded to
5337 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5338 automatically post an article on @samp{comp.unix.wizards} saying that
5339 you have just viewed the file in question.  This feature can't be turned
5340 off.
5341
5342
5343 @node Shared Articles
5344 @subsection Shared Articles
5345 @cindex unshar
5346 @cindex shared articles
5347
5348 @table @kbd
5349
5350 @item X s
5351 @kindex X s (Summary)
5352 @findex gnus-uu-decode-unshar
5353 Unshars the current series (@code{gnus-uu-decode-unshar}).
5354
5355 @item X S
5356 @kindex X S (Summary)
5357 @findex gnus-uu-decode-unshar-and-save
5358 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5359
5360 @item X v s
5361 @kindex X v s (Summary)
5362 @findex gnus-uu-decode-unshar-view
5363 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5364
5365 @item X v S
5366 @kindex X v S (Summary)
5367 @findex gnus-uu-decode-unshar-and-save-view
5368 Unshars, views and saves the current series
5369 (@code{gnus-uu-decode-unshar-and-save-view}). 
5370 @end table
5371
5372
5373 @node PostScript Files
5374 @subsection PostScript Files
5375 @cindex PostScript
5376
5377 @table @kbd
5378
5379 @item X p
5380 @kindex X p (Summary)
5381 @findex gnus-uu-decode-postscript
5382 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5383
5384 @item X P
5385 @kindex X P (Summary)
5386 @findex gnus-uu-decode-postscript-and-save
5387 Unpack and save the current PostScript series
5388 (@code{gnus-uu-decode-postscript-and-save}).
5389
5390 @item X v p
5391 @kindex X v p (Summary)
5392 @findex gnus-uu-decode-postscript-view
5393 View the current PostScript series
5394 (@code{gnus-uu-decode-postscript-view}).
5395
5396 @item X v P
5397 @kindex X v P (Summary)
5398 @findex gnus-uu-decode-postscript-and-save-view
5399 View and save the current PostScript series
5400 (@code{gnus-uu-decode-postscript-and-save-view}). 
5401 @end table
5402
5403
5404 @node Decoding Variables
5405 @subsection Decoding Variables
5406
5407 Adjective, not verb.
5408
5409 @menu 
5410 * Rule Variables::          Variables that say how a file is to be viewed.
5411 * Other Decode Variables::  Other decode variables.
5412 * Uuencoding and Posting::  Variables for customizing uuencoding.
5413 @end menu
5414
5415
5416 @node Rule Variables
5417 @subsubsection Rule Variables
5418 @cindex rule variables
5419
5420 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5421 variables are on the form
5422   
5423 @lisp
5424       (list '(regexp1 command2)
5425             '(regexp2 command2)
5426             ...)
5427 @end lisp
5428
5429 @table @code
5430
5431 @item gnus-uu-user-view-rules
5432 @vindex gnus-uu-user-view-rules
5433 @cindex sox
5434 This variable is consulted first when viewing files.  If you wish to use,
5435 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5436 say something like:
5437 @lisp
5438 (setq gnus-uu-user-view-rules
5439       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5440 @end lisp
5441
5442 @item gnus-uu-user-view-rules-end
5443 @vindex gnus-uu-user-view-rules-end
5444 This variable is consulted if Gnus couldn't make any matches from the
5445 user and default view rules.
5446
5447 @item gnus-uu-user-archive-rules
5448 @vindex gnus-uu-user-archive-rules
5449 This variable can be used to say what commands should be used to unpack
5450 archives.
5451 @end table
5452
5453
5454 @node Other Decode Variables
5455 @subsubsection Other Decode Variables
5456
5457 @table @code
5458 @vindex gnus-uu-grabbed-file-functions
5459
5460 @item gnus-uu-grabbed-file-functions
5461 All functions in this list will be called right each file has been
5462 successfully decoded---so that you can move or view files right away,
5463 and don't have to wait for all files to be decoded before you can do
5464 anything.  Ready-made functions you can put in this list are:
5465
5466 @table @code
5467
5468 @item gnus-uu-grab-view
5469 @findex gnus-uu-grab-view
5470 View the file.
5471
5472 @item gnus-uu-grab-move
5473 @findex gnus-uu-grab-move
5474 Move the file (if you're using a saving function.)
5475 @end table
5476
5477 @item gnus-uu-be-dangerous
5478 @vindex gnus-uu-be-dangerous
5479 Specifies what to do if unusual situations arise during decoding.  If
5480 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5481 that didn't work, and overwrite existing files.  Otherwise, ask each
5482 time.
5483
5484 @item gnus-uu-ignore-files-by-name
5485 @vindex gnus-uu-ignore-files-by-name
5486 Files with name matching this regular expression won't be viewed.
5487
5488 @item gnus-uu-ignore-files-by-type
5489 @vindex gnus-uu-ignore-files-by-type
5490 Files with a @sc{mime} type matching this variable won't be viewed.
5491 Note that Gnus tries to guess what type the file is based on the name.
5492 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5493 kludgey.
5494
5495 @item gnus-uu-tmp-dir
5496 @vindex gnus-uu-tmp-dir
5497 Where @code{gnus-uu} does its work.
5498
5499 @item gnus-uu-do-not-unpack-archives
5500 @vindex gnus-uu-do-not-unpack-archives
5501 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5502 looking for files to display.
5503
5504 @item gnus-uu-view-and-save
5505 @vindex gnus-uu-view-and-save
5506 Non-@code{nil} means that the user will always be asked to save a file
5507 after viewing it.
5508
5509 @item gnus-uu-ignore-default-view-rules
5510 @vindex gnus-uu-ignore-default-view-rules
5511 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5512 rules.
5513
5514 @item gnus-uu-ignore-default-archive-rules
5515 @vindex gnus-uu-ignore-default-archive-rules
5516 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5517 unpacking commands.
5518
5519 @item gnus-uu-kill-carriage-return
5520 @vindex gnus-uu-kill-carriage-return
5521 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5522 from articles.
5523
5524 @item gnus-uu-unmark-articles-not-decoded
5525 @vindex gnus-uu-unmark-articles-not-decoded
5526 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5527 unsuccessfully decoded as unread.
5528
5529 @item gnus-uu-correct-stripped-uucode
5530 @vindex gnus-uu-correct-stripped-uucode
5531 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5532 uuencoded files that have had trailing spaces deleted.
5533
5534 @item gnus-uu-view-with-metamail
5535 @vindex gnus-uu-view-with-metamail
5536 @cindex metamail
5537 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5538 commands defined by the rule variables and just fudge a @sc{mime}
5539 content type based on the file name.  The result will be fed to
5540 @code{metamail} for viewing.
5541
5542 @item gnus-uu-save-in-digest
5543 @vindex gnus-uu-save-in-digest
5544 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5545 decoding, will save in digests.  If this variable is @code{nil},
5546 @code{gnus-uu} will just save everything in a file without any
5547 embellishments.  The digesting almost conforms to RFC1153---no easy way
5548 to specify any meaningful volume and issue numbers were found, so I
5549 simply dropped them.
5550
5551 @end table
5552
5553
5554 @node Uuencoding and Posting
5555 @subsubsection Uuencoding and Posting
5556
5557 @table @code
5558
5559 @item gnus-uu-post-include-before-composing
5560 @vindex gnus-uu-post-include-before-composing
5561 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5562 before you compose the article.  If this variable is @code{t}, you can
5563 either include an encoded file with @kbd{C-c C-i} or have one included
5564 for you when you post the article.
5565
5566 @item gnus-uu-post-length
5567 @vindex gnus-uu-post-length
5568 Maximum length of an article.  The encoded file will be split into how
5569 many articles it takes to post the entire file.
5570
5571 @item gnus-uu-post-threaded
5572 @vindex gnus-uu-post-threaded
5573 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5574 thread.  This may not be smart, as no other decoder I have seen are able
5575 to follow threads when collecting uuencoded articles.  (Well, I have
5576 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5577 think that counts...) Default is @code{nil}.
5578
5579 @item gnus-uu-post-separate-description
5580 @vindex gnus-uu-post-separate-description
5581 Non-@code{nil} means that the description will be posted in a separate
5582 article.  The first article will typically be numbered (0/x).  If this
5583 variable is @code{nil}, the description the user enters will be included
5584 at the beginning of the first article, which will be numbered (1/x).
5585 Default is @code{t}.
5586
5587 @end table
5588
5589
5590 @node Viewing Files
5591 @subsection Viewing Files
5592 @cindex viewing files
5593 @cindex pseudo-articles
5594
5595 After decoding, if the file is some sort of archive, Gnus will attempt
5596 to unpack the archive and see if any of the files in the archive can be
5597 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5598 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5599 uncompress and de-tar the main file, and then view the two pictures.
5600 This unpacking process is recursive, so if the archive contains archives
5601 of archives, it'll all be unpacked.
5602
5603 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5604 extracted file into the summary buffer.  If you go to these
5605 ``articles'', you will be prompted for a command to run (usually Gnus
5606 will make a suggestion), and then the command will be run.
5607
5608 @vindex gnus-view-pseudo-asynchronously
5609 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5610 until the viewing is done before proceeding.
5611
5612 @vindex gnus-view-pseudos
5613 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5614 the pseudo-articles into the summary buffer, but view them
5615 immediately.  If this variable is @code{not-confirm}, the user won't even
5616 be asked for a confirmation before viewing is done.
5617
5618 @vindex gnus-view-pseudos-separately 
5619 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5620 pseudo-article will be created for each file to be viewed.  If
5621 @code{nil}, all files that use the same viewing command will be given as
5622 a list of parameters to that command.
5623
5624 @vindex gnus-insert-pseudo-articles
5625 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5626 pseudo-articles when decoding.  It is @code{t} by default.
5627
5628 So; there you are, reading your @emph{pseudo-articles} in your
5629 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5630 Why isn't anything real anymore? How did we get here?
5631
5632
5633 @node Article Treatment
5634 @section Article Treatment
5635
5636 Reading through this huge manual, you may have quite forgotten that the
5637 object of newsreaders are to actually, like, read what people have
5638 written.  Reading articles.  Unfortunately, people are quite bad at
5639 writing, so there are tons of functions and variables to make reading
5640 these articles easier.
5641
5642 @menu
5643 * Article Highlighting::    You want to make the article look like fruit salad.
5644 * Article Fontisizing::     Making emphasized text look niced.
5645 * Article Hiding::          You also want to make certain info go away.
5646 * Article Washing::         Lots of way-neat functions to make life better.
5647 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5648 * Article Date::            Grumble, UT!
5649 * Article Signature::       What is a signature?
5650 @end menu
5651
5652
5653 @node Article Highlighting
5654 @subsection Article Highlighting
5655 @cindex highlight
5656
5657 Not only do you want your article buffer to look like fruit salad, but
5658 you want it to look like technicolor fruit salad.
5659
5660 @table @kbd
5661
5662 @item W H a
5663 @kindex W H a (Summary)
5664 @findex gnus-article-highlight
5665 Highlight the current article (@code{gnus-article-highlight}).
5666
5667 @item W H h
5668 @kindex W H h (Summary)
5669 @findex gnus-article-highlight-headers
5670 @vindex gnus-header-face-alist
5671 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5672 highlighting will be done according to the @code{gnus-header-face-alist}
5673 variable, which is a list where each element has the form @var{(regexp
5674 name content)}.  @var{regexp} is a regular expression for matching the
5675 header, @var{name} is the face used for highlighting the header name and
5676 @var{content} is the face for highlighting the header value.  The first
5677 match made will be used.  Note that @var{regexp} shouldn't have @samp{^}
5678 prepended---Gnus will add one.
5679
5680 @item W H c
5681 @kindex W H c (Summary)
5682 @findex gnus-article-highlight-citation
5683 Highlight cited text (@code{gnus-article-highlight-citation}). 
5684
5685 Some variables to customize the citation highlights:
5686
5687 @table @code
5688 @vindex gnus-cite-parse-max-size
5689
5690 @item gnus-cite-parse-max-size
5691 If the article size if bigger than this variable (which is 25000 by
5692 default), no citation highlighting will be performed.  
5693
5694 @item gnus-cite-prefix-regexp
5695 @vindex gnus-cite-prefix-regexp
5696 Regexp matching the longest possible citation prefix on a line. 
5697
5698 @item gnus-cite-max-prefix
5699 @vindex gnus-cite-max-prefix
5700 Maximum possible length for a citation prefix (default 20).
5701
5702 @item gnus-cite-face-list
5703 @vindex gnus-cite-face-list
5704 List of faces used for highlighting citations.  When there are citations
5705 from multiple articles in the same message, Gnus will try to give each
5706 citation from each article its own face.  This should make it easier to
5707 see who wrote what.
5708
5709 @item gnus-supercite-regexp
5710 @vindex gnus-supercite-regexp
5711 Regexp matching normal Supercite attribution lines.  
5712
5713 @item gnus-supercite-secondary-regexp
5714 @vindex gnus-supercite-secondary-regexp
5715 Regexp matching mangled Supercite attribution lines.
5716
5717 @item gnus-cite-minimum-match-count
5718 @vindex gnus-cite-minimum-match-count
5719 Minimum number of identical prefixes we have to see before we believe
5720 that it's a citation.
5721
5722 @item gnus-cite-attribution-prefix
5723 @vindex gnus-cite-attribution-prefix
5724 Regexp matching the beginning of an attribution line.
5725
5726 @item gnus-cite-attribution-suffix
5727 @vindex gnus-cite-attribution-suffix
5728 Regexp matching the end of an attribution line.
5729
5730 @item gnus-cite-attribution-face
5731 @vindex gnus-cite-attribution-face
5732 Face used for attribution lines.  It is merged with the face for the
5733 cited text belonging to the attribution.
5734
5735 @end table
5736
5737
5738 @item W H s
5739 @kindex W H s (Summary)
5740 @vindex gnus-signature-separator
5741 @vindex gnus-signature-face
5742 @findex gnus-article-highlight-signature
5743 Highlight the signature (@code{gnus-article-highlight-signature}).
5744 Everything after @code{gnus-signature-separator} (@pxref{Article
5745 Signature}) in an article will be considered a signature and will be
5746 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5747 default.
5748
5749 @end table
5750
5751
5752 @node Article Fontisizing
5753 @subsection Article Fontisizing
5754 @cindex emphasis
5755 @cindex article emphasis
5756
5757 @findex gnus-article-emphasize
5758 @kindex W e (Summary)
5759 People commonly add emphasis to words in news articles by writing things
5760 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5761 running the article through the @kbd{W e}
5762 (@code{gnus-article-emphasize}) command.
5763
5764 @vindex gnus-article-emphasis
5765 How the emphasis is computed is controlled by the
5766 @code{gnus-article-emphasis} variable.  This is an alist where the first
5767 element is a regular expression to be matched.  The second is a number
5768 that says what regular expression grouping used to find the entire
5769 emphasized word.  The third is a number that says what regexp grouping
5770 should be displayed and highlighted.  (The text between these two
5771 groupings will be hidden.)  The fourth is the face used for
5772 highlighting.
5773
5774 @lisp
5775 (setq gnus-article-emphasis
5776       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5777         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5778 @end lisp
5779
5780 @vindex gnus-emphasis-underline
5781 @vindex gnus-emphasis-bold
5782 @vindex gnus-emphasis-italic
5783 @vindex gnus-emphasis-underline-bold
5784 @vindex gnus-emphasis-underline-italic
5785 @vindex gnus-emphasis-bold-italic
5786 @vindex gnus-emphasis-underline-bold-italic
5787 By default, there are seven rules, and they use the following faces:
5788 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5789 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5790 @code{gnus-emphasis-underline-italic},
5791 @code{gnus-emphasis-undeline-bold}, and
5792 @code{gnus-emphasis-underline-bold-italic}.  
5793
5794 If you want to change these faces, you can either use @kbd{M-x
5795 customize}, or you can use @code{copy-face}.  For instance, if you want
5796 to make @code{gnus-emphasis-italic} use a red face instead, you could
5797 say something like:
5798
5799 @lisp
5800 (copy-face 'red 'gnus-emphasis-italic)
5801 @end lisp
5802
5803
5804 @node Article Hiding
5805 @subsection Article Hiding
5806 @cindex article hiding
5807
5808 Or rather, hiding certain things in each article.  There usually is much
5809 too much cruft in most articles.  
5810
5811 @table @kbd
5812
5813 @item W W a
5814 @kindex W W a (Summary)
5815 @findex gnus-article-hide
5816 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}). 
5817
5818 @item W W h
5819 @kindex W W h (Summary)
5820 @findex gnus-article-hide-headers
5821 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5822 Headers}. 
5823
5824 @item W W b
5825 @kindex W W b (Summary)
5826 @findex gnus-article-hide-boring-headers
5827 Hide headers that aren't particularly interesting
5828 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5829
5830 @item W W s
5831 @kindex W W s (Summary)
5832 @findex gnus-article-hide-signature
5833 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5834 Signature}. 
5835
5836 @item W W p
5837 @kindex W W p (Summary)
5838 @findex gnus-article-hide-pgp
5839 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). 
5840
5841 @item W W P
5842 @kindex W W P (Summary)
5843 @findex gnus-article-hide-pem
5844 Hide @sc{pem} (privacy enhanced messages) gruft
5845 (@code{gnus-article-hide-pem}).
5846
5847 @item W W c
5848 @kindex W W c (Summary)
5849 @findex gnus-article-hide-citation
5850 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5851 customizing the hiding:
5852
5853 @table @code
5854
5855 @item gnus-cite-hide-percentage
5856 @vindex gnus-cite-hide-percentage
5857 If the cited text is of a bigger percentage than this variable (default
5858 50), hide the cited text.
5859
5860 @item gnus-cite-hide-absolute
5861 @vindex gnus-cite-hide-absolute
5862 The cited text must be have at least this length (default 10) before it
5863 is hidden.
5864
5865 @item gnus-cited-text-button-line-format
5866 @vindex gnus-cited-text-button-line-format
5867 Gnus adds buttons show where the cited text has been hidden, and to
5868 allow toggle hiding the text.  The format of the variable is specified
5869 by this format-like variable (@pxref{Formatting Variables}).  These
5870 specs are legal:
5871
5872 @table @samp
5873 @item b
5874 Start point of the hidden text.
5875 @item e
5876 End point of the hidden text.
5877 @item l
5878 Length of the hidden text.
5879 @end table
5880
5881 @item gnus-cited-lines-visible
5882 @vindex gnus-cited-lines-visible
5883 The number of lines at the beginning of the cited text to leave shown. 
5884
5885 @end table
5886
5887 @item W W C
5888 @kindex W W C (Summary)
5889 @findex gnus-article-hide-citation-in-followups
5890 Hide cited text in articles that aren't roots
5891 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
5892 useful as an interactive command, but might be a handy function to stick
5893 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}). 
5894
5895 @end table
5896
5897 All these ``hiding'' commands are toggles, but if you give a negative
5898 prefix to these commands, they will show what they have previously
5899 hidden.  If you give a positive prefix, they will always hide.
5900
5901 Also @pxref{Article Highlighting} for further variables for
5902 citation customization.
5903
5904
5905 @node Article Washing
5906 @subsection Article Washing
5907 @cindex washing
5908 @cindex article washing
5909
5910 We call this ``article washing'' for a really good reason.  Namely, the
5911 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5912
5913 @dfn{Washing} is defined by us as ``changing something from something to
5914 something else'', but normally results in something looking better.
5915 Cleaner, perhaps.
5916
5917 @table @kbd
5918
5919 @item W l
5920 @kindex W l (Summary)
5921 @findex gnus-summary-stop-page-breaking
5922 Remove page breaks from the current article
5923 (@code{gnus-summary-stop-page-breaking}).
5924
5925 @item W r
5926 @kindex W r (Summary)
5927 @findex gnus-summary-caesar-message
5928 Do a Caesar rotate (rot13) on the article buffer
5929 (@code{gnus-summary-caesar-message}). 
5930
5931 @item W t
5932 @kindex W t (Summary)
5933 @findex gnus-summary-toggle-header
5934 Toggle whether to display all headers in the article buffer
5935 (@code{gnus-summary-toggle-header}). 
5936
5937 @item W v
5938 @kindex W v (Summary)
5939 @findex gnus-summary-verbose-header
5940 Toggle whether to display all headers in the article buffer permanently
5941 (@code{gnus-summary-verbose-header}).
5942
5943 @item W m
5944 @kindex W m (Summary)
5945 @findex gnus-summary-toggle-mime
5946 Toggle whether to run the article through @sc{mime} before displaying
5947 (@code{gnus-summary-toggle-mime}).
5948
5949 @item W o
5950 @kindex W o (Summary)
5951 @findex gnus-article-treat-overstrike
5952 Treat overstrike (@code{gnus-article-treat-overstrike}).
5953
5954 @item W w
5955 @kindex W w (Summary)
5956 @findex gnus-article-fill-cited-article
5957 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
5958 function in @code{gnus-article-display-hook}, it should be run fairly
5959 late and certainly after any highlighting.
5960
5961 You can give the command a numerical prefix to specify the width to use
5962 when filling.
5963
5964 @item W c
5965 @kindex W c (Summary)
5966 @findex gnus-article-remove-cr
5967 Remove CR (@code{gnus-article-remove-cr}).
5968
5969 @item W q
5970 @kindex W q (Summary)
5971 @findex gnus-article-de-quoted-unreadable
5972 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5973
5974 @item W f
5975 @kindex W f (Summary)
5976 @cindex x-face
5977 @findex gnus-article-display-x-face
5978 @findex gnus-article-x-face-command
5979 @vindex gnus-article-x-face-command
5980 @vindex gnus-article-x-face-too-ugly
5981 Look for and display any X-Face headers
5982 (@code{gnus-article-display-x-face}).  The command executed by this
5983 function is given by the @code{gnus-article-x-face-command} variable.
5984 If this variable is a string, this string will be executed in a
5985 sub-shell.  If it is a function, this function will be called with the
5986 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
5987 is a regexp) matches the @code{From} header, the face will not be shown.
5988 The default action under Emacs is to fork off an @code{xv} to view the
5989 face; under XEmacs the default action is to display the face before the
5990 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
5991 support---that will make display somewhat faster.  If there's no native
5992 X-Face support, Gnus will try to convert the @code{X-Face} header using
5993 external programs from the @code{pbmplus} package and friends.)  If you
5994 want to have this function in the display hook, it should probably come
5995 last.
5996
5997 @item W b
5998 @kindex W b (Summary)
5999 @findex gnus-article-add-buttons
6000 Add clickable buttons to the article (@code{gnus-article-add-buttons}). 
6001
6002 @item W B
6003 @kindex W B (Summary)
6004 @findex gnus-article-add-buttons-to-head
6005 Add clickable buttons to the article headers
6006 (@code{gnus-article-add-buttons-to-head}).  
6007
6008 @item W E l
6009 @kindex W E l (Summary)
6010 @findex gnus-article-strip-leading-blank-lines
6011 Remove all blank lines from the beginning of the article
6012 (@code{gnus-article-strip-leading-blank-lines}).
6013
6014 @item W E m
6015 @kindex W E m (Summary)
6016 @findex gnus-article-strip-multiple-blank-lines
6017 Replace all blank lines with empty lines and then all multiple empty
6018 lines with a single empty line.
6019 (@code{gnus-article-strip-multiple-blank-lines}).
6020
6021 @item W E t
6022 @kindex W E t (Summary)
6023 @findex gnus-article-remove-trailing-blank-lines
6024 Remove all blank lines at the end of the article
6025 (@code{gnus-article-remove-trailing-blank-lines}).
6026
6027 @item W E a
6028 @kindex W E a (Summary)
6029 @findex gnus-article-strip-blank-lines
6030 Do all the three commands above
6031 (@code{gnus-article-strip-blank-lines}).
6032
6033 @item W E s
6034 @kindex W E s (Summary)
6035 @findex gnus-article-strip-leading-space
6036 Remove all white space from the beginning of all lines of the article
6037 body (@code{gnus-article-strip-leading-space}).
6038
6039 @end table
6040
6041
6042 @node Article Buttons
6043 @subsection Article Buttons
6044 @cindex buttons
6045
6046 People often include references to other stuff in articles, and it would
6047 be nice if Gnus could just fetch whatever it is that people talk about
6048 with the minimum of fuzz.
6049
6050 Gnus adds @dfn{buttons} to certain standard references by default:
6051 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6052 two variables, one that handles article bodies and one that handles
6053 article heads:
6054
6055 @table @code
6056
6057 @item gnus-button-alist
6058 @vindex gnus-button-alist
6059 This is an alist where each entry has this form:
6060
6061 @lisp
6062 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6063 @end lisp
6064
6065 @table @var
6066
6067 @item regexp
6068 All text that match this regular expression will be considered an
6069 external reference.  Here's a typical regexp that match embedded URLs:
6070 @samp{<URL:\\([^\n\r>]*\\)>}. 
6071
6072 @item button-par
6073 Gnus has to know which parts of the match is to be highlighted.  This is
6074 a number that says what sub-expression of the regexp that is to be
6075 highlighted.  If you want it all highlighted, you use 0 here.
6076
6077 @item use-p
6078 This form will be @code{eval}ed, and if the result is non-@code{nil},
6079 this is considered a match.  This is useful if you want extra sifting to
6080 avoid false matches.
6081
6082 @item function
6083 This function will be called when you click on this button.
6084
6085 @item data-par
6086 As with @var{button-par}, this is a sub-expression number, but this one
6087 says which part of the match is to be sent as data to @var{function}. 
6088
6089 @end table
6090
6091 So the full entry for buttonizing URLs is then
6092
6093 @lisp
6094 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6095 @end lisp
6096
6097 @item gnus-header-button-alist
6098 @vindex gnus-header-button-alist
6099 This is just like the other alist, except that it is applied to the
6100 article head only, and that each entry has an additional element that is
6101 used to say what headers to apply the buttonize coding to:
6102
6103 @lisp
6104 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6105 @end lisp
6106
6107 @var{header} is a regular expression.
6108
6109 @item gnus-button-url-regexp
6110 @vindex gnus-button-url-regexp
6111 A regular expression that matches embedded URLs.  It is used in the
6112 default values of the variables above.
6113
6114 @item gnus-article-button-face
6115 @vindex gnus-article-button-face
6116 Face used on buttons.
6117
6118 @item gnus-article-mouse-face
6119 @vindex gnus-article-mouse-face
6120 Face is used when the mouse cursor is over a button.
6121
6122 @end table
6123
6124
6125 @node Article Date
6126 @subsection Article Date
6127
6128 The date is most likely generated in some obscure timezone you've never
6129 heard of, so it's quite nice to be able to find out what the time was
6130 when the article was sent.
6131
6132 @table @kbd
6133
6134 @item W T u
6135 @kindex W T u (Summary)
6136 @findex gnus-article-date-ut
6137 Display the date in UT (aka. GMT, aka ZULU)
6138 (@code{gnus-article-date-ut}). 
6139
6140 @item W T l
6141 @kindex W T l (Summary)
6142 @findex gnus-article-date-local
6143 Display the date in the local timezone (@code{gnus-article-date-local}).
6144
6145 @item W T s
6146 @kindex W T s (Summary)
6147 @vindex gnus-article-time-format
6148 @findex gnus-article-date-user
6149 @findex format-time-string
6150 Display the date using a user-defined format
6151 (@code{gnus-article-date-user}).  The format is specified by the
6152 @code{gnus-article-time-format} variable, and is a string that's passed
6153 to @code{format-time-string}.  See the documentation of that variable
6154 for a list possible format specs.
6155
6156 @item W T e
6157 @kindex W T e (Summary)
6158 @findex gnus-article-date-lapsed
6159 Say how much time has (e)lapsed between the article was posted and now
6160 (@code{gnus-article-date-lapsed}).
6161
6162 @item W T o
6163 @kindex W T o (Summary)
6164 @findex gnus-article-date-original
6165 Display the original date (@code{gnus-article-date-original}).  This can
6166 be useful if you normally use some other conversion function and is
6167 worried that it might be doing something totally wrong.  Say, claiming
6168 that the article was posted in 1854.  Although something like that is
6169 @emph{totally} impossible.  Don't you trust me? *titter*
6170
6171 @end table
6172
6173
6174 @node Article Signature
6175 @subsection Article Signature
6176 @cindex signatures
6177 @cindex article signature
6178
6179 @vindex gnus-signature-separator
6180 Each article is divided into two parts---the head and the body.  The
6181 body can be divided into a signature part and a text part.  The variable
6182 that says what is to be considered a signature is
6183 @code{gnus-signature-separator}.  This is normally the standard
6184 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6185 non-standard signature separators, so this variable can also be a list
6186 of regular expressions to be tested, one by one.  (Searches are done
6187 from the end of the body towards the beginning.)  One likely value is:
6188
6189 @lisp
6190 (setq gnus-signature-separator
6191       '("^-- $"         ; The standard
6192         "^-- *$"        ; A common mangling
6193         "^-------*$"    ; Many people just use a looong 
6194                         ; line of dashes.  Shame!
6195         "^ *--------*$" ; Double-shame!
6196         "^________*$"   ; Underscores are also popular
6197         "^========*$")) ; Pervert!
6198 @end lisp
6199
6200 The more permissive you are, the more likely it is that you'll get false
6201 positives.
6202
6203 @vindex gnus-signature-limit
6204 @code{gnus-signature-limit} provides a limit to what is considered a
6205 signature. 
6206
6207 @enumerate
6208 @item 
6209 If it is an integer, no signature may be longer (in characters) than
6210 that integer.
6211 @item 
6212 If it is a floating point number, no signature may be longer (in lines)
6213 than that number.
6214 @item 
6215 If it is a function, the function will be called without any parameters,
6216 and if it returns @code{nil}, there is no signature in the buffer.
6217 @item
6218 If it is a string, it will be used as a regexp.  If it matches, the text
6219 in question is not a signature.
6220 @end enumerate
6221
6222 This variable can also be a list where the elements may be of the types
6223 listed above.  
6224
6225
6226 @node Article Commands
6227 @section Article Commands
6228
6229 @table @kbd
6230
6231 @item A P
6232 @cindex PostScript
6233 @cindex printing
6234 @kindex A P (Summary)
6235 @vindex gnus-ps-print-hook
6236 @findex gnus-summary-print-article 
6237 Generate and print a PostScript image of the article buffer
6238 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6239 run just before printing the buffer.
6240
6241 @end table
6242
6243
6244 @node Summary Sorting
6245 @section Summary Sorting
6246 @cindex summary sorting
6247
6248 You can have the summary buffer sorted in various ways, even though I
6249 can't really see why you'd want that.
6250
6251 @table @kbd
6252
6253 @item C-c C-s C-n
6254 @kindex C-c C-s C-n (Summary)
6255 @findex gnus-summary-sort-by-number
6256 Sort by article number (@code{gnus-summary-sort-by-number}).
6257
6258 @item C-c C-s C-a
6259 @kindex C-c C-s C-a (Summary)
6260 @findex gnus-summary-sort-by-author
6261 Sort by author (@code{gnus-summary-sort-by-author}).
6262
6263 @item C-c C-s C-s
6264 @kindex C-c C-s C-s (Summary)
6265 @findex gnus-summary-sort-by-subject
6266 Sort by subject (@code{gnus-summary-sort-by-subject}).
6267
6268 @item C-c C-s C-d
6269 @kindex C-c C-s C-d (Summary)
6270 @findex gnus-summary-sort-by-date
6271 Sort by date (@code{gnus-summary-sort-by-date}).
6272
6273 @item C-c C-s C-l
6274 @kindex C-c C-s C-l (Summary)
6275 @findex gnus-summary-sort-by-lines
6276 Sort by lines (@code{gnus-summary-sort-by-lines}).
6277
6278 @item C-c C-s C-i
6279 @kindex C-c C-s C-i (Summary)
6280 @findex gnus-summary-sort-by-score
6281 Sort by score (@code{gnus-summary-sort-by-score}).
6282 @end table
6283
6284 These functions will work both when you use threading and when you don't
6285 use threading.  In the latter case, all summary lines will be sorted,
6286 line by line.  In the former case, sorting will be done on a
6287 root-by-root basis, which might not be what you were looking for.  To
6288 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6289 Commands}).
6290
6291
6292 @node Finding the Parent
6293 @section Finding the Parent
6294 @cindex parent articles
6295 @cindex referring articles
6296
6297 @findex gnus-summary-refer-parent-article
6298 @kindex ^ (Summary)
6299 If you'd like to read the parent of the current article, and it is not
6300 displayed in the summary buffer, you might still be able to.  That is,
6301 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6302 and the @code{References} in the current article are not mangled, you
6303 can just press @kbd{^} or @kbd{A r}
6304 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6305 you'll get the parent.  If the parent is already displayed in the
6306 summary buffer, point will just move to this article.
6307
6308 If given a positive numerical prefix, fetch that many articles back into
6309 the ancestry.  If given a negative numerical prefix, fetch just that
6310 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6311 grandparent and the grandgrandparent of the current article.  If you say
6312 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6313 article. 
6314
6315 @findex gnus-summary-refer-references
6316 @kindex A R (Summary)
6317 You can have Gnus fetch all articles mentioned in the @code{References}
6318 header of the article by pushing @kbd{A R}
6319 (@code{gnus-summary-refer-references}). 
6320
6321 @findex gnus-summary-refer-article
6322 @kindex M-^ (Summary)
6323 @cindex Message-ID
6324 @cindex fetching by Message-ID
6325 You can also ask the @sc{nntp} server for an arbitrary article, no
6326 matter what group it belongs to.  @kbd{M-^}
6327 (@code{gnus-summary-refer-article}) will ask you for a
6328 @code{Message-ID}, which is one of those long, hard-to-read thingies
6329 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6330 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6331
6332 @vindex gnus-refer-article-method
6333 If the group you are reading is located on a backend that does not
6334 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6335 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6336 would, perhaps, be best if the @sc{nntp} server you consult is the same
6337 as the one that keeps the spool you are reading from updated, but that's
6338 not really necessary.
6339
6340 Most of the mail backends support fetching by @code{Message-ID}, but do
6341 not do a particularly excellent job of it.  That is, @code{nnmbox} and
6342 @code{nnbabyl} are able to locate articles from any groups, while
6343 @code{nnml} and @code{nnfolder} are only able to locate articles that
6344 have been posted to the current group.  (Anything else would be too time
6345 consuming.)  @code{nnmh} does not support this at all.
6346
6347
6348 @node Alternative Approaches
6349 @section Alternative Approaches
6350
6351 Different people like to read news using different methods.  This being
6352 Gnus, we offer a small selection of minor modes for the summary buffers.
6353
6354 @menu
6355 * Pick and Read::               First mark articles and then read them.
6356 * Binary Groups::               Auto-decode all articles.
6357 @end menu
6358
6359
6360 @node Pick and Read
6361 @subsection Pick and Read
6362 @cindex pick and read
6363
6364 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6365 reading interface.  The user first marks the articles she wants to read
6366 from a summary buffer.  Then she starts reading the articles with just
6367 an article buffer displayed.
6368
6369 @findex gnus-pick-mode
6370 @kindex M-x gnus-pick-mode
6371 Gnus provides a summary buffer minor mode that allows
6372 this---@code{gnus-pick-mode}.  This basically means that a few process
6373 mark commands become one-keystroke commands to allow easy marking, and
6374 it makes one additional command for switching to the summary buffer
6375 available. 
6376
6377 Here are the available keystrokes when using pick mode:
6378
6379 @table @kbd
6380 @item .
6381 @kindex . (Pick)
6382 @findex gnus-summary-mark-as-processable
6383 Pick the article on the current line
6384 (@code{gnus-summary-mark-as-processable}).  If given a numerical prefix,
6385 go to the article on that line and pick that article.  (The line number
6386 is normally displayed on the beginning of the summary pick lines.)
6387
6388 @item SPACE
6389 @kindex SPACE (Pick)
6390 @findex gnus-pick-next-page
6391 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6392 at the end of the buffer, start reading the picked articles.
6393
6394 @item u
6395 @kindex u (Pick)
6396 @findex gnus-summary-unmark-as-processable
6397 Unpick the article (@code{gnus-summary-unmark-as-processable}). 
6398
6399 @item U
6400 @kindex U (Pick)
6401 @findex gnus-summary-unmark-all-processable
6402 Unpick all articles (@code{gnus-summary-unmark-all-processable}). 
6403
6404 @item t
6405 @kindex t (Pick)
6406 @findex gnus-uu-mark-thread
6407 Pick the thread (@code{gnus-uu-mark-thread}). 
6408
6409 @item T
6410 @kindex T (Pick)
6411 @findex gnus-uu-unmark-thread
6412 Unpick the thread (@code{gnus-uu-unmark-thread}). 
6413
6414 @item r
6415 @kindex r (Pick)
6416 @findex gnus-uu-mark-region
6417 Pick the region (@code{gnus-uu-mark-region}). 
6418
6419 @item R
6420 @kindex R (Pick)
6421 @findex gnus-uu-unmark-region
6422 Unpick the region (@code{gnus-uu-unmark-region}). 
6423
6424 @item e
6425 @kindex e (Pick)
6426 @findex gnus-uu-mark-by-regexp
6427 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}). 
6428
6429 @item E
6430 @kindex E (Pick)
6431 @findex gnus-uu-unmark-by-regexp
6432 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}). 
6433
6434 @item b
6435 @kindex b (Pick)
6436 @findex gnus-uu-mark-buffer
6437 Pick the buffer (@code{gnus-uu-mark-buffer}). 
6438
6439 @item B
6440 @kindex B (Pick)
6441 @findex gnus-uu-unmark-buffer
6442 Unpick the buffer (@code{gnus-uu-unmark-buffer}). 
6443
6444 @item RET
6445 @kindex RET (Pick)
6446 @findex gnus-pick-start-reading
6447 @vindex gnus-pick-display-summary
6448 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6449 given a prefix, mark all unpicked articles as read first.  If
6450 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6451 will still be visible when you are reading.
6452
6453 @end table
6454
6455 If this sounds like a good idea to you, you could say:
6456
6457 @lisp
6458 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6459 @end lisp
6460
6461 @vindex gnus-pick-mode-hook
6462 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6463
6464 @vindex gnus-mark-unpicked-articles-as-read
6465 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6466 all unpicked articles as read.  The default is @code{nil}.
6467
6468 @vindex gnus-summary-pick-line-format
6469 The summary line format in pick mode is slightly different than the
6470 standard format.  At the beginning of each line the line number is
6471 displayed.  The pick mode line format is controlled by the
6472 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6473 Variables}).  It accepts the same format specs that
6474 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}). 
6475
6476
6477 @node Binary Groups
6478 @subsection Binary Groups
6479 @cindex binary groups
6480
6481 @findex gnus-binary-mode
6482 @kindex M-x gnus-binary-mode
6483 If you spend much time in binary groups, you may grow tired of hitting
6484 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6485 is a minor mode for summary buffers that makes all ordinary Gnus article
6486 selection functions uudecode series of articles and display the result
6487 instead of just displaying the articles the normal way.  
6488
6489 @kindex g (Binary)
6490 @findex gnus-binary-show-article
6491 In fact, the only way to see the actual articles if you have turned this
6492 mode on is the @kbd{g} command (@code{gnus-binary-show-article}). 
6493
6494 @vindex gnus-binary-mode-hook
6495 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6496
6497
6498 @node Tree Display
6499 @section Tree Display
6500 @cindex trees
6501
6502 @vindex gnus-use-trees
6503 If you don't like the normal Gnus summary display, you might try setting
6504 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6505 additional @dfn{tree buffer}.  You can execute all summary mode commands
6506 in the tree buffer.  
6507
6508 There are a few variables to customize the tree display, of course:
6509
6510 @table @code
6511 @item gnus-tree-mode-hook
6512 @vindex gnus-tree-mode-hook
6513 A hook called in all tree mode buffers.
6514
6515 @item gnus-tree-mode-line-format
6516 @vindex gnus-tree-mode-line-format
6517 A format string for the mode bar in the tree mode buffers.  The default
6518 is @samp{Gnus: %%b [%A] %Z}.  For a list of legal specs, @pxref{Summary
6519 Buffer Mode Line}. 
6520
6521 @item gnus-selected-tree-face
6522 @vindex gnus-selected-tree-face
6523 Face used for highlighting the selected article in the tree buffer.  The
6524 default is @code{modeline}.
6525
6526 @item gnus-tree-line-format
6527 @vindex gnus-tree-line-format
6528 A format string for the tree nodes.  The name is a bit of a misnomer,
6529 though---it doesn't define a line, but just the node.  The default value
6530 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6531 the name of the poster.  It is vital that all nodes are of the same
6532 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6533
6534 Legal specs are:
6535
6536 @table @samp
6537 @item n
6538 The name of the poster.
6539 @item f
6540 The @code{From} header.
6541 @item N
6542 The number of the article.
6543 @item [
6544 The opening bracket.
6545 @item ] 
6546 The closing bracket.
6547 @item s
6548 The subject.
6549 @end table
6550
6551 @xref{Formatting Variables}.
6552
6553 Variables related to the display are:
6554
6555 @table @code
6556 @item gnus-tree-brackets
6557 @vindex gnus-tree-brackets
6558 This is used for differentiating between ``real'' articles and
6559 ``sparse'' articles.  The format is @var{((real-open . real-close)
6560 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6561 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6562
6563 @item gnus-tree-parent-child-edges
6564 @vindex gnus-tree-parent-child-edges
6565 This is a list that contains the characters used for connecting parent
6566 nodes to their children.  The default is @code{(?- ?\\ ?|)}. 
6567
6568 @end table
6569
6570 @item gnus-tree-minimize-window
6571 @vindex gnus-tree-minimize-window
6572 If this variable is non-@code{nil}, Gnus will try to keep the tree
6573 buffer as small as possible to allow more room for the other Gnus
6574 windows.  If this variable is a number, the tree buffer will never be
6575 higher than that number.  The default is @code{t}.
6576
6577 @item gnus-generate-tree-function
6578 @vindex gnus-generate-tree-function
6579 @findex gnus-generate-horizontal-tree
6580 @findex gnus-generate-vertical-tree
6581 The function that actually generates the thread tree.  Two predefined
6582 functions are available: @code{gnus-generate-horizontal-tree} and
6583 @code{gnus-generate-vertical-tree} (which is the default).
6584
6585 @end table
6586
6587 Here's and example from a horizontal tree buffer:
6588
6589 @example
6590 @{***@}-(***)-[odd]-[Gun]
6591      |      \[Jan]
6592      |      \[odd]-[Eri]
6593      |      \(***)-[Eri]
6594      |            \[odd]-[Paa]
6595      \[Bjo]
6596      \[Gun]
6597      \[Gun]-[Jor]
6598 @end example
6599
6600 Here's the same thread displayed in a vertical tree buffer:
6601
6602 @example
6603 @{***@}
6604   |--------------------------\-----\-----\
6605 (***)                         [Bjo] [Gun] [Gun]
6606   |--\-----\-----\                          |
6607 [odd] [Jan] [odd] (***)                   [Jor]
6608   |           |     |--\
6609 [Gun]       [Eri] [Eri] [odd]
6610                           |
6611                         [Paa]
6612 @end example
6613
6614
6615 @node Mail Group Commands
6616 @section Mail Group Commands
6617 @cindex mail group commands
6618
6619 Some commands only make sense in mail groups.  If these commands are
6620 illegal in the current group, they will raise a hell and let you know.
6621
6622 All these commands (except the expiry and edit commands) use the
6623 process/prefix convention (@pxref{Process/Prefix}).
6624
6625 @table @kbd
6626
6627 @item B e
6628 @kindex B e (Summary)
6629 @findex gnus-summary-expire-articles
6630 Expire all expirable articles in the group
6631 (@code{gnus-summary-expire-articles}).
6632
6633 @item B M-C-e
6634 @kindex B M-C-e (Summary)
6635 @findex gnus-summary-expire-articles-now
6636 Delete all the expirable articles in the group
6637 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6638 articles that are eligible for expiry in the current group will
6639 disappear forever into that big @file{/dev/null} in the sky.
6640
6641 @item B DEL
6642 @kindex B DEL (Summary)
6643 @findex gnus-summary-delete-article
6644 Delete the mail article.  This is ``delete'' as in ``delete it from your
6645 disk forever and ever, never to return again.'' Use with caution.
6646 (@code{gnus-summary-delete-article}).
6647
6648 @item B m
6649 @kindex B m (Summary)
6650 @cindex move mail
6651 @findex gnus-summary-move-article
6652 Move the article from one mail group to another
6653 (@code{gnus-summary-move-article}). 
6654
6655 @item B c
6656 @kindex B c (Summary)
6657 @cindex copy mail
6658 @findex gnus-summary-copy-article
6659 Copy the article from one group (mail group or not) to a mail group
6660 (@code{gnus-summary-copy-article}).
6661
6662 @item B C
6663 @kindex B C (Summary)
6664 @cindex crosspost mail
6665 @findex gnus-summary-crosspost-article
6666 Crosspost the current article to some other group
6667 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6668 the article in the other group, and the Xref headers of the article will
6669 be properly updated.
6670
6671 @item B i
6672 @kindex B i (Summary)
6673 @findex gnus-summary-import-article
6674 Import an arbitrary file into the current mail newsgroup
6675 (@code{gnus-summary-import-article}).  You will be prompted for a file
6676 name, a @code{From} header and a @code{Subject} header.
6677
6678 @item B r
6679 @kindex B r (Summary)
6680 @findex gnus-summary-respool-article
6681 Respool the mail article (@code{gnus-summary-move-article}).
6682 @code{gnus-summary-respool-default-method} will be used as the default
6683 select method when respooling.  This variable is @code{nil} by default,
6684 which means that the current group select method will be used instead.
6685
6686 @item B w
6687 @itemx e
6688 @kindex B w (Summary)
6689 @kindex e (Summary)
6690 @findex gnus-summary-edit-article
6691 @kindex C-c C-c (Article)
6692 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6693 editing and make the changes permanent, type @kbd{C-c C-c}
6694 (@kbd{gnus-summary-edit-article-done}).
6695
6696 @item B q
6697 @kindex B q (Summary)
6698 @findex gnus-summary-respool-query
6699 If you want to re-spool an article, you might be curious as to what group
6700 the article will end up in before you do the re-spooling.  This command
6701 will tell you (@code{gnus-summary-respool-query}). 
6702
6703 @item B p
6704 @kindex B p (Summary)
6705 @findex gnus-summary-article-posted-p
6706 Some people have a tendency to send you "courtesy" copies when they
6707 follow up to articles you have posted.  These usually have a
6708 @code{Newsgroups} header in them, but not always.  This command
6709 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6710 article from your news server (or rather, from
6711 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6712 report back whether it found the article or not.  Even if it says that
6713 it didn't find the article, it may have been posted anyway---mail
6714 propagation is much faster than news propagation, and the news copy may
6715 just not have arrived yet.
6716
6717 @end table
6718
6719 @vindex gnus-move-split-methods
6720 @cindex moving articles
6721 If you move (or copy) articles regularly, you might wish to have Gnus
6722 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6723 variable that uses the same syntax as @code{gnus-split-methods}
6724 (@pxref{Saving Articles}).  You may customize that variable to create
6725 suggestions you find reasonable.
6726
6727 @lisp
6728 (setq gnus-move-split-methods
6729       '(("^From:.*Lars Magne" "nnml:junk")
6730         ("^Subject:.*gnus" "nnfolder:important")
6731         (".*" "nnml:misc")))
6732 @end lisp
6733
6734
6735 @node Various Summary Stuff
6736 @section Various Summary Stuff
6737
6738 @menu
6739 * Summary Group Information::         Information oriented commands.
6740 * Searching for Articles::            Multiple article commands.
6741 * Summary Generation Commands::       (Re)generating the summary buffer.
6742 * Really Various Summary Commands::   Those pesky non-conformant commands.
6743 @end menu
6744
6745 @table @code
6746 @vindex gnus-summary-mode-hook
6747 @item gnus-summary-mode-hook
6748 This hook is called when creating a summary mode buffer.
6749
6750 @vindex gnus-summary-generate-hook
6751 @item gnus-summary-generate-hook
6752 This is called as the last thing before doing the threading and the
6753 generation of the summary buffer.  It's quite convenient for customizing
6754 the threading variables based on what data the newsgroup has.  This hook
6755 is called from the summary buffer after most summary buffer variables
6756 has been set.
6757
6758 @vindex gnus-summary-prepare-hook
6759 @item gnus-summary-prepare-hook
6760 Is is called after the summary buffer has been generated.  You might use
6761 it to, for instance, highlight lines or modify the look of the buffer in
6762 some other ungodly manner.  I don't care.
6763
6764 @end table
6765
6766
6767 @node Summary Group Information
6768 @subsection Summary Group Information
6769
6770 @table @kbd
6771
6772 @item H f
6773 @kindex H f (Summary)
6774 @findex gnus-summary-fetch-faq
6775 @vindex gnus-group-faq-directory
6776 Try to fetch the FAQ (list of frequently asked questions) for the
6777 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
6778 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6779 on a remote machine.  This variable can also be a list of directories.
6780 In that case, giving a prefix to this command will allow you to choose
6781 between the various sites.  @code{ange-ftp} probably will be used for
6782 fetching the file.
6783
6784 @item H d
6785 @kindex H d (Summary)
6786 @findex gnus-summary-describe-group
6787 Give a brief description of the current group
6788 (@code{gnus-summary-describe-group}).  If given a prefix, force
6789 rereading the description from the server.
6790
6791 @item H h
6792 @kindex H h (Summary)
6793 @findex gnus-summary-describe-briefly
6794 Give an extremely brief description of the most important summary
6795 keystrokes (@code{gnus-summary-describe-briefly}).
6796
6797 @item H i
6798 @kindex H i (Summary)
6799 @findex gnus-info-find-node
6800 Go to the Gnus info node (@code{gnus-info-find-node}).
6801 @end table
6802
6803
6804 @node Searching for Articles
6805 @subsection Searching for Articles
6806
6807 @table @kbd
6808
6809 @item M-s
6810 @kindex M-s (Summary)
6811 @findex gnus-summary-search-article-forward
6812 Search through all subsequent articles for a regexp
6813 (@code{gnus-summary-search-article-forward}). 
6814
6815 @item M-r
6816 @kindex M-r (Summary)
6817 @findex gnus-summary-search-article-backward
6818 Search through all previous articles for a regexp
6819 (@code{gnus-summary-search-article-backward}). 
6820
6821 @item &
6822 @kindex & (Summary)
6823 @findex gnus-summary-execute-command
6824 This command will prompt you for a header field, a regular expression to
6825 match on this field, and a command to be executed if the match is made
6826 (@code{gnus-summary-execute-command}).
6827
6828 @item M-&
6829 @kindex M-& (Summary)
6830 @findex gnus-summary-universal-argument
6831 Perform any operation on all articles that have been marked with
6832 the process mark (@code{gnus-summary-universal-argument}).
6833 @end table
6834
6835 @node Summary Generation Commands
6836 @subsection Summary Generation Commands
6837
6838 @table @kbd
6839
6840 @item Y g
6841 @kindex Y g (Summary)
6842 @findex gnus-summary-prepare
6843 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6844
6845 @item Y c 
6846 @kindex Y c (Summary)
6847 @findex gnus-summary-insert-cached-articles
6848 Pull all cached articles (for the current group) into the summary buffer
6849 (@code{gnus-summary-insert-cached-articles}).
6850
6851 @end table
6852
6853
6854 @node Really Various Summary Commands
6855 @subsection Really Various Summary Commands
6856
6857 @table @kbd
6858
6859 @item C-d
6860 @kindex C-d (Summary)
6861 @findex gnus-summary-enter-digest-group
6862 If the current article is a collection of other articles (for instance,
6863 a digest), you might use this command to enter a group based on the that
6864 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
6865 guess what article type is currently displayed unless you give a prefix
6866 to this command, which forces a ``digest'' interpretation.  Basically,
6867 whenever you see a message that is a collection of other messages on
6868 some format, you @kbd{C-d} and read these messages in a more convenient
6869 fashion.
6870
6871 @item M-C-d
6872 @kindex M-C-d (Summary)
6873 @findex gnus-summary-read-document
6874 This command is very similar to the one above, but lets you gather
6875 several documents into one biiig group
6876 (@code{gnus-summary-read-document}).  It does this by opening several
6877 @code{nndoc} groups for each document, and then opening an
6878 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
6879 command understands the process/prefix convention
6880 (@pxref{Process/Prefix}). 
6881
6882 @item C-t
6883 @kindex C-t (Summary)
6884 @findex gnus-summary-toggle-truncation
6885 Toggle truncation of summary lines
6886 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
6887 line centering function in the summary buffer, so it's not a good idea
6888 to have truncation switched off while reading articles.
6889
6890 @item =
6891 @kindex = (Summary)
6892 @findex gnus-summary-expand-window
6893 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6894 If given a prefix, force an @code{article} window configuration. 
6895
6896 @end table
6897
6898
6899 @node Exiting the Summary Buffer
6900 @section Exiting the Summary Buffer
6901 @cindex summary exit
6902 @cindex exiting groups
6903
6904 Exiting from the summary buffer will normally update all info on the
6905 group and return you to the group buffer. 
6906
6907 @table @kbd
6908
6909 @item Z Z
6910 @itemx q
6911 @kindex Z Z (Summary)
6912 @kindex q (Summary)
6913 @findex gnus-summary-exit
6914 @vindex gnus-summary-exit-hook
6915 @vindex gnus-summary-prepare-exit-hook
6916 Exit the current group and update all information on the group
6917 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6918 called before doing much of the exiting, and calls
6919 @code{gnus-summary-expire-articles} by default.
6920 @code{gnus-summary-exit-hook} is called after finishing the exiting
6921 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
6922 group mode having no more (unread) groups.
6923
6924 @item Z E
6925 @itemx Q
6926 @kindex Z E (Summary)
6927 @kindex Q (Summary)
6928 @findex gnus-summary-exit-no-update
6929 Exit the current group without updating any information on the group
6930 (@code{gnus-summary-exit-no-update}).
6931
6932 @item Z c
6933 @itemx c
6934 @kindex Z c (Summary)
6935 @kindex c (Summary)
6936 @findex gnus-summary-catchup-and-exit
6937 Mark all unticked articles in the group as read and then exit
6938 (@code{gnus-summary-catchup-and-exit}).
6939
6940 @item Z C
6941 @kindex Z C (Summary)
6942 @findex gnus-summary-catchup-all-and-exit
6943 Mark all articles, even the ticked ones, as read and then exit
6944 (@code{gnus-summary-catchup-all-and-exit}).
6945
6946 @item Z n
6947 @kindex Z n (Summary)
6948 @findex gnus-summary-catchup-and-goto-next-group
6949 Mark all articles as read and go to the next group
6950 (@code{gnus-summary-catchup-and-goto-next-group}). 
6951
6952 @item Z R
6953 @kindex Z R (Summary)
6954 @findex gnus-summary-reselect-current-group
6955 Exit this group, and then enter it again
6956 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
6957 all articles, both read and unread.
6958
6959 @item Z G
6960 @itemx M-g
6961 @kindex Z G (Summary)
6962 @kindex M-g (Summary)
6963 @findex gnus-summary-rescan-group
6964 Exit the group, check for new articles in the group, and select the
6965 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
6966 articles, both read and unread.
6967
6968 @item Z N
6969 @kindex Z N (Summary)
6970 @findex gnus-summary-next-group
6971 Exit the group and go to the next group
6972 (@code{gnus-summary-next-group}). 
6973
6974 @item Z P
6975 @kindex Z P (Summary)
6976 @findex gnus-summary-prev-group
6977 Exit the group and go to the previous group
6978 (@code{gnus-summary-prev-group}). 
6979
6980 @item Z s
6981 @kindex Z s (Summary)
6982 @findex gnus-summary-save-newsrc
6983 Save the current number of read/marked articles in the dribble buffer
6984 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
6985 given a prefix, also save the @file{.newsrc} file(s).  Using this
6986 command will make exit without updating (the @kbd{Q} command) worthless.
6987 @end table
6988
6989 @vindex gnus-exit-group-hook
6990 @code{gnus-exit-group-hook} is called when you exit the current
6991 group.  
6992
6993 @findex gnus-summary-wake-up-the-dead
6994 @findex gnus-dead-summary-mode
6995 @vindex gnus-kill-summary-on-exit
6996 If you're in the habit of exiting groups, and then changing your mind
6997 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6998 If you do that, Gnus won't kill the summary buffer when you exit it.
6999 (Quelle surprise!)  Instead it will change the name of the buffer to
7000 something like @samp{*Dead Summary ... *} and install a minor mode
7001 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7002 buffer, you'll find that all keys are mapped to a function called
7003 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7004 summary buffer will result in a live, normal summary buffer.  
7005
7006 There will never be more than one dead summary buffer at any one time. 
7007
7008 @vindex gnus-use-cross-reference
7009 The data on the current group will be updated (which articles you have
7010 read, which articles you have replied to, etc.) when you exit the
7011 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7012 @code{t} (which is the default), articles that are cross-referenced to
7013 this group and are marked as read, will also be marked as read in the
7014 other subscribed groups they were cross-posted to.  If this variable is
7015 neither @code{nil} nor @code{t}, the article will be marked as read in
7016 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7017
7018
7019 @node Crosspost Handling
7020 @section Crosspost Handling
7021
7022 @cindex velveeta
7023 @cindex spamming
7024 Marking cross-posted articles as read ensures that you'll never have to
7025 read the same article more than once.  Unless, of course, somebody has
7026 posted it to several groups separately.  Posting the same article to
7027 several groups (not cross-posting) is called @dfn{spamming}, and you are
7028 by law required to send nasty-grams to anyone who perpetrates such a
7029 heinous crime.  You may want to try NoCeM handling to filter out spam
7030 (@pxref{NoCeM}). 
7031
7032 Remember: Cross-posting is kinda ok, but posting the same article
7033 separately to several groups is not.  Massive cross-posting (aka.
7034 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7035 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7036 excessive crossposting (@pxref{Summary Mail Commands}).
7037
7038 @cindex cross-posting
7039 @cindex Xref
7040 @cindex @sc{nov}
7041 One thing that may cause Gnus to not do the cross-posting thing
7042 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7043 (which is very nice, because it speeds things up considerably) which
7044 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7045 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7046 even with @sc{xover} by registering the @code{Xref} lines of all
7047 articles you actually read, but if you kill the articles, or just mark
7048 them as read without reading them, Gnus will not get a chance to snoop
7049 the @code{Xref} lines out of these articles, and will be unable to use
7050 the cross reference mechanism.
7051
7052 @cindex LIST overview.fmt
7053 @cindex overview.fmt
7054 To check whether your @sc{nntp} server includes the @code{Xref} header
7055 in its overview files, try @samp{telnet your.nntp.server nntp},
7056 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7057 overview.fmt}.  This may not work, but if it does, and the last line you
7058 get does not read @samp{Xref:full}, then you should shout and whine at
7059 your news admin until she includes the @code{Xref} header in the
7060 overview files.
7061
7062 @vindex gnus-nov-is-evil
7063 If you want Gnus to get the @code{Xref}s right all the time, you have to
7064 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7065 considerably.
7066
7067 C'est la vie.
7068
7069 For an alternative approach, @pxref{Duplicate Suppression}.
7070
7071
7072 @node Duplicate Suppression
7073 @section Duplicate Suppression
7074
7075 By default, Gnus tries to make sure that you don't have to read the same
7076 article more than once by utilizing the crossposting mechanism
7077 (@pxref{Crosspost Handling}).  However, that simple and efficient
7078 approach may not work satisfactorily for some users for various
7079 reasons.  
7080
7081 @enumerate
7082 @item 
7083 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7084 is evil and not very common.
7085
7086 @item 
7087 The @sc{nntp} server may fail to include the @code{Xref} header in the
7088 @file{.overview} data bases.  This is evil and all too common, alas.
7089
7090 @item
7091 You may be reading the same group (or several related groups) from
7092 different @sc{nntp} servers.
7093
7094 @item
7095 You may be getting mail that duplicates articles posted to groups.
7096 @end enumerate
7097
7098 I'm sure there are other situations that @code{Xref} handling fails as
7099 well, but these four are the most common situations.
7100
7101 If, and only if, @code{Xref} handling fails for you, then you may
7102 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7103 will remember the @code{Message-ID}s of all articles you have read or
7104 otherwise marked as read, and then, as if by magic, mark them as read
7105 all subsequent times you see them---in @emph{all} groups.  Using this
7106 mechanism is quite likely to be somewhat inefficient, but not overly
7107 so.  It's certainly preferable to reading the same articles more than
7108 once.
7109
7110 Duplicate suppression is not a very subtle instrument.  It's more like a
7111 sledge hammer than anything else.  It works in a very simple
7112 fashion---if you have marked an article as read, it adds this Message-ID
7113 to a cache.  The next time it sees this Message-ID, it will mark the
7114 article as read the the @samp{M} mark.  It doesn't care what group it
7115 saw the article in.
7116
7117 @table @code
7118 @item gnus-suppress-duplicates
7119 @vindex gnus-suppress-duplicates
7120 If non-@code{nil}, suppress duplicates.
7121
7122 @item gnus-save-duplicate-list
7123 @vindex gnus-save-duplicate-list
7124 If non-@code{nil}, save the list of duplicates to a file.  This will
7125 make startup and shutdown take longer, so the default is @code{nil}.
7126 However, this means that only duplicate articles that is read in a
7127 single Gnus session are suppressed.  
7128
7129 @item gnus-duplicate-list-length
7130 @vindex gnus-duplicate-list-length
7131 This variables says how many @code{Message-ID}s to keep in the duplicate
7132 suppression list.  The default is 10000.  
7133
7134 @item gnus-duplicate-file
7135 @vindex gnus-duplicate-file
7136 The name of the file to store the duplicate suppression list.  The
7137 default is @file{~/News/suppression}.
7138 @end table
7139
7140 If you have a tendency to stop and start Gnus often, setting
7141 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7142 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7143 the other hand, saving the list makes startup and shutdown much slower,
7144 so that means that if you stop and start Gnus often, you should set
7145 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7146 to you to figure out, I think.
7147
7148
7149 @node The Article Buffer
7150 @chapter The Article Buffer
7151 @cindex article buffer
7152
7153 The articles are displayed in the article buffer, of which there is only
7154 one.  All the summary buffers share the same article buffer unless you
7155 tell Gnus otherwise.
7156
7157 @menu
7158 * Hiding Headers::        Deciding what headers should be displayed.
7159 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7160 * Customizing Articles::  Tailoring the look of the articles.
7161 * Article Keymap::        Keystrokes available in the article buffer.
7162 * Misc Article::          Other stuff.
7163 @end menu
7164
7165
7166 @node Hiding Headers
7167 @section Hiding Headers
7168 @cindex hiding headers
7169 @cindex deleting headers
7170
7171 The top section of each article is the @dfn{head}.  (The rest is the
7172 @dfn{body}, but you may have guessed that already.)
7173
7174 @vindex gnus-show-all-headers
7175 There is a lot of useful information in the head: the name of the person
7176 who wrote the article, the date it was written and the subject of the
7177 article.  That's well and nice, but there's also lots of information
7178 most people do not want to see---what systems the article has passed
7179 through before reaching you, the @code{Message-ID}, the
7180 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7181 of some of those lines.  If you want to keep all those lines in the
7182 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7183
7184 Gnus provides you with two variables for sifting headers:
7185
7186 @table @code
7187
7188 @item gnus-visible-headers
7189 @vindex gnus-visible-headers
7190 If this variable is non-@code{nil}, it should be a regular expression
7191 that says what headers you wish to keep in the article buffer.  All
7192 headers that do not match this variable will be hidden.
7193
7194 For instance, if you only want to see the name of the person who wrote
7195 the article and the subject, you'd say:
7196
7197 @lisp
7198 (setq gnus-visible-headers "^From:\\|^Subject:")
7199 @end lisp
7200
7201 This variable can also be a list of regexps to match headers that are to
7202 remain visible.
7203
7204 @item gnus-ignored-headers
7205 @vindex gnus-ignored-headers
7206 This variable is the reverse of @code{gnus-visible-headers}.  If this
7207 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7208 should be a regular expression that matches all lines that you want to
7209 hide.  All lines that do not match this variable will remain visible.
7210
7211 For instance, if you just want to get rid of the @code{References} line
7212 and the @code{Xref} line, you might say:
7213
7214 @lisp
7215 (setq gnus-ignored-headers "^References:\\|^Xref:")
7216 @end lisp
7217
7218 This variable can also be a list of regexps to match headers that are to
7219 be removed.
7220
7221 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7222 variable will have no effect.
7223
7224 @end table
7225
7226 @vindex gnus-sorted-header-list
7227 Gnus can also sort the headers for you.  (It does this by default.)  You
7228 can control the sorting by setting the @code{gnus-sorted-header-list}
7229 variable.  It is a list of regular expressions that says in what order
7230 the headers are to be displayed.
7231
7232 For instance, if you want the name of the author of the article first,
7233 and then the subject, you might say something like:
7234
7235 @lisp
7236 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7237 @end lisp
7238
7239 Any headers that are to remain visible, but are not listed in this
7240 variable, will be displayed in random order after all the headers that
7241 are listed in this variable.
7242
7243 @findex gnus-article-hide-boring-headers
7244 @vindex gnus-article-display-hook
7245 @vindex gnus-boring-article-headers
7246 You can hide further boring headers by entering
7247 @code{gnus-article-hide-boring-headers} into
7248 @code{gnus-article-display-hook}.  What this function does depends on
7249 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7250 list doesn't actually contain header names.  Instead is lists various
7251 @dfn{boring conditions} that Gnus can check and remove from sight.
7252
7253 These conditions are:
7254 @table @code
7255 @item empty
7256 Remove all empty headers.
7257 @item newsgroups
7258 Remove the @code{Newsgroups} header if it only contains the current group
7259 name. 
7260 @item followup-to
7261 Remove the @code{Followup-To} header if it is identical to the
7262 @code{Newsgroups} header.
7263 @item reply-to
7264 Remove the @code{Reply-To} header if it lists the same address as the
7265 @code{From} header.
7266 @item date
7267 Remove the @code{Date} header if the article is less than three days
7268 old. 
7269 @end table
7270
7271 To include the four first elements, you could say something like;
7272
7273 @lisp
7274 (setq gnus-boring-article-headers 
7275       '(empty newsgroups followup-to reply-to))
7276 @end lisp
7277
7278 This is also the default value for this variable.
7279
7280
7281 @node Using MIME
7282 @section Using @sc{mime}
7283 @cindex @sc{mime}
7284
7285 Mime is a standard for waving your hands through the air, aimlessly,
7286 while people stand around yawning.
7287
7288 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7289 while all newsreaders die of fear.
7290
7291 @sc{mime} may specify what character set the article uses, the encoding
7292 of the characters, and it also makes it possible to embed pictures and
7293 other naughty stuff in innocent-looking articles.
7294
7295 @vindex gnus-show-mime
7296 @vindex gnus-show-mime-method
7297 @vindex gnus-strict-mime
7298 @findex metamail-buffer
7299 Gnus handles @sc{mime} by pushing the articles through
7300 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7301 default.  Set @code{gnus-show-mime} to @code{t} if you want to use
7302 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7303 non-@code{nil}, the @sc{mime} method will only be used if there are
7304 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7305 set, then you'll see some unfortunate display glitches in the article
7306 buffer.  These can't be avoided.
7307
7308 It might be best to just use the toggling functions from the summary
7309 buffer to avoid getting nasty surprises. (For instance, you enter the
7310 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7311 decoded the sound file in the article and some horrible sing-a-long song
7312 comes streaming out out your speakers, and you can't find the volume
7313 button, because there isn't one, and people are starting to look at you,
7314 and you try to stop the program, but you can't, and you can't find the
7315 program to control the volume, and everybody else in the room suddenly
7316 decides to look at you disdainfully, and you'll feel rather stupid.)
7317
7318 Any similarity to real events and people is purely coincidental.  Ahem.
7319
7320
7321 @node Customizing Articles
7322 @section Customizing Articles
7323 @cindex article customization
7324
7325 @vindex gnus-article-display-hook
7326 The @code{gnus-article-display-hook} is called after the article has
7327 been inserted into the article buffer.  It is meant to handle all
7328 treatment of the article before it is displayed. 
7329
7330 @findex gnus-article-maybe-highlight
7331 By default this hook just contains @code{gnus-article-hide-headers},
7332 @code{gnus-article-treat-overstrike}, and
7333 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7334 millions, of functions you can put in this hook.  For an overview of
7335 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7336 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7337 Date}.  Note that the order of functions in this hook might affect
7338 things, so you may have to fiddle a bit to get the desired results. 
7339
7340 You can, of course, write your own functions.  The functions are called
7341 from the article buffer, and you can do anything you like, pretty much.
7342 There is no information that you have to keep in the buffer---you can
7343 change everything.  However, you shouldn't delete any headers.  Instead
7344 make them invisible if you want to make them go away.
7345
7346
7347 @node Article Keymap
7348 @section Article Keymap
7349
7350 Most of the keystrokes in the summary buffer can also be used in the
7351 article buffer.  They should behave as if you typed them in the summary
7352 buffer, which means that you don't actually have to have a summary
7353 buffer displayed while reading.  You can do it all from the article
7354 buffer.
7355
7356 A few additional keystrokes are available:
7357
7358 @table @kbd
7359
7360 @item SPACE
7361 @kindex SPACE (Article)
7362 @findex gnus-article-next-page
7363 Scroll forwards one page (@code{gnus-article-next-page}).
7364
7365 @item DEL
7366 @kindex DEL (Article)
7367 @findex gnus-article-prev-page
7368 Scroll backwards one page (@code{gnus-article-prev-page}).
7369
7370 @item C-c ^
7371 @kindex C-c ^ (Article)
7372 @findex gnus-article-refer-article
7373 If point is in the neighborhood of a @code{Message-ID} and you press
7374 @kbd{r}, Gnus will try to get that article from the server
7375 (@code{gnus-article-refer-article}).
7376
7377 @item C-c C-m
7378 @kindex C-c C-m (Article)
7379 @findex gnus-article-mail
7380 Send a reply to the address near point (@code{gnus-article-mail}).  If
7381 given a prefix, include the mail.
7382
7383 @item s
7384 @kindex s (Article)
7385 @findex gnus-article-show-summary
7386 Reconfigure the buffers so that the summary buffer becomes visible
7387 (@code{gnus-article-show-summary}).
7388
7389 @item ?
7390 @kindex ? (Article)
7391 @findex gnus-article-describe-briefly
7392 Give a very brief description of the available keystrokes
7393 (@code{gnus-article-describe-briefly}). 
7394
7395 @item TAB
7396 @kindex TAB (Article)
7397 @findex gnus-article-next-button
7398 Go to the next button, if any (@code{gnus-article-next-button}.  This
7399 only makes sense if you have buttonizing turned on.
7400
7401 @item M-TAB
7402 @kindex M-TAB (Article)
7403 @findex gnus-article-prev-button
7404 Go to the previous button, if any (@code{gnus-article-prev-button}.  
7405
7406 @end table
7407
7408
7409 @node Misc Article
7410 @section Misc Article
7411
7412 @table @code
7413
7414 @item gnus-single-article-buffer
7415 @vindex gnus-single-article-buffer
7416 If non-@code{nil}, use the same article buffer for all the groups.
7417 (This is the default.)  If @code{nil}, each group will have its own
7418 article buffer.
7419
7420 @vindex gnus-article-prepare-hook
7421 @item gnus-article-prepare-hook
7422 This hook is called right after the article has been inserted into the
7423 article buffer.  It is mainly intended for functions that do something
7424 depending on the contents; it should probably not be used for changing
7425 the contents of the article buffer.
7426
7427 @vindex gnus-article-display-hook
7428 @item gnus-article-display-hook
7429 This hook is called as the last thing when displaying an article, and is
7430 intended for modifying the contents of the buffer, doing highlights,
7431 hiding headers, and the like.
7432
7433 @item gnus-article-mode-hook
7434 @vindex gnus-article-mode-hook
7435 Hook called in article mode buffers.
7436
7437 @item gnus-article-mode-syntax-table
7438 @vindex gnus-article-mode-syntax-table
7439 Syntax table used in article buffers.  It is initialized from
7440 @code{text-mode-syntax-table}. 
7441
7442 @vindex gnus-article-mode-line-format
7443 @item gnus-article-mode-line-format
7444 This variable is a format string along the same lines as
7445 @code{gnus-summary-mode-line-format}.  It accepts the same
7446 format specifications as that variable, with one extension:
7447
7448 @table @samp
7449 @item w
7450 The @dfn{wash status} of the article.  This is a short string with one
7451 character for each possible article wash operation that may have been
7452 performed. 
7453 @end table
7454
7455 @vindex gnus-break-pages
7456
7457 @item gnus-break-pages
7458 Controls whether @dfn{page breaking} is to take place.  If this variable
7459 is non-@code{nil}, the articles will be divided into pages whenever a
7460 page delimiter appears in the article.  If this variable is @code{nil},
7461 paging will not be done.
7462
7463 @item gnus-page-delimiter
7464 @vindex gnus-page-delimiter
7465 This is the delimiter mentioned above.  By default, it is @samp{^L}
7466 (form linefeed).
7467 @end table
7468
7469
7470 @node Composing Messages
7471 @chapter Composing Messages
7472 @cindex reply
7473 @cindex followup
7474 @cindex post
7475
7476 @kindex C-c C-c (Post)
7477 All commands for posting and mailing will put you in a message buffer
7478 where you can edit the article all you like, before you send the article
7479 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7480 Manual}.  If you are in a foreign news group, and you wish to post the
7481 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7482 to make Gnus try to post using the foreign server.
7483
7484 @menu 
7485 * Mail::                 Mailing and replying.
7486 * Post::                 Posting and following up.
7487 * Posting Server::       What server should you post via?
7488 * Mail and Post::        Mailing and posting at the same time.
7489 * Archived Messages::    Where Gnus stores the messages you've sent.
7490 @c * Posting Styles::       An easier way to configure some key elements.
7491 @c * Drafts::               Postponing messages and rejected messages.
7492 @c * Rejected Articles::    What happens if the server doesn't like your article?
7493 @end menu
7494
7495 Also see @pxref{Canceling and Superseding} for information on how to
7496 remove articles you shouldn't have posted.
7497
7498
7499 @node Mail
7500 @section Mail
7501
7502 Variables for customizing outgoing mail:
7503
7504 @table @code
7505 @item gnus-uu-digest-headers
7506 @vindex gnus-uu-digest-headers
7507 List of regexps to match headers included in digested messages.  The
7508 headers will be included in the sequence they are matched.
7509
7510 @end table
7511
7512
7513 @node Post
7514 @section Post
7515
7516 Variables for composing news articles:
7517
7518 @table @code
7519 @item gnus-sent-message-ids-file
7520 @vindex gnus-sent-message-ids-file
7521 Gnus will keep a @code{Message-ID} history file of all the mails it has
7522 sent.  If it discovers that it has already sent a mail, it will ask the
7523 user whether to re-send the mail.  (This is primarily useful when
7524 dealing with @sc{soup} packets and the like where one is apt to sent the
7525 same packet multiple times.)  This variable says what the name of this
7526 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7527 this variable to @code{nil} if you don't want Gnus to keep a history
7528 file.
7529
7530 @item gnus-sent-message-ids-length
7531 @vindex gnus-sent-message-ids-length
7532 This variable says how many @code{Message-ID}s to keep in the history
7533 file.  It is 1000 by default.
7534
7535 @end table
7536
7537
7538 @node Posting Server
7539 @section Posting Server
7540
7541 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7542 (extremely intelligent, of course) article, where does it go?
7543
7544 Thank you for asking.  I hate you.
7545
7546 @vindex gnus-post-method
7547
7548 It can be quite complicated.  Normally, Gnus will use the same native
7549 server.  However.  If your native server doesn't allow posting, just
7550 reading, you probably want to use some other server to post your
7551 (extremely intelligent and fabulously interesting) articles.  You can
7552 then set the @code{gnus-post-method} to some other method:
7553
7554 @lisp
7555 (setq gnus-post-method '(nnspool ""))
7556 @end lisp
7557
7558 Now, if you've done this, and then this server rejects your article, or
7559 this server is down, what do you do then?  To override this variable you
7560 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7561 the ``current'' server for posting.
7562
7563 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7564 Gnus will prompt you for what method to use for posting.  
7565
7566 You can also set @code{gnus-post-method} to a list of select methods.
7567 If that's the case, Gnus will always prompt you for what method to use
7568 for posting. 
7569
7570
7571 @node Mail and Post
7572 @section Mail and Post
7573
7574 Here's a list of variables that are relevant to both mailing and
7575 posting:
7576
7577 @table @code
7578 @item gnus-mailing-list-groups
7579 @findex gnus-mailing-list-groups
7580 @cindex mailing lists
7581
7582 If your news server offers groups that are really mailing lists that are
7583 gatewayed to the @sc{nntp} server, you can read those groups without
7584 problems, but you can't post/followup to them without some difficulty.
7585 One solution is to add a @code{to-address} to the group parameters
7586 (@pxref{Group Parameters}).  An easier thing to do is set the
7587 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7588 really are mailing lists.  Then, at least, followups to the mailing
7589 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7590 still a pain, though.
7591
7592 @end table
7593
7594 You may want to do spell-checking on messages that you send out.  Or, if
7595 you don't want to spell-check by hand, you could add automatic
7596 spell-checking via the @code{ispell} package:
7597
7598 @cindex ispell
7599 @findex ispell-message
7600 @lisp
7601 (add-hook 'message-send-hook 'ispell-message) 
7602 @end lisp
7603
7604
7605 @node Archived Messages
7606 @section Archived Messages
7607 @cindex archived messages
7608 @cindex sent messages
7609
7610 Gnus provides a few different methods for storing the mail and news you
7611 send.  The default method is to use the @dfn{archive virtual server} to
7612 store the messages.  If you want to disable this completely, the
7613 @code{gnus-message-archive-group} variable should be @code{nil}, which
7614 is the default.
7615
7616 @vindex gnus-message-archive-method
7617 @code{gnus-message-archive-method} says what virtual server Gnus is to
7618 use to store sent messages.  The default is:
7619
7620 @lisp
7621 (nnfolder "archive"
7622           (nnfolder-directory "~/Mail/archive/"))
7623 @end lisp
7624
7625 You can, however, use any mail select method (@code{nnml},
7626 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7627 for doing this sort of thing, though.  If you don't like the default
7628 directory chosen, you could say something like:
7629
7630 @lisp
7631 (setq gnus-message-archive-method
7632       '(nnfolder "archive" 
7633                  (nnfolder-inhibit-expiry t)
7634                  (nnfolder-active-file "~/News/sent-mail/active")
7635                  (nnfolder-directory "~/News/sent-mail/")))
7636 @end lisp
7637
7638 @vindex gnus-message-archive-group
7639 @cindex Gcc
7640 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7641 to one or more group(s) on that server.  Which group to use is
7642 determined by the @code{gnus-message-archive-group} variable.  
7643
7644 This variable can be:
7645
7646 @itemize @bullet
7647 @item a string
7648 Messages will be saved in that group.
7649 @item a list of strings
7650 Messages will be saved in all those groups.
7651 @item an alist of regexps, functions and forms
7652 When a key ``matches'', the result is used.
7653 @item @code{nil}
7654 No message archiving will take place.  This is the default.
7655 @end itemize
7656
7657 Let's illustrate:
7658
7659 Just saving to a single group called @samp{MisK}:
7660 @lisp
7661 (setq gnus-message-archive-group "MisK")
7662 @end lisp
7663
7664 Saving to two groups, @samp{MisK} and @samp{safe}:
7665 @lisp
7666 (setq gnus-message-archive-group '("MisK" "safe"))
7667 @end lisp
7668
7669 Save to different groups based on what group you are in:
7670 @lisp
7671 (setq gnus-message-archive-group 
7672       '(("^alt" "sent-to-alt")
7673         ("mail" "sent-to-mail")
7674         (".*" "sent-to-misc")))
7675 @end lisp
7676
7677 More complex stuff:
7678 @lisp
7679 (setq gnus-message-archive-group 
7680       '((if (message-news-p)
7681             "misc-news" 
7682           "misc-mail")))
7683 @end lisp       
7684
7685 How about storing all news messages in one file, but storing all mail
7686 messages in one file per month:
7687
7688 @lisp
7689 (setq gnus-message-archive-group
7690       '((if (message-news-p)
7691             "misc-news" 
7692           (concat "mail." (format-time-string 
7693                            "%Y-%m" (current-time))))))
7694 @end lisp
7695
7696 Now, when you send a message off, it will be stored in the appropriate
7697 group.  (If you want to disable storing for just one particular message,
7698 you can just remove the @code{Gcc} header that has been inserted.)  The
7699 archive group will appear in the group buffer the next time you start
7700 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7701 enter it and read the articles in it just like you'd read any other
7702 group.  If the group gets really big and annoying, you can simply rename
7703 if (using @kbd{G r} in the group buffer) to something
7704 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
7705 continue to be stored in the old (now empty) group.
7706
7707 That's the default method of archiving sent messages.  Gnus also a
7708 different way for the people who don't like the default method.  In that
7709 case you should set @code{gnus-message-archive-group} to @code{nil};
7710 this will disable archiving.
7711
7712 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7713 use a different value for @code{gnus-message-archive-group} there.
7714
7715 @table @code
7716 @item gnus-outgoing-message-group 
7717 @vindex gnus-outgoing-message-group 
7718 All outgoing messages will be put in this group.  If you want to store
7719 all your outgoing mail and articles in the group @samp{nnml:archive},
7720 you set this variable to that value.  This variable can also be a list of
7721 group names.
7722
7723 If you want to have greater control over what group to put each
7724 message in, you can set this variable to a function that checks the
7725 current newsgroup name and then returns a suitable group name (or list
7726 of names).
7727
7728 This variable can be used instead of @code{gnus-message-archive-group},
7729 but the latter is the preferred method.
7730 @end table
7731
7732
7733 @c @node Posting Styles
7734 @c @section Posting Styles
7735 @c @cindex posting styles
7736 @c @cindex styles
7737 @c 
7738 @c All them variables, they make my head swim.  
7739 @c 
7740 @c So what if you want a different @code{Organization} and signature based
7741 @c on what groups you post to?  And you post both from your home machine
7742 @c and your work machine, and you want different @code{From} lines, and so
7743 @c on? 
7744 @c 
7745 @c @vindex gnus-posting-styles
7746 @c One way to do stuff like that is to write clever hooks that change the
7747 @c variables you need to have changed.  That's a bit boring, so somebody
7748 @c came up with the bright idea of letting the user specify these things in
7749 @c a handy alist.  Here's an example of a @code{gnus-posting-styles}
7750 @c variable: 
7751 @c 
7752 @c @lisp
7753 @c ((".*" 
7754 @c   (signature . "Peace and happiness")
7755 @c   (organization . "What me?"))
7756 @c  ("^comp" 
7757 @c   (signature . "Death to everybody"))
7758 @c  ("comp.emacs.i-love-it" 
7759 @c   (organization . "Emacs is it")))
7760 @c @end lisp
7761 @c 
7762 @c As you might surmise from this example, this alist consists of several
7763 @c @dfn{styles}.  Each style will be applicable if the first element
7764 @c ``matches'', in some form or other.  The entire alist will be iterated
7765 @c over, from the beginning towards the end, and each match will be
7766 @c applied, which means that attributes in later styles that match override
7767 @c the same attributes in earlier matching styles.  So
7768 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7769 @c signature and the @samp{What me?} @code{Organization} header.
7770 @c 
7771 @c The first element in each style is called the @code{match}.  If it's a
7772 @c string, then Gnus will try to regexp match it against the group name.
7773 @c If it's a function symbol, that function will be called with no
7774 @c arguments.  If it's a variable symbol, then the variable will be
7775 @c referenced.  If it's a list, then that list will be @code{eval}ed.  In
7776 @c any case, if this returns a non-@code{nil} value, then the style is said
7777 @c to @dfn{match}.
7778 @c 
7779 @c Each style may contain a arbitrary amount of @dfn{attributes}.  Each
7780 @c attribute consists of a @var{(name . value)} pair.  The attribute name
7781 @c can be one of @code{signature}, @code{organization} or @code{from}.  The
7782 @c attribute name can also be a string.  In that case, this will be used as
7783 @c a header name, and the value will be inserted in the headers of the
7784 @c article.
7785 @c 
7786 @c The attribute value can be a string (used verbatim), a function (the
7787 @c return value will be used), a variable (its value will be used) or a
7788 @c list (it will be @code{eval}ed and the return value will be used).
7789 @c 
7790 @c So here's a new example:
7791 @c 
7792 @c @lisp
7793 @c (setq gnus-posting-styles
7794 @c       '((".*" 
7795 @c           (signature . "~/.signature") 
7796 @c           (from . "user@@foo (user)")
7797 @c           ("X-Home-Page" . (getenv "WWW_HOME"))
7798 @c           (organization . "People's Front Against MWM"))
7799 @c         ("^rec.humor" 
7800 @c           (signature . my-funny-signature-randomizer))
7801 @c         ((equal (system-name) "gnarly")
7802 @c           (signature . my-quote-randomizer))
7803 @c         (posting-from-work-p
7804 @c           (signature . "~/.work-signature")
7805 @c           (from . "user@@bar.foo (user)")
7806 @c           (organization . "Important Work, Inc"))
7807 @c         ("^nn.+:" 
7808 @c           (signature . "~/.mail-signature"))))
7809 @c @end lisp
7810
7811 @c @node Drafts
7812 @c @section Drafts
7813 @c @cindex drafts
7814 @c 
7815 @c If you are writing a message (mail or news) and suddenly remember that
7816 @c you have a steak in the oven (or some pesto in the food processor, you
7817 @c craazy vegetarians), you'll probably wish there was a method to save the
7818 @c message you are writing so that you can continue editing it some other
7819 @c day, and send it when you feel its finished.
7820 @c 
7821 @c Well, don't worry about it.  Whenever you start composing a message of
7822 @c some sort using the Gnus mail and post commands, the buffer you get will
7823 @c automatically associate to an article in a special @dfn{draft} group.
7824 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7825 @c article will be saved there.  (Auto-save files also go to the draft
7826 @c group.) 
7827 @c 
7828 @c @cindex nndraft
7829 @c @vindex gnus-draft-group-directory
7830 @c The draft group is a special group (which is implemented as an
7831 @c @code{nndraft} group, if you absolutely have to know) called
7832 @c @samp{nndraft:drafts}.  The variable @code{gnus-draft-group-directory}
7833 @c controls both the name of the group and the location---the leaf element
7834 @c in the path will be used as the name of the group.  What makes this
7835 @c group special is that you can't tick any articles in it or mark any
7836 @c articles as read---all articles in the group are permanently unread.
7837 @c 
7838 @c If the group doesn't exist, it will be created and you'll be subscribed
7839 @c to it.
7840 @c 
7841 @c @findex gnus-dissociate-buffer-from-draft
7842 @c @kindex C-c M-d (Mail)
7843 @c @kindex C-c M-d (Post)
7844 @c @findex gnus-associate-buffer-with-draft
7845 @c @kindex C-c C-d (Mail)
7846 @c @kindex C-c C-d (Post)
7847 @c If you're writing some super-secret message that you later want to
7848 @c encode with PGP before sending, you may wish to turn the auto-saving
7849 @c (and association with the draft group) off.  You never know who might be
7850 @c interested in reading all your extremely valuable and terribly horrible
7851 @c and interesting secrets.  The @kbd{C-c M-d}
7852 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7853 @c If you change your mind and want to turn the auto-saving back on again,
7854 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7855 @c 
7856 @c @vindex gnus-use-draft
7857 @c To leave association with the draft group off by default, set
7858 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default. 
7859 @c 
7860 @c @findex gnus-summary-send-draft
7861 @c @kindex S D c (Summary)
7862 @c When you want to continue editing the article, you simply enter the
7863 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7864 @c that.  You will be placed in a buffer where you left off.
7865 @c 
7866 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7867 @c Articles}).
7868 @c 
7869 @c @findex gnus-summary-send-all-drafts
7870 @c If you have lots of rejected messages you want to post (or mail) without
7871 @c doing further editing, you can use the @kbd{S D a} command
7872 @c (@code{gnus-summary-send-all-drafts}).  This command understands the
7873 @c process/prefix convention (@pxref{Process/Prefix}).  
7874 @c 
7875 @c 
7876 @c @node Rejected Articles
7877 @c @section Rejected Articles
7878 @c @cindex rejected articles
7879 @c 
7880 @c Sometimes a news server will reject an article.  Perhaps the server
7881 @c doesn't like your face.  Perhaps it just feels miserable.  Perhaps
7882 @c @emph{there be demons}.  Perhaps you have included too much cited text.
7883 @c Perhaps the disk is full.  Perhaps the server is down.
7884 @c 
7885 @c These situations are, of course, totally beyond the control of Gnus.
7886 @c (Gnus, of course, loves the way you look, always feels great, has angels
7887 @c fluttering around inside of it, doesn't care about how much cited text
7888 @c you include, never runs full and never goes down.)  So Gnus saves these
7889 @c articles until some later time when the server feels better.
7890 @c 
7891 @c The rejected articles will automatically be put in a special draft group
7892 @c (@pxref{Drafts}).  When the server comes back up again, you'd then
7893 @c typically enter that group and send all the articles off.
7894 @c 
7895
7896 @node Select Methods
7897 @chapter Select Methods
7898 @cindex foreign groups
7899 @cindex select methods
7900
7901 A @dfn{foreign group} is a group that is not read by the usual (or
7902 default) means.  It could be, for instance, a group from a different
7903 @sc{nntp} server, it could be a virtual group, or it could be your own
7904 personal mail group.
7905
7906 A foreign group (or any group, really) is specified by a @dfn{name} and
7907 a @dfn{select method}.  To take the latter first, a select method is a
7908 list where the first element says what backend to use (e.g. @code{nntp},
7909 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7910 name}.  There may be additional elements in the select method, where the
7911 value may have special meaning for the backend in question.
7912
7913 One could say that a select method defines a @dfn{virtual server}---so
7914 we do just that (@pxref{The Server Buffer}).
7915
7916 The @dfn{name} of the group is the name the backend will recognize the
7917 group as.
7918
7919 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7920 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7921 method @code{(nntp "some.where.edu")}.  Gnus will call this group
7922 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7923 backend just knows this group as @samp{soc.motss}.
7924
7925 The different methods all have their peculiarities, of course.
7926
7927 @menu
7928 * The Server Buffer::     Making and editing virtual servers.
7929 * Getting News::          Reading USENET news with Gnus.
7930 * Getting Mail::          Reading your personal mail with Gnus.
7931 * Other Sources::         Reading directories, files, SOUP packets.
7932 * Combined Groups::       Combining groups into one group.
7933 @end menu
7934
7935
7936 @node The Server Buffer
7937 @section The Server Buffer
7938
7939 Traditionally, a @dfn{server} is a machine or a piece of software that
7940 one connects to, and then requests information from.  Gnus does not
7941 connect directly to any real servers, but does all transactions through
7942 one backend or other.  But that's just putting one layer more between
7943 the actual media and Gnus, so we might just as well say that each
7944 backend represents a virtual server.
7945
7946 For instance, the @code{nntp} backend may be used to connect to several
7947 different actual @sc{nntp} servers, or, perhaps, to many different ports
7948 on the same actual @sc{nntp} server.  You tell Gnus which backend to
7949 use, and what parameters to set by specifying a @dfn{select method}.
7950
7951 These select methods specifications can sometimes become quite
7952 complicated---say, for instance, that you want to read from the
7953 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7954 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
7955 Anyways, if you had to specify that for each group that used this
7956 server, that would be too much work, so Gnus offers a way of naming
7957 select methods, which is what you do in the server buffer.
7958
7959 To enter the server buffer, user the @kbd{^}
7960 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7961
7962 @menu
7963 * Server Buffer Format::      You can customize the look of this buffer.
7964 * Server Commands::           Commands to manipulate servers.
7965 * Example Methods::           Examples server specifications.
7966 * Creating a Virtual Server:: An example session.
7967 * Server Variables::          Which variables to set.
7968 * Servers and Methods::       You can use server names as select methods.
7969 * Unavailable Servers::       Some servers you try to contact may be down.
7970 @end menu
7971
7972 @vindex gnus-server-mode-hook
7973 @code{gnus-server-mode-hook} is run when creating the server buffer.
7974
7975
7976 @node Server Buffer Format
7977 @subsection Server Buffer Format
7978 @cindex server buffer format
7979
7980 @vindex gnus-server-line-format
7981 You can change the look of the server buffer lines by changing the
7982 @code{gnus-server-line-format} variable.  This is a @code{format}-like
7983 variable, with some simple extensions:
7984
7985 @table @samp
7986
7987 @item h 
7988 How the news is fetched---the backend name.
7989
7990 @item n
7991 The name of this server.
7992
7993 @item w
7994 Where the news is to be fetched from---the address.
7995
7996 @item s
7997 The opened/closed/denied status of the server.
7998 @end table
7999
8000 @vindex gnus-server-mode-line-format
8001 The mode line can also be customized by using the
8002 @code{gnus-server-mode-line-format} variable.  The following specs are
8003 understood: 
8004
8005 @table @samp
8006 @item S
8007 Server name.
8008
8009 @item M
8010 Server method.
8011 @end table
8012
8013 Also @pxref{Formatting Variables}.
8014
8015
8016 @node Server Commands
8017 @subsection Server Commands
8018 @cindex server commands
8019
8020 @table @kbd
8021
8022 @item a
8023 @kindex a (Server)
8024 @findex gnus-server-add-server
8025 Add a new server (@code{gnus-server-add-server}).
8026
8027 @item e
8028 @kindex e (Server)
8029 @findex gnus-server-edit-server
8030 Edit a server (@code{gnus-server-edit-server}).
8031
8032 @item SPACE
8033 @kindex SPACE (Server)
8034 @findex gnus-server-read-server
8035 Browse the current server (@code{gnus-server-read-server}).
8036
8037 @item q
8038 @kindex q (Server)
8039 @findex gnus-server-exit
8040 Return to the group buffer (@code{gnus-server-exit}).
8041
8042 @item k
8043 @kindex k (Server)
8044 @findex gnus-server-kill-server
8045 Kill the current server (@code{gnus-server-kill-server}).
8046
8047 @item y
8048 @kindex y (Server)
8049 @findex gnus-server-yank-server
8050 Yank the previously killed server (@code{gnus-server-yank-server}).
8051
8052 @item c
8053 @kindex c (Server)
8054 @findex gnus-server-copy-server
8055 Copy the current server (@code{gnus-server-copy-server}).
8056
8057 @item l
8058 @kindex l (Server)
8059 @findex gnus-server-list-servers
8060 List all servers (@code{gnus-server-list-servers}).
8061
8062 @item s
8063 @kindex s (Server)
8064 @findex gnus-server-scan-server
8065 Request that the server scan its sources for new articles
8066 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8067 servers. 
8068
8069 @item g
8070 @kindex g (Server)
8071 @findex gnus-server-regenerate-server
8072 Request that the server regenerate all its data structures
8073 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8074 a mail backend that has gotten out of synch.
8075
8076 @end table
8077
8078
8079 @node Example Methods
8080 @subsection Example Methods
8081
8082 Most select methods are pretty simple and self-explanatory: 
8083
8084 @lisp
8085 (nntp "news.funet.fi")
8086 @end lisp
8087
8088 Reading directly from the spool is even simpler:
8089
8090 @lisp
8091 (nnspool "")
8092 @end lisp
8093
8094 As you can see, the first element in a select method is the name of the
8095 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8096 will. 
8097
8098 After these two elements, there may be a arbitrary number of
8099 @var{(variable form)} pairs.
8100
8101 To go back to the first example---imagine that you want to read from
8102 port 15 from that machine.  This is what the select method should
8103 look like then:
8104
8105 @lisp
8106 (nntp "news.funet.fi" (nntp-port-number 15))
8107 @end lisp
8108
8109 You should read the documentation to each backend to find out what
8110 variables are relevant, but here's an @code{nnmh} example. 
8111
8112 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8113 you have two structures that you wish to access: One is your private
8114 mail spool, and the other is a public one.  Here's the possible spec for
8115 you private mail:
8116
8117 @lisp
8118 (nnmh "private" (nnmh-directory "~/private/mail/"))
8119 @end lisp
8120
8121 (This server is then called @samp{private}, but you may have guessed
8122 that.)
8123
8124 Here's the method for a public spool:
8125
8126 @lisp
8127 (nnmh "public" 
8128       (nnmh-directory "/usr/information/spool/") 
8129       (nnmh-get-new-mail nil))
8130 @end lisp
8131
8132 If you are behind a firewall and only have access to the @sc{nntp}
8133 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8134 on the firewall machine and telnet from there to the @sc{nntp} server.
8135 Doing this can be rather fiddly, but your virtual server definition
8136 should probably look something like this:
8137
8138 @lisp
8139 (nntp "firewall"
8140       (nntp-address "the.firewall.machine")
8141       (nntp-open-connection-function nntp-open-rlogin)
8142       (nntp-end-of-line "\n")
8143       (nntp-rlogin-parameters
8144        ("telnet" "the.real.nntp.host" "nntp")))
8145 @end lisp
8146
8147
8148
8149 @node Creating a Virtual Server
8150 @subsection Creating a Virtual Server
8151
8152 If you're saving lots of articles in the cache by using persistent
8153 articles, you may want to create a virtual server to read the cache.
8154
8155 First you need to add a new server.  The @kbd{a} command does that.  It
8156 would probably be best to use @code{nnspool} to read the cache.  You
8157 could also use @code{nnml} or @code{nnmh}, though.
8158
8159 Type @kbd{a nnspool RET cache RET}.
8160
8161 You should now have a brand new @code{nnspool} virtual server called
8162 @samp{cache}.  You now need to edit it to have the right definitions.
8163 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8164 will contain the following:
8165
8166 @lisp
8167 (nnspool "cache")
8168 @end lisp
8169
8170 Change that to:
8171
8172 @lisp
8173 (nnspool "cache"
8174          (nnspool-spool-directory "~/News/cache/")
8175          (nnspool-nov-directory "~/News/cache/")
8176          (nnspool-active-file "~/News/cache/active"))
8177 @end lisp
8178
8179 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8180 @kbd{RET} over this virtual server, you should be entered into a browse
8181 buffer, and you should be able to enter any of the groups displayed.
8182
8183
8184 @node Server Variables
8185 @subsection Server Variables
8186
8187 One sticky point when defining variables (both on backends and in Emacs
8188 in general) is that some variables are typically initialized from other
8189 variables when the definition of the variables is being loaded.  If you
8190 change the "base" variable after the variables have been loaded, you
8191 won't change the "derived" variables.
8192
8193 This typically affects directory and file variables.  For instance,
8194 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8195 directory variables are initialized from that variable, so
8196 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8197 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8198 @code{nnml-directory}---you have to explicitly set all the file
8199 variables to be what you want them to be.  For a complete list of
8200 variables for each backend, see each backend's section later in this
8201 manual, but here's an example @code{nnml} definition:
8202
8203 @lisp
8204 (nnml "public" 
8205       (nnml-directory "~/my-mail/")
8206       (nnml-active-file "~/my-mail/active")
8207       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8208 @end lisp
8209
8210
8211 @node Servers and Methods
8212 @subsection Servers and Methods
8213
8214 Wherever you would normally use a select method
8215 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8216 when browsing a foreign server) you can use a virtual server name
8217 instead.  This could potentially save lots of typing.  And it's nice all
8218 over.
8219
8220
8221 @node Unavailable Servers
8222 @subsection Unavailable Servers
8223
8224 If a server seems to be unreachable, Gnus will mark that server as
8225 @code{denied}.  That means that any subsequent attempt to make contact
8226 with that server will just be ignored.  ``It can't be opened,'' Gnus
8227 will tell you, without making the least effort to see whether that is
8228 actually the case or not.
8229
8230 That might seem quite naughty, but it does make sense most of the time.
8231 Let's say you have 10 groups subscribed to the server
8232 @samp{nepholococcygia.com}.  This server is located somewhere quite far
8233 away from you, the machine is quite, so it takes 1 minute just to find
8234 out that it refuses connection from you today.  If Gnus were to attempt
8235 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8236 that.  Once it has gotten a single ``connection refused'', it will
8237 regard that server as ``down''.
8238
8239 So, what happens if the machine was only feeling unwell temporarily?
8240 How do you test to see whether the machine has come up again?
8241
8242 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8243 with the following commands:
8244
8245 @table @kbd
8246
8247 @item O
8248 @kindex O (Server)
8249 @findex gnus-server-open-server
8250 Try to establish connection to the server on the current line
8251 (@code{gnus-server-open-server}).
8252
8253 @item C
8254 @kindex C (Server)
8255 @findex gnus-server-close-server
8256 Close the connection (if any) to the server
8257 (@code{gnus-server-close-server}).
8258
8259 @item D
8260 @kindex D (Server)
8261 @findex gnus-server-deny-server
8262 Mark the current server as unreachable
8263 (@code{gnus-server-deny-server}). 
8264
8265 @item M-o
8266 @kindex M-o (Server)
8267 @findex gnus-server-open-all-servers
8268 Open the connections to all servers in the buffer
8269 (@code{gnus-server-open-all-servers}). 
8270
8271 @item M-c
8272 @kindex M-c (Server)
8273 @findex gnus-server-close-all-servers
8274 Close the connections to all servers in the buffer
8275 (@code{gnus-server-close-all-servers}). 
8276
8277 @item R
8278 @kindex R (Server)
8279 @findex gnus-server-remove-denials
8280 Remove all marks to whether Gnus was denied connection from all servers
8281 (@code{gnus-server-remove-denials}). 
8282
8283 @end table
8284
8285
8286 @node Getting News
8287 @section Getting News
8288 @cindex reading news
8289 @cindex news backends
8290
8291 A newsreader is normally used for reading news.  Gnus currently provides
8292 only two methods of getting news---it can read from an @sc{nntp} server,
8293 or it can read from a local spool.
8294
8295 @menu
8296 * NNTP::               Reading news from an @sc{nntp} server.
8297 * News Spool::         Reading news from the local spool.
8298 @end menu
8299
8300
8301 @node NNTP
8302 @subsection @sc{nntp}
8303 @cindex nntp
8304
8305 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8306 You just specify @code{nntp} as method and the address of the @sc{nntp}
8307 server as the, uhm, address.
8308
8309 If the @sc{nntp} server is located at a non-standard port, setting the
8310 third element of the select method to this port number should allow you
8311 to connect to the right port.  You'll have to edit the group info for
8312 that (@pxref{Foreign Groups}).
8313
8314 The name of the foreign group can be the same as a native group.  In
8315 fact, you can subscribe to the same group from as many different servers
8316 you feel like.  There will be no name collisions.
8317
8318 The following variables can be used to create a virtual @code{nntp}
8319 server: 
8320
8321 @table @code
8322
8323 @item nntp-server-opened-hook
8324 @vindex nntp-server-opened-hook
8325 @cindex @sc{mode reader}
8326 @cindex authinfo
8327 @cindex authentification
8328 @cindex nntp authentification
8329 @findex nntp-send-authinfo
8330 @findex nntp-send-mode-reader
8331 @code{nntp-server-opened-hook} is run after a connection has been made.
8332 It can be used to send commands to the @sc{nntp} server after it has
8333 been contacted.  By default is sends the command @code{MODE READER} to
8334 the server with the @code{nntp-send-mode-reader} function. 
8335
8336 @item nntp-authinfo-function 
8337 @vindex nntp-authinfo-function 
8338 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8339 server.  Available functions include:
8340
8341 @table @code
8342 @item nntp-send-authinfo
8343 @findex nntp-send-authinfo
8344 This function will used you current login name as the user name and will
8345 prompt you for the password.  This is the default.
8346
8347 @item nntp-send-nosy-authinfo
8348 @findex nntp-send-nosy-authinfo
8349 This function will prompt you for both user name and password.
8350
8351 @item nntp-send-authinfo-from-file
8352 @findex nntp-send-authinfo-from-file
8353 This function will use your current login name as the user name and will
8354 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8355 @end table
8356
8357 @item nntp-server-action-alist 
8358 @vindex nntp-server-action-alist 
8359 This is an list of regexps to match on server types and actions to be
8360 taken when matches are made.  For instance, if you want Gnus to beep
8361 every time you connect to innd, you could say something like:
8362
8363 @lisp
8364 (setq nntp-server-action-alist
8365       '(("innd" (ding))))
8366 @end lisp
8367
8368 You probably don't want to do that, though.
8369
8370 The default value is
8371
8372 @lisp
8373   '(("nntpd 1\\.5\\.11t" 
8374      (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8375 @end lisp
8376
8377 This ensures that Gnus doesn't send the @code{MODE READER} command to
8378 nntpd 1.5.11t, since that command chokes that server, I've been told. 
8379
8380 @item nntp-maximum-request
8381 @vindex nntp-maximum-request
8382 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8383 will collect headers by sending a series of @code{head} commands.  To
8384 speed things up, the backend sends lots of these commands without
8385 waiting for reply, and then reads all the replies.  This is controlled
8386 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8387 your network is buggy, you should set this to 1.
8388
8389 @item nntp-connection-timeout
8390 @vindex nntp-connection-timeout
8391 If you have lots of foreign @code{nntp} groups that you connect to
8392 regularly, you're sure to have problems with @sc{nntp} servers not
8393 responding properly, or being too loaded to reply within reasonable
8394 time.  This is can lead to awkward problems, which can be helped
8395 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8396 that says how many seconds the @code{nntp} backend should wait for a
8397 connection before giving up.  If it is @code{nil}, which is the default,
8398 no timeouts are done.
8399
8400 @item nntp-command-timeout
8401 @vindex nntp-command-timeout
8402 @cindex PPP connections
8403 @cindex dynamic IP addresses
8404 If you're running Gnus on a machine that has a dynamically assigned
8405 address, Gnus may become confused.  If the address of your machine
8406 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8407 waiting forever for replies from the server.  To help with this
8408 unfortunate problem, you can set this command to a number.  Gnus will
8409 then, if it sits waiting longer than that number of seconds for a reply
8410 from the server, shut down the connection, start a new one, and resend
8411 the command.  This should hopefully be transparent to the user.  A
8412 likely number is 30 seconds. 
8413
8414 @item nntp-retry-on-break
8415 @vindex nntp-retry-on-break
8416 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8417 hangs.  This will have much the same effect as the command timeout
8418 described above.
8419
8420 @item nntp-server-hook
8421 @vindex nntp-server-hook
8422 This hook is run as the last step when connecting to an @sc{nntp}
8423 server.
8424
8425 @findex nntp-open-rlogin
8426 @findex nntp-open-network-stream
8427 @item nntp-open-connection-function
8428 @vindex nntp-open-connection-function
8429 This function is used to connect to the remote system.  Two pre-made
8430 functions are @code{nntp-open-network-stream}, which is the default, and
8431 simply connects to some port or other on the remote system.  The other
8432 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8433 and then does a telnet to the @sc{nntp} server available there.
8434
8435 @item nntp-rlogin-parameters
8436 @vindex nntp-rlogin-parameters
8437 If you use @code{nntp-open-rlogin} as the
8438 @code{nntp-open-connection-function}, this list will be used as the
8439 parameter list given to @code{rsh}.
8440
8441 @item nntp-end-of-line
8442 @vindex nntp-end-of-line
8443 String to use as end-of-line markers when talking to the @sc{nntp}
8444 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8445 using @code{rlogin} to talk to the server.
8446
8447 @item nntp-rlogin-user-name
8448 @vindex nntp-rlogin-user-name
8449 User name on the remote system when using the @code{rlogin} connect
8450 function. 
8451
8452 @item nntp-address
8453 @vindex nntp-address
8454 The address of the remote system running the @sc{nntp} server.
8455
8456 @item nntp-port-number
8457 @vindex nntp-port-number
8458 Port number to connect to when using the @code{nntp-open-network-stream}
8459 connect function.
8460
8461 @item nntp-buggy-select
8462 @vindex nntp-buggy-select
8463 Set this to non-@code{nil} if your select routine is buggy.
8464
8465 @item nntp-nov-is-evil 
8466 @vindex nntp-nov-is-evil 
8467 If the @sc{nntp} server does not support @sc{nov}, you could set this
8468 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8469 can be used automatically.
8470
8471 @item nntp-xover-commands
8472 @vindex nntp-xover-commands
8473 @cindex nov
8474 @cindex XOVER
8475 List of strings that are used as commands to fetch @sc{nov} lines from a
8476 server.  The default value of this variable is @code{("XOVER"
8477 "XOVERVIEW")}. 
8478
8479 @item nntp-nov-gap
8480 @vindex nntp-nov-gap
8481 @code{nntp} normally sends just one big request for @sc{nov} lines to
8482 the server.  The server responds with one huge list of lines.  However,
8483 if you have read articles 2-5000 in the group, and only want to read
8484 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8485 lines that you do not want, and will not use.  This variable says how
8486 big a gap between two consecutive articles is allowed to be before the
8487 @code{XOVER} request is split into several request.  Note that if your
8488 network is fast, setting this variable to a really small number means
8489 that fetching will probably be slower.  If this variable is @code{nil},
8490 @code{nntp} will never split requests.
8491
8492 @item nntp-prepare-server-hook
8493 @vindex nntp-prepare-server-hook
8494 A hook run before attempting to connect to an @sc{nntp} server.
8495
8496 @item nntp-warn-about-losing-connection
8497 @vindex nntp-warn-about-losing-connection
8498 If this variable is non-@code{nil}, some noise will be made when a
8499 server closes connection.
8500
8501 @end table
8502
8503
8504 @node News Spool
8505 @subsection News Spool
8506 @cindex nnspool
8507 @cindex news spool
8508
8509 Subscribing to a foreign group from the local spool is extremely easy,
8510 and might be useful, for instance, to speed up reading groups that
8511 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8512 instance. 
8513
8514 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8515 anything else) as the address.
8516
8517 If you have access to a local spool, you should probably use that as the
8518 native select method (@pxref{Finding the News}).  It is normally faster
8519 than using an @code{nntp} select method, but might not be.  It depends.
8520 You just have to try to find out what's best at your site.
8521
8522 @table @code
8523
8524 @item nnspool-inews-program
8525 @vindex nnspool-inews-program
8526 Program used to post an article.
8527
8528 @item nnspool-inews-switches
8529 @vindex nnspool-inews-switches
8530 Parameters given to the inews program when posting an article. 
8531
8532 @item nnspool-spool-directory
8533 @vindex nnspool-spool-directory
8534 Where @code{nnspool} looks for the articles.  This is normally
8535 @file{/usr/spool/news/}.
8536
8537 @item nnspool-nov-directory 
8538 @vindex nnspool-nov-directory 
8539 Where @code{nnspool} will look for @sc{nov} files.  This is normally
8540 @file{/usr/spool/news/over.view/}.
8541
8542 @item nnspool-lib-dir
8543 @vindex nnspool-lib-dir
8544 Where the news lib dir is (@file{/usr/lib/news/} by default).
8545
8546 @item nnspool-active-file
8547 @vindex nnspool-active-file
8548 The path of the active file.
8549
8550 @item nnspool-newsgroups-file
8551 @vindex nnspool-newsgroups-file
8552 The path of the group descriptions file.
8553
8554 @item nnspool-history-file
8555 @vindex nnspool-history-file
8556 The path of the news history file.
8557
8558 @item nnspool-active-times-file
8559 @vindex nnspool-active-times-file
8560 The path of the active date file.
8561
8562 @item nnspool-nov-is-evil
8563 @vindex nnspool-nov-is-evil
8564 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8565 that it finds.
8566
8567 @item nnspool-sift-nov-with-sed
8568 @vindex nnspool-sift-nov-with-sed
8569 @cindex sed
8570 If non-@code{nil}, which is the default, use @code{sed} to get the
8571 relevant portion from the overview file.  If nil, @code{nnspool} will
8572 load the entire file into a buffer and process it there.
8573
8574 @end table
8575
8576
8577 @node Getting Mail
8578 @section Getting Mail
8579 @cindex reading mail
8580 @cindex mail
8581
8582 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8583 course.
8584
8585 @menu
8586 * Getting Started Reading Mail:: A simple cookbook example.
8587 * Splitting Mail::               How to create mail groups.
8588 * Mail Backend Variables::       Variables for customizing mail handling.
8589 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
8590 * Mail and Procmail::            Reading mail groups that procmail create.
8591 * Incorporating Old Mail::       What about the old mail you have?
8592 * Expiring Mail::                Getting rid of unwanted mail.
8593 * Washing Mail::                 Removing gruft from the mail you get.
8594 * Duplicates::                   Dealing with duplicated mail.
8595 * Not Reading Mail::             Using mail backends for reading other files.
8596 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
8597 @end menu
8598
8599
8600 @node Getting Started Reading Mail
8601 @subsection Getting Started Reading Mail
8602
8603 It's quite easy to use Gnus to read your new mail.  You just plonk the
8604 mail backend of your choice into @code{gnus-secondary-select-methods},
8605 and things will happen automatically.
8606
8607 For instance, if you want to use @code{nnml} (which is a one file per
8608 mail backend), you could put the following in your @file{.gnus} file:
8609
8610 @lisp
8611 (setq gnus-secondary-select-methods
8612       '((nnml "private")))
8613 @end lisp
8614
8615 Now, the next time you start Gnus, this backend will be queried for new
8616 articles, and it will move all the messages in your spool file to its
8617 directory, which is @code{~/Mail/} by default.  The new group that will
8618 be created (@samp{mail.misc}) will be subscribed, and you can read it
8619 like any other group.
8620
8621 You will probably want to split the mail into several groups, though:
8622
8623 @lisp
8624 (setq nnmail-split-methods
8625       '(("junk" "^From:.*Lars Ingebrigtsen")
8626        ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8627        ("other" "")))
8628 @end lisp
8629
8630 This will result in three new @code{nnml} mail groups being created:
8631 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
8632 mail that doesn't fit into the first two groups will be placed in the
8633 latter group.
8634
8635 This should be sufficient for reading mail with Gnus.  You might want to
8636 give the other sections in this part of the manual a perusal, though,
8637 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}. 
8638
8639
8640 @node Splitting Mail
8641 @subsection Splitting Mail
8642 @cindex splitting mail
8643 @cindex mail splitting
8644
8645 @vindex nnmail-split-methods
8646 The @code{nnmail-split-methods} variable says how the incoming mail is
8647 to be split into groups.
8648
8649 @lisp
8650 (setq nnmail-split-methods
8651   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8652     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8653     ("mail.other" "")))
8654 @end lisp
8655
8656 This variable is a list of lists, where the first element of each of
8657 these lists is the name of the mail group (they do not have to be called
8658 something beginning with @samp{mail}, by the way), and the second
8659 element is a regular expression used on the header of each mail to
8660 determine if it belongs in this mail group.
8661
8662 If the first element is the special symbol @code{junk}, then messages
8663 that match the regexp will disappear into the aether.  Use with
8664 extreme caution. 
8665
8666 The second element can also be a function.  In that case, it will be
8667 called narrowed to the headers with the first element of the rule as the
8668 argument.  It should return a non-@code{nil} value if it thinks that the
8669 mail belongs in that group.
8670
8671 The last of these groups should always be a general one, and the regular
8672 expression should @emph{always} be @samp{} so that it matches any mails
8673 that haven't been matched by any of the other regexps.  (These rules are
8674 processed from the beginning of the alist toward the end.  The first
8675 rule to make a match will "win", unless you have crossposting enabled.
8676 In that case, all matching rules will "win".)
8677
8678 If you like to tinker with this yourself, you can set this variable to a
8679 function of your choice.  This function will be called without any
8680 arguments in a buffer narrowed to the headers of an incoming mail
8681 message.  The function should return a list of groups names that it
8682 thinks should carry this mail message.
8683
8684 Note that the mail backends are free to maul the poor, innocent
8685 incoming headers all they want to.  They all add @code{Lines} headers;
8686 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8687 @code{From<SPACE>} line to something else.
8688
8689 @vindex nnmail-crosspost
8690 The mail backends all support cross-posting.  If several regexps match,
8691 the mail will be ``cross-posted'' to all those groups.
8692 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
8693 that no articles are crossposted to the general (@samp{}) group.
8694
8695 @vindex nnmail-crosspost-link-function
8696 @cindex crosspost
8697 @cindex links
8698 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8699 the crossposted articles.  However, not all files systems support hard
8700 links.  If that's the case for you, set
8701 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
8702 variable is @code{add-name-to-file} by default.)  
8703
8704 @kindex M-x nnmail-split-history
8705 @kindex nnmail-split-history
8706 If you wish to see where the previous mail split put the messages, you
8707 can use the @kbd{M-x nnmail-split-history} command.
8708
8709 Gnus gives you all the opportunity you could possibly want for shooting
8710 yourself in the foot.  Let's say you create a group that will contain
8711 all the mail you get from your boss.  And then you accidentally
8712 unsubscribe from the group.  Gnus will still put all the mail from your
8713 boss in the unsubscribed group, and so, when your boss mails you ``Have
8714 that report ready by Monday or you're fired!'', you'll never see it and,
8715 come Tuesday, you'll still believe that you're gainfully employed while
8716 you really should be out collecting empty bottles to save up for next
8717 month's rent money.
8718
8719
8720 @node Mail Backend Variables
8721 @subsection Mail Backend Variables
8722
8723 These variables are (for the most part) pertinent to all the various
8724 mail backends.
8725
8726 @table @code
8727 @vindex nnmail-read-incoming-hook
8728 @item nnmail-read-incoming-hook
8729 The mail backends all call this hook after reading new mail.  You can
8730 use this hook to notify any mail watch programs, if you want to.
8731
8732 @vindex nnmail-spool-file
8733 @item nnmail-spool-file
8734 @cindex POP mail
8735 @cindex MAILHOST
8736 @cindex movemail
8737 @vindex nnmail-pop-password
8738 @vindex nnmail-pop-password-required
8739 The backends will look for new mail in this file.  If this variable is
8740 @code{nil}, the mail backends will never attempt to fetch mail by
8741 themselves.  If you are using a POP mail server and your name is
8742 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
8743 your name is not @samp{larsi}, you should probably modify that
8744 slightly, but you may have guessed that already, you smart & handsome
8745 devil!  You can also set this variable to @code{pop}, and Gnus will try
8746 to figure out the POP mail string by itself.  In any case, Gnus will
8747 call @code{movemail} which will contact the POP server named in the
8748 @code{MAILHOST} environment variable.  If the POP server needs a
8749 password, you can either set @code{nnmail-pop-password-required} to
8750 @code{t} and be prompted for the password, or set
8751 @code{nnmail-pop-password} to the password itself.
8752
8753 @code{nnmail-spool-file} can also be a list of mailboxes.
8754
8755 Your Emacs has to have been configured with @samp{--with-pop} before
8756 compilation.  This is the default, but some installations have it
8757 switched off.
8758
8759 When you use a mail backend, Gnus will slurp all your mail from your
8760 inbox and plonk it down in your home directory.  Gnus doesn't move any
8761 mail if you're not using a mail backend---you have to do a lot of magic
8762 invocations first.  At the time when you have finished drawing the
8763 pentagram, lightened the candles, and sacrificed the goat, you really
8764 shouldn't be too surprised when Gnus moves your mail.
8765
8766 @vindex nnmail-use-procmail
8767 @vindex nnmail-procmail-suffix
8768 @item nnmail-use-procmail
8769 If non-@code{nil}, the mail backends will look in
8770 @code{nnmail-procmail-directory} for incoming mail.  All the files in
8771 that directory that have names ending in @code{nnmail-procmail-suffix}
8772 will be considered incoming mailboxes, and will be searched for new
8773 mail.
8774
8775 @vindex nnmail-crash-box
8776 @item nnmail-crash-box
8777 When the mail backends read a spool file, it is first moved to this
8778 file, which is @file{~/.gnus-crash-box} by default.  If this file
8779 already exists, it will always be read (and incorporated) before any
8780 other spool files.
8781
8782 @vindex nnmail-prepare-incoming-hook
8783 @item nnmail-prepare-incoming-hook
8784 This is run in a buffer that holds all the new incoming mail, and can be
8785 used for, well, anything, really.
8786
8787 @vindex nnmail-split-hook
8788 @item nnmail-split-hook
8789 @findex article-decode-rfc1522
8790 @findex RFC1522 decoding
8791 Hook run in the buffer where the mail headers of each message is kept
8792 just before the splitting based on these headers is done.  The hook is
8793 free to modify the buffer contents in any way it sees fit---the buffer
8794 is discarded after the splitting has been done, and no changes performed
8795 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
8796 is one likely function to add to this hook.
8797
8798 @vindex nnmail-pre-get-new-mail-hook
8799 @vindex nnmail-post-get-new-mail-hook
8800 @item nnmail-pre-get-new-mail-hook
8801 @itemx nnmail-post-get-new-mail-hook
8802 These are two useful hooks executed when treating new incoming
8803 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8804 starting to handle the new mail) and
8805 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8806 is done).  Here's and example of using these two hooks to change the
8807 default file modes the new mail files get:
8808
8809 @lisp
8810 (add-hook 'gnus-pre-get-new-mail-hook 
8811           (lambda () (set-default-file-modes 511)))
8812
8813 (add-hook 'gnus-post-get-new-mail-hook 
8814           (lambda () (set-default-file-modes 551)))
8815 @end lisp
8816
8817 @item nnmail-tmp-directory
8818 @vindex nnmail-tmp-directory
8819 This variable says where to move the incoming mail to while processing
8820 it.  This is usually done in the same directory that the mail backend
8821 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8822 it will be used instead.
8823
8824 @item nnmail-movemail-program
8825 @vindex nnmail-movemail-program
8826 This program is executed to move mail from the user's inbox to her home
8827 directory.  The default is @samp{movemail}.
8828
8829 This can also be a function.  In that case, the function will be called
8830 with two parameters -- the name of the inbox, and the file to be moved
8831 to.
8832
8833 @item nnmail-delete-incoming
8834 @vindex nnmail-delete-incoming
8835 @cindex incoming mail files
8836 @cindex deleting incoming files
8837 If non-@code{nil}, the mail backends will delete the temporary incoming
8838 file after splitting mail into the proper groups.  This is @code{t} by
8839 default.
8840
8841 @c This is @code{nil} by
8842 @c default for reasons of security.
8843
8844 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8845 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8846 lost mail, I think, but that's not the point.  (Except certain versions
8847 of Red Gnus.))  By not deleting the Incoming* files, one can be sure to
8848 not lose mail -- if Gnus totally whacks out, one can always recover what
8849 was lost.
8850
8851 Delete the @file{Incoming*} files at will.
8852
8853 @item nnmail-use-long-file-names
8854 @vindex nnmail-use-long-file-names
8855 If non-@code{nil}, the mail backends will use long file and directory
8856 names.  Groups like @samp{mail.misc} will end up in directories like
8857 @file{mail.misc/}.  If it is @code{nil}, the same group will end up in
8858 @file{mail/misc/}.
8859
8860 @item nnmail-delete-file-function
8861 @vindex nnmail-delete-file-function
8862 @findex delete-file
8863 Function called to delete files.  It is @code{delete-file} by default. 
8864
8865 @end table
8866
8867
8868 @node Fancy Mail Splitting
8869 @subsection Fancy Mail Splitting
8870 @cindex mail splitting
8871 @cindex fancy mail splitting
8872
8873 @vindex nnmail-split-fancy
8874 @findex nnmail-split-fancy
8875 If the rather simple, standard method for specifying how to split mail
8876 doesn't allow you to do what you want, you can set
8877 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
8878 play with the @code{nnmail-split-fancy} variable.
8879
8880 Let's look at an example value of this variable first:
8881
8882 @lisp
8883 ;; Messages from the mailer daemon are not crossposted to any of
8884 ;; the ordinary groups.  Warnings are put in a separate group
8885 ;; from real errors.
8886 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8887                    "mail.misc"))
8888    ;; Non-error messages are crossposted to all relevant
8889    ;; groups, but we don't crosspost between the group for the
8890    ;; (ding) list and the group for other (ding) related mail.
8891    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8892          ("subject" "ding" "ding.misc"))
8893       ;; Other mailing lists...
8894       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8895       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8896       ;; People...
8897       (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8898    ;; Unmatched mail goes to the catch all group.
8899    "misc.misc")
8900 @end lisp
8901
8902 This variable has the format of a @dfn{split}.  A split is a (possibly)
8903 recursive structure where each split may contain other splits.  Here are
8904 the five possible split syntaxes:
8905
8906 @enumerate
8907
8908 @item 
8909 @samp{group}: If the split is a string, that will be taken as a group name. 
8910
8911 @item
8912 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8913 element is a string, then that means that if header FIELD (a regexp)
8914 contains VALUE (also a regexp), then store the message as specified by
8915 SPLIT.
8916
8917 @item
8918 @var{(| SPLIT...)}: If the split is a list, and the first element is
8919 @code{|} (vertical bar), then process each SPLIT until one of them
8920 matches.  A SPLIT is said to match if it will cause the mail message to
8921 be stored in one or more groups.
8922
8923 @item
8924 @var{(& SPLIT...)}: If the split is a list, and the first element is
8925 @code{&}, then process all SPLITs in the list.
8926
8927 @item 
8928 @code{junk}: If the split is the symbol @code{junk}, then don't save
8929 this message anywhere.
8930
8931 @item
8932 @var{(: function arg1 arg2 ...)}:  If the split is a list, and the first
8933 element is @code{:}, then the second element will be called as a
8934 function with @var{args} given as arguments.  The function should return
8935 a SPLIT.
8936
8937 @end enumerate
8938
8939 In these splits, @var{FIELD} must match a complete field name.
8940 @var{VALUE} must match a complete word according to the fundamental mode
8941 syntax table.  You can use @code{.*} in the regexps to match partial
8942 field names or words.  In other words, all @var{VALUE}'s are wrapped in
8943 @samp{\<} and @samp{\>} pairs.
8944
8945 @vindex nnmail-split-abbrev-alist
8946 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8947 are expanded as specified by the variable
8948 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
8949 the car of the cells contains the key, and the cdr contains a string.
8950
8951 @vindex nnmail-split-fancy-syntax-table
8952 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8953 when all this splitting is performed.
8954
8955 If you want to have Gnus create groups dynamically based on some
8956 information in the headers, you can say things like:
8957
8958 @example
8959 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8960 @end example
8961
8962 That is, do @code{replace-match}-like substitions in the group names. 
8963
8964
8965 @node Mail and Procmail
8966 @subsection Mail and Procmail
8967 @cindex procmail
8968
8969 @cindex slocal
8970 @cindex elm
8971 Many people use @code{procmail} (or some other mail filter program or
8972 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8973 incoming mail into groups.  If you do that, you should set
8974 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8975 backends never ever try to fetch mail by themselves.
8976
8977 This also means that you probably don't want to set
8978 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8979 side effects.
8980
8981 When a mail backend is queried for what groups it carries, it replies
8982 with the contents of that variable, along with any groups it has figured
8983 out that it carries by other means.  None of the backends (except
8984 @code{nnmh}) actually go out to the disk and check what groups actually
8985 exist.  (It's not trivial to distinguish between what the user thinks is
8986 a basis for a newsgroup and what is just a plain old file or directory.)
8987
8988 This means that you have to tell Gnus (and the backends) what groups
8989 exist by hand.
8990
8991 Let's take the @code{nnmh} backend as an example. 
8992
8993 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8994 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8995
8996 Go to the group buffer and type @kbd{G m}.  When prompted, answer
8997 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
8998 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
8999 to include all your mail groups.
9000
9001 That's it.  You are now set to read your mail.  An active file for this
9002 method will be created automatically.
9003
9004 @vindex nnmail-procmail-suffix
9005 @vindex nnmail-procmail-directory
9006 If you use @code{nnfolder} or any other backend that store more than a
9007 single article in each file, you should never have procmail add mails to
9008 the file that Gnus sees.  Instead, procmail should put all incoming mail
9009 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9010 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9011 name.  The mail backends will read the mail from these files.
9012
9013 @vindex nnmail-resplit-incoming
9014 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9015 put in the @code{mail.misc}, as one would expect.  However, if you want
9016 Gnus to split the mail the normal way, you could set
9017 @code{nnmail-resplit-incoming} to @code{t}.
9018
9019 @vindex nnmail-keep-last-article
9020 If you use @code{procmail} to split things directory into an @code{nnmh}
9021 directory (which you shouldn't do), you should set
9022 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9023 ever expiring the final article (i. e., the article with the highest
9024 article number) in a mail newsgroup.  This is quite, quite important.
9025
9026 Here's an example setup:  The incoming spools are located in
9027 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
9028 spool files have the same names as the equivalent groups).  The
9029 @code{nnfolder} backend is to be used as the mail interface, and the
9030 @code{nnfolder} directory is @file{~/fMail/}.
9031
9032 @lisp
9033 (setq nnfolder-directory "~/fMail/")
9034 (setq nnmail-spool-file 'procmail)
9035 (setq nnmail-procmail-directory "~/incoming/")
9036 (setq gnus-secondary-select-methods '((nnfolder "")))
9037 (setq nnmail-procmail-suffix "")
9038 @end lisp
9039
9040
9041 @node Incorporating Old Mail
9042 @subsection Incorporating Old Mail
9043
9044 Most people have lots of old mail stored in various file formats.  If
9045 you have set up Gnus to read mail using one of the spiffy Gnus mail
9046 backends, you'll probably wish to have that old mail incorporated into
9047 your mail groups.
9048
9049 Doing so can be quite easy.
9050
9051 To take an example: You're reading mail using @code{nnml}
9052 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9053 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9054 file filled with important, but old, mail.  You want to move it into
9055 your @code{nnml} groups.
9056
9057 Here's how:
9058
9059 @enumerate
9060 @item
9061 Go to the group buffer.
9062
9063 @item 
9064 Type `G f' and give the path of the mbox file when prompted to create an
9065 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9066
9067 @item 
9068 Type `SPACE' to enter the newly created group.
9069
9070 @item
9071 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9072 Process Marks}).
9073
9074 @item 
9075 Type `B r' to respool all the process-marked articles, and answer
9076 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9077 @end enumerate
9078
9079 All the mail messages in the mbox file will now also be spread out over
9080 all your @code{nnml} groups.  Try entering them and check whether things
9081 have gone without a glitch.  If things look ok, you may consider
9082 deleting the mbox file, but I wouldn't do that unless I was absolutely
9083 sure that all the mail has ended up where it should be.
9084
9085 Respooling is also a handy thing to do if you're switching from one mail
9086 backend to another.  Just respool all the mail in the old mail groups
9087 using the new mail backend.
9088
9089
9090 @node Expiring Mail
9091 @subsection Expiring Mail
9092 @cindex article expiry
9093
9094 Traditional mail readers have a tendency to remove mail articles when
9095 you mark them as read, in some way.  Gnus takes a fundamentally
9096 different approach to mail reading.
9097
9098 Gnus basically considers mail just to be news that has been received in
9099 a rather peculiar manner.  It does not think that it has the power to
9100 actually change the mail, or delete any mail messages.  If you enter a
9101 mail group, and mark articles as ``read'', or kill them in some other
9102 fashion, the mail articles will still exist on the system.  I repeat:
9103 Gnus will not delete your old, read mail.  Unless you ask it to, of
9104 course.
9105
9106 To make Gnus get rid of your unwanted mail, you have to mark the
9107 articles as @dfn{expirable}.  This does not mean that the articles will
9108 disappear right away, however.  In general, a mail article will be
9109 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9110 more than one week old.  If you do not mark an article as expirable, it
9111 will remain on your system until hell freezes over.  This bears
9112 repeating one more time, with some spurious capitalizations: IF you do
9113 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9114
9115 @vindex gnus-auto-expirable-newsgroups
9116 You do not have to mark articles as expirable by hand.  Groups that
9117 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9118 have all articles that you read marked as expirable automatically.  All
9119 articles that are marked as expirable have an @samp{E} in the first
9120 column in the summary buffer.
9121
9122 Note that making a group auto-expirable don't mean that all read
9123 articles are expired---only the articles that are marked as expirable
9124 will be expired.  Also note the using the @kbd{d} command won't make
9125 groups expirable---only semi-automatic marking of articles as read will
9126 mark the articles as expirable in auto-expirable groups.
9127
9128 Let's say you subscribe to a couple of mailing lists, and you want the
9129 articles you have read to disappear after a while:
9130
9131 @lisp
9132 (setq gnus-auto-expirable-newsgroups 
9133       "mail.nonsense-list\\|mail.nice-list")
9134 @end lisp
9135
9136 Another way to have auto-expiry happen is to have the element
9137 @code{auto-expire} in the group parameters of the group. 
9138
9139 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9140 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9141 doesn't really mix very well.  
9142
9143 @vindex nnmail-expiry-wait
9144 The @code{nnmail-expiry-wait} variable supplies the default time an
9145 expirable article has to live.  Gnus starts counting days from when the
9146 message @emph{arrived}, not from when it was sent.  The default is seven
9147 days.
9148
9149 Gnus also supplies a function that lets you fine-tune how long articles
9150 are to live, based on what group they are in.  Let's say you want to
9151 have one month expiry period in the @samp{mail.private} group, a one day
9152 expiry period in the @samp{mail.junk} group, and a six day expiry period
9153 everywhere else:
9154
9155 @vindex nnmail-expiry-wait-function
9156 @lisp
9157 (setq nnmail-expiry-wait-function
9158       (lambda (group)
9159        (cond ((string= group "mail.private")
9160                31)
9161              ((string= group "mail.junk")
9162                1)
9163              ((string= group "important")
9164                'never)
9165              (t
9166                6))))
9167 @end lisp
9168
9169 The group names that this function is fed are ``unadorned'' group
9170 names---no @samp{nnml:} prefixes and the like.
9171
9172 The @code{nnmail-expiry-wait} variable and
9173 @code{nnmail-expiry-wait-function} function can be either a number (not
9174 necessarily an integer) or the symbols @code{immediate} or
9175 @code{never}.  
9176
9177 You can also use the @code{expiry-wait} group parameter to selectively
9178 change the expiry period (@pxref{Group Parameters}).
9179
9180 @vindex nnmail-keep-last-article
9181 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9182 expire the final article in a mail newsgroup.  This is to make life
9183 easier for procmail users.
9184
9185 @vindex gnus-total-expirable-newsgroups
9186 By the way, that line up there about Gnus never expiring non-expirable
9187 articles is a lie.  If you put @code{total-expire} in the group
9188 parameters, articles will not be marked as expirable, but all read
9189 articles will be put through the expiry process.  Use with extreme
9190 caution.  Even more dangerous is the
9191 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9192 this regexp will have all read articles put through the expiry process,
9193 which means that @emph{all} old mail articles in the groups in question
9194 will be deleted after a while.  Use with extreme caution, and don't come
9195 crying to me when you discover that the regexp you used matched the
9196 wrong group and all your important mail has disappeared.  Be a
9197 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9198 with!  So there!
9199
9200 Most people make most of their mail groups total-expirable, though. 
9201
9202
9203 @node Washing Mail
9204 @subsection Washing Mail
9205 @cindex mail washing
9206 @cindex list server brain damage
9207 @cindex incoming mail treatment
9208
9209 Mailers and list servers are notorious for doing all sorts of really,
9210 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9211 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9212 end of all lines passing through our server, so let's do that!!!!1!''
9213 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9214 considered to be self-evident were not discussed.  So.  Here we are.
9215
9216 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9217 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9218 be shocked and dismayed by this, but I haven't got the energy.  It is to
9219 laugh.
9220
9221 Gnus provides a plethora of functions for washing articles while
9222 displaying them, but it might be nicer to do the filtering before
9223 storing the mail to disc.  For that purpose, we have three hooks and
9224 various functions that can be put in these hooks.
9225
9226 @table @code
9227 @item nnmail-prepare-incoming-hook
9228 @vindex nnmail-prepare-incoming-hook
9229 This hook is called before doing anything with the mail and is meant for
9230 grand, sweeping gestures.  Functions to be used include:
9231
9232 @table @code
9233 @item nnheader-ms-strip-cr
9234 @findex nnheader-ms-strip-cr
9235 Remove trailing carriage returns from each line.  This is default on
9236 Emacs running on MS machines.
9237
9238 @end table
9239
9240 @item nnmail-prepare-incoming-header-hook
9241 @vindex nnmail-prepare-incoming-header-hook
9242 This hook is called narrowed to each header.  It can be used when
9243 cleaning up the headers.  Functions that can be used include:
9244
9245 @table @code
9246 @item nnmail-remove-leading-whitespace
9247 @findex nnmail-remove-leading-whitespace
9248 Clear leading white space that ``helpful'' listservs have added to the
9249 headers too make them look nice.  Aaah.  
9250
9251 @item nnmail-remove-list-identifiers
9252 @findex nnmail-remove-list-identifiers
9253 Some list servers add an identifier---for example, @samp{(idm)}---to the
9254 beginning of all @code{Subject} headers.  I'm sure that's nice for
9255 people who use stone age mail readers.  This function will remove
9256 strings that match the @code{nnmail-list-identifiers} regexp, which can
9257 also be a list of regexp.
9258
9259 For instance, if you want to remove the @samp{(idm)} and the
9260 @samp{nagnagnag} identifiers:
9261
9262 @lisp
9263 (setq nnmail-list-identifiers
9264       '("(idm)" "nagnagnag"))
9265 @end lisp
9266
9267 @item nnmail-remove-tabs
9268 @findex nnmail-remove-tabs
9269 Translate all @samp{TAB} characters into @samp{SPACE} characters. 
9270
9271 @end table
9272
9273 @item nnmail-prepare-incoming-message-hook
9274 @vindex nnmail-prepare-incoming-message-hook
9275 This hook is called narrowed to each message.  Functions to be used
9276 include: 
9277
9278 @table @code
9279 @item article-de-quoted-unreadable
9280 @findex article-de-quoted-unreadable
9281 Decode Quoted Readable encoding.
9282
9283 @end table
9284 @end table
9285
9286
9287 @node Duplicates
9288 @subsection Duplicates
9289
9290 @vindex nnmail-treat-duplicates
9291 @vindex nnmail-message-id-cache-length
9292 @vindex nnmail-message-id-cache-file
9293 @cindex duplicate mails
9294 If you are a member of a couple of mailing list, you will sometime
9295 receive two copies of the same mail.  This can be quite annoying, so
9296 @code{nnmail} checks for and treats any duplicates it might find.  To do
9297 this, it keeps a cache of old @code{Message-ID}s---
9298 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9299 default.  The approximate maximum number of @code{Message-ID}s stored
9300 there is controlled by the @code{nnmail-message-id-cache-length}
9301 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9302 stored.) If all this sounds scary to you, you can set
9303 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9304 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9305 will insert a warning into the head of the mail saying that it thinks
9306 that this is a duplicate of a different message.
9307
9308 This variable can also be a function.  If that's the case, the function
9309 will be called from a buffer narrowed to the message in question with
9310 the @code{Message-ID} as a parameter.  The function must return either
9311 @code{nil}, @code{warn}, or @code{delete}.
9312
9313 You can turn this feature off completely by setting the variable to
9314 @code{nil}.
9315
9316 If you want all the duplicate mails to be put into a special
9317 @dfn{duplicates} group, you could do that using the normal mail split
9318 methods:
9319
9320 @lisp
9321 (setq nnmail-split-fancy
9322       '(| ;; Messages duplicates go to a separate group.
9323           ("gnus-warning" "duplication of message" "duplicate")
9324           ;; Message from daemons, postmaster, and the like to another.
9325           (any mail "mail.misc")
9326           ;; Other rules.
9327           [ ... ] ))
9328 @end lisp
9329
9330 Or something like:
9331 @lisp
9332 (setq nnmail-split-methods 
9333       '(("duplicates" "^Gnus-Warning:")
9334         ;; Other rules.
9335         [...]))
9336 @end lisp
9337
9338 Here's a neat feature: If you know that the recipient reads her mail
9339 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9340 @code{delete}, you can send her as many insults as you like, just by
9341 using a @code{Message-ID} of a mail that you know that she's already
9342 received.  Think of all the fun!  She'll never see any of it!  Whee!
9343
9344
9345 @node Not Reading Mail
9346 @subsection Not Reading Mail
9347
9348 If you start using any of the mail backends, they have the annoying
9349 habit of assuming that you want to read mail with them.  This might not
9350 be unreasonable, but it might not be what you want.
9351
9352 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9353 will ever attempt to read incoming mail, which should help.
9354
9355 @vindex nnbabyl-get-new-mail
9356 @vindex nnmbox-get-new-mail
9357 @vindex nnml-get-new-mail
9358 @vindex nnmh-get-new-mail
9359 @vindex nnfolder-get-new-mail
9360 This might be too much, if, for instance, you are reading mail quite
9361 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9362 file you have stashed away with @code{nnbabyl}.  All backends have
9363 variables called backend-@code{get-new-mail}.  If you want to disable
9364 the @code{nnbabyl} mail reading, you edit the virtual server for the
9365 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9366
9367 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9368 narrowed to the article to be saved before saving it when reading
9369 incoming mail.
9370
9371
9372 @node Choosing a Mail Backend
9373 @subsection Choosing a Mail Backend
9374
9375 Gnus will read the mail spool when you activate a mail group.  The mail
9376 file is first copied to your home directory.  What happens after that
9377 depends on what format you want to store your mail in.
9378
9379 @menu
9380 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9381 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9382 * Mail Spool::                  Store your mail in a private spool?
9383 * MH Spool::                    An mhspool-like backend.
9384 * Mail Folders::                Having one file for each group.
9385 @end menu
9386
9387
9388 @node Unix Mail Box
9389 @subsubsection Unix Mail Box
9390 @cindex nnmbox
9391 @cindex unix mail box
9392
9393 @vindex nnmbox-active-file
9394 @vindex nnmbox-mbox-file
9395 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9396 mail.  @code{nnmbox} will add extra headers to each mail article to say
9397 which group it belongs in.
9398
9399 Virtual server settings:
9400
9401 @table @code
9402 @item nnmbox-mbox-file
9403 @vindex nnmbox-mbox-file
9404 The name of the mail box in the user's home directory. 
9405
9406 @item nnmbox-active-file
9407 @vindex nnmbox-active-file
9408 The name of the active file for the mail box.
9409
9410 @item nnmbox-get-new-mail
9411 @vindex nnmbox-get-new-mail
9412 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9413 into groups.
9414 @end table
9415
9416
9417 @node Rmail Babyl
9418 @subsubsection Rmail Babyl
9419 @cindex nnbabyl
9420 @cindex rmail mbox
9421
9422 @vindex nnbabyl-active-file
9423 @vindex nnbabyl-mbox-file
9424 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9425 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9426 article to say which group it belongs in.
9427
9428 Virtual server settings:
9429
9430 @table @code
9431 @item nnbabyl-mbox-file
9432 @vindex nnbabyl-mbox-file
9433 The name of the rmail mbox file.
9434
9435 @item nnbabyl-active-file
9436 @vindex nnbabyl-active-file
9437 The name of the active file for the rmail box.
9438
9439 @item nnbabyl-get-new-mail
9440 @vindex nnbabyl-get-new-mail
9441 If non-@code{nil}, @code{nnbabyl} will read incoming mail. 
9442 @end table
9443
9444
9445 @node Mail Spool
9446 @subsubsection Mail Spool
9447 @cindex nnml
9448 @cindex mail @sc{nov} spool
9449
9450 The @dfn{nnml} spool mail format isn't compatible with any other known
9451 format.  It should be used with some caution.
9452
9453 @vindex nnml-directory
9454 If you use this backend, Gnus will split all incoming mail into files;
9455 one file for each mail, and put the articles into the correct
9456 directories under the directory specified by the @code{nnml-directory}
9457 variable.  The default value is @file{~/Mail/}.
9458
9459 You do not have to create any directories beforehand; Gnus will take
9460 care of all that.
9461
9462 If you have a strict limit as to how many files you are allowed to store
9463 in your account, you should not use this backend.  As each mail gets its
9464 own file, you might very well occupy thousands of inodes within a few
9465 weeks.  If this is no problem for you, and it isn't a problem for you
9466 having your friendly systems administrator walking around, madly,
9467 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9468 know that this is probably the fastest format to use.  You do not have
9469 to trudge through a big mbox file just to read your new mail.
9470
9471 @code{nnml} is probably the slowest backend when it comes to article
9472 splitting.  It has to create lots of files, and it also generates
9473 @sc{nov} databases for the incoming mails.  This makes is the fastest
9474 backend when it comes to reading mail.
9475
9476 Virtual server settings:
9477
9478 @table @code
9479 @item nnml-directory
9480 @vindex nnml-directory
9481 All @code{nnml} directories will be placed under this directory. 
9482
9483 @item nnml-active-file
9484 @vindex nnml-active-file
9485 The active file for the @code{nnml} server.
9486
9487 @item nnml-newsgroups-file
9488 @vindex nnml-newsgroups-file
9489 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9490 Format}. 
9491
9492 @item nnml-get-new-mail
9493 @vindex nnml-get-new-mail
9494 If non-@code{nil}, @code{nnml} will read incoming mail.
9495
9496 @item nnml-nov-is-evil
9497 @vindex nnml-nov-is-evil
9498 If non-@code{nil}, this backend will ignore any @sc{nov} files.  
9499
9500 @item nnml-nov-file-name
9501 @vindex nnml-nov-file-name
9502 The name of the @sc{nov} files.  The default is @file{.overview}. 
9503
9504 @item nnml-prepare-save-mail-hook
9505 @vindex nnml-prepare-save-mail-hook
9506 Hook run narrowed to an article before saving.
9507
9508 @end table
9509
9510 @findex nnml-generate-nov-databases
9511 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9512 you can do a complete update by typing @kbd{M-x
9513 nnml-generate-nov-databases}.  This command will trawl through the
9514 entire @code{nnml} hierarchy, looking at each and every article, so it
9515 might take a while to complete.  A better interface to this
9516 functionality can be found in the server buffer (@pxref{Server
9517 Commands}). 
9518
9519
9520 @node MH Spool
9521 @subsubsection MH Spool
9522 @cindex nnmh
9523 @cindex mh-e mail spool
9524
9525 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9526 @sc{nov} databases and it doesn't keep an active file.  This makes
9527 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9528 makes it easier to write procmail scripts for.
9529
9530 Virtual server settings:
9531
9532 @table @code
9533 @item nnmh-directory
9534 @vindex nnmh-directory
9535 All @code{nnmh} directories will be located under this directory.
9536
9537 @item nnmh-get-new-mail
9538 @vindex nnmh-get-new-mail
9539 If non-@code{nil}, @code{nnmh} will read incoming mail.
9540
9541 @item nnmh-be-safe
9542 @vindex nnmh-be-safe
9543 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9544 sure that the articles in the folder are actually what Gnus thinks they
9545 are.  It will check date stamps and stat everything in sight, so
9546 setting this to @code{t} will mean a serious slow-down.  If you never
9547 use anything but Gnus to read the @code{nnmh} articles, you do not have
9548 to set this variable to @code{t}.
9549 @end table
9550
9551
9552 @node Mail Folders
9553 @subsubsection Mail Folders
9554 @cindex nnfolder
9555 @cindex mbox folders
9556 @cindex mail folders
9557
9558 @code{nnfolder} is a backend for storing each mail group in a separate
9559 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
9560 will add extra headers to keep track of article numbers and arrival
9561 dates.
9562
9563 Virtual server settings:
9564
9565 @table @code
9566 @item nnfolder-directory
9567 @vindex nnfolder-directory
9568 All the @code{nnfolder} mail boxes will be stored under this directory. 
9569
9570 @item nnfolder-active-file
9571 @vindex nnfolder-active-file
9572 The name of the active file.
9573
9574 @item nnfolder-newsgroups-file
9575 @vindex nnfolder-newsgroups-file
9576 The name of the group descriptions file.  @xref{Newsgroups File Format}.
9577
9578 @item nnfolder-get-new-mail
9579 @vindex nnfolder-get-new-mail
9580 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9581 @end table
9582
9583 @findex nnfolder-generate-active-file
9584 @kindex M-x nnfolder-generate-active-file
9585 If you have lots of @code{nnfolder}-like files you'd like to read with
9586 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9587 command to make @code{nnfolder} aware of all likely files in
9588 @code{nnfolder-directory}.
9589
9590
9591 @node Other Sources
9592 @section Other Sources
9593
9594 Gnus can do more than just read news or mail.  The methods described
9595 below allow Gnus to view directories and files as if they were
9596 newsgroups.
9597
9598 @menu
9599 * Directory Groups::      You can read a directory as if it was a newsgroup.
9600 * Anything Groups::       Dired?  Who needs dired?
9601 * Document Groups::       Single files can be the basis of a group.
9602 * SOUP::                  Reading @sc{SOUP} packets ``offline''.
9603 * Web Searches::          Creating groups from articles that match a string.
9604 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9605 @end menu
9606
9607
9608 @node Directory Groups
9609 @subsection Directory Groups
9610 @cindex nndir
9611 @cindex directory groups
9612
9613 If you have a directory that has lots of articles in separate files in
9614 it, you might treat it as a newsgroup.  The files have to have numerical
9615 names, of course.
9616
9617 This might be an opportune moment to mention @code{ange-ftp}, that most
9618 wonderful of all wonderful Emacs packages.  When I wrote @code{nndir}, I
9619 didn't think much about it---a backend to read directories.  Big deal.
9620
9621 @code{ange-ftp} changes that picture dramatically.  For instance, if you
9622 enter the @code{ange-ftp} file name
9623 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9624 @code{ange-ftp} will actually allow you to read this directory over at
9625 @samp{sina} as a newsgroup.  Distributed news ahoy!
9626
9627 @code{nndir} will use @sc{nov} files if they are present.
9628
9629 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9630 articles with this method.  You can use @code{nnmh} or @code{nnml} for
9631 whatever you use @code{nndir} for, so you could switch to any of those
9632 methods if you feel the need to have a non-read-only @code{nndir}.
9633
9634
9635 @node Anything Groups
9636 @subsection Anything Groups
9637 @cindex nneething
9638
9639 From the @code{nndir} backend (which reads a single spool-like
9640 directory), it's just a hop and a skip to @code{nneething}, which
9641 pretends that any arbitrary directory is a newsgroup.  Strange, but
9642 true.
9643
9644 When @code{nneething} is presented with a directory, it will scan this
9645 directory and assign article numbers to each file.  When you enter such
9646 a group, @code{nneething} must create ``headers'' that Gnus can use.
9647 After all, Gnus is a newsreader, in case you're
9648 forgetting. @code{nneething} does this in a two-step process.  First, it
9649 snoops each file in question.  If the file looks like an article (i.e.,
9650 the first few lines look like headers), it will use this as the head.
9651 If this is just some arbitrary file without a head (e.g. a C source
9652 file), @code{nneething} will cobble up a header out of thin air.  It
9653 will use file ownership, name and date and do whatever it can with these
9654 elements.
9655
9656 All this should happen automatically for you, and you will be presented
9657 with something that looks very much like a newsgroup.  Totally like a
9658 newsgroup, to be precise.  If you select an article, it will be displayed
9659 in the article buffer, just as usual.
9660
9661 If you select a line that represents a directory, Gnus will pop you into
9662 a new summary buffer for this @code{nneething} group.  And so on.  You can
9663 traverse the entire disk this way, if you feel like, but remember that
9664 Gnus is not dired, really, and does not intend to be, either.
9665
9666 There are two overall modes to this action---ephemeral or solid.  When
9667 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9668 will not store information on what files you have read, and what files
9669 are new, and so on.  If you create a solid @code{nneething} group the
9670 normal way with @kbd{G m}, Gnus will store a mapping table between
9671 article numbers and file names, and you can treat this group like any
9672 other groups.  When you activate a solid @code{nneething} group, you will
9673 be told how many unread articles it contains, etc., etc.
9674
9675 Some variables:
9676
9677 @table @code
9678 @item nneething-map-file-directory
9679 @vindex nneething-map-file-directory
9680 All the mapping files for solid @code{nneething} groups will be stored
9681 in this directory, which defaults to @file{~/.nneething/}.
9682
9683 @item nneething-exclude-files
9684 @vindex nneething-exclude-files
9685 All files that match this regexp will be ignored.  Nice to use to exclude
9686 auto-save files and the like, which is what it does by default.
9687
9688 @item nneething-map-file
9689 @vindex nneething-map-file
9690 Name of the map files.
9691 @end table
9692
9693
9694 @node Document Groups
9695 @subsection Document Groups
9696 @cindex nndoc
9697 @cindex documentation group
9698 @cindex help group
9699
9700 @code{nndoc} is a cute little thing that will let you read a single file
9701 as a newsgroup.  Several files types are supported:
9702
9703 @table @code
9704 @cindex babyl
9705 @cindex rmail mbox
9706
9707 @item babyl
9708 The babyl (rmail) mail box.
9709 @cindex mbox
9710 @cindex Unix mbox
9711
9712 @item mbox
9713 The standard Unix mbox file.
9714
9715 @cindex MMDF mail box
9716 @item mmdf
9717 The MMDF mail box format.
9718
9719 @item news
9720 Several news articles appended into a file.
9721
9722 @item rnews
9723 @cindex rnews batch files
9724 The rnews batch transport format.
9725 @cindex forwarded messages
9726
9727 @item forward
9728 Forwarded articles.
9729
9730 @item mime-digest
9731 @cindex digest
9732 @cindex MIME digest
9733 @cindex 1153 digest
9734 @cindex RFC 1153 digest
9735 @cindex RFC 341 digest
9736 MIME (RFC 1341) digest format.
9737
9738 @item standard-digest
9739 The standard (RFC 1153) digest format.
9740
9741 @item slack-digest
9742 Non-standard digest format---matches most things, but does it badly. 
9743 @end table
9744
9745 You can also use the special ``file type'' @code{guess}, which means
9746 that @code{nndoc} will try to guess what file type it is looking at.
9747 @code{digest} means that @code{nndoc} should guess what digest type the
9748 file is.
9749
9750 @code{nndoc} will not try to change the file or insert any extra headers into
9751 it---it will simply, like, let you use the file as the basis for a
9752 group.  And that's it.
9753
9754 If you have some old archived articles that you want to insert into your
9755 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9756 that.  Say you have an old @file{RMAIL} file with mail that you now want
9757 to split into your new @code{nnml} groups.  You look at that file using
9758 @code{nndoc} (using the @kbd{G f} command in the group buffer
9759 (@pxref{Foreign Groups})), set the process mark on all the articles in
9760 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9761 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
9762 file is now also stored in lots of @code{nnml} directories, and you can
9763 delete that pesky @file{RMAIL} file.  If you have the guts!
9764
9765 Virtual server variables:
9766
9767 @table @code
9768 @item nndoc-article-type
9769 @vindex nndoc-article-type
9770 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9771 @code{mmdf}, @code{forward}, @code{rfc934}, @code{rfc822-forward},
9772 @code{news}, @code{rnews}, @code{mime-digest}, @code{clari-briefs}, or
9773 @code{guess}.
9774
9775 @item nndoc-post-type
9776 @vindex nndoc-post-type
9777 This variable says whether Gnus is to consider the group a news group or
9778 a mail group.  There are two legal values:  @code{mail} (the default)
9779 and @code{news}.
9780 @end table
9781
9782 @menu
9783 * Document Server Internals::   How to add your own document types.
9784 @end menu
9785
9786
9787 @node Document Server Internals
9788 @subsubsection Document Server Internals
9789
9790 Adding new document types to be recognized by @code{nndoc} isn't
9791 difficult.  You just have to whip up a definition of what the document
9792 looks like, write a predicate function to recognize that document type,
9793 and then hook into @code{nndoc}.
9794
9795 First, here's an example document type definition:
9796
9797 @example
9798 (mmdf 
9799  (article-begin .  "^\^A\^A\^A\^A\n")
9800  (body-end .  "^\^A\^A\^A\^A\n"))
9801 @end example
9802
9803 The definition is simply a unique @dfn{name} followed by a series of
9804 regexp pseudo-variable settings.  Below are the possible
9805 variables---don't be daunted by the number of variables; most document
9806 types can be defined with very few settings:
9807
9808 @table @code
9809 @item first-article
9810 If present, @code{nndoc} will skip past all text until it finds
9811 something that match this regexp.  All text before this will be
9812 totally ignored. 
9813
9814 @item article-begin
9815 This setting has to be present in all document type definitions.  It
9816 says what the beginning of each article looks like.
9817
9818 @item head-begin-function
9819 If present, this should be a function that moves point to the head of
9820 the article.
9821
9822 @item nndoc-head-begin
9823 If present, this should be a regexp that matches the head of the
9824 article. 
9825
9826 @item nndoc-head-end
9827 This should match the end of the head of the article.  It defaults to
9828 @samp{^$}---the empty line.
9829
9830 @item body-begin-function
9831 If present, this function should move point to the beginning of the body
9832 of the article.
9833
9834 @item body-begin
9835 This should match the beginning of the body of the article.  It defaults
9836 to @samp{^\n}.
9837
9838 @item body-end-function
9839 If present, this function should move point to the end of the body of
9840 the article.
9841
9842 @item body-end
9843 If present, this should match the end of the body of the article.
9844
9845 @item nndoc-file-end
9846 If present, this should match the end of the file.  All text after this
9847 regexp will be totally ignored. 
9848
9849 @end table
9850
9851 So, using these variables @code{nndoc} is able to dissect a document
9852 file into a series of articles, each with a head and a body.  However, a
9853 few more variables are needed since not all document types are all that
9854 news-like---variables needed to transform the head or the body into
9855 something that's palatable for Gnus:
9856
9857 @table @code
9858 @item prepare-body-function
9859 If present, this function will be called when requesting an article.  It
9860 will be called with point at the start of the body, and is useful if the
9861 document has encoded some parts of its contents. 
9862
9863 @item article-transform-function
9864 If present, this function is called when requesting an article.  It's
9865 meant to be used how more wide-ranging transformation of both head and
9866 body of the article.
9867
9868 @item generate-head-function
9869 If present, this function is called to generate a head that Gnus can
9870 understand.  It is called with the article number as a parameter, and is
9871 expected to generate a nice head for the article in question.  It is
9872 called when requesting the headers of all articles.
9873
9874 @end table
9875
9876 Let's look at the most complicated example I can come up with---standard
9877 digests:
9878
9879 @example
9880 (standard-digest
9881  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9882  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9883  (prepare-body-function . nndoc-unquote-dashes)
9884  (body-end-function . nndoc-digest-body-end)
9885  (head-end . "^ ?$")
9886  (body-begin . "^ ?\n")
9887  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9888  (subtype digest guess))
9889 @end example
9890
9891 We see that all text before a 70-width line of dashes is ignored; all
9892 text after a line that starts with that @samp{^End of} is also ignored;
9893 each article begins with a 30-width line of dashes; the line separating
9894 the head from the body may contain a single space; and that the body is
9895 run through @code{nndoc-unquote-dashes} before being delivered.
9896
9897 To hook your own document definition into @code{nndoc}, use the
9898 @code{nndoc-add-type} function.  It takes two parameters---the first is
9899 the definition itself and the second (optional) parameter says where in
9900 the document type definition alist to put this definition.  The alist is
9901 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9902 type.  So @code{nndoc-mmdf-type-p} is called to see whether a document
9903 is of @code{mmdf} type, and so on.  These type predicates should return
9904 @code{nil} if the document is not of the correct type; @code{t} if it is
9905 of the correct type; and a number if the document might be of the
9906 correct type.  A high number means high probability; a low number means
9907 low probability with @samp{0} being the lowest legal number.
9908
9909
9910 @node SOUP
9911 @subsection SOUP
9912 @cindex SOUP
9913 @cindex offline
9914
9915 In the PC world people often talk about ``offline'' newsreaders.  These
9916 are thingies that are combined reader/news transport monstrosities.
9917 With built-in modem programs.  Yecchh!
9918
9919 Of course, us Unix Weenie types of human beans use things like
9920 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9921 transport things like Ghod intended.  And then we just use normal
9922 newsreaders.  
9923
9924 However, it can sometimes be convenient to do something a that's a bit
9925 easier on the brain if you have a very slow modem, and you're not really
9926 that interested in doing things properly.  
9927
9928 A file format called @sc{soup} has been developed for transporting news
9929 and mail from servers to home machines and back again.  It can be a bit
9930 fiddly.
9931
9932 First some terminology:
9933
9934 @table @dfn
9935
9936 @item server
9937 This is the machine that is connected to the outside world and where you
9938 get news and/or mail from.
9939
9940 @item home machine
9941 This is the machine that you want to do the actual reading and responding
9942 on.  It is typically not connected to the rest of the world in any way.
9943
9944 @item packet
9945 Something that contains messages and/or commands.  There are two kinds
9946 of packets:
9947
9948 @table @dfn
9949 @item message packets
9950 These are packets made at the server, and typically contains lots of
9951 messages for you to read.  These are called @file{SoupoutX.tgz} by
9952 default, where @var{X} is a number.
9953
9954 @item response packets
9955 These are packets made at the home machine, and typically contains
9956 replies that you've written.  These are called @file{SoupinX.tgz} by
9957 default, where @var{X} is a number.
9958
9959 @end table
9960
9961 @end table
9962
9963
9964 @enumerate
9965
9966 @item
9967 You log in on the server and create a @sc{soup} packet.  You can either
9968 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9969 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9970 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9971
9972 @item 
9973 You transfer the packet home.  Rail, boat, car or modem will do fine.
9974
9975 @item
9976 You put the packet in your home directory.
9977
9978 @item
9979 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9980 the native or secondary server.
9981
9982 @item
9983 You read articles and mail and answer and followup to the things you
9984 want (@pxref{SOUP Replies}).
9985
9986 @item 
9987 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9988 packet.
9989
9990 @item 
9991 You transfer this packet to the server.  
9992
9993 @item
9994 You use Gnus to mail this packet out with the @kbd{G s s} command.
9995
9996 @item
9997 You then repeat until you die.
9998
9999 @end enumerate
10000
10001 So you basically have a bipartite system---you use @code{nnsoup} for
10002 reading and Gnus for packing/sending these @sc{soup} packets.
10003
10004 @menu
10005 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10006 * SOUP Groups::       A backend for reading @sc{soup} packets.
10007 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10008 @end menu
10009
10010
10011 @node SOUP Commands
10012 @subsubsection SOUP Commands
10013
10014 These are commands for creating and manipulating @sc{soup} packets.
10015
10016 @table @kbd
10017 @item G s b
10018 @kindex G s b (Group)
10019 @findex gnus-group-brew-soup
10020 Pack all unread articles in the current group
10021 (@code{gnus-group-brew-soup}).  This command understands the
10022 process/prefix convention.
10023
10024 @item G s w
10025 @kindex G s w (Group)
10026 @findex gnus-soup-save-areas
10027 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10028
10029 @item G s s
10030 @kindex G s s (Group)
10031 @findex gnus-soup-send-replies
10032 Send all replies from the replies packet
10033 (@code{gnus-soup-send-replies}). 
10034
10035 @item G s p
10036 @kindex G s p (Group)
10037 @findex gnus-soup-pack-packet
10038 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}). 
10039
10040 @item G s r
10041 @kindex G s r (Group)
10042 @findex nnsoup-pack-replies
10043 Pack all replies into a replies packet (@code{nnsoup-pack-replies}). 
10044
10045 @item O s
10046 @kindex O s (Summary)
10047 @findex gnus-soup-add-article
10048 This summary-mode command adds the current article to a @sc{soup} packet
10049 (@code{gnus-soup-add-article}).  It understands the process/prefix
10050 convention (@pxref{Process/Prefix}). 
10051
10052 @end table
10053
10054
10055 There are a few variables to customize where Gnus will put all these
10056 thingies:  
10057
10058 @table @code
10059
10060 @item gnus-soup-directory
10061 @vindex gnus-soup-directory
10062 Directory where Gnus will save intermediate files while composing
10063 @sc{soup} packets.  The default is @file{~/SoupBrew/}. 
10064
10065 @item gnus-soup-replies-directory
10066 @vindex gnus-soup-replies-directory
10067 This is what Gnus will use as a temporary directory while sending our
10068 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10069
10070 @item gnus-soup-prefix-file
10071 @vindex gnus-soup-prefix-file
10072 Name of the file where Gnus stores the last used prefix.  The default is
10073 @samp{gnus-prefix}. 
10074
10075 @item gnus-soup-packer
10076 @vindex gnus-soup-packer
10077 A format string command for packing a @sc{soup} packet.  The default is
10078 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}. 
10079
10080 @item gnus-soup-unpacker
10081 @vindex gnus-soup-unpacker
10082 Format string command for unpacking a @sc{soup} packet.  The default is
10083 @samp{gunzip -c %s | tar xvf -}.
10084
10085 @item gnus-soup-packet-directory
10086 @vindex gnus-soup-packet-directory
10087 Where Gnus will look for reply packets.  The default is @file{~/}. 
10088
10089 @item gnus-soup-packet-regexp
10090 @vindex gnus-soup-packet-regexp
10091 Regular expression matching @sc{soup} reply packets in
10092 @code{gnus-soup-packet-directory}. 
10093
10094 @end table
10095  
10096
10097 @node SOUP Groups
10098 @subsubsection @sc{soup} Groups
10099 @cindex nnsoup
10100
10101 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10102 read incoming packets, unpack them, and put them in a directory where
10103 you can read them at leisure.
10104
10105 These are the variables you can use to customize its behavior:
10106
10107 @table @code
10108
10109 @item nnsoup-tmp-directory
10110 @vindex nnsoup-tmp-directory
10111 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10112 directory.  (@file{/tmp/} by default.)  
10113
10114 @item nnsoup-directory
10115 @vindex nnsoup-directory
10116 @code{nnsoup} then moves each message and index file to this directory.
10117 The default is @file{~/SOUP/}.
10118
10119 @item nnsoup-replies-directory 
10120 @vindex nnsoup-replies-directory 
10121 All replies will stored in this directory before being packed into a
10122 reply packet.  The default is @file{~/SOUP/replies/"}.
10123
10124 @item nnsoup-replies-format-type
10125 @vindex nnsoup-replies-format-type
10126 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10127 (rnews), and I don't think you should touch that variable.  I probably
10128 shouldn't even have documented it.  Drats!  Too late!
10129
10130 @item nnsoup-replies-index-type
10131 @vindex nnsoup-replies-index-type
10132 The index type of the replies packet.  The is @samp{?n}, which means
10133 ``none''.  Don't fiddle with this one either!
10134
10135 @item nnsoup-active-file
10136 @vindex nnsoup-active-file
10137 Where @code{nnsoup} stores lots of information.  This is not an ``active
10138 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10139 this file or mess it up in any way, you're dead.  The default is
10140 @file{~/SOUP/active}.
10141
10142 @item nnsoup-packer
10143 @vindex nnsoup-packer
10144 Format string command for packing a reply @sc{soup} packet.  The default
10145 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}. 
10146
10147 @item nnsoup-unpacker
10148 @vindex nnsoup-unpacker
10149 Format string command for unpacking incoming @sc{soup} packets.  The
10150 default is @samp{gunzip -c %s | tar xvf -}. 
10151
10152 @item nnsoup-packet-directory
10153 @vindex nnsoup-packet-directory
10154 Where @code{nnsoup} will look for incoming packets.  The default is
10155 @file{~/}.  
10156
10157 @item nnsoup-packet-regexp
10158 @vindex nnsoup-packet-regexp
10159 Regular expression matching incoming @sc{soup} packets.  The default is
10160 @samp{Soupout}. 
10161
10162 @end table
10163
10164
10165 @node SOUP Replies
10166 @subsubsection SOUP Replies
10167
10168 Just using @code{nnsoup} won't mean that your postings and mailings end
10169 up in @sc{soup} reply packets automagically.  You have to work a bit
10170 more for that to happen.
10171
10172 @findex nnsoup-set-variables
10173 The @code{nnsoup-set-variables} command will set the appropriate
10174 variables to ensure that all your followups and replies end up in the
10175 @sc{soup} system.
10176
10177 In specific, this is what it does:
10178
10179 @lisp
10180 (setq message-send-news-function 'nnsoup-request-post)
10181 (setq message-send-mail-function 'nnsoup-request-mail)
10182 @end lisp
10183
10184 And that's it, really.  If you only want news to go into the @sc{soup}
10185 system you just use the first line.  If you only want mail to be
10186 @sc{soup}ed you use the second.
10187
10188
10189 @node Web Searches
10190 @subsection Web Searches
10191 @cindex nnweb
10192 @cindex DejaNews
10193 @cindex Alta Vista
10194 @cindex InReference
10195 @cindex Usenet searches
10196 @cindex searching the Usenet
10197
10198 It's, like, too neat to search the Usenet for articles that match a
10199 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10200 those, like, Web browsers, and you, like, have to, rilly, like, look at
10201 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10202 searches without having to use a browser.
10203
10204 The @code{nnweb} backend allows an easy interface to the mighty search
10205 engine.  You create an @code{nnweb} group, enter a search pattern, and
10206 then enter the group and read the articles like you would any normal
10207 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10208 Groups}) will do this in an easy-to-use fashion.
10209
10210 @code{nnweb} groups don't really lend themselves to being solid
10211 groups---they have a very fleeting idea of article numbers.  In fact,
10212 each time you enter an @code{nnweb} group (not even changing the search
10213 pattern), you are likely to get the articles ordered in a different
10214 manner.  Not even using duplicate suppression (@code{Duplicate
10215 Suppression}) will help, since @code{nnweb} doesn't even know the
10216 @code{Message-ID} of the articles before reading them using some search
10217 engines (DejaNews, for instance).  The only possible way to keep track
10218 of which articles you've read is by scoring on the @code{Date}
10219 header---mark all articles that were posted before the last date you
10220 read the group as read.
10221
10222 If the search engine changes its output substantially, @code{nnweb}
10223 won't be able to parse it and will fail.  One could hardly fault the Web
10224 providers if they were to do this---their @emph{raison d'être} is to
10225 make money off of advertisements, not to provide services to the
10226 community.  Since @code{nnweb} washes the ads off all the articles, one
10227 might think that the providers might be somewhat miffed.  We'll see.
10228
10229 You must have the @code{url} and @code{w3} package installed to be able
10230 to use @code{nnweb}.
10231
10232 Virtual server variables:
10233
10234 @table @code
10235 @item nnweb-type
10236 @vindex nnweb-type
10237 What search engine type is being used.  The currently supported types
10238 are @code{dejanews}, @code{altavista} and @code{reference}.
10239
10240 @item nnweb-search
10241 @vindex nnweb-search
10242 The search string to feed to the search engine.
10243
10244 @item nnweb-max-hits
10245 @vindex nnweb-max-hits
10246 Advisory maximum number of hits per search to display.  The default is
10247 100.
10248
10249 @item nnweb-type-definition
10250 @vindex nnweb-type-definition
10251 Type-to-definition alist.  This alist says what @code{nnweb} should do
10252 with the various search engine types.  The following elements must be
10253 present: 
10254
10255 @table @code
10256 @item article
10257 Function to decode the article and provide something that Gnus
10258 understands. 
10259
10260 @item map
10261 Function to create an article number to message header and URL alist. 
10262
10263 @item search
10264 Function to send the search string to the search engine.
10265
10266 @item address
10267 The address the aforementioned function should send the search string
10268 to. 
10269
10270 @item id
10271 Format string URL to fetch an article by @code{Message-ID}.
10272 @end table
10273
10274 @end table
10275
10276
10277
10278 @node Mail-To-News Gateways
10279 @subsection Mail-To-News Gateways
10280 @cindex mail-to-news gateways
10281 @cindex gateways
10282
10283 If your local @code{nntp} server doesn't allow posting, for some reason
10284 or other, you can post using one of the numerous mail-to-news gateways.
10285 The @code{nngateway} backend provides the interface.
10286
10287 Note that you can't read anything from this backend---it can only be
10288 used to post with.
10289
10290 Server variables:
10291
10292 @table @code
10293 @item nngateway-address 
10294 @vindex nngateway-address 
10295 This is the address of the mail-to-news gateway.
10296
10297 @item nngateway-header-transformation
10298 @vindex nngateway-header-transformation
10299 News headers have often have to be transformed in some odd way or other
10300 for the mail-to-news gateway to accept it.  This variable says what 
10301 transformation should be called, and defaults to
10302 @code{nngateway-simple-header-transformation}.  The function is called
10303 narrowed to the headers to be transformed and with one parameter---the
10304 gateway address.
10305
10306 This default function just inserts a new @code{To} header based on the
10307 @code{Newsgroups} header and the gateway address---an article with this
10308 @code{Newsgroups} header:
10309
10310 @example
10311 Newsgroups: alt.religion.emacs
10312 @end example
10313
10314 will get this @code{From} header inserted:
10315
10316 @example
10317 To: alt-religion-emacs@@GATEWAY
10318 @end example
10319
10320 @end table
10321
10322 So, to use this, simply say something like:
10323
10324 @lisp
10325 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10326 @end lisp
10327
10328
10329 @node Combined Groups
10330 @section Combined Groups
10331
10332 Gnus allows combining a mixture of all the other group types into bigger
10333 groups.
10334
10335 @menu
10336 * Virtual Groups::     Combining articles from many groups.
10337 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10338 @end menu
10339
10340
10341 @node Virtual Groups
10342 @subsection Virtual Groups
10343 @cindex nnvirtual
10344 @cindex virtual groups
10345
10346 An @dfn{nnvirtual group} is really nothing more than a collection of
10347 other groups.
10348
10349 For instance, if you are tired of reading many small group, you can
10350 put them all in one big group, and then grow tired of reading one
10351 big, unwieldy group.  The joys of computing!
10352
10353 You specify @code{nnvirtual} as the method.  The address should be a
10354 regexp to match component groups.
10355
10356 All marks in the virtual group will stick to the articles in the
10357 component groups.  So if you tick an article in a virtual group, the
10358 article will also be ticked in the component group from whence it came.
10359 (And vice versa---marks from the component groups will also be shown in
10360 the virtual group.)
10361
10362 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10363 newsgroups into one, big, happy newsgroup:
10364
10365 @lisp
10366 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10367 @end lisp
10368
10369 The component groups can be native or foreign; everything should work
10370 smoothly, but if your computer explodes, it was probably my fault.
10371
10372 Collecting the same group from several servers might actually be a good
10373 idea if users have set the Distribution header to limit distribution.
10374 If you would like to read @samp{soc.motss} both from a server in Japan
10375 and a server in Norway, you could use the following as the group regexp:
10376
10377 @example
10378 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10379 @end example
10380
10381 This should work kinda smoothly---all articles from both groups should
10382 end up in this one, and there should be no duplicates.  Threading (and
10383 the rest) will still work as usual, but there might be problems with the
10384 sequence of articles.  Sorting on date might be an option here
10385 (@pxref{Selecting a Group}.
10386
10387 One limitation, however---all groups that are included in a virtual
10388 group has to be alive (i.e., subscribed or unsubscribed).  Killed or
10389 zombie groups can't be component groups for @code{nnvirtual} groups.
10390
10391 @vindex nnvirtual-always-rescan
10392 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10393 @code{nnvirtual} will always scan groups for unread articles when
10394 entering a virtual group.  If this variable is @code{nil} (which is the
10395 default) and you read articles in a component group after the virtual
10396 group has been activated, the read articles from the component group
10397 will show up when you enter the virtual group.  You'll also see this
10398 effect if you have two virtual groups that contain the same component
10399 group.  If that's the case, you should set this variable to @code{t}.
10400 Or you can just tap @code{M-g} on the virtual group every time before
10401 you enter it---it'll have much the same effect.
10402
10403
10404 @node Kibozed Groups
10405 @subsection Kibozed Groups
10406 @cindex nnkiboze
10407 @cindex kibozing
10408
10409 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10410 the news feed''.  @code{nnkiboze} is a backend that will do this for
10411 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10412 with useless requests!  Oh happiness!
10413
10414 @kindex G k (Group)
10415 To create a kibozed group, use the @kbd{G k} command in the group
10416 buffer. 
10417
10418 The address field of the @code{nnkiboze} method is, as with
10419 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10420 @code{nnkiboze} group.  There most similarities between @code{nnkiboze}
10421 and @code{nnvirtual} ends.
10422
10423 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10424 must have a score file to say what articles that are to be included in
10425 the group (@pxref{Scoring}).
10426
10427 @kindex M-x nnkiboze-generate-groups
10428 @findex nnkiboze-generate-groups
10429 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10430 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
10431 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
10432 all the articles in all the components groups and run them through the
10433 scoring process to determine if there are any articles in the groups
10434 that are to be part of the @code{nnkiboze} groups.
10435
10436 Please limit the number of component groups by using restrictive
10437 regexps.  Otherwise your sysadmin may become annoyed with you, and the
10438 @sc{nntp} site may throw you off and never let you back in again.
10439 Stranger things have happened.
10440
10441 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10442 and they can be foreign.  No restrictions.
10443
10444 @vindex nnkiboze-directory
10445 The generation of an @code{nnkiboze} group means writing two files in
10446 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
10447 contains the @sc{nov} header lines for all the articles in the group,
10448 and the other is an additional @file{.newsrc} file to store information
10449 on what groups that have been searched through to find component
10450 articles.
10451
10452 Articles that are marked as read in the @code{nnkiboze} group will have their
10453 @sc{nov} lines removed from the @sc{nov} file.
10454
10455
10456 @node Scoring
10457 @chapter Scoring
10458 @cindex scoring
10459
10460 Other people use @dfn{kill files}, but we here at Gnus Towers like
10461 scoring better than killing, so we'd rather switch than fight.  They do
10462 something completely different as well, so sit up straight and pay
10463 attention!
10464
10465 @vindex gnus-summary-mark-below
10466 All articles have a default score (@code{gnus-summary-default-score}),
10467 which is 0 by default.  This score may be raised or lowered either
10468 interactively or by score files.  Articles that have a score lower than
10469 @code{gnus-summary-mark-below} are marked as read.
10470
10471 Gnus will read any @dfn{score files} that apply to the current group
10472 before generating the summary buffer.
10473
10474 There are several commands in the summary buffer that insert score
10475 entries based on the current article.  You can, for instance, ask Gnus to
10476 lower or increase the score of all articles with a certain subject.
10477
10478 There are two sorts of scoring entries: Permanent and temporary.
10479 Temporary score entries are self-expiring entries.  Any entries that are
10480 temporary and have not been used for, say, a week, will be removed
10481 silently to help keep the sizes of the score files down.
10482
10483 @menu 
10484 * Summary Score Commands::   Adding score entries for the current group.
10485 * Group Score Commands::     General score commands.
10486 * Score Variables::          Customize your scoring.  (My, what terminology).
10487 * Score File Format::        What a score file may contain.
10488 * Score File Editing::       You can edit score files by hand as well.
10489 * Adaptive Scoring::         Big Sister Gnus knows what you read.
10490 * Home Score File::          How to say where new score entries are to go.
10491 * Followups To Yourself::    Having Gnus notice when people answer you.
10492 * Scoring Tips::             How to score effectively.
10493 * Reverse Scoring::          That problem child of old is not problem.
10494 * Global Score Files::       Earth-spanning, ear-splitting score files.
10495 * Kill Files::               They are still here, but they can be ignored.
10496 * Converting Kill Files::    Translating kill files to score files.
10497 * GroupLens::                Getting predictions on what you like to read.
10498 * Advanced Scoring::         Using logical expressions to build score rules.
10499 * Score Decays::             It can be useful to let scores wither away.
10500 @end menu
10501
10502
10503 @node Summary Score Commands
10504 @section Summary Score Commands
10505 @cindex score commands
10506
10507 The score commands that alter score entries do not actually modify real
10508 score files.  That would be too inefficient.  Gnus maintains a cache of
10509 previously loaded score files, one of which is considered the
10510 @dfn{current score file alist}.  The score commands simply insert
10511 entries into this list, and upon group exit, this list is saved.
10512
10513 The current score file is by default the group's local score file, even
10514 if no such score file actually exists.  To insert score commands into
10515 some other score file (e.g. @file{all.SCORE}), you must first make this
10516 score file the current one.
10517
10518 General score commands that don't actually change the score file:
10519
10520 @table @kbd
10521
10522 @item V s
10523 @kindex V s (Summary)
10524 @findex gnus-summary-set-score
10525 Set the score of the current article (@code{gnus-summary-set-score}).  
10526
10527 @item V S
10528 @kindex V S (Summary)
10529 @findex gnus-summary-current-score
10530 Display the score of the current article
10531 (@code{gnus-summary-current-score}).   
10532
10533 @item V t
10534 @kindex V t (Summary)
10535 @findex gnus-score-find-trace
10536 Display all score rules that have been used on the current article
10537 (@code{gnus-score-find-trace}).   
10538
10539 @item V R
10540 @kindex V R (Summary)
10541 @findex gnus-summary-rescore
10542 Run the current summary through the scoring process
10543 (@code{gnus-summary-rescore}).  This might be useful if you're playing
10544 around with your score files behind Gnus' back and want to see the
10545 effect you're having.
10546
10547 @item V a
10548 @kindex V a (Summary)
10549 @findex gnus-summary-score-entry
10550 Add a new score entry, and allow specifying all elements 
10551 (@code{gnus-summary-score-entry}).
10552
10553 @item V c
10554 @kindex V c (Summary)
10555 @findex gnus-score-change-score-file
10556 Make a different score file the current
10557 (@code{gnus-score-change-score-file}). 
10558
10559 @item V e
10560 @kindex V e (Summary)
10561 @findex gnus-score-edit-current-scores
10562 Edit the current score file (@code{gnus-score-edit-current-scores}).
10563 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10564 File Editing}).
10565
10566 @item V f
10567 @kindex V f (Summary)
10568 @findex gnus-score-edit-file
10569 Edit a score file and make this score file the current one
10570 (@code{gnus-score-edit-file}).
10571
10572 @item V F
10573 @kindex V F (Summary)
10574 @findex gnus-score-flush-cache
10575 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
10576 after editing score files.
10577
10578 @item V C
10579 @kindex V C (Summary)
10580 @findex gnus-score-customize
10581 Customize a score file in a visually pleasing manner
10582 (@code{gnus-score-customize}). 
10583
10584 @item I C-i
10585 @kindex I C-i (Summary)
10586 @findex gnus-summary-raise-score
10587 Increase the score of the current article
10588 (@code{gnus-summary-raise-score}).
10589
10590 @item L C-l
10591 @kindex L C-l (Summary)
10592 @findex gnus-summary-lower-score
10593 Lower the score of the current article
10594 (@code{gnus-summary-lower-score}). 
10595 @end table
10596
10597 The rest of these commands modify the local score file.
10598
10599 @table @kbd
10600
10601 @item V m
10602 @kindex V m (Summary)
10603 @findex gnus-score-set-mark-below
10604 Prompt for a score, and mark all articles with a score below this as
10605 read (@code{gnus-score-set-mark-below}).
10606
10607 @item V x
10608 @kindex V x (Summary)
10609 @findex gnus-score-set-expunge-below
10610 Prompt for a score, and add a score rule to the current score file to
10611 expunge all articles below this score
10612 (@code{gnus-score-set-expunge-below}).
10613 @end table
10614
10615 The keystrokes for actually making score entries follow a very regular
10616 pattern, so there's no need to list all the commands.  (Hundreds of
10617 them.)  
10618
10619 @enumerate
10620 @item
10621 The first key is either @kbd{I} (upper case i) for increasing the score
10622 or @kbd{L} for lowering the score. 
10623 @item
10624 The second key says what header you want to score on.  The following
10625 keys are available:
10626 @table @kbd
10627
10628 @item a
10629 Score on the author name.
10630
10631 @item s
10632 Score on the subject line.
10633
10634 @item x
10635 Score on the Xref line---i.e., the cross-posting line.
10636
10637 @item t
10638 Score on thread---the References line.
10639
10640 @item d
10641 Score on the date.
10642
10643 @item l
10644 Score on the number of lines.
10645
10646 @item i
10647 Score on the Message-ID.
10648
10649 @item f
10650 Score on followups.
10651
10652 @item b
10653 Score on the body.
10654
10655 @item h
10656 Score on the head.
10657 @end table
10658
10659 @item
10660 The third key is the match type.  Which match types are legal depends on
10661 what headers you are scoring on.
10662
10663 @table @code
10664
10665 @item strings 
10666
10667 @table @kbd
10668
10669 @item e
10670 Exact matching.
10671
10672 @item s
10673 Substring matching.
10674
10675 @item f
10676 Fuzzy matching (@pxref{Fuzzy Matching}).
10677
10678 @item r
10679 Regexp matching
10680 @end table
10681
10682 @item date
10683 @table @kbd
10684
10685 @item b
10686 Before date.
10687
10688 @item a
10689 At date.
10690
10691 @item n
10692 This date.
10693 @end table
10694
10695 @item number
10696 @table @kbd
10697
10698 @item <
10699 Less than number.
10700
10701 @item =
10702 Equal to number.
10703
10704 @item >
10705 Greater than number.
10706 @end table
10707 @end table
10708
10709 @item 
10710 The fourth and final key says whether this is a temporary (i.e., expiring)
10711 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10712 it is to be done immediately, without adding to the score file.
10713 @table @kbd
10714
10715 @item t
10716 Temporary score entry.
10717
10718 @item p
10719 Permanent score entry.
10720
10721 @item i
10722 Immediately scoring.
10723 @end table
10724
10725 @end enumerate
10726
10727 So, let's say you want to increase the score on the current author with
10728 exact matching permanently: @kbd{I a e p}.  If you want to lower the
10729 score based on the subject line, using substring matching, and make a
10730 temporary score entry: @kbd{L s s t}.  Pretty easy.
10731
10732 To make things a bit more complicated, there are shortcuts.  If you use
10733 a capital letter on either the second or third keys, Gnus will use
10734 defaults for the remaining one or two keystrokes.  The defaults are
10735 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
10736 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10737
10738 @vindex gnus-score-mimic-keymap
10739 The @code{gnus-score-mimic-keymap} says whether these commands will
10740 pretend they are keymaps or not.
10741
10742
10743 @node Group Score Commands
10744 @section Group Score Commands
10745 @cindex group score commands
10746
10747 There aren't many of these as yet, I'm afraid.
10748
10749 @table @kbd
10750
10751 @item W f
10752 @kindex W f (Group)
10753 @findex gnus-score-flush-cache
10754 Gnus maintains a cache of score alists to avoid having to reload them
10755 all the time.  This command will flush the cache
10756 (@code{gnus-score-flush-cache}). 
10757
10758 @end table
10759
10760
10761 @node Score Variables
10762 @section Score Variables
10763 @cindex score variables
10764
10765 @table @code
10766
10767 @item gnus-use-scoring
10768 @vindex gnus-use-scoring
10769 If @code{nil}, Gnus will not check for score files, and will not, in
10770 general, do any score-related work.  This is @code{t} by default.
10771
10772 @item gnus-kill-killed
10773 @vindex gnus-kill-killed
10774 If this variable is @code{nil}, Gnus will never apply score files to
10775 articles that have already been through the kill process.  While this
10776 may save you lots of time, it also means that if you apply a kill file
10777 to a group, and then change the kill file and want to run it over you
10778 group again to kill more articles, it won't work.  You have to set this
10779 variable to @code{t} to do that.  (It is @code{t} by default.)
10780
10781 @item gnus-kill-files-directory
10782 @vindex gnus-kill-files-directory
10783 All kill and score files will be stored in this directory, which is
10784 initialized from the @code{SAVEDIR} environment variable by default.
10785 This is @file{~/News/} by default.
10786
10787 @item gnus-score-file-suffix
10788 @vindex gnus-score-file-suffix
10789 Suffix to add to the group name to arrive at the score file name
10790 (@samp{SCORE} by default.)
10791
10792 @item gnus-score-uncacheable-files
10793 @vindex gnus-score-uncacheable-files
10794 @cindex score cache
10795 All score files are normally cached to avoid excessive re-loading of
10796 score files.  However, if this might make you Emacs grow big and
10797 bloated, so this regexp can be used to weed out score files that are
10798 unlikely to be needed again.  It would be a bad idea to deny caching of
10799 @file{all.SCORE}, while it might be a good idea to not cache
10800 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
10801 variable is @samp{ADAPT$} by default, so no adaptive score files will
10802 be cached.
10803
10804 @item gnus-save-score
10805 @vindex gnus-save-score
10806 If you have really complicated score files, and do lots of batch
10807 scoring, then you might set this variable to @code{t}.  This will make
10808 Gnus save the scores into the @file{.newsrc.eld} file.
10809
10810 @item gnus-score-interactive-default-score
10811 @vindex gnus-score-interactive-default-score
10812 Score used by all the interactive raise/lower commands to raise/lower
10813 score with.  Default is 1000, which may seem excessive, but this is to
10814 ensure that the adaptive scoring scheme gets enough room to play with.
10815 We don't want the small changes from the adaptive scoring to overwrite
10816 manually entered data.
10817
10818 @item gnus-summary-default-score
10819 @vindex gnus-summary-default-score
10820 Default score of an article, which is 0 by default.
10821
10822 @item gnus-summary-expunge-below
10823 @vindex gnus-summary-expunge-below
10824 Don't display the summary lines of articles that have scores lower than
10825 this variable.  This is @code{nil} by default, which means that no
10826 articles will be hidden.
10827
10828 @item gnus-score-over-mark
10829 @vindex gnus-score-over-mark
10830 Mark (in the third column) used for articles with a score over the
10831 default.  Default is @samp{+}.
10832
10833 @item gnus-score-below-mark
10834 @vindex gnus-score-below-mark
10835 Mark (in the third column) used for articles with a score below the
10836 default.  Default is @samp{-}.
10837
10838 @item gnus-score-find-score-files-function
10839 @vindex gnus-score-find-score-files-function
10840 Function used to find score files for the current group.  This function
10841 is called with the name of the group as the argument. 
10842
10843 Predefined functions available are:
10844 @table @code
10845
10846 @item gnus-score-find-single
10847 @findex gnus-score-find-single
10848 Only apply the group's own score file.
10849
10850 @item gnus-score-find-bnews
10851 @findex gnus-score-find-bnews
10852 Apply all score files that match, using bnews syntax.  This is the
10853 default.  If the current group is @samp{gnu.emacs.gnus}, for instance, 
10854 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10855 @file{gnu.all.SCORE} would all apply.  In short, the instances of
10856 @samp{all} in the score file names are translated into @samp{.*}, and
10857 then a regexp match is done.
10858
10859 This means that if you have some score entries that you want to apply to
10860 all groups, then you put those entries in the @file{all.SCORE} file. 
10861
10862 The score files are applied in a semi-random order, although Gnus will
10863 try to apply the more general score files before the more specific score
10864 files.  It does this by looking at the number of elements in the score
10865 file names---discarding the @samp{all} elements.
10866
10867 @item gnus-score-find-hierarchical
10868 @findex gnus-score-find-hierarchical
10869 Apply all score files from all the parent groups.  This means that you
10870 can't have score files like @file{all.SCORE}, but you can have
10871 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10872
10873 @end table
10874 This variable can also be a list of functions.  In that case, all these
10875 functions will be called, and all the returned lists of score files will
10876 be applied.  These functions can also return lists of score alists
10877 directly.  In that case, the functions that return these non-file score
10878 alists should probably be placed before the ``real'' score file
10879 functions, to ensure that the last score file returned is the local
10880 score file.  Phu.
10881
10882 @item gnus-score-expiry-days
10883 @vindex gnus-score-expiry-days
10884 This variable says how many days should pass before an unused score file
10885 entry is expired.  If this variable is @code{nil}, no score file entries
10886 are expired.  It's 7 by default.
10887
10888 @item gnus-update-score-entry-dates
10889 @vindex gnus-update-score-entry-dates
10890 If this variable is non-@code{nil}, matching score entries will have
10891 their dates updated.  (This is how Gnus controls expiry---all
10892 non-matching entries will become too old while matching entries will
10893 stay fresh and young.)  However, if you set this variable to @code{nil},
10894 even matching entries will grow old and will have to face that oh-so
10895 grim reaper.  
10896
10897 @item gnus-score-after-write-file-function
10898 @vindex gnus-score-after-write-file-function
10899 Function called with the name of the score file just written.
10900
10901 @end table
10902
10903
10904 @node Score File Format
10905 @section Score File Format
10906 @cindex score file format
10907
10908 A score file is an @code{emacs-lisp} file that normally contains just a
10909 single form.  Casual users are not expected to edit these files;
10910 everything can be changed from the summary buffer.
10911
10912 Anyway, if you'd like to dig into it yourself, here's an example:
10913
10914 @lisp
10915 (("from"
10916   ("Lars Ingebrigtsen" -10000)
10917   ("Per Abrahamsen")
10918   ("larsi\\|lmi" -50000 nil R))
10919  ("subject"
10920   ("Ding is Badd" nil 728373))
10921  ("xref"
10922   ("alt.politics" -1000 728372 s))
10923  ("lines"
10924   (2 -100 nil <))
10925  (mark 0)
10926  (expunge -1000)
10927  (mark-and-expunge -10)
10928  (read-only nil)
10929  (orphan -10)
10930  (adapt t)
10931  (files "/hom/larsi/News/gnu.SCORE")
10932  (exclude-files "all.SCORE")
10933  (local (gnus-newsgroup-auto-expire t)
10934         (gnus-summary-make-false-root 'empty))
10935  (eval (ding)))
10936 @end lisp
10937
10938 This example demonstrates absolutely everything about a score file. 
10939
10940 Even though this looks much like lisp code, nothing here is actually
10941 @code{eval}ed.  The lisp reader is used to read this form, though, so it
10942 has to be legal syntactically, if not semantically.
10943
10944 Six keys are supported by this alist:
10945
10946 @table @code
10947
10948 @item STRING
10949 If the key is a string, it is the name of the header to perform the
10950 match on.  Scoring can only be performed on these eight headers:
10951 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10952 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
10953 these headers, there are three strings to tell Gnus to fetch the entire
10954 article and do the match on larger parts of the article: @code{Body}
10955 will perform the match on the body of the article, @code{Head} will
10956 perform the match on the head of the article, and @code{All} will
10957 perform the match on the entire article.  Note that using any of these
10958 last three keys will slow down group entry @emph{considerably}.  The
10959 final ``header'' you can score on is @code{Followup}.  These score
10960 entries will result in new score entries being added for all follow-ups
10961 to articles that matches these score entries.
10962
10963 Following this key is a arbitrary number of score entries, where each
10964 score entry has one to four elements.
10965 @enumerate
10966
10967 @item 
10968 The first element is the @dfn{match element}.  On most headers this will
10969 be a string, but on the Lines and Chars headers, this must be an
10970 integer. 
10971
10972 @item 
10973 If the second element is present, it should be a number---the @dfn{score
10974 element}.  This number should be an integer in the neginf to posinf
10975 interval.  This number is added to the score of the article if the match
10976 is successful.  If this element is not present, the
10977 @code{gnus-score-interactive-default-score} number will be used
10978 instead.  This is 1000 by default.
10979
10980 @item 
10981 If the third element is present, it should be a number---the @dfn{date
10982 element}.  This date says when the last time this score entry matched,
10983 which provides a mechanism for expiring the score entries.  It this
10984 element is not present, the score entry is permanent.  The date is
10985 represented by the number of days since December 31, 1 BCE.
10986
10987 @item 
10988 If the fourth element is present, it should be a symbol---the @dfn{type
10989 element}.  This element specifies what function should be used to see
10990 whether this score entry matches the article.  What match types that can
10991 be used depends on what header you wish to perform the match on.
10992 @table @dfn
10993
10994 @item From, Subject, References, Xref, Message-ID
10995 For most header types, there are the @code{r} and @code{R} (regexp), as
10996 well as @code{s} and @code{S} (substring) types, and @code{e} and
10997 @code{E} (exact match), and @code{w} (word match) types.  If this
10998 element is not present, Gnus will assume that substring matching should
10999 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
11000 that the matches will be done in a case-sensitive manner.  All these
11001 one-letter types are really just abbreviations for the @code{regexp},
11002 @code{string}, @code{exact}, and @code{word} types, which you can use
11003 instead, if you feel like.
11004
11005 @item Lines, Chars
11006 These two headers use different match types: @code{<}, @code{>},
11007 @code{=}, @code{>=} and @code{<=}.  When matching on @code{Lines}, be
11008 careful because some backends (like @code{nndir}) do not generate
11009 @code{Lines} header, so every article ends up being marked as having 0
11010 lines.  This can lead to strange results if you happen to lower score of
11011 the articles with few lines.
11012
11013 @item Date
11014 For the Date header we have three kinda silly match types:
11015 @code{before}, @code{at} and @code{after}.  I can't really imagine this
11016 ever being useful, but, like, it would feel kinda silly not to provide
11017 this function.  Just in case.  You never know.  Better safe than sorry.
11018 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
11019 sex on a first date.  (I have been told that at least one person, and I
11020 quote, ``found this function indispensable'', however.)
11021
11022 @cindex ISO8601
11023 @cindex date
11024 A more useful match type is @code{regexp}.  With it, you can match the
11025 date string using a regular expression.  The date is normalized to
11026 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}.  If you want to
11027 match all articles that have been posted on April 1st in every year, you
11028 could use @samp{....0401.........} as a match string, for instance.
11029 (Note that the date is kept in its original time zone, so this will
11030 match articles that were posted when it was April 1st where the article
11031 was posted from.  Time zones are such wholesome fun for the whole
11032 family, eh?)
11033
11034 @item Head, Body, All
11035 These three match keys use the same match types as the @code{From} (etc)
11036 header uses.
11037
11038 @item Followup
11039 This match key is somewhat special, in that it will match the
11040 @code{From} header, and affect the score of not only the matching
11041 articles, but also all followups to the matching articles.  This allows
11042 you e.g. increase the score of followups to your own articles, or
11043 decrease the score of followups to the articles of some known
11044 trouble-maker.  Uses the same match types as the @code{From} header
11045 uses.
11046
11047 @item Thread
11048 This match key works along the same lines as the @code{Followup} match
11049 key.  If you say that you want to score on a (sub-)thread that is
11050 started by an article with a @code{Message-ID} @var{X}, then you add a
11051 @samp{thread} match.  This will add a new @samp{thread} match for each
11052 article that has @var{X} in its @code{References} header.  (These new
11053 @samp{thread} matches will use the @code{Message-ID}s of these matching
11054 articles.)  This will ensure that you can raise/lower the score of an
11055 entire thread, even though some articles in the thread may not have
11056 complete @code{References} headers.  Note that using this may lead to
11057 undeterministic scores of the articles in the thread.
11058 @end table
11059 @end enumerate
11060
11061 @item mark
11062 The value of this entry should be a number.  Any articles with a score
11063 lower than this number will be marked as read.
11064
11065 @item expunge
11066 The value of this entry should be a number.  Any articles with a score
11067 lower than this number will be removed from the summary buffer.
11068
11069 @item mark-and-expunge
11070 The value of this entry should be a number.  Any articles with a score
11071 lower than this number will be marked as read and removed from the
11072 summary buffer.
11073
11074 @item thread-mark-and-expunge
11075 The value of this entry should be a number.  All articles that belong to
11076 a thread that has a total score below this number will be marked as read
11077 and removed from the summary buffer.  @code{gnus-thread-score-function}
11078 says how to compute the total score for a thread.
11079
11080 @item files
11081 The value of this entry should be any number of file names.  These files
11082 are assumed to be score files as well, and will be loaded the same way
11083 this one was.
11084
11085 @item exclude-files
11086 The clue of this entry should be any number of files.  These files will
11087 not be loaded, even though they would normally be so, for some reason or
11088 other. 
11089
11090 @item eval
11091 The value of this entry will be @code{eval}el.  This element will be
11092 ignored when handling global score files. 
11093
11094 @item read-only
11095 Read-only score files will not be updated or saved.  Global score files
11096 should feature this atom (@pxref{Global Score Files}).
11097
11098 @item orphan
11099 The value of this entry should be a number.  Articles that do not have
11100 parents will get this number added to their scores.  Imagine you follow
11101 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
11102 will only follow a few of the threads, also want to see any new threads.
11103
11104 You can do this with the following two score file entries:
11105
11106 @example
11107         (orphan -500)
11108         (mark-and-expunge -100)
11109 @end example
11110
11111 When you enter the group the first time, you will only see the new
11112 threads.  You then raise the score of the threads that you find
11113 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11114 rest.  Next time you enter the group, you will see new articles in the
11115 interesting threads, plus any new threads.
11116
11117 I.e.---the orphan score atom is for high-volume groups where there
11118 exist a few interesting threads which can't be found automatically by
11119 ordinary scoring rules.
11120
11121 @item adapt
11122 This entry controls the adaptive scoring.  If it is @code{t}, the
11123 default adaptive scoring rules will be used.  If it is @code{ignore}, no
11124 adaptive scoring will be performed on this group.  If it is a list, this
11125 list will be used as the adaptive scoring rules.  If it isn't present,
11126 or is something other than @code{t} or @code{ignore}, the default
11127 adaptive scoring rules will be used.  If you want to use adaptive
11128 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11129 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11130 not want adaptive scoring.  If you only want adaptive scoring in a few
11131 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11132 insert @code{(adapt t)} in the score files of the groups where you want
11133 it. 
11134
11135 @item adapt-file
11136 All adaptive score entries will go to the file named by this entry.  It
11137 will also be applied when entering the group.  This atom might be handy
11138 if you want to adapt on several groups at once, using the same adaptive
11139 file for a number of groups.
11140
11141 @item local
11142 @cindex local variables
11143 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11144 Each @var{var} will be made buffer-local to the current summary buffer,
11145 and set to the value specified.  This is a convenient, if somewhat
11146 strange, way of setting variables in some groups if you don't like hooks
11147 much.
11148 @end table
11149
11150
11151 @node Score File Editing
11152 @section Score File Editing
11153
11154 You normally enter all scoring commands from the summary buffer, but you
11155 might feel the urge to edit them by hand as well, so we've supplied you
11156 with a mode for that.  
11157
11158 It's simply a slightly customized @code{emacs-lisp} mode, with these
11159 additional commands:
11160
11161 @table @kbd
11162
11163 @item C-c C-c
11164 @kindex C-c C-c (Score)
11165 @findex gnus-score-edit-done
11166 Save the changes you have made and return to the summary buffer
11167 (@code{gnus-score-edit-done}). 
11168
11169 @item C-c C-d
11170 @kindex C-c C-d (Score)
11171 @findex gnus-score-edit-insert-date
11172 Insert the current date in numerical format
11173 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
11174 you were wondering.
11175
11176 @item C-c C-p
11177 @kindex C-c C-p (Score)
11178 @findex gnus-score-pretty-print
11179 The adaptive score files are saved in an unformatted fashion.  If you
11180 intend to read one of these files, you want to @dfn{pretty print} it
11181 first.  This command (@code{gnus-score-pretty-print}) does that for
11182 you. 
11183
11184 @end table
11185
11186 Type @kbd{M-x gnus-score-mode} to use this mode.
11187
11188 @vindex gnus-score-mode-hook
11189 @code{gnus-score-menu-hook} is run in score mode buffers.
11190
11191 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11192 e} to begin editing score files.
11193
11194
11195 @node Adaptive Scoring
11196 @section Adaptive Scoring
11197 @cindex adaptive scoring
11198
11199 If all this scoring is getting you down, Gnus has a way of making it all
11200 happen automatically---as if by magic.  Or rather, as if by artificial
11201 stupidity, to be precise.
11202
11203 @vindex gnus-use-adaptive-scoring
11204 When you read an article, or mark an article as read, or kill an
11205 article, you leave marks behind.  On exit from the group, Gnus can sniff
11206 these marks and add score elements depending on what marks it finds.
11207 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11208 @code{t} or @code{(line)}.  If you want score adaptively on separate
11209 words appearing in the subjects, you should set this variable to
11210 @code{(word)}.  If you want to use both adaptive methods, set this
11211 variable to @code{(word line)}.
11212
11213 @vindex gnus-default-adaptive-score-alist
11214 To give you complete control over the scoring process, you can customize
11215 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
11216 might look something like this:
11217
11218 @lisp
11219 (defvar gnus-default-adaptive-score-alist
11220   '((gnus-unread-mark)
11221     (gnus-ticked-mark (from 4))
11222     (gnus-dormant-mark (from 5))
11223     (gnus-del-mark (from -4) (subject -1))
11224     (gnus-read-mark (from 4) (subject 2))
11225     (gnus-expirable-mark (from -1) (subject -1))
11226     (gnus-killed-mark (from -1) (subject -3))
11227     (gnus-kill-file-mark)
11228     (gnus-ancient-mark)
11229     (gnus-low-score-mark)
11230     (gnus-catchup-mark (from -1) (subject -1))))
11231 @end lisp
11232
11233 As you see, each element in this alist has a mark as a key (either a
11234 variable name or a ``real'' mark---a character).  Following this key is
11235 a arbitrary number of header/score pairs.  If there are no header/score
11236 pairs following the key, no adaptive scoring will be done on articles
11237 that have that key as the article mark.  For instance, articles with
11238 @code{gnus-unread-mark} in the example above will not get adaptive score
11239 entries.
11240
11241 Each article can have only one mark, so just a single of these rules
11242 will be applied to each article.
11243
11244 To take @code{gnus-del-mark} as an example---this alist says that all
11245 articles that have that mark (i.e., are marked with @samp{D}) will have a
11246 score entry added to lower based on the @code{From} header by -4, and
11247 lowered by @code{Subject} by -1.  Change this to fit your prejudices. 
11248
11249 If you have marked 10 articles with the same subject with
11250 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11251 That means that that subject will get a score of ten times -1, which
11252 should be, unless I'm much mistaken, -10.
11253
11254 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11255 the read articles will be marked with the @samp{E} mark.  This'll
11256 probably make adaptive scoring slightly impossible, so auto-expiring and
11257 adaptive scoring doesn't really mix very well.
11258
11259 The headers you can score on are @code{from}, @code{subject},
11260 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11261 @code{chars} and @code{date}.  In addition, you can score on
11262 @code{followup}, which will create an adaptive score entry that matches
11263 on the @code{References} header using the @code{Message-ID} of the
11264 current article, thereby matching the following thread.  
11265
11266 You can also score on @code{thread}, which will try to score all
11267 articles that appear in a thread.  @code{thread} matches uses a
11268 @code{Message-ID} to match on the @code{References} header of the
11269 article.  If the match is made, the @code{Message-ID} of the article is
11270 added to the @code{thread} rule.  (Think about it.  I'd recommend two
11271 aspirins afterwards.)
11272
11273 If you use this scheme, you should set the score file atom @code{mark}
11274 to something small---like -300, perhaps, to avoid having small random
11275 changes result in articles getting marked as read.
11276
11277 After using adaptive scoring for a week or so, Gnus should start to
11278 become properly trained and enhance the authors you like best, and kill
11279 the authors you like least, without you having to say so explicitly. 
11280
11281 You can control what groups the adaptive scoring is to be performed on
11282 by using the score files (@pxref{Score File Format}).  This will also
11283 let you use different rules in different groups.
11284
11285 @vindex gnus-adaptive-file-suffix
11286 The adaptive score entries will be put into a file where the name is the
11287 group name with @code{gnus-adaptive-file-suffix} appended.  The default
11288 is @samp{ADAPT}.
11289
11290 @vindex gnus-score-exact-adapt-limit
11291 When doing adaptive scoring, substring or fuzzy matching would probably
11292 give you the best results in most cases.  However, if the header one
11293 matches is short, the possibility for false positives is great, so if
11294 the length of the match is less than
11295 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
11296 this variable is @code{nil}, exact matching will always be used to avoid
11297 this problem.
11298
11299 @vindex gnus-default-adaptive-word-score-alist
11300 As mentioned above, you can adapt either on individual words or entire
11301 headers.  If you adapt on words, the
11302 @code{gnus-default-adaptive-word-score-alist} variable says what score
11303 each instance of a word should add given a mark.
11304
11305 @lisp
11306 (setq gnus-default-adaptive-word-score-alist  
11307       `((,gnus-read-mark . 30)
11308         (,gnus-catchup-mark . -10)
11309         (,gnus-killed-mark . -20)
11310         (,gnus-del-mark . -15)))
11311 @end lisp
11312
11313 This is the default value.  If you have adaption on words enabled, every
11314 word that appears in subjects of articles that are marked with
11315 @code{gnus-read-mark} will result in a score rule that increase the
11316 score with 30 points.
11317
11318 @vindex gnus-default-ignored-adaptive-words
11319 @vindex gnus-ignored-adaptive-words
11320 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11321 will be ignored.  If you wish to add more words to be ignored, use the
11322 @code{gnus-ignored-adaptive-words} list instead.
11323
11324 @vindex gnus-adaptive-word-syntax-table
11325 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11326 syntax table in effect.  It is similar to the standard syntax table, but
11327 it considers numbers to be non-word-constituent characters.
11328
11329 After using this scheme for a while, it might be nice to write a
11330 @code{gnus-psychoanalyze-user} command to go through the rules and see
11331 what words you like and what words you don't like.  Or perhaps not.
11332
11333 Note that the adaptive word scoring thing is highly experimental and is
11334 likely to change in the future.  Initial impressions seem to indicate
11335 that it's totally useless as it stands.  Some more work (involving more
11336 rigorous statistical methods) will have to be done to make this useful. 
11337
11338
11339 @node Home Score File
11340 @section Home Score File
11341
11342 The score file where new score file entries will go is called the
11343 @dfn{home score file}.  This is normally (and by default) the score file
11344 for the group itself.  For instance, the home score file for
11345 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11346
11347 However, this may not be what you want.  It is often convenient to share
11348 a common home score file among many groups---all @samp{emacs} groups
11349 could perhaps use the same home score file.
11350
11351 @vindex gnus-home-score-file
11352 The variable that controls this is @code{gnus-home-score-file}.  It can
11353 be:
11354
11355 @enumerate
11356 @item
11357 A string.  Then this file will be used as the home score file for all
11358 groups. 
11359
11360 @item
11361 A function. The result of this function will be used as the home score
11362 file.  The function will be called with the name of the group as the
11363 parameter. 
11364
11365 @item
11366 A list.  The elements in this list can be:
11367
11368 @enumerate
11369 @item 
11370 @var{(regexp file-name)}.  If the @var{regexp} matches the group name,
11371 the @var{file-name} will will be used as the home score file.
11372
11373 @item 
11374 A function. If the function returns non-nil, the result will be used as
11375 the home score file.
11376
11377 @item 
11378 A string.  Use the string as the home score file.
11379 @end enumerate
11380
11381 The list will be traversed from the beginning towards the end looking
11382 for matches.
11383
11384 @end enumerate
11385
11386 So, if you want to use just a single score file, you could say:
11387
11388 @lisp
11389 (setq gnus-home-score-file
11390       "my-total-score-file.SCORE")
11391 @end lisp
11392
11393 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11394 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11395
11396 @lisp
11397 (setq gnus-home-score-file
11398       'gnus-hierarchial-home-score-file)
11399 @end lisp
11400
11401 This is a ready-made function provided for your convenience.
11402
11403 If you want to have one score file for the @samp{emacs} groups and
11404 another for the @samp{comp} groups, while letting all other groups use
11405 their own home score files:
11406
11407 @lisp
11408 (setq gnus-home-score-file
11409       ;; All groups that match the regexp "\\.emacs"
11410       '("\\.emacs" "emacs.SCORE")
11411       ;; All the comp groups in one score file
11412        ("^comp" "comp.SCORE"))
11413 @end lisp
11414    
11415 @vindex gnus-home-adapt-file
11416 @code{gnus-home-adapt-file} works exactly the same way as
11417 @code{gnus-home-score-file}, but says what the home adaptive score file
11418 is instead.  All new adaptive file entries will go into the file
11419 specified by this variable, and the same syntax is allowed.
11420
11421 In addition to using @code{gnus-home-score-file} and
11422 @code{gnus-home-adapt-file}, you can also use group parameters
11423 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11424 Parameters}) to achieve much the same.  Group and topic parameters take
11425 precedence over this variable.
11426
11427
11428 @node Followups To Yourself
11429 @section Followups To Yourself
11430
11431 Gnus offers two commands for picking out the @code{Message-ID} header in
11432 the current buffer.  Gnus will then add a score rule that scores using
11433 this @code{Message-ID} on the @code{References} header of other
11434 articles.  This will, in effect, increase the score of all articles that
11435 respond to the article in the current buffer.  Quite useful if you want
11436 to easily note when people answer what you've said.
11437
11438 @table @code
11439
11440 @item gnus-score-followup-article
11441 @findex gnus-score-followup-article
11442 This will add a score to articles that directly follow up your own
11443 article. 
11444
11445 @item gnus-score-followup-thread
11446 @findex gnus-score-followup-thread
11447 This will add a score to all articles that appear in a thread ``below''
11448 your own article.
11449 @end table
11450
11451 @vindex message-sent-hook
11452 These two functions are both primarily meant to be used in hooks like
11453 @code{message-sent-hook}.  
11454
11455 If you look closely at your own @code{Message-ID}, you'll notice that
11456 the first two or three characters are always the same.  Here's two of
11457 mine:  
11458
11459 @example
11460 <x6u3u47icf.fsf@@eyesore.no>
11461 <x6sp9o7ibw.fsf@@eyesore.no>
11462 @end example
11463
11464 So ``my'' ident on this machine is @samp{x6}.  This can be
11465 exploited---the following rule will raise the score on all followups to
11466 myself: 
11467
11468 @lisp
11469 ("references"
11470  ("<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r))
11471 @end lisp
11472
11473 Whether it's the first two or first three characters that are ``yours''
11474 is system-dependent.
11475
11476
11477 @node Scoring Tips
11478 @section Scoring Tips
11479 @cindex scoring tips
11480
11481 @table @dfn
11482
11483 @item Crossposts
11484 @cindex crossposts
11485 @cindex scoring crossposts
11486 If you want to lower the score of crossposts, the line to match on is
11487 the @code{Xref} header.
11488 @lisp
11489 ("xref" (" talk.politics.misc:" -1000))
11490 @end lisp
11491
11492 @item Multiple crossposts
11493 If you want to lower the score of articles that have been crossposted to
11494 more than, say, 3 groups:
11495 @lisp
11496 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11497 @end lisp
11498
11499 @item Matching on the body
11500 This is generally not a very good idea---it takes a very long time.
11501 Gnus actually has to fetch each individual article from the server.  But
11502 you might want to anyway, I guess.  Even though there are three match
11503 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11504 and stick with it in each score file.  If you use any two, each article
11505 will be fetched @emph{twice}.  If you want to match a bit on the
11506 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11507 the matches.  
11508
11509 @item Marking as read
11510 You will probably want to mark articles that has a score below a certain
11511 number as read.  This is most easily achieved by putting the following
11512 in your @file{all.SCORE} file:
11513 @lisp
11514 ((mark -100))
11515 @end lisp
11516 You may also consider doing something similar with @code{expunge}.  
11517
11518 @item Negated character classes
11519 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11520 That will match newlines, which might lead to, well, The Unknown.  Say
11521 @code{[^abcd\n]*} instead.
11522 @end table
11523
11524
11525 @node Reverse Scoring
11526 @section Reverse Scoring
11527 @cindex reverse scoring
11528
11529 If you want to keep just articles that have @samp{Sex with Emacs} in the
11530 subject header, and expunge all other articles, you could put something
11531 like this in your score file:
11532
11533 @lisp
11534 (("subject"
11535   ("Sex with Emacs" 2))
11536  (mark 1)
11537  (expunge 1))
11538 @end lisp
11539
11540 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11541 rest as read, and expunge them to boot.
11542
11543
11544 @node Global Score Files
11545 @section Global Score Files
11546 @cindex global score files
11547
11548 Sure, other newsreaders have ``global kill files''.  These are usually
11549 nothing more than a single kill file that applies to all groups, stored
11550 in the user's home directory.  Bah!  Puny, weak newsreaders!
11551
11552 What I'm talking about here are Global Score Files.  Score files from
11553 all over the world, from users everywhere, uniting all nations in one
11554 big, happy score file union!  Ange-score!  New and untested!
11555
11556 @vindex gnus-global-score-files
11557 All you have to do to use other people's score files is to set the
11558 @code{gnus-global-score-files} variable.  One entry for each score file,
11559 or each score file directory.  Gnus will decide by itself what score
11560 files are applicable to which group.
11561
11562 Say you want to use the score file
11563 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11564 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11565
11566 @lisp
11567 (setq gnus-global-score-files
11568       '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11569         "/ftp@@ftp.some-where:/pub/score/"))
11570 @end lisp
11571
11572 @findex gnus-score-search-global-directories
11573 Simple, eh?  Directory names must end with a @samp{/}.  These
11574 directories are typically scanned only once during each Gnus session.
11575 If you feel the need to manually re-scan the remote directories, you can
11576 use the @code{gnus-score-search-global-directories} command.
11577
11578 Note that, at present, using this option will slow down group entry
11579 somewhat.  (That is---a lot.)
11580
11581 If you want to start maintaining score files for other people to use,
11582 just put your score file up for anonymous ftp and announce it to the
11583 world.  Become a retro-moderator!  Participate in the retro-moderator
11584 wars sure to ensue, where retro-moderators battle it out for the
11585 sympathy of the people, luring them to use their score files on false
11586 premises!  Yay!  The net is saved!
11587
11588 Here are some tips for the would-be retro-moderator, off the top of my
11589 head: 
11590
11591 @itemize @bullet
11592
11593 @item 
11594 Articles that are heavily crossposted are probably junk. 
11595 @item
11596 To lower a single inappropriate article, lower by @code{Message-ID}.
11597 @item
11598 Particularly brilliant authors can be raised on a permanent basis. 
11599 @item
11600 Authors that repeatedly post off-charter for the group can safely be
11601 lowered out of existence.
11602 @item
11603 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11604 articles completely.
11605
11606 @item 
11607 Use expiring score entries to keep the size of the file down.  You
11608 should probably have a long expiry period, though, as some sites keep
11609 old articles for a long time.
11610 @end itemize
11611
11612 ... I wonder whether other newsreaders will support global score files
11613 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
11614 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
11615 holding our breath yet?
11616
11617
11618 @node Kill Files
11619 @section Kill Files
11620 @cindex kill files
11621
11622 Gnus still supports those pesky old kill files.  In fact, the kill file
11623 entries can now be expiring, which is something I wrote before Daniel
11624 Quinlan thought of doing score files, so I've left the code in there.
11625
11626 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11627 than score processing, so it might be a good idea to rewrite your kill
11628 files into score files.
11629
11630 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
11631 forms into this file, which means that you can use kill files as some
11632 sort of primitive hook function to be run on group entry, even though
11633 that isn't a very good idea.
11634
11635 Normal kill files look like this:
11636
11637 @lisp
11638 (gnus-kill "From" "Lars Ingebrigtsen")
11639 (gnus-kill "Subject" "ding")
11640 (gnus-expunge "X")
11641 @end lisp
11642
11643 This will mark every article written by me as read, and remove them from
11644 the summary buffer.  Very useful, you'll agree.
11645
11646 Other programs use a totally different kill file syntax.  If Gnus
11647 encounters what looks like a @code{rn} kill file, it will take a stab at
11648 interpreting it. 
11649
11650 Two summary functions for editing a GNUS kill file:
11651
11652 @table @kbd
11653
11654 @item M-k
11655 @kindex M-k (Summary)
11656 @findex gnus-summary-edit-local-kill
11657 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11658
11659 @item M-K
11660 @kindex M-K (Summary)
11661 @findex gnus-summary-edit-global-kill
11662 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11663 @end table
11664
11665 Two group mode functions for editing the kill files:
11666
11667 @table @kbd
11668
11669 @item M-k
11670 @kindex M-k (Group)
11671 @findex gnus-group-edit-local-kill
11672 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11673
11674 @item M-K
11675 @kindex M-K (Group)
11676 @findex gnus-group-edit-global-kill
11677 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11678 @end table
11679
11680 Kill file variables:
11681
11682 @table @code
11683 @item gnus-kill-file-name
11684 @vindex gnus-kill-file-name
11685 A kill file for the group @samp{soc.motss} is normally called
11686 @file{soc.motss.KILL}.  The suffix appended to the group name to get
11687 this file name is detailed by the @code{gnus-kill-file-name} variable.
11688 The ``global'' kill file (not in the score file sense of ``global'', of
11689 course) is called just @file{KILL}.
11690
11691 @vindex gnus-kill-save-kill-file
11692 @item gnus-kill-save-kill-file
11693 If this variable is non-@code{nil}, Gnus will save the
11694 kill file after processing, which is necessary if you use expiring
11695 kills. 
11696
11697 @item gnus-apply-kill-hook
11698 @vindex gnus-apply-kill-hook
11699 @findex gnus-apply-kill-file-unless-scored
11700 @findex gnus-apply-kill-file
11701 A hook called to apply kill files to a group.  It is
11702 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
11703 kill file if you have a score file for the same group, you can set this
11704 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
11705 kill files to be processed, you should set this variable to @code{nil}.
11706
11707 @item gnus-kill-file-mode-hook
11708 @vindex gnus-kill-file-mode-hook
11709 A hook called in kill-file mode buffers.
11710
11711 @end table
11712
11713
11714 @node Converting Kill Files
11715 @section Converting Kill Files
11716 @cindex kill files
11717 @cindex converting kill files
11718
11719 If you have loads of old kill files, you may want to convert them into
11720 score files.  If they are ``regular'', you can use
11721 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11722 by hand.
11723
11724 The kill to score conversion package isn't included in Gnus by default.
11725 You can fetch it from
11726 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.  
11727
11728 If your old kill files are very complex---if they contain more
11729 non-@code{gnus-kill} forms than not, you'll have to convert them by
11730 hand.  Or just let them be as they are.  Gnus will still use them as
11731 before. 
11732
11733
11734 @node GroupLens
11735 @section GroupLens
11736 @cindex GroupLens
11737
11738 GroupLens is a collaborative filtering system that helps you work
11739 together with other people to find the quality news articles out of the
11740 huge volume of news articles generated every day.
11741
11742 To accomplish this the GroupLens system combines your opinions about
11743 articles you have already read with the opinions of others who have done
11744 likewise and gives you a personalized prediction for each unread news
11745 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
11746 rate articles, and finds other people that rate articles the same way.
11747 Once it has found for you some people you agree with it tells you, in
11748 the form of a prediction, what they thought of the article.  You can use
11749 this prediction to help you decide whether or not you want to read the
11750 article.
11751
11752 @menu
11753 * Using GroupLens::          How to make Gnus use GroupLens.
11754 * Rating Articles::          Letting GroupLens know how you rate articles.
11755 * Displaying Predictions::   Displaying predictions given by GroupLens.
11756 * GroupLens Variables::      Customizing GroupLens.
11757 @end menu
11758
11759
11760 @node Using GroupLens
11761 @subsection Using GroupLens
11762
11763 To use GroupLens you must register a pseudonym with your local Better
11764 Bit Bureau (BBB).
11765 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11766 better bit in town is at the moment.
11767
11768 Once you have registered you'll need to set a couple of variables.
11769
11770 @table @code
11771
11772 @item gnus-use-grouplens
11773 @vindex gnus-use-grouplens
11774 Setting this variable to a non-@code{nil} value will make Gnus hook into
11775 all the relevant GroupLens functions.
11776
11777 @item grouplens-pseudonym
11778 @vindex grouplens-pseudonym
11779 This variable should be set to the pseudonym you got when registering
11780 with the Better Bit Bureau.
11781
11782 @item grouplens-newsgroups
11783 @vindex grouplens-newsgroups
11784 A list of groups that you want to get GroupLens predictions for. 
11785
11786 @end table
11787
11788 Thats the minimum of what you need to get up and running with GroupLens.
11789 Once you've registered, GroupLens will start giving you scores for
11790 articles based on the average of what other people think.  But, to get
11791 the real benefit of GroupLens you need to start rating articles
11792 yourself.  Then the scores GroupLens gives you will be personalized for
11793 you, based on how the people you usually agree with have already rated.
11794
11795
11796 @node Rating Articles
11797 @subsection Rating Articles
11798
11799 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11800 Where 1 means something like this article is a waste of bandwidth and 5
11801 means that the article was really good.  The basic question to ask
11802 yourself is, "on a scale from 1 to 5 would I like to see more articles
11803 like this one?"
11804
11805 There are four ways to enter a rating for an article in GroupLens.
11806
11807 @table @kbd
11808
11809 @item r
11810 @kindex r (GroupLens)
11811 @findex bbb-summary-rate-article
11812 This function will prompt you for a rating on a scale of one to five.
11813
11814 @item k
11815 @kindex k (GroupLens)
11816 @findex grouplens-score-thread
11817 This function will prompt you for a rating, and rate all the articles in
11818 the thread.  This is really useful for some of those long running giant
11819 threads in rec.humor.
11820
11821 @end table
11822
11823 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11824 the score of the article you're reading.
11825
11826 @table @kbd
11827
11828 @item 1-5 n
11829 @kindex n (GroupLens)
11830 @findex grouplens-next-unread-article
11831 Rate the article and go to the next unread article.
11832
11833 @item 1-5 ,
11834 @kindex , (GroupLens)
11835 @findex grouplens-best-unread-article
11836 Rate the article and go to the next unread article with the highest score.
11837
11838 @end table
11839
11840 If you want to give the current article a score of 4 and then go to the
11841 next article, just type @kbd{4 n}.
11842
11843
11844 @node Displaying Predictions
11845 @subsection Displaying Predictions
11846
11847 GroupLens makes a prediction for you about how much you will like a
11848 news article.  The predictions from GroupLens are on a scale from 1 to
11849 5, where 1 is the worst and 5 is the best.  You can use the predictions
11850 from GroupLens in one of three ways controlled by the variable
11851 @code{gnus-grouplens-override-scoring}.
11852
11853 @vindex gnus-grouplens-override-scoring
11854 There are three ways to display predictions in grouplens.  You may
11855 choose to have the GroupLens scores contribute to, or override the
11856 regular gnus scoring mechanism. override is the default; however, some
11857 people prefer to see the Gnus scores plus the grouplens scores.  To get
11858 the separate scoring behavior you need to set
11859 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
11860 GroupLens predictions combined with the grouplens scores set it to
11861 @code{'override} and to combine the scores set
11862 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
11863 the combine option you will also want to set the values for
11864 @code{grouplens-prediction-offset} and
11865 @code{grouplens-score-scale-factor}.
11866
11867 @vindex grouplens-prediction-display
11868 In either case, GroupLens gives you a few choices for how you would like
11869 to see your predictions displayed.  The display of predictions is
11870 controlled by the @code{grouplens-prediction-display} variable.
11871
11872 The following are legal values for that variable.
11873
11874 @table @code
11875 @item prediction-spot
11876 The higher the prediction, the further to the right an @samp{*} is
11877 displayed. 
11878
11879 @item confidence-interval
11880 A numeric confidence interval.
11881
11882 @item prediction-bar
11883 The higher the prediction, the longer the bar.
11884
11885 @item confidence-bar
11886 Numerical confidence.
11887
11888 @item confidence-spot
11889 The spot gets bigger with more confidence.
11890
11891 @item prediction-num
11892 Plain-old numeric value.
11893
11894 @item confidence-plus-minus
11895 Prediction +/i confidence.
11896
11897 @end table
11898
11899
11900 @node GroupLens Variables
11901 @subsection GroupLens Variables
11902
11903 @table @code
11904
11905 @item gnus-summary-grouplens-line-format
11906 The summary line format used in summary buffers that are GroupLens
11907 enhanced.  It accepts the same specs as the normal summary line format
11908 (@pxref{Summary Buffer Lines}).  The default is
11909 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11910
11911 @item grouplens-bbb-host
11912 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
11913 default.
11914
11915 @item grouplens-bbb-port
11916 Port of the host running the bbbd server.  The default is 9000.
11917
11918 @item grouplens-score-offset
11919 Offset the prediction by this value.  In other words, subtract the
11920 prediction value by this number to arrive at the effective score.  The
11921 default is 0.
11922
11923 @item grouplens-score-scale-factor 
11924 This variable allows the user to magnify the effect of GroupLens scores.
11925 The scale factor is applied after the offset.  The default is 1.
11926
11927 @end table
11928
11929
11930 @node Advanced Scoring
11931 @section Advanced Scoring
11932
11933 Scoring on Subjects and From headers is nice enough, but what if you're
11934 really interested in what a person has to say only when she's talking
11935 about a particular subject?  Or what about if you really don't want to
11936 read what person A has to say when she's following up to person B, but
11937 want to read what she says when she's following up to person C?
11938
11939 By using advanced scoring rules you may create arbitrarily complex
11940 scoring patterns.
11941
11942 @menu
11943 * Advanced Scoring Syntax::     A definition.
11944 * Advanced Scoring Examples::   What they look like.
11945 * Advanced Scoring Tips::       Getting the most out of it.
11946 @end menu
11947
11948
11949 @node Advanced Scoring Syntax
11950 @subsection Advanced Scoring Syntax
11951
11952 Ordinary scoring rules have a string as the first element in the rule.
11953 Advanced scoring rules have a list as the first element.  The second
11954 element is the score to be applied if the first element evaluated to a
11955 non-@code{nil} value.
11956
11957 These lists may consist of three logical operators, one redirection
11958 operator, and various match operators.
11959
11960 Logical operators:
11961
11962 @table @code
11963 @item &
11964 @itemx and
11965 This logical operator will evaluate each of its arguments until it finds
11966 one that evaluates to @code{false}, and then it'll stop.  If all arguments
11967 evaluate to @code{true} values, then this operator will return
11968 @code{true}. 
11969
11970 @item |
11971 @itemx or
11972 This logical operator will evaluate each of its arguments until it finds
11973 one that evaluates to @code{true}.  If no arguments are @code{true},
11974 then this operator will return @code{false}.
11975
11976 @item !
11977 @itemx not
11978 @itemx Â¬
11979 This logical operator only takes a single argument.  It returns the
11980 inverse of the value of its argument.
11981
11982 @end table
11983
11984 There is an @dfn{indirection operator} that will make its arguments
11985 apply to the ancestors of the current article being scored.  For
11986 instance, @code{1-} will make score rules apply to the parent of the
11987 current article.  @code{2-} will make score fules apply to the
11988 grandparent of the current article.  Alternatively, you can write
11989 @code{^^}, where the number of @code{^}s (carets) say how far back into
11990 the ancestry you want to go.
11991
11992 Finally, we have the match operators.  These are the ones that do the
11993 real work.  Match operators are header name strings followed by a match
11994 and a match type.  A typical match operator looks like @samp{("from"
11995 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
11996 simple scoring, and the match types are also the same.
11997
11998
11999 @node Advanced Scoring Examples
12000 @subsection Advanced Scoring Examples
12001
12002 Let's say you want to increase the score of articles written by Lars
12003 when he's talking about Gnus:
12004
12005 @example
12006 ((& 
12007   ("from" "Lars Ingebrigtsen")
12008   ("subject" "Gnus"))
12009  1000)
12010 @end example
12011
12012 Quite simple, huh?
12013
12014 When he writes long articles, he sometimes has something nice to say: 
12015
12016 @example
12017 ((& 
12018   ("from" "Lars Ingebrigtsen")
12019   (|
12020    ("subject" "Gnus")
12021    ("lines" 100 >)))
12022  1000)
12023 @end example
12024
12025 However, when he responds to things written by Reig Eigil Logge, you
12026 really don't want to read what he's written:
12027
12028 @example
12029 ((&
12030   ("from" "Lars Ingebrigtsen")
12031   (1- ("from" "Reig Eigir Logge")))
12032  -100000)
12033 @end example
12034
12035 Everybody that follows up Redmondo when he writes about disappearing
12036 socks should have their scores raised, but only when they talk about
12037 white socks.  However, when Lars talks about socks, it's usually not
12038 very interesting:
12039
12040 @example
12041 ((&
12042   (1-
12043    (&
12044     ("from" "redmondo@@.*no" r)
12045     ("body" "disappearing.*socks" t)))
12046   (! ("from" "Lars Ingebrigtsen"))
12047   ("body" "white.*socks"))
12048  1000)
12049 @end example
12050
12051 The possibilities are endless.
12052
12053
12054 @node Advanced Scoring Tips
12055 @subsection Advanced Scoring Tips
12056
12057 The @code{&} and @code{|} logical operators do short-circuit logic.
12058 That is, they stop processing their arguments when it's clear what the
12059 result of the operation will be.  For instance, if one of the arguments
12060 of an @code{&} evaluates to @code{false}, there's no point in evaluating
12061 the rest of the arguments.  This means that you should put slow matches
12062 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12063 @samp{subject}) first.
12064
12065 The indirection arguments (@code{1-} and so on) will make their
12066 arguments work on previous generations of the thread.  If you say
12067 something like:
12068
12069 @example
12070 ...
12071 (1-
12072  (1-
12073   ("from" "lars")))
12074 ...
12075 @end example
12076
12077 Then that means "score on the from header of the grandparent of the
12078 current article".  An indirection is quite fast, but it's better to say:
12079
12080 @example
12081 (1-
12082  (& 
12083   ("from" "Lars")
12084   ("subject" "Gnus")))
12085 @end example
12086
12087 than it is to say:
12088
12089 @example
12090 (&
12091  (1- ("from" "Lars"))
12092  (1- ("subject" "Gnus")))
12093 @end example
12094
12095
12096 @node Score Decays
12097 @section Score Decays
12098 @cindex score decays
12099 @cindex decays
12100
12101 You may find that your scores have a tendency to grow without
12102 bounds, especially if you're using adaptive scoring.  If scores get too
12103 big, they lose all meaning---they simply max out and it's difficult to
12104 use them in any sensible way.
12105
12106 @vindex gnus-decay-scores
12107 @findex gnus-decay-score
12108 @vindex gnus-score-decay-function
12109 Gnus provides a mechanism for decaying scores to help with this problem.
12110 When score files are loaded and @code{gnus-decay-scores} is
12111 non-@code{nil}, Gnus will run the score files through the decaying
12112 mechanism thereby lowering the scores of all non-permanent score rules.
12113 The decay itself if performed by the @code{gnus-score-decay-function}
12114 function, which is @code{gnus-decay-score} by default.  Here's the
12115 definition of that function:
12116
12117 @lisp
12118 (defun gnus-decay-score (score)
12119   (floor
12120    (- score
12121       (* (if (< score 0) 1 -1)
12122          (min score
12123               (max gnus-score-decay-constant
12124                    (* (abs score)
12125                       gnus-score-decay-scale)))))))
12126 @end lisp
12127
12128 @vindex gnus-score-decay-scale
12129 @vindex gnus-score-decay-constant
12130 @code{gnus-score-decay-constant} is 3 by default and
12131 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
12132
12133 @enumerate
12134 @item
12135 Scores between -3 and 3 will be set to 0 when this function is called.
12136
12137 @item
12138 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12139
12140 @item
12141 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12142 score.
12143 @end enumerate
12144
12145 If you don't like this decay function, write your own.  It is called
12146 with the score to be decayed as its only parameter, and it should return
12147 the new score, which should be an integer.
12148
12149 Gnus will try to decay scores once a day.  If you haven't run Gnus for
12150 four days, Gnus will decay the scores four times, for instance.
12151
12152
12153 @node Various
12154 @chapter Various
12155
12156 @menu
12157 * Process/Prefix::             A convention used by many treatment commands.
12158 * Interactive::                Making Gnus ask you many questions.
12159 * Formatting Variables::       You can specify what buffers should look like.
12160 * Windows Configuration::      Configuring the Gnus buffer windows.
12161 * Compilation::                How to speed Gnus up.
12162 * Mode Lines::                 Displaying information in the mode lines.
12163 * Highlighting and Menus::     Making buffers look all nice and cozy.
12164 * Buttons::                    Get tendonitis in ten easy steps!
12165 * Daemons::                    Gnus can do things behind your back.
12166 * NoCeM::                      How to avoid spam and other fatty foods.
12167 * Picons::                     How to display pictures of what your reading.
12168 * Undo::                       Some actions can be undone.
12169 * Moderation::                 What to do if you're a moderator.
12170 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
12171 * Fuzzy Matching::             What's the big fuzz?
12172 * Various Various::            Things that are really various.
12173 @end menu
12174
12175
12176 @node Process/Prefix
12177 @section Process/Prefix
12178 @cindex process/prefix convention
12179
12180 Many functions, among them functions for moving, decoding and saving
12181 articles, use what is known as the @dfn{Process/Prefix convention}.
12182
12183 This is a method for figuring out what articles that the user wants the
12184 command to be performed on.
12185
12186 It goes like this:
12187
12188 If the numeric prefix is N, perform the operation on the next N
12189 articles, starting with the current one.  If the numeric prefix is
12190 negative, perform the operation on the previous N articles, starting
12191 with the current one.
12192
12193 @vindex transient-mark-mode
12194 If @code{transient-mark-mode} in non-@code{nil} and the region is
12195 active, all articles in the region will be worked upon.
12196
12197 If there is no numeric prefix, but some articles are marked with the
12198 process mark, perform the operation on the articles that are marked with
12199 the process mark.
12200
12201 If there is neither a numeric prefix nor any articles marked with the
12202 process mark, just perform the operation on the current article.
12203
12204 Quite simple, really, but it needs to be made clear so that surprises
12205 are avoided.
12206
12207 Commands that react to the process mark will push the current list of
12208 process marked articles onto a stack and will then clear all process
12209 marked articles.  You can restore the previous configuration with the
12210 @kbd{M P y} command (@pxref{Setting Process Marks}).
12211
12212 @vindex gnus-summary-goto-unread
12213 One thing that seems to shock & horrify lots of people is that, for
12214 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12215 Since each @kbd{d} (which marks the current article as read) by default
12216 goes to the next unread article after marking, this means that @kbd{3 d}
12217 will mark the next three unread articles as read, no matter what the
12218 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
12219 @code{nil} for a more straightforward action.
12220
12221
12222 @node Interactive
12223 @section Interactive
12224 @cindex interaction
12225
12226 @table @code
12227
12228 @item gnus-novice-user
12229 @vindex gnus-novice-user
12230 If this variable is non-@code{nil}, you are either a newcomer to the
12231 World of Usenet, or you are very cautious, which is a nice thing to be,
12232 really.  You will be given questions of the type ``Are you sure you want
12233 to do this?'' before doing anything dangerous.  This is @code{t} by
12234 default.
12235
12236 @item gnus-expert-user
12237 @vindex gnus-expert-user
12238 If this variable is non-@code{nil}, you will never ever be asked any
12239 questions by Gnus.  It will simply assume you know what you're doing, no
12240 matter how strange.
12241
12242 @item gnus-interactive-catchup
12243 @vindex gnus-interactive-catchup
12244 Require confirmation before catching up a group if non-@code{nil}.  It
12245 is @code{t} by default.
12246
12247 @item gnus-interactive-exit
12248 @vindex gnus-interactive-exit
12249 Require confirmation before exiting Gnus.  This variable is @code{t} by
12250 default. 
12251 @end table
12252
12253
12254 @node Formatting Variables
12255 @section Formatting Variables
12256 @cindex formatting variables
12257
12258 Throughout this manual you've probably noticed lots of variables that
12259 are called things like @code{gnus-group-line-format} and
12260 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
12261 output lines in the various buffers.  There's quite a lot of them.
12262 Fortunately, they all use the same syntax, so there's not that much to
12263 be annoyed by.
12264
12265 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12266 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
12267 lots of percentages everywhere.  
12268
12269 @menu 
12270 * Formatting Basics::     A formatting variable is basically a format string.
12271 * Advanced Formatting::   Modifying output in various ways.
12272 * User-Defined Specs::    Having Gnus call your own functions.
12273 * Formatting Fonts::      Making the formatting look colorful and nice.
12274 @end menu
12275
12276 Currently Gnus uses the following formatting variables:
12277 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12278 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12279 @code{gnus-group-mode-line-format},
12280 @code{gnus-summary-mode-line-format},
12281 @code{gnus-article-mode-line-format},
12282 @code{gnus-server-mode-line-format}, and
12283 @code{gnus-summary-pick-line-format}.
12284
12285 All these format variables can also be arbitrary elisp forms.  In that
12286 case, they will be @code{eval}ed to insert the required lines.
12287
12288 @kindex M-x gnus-update-format
12289 @findex gnus-update-format
12290 Gnus includes a command to help you while creating your own format
12291 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
12292 update the spec in question and pop you to a buffer where you can
12293 examine the resulting lisp code to be run to generate the line.  
12294
12295
12296
12297 @node Formatting Basics
12298 @subsection Formatting Basics
12299
12300 Each @samp{%} element will be replaced by some string or other when the
12301 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
12302 spec, and pad with spaces to get a 5-character field''.
12303
12304 As with normal C and Emacs Lisp formatting strings, the numerical
12305 modifier between the @samp{%} and the formatting type character will
12306 @dfn{pad} the output so that it is always at least that long.
12307 @samp{%5y} will make the field always (at least) five characters wide by
12308 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
12309 the right instead.
12310
12311 You may also wish to limit the length of the field to protect against
12312 particularly wide values.  For that you can say @samp{%4,6y}, which
12313 means that the field will never be more than 6 characters wide and never
12314 less than 4 characters wide.
12315
12316
12317 @node Advanced Formatting
12318 @subsection Advanced Formatting
12319
12320 It is frequently useful to post-process the fields in some way.
12321 Padding, limiting, cutting off parts and suppressing certain values can
12322 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
12323 look like @samp{%~(cut 3)~(ignore "0")y}.
12324
12325 These are the legal modifiers:
12326
12327 @table @code
12328 @item pad
12329 @itemx pad-left
12330 Pad the field to the left with spaces until it reaches the required
12331 length.
12332
12333 @item pad-right
12334 Pad the field to the right with spaces until it reaches the required
12335 length.
12336
12337 @item max
12338 @itemx max-left
12339 Cut off characters from the left until it reaches the specified length.
12340
12341 @item max-right
12342 Cut off characters from the right until it reaches the specified
12343 length. 
12344
12345 @item cut
12346 @itemx cut-left
12347 Cut off the specified number of characters from the left.
12348
12349 @item cut-right
12350 Cut off the specified number of characters from the right.
12351
12352 @item ignore
12353 Return an empty string if the field is equal to the specified value. 
12354
12355 @item form
12356 Use the specified form as the field value when the @samp{@@} spec is
12357 used. 
12358 @end table
12359
12360 Let's take an example.  The @samp{%o} spec in the summary mode lines
12361 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12362 This is quite a mouthful, so we want to shave off the century number and
12363 the time, leaving us with a six-character date.  That would be
12364 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
12365 maxing, and we need the padding to ensure that the date is never less
12366 than 6 characters to make it look nice in columns.)
12367
12368 Ignoring is done first; then cutting; then maxing; and then as the very
12369 last operation, padding.  
12370
12371 If you use lots of these advanced thingies, you'll find that Gnus gets
12372 quite slow.  This can be helped enormously by running @kbd{M-x
12373 gnus-compile} when you are satisfied with the look of your lines.
12374 @xref{Compilation}. 
12375
12376
12377 @node User-Defined Specs
12378 @subsection User-Defined Specs
12379
12380 All the specs allow for inserting user defined specifiers---@samp{u}.
12381 The next character in the format string should be a letter.  Gnus
12382 will call the function @code{gnus-user-format-function-}@samp{X}, where
12383 @samp{X} is the letter following @samp{%u}.  The function will be passed
12384 a single parameter---what the parameter means depends on what buffer
12385 it's being called from.  The function should return a string, which will
12386 be inserted into the buffer just like information from any other
12387 specifier.  This function may also be called with dummy values, so it
12388 should protect against that.
12389
12390 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12391 much the same without defining new functions.  Here's an example:
12392 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
12393 given here will be evaluated to yield the current line number, and then
12394 inserted.
12395
12396
12397 @node Formatting Fonts
12398 @subsection Formatting Fonts
12399
12400 There are specs for highlighting, and these are shared by all the format
12401 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
12402 the special @code{mouse-face} property set, which means that it will be
12403 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12404 over it.
12405
12406 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12407 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12408 default.  If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12409 instead, and so on.  Create as many faces as you wish.  The same goes
12410 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12411 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12412
12413 Here's an alternative recipe for the group buffer:
12414
12415 @lisp
12416 ;; Create three face types.
12417 (setq gnus-face-1 'bold)
12418 (setq gnus-face-3 'italic)
12419
12420 ;; We want the article count to be in 
12421 ;; a bold and green face.  So we create 
12422 ;; a new face called `my-green-bold'.
12423 (copy-face 'bold 'my-green-bold)
12424 ;; Set the color.
12425 (set-face-foreground 'my-green-bold "ForestGreen")
12426 (setq gnus-face-2 'my-green-bold)
12427
12428 ;; Set the new & fancy format.
12429 (setq gnus-group-line-format 
12430       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12431 @end lisp
12432
12433 I'm sure you'll be able to use this scheme to create totally unreadable
12434 and extremely vulgar displays.  Have fun!
12435
12436 Note that the @samp{%(} specs (and friends) do not make any sense on the
12437 mode-line variables.
12438
12439
12440 @node Windows Configuration
12441 @section Windows Configuration
12442 @cindex windows configuration
12443
12444 No, there's nothing here about X, so be quiet.
12445
12446 @vindex gnus-use-full-window
12447 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12448 other windows and occupy the entire Emacs screen by itself.  It is
12449 @code{t} by default.
12450
12451 @vindex gnus-buffer-configuration
12452 @code{gnus-buffer-configuration} describes how much space each Gnus
12453 buffer should be given.  Here's an excerpt of this variable:
12454
12455 @lisp
12456 ((group (vertical 1.0 (group 1.0 point)
12457                       (if gnus-carpal (group-carpal 4))))
12458  (article (vertical 1.0 (summary 0.25 point) 
12459                         (article 1.0))))
12460 @end lisp
12461
12462 This is an alist.  The @dfn{key} is a symbol that names some action or
12463 other.  For instance, when displaying the group buffer, the window
12464 configuration function will use @code{group} as the key.  A full list of
12465 possible names is listed below.
12466
12467 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12468 should occupy.  To take the @code{article} split as an example -
12469
12470 @lisp
12471 (article (vertical 1.0 (summary 0.25 point)
12472                        (article 1.0)))
12473 @end lisp
12474
12475 This @dfn{split} says that the summary buffer should occupy 25% of upper
12476 half of the screen, and that it is placed over the article buffer.  As
12477 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12478 reaching for that calculator there).  However, the special number
12479 @code{1.0} is used to signal that this buffer should soak up all the
12480 rest of the space available after the rest of the buffers have taken
12481 whatever they need.  There should be only one buffer with the @code{1.0}
12482 size spec per split.
12483
12484 Point will be put in the buffer that has the optional third element
12485 @code{point}. 
12486
12487 Here's a more complicated example:
12488
12489 @lisp
12490 (article (vertical 1.0 (group 4)
12491                        (summary 0.25 point)
12492                        (if gnus-carpal (summary-carpal 4))
12493                        (article 1.0)))
12494 @end lisp
12495
12496 If the size spec is an integer instead of a floating point number, 
12497 then that number will be used to say how many lines a buffer should
12498 occupy, not a percentage.
12499
12500 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12501 precise---if the @code{car} of the split is a function or a subr), this
12502 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
12503 be used as a split.  This means that there will be three buffers if
12504 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12505 is non-@code{nil}.
12506
12507 Not complicated enough for you?  Well, try this on for size:
12508
12509 @lisp
12510 (article (horizontal 1.0 
12511              (vertical 0.5
12512                  (group 1.0)
12513                  (gnus-carpal 4))
12514              (vertical 1.0
12515                  (summary 0.25 point)
12516                  (summary-carpal 4)
12517                  (article 1.0))))
12518 @end lisp
12519
12520 Whoops.  Two buffers with the mystery 100% tag.  And what's that
12521 @code{horizontal} thingie?  
12522
12523 If the first element in one of the split is @code{horizontal}, Gnus will
12524 split the window horizontally, giving you two windows side-by-side.
12525 Inside each of these strips you may carry on all you like in the normal
12526 fashion.  The number following @code{horizontal} says what percentage of
12527 the screen is to be given to this strip.
12528
12529 For each split, there @emph{must} be one element that has the 100% tag.
12530 The splitting is never accurate, and this buffer will eat any leftover
12531 lines from the splits.
12532
12533 To be slightly more formal, here's a definition of what a legal split
12534 may look like:
12535
12536 @example
12537 split       = frame | horizontal | vertical | buffer | form
12538 frame       = "(frame " size *split ")"
12539 horizontal  = "(horizontal " size *split ")"
12540 vertical    = "(vertical " size *split ")"
12541 buffer      = "(" buffer-name " " size *[ "point" ] ")"
12542 size        = number | frame-params
12543 buffer-name = group | article | summary ...
12544 @end example
12545
12546 The limitations are that the @code{frame} split can only appear as the
12547 top-level split.  @var{form} should be an Emacs Lisp form that should
12548 return a valid split.  We see that each split is fully recursive, and
12549 may contain any number of @code{vertical} and @code{horizontal} splits. 
12550
12551 @vindex gnus-window-min-width
12552 @vindex gnus-window-min-height
12553 @cindex window height
12554 @cindex window width
12555 Finding the right sizes can be a bit complicated.  No window may be less
12556 than @code{gnus-window-min-height} (default 1) characters high, and all
12557 windows must be at least @code{gnus-window-min-width} (default 1)
12558 characters wide.  Gnus will try to enforce this before applying the
12559 splits.  If you want to use the normal Emacs window width/height limit,
12560 you can just set these two variables to @code{nil}.
12561
12562 If you're not familiar with Emacs terminology, @code{horizontal} and
12563 @code{vertical} splits may work the opposite way of what you'd expect.
12564 Windows inside a @code{horizontal} split are shown side-by-side, and
12565 windows within a @code{vertical} split are shown above each other.
12566
12567 @findex gnus-configure-frame
12568 If you want to experiment with window placement, a good tip is to call
12569 @code{gnus-configure-frame} directly with a split.  This is the function
12570 that does all the real work when splitting buffers.  Below is a pretty
12571 nonsensical configuration with 5 windows; two for the group buffer and
12572 three for the article buffer.  (I said it was nonsensical.)  If you
12573 @code{eval} the statement below, you can get an idea of how that would
12574 look straight away, without going through the normal Gnus channels.
12575 Play with it until you're satisfied, and then use
12576 @code{gnus-add-configuration} to add your new creation to the buffer
12577 configuration list. 
12578
12579 @lisp
12580 (gnus-configure-frame
12581  '(horizontal 1.0
12582     (vertical 10
12583       (group 1.0)
12584       (article 0.3 point))
12585     (vertical 1.0
12586       (article 1.0)
12587       (horizontal 4
12588         (group 1.0)
12589         (article 10)))))
12590 @end lisp
12591
12592 You might want to have several frames as well.  No prob---just use the
12593 @code{frame} split:
12594
12595 @lisp
12596 (gnus-configure-frame
12597  '(frame 1.0
12598          (vertical 1.0
12599                    (summary 0.25 point)
12600                    (article 1.0))
12601          (vertical ((height . 5) (width . 15)
12602                     (user-position . t)
12603                     (left . -1) (top . 1))
12604                    (picon 1.0))))
12605
12606 @end lisp
12607
12608 This split will result in the familiar summary/article window
12609 configuration in the first (or ``main'') frame, while a small additional
12610 frame will be created where picons will be shown.  As you can see,
12611 instead of the normal @code{1.0} top-level spec, each additional split
12612 should have a frame parameter alist as the size spec.
12613 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12614 Reference Manual}.
12615
12616 Here's a list of all possible keys for
12617 @code{gnus-buffer-configuration}:
12618
12619 @code{group}, @code{summary}, @code{article}, @code{server},
12620 @code{browse}, @code{message}, @code{pick}, @code{info},
12621 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12622 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12623 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
12624 @code{bug}, @code{compose-bounce}.
12625
12626 Note that the @code{message} key is used for both
12627 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
12628 it is desirable to distinguish between the two, something like this
12629 might be used:
12630
12631 @lisp
12632 (message (horizontal 1.0
12633                      (vertical 1.0 (message 1.0 point))
12634                      (vertical 0.24
12635                                (if (buffer-live-p gnus-summary-buffer)
12636                                    '(summary 0.5))
12637                                (group 1.0)))))
12638 @end lisp
12639
12640 @findex gnus-add-configuration
12641 Since the @code{gnus-buffer-configuration} variable is so long and
12642 complicated, there's a function you can use to ease changing the config
12643 of a single setting: @code{gnus-add-configuration}.  If, for instance,
12644 you want to change the @code{article} setting, you could say:
12645
12646 @lisp
12647 (gnus-add-configuration
12648  '(article (vertical 1.0
12649                (group 4)
12650                (summary .25 point)
12651                (article 1.0))))
12652 @end lisp
12653
12654 You'd typically stick these @code{gnus-add-configuration} calls in your
12655 @file{.gnus.el} file or in some startup hook---they should be run after
12656 Gnus has been loaded.
12657
12658 @vindex gnus-always-force-window-configuration
12659 If all windows mentioned in the configuration are already visible, Gnus
12660 won't change the window configuration.  If you always want to force the
12661 ``right'' window configuration, you can set
12662 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12663
12664
12665 @node Compilation
12666 @section Compilation
12667 @cindex compilation
12668 @cindex byte-compilation
12669
12670 @findex gnus-compile
12671
12672 Remember all those line format specification variables?
12673 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12674 on.  Now, Gnus will of course heed whatever these variables are, but,
12675 unfortunately, changing them will mean a quite significant slow-down.
12676 (The default values of these variables have byte-compiled functions
12677 associated with them, while the user-generated versions do not, of
12678 course.) 
12679
12680 To help with this, you can run @kbd{M-x gnus-compile} after you've
12681 fiddled around with the variables and feel that you're (kind of)
12682 satisfied.  This will result in the new specs being byte-compiled, and
12683 you'll get top speed again.  Gnus will save these compiled specs in the
12684 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
12685 this function, though---you should compile them yourself by sticking
12686 them into the @code{.gnus.el} file and byte-compiling that file.)
12687
12688
12689 @node Mode Lines
12690 @section Mode Lines
12691 @cindex mode lines
12692
12693 @vindex gnus-updated-mode-lines
12694 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12695 lines updated.  It is a list of symbols.  Supported symbols include
12696 @code{group}, @code{article}, @code{summary}, @code{server},
12697 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
12698 Gnus will keep that mode line updated with information that may be
12699 pertinent.  If this variable is @code{nil}, screen refresh may be
12700 quicker.
12701
12702 @cindex display-time
12703
12704 @vindex gnus-mode-non-string-length
12705 By default, Gnus displays information on the current article in the mode
12706 lines of the summary and article buffers.  The information Gnus wishes
12707 to display (e.g. the subject of the article) is often longer than the
12708 mode lines, and therefore have to be cut off at some point.  The
12709 @code{gnus-mode-non-string-length} variable says how long the other
12710 elements on the line is (i.e., the non-info part).  If you put
12711 additional elements on the mode line (e.g. a clock), you should modify
12712 this variable:
12713
12714 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12715 @lisp
12716 (add-hook 'display-time-hook
12717           (lambda () (setq gnus-mode-non-string-length
12718                            (+ 21
12719                               (if line-number-mode 5 0)
12720                               (if column-number-mode 4 0)
12721                               (length display-time-string)))))
12722 @end lisp
12723
12724 If this variable is @code{nil} (which is the default), the mode line
12725 strings won't be chopped off, and they won't be padded either.
12726 Note that the default is unlikely to be desirable, as even the
12727 percentage complete in the buffer may be crowded off the mode line;
12728 the user should configure this variable appropriately for their
12729 configuration.
12730
12731
12732 @node Highlighting and Menus
12733 @section Highlighting and Menus
12734 @cindex visual
12735 @cindex highlighting
12736 @cindex menus
12737
12738 @vindex gnus-visual
12739 The @code{gnus-visual} variable controls most of the prettifying Gnus
12740 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
12741 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
12742 file.
12743
12744 This variable can be a list of visual properties that are enabled.  The
12745 following elements are legal, and are all included by default:
12746
12747 @table @code
12748 @item group-highlight
12749 Do highlights in the group buffer.
12750 @item summary-highlight
12751 Do highlights in the summary buffer.
12752 @item article-highlight
12753 Do highlights in the article buffer.
12754 @item highlight
12755 Turn on highlighting in all buffers.
12756 @item group-menu
12757 Create menus in the group buffer.
12758 @item summary-menu
12759 Create menus in the summary buffers.
12760 @item article-menu
12761 Create menus in the article buffer.
12762 @item browse-menu
12763 Create menus in the browse buffer.
12764 @item server-menu
12765 Create menus in the server buffer.
12766 @item score-menu
12767 Create menus in the score buffers.
12768 @item menu
12769 Create menus in all buffers.
12770 @end table
12771
12772 So if you only want highlighting in the article buffer and menus in all
12773 buffers, you could say something like:
12774
12775 @lisp
12776 (setq gnus-visual '(article-highlight menu))
12777 @end lisp
12778
12779 If you want only highlighting and no menus whatsoever, you'd say:
12780
12781 @lisp
12782 (setq gnus-visual '(highlight))
12783 @end lisp
12784
12785 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12786 in all Gnus buffers.
12787
12788 Other general variables that influence the look of all buffers include:
12789
12790 @table @code
12791 @item gnus-mouse-face
12792 @vindex gnus-mouse-face
12793 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
12794 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12795
12796 @end table
12797
12798 There are hooks associated with the creation of all the different menus:
12799
12800 @table @code
12801
12802 @item gnus-article-menu-hook
12803 @vindex gnus-article-menu-hook
12804 Hook called after creating the article mode menu.
12805
12806 @item gnus-group-menu-hook
12807 @vindex gnus-group-menu-hook
12808 Hook called after creating the group mode menu.
12809
12810 @item gnus-summary-menu-hook
12811 @vindex gnus-summary-menu-hook
12812 Hook called after creating the summary mode menu.
12813
12814 @item gnus-server-menu-hook
12815 @vindex gnus-server-menu-hook
12816 Hook called after creating the server mode menu.
12817
12818 @item gnus-browse-menu-hook
12819 @vindex gnus-browse-menu-hook
12820 Hook called after creating the browse mode menu.
12821
12822 @item gnus-score-menu-hook
12823 @vindex gnus-score-menu-hook
12824 Hook called after creating the score mode menu.
12825
12826 @end table
12827
12828
12829 @node Buttons
12830 @section Buttons
12831 @cindex buttons
12832 @cindex mouse
12833 @cindex click
12834
12835 Those new-fangled @dfn{mouse} contraptions is very popular with the
12836 young, hep kids who don't want to learn the proper way to do things
12837 these days.  Why, I remember way back in the summer of '89, when I was
12838 using Emacs on a Tops 20 system.  Three hundred users on one single
12839 machine, and every user was running Simula compilers.  Bah!
12840
12841 Right.
12842
12843 @vindex gnus-carpal
12844 Well, you can make Gnus display bufferfuls of buttons you can click to
12845 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
12846 really.  Tell the chiropractor I sent you.
12847
12848
12849 @table @code
12850
12851 @item gnus-carpal-mode-hook
12852 @vindex gnus-carpal-mode-hook
12853 Hook run in all carpal mode buffers.
12854
12855 @item gnus-carpal-button-face
12856 @vindex gnus-carpal-button-face
12857 Face used on buttons.
12858
12859 @item gnus-carpal-header-face
12860 @vindex gnus-carpal-header-face
12861 Face used on carpal buffer headers.
12862
12863 @item gnus-carpal-group-buffer-buttons
12864 @vindex gnus-carpal-group-buffer-buttons
12865 Buttons in the group buffer.
12866
12867 @item gnus-carpal-summary-buffer-buttons
12868 @vindex gnus-carpal-summary-buffer-buttons
12869 Buttons in the summary buffer.
12870
12871 @item gnus-carpal-server-buffer-buttons
12872 @vindex gnus-carpal-server-buffer-buttons
12873 Buttons in the server buffer.
12874
12875 @item gnus-carpal-browse-buffer-buttons
12876 @vindex gnus-carpal-browse-buffer-buttons
12877 Buttons in the browse buffer.
12878 @end table
12879
12880 All the @code{buttons} variables are lists.  The elements in these list
12881 is either a cons cell where the car contains a text to be displayed and
12882 the cdr contains a function symbol, or a simple string.
12883
12884
12885 @node Daemons
12886 @section Daemons
12887 @cindex demons
12888 @cindex daemons
12889
12890 Gnus, being larger than any program ever written (allegedly), does lots
12891 of strange stuff that you may wish to have done while you're not
12892 present.  For instance, you may want it to check for new mail once in a
12893 while.  Or you may want it to close down all connections to all servers
12894 when you leave Emacs idle.  And stuff like that.
12895
12896 Gnus will let you do stuff like that by defining various
12897 @dfn{handlers}.  Each handler consists of three elements:  A
12898 @var{function}, a @var{time}, and an @var{idle} parameter.
12899
12900 Here's an example of a handler that closes connections when Emacs has
12901 been idle for thirty minutes:
12902
12903 @lisp
12904 (gnus-demon-close-connections nil 30)
12905 @end lisp
12906
12907 Here's a handler that scans for PGP headers every hour when Emacs is
12908 idle: 
12909
12910 @lisp
12911 (gnus-demon-scan-pgp 60 t)
12912 @end lisp
12913
12914 This @var{time} parameter and than @var{idle} parameter works together
12915 in a strange, but wonderful fashion.  Basically, if @var{idle} is
12916 @code{nil}, then the function will be called every @var{time} minutes.
12917
12918 If @var{idle} is @code{t}, then the function will be called after
12919 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
12920 the function will never be called.  But once Emacs goes idle, the
12921 function will be called every @var{time} minutes.
12922
12923 If @var{idle} is a number and @var{time} is a number, the function will
12924 be called every @var{time} minutes only when Emacs has been idle for
12925 @var{idle} minutes.
12926
12927 If @var{idle} is a number and @var{time} is @code{nil}, the function
12928 will be called once every time Emacs has been idle for @var{idle}
12929 minutes.  
12930
12931 And if @var{time} is a string, it should look like @samp{07:31}, and
12932 the function will then be called once every day somewhere near that
12933 time.  Modified by the @var{idle} parameter, of course.
12934
12935 @vindex gnus-demon-timestep
12936 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12937 seconds.  This is 60 by default.  If you change that variable,
12938 all the timings in the handlers will be affected.)
12939
12940 @vindex gnus-use-demon
12941 To set the whole thing in motion, though, you have to set
12942 @code{gnus-use-demon} to @code{t}.
12943
12944 So, if you want to add a handler, you could put something like this in
12945 your @file{.gnus} file:
12946
12947 @findex gnus-demon-add-handler
12948 @lisp
12949 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12950 @end lisp
12951
12952 @findex gnus-demon-add-nocem
12953 @findex gnus-demon-add-scanmail
12954 @findex gnus-demon-add-rescan
12955 @findex gnus-demon-add-disconnection
12956 Some ready-made functions to do this has been created:
12957 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12958 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}.  Just
12959 put those functions in your @file{.gnus} if you want those abilities.
12960
12961 @findex gnus-demon-init
12962 @findex gnus-demon-cancel
12963 @vindex gnus-demon-handlers
12964 If you add handlers to @code{gnus-demon-handlers} directly, you should
12965 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
12966 daemons, you can use the @code{gnus-demon-cancel} function.
12967
12968 Note that adding daemons can be pretty naughty if you overdo it.  Adding
12969 functions that scan all news and mail from all servers every two seconds
12970 is a sure-fire way of getting booted off any respectable system.  So
12971 behave. 
12972
12973
12974 @node NoCeM
12975 @section NoCeM
12976 @cindex nocem
12977 @cindex spam
12978
12979 @dfn{Spamming} is posting the same article lots and lots of times.
12980 Spamming is bad.  Spamming is evil.  
12981
12982 Spamming is usually canceled within a day or so by various anti-spamming
12983 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
12984 NoCeM is pronounced ``no see-'em'', and means what the name
12985 implies---these are messages that make the offending articles, like, go
12986 away.  
12987
12988 What use are these NoCeM messages if the articles are canceled anyway?
12989 Some sites do not honor cancel messages and some sites just honor cancels
12990 from a select few people.  Then you may wish to make use of the NoCeM
12991 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12992
12993 Gnus can read and parse the messages in this group automatically, and
12994 this will make spam disappear.  
12995
12996 There are some variables to customize, of course:
12997
12998 @table @code
12999 @item gnus-use-nocem
13000 @vindex gnus-use-nocem
13001 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
13002 by default. 
13003
13004 @item gnus-nocem-groups
13005 @vindex gnus-nocem-groups
13006 Gnus will look for NoCeM messages in the groups in this list.  The
13007 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
13008 "alt.nocem.misc" "news.admin.net-abuse.announce")}. 
13009
13010 @item gnus-nocem-issuers
13011 @vindex gnus-nocem-issuers
13012 There are many people issuing NoCeM messages.  This list says what
13013 people you want to listen to.  The default is @code{("Automoose-1"
13014 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
13015 (Richard E. Depew)")}; fine, upstanding citizens all of them.
13016
13017 Known despammers that you can put in this list include:
13018
13019 @table @samp
13020 @item clewis@@ferret.ocunix.on.ca;
13021 @cindex Chris Lewis
13022 Chris Lewis---Major Canadian despammer who has probably canceled more
13023 usenet abuse than anybody else.
13024
13025 @item Automoose-1
13026 @cindex CancelMoose[tm]
13027 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
13028 Norwegian, and was the person(s) who invented NoCeM.  
13029
13030 @item jem@@xpat.com;
13031 @cindex Jem
13032 John Milburn---despammer located in Korea who is getting very busy these
13033 days.
13034
13035 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
13036 Richard E. Depew---lone American despammer.  He mostly cancels binary
13037 postings to non-binary groups and removes spews (regurgitated articles).
13038 @end table
13039
13040 You do not have to heed NoCeM messages from all these people---just the
13041 ones you want to listen to.
13042
13043 @item gnus-nocem-verifyer
13044 @vindex gnus-nocem-verifyer
13045 @findex mc-verify
13046 This should be a function for verifying that the NoCeM issuer is who she
13047 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
13048 function.  If this is too slow and you don't care for verification
13049 (which may be dangerous), you can set this variable to @code{nil}.
13050
13051 @item gnus-nocem-directory
13052 @vindex gnus-nocem-directory
13053 This is where Gnus will store its NoCeM cache files.  The default is
13054 @file{~/News/NoCeM/}. 
13055
13056 @item gnus-nocem-expiry-wait
13057 @vindex gnus-nocem-expiry-wait
13058 The number of days before removing old NoCeM entries from the cache.
13059 The default is 15.  If you make it shorter Gnus will be faster, but you
13060 might then see old spam.
13061
13062 @end table
13063
13064
13065 @node Picons
13066 @section Picons
13067
13068 So...  You want to slow down your news reader even more!  This is a
13069 good way to do so.  Its also a great way to impress people staring
13070 over your shoulder as you read news.
13071
13072 @menu
13073 * Picon Basics::           What are picons and How do I get them.
13074 * Picon Requirements::     Don't go further if you aren't using XEmacs.
13075 * Easy Picons::            Displaying Picons---the easy way.
13076 * Hard Picons::            The way you should do it.  You'll learn something.
13077 * Picon Configuration::    Other variables you can trash/tweak/munge/play with.
13078 @end menu
13079
13080
13081 @node Picon Basics
13082 @subsection Picon Basics
13083
13084 What are Picons?  To quote directly from the Picons Web site:
13085
13086 @quotation 
13087 @dfn{Picons} is short for ``personal icons''.  They're small,
13088 constrained images used to represent users and domains on the net,
13089 organized into databases so that the appropriate image for a given
13090 e-mail address can be found.  Besides users and domains, there are picon
13091 databases for Usenet newsgroups and weather forecasts.  The picons are
13092 in either monochrome @code{XBM} format or color @code{XPM} and
13093 @code{GIF} formats.
13094 @end quotation
13095
13096 For instructions on obtaining and installing the picons databases, point
13097 your Web browser at
13098 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13099
13100 @vindex gnus-picons-database
13101 Gnus expects picons to be installed into a location pointed to by
13102 @code{gnus-picons-database}.
13103
13104
13105 @node Picon Requirements
13106 @subsection Picon Requirements
13107
13108 To use have Gnus display Picons for you, you must be running XEmacs
13109 19.13 or greater since all other versions of Emacs aren't yet able to
13110 display images.
13111
13112 Additionally, you must have @code{xpm} support compiled into XEmacs.
13113
13114 @vindex gnus-picons-convert-x-face
13115 If you want to display faces from @code{X-Face} headers, you must have
13116 the @code{netpbm} utilities installed, or munge the
13117 @code{gnus-picons-convert-x-face} variable to use something else.
13118
13119
13120 @node Easy Picons
13121 @subsection Easy Picons
13122
13123 To enable displaying picons, simply put the following line in your
13124 @file{~/.gnus} file and start Gnus.
13125
13126 @lisp
13127 (setq gnus-use-picons t)
13128 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13129 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13130 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13131 @end lisp
13132
13133
13134 @node Hard Picons
13135 @subsection Hard Picons 
13136
13137 Gnus can display picons for you as you enter and leave groups and
13138 articles.  It knows how to interact with three sections of the picons
13139 database.  Namely, it can display the picons newsgroup pictures,
13140 author's face picture(s), and the authors domain.  To enable this
13141 feature, you need to first decide where to display them.
13142
13143 @table @code 
13144
13145 @item gnus-picons-display-where 
13146 @vindex gnus-picons-display-where 
13147 Where the picon images should be displayed.  It is @code{picons} by
13148 default (which by default maps to the buffer @samp{*Picons*}).  Other
13149 valid places could be @code{article}, @code{summary}, or
13150 @samp{*scratch*} for all I care.  Just make sure that you've made the
13151 buffer visible using the standard Gnus window configuration
13152 routines---@pxref{Windows Configuration}.
13153
13154 @end table
13155
13156 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13157 window configuration for you to include the @code{picons} buffer.
13158
13159 Now that you've made that decision, you need to add the following
13160 functions to the appropriate hooks so these pictures will get
13161 displayed at the right time.
13162
13163 @vindex gnus-article-display-hook
13164 @vindex gnus-picons-display-where
13165 @table @code
13166 @item gnus-article-display-picons
13167 @findex gnus-article-display-picons
13168 Looks up and display the picons for the author and the author's domain
13169 in the @code{gnus-picons-display-where} buffer.  Should be added to
13170 the @code{gnus-article-display-hook}.
13171
13172 @item gnus-group-display-picons
13173 @findex gnus-article-display-picons
13174 Displays picons representing the current group.  This function should
13175 be added to the @code{gnus-summary-prepare-hook} or to the
13176 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13177 is set to @code{article}.
13178
13179 @item gnus-picons-article-display-x-face
13180 @findex gnus-article-display-picons
13181 Decodes and displays the X-Face header if present.  This function
13182 should be added to @code{gnus-article-display-hook}.
13183
13184 @end table
13185
13186 Note:  You must append them to the hook, so make sure to specify 't'
13187 to the append flag of @code{add-hook}:
13188
13189 @lisp
13190 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13191 @end lisp
13192
13193
13194 @node Picon Configuration
13195 @subsection Picon Configuration
13196
13197 The following variables offer further control over how things are
13198 done, where things are located, and other useless stuff you really
13199 don't need to worry about.
13200
13201 @table @code
13202 @item gnus-picons-database
13203 @vindex gnus-picons-database
13204 The location of the picons database.  Should point to a directory
13205 containing the @file{news}, @file{domains}, @file{users} (and so on)
13206 subdirectories.  Defaults to @file{/usr/local/faces}.
13207
13208 @item gnus-picons-news-directory
13209 @vindex gnus-picons-news-directory
13210 Sub-directory of the faces database containing the icons for
13211 newsgroups.
13212
13213 @item gnus-picons-user-directories
13214 @vindex gnus-picons-user-directories
13215 List of subdirectories to search in @code{gnus-picons-database} for user
13216 faces.  @code{("local" "users" "usenix" "misc/MISC")} is the default.
13217
13218 @item gnus-picons-domain-directories
13219 @vindex gnus-picons-domain-directories
13220 List of subdirectories to search in @code{gnus-picons-database} for
13221 domain name faces.  Defaults to @code{("domains")}.  Some people may
13222 want to add @samp{unknown} to this list.
13223
13224 @item gnus-picons-convert-x-face
13225 @vindex gnus-picons-convert-x-face
13226 The command to use to convert the @code{X-Face} header to an X bitmap
13227 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
13228 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13229 gnus-picons-x-face-file-name)}
13230
13231 @item gnus-picons-x-face-file-name
13232 @vindex gnus-picons-x-face-file-name
13233 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
13234 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13235
13236 @item gnus-picons-buffer
13237 @vindex gnus-picons-buffer
13238 The name of the buffer that @code{picons} points to.  Defaults to
13239 @samp{*Icon Buffer*}.
13240
13241 @end table
13242
13243
13244 @node Undo
13245 @section Undo
13246 @cindex undo
13247
13248 It is very useful to be able to undo actions one has done.  In normal
13249 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13250 In Gnus buffers, however, it isn't that simple.
13251
13252 The things Gnus displays in its buffer is of no value whatsoever to
13253 Gnus---it's all just data that is designed to look nice to the user.
13254 Killing a group in the group buffer with @kbd{C-k} makes the line
13255 disappear, but that's just a side-effect of the real action---the
13256 removal of the group in question from the internal Gnus structures.
13257 Undoing something like that can't be done by the normal Emacs
13258 @code{undo} function.
13259
13260 Gnus tries to remedy this somewhat by keeping track of what the user
13261 does and coming up with actions that would reverse the actions the user
13262 takes.  When the user then presses the @code{undo} key, Gnus will run
13263 the code to reverse the previous action, or the previous actions.
13264 However, not all actions are easily reversible, so Gnus currently offers
13265 a few key functions to be undoable.  These include killing groups,
13266 yanking groups, and changing the list of read articles of groups.
13267 That's it, really.  More functions may be added in the future, but each
13268 added function means an increase in data to be stored, so Gnus will
13269 never be totally undoable.
13270
13271 @findex gnus-undo-mode
13272 @vindex gnus-use-undo
13273 @findex gnus-undo
13274 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
13275 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13276 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
13277 command, which should feel kinda like the normal Emacs @code{undo}
13278 command. 
13279
13280
13281 @node Moderation
13282 @section Moderation
13283 @cindex moderation
13284
13285 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13286 It is not included in the standard Gnus package.  Write a mail to
13287 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13288 get a copy.
13289
13290 The moderation package is implemented as a minor mode for summary
13291 buffers.  Put
13292
13293 @lisp
13294 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13295 @end lisp
13296
13297 in your @file{.gnus.el} file.
13298
13299 If you are the moderation of @samp{rec.zoofle}, this is how it's
13300 supposed to work:
13301
13302 @enumerate
13303 @item 
13304 You split your incoming mail by matching on
13305 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13306 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13307
13308 @item
13309 You enter that group once in a while and post articles using the @kbd{e}
13310 (edit-and-post) or @kbd{s} (just send unedited) commands.
13311
13312 @item
13313 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13314 articles that weren't approved by you, you can cancel them with the
13315 @kbd{c} command.
13316 @end enumerate
13317
13318 To use moderation mode in these two groups, say:
13319
13320 @lisp
13321 (setq gnus-moderated-list
13322       "^nnml:rec.zoofle$\\|^rec.zoofle$")
13323 @end lisp
13324
13325
13326 @node XEmacs Enhancements
13327 @section XEmacs Enhancements
13328 @cindex XEmacs
13329
13330 XEmacs is able to display pictures and stuff, so Gnus has taken
13331 advantage of that.  Relevant variables include:
13332
13333 @table @code
13334 @item gnus-xmas-glyph-directory
13335 @vindex gnus-xmas-glyph-directory
13336 This is where Gnus will look for pictures.  Gnus will normally
13337 auto-detect this directory, but you may set it manually if you have an
13338 unusual directory structure.
13339
13340 @item gnus-xmas-logo-color-alist
13341 @vindex gnus-xmas-logo-color-alist
13342 This is an alist where the key is a type symbol and the values are the
13343 foreground and background color of the splash page glyph.
13344
13345 @item gnus-xmas-logo-color-style
13346 @vindex gnus-xmas-logo-color-style
13347 This is the key used to look up the color in the alist described above.
13348 Legal values include @code{flame}, @code{pine}, @code{moss},
13349 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13350 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13351
13352 @item gnus-use-toolbar
13353 @vindex gnus-use-toolbar
13354 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
13355 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13356 @code{right-toolbar}, or @code{left-toolbar}.
13357
13358 @item gnus-group-toolbar
13359 @vindex gnus-group-toolbar
13360 The toolbar in the group buffer.
13361
13362 @item gnus-summary-toolbar
13363 @vindex gnus-summary-toolbar
13364 The toolbar in the summary buffer.
13365
13366 @item gnus-summary-mail-toolbar
13367 @vindex gnus-summary-mail-toolbar
13368 The toolbar in the summary buffer of mail groups.
13369
13370 @item gnus-xmas-modeline-glyph
13371 @vindex gnus-xmas-modeline-glyph
13372 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
13373 default. 
13374
13375 @end table
13376
13377
13378 @node Fuzzy Matching
13379 @section Fuzzy Matching
13380 @cindex fuzzy matching
13381
13382 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
13383 things like scoring, thread gathering and thread comparison.  
13384
13385 As opposed to regular expression matching, fuzzy matching is very fuzzy.
13386 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
13387 means, and the implementation has changed over time.
13388
13389 Basically, it tries to remove all noise from lines before comparing.
13390 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
13391 out of the strings before comparing the results.  This often leads to
13392 adequate results---even when faced with strings generated by text
13393 manglers masquerading as newsreaders.
13394
13395
13396 @node Various Various
13397 @section Various Various
13398 @cindex mode lines
13399 @cindex highlights
13400
13401 @table @code
13402
13403 @item gnus-home-directory
13404 All Gnus path variables will be initialized from this variable, which
13405 defaults to @file{~/}.
13406
13407 @item gnus-directory
13408 @vindex gnus-directory
13409 Most Gnus storage path variables will be initialized from this variable,
13410 which defaults to the @samp{SAVEDIR} environment variable, or
13411 @file{~/News/} if that variable isn't set.
13412
13413 @item gnus-default-directory
13414 @vindex gnus-default-directory
13415 Not related to the above variable at all---this variable says what the
13416 default directory of all Gnus buffers should be.  If you issue commands
13417 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13418 default directory.  If this variable is @code{nil} (which is the
13419 default), the default directory will be the default directory of the
13420 buffer you were in when you started Gnus.
13421
13422 @item gnus-verbose
13423 @vindex gnus-verbose
13424 This variable is an integer between zero and ten.  The higher the value,
13425 the more messages will be displayed.  If this variable is zero, Gnus
13426 will never flash any messages, if it is seven (which is the default),
13427 most important messages will be shown, and if it is ten, Gnus won't ever
13428 shut up, but will flash so many messages it will make your head swim.
13429
13430 @item gnus-verbose-backends
13431 @vindex gnus-verbose-backends
13432 This variable works the same way as @code{gnus-verbose}, but it applies
13433 to the Gnus backends instead of Gnus proper.
13434
13435 @item nnheader-max-head-length
13436 @vindex nnheader-max-head-length
13437 When the backends read straight heads of articles, they all try to read
13438 as little as possible.  This variable (default 4096) specifies
13439 the absolute max length the backends will try to read before giving up
13440 on finding a separator line between the head and the body.  If this
13441 variable is @code{nil}, there is no upper read bound.  If it is
13442 @code{t}, the backends won't try to read the articles piece by piece,
13443 but read the entire articles.  This makes sense with some versions of
13444 @code{ange-ftp}. 
13445
13446 @item nnheader-head-chop-length
13447 @vindex nnheader-head-chop-length
13448 This variable says how big a piece of each article to read when doing
13449 the operation described above.
13450
13451 @item nnheader-file-name-translation-alist 
13452 @vindex nnheader-file-name-translation-alist 
13453 @cindex file names
13454 @cindex illegal characters in file names
13455 @cindex characters in file names
13456 This is an alist that says how to translate characters in file names.
13457 For instance, if @samp{:} is illegal as a file character in file names
13458 on your system (you OS/2 user you), you could say something like:
13459
13460 @lisp
13461 (setq nnheader-file-name-translation-alist 
13462       '((?: . ?_)))
13463 @end lisp
13464
13465 In fact, this is the default value for this variable on OS/2 and MS
13466 Windows (phooey) systems.
13467
13468 @item gnus-hidden-properties
13469 @vindex gnus-hidden-properties
13470 This is a list of properties to use to hide ``invisible'' text.  It is
13471 @code{(invisible t intangible t)} by default on most systems, which
13472 makes invisible text invisible and intangible.
13473
13474 @item gnus-parse-headers-hook
13475 @vindex gnus-parse-headers-hook
13476 A hook called before parsing headers.  It can be used, for instance, to
13477 gather statistics on the headers fetched, or perhaps you'd like to prune
13478 some headers.  I don't see why you'd want that, though.
13479
13480 @item gnus-shell-command-separator
13481 @vindex gnus-shell-command-separator
13482 String used to separate to shell commands.  The default is @samp{;}. 
13483
13484
13485 @end table
13486
13487
13488 @node The End
13489 @chapter The End
13490
13491 Well, that's the manual---you can get on with your life now.  Keep in
13492 touch.  Say hello to your cats from me.  
13493
13494 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
13495
13496 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13497
13498 @quotation
13499 @strong{Te Deum}
13500
13501 @sp 1
13502 Not because of victories @*
13503 I sing,@*
13504 having none,@*
13505 but for the common sunshine,@*
13506 the breeze,@*
13507 the largess of the spring.
13508
13509 @sp 1
13510 Not for victory@*
13511 but for the day's work done@*
13512 as well as I was able;@*
13513 not for a seat upon the dais@*
13514 but at the common table.@*
13515 @end quotation
13516
13517
13518 @node Appendices
13519 @chapter Appendices
13520
13521 @menu
13522 * History::                        How Gnus got where it is today.
13523 * Terminology::                    We use really difficult, like, words here.
13524 * Customization::                  Tailoring Gnus to your needs.
13525 * Troubleshooting::                What you might try if things do not work.
13526 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
13527 * Emacs for Heathens::             A short introduction to Emacsian terms.
13528 * Frequently Asked Questions::     A question-and-answer session.
13529 @end menu
13530
13531
13532 @node History
13533 @section History
13534
13535 @cindex history
13536 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
13537 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13538
13539 If you want to investigate the person responsible for this outrage, you
13540 can point your (feh!) web browser to
13541 @file{http://www.ifi.uio.no/~larsi/}.  This is also the primary
13542 distribution point for the new and spiffy versions of Gnus, and is known
13543 as The Site That Destroys Newsrcs And Drives People Mad.
13544
13545 During the first extended alpha period of development, the new Gnus was
13546 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
13547 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13548 (Besides, the ``Gnus'' in this abbreviation should probably be
13549 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13550 appropriate name, don't you think?)
13551
13552 In any case, after spending all that energy on coming up with a new and
13553 spunky name, we decided that the name was @emph{too} spunky, so we
13554 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
13555 ``@sc{gnus}''.  New vs. old.
13556
13557 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13558 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13559 plus 15 Gnus 5.0 releases).
13560
13561 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13562 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13563
13564 On July 28th 1996 work on Red Gnus was begun, and it was released on
13565 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13566
13567 If you happen upon a version of Gnus that has a name that is prefixed --
13568 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13569 don't panic.  Don't let it know that you're frightened.  Back away.
13570 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
13571 out of its reach.  Find a proper released version of Gnus and snuggle up
13572 to that instead.
13573
13574 @menu
13575 * Why?::                What's the point of Gnus?
13576 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
13577 * Conformity::          Gnus tries to conform to all standards.
13578 * Emacsen::             Gnus can be run on a few modern Emacsen.
13579 * Contributors::        Oodles of people.  
13580 * New Features::        Pointers to some of the new stuff in Gnus.
13581 * Newest Features::     Features so new that they haven't been written yet.
13582 @end menu
13583
13584
13585 @node Why?
13586 @subsection Why?
13587
13588 What's the point of Gnus?  
13589
13590 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13591 newsreader, that lets you do anything you can think of.  That was my
13592 original motivation, but while working on Gnus, it has become clear to
13593 me that this generation of newsreaders really belong in the stone age.
13594 Newsreaders haven't developed much since the infancy of the net.  If the
13595 volume continues to rise with the current rate of increase, all current
13596 newsreaders will be pretty much useless.  How do you deal with
13597 newsgroups that have thousands of new articles each day?  How do you
13598 keep track of millions of people who post?
13599
13600 Gnus offers no real solutions to these questions, but I would very much
13601 like to see Gnus being used as a testing ground for new methods of
13602 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
13603 to separate the newsreader from the backends, Gnus now offers a simple
13604 interface for anybody who wants to write new backends for fetching mail
13605 and news from different sources.  I have added hooks for customizations
13606 everywhere I could imagine useful.  By doing so, I'm inviting every one
13607 of you to explore and invent.
13608
13609 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}. 
13610
13611
13612 @node Compatibility
13613 @subsection Compatibility
13614
13615 @cindex compatibility
13616 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
13617 bindings have been kept.  More key bindings have been added, of course,
13618 but only in one or two obscure cases have old bindings been changed.
13619
13620 Our motto is:
13621 @quotation
13622 @cartouche
13623 @center In a cloud bones of steel.
13624 @end cartouche
13625 @end quotation
13626
13627 All commands have kept their names.  Some internal functions have changed
13628 their names.
13629
13630 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13631 Articles}. 
13632
13633 One major compatibility question is the presence of several summary
13634 buffers.  All variables that are relevant while reading a group are
13635 buffer-local to the summary buffer they belong in.  Although many
13636 important variables have their values copied into their global
13637 counterparts whenever a command is executed in the summary buffer, this
13638 change might lead to incorrect values being used unless you are careful.
13639
13640 All code that relies on knowledge of @sc{gnus} internals will probably
13641 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
13642 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
13643 maintains a hash table that points to the entries in this alist (which
13644 speeds up many functions), and changing the alist directly will lead to
13645 peculiar results.
13646
13647 @cindex hilit19
13648 @cindex highlighting
13649 Old hilit19 code does not work at all.  In fact, you should probably
13650 remove all hilit code from all Gnus hooks
13651 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13652 Gnus provides various integrated functions for highlighting.  These are
13653 faster and more accurate.  To make life easier for everybody, Gnus will
13654 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
13655 Away!
13656
13657 Packages like @code{expire-kill} will no longer work.  As a matter of
13658 fact, you should probably remove all old @sc{gnus} packages (and other
13659 code) when you start using Gnus.  More likely than not, Gnus already
13660 does what you have written code to make @sc{gnus} do.  (Snicker.)
13661
13662 Even though old methods of doing things are still supported, only the
13663 new methods are documented in this manual.  If you detect a new method of
13664 doing something while reading this manual, that does not mean you have
13665 to stop doing it the old way.
13666
13667 Gnus understands all @sc{gnus} startup files.
13668
13669 @kindex M-x gnus-bug
13670 @findex gnus-bug
13671 @cindex reporting bugs
13672 @cindex bugs
13673 Overall, a casual user who hasn't written much code that depends on
13674 @sc{gnus} internals should suffer no problems.  If problems occur,
13675 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13676
13677
13678 @node Conformity
13679 @subsection Conformity
13680
13681 No rebels without a clue here, ma'am.  We conform to all standards known
13682 to (wo)man.  Except for those standards and/or conventions we disagree
13683 with, of course.
13684
13685 @table @strong
13686
13687 @item RFC 822
13688 @cindex RFC 822
13689 There are no known breaches of this standard.
13690
13691 @item RFC 1036
13692 @cindex RFC 1036
13693 There are no known breaches of this standard, either.
13694
13695 @item Good Net-Keeping Seal of Approval
13696 @cindex Good Net-Keeping Seal of Approval
13697 Gnus has been through the Seal process and failed.  I think it'll pass
13698 the next inspection.
13699
13700 @item Son-of-RFC 1036
13701 @cindex Son-of-RFC 1036
13702 We do have some breaches to this one.
13703
13704 @table @emph
13705
13706 @item MIME
13707 Gnus does no MIME handling, and this standard-to-be seems to think that
13708 MIME is the bees' knees, so we have major breakage here.
13709
13710 @item X-Newsreader
13711 This is considered to be a ``vanity header'', while I consider it to be
13712 consumer information.  After seeing so many badly formatted articles
13713 coming from @code{tin} and @code{Netscape} I know not to use either of
13714 those for posting articles.  I would not have known that if it wasn't
13715 for the @code{X-Newsreader} header.
13716 @end table
13717
13718 @end table
13719
13720 If you ever notice Gnus acting non-compliantly with regards to the texts
13721 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13722 know.
13723
13724
13725 @node Emacsen
13726 @subsection Emacsen
13727 @cindex Emacsen
13728 @cindex XEmacs
13729 @cindex Mule
13730 @cindex Emacs
13731
13732 Gnus should work on :
13733
13734 @itemize @bullet 
13735
13736 @item
13737 Emacs 19.32 and up.
13738
13739 @item
13740 XEmacs 19.14 and up.
13741
13742 @item 
13743 Mule versions based on Emacs 19.32 and up.
13744
13745 @end itemize
13746
13747 Gnus will absolutely not work on any Emacsen older than that.  Not
13748 reliably, at least. 
13749
13750 There are some vague differences between Gnus on the various
13751 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13752 other than that, things should look pretty much the same under all
13753 Emacsen. 
13754
13755
13756 @node Contributors
13757 @subsection Contributors
13758 @cindex contributors
13759
13760 The new Gnus version couldn't have been done without the help of all the
13761 people on the (ding) mailing list.  Every day for over a year I have
13762 gotten billions of nice bug reports from them, filling me with joy,
13763 every single one of them.  Smooches.  The people on the list have been
13764 tried beyond endurance, what with my ``oh, that's a neat idea <type
13765 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13766 work at all <type type>, yup, I'll ship that one off right away <ship
13767 off> no, wait, that absolutely does not work'' policy for releases.
13768 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
13769 ``worser''? ``much worser''?  ``worsest''?)
13770
13771 I would like to take this opportunity to thank the Academy for...  oops,
13772 wrong show.
13773
13774 @itemize @bullet
13775
13776 @item 
13777 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13778
13779 @item 
13780 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13781 well as numerous other things).
13782
13783 @item 
13784 Luis Fernandes---design and graphics.
13785
13786 @item
13787 Erik Naggum---help, ideas, support, code and stuff.
13788
13789 @item 
13790 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13791 @dfn{picons} (@pxref{Picons}).
13792
13793 @item 
13794 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13795 (@pxref{GroupLens}).
13796
13797 @item 
13798 Sudish Joseph---innumerable bug fixes.
13799
13800 @item 
13801 Ilja Weis---@file{gnus-topic.el}.
13802
13803 @item 
13804 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13805
13806 @item 
13807 Vladimir Alexiev---the refcard and reference booklets.
13808
13809 @item 
13810 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13811 distribution by Felix Lee and JWZ.
13812
13813 @item 
13814 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13815
13816 @item 
13817 Peter Mutsaers---orphan article scoring code.
13818
13819 @item 
13820 Ken Raeburn---POP mail support.
13821
13822 @item 
13823 Hallvard B Furuseth---various bits and pieces, especially dealing with
13824 .newsrc files.
13825
13826 @item 
13827 Brian Edmonds---@file{gnus-bbdb.el}.
13828
13829 @item
13830 David Moore---rewrite of @file{nnvirtual.el} and many other things. 
13831
13832 @item 
13833 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13834
13835 @item 
13836 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13837
13838 @item
13839 François Pinard---many, many interesting and thorough bug reports.
13840
13841 @end itemize
13842
13843 The following people have contributed many patches and suggestions: 
13844
13845 Christopher Davis,
13846 Andrew Eskilsson,
13847 Kai Grossjohann,
13848 David KÃ¥gedal,
13849 Richard Pieri,
13850 Fabrice Popineau, 
13851 Daniel Quinlan, 
13852 Jason L. Tibbitts, III,
13853 and
13854 Jack Vinson.
13855
13856 Also thanks to the following for patches and stuff:
13857
13858 Adrian Aichner,
13859 Peter Arius, 
13860 Matt Armstrong,
13861 Marc Auslander,
13862 Chris Bone,
13863 Mark Borges,
13864 Lance A. Brown,
13865 Kees de Bruin,
13866 Martin Buchholz,
13867 Kevin Buhr,
13868 Alastair Burt,
13869 Joao Cachopo,
13870 Zlatko Calusic,
13871 Massimo Campostrini,
13872 Michael R. Cook,
13873 Glenn Coombs, 
13874 Frank D. Cringle, 
13875 Geoffrey T. Dairiki,
13876 Andre Deparade,
13877 Ulrik Dickow,
13878 Dave Disser,
13879 Joev Dubach,
13880 Paul Eggert,
13881 Michael Ernst,
13882 Luc Van Eycken,
13883 Sam Falkner,
13884 Paul Franklin, 
13885 David S. Goldberg,
13886 D. Hall, 
13887 Magnus Hammerin,
13888 Raja R. Harinath,
13889 Hisashige Kenji, @c Hisashige
13890 Marc Horowitz,
13891 François Felix Ingrand,
13892 Ishikawa Ichiro, @c Ishikawa
13893 Lee Iverson, 
13894 Rajappa Iyer,
13895 Randell Jesup,
13896 Fred Johansen, 
13897 Greg Klanderman,
13898 Karl Kleinpaste,
13899 Peter Skov Knudsen,
13900 Shuhei Kobayashi, @c Kobayashi
13901 Thor Kristoffersen,
13902 Jens Lautenbacher,
13903 Carsten Leonhardt,
13904 James LewisMoss,
13905 Christian Limpach,
13906 Markus Linnala,
13907 Dave Love,
13908 Tonny Madsen,
13909 Shlomo Mahlab,
13910 Nat Makarevitch,
13911 David Martin,
13912 Gordon Matzigkeit,
13913 Timo Metzemakers,
13914 Richard Mlynarik,
13915 Lantz Moore,
13916 Morioka Tomohiko, @c Morioka
13917 Erik Toubro Nielsen,
13918 Hrvoje Niksic,
13919 Andy Norman,
13920 C. R. Oldham,
13921 Alexandre Oliva,
13922 Ken Olstad,
13923 Masaharu Onishi, @c Onishi
13924 Hideki Ono, @c Ono
13925 William Perry,
13926 Stephen Peters,
13927 Ulrich Pfeifer,
13928 John McClary Prevost,
13929 Colin Rafferty,
13930 Bart Robinson,
13931 Jason Rumney,
13932 Loren Schall,
13933 Dan Schmidt,
13934 Ralph Schleicher,
13935 Philippe Schnoebelen,
13936 Randal L. Schwartz,
13937 Danny Siu, 
13938 Paul D. Smith,
13939 Jeff Sparkes,
13940 Michael Sperber,
13941 Richard Stallman,
13942 Greg Stark, 
13943 Paul Stodghill,
13944 Kurt Swanson,
13945 Samuel Tardieu, 
13946 Teddy,
13947 Chuck Thompson,
13948 Philippe Troin,
13949 Jan Vroonhof,
13950 Barry A. Warsaw,
13951 Christoph Wedler,
13952 Joe Wells,
13953 and
13954 Katsumi Yamaoka. @c Yamaoka
13955
13956 For a full overview of what each person has done, the ChangeLogs
13957 included in the Gnus alpha distributions should give ample reading
13958 (550kB and counting).
13959
13960 Apologies to everybody that I've forgotten, of which there are many, I'm
13961 sure.  
13962
13963 Gee, that's quite a list of people.  I guess that must mean that there
13964 actually are people who are using Gnus.  Who'd'a thunk it!
13965
13966
13967 @node New Features
13968 @subsection New Features
13969 @cindex new features
13970
13971 @menu
13972 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
13973 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
13974 * Red Gnus::           Third time best---Gnus 5.4/5.5.
13975 @end menu
13976
13977 These lists are, of course, just @emph{short} overviews of the
13978 @emph{most} important new features.  No, really.  There are tons more.
13979 Yes, we have feeping creaturism in full effect.
13980
13981
13982 @node ding Gnus
13983 @subsubsection (ding) Gnus
13984
13985 New features in Gnus 5.0/5.1:
13986
13987 @itemize @bullet
13988
13989 @item
13990 The look of all buffers can be changed by setting format-like variables
13991 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}). 
13992  
13993 @item 
13994 Local spool and several @sc{nntp} servers can be used at once
13995 (@pxref{Select Methods}).  
13996
13997 @item 
13998 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13999
14000 @item 
14001 You can read a number of different mail formats (@pxref{Getting Mail}).
14002 All the mail backends implement a convenient mail expiry scheme
14003 (@pxref{Expiring Mail}). 
14004
14005 @item
14006 Gnus can use various strategies for gathering threads that have lost
14007 their roots (thereby gathering loose sub-threads into one thread) or it
14008 can go back and retrieve enough headers to build a complete thread
14009 (@pxref{Customizing Threading}).
14010
14011 @item 
14012 Killed groups can be displayed in the group buffer, and you can read
14013 them as well (@pxref{Listing Groups}).
14014
14015 @item 
14016 Gnus can do partial group updates---you do not have to retrieve the
14017 entire active file just to check for new articles in a few groups
14018 (@pxref{The Active File}).
14019
14020 @item 
14021 Gnus implements a sliding scale of subscribedness to groups
14022 (@pxref{Group Levels}).
14023
14024 @item 
14025 You can score articles according to any number of criteria
14026 (@pxref{Scoring}).  You can even get Gnus to find out how to score
14027 articles for you (@pxref{Adaptive Scoring}).
14028
14029 @item 
14030 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
14031 manner, so it should be difficult to lose much data on what you have
14032 read if your machine should go down (@pxref{Auto Save}). 
14033
14034 @item 
14035 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
14036 the @file{.emacs} file.
14037
14038 @item 
14039 You can set the process mark on both groups and articles and perform
14040 operations on all the marked items (@pxref{Process/Prefix}).
14041
14042 @item 
14043 You can grep through a subset of groups and create a group from the
14044 results (@pxref{Kibozed Groups}). 
14045
14046 @item 
14047 You can list subsets of groups according to, well, anything
14048 (@pxref{Listing Groups}). 
14049
14050 @item 
14051 You can browse foreign servers and subscribe to groups from those
14052 servers (@pxref{Browse Foreign Server}). 
14053
14054 @item 
14055 Gnus can fetch articles asynchronously on a second connection to the
14056 server (@pxref{Asynchronous Fetching}).
14057
14058 @item 
14059 You can cache articles locally (@pxref{Article Caching}). 
14060
14061 @item 
14062 The uudecode functions have been expanded and generalized
14063 (@pxref{Decoding Articles}). 
14064
14065 @item
14066 You can still post uuencoded articles, which was a little-known feature
14067 of @sc{gnus}' past (@pxref{Uuencoding and Posting}). 
14068
14069 @item
14070 Fetching parents (and other articles) now actually works without
14071 glitches (@pxref{Finding the Parent}). 
14072
14073 @item
14074 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
14075
14076 @item
14077 Digests (and other files) can be used as the basis for groups
14078 (@pxref{Document Groups}).
14079
14080 @item 
14081 Articles can be highlighted and customized (@pxref{Customizing
14082 Articles}). 
14083
14084 @item 
14085 URLs and other external references can be buttonized (@pxref{Article
14086 Buttons}). 
14087
14088 @item
14089 You can do lots of strange stuff with the Gnus window & frame
14090 configuration (@pxref{Windows Configuration}).
14091
14092 @item
14093 You can click on buttons instead of using the keyboard
14094 (@pxref{Buttons}). 
14095
14096 @end itemize
14097
14098
14099 @node September Gnus
14100 @subsubsection September Gnus
14101
14102 New features in Gnus 5.2/5.3:
14103
14104 @itemize @bullet
14105
14106 @item
14107 A new message composition mode is used.  All old customization variables
14108 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14109 now obsolete.
14110
14111 @item
14112 Gnus is now able to generate @dfn{sparse} threads---threads where
14113 missing articles are represented by empty nodes (@pxref{Customizing
14114 Threading}). 
14115
14116 @lisp
14117 (setq gnus-build-sparse-threads 'some)
14118 @end lisp
14119
14120 @item
14121 Outgoing articles are stored on a special archive server
14122 (@pxref{Archived Messages}). 
14123
14124 @item
14125 Partial thread regeneration now happens when articles are
14126 referred. 
14127
14128 @item
14129 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14130
14131 @item
14132 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}). 
14133
14134 @item
14135 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14136
14137 @lisp
14138 (setq gnus-use-trees t)
14139 @end lisp
14140
14141 @item
14142 An @code{nn}-like pick-and-read minor mode is available for the summary
14143 buffers (@pxref{Pick and Read}).
14144
14145 @lisp
14146 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14147 @end lisp
14148
14149 @item
14150 In binary groups you can use a special binary minor mode (@pxref{Binary
14151 Groups}). 
14152
14153 @item
14154 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14155 Topics}).
14156
14157 @lisp
14158 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14159 @end lisp
14160
14161 @item
14162 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14163
14164 @item
14165 Groups can now have a score, and bubbling based on entry frequency
14166 is possible (@pxref{Group Score}).
14167
14168 @lisp
14169 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14170 @end lisp
14171
14172 @item
14173 Groups can be process-marked, and commands can be performed on
14174 groups of groups (@pxref{Marking Groups}).
14175
14176 @item
14177 Caching is possible in virtual groups.
14178
14179 @item
14180 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14181 news batches, ClariNet briefs collections, and just about everything
14182 else (@pxref{Document Groups}).
14183
14184 @item
14185 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14186 (@pxref{SOUP}).
14187
14188 @item
14189 The Gnus cache is much faster.
14190
14191 @item
14192 Groups can be sorted according to many criteria (@pxref{Sorting
14193 Groups}).
14194
14195 @item
14196 New group parameters have been introduced to set list-address and
14197 expiry times (@pxref{Group Parameters}).
14198
14199 @item
14200 All formatting specs allow specifying faces to be used
14201 (@pxref{Formatting Fonts}).
14202
14203 @item
14204 There are several more commands for setting/removing/acting on process
14205 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14206
14207 @item
14208 The summary buffer can be limited to show parts of the available
14209 articles based on a wide range of criteria.  These commands have been
14210 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14211
14212 @item
14213 Articles can be made persistent with the @kbd{*} command
14214 (@pxref{Persistent Articles}).
14215
14216 @item
14217 All functions for hiding article elements are now toggles.
14218
14219 @item
14220 Article headers can be buttonized (@pxref{Article Washing}).
14221
14222 @lisp
14223 (add-hook 'gnus-article-display-hook 
14224           'gnus-article-add-buttons-to-head)
14225 @end lisp
14226
14227 @item
14228 All mail backends support fetching articles by @code{Message-ID}.
14229
14230 @item
14231 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14232
14233 @item
14234 All summary mode commands are available directly from the article
14235 buffer (@pxref{Article Keymap}). 
14236
14237 @item
14238 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14239 Configuration}).
14240
14241 @item
14242 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14243
14244 @item
14245 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14246
14247 @lisp
14248 (setq gnus-use-nocem t)
14249 @end lisp
14250
14251 @item
14252 Groups can be made permanently visible (@pxref{Listing Groups}).
14253
14254 @lisp
14255 (setq gnus-permanently-visible-groups "^nnml:")
14256 @end lisp
14257
14258 @item
14259 Many new hooks have been introduced to make customizing easier. 
14260
14261 @item
14262 Gnus respects the @code{Mail-Copies-To} header.
14263
14264 @item
14265 Threads can be gathered by looking at the @code{References} header
14266 (@pxref{Customizing Threading}).
14267
14268 @lisp
14269 (setq gnus-summary-thread-gathering-function 
14270       'gnus-gather-threads-by-references)
14271 @end lisp
14272
14273 @item
14274 Read articles can be stored in a special backlog buffer to avoid
14275 refetching (@pxref{Article Backlog}).  
14276
14277 @lisp
14278 (setq gnus-keep-backlog 50)
14279 @end lisp
14280
14281 @item
14282 A clean copy of the current article is always stored in a separate
14283 buffer to allow easier treatment.
14284
14285 @item
14286 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14287
14288 @item
14289 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14290 Articles}). 
14291
14292 @lisp
14293 (setq gnus-prompt-before-saving t)
14294 @end lisp
14295
14296 @item
14297 @code{gnus-uu} can view decoded files asynchronously while fetching
14298 articles (@pxref{Other Decode Variables}). 
14299
14300 @lisp
14301 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14302 @end lisp
14303
14304 @item
14305 Filling in the article buffer now works properly on cited text
14306 (@pxref{Article Washing}).
14307
14308 @item
14309 Hiding cited text adds buttons to toggle hiding, and how much
14310 cited text to hide is now customizable (@pxref{Article Hiding}).
14311
14312 @lisp
14313 (setq gnus-cited-lines-visible 2)
14314 @end lisp
14315
14316 @item
14317 Boring headers can be hidden (@pxref{Article Hiding}).
14318
14319 @lisp
14320 (add-hook 'gnus-article-display-hook 
14321           'gnus-article-hide-boring-headers t)
14322 @end lisp
14323
14324 @item
14325 Default scoring values can now be set from the menu bar.
14326
14327 @item
14328 Further syntax checking of outgoing articles have been added.
14329
14330 @end itemize
14331
14332
14333 @node Red Gnus
14334 @subsubsection Red Gnus
14335
14336 New features in Gnus 5.4/5.5:
14337
14338 @itemize @bullet
14339
14340 @item
14341 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14342
14343 @item
14344 Article prefetching functionality has been moved up into 
14345 Gnus (@pxref{Asynchronous Fetching}).  
14346
14347 @item
14348 Scoring can now be performed with logical operators like @code{and},
14349 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14350 Scoring}).
14351
14352 @item
14353 Article washing status can be displayed in the
14354 article mode line (@pxref{Misc Article}).
14355
14356 @item
14357 @file{gnus.el} has been split into many smaller files.
14358
14359 @item
14360 Suppression of duplicate articles based on Message-ID can be done
14361 (@pxref{Duplicate Suppression}).
14362
14363 @lisp
14364 (setq gnus-suppress-duplicates t)
14365 @end lisp
14366
14367 @item
14368 New variables for specifying what score and adapt files are to be
14369 considered home score and adapt files (@pxref{Home Score File}).
14370
14371 @item
14372 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14373 Server Internals}). 
14374
14375 @item
14376 Groups can inherit group parameters from parent topics (@pxref{Topic
14377 Parameters}).
14378
14379 @item
14380 Article editing has been revamped and is now actually usable.
14381
14382 @item
14383 Signatures can be recognized in more intelligent fashions
14384 (@pxref{Article Signature}).
14385
14386 @item
14387 Summary pick mode has been made to look more @code{nn}-like.  Line
14388 numbers are displayed and the @kbd{.} command can be used to pick
14389 articles (@code{Pick and Read}).
14390
14391 @item
14392 Commands for moving the @file{.newsrc.eld} from one server to
14393 another have been added (@pxref{Changing Servers}).
14394
14395 @item
14396 A way to specify that ``uninteresting'' fields be suppressed when
14397 generating lines in buffers (@pxref{Advanced Formatting}).
14398
14399 @item
14400 Several commands in the group buffer can be undone with @kbd{M-C-_}
14401 (@pxref{Undo}).
14402
14403 @item
14404 Scoring can be done on words using the new score type @code{w}
14405 (@pxref{Score File Format}).
14406
14407 @item
14408 Adaptive scoring can be done on a Subject word-by-word basis
14409 (@pxref{Adaptive Scoring}). 
14410
14411 @lisp
14412 (setq gnus-use-adaptive-scoring '(word))
14413 @end lisp
14414
14415 @item
14416 Scores can be decayed (@pxref{Score Decays}).
14417  
14418 @lisp
14419 (setq gnus-decay-scores t)
14420 @end lisp
14421
14422 @item
14423 Scoring can be performed using a regexp on the Date header.  The Date is
14424 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14425
14426 @item
14427 A new command has been added to remove all data on articles from
14428 the native server (@pxref{Changing Servers}).
14429
14430 @item
14431 A new command for reading collections of documents
14432 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14433 (@pxref{Really Various Summary Commands}). 
14434
14435 @item
14436 Process mark sets can be pushed and popped (@pxref{Setting Process
14437 Marks}).
14438
14439 @item
14440 A new mail-to-news backend makes it possible to post even when the NNTP
14441 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14442
14443 @item
14444 A new backend for reading searches from Web search engines
14445 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14446 (@pxref{Web Searches}).
14447
14448 @item
14449 Groups inside topics can now be sorted using the standard sorting
14450 functions, and each topic can be sorted independently (@pxref{Topic
14451 Sorting}).
14452
14453 @item
14454 Subsets of the groups can be sorted independently (@code{Sorting
14455 Groups}).
14456
14457 @item
14458 Cached articles can be pulled into the groups (@pxref{Summary Generation
14459 Commands}).
14460   
14461 @item
14462 Score files are now applied in a more reliable order (@pxref{Score
14463 Variables}).
14464
14465 @item
14466 Reports on where mail messages end up can be generated (@pxref{Splitting
14467 Mail}).
14468
14469 @item
14470 More hooks and functions have been added to remove junk from incoming
14471 mail before saving the mail (@pxref{Washing Mail}).
14472
14473 @item
14474 Emphasized text can be properly fontisized:
14475
14476 @lisp
14477 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14478 @end lisp
14479  
14480 @end itemize
14481
14482
14483 @node Newest Features
14484 @subsection Newest Features
14485 @cindex todo
14486
14487 Also known as the @dfn{todo list}.  Sure to be implemented before the
14488 next millennium. 
14489
14490 Be afraid.  Be very afraid.
14491
14492 @itemize @bullet
14493 @item
14494 Native @sc{mime} support is something that should be done.  
14495 @item
14496 Really do unbinhexing.
14497 @end itemize
14498
14499 And much, much, much more.  There is more to come than has already been
14500 implemented.  (But that's always true, isn't it?)
14501
14502 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14503 up-to-the-second todo list is located, so if you're really curious, you
14504 could point your Web browser over that-a-way.
14505
14506 @iftex
14507
14508 @node The Manual
14509 @section The Manual
14510 @cindex colophon
14511 @cindex manual
14512
14513 This manual was generated from a TeXinfo file and then run through
14514 either @code{texi2dvi}
14515 @iflatex
14516 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14517 and then run through @code{latex} and @code{dvips} 
14518 @end iflatex
14519 to get what you hold in your hands now.
14520
14521 The following conventions have been used:
14522
14523 @enumerate
14524
14525 @item
14526 This is a @samp{string}
14527
14528 @item
14529 This is a @kbd{keystroke}
14530
14531 @item
14532 This is a @file{file}
14533
14534 @item 
14535 This is a @code{symbol}
14536
14537 @end enumerate
14538
14539 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14540 mean:
14541
14542 @lisp
14543 (setq flargnoze "yes")
14544 @end lisp
14545
14546 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14547
14548 @lisp
14549 (setq flumphel 'yes)
14550 @end lisp
14551
14552 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14553 ever get them confused.
14554
14555 @iflatex
14556 @c @head
14557 Of course, everything in this manual is of vital interest, so you should
14558 read it all.  Several times.  However, if you feel like skimming the
14559 manual, look for that gnu head you should see in the margin over
14560 there---it means that what's being discussed is of more importance than
14561 the rest of the stuff.  (On the other hand, if everything is infinitely
14562 important, how can anything be more important than that?  Just one more
14563 of the mysteries of this world, I guess.)
14564 @end iflatex
14565
14566 @end iftex
14567
14568
14569 @node Terminology
14570 @section Terminology
14571
14572 @cindex terminology
14573 @table @dfn
14574
14575 @item news
14576 @cindex news
14577 This is what you are supposed to use this thing for---reading news.
14578 News is generally fetched from a nearby @sc{nntp} server, and is
14579 generally publicly available to everybody.  If you post news, the entire
14580 world is likely to read just what you have written, and they'll all
14581 snigger mischievously.  Behind your back.
14582
14583 @item mail
14584 @cindex mail
14585 Everything that's delivered to you personally is mail.  Some news/mail
14586 readers (like Gnus) blur the distinction between mail and news, but
14587 there is a difference.  Mail is private.  News is public.  Mailing is
14588 not posting, and replying is not following up.
14589
14590 @item reply
14591 @cindex reply
14592 Send a mail to the person who has written what you are reading.
14593
14594 @item follow up
14595 @cindex follow up
14596 Post an article to the current newsgroup responding to the article you
14597 are reading.
14598
14599 @item backend
14600 @cindex backend
14601 Gnus gets fed articles from a number of backends, both news and mail
14602 backends.  Gnus does not handle the underlying media, so to speak---this
14603 is all done by the backends.
14604
14605 @item native
14606 @cindex native
14607 Gnus will always use one method (and backend) as the @dfn{native}, or
14608 default, way of getting news.
14609
14610 @item foreign
14611 @cindex foreign
14612 You can also have any number of foreign groups active at the same time.
14613 These are groups that use different backends for getting news.
14614
14615 @item secondary
14616 @cindex secondary
14617 Secondary backends are somewhere half-way between being native and being
14618 foreign, but they mostly act like they are native.
14619
14620 @item article
14621 @cindex article
14622 A message that has been posted as news.
14623
14624 @item mail message
14625 @cindex mail message
14626 A message that has been mailed.
14627
14628 @item message 
14629 @cindex message
14630 A mail message or news article
14631
14632 @item head
14633 @cindex head
14634 The top part of a message, where administrative information (etc.) is
14635 put.
14636
14637 @item body
14638 @cindex body
14639 The rest of an article.  Everything that is not in the head is in the
14640 body. 
14641
14642 @item header
14643 @cindex header
14644 A line from the head of an article. 
14645
14646 @item headers
14647 @cindex headers
14648 A collection of such lines, or a collection of heads.  Or even a
14649 collection of @sc{nov} lines.
14650
14651 @item @sc{nov}
14652 @cindex nov
14653 When Gnus enters a group, it asks the backend for the headers of all
14654 unread articles in the group.  Most servers support the News OverView
14655 format, which is more compact and much faster to read and parse than the
14656 normal @sc{head} format.
14657
14658 @item level
14659 @cindex levels
14660 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
14661 that have a lower level are ``more'' subscribed than the groups with a
14662 higher level.  In fact, groups on levels 1-5 are considered
14663 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14664 are @dfn{killed}.  Commands for listing groups and scanning for new
14665 articles will all use the numeric prefix as @dfn{working level}.
14666
14667 @item killed groups
14668 @cindex killed groups
14669 No information on killed groups is stored or updated, which makes killed
14670 groups much easier to handle than subscribed groups.
14671
14672 @item zombie groups
14673 @cindex zombie groups
14674 Just like killed groups, only slightly less dead.
14675
14676 @item active file
14677 @cindex active file
14678 The news server has to keep track of what articles it carries, and what
14679 groups exist.  All this information in stored in the active file, which
14680 is rather large, as you might surmise.
14681
14682 @item bogus groups
14683 @cindex bogus groups
14684 A group that exists in the @file{.newsrc} file, but isn't known to the
14685 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
14686 This means that the group probably doesn't exist (any more).
14687
14688 @item server 
14689 @cindex server
14690 A machine than one can connect to and get news (or mail) from.
14691
14692 @item select method
14693 @cindex select method
14694 A structure that specifies the backend, the server and the virtual
14695 server parameters.
14696
14697 @item virtual server
14698 @cindex virtual server
14699 A named select method.  Since a select methods defines all there is to
14700 know about connecting to a (physical) server, taking the things as a
14701 whole is a virtual server.
14702
14703 @item washing
14704 @cindex washing
14705 Taking a buffer and running it through a filter of some sort.  The
14706 result will (more often than not) be cleaner and more pleasing than the
14707 original. 
14708
14709 @item ephemeral groups
14710 @cindex ephemeral groups
14711 Most groups store data on what articles you have read.  @dfn{Ephemeral}
14712 groups are groups that will have no data stored---when you exit the
14713 group, it'll disappear into the aether.  
14714
14715 @item solid groups
14716 @cindex solid groups
14717 This is the opposite of ephemeral groups.  All groups listed in the
14718 group buffer are solid groups.
14719
14720 @item sparse articles
14721 @cindex sparse articles
14722 These are article placeholders shown in the summary buffer when
14723 @code{gnus-build-sparse-threads} has been switched on.
14724
14725 @end table
14726
14727
14728 @node Customization
14729 @section Customization
14730 @cindex general customization
14731
14732 All variables are properly documented elsewhere in this manual.  This
14733 section is designed to give general pointers on how to customize Gnus
14734 for some quite common situations.
14735
14736 @menu
14737 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14738 * Slow Terminal Connection::  You run a remote Emacs.
14739 * Little Disk Space::         You feel that having large setup files is icky.
14740 * Slow Machine::              You feel like buying a faster machine.
14741 @end menu
14742
14743
14744 @node Slow/Expensive Connection
14745 @subsection Slow/Expensive @sc{nntp} Connection
14746
14747 If you run Emacs on a machine locally, and get your news from a machine
14748 over some very thin strings, you want to cut down on the amount of data
14749 Gnus has to get from the @sc{nntp} server.
14750
14751 @table @code
14752
14753 @item gnus-read-active-file
14754 Set this to @code{nil}, which will inhibit Gnus from requesting the
14755 entire active file from the server.  This file is often v.  large.  You
14756 also have to set @code{gnus-check-new-newsgroups} and
14757 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14758 doesn't suddenly decide to fetch the active file anyway.
14759
14760 @item gnus-nov-is-evil
14761 This one has to be @code{nil}.  If not, grabbing article headers from
14762 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
14763 support @sc{xover}; Gnus will detect this by itself.
14764 @end table
14765
14766
14767 @node Slow Terminal Connection
14768 @subsection Slow Terminal Connection
14769
14770 Let's say you use your home computer for dialing up the system that
14771 runs Emacs and Gnus.  If your modem is slow, you want to reduce the
14772 amount of data that is sent over the wires as much as possible.
14773
14774 @table @code
14775
14776 @item gnus-auto-center-summary
14777 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14778 buffer all the time.  If it is @code{vertical}, do only vertical
14779 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
14780 horizontal and vertical recentering.
14781
14782 @item gnus-visible-headers
14783 Cut down on the headers that are included in the articles to the
14784 minimum.  You can, in fact, make do without them altogether---most of the
14785 useful data is in the summary buffer, anyway.  Set this variable to
14786 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14787
14788 @item gnus-article-display-hook
14789 Set this hook to all the available hiding commands:
14790 @lisp
14791 (setq gnus-article-display-hook 
14792       '(gnus-article-hide-headers gnus-article-hide-signature
14793         gnus-article-hide-citation))
14794 @end lisp
14795
14796 @item gnus-use-full-window
14797 By setting this to @code{nil}, you can make all the windows smaller.
14798 While this doesn't really cut down much generally, it means that you
14799 have to see smaller portions of articles before deciding that you didn't
14800 want to read them anyway.
14801
14802 @item gnus-thread-hide-subtree
14803 If this is non-@code{nil}, all threads in the summary buffer will be
14804 hidden initially.
14805
14806 @item gnus-updated-mode-lines
14807 If this is @code{nil}, Gnus will not put information in the buffer mode
14808 lines, which might save some time.
14809 @end table
14810
14811
14812 @node Little Disk Space
14813 @subsection Little Disk Space
14814 @cindex disk space
14815
14816 The startup files can get rather large, so you may want to cut their
14817 sizes a bit if you are running out of space.
14818
14819 @table @code
14820
14821 @item gnus-save-newsrc-file
14822 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14823 only save @file{.newsrc.eld}.  This means that you will not be able to
14824 use any other newsreaders than Gnus.  This variable is @code{t} by
14825 default. 
14826
14827 @item gnus-save-killed-list
14828 If this is @code{nil}, Gnus will not save the list of dead groups.  You
14829 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14830 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14831 variable to @code{nil}.  This variable is @code{t} by default.
14832
14833 @end table
14834
14835
14836 @node Slow Machine
14837 @subsection Slow Machine
14838 @cindex slow machine
14839
14840 If you have a slow machine, or are just really impatient, there are a
14841 few things you can do to make Gnus run faster.
14842
14843 Set@code{gnus-check-new-newsgroups} and
14844 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14845
14846 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14847 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14848 summary buffer faster.
14849
14850 Set @code{gnus-article-display-hook} to @code{nil} to make article
14851 processing a bit faster.
14852
14853
14854 @node Troubleshooting
14855 @section Troubleshooting
14856 @cindex troubleshooting
14857
14858 Gnus works @emph{so} well straight out of the box---I can't imagine any
14859 problems, really.
14860
14861 Ahem.
14862
14863 @enumerate
14864
14865 @item
14866 Make sure your computer is switched on.
14867
14868 @item
14869 Make sure that you really load the current Gnus version.  If you have
14870 been running @sc{gnus}, you need to exit Emacs and start it up again before
14871 Gnus will work.
14872
14873 @item
14874 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
14875 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
14876 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14877 flee}, you have some old @file{.el} files lying around.  Delete these.
14878
14879 @item
14880 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14881 how-to. 
14882
14883 @item
14884 @vindex max-lisp-eval-depth
14885 Gnus works on many recursive structures, and in some extreme (and very
14886 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14887 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14888 something like that.
14889 @end enumerate
14890
14891 If all else fails, report the problem as a bug.
14892
14893 @cindex bugs
14894 @cindex reporting bugs
14895
14896 @kindex M-x gnus-bug
14897 @findex gnus-bug
14898 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14899 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14900 me the backtrace.  I will fix bugs, but I can only fix them if you send
14901 me a precise description as to how to reproduce the bug.
14902
14903 You really can never be too detailed in a bug report.  Always use the
14904 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14905 a 10Kb mail each time you use it, and even if you have sent me your
14906 environment 500 times before.  I don't care.  I want the full info each
14907 time.  
14908
14909 It is also important to remember that I have no memory whatsoever.  If
14910 you send a bug report, and I send you a reply, and then you send back
14911 just ``No, it's not! Moron!'', I will have no idea what you are
14912 insulting me about.  Always over-explain everything.  It's much easier
14913 for all of us---if I don't have all the information I need, I will just
14914 mail you and ask for more info, and everything takes more time.
14915
14916 If the problem you're seeing is very visual, and you can't quite explain
14917 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14918 it somewhere it can be reached, and include the URL of the picture in
14919 the bug report.
14920
14921 If you just need help, you are better off asking on
14922 @samp{gnu.emacs.gnus}.  I'm not very helpful.
14923
14924 @cindex gnu.emacs.gnus
14925 @cindex ding mailing list
14926 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14927 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14928
14929
14930 @node A Programmers Guide to Gnus
14931 @section A Programmer@'s Guide to Gnus
14932
14933 It is my hope that other people will figure out smart stuff that Gnus
14934 can do, and that other people will write those smart things as well.  To
14935 facilitate that I thought it would be a good idea to describe the inner
14936 workings of Gnus.  And some of the not-so-inner workings, while I'm at
14937 it.
14938
14939 You can never expect the internals of a program not to change, but I
14940 will be defining (in some details) the interface between Gnus and its
14941 backends (this is written in stone), the format of the score files
14942 (ditto), data structures (some are less likely to change than others)
14943 and general method of operations.
14944
14945 @menu 
14946 * Backend Interface::        How Gnus communicates with the servers.
14947 * Score File Syntax::        A BNF definition of the score file standard.
14948 * Headers::                  How Gnus stores headers internally.
14949 * Ranges::                   A handy format for storing mucho numbers.
14950 * Group Info::               The group info format.
14951 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
14952 * Various File Formats::     Formats of files that Gnus use.
14953 @end menu
14954
14955
14956 @node Backend Interface
14957 @subsection Backend Interface
14958
14959 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14960 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
14961 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
14962 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
14963 examples of the latter we have @code{nntp-port-number} and
14964 @code{nnmbox-directory}.
14965
14966 When Gnus asks for information from a backend---say @code{nntp}---on
14967 something, it will normally include a virtual server name in the
14968 function parameters.  (If not, the backend should use the ``current''
14969 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
14970 server as its only (optional) parameter.  If this virtual server hasn't
14971 been opened, the function should fail.
14972
14973 Note that a virtual server name has no relation to some physical server
14974 name.  Take this example:
14975
14976 @lisp
14977 (nntp "odd-one" 
14978       (nntp-address "ifi.uio.no") 
14979       (nntp-port-number 4324))
14980 @end lisp
14981
14982 Here the virtual server name is @samp{odd-one} while the name of
14983 the physical server is @samp{ifi.uio.no}. 
14984
14985 The backends should be able to switch between several virtual servers.
14986 The standard backends implement this by keeping an alist of virtual
14987 server environments that it pulls down/pushes up when needed.  
14988
14989 There are two groups of interface functions: @dfn{required functions},
14990 which must be present, and @dfn{optional functions}, which Gnus will
14991 always check whether are present before attempting to call.
14992
14993 All these functions are expected to return data in the buffer
14994 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14995 unfortunately named, but we'll have to live with it.  When I talk about
14996 @dfn{resulting data}, I always refer to the data in that buffer.  When I
14997 talk about @dfn{return value}, I talk about the function value returned by
14998 the function call.  Functions that fail should return @code{nil} as the
14999 return value.
15000
15001 Some backends could be said to be @dfn{server-forming} backends, and
15002 some might be said to not be.  The latter are backends that generally
15003 only operate on one group at a time, and have no concept of ``server''
15004 -- they have a group, and they deliver info on that group and nothing
15005 more.
15006
15007 In the examples and definitions I will refer to the imaginary backend
15008 @code{nnchoke}. 
15009
15010 @cindex @code{nnchoke}
15011
15012 @menu
15013 * Required Backend Functions::        Functions that must be implemented.
15014 * Optional Backend Functions::        Functions that need not be implemented.
15015 * Error Messaging::                   How to get messages and report errors.
15016 * Writing New Backends::              Extending old backends.
15017 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
15018 * Mail-like Backends::                Some tips on mail backends.
15019 @end menu
15020
15021
15022 @node Required Backend Functions
15023 @subsubsection Required Backend Functions
15024
15025 @table @code
15026
15027 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
15028
15029 @var{articles} is either a range of article numbers or a list of
15030 @code{Message-ID}s.  Current backends do not fully support either---only
15031 sequences (lists) of article numbers, and most backends do not support
15032 retrieval of @code{Message-ID}s.  But they should try for both. 
15033
15034 The result data should either be HEADs or NOV lines, and the result
15035 value should either be @code{headers} or @code{nov} to reflect this.
15036 This might later be expanded to @code{various}, which will be a mixture
15037 of HEADs and NOV lines, but this is currently not supported by Gnus.  
15038
15039 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
15040 headers, in some meaning of the word.  This is generally done by
15041 fetching (at most) @var{fetch-old} extra headers less than the smallest
15042 article number in @code{articles}, and fill in the gaps as well.  The
15043 presence of this parameter can be ignored if the backend finds it
15044 cumbersome to follow the request.  If this is non-@code{nil} and not a
15045 number, do maximum fetches.
15046
15047 Here's an example HEAD:
15048
15049 @example
15050 221 1056 Article retrieved.
15051 Path: ifi.uio.no!sturles
15052 From: sturles@@ifi.uio.no (Sturle Sunde)
15053 Newsgroups: ifi.discussion
15054 Subject: Re: Something very droll
15055 Date: 27 Oct 1994 14:02:57 +0100
15056 Organization: Dept. of Informatics, University of Oslo, Norway
15057 Lines: 26
15058 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
15059 References: <38jdmq$4qu@@visbur.ifi.uio.no>
15060 NNTP-Posting-Host: holmenkollen.ifi.uio.no
15061 .
15062 @end example
15063
15064 So a @code{headers} return value would imply that there's a number of
15065 these in the data buffer.
15066
15067 Here's a BNF definition of such a buffer:
15068
15069 @example
15070 headers        = *head
15071 head           = error / valid-head
15072 error-message  = [ "4" / "5" ] 2number " " <error message> eol
15073 valid-head     = valid-message *header "." eol
15074 valid-message  = "221 " <number> " Article retrieved." eol
15075 header         = <text> eol
15076 @end example
15077
15078 If the return value is @code{nov}, the data buffer should contain
15079 @dfn{network overview database} lines.  These are basically fields
15080 separated by tabs. 
15081
15082 @example
15083 nov-buffer = *nov-line
15084 nov-line   = 8*9 [ field <TAB> ] eol
15085 field      = <text except TAB>
15086 @end example
15087
15088 For a closer explanation what should be in those fields,
15089 @pxref{Headers}. 
15090
15091
15092 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15093
15094 @var{server} is here the virtual server name.  @var{definitions} is a
15095 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server. 
15096
15097 If the server can't be opened, no error should be signaled.  The backend
15098 may then choose to refuse further attempts at connecting to this
15099 server.  In fact, it should do so. 
15100
15101 If the server is opened already, this function should return a
15102 non-@code{nil} value.  There should be no data returned.
15103
15104
15105 @item (nnchoke-close-server &optional SERVER)
15106
15107 Close connection to @var{server} and free all resources connected
15108 to it.  Return @code{nil} if the server couldn't be closed for some
15109 reason.
15110
15111 There should be no data returned.
15112
15113
15114 @item (nnchoke-request-close)
15115
15116 Close connection to all servers and free all resources that the backend
15117 have reserved.  All buffers that have been created by that backend
15118 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
15119 function is generally only called when Gnus is shutting down.
15120
15121 There should be no data returned. 
15122
15123
15124 @item (nnchoke-server-opened &optional SERVER)
15125
15126 If @var{server} is the current virtual server, and the connection to the
15127 physical server is alive, then this function should return a
15128 non-@code{nil} vlue.  This function should under no circumstances
15129 attempt to reconnect to a server that is has lost connection to.
15130
15131 There should be no data returned.
15132
15133
15134 @item (nnchoke-status-message &optional SERVER)
15135
15136 This function should return the last error message from @var{server}. 
15137
15138 There should be no data returned.
15139
15140
15141 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15142
15143 The result data from this function should be the article specified by
15144 @var{article}.  This might either be a @code{Message-ID} or a number.
15145 It is optional whether to implement retrieval by @code{Message-ID}, but
15146 it would be nice if that were possible.
15147
15148 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15149 in this buffer instead of the normal data buffer.  This is to make it
15150 possible to avoid copying large amounts of data from one buffer to
15151 another, and Gnus mainly request articles to be inserted directly into
15152 its article buffer.
15153
15154 If it is at all possible, this function should return a cons cell where
15155 the car is the group name the article was fetched from, and the cdr is
15156 the article number.  This will enable Gnus to find out what the real
15157 group and article numbers are when fetching articles by
15158 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
15159 on successful article retrievement.
15160
15161
15162 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15163
15164 Get data on @var{group}.  This function also has the side effect of
15165 making @var{group} the current group. 
15166
15167 If @var{FAST}, don't bother to return useful data, just make @var{group}
15168 the current group.
15169
15170 Here's an example of some result data and a definition of the same:
15171
15172 @example
15173 211 56 1000 1059 ifi.discussion
15174 @end example
15175
15176 The first number is the status, which should be 211.  Next is the
15177 total number of articles in the group, the lowest article number, the
15178 highest article number, and finally the group name.  Note that the total
15179 number of articles may be less than one might think while just
15180 considering the highest and lowest article numbers, but some articles
15181 may have been canceled.  Gnus just discards the total-number, so
15182 whether one should take the bother to generate it properly (if that is a
15183 problem) is left as an exercise to the reader.
15184
15185 @example
15186 group-status = [ error / info ] eol
15187 error        = [ "4" / "5" ] 2<number> " " <Error message>
15188 info         = "211 " 3* [ <number> " " ] <string>
15189 @end example
15190
15191
15192 @item (nnchoke-close-group GROUP &optional SERVER)
15193
15194 Close @var{group} and free any resources connected to it.  This will be
15195 a no-op on most backends. 
15196
15197 There should be no data returned.
15198
15199
15200 @item (nnchoke-request-list &optional SERVER)
15201
15202 Return a list of all groups available on @var{server}.  And that means
15203 @emph{all}. 
15204
15205 Here's an example from a server that only carries two groups:
15206
15207 @example
15208 ifi.test 0000002200 0000002000 y
15209 ifi.discussion 3324 3300 n
15210 @end example
15211
15212 On each line we have a group name, then the highest article number in
15213 that group, the lowest article number, and finally a flag.
15214
15215 @example
15216 active-file = *active-line
15217 active-line = name " " <number> " " <number> " " flags eol
15218 name        = <string>
15219 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
15220 @end example
15221
15222 The flag says whether the group is read-only (@samp{n}), is moderated
15223 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15224 (@samp{=other-group} or none of the above (@samp{y}). 
15225
15226
15227 @item (nnchoke-request-post &optional SERVER)
15228
15229 This function should post the current buffer.  It might return whether
15230 the posting was successful or not, but that's not required.  If, for
15231 instance, the posting is done asynchronously, it has generally not been
15232 completed by the time this function concludes.  In that case, this
15233 function should set up some kind of sentinel to beep the user loud and
15234 clear if the posting could not be completed.
15235
15236 There should be no result data from this function. 
15237
15238 @end table
15239
15240
15241 @node Optional Backend Functions
15242 @subsubsection Optional Backend Functions
15243
15244 @table @code
15245
15246 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15247
15248 @var{groups} is a list of groups, and this function should request data
15249 on all those groups.  How it does it is of no concern to Gnus, but it
15250 should attempt to do this in a speedy fashion.
15251
15252 The return value of this function can be either @code{active} or
15253 @code{group}, which says what the format of the result data is.  The
15254 former is in the same format as the data from
15255 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15256 in the same format as @code{nnchoke-request-group} gives.
15257
15258 @example
15259 group-buffer = *active-line / *group-status
15260 @end example
15261
15262
15263 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15264
15265 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15266 alterations.  This comes in handy if the backend really carries all the
15267 information (as is the case with virtual and imap groups).  This
15268 function should destructively alter the info to suit its needs, and
15269 should return the (altered) group info.
15270
15271 There should be no result data from this function.
15272
15273
15274 @item (nnchoke-request-type GROUP &optional ARTICLE)
15275
15276 When the user issues commands for ``sending news'' (@kbd{F} in the
15277 summary buffer, for instance), Gnus has to know whether the article the
15278 user is following up is news or mail.  This function should return
15279 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15280 is mail and @code{unknown} if the type can't be decided.  (The
15281 @var{article} parameter is necessary in @code{nnvirtual} groups which
15282 might very well combine mail groups and news groups.)  Both @var{group}
15283 and @var{article} may be @code{nil}.
15284
15285 There should be no result data from this function.
15286
15287
15288 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15289
15290 If the user tries to set a mark that the backend doesn't like, this
15291 function may change the mark.  Gnus will use whatever this function
15292 returns as the mark for @var{article} instead of the original
15293 @var{mark}.  If the backend doesn't care, it must return the original
15294 @var{mark}, and not @code{nil} or any other type of garbage.  
15295
15296 The only use for this that I can see is what @code{nnvirtual} does with
15297 it---if a component group is auto-expirable, marking an article as read
15298 in the virtual group should result in the article being marked as
15299 expirable. 
15300
15301 There should be no result data from this function.
15302
15303
15304 @item (nnchoke-request-scan &optional GROUP SERVER)
15305
15306 This function may be called at any time (by Gnus or anything else) to
15307 request that the backend check for incoming articles, in one way or
15308 another.  A mail backend will typically read the spool file or query the
15309 POP server when this function is invoked.  The @var{group} doesn't have
15310 to be heeded---if the backend decides that it is too much work just
15311 scanning for a single group, it may do a total scan of all groups.  It
15312 would be nice, however, to keep things local if that's practical.
15313
15314 There should be no result data from this function.
15315
15316
15317 @item (nnchoke-request-group-description GROUP &optional SERVER)
15318
15319 The result data from this function should be a description of
15320 @var{group}. 
15321
15322 @example
15323 description-line = name <TAB> description eol
15324 name             = <string>
15325 description      = <text>
15326 @end example
15327
15328 @item (nnchoke-request-list-newsgroups &optional SERVER)
15329
15330 The result data from this function should be the description of all
15331 groups available on the server.
15332
15333 @example
15334 description-buffer = *description-line
15335 @end example
15336
15337
15338 @item (nnchoke-request-newgroups DATE &optional SERVER)
15339
15340 The result data from this function should be all groups that were
15341 created after @samp{date}, which is in normal human-readable date
15342 format.  The data should be in the active buffer format.
15343
15344
15345 @item (nnchoke-request-create-group GROUP &optional SERVER)
15346
15347 This function should create an empty group with name @var{group}.  
15348
15349 There should be no return data.
15350
15351
15352 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15353
15354 This function should run the expiry process on all articles in the
15355 @var{articles} range (which is currently a simple list of article
15356 numbers.)  It is left up to the backend to decide how old articles
15357 should be before they are removed by this function.  If @var{force} is
15358 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15359 they are. 
15360
15361 This function should return a list of articles that it did not/was not
15362 able to delete.
15363
15364 There should be no result data returned.
15365
15366
15367 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15368 &optional LAST)
15369
15370 This function should move @var{article} (which is a number) from
15371 @var{group} by calling @var{accept-form}.  
15372
15373 This function should ready the article in question for moving by
15374 removing any header lines it has added to the article, and generally
15375 should ``tidy up'' the article.  Then it should @code{eval}
15376 @var{accept-form} in the buffer where the ``tidy'' article is.  This
15377 will do the actual copying.  If this @code{eval} returns a
15378 non-@code{nil} value, the article should be removed.
15379
15380 If @var{last} is @code{nil}, that means that there is a high likelihood
15381 that there will be more requests issued shortly, so that allows some
15382 optimizations. 
15383
15384 The function should return a cons where the car is the group name and
15385 the cdr is the article number that the article was entered as.
15386
15387 There should be no data returned. 
15388
15389
15390 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15391
15392 This function takes the current buffer and inserts it into @var{group}.
15393 If @var{last} in @code{nil}, that means that there will be more calls to
15394 this function in short order.
15395
15396 The function should return a cons where the car is the group name and
15397 the cdr is the article number that the article was entered as.
15398
15399 There should be no data returned.
15400
15401
15402 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15403
15404 This function should remove @var{article} (which is a number) from
15405 @var{group} and insert @var{buffer} there instead.
15406
15407 There should be no data returned.
15408
15409
15410 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15411
15412 This function should delete @var{group}.  If @var{force}, it should
15413 really delete all the articles in the group, and then delete the group
15414 itself.  (If there is such a thing as ``the group itself''.)
15415
15416 There should be no data returned.
15417
15418
15419 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15420
15421 This function should rename @var{group} into @var{new-name}.  All
15422 articles that are in @var{group} should move to @var{new-name}.
15423
15424 There should be no data returned.
15425
15426 @end table
15427
15428
15429 @node Error Messaging
15430 @subsubsection Error Messaging
15431
15432 @findex nnheader-report
15433 @findex nnheader-get-report
15434 The backends should use the function @code{nnheader-report} to report
15435 error conditions---they should not raise errors when they aren't able to
15436 perform a request.  The first argument to this function is the backend
15437 symbol, and the rest are interpreted as arguments to @code{format} if
15438 there are many of them, or just a string if there is one of them.
15439 This function always returns @code{nil}.
15440
15441 @lisp
15442 (nnheader-report 'nnchoke "You did something totally bogus")
15443
15444 (nnheader-report 'nnchoke "Could not request group %s" group)
15445 @end lisp
15446
15447 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15448 @code{nil} back from a server, and this function returns the most
15449 recently reported message for the backend in question.  This function
15450 takes one argument---the server symbol.
15451
15452 Internally, these function access @var{backend}@code{-status-string}, so
15453 the @code{nnchoke} backend will have its error message stored in
15454 @code{nnchoke-status-string}. 
15455
15456
15457 @node Writing New Backends
15458 @subsubsection Writing New Backends
15459
15460 Many backends are quite similar.  @code{nnml} is just like
15461 @code{nnspool}, but it allows you to edit the articles on the server.
15462 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15463 and it doesn't maintain overview databases.  @code{nndir} is just like
15464 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15465 editing articles.
15466
15467 It would make sense if it were possible to ``inherit'' functions from
15468 backends when writing new backends.  And, indeed, you can do that if you
15469 want to.  (You don't have to if you don't want to, of course.)  
15470
15471 All the backends declare their public variables and functions by using a
15472 package called @code{nnoo}.  
15473
15474 To inherit functions from other backends (and allow other backends to
15475 inherit functions from the current backend), you should use the
15476 following macros:
15477 following. 
15478
15479 @table @code
15480
15481 @item nnoo-declare
15482 This macro declares the first parameter to be a child of the subsequent
15483 parameters.  For instance:
15484
15485 @lisp
15486 (nnoo-declare nndir
15487   nnml nnmh)
15488 @end lisp
15489
15490 @code{nndir} has here declared that it intends to inherit functions from
15491 both @code{nnml} and @code{nnmh}.
15492
15493 @item defvoo
15494 This macro is equivalent to @code{defvar}, but registers the variable as
15495 a public server variable.  Most state-oriented variables should be
15496 declared with @code{defvoo} instead of @code{defvar}.  
15497
15498 In addition to the normal @code{defvar} parameters, it takes a list of
15499 variables in the parent backends to map the variable to when executing
15500 a function in those backends.
15501
15502 @lisp
15503 (defvoo nndir-directory nil
15504   "Where nndir will look for groups."
15505   nnml-current-directory nnmh-current-directory)
15506 @end lisp
15507
15508 This means that @code{nnml-current-directory} will be set to
15509 @code{nndir-directory} when an @code{nnml} function is called on behalf
15510 of @code{nndir}.  (The same with @code{nnmh}.)  
15511
15512 @item nnoo-define-basics
15513 This macro defines some common functions that almost all backends should
15514 have.
15515
15516 @example
15517 (nnoo-define-basics nndir)
15518 @end example
15519
15520 @item deffoo
15521 This macro is just like @code{defun} and takes the same parameters.  In
15522 addition to doing the normal @code{defun} things, it registers the
15523 function as being public so that other backends can inherit it.
15524
15525 @item nnoo-map-functions
15526 This macro allows mapping of functions from the current backend to
15527 functions from the parent backends.
15528
15529 @example
15530 (nnoo-map-functions nndir
15531   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15532   (nnmh-request-article 0 nndir-current-group 0 0))
15533 @end example
15534
15535 This means that when @code{nndir-retrieve-headers} is called, the first,
15536 third, and fourth parameters will be passed on to
15537 @code{nnml-retrieve-headers}, while the second parameter is set to the
15538 value of @code{nndir-current-group}.
15539
15540 @item nnoo-import
15541 This macro allows importing functions from backends.  It should be the
15542 last thing in the source file, since it will only define functions that
15543 haven't already been defined.
15544
15545 @example
15546 (nnoo-import nndir
15547   (nnmh
15548    nnmh-request-list
15549    nnmh-request-newgroups)
15550   (nnml))
15551 @end example
15552
15553 This means that calls to @code{nndir-request-list} should just be passed
15554 on to @code{nnmh-request-list}, while all public functions from
15555 @code{nnml} that haven't been defined in @code{nndir} yet should be
15556 defined now.
15557
15558 @end table
15559
15560 Below is a slightly shortened version of the @code{nndir} backend.
15561
15562 @lisp
15563 ;;; nndir.el --- single directory newsgroup access for Gnus
15564 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15565
15566 ;;; Code:
15567
15568 (require 'nnheader)
15569 (require 'nnmh)
15570 (require 'nnml)
15571 (require 'nnoo)
15572 (eval-when-compile (require 'cl))
15573
15574 (nnoo-declare nndir
15575   nnml nnmh)
15576
15577 (defvoo nndir-directory nil
15578   "Where nndir will look for groups."
15579   nnml-current-directory nnmh-current-directory)
15580
15581 (defvoo nndir-nov-is-evil nil
15582   "*Non-nil means that nndir will never retrieve NOV headers."
15583   nnml-nov-is-evil)
15584
15585 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15586 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15587 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15588
15589 (defvoo nndir-status-string "" nil nnmh-status-string)
15590 (defconst nndir-version "nndir 1.0")
15591
15592 ;;; Interface functions.
15593
15594 (nnoo-define-basics nndir)
15595
15596 (deffoo nndir-open-server (server &optional defs)
15597   (setq nndir-directory
15598         (or (cadr (assq 'nndir-directory defs))
15599             server))
15600   (unless (assq 'nndir-directory defs)
15601     (push `(nndir-directory ,server) defs))
15602   (push `(nndir-current-group
15603           ,(file-name-nondirectory (directory-file-name nndir-directory)))
15604         defs)
15605   (push `(nndir-top-directory
15606           ,(file-name-directory (directory-file-name nndir-directory)))
15607         defs)
15608   (nnoo-change-server 'nndir server defs))
15609
15610 (nnoo-map-functions nndir
15611   (nnml-retrieve-headers 0 nndir-current-group 0 0)
15612   (nnmh-request-article 0 nndir-current-group 0 0)
15613   (nnmh-request-group nndir-current-group 0 0)
15614   (nnmh-close-group nndir-current-group 0))
15615
15616 (nnoo-import nndir
15617   (nnmh
15618    nnmh-status-message
15619    nnmh-request-list
15620    nnmh-request-newgroups))
15621
15622 (provide 'nndir)
15623 @end lisp
15624
15625
15626 @node Hooking New Backends Into Gnus
15627 @subsubsection Hooking New Backends Into Gnus
15628
15629 @vindex gnus-valid-select-methods
15630 Having Gnus start using your new backend is rather easy---you just
15631 declare it with the @code{gnus-declare-backend} functions.  This will
15632 enter the backend into the @code{gnus-valid-select-methods} variable.
15633
15634 @code{gnus-declare-backend} takes two parameters---the backend name and
15635 an arbitrary number of @dfn{abilities}.
15636
15637 Here's an example:
15638
15639 @lisp
15640 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15641 @end lisp
15642
15643 The abilities can be:
15644
15645 @table @code
15646 @item mail
15647 This is a mailish backend---followups should (probably) go via mail.
15648 @item post
15649 This is a newsish backend---followups should (probably) go via news. 
15650 @item post-mail
15651 This backend supports both mail and news.
15652 @item none
15653 This is neither a post or mail backend---it's something completely
15654 different. 
15655 @item respool
15656 It supports respooling---or rather, it is able to modify its source
15657 articles and groups.
15658 @item address
15659 The name of the server should be in the virtual server name.  This is
15660 true for almost all backends.
15661 @item prompt-address
15662 The user should be prompted for an address when doing commands like
15663 @kbd{B} in the group buffer.  This is true for backends like
15664 @code{nntp}, but not @code{nnmbox}, for instance. 
15665 @end table
15666
15667
15668 @node Mail-like Backends
15669 @subsubsection Mail-like Backends
15670
15671 One of the things that separate the mail backends from the rest of the
15672 backends is the heavy dependence by the mail backends on common
15673 functions in @file{nnmail.el}.  For instance, here's the definition of
15674 @code{nnml-request-scan}: 
15675
15676 @lisp
15677 (deffoo nnml-request-scan (&optional group server)
15678   (setq nnml-article-file-alist nil)
15679   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15680 @end lisp
15681
15682 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15683 and @code{nnmail} takes care of all the moving and splitting of the
15684 mail.  
15685
15686 This function takes four parameters.
15687
15688 @table @var
15689 @item method
15690 This should be a symbol to designate which backend is responsible for
15691 the call.
15692
15693 @item exit-function
15694 This function should be called after the splitting has been performed.
15695
15696 @item temp-directory
15697 Where the temporary files should be stored.
15698
15699 @item group
15700 This optional argument should be a group name if the splitting is to be
15701 performed for one group only.
15702 @end table
15703
15704 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15705 save each article.  @var{backend}@code{-active-number} will be called to
15706 find the article number assigned to this article.  
15707
15708 The function also uses the following variables:
15709 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15710 this backend); and @var{backend}@code{-group-alist} and
15711 @var{backend}@code{-active-file} to generate the new active file.
15712 @var{backend}@code{-group-alist} should be a group-active alist, like
15713 this:
15714
15715 @example
15716 (("a-group" (1 . 10))
15717  ("some-group" (34 . 39)))
15718 @end example
15719
15720
15721 @node Score File Syntax
15722 @subsection Score File Syntax
15723
15724 Score files are meant to be easily parsable, but yet extremely
15725 mallable.   It was decided that something that had the same read syntax
15726 as an Emacs Lisp list would fit that spec.
15727
15728 Here's a typical score file:
15729
15730 @lisp
15731 (("summary"
15732   ("win95" -10000 nil s)
15733   ("Gnus"))
15734  ("from"
15735   ("Lars" -1000))
15736  (mark -100))
15737 @end lisp
15738
15739 BNF definition of a score file:
15740
15741 @example
15742 score-file       = "" / "(" *element ")"
15743 element          = rule / atom
15744 rule             = string-rule / number-rule / date-rule
15745 string-rule      = "(" quote string-header quote space *string-match ")"
15746 number-rule      = "(" quote number-header quote space *number-match ")"
15747 date-rule        = "(" quote date-header quote space *date-match ")"
15748 quote            = <ascii 34>
15749 string-header    = "subject" / "from" / "references" / "message-id" / 
15750                    "xref" / "body" / "head" / "all" / "followup"
15751 number-header    = "lines" / "chars"
15752 date-header      = "date"
15753 string-match     = "(" quote <string> quote [ "" / [ space score [ "" / 
15754                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15755 score            = "nil" / <integer>
15756 date             = "nil" / <natural number>
15757 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" / 
15758                    "r" / "regex" / "R" / "Regex" /
15759                    "e" / "exact" / "E" / "Exact" /
15760                    "f" / "fuzzy" / "F" / "Fuzzy"
15761 number-match     = "(" <integer> [ "" / [ space score [ "" / 
15762                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15763 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
15764 date-match       = "(" quote <string> quote [ "" / [ space score [ "" / 
15765                    space date [ "" / [ space date-match-t ] ] ] ] ")"
15766 date-match-t     = "nil" / "at" / "before" / "after"
15767 atom             = "(" [ required-atom / optional-atom ] ")"
15768 required-atom    = mark / expunge / mark-and-expunge / files /
15769                    exclude-files / read-only / touched
15770 optional-atom    = adapt / local / eval 
15771 mark             = "mark" space nil-or-number
15772 nil-or-number    = "nil" / <integer>
15773 expunge          = "expunge" space nil-or-number
15774 mark-and-expunge = "mark-and-expunge" space nil-or-number
15775 files            = "files" *[ space <string> ]
15776 exclude-files    = "exclude-files" *[ space <string> ]
15777 read-only        = "read-only" [ space "nil" / space "t" ]
15778 adapt            = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15779 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15780 local            = "local" *[ space "(" <string> space <form> ")" ]
15781 eval             = "eval" space <form>
15782 space            = *[ " " / <TAB> / <NEWLINE> ]
15783 @end example
15784
15785 Any unrecognized elements in a score file should be ignored, but not
15786 discarded.  
15787
15788 As you can see, white space is needed, but the type and amount of white
15789 space is irrelevant.  This means that formatting of the score file is
15790 left up to the programmer---if it's simpler to just spew it all out on
15791 one looong line, then that's ok.
15792
15793 The meaning of the various atoms are explained elsewhere in this
15794 manual. 
15795
15796
15797 @node Headers
15798 @subsection Headers
15799
15800 Gnus uses internally a format for storing article headers that
15801 corresponds to the @sc{nov} format in a mysterious fashion.  One could
15802 almost suspect that the author looked at the @sc{nov} specification and
15803 just shamelessly @emph{stole} the entire thing, and one would be right.
15804
15805 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
15806 RFC1036 to talk about lines in the head of an article (e.g.,
15807 @code{From}).  It is used by many people as a synonym for
15808 ``head''---``the header and the body''.  (That should be avoided, in my
15809 opinion.)  And Gnus uses a format internally that it calls ``header'',
15810 which is what I'm talking about here.  This is a 9-element vector,
15811 basically, with each header (ouch) having one slot.
15812
15813 These slots are, in order: @code{number}, @code{subject}, @code{from},
15814 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15815 @code{xref}.  There are macros for accessing and setting these
15816 slots---they all have predictable names beginning with
15817 @code{mail-header-} and @code{mail-header-set-}, respectively.
15818
15819 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
15820 be put in there.
15821
15822
15823 @node Ranges
15824 @subsection Ranges
15825
15826 @sc{gnus} introduced a concept that I found so useful that I've started
15827 using it a lot and have elaborated on it greatly. 
15828
15829 The question is simple: If you have a large amount of objects that are
15830 identified by numbers (say, articles, to take a @emph{wild} example)
15831 that you want to qualify as being ``included'', a normal sequence isn't
15832 very useful.  (A 200,000 length sequence is a bit long-winded.)
15833
15834 The solution is as simple as the question: You just collapse the
15835 sequence. 
15836
15837 @example
15838 (1 2 3 4 5 6 10 11 12)
15839 @end example
15840
15841 is transformed into
15842
15843 @example
15844 ((1 . 6) (10 . 12))
15845 @end example
15846
15847 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15848 lonesome object, a @samp{13} is a valid element:
15849
15850 @example
15851 ((1 . 6) 7 (10 . 12))
15852 @end example
15853
15854 This means that comparing two ranges to find out whether they are equal
15855 is slightly tricky:
15856
15857 @example
15858 ((1 . 5) 7 8 (10 . 12))
15859 @end example
15860
15861 and
15862
15863 @example
15864 ((1 . 5) (7 . 8) (10 . 12))
15865 @end example
15866
15867 are equal.  In fact, any non-descending list is a range:
15868
15869 @example
15870 (1 2 3 4 5)
15871 @end example
15872
15873 is a perfectly valid range, although a pretty long-winded one.  This is
15874 also legal:
15875
15876 @example
15877 (1 . 5)
15878 @end example
15879
15880 and is equal to the previous range.
15881
15882 Here's a BNF definition of ranges.  Of course, one must remember the
15883 semantic requirement that the numbers are non-descending.  (Any number
15884 of repetition of the same number is allowed, but apt to disappear in
15885 range handling.)
15886
15887 @example
15888 range           = simple-range / normal-range
15889 simple-range    = "(" number " . " number ")"
15890 normal-range    = "(" start-contents ")"
15891 contents        = "" / simple-range *[ " " contents ] / 
15892                   number *[ " " contents ]
15893 @end example
15894
15895 Gnus currently uses ranges to keep track of read articles and article
15896 marks.  I plan on implementing a number of range operators in C if The
15897 Powers That Be are willing to let me.  (I haven't asked yet, because I
15898 need to do some more thinking on what operators I need to make life
15899 totally range-based without ever having to convert back to normal
15900 sequences.) 
15901
15902
15903 @node Group Info
15904 @subsection Group Info
15905
15906 Gnus stores all permanent info on groups in a @dfn{group info} list.
15907 This list is from three to six elements (or more) long and exhaustively
15908 describes the group.
15909
15910 Here are two example group infos; one is a very simple group while the
15911 second is a more complex one:
15912
15913 @example
15914 ("no.group" 5 (1 . 54324))
15915
15916 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15917                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15918                 (nnml "")
15919                 (auto-expire (to-address "ding@@ifi.uio.no")))
15920 @end example
15921
15922 The first element is the @dfn{group name}---as Gnus knows the group,
15923 anyway.  The second element is the @dfn{subscription level}, which
15924 normally is a small integer.  The third element is a list of ranges of
15925 read articles.  The fourth element is a list of lists of article marks
15926 of various kinds.  The fifth element is the select method (or virtual
15927 server, if you like).  The sixth element is a list of @dfn{group
15928 parameters}, which is what this section is about.
15929
15930 Any of the last three elements may be missing if they are not required.
15931 In fact, the vast majority of groups will normally only have the first
15932 three elements, which saves quite a lot of cons cells.
15933
15934 Here's a BNF definition of the group info format:
15935
15936 @example
15937 info          = "(" group space level space read 
15938                 [ "" / [ space marks-list [ "" / [ space method [ "" /
15939                 space parameters ] ] ] ] ] ")" 
15940 group         = quote <string> quote
15941 level         = <integer in the range of 1 to inf>
15942 read          = range
15943 marks-lists   = nil / "(" *marks ")"
15944 marks         = "(" <string> range ")"
15945 method        = "(" <string> *elisp-forms ")"
15946 parameters    = "(" *elisp-forms ")"
15947 @end example
15948
15949 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
15950 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15951 in pseudo-BNF.
15952
15953
15954 @node Emacs/XEmacs Code
15955 @subsection Emacs/XEmacs Code
15956 @cindex XEmacs
15957 @cindex Emacsen
15958
15959 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15960 platforms must be the primary one.  I chose Emacs.  Not because I don't
15961 like XEmacs or Mule, but because it comes first alphabetically.
15962
15963 This means that Gnus will byte-compile under Emacs with nary a warning,
15964 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15965 As I use byte-compilation warnings to help me root out trivial errors in
15966 Gnus, that's very useful.  
15967
15968 I've also consistently used Emacs function interfaces, but have used
15969 Gnusey aliases for the functions.  To take an example:  Emacs defines a
15970 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15971 function.  I then define a function called @code{gnus-run-at-time} that
15972 takes the same parameters as the Emacs @code{run-at-time}.  When running
15973 Gnus under Emacs, the former function is just an alias for the latter.
15974 However, when running under XEmacs, the former is an alias for the
15975 following function:
15976
15977 @lisp
15978 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15979   (start-itimer
15980    "gnus-run-at-time"
15981    `(lambda ()
15982       (,function ,@@args))
15983    time repeat))
15984 @end lisp
15985
15986 This sort of thing has been done for bunches of functions.  Gnus does
15987 not redefine any native Emacs functions while running under XEmacs---it
15988 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
15989 all over.
15990
15991 Of course, I could have chosen XEmacs as my native platform and done
15992 mapping functions the other way around.  But I didn't.  The performance
15993 hit these indirections impose on Gnus under XEmacs should be slight.
15994
15995
15996 @node Various File Formats
15997 @subsection Various File Formats
15998
15999 @menu
16000 * Active File Format::      Information on articles and groups available.
16001 * Newsgroups File Format::  Group descriptions.
16002 @end menu
16003
16004
16005 @node Active File Format
16006 @subsubsection Active File Format
16007
16008 The active file lists all groups that are available on the server in
16009 question.  It also lists the highest and lowest current article numbers
16010 in each group.  
16011
16012 Here's an excerpt from a typical active file:
16013
16014 @example
16015 soc.motss 296030 293865 y
16016 alt.binaries.pictures.fractals 3922 3913 n
16017 comp.sources.unix 1605 1593 m
16018 comp.binaries.ibm.pc 5097 5089 y
16019 no.general 1000 900 y
16020 @end example
16021
16022 Here's a pseudo-BNF definition of this file:
16023
16024 @example
16025 active      = *group-line
16026 group-line  = group space high-number space low-number space flag <NEWLINE>
16027 group       = <non-white-space string>
16028 space       = " "
16029 high-number = <non-negative integer>
16030 low-number  = <positive integer>
16031 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
16032 @end example
16033
16034
16035 @node Newsgroups File Format
16036 @subsubsection Newsgroups File Format
16037
16038 The newsgroups file lists groups along with their descriptions.  Not all
16039 groups on the server have to be listed,  and not all groups in the file
16040 have to exist on the server.  The file is meant purely as information to
16041 the user.
16042
16043 The format is quite simple; a group name, a tab, and the description.
16044 Here's the definition:
16045
16046 @example
16047 newsgroups    = *line
16048 line          = group tab description <NEWLINE>
16049 group         = <non-white-space string>
16050 tab           = <TAB>
16051 description   = <string>
16052 @end example
16053
16054
16055 @node Emacs for Heathens
16056 @section Emacs for Heathens
16057
16058 Believe it or not, but some people who use Gnus haven't really used
16059 Emacs much before they embarked on their journey on the Gnus Love Boat.
16060 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
16061 region'', and ``set @code{gnus-flargblossen} to an alist where the key
16062 is a regexp that is used for matching on the group name'' are magical
16063 phrases with little or no meaning, then this appendix is for you.  If
16064 you are already familiar with Emacs, just ignore this and go fondle your
16065 cat instead.
16066
16067 @menu
16068 * Keystrokes::      Entering text and executing commands.
16069 * Emacs Lisp::      The built-in Emacs programming language.
16070 @end menu
16071
16072
16073 @node Keystrokes
16074 @subsection Keystrokes
16075
16076 @itemize @bullet
16077 @item
16078 Q: What is an experienced Emacs user?
16079
16080 @item 
16081 A: A person who wishes that the terminal had pedals.
16082 @end itemize
16083
16084 Yes, when you use Emacs, you are apt to use the control key, the shift
16085 key and the meta key a lot.  This is very annoying to some people
16086 (notably @code{vi}le users), and the rest of us just love the hell out
16087 of it.  Just give up and submit.  Emacs really does stand for
16088 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
16089 may have heard from other disreputable sources (like the Emacs author).
16090
16091 The shift key is normally located near your pinky fingers, and are
16092 normally used to get capital letters and stuff.  You probably use it all
16093 the time.  The control key is normally marked ``CTRL'' or something like
16094 that.  The meta key is, funnily enough, never marked as such on any
16095 keyboards.  The one I'm currently at has a key that's marked ``Alt'',
16096 which is the meta key on this keyboard.  It's usually located somewhere
16097 to the left hand side of the keyboard, usually on the bottom row.
16098
16099 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16100 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
16101 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16102 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
16103 down the control key, and hold it down while you press @kbd{k}''.
16104 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16105 the control key and then press @kbd{k}''.  Simple, ay?
16106
16107 This is somewhat complicated by the fact that not all keyboards have a
16108 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
16109 means ``press escape, release escape, press @kbd{k}''.  That's much more
16110 work than if you have a meta key, so if that's the case, I respectfully
16111 suggest you get a real keyboard with a meta key.  You can't live without
16112 it.
16113
16114
16115
16116 @node Emacs Lisp
16117 @subsection Emacs Lisp
16118
16119 Emacs is the King of Editors because it's really a Lisp interpreter.
16120 Each and every key you tap runs some Emacs Lisp code snippet, and since
16121 Emacs Lisp is an interpreted language, that means that you can configure
16122 any key to run any arbitrary code.  You just, like, do it.
16123
16124 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16125 functions.  (These are byte-compiled for speed, but it's still
16126 interpreted.)  If you decide that you don't like the way Gnus does
16127 certain things, it's trivial to have it do something a different way.
16128 (Well, at least if you know how to write Lisp code.)  However, that's
16129 beyond the scope of this manual, so we are simply going to talk about
16130 some common constructs that you normally use in your @file{.emacs} file
16131 to customize Gnus.
16132
16133 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16134 write the following:
16135
16136 @lisp
16137 (setq gnus-florgbnize 4)
16138 @end lisp
16139
16140 This function (really ``special form'') @code{setq} is the one that can
16141 set a variable to some value.  This is really all you need to know.  Now
16142 you can go and fill your @code{.emacs} file with lots of these to change
16143 how Gnus works.
16144
16145 If you have put that thing in your @code{.emacs} file, it will be read
16146 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16147 start Emacs.  If you want to change the variable right away, simply say
16148 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
16149 previous ``form'', which here is a simple @code{setq} statement.
16150
16151 Go ahead---just try it, if you're located at your Emacs.  After you
16152 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16153 is the return value of the form you @code{eval}ed.
16154
16155 Some pitfalls:
16156
16157 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16158 that means:
16159
16160 @lisp
16161 (setq gnus-read-active-file 'some)
16162 @end lisp
16163
16164 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16165 @samp{nntp.ifi.uio.no}'', that means:
16166
16167 @lisp
16168 (setq gnus-nntp-server "nntp.ifi.uio.no")
16169 @end lisp
16170
16171 So be careful not to mix up strings (the latter) with symbols (the
16172 former).  The manual is unambiguous, but it can be confusing.
16173
16174
16175 @include gnus-faq.texi
16176
16177 @node Index
16178 @chapter Index
16179 @printindex cp
16180
16181 @node Key Index
16182 @chapter Key Index
16183 @printindex ky
16184
16185 @summarycontents
16186 @contents
16187 @bye
16188
16189 @iftex
16190 @iflatex
16191 \end{document}
16192 @end iflatex
16193 @end iftex
16194
16195 @c End:
16196